xref: /freebsd/contrib/tcpdump/print-brcmtag.c (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
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 #define ND_LONGJMP_FROM_TCHECK
31 #include "netdissect.h"
32 #include "ethertype.h"
33 #include "addrtoname.h"
34 #include "extract.h"
35 
36 #define ETHER_TYPE_LEN		2
37 
38 #define BRCM_TAG_LEN		4
39 #define BRCM_OPCODE_SHIFT	5
40 #define BRCM_OPCODE_MASK	0x7
41 
42 /* Ingress fields */
43 #define BRCM_IG_TC_SHIFT	2
44 #define BRCM_IG_TC_MASK		0x7
45 #define BRCM_IG_TE_MASK		0x3
46 #define BRCM_IG_TS_SHIFT	7
47 #define BRCM_IG_DSTMAP_MASK	0x1ff
48 
49 /* Egress fields */
50 #define BRCM_EG_CID_MASK	0xff
51 #define BRCM_EG_RC_MASK		0xff
52 #define  BRCM_EG_RC_RSVD	(3 << 6)
53 #define  BRCM_EG_RC_EXCEPTION	(1 << 5)
54 #define  BRCM_EG_RC_PROT_SNOOP	(1 << 4)
55 #define  BRCM_EG_RC_PROT_TERM	(1 << 3)
56 #define  BRCM_EG_RC_SWITCH	(1 << 2)
57 #define  BRCM_EG_RC_MAC_LEARN	(1 << 1)
58 #define  BRCM_EG_RC_MIRROR	(1 << 0)
59 #define BRCM_EG_TC_SHIFT	5
60 #define BRCM_EG_TC_MASK		0x7
61 #define BRCM_EG_PID_MASK	0x1f
62 
63 static const struct tok brcm_tag_te_values[] = {
64 	{ 0, "None" },
65 	{ 1, "Untag" },
66 	{ 2, "Header"},
67 	{ 3, "Reserved" },
68 	{ 0, NULL }
69 };
70 
71 static const struct tok brcm_tag_rc_values[] = {
72 	{ 1, "mirror" },
73 	{ 2, "MAC learning" },
74 	{ 4, "switching" },
75 	{ 8, "prot term" },
76 	{ 16, "prot snoop" },
77 	{ 32, "exception" },
78 	{ 0, NULL }
79 };
80 
81 static void
82 brcm_tag_print(netdissect_options *ndo, const u_char *bp)
83 {
84 	uint8_t tag[BRCM_TAG_LEN];
85 	uint16_t dst_map;
86 	unsigned int i;
87 
88 	for (i = 0; i < BRCM_TAG_LEN; i++)
89 		tag[i] = GET_U_1(bp + i);
90 
91 	ND_PRINT("BRCM tag OP: %s", tag[0] ? "IG" : "EG");
92 	if (tag[0] & (1 << BRCM_OPCODE_SHIFT)) {
93 		/* Ingress Broadcom tag */
94 		ND_PRINT(", TC: %d", (tag[1] >> BRCM_IG_TC_SHIFT) &
95 			 BRCM_IG_TC_MASK);
96 		ND_PRINT(", TE: %s",
97 			 tok2str(brcm_tag_te_values, "unknown",
98 				 (tag[1] & BRCM_IG_TE_MASK)));
99 		ND_PRINT(", TS: %d", tag[1] >> BRCM_IG_TS_SHIFT);
100 		dst_map = (uint16_t)tag[2] << 8 | tag[3];
101 		ND_PRINT(", DST map: 0x%04x", dst_map & BRCM_IG_DSTMAP_MASK);
102 	} else {
103 		/* Egress Broadcom tag */
104 		ND_PRINT(", CID: %d", tag[1]);
105 		ND_PRINT(", RC: %s", tok2str(brcm_tag_rc_values,
106 			 "reserved", tag[2]));
107 		ND_PRINT(", TC: %d", (tag[3] >> BRCM_EG_TC_SHIFT) &
108 			 BRCM_EG_TC_MASK);
109 		ND_PRINT(", port: %d", tag[3] & BRCM_EG_PID_MASK);
110 	}
111 	ND_PRINT(", ");
112 }
113 
114 void
115 brcm_tag_if_print(netdissect_options *ndo, const struct pcap_pkthdr *h,
116 		  const u_char *p)
117 {
118 	u_int caplen = h->caplen;
119 	u_int length = h->len;
120 
121 	ndo->ndo_protocol = "brcm-tag";
122 	ndo->ndo_ll_hdr_len +=
123 		ether_switch_tag_print(ndo, p, length, caplen,
124 				       brcm_tag_print, BRCM_TAG_LEN);
125 }
126 
127 void
128 brcm_tag_prepend_if_print(netdissect_options *ndo, const struct pcap_pkthdr *h,
129 			  const u_char *p)
130 {
131 	u_int caplen = h->caplen;
132 	u_int length = h->len;
133 
134 	ndo->ndo_protocol = "brcm-tag-prepend";
135 	ND_TCHECK_LEN(p, BRCM_TAG_LEN);
136 	ndo->ndo_ll_hdr_len += BRCM_TAG_LEN;
137 
138 	if (ndo->ndo_eflag) {
139 		/* Print the prepended Broadcom tag. */
140 		brcm_tag_print(ndo, p);
141 	}
142 	p += BRCM_TAG_LEN;
143 	length -= BRCM_TAG_LEN;
144 	caplen -= BRCM_TAG_LEN;
145 
146 	/*
147 	 * Now print the Ethernet frame following it.
148 	 */
149 	ndo->ndo_ll_hdr_len +=
150 		ether_print(ndo, p, length, caplen, NULL, NULL);
151 }
152