usb.h

Go to the documentation of this file.

/* SPDX-License-Identifier: GPL-2.0-or-later */
 
/***************************************************************************
 *   Copyright (C) 2011 by Martin Schmoelzer                               *
 *   <martin.schmoelzer@student.tuwien.ac.at>                              *
 ***************************************************************************/
 
#ifndef __USB_H
#define __USB_H
 
#include "reg_ezusb.h"
 
#include <stdint.h>
#include <stdbool.h>
 
#define NULL        (void *)0;
 
/* High and Low byte of a word (uint16_t) */
#define HI8(word)   (uint8_t)(((uint16_t)word >> 8) & 0xff)
#define LO8(word)   (uint8_t)((uint16_t)word & 0xff)
 
/* Convenience functions */
#define STALL_EP0()   (EP0CS |= EP0STALL)
#define CLEAR_IRQ()   (EXIF &= ~USBINT)
 
/*********** USB descriptors. See section 9.5 of the USB 1.1 spec **********/
 
/* USB Descriptor Types. See USB 1.1 spec, page 187, table 9-5 */
#define DESCRIPTOR_TYPE_DEVICE         0x01
#define DESCRIPTOR_TYPE_CONFIGURATION  0x02
#define DESCRIPTOR_TYPE_STRING         0x03
#define DESCRIPTOR_TYPE_INTERFACE      0x04
#define DESCRIPTOR_TYPE_ENDPOINT       0x05
 
#define STR_DESCR(len, ...) { len * 2 + 2, DESCRIPTOR_TYPE_STRING, { __VA_ARGS__ } }
 
struct usb_device_descriptor {
    uint8_t bLength;        
    uint8_t bDescriptorType;    
    uint16_t bcdUSB;        
    uint8_t bDeviceClass;       
    uint8_t bDeviceSubClass;    
    uint8_t bDeviceProtocol;    
    uint8_t bMaxPacketSize0;    
    uint16_t idVendor;      
    uint16_t idProduct;     
    uint16_t bcdDevice;     
    uint8_t iManufacturer;      
    uint8_t iProduct;       
    uint8_t iSerialNumber;      
    uint8_t bNumConfigurations; 
};
 
struct usb_config_descriptor {
    uint8_t bLength;        
    uint8_t bDescriptorType;    
    uint16_t wTotalLength;      
    uint8_t bNumInterfaces;     
    uint8_t bConfigurationValue;    
    uint8_t iConfiguration;     
    uint8_t bmAttributes;       
    uint8_t MaxPower;       
};
 
struct usb_interface_descriptor {
    uint8_t bLength;        
    uint8_t bDescriptorType;    
    uint8_t bInterfaceNumber;   
    uint8_t bAlternateSetting;  
    uint8_t bNumEndpoints;      
    uint8_t bInterfaceClass;    
    uint8_t bInterfaceSubclass; 
    uint8_t bInterfaceProtocol; 
    uint8_t iInterface;     
};
 
struct usb_endpoint_descriptor {
    uint8_t bLength;        
    uint8_t bDescriptorType;    
    uint8_t bEndpointAddress;   
    uint8_t bmAttributes;       
    uint16_t wMaxPacketSize;    
    uint8_t bInterval;      
};
 
struct usb_language_descriptor {
    uint8_t bLength;        
    uint8_t bDescriptorType;    
    uint16_t wLANGID[];     
};
 
struct usb_string_descriptor {
    uint8_t bLength;        
    uint8_t bDescriptorType;    
    uint16_t bString[];     
};
 
/********************** USB Control Endpoint 0 related *********************/
 
struct setup_data {
    uint8_t bmRequestType;      
    uint8_t bRequest;       
    uint16_t wValue;        
    uint16_t wIndex;        
    uint16_t wLength;       
};
 
/* External declarations for variables that need to be accessed outside of
 * the USB module */
extern volatile bool EP2_out;
extern volatile bool EP2_in;
extern volatile __xdata __at 0x7FE8 struct setup_data setup_data;
 
/*
 * USB Request Types (bmRequestType): See USB 1.1 spec, page 183, table 9-2
 *
 * Bit 7: Data transfer direction
 *    0 = Host-to-device
 *    1 = Device-to-host
 * Bit 6...5: Type
 *    0 = Standard
 *    1 = Class
 *    2 = Vendor
 *    3 = Reserved
 * Bit 4...0: Recipient
 *    0 = Device
 *    1 = Interface
 *    2 = Endpoint
 *    3 = Other
 *    4...31 = Reserved
 */
 
#define USB_DIR_OUT             0x00
#define USB_DIR_IN              0x80
 
#define USB_REQ_TYPE_STANDARD   (0x00 << 5)
#define USB_REQ_TYPE_CLASS      (0x01 << 5)
#define USB_REQ_TYPE_VENDOR     (0x02 << 5)
#define USB_REQ_TYPE_RESERVED   (0x03 << 5)
 
