ra8_usb_pmsc.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_pmsc_pipe_bulk_in  = 3U, 
  k_ra8_pmsc_pipe_bulk_out = 4U, 
} ra8_usb_pmsc_pipe_t;

typedef enum : uint8_t {
  k_ra8_pmsc_ep_bulk_in  = 1U, 
  k_ra8_pmsc_ep_bulk_out = 2U, 
} ra8_usb_pmsc_endpoint_t;

typedef enum : uint16_t {
  k_ra8_pmsc_bulk_max_packet_fs = 64U,  
  k_ra8_pmsc_bulk_max_packet_hs = 512U, 
} ra8_usb_pmsc_packet_t;

typedef enum : uint8_t {
  k_ra8_pmsc_class_msc     = 0x08U, 
  k_ra8_pmsc_subclass_scsi = 0x06U, 
  k_ra8_pmsc_protocol_bbb  = 0x50U, 
} ra8_usb_pmsc_class_t;

typedef enum : uint8_t {
  k_ra8_pmsc_req_mass_storage_reset = 0xFFU, 
  k_ra8_pmsc_req_get_max_lun        = 0xFEU, 
} ra8_usb_pmsc_request_t;

typedef enum : uint8_t {
  k_ra8_pmsc_max_lun = 0U, 
} ra8_usb_pmsc_max_lun_t;

typedef enum : uint8_t {
  k_ra8_pmsc_csw_status_passed      = 0x00U, 
  k_ra8_pmsc_csw_status_failed      = 0x01U, 
  k_ra8_pmsc_csw_status_phase_error = 0x02U, 
} ra8_usb_pmsc_csw_status_t;

typedef enum : uint8_t {
  k_ra8_pmsc_scsi_test_unit_ready  = 0x00U, 
  k_ra8_pmsc_scsi_request_sense    = 0x03U, 
  k_ra8_pmsc_scsi_inquiry          = 0x12U, 
  k_ra8_pmsc_scsi_mode_sense_6     = 0x1AU, 
  k_ra8_pmsc_scsi_read_capacity_10 = 0x25U, 
  k_ra8_pmsc_scsi_read_10          = 0x28U, 
  k_ra8_pmsc_scsi_write_10         = 0x2AU, 
} ra8_usb_pmsc_scsi_t;

typedef enum : uint16_t {
  k_ra8_pmsc_inquiry_resp_len       = 36U,  
  k_ra8_pmsc_read_capacity_resp_len = 8U,   
  k_ra8_pmsc_request_sense_resp_len = 18U,  
  k_ra8_pmsc_mode_sense_resp_len    = 4U,   
  k_ra8_pmsc_block_size_default     = 512U, 
} ra8_usb_pmsc_resp_size_t;

typedef enum : uint8_t {
  k_ra8_pmsc_inq_vendor_len   = 8U,  
  k_ra8_pmsc_inq_product_len  = 16U, 
  k_ra8_pmsc_inq_revision_len = 4U,  
} ra8_usb_pmsc_inquiry_field_t;
 
/* =============================================================================
 * Storage backend interface (Dependency Inversion)
 * =============================================================================
 */

typedef ra8_err_t (*ra8_usb_pmsc_read_block_fn_t)(void*    ctx,
                                                  uint32_t lba,
                                                  uint32_t block_count,
                                                  uint8_t* buf);

typedef ra8_err_t (*ra8_usb_pmsc_write_block_fn_t)(void*          ctx,
                                                   uint32_t       lba,
                                                   uint32_t       block_count,
                                                   const uint8_t* buf);

typedef ra8_err_t (*ra8_usb_pmsc_get_capacity_fn_t)(void*     ctx,
                                                    uint32_t* block_count,
                                                    uint32_t* block_size);

typedef ra8_err_t (*ra8_usb_pmsc_get_inquiry_fn_t)(void*    ctx,
                                                   uint8_t* vendor8,
                                                   uint8_t* product16,
                                                   uint8_t* revision4);

typedef struct {
  ra8_usb_pmsc_read_block_fn_t   read_block;   
  ra8_usb_pmsc_write_block_fn_t  write_block;  
  ra8_usb_pmsc_get_capacity_fn_t get_capacity; 
  ra8_usb_pmsc_get_inquiry_fn_t  get_inquiry;  
  void*                          ctx;          
} ra8_usb_pmsc_storage_t;
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

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

[[nodiscard]] ra8_err_t ra8_usb_pmsc_close(void);
 
/* =============================================================================
 * Storage backend
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_pmsc_attach_storage(const ra8_usb_pmsc_storage_t* storage);
 
/* =============================================================================
 * BOT state machine
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_pmsc_step(void);
 
/* =============================================================================
 * Test / introspection helpers
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_pmsc_feed_cbw(const uint8_t* cbw);

[[nodiscard]] ra8_err_t ra8_usb_pmsc_dispatch_command(uint8_t*                   data_buf,
                                                      uint32_t                   data_buf_capacity,
                                                      uint32_t*                  data_len,
                                                      ra8_usb_pmsc_csw_status_t* csw_status);

[[nodiscard]] ra8_err_t
ra8_usb_pmsc_build_csw(ra8_usb_pmsc_csw_status_t csw_status, uint32_t residue, uint8_t* out_csw);
 
#ifdef __cplusplus
}
#endif