ra8_usb_hhid.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_err.h"
#include "ra8_usb.h"
 
/* =============================================================================
 * Constants
 * =============================================================================
 */

typedef enum : uint8_t {
  k_ra8_hhid_pipe_intr_in  = 6U, 
  k_ra8_hhid_pipe_intr_out = 7U, 
} ra8_usb_hhid_pipe_t;

typedef enum : uint16_t {
  k_ra8_hhid_intr_max_packet_default = 8U,    
  k_ra8_hhid_intr_max_packet_fs      = 64U,   
  k_ra8_hhid_intr_max_packet_hs      = 1024U, 
} ra8_usb_hhid_packet_t;

typedef enum : uint8_t {
  k_ra8_hhid_class_hid         = 0x03U, 
  k_ra8_hhid_subclass_none     = 0x00U, 
  k_ra8_hhid_subclass_boot     = 0x01U, 
  k_ra8_hhid_protocol_other    = 0x00U, 
  k_ra8_hhid_protocol_keyboard = 0x01U, 
  k_ra8_hhid_protocol_mouse    = 0x02U, 
} ra8_usb_hhid_class_t;

typedef enum : uint8_t {
  k_ra8_hhid_req_get_report   = 0x01U, 
  k_ra8_hhid_req_get_idle     = 0x02U, 
  k_ra8_hhid_req_get_protocol = 0x03U, 
  k_ra8_hhid_req_set_report   = 0x09U, 
  k_ra8_hhid_req_set_idle     = 0x0AU, 
  k_ra8_hhid_req_set_protocol = 0x0BU, 
} ra8_usb_hhid_request_t;

typedef enum : uint8_t {
  k_ra8_hhid_report_type_input   = 0x01U, 
  k_ra8_hhid_report_type_output  = 0x02U, 
  k_ra8_hhid_report_type_feature = 0x03U, 
} ra8_usb_hhid_report_type_t;

typedef enum : uint8_t {
  k_ra8_hhid_proto_boot   = 0U, 
  k_ra8_hhid_proto_report = 1U, 
} ra8_usb_hhid_protocol_select_t;

typedef enum : uint8_t {
  k_ra8_hhid_desc_hid      = 0x21U, 
  k_ra8_hhid_desc_report   = 0x22U, 
  k_ra8_hhid_desc_physical = 0x23U, 
} ra8_usb_hhid_desc_t;

typedef enum : uint16_t {
  k_ra8_hhid_report_desc_max = 256U, 
} ra8_usb_hhid_report_buf_t;

typedef struct {
  uint8_t        device_address;        
  uint8_t        intr_in_ep;            
  uint8_t        intr_out_ep;           
  uint8_t        interface_number;      
  uint8_t        subclass;              
  uint8_t        protocol;              
  uint16_t       intr_in_max_packet;    
  uint16_t       intr_out_max_packet;   
  uint16_t       vendor_id;             
  uint16_t       product_id;            
  uint16_t       report_descriptor_len; 
  const uint8_t* hid_descriptor;        
  const uint8_t* report_descriptor;     
} ra8_usb_hhid_device_t;

typedef void (*ra8_usb_hhid_attach_fn_t)(void* ctx, const ra8_usb_hhid_device_t* device);
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_hhid_init(ra8_usb_speed_t speed);

[[nodiscard]] ra8_err_t ra8_usb_hhid_close(void);
 
/* =============================================================================
 * Attach callback
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_hhid_attach_callback(ra8_usb_hhid_attach_fn_t on_attach, void* ctx);
 
/* =============================================================================
 * Class control transfers
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_hhid_get_report(ra8_usb_hhid_report_type_t target_report_type,
                                                uint8_t                    target_report_id,
                                                uint8_t*                   out_buf,
                                                uint16_t                   max_len,
                                                uint16_t*                  got_len);

[[nodiscard]] ra8_err_t ra8_usb_hhid_set_report(ra8_usb_hhid_report_type_t target_report_type,
                                                uint8_t                    target_report_id,
                                                const uint8_t*             in_buf,
                                                uint16_t                   len);

[[nodiscard]] ra8_err_t ra8_usb_hhid_set_idle(uint8_t duration, uint8_t report_id);

[[nodiscard]] ra8_err_t ra8_usb_hhid_set_protocol(ra8_usb_hhid_protocol_select_t boot_or_report);
 
/* =============================================================================
 * Interrupt-IN polling
 * =============================================================================
 */

[[nodiscard]] ra8_err_t
ra8_usb_hhid_get_input_report(uint8_t* out_buf, uint16_t max_len, uint16_t* got_len);
 
/* =============================================================================
 * Test / introspection helpers
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_hhid_step(void);
 
#ifdef __cplusplus
}
#endif