nw_icmpv6_pkg Package Body Reference

Package Body >> nw_icmpv6_pkg

Functions
t_slv_arr	f_icmpv6_create_pkt ( ipv6_header: in t_ipv6_header icmp_header: in t_icmpv6_header payload: in t_slv_arr routing_header: in t_extension_header C_DEFAULT_EXT_HEADER get_length: in boolean )
t_slv_arr	f_icmpv6_create_pkt ( ipv6_header: in t_ipv6_header icmp_header: in t_icmpv6_header payload: in t_slv_arr routing_header: in t_extension_header C_DEFAULT_EXT_HEADER )
	Create ICMPv4 packet.
natural	f_icmpv6_create_pkt_len ( ipv6_header: in t_ipv6_header icmp_header: in t_icmpv6_header payload: in t_slv_arr routing_header: in t_extension_header C_DEFAULT_EXT_HEADER )
	Return length of ICMP packet.
t_icmpv6_header	f_icmpv6_get_header ( icmp_pkt: in t_slv_arr )
	Get ICMP header.
t_slv_arr	f_icmpv6_get_payload ( icmp_pkt: in t_slv_arr , get_length: in boolean false )
t_slv_arr	f_icmpv6_get_payload ( icmp_pkt: in t_slv_arr )
	Get ICMP payload.
natural	f_icmpv6_get_payload_len ( icmp_pkt: in t_slv_arr )
	Get ICMP payload length.
boolean	f_icmpv6_chksum_ok ( ipv6_header: in t_ipv6_header icmp_pkt: in t_slv_arr routing_header: in t_extension_header C_DEFAULT_EXT_HEADER )
	Check ICMP checksum.

Member Function/Procedure/Process Documentation

f_icmpv6_create_pkt()

t_slv_arr f_icmpv6_create_pkt (   ipv6_header in t_ipv6_header ,   icmp_header in t_icmpv6_header ,   payload in t_slv_arr ,   routing_header in t_extension_header C_DEFAULT_EXT_HEADER   )

Function

Create ICMPv4 packet.

Parameters

ipv6_header	IPv6 header (required for checksum calculation)
icmp_header	ICMP header
payload	ICMP payload
routing_header	IPv6 routing extension header (default none)

Returns

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

Create ICMPv6 packet. Payload must be 8bit data array. A pseudo-header is generated from the IPv6 header which is included in the checksum calculation. If the IPv6 packet contains a routing extension header, it must be included here as the pseudo header destination address is the final destination.

Example use

v_packet_8bit  := f_icmpv6_create_pkt(v_ipv6_header, C_DEFAULT_ICMPV6_HEADER, payload); -- echo request

f_icmpv6_create_pkt_len()

natural f_icmpv6_create_pkt_len (   ipv6_header in t_ipv6_header ,   icmp_header in t_icmpv6_header ,   payload in t_slv_arr ,   routing_header in t_extension_header C_DEFAULT_EXT_HEADER   )

Function

Return length of ICMP packet.

Parameters

ipv6_header	IPv6 header (required for checksum calculation)
icmp_header	ICMP header
payload	ICMP payload
routing_header	IPv6 routing extension header (default none)

Returns

Length of ICMP packet

Return the length of the created ICMP packet.

Example use

v_len                      := f_icmpv6_create_pkt_len(v_ipv6_header, v_icmp_header, payload); 
v_pkt_8bit(0 to v_len - 1) := f_icmpv6_create_pkt(v_ipv6_header, v_icmp_header, payload);

f_icmpv6_get_header()

t_icmpv6_header f_icmpv6_get_header (   icmp_pkt in t_slv_arr   )

Function

Get ICMP header.

Parameters

icmp_pkt

ICMP packet (8bit)

Returns

ICMP header

Extract ICMP header from ICMP packet.

Example use

v_icmp_header := f_icmpv6_get_header(data_array_8bit); 

f_icmpv6_get_payload()

t_slv_arr f_icmpv6_get_payload (   icmp_pkt in t_slv_arr   )

Function

Get ICMP payload.

Parameters

icmp_pkt

ICMP packet (8bit)

Returns

t_slv_arr

Extract ICMP payload from ICMP packet.

Example use

v_len                     := f_icmpv6_get_payload_len(data_array_8bit); 
v_payload(0 to v_len - 1) := f_icmpv6_get_payload(data_array_8bit); 

f_icmpv6_get_payload_len()

natural f_icmpv6_get_payload_len (   icmp_pkt in t_slv_arr   )

Function

Get ICMP payload length.

Parameters

icmp_pkt

ICMP packet (8bit)

Returns

ICMP payload length

Get ICMP payload length from ICMP packet.

Example use

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

f_icmpv6_chksum_ok()

boolean f_icmpv6_chksum_ok (   ipv6_header in t_ipv6_header ,   icmp_pkt in t_slv_arr ,   routing_header in t_extension_header C_DEFAULT_EXT_HEADER   )

Function

Check ICMP checksum.

Parameters

ipv6_header	IPv6 header (required for checksum calculation)
icmp_pkt	ICMP packet (8bit)
routing_header	IPv6 routing extension header (default none)

Returns

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

Check checksum of ICMP packet.

Example use

v_check := f_icmpv6_chksum_ok(v_ipv6_header, icmp_pkt); 

---

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

• nw_ipv6/src/nw_icmpv6_pkg.vhd