2 * Copyright (c) 2011 The Chromium OS Authors.
4 * SPDX-License-Identifier: GPL-2.0+
11 #include <dm/device-internal.h>
13 #include "usb_ether.h"
17 #define USB_BULK_RECV_TIMEOUT 500
19 int usb_ether_register(struct udevice *dev, struct ueth_data *ueth, int rxsize)
21 struct usb_device *udev = dev_get_parentdata(dev);
22 struct usb_interface_descriptor *iface_desc;
23 bool ep_in_found = false, ep_out_found = false;
24 struct usb_interface *iface;
25 const int ifnum = 0; /* Always use interface 0 */
28 iface = &udev->config.if_desc[ifnum];
29 iface_desc = &udev->config.if_desc[ifnum].desc;
31 /* Initialize the ueth_data structure with some useful info */
33 ueth->subclass = iface_desc->bInterfaceSubClass;
34 ueth->protocol = iface_desc->bInterfaceProtocol;
37 * We are expecting a minimum of 3 endpoints - in, out (bulk), and int.
38 * We will ignore any others.
40 for (i = 0; i < iface_desc->bNumEndpoints; i++) {
41 int ep_addr = iface->ep_desc[i].bEndpointAddress;
43 /* is it an BULK endpoint? */
44 if ((iface->ep_desc[i].bmAttributes &
45 USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_BULK) {
46 if (ep_addr & USB_DIR_IN && !ep_in_found) {
47 ueth->ep_in = ep_addr &
48 USB_ENDPOINT_NUMBER_MASK;
50 } else if (!(ep_addr & USB_DIR_IN) && !ep_out_found) {
51 ueth->ep_out = ep_addr &
52 USB_ENDPOINT_NUMBER_MASK;
57 /* is it an interrupt endpoint? */
58 if ((iface->ep_desc[i].bmAttributes &
59 USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT) {
60 ueth->ep_int = iface->ep_desc[i].bEndpointAddress &
61 USB_ENDPOINT_NUMBER_MASK;
62 ueth->irqinterval = iface->ep_desc[i].bInterval;
65 debug("Endpoints In %d Out %d Int %d\n", ueth->ep_in, ueth->ep_out,
68 /* Do some basic sanity checks, and bail if we find a problem */
69 if (!ueth->ep_in || !ueth->ep_out || !ueth->ep_int) {
70 debug("%s: %s: Cannot find endpoints\n", __func__, dev->name);
74 ueth->rxsize = rxsize;
75 ueth->rxbuf = memalign(rxsize, ARCH_DMA_MINALIGN);
79 ret = usb_set_interface(udev, iface_desc->bInterfaceNumber, ifnum);
81 debug("%s: %s: Cannot set interface: %d\n", __func__, dev->name,
85 ueth->pusb_dev = udev;
90 int usb_ether_deregister(struct ueth_data *ueth)
95 int usb_ether_receive(struct ueth_data *ueth, int rxsize)
100 if (rxsize > ueth->rxsize)
102 ret = usb_bulk_msg(ueth->pusb_dev,
103 usb_rcvbulkpipe(ueth->pusb_dev, ueth->ep_in),
104 ueth->rxbuf, rxsize, &actual_len,
105 USB_BULK_RECV_TIMEOUT);
106 debug("Rx: len = %u, actual = %u, err = %d\n", rxsize, actual_len, ret);
108 printf("Rx: failed to receive: %d\n", ret);
111 if (actual_len > rxsize) {
112 debug("Rx: received too many bytes %d\n", actual_len);
115 ueth->rxlen = actual_len;
118 return actual_len ? 0 : -EAGAIN;
121 void usb_ether_advance_rxbuf(struct ueth_data *ueth, int num_bytes)
123 ueth->rxptr += num_bytes;
124 if (num_bytes < 0 || ueth->rxptr >= ueth->rxlen)
128 int usb_ether_get_rx_bytes(struct ueth_data *ueth, uint8_t **ptrp)
133 *ptrp = &ueth->rxbuf[ueth->rxptr];
135 return ueth->rxlen - ueth->rxptr;
140 typedef void (*usb_eth_before_probe)(void);
141 typedef int (*usb_eth_probe)(struct usb_device *dev, unsigned int ifnum,
142 struct ueth_data *ss);
143 typedef int (*usb_eth_get_info)(struct usb_device *dev, struct ueth_data *ss,
144 struct eth_device *dev_desc);
146 struct usb_eth_prob_dev {
147 usb_eth_before_probe before_probe; /* optional */
149 usb_eth_get_info get_info;
152 /* driver functions go here, each bracketed by #ifdef CONFIG_USB_ETHER_xxx */
153 static const struct usb_eth_prob_dev prob_dev[] = {
154 #ifdef CONFIG_USB_ETHER_ASIX
156 .before_probe = asix_eth_before_probe,
157 .probe = asix_eth_probe,
158 .get_info = asix_eth_get_info,
161 #ifdef CONFIG_USB_ETHER_ASIX88179
163 .before_probe = ax88179_eth_before_probe,
164 .probe = ax88179_eth_probe,
165 .get_info = ax88179_eth_get_info,
168 #ifdef CONFIG_USB_ETHER_MCS7830
170 .before_probe = mcs7830_eth_before_probe,
171 .probe = mcs7830_eth_probe,
172 .get_info = mcs7830_eth_get_info,
175 #ifdef CONFIG_USB_ETHER_SMSC95XX
177 .before_probe = smsc95xx_eth_before_probe,
178 .probe = smsc95xx_eth_probe,
179 .get_info = smsc95xx_eth_get_info,
185 static int usb_max_eth_dev; /* number of highest available usb eth device */
186 static struct ueth_data usb_eth[USB_MAX_ETH_DEV];
188 /*******************************************************************************
189 * tell if current ethernet device is a usb dongle
191 int is_eth_dev_on_usb_host(void)
194 struct eth_device *dev = eth_get_dev();
197 for (i = 0; i < usb_max_eth_dev; i++)
198 if (&usb_eth[i].eth_dev == dev)
205 * Given a USB device, ask each driver if it can support it, and attach it
206 * to the first driver that says 'yes'
208 static void probe_valid_drivers(struct usb_device *dev)
210 struct eth_device *eth;
213 for (j = 0; prob_dev[j].probe && prob_dev[j].get_info; j++) {
214 if (!prob_dev[j].probe(dev, 0, &usb_eth[usb_max_eth_dev]))
217 * ok, it is a supported eth device. Get info and fill it in
219 eth = &usb_eth[usb_max_eth_dev].eth_dev;
220 if (prob_dev[j].get_info(dev,
221 &usb_eth[usb_max_eth_dev],
223 /* found proper driver */
224 /* register with networking stack */
228 * usb_max_eth_dev must be incremented prior to this
229 * call since eth_current_changed (internally called)
233 if (eth_write_hwaddr(eth, "usbeth",
234 usb_max_eth_dev - 1))
235 puts("Warning: failed to set MAC address\n");
241 /*******************************************************************************
242 * scan the usb and reports device info
243 * to the user if mode = 1
244 * returns current device or -1 if no
246 int usb_host_eth_scan(int mode)
251 printf(" scanning usb for ethernet devices... ");
253 old_async = usb_disable_asynch(1); /* asynch transfer not allowed */
255 /* unregister a previously detected device */
256 for (i = 0; i < usb_max_eth_dev; i++)
257 eth_unregister(&usb_eth[i].eth_dev);
259 memset(usb_eth, 0, sizeof(usb_eth));
261 for (i = 0; prob_dev[i].probe; i++) {
262 if (prob_dev[i].before_probe)
263 prob_dev[i].before_probe();
269 * TODO: We should add U_BOOT_USB_DEVICE() declarations to each USB
270 * Ethernet driver and then most of this file can be removed.
276 ret = uclass_get(UCLASS_USB, &uc);
279 uclass_foreach_dev(bus, uc) {
280 for (i = 0; i < USB_MAX_DEVICE; i++) {
281 struct usb_device *dev;
283 dev = usb_get_dev_index(bus, i); /* get device */
284 debug("i=%d, %s\n", i, dev ? dev->dev->name : "(done)");
286 break; /* no more devices available */
289 * find valid usb_ether driver for this device,
292 probe_valid_drivers(dev);
295 if (usb_max_eth_dev == USB_MAX_ETH_DEV)
300 for (i = 0; i < USB_MAX_DEVICE; i++) {
301 struct usb_device *dev;
303 dev = usb_get_dev_index(i); /* get device */
306 break; /* no more devices available */
308 /* find valid usb_ether driver for this device, if any */
309 probe_valid_drivers(dev);
312 if (usb_max_eth_dev == USB_MAX_ETH_DEV)
316 if (usb_max_eth_dev == USB_MAX_ETH_DEV) {
317 printf("max USB Ethernet Device reached: %d stopping\n",
320 usb_disable_asynch(old_async); /* restore asynch value */
321 printf("%d Ethernet Device(s) found\n", usb_max_eth_dev);
322 if (usb_max_eth_dev > 0)