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