| 1 | /* |
| 2 | * Copyright 2006, 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 | /* IPV4 and IPV6 common */ |
| 18 | #define IP_VER_OFFSET 0x0 /* offset to version field */ |
| 19 | #define IP_VER_MASK 0xf0 /* version mask */ |
| 20 | #define IP_VER_SHIFT 4 /* version shift */ |
| 21 | #define IP_VER_4 4 /* version number for IPV4 */ |
| 22 | #define IP_VER_6 6 /* version number for IPV6 */ |
| 23 | |
| 24 | #define IP_VER(ip_body) \ |
| 25 | ((((uint8 *)(ip_body))[IP_VER_OFFSET] & IP_VER_MASK) >> IP_VER_SHIFT) |
| 26 | |
| 27 | #define IP_PROT_ICMP 0x1 /* ICMP protocol */ |
| 28 | #define IP_PROT_TCP 0x6 /* TCP protocol */ |
| 29 | #define IP_PROT_UDP 0x11 /* UDP protocol type */ |
| 30 | |
| 31 | /* IPV4 field offsets */ |
| 32 | #define IPV4_VER_HL_OFFSET 0 /* version and ihl byte offset */ |
| 33 | #define IPV4_TOS_OFFSET 1 /* type of service offset */ |
| 34 | #define IPV4_PROT_OFFSET 9 /* protocol type offset */ |
| 35 | #define IPV4_CHKSUM_OFFSET 10 /* IP header checksum offset */ |
| 36 | #define IPV4_SRC_IP_OFFSET 12 /* src IP addr offset */ |
| 37 | #define IPV4_DEST_IP_OFFSET 16 /* dest IP addr offset */ |
| 38 | |
| 39 | /* IPV4 field decodes */ |
| 40 | #define IPV4_VER_MASK 0xf0 /* IPV4 version mask */ |
| 41 | #define IPV4_VER_SHIFT 4 /* IPV4 version shift */ |
| 42 | |
| 43 | #define IPV4_HLEN_MASK 0x0f /* IPV4 header length mask */ |
| 44 | #define IPV4_HLEN(ipv4_body) (4 * (((uint8 *)(ipv4_body))[IPV4_VER_HL_OFFSET] & IPV4_HLEN_MASK)) |
| 45 | |
| 46 | #define IPV4_ADDR_LEN 4 /* IPV4 address length */ |
| 47 | |
| 48 | #define IPV4_ADDR_NULL(a) ((((uint8 *)(a))[0] | ((uint8 *)(a))[1] | \ |
| 49 | ((uint8 *)(a))[2] | ((uint8 *)(a))[3]) == 0) |
| 50 | |
| 51 | #define IPV4_TOS_DSCP_MASK 0xfc /* DiffServ codepoint mask */ |
| 52 | #define IPV4_TOS_DSCP_SHIFT 2 /* DiffServ codepoint shift */ |
| 53 | |
| 54 | #define IPV4_TOS(ipv4_body) (((uint8 *)(ipv4_body))[IPV4_TOS_OFFSET]) |
| 55 | |
| 56 | #define IPV4_TOS_PREC_MASK 0xe0 /* Historical precedence mask */ |
| 57 | #define IPV4_TOS_PREC_SHIFT 5 /* Historical precedence shift */ |
| 58 | |
| 59 | #define IPV4_TOS_LOWDELAY 0x10 /* Lowest delay requested */ |
| 60 | #define IPV4_TOS_THROUGHPUT 0x8 /* Best throughput requested */ |
| 61 | #define IPV4_TOS_RELIABILITY 0x4 /* Most reliable delivery requested */ |
| 62 | |
| 63 | #define IPV4_PROT(ipv4_body) (((uint8 *)(ipv4_body))[IPV4_PROT_OFFSET]) |
| 64 | |
| 65 | #define IPV4_ADDR_STR_LEN 16 /* Max IP address length in string format */ |
| 66 | |
| 67 | /* IPV6 field offsets */ |
| 68 | #define IPV6_PAYLOAD_LEN_OFFSET 4 /* payload length offset */ |
| 69 | #define IPV6_NEXT_HDR_OFFSET 6 /* next header/protocol offset */ |
| 70 | #define IPV6_HOP_LIMIT_OFFSET 7 /* hop limit offset */ |
| 71 | #define IPV6_SRC_IP_OFFSET 8 /* src IP addr offset */ |
| 72 | #define IPV6_DEST_IP_OFFSET 24 /* dst IP addr offset */ |
| 73 | |
| 74 | /* IPV6 field decodes */ |
| 75 | #define IPV6_TRAFFIC_CLASS(ipv6_body) \ |
| 76 | (((((uint8 *)(ipv6_body))[0] & 0x0f) << 4) | \ |
| 77 | ((((uint8 *)(ipv6_body))[1] & 0xf0) >> 4)) |
| 78 | |
| 79 | #define IPV6_FLOW_LABEL(ipv6_body) \ |
| 80 | (((((uint8 *)(ipv6_body))[1] & 0x0f) << 16) | \ |
| 81 | (((uint8 *)(ipv6_body))[2] << 8) | \ |
| 82 | (((uint8 *)(ipv6_body))[3])) |
| 83 | |
| 84 | #define IPV6_PAYLOAD_LEN(ipv6_body) \ |
| 85 | ((((uint8 *)(ipv6_body))[IPV6_PAYLOAD_LEN_OFFSET + 0] << 8) | \ |
| 86 | ((uint8 *)(ipv6_body))[IPV6_PAYLOAD_LEN_OFFSET + 1]) |
| 87 | |
| 88 | #define IPV6_NEXT_HDR(ipv6_body) \ |
| 89 | (((uint8 *)(ipv6_body))[IPV6_NEXT_HDR_OFFSET]) |
| 90 | |
| 91 | #define IPV6_PROT(ipv6_body) IPV6_NEXT_HDR(ipv6_body) |
| 92 | |
| 93 | #define IPV6_ADDR_LEN 16 /* IPV6 address length */ |
| 94 | |
| 95 | /* IPV4 TOS or IPV6 Traffic Classifier or 0 */ |
| 96 | #define IP_TOS(ip_body) \ |
| 97 | (IP_VER(ip_body) == IP_VER_4 ? IPV4_TOS(ip_body) : \ |
| 98 | IP_VER(ip_body) == IP_VER_6 ? IPV6_TRAFFIC_CLASS(ip_body) : 0) |
| 99 | |
| 100 | #endif /* _bcmip_h_ */ |
| 101 | |
