ra8_usb_hhub.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_hhub_class_hub = 0x09U, 
} ra8_usb_hhub_class_t;

typedef enum : uint8_t {
  k_ra8_hhub_desc_hub = 0x29U, 
} ra8_usb_hhub_desc_t;

typedef enum : uint8_t {
  k_ra8_hhub_req_get_status      = 0x00U, 
  k_ra8_hhub_req_clear_feature   = 0x01U, 
  k_ra8_hhub_req_set_feature     = 0x03U, 
  k_ra8_hhub_req_get_descriptor  = 0x06U, 
  k_ra8_hhub_req_set_descriptor  = 0x07U, 
  k_ra8_hhub_req_clear_tt_buffer = 0x08U, 
  k_ra8_hhub_req_reset_tt        = 0x09U, 
} ra8_usb_hhub_request_t;

typedef enum : uint16_t {
  k_ra8_hhub_feature_port_connection   = 0U,  
  k_ra8_hhub_feature_port_enable       = 1U,  
  k_ra8_hhub_feature_port_suspend      = 2U,  
  k_ra8_hhub_feature_port_overcurrent  = 3U,  
  k_ra8_hhub_feature_port_reset        = 4U,  
  k_ra8_hhub_feature_port_power        = 8U,  
  k_ra8_hhub_feature_port_low_speed    = 9U,  
  k_ra8_hhub_feature_c_port_connection = 16U, 
  k_ra8_hhub_feature_c_port_enable     = 17U, 
  k_ra8_hhub_feature_c_port_suspend    = 18U, 
  k_ra8_hhub_feature_c_port_overcurr   = 19U, 
  k_ra8_hhub_feature_c_port_reset      = 20U, 
} ra8_usb_hhub_feature_t;

typedef enum : uint8_t {
  k_ra8_hhub_status_bit_connection  = 0U,  
  k_ra8_hhub_status_bit_enable      = 1U,  
  k_ra8_hhub_status_bit_suspend     = 2U,  
  k_ra8_hhub_status_bit_overcurrent = 3U,  
  k_ra8_hhub_status_bit_reset       = 4U,  
  k_ra8_hhub_status_bit_power       = 8U,  
  k_ra8_hhub_status_bit_low_speed   = 9U,  
  k_ra8_hhub_status_bit_high_speed  = 10U, 
} ra8_usb_hhub_port_status_bits_t;

typedef enum : uint8_t {
  k_ra8_hhub_max_ports  = 16U, 
  k_ra8_hhub_first_port = 1U,  
} ra8_usb_hhub_limits_t;

typedef struct {
  uint8_t  device_address; 
  uint8_t  port_count;     
  uint16_t vendor_id;      
  uint16_t product_id;     
} ra8_usb_hhub_device_t;

typedef void (*ra8_usb_hhub_attach_fn_t)(void* ctx, const ra8_usb_hhub_device_t* device);
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

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

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

[[nodiscard]] ra8_err_t ra8_usb_hhub_attach_callback(ra8_usb_hhub_attach_fn_t on_attach, void* ctx);
 
/* =============================================================================
 * HUB class control transfers
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_hhub_get_port_count(uint8_t* count);

[[nodiscard]] ra8_err_t ra8_usb_hhub_get_port_status(uint8_t port, uint32_t* status);

[[nodiscard]] ra8_err_t ra8_usb_hhub_set_port_feature(uint8_t port, ra8_usb_hhub_feature_t feature);

[[nodiscard]] ra8_err_t ra8_usb_hhub_clear_port_feature(uint8_t                port,
                                                        ra8_usb_hhub_feature_t feature);
 
/* =============================================================================
 * Test / introspection helpers
 * =============================================================================
 */

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