---

/opentcp/include/inet/ip.h File Reference

---

Detailed Description

Author:

• Jari Lahti (jari.lahti@violasystems.com)

Version:

1.0

Date:

11.6.2002

OpenTCP IP function declarations, constants, etc.

Definition in file ip.h.

Go to the source code of this file.

Data Structures
struct	ip_frame
	IP datagram header fields. More...
Defines
#define	PHY_ADR_LEN   ETH_ADDRESS_LEN
#define	IP_ICMP   0x01
#define	IP_UDP   17
#define	IP_TCP   6
Functions
INT16	process_ip_in (struct ethernet_frame *)
	Process received IP frame.
INT16	process_ip_out (UINT32, UINT8, UINT8, UINT8, UINT8 *, UINT16)
	Try to send out IP frame.
UINT8	ip_check_cs (struct ip_frame *)
	Check IP frame's checksum.
UINT16	ip_checksum (UINT16, UINT8, UINT8)
	Used for constructuing IP checksum.
UINT32	ip_construct_cs (struct ip_frame *)
	Construct checksum of the IP header.

---

Define Documentation

#define PHY_ADR_LEN   ETH_ADDRESS_LEN

Lower-layer physical address length Definition at line 69 of file ip.h. Referenced by process_ip_in().

#define IP_ICMP   0x01

ICMP over IP Definition at line 71 of file ip.h. Referenced by process_icmp_in(), process_ip_in(), and process_ip_out().

#define IP_UDP   17

UDP over IP Definition at line 72 of file ip.h. Referenced by process_ip_out(), process_udp_in(), and udp_send().

#define IP_TCP   6

TCP over IP Definition at line 73 of file ip.h. Referenced by process_ip_out(), process_tcp_in(), and process_tcp_out().

---

Function Documentation

INT16 process_ip_out (  UINT32    ipadr, UINT8    pcol, UINT8    tos, UINT8    ttl, UINT8 *    dat, UINT16    len )

Author: Jari Lahti Date: 11.06.2002 Parameters: ipadr  remote IP address pcol  protocol over IP used. Can be one of the following: IP_ICMP IP_UDP IP_TCP tos  type of service required ttl  time to live header field of IP packet dat  pointer to data buffer len  length of data to be sent in IP datagram Returns: -1 - general error -2 - ARP cache not ready >0 - number of data bytes sent (packet OK) Invoke this function to perform all of the necessary preparation in order to send out an IP packet. These include: Consulting ARP cache for HW address to send the packet to Filling send_ip_packet variable with correct values Calculating checksum for the IP packet Adding datalink header information Sending IP header and data Instructing NIC to send the data Definition at line 300 of file ip.c. References arp_find(), ARP_TEMP_IP, ip_frame::checksum, ip_frame::dip, ip_frame::frags, arp_entry::hwadr, ICMP_BUF, ip_frame::id, ip_construct_cs(), IP_ICMP, ip_id, IP_TCP, IP_UDP, MAXHWALEN, NETWORK_ADD_DATALINK, NETWORK_COMPLETE_SEND, NETWORK_SEND_INITIALIZE, ip_frame::protocol, PROTOCOL_IP, SEND_NETWORK_B, ip_frame::sip, TCP_BUF, ip_frame::tlen, ip_frame::tos, ip_frame::ttl, UDP_BUF, and ip_frame::vihl. Referenced by process_icmp_in(), process_tcp_out(), and udp_send().

UINT8 ip_check_cs (  struct ip_frame *    frame )

Author: Jari Lahti Date: 11.06.2002 Parameters: frame  pointer to IP frame to be checked Returns: 0 - checksum corrupted 1 - checksum OK Checksum of an IP packet is calculated and compared with the received checksum. Error is signaled if there is discrepancy between them. Definition at line 476 of file ip.c. References ip_frame::checksum, ip_frame::dip, ip_frame::frags, ip_frame::id, ip_checksum(), ip_frame::opt, ip_frame::protocol, ip_frame::sip, ip_frame::tlen, ip_frame::tos, ip_frame::ttl, and ip_frame::vihl. Referenced by process_ip_in().

UINT16 ip_checksum (  UINT16    cs, UINT8    dat, UINT8    count )

Author: Jari Lahti Date: 24.02.2002 Parameters: cs  last checksum value dat  byte to be added to checksum count  byte indicating whether dat is MSB or LSB byte Returns: new checksum value Based on count value, dat byte is added to checksum either as a MSB or a LSB byte and the new checksum value is then returned. Definition at line 541 of file ip.c. Referenced by ip_check_cs(), ip_construct_cs(), process_icmp_in(), process_tcp_out(), process_udp_in(), tcp_check_cs(), and udp_send().

UINT32 ip_construct_cs (  struct ip_frame *    frame )

Author: Jari Lahti Date: 08.07.2002 Parameters: frame  pointer to ip_frame structure holding header information based on which checksum is calculated Returns: Calculated checksum Checksum of the supplied IP datagram is calculated. Definition at line 419 of file ip.c. References ip_frame::dip, ip_frame::frags, ip_frame::id, ip_checksum(), ip_frame::opt, ip_frame::protocol, ip_frame::sip, ip_frame::tlen, ip_frame::tos, ip_frame::ttl, and ip_frame::vihl. Referenced by process_ip_out().

---