ra8_usb_phid.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_phid_pipe_intr_in  = 6U, 
  k_ra8_phid_pipe_intr_out = 7U, 
} ra8_usb_phid_pipe_t;

typedef enum : uint8_t {
  k_ra8_phid_ep_intr_in_addr  = 1U, 
  k_ra8_phid_ep_intr_out_addr = 2U, 
} ra8_usb_phid_ep_t;

typedef enum : uint16_t {
  k_ra8_phid_intr_max_packet_default = 8U,    
  k_ra8_phid_intr_max_packet_fs      = 64U,   
  k_ra8_phid_intr_max_packet_hs      = 1024U, 
} ra8_usb_phid_packet_t;

typedef enum : uint8_t {
  k_ra8_phid_class_hid         = 0x03U, 
  k_ra8_phid_subclass_none     = 0x00U, 
  k_ra8_phid_subclass_boot     = 0x01U, 
  k_ra8_phid_protocol_other    = 0x00U, 
  k_ra8_phid_protocol_keyboard = 0x01U, 
  k_ra8_phid_protocol_mouse    = 0x02U, 
} ra8_usb_phid_class_t;

typedef enum : uint8_t {
  k_ra8_phid_req_get_report   = 0x01U, 
  k_ra8_phid_req_get_idle     = 0x02U, 
  k_ra8_phid_req_get_protocol = 0x03U, 
  k_ra8_phid_req_set_report   = 0x09U, 
  k_ra8_phid_req_set_idle     = 0x0AU, 
  k_ra8_phid_req_set_protocol = 0x0BU, 
} ra8_usb_phid_request_t;

typedef enum : uint8_t {
  k_ra8_phid_report_type_input   = 0x01U, 
  k_ra8_phid_report_type_output  = 0x02U, 
  k_ra8_phid_report_type_feature = 0x03U, 
} ra8_usb_phid_report_type_t;

typedef enum : uint8_t {
  k_ra8_phid_proto_boot   = 0U, 
  k_ra8_phid_proto_report = 1U, 
} ra8_usb_phid_protocol_select_t;

typedef enum : uint8_t {
  k_ra8_phid_desc_hid      = 0x21U, 
  k_ra8_phid_desc_report   = 0x22U, 
  k_ra8_phid_desc_physical = 0x23U, 
} ra8_usb_phid_desc_t;

typedef ra8_err_t (*ra8_usb_phid_setup_fn_t)(void* ctx, const ra8_usb_setup_t* setup);
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

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

[[nodiscard]] ra8_err_t ra8_usb_phid_close(void);
 
/* =============================================================================
 * Descriptor handoff
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_phid_set_descriptors(const uint8_t* report_desc,
                                                     uint16_t       report_desc_len,
                                                     const uint8_t* hid_desc,
                                                     uint16_t       hid_desc_len);
 
/* =============================================================================
 * Input / output reports
 * =============================================================================
 */

[[nodiscard]] ra8_err_t
ra8_usb_phid_send_report(uint8_t report_id, const uint8_t* payload, uint16_t len);

[[nodiscard]] ra8_err_t
ra8_usb_phid_recv_report(uint8_t report_id, uint8_t* buf, uint16_t max_len, uint16_t* got_len);
 
/* =============================================================================
 * Setup-handler attach
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_phid_attach_setup_handler(ra8_usb_phid_setup_fn_t setup_fn,
                                                          void*                   ctx);
 
/* =============================================================================
 * Class SETUP dispatch
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_phid_handle_setup(const ra8_usb_setup_t* setup);
 
/* =============================================================================
 * Introspection
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_phid_get_idle(uint8_t* out_idle_rate);

[[nodiscard]] ra8_err_t ra8_usb_phid_get_protocol(ra8_usb_phid_protocol_select_t* out_protocol);
 
#ifdef __cplusplus
}
#endif