ra8_usb_hmsc.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_hmsc_pipe_bulk_in  = 3U, 
  k_ra8_hmsc_pipe_bulk_out = 4U, 
} ra8_usb_hmsc_pipe_t;

typedef enum : uint16_t {
  k_ra8_hmsc_bulk_max_packet_fs = 64U,  
  k_ra8_hmsc_bulk_max_packet_hs = 512U, 
} ra8_usb_hmsc_packet_t;

typedef enum : uint8_t {
  k_ra8_hmsc_class_msc     = 0x08U, 
  k_ra8_hmsc_subclass_scsi = 0x06U, 
  k_ra8_hmsc_protocol_bbb  = 0x50U, 
} ra8_usb_hmsc_class_t;

typedef enum : uint8_t {
  k_ra8_hmsc_req_mass_storage_reset = 0xFFU, 
  k_ra8_hmsc_req_get_max_lun        = 0xFEU, 
} ra8_usb_hmsc_request_t;

typedef enum : uint8_t {
  k_ra8_hmsc_max_lun = 4U, 
} ra8_usb_hmsc_max_lun_t;

typedef enum : uint8_t {
  k_ra8_hmsc_csw_status_passed      = 0x00U, 
  k_ra8_hmsc_csw_status_failed      = 0x01U, 
  k_ra8_hmsc_csw_status_phase_error = 0x02U, 
} ra8_usb_hmsc_csw_status_t;

typedef enum : uint8_t {
  k_ra8_hmsc_scsi_test_unit_ready  = 0x00U, 
  k_ra8_hmsc_scsi_request_sense    = 0x03U, 
  k_ra8_hmsc_scsi_inquiry          = 0x12U, 
  k_ra8_hmsc_scsi_read_capacity_10 = 0x25U, 
  k_ra8_hmsc_scsi_read_10          = 0x28U, 
  k_ra8_hmsc_scsi_write_10         = 0x2AU, 
} ra8_usb_hmsc_scsi_t;

typedef enum : uint16_t {
  k_ra8_hmsc_inquiry_resp_len       = 36U,  
  k_ra8_hmsc_read_capacity_resp_len = 8U,   
  k_ra8_hmsc_block_size_default     = 512U, 
} ra8_usb_hmsc_resp_size_t;

typedef struct {
  uint8_t  device_address;      
  uint8_t  bulk_in_ep;          
  uint8_t  bulk_out_ep;         
  uint8_t  max_lun;             
  uint8_t  interface_number;    
  uint16_t bulk_in_max_packet;  
  uint16_t bulk_out_max_packet; 
  uint16_t vendor_id;           
  uint16_t product_id;          
} ra8_usb_hmsc_device_t;

typedef struct {
  uint8_t peripheral_qualifier;   
  uint8_t peripheral_device_type; 
  uint8_t removable;              
  uint8_t version;                
  uint8_t vendor_id[8];           
  uint8_t product_id[16];         
  uint8_t product_revision[4];    
} ra8_usb_hmsc_inquiry_response_t;

typedef void (*ra8_usb_hmsc_attach_fn_t)(void* ctx, const ra8_usb_hmsc_device_t* device);
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

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

[[nodiscard]] ra8_err_t ra8_usb_hmsc_close(void);

[[nodiscard]] ra8_err_t ra8_usb_hmsc_enumerate(ra8_usb_hmsc_device_t* out_device);
 
/* =============================================================================
 * Attach callback
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_hmsc_attach_callback(ra8_usb_hmsc_attach_fn_t on_attach, void* ctx);
 
/* =============================================================================
 * SCSI commands (Bulk-Only Transport)
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_hmsc_inquiry(uint8_t                          target_lun,
                                             ra8_usb_hmsc_inquiry_response_t* response);

[[nodiscard]] ra8_err_t
ra8_usb_hmsc_read_capacity(uint8_t target_lun, uint32_t* block_count, uint32_t* block_size);

[[nodiscard]] ra8_err_t
ra8_usb_hmsc_read10(uint8_t target_lun, uint32_t lba, uint16_t block_count, uint8_t* out_buf);

[[nodiscard]] ra8_err_t
ra8_usb_hmsc_write10(uint8_t target_lun, uint32_t lba, uint16_t block_count, const uint8_t* in_buf);
 
/* =============================================================================
 * Test / introspection helpers
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_usb_hmsc_build_cbw(uint8_t        target_lun,
                                               uint32_t       data_transfer_length,
                                               bool           data_in,
                                               const uint8_t* cdb,
                                               uint8_t        cdb_len,
                                               uint8_t*       out_cbw);

[[nodiscard]] ra8_err_t ra8_usb_hmsc_decode_csw(const uint8_t*             csw,
                                                uint32_t                   expected_tag,
                                                ra8_usb_hmsc_csw_status_t* out_status);
 
#ifdef __cplusplus
}
#endif