1 /* 2 * CDC network driver ioctl/indication encoding 3 * Broadcom 802.11abg Networking Device Driver 4 * 5 * Definitions subject to change without notice. 6 * 7 * Copyright (C) 1999-2019, Broadcom. 8 * 9 * Unless you and Broadcom execute a separate written software license 10 * agreement governing use of this software, this software is licensed to you 11 * under the terms of the GNU General Public License version 2 (the "GPL"), 12 * available at http://www.broadcom.com/licenses/GPLv2.php, with the 13 * following added to such license: 14 * 15 * As a special exception, the copyright holders of this software give you 16 * permission to link this software with independent modules, and to copy and 17 * distribute the resulting executable under terms of your choice, provided that 18 * you also meet, for each linked independent module, the terms and conditions 19 * of the license of that module. An independent module is a module which is 20 * not derived from this software. The special exception does not apply to any 21 * modifications of the software. 22 * 23 * Notwithstanding the above, under no circumstances may you combine this 24 * software in any way with any other Broadcom software provided under a license 25 * other than the GPL, without Broadcom's express prior written consent. 26 * 27 * 28 * <<Broadcom-WL-IPTag/Open:>> 29 * 30 * $Id: bcmcdc.h 700076 2017-05-17 14:42:22Z $ 31 */ 32 #ifndef _bcmcdc_h_ 33 #define _bcmcdc_h_ 34 #include <ethernet.h> 35 36 typedef struct cdc_ioctl { 37 uint32 cmd; /* ioctl command value */ 38 uint32 len; /* lower 16: output buflen; upper 16: input buflen (excludes 39 header) */ 40 uint32 flags; /* flag defns given below */ 41 uint32 status; /* status code returned from the device */ 42 } cdc_ioctl_t; 43 44 /* Max valid buffer size that can be sent to the dongle */ 45 #define CDC_MAX_MSG_SIZE ETHER_MAX_LEN 46 47 /* len field is divided into input and output buffer lengths */ 48 #define CDCL_IOC_OUTLEN_MASK \ 49 0x0000FFFF /* maximum or expected response length, */ 50 /* excluding IOCTL header */ 51 #define CDCL_IOC_OUTLEN_SHIFT 0 52 #define CDCL_IOC_INLEN_MASK \ 53 0xFFFF0000 /* input buffer length, excluding IOCTL header */ 54 #define CDCL_IOC_INLEN_SHIFT 16 55 56 /* CDC flag definitions */ 57 #define CDCF_IOC_ERROR 0x01 /* 0=success, 1=ioctl cmd failed */ 58 #define CDCF_IOC_SET 0x02 /* 0=get, 1=set cmd */ 59 #define CDCF_IOC_OVL_IDX_MASK 0x3c /* overlay region index mask */ 60 #define CDCF_IOC_OVL_RSV 0x40 /* 1=reserve this overlay region */ 61 #define CDCF_IOC_OVL 0x80 /* 1=this ioctl corresponds to an overlay */ 62 #define CDCF_IOC_ACTION_MASK 0xfe /* SET/GET, OVL_IDX, OVL_RSV, OVL mask */ 63 #define CDCF_IOC_ACTION_SHIFT 1 /* SET/GET, OVL_IDX, OVL_RSV, OVL shift */ 64 #define CDCF_IOC_IF_MASK 0xF000 /* I/F index */ 65 #define CDCF_IOC_IF_SHIFT 12 66 #define CDCF_IOC_ID_MASK \ 67 0xFFFF0000 /* used to uniquely id an ioctl req/resp pairing */ 68 #define CDCF_IOC_ID_SHIFT 16 /* # of bits of shift for ID Mask */ 69 70 #define CDC_IOC_IF_IDX(flags) (((flags)&CDCF_IOC_IF_MASK) >> CDCF_IOC_IF_SHIFT) 71 #define CDC_IOC_ID(flags) (((flags)&CDCF_IOC_ID_MASK) >> CDCF_IOC_ID_SHIFT) 72 73 #define CDC_GET_IF_IDX(hdr) \ 74 ((int)((((hdr)->flags) & CDCF_IOC_IF_MASK) >> CDCF_IOC_IF_SHIFT)) 75 #define CDC_SET_IF_IDX(hdr, idx) \ 76 ((hdr)->flags = \ 77 (((hdr)->flags & ~CDCF_IOC_IF_MASK) | ((idx) << CDCF_IOC_IF_SHIFT))) 78 79 /* 80 * BDC header 81 * 82 * The BDC header is used on data packets to convey priority across USB. 83 */ 84 85 struct bdc_header { 86 uint8 flags; /* Flags */ 87 uint8 priority; /* 802.1d Priority 0:2 bits, 4:7 USB flow control info */ 88 uint8 flags2; 89 uint8 dataOffset; /* Offset from end of BDC header to packet data, in 90 * 4-byte words. Leaves room for optional headers. 91 */ 92 }; 93 94 #define BDC_HEADER_LEN 4 95 96 /* flags field bitmap */ 97 #define BDC_FLAG_EXEMPT \ 98 0x03 /* EXT_STA: encryption exemption (host -> dongle?) */ 99 #define BDC_FLAG_80211_PKT \ 100 0x01 /* Packet is in 802.11 format (dongle -> host) */ 101 #define BDC_FLAG_SUM_GOOD 0x04 /* Dongle has verified good RX checksums */ 102 #define BDC_FLAG_SUM_NEEDED \ 103 0x08 /* Dongle needs to do TX checksums: host->device */ 104 #define BDC_FLAG_EVENT_MSG \ 105 0x08 /* Payload contains an event msg: device->host */ 106 #define BDC_FLAG_VER_MASK 0xf0 /* Protocol version mask */ 107 #define BDC_FLAG_VER_SHIFT 4 /* Protocol version shift */ 108 109 /* priority field bitmap */ 110 #define BDC_PRIORITY_MASK 0x07 111 #define BDC_PRIORITY_FC_MASK 0xf0 /* flow control info mask */ 112 #define BDC_PRIORITY_FC_SHIFT 4 /* flow control info shift */ 113 114 /* flags2 field bitmap */ 115 #define BDC_FLAG2_IF_MASK 0x0f /* interface index (host <-> dongle) */ 116 #define BDC_FLAG2_IF_SHIFT 0 117 #define BDC_FLAG2_FC_FLAG 0x10 /* flag to indicate if pkt contains */ 118 /* FLOW CONTROL info only */ 119 120 /* version numbers */ 121 #define BDC_PROTO_VER_1 1 /* Old Protocol version */ 122 #define BDC_PROTO_VER 2 /* Protocol version */ 123 124 /* flags2.if field access macros */ 125 #define BDC_GET_IF_IDX(hdr) \ 126 ((int)((((hdr)->flags2) & BDC_FLAG2_IF_MASK) >> BDC_FLAG2_IF_SHIFT)) 127 #define BDC_SET_IF_IDX(hdr, idx) \ 128 ((hdr)->flags2 = (((hdr)->flags2 & ~BDC_FLAG2_IF_MASK) | \ 129 ((idx) << BDC_FLAG2_IF_SHIFT))) 130 131 #endif /* _bcmcdc_h_ */ 132