descriptor.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2018 Koen Zandberg <koen@bergzand.net>
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <stdint.h>
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif

#define USB_SETUP_REQ_GET_STATUS            0x00    
#define USB_SETUP_REQ_CLEAR_FEATURE         0x01    
#define USB_SETUP_REQ_SET_FEATURE           0x03    
#define USB_SETUP_REQ_SET_ADDRESS           0x05    
#define USB_SETUP_REQ_GET_DESCRIPTOR        0x06    
#define USB_SETUP_REQ_SET_DESCRIPTOR        0x07    
#define USB_SETUP_REQ_GET_CONFIGURATION     0x08    
#define USB_SETUP_REQ_SET_CONFIGURATION     0x09    
#define USB_SETUP_REQ_GET_INTERFACE         0x0a    
#define USB_SETUP_REQ_SET_INTERFACE         0x0b    
#define USB_SETUP_REQ_SYNCH_FRAME           0x0c    

#define USB_TYPE_DESCRIPTOR_DEVICE          0x01    
#define USB_TYPE_DESCRIPTOR_CONFIGURATION   0x02    
#define USB_TYPE_DESCRIPTOR_STRING          0x03    
#define USB_TYPE_DESCRIPTOR_INTERFACE       0x04    
#define USB_TYPE_DESCRIPTOR_ENDPOINT        0x05    
#define USB_TYPE_DESCRIPTOR_DEV_QUALIFIER   0x06    
#define USB_TYPE_DESCRIPTOR_SPEED_CONFIG    0x07    
#define USB_TYPE_DESCRIPTOR_IFACE_POWER     0x08    
#define USB_TYPE_DESCRIPTOR_INTERFACE_ASSOC 0x0b    

#define USB_FEATURE_ENDPOINT_HALT           0x00    
#define USB_FEATURE_DEVICE_REMOTE_WAKEUP    0x01    
#define USB_FEATURE_TEST_MODE               0x02    

#define USB_CONF_ATTR_RESERVED              0x80    
#define USB_CONF_ATTR_SELF_POWERED          0x40    
#define USB_CONF_ATTR_REM_WAKEUP            0x20    

#define USB_SETUP_REQUEST_DEVICE2HOST           0x80    
 
#define USB_SETUP_REQUEST_RECIPIENT_MASK        0x1f    
#define USB_SETUP_REQUEST_RECIPIENT_DEVICE      0x00    
#define USB_SETUP_REQUEST_RECIPIENT_INTERFACE   0x01    
#define USB_SETUP_REQUEST_RECIPIENT_ENDPOINT    0x02    
#define USB_SETUP_REQUEST_RECIPIENT_OTHER       0x03    
 
#define USB_SETUP_REQUEST_TYPE_MASK             0x60    
#define USB_SETUP_REQUEST_TYPE_STANDARD         0x00    
#define USB_SETUP_REQUEST_TYPE_CLASS            0x20    
#define USB_SETUP_REQUEST_TYPE_VENDOR           0x40    

#define USB_ENDPOINT_DESCRIPTOR_INTERVAL_ISOCHRONOUS    1

#define USB_CLASS_AUDIO             0x01    
#define USB_CLASS_CDC_CONTROL       0x02    
#define USB_CLASS_HID               0x03    
#define USB_CLASS_PHYSICAL          0x05    
#define USB_CLASS_IMAGE             0x06    
#define USB_CLASS_PRINTER           0x07    
#define USB_CLASS_MASS_STORAGE      0x08    
#define USB_CLASS_CDC_DATA          0x0a    
#define USB_CLASS_VENDOR            0xff    

typedef struct __attribute__((packed)) {
    uint8_t length;             
    uint8_t type;               
    uint16_t bcd_usb;           
    uint8_t class;              
    uint8_t subclass;           
    uint8_t protocol;           
    uint8_t max_packet_size;    
    uint16_t vendor_id;         
    uint16_t product_id;        
    uint16_t bcd_device;        
    uint8_t manufacturer_idx;   
    uint8_t product_idx;        
    uint8_t serial_idx;         
    uint8_t num_configurations; 
} usb_descriptor_device_t;

typedef struct __attribute__((packed)) {
    uint8_t length;             
    uint8_t type;               
    uint16_t total_length;      
    uint8_t num_interfaces;     
    uint8_t val;                
    uint8_t idx;                
    uint8_t attributes;         
    uint8_t max_power;          
} usb_descriptor_configuration_t;

typedef struct __attribute__((packed)) {
    uint8_t length;             
    uint8_t type;               
    uint8_t interface_num;      
    uint8_t alternate_setting;  
    uint8_t num_endpoints;      
    uint8_t class;              
    uint8_t subclass;           
    uint8_t protocol;           
    uint8_t idx;                
} usb_descriptor_interface_t;

typedef struct __attribute__((packed)) {
    uint8_t length;             
    uint8_t type;               
    uint8_t address;            
    uint8_t attributes;         
    uint16_t max_packet_size;   
    uint8_t interval;           
} usb_descriptor_endpoint_t;

typedef struct __attribute__((packed)) {
    uint8_t length;             
    uint8_t type;               
} usb_descriptor_string_t;

typedef struct __attribute__((packed)) {
    uint8_t length;             
    uint8_t type;               
    uint8_t first_interface;    
    uint8_t interface_count;    
    uint8_t class;              
    uint8_t subclass;           
    uint8_t protocol;           
    uint8_t idx;                
} usb_descriptor_interface_association_t;

typedef struct __attribute__((packed)) {
    uint8_t type;       
    uint8_t request;    
    uint16_t value;     
    uint16_t index;     
    uint16_t length;    
} usb_setup_t;

static inline bool usb_setup_is_read(usb_setup_t *pkt)
{
    return pkt->type & USB_SETUP_REQUEST_DEVICE2HOST;
}
 
#ifdef __cplusplus
}
#endif