usb.h

Go to the documentation of this file.

#ifndef _USB_H
#define _USB_H

#include <cc2511_types.h>

#define USB_VENDOR_ID_POLOLU 0x1FFB

#define USB_EP0_PACKET_SIZE 32

/* USB CONSTANTS **************************************************************/

enum USB_DEVICE_STATES
{
    USB_STATE_DETACHED = 0,
    USB_STATE_ATTACHED = 1,
    USB_STATE_POWERED = 2,
    USB_STATE_DEFAULT = 4,
    USB_STATE_ADDRESS = 8,
    USB_STATE_CONFIGURED = 16
};

// SETUP_PACKET.bRequest values from USB Spec Table 9-4
#define USB_REQUEST_GET_STATUS 0u
#define USB_REQUEST_CLEAR_FEATURE 1u
#define USB_REQUEST_SET_FEATURE 3u
#define USB_REQUEST_SET_ADDRESS 5u
#define USB_REQUEST_GET_DESCRIPTOR 6u
#define USB_REQUEST_SET_DESCRIPTOR 7u
#define USB_REQUEST_GET_CONFIGURATION 8u
#define USB_REQUEST_SET_CONFIGURATION 9u
#define USB_REQUEST_GET_INTERFACE 10u
#define USB_REQUEST_SET_INTERFACE 11u
#define USB_REQUEST_SYNCH_FRAME 12u

// SETUP_PACKET.request_type values from USB Spec Table 9-2
#define USB_REQUEST_TYPE_STANDARD 0u
#define USB_REQUEST_TYPE_CLASS 1u
#define USB_REQUEST_TYPE_VENDOR 2u

// SETUP_PACKET.recipient values from USB Spec Table 9-2
#define USB_RECIPIENT_DEVICE 0u
#define USB_RECIPIENT_INTERFACE 1u
#define USB_RECIPIENT_ENDPOINT 2u
#define USB_RECIPIENT_OTHER 3u

// Descriptor types from USB Spec Table 9-5
#define USB_DESCRIPTOR_TYPE_DEVICE 1u
#define USB_DESCRIPTOR_TYPE_CONFIGURATION 2u
#define USB_DESCRIPTOR_TYPE_STRING 3u
#define USB_DESCRIPTOR_TYPE_INTERFACE 4u
#define USB_DESCRIPTOR_TYPE_ENDPOINT 5u
#define USB_DESCRIPTOR_TYPE_DEVICE_QUALIFIER 6u
#define USB_DESCRIPTOR_TYPE_OTHER_SPEED_CONFIGURATION 7u
#define USB_DESCRIPTOR_TYPE_INTERFACE_POWER 8u
#define USB_DESCRIPTOR_TYPE_ENDPOINT_CLASS_SPECIFIC 0x25u
#define USB_DESCRIPTOR_TYPE_INTERFACE_ASSOCIATION 0x0Bu

// setup_packet feature selectors, USB Spec Table 9-6, Standard Feature Selectors
#define USB_FEATURE_DEVICE_REMOTE_WAKEUP 1u
#define USB_FEATURE_ENDPOINT_HALT 0u
#define USB_FEATURE_TEST_MODE 2u

// Configuration Decriptor bmAttributes bitmasks (USB Spec Table 9-10)
#define USB_CONFIG_ATTR_DEFAULT       (1<<7) //Default Value (bit 7 must be set to 1)
#define USB_CONFIG_ATTR_SELF_POWERED  (1<<6) //Self-powered
#define USB_CONFIG_ATTR_REMOTE_WAKEUP (1<<5) //Remote Wakeup

// Values for usbSetupPacket.direction bit.
#define USB_OUT 0u
#define USB_IN  1u

// USB Endpoint addresses, to be used in descriptors
// To get the address of an IN endpoint, do: USB_ENDPOINT_ADDRESS_IN | 1
#define USB_ENDPOINT_ADDRESS_IN    0x80
#define USB_ENDPOINT_ADDRESS_OUT   0x00

// Endpoint transfer types, used in endpoint descriptors (USB Spec Table 9-13)
#define USB_TRANSFER_TYPE_CONTROL     0
#define USB_TRANSFER_TYPE_ISOCHRONOUS 1
#define USB_TRANSFER_TYPE_BULK        2
#define USB_TRANSFER_TYPE_INTERRUPT   3

#define USB_LANGUAGE_EN_US 0x0409

/* USB STRUCTS ****************************************************************/

typedef union
{
    struct
    {
        uint8 bmRequestType;
        uint8 bRequest;
        uint16 wValue;
        uint16 wIndex;
        uint16 wLength;
    };

    struct
    {
        unsigned recipient:5;   //see REQUEST_RECIPIENT_*
        unsigned requestType:2; //see REQUEST_TYPE_*
        unsigned direction:1;   //0=USB_OUT,1=USB_IN
    };
} USB_SETUP_PACKET;

