ip.h

Go to the documentation of this file.

#ifndef _IPXE_IP_H
#define _IPXE_IP_H

/** @file
 *
 * IP protocol
 *
 */

FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );

#include <stdint.h>
#include <ipxe/in.h>
#include <ipxe/list.h>
#include <ipxe/retry.h>
#include <ipxe/netdevice.h>

struct io_buffer;

/* IP constants */

#define IP_VER                  0x40U
#define IP_MASK_VER             0xf0U
#define IP_MASK_HLEN            0x0fU
#define IP_MASK_OFFSET          0x1fffU
#define IP_MASK_DONOTFRAG       0x4000U
#define IP_MASK_MOREFRAGS       0x2000U
#define IP_PSHLEN       12

/* IP header defaults */
#define IP_TOS          0
#define IP_TTL          64

/** An IPv4 packet header */
struct iphdr {
        uint8_t  verhdrlen;
        uint8_t  service;
        uint16_t len;
        uint16_t ident;
        uint16_t frags;
        uint8_t  ttl;
        uint8_t  protocol;
        uint16_t chksum;
        struct in_addr src;
        struct in_addr dest;
} __attribute__ (( packed ));

/** An IPv4 pseudo header */
struct ipv4_pseudo_header {
        struct in_addr src;
        struct in_addr dest;
        uint8_t zero_padding;
        uint8_t protocol;
        uint16_t len;
};

/** An IPv4 address/routing table entry */
struct ipv4_miniroute {
        /** List of miniroutes */
        struct list_head list;

        /** Network device */
        struct net_device *netdev;

        /** IPv4 address */
        struct in_addr address;
        /** Subnet mask
         *
         * An address with all of these bits in common with our IPv4
         * address is in the local subnet.
         */
        struct in_addr netmask;
        /** Host mask
         *
         * An address in the local subnet with all of these bits set
         * to zero represents the network address, and an address in
         * the local subnet with all of these bits set to one
         * represents the directed broadcast address.  All other
         * addresses in the local subnet are valid host addresses.
         *
         * For most subnets, this is the inverse of the subnet mask.
         * In a small subnet (/31 or /32) there is no network address
         * or directed broadcast address, and all addresses in the
         * subnet are valid host addresses.
         */
        struct in_addr hostmask;
        /** Gateway address, or zero for no gateway */
        struct in_addr gateway;
};

extern struct list_head ipv4_miniroutes;

extern struct net_protocol ipv4_protocol __net_protocol;

extern int ipv4_has_any_addr ( struct net_device *netdev );
extern int parse_ipv4_setting ( const struct setting_type *type,
                                const char *value, void *buf, size_t len );
extern int format_ipv4_setting ( const struct setting_type *type,
                                 const void *raw, size_t raw_len, char *buf,
                                 size_t len );

#endif /* _IPXE_IP_H */