ra8_usb_pal.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 : uint16_t {
  k_ra8_usb_pal_ep_max         = 10U,   
  k_ra8_usb_pal_ep0_max_packet = 64U,   
  k_ra8_usb_pal_bulk_max_fs    = 64U,   
  k_ra8_usb_pal_bulk_max_hs    = 512U,  
  k_ra8_usb_pal_xfer_max       = 1024U, 
  k_ra8_usb_pal_ep_addr_mask   = 0x7FU, 
} ra8_usb_pal_limits_t;

typedef enum : uint8_t {
  k_ra8_usb_pal_ep_dir_out = 0U, 
  k_ra8_usb_pal_ep_dir_in  = 1U, 
} ra8_usb_pal_ep_dir_t;

typedef enum : uint8_t {
  k_ra8_usb_pal_ep_type_control = 0U, 
  k_ra8_usb_pal_ep_type_iso     = 1U, 
  k_ra8_usb_pal_ep_type_bulk    = 2U, 
  k_ra8_usb_pal_ep_type_intr    = 3U, 
} ra8_usb_pal_ep_type_t;

typedef enum : uint8_t {
  k_ra8_usb_pal_state_detached  = 0U, 
  k_ra8_usb_pal_state_attached  = 1U, 
  k_ra8_usb_pal_state_default   = 2U, 
  k_ra8_usb_pal_state_addressed = 3U, 
  k_ra8_usb_pal_state_configd   = 4U, 
  k_ra8_usb_pal_state_suspended = 5U, 
} ra8_usb_pal_state_t;
 
/* =============================================================================
 * Event bits (relayed from ra8_usb status mask)
 * =============================================================================
 */

typedef enum : uint16_t {
  k_ra8_usb_pal_event_none    = 0x0000U, 
  k_ra8_usb_pal_event_reset   = 0x0001U, 
  k_ra8_usb_pal_event_suspend = 0x0002U, 
  k_ra8_usb_pal_event_resume  = 0x0004U, 
  k_ra8_usb_pal_event_setup   = 0x0008U, 
  k_ra8_usb_pal_event_ep_in   = 0x0010U, 
  k_ra8_usb_pal_event_ep_out  = 0x0020U, 
  k_ra8_usb_pal_event_sof     = 0x0040U, 
  k_ra8_usb_pal_event_attach  = 0x0080U, 
  k_ra8_usb_pal_event_detach  = 0x0100U, 
  k_ra8_usb_pal_event_error   = 0x8000U, 
} ra8_usb_pal_event_t;

typedef void (*ra8_usb_pal_event_fn_t)(void* ctx, ra8_usb_speed_t speed, uint16_t event_mask);
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

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

[[nodiscard]] ra8_err_t ra8_usb_pal_deinit(void);
 
/* =============================================================================
 * Bus state
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_pal_attach(bool attached);

[[nodiscard]] ra8_err_t ra8_usb_pal_get_state(ra8_usb_pal_state_t* out_state);
 
/* =============================================================================
 * Endpoint I/O
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_pal_ep_open(uint8_t               ep_addr,
                                            ra8_usb_pal_ep_dir_t  dir,
                                            ra8_usb_pal_ep_type_t type,
                                            uint16_t              max_packet);

[[nodiscard]] ra8_err_t ra8_usb_pal_ep_send(uint8_t ep_addr, const uint8_t* data, uint16_t len);

[[nodiscard]] ra8_err_t ra8_usb_pal_ep_recv(uint8_t ep_addr, uint8_t* out_buf, uint16_t* inout_len);
 
/* =============================================================================
 * Async event handler
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_pal_set_event_handler(ra8_usb_pal_event_fn_t fn, void* ctx);
 
#ifdef __cplusplus
}
#endif