package/broadcom-57xx/src/proto/bcmip.h

   1 /*
   2  * Copyright 2007, Broadcom Corporation
   3  * All Rights Reserved.
   4  *
   5  * THIS SOFTWARE IS OFFERED "AS IS", AND BROADCOM GRANTS NO WARRANTIES OF ANY
   6  * KIND, EXPRESS OR IMPLIED, BY STATUTE, COMMUNICATION OR OTHERWISE. BROADCOM
   7  * SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS
   8  * FOR A SPECIFIC PURPOSE OR NONINFRINGEMENT CONCERNING THIS SOFTWARE.
   9  *
  10  * Fundamental constants relating to IP Protocol
  11  *
  12  */
  13
  14 #ifndef _bcmip_h_
  15 #define _bcmip_h_
  16
  17 /* enable structure packing */
  18 #if defined(__GNUC__)
  19 #define PACKED  __attribute__((packed))
  20 #else
  21 #pragma pack(1)
  22 #define PACKED
  23 #endif
  24
  25
  26 /* IPV4 and IPV6 common */
  27 #define IP_VER_OFFSET           0x0     /* offset to version field */
  28 #define IP_VER_MASK             0xf0    /* version mask */
  29 #define IP_VER_SHIFT            4       /* version shift */
  30 #define IP_VER_4                4       /* version number for IPV4 */
  31 #define IP_VER_6                6       /* version number for IPV6 */
  32
  33 #define IP_VER(ip_body) \
  34         ((((uint8 *)(ip_body))[IP_VER_OFFSET] & IP_VER_MASK) >> IP_VER_SHIFT)
  35
  36 #define IP_PROT_ICMP            0x1     /* ICMP protocol */
  37 #define IP_PROT_TCP             0x6     /* TCP protocol */
  38 #define IP_PROT_UDP             0x11    /* UDP protocol type */
  39
  40 /* IPV4 field offsets */
  41 #define IPV4_VER_HL_OFFSET      0       /* version and ihl byte offset */
  42 #define IPV4_TOS_OFFSET         1       /* type of service offset */
  43 #define IPV4_PKTLEN_OFFSET      2       /* packet length offset */
  44 #define IPV4_PKTFLAG_OFFSET     6       /* more-frag,dont-frag flag offset */
  45 #define IPV4_PROT_OFFSET        9       /* protocol type offset */
  46 #define IPV4_CHKSUM_OFFSET      10      /* IP header checksum offset */
  47 #define IPV4_SRC_IP_OFFSET      12      /* src IP addr offset */
  48 #define IPV4_DEST_IP_OFFSET     16      /* dest IP addr offset */
  49 #define IPV4_OPTIONS_OFFSET     20      /* IP options offset */
  50
  51 /* IPV4 field decodes */
  52 #define IPV4_VER_MASK           0xf0    /* IPV4 version mask */
  53 #define IPV4_VER_SHIFT          4       /* IPV4 version shift */
  54
  55 #define IPV4_HLEN_MASK          0x0f    /* IPV4 header length mask */
  56 #define IPV4_HLEN(ipv4_body)    (4 * (((uint8 *)(ipv4_body))[IPV4_VER_HL_OFFSET] & IPV4_HLEN_MASK))
  57
  58 #define IPV4_ADDR_LEN           4       /* IPV4 address length */
  59
  60 #define IPV4_ADDR_NULL(a)       ((((uint8 *)(a))[0] | ((uint8 *)(a))[1] | \
  61                                   ((uint8 *)(a))[2] | ((uint8 *)(a))[3]) == 0)
  62
  63 #define IPV4_ADDR_BCAST(a)      ((((uint8 *)(a))[0] & ((uint8 *)(a))[1] & \
  64                                   ((uint8 *)(a))[2] & ((uint8 *)(a))[3]) == 0xff)
  65
  66 #define IPV4_TOS_DSCP_MASK      0xfc    /* DiffServ codepoint mask */
  67 #define IPV4_TOS_DSCP_SHIFT     2       /* DiffServ codepoint shift */
  68
  69 #define IPV4_TOS(ipv4_body)     (((uint8 *)(ipv4_body))[IPV4_TOS_OFFSET])
  70
  71 #define IPV4_TOS_PREC_MASK      0xe0    /* Historical precedence mask */
  72 #define IPV4_TOS_PREC_SHIFT     5       /* Historical precedence shift */
  73
  74 #define IPV4_TOS_LOWDELAY       0x10    /* Lowest delay requested */
  75 #define IPV4_TOS_THROUGHPUT     0x8     /* Best throughput requested */
  76 #define IPV4_TOS_RELIABILITY    0x4     /* Most reliable delivery requested */
  77
  78 #define IPV4_PROT(ipv4_body)    (((uint8 *)(ipv4_body))[IPV4_PROT_OFFSET])
  79
  80 #define IPV4_FRAG_RESV          0x8000  /* Reserved */
  81 #define IPV4_FRAG_DONT          0x4000  /* Don't fragment */
  82 #define IPV4_FRAG_MORE          0x2000  /* More fragments */
  83 #define IPV4_FRAG_OFFSET_MASK   0x1fff  /* Fragment offset */
  84
  85 #define IPV4_ADDR_STR_LEN       16      /* Max IP address length in string format */
  86
  87 /* IPv4, no options only.  */
  88 #define IPV4_NO_OPTIONS_HDR_LEN 20
  89 #define IPV4_NO_OPTIONS_PAYLOAD(ip_hdr)    (&(((uint8 *)(ip_hdr))[IPV4_NO_OPTIONS_HDR_LEN]))
  90
  91 #define IPV4_PAYLOAD_LEN(ip_body) \
  92         (((int)(((uint8 *)(ip_body))[IPV4_PKTLEN_OFFSET + 0]) << 8) | \
  93          ((uint8 *)(ip_body))[IPV4_PKTLEN_OFFSET + 1])
  94
  95 /* IPV4 packet formats */
  96 struct ipv4_addr {
  97         uint8   addr[IPV4_ADDR_LEN];
  98 } PACKED;
  99
 100 struct ipv4_hdr {
 101         uint8   version_ihl;            /* Version and Internet Header Length */
 102         uint8   tos;                    /* Type Of Service */
 103         uint16  tot_len;                /* Number of bytes in packet (max 65535) */
 104         uint16  id;
 105         uint16  frag;                   /* 3 flag bits and fragment offset */
 106         uint8   ttl;                    /* Time To Live */
 107         uint8   prot;                   /* Protocol */
 108         uint16  hdr_chksum;             /* IP header checksum */
 109         uint8   src_ip[IPV4_ADDR_LEN];  /* Source IP Address */
 110         uint8   dst_ip[IPV4_ADDR_LEN];  /* Destination IP Address */
 111 } PACKED;
 112
 113 /* IPV6 field offsets */
 114 #define IPV6_PAYLOAD_LEN_OFFSET 4       /* payload length offset */
 115 #define IPV6_NEXT_HDR_OFFSET    6       /* next header/protocol offset */
 116 #define IPV6_HOP_LIMIT_OFFSET   7       /* hop limit offset */
 117 #define IPV6_SRC_IP_OFFSET      8       /* src IP addr offset */
 118 #define IPV6_DEST_IP_OFFSET     24      /* dst IP addr offset */
 119
 120 /* IPV6 field decodes */
 121 #define IPV6_TRAFFIC_CLASS(ipv6_body) \
 122         (((((uint8 *)(ipv6_body))[0] & 0x0f) << 4) | \
 123          ((((uint8 *)(ipv6_body))[1] & 0xf0) >> 4))
 124
 125 #define IPV6_FLOW_LABEL(ipv6_body) \
 126         (((((uint8 *)(ipv6_body))[1] & 0x0f) << 16) | \
 127          (((uint8 *)(ipv6_body))[2] << 8) | \
 128          (((uint8 *)(ipv6_body))[3]))
 129
 130 #define IPV6_PAYLOAD_LEN(ipv6_body) \
 131         ((((uint8 *)(ipv6_body))[IPV6_PAYLOAD_LEN_OFFSET + 0] << 8) | \
 132          ((uint8 *)(ipv6_body))[IPV6_PAYLOAD_LEN_OFFSET + 1])
 133
 134 #define IPV6_NEXT_HDR(ipv6_body) \
 135         (((uint8 *)(ipv6_body))[IPV6_NEXT_HDR_OFFSET])
 136
 137 #define IPV6_PROT(ipv6_body)    IPV6_NEXT_HDR(ipv6_body)
 138
 139 #define IPV6_ADDR_LEN           16      /* IPV6 address length */
 140
 141 /* IPV4 TOS or IPV6 Traffic Classifier or 0 */
 142 #define IP_TOS(ip_body) \
 143         (IP_VER(ip_body) == IP_VER_4 ? IPV4_TOS(ip_body) : \
 144          IP_VER(ip_body) == IP_VER_6 ? IPV6_TRAFFIC_CLASS(ip_body) : 0)
 145
 146 #undef PACKED
 147 #if !defined(__GNUC__)
 148 #pragma pack()
 149 #endif
 150
 151 #endif  /* _bcmip_h_ */