ra8_usb_paud.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_paud_pipe_iso_in  = 1U, 
  k_ra8_paud_pipe_iso_out = 2U, 
} ra8_usb_paud_pipe_t;

typedef enum : uint8_t {
  k_ra8_paud_ep_iso_in_addr  = 1U, 
  k_ra8_paud_ep_iso_out_addr = 2U, 
} ra8_usb_paud_ep_t;

typedef enum : uint16_t {
  k_ra8_paud_iso_max_packet_fs_default = 192U,  
  k_ra8_paud_iso_max_packet_fs         = 1023U, 
  k_ra8_paud_iso_max_packet_hs         = 1024U, 
} ra8_usb_paud_packet_t;

typedef enum : uint8_t {
  k_ra8_paud_class_audio        = 0x01U, 
  k_ra8_paud_subclass_control   = 0x01U, 
  k_ra8_paud_subclass_streaming = 0x02U, 
  k_ra8_paud_protocol_none      = 0x00U, 
} ra8_usb_paud_class_t;

typedef enum : uint8_t {
  k_ra8_paud_req_set_cur  = 0x01U, 
  k_ra8_paud_req_get_cur  = 0x81U, 
  k_ra8_paud_req_set_min  = 0x02U, 
  k_ra8_paud_req_get_min  = 0x82U, 
  k_ra8_paud_req_set_max  = 0x03U, 
  k_ra8_paud_req_get_max  = 0x83U, 
  k_ra8_paud_req_set_res  = 0x04U, 
  k_ra8_paud_req_get_res  = 0x84U, 
  k_ra8_paud_req_get_stat = 0xFFU, 
} ra8_usb_paud_request_t;

typedef enum : uint8_t {
  k_ra8_paud_ctl_mute        = 0x01U, 
  k_ra8_paud_ctl_volume      = 0x02U, 
  k_ra8_paud_ctl_sample_rate = 0x01U, 
} ra8_usb_paud_control_sel_t;

typedef struct {
  uint32_t sample_rate_hz;   
  uint8_t  channels;         
  uint8_t  bytes_per_sample; 
} ra8_usb_paud_format_t;

typedef ra8_err_t (*ra8_usb_paud_setup_fn_t)(void* ctx, const ra8_usb_setup_t* setup);
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

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

[[nodiscard]] ra8_err_t ra8_usb_paud_close(void);
 
/* =============================================================================
 * Descriptor handoff
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_paud_set_descriptors(const uint8_t* desc, uint16_t desc_len);
 
/* =============================================================================
 * Audio data transport
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_paud_send_frame(const uint8_t* frame, uint16_t len);

[[nodiscard]] ra8_err_t ra8_usb_paud_recv_frame(uint8_t* buf, uint16_t max_len, uint16_t* got_len);
 
/* =============================================================================
 * Format / volume helpers
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_paud_set_format(ra8_usb_paud_format_t format);

[[nodiscard]] ra8_err_t ra8_usb_paud_get_format(ra8_usb_paud_format_t* out_format);

[[nodiscard]] ra8_err_t ra8_usb_paud_set_volume(int16_t volume_q8_8);

[[nodiscard]] ra8_err_t ra8_usb_paud_get_volume(int16_t* out_volume);
 
/* =============================================================================
 * Setup-handler attach
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_paud_attach_setup_handler(ra8_usb_paud_setup_fn_t setup_fn,
                                                          void*                   ctx);
 
/* =============================================================================
 * Class SETUP dispatch
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_paud_handle_setup(const ra8_usb_setup_t* setup);
 
#ifdef __cplusplus
}
#endif