ra8_usb_composite.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_usb_composite_max_classes = 4U,  
  k_ra8_usb_composite_max_ifs     = 16U, 
} ra8_usb_composite_limits_t;

typedef enum : uint8_t {
  k_ra8_usb_composite_class_misc          = 0xEFU, 
  k_ra8_usb_composite_subclass_common     = 0x02U, 
  k_ra8_usb_composite_protocol_iad        = 0x01U, 
  k_ra8_usb_composite_descriptor_type_iad = 0x0BU, 
} ra8_usb_composite_iad_t;
 
/* =============================================================================
 * Class-layer interface
 * =============================================================================
 */

typedef ra8_err_t (*ra8_usb_composite_init_fn_t)(void* ctx);

typedef ra8_err_t (*ra8_usb_composite_setup_fn_t)(void* ctx, const ra8_usb_setup_t* setup);

typedef ra8_err_t (*ra8_usb_composite_close_fn_t)(void* ctx);

typedef struct {
  uint8_t                      interface_number_first; 
  uint8_t                      interface_number_count; 
  ra8_usb_composite_init_fn_t  init;                   
  ra8_usb_composite_setup_fn_t handle_setup;           
  ra8_usb_composite_close_fn_t close;                  
  void*                        ctx;                    
} ra8_usb_composite_class_t;
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

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

[[nodiscard]] ra8_err_t ra8_usb_composite_close(void);
 
/* =============================================================================
 * Class registration
 * =============================================================================
 */

[[nodiscard]] ra8_err_t
ra8_usb_composite_register_class(const ra8_usb_composite_class_t* class_layer);
 
/* =============================================================================
 * Descriptors
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_composite_set_descriptors(const uint8_t* device_desc,
                                                          const uint8_t* config_desc);
 
/* =============================================================================
 * Dispatch
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_composite_step(void);
 
/* =============================================================================
 * Test / introspection helpers
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_composite_dispatch_setup(const ra8_usb_setup_t* setup,
                                                         uint8_t*               out_handler_class);

[[nodiscard]] ra8_err_t ra8_usb_composite_get_class_count(uint8_t* out_count);

[[nodiscard]] ra8_err_t ra8_usb_composite_get_device_descriptor(const uint8_t** out_desc);

[[nodiscard]] ra8_err_t ra8_usb_composite_get_config_descriptor(const uint8_t** out_desc);
 
#ifdef __cplusplus
}
#endif