iPXE
ncm.c
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2014 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17  * 02110-1301, USA.
18  *
19  * You can also choose to distribute this program under the terms of
20  * the Unmodified Binary Distribution Licence (as given in the file
21  * COPYING.UBDL), provided that you have satisfied its requirements.
22  */
23 
24 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
25 
26 #include <string.h>
27 #include <errno.h>
28 #include <ipxe/netdevice.h>
29 #include <ipxe/ethernet.h>
30 #include <ipxe/if_ether.h>
31 #include <ipxe/profile.h>
32 #include <ipxe/usb.h>
33 #include <ipxe/usbnet.h>
34 #include "ecm.h"
35 #include "ncm.h"
36 
37 /** @file
38  *
39  * CDC-NCM USB Ethernet driver
40  *
41  */
42 
43 /** Interrupt completion profiler */
44 static struct profiler ncm_intr_profiler __profiler =
45  { .name = "ncm.intr" };
46 
47 /** Bulk IN completion profiler */
48 static struct profiler ncm_in_profiler __profiler =
49  { .name = "ncm.in" };
50 
51 /** Bulk IN per-datagram profiler */
52 static struct profiler ncm_in_datagram_profiler __profiler =
53  { .name = "ncm.in_dgram" };
54 
55 /** Bulk OUT profiler */
56 static struct profiler ncm_out_profiler __profiler =
57  { .name = "ncm.out" };
58 
59 /******************************************************************************
60  *
61  * CDC-NCM communications interface
62  *
63  ******************************************************************************
64  */
65 
66 /**
67  * Complete interrupt transfer
68  *
69  * @v ep USB endpoint
70  * @v iobuf I/O buffer
71  * @v rc Completion status code
72  */
73 static void ncm_intr_complete ( struct usb_endpoint *ep,
74  struct io_buffer *iobuf, int rc ) {
75  struct ncm_device *ncm = container_of ( ep, struct ncm_device,
76  usbnet.intr );
77  struct net_device *netdev = ncm->netdev;
78  struct usb_setup_packet *message;
79  size_t len = iob_len ( iobuf );
80 
81  /* Profile completions */
82  profile_start ( &ncm_intr_profiler );
83 
84  /* Ignore packets cancelled when the endpoint closes */
85  if ( ! ep->open )
86  goto ignore;
87 
88  /* Ignore packets with errors */
89  if ( rc != 0 ) {
90  DBGC ( ncm, "NCM %p interrupt failed: %s\n",
91  ncm, strerror ( rc ) );
92  DBGC_HDA ( ncm, 0, iobuf->data, iob_len ( iobuf ) );
93  goto error;
94  }
95 
96  /* Extract message header */
97  if ( len < sizeof ( *message ) ) {
98  DBGC ( ncm, "NCM %p underlength interrupt:\n", ncm );
99  DBGC_HDA ( ncm, 0, iobuf->data, iob_len ( iobuf ) );
100  rc = -EINVAL;
101  goto error;
102  }
103  message = iobuf->data;
104 
105  /* Parse message header */
106  switch ( message->request ) {
107 
109  if ( message->value ) {
110  DBGC ( ncm, "NCM %p link up\n", ncm );
112  } else {
113  DBGC ( ncm, "NCM %p link down\n", ncm );
115  }
116  break;
117 
119  /* Ignore */
120  break;
121 
122  default:
123  DBGC ( ncm, "NCM %p unrecognised interrupt:\n", ncm );
124  DBGC_HDA ( ncm, 0, iobuf->data, iob_len ( iobuf ) );
125  goto error;
126  }
127 
128  /* Free I/O buffer */
129  free_iob ( iobuf );
130  profile_stop ( &ncm_intr_profiler );
131 
132  return;
133 
134  error:
135  netdev_rx_err ( netdev, iob_disown ( iobuf ), rc );
136  ignore:
137  free_iob ( iobuf );
138  return;
139 }
140 
141 /** Interrupt endpoint operations */
144 };
145 
146 /******************************************************************************
147  *
148  * CDC-NCM data interface
149  *
150  ******************************************************************************
151  */
152 
153 /**
154  * Prefill bulk IN endpoint
155  *
156  * @v ncm CDC-NCM device
157  * @ret rc Return status code
158  */
159 static int ncm_in_prefill ( struct ncm_device *ncm ) {
160  struct usb_bus *bus = ncm->bus;
161  size_t mtu;
162  unsigned int count;
163  int rc;
164 
165  /* Some devices have a very small number of internal buffers,
166  * and rely on being able to pack multiple packets into each
167  * buffer. We therefore want to use large buffers if
168  * possible. However, large allocations have a reasonable
169  * chance of failure, especially if this is not the first or
170  * only device to be opened.
171  *
172  * We therefore attempt to find a usable buffer size, starting
173  * large and working downwards until allocation succeeds.
174  * Smaller buffers will still work, albeit with a higher
175  * chance of packet loss and so lower overall throughput.
176  */
177  for ( mtu = ncm->mtu ; mtu >= NCM_MIN_NTB_INPUT_SIZE ; mtu >>= 1 ) {
178 
179  /* Attempt allocation at this MTU */
180  if ( mtu > NCM_MAX_NTB_INPUT_SIZE )
181  continue;
182  if ( mtu > bus->mtu )
183  continue;
184  count = ( NCM_IN_MIN_SIZE / mtu );
185  if ( count < NCM_IN_MIN_COUNT )
187  if ( ( count * mtu ) > NCM_IN_MAX_SIZE )
188  continue;
189  usb_refill_init ( &ncm->usbnet.in, 0, mtu, count );
190  if ( ( rc = usb_prefill ( &ncm->usbnet.in ) ) != 0 ) {
191  DBGC ( ncm, "NCM %p could not prefill %dx %zd-byte "
192  "buffers for bulk IN\n", ncm, count, mtu );
193  continue;
194  }
195 
196  DBGC ( ncm, "NCM %p using %dx %zd-byte buffers for bulk IN\n",
197  ncm, count, mtu );
198  return 0;
199  }
200 
201  DBGC ( ncm, "NCM %p could not prefill bulk IN endpoint\n", ncm );
202  return -ENOMEM;
203 }
204 
205 /**
206  * Complete bulk IN transfer
207  *
208  * @v ep USB endpoint
209  * @v iobuf I/O buffer
210  * @v rc Completion status code
211  */
212 static void ncm_in_complete ( struct usb_endpoint *ep, struct io_buffer *iobuf,
213  int rc ) {
214  struct ncm_device *ncm = container_of ( ep, struct ncm_device,
215  usbnet.in );
216  struct net_device *netdev = ncm->netdev;
217  struct ncm_transfer_header *nth;
218  struct ncm_datagram_pointer *ndp;
219  struct ncm_datagram_descriptor *desc;
220  struct io_buffer *pkt;
221  unsigned int remaining;
222  size_t ndp_offset;
223  size_t ndp_len;
224  size_t pkt_offset;
225  size_t pkt_len;
226  size_t headroom;
227  size_t len;
228 
229  /* Profile overall bulk IN completion */
230  profile_start ( &ncm_in_profiler );
231 
232  /* Ignore packets cancelled when the endpoint closes */
233  if ( ! ep->open )
234  goto ignore;
235 
236  /* Record USB errors against the network device */
237  if ( rc != 0 ) {
238  DBGC ( ncm, "NCM %p bulk IN failed: %s\n",
239  ncm, strerror ( rc ) );
240  goto error;
241  }
242 
243  /* Locate transfer header */
244  len = iob_len ( iobuf );
245  if ( sizeof ( *nth ) > len ) {
246  DBGC ( ncm, "NCM %p packet too short for NTH:\n", ncm );
247  rc = -EINVAL;
248  goto error;
249  }
250  nth = iobuf->data;
251 
252  /* Locate datagram pointer */
253  ndp_offset = le16_to_cpu ( nth->offset );
254  if ( ( ndp_offset + sizeof ( *ndp ) ) > len ) {
255  DBGC ( ncm, "NCM %p packet too short for NDP:\n", ncm );
256  rc = -EINVAL;
257  goto error;
258  }
259  ndp = ( iobuf->data + ndp_offset );
260  ndp_len = le16_to_cpu ( ndp->header_len );
261  if ( ndp_len < offsetof ( typeof ( *ndp ), desc ) ) {
262  DBGC ( ncm, "NCM %p NDP header length too short:\n", ncm );
263  rc = -EINVAL;
264  goto error;
265  }
266  if ( ( ndp_offset + ndp_len ) > len ) {
267  DBGC ( ncm, "NCM %p packet too short for NDP:\n", ncm );
268  rc = -EINVAL;
269  goto error;
270  }
271 
272  /* Process datagrams */
273  remaining = ( ( ndp_len - offsetof ( typeof ( *ndp ), desc ) ) /
274  sizeof ( ndp->desc[0] ) );
275  for ( desc = ndp->desc ; remaining && desc->offset ; remaining-- ) {
276 
277  /* Profile individual datagrams */
278  profile_start ( &ncm_in_datagram_profiler );
279 
280  /* Locate datagram */
281  pkt_offset = le16_to_cpu ( desc->offset );
282  pkt_len = le16_to_cpu ( desc->len );
283  if ( pkt_len < ETH_HLEN ) {
284  DBGC ( ncm, "NCM %p underlength datagram:\n", ncm );
285  rc = -EINVAL;
286  goto error;
287  }
288  if ( ( pkt_offset + pkt_len ) > len ) {
289  DBGC ( ncm, "NCM %p datagram exceeds packet:\n", ncm );
290  rc = -EINVAL;
291  goto error;
292  }
293 
294  /* Move to next descriptor */
295  desc++;
296 
297  /* Copy data to a new I/O buffer. Our USB buffers may
298  * be very large and so we choose to recycle the
299  * buffers directly rather than attempt reallocation
300  * while the device is running. We therefore copy the
301  * data to a new I/O buffer even if this is the only
302  * (or last) packet within the buffer.
303  *
304  * We reserve enough space at the start of each buffer
305  * to allow for our own transmission header, to
306  * support protocols such as ARP which may modify the
307  * received packet and reuse the same I/O buffer for
308  * transmission.
309  */
310  headroom = ( sizeof ( struct ncm_ntb_header ) + ncm->padding );
311  pkt = alloc_iob ( headroom + pkt_len );
312  if ( ! pkt ) {
313  /* Record error and continue */
315  continue;
316  }
317  iob_reserve ( pkt, headroom );
318  memcpy ( iob_put ( pkt, pkt_len ),
319  ( iobuf->data + pkt_offset ), pkt_len );
320 
321  /* Strip CRC, if present */
323  iob_unput ( pkt, 4 /* CRC32 */ );
324 
325  /* Hand off to network stack */
326  netdev_rx ( netdev, pkt );
327  profile_stop ( &ncm_in_datagram_profiler );
328  }
329 
330  /* Recycle I/O buffer */
331  usb_recycle ( &ncm->usbnet.in, iobuf );
332  profile_stop ( &ncm_in_profiler );
333 
334  return;
335 
336  error:
337  /* Record error against network device */
338  DBGC_HDA ( ncm, 0, iobuf->data, iob_len ( iobuf ) );
339  netdev_rx_err ( netdev, NULL, rc );
340  ignore:
341  usb_recycle ( &ncm->usbnet.in, iobuf );
342 }
343 
344 /** Bulk IN endpoint operations */
347 };
348 
349 /**
350  * Transmit packet
351  *
352  * @v ncm CDC-NCM device
353  * @v iobuf I/O buffer
354  * @ret rc Return status code
355  */
356 static int ncm_out_transmit ( struct ncm_device *ncm,
357  struct io_buffer *iobuf ) {
358  struct ncm_ntb_header *header;
359  size_t len = iob_len ( iobuf );
360  size_t header_len = ( sizeof ( *header ) + ncm->padding );
361  int rc;
362 
363  /* Profile transmissions */
364  profile_start ( &ncm_out_profiler );
365 
366  /* Prepend header */
367  if ( ( rc = iob_ensure_headroom ( iobuf, header_len ) ) != 0 )
368  return rc;
369  header = iob_push ( iobuf, header_len );
370 
371  /* Populate header */
373  header->nth.header_len = cpu_to_le16 ( sizeof ( header->nth ) );
374  header->nth.sequence = cpu_to_le16 ( ncm->sequence );
375  header->nth.len = cpu_to_le16 ( iob_len ( iobuf ) );
376  header->nth.offset =
377  cpu_to_le16 ( offsetof ( typeof ( *header ), ndp ) );
379  header->ndp.header_len = cpu_to_le16 ( sizeof ( header->ndp ) +
380  sizeof ( header->desc ) );
381  header->ndp.offset = cpu_to_le16 ( 0 );
382  header->desc[0].offset = cpu_to_le16 ( header_len );
383  header->desc[0].len = cpu_to_le16 ( len );
384  memset ( &header->desc[1], 0, sizeof ( header->desc[1] ) );
385 
386  /* Enqueue I/O buffer */
387  if ( ( rc = usb_stream ( &ncm->usbnet.out, iobuf, 0 ) ) != 0 )
388  return rc;
389 
390  /* Increment sequence number */
391  ncm->sequence++;
392 
393  profile_stop ( &ncm_out_profiler );
394  return 0;
395 }
396 
397 /**
398  * Complete bulk OUT transfer
399  *
400  * @v ep USB endpoint
401  * @v iobuf I/O buffer
402  * @v rc Completion status code
403  */
404 static void ncm_out_complete ( struct usb_endpoint *ep, struct io_buffer *iobuf,
405  int rc ) {
406  struct ncm_device *ncm = container_of ( ep, struct ncm_device,
407  usbnet.out );
408  struct net_device *netdev = ncm->netdev;
409 
410  /* Report TX completion */
411  netdev_tx_complete_err ( netdev, iobuf, rc );
412 }
413 
414 /** Bulk OUT endpoint operations */
417 };
418 
419 /******************************************************************************
420  *
421  * Network device interface
422  *
423  ******************************************************************************
424  */
425 
426 /**
427  * Open network device
428  *
429  * @v netdev Network device
430  * @ret rc Return status code
431  */
432 static int ncm_open ( struct net_device *netdev ) {
433  struct ncm_device *ncm = netdev->priv;
434  struct usb_device *usb = ncm->usb;
436  int rc;
437 
438  /* Reset sequence number */
439  ncm->sequence = 0;
440 
441  /* Prefill I/O buffers */
442  if ( ( rc = ncm_in_prefill ( ncm ) ) != 0 )
443  goto err_prefill;
444 
445  /* Set maximum input size */
446  memset ( &size, 0, sizeof ( size ) );
447  size.mtu = cpu_to_le32 ( ncm->usbnet.in.len );
448  if ( ( rc = usb_control ( usb, NCM_SET_NTB_INPUT_SIZE, 0,
449  ncm->usbnet.comms, &size,
450  sizeof ( size ) ) ) != 0 ) {
451  DBGC ( ncm, "NCM %p could not set input size to %zd: %s\n",
452  ncm, ncm->usbnet.in.len, strerror ( rc ) );
453  goto err_set_ntb_input_size;
454  }
455 
456  /* Set MAC address */
457  if ( ( rc = usb_control ( usb, NCM_SET_NET_ADDRESS, 0,
458  ncm->usbnet.comms, netdev->ll_addr,
459  netdev->ll_protocol->ll_addr_len ) ) != 0 ) {
460  DBGC ( ncm, "NCM %p could not set MAC address: %s\n",
461  ncm, strerror ( rc ) );
462  /* Ignore error and continue */
463  }
464 
465  /* Open USB network device */
466  if ( ( rc = usbnet_open ( &ncm->usbnet ) ) != 0 ) {
467  DBGC ( ncm, "NCM %p could not open: %s\n",
468  ncm, strerror ( rc ) );
469  goto err_open;
470  }
471 
472  return 0;
473 
474  usbnet_close ( &ncm->usbnet );
475  err_open:
476  err_set_ntb_input_size:
477  usb_flush ( &ncm->usbnet.in );
478  err_prefill:
479  return rc;
480 }
481 
482 /**
483  * Close network device
484  *
485  * @v netdev Network device
486  */
487 static void ncm_close ( struct net_device *netdev ) {
488  struct ncm_device *ncm = netdev->priv;
489 
490  /* Close USB network device */
491  usbnet_close ( &ncm->usbnet );
492 }
493 
494 /**
495  * Transmit packet
496  *
497  * @v netdev Network device
498  * @v iobuf I/O buffer
499  * @ret rc Return status code
500  */
501 static int ncm_transmit ( struct net_device *netdev,
502  struct io_buffer *iobuf ) {
503  struct ncm_device *ncm = netdev->priv;
504  int rc;
505 
506  /* Transmit packet */
507  if ( ( rc = ncm_out_transmit ( ncm, iobuf ) ) != 0 )
508  return rc;
509 
510  return 0;
511 }
512 
513 /**
514  * Poll for completed and received packets
515  *
516  * @v netdev Network device
517  */
518 static void ncm_poll ( struct net_device *netdev ) {
519  struct ncm_device *ncm = netdev->priv;
520  int rc;
521 
522  /* Poll USB bus */
523  usb_poll ( ncm->bus );
524 
525  /* Refill endpoints */
526  if ( ( rc = usbnet_refill ( &ncm->usbnet ) ) != 0 )
527  netdev_rx_err ( netdev, NULL, rc );
528 
529 }
530 
531 /** CDC-NCM network device operations */
533  .open = ncm_open,
534  .close = ncm_close,
535  .transmit = ncm_transmit,
536  .poll = ncm_poll,
537 };
538 
539 /******************************************************************************
540  *
541  * USB interface
542  *
543  ******************************************************************************
544  */
545 
546 /**
547  * Probe device
548  *
549  * @v func USB function
550  * @v config Configuration descriptor
551  * @ret rc Return status code
552  */
553 static int ncm_probe ( struct usb_function *func,
554  struct usb_configuration_descriptor *config ) {
555  struct usb_device *usb = func->usb;
556  struct net_device *netdev;
557  struct ncm_device *ncm;
558  struct usb_interface_descriptor *comms;
559  struct ecm_ethernet_descriptor *ethernet;
560  struct ncm_ntb_parameters params;
561  int rc;
562 
563  /* Allocate and initialise structure */
564  netdev = alloc_etherdev ( sizeof ( *ncm ) );
565  if ( ! netdev ) {
566  rc = -ENOMEM;
567  goto err_alloc;
568  }
570  netdev->dev = &func->dev;
571  ncm = netdev->priv;
572  memset ( ncm, 0, sizeof ( *ncm ) );
573  ncm->usb = usb;
574  ncm->bus = usb->port->hub->bus;
575  ncm->netdev = netdev;
576  usbnet_init ( &ncm->usbnet, func, &ncm_intr_operations,
578  usb_refill_init ( &ncm->usbnet.intr, 0, 0, NCM_INTR_COUNT );
579  DBGC ( ncm, "NCM %p on %s\n", ncm, func->name );
580 
581  /* Describe USB network device */
582  if ( ( rc = usbnet_describe ( &ncm->usbnet, config ) ) != 0 ) {
583  DBGC ( ncm, "NCM %p could not describe: %s\n",
584  ncm, strerror ( rc ) );
585  goto err_describe;
586  }
587 
588  /* Locate Ethernet descriptor */
589  comms = usb_interface_descriptor ( config, ncm->usbnet.comms, 0 );
590  assert ( comms != NULL );
591  ethernet = ecm_ethernet_descriptor ( config, comms );
592  if ( ! ethernet ) {
593  DBGC ( ncm, "NCM %p has no Ethernet descriptor\n", ncm );
594  rc = -EINVAL;
595  goto err_ethernet;
596  }
597 
598  /* Fetch MAC address */
599  if ( ( rc = ecm_fetch_mac ( usb, ethernet, netdev->hw_addr ) ) != 0 ) {
600  DBGC ( ncm, "NCM %p could not fetch MAC address: %s\n",
601  ncm, strerror ( rc ) );
602  goto err_fetch_mac;
603  }
604 
605  /* Get NTB parameters */
606  if ( ( rc = usb_control ( usb, NCM_GET_NTB_PARAMETERS, 0,
607  ncm->usbnet.comms, &params,
608  sizeof ( params ) ) ) != 0 ) {
609  DBGC ( ncm, "NCM %p could not get NTB parameters: %s\n",
610  ncm, strerror ( rc ) );
611  goto err_ntb_parameters;
612  }
613 
614  /* Get maximum supported input size */
615  ncm->mtu = le32_to_cpu ( params.in.mtu );
616  DBGC2 ( ncm, "NCM %p maximum IN size is %zd bytes\n", ncm, ncm->mtu );
617 
618  /* Calculate transmit padding */
619  ncm->padding = ( ( le16_to_cpu ( params.out.remainder ) -
620  sizeof ( struct ncm_ntb_header ) - ETH_HLEN ) &
621  ( le16_to_cpu ( params.out.divisor ) - 1 ) );
622  DBGC2 ( ncm, "NCM %p using %zd-byte transmit padding\n",
623  ncm, ncm->padding );
624  assert ( ( ( sizeof ( struct ncm_ntb_header ) + ncm->padding +
625  ETH_HLEN ) % le16_to_cpu ( params.out.divisor ) ) ==
626  le16_to_cpu ( params.out.remainder ) );
627 
628  /* Register network device */
629  if ( ( rc = register_netdev ( netdev ) ) != 0 )
630  goto err_register;
631 
632  usb_func_set_drvdata ( func, ncm );
633  return 0;
634 
636  err_register:
637  err_ntb_parameters:
638  err_fetch_mac:
639  err_ethernet:
640  err_describe:
642  netdev_put ( netdev );
643  err_alloc:
644  return rc;
645 }
646 
647 /**
648  * Remove device
649  *
650  * @v func USB function
651  */
652 static void ncm_remove ( struct usb_function *func ) {
653  struct ncm_device *ncm = usb_func_get_drvdata ( func );
654  struct net_device *netdev = ncm->netdev;
655 
658  netdev_put ( netdev );
659 }
660 
661 /** CDC-NCM device IDs */
662 static struct usb_device_id ncm_ids[] = {
663  {
664  .name = "cdc-ncm",
665  .vendor = USB_ANY_ID,
666  .product = USB_ANY_ID,
667  },
668 };
669 
670 /** CDC-NCM driver */
671 struct usb_driver ncm_driver __usb_driver = {
672  .ids = ncm_ids,
673  .id_count = ( sizeof ( ncm_ids ) / sizeof ( ncm_ids[0] ) ),
675  .score = USB_SCORE_NORMAL,
676  .probe = ncm_probe,
677  .remove = ncm_remove,
678 };
A USB driver.
Definition: usb.h:1363
#define EINVAL
Invalid argument.
Definition: errno.h:428
#define NCM_IN_MIN_SIZE
Bulk IN ring minimum total buffer size.
Definition: ncm.h:164
struct arbelprm_rc_send_wqe rc
Definition: arbel.h:14
A USB device ID.
Definition: usb.h:1317
#define iob_put(iobuf, len)
Definition: iobuf.h:116
void(* complete)(struct usb_endpoint *ep, struct io_buffer *iobuf, int rc)
Complete transfer.
Definition: usb.h:481
void netdev_rx_err(struct net_device *netdev, struct io_buffer *iobuf, int rc)
Discard received packet.
Definition: netdevice.c:501
An Ethernet Functional Descriptor.
Definition: ecm.h:39
unsigned int comms
Communications interface.
Definition: usbnet.h:20
static void * usb_func_get_drvdata(struct usb_function *func)
Get USB function driver private data.
Definition: usb.h:701
uint8_t ll_addr_len
Link-layer address length.
Definition: netdevice.h:198
CDC-ECM USB Ethernet driver.
const char * name
Name.
Definition: usb.h:659
size_t mtu
Maximum supported NTB input size.
Definition: ncm.h:147
static int ncm_probe(struct usb_function *func, struct usb_configuration_descriptor *config)
Probe device.
Definition: ncm.c:553
#define le32_to_cpu(value)
Definition: byteswap.h:113
int(* open)(struct net_device *netdev)
Open network device.
Definition: netdevice.h:222
const char * name
Name.
Definition: usb.h:1319
FILE_LICENCE(GPL2_OR_LATER_OR_UBDL)
struct ncm_datagram_pointer ndp
Datagram pointer.
Definition: ncm.h:130
Error codes.
uint16_t remainder
Alignment remainder.
Definition: ncm.h:33
CDC-NCM datagram pointer (16-bit)
Definition: ncm.h:102
#define NCM_GET_NTB_PARAMETERS
Get NTB parameters.
Definition: ncm.h:22
#define iob_push(iobuf, len)
Definition: iobuf.h:80
void free_iob(struct io_buffer *iobuf)
Free I/O buffer.
Definition: iobuf.c:145
CDC-NCM USB Ethernet driver.
struct arbelprm_completion_with_error error
Definition: arbel.h:12
size_t len
Refill buffer payload length.
Definition: usb.h:423
static int ncm_in_prefill(struct ncm_device *ncm)
Prefill bulk IN endpoint.
Definition: ncm.c:159
CDC-NCM transfer header (16-bit)
Definition: ncm.h:77
#define USB_SUBCLASS_CDC_NCM
CDC-NCM subclass.
Definition: ncm.h:19
#define DBGC(...)
Definition: compiler.h:505
struct ncm_ntb_datagram_parameters in
IN datagram parameters.
Definition: ncm.h:45
int usb_stream(struct usb_endpoint *ep, struct io_buffer *iobuf, int terminate)
Enqueue USB stream transfer.
Definition: usb.c:528
int usb_prefill(struct usb_endpoint *ep)
Prefill endpoint recycled buffer list.
Definition: usb.c:602
struct usb_driver ncm_driver __usb_driver
CDC-NCM driver.
Definition: ncm.c:671
void netdev_link_down(struct net_device *netdev)
Mark network device as having link down.
Definition: netdevice.c:186
struct ncm_ntb_datagram_parameters out
OUT datagram parameters.
Definition: ncm.h:49
#define offsetof(type, field)
Get offset of a field within a structure.
Definition: stddef.h:24
A data structure for storing profiling information.
Definition: profile.h:26
int open
Endpoint is open.
Definition: usb.h:404
static void profile_stop(struct profiler *profiler)
Stop profiling.
Definition: profile.h:171
uint32_t mtu
Maximum size.
Definition: ncm.h:29
struct usb_endpoint intr
Interrupt endpoint.
Definition: usbnet.h:27
struct io_buffer * alloc_iob(size_t len)
Allocate I/O buffer.
Definition: iobuf.c:128
struct ncm_datagram_descriptor desc[0]
Datagram descriptors.
Definition: ncm.h:113
int usb_control(struct usb_device *usb, unsigned int request, unsigned int value, unsigned int index, void *data, size_t len)
Issue USB control transaction.
Definition: usb.c:753
static void ncm_poll(struct net_device *netdev)
Poll for completed and received packets.
Definition: ncm.c:518
Set NTB input size.
Definition: ncm.h:65
#define NCM_MIN_NTB_INPUT_SIZE
Minimum allowed NTB input size.
Definition: ncm.h:71
static void ncm_intr_complete(struct usb_endpoint *ep, struct io_buffer *iobuf, int rc)
Complete interrupt transfer.
Definition: ncm.c:73
struct usb_endpoint out
Bulk OUT endpoint.
Definition: usbnet.h:31
static void netdev_init(struct net_device *netdev, struct net_device_operations *op)
Initialise a network device.
Definition: netdevice.h:498
uint16_t offset
Offset of first datagram pointer.
Definition: ncm.h:87
static struct usb_endpoint_driver_operations ncm_in_operations
Bulk IN endpoint operations.
Definition: ncm.c:345
#define ENOMEM
Not enough space.
Definition: errno.h:534
uint16_t sequence
Transmitted packet sequence number.
Definition: ncm.h:149
#define iob_disown(iobuf)
Disown an I/O buffer.
Definition: iobuf.h:208
A USB endpoint.
Definition: usb.h:389
void * memcpy(void *dest, const void *src, size_t len) __nonnull
#define NCM_SET_NTB_INPUT_SIZE
Set NTB input size.
Definition: ncm.h:60
const char * name
Name.
Definition: profile.h:28
A USB interface descriptor.
Definition: usb.h:230
#define ETH_HLEN
Definition: if_ether.h:9
struct usb_port * port
USB port.
Definition: usb.h:710
static void usb_recycle(struct usb_endpoint *ep, struct io_buffer *iobuf)
Recycle I/O buffer.
Definition: usb.h:617
assert((readw(&hdr->flags) &(GTF_reading|GTF_writing))==0)
static void netdev_put(struct net_device *netdev)
Drop reference to network device.
Definition: netdevice.h:555
#define container_of(ptr, type, field)
Get containing structure.
Definition: stddef.h:35
static int ncm_open(struct net_device *netdev)
Open network device.
Definition: ncm.c:432
Ethernet protocol.
struct net_device * netdev
Network device.
Definition: ncm.h:142
void * priv
Driver private data.
Definition: netdevice.h:425
#define DBGC_HDA(...)
Definition: compiler.h:506
static void netdev_link_up(struct net_device *netdev)
Mark network device as having link up.
Definition: netdevice.h:768
uint16_t header_len
Header length.
Definition: ncm.h:106
#define NCM_IN_MIN_COUNT
Bulk IN ring minimum buffer count.
Definition: ncm.h:158
CDC-NCM datagram descriptor (16-bit)
Definition: ncm.h:94
struct ecm_ethernet_descriptor * ecm_ethernet_descriptor(struct usb_configuration_descriptor *config, struct usb_interface_descriptor *interface)
Locate Ethernet functional descriptor.
Definition: ecm.c:69
static void usb_refill_init(struct usb_endpoint *ep, size_t reserve, size_t len, unsigned int max)
Initialise USB endpoint refill.
Definition: usb.h:601
static struct net_device * netdev
Definition: gdbudp.c:52
struct usb_device * usb
USB device.
Definition: ncm.h:138
uint16_t offset
Starting offset.
Definition: ncm.h:96
static void usb_func_set_drvdata(struct usb_function *func, void *priv)
Set USB function driver private data.
Definition: usb.h:690
static void profile_start(struct profiler *profiler)
Start profiling.
Definition: profile.h:158
Profiling.
void unregister_netdev(struct net_device *netdev)
Unregister network device.
Definition: netdevice.c:844
#define NCM_MAX_NTB_INPUT_SIZE
Maximum allowed NTB input size (16-bit)
Definition: ncm.h:74
static void ncm_close(struct net_device *netdev)
Close network device.
Definition: ncm.c:487
static int ncm_out_transmit(struct ncm_device *ncm, struct io_buffer *iobuf)
Transmit packet.
Definition: ncm.c:356
int usbnet_refill(struct usbnet_device *usbnet)
Refill USB network device bulk IN and interrupt endpoints.
Definition: usbnet.c:151
#define cpu_to_le32(value)
Definition: byteswap.h:107
A USB device.
Definition: usb.h:706
#define NCM_IN_MAX_SIZE
Bulk IN ring maximum total buffer size.
Definition: ncm.h:170
struct usb_interface_descriptor * usb_interface_descriptor(struct usb_configuration_descriptor *config, unsigned int interface, unsigned int alternate)
Locate USB interface descriptor.
Definition: usb.c:143
#define CDC_NETWORK_CONNECTION
Network connection notification.
Definition: cdc.h:49
static void usb_poll(struct usb_bus *bus)
Poll USB bus.
Definition: usb.h:1049
#define iob_unput(iobuf, len)
Definition: iobuf.h:131
#define CDC_CONNECTION_SPEED_CHANGE
Connection speed change notification.
Definition: cdc.h:54
#define NCM_DATAGRAM_POINTER_MAGIC_CRC
CDC-NCM datagram pointer CRC present flag.
Definition: ncm.h:120
char * strerror(int errno)
Retrieve string representation of error number.
Definition: strerror.c:78
int register_netdev(struct net_device *netdev)
Register network device.
Definition: netdevice.c:667
static size_t iob_len(struct io_buffer *iobuf)
Calculate length of data in an I/O buffer.
Definition: iobuf.h:151
NTB parameters.
Definition: ncm.h:39
struct usbnet_device usbnet
USB network device.
Definition: ncm.h:144
#define USB_CLASS_ID(base, subclass, protocol)
Construct USB class ID.
Definition: usb.h:1345
A network device.
Definition: netdevice.h:348
struct usb_endpoint in
Bulk IN endpoint.
Definition: usbnet.h:29
static void netdev_nullify(struct net_device *netdev)
Stop using a network device.
Definition: netdevice.h:511
Normal driver.
Definition: usb.h:1406
uint16_t len
Length.
Definition: ncm.h:98
uint16_t divisor
Alignment divisor.
Definition: ncm.h:31
int ecm_fetch_mac(struct usb_device *usb, struct ecm_ethernet_descriptor *desc, uint8_t *hw_addr)
Get hardware MAC address.
Definition: ecm.c:89
struct usb_device * usb
USB device.
Definition: usb.h:661
#define NCM_SET_NET_ADDRESS
Set MAC address.
Definition: ncm.h:55
#define le16_to_cpu(value)
Definition: byteswap.h:112
A USB setup data packet.
Definition: usb.h:68
A CDC-NCM network device.
Definition: ncm.h:136
#define USB_CLASS_CDC
Class code for communications devices.
Definition: cdc.h:15
Network device operations.
Definition: netdevice.h:213
static struct usb_endpoint_driver_operations ncm_out_operations
Bulk OUT endpoint operations.
Definition: ncm.c:415
void netdev_rx(struct net_device *netdev, struct io_buffer *iobuf)
Add packet to receive queue.
Definition: netdevice.c:470
struct device * dev
Underlying hardware device.
Definition: netdevice.h:360
uint32_t magic
Signature.
Definition: ncm.h:104
Network device management.
USB network devices.
#define iob_reserve(iobuf, len)
Definition: iobuf.h:63
A USB configuration descriptor.
Definition: usb.h:195
static void ncm_out_complete(struct usb_endpoint *ep, struct io_buffer *iobuf, int rc)
Complete bulk OUT transfer.
Definition: ncm.c:404
void netdev_tx_complete_err(struct net_device *netdev, struct io_buffer *iobuf, int rc)
Complete network transmission.
Definition: netdevice.c:395
uint32_t len
Length.
Definition: ena.h:14
static struct net_device_operations ncm_operations
CDC-NCM network device operations.
Definition: ncm.c:532
#define DBGC2(...)
Definition: compiler.h:522
#define USB_ANY_ID
Match-anything ID.
Definition: usb.h:1329
Universal Serial Bus (USB)
uint32_t mtu
Maximum MTU.
Definition: ena.h:28
static void usbnet_init(struct usbnet_device *usbnet, struct usb_function *func, struct usb_endpoint_driver_operations *intr, struct usb_endpoint_driver_operations *in, struct usb_endpoint_driver_operations *out)
Initialise USB network device.
Definition: usbnet.h:44
void * data
Start of data.
Definition: iobuf.h:44
struct usb_hub * hub
USB hub.
Definition: usb.h:798
static void ncm_remove(struct usb_function *func)
Remove device.
Definition: ncm.c:652
uint16_t count
Number of entries.
Definition: ena.h:22
struct net_device * alloc_etherdev(size_t priv_size)
Allocate Ethernet device.
Definition: ethernet.c:264
static int ncm_transmit(struct net_device *netdev, struct io_buffer *iobuf)
Transmit packet.
Definition: ncm.c:501
struct ena_aq_header header
Header.
Definition: ena.h:12
#define cpu_to_le16(value)
Definition: byteswap.h:106
uint8_t size
Entry size (in 32-bit words)
Definition: ena.h:16
#define NCM_DATAGRAM_POINTER_MAGIC
CDC-NCM datagram pointer magic.
Definition: ncm.h:117
int usbnet_describe(struct usbnet_device *usbnet, struct usb_configuration_descriptor *config)
Describe USB network device interfaces.
Definition: usbnet.c:277
static struct usb_device_id ncm_ids[]
CDC-NCM device IDs.
Definition: ncm.c:662
void usb_flush(struct usb_endpoint *ep)
Discard endpoint recycled buffer list.
Definition: usb.c:689
uint8_t ll_addr[MAX_LL_ADDR_LEN]
Link-layer address.
Definition: netdevice.h:381
NTB constructed for transmitted packets (excluding padding)
Definition: ncm.h:126
static struct profiler ncm_intr_profiler __profiler
Interrupt completion profiler.
Definition: ncm.c:44
char message[VMCONSOLE_BUFSIZE]
Definition: vmconsole.c:54
static void ncm_in_complete(struct usb_endpoint *ep, struct io_buffer *iobuf, int rc)
Complete bulk IN transfer.
Definition: ncm.c:212
void usbnet_close(struct usbnet_device *usbnet)
Close USB network device.
Definition: usbnet.c:127
USB endpoint driver operations.
Definition: usb.h:474
#define NCM_TRANSFER_HEADER_MAGIC
CDC-NCM transfer header magic.
Definition: ncm.h:91
struct device dev
Generic device.
Definition: usb.h:665
A USB function.
Definition: usb.h:657
struct usb_bus * bus
USB bus.
Definition: usb.h:828
int iob_ensure_headroom(struct io_buffer *iobuf, size_t len)
Ensure I/O buffer has sufficient headroom.
Definition: iobuf.c:183
size_t padding
Alignment padding required on transmitted packets.
Definition: ncm.h:151
uint8_t hw_addr[MAX_HW_ADDR_LEN]
Hardware address.
Definition: netdevice.h:375
#define NULL
NULL pointer (VOID *)
Definition: Base.h:362
String functions.
static struct usb_endpoint_driver_operations ncm_intr_operations
Interrupt endpoint operations.
Definition: ncm.c:142
A USB bus.
Definition: usb.h:949
uint8_t bus
Bus.
Definition: edd.h:14
#define NCM_INTR_COUNT
Interrupt ring buffer count.
Definition: ncm.h:176
struct ll_protocol * ll_protocol
Link-layer protocol.
Definition: netdevice.h:366
struct usb_bus * bus
USB bus.
Definition: ncm.h:140
struct usb_device_id * ids
USB ID table.
Definition: usb.h:1365
void * memset(void *dest, int character, size_t len) __nonnull
A persistent I/O buffer.
Definition: iobuf.h:32
int usbnet_open(struct usbnet_device *usbnet)
Open USB network device.
Definition: usbnet.c:54