usb_selftest_ospi_steps.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdint.h>
 
#include "ra8_err.h"
 
/* -------------------------------------------------------------------------- */
/* Tunables */
/* -------------------------------------------------------------------------- */

typedef enum : uint32_t {
  k_selftest_thread_stack    = 4096U,   
  k_selftest_host_stack      = 8192U,   
  k_selftest_usbx_pool_bytes = 32768U,  
  k_selftest_block_size      = 512U,    
  k_selftest_idle_ticks      = 50U,     
  k_selftest_boot_wait_ticks = 500U,    
  k_selftest_retry_ticks     = 5000U,   
  k_selftest_baud            = 115200U, 
  k_selftest_print_cap       = 160U,    
  k_selftest_dev_priority    = 8U,      
  k_selftest_host_priority   = 24U,     
} selftest_config_t;

typedef enum : uint8_t {
  k_selftest_hex_chars_u16   = 4U,  
  k_selftest_hex_chars_u32   = 8U,  
  k_selftest_dec_chars_u32   = 10U, 
  k_selftest_nibble_bits     = 4U,  
  k_selftest_hex_digit_split = 10U, 
} selftest_hex_t;

typedef enum : uint32_t {
  k_selftest_nibble_mask = 0xFU, 
  k_selftest_dec_radix   = 10U,  
} selftest_mask_t;

typedef enum : uint32_t {
  k_selftest_burst_blocks  = 8U,          
  k_selftest_burst_bytes   = 4096U,       
  k_selftest_target_lun    = 0U,          
  k_selftest_wp_probe_lba  = 50U,         
  k_selftest_no_mismatch   = 0xFFFFFFFFU, 
  k_selftest_ms_per_sec    = 1000U,       
  k_selftest_bytes_per_kib = 1024U,       
} selftest_verify_t;

typedef enum : uint32_t {
  k_selftest_phase_boot      = 0U, 
  k_selftest_phase_host_init = 1U, 
  k_selftest_phase_enum      = 2U, 
  k_selftest_phase_mount     = 3U, 
  k_selftest_phase_verify    = 4U, 
  k_selftest_phase_wp        = 5U, 
  k_selftest_phase_pass      = 6U, 
} selftest_phase_t;

typedef enum : uint32_t {
  k_ospi_instance     = 0U,          
  k_ospi_test_offset  = 0x00100000U, 
  k_ospi_bytes        = 0x00100000U, 
  k_ospi_erase_sector = 0x00001000U, 
  k_ospi_erase_count  = 256U,        
} selftest_ospi_t;

typedef enum : uint32_t {
  k_ospi_pat_smul = 31U,   
  k_ospi_pat_imul = 131U,  
  k_ospi_pat_bias = 0xA5U, 
  k_ospi_pat_mask = 0xFFU, 
} selftest_pattern_t;

typedef enum : uint8_t {
  k_scsi_sense_illegal_request = 0x05U, 
  k_scsi_asc_lba_out_of_range  = 0x21U, 
  k_scsi_ascq_none             = 0x00U, 
} scsi_sense_code_t;

typedef enum : uint8_t {
  k_scsi_sense_data_protect  = 0x07U, 
  k_scsi_asc_write_protected = 0x27U, 
} scsi_wp_sense_t;

typedef enum : uint32_t {
  k_fat_reserved_sectors = 1U,      
  k_fat_num_fats         = 1U,      
  k_fat_fat_sectors      = 17U,     
  k_fat_root_entries     = 512U,    
  k_fat_root_sectors     = 32U,     
  k_fat_data_sectors     = 4096U,   
  k_fat_fat_lba          = 1U,      
  k_fat_root_lba         = 18U,     
  k_fat_data_lba         = 50U,     
  k_fat_total_sectors    = 4146U,   
  k_fat_first_cluster    = 2U,      
  k_fat_data_clusters    = 2048U,   
  k_fat_last_data_clus   = 2049U,   
  k_fat_entries_per_sec  = 256U,    
  k_fat_eoc              = 0xFFFFU, 
  k_fat_entry0           = 0xFFF8U, 
} selftest_fat_geom_t;

