1/*	$NetBSD: if_cdce.c,v 1.81 2022/03/03 05:56:28 riastradh Exp $ */
2
3/*
4 * Copyright (c) 1997, 1998, 1999, 2000-2003 Bill Paul <wpaul@windriver.com>
5 * Copyright (c) 2003 Craig Boston
6 * Copyright (c) 2004 Daniel Hartmeier
7 * All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 *    notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 *    notice, this list of conditions and the following disclaimer in the
16 *    documentation and/or other materials provided with the distribution.
17 * 3. All advertising materials mentioning features or use of this software
18 *    must display the following acknowledgement:
19 *	This product includes software developed by Bill Paul.
20 * 4. Neither the name of the author nor the names of any co-contributors
21 *    may be used to endorse or promote products derived from this software
22 *    without specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul, THE VOICES IN HIS HEAD OR
28 * THE CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
29 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
30 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
31 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
32 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
33 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
34 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 */
36
37/*
38 * USB Communication Device Class (Ethernet Networking Control Model)
39 * http://www.usb.org/developers/devclass_docs/usbcdc11.pdf
40 */
41
42#include <sys/cdefs.h>
43__KERNEL_RCSID(0, "$NetBSD: if_cdce.c,v 1.81 2022/03/03 05:56:28 riastradh Exp $");
44
45#include <sys/param.h>
46
47#include <dev/usb/usbnet.h>
48#include <dev/usb/usbcdc.h>
49
50#include <dev/usb/if_cdcereg.h>
51
52struct cdce_type {
53	struct usb_devno	 cdce_dev;
54	uint16_t		 cdce_flags;
55#define CDCE_ZAURUS	1
56#define CDCE_NO_UNION	2
57};
58
59static const struct cdce_type cdce_devs[] = {
60  {{ USB_VENDOR_ACERLABS, USB_PRODUCT_ACERLABS_M5632 }, CDCE_NO_UNION },
61  {{ USB_VENDOR_COMPAQ, USB_PRODUCT_COMPAQ_IPAQLINUX }, CDCE_NO_UNION },
62  {{ USB_VENDOR_GMATE, USB_PRODUCT_GMATE_YP3X00 }, CDCE_NO_UNION },
63  {{ USB_VENDOR_MOTOROLA2, USB_PRODUCT_MOTOROLA2_USBLAN }, CDCE_ZAURUS | CDCE_NO_UNION },
64  {{ USB_VENDOR_MOTOROLA2, USB_PRODUCT_MOTOROLA2_USBLAN2 }, CDCE_ZAURUS | CDCE_NO_UNION },
65  {{ USB_VENDOR_PROLIFIC, USB_PRODUCT_PROLIFIC_PL2501 }, CDCE_NO_UNION },
66  {{ USB_VENDOR_SHARP, USB_PRODUCT_SHARP_SL5500 }, CDCE_ZAURUS },
67  {{ USB_VENDOR_SHARP, USB_PRODUCT_SHARP_A300 }, CDCE_ZAURUS | CDCE_NO_UNION },
68  {{ USB_VENDOR_SHARP, USB_PRODUCT_SHARP_SL5600 }, CDCE_ZAURUS | CDCE_NO_UNION },
69  {{ USB_VENDOR_SHARP, USB_PRODUCT_SHARP_C700 }, CDCE_ZAURUS | CDCE_NO_UNION },
70  {{ USB_VENDOR_SHARP, USB_PRODUCT_SHARP_C750 }, CDCE_ZAURUS | CDCE_NO_UNION },
71};
72#define cdce_lookup(v, p) \
73	((const struct cdce_type *)usb_lookup(cdce_devs, v, p))
74
75static int	cdce_match(device_t, cfdata_t, void *);
76static void	cdce_attach(device_t, device_t, void *);
77
78CFATTACH_DECL_NEW(cdce, sizeof(struct usbnet), cdce_match, cdce_attach,
79    usbnet_detach, usbnet_activate);
80
81static void	cdce_uno_rx_loop(struct usbnet *, struct usbnet_chain *,
82				 uint32_t);
83static unsigned	cdce_uno_tx_prepare(struct usbnet *, struct mbuf *,
84				    struct usbnet_chain *);
85
86static const struct usbnet_ops cdce_ops = {
87	.uno_tx_prepare = cdce_uno_tx_prepare,
88	.uno_rx_loop = cdce_uno_rx_loop,
89};
90
91static int
92cdce_match(device_t parent, cfdata_t match, void *aux)
93{
94	struct usbif_attach_arg *uiaa = aux;
95
96	if (cdce_lookup(uiaa->uiaa_vendor, uiaa->uiaa_product) != NULL)
97		return UMATCH_VENDOR_PRODUCT;
98
99	if (uiaa->uiaa_class == UICLASS_CDC && uiaa->uiaa_subclass ==
100	    UISUBCLASS_ETHERNET_NETWORKING_CONTROL_MODEL)
101		return UMATCH_IFACECLASS_GENERIC;
102
103	return UMATCH_NONE;
104}
105
106static void
107cdce_attach(device_t parent, device_t self, void *aux)
108{
109	struct usbnet * const		 un = device_private(self);
110	struct usbif_attach_arg		*uiaa = aux;
111	char				*devinfop;
112	struct usbd_device	        *dev = uiaa->uiaa_device;
113	const struct cdce_type		*t;
114	usb_interface_descriptor_t	*id;
115	usb_endpoint_descriptor_t	*ed;
116	const usb_cdc_union_descriptor_t *ud;
117	usb_config_descriptor_t		*cd;
118	int				 data_ifcno;
119	int				 i, j, numalts;
120	const usb_cdc_ethernet_descriptor_t *ue;
121	char				 eaddr_str[USB_MAX_ENCODED_STRING_LEN];
122
123	aprint_naive("\n");
124	aprint_normal("\n");
125	devinfop = usbd_devinfo_alloc(dev, 0);
126	aprint_normal_dev(self, "%s\n", devinfop);
127	usbd_devinfo_free(devinfop);
128
129	un->un_dev = self;
130	un->un_udev = dev;
131	un->un_sc = un;
132	un->un_ops = &cdce_ops;
133	un->un_rx_xfer_flags = USBD_SHORT_XFER_OK;
134	un->un_tx_xfer_flags = USBD_FORCE_SHORT_XFER;
135	un->un_rx_list_cnt = CDCE_RX_LIST_CNT;
136	un->un_tx_list_cnt = CDCE_TX_LIST_CNT;
137	un->un_rx_bufsz = CDCE_BUFSZ;
138	un->un_tx_bufsz = CDCE_BUFSZ;
139
140	t = cdce_lookup(uiaa->uiaa_vendor, uiaa->uiaa_product);
141	if (t)
142		un->un_flags = t->cdce_flags;
143
144	if (un->un_flags & CDCE_NO_UNION)
145		un->un_iface = uiaa->uiaa_iface;
146	else {
147		ud = (const usb_cdc_union_descriptor_t *)usb_find_desc_if(un->un_udev,
148		    UDESC_CS_INTERFACE, UDESCSUB_CDC_UNION,
149		    usbd_get_interface_descriptor(uiaa->uiaa_iface));
150		if (ud == NULL) {
151			aprint_error_dev(self, "no union descriptor\n");
152			return;
153		}
154		data_ifcno = ud->bSlaveInterface[0];
155
156		for (i = 0; i < uiaa->uiaa_nifaces; i++) {
157			if (uiaa->uiaa_ifaces[i] != NULL) {
158				id = usbd_get_interface_descriptor(
159				    uiaa->uiaa_ifaces[i]);
160				if (id != NULL && id->bInterfaceNumber ==
161				    data_ifcno) {
162					un->un_iface = uiaa->uiaa_ifaces[i];
163					uiaa->uiaa_ifaces[i] = NULL;
164				}
165			}
166		}
167	}
168	if (un->un_iface == NULL) {
169		aprint_error_dev(self, "no data interface\n");
170		return;
171	}
172
173	/*
174	 * <quote>
175	 *  The Data Class interface of a networking device shall have a minimum
176	 *  of two interface settings. The first setting (the default interface
177	 *  setting) includes no endpoints and therefore no networking traffic is
178	 *  exchanged whenever the default interface setting is selected. One or
179	 *  more additional interface settings are used for normal operation, and
180	 *  therefore each includes a pair of endpoints (one IN, and one OUT) to
181	 *  exchange network traffic. Select an alternate interface setting to
182	 *  initialize the network aspects of the device and to enable the
183	 *  exchange of network traffic.
184	 * </quote>
185	 *
186	 * Some devices, most notably cable modems, include interface settings
187	 * that have no IN or OUT endpoint, therefore loop through the list of all
188	 * available interface settings looking for one with both IN and OUT
189	 * endpoints.
190	 */
191	id = usbd_get_interface_descriptor(un->un_iface);
192	cd = usbd_get_config_descriptor(un->un_udev);
193	numalts = usbd_get_no_alts(cd, id->bInterfaceNumber);
194
195	for (j = 0; j < numalts; j++) {
196		if (usbd_set_interface(un->un_iface, j)) {
197			aprint_error_dev(un->un_dev,
198					"setting alternate interface failed\n");
199			return;
200		}
201		/* Find endpoints. */
202		id = usbd_get_interface_descriptor(un->un_iface);
203		un->un_ed[USBNET_ENDPT_RX] = un->un_ed[USBNET_ENDPT_TX] = 0;
204		for (i = 0; i < id->bNumEndpoints; i++) {
205			ed = usbd_interface2endpoint_descriptor(un->un_iface, i);
206			if (!ed) {
207				aprint_error_dev(self,
208						"could not read endpoint descriptor\n");
209				return;
210			}
211			if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
212					UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
213				un->un_ed[USBNET_ENDPT_RX] = ed->bEndpointAddress;
214			} else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
215					UE_GET_XFERTYPE(ed->bmAttributes) == UE_BULK) {
216				un->un_ed[USBNET_ENDPT_TX] = ed->bEndpointAddress;
217			} else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
218					UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT) {
219				/* XXX: CDC spec defines an interrupt pipe, but it is not
220				 * needed for simple host-to-host applications. */
221			} else {
222				aprint_error_dev(self, "unexpected endpoint\n");
223			}
224		}
225		/* If we found something, try and use it... */
226		if (un->un_ed[USBNET_ENDPT_RX] != 0 && un->un_ed[USBNET_ENDPT_TX] != 0)
227			break;
228	}
229
230	if (un->un_ed[USBNET_ENDPT_RX] == 0) {
231		aprint_error_dev(self, "could not find data bulk in\n");
232		return;
233	}
234	if (un->un_ed[USBNET_ENDPT_TX] == 0) {
235		aprint_error_dev(self, "could not find data bulk out\n");
236		return;
237	}
238
239	ue = (const usb_cdc_ethernet_descriptor_t *)usb_find_desc_if(dev,
240	    UDESC_CS_INTERFACE, UDESCSUB_CDC_ENF,
241	    usbd_get_interface_descriptor(uiaa->uiaa_iface));
242	if (!ue || usbd_get_string(dev, ue->iMacAddress, eaddr_str) ||
243	    ether_aton_r(un->un_eaddr, sizeof(un->un_eaddr), eaddr_str)) {
244		aprint_normal_dev(self, "faking address\n");
245		un->un_eaddr[0] = 0x2a;
246		uint32_t ticks = getticks();
247		memcpy(&un->un_eaddr[1], &ticks, sizeof(ticks));
248		un->un_eaddr[5] = (uint8_t)(device_unit(un->un_dev));
249	}
250
251	usbnet_attach(un);
252	usbnet_attach_ifp(un, IFF_SIMPLEX | IFF_BROADCAST | IFF_MULTICAST,
253            0, NULL);
254}
255
256static void
257cdce_uno_rx_loop(struct usbnet * un, struct usbnet_chain *c, uint32_t total_len)
258{
259	struct ifnet		*ifp = usbnet_ifp(un);
260
261	/* Strip off CRC added by Zaurus, if present */
262	if (un->un_flags & CDCE_ZAURUS && total_len > 4)
263		total_len -= 4;
264
265	if (total_len < sizeof(struct ether_header)) {
266		if_statinc(ifp, if_ierrors);
267		return;
268	}
269
270	usbnet_enqueue(un, c->unc_buf, total_len, 0, 0, 0);
271}
272
273static unsigned
274cdce_uno_tx_prepare(struct usbnet *un, struct mbuf *m, struct usbnet_chain *c)
275{
276	/* Zaurus wants a 32-bit CRC appended to every frame */
277	uint32_t		 crc;
278	unsigned		 extra = 0;
279	unsigned		 length;
280
281	if (un->un_flags & CDCE_ZAURUS)
282		extra = sizeof(crc);
283
284	if ((unsigned)m->m_pkthdr.len > un->un_tx_bufsz - extra)
285		return 0;
286	length = m->m_pkthdr.len + extra;
287
288	m_copydata(m, 0, m->m_pkthdr.len, c->unc_buf);
289	if (un->un_flags & CDCE_ZAURUS) {
290		crc = htole32(~ether_crc32_le(c->unc_buf, m->m_pkthdr.len));
291		memcpy(c->unc_buf + m->m_pkthdr.len, &crc, sizeof(crc));
292	}
293
294	return length;
295}
296
297#ifdef _MODULE
298#include "ioconf.c"
299#endif
300
301USBNET_MODULE(cdce)
302