ecm.h File Reference

CDC-ECM USB Ethernet driver. More...

#include <ipxe/usb.h>
#include <ipxe/usbnet.h>
#include <ipxe/cdc.h>

Go to the source code of this file.

Data Structures
struct	ecm_ethernet_descriptor
	An Ethernet Functional Descriptor. More...
struct	ecm_device
	A CDC-ECM network device. More...

Macros
#define	USB_SUBCLASS_CDC_ECM   0x06
	CDC-ECM subclass.
#define	ECM_SET_ETHERNET_PACKET_FILTER
	Set Ethernet packet filter.
#define	ECM_INTR_MAX_FILL   2
	Interrupt maximum fill level.
#define	ECM_IN_MAX_FILL   8
	Bulk IN maximum fill level.
#define	ECM_IN_MTU   ( ETH_FRAME_LEN + 4 /* possible VLAN header */ )
	Bulk IN buffer size.

Enumerations
enum	ecm_ethernet_packet_filter {   ECM_PACKET_TYPE_PROMISCUOUS = 0x0001 , ECM_PACKET_TYPE_ALL_MULTICAST = 0x0002 , ECM_PACKET_TYPE_DIRECTED = 0x0004 , ECM_PACKET_TYPE_BROADCAST = 0x0008 ,   ECM_PACKET_TYPE_MULTICAST = 0x0010 }
	Ethernet packet types. More...

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
struct ecm_ethernet_descriptor *	ecm_ethernet_descriptor (struct usb_configuration_descriptor *config, struct usb_interface_descriptor *interface)
	Locate Ethernet functional descriptor.
int	ecm_fetch_mac (struct usb_function *func, struct ecm_ethernet_descriptor *desc, struct net_device *netdev)
	Get hardware MAC address.

Detailed Description

CDC-ECM USB Ethernet driver.

Definition in file ecm.h.

Macro Definition Documentation

USB_SUBCLASS_CDC_ECM

#define USB_SUBCLASS_CDC_ECM   0x06

CDC-ECM subclass.

Definition at line 18 of file ecm.h.

ECM_SET_ETHERNET_PACKET_FILTER

#define ECM_SET_ETHERNET_PACKET_FILTER

Value:

        ( USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE |              \
          USB_REQUEST_TYPE ( 0x43 ) )

Set Ethernet packet filter.

Definition at line 21 of file ecm.h.

#define ECM_SET_ETHERNET_PACKET_FILTER                                  \
        ( USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE |          \
          USB_REQUEST_TYPE ( 0x43 ) )

Referenced by ecm_open().

ECM_INTR_MAX_FILL

#define ECM_INTR_MAX_FILL   2

Interrupt maximum fill level.

This is a policy decision.

Definition at line 73 of file ecm.h.

Referenced by ecm_probe().

ECM_IN_MAX_FILL

#define ECM_IN_MAX_FILL   8

Bulk IN maximum fill level.

This is a policy decision.

Definition at line 79 of file ecm.h.

Referenced by ecm_probe().

ECM_IN_MTU

#define ECM_IN_MTU   ( ETH_FRAME_LEN + 4 /* possible VLAN header */ )

Bulk IN buffer size.

This is a policy decision.

Definition at line 85 of file ecm.h.

Referenced by ecm_probe().

Enumeration Type Documentation

ecm_ethernet_packet_filter

enum ecm_ethernet_packet_filter

Ethernet packet types.

Enumerator
ECM_PACKET_TYPE_PROMISCUOUS	Promiscuous mode.
ECM_PACKET_TYPE_ALL_MULTICAST	All multicast packets.
ECM_PACKET_TYPE_DIRECTED	Unicast packets.
ECM_PACKET_TYPE_BROADCAST	Broadcast packets.
ECM_PACKET_TYPE_MULTICAST	Specified multicast packets.

Definition at line 26 of file ecm.h.

                                {
        /** Promiscuous mode */
        ECM_PACKET_TYPE_PROMISCUOUS = 0x0001,
        /** All multicast packets */
        ECM_PACKET_TYPE_ALL_MULTICAST = 0x0002,
        /** Unicast packets */
        ECM_PACKET_TYPE_DIRECTED = 0x0004,
        /** Broadcast packets */
        ECM_PACKET_TYPE_BROADCAST = 0x0008,
        /** Specified multicast packets */
        ECM_PACKET_TYPE_MULTICAST = 0x0010,
};

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

ecm_ethernet_descriptor()

struct ecm_ethernet_descriptor * ecm_ethernet_descriptor ( struct usb_configuration_descriptor * config, struct usb_interface_descriptor * interface )

extern

Locate Ethernet functional descriptor.

Parameters

config	Configuration descriptor
interface	Interface descriptor

Return values

desc	Descriptor, or NULL if not found

Definition at line 71 of file ecm.c.

                                                                       {
        struct ecm_ethernet_descriptor *desc;
 
        for_each_interface_descriptor ( desc, config, interface ) {
                if ( ( desc->header.type == USB_CS_INTERFACE_DESCRIPTOR ) &&
                     ( desc->subtype == CDC_SUBTYPE_ETHERNET ) )
                        return desc;
        }
        return NULL;
}

References CDC_SUBTYPE_ETHERNET, desc, for_each_interface_descriptor, NULL, and USB_CS_INTERFACE_DESCRIPTOR.

Referenced by ecm_probe(), and ncm_probe().

ecm_fetch_mac()

int ecm_fetch_mac ( struct usb_function * func, struct ecm_ethernet_descriptor * desc, struct net_device * netdev )

extern

Get hardware MAC address.

Parameters

func	USB function
desc	Ethernet functional descriptor
netdev	Network device

Return values

rc	Return status code

Definition at line 91 of file ecm.c.

                                                {
        struct usb_device *usb = func->usb;
        char buf[ base16_encoded_len ( ETH_ALEN ) + 1 /* NUL */ ];
        uint8_t amac[ETH_ALEN];
        int len;
        int rc;
 
        /* Fetch MAC address string */
        buf[ sizeof ( buf ) - 1 ] = '\0';
        len = usb_get_string_descriptor ( usb, desc->mac, 0, buf,
                                          ( sizeof ( buf ) - 1 ) );
        if ( len < 0 ) {
                rc = len;
                return rc;
        }
 
        /* Sanity check */
        if ( len != ( ( int ) ( sizeof ( buf ) - 1 /* NUL */ ) ) ) {
                DBGC ( usb, "USB %s has invalid ECM MAC \"%s\"\n",
                       func->name, buf );
                return -EINVAL;
        }
 
        /* Decode MAC address */
        len = base16_decode ( buf, netdev->hw_addr, ETH_ALEN );
        if ( len < 0 ) {
                rc = len;
                DBGC ( usb, "USB %s could not decode ECM MAC \"%s\": %s\n",
                       func->name, buf, strerror ( rc ) );
                return rc;
        }
 
        /* Apply system-specific MAC address as current link-layer
         * address, if present.
         */
        if ( ( rc = acpi_mac ( amac ) ) == 0 ) {
                memcpy ( netdev->ll_addr, amac, ETH_ALEN );
                DBGC ( usb, "USB %s using system-specific MAC %s\n",
                       func->name, eth_ntoa ( netdev->ll_addr ) );
        }
 
        return 0;
}

References acpi_mac(), base16_encoded_len(), DBGC, desc, EINVAL, ETH_ALEN, eth_ntoa(), len, memcpy(), usb_function::name, netdev, rc, strerror(), usb_function::usb, and usb_get_string_descriptor().

Referenced by ecm_probe(), and ncm_probe().