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 #define CDCE_BIT(x) (1 << (x))
41
42 #define CDCE_FRAMES_MAX 8 /* units */
43 #define CDCE_IND_SIZE_MAX 32 /* bytes */
44
45 #define CDCE_NCM_TX_MINLEN 512 /* bytes, must be power of two */
46 #define CDCE_NCM_TX_MAXLEN (16384 + 4) /* bytes, must be short terminated */
47 #define CDCE_NCM_TX_FRAMES_MAX 8 /* units */
48
49 #define CDCE_NCM_RX_MAXLEN (1UL << 14) /* bytes */
50 #define CDCE_NCM_RX_FRAMES_MAX 1 /* units */
51
52 #define CDCE_NCM_SUBFRAMES_MAX 32 /* units */
53
54 #define CDCE_NCM_ALIGN(rem,off,mod) \
55 ((uint32_t)(((uint32_t)(rem)) - \
56 ((uint32_t)((-(uint32_t)(off)) & (-(uint32_t)(mod))))))
57
58 #ifndef CDCE_HAVE_NCM
59 #define CDCE_HAVE_NCM 1
60 #endif
61
62 enum {
63 CDCE_BULK_RX,
64 CDCE_BULK_TX,
65 CDCE_INTR_RX,
66 CDCE_INTR_TX,
67 CDCE_N_TRANSFER,
68 };
69
70 struct cdce_ncm {
71 struct usb_ncm16_hdr hdr;
72 struct usb_ncm16_dpt dpt;
73 struct usb_ncm16_dp dp[CDCE_NCM_SUBFRAMES_MAX];
74 uint32_t rx_max;
75 uint32_t tx_max;
76 uint16_t tx_remainder;
77 uint16_t tx_modulus;
78 uint16_t tx_struct_align;
79 uint16_t tx_seq;
80 uint16_t tx_nframe;
81 };
82
83 struct cdce_softc {
84 struct usb_ether sc_ue;
85 struct mtx sc_mtx;
86 #if CDCE_HAVE_NCM
87 struct cdce_ncm sc_ncm;
88 #endif
89 struct usb_xfer *sc_xfer[CDCE_N_TRANSFER];
90 struct mbuf *sc_rx_buf[CDCE_FRAMES_MAX];
91 struct mbuf *sc_tx_buf[CDCE_FRAMES_MAX];
92
93 struct ifmedia sc_media;
94
95 int sc_flags;
96 #define CDCE_FLAG_ZAURUS 0x0001
97 #define CDCE_FLAG_NO_UNION 0x0002
98 #define CDCE_FLAG_RX_DATA 0x0010
99 #define CDCE_FLAG_VLAN 0x0020
100
101 uint8_t sc_eaddr_str_index;
102 uint8_t sc_ifaces_index[2];
103 uint8_t sc_notify_state;
104 #define CDCE_NOTIFY_NETWORK_CONNECTION 0
105 #define CDCE_NOTIFY_SPEED_CHANGE 1
106 #define CDCE_NOTIFY_DONE 2
107 };
108
109 /*
110 * Taken from USB CDC Subclass Specification for Ethernet Devices v1.2,
111 * section 6.2.4.
112 */
113
114 #define CDC_SET_ETHERNET_PACKET_FILTER 0x43 /* Command code. */
115
116 #define CDC_PACKET_TYPE_PROMISC CDCE_BIT(0)
117 #define CDC_PACKET_TYPE_ALL_MULTICAST CDCE_BIT(1) /* Allmulti. */
118 #define CDC_PACKET_TYPE_DIRECTED CDCE_BIT(2) /* Filter unicast by mac. */
119 #define CDC_PACKET_TYPE_BROADCAST CDCE_BIT(3)
120 #define CDC_PACKET_TYPE_MULTICAST CDCE_BIT(4) /* Multicast filtering, not supported. */
121
122 #define CDCE_LOCK(_sc) mtx_lock(&(_sc)->sc_mtx)
123 #define CDCE_UNLOCK(_sc) mtx_unlock(&(_sc)->sc_mtx)
124 #define CDCE_LOCK_ASSERT(_sc, t) mtx_assert(&(_sc)->sc_mtx, t)
125 #endif /* _USB_IF_CDCEREG_H_ */
Cache object: f3f9c3b37b32a37494208470f6575b6e
|