ra8_usb_device.h

Go to the documentation of this file.

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

typedef enum : uint8_t {
  k_ra8_usb_speed_fs = 0U, 
  k_ra8_usb_speed_hs = 1U, 
} ra8_usb_speed_t;

typedef enum : uint8_t {
  k_ra8_usb_dev_state_powered    = 0U, 
  k_ra8_usb_dev_state_default    = 1U, 
  k_ra8_usb_dev_state_address    = 2U, 
  k_ra8_usb_dev_state_configured = 3U, 
  k_ra8_usb_dev_state_suspended  = 4U, 
} ra8_usb_dev_state_t;

typedef enum : uint8_t {
  k_ra8_usb_ep_dir_out = 0U, 
  k_ra8_usb_ep_dir_in  = 1U, 
} ra8_usb_ep_dir_t;

typedef enum : uint8_t {
  k_ra8_usb_ep_type_bulk = 0U, 
  k_ra8_usb_ep_type_intr = 1U, 
  k_ra8_usb_ep_type_iso  = 2U, 
} ra8_usb_ep_type_t;

typedef struct {
  uint8_t  bm_request_type; 
  uint8_t  b_request;       
  uint16_t w_value;         
  uint16_t w_index;         
  uint16_t w_length;        
} ra8_usb_setup_t;

typedef void (*ra8_usb_event_fn_t)(void* ctx, ra8_usb_speed_t speed, uint16_t status_mask);
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

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

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

[[nodiscard]] ra8_err_t ra8_usb_device_attach(ra8_usb_speed_t speed, bool attached);
 
/* =============================================================================
 * Status / state
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_get_status(ra8_usb_speed_t speed, uint16_t* out_mask);

[[nodiscard]] ra8_err_t ra8_usb_clear_status(ra8_usb_speed_t speed, uint16_t mask);

[[nodiscard]] ra8_err_t ra8_usb_get_device_state(ra8_usb_speed_t      speed,
                                                 ra8_usb_dev_state_t* out_state);

[[nodiscard]] ra8_err_t ra8_usb_set_address(ra8_usb_speed_t speed, uint8_t address);

[[nodiscard]] ra8_err_t ra8_usb_device_busreset_rearm(ra8_usb_speed_t speed);
 
/* =============================================================================
 * Endpoints
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_configure_endpoint(ra8_usb_speed_t   speed,
                                                   uint8_t           pipe_num,
                                                   uint8_t           ep_addr,
                                                   ra8_usb_ep_dir_t  dir,
                                                   ra8_usb_ep_type_t type,
                                                   uint16_t          max_packet);

[[nodiscard]] ra8_err_t ra8_usb_stall_endpoint(ra8_usb_speed_t speed, uint8_t pipe_num);

[[nodiscard]] ra8_err_t
ra8_usb_queue_in(ra8_usb_speed_t speed, uint8_t pipe_num, const uint8_t* data, uint16_t len);

[[nodiscard]] ra8_err_t ra8_usb_queue_out(ra8_usb_speed_t speed,
                                          uint8_t         pipe_num,
                                          uint8_t*        out_buf,
                                          uint16_t*       inout_len,
                                          bool            rearm);

[[nodiscard]] ra8_err_t ra8_usb_rearm_out_pipe(ra8_usb_speed_t speed, uint8_t pipe_num);

[[nodiscard]] ra8_err_t ra8_usb_park_out_pipe(ra8_usb_speed_t speed, uint8_t pipe_num);
 
/* =============================================================================
 * Control transfers (EP0 / DCP)
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_read_setup_if_valid(ra8_usb_speed_t  speed,
                                                    ra8_usb_setup_t* out_setup);

[[nodiscard]] ra8_err_t ra8_usb_read_setup_unconditional(ra8_usb_speed_t  speed,
                                                         ra8_usb_setup_t* out_setup);

[[nodiscard]] ra8_err_t ra8_usb_control_response(ra8_usb_speed_t speed, bool accept);

[[nodiscard]] ra8_err_t
ra8_usb_dcp_in_data(ra8_usb_speed_t speed, const uint8_t* data, uint16_t len);

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

[[nodiscard]] ra8_err_t
ra8_usb_dcp_out_read(ra8_usb_speed_t speed, uint8_t* buf, uint16_t cap, uint16_t* out_rx);
 
/* =============================================================================
 * IRQ delivery
 * =============================================================================
 */

void ra8_usb_attach_handler(ra8_usb_speed_t speed, ra8_usb_event_fn_t fn, void* ctx);

void ra8_usb_dispatch(ra8_usb_speed_t speed);

uint16_t ra8_usb_intsts0_snapshot(ra8_usb_speed_t speed);
 
/* =============================================================================
 * Power
 * =============================================================================
 */

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

[[nodiscard]] ra8_err_t ra8_usb_exit_stop(ra8_usb_speed_t speed);
 
#ifdef __cplusplus
}
#endif