ra8_usb_hcdc.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_hcdc_pipe_bulk_in  = 1U, 
  k_ra8_hcdc_pipe_bulk_out = 2U, 
  k_ra8_hcdc_pipe_intr_in  = 6U, 
} ra8_usb_hcdc_pipe_t;

typedef enum : uint16_t {
  k_ra8_hcdc_bulk_max_packet_fs = 64U,  
  k_ra8_hcdc_bulk_max_packet_hs = 512U, 
  k_ra8_hcdc_intr_max_packet    = 8U,   
} ra8_usb_hcdc_packet_t;

typedef enum : uint8_t {
  k_ra8_hcdc_class_comms     = 0x02U, 
  k_ra8_hcdc_subclass_acm    = 0x02U, 
  k_ra8_hcdc_protocol_at_v25 = 0x01U, 
  k_ra8_hcdc_class_data      = 0x0AU, 
  k_ra8_hcdc_subclass_zero   = 0x00U, 
  k_ra8_hcdc_protocol_zero   = 0x00U, 
} ra8_usb_hcdc_class_t;

typedef enum : uint8_t {
  k_ra8_hcdc_req_set_line_coding        = 0x20U, 
  k_ra8_hcdc_req_get_line_coding        = 0x21U, 
  k_ra8_hcdc_req_set_control_line_state = 0x22U, 
} ra8_usb_hcdc_request_t;

typedef enum : uint8_t {
  k_ra8_hcdc_parity_none  = 0U, 
  k_ra8_hcdc_parity_odd   = 1U, 
  k_ra8_hcdc_parity_even  = 2U, 
  k_ra8_hcdc_parity_mark  = 3U, 
  k_ra8_hcdc_parity_space = 4U, 
} ra8_usb_hcdc_parity_t;

typedef enum : uint8_t {
  k_ra8_hcdc_stop_1   = 0U, 
  k_ra8_hcdc_stop_1_5 = 1U, 
  k_ra8_hcdc_stop_2   = 2U, 
} ra8_usb_hcdc_stop_bits_t;

typedef struct {
  uint8_t  device_address;      
  uint8_t  bulk_in_ep;          
  uint8_t  bulk_out_ep;         
  uint8_t  intr_in_ep;          
  uint16_t bulk_in_max_packet;  
  uint16_t bulk_out_max_packet; 
  uint16_t vendor_id;           
  uint16_t product_id;          
} ra8_usb_hcdc_device_t;

typedef void (*ra8_usb_hcdc_attach_fn_t)(void* ctx, const ra8_usb_hcdc_device_t* device);
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

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

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

[[nodiscard]] ra8_err_t ra8_usb_hcdc_attach_callback(ra8_usb_hcdc_attach_fn_t on_attach, void* ctx);
 
/* =============================================================================
 * Bulk byte pipe
 * =============================================================================
 */

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

[[nodiscard]] ra8_err_t ra8_usb_hcdc_recv(uint8_t* out_buf, uint16_t max_len, uint16_t* got_len);
 
/* =============================================================================
 * Class control transfer
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_hcdc_set_line_coding(uint32_t                 baud,
                                                     ra8_usb_hcdc_parity_t    parity,
                                                     ra8_usb_hcdc_stop_bits_t stop_bits);
 
/* =============================================================================
 * Test / introspection helpers
 * =============================================================================
 */

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