The Tcpdump Group git mirrors - tcpdump/blob - print-brcmtag.c

   1 /*
   2  * Copyright (c) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that: (1) source code distributions
   7  * retain the above copyright notice and this paragraph in its entirety, (2)
   8  * distributions including binary code include the above copyright notice and
   9  * this paragraph in its entirety in the documentation or other materials
  10  * provided with the distribution, and (3) all advertising materials mentioning
  11  * features or use of this software display the following acknowledgement:
  12  * ``This product includes software developed by the University of California,
  13  * Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
  14  * the University nor the names of its contributors may be used to endorse
  15  * or promote products derived from this software without specific prior
  16  * written permission.
  17  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
  18  * WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
  19  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  20  */
  21
  22 /* \summary: Broadcom Ethernet switches tag (4 bytes) printer */
  23
  24 #ifdef HAVE_CONFIG_H
  25 #include <config.h>
  26 #endif
  27
  28 #include "netdissect-stdinc.h"
  29
  30 #include "netdissect.h"
  31 #include "ethertype.h"
  32 #include "addrtoname.h"
  33 #include "extract.h"
  34
  35 struct  ether_header {
  36         nd_mac_addr     ether_dhost;
  37         nd_mac_addr     ether_shost;
  38         nd_uint16_t     ether_length_type;
  39 };
  40
  41 #define ETHER_SA_OFFSET         12
  42 #define ETHER_TYPE_LEN          2
  43
  44 #define BRCM_TAG_LEN            4
  45 #define BRCM_OPCODE_SHIFT       5
  46 #define BRCM_OPCODE_MASK        0x7
  47
  48 /* Ingress fields */
  49 #define BRCM_IG_TC_SHIFT        2
  50 #define BRCM_IG_TC_MASK         0x7
  51 #define BRCM_IG_TE_MASK         0x3
  52 #define BRCM_IG_TS_SHIFT        7
  53 #define BRCM_IG_DSTMAP_MASK     0x1ff
  54
  55 /* Egress fields */
  56 #define BRCM_EG_CID_MASK        0xff
  57 #define BRCM_EG_RC_MASK         0xff
  58 #define  BRCM_EG_RC_RSVD        (3 << 6)
  59 #define  BRCM_EG_RC_EXCEPTION   (1 << 5)
  60 #define  BRCM_EG_RC_PROT_SNOOP  (1 << 4)
  61 #define  BRCM_EG_RC_PROT_TERM   (1 << 3)
  62 #define  BRCM_EG_RC_SWITCH      (1 << 2)
  63 #define  BRCM_EG_RC_MAC_LEARN   (1 << 1)
  64 #define  BRCM_EG_RC_MIRROR      (1 << 0)
  65 #define BRCM_EG_TC_SHIFT        5
  66 #define BRCM_EG_TC_MASK         0x7
  67 #define BRCM_EG_PID_MASK        0x1f
  68
  69 const struct tok brcm_tag_te_values[] = {
  70         { 0, "None" },
  71         { 1, "Untag" },
  72         { 2, "Header"},
  73         { 3, "Reserved" },
  74 };
  75
  76 const struct tok brcm_tag_rc_values[] = {
  77         { 1, "mirror" },
  78         { 2, "MAC learning" },
  79         { 4, "switching" },
  80         { 8, "prot term" },
  81         { 16, "prot snoop" },
  82         { 32, "exception" },
  83 };
  84
  85 static int brcm_tag_print_full(netdissect_options *ndo, const u_char *bp,
  86                                u_int length)
  87 {
  88         uint8_t tag[BRCM_TAG_LEN];
  89         uint16_t dst_map;
  90         unsigned int i;
  91
  92         if (length < BRCM_TAG_LEN)
  93                 return (1);
  94
  95         for (i = 0; i < BRCM_TAG_LEN; i++)
  96                 tag[i] = EXTRACT_U_1(bp + i);
  97
  98         ND_PRINT("BRCM tag OP: %s", tag[0] ? "IG" : "EG");
  99         if (tag[0] & (1 << BRCM_OPCODE_SHIFT)) {
 100                 /* Ingress Broadcom tag */
 101                 ND_PRINT(", TC: %d", (tag[1] >> BRCM_IG_TC_SHIFT) &
 102                                      BRCM_IG_TC_MASK);
 103                 ND_PRINT(", TE: %s",
 104                          tok2str(brcm_tag_te_values, "unknown",
 105                                  (tag[1] & BRCM_IG_TE_MASK)));
 106                 ND_PRINT(", TS: %d", tag[1] >> BRCM_IG_TS_SHIFT);
 107                 dst_map = (uint16_t)tag[2] << 8 | tag[3];
 108                 ND_PRINT(", DST map: 0x%04x", dst_map & BRCM_IG_DSTMAP_MASK);
 109         } else {
 110                 /* Egress Broadcom tag */
 111                 ND_PRINT(", CID: %d", tag[1]);
 112                 ND_PRINT(", RC: %s", tok2str(brcm_tag_rc_values,
 113                                            "reserved", tag[2]));
 114                 ND_PRINT(", TC: %d", (tag[3] >> BRCM_EG_TC_SHIFT) &
 115                                     BRCM_EG_TC_MASK);
 116                 ND_PRINT(", port: %d", tag[3] & BRCM_EG_PID_MASK);
 117         }
 118         ND_PRINT(", ");
 119
 120         return (0);
 121 }
 122
 123 u_int
 124 brcm_tag_if_print(netdissect_options *ndo, const struct pcap_pkthdr *h,
 125                   const u_char *p)
 126 {
 127         const struct ether_header *ehp;
 128         int old_eflag = ndo->ndo_eflag;
 129         u_int caplen = h->caplen;
 130         u_int length = h->len;
 131         int ret;
 132
 133         ndo->ndo_protocol = "brcm-tag";
 134         if (caplen < ETHER_SA_OFFSET + BRCM_TAG_LEN) {
 135                 nd_print_trunc(ndo);
 136                 return (caplen);
 137         }
 138
 139         if (length < ETHER_SA_OFFSET + BRCM_TAG_LEN) {
 140                 nd_print_trunc(ndo);
 141                 return (length);
 142         }
 143
 144         ehp = (const struct ether_header *)p;
 145         if (ndo->ndo_eflag)
 146                 ND_PRINT("%s > %s, ",
 147                              etheraddr_string(ndo, ehp->ether_shost),
 148                              etheraddr_string(ndo, ehp->ether_dhost));
 149
 150         if (brcm_tag_print_full(ndo, p + ETHER_SA_OFFSET,
 151                                 caplen - ETHER_SA_OFFSET))
 152                 return (1);
 153
 154         /* We printed the Ethernet header already */
 155         ndo->ndo_eflag = 0;
 156
 157         /* Parse the Ethernet frame regularly telling how big the non
 158          * standard Ethernet header is.
 159          *
 160          * +-----------++-----------++----------------++--------------+
 161          * | MAC DA (6)|| MAC SA (6)||Broadcom tag (4)||Type/Length(2)|
 162          * +-----------++-----------++----------------++--------------+
 163          */
 164         ret = ether_print_hdr_len(ndo, p, length, caplen, NULL, NULL,
 165                                   ETHER_SA_OFFSET + BRCM_TAG_LEN + 2);
 166         ndo->ndo_eflag = old_eflag;
 167         return ret;
 168 }
 169
 170 static void brcm_tag_print_encap(netdissect_options *ndo,
 171                                  const u_char *p)
 172 {
 173         brcm_tag_print_full(ndo, p, BRCM_TAG_LEN);
 174 }
 175
 176 u_int
 177 brcm_tag_prepend_if_print(netdissect_options *ndo, const struct pcap_pkthdr *h,
 178                           const u_char *p)
 179 {
 180         u_int caplen = h->caplen;
 181         u_int length = h->len;
 182
 183         ndo->ndo_protocol = "brcm-tag-prepend";
 184         if (caplen < BRCM_TAG_LEN) {
 185                 nd_print_trunc(ndo);
 186                 return (caplen);
 187         }
 188
 189         if (length < BRCM_TAG_LEN) {
 190                 nd_print_trunc(ndo);
 191                 return (length);
 192         }
 193
 194         /* Parse the Ethernet frame regularly and utilize the encapsulation
 195          * header printing facility to pring the pre-pended Broadcom tag.
 196          *
 197          * +-----------------++-----------++-----------++--------------+
 198          * | Broadcom tag (4)|| MAC DA (6)|| MAC SA (6)||Type/Length(2)|
 199          * +-----------------++-----------++-----------++--------------+
 200          */
 201         return ether_print(ndo, p + BRCM_TAG_LEN,
 202                            length - BRCM_TAG_LEN,
 203                            caplen - BRCM_TAG_LEN, brcm_tag_print_encap, p);
 204 }