usb.h

Go to the documentation of this file.

#pragma once
#include <stdbool.h>
#include <stdint.h>

// Forward-declared rather than #include <picofuse/hid/device.h> - only
// used as opaque pointers below (hw_usb_register_hid()'s own parameter/
// return type), and pulling in the whole header would add a hw->hid
// header dependency this module doesn't otherwise have (hid already
// depends on hw, not the other way around - see hw_usb_register_hid()'s
// own doc on why the bridge itself still has to be compiled into
// picofuse-hid rather than picofuse-hw).
typedef struct hid_t hid_t;
typedef struct hid_device_t hid_device_t;

#ifndef HW_USB_STRING_MAX_LENGTH
#define HW_USB_STRING_MAX_LENGTH 63
#endif

#ifndef HW_USB_INTERFACE_MAX_COUNT
#define HW_USB_INTERFACE_MAX_COUNT 8
#endif

// TYPES

typedef enum {
  hw_usb_event_attached = (1 << 0), 
  hw_usb_event_detached = (1 << 1), 
} hw_usb_event_t;

typedef enum {
  hw_usb_device_class_per_interface = 0x00,
  hw_usb_device_class_audio = 0x01,
  hw_usb_device_class_communications = 0x02,
  hw_usb_device_class_hid = 0x03,
  hw_usb_device_class_physical = 0x05,
  hw_usb_device_class_image = 0x06,
  hw_usb_device_class_printer = 0x07,
  hw_usb_device_class_mass_storage = 0x08,
  hw_usb_device_class_hub = 0x09,
  hw_usb_device_class_cdc_data = 0x0A,
  hw_usb_device_class_smart_card = 0x0B,
  hw_usb_device_class_content_security = 0x0D,
  hw_usb_device_class_video = 0x0E,
  hw_usb_device_class_personal_healthcare = 0x0F,
  hw_usb_device_class_audio_video = 0x10,
  hw_usb_device_class_bluetooth = 0xE0,
  hw_usb_device_class_miscellaneous = 0xEF,
  hw_usb_device_class_application_specific = 0xFE,
  hw_usb_device_class_vendor_specific = 0xFF,
} hw_usb_device_class_t;

const char *hw_usb_device_class_to_string(hw_usb_device_class_t device_class);

typedef enum {
  hw_usb_device_subclass_none = 0x00,
  hw_usb_device_subclass_boot_interface = 0x01,
  hw_usb_device_subclass_abstract_control_model = 0x02,
  hw_usb_device_subclass_vendor_specific = 0xFF,
} hw_usb_device_subclass_t;

typedef enum {
  hw_usb_device_protocol_none = 0x00,
  hw_usb_device_protocol_keyboard = 0x01,
  hw_usb_device_protocol_mouse = 0x02,
} hw_usb_device_protocol_t;

const char *
hw_usb_device_protocol_to_string(hw_usb_device_protocol_t device_protocol);

typedef struct {
  uint32_t device_id; 
  uint16_t vid;                             
  uint16_t pid;                             
  hw_usb_device_class_t device_class;       
  hw_usb_device_subclass_t device_subclass; 
  hw_usb_device_protocol_t device_protocol; 
  uint8_t interface_number; 
  hw_usb_device_class_t interface_class;       
  hw_usb_device_subclass_t interface_subclass; 
  hw_usb_device_protocol_t interface_protocol; 
  char manufacturer[HW_USB_STRING_MAX_LENGTH + 1]; 
  char product[HW_USB_STRING_MAX_LENGTH + 1];      
  char serial[HW_USB_STRING_MAX_LENGTH + 1];       
} hw_usb_device_t;

typedef struct hw_usb_t hw_usb_t;

typedef void (*hw_usb_callback_t)(hw_usb_t *usb, hw_usb_event_t event,
                                  const hw_usb_device_t *device,
                                  void *userdata);

// LIFECYCLE

hw_usb_t *hw_usb_init(void);

void hw_usb_deinit(hw_usb_t *usb);

// METHODS

void hw_usb_set_callback(hw_usb_t *usb, hw_usb_callback_t callback,
                         void *userdata);

// HID INTEGRATION

hid_device_t *hw_usb_register_hid(hid_t *instance, hw_usb_t *usb);