ra8_usb_pvnd.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_pvnd_pipe_bulk_in  = 5U, 
  k_ra8_pvnd_pipe_bulk_out = 1U, 
} ra8_usb_pvnd_pipe_t;

typedef enum : uint8_t {
  k_ra8_pvnd_ep_bulk_in_addr  = 1U, 
  k_ra8_pvnd_ep_bulk_out_addr = 2U, 
} ra8_usb_pvnd_ep_t;

typedef enum : uint16_t {
  k_ra8_pvnd_bulk_max_packet_fs = 64U,  
  k_ra8_pvnd_bulk_max_packet_hs = 512U, 
} ra8_usb_pvnd_packet_t;

typedef enum : uint8_t {
  k_ra8_pvnd_class_vendor = 0xFFU, 
} ra8_usb_pvnd_class_t;

typedef enum : uint8_t {
  k_ra8_pvnd_bm_vendor_dev_in    = 0xC0U, 
  k_ra8_pvnd_bm_vendor_dev_out   = 0x40U, 
  k_ra8_pvnd_bm_vendor_iface_in  = 0xC1U, 
  k_ra8_pvnd_bm_vendor_iface_out = 0x41U, 
  k_ra8_pvnd_bm_vendor_ep_in     = 0xC2U, 
  k_ra8_pvnd_bm_vendor_ep_out    = 0x42U, 
} ra8_usb_pvnd_envelope_t;

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

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

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

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

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

[[nodiscard]] ra8_err_t ra8_usb_pvnd_recv(uint8_t* buf, uint16_t max_len, uint16_t* got_len);
 
/* =============================================================================
 * Setup-handler attach
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_pvnd_attach_setup_handler(ra8_usb_pvnd_setup_fn_t setup_fn,
                                                          void*                   ctx);
 
/* =============================================================================
 * Vendor SETUP dispatch
 * =============================================================================
 */

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