1 /*- 2 * SPDX-License-Identifier: BSD-4-Clause 3 * 4 * Copyright (c) 2003-2005 Craig Boston 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 3. All advertising materials mentioning features or use of this software 16 * must display the following acknowledgement: 17 * This product includes software developed by Bill Paul. 18 * 4. Neither the name of the author nor the names of any co-contributors 19 * may be used to endorse or promote products derived from this software 20 * without specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND 23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25 * ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul, THE VOICES IN HIS HEAD OR 26 * THE CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 27 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 28 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 29 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 30 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 31 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 32 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 33 * 34 * $FreeBSD$ 35 */ 36 37 #ifndef _USB_IF_CDCEREG_H_ 38 #define _USB_IF_CDCEREG_H_ 39 40 /*************************************************************/ 41 #define ETHER_TYPE_LEN 2 /* length of the Ethernet type field */ 42 #define ETHER_HDR_LEN (NETIF_MAX_HWADDR_LEN*2+ETHER_TYPE_LEN) 43 /* 44 * Mbuf adjust factor to force 32-bit alignment of IP header. 45 * Drivers should do m_adj(m, ETHER_ALIGN) when setting up a 46 * receive so the upper layers get the IP header properly aligned 47 * past the 14-byte Ethernet header. 48 */ 49 #define ETHER_ALIGN 2 /* driver adjust for IP hdr alignment */ 50 51 #define CDCE_BIT(x) (1 << (x)) 52 53 #define CDCE_FRAMES_MAX 8 /* units */ 54 #define CDCE_IND_SIZE_MAX 32 /* bytes */ 55 56 #define CDCE_NCM_TX_MINLEN 512 /* bytes, must be power of two */ 57 #define CDCE_NCM_TX_MAXLEN (16384 + 4) /* bytes, must be short terminated */ 58 #define CDCE_NCM_TX_FRAMES_MAX 8 /* units */ 59 60 #define CDCE_NCM_RX_MAXLEN (1UL << 14) /* bytes */ 61 #define CDCE_NCM_RX_FRAMES_MAX 1 /* units */ 62 63 #define CDCE_NCM_SUBFRAMES_MAX 32 /* units */ 64 65 #define CDCE_NCM_ALIGN(rem,off,mod) \ 66 ((uint32_t)(((uint32_t)(rem)) - \ 67 ((uint32_t)((-(uint32_t)(off)) & (-(uint32_t)(mod)))))) 68 #define CDCE_HAVE_NCM 0 69 70 #ifndef CDCE_HAVE_NCM 71 #define CDCE_HAVE_NCM 1 72 #endif 73 74 enum { 75 CDCE_BULK_RX, 76 CDCE_BULK_TX, 77 CDCE_INTR_RX, 78 CDCE_INTR_TX, 79 CDCE_N_TRANSFER, 80 }; 81 82 struct cdce_ncm { 83 struct usb_ncm16_hdr hdr; 84 struct usb_ncm16_dpt dpt; 85 struct usb_ncm16_dp dp[CDCE_NCM_SUBFRAMES_MAX]; 86 uint32_t rx_max; 87 uint32_t tx_max; 88 uint16_t tx_remainder; 89 uint16_t tx_modulus; 90 uint16_t tx_struct_align; 91 uint16_t tx_seq; 92 uint16_t tx_nframe; 93 }; 94 95 struct cdce_softc { 96 struct usb_ether sc_ue; 97 struct mtx sc_mtx; 98 #if CDCE_HAVE_NCM 99 struct cdce_ncm sc_ncm; 100 #endif 101 struct usb_xfer *sc_xfer[CDCE_N_TRANSFER]; 102 struct pbuf *sc_rx_buf[CDCE_FRAMES_MAX]; 103 struct pbuf *sc_tx_buf[CDCE_FRAMES_MAX]; 104 105 int sc_flags; 106 #define CDCE_FLAG_ZAURUS 0x0001 107 #define CDCE_FLAG_NO_UNION 0x0002 108 #define CDCE_FLAG_RX_DATA 0x0010 109 #define CDCE_FLAG_VLAN 0x0020 110 111 uint8_t sc_eaddr_str_index; 112 uint8_t sc_ifaces_index[2]; 113 uint8_t sc_notify_state; 114 #define CDCE_NOTIFY_NETWORK_CONNECTION 0 115 #define CDCE_NOTIFY_SPEED_CHANGE 1 116 #define CDCE_NOTIFY_DONE 2 117 }; 118 119 /* 120 * Taken from USB CDC Subclass Specification for Ethernet Devices v1.2, 121 * section 6.2.4. 122 */ 123 124 #define CDC_SET_ETHERNET_PACKET_FILTER 0x43 /* Command code. */ 125 126 #define CDC_PACKET_TYPE_PROMISC CDCE_BIT(0) 127 #define CDC_PACKET_TYPE_ALL_MULTICAST CDCE_BIT(1) /* Allmulti. */ 128 #define CDC_PACKET_TYPE_DIRECTED CDCE_BIT(2) /* Filter unicast by mac. */ 129 #define CDC_PACKET_TYPE_BROADCAST CDCE_BIT(3) 130 #define CDC_PACKET_TYPE_MULTICAST CDCE_BIT(4) /* Multicast filtering, not supported. */ 131 132 /* 133 * Structure of a DEC/Intel/Xerox or 802.3 Ethernet header. 134 */ 135 struct ether_header { 136 uint8_t ether_dhost[NETIF_MAX_HWADDR_LEN]; 137 uint8_t ether_shost[NETIF_MAX_HWADDR_LEN]; 138 uint16_t ether_type; 139 }; 140 141 #define CDCE_LOCK(_sc) mtx_lock(&(_sc)->sc_mtx) 142 #define CDCE_UNLOCK(_sc) mtx_unlock(&(_sc)->sc_mtx) 143 #define CDCE_LOCK_ASSERT(_sc, t) mtx_assert(&(_sc)->sc_mtx, t) 144 #endif /* _USB_IF_CDCEREG_H_ */ 145