/* SPDX-License-Identifier: GPL-2.0+ */ /* * u_ether.h -- interface to USB gadget "ethernet link" utilities * * Copyright (C) 2003-2005,2008 David Brownell * Copyright (C) 2003-2004 Robert Schwebel, Benedikt Spranger * Copyright (C) 2008 Nokia Corporation */ #ifndef __U_ETHER_H #define __U_ETHER_H #include <linux/err.h> #include <linux/if_ether.h> #include <linux/usb/composite.h> #include <linux/usb/cdc.h> #include <linux/netdevice.h> #define QMULT_DEFAULT … /* * dev_addr: initial value * changed by "ifconfig usb0 hw ether xx:xx:xx:xx:xx:xx" * host_addr: this address is invisible to ifconfig */ #define USB_ETHERNET_MODULE_PARAMETERS() … struct eth_dev; /* * This represents the USB side of an "ethernet" link, managed by a USB * function which provides control and (maybe) framing. Two functions * in different configurations could share the same ethernet link/netdev, * using different host interaction models. * * There is a current limitation that only one instance of this link may * be present in any given configuration. When that's a problem, network * layer facilities can be used to package multiple logical links on this * single "physical" one. */ struct gether { … }; #define DEFAULT_FILTER … /* variant of gether_setup that allows customizing network device name */ struct eth_dev *gether_setup_name(struct usb_gadget *g, const char *dev_addr, const char *host_addr, u8 ethaddr[ETH_ALEN], unsigned qmult, const char *netname); /* netdev setup/teardown as directed by the gadget driver */ /* gether_setup - initialize one ethernet-over-usb link * @g: gadget to associated with these links * @ethaddr: NULL, or a buffer in which the ethernet address of the * host side of the link is recorded * Context: may sleep * * This sets up the single network link that may be exported by a * gadget driver using this framework. The link layer addresses are * set up using module parameters. * * Returns a eth_dev pointer on success, or an ERR_PTR on failure */ static inline struct eth_dev *gether_setup(struct usb_gadget *g, const char *dev_addr, const char *host_addr, u8 ethaddr[ETH_ALEN], unsigned qmult) { … } /* * variant of gether_setup_default that allows customizing * network device name */ struct net_device *gether_setup_name_default(const char *netname); /* * gether_register_netdev - register the net device * @net: net device to register * * Registers the net device associated with this ethernet-over-usb link * */ int gether_register_netdev(struct net_device *net); /* gether_setup_default - initialize one ethernet-over-usb link * Context: may sleep * * This sets up the single network link that may be exported by a * gadget driver using this framework. The link layer addresses * are set to random values. * * Returns negative errno, or zero on success */ static inline struct net_device *gether_setup_default(void) { … } /** * gether_set_gadget - initialize one ethernet-over-usb link with a gadget * @net: device representing this link * @g: the gadget to initialize with * * This associates one ethernet-over-usb link with a gadget. */ void gether_set_gadget(struct net_device *net, struct usb_gadget *g); /** * gether_set_dev_addr - initialize an ethernet-over-usb link with eth address * @net: device representing this link * @dev_addr: eth address of this device * * This sets the device-side Ethernet address of this ethernet-over-usb link * if dev_addr is correct. * Returns negative errno if the new address is incorrect. */ int gether_set_dev_addr(struct net_device *net, const char *dev_addr); /** * gether_get_dev_addr - get an ethernet-over-usb link eth address * @net: device representing this link * @dev_addr: place to store device's eth address * @len: length of the @dev_addr buffer * * This gets the device-side Ethernet address of this ethernet-over-usb link. * Returns zero on success, else negative errno. */ int gether_get_dev_addr(struct net_device *net, char *dev_addr, int len); /** * gether_set_host_addr - initialize an ethernet-over-usb link with host address * @net: device representing this link * @host_addr: eth address of the host * * This sets the host-side Ethernet address of this ethernet-over-usb link * if host_addr is correct. * Returns negative errno if the new address is incorrect. */ int gether_set_host_addr(struct net_device *net, const char *host_addr); /** * gether_get_host_addr - get an ethernet-over-usb link host address * @net: device representing this link * @host_addr: place to store eth address of the host * @len: length of the @host_addr buffer * * This gets the host-side Ethernet address of this ethernet-over-usb link. * Returns zero on success, else negative errno. */ int gether_get_host_addr(struct net_device *net, char *host_addr, int len); /** * gether_get_host_addr_cdc - get an ethernet-over-usb link host address * @net: device representing this link * @host_addr: place to store eth address of the host * @len: length of the @host_addr buffer * * This gets the CDC formatted host-side Ethernet address of this * ethernet-over-usb link. * Returns zero on success, else negative errno. */ int gether_get_host_addr_cdc(struct net_device *net, char *host_addr, int len); /** * gether_get_host_addr_u8 - get an ethernet-over-usb link host address * @net: device representing this link * @host_mac: place to store the eth address of the host * * This gets the binary formatted host-side Ethernet address of this * ethernet-over-usb link. */ void gether_get_host_addr_u8(struct net_device *net, u8 host_mac[ETH_ALEN]); /** * gether_set_qmult - initialize an ethernet-over-usb link with a multiplier * @net: device representing this link * @qmult: queue multiplier * * This sets the queue length multiplier of this ethernet-over-usb link. * For higher speeds use longer queues. */ void gether_set_qmult(struct net_device *net, unsigned qmult); /** * gether_get_qmult - get an ethernet-over-usb link multiplier * @net: device representing this link * * This gets the queue length multiplier of this ethernet-over-usb link. */ unsigned gether_get_qmult(struct net_device *net); /** * gether_get_ifname - get an ethernet-over-usb link interface name * @net: device representing this link * @name: place to store the interface name * @len: length of the @name buffer * * This gets the interface name of this ethernet-over-usb link. * Returns zero on success, else negative errno. */ int gether_get_ifname(struct net_device *net, char *name, int len); /** * gether_set_ifname - set an ethernet-over-usb link interface name * @net: device representing this link * @name: new interface name * @len: length of @name * * This sets the interface name of this ethernet-over-usb link. * A single terminating newline, if any, is ignored. * Returns zero on success, else negative errno. */ int gether_set_ifname(struct net_device *net, const char *name, int len); void gether_cleanup(struct eth_dev *dev); void gether_suspend(struct gether *link); void gether_resume(struct gether *link); /* connect/disconnect is handled by individual functions */ struct net_device *gether_connect(struct gether *); void gether_disconnect(struct gether *); /* Some controllers can't support CDC Ethernet (ECM) ... */ static inline bool can_support_ecm(struct usb_gadget *gadget) { … } /* peak (theoretical) bulk transfer rate in bits-per-second */ static inline unsigned int gether_bitrate(struct usb_gadget *g) { … } #endif /* __U_ETHER_H */
Codebase Browser
linux