gadget/function/u_ether.h

1 /* SPDX-License-Identifier: GPL-2.0+ */
3  * u_ether.h -- interface to USB gadget "ethernet link" utilities
5  * Copyright (C) 2003-2005,2008 David Brownell
6  * Copyright (C) 2003-2004 Robert Schwebel, Benedikt Spranger
42  * This represents the USB side of an "ethernet" link, managed by a USB
44  * in different configurations could share the same ethernet link/netdev,
47  * There is a current limitation that only one instance of this link may
90 /* variant of gether_setup that allows customizing network device name */
96 /* gether_setup - initialize one ethernet-over-usb link
99  *	host side of the link is recorded
102  * This sets up the single network link that may be exported by a
103  * gadget driver using this framework.  The link layer addresses are
117  * network device name
122  * gether_register_netdev - register the net device
125  * Registers the net device associated with this ethernet-over-usb link
130 /* gether_setup_default - initialize one ethernet-over-usb link
133  * This sets up the single network link that may be exported by a
134  * gadget driver using this framework.  The link layer addresses
145  * gether_set_gadget - initialize one ethernet-over-usb link with a gadget
146  * @net: device representing this link
149  * This associates one ethernet-over-usb link with a gadget.
154  * gether_set_dev_addr - initialize an ethernet-over-usb link with eth address
155  * @net: device representing this link
158  * This sets the device-side Ethernet address of this ethernet-over-usb link
165  * gether_get_dev_addr - get an ethernet-over-usb link eth address
166  * @net: device representing this link
170  * This gets the device-side Ethernet address of this ethernet-over-usb link.
176  * gether_set_host_addr - initialize an ethernet-over-usb link with host address
177  * @net: device representing this link
180  * This sets the host-side Ethernet address of this ethernet-over-usb link
187  * gether_get_host_addr - get an ethernet-over-usb link host address
188  * @net: device representing this link
192  * This gets the host-side Ethernet address of this ethernet-over-usb link.
198  * gether_get_host_addr_cdc - get an ethernet-over-usb link host address
199  * @net: device representing this link
203  * This gets the CDC formatted host-side Ethernet address of this
204  * ethernet-over-usb link.
210  * gether_get_host_addr_u8 - get an ethernet-over-usb link host address
211  * @net: device representing this link
214  * This gets the binary formatted host-side Ethernet address of this
215  * ethernet-over-usb link.
220  * gether_set_qmult - initialize an ethernet-over-usb link with a multiplier
221  * @net: device representing this link
224  * This sets the queue length multiplier of this ethernet-over-usb link.
230  * gether_get_qmult - get an ethernet-over-usb link multiplier
231  * @net: device representing this link
233  * This gets the queue length multiplier of this ethernet-over-usb link.
238  * gether_get_ifname - get an ethernet-over-usb link interface name
239  * @net: device representing this link
240  * @name: place to store the interface name
241  * @len: length of the @name buffer
243  * This gets the interface name of this ethernet-over-usb link.
246 int gether_get_ifname(struct net_device *net, char *name, int len);
249  * gether_set_ifname - set an ethernet-over-usb link interface name
250  * @net: device representing this link
251  * @name: new interface name
252  * @len: length of @name
254  * This sets the interface name of this ethernet-over-usb link.
258 int gether_set_ifname(struct net_device *net, const char *name, int len);
262 void gether_suspend(struct gether *link);
263 void gether_resume(struct gether *link);
282 /* peak (theoretical) bulk transfer rate in bits-per-second */
285 	if (g->speed >= USB_SPEED_SUPER_PLUS)  in gether_bitrate()
287 	if (g->speed == USB_SPEED_SUPER)  in gether_bitrate()
289 	else if (g->speed == USB_SPEED_HIGH)  in gether_bitrate()