typedef enum : uint32_t {
  k_boot_jmp0        = 0xEBU,       
  k_boot_jmp1        = 0x3CU,       
  k_boot_jmp2        = 0x90U,       
  k_boot_media       = 0xF8U,       
  k_boot_sec_per_trk = 32U,         
  k_boot_num_heads   = 16U,         
  k_boot_drive_num   = 0x80U,       
  k_boot_ext_sig     = 0x29U,       
  k_boot_volume_id   = 0x52A8D20AU, 
  k_boot_sig_lo      = 0x55U,       
  k_boot_sig_hi      = 0xAAU,       
  k_boot_sig_lo_off  = 510U,        
  k_boot_sig_hi_off  = 511U,        
} selftest_fat_boot_t;

typedef enum : uint8_t {
  k_bpb_off_jmp        = 0U,    
  k_bpb_off_oem        = 3U,    
  k_bpb_off_bps        = 11U,   
  k_bpb_off_spc        = 13U,   
  k_bpb_off_rsvd       = 14U,   
  k_bpb_off_nfats      = 16U,   
  k_bpb_off_rootent    = 17U,   
  k_bpb_off_totsec16   = 19U,   
  k_bpb_off_media      = 21U,   
  k_bpb_off_fatsz16    = 22U,   
  k_bpb_off_spt        = 24U,   
  k_bpb_off_heads      = 26U,   
  k_bpb_off_drvnum     = 36U,   
  k_bpb_off_bootsig    = 38U,   
  k_bpb_off_volid      = 39U,   
  k_bpb_off_label      = 43U,   
  k_bpb_off_fstype     = 54U,   
  k_dir_entry_bytes    = 32U,   
  k_dir_off_attr       = 11U,   
  k_dir_off_cluster_lo = 26U,   
  k_dir_off_size       = 28U,   
  k_dir_attr_volume    = 0x08U, 
  k_dir_attr_read_only = 0x01U, 
  k_dir_name_bytes     = 11U,   
  k_byte_shift         = 8U,    
  k_byte_mask          = 0xFFU, 
} selftest_fat_off_t;

typedef enum : uint32_t {
  k_word_shift = 16U,     
  k_word_mask  = 0xFFFFU, 
} selftest_word_pack_t;
 
#ifndef RA8_OFF_TARGET
 
#include "ra8_fs.h"
#include "ra8_usb_hmsc.h"
#include "tx_api.h"
 
/* -------------------------------------------------------------------------- */
/* FAT16 synthesis + storage media callbacks (usb_selftest_ospi_format.c) */
/* -------------------------------------------------------------------------- */

void selftest_pattern_fill(uint32_t win_sector, UCHAR* out);

UINT selftest_msc_read(VOID*  storage,
                       ULONG  lun,
                       UCHAR* data_pointer,
                       ULONG  number_blocks,
                       ULONG  lba,
                       ULONG* media_status);

UINT selftest_msc_write(VOID*  storage,
                        ULONG  lun,
                        UCHAR* data_pointer,
                        ULONG  number_blocks,
                        ULONG  lba,
                        ULONG* media_status);

UINT selftest_msc_status(VOID* storage, ULONG lun, ULONG media_id, ULONG* media_status);
 
/* -------------------------------------------------------------------------- */
/* Console helpers (usb_selftest_ospi_format.c) */
/* -------------------------------------------------------------------------- */

[[nodiscard]] ra8_err_t selftest_print(const char* text);

[[nodiscard]] ra8_err_t selftest_print_dec(uint32_t value);

[[nodiscard]] ra8_err_t selftest_print_hex(uint32_t value, uint8_t digits);

[[nodiscard]] ra8_err_t selftest_print_fail(const char* what, ra8_err_t err);
 
/* -------------------------------------------------------------------------- */
/* Host-side pass ladder (usb_selftest_ospi_host.c) */
/* -------------------------------------------------------------------------- */

[[nodiscard]] ra8_err_t selftest_host_pass(void);
 
#endif /* !RA8_OFF_TARGET */