typedef struct USB_DESCRIPTOR_DEVICE
{
    uint8  bLength;               
    uint8  bDescriptorType;       
    uint16 bcdUSB;                
    uint8  bDeviceClass;          
    uint8  bDeviceSubClass;       
    uint8  bDeviceProtocol;       
    uint8  bMaxPacketSize0;       
    uint16 idVendor;              
    uint16 idProduct;             
    uint16 bcdDevice;             
    uint8  iManufacturer;         
    uint8  iProduct;              
    uint8  iSerialNumber;         
    uint8  bNumConfigurations;    
} USB_DESCRIPTOR_DEVICE;

typedef struct USB_DESCRIPTOR_CONFIGURATION
{
    uint8  bLength;               
    uint8  bDescriptorType;       
    uint16 wTotalLength;          
    uint8  bNumInterfaces;        
    uint8  bConfigurationValue;   
    uint8  iConfiguration;        
    uint8  bmAttributes;          
    uint8  bMaxPower;             
} USB_DESCRIPTOR_CONFIGURATION;

typedef struct USB_DESCRIPTOR_INTERFACE_ASSOCIATION
{
    uint8  bLength;               
    uint8  bDescriptorType;       
    uint8  bFirstInterface;       
    uint8  bInterfaceCount;       
    uint8  bFunctionClass;        
    uint8  bFunctionSubClass;     
    uint8  bFunctionProtocol;     
    uint8  iFunction;             
} USB_DESCRIPTOR_INTERFACE_ASSOCIATION;

typedef struct USB_DESCRIPTOR_INTERFACE
{
    uint8  bLength;               
    uint8  bDescriptorType;       
    uint8  bInterfaceNumber;      
    uint8  bAlternateSetting;     
    uint8  bNumEndpoints;         
    uint8  bInterfaceClass;       
    uint8  bInterfaceSubClass;    
    uint8  bInterfaceProtocol;    
    uint8  iInterface;            
} USB_DESCRIPTOR_INTERFACE;

typedef struct USB_DESCRIPTOR_ENDPOINT
{
    uint8  bLength;               
    uint8  bDescriptorType;       
    uint8  bEndpointAddress;      
    uint8  bmAttributes;          
    uint16 wMaxPacketSize;        
    uint8  bInterval;             
} USB_DESCRIPTOR_ENDPOINT;

/* CC2511 USB CONSTANTS *******************************************************/

// USBCSOL register bit values
#define USBCSOL_OUTPKT_RDY   0x01

// USBCSIL register bit values
#define USBCSIL_INPKT_RDY    0x01
#define USBCSIL_PKT_PRESENT  0x02

/* HELPERS ********************************************************************/

#define DEFINE_STRING_DESCRIPTOR(name,char_count,...) static uint16 CODE name[] = { (2*(char_count+1)) | (USB_DESCRIPTOR_TYPE_STRING<<8), __VA_ARGS__ };

/* PROTOTYPES DEFINED BY LIBUSB ***********************************************/

extern enum USB_DEVICE_STATES XDATA usbDeviceState;

extern USB_SETUP_PACKET XDATA usbSetupPacket;

void usbInit(void);

void usbPoll(void);

void usbControlRead(uint16 bytesCount, uint8 XDATA * source);

void usbControlWrite(uint16 bytesCount, uint8 XDATA * source);

void usbControlAcknowledge(void);

void usbControlStall(void);

void usbInitEndpointIn(uint8 endpointNumber, uint8 maxPacketSize);

void usbInitEndpointOut(uint8 endpointNumber, uint8 maxPacketSize);

void usbWriteFifo(uint8 endpointNumber, uint8 count, const uint8 XDATA * buffer);

void usbReadFifo(uint8 endpointNumber, uint8 count, uint8 XDATA * buffer);

BIT usbSuspended(void);

void usbSleep(void);

extern volatile BIT usbSuspendMode;

void usbShowStatusWithGreenLed(void);

extern volatile BIT usbActivityFlag;

/* HIGH-LEVEL CALLBACKS AND DATA STRUCTURES REQUIRED BY usb.c *****************/
// usb.c requires these high-level callbacks and data structures:

extern USB_DESCRIPTOR_DEVICE CODE usbDeviceDescriptor;

extern uint8 CODE usbStringDescriptorCount;

extern uint16 CODE * CODE usbStringDescriptors[];

void usbCallbackSetupHandler(void);

void usbCallbackClassDescriptorHandler(void);

void usbCallbackInitEndpoints(void);

void usbCallbackControlWriteHandler(void);

#endif