cdc.h File Reference

USB Communications Device Class (CDC) More...

#include <ipxe/usb.h>

Go to the source code of this file.

Data Structures
struct	cdc_union_descriptor
	Union functional descriptor. More...
struct	cdc_connection_speed_change
	Connection speed change notification. More...

Macros
#define	USB_CLASS_CDC   2
	Class code for communications devices.
#define	CDC_SEND_ENCAPSULATED_COMMAND
	Send encapsulated command.
#define	CDC_GET_ENCAPSULATED_RESPONSE
	Get encapsulated response.
#define	CDC_SUBTYPE_UNION   6
	Union functional descriptor subtype.
#define	CDC_SUBTYPE_ETHERNET   15
	Ethernet descriptor subtype.
#define	CDC_RESPONSE_AVAILABLE
	Response available.
#define	CDC_NETWORK_CONNECTION
	Network connection notification.
#define	CDC_CONNECTION_SPEED_CHANGE
	Connection speed change notification.

Functions
	FILE_LICENCE (GPL2_OR_LATER_OR_UBDL)
	FILE_SECBOOT (PERMITTED)
struct cdc_union_descriptor *	cdc_union_descriptor (struct usb_configuration_descriptor *config, struct usb_interface_descriptor *interface)
	Locate CDC union functional descriptor.
static int	cdc_send_encapsulated_command (struct usb_device *usb, unsigned int interface, void *data, size_t len)
	Send encapsulated command.
static int	cdc_get_encapsulated_response (struct usb_device *usb, unsigned int interface, void *data, size_t len)
	Get encapsulated response.

Detailed Description

USB Communications Device Class (CDC)

Definition in file cdc.h.

Macro Definition Documentation

USB_CLASS_CDC

#define USB_CLASS_CDC   2

Class code for communications devices.

Definition at line 16 of file cdc.h.

Referenced by usb_describe().

CDC_SEND_ENCAPSULATED_COMMAND

#define CDC_SEND_ENCAPSULATED_COMMAND

Value:

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

Send encapsulated command.

Definition at line 19 of file cdc.h.

#define CDC_SEND_ENCAPSULATED_COMMAND                                   \
        ( USB_DIR_OUT | USB_TYPE_CLASS | USB_RECIP_INTERFACE |          \
          USB_REQUEST_TYPE ( 0x00 ) )

Referenced by cdc_send_encapsulated_command().

CDC_GET_ENCAPSULATED_RESPONSE

#define CDC_GET_ENCAPSULATED_RESPONSE

Value:

        ( USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE |                \
          USB_REQUEST_TYPE ( 0x01 ) )

Get encapsulated response.

Definition at line 24 of file cdc.h.

#define CDC_GET_ENCAPSULATED_RESPONSE                                   \
        ( USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE |           \
          USB_REQUEST_TYPE ( 0x01 ) )

Referenced by cdc_get_encapsulated_response().

CDC_SUBTYPE_UNION

#define CDC_SUBTYPE_UNION   6

Union functional descriptor subtype.

Definition at line 39 of file cdc.h.

Referenced by cdc_union_descriptor().

CDC_SUBTYPE_ETHERNET

#define CDC_SUBTYPE_ETHERNET   15

Ethernet descriptor subtype.

Definition at line 42 of file cdc.h.

Referenced by ecm_ethernet_descriptor().

CDC_RESPONSE_AVAILABLE

#define CDC_RESPONSE_AVAILABLE

Value:

        ( USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE |                \
          USB_REQUEST_TYPE ( 0x01 ) )

Response available.

Definition at line 45 of file cdc.h.

#define CDC_RESPONSE_AVAILABLE                                          \
        ( USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE |           \
          USB_REQUEST_TYPE ( 0x01 ) )

Referenced by acm_intr_complete().

CDC_NETWORK_CONNECTION

#define CDC_NETWORK_CONNECTION

Value:

        ( USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE |                \
          USB_REQUEST_TYPE ( 0x00 ) )

Network connection notification.

Definition at line 50 of file cdc.h.

#define CDC_NETWORK_CONNECTION                                          \
        ( USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE |           \
          USB_REQUEST_TYPE ( 0x00 ) )

Referenced by ecm_intr_complete(), and ncm_intr_complete().

CDC_CONNECTION_SPEED_CHANGE

#define CDC_CONNECTION_SPEED_CHANGE

Value:

        ( USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE |                \
          USB_REQUEST_TYPE ( 0x2a ) )

Connection speed change notification.

Definition at line 55 of file cdc.h.

#define CDC_CONNECTION_SPEED_CHANGE                                     \
        ( USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE |           \
          USB_REQUEST_TYPE ( 0x2a ) )

Referenced by ecm_intr_complete(), and ncm_intr_complete().

Function Documentation

FILE_LICENCE()

FILE_LICENCE

(

GPL2_OR_LATER_OR_UBDL

)

FILE_SECBOOT()

FILE_SECBOOT

(

PERMITTED

)

cdc_union_descriptor()

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

extern

Locate CDC union functional descriptor.

Parameters

config	Configuration descriptor
interface	Interface descriptor

Return values

desc	Union functional descriptor, or NULL if not found

Definition at line 45 of file cdc.c.

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

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

cdc_send_encapsulated_command()

int cdc_send_encapsulated_command ( struct usb_device * usb, unsigned int interface, void * data, size_t len )

inlinestatic

Send encapsulated command.

Parameters

usb	USB device
interface	Interface number
data	Command
len	Length of command

Return values

rc	Return status code

Definition at line 81 of file cdc.h.

                                                         {
 
        return usb_control ( usb, CDC_SEND_ENCAPSULATED_COMMAND, 0, interface,
                             data, len );
}

References CDC_SEND_ENCAPSULATED_COMMAND, data, len, and usb_control().

Referenced by acm_control_transmit().

cdc_get_encapsulated_response()

int cdc_get_encapsulated_response ( struct usb_device * usb, unsigned int interface, void * data, size_t len )

inlinestatic

Get encapsulated response.

Parameters

usb	USB device
interface	Interface number
data	Response buffer
len	Length of response buffer

Return values

rc	Return status code

Definition at line 98 of file cdc.h.

                                                         {
 
        return usb_control ( usb, CDC_GET_ENCAPSULATED_RESPONSE, 0, interface,
                             data, len );
}

References CDC_GET_ENCAPSULATED_RESPONSE, data, len, and usb_control().

Referenced by acm_control_receive().