xref: /OK3568_Linux_fs/kernel/drivers/net/wireless/rockchip_wlan/infineon/bcmdhd/include/bcmeth.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1 /*
2  * Broadcom Ethernettype  protocol definitions
3  *
4  * Portions of this code are copyright (c) 2022 Cypress Semiconductor Corporation
5  *
6  * Copyright (C) 1999-2017, Broadcom Corporation
7  *
8  *      Unless you and Broadcom execute a separate written software license
9  * agreement governing use of this software, this software is licensed to you
10  * under the terms of the GNU General Public License version 2 (the "GPL"),
11  * available at http://www.broadcom.com/licenses/GPLv2.php, with the
12  * following added to such license:
13  *
14  *      As a special exception, the copyright holders of this software give you
15  * permission to link this software with independent modules, and to copy and
16  * distribute the resulting executable under terms of your choice, provided that
17  * you also meet, for each linked independent module, the terms and conditions of
18  * the license of that module.  An independent module is a module which is not
19  * derived from this software.  The special exception does not apply to any
20  * modifications of the software.
21  *
22  *      Notwithstanding the above, under no circumstances may you combine this
23  * software in any way with any other Broadcom software provided under a license
24  * other than the GPL, without Broadcom's express prior written consent.
25  *
26  *
27  * <<Broadcom-WL-IPTag/Open:>>
28  *
29  * $Id$
30  */
31 
32 /*
33  * Broadcom Ethernet protocol defines
34  */
35 
36 #ifndef _BCMETH_H_
37 #define _BCMETH_H_
38 
39 #ifndef _TYPEDEFS_H_
40 #include <typedefs.h>
41 #endif // endif
42 
43 /* This marks the start of a packed structure section. */
44 #include <packed_section_start.h>
45 
46 /* ETHER_TYPE_BRCM is defined in ethernet.h */
47 
48 /*
49  * Following the 2byte BRCM ether_type is a 16bit BRCM subtype field
50  * in one of two formats: (only subtypes 32768-65535 are in use now)
51  *
52  * subtypes 0-32767:
53  *     8 bit subtype (0-127)
54  *     8 bit length in bytes (0-255)
55  *
56  * subtypes 32768-65535:
57  *     16 bit big-endian subtype
58  *     16 bit big-endian length in bytes (0-65535)
59  *
60  * length is the number of additional bytes beyond the 4 or 6 byte header
61  *
62  * Reserved values:
63  * 0 reserved
64  * 5-15 reserved for iLine protocol assignments
65  * 17-126 reserved, assignable
66  * 127 reserved
67  * 32768 reserved
68  * 32769-65534 reserved, assignable
69  * 65535 reserved
70  */
71 
72 /*
73  * While adding the subtypes and their specific processing code make sure
74  * bcmeth_bcm_hdr_t is the first data structure in the user specific data structure definition
75  */
76 
77 #define	BCMILCP_SUBTYPE_RATE		1
78 #define	BCMILCP_SUBTYPE_LINK		2
79 #define	BCMILCP_SUBTYPE_CSA		3
80 #define	BCMILCP_SUBTYPE_LARQ		4
81 #define BCMILCP_SUBTYPE_VENDOR		5
82 #define	BCMILCP_SUBTYPE_FLH		17
83 
84 #define BCMILCP_SUBTYPE_VENDOR_LONG	32769
85 #define BCMILCP_SUBTYPE_CERT		32770
86 #define BCMILCP_SUBTYPE_SES		32771
87 
88 #define BCMILCP_BCM_SUBTYPE_RESERVED		0
89 #define BCMILCP_BCM_SUBTYPE_EVENT		1
90 #define BCMILCP_BCM_SUBTYPE_SES			2
91 /*
92  * The EAPOL type is not used anymore. Instead EAPOL messages are now embedded
93  * within BCMILCP_BCM_SUBTYPE_EVENT type messages
94  */
95 /* #define BCMILCP_BCM_SUBTYPE_EAPOL		3 */
96 #define BCMILCP_BCM_SUBTYPE_DPT                 4
97 #define BCMILCP_BCM_SUBTYPE_DNGLEVENT       5
98 
99 #define BCMILCP_BCM_SUBTYPEHDR_MINLENGTH	8
100 #define BCMILCP_BCM_SUBTYPEHDR_VERSION		0
101 #define BCMILCP_BCM_SUBTYPE_EVENT_DATA_PAD	2
102 
103 /* These fields are stored in network order */
104 typedef BWL_PRE_PACKED_STRUCT struct bcmeth_hdr
105 {
106 	uint16	subtype;	/* Vendor specific..32769 */
107 	uint16	length;
108 	uint8	version;	/* Version is 0 */
109 	uint8	oui[3];		/* Broadcom OUI */
110 	/* user specific Data */
111 	uint16	usr_subtype;
112 } BWL_POST_PACKED_STRUCT bcmeth_hdr_t;
113 
114 /* This marks the end of a packed structure section. */
115 #include <packed_section_end.h>
116 
117 #endif	/*  _BCMETH_H_ */
118