nw_ipv4_pkg Package Body Reference

Package >> nw_ipv4_pkg

Functions
t_ipv4_header	f_ipv4_get_header ( ipv4_pkt: in t_slv_arr )
	Get IPv4 header.
t_slv_arr	f_ipv4_get_payload ( ipv4_pkt: in t_slv_arr )
natural	f_ipv4_get_payload_len ( ipv4_pkt: in t_slv_arr )
	Get IPv4 payload.
t_slv_arr	f_ipv4_create_pkt ( header: in t_ipv4_header , payload: in t_slv_arr )
	Get IPv4 payload length.
natural	f_ipv4_create_pkt_len ( header: in t_ipv4_header , payload: in t_slv_arr )
	Create IPv4 packet.
boolean	f_ipv4_chksum_ok ( ipv4_pkt: in t_slv_arr )
	Return length of IPv4 packet.

Member Function Documentation

f_ipv4_get_header()

t_ipv4_header f_ipv4_get_header (   ipv4_pkt in t_slv_arr   )

Function

Get IPv4 header.

Parameters

ipv4_pkt

IPv4 packet (8bit)

Returns

IPv4 header

Extract IPv4 header from IPv4 packet.

Example use

v_ipv4_header := f_ipv4_get_header(data_array_8bit); 

f_ipv4_get_payload_len()

natural f_ipv4_get_payload_len (   ipv4_pkt in t_slv_arr   )

Function

Get IPv4 payload.

Parameters

ipv4_pkt

IPv4 packet (8bit)

Returns

t_slv_arr

Extract IPv4 payload from IPv4 packet.

Example use

v_len                     := f_ipv4_get_payload_len(data_array_8bit); 
v_payload(0 to v_len - 1) := f_ipv4_get_payload(data_array_8bit); 

f_ipv4_create_pkt()

t_slv_arr f_ipv4_create_pkt (   header in t_ipv4_header ,   payload in t_slv_arr   )

Function

Get IPv4 payload length.

Parameters

ipv4_pkt

IPv4 packet (8bit)

Returns

IPv4 payload length

Get IPv4 payload length from IPv4 packet.

Example use

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

f_ipv4_create_pkt_len()

natural f_ipv4_create_pkt_len (   header in t_ipv4_header ,   payload in t_slv_arr   )

Function

Create IPv4 packet.

Parameters

header	IPv4 header
payload	IPv4 payload

Returns

IPv4 packet (8bit array) or length of IPv4 packet

Create IPv4 packet. Payload must be 8bit data array.

Example use

v_ipv4_header := C_DEFAULT_IPV4_HEADER;
v_packet_8bit := f_ipv4_create_pkt(v_ipv4_header, payload); 

f_ipv4_chksum_ok()

boolean f_ipv4_chksum_ok (   ipv4_pkt in t_slv_arr   )

Function

Return length of IPv4 packet.

Parameters

header	IPv4 header
payload	IPv4 payload

Returns

Length of IPv4 packet

Return the length of the created IPv4 packet.

Example use

v_len                      := f_ipv4_create_pkt_len(v_ipv4_header, payload); 
v_pkt_8bit(0 to v_len - 1) := f_ipv4_create_pkt(v_ipv4_header, payload);

---

The documentation for this class was generated from the following file:

• nw_ipv4/src/nw_ipv4_pkg.vhd