#define USB_RECIP_DEVICE        0x00
#define USB_RECIP_INTERFACE     0x01
#define USB_RECIP_ENDPOINT      0x02
#define USB_RECIP_OTHER         0x03
 
/* bmRequestType for USB Standard Requests */
 
/* Clear Interface Request */
#define CF_DEVICE    (USB_DIR_OUT | USB_REQ_TYPE_STANDARD | USB_RECIP_DEVICE)
#define CF_INTERFACE (USB_DIR_OUT | USB_REQ_TYPE_STANDARD | USB_RECIP_INTERFACE)
#define CF_ENDPOINT  (USB_DIR_OUT | USB_REQ_TYPE_STANDARD | USB_RECIP_ENDPOINT)
 
/* Get Configuration Request */
#define GC_DEVICE    (USB_DIR_IN | USB_REQ_TYPE_STANDARD | USB_RECIP_DEVICE)
 
/* Get Descriptor Request */
#define GD_DEVICE    (USB_DIR_IN | USB_REQ_TYPE_STANDARD | USB_RECIP_DEVICE)
 
/* Get Interface Request */
#define GI_INTERFACE (USB_DIR_IN | USB_REQ_TYPE_STANDARD | USB_RECIP_INTERFACE)
 
/* Get Status Request: See USB 1.1 spec, page 190 */
#define GS_DEVICE    (USB_DIR_IN | USB_REQ_TYPE_STANDARD | USB_RECIP_DEVICE)
#define GS_INTERFACE (USB_DIR_IN | USB_REQ_TYPE_STANDARD | USB_RECIP_INTERFACE)
#define GS_ENDPOINT  (USB_DIR_IN | USB_REQ_TYPE_STANDARD | USB_RECIP_ENDPOINT)
 
/* Set Address Request is handled by EZ-USB core */
 
/* Set Configuration Request */
#define SC_DEVICE    (USB_DIR_OUT | USB_REQ_TYPE_STANDARD | USB_RECIP_DEVICE)
 
/* Set Descriptor Request */
#define SD_DEVICE    (USB_DIR_OUT | USB_REQ_TYPE_STANDARD | USB_RECIP_DEVICE)
 
/* Set Feature Request */
#define SF_DEVICE    (USB_DIR_OUT | USB_REQ_TYPE_STANDARD | USB_RECIP_DEVICE)
#define SF_INTERFACE (USB_DIR_OUT | USB_REQ_TYPE_STANDARD | USB_RECIP_INTERFACE)
#define SF_ENDPOINT  (USB_DIR_OUT | USB_REQ_TYPE_STANDARD | USB_RECIP_ENDPOINT)
 
/* Set Interface Request */
#define SI_INTERFACE (USB_DIR_OUT | USB_REQ_TYPE_STANDARD | USB_RECIP_INTERFACE)
 
/* Synch Frame Request */
#define SY_ENDPOINT  (USB_DIR_IN | USB_REQ_TYPE_STANDARD | USB_RECIP_ENDPOINT)
 
/* USB Requests (bRequest): See USB 1.1 spec, table 9-4 on page 187 */
#define GET_STATUS               0
#define CLEAR_FEATURE            1
/* Value '2' is reserved for future use */
#define SET_FEATURE              3
/* Value '4' is reserved for future use */
#define SET_ADDRESS              5
#define GET_DESCRIPTOR           6
#define SET_DESCRIPTOR           7
#define GET_CONFIGURATION        8
#define SET_CONFIGURATION        9
#define GET_INTERFACE           10
#define SET_INTERFACE           11
#define SYNCH_FRAME             12
 
/* Standard Feature Selectors: See USB 1.1 spec, table 9-6 on page 188 */
#define DEVICE_REMOTE_WAKEUP     1
#define ENDPOINT_HALT            0
 
/************************** EZ-USB specific stuff **************************/
 
enum usb_isr {
    SUDAV_ISR = 13,
    SOF_ISR,
    SUTOK_ISR,
    SUSPEND_ISR,
    USBRESET_ISR,
    IBN_ISR,
    EP0IN_ISR,
    EP0OUT_ISR,
    EP1IN_ISR,
    EP1OUT_ISR,
    EP2IN_ISR,
    EP2OUT_ISR,
    EP3IN_ISR,
    EP3OUT_ISR,
    EP4IN_ISR,
    EP4OUT_ISR,
    EP5IN_ISR,
    EP5OUT_ISR,
    EP6IN_ISR,
    EP6OUT_ISR,
    EP7IN_ISR,
    EP7OUT_ISR
};
 
/*************************** Function Prototypes ***************************/
 
__xdata uint8_t *usb_get_endpoint_cs_reg(uint8_t ep);
void usb_reset_data_toggle(uint8_t ep);
 
bool usb_handle_get_status(void);
bool usb_handle_clear_feature(void);
bool usb_handle_set_feature(void);
bool usb_handle_get_descriptor(void);
void usb_handle_set_interface(void);
 
void usb_handle_setup_data(void);
void usb_init(void);
 
#endif