1/* 2 * Copyright (C) 2013, Broadcom Corporation. All Rights Reserved. 3 * 4 * Permission to use, copy, modify, and/or distribute this software for any 5 * purpose with or without fee is hereby granted, provided that the above 6 * copyright notice and this permission notice appear in all copies. 7 * 8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY 11 * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION 13 * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN 14 * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 15 * 16 * Fundamental constants relating to IP Protocol 17 * 18 * $Id: bcmip.h 427480 2013-10-03 19:09:47Z $ 19 */ 20 21#ifndef _bcmip_h_ 22#define _bcmip_h_ 23 24#ifndef _TYPEDEFS_H_ 25#include <typedefs.h> 26#endif 27 28/* This marks the start of a packed structure section. */ 29#include <packed_section_start.h> 30 31 32/* IPV4 and IPV6 common */ 33#define IP_VER_OFFSET 0x0 /* offset to version field */ 34#define IP_VER_MASK 0xf0 /* version mask */ 35#define IP_VER_SHIFT 4 /* version shift */ 36#define IP_VER_4 4 /* version number for IPV4 */ 37#define IP_VER_6 6 /* version number for IPV6 */ 38 39#if defined(CTF_PPTP) || defined(CTF_L2TP) 40/* IP flags. */ 41#define IP_CE 0x8000 /* Flag: "Congestion" */ 42#define IP_DF 0x4000 /* Flag: "Don't Fragment" */ 43#define IP_MF 0x2000 /* Flag: "More Fragments" */ 44#define IP_OFFSET 0x1FFF /* "Fragment Offset" part */ 45#endif 46 47#define IP_VER(ip_body) \ 48 ((((uint8 *)(ip_body))[IP_VER_OFFSET] & IP_VER_MASK) >> IP_VER_SHIFT) 49 50#define IP_PROT_ICMP 0x1 /* ICMP protocol */ 51#define IP_PROT_IGMP 0x2 /* IGMP protocol */ 52#define IP_PROT_TCP 0x6 /* TCP protocol */ 53#define IP_PROT_UDP 0x11 /* UDP protocol type */ 54#define IP_PROT_ICMP6 0x3a /* ICMPv6 protocol type */ 55#if defined(CTF_PPTP) || defined(CTF_L2TP) 56#define IP_PROT_GRE 0x2f /* GRE protocol type */ 57#endif 58 59/* IPV4 field offsets */ 60#define IPV4_VER_HL_OFFSET 0 /* version and ihl byte offset */ 61#define IPV4_TOS_OFFSET 1 /* type of service offset */ 62#define IPV4_PKTLEN_OFFSET 2 /* packet length offset */ 63#define IPV4_PKTFLAG_OFFSET 6 /* more-frag,dont-frag flag offset */ 64#define IPV4_PROT_OFFSET 9 /* protocol type offset */ 65#define IPV4_CHKSUM_OFFSET 10 /* IP header checksum offset */ 66#define IPV4_SRC_IP_OFFSET 12 /* src IP addr offset */ 67#define IPV4_DEST_IP_OFFSET 16 /* dest IP addr offset */ 68#define IPV4_OPTIONS_OFFSET 20 /* IP options offset */ 69#define IPV4_MIN_HEADER_LEN 20 /* Minimum size for an IP header (no options) */ 70 71/* IPV4 field decodes */ 72#define IPV4_VER_MASK 0xf0 /* IPV4 version mask */ 73#define IPV4_VER_SHIFT 4 /* IPV4 version shift */ 74 75#define IPV4_HLEN_MASK 0x0f /* IPV4 header length mask */ 76#define IPV4_HLEN(ipv4_body) (4 * (((uint8 *)(ipv4_body))[IPV4_VER_HL_OFFSET] & IPV4_HLEN_MASK)) 77 78#define IPV4_ADDR_LEN 4 /* IPV4 address length */ 79 80#define IPV4_ADDR_NULL(a) ((((uint8 *)(a))[0] | ((uint8 *)(a))[1] | \ 81 ((uint8 *)(a))[2] | ((uint8 *)(a))[3]) == 0) 82 83#define IPV4_ADDR_BCAST(a) ((((uint8 *)(a))[0] & ((uint8 *)(a))[1] & \ 84 ((uint8 *)(a))[2] & ((uint8 *)(a))[3]) == 0xff) 85 86#define IPV4_TOS_DSCP_MASK 0xfc /* DiffServ codepoint mask */ 87#define IPV4_TOS_DSCP_SHIFT 2 /* DiffServ codepoint shift */ 88 89#define IPV4_TOS(ipv4_body) (((uint8 *)(ipv4_body))[IPV4_TOS_OFFSET]) 90 91#define IPV4_TOS_PREC_MASK 0xe0 /* Historical precedence mask */ 92#define IPV4_TOS_PREC_SHIFT 5 /* Historical precedence shift */ 93 94#define IPV4_TOS_LOWDELAY 0x10 /* Lowest delay requested */ 95#define IPV4_TOS_THROUGHPUT 0x8 /* Best throughput requested */ 96#define IPV4_TOS_RELIABILITY 0x4 /* Most reliable delivery requested */ 97 98#define IPV4_TOS_ROUTINE 0 99#define IPV4_TOS_PRIORITY 1 100#define IPV4_TOS_IMMEDIATE 2 101#define IPV4_TOS_FLASH 3 102#define IPV4_TOS_FLASHOVERRIDE 4 103#define IPV4_TOS_CRITICAL 5 104#define IPV4_TOS_INETWORK_CTRL 6 105#define IPV4_TOS_NETWORK_CTRL 7 106 107#define IPV4_PROT(ipv4_body) (((uint8 *)(ipv4_body))[IPV4_PROT_OFFSET]) 108 109#define IPV4_FRAG_RESV 0x8000 /* Reserved */ 110#define IPV4_FRAG_DONT 0x4000 /* Don't fragment */ 111#define IPV4_FRAG_MORE 0x2000 /* More fragments */ 112#define IPV4_FRAG_OFFSET_MASK 0x1fff /* Fragment offset */ 113 114#define IPV4_ADDR_STR_LEN 16 /* Max IP address length in string format */ 115 116/* IPV4 packet formats */ 117BWL_PRE_PACKED_STRUCT struct ipv4_addr { 118 uint8 addr[IPV4_ADDR_LEN]; 119} BWL_POST_PACKED_STRUCT; 120 121BWL_PRE_PACKED_STRUCT struct ipv4_hdr { 122 uint8 version_ihl; /* Version and Internet Header Length */ 123 uint8 tos; /* Type Of Service */ 124 uint16 tot_len; /* Number of bytes in packet (max 65535) */ 125 uint16 id; 126 uint16 frag; /* 3 flag bits and fragment offset */ 127 uint8 ttl; /* Time To Live */ 128 uint8 prot; /* Protocol */ 129 uint16 hdr_chksum; /* IP header checksum */ 130 uint8 src_ip[IPV4_ADDR_LEN]; /* Source IP Address */ 131 uint8 dst_ip[IPV4_ADDR_LEN]; /* Destination IP Address */ 132} BWL_POST_PACKED_STRUCT; 133 134/* IPV6 field offsets */ 135#define IPV6_PAYLOAD_LEN_OFFSET 4 /* payload length offset */ 136#define IPV6_NEXT_HDR_OFFSET 6 /* next header/protocol offset */ 137#define IPV6_HOP_LIMIT_OFFSET 7 /* hop limit offset */ 138#define IPV6_SRC_IP_OFFSET 8 /* src IP addr offset */ 139#define IPV6_DEST_IP_OFFSET 24 /* dst IP addr offset */ 140 141/* IPV6 field decodes */ 142#define IPV6_TRAFFIC_CLASS(ipv6_body) \ 143 (((((uint8 *)(ipv6_body))[0] & 0x0f) << 4) | \ 144 ((((uint8 *)(ipv6_body))[1] & 0xf0) >> 4)) 145 146#define IPV6_FLOW_LABEL(ipv6_body) \ 147 (((((uint8 *)(ipv6_body))[1] & 0x0f) << 16) | \ 148 (((uint8 *)(ipv6_body))[2] << 8) | \ 149 (((uint8 *)(ipv6_body))[3])) 150 151#define IPV6_PAYLOAD_LEN(ipv6_body) \ 152 ((((uint8 *)(ipv6_body))[IPV6_PAYLOAD_LEN_OFFSET + 0] << 8) | \ 153 ((uint8 *)(ipv6_body))[IPV6_PAYLOAD_LEN_OFFSET + 1]) 154 155#define IPV6_NEXT_HDR(ipv6_body) \ 156 (((uint8 *)(ipv6_body))[IPV6_NEXT_HDR_OFFSET]) 157 158#define IPV6_PROT(ipv6_body) IPV6_NEXT_HDR(ipv6_body) 159 160#define IPV6_ADDR_LEN 16 /* IPV6 address length */ 161 162/* IPV4 TOS or IPV6 Traffic Classifier or 0 */ 163#define IP_TOS46(ip_body) \ 164 (IP_VER(ip_body) == IP_VER_4 ? IPV4_TOS(ip_body) : \ 165 IP_VER(ip_body) == IP_VER_6 ? IPV6_TRAFFIC_CLASS(ip_body) : 0) 166 167#define IP_DSCP46(ip_body) (IP_TOS46(ip_body) >> IPV4_TOS_DSCP_SHIFT); 168 169/* IPV4 or IPV6 Protocol Classifier or 0 */ 170#define IP_PROT46(ip_body) \ 171 (IP_VER(ip_body) == IP_VER_4 ? IPV4_PROT(ip_body) : \ 172 IP_VER(ip_body) == IP_VER_6 ? IPV6_PROT(ip_body) : 0) 173 174/* IPV6 extension headers (options) */ 175#define IPV6_EXTHDR_HOP 0 176#define IPV6_EXTHDR_ROUTING 43 177#define IPV6_EXTHDR_FRAGMENT 44 178#define IPV6_EXTHDR_AUTH 51 179#define IPV6_EXTHDR_NONE 59 180#define IPV6_EXTHDR_DEST 60 181 182#define IPV6_EXTHDR(prot) (((prot) == IPV6_EXTHDR_HOP) || \ 183 ((prot) == IPV6_EXTHDR_ROUTING) || \ 184 ((prot) == IPV6_EXTHDR_FRAGMENT) || \ 185 ((prot) == IPV6_EXTHDR_AUTH) || \ 186 ((prot) == IPV6_EXTHDR_NONE) || \ 187 ((prot) == IPV6_EXTHDR_DEST)) 188 189#define IPV6_MIN_HLEN 40 190 191#define IPV6_EXTHDR_LEN(eh) ((((struct ipv6_exthdr *)(eh))->hdrlen + 1) << 3) 192 193BWL_PRE_PACKED_STRUCT struct ipv6_exthdr { 194 uint8 nexthdr; 195 uint8 hdrlen; 196} BWL_POST_PACKED_STRUCT; 197 198BWL_PRE_PACKED_STRUCT struct ipv6_exthdr_frag { 199 uint8 nexthdr; 200 uint8 rsvd; 201 uint16 frag_off; 202 uint32 ident; 203} BWL_POST_PACKED_STRUCT; 204 205static INLINE int32 206ipv6_exthdr_len(uint8 *h, uint8 *proto) 207{ 208 uint16 len = 0, hlen; 209 struct ipv6_exthdr *eh = (struct ipv6_exthdr *)h; 210 211 while (IPV6_EXTHDR(eh->nexthdr)) { 212 if (eh->nexthdr == IPV6_EXTHDR_NONE) 213 return -1; 214 else if (eh->nexthdr == IPV6_EXTHDR_FRAGMENT) 215 hlen = 8; 216 else if (eh->nexthdr == IPV6_EXTHDR_AUTH) 217 hlen = (eh->hdrlen + 2) << 2; 218 else 219 hlen = IPV6_EXTHDR_LEN(eh); 220 221 len += hlen; 222 eh = (struct ipv6_exthdr *)(h + len); 223 } 224 225 *proto = eh->nexthdr; 226 return len; 227} 228 229#define IPV4_ISMULTI(a) (((a) & 0xf0000000) == 0xe0000000) 230 231#define IPV4_MCAST_TO_ETHER_MCAST(ipv4, ether) \ 232{ \ 233 ether[0] = 0x01; \ 234 ether[1] = 0x00; \ 235 ether[2] = 0x5E; \ 236 ether[3] = (ipv4 & 0x7f0000) >> 16; \ 237 ether[4] = (ipv4 & 0xff00) >> 8; \ 238 ether[5] = (ipv4 & 0xff); \ 239} 240 241/* This marks the end of a packed structure section. */ 242#include <packed_section_end.h> 243 244#endif /* _bcmip_h_ */ 245