Atmel Software Framework

applications/uc3-audio-player/usb_host_enum.h File Reference
#include "conf_usb.h"
#include "compiler.h"
#include "usb_drv.h"
#include "usb_task.h"

Data Structures

struct  S_interface
 Interface. More...
 
struct  S_usb_setup_data
 USB Setup Data. More...
 

Macros

#define CONTROL_CRC16   0x10
 
#define CONTROL_DATA_PID   0x02
 
#define CONTROL_DATA_TOGGLE   0x01
 
#define CONTROL_GOOD   0x00
 
#define CONTROL_NO_DEVICE   0x40
 
#define CONTROL_PID   0x04
 
#define CONTROL_STALL   0x20
 
#define CONTROL_TIMEOUT   0x08
 
#define Get_altset_nb(s_interface)   (interface_supported[(s_interface)].altset_nb)
 Number of alternate settings associated with a supported interface. More...
 
#define Get_class(s_interface)   (interface_supported[(s_interface)].uclass)
 USB class associated with the supported interface. More...
 
#define Get_ep_nbr(s_interface, n_ep)   (Host_get_pipe_endpoint_number(Get_ep_pipe(s_interface, n_ep)))
 Endpoint number associated with the supported interface. More...
 
#define Get_ep_pipe(s_interface, n_ep)   (interface_supported[(s_interface)].ep_pipe[(n_ep)])
 Endpoint pipe associated with the supported interface. More...
 
#define Get_ep_type(s_interface, n_ep)   (Host_get_pipe_type(Get_ep_pipe(s_interface, n_ep)))
 Endpoint type associated with the supported interface. More...
 
#define Get_interface_number(s_interface)   (interface_supported[(s_interface)].interface_nb)
 Number of interfaces associated with a supported interface. More...
 
#define Get_maxpower()   (maxpower)
 Maximal power consumption of the connected device (unit is 2 mA) More...
 
#define Get_nb_ep(s_interface)   (interface_supported[(s_interface)].nb_ep)
 Number of endpoints associated with a supported interface. More...
 
#define Get_nb_supported_interface()   (nb_interface_supported)
 Number of supported interfaces in the connected device. More...
 
#define Get_PID()   (device_PID)
 PID of the connected device. More...
 
#define Get_pipe_token(ep_addr)   ((Get_desc_ep_dir(ep_addr)) ? TOKEN_IN : TOKEN_OUT)
 Extract token information from endpoint address. More...
 
#define Get_protocol(s_interface)   (interface_supported[(s_interface)].protocol)
 USB protocol associated with the supported interface. More...
 
#define Get_subclass(s_interface)   (interface_supported[(s_interface)].subclass)
 USB subclass associated with the supported interface. More...
 
#define Get_VID()   (device_VID)
 VID of the connected device. More...
 
#define host_clear_endpoint_feature(ep)
 Send a "clear endpoint feature" request. More...
 
#define host_get_configuration()
 Send a "get configuration" request. More...
 
#define host_get_configuration_descriptor(cfg_ix)
 Send a "get device configuration descriptor" request The configuration descriptor received is stored in the data_stage array. More...
 
#define host_get_device_descriptor()
 Send a "get device descriptor" request The descriptor received is stored in the data_stage array. More...
 
#define host_get_device_descriptor_incomplete()
 Send an incomplete "get device descriptor" request The descriptor received is stored in the data_stage array. More...
 
#define host_ms_get_max_lun()
 Send the mass-storage specific request "get max LUN". More...
 
#define host_set_address(addr)
 Send a "set address" request. More...
 
#define host_set_configuration(cfg_nb)
 Send a "set configuration" request. More...
 
#define host_set_feature_remote_wakeup()
 Send a "set feature" "device remote wake-up". More...
 
#define host_set_interface(interface_nb, alt_setting)
 Send a "set interface" request to specify an alternate setting for an interface. More...
 
#define Is_device_self_powered()   (Tst_bits(bmattributes, SELF_POWERED_MASK))
 true if the connected device is self-powered More...
 
#define Is_device_supports_remote_wakeup()   (Tst_bits(bmattributes, REMOTE_WAKEUP_MASK))
 true if the connected device supports remote wake-up More...
 
#define Is_ep_in(s_interface, n_ep)   (Host_get_pipe_token(Get_ep_pipe(s_interface, n_ep)) == TOKEN_IN)
 true if the endpoint direction associated with the supported interface is IN More...
 
#define OFFSET_DESCRIPTOR_LENGTH   0
 Offsets common to all descriptor types. More...
 
#define OFFSET_FIELD_ALT   3
 
#define OFFSET_FIELD_BMATTRIBUTES   7
 
#define OFFSET_FIELD_CLASS   5
 
#define OFFSET_FIELD_CONFIGURATION_NB   5
 
#define OFFSET_FIELD_DESCRIPTOR_TYPE   1
 
#define OFFSET_FIELD_EP_ADDR   2
 Offsets in endpoint descriptors. More...
 
#define OFFSET_FIELD_EP_INTERVAL   6
 
#define OFFSET_FIELD_EP_SIZE   4
 
#define OFFSET_FIELD_EP_TYPE   3
 
#define OFFSET_FIELD_INTERFACE_NB   2
 Offsets in interface descriptors. More...
 
#define OFFSET_FIELD_MAXPACKETSIZE   7
 Offsets in device descriptors. More...
 
#define OFFSET_FIELD_MAXPOWER   8
 
#define OFFSET_FIELD_NB_CONFIGURATION   17
 
#define OFFSET_FIELD_NB_INTERFACE   4
 
#define OFFSET_FIELD_NB_OF_EP   4
 
#define OFFSET_FIELD_PID   10
 
#define OFFSET_FIELD_PROTOCOL   7
 
#define OFFSET_FIELD_SUB_CLASS   6
 
#define OFFSET_FIELD_TOTAL_LENGTH   2
 Offsets in configuration descriptors. More...
 
#define OFFSET_FIELD_VID   8
 
#define REMOTE_WAKEUP_BIT   5
 
#define REMOTE_WAKEUP_MASK   (1 << REMOTE_WAKEUP_BIT)
 
#define SELF_POWERED_BIT   6
 
#define SELF_POWERED_MASK   (1 << SELF_POWERED_BIT)
 

Functions

bool host_check_class (void)
 This function checks if the device class is supported. More...
 
bool host_check_VID_PID (void)
 This function checks if the VID and the PID are supported (if the VID & PID belong to the VID_PID table). More...
 
Status_t host_transfer_control (void *data_pointer)
 This function is the generic control pipe management function. More...
 

Variables

volatile uint8_t bmattributes
 bmAttributes byte of connected device More...
 
volatile uint16_t device_PID
 PID of connected device. More...
 
volatile uint16_t device_VID
 VID of connected device. More...
 
volatile S_interface interface_supported [MAX_INTERFACE_SUPPORTED]
 Supported interfaces. More...
 
volatile uint8_t maxpower
 maxpower byte of connected device (unit is 2 mA) More...
 
volatile uint8_t nb_interface_supported
 Number of interfaces the host is able to support in the connected device. More...