nw_tcpv4_pkg Package Body Reference

Package Body >> nw_tcpv4_pkg

Functions
t_slv_arr	f_tcpv4_create_pkt ( ipv4_header: in t_ipv4_header tcp_header: in t_tcp_header payload: in t_slv_arr add_payload: in boolean get_length: in boolean false )
t_slv_arr	f_tcpv4_create_pkt ( ipv4_header: in t_ipv4_header tcp_header: in t_tcp_header payload: in t_slv_arr )
	Create TCP for IPv4 packet.
natural	f_tcpv4_create_pkt_len ( ipv4_header: in t_ipv4_header tcp_header: in t_tcp_header payload: in t_slv_arr )
	Return length of TCP packet.
t_slv_arr	f_tcpv4_create_pkt ( ipv4_header: in t_ipv4_header , tcp_header: in t_tcp_header )
	Create TCP for IPv4 packet.
natural	f_tcpv4_create_pkt_len ( ipv4_header: in t_ipv4_header , tcp_header: in t_tcp_header )
	Return length of TCP packet.
t_tcp_header	f_tcpv4_get_header ( tcp_pkt: in t_slv_arr )
	Get TCP header.
t_slv_arr	f_tcpv4_get_payload ( tcp_pkt: in t_slv_arr , get_length: in boolean false )
t_slv_arr	f_tcpv4_get_payload ( tcp_pkt: in t_slv_arr )
	Get TCP payload.
natural	f_tcpv4_get_payload_len ( tcp_pkt: in t_slv_arr )
	Get TCP payload length.
boolean	f_tcpv4_chksum_ok ( ipv4_header: in t_ipv4_header , tcp_pkt: in t_slv_arr )
	Check TCP checksum.

Member Function/Procedure/Process Documentation

f_tcpv4_create_pkt() [1/2]

t_slv_arr f_tcpv4_create_pkt (   ipv4_header in t_ipv4_header ,   tcp_header in t_tcp_header ,   payload in t_slv_arr   )

Function

Create TCP for IPv4 packet.

Parameters

ipv4_header	IPv4 header (required for checksum calculation)
udp_header	TCP header
payload	TCP payload

Returns

TCP packet (8bit array)

Create TCPv4 packet. Payload must be 8bit data array. A pseudo-header is generated from the IPv4 header which is included in the checksum calculation.

Example use

v_ipv4_header := C_DEFAULT_IPV4_HEADER;
v_tcp_header  := C_DEFAULT_TCP_HEADER;
v_packet_8bit := f_tcpv4_create_pkt(v_ipv4_header, v_tcp_header, payload); 

f_tcpv4_create_pkt_len() [1/2]

natural f_tcpv4_create_pkt_len (   ipv4_header in t_ipv4_header ,   tcp_header in t_tcp_header ,   payload in t_slv_arr   )

Function

Return length of TCP packet.

Parameters

ipv4_header	IPv4 header (required for checksum calculation)
tcp_header	TCP header
payload	TCP payload

Returns

Length of TCP packet

Return the length of the created TCP packet.

Example use

v_len                      := f_tcpv4_create_pkt_len(v_ipv4_header, v_tcp_header, payload); 
v_pkt_8bit(0 to v_len - 1) := f_tcpv4_create_pkt(v_ipv4_header, v_tcp_header, payload);

f_tcpv4_create_pkt() [2/2]

t_slv_arr f_tcpv4_create_pkt (   ipv4_header in t_ipv4_header ,   tcp_header in t_tcp_header   )

Function

Create TCP for IPv4 packet.

Parameters

ipv4_header	IPv4 header (required for checksum calculation)
udp_header	TCP header

Returns

TCP packet (8bit array)

Create TCPv4 packet without payload.

Example use

v_ipv4_header := C_DEFAULT_IPV4_HEADER;
v_tcp_header  := C_DEFAULT_TCP_HEADER;
v_packet_8bit := f_tcpv4_create_pkt(v_ipv4_header, v_tcp_header); 

f_tcpv4_create_pkt_len() [2/2]

natural f_tcpv4_create_pkt_len (   ipv4_header in t_ipv4_header ,   tcp_header in t_tcp_header   )

Function

Return length of TCP packet.

Parameters

ipv4_header	IPv4 header (required for checksum calculation)
tcp_header	TCP header

Returns

Length of TCP packet

Return the length of the created TCP packet (no payload).

Example use

v_len                      := f_tcpv4_create_pkt_len(v_ipv4_header, v_tcp_header); 
v_pkt_8bit(0 to v_len - 1) := f_tcpv4_create_pkt(v_ipv4_header, v_tcp_header);

f_tcpv4_get_header()

t_tcp_header f_tcpv4_get_header (   tcp_pkt in t_slv_arr   )

Function

Get TCP header.

Parameters

tcp_pkt

TCP packet (8bit)

Returns

TCP header

Extract TCP header from TCP packet.

Example use

v_tcp_header := f_tcpv4_get_header(data_array_8bit); 

f_tcpv4_get_payload()

t_slv_arr f_tcpv4_get_payload (   tcp_pkt in t_slv_arr   )

Function

Get TCP payload.

Parameters

tcp_pkt

TCP packet (8bit)

Returns

t_slv_arr

Extract TCP payload from TCP packet.

Example use

v_len                     := f_tcpv4_get_payload_len(data_array_8bit); 
v_payload(0 to v_len - 1) := f_tcpv4_get_payload(data_array_8bit); 

f_tcpv4_get_payload_len()

natural f_tcpv4_get_payload_len (   tcp_pkt in t_slv_arr   )

Function

Get TCP payload length.

Parameters

tcp_pkt

TCP packet (8bit)

Returns

TCP payload length

Get TCP payload length from TCP packet.

Example use

v_len := f_tcpv4_get_payload_len(data_array_8bit); -- determine size of payload

f_tcpv4_chksum_ok()

boolean f_tcpv4_chksum_ok (   ipv4_header in t_ipv4_header ,   tcp_pkt in t_slv_arr   )

Function

Check TCP checksum.

Parameters

ipv4_header	IPv4 header
tcp_pkt	TCP packet (8bit)

Returns

Checksum is OK (True), or not (False)

Check checksum of TCP packet. The IPv4 header is required for the pseudo-header fields.

Example use

v_check := f_tcpv4_chksum_ok(ipv4_header, data_array_8bit); 

---

The documentation for this design unit was generated from the following file:

• nw_ipv4/src/nw_tcpv4_pkg.vhd