usb.h

Go to the documentation of this file.

//
// usb.h
//
// USPi - An USB driver for Raspberry Pi written in C
// Copyright (C) 2014  R. Stange <rsta2@o2online.de>
// 
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
//
#ifndef _uspi_usb_h
#define _uspi_usb_h
 
#include "uspi/macros.h"
 
// PID
typedef enum
{
    USBPIDSetup,
    USBPIDData0,
    USBPIDData1,
    //USBPIDData2,
    //USBPIDMData
}
TUSBPID;
 
// Device Addresses
#define USB_DEFAULT_ADDRESS     0
#define USB_FIRST_DEDICATED_ADDRESS 1
#define USB_MAX_ADDRESS         127
 
// Speed
typedef enum
{
    USBSpeedLow,
    USBSpeedFull,
    USBSpeedHigh,
    USBSpeedUnknown
}
TUSBSpeed;
 
#pragma pack(push,1)
// Setup Data
typedef struct
{
    unsigned char   bmRequestType;
    unsigned char   bRequest;
    unsigned short  wValue;
    unsigned short  wIndex;
    unsigned short  wLength;
    // Data follows
}TSetupData;
#pragma pack(pop)
//PACKED TSetupData;
 
// Request Types
#define REQUEST_OUT         0
#define REQUEST_IN          0x80
 
#define REQUEST_CLASS           0x20
#define REQUEST_VENDOR          0x40
 
#define REQUEST_TO_INTERFACE        1
#define REQUEST_TO_OTHER        3
 
// Standard Request Codes
#define GET_STATUS          0
#define CLEAR_FEATURE           1
#define SET_FEATURE         3
#define SET_ADDRESS         5
#define GET_DESCRIPTOR          6
#define SET_CONFIGURATION       9
#define SET_INTERFACE           11
 
// Descriptor Types
#define DESCRIPTOR_DEVICE       1
#define DESCRIPTOR_CONFIGURATION    2
#define DESCRIPTOR_STRING       3
#define DESCRIPTOR_INTERFACE        4
#define DESCRIPTOR_ENDPOINT     5
#define DESCRIPTOR_CS_INTERFACE 36
#define DESCRIPTOR_CS_ENDPOINT  37
 
#define DESCRIPTOR_INDEX_DEFAULT    0
 
#pragma pack(push,1)
// Device Descriptor
typedef struct
{
    unsigned char   bLength;
    unsigned char   bDescriptorType;
    unsigned short  bcdUSB;
    unsigned char   bDeviceClass;
    unsigned char   bDeviceSubClass;
    unsigned char   bDeviceProtocol;
    unsigned char   bMaxPacketSize0;
    #define USB_DEFAULT_MAX_PACKET_SIZE 8
    unsigned short  idVendor;
    unsigned short  idProduct;
    unsigned short  bcdDevice;
    unsigned char   iManufacturer;
    unsigned char   iProduct;
    unsigned char   iSerialNumber;
    unsigned char   bNumConfigurations;
}TUSBDeviceDescriptor;
#pragma pack(pop)
//PACKED TUSBDeviceDescriptor;
 
#pragma pack(push,1)
// Configuration Descriptor
typedef struct
{
    unsigned char   bLength;
    unsigned char   bDescriptorType;
    unsigned short  wTotalLength;
    unsigned char   bNumInterfaces;
    unsigned char   bConfigurationValue;
    unsigned char   iConfiguration;
    unsigned char   bmAttributes;
    unsigned char   bMaxPower;
}TUSBConfigurationDescriptor;
#pragma pack(pop)
 
//PACKED TUSBConfigurationDescriptor;
 
#pragma pack(push,1)
// Interface Descriptor
typedef struct
{
    unsigned char   bLength;
    unsigned char   bDescriptorType;
    unsigned char   bInterfaceNumber;
    unsigned char   bAlternateSetting;
    unsigned char   bNumEndpoints;
    unsigned char   bInterfaceClass;
    unsigned char   bInterfaceSubClass;
    unsigned char   bInterfaceProtocol;
    unsigned char   iInterface;
}TUSBInterfaceDescriptor;
#pragma pack(pop)
//PACKED TUSBInterfaceDescriptor;
 
#pragma pack(push,1)
// Endpoint Descriptor
typedef struct
{
    unsigned char   bLength;
    unsigned char   bDescriptorType;
    unsigned char   bEndpointAddress;
    unsigned char   bmAttributes;
    unsigned short  wMaxPacketSize;
    unsigned char   bInterval;
}TUSBEndpointDescriptor;
#pragma pack(pop)
//PACKED TUSBEndpointDescriptor;
 
#pragma pack(push,1)
// Audio class Endpoint Descriptor
typedef struct
{
    unsigned char   bLength;
    unsigned char   bDescriptorType;
    unsigned char   bEndpointAddress;
    unsigned char   bmAttributes;
    unsigned short  wMaxPacketSize;
    unsigned char   bInterval;
    unsigned char   bRefresh;
    unsigned char   bSynchAddress;
}TUSBAudioEndpointDescriptor;
#pragma pack(pop)
//PACKED TUSBAudioEndpointDescriptor;
 
#pragma pack(push,1)
// MIDI-streaming class-specific Endpoint Descriptor
typedef struct
{
    unsigned char   bLength;
    unsigned char   bDescriptorType;
    unsigned char   bDescriptorSubType;
    unsigned char   bNumEmbMIDIJack;
    unsigned char   bAssocJackIDs[];
}TUSBMIDIStreamingEndpointDescriptor;
#pragma pack(pop)
//PACKED TUSBMIDIStreamingEndpointDescriptor;
 
#pragma pack(push,1)
// Descriptor union
typedef union
{
    struct
    {
        unsigned char   bLength;
        unsigned char   bDescriptorType;
    }
    Header;
 
    TUSBConfigurationDescriptor         Configuration;
    TUSBInterfaceDescriptor             Interface;
    TUSBEndpointDescriptor              Endpoint;
    TUSBAudioEndpointDescriptor         AudioEndpoint;
    TUSBMIDIStreamingEndpointDescriptor MIDIStreamingEndpoint;
}TUSBDescriptor;
#pragma pack(pop)
//PACKED TUSBDescriptor;
 
#pragma pack(push,1)
typedef struct TUSBStringDescriptor
{
    unsigned char   bLength;
    unsigned char   bDescriptorType;
    unsigned short  bString[0];
}TUSBStringDescriptor;
#pragma pack(pop)
//PACKED TUSBStringDescriptor;
 
#endif