ra8_usb_cdc.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_cdc_pipe_bulk_in  = 1U, 
  k_ra8_cdc_pipe_bulk_out = 2U, 
  k_ra8_cdc_pipe_intr_in  = 6U, 
} ra8_usb_cdc_pipe_t;

typedef enum : uint8_t {
  k_ra8_cdc_ep_bulk_in_addr  = 1U, 
  k_ra8_cdc_ep_bulk_out_addr = 2U, 
  k_ra8_cdc_ep_intr_in_addr  = 3U, 
} ra8_usb_cdc_ep_t;

typedef enum : uint16_t {
  k_ra8_cdc_bulk_max_packet_fs = 64U,  
  k_ra8_cdc_bulk_max_packet_hs = 512U, 
  k_ra8_cdc_intr_max_packet    = 8U,   
} ra8_usb_cdc_packet_t;

typedef enum : uint8_t {
  k_ra8_cdc_req_set_line_coding        = 0x20U, 
  k_ra8_cdc_req_get_line_coding        = 0x21U, 
  k_ra8_cdc_req_set_control_line_state = 0x22U, 
} ra8_usb_cdc_request_t;

typedef enum : uint16_t {
  k_ra8_cdc_line_state_dtr = 0x0001U, 
  k_ra8_cdc_line_state_rts = 0x0002U, 
} ra8_usb_cdc_line_state_t;

typedef struct {
  uint32_t dte_rate;    
  uint8_t  char_format; 
  uint8_t  parity_type; 
  uint8_t  data_bits;   
} ra8_usb_cdc_line_coding_t;
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

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

[[nodiscard]] ra8_err_t ra8_usb_cdc_deinit(void);

[[nodiscard]] ra8_err_t ra8_usb_cdc_attach(bool attached);
 
/* =============================================================================
 * Bulk byte pipe
 * =============================================================================
 */

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

[[nodiscard]] ra8_err_t ra8_usb_cdc_recv(uint8_t* out_buf, uint16_t* inout_len);
 
/* =============================================================================
 * SETUP request handler
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_cdc_handle_setup(const ra8_usb_setup_t* setup);

[[nodiscard]] ra8_err_t ra8_usb_cdc_get_line_coding(ra8_usb_cdc_line_coding_t* out);

[[nodiscard]] ra8_err_t ra8_usb_cdc_get_line_state(bool* out_dtr, bool* out_rts);
 
#ifdef __cplusplus
}
#endif