usb_selftest_microsd_steps.c

Go to the documentation of this file.

 
#include "usb_selftest_microsd_steps.h"
 
#include <stdint.h>
#include <string.h>
 
#include "ra8_board_ek_ra8d2.h"
#include "ra8_err.h"
#include "ra8_usb.h"
#include "ra8_usb_hmsc.h"
 
#ifndef RA8_OFF_TARGET
#include "tx_api.h"
#include "ux_api.h"
#include "ux_dcd_ra8_usb.h"
#include "ux_device_class_storage.h"
#include "ux_device_stack.h"
 
/* -------------------------------------------------------------------------- */
/* ThreadX device worker + USBX pool storage */
/* -------------------------------------------------------------------------- */

static UCHAR s_usbx_pool[k_microsd_usbx_pool_bytes];
 
/* SCSI INQUIRY strings -- 8 / 16 / 4 byte fields per SBC-3. */
static UCHAR s_msc_vendor_id[]   = "RA8D2   ";
static UCHAR s_msc_product_id[]  = "MICROSD CARD RO ";
static UCHAR s_msc_product_rev[] = "0001";
 
/* -------------------------------------------------------------------------- */
/* J-Link probes (device + host owned) */
/* -------------------------------------------------------------------------- */

static volatile uint32_t s_dbg_phase;
static volatile uint32_t s_dbg_luns_ok;
static volatile uint32_t s_dbg_max_lun;
static volatile uint32_t s_dbg_mismatch = (uint32_t)k_microsd_no_mismatch;
static volatile uint32_t s_dbg_pass_count;
static volatile uint32_t s_dbg_read_calls;
static volatile uint32_t s_dbg_dev_step;
static volatile uint32_t s_dbg_dev_err;
 
/* -------------------------------------------------------------------------- */
/* USB descriptors (single-interface MSC; multi-LUN is a BOT-level concept) */
/* -------------------------------------------------------------------------- */
 
/* MSC config: bulk-only transport, SCSI command set, EP1 IN + EP2 OUT,
 * 64-byte MPS. The number of LUNs is a class-registration parameter, not
 * a descriptor field, so this framework is the standard single-interface
 * MSC blob. PID 0x0015 marks the microSD self-test identity. */
static UCHAR s_device_framework_fs[] = {
  /* Device descriptor (USB 2.0 sec 9.6.1) -- 18 bytes. */
  0x12U,
  0x01U,
  0x00U,
  0x02U,
  0x00U,
  0x00U,
  0x00U,
  0x40U,
  0x09U,
  0x12U,
  0x15U, /* PID = 0x0015 (pid.codes test). */
  0x00U,
  0x00U,
  0x01U,
  0x01U,
  0x02U,
  0x03U,
  0x01U,
  /* Configuration descriptor (32 bytes total). */
  0x09U,
  0x02U,
  0x20U,
  0x00U,
  0x01U,
  0x01U,
  0x00U,
  0x80U,
  0x32U,
  /* Interface descriptor -- MSC, SCSI, BBB. */
  0x09U,
  0x04U,
  0x00U,
  0x00U,
  0x02U,
  0x08U,
  0x06U,
  0x50U,
  0x00U,
  /* Bulk-IN endpoint (EP1 IN, 64-byte MPS). */
  0x07U,
  0x05U,
  0x81U,
  0x02U,
  0x40U,
  0x00U,
  0x00U,
  /* Bulk-OUT endpoint (EP2 OUT, 64-byte MPS). */
  0x07U,
  0x05U,
  0x02U,
  0x02U,
  0x40U,
  0x00U,
  0x00U,
};

static UCHAR s_string_framework[] = {
  /* idx 1: "Brighton Sikarskie". */
  0x09U,
  0x04U,
  0x01U,
  0x12U,
  'B',
  'r',
  'i',
  'g',
  'h',
  't',
  'o',
  'n',
  ' ',
  'S',
  'i',
  'k',
  'a',
  'r',
  's',
  'k',
  'i',
  'e',
  /* idx 2: "RA8D2 MULTILUN". */
  0x09U,
  0x04U,
  0x02U,
  0x0EU,
  'R',
  'A',
  '8',
  'D',
  '2',
  ' ',
  'M',
  'U',
  'L',
  'T',
  'I',
  'L',
  'U',
  'N',
  /* idx 3: serial. */
  0x09U,
  0x04U,
  0x03U,
  0x08U,
  '0',
  '0',
  '0',
  '0',
  '0',
  '0',
  '1',
  '3',
};

static UCHAR s_language_id_framework[] = {k_usb_langid_en_us_lo, k_usb_langid_en_us_hi};
 
/* -------------------------------------------------------------------------- */
/* Storage class media callbacks (single read-only microSD LUN) */
/* -------------------------------------------------------------------------- */

static UINT microsd_msc_read(VOID*  storage,
                             ULONG  lun,
                             UCHAR* data_pointer,
                             ULONG  number_blocks,
                             ULONG  lba,
                             ULONG* media_status)
{
  (void)storage;
  (void)lun;
  s_dbg_read_calls++;
  if ((lba + number_blocks) > (ULONG)k_microsd_sectors) {
    *media_status = UX_DEVICE_CLASS_STORAGE_SENSE_STATUS(k_scsi_sense_illegal_request,
                                                         k_scsi_asc_lba_out_of_range,
                                                         k_scsi_ascq_none);
    return UX_ERROR;
  }
  (void)memcpy(data_pointer,
               &s_usb_selftest_microsd_sd_snapshot[lba * (ULONG)k_microsd_block_size],
               (size_t)(number_blocks * (ULONG)k_microsd_block_size));
  *media_status = 0UL;
  (void)ra8_board_led_toggle(k_ra8_board_led1);
  return UX_SUCCESS;
}

static UINT microsd_msc_write(VOID*  storage,
                              ULONG  lun,
                              UCHAR* data_pointer,
                              ULONG  number_blocks,
                              ULONG  lba,
                              ULONG* media_status)
{
  (void)storage;
  (void)lun;
  (void)data_pointer;
  (void)number_blocks;
  (void)lba;
  *media_status = UX_DEVICE_CLASS_STORAGE_SENSE_STATUS(k_scsi_sense_data_protect,
                                                       k_scsi_asc_write_protected,
                                                       k_scsi_ascq_none);
  return UX_ERROR;
}

static UINT microsd_msc_status(VOID* storage, ULONG lun, ULONG media_id, ULONG* media_status)
{
  (void)storage;
  (void)lun;
  (void)media_id;
  *media_status = 0UL;
  return UX_SUCCESS;
}
 
/* -------------------------------------------------------------------------- */
/* Device side: USBX MSC with one read-only microSD LUN */
/* -------------------------------------------------------------------------- */

static UINT microsd_usbx_stack_up(void)
{
  if (_ux_system_initialize(s_usbx_pool, k_microsd_usbx_pool_bytes, UX_NULL, 0) != UX_SUCCESS) {
    return UX_ERROR;
  }
  return _ux_device_stack_initialize((UCHAR*)UX_NULL,
                                     0,
                                     s_device_framework_fs,
                                     sizeof(s_device_framework_fs),
                                     s_string_framework,
                                     sizeof(s_string_framework),
                                     s_language_id_framework,
                                     sizeof(s_language_id_framework),
                                     UX_NULL);
}

static void microsd_fill_lun(UX_SLAVE_CLASS_STORAGE_PARAMETER* p, uint32_t idx)
{
  p->ux_slave_class_storage_parameter_lun[idx].ux_slave_class_storage_media_last_lba =
    (ULONG)k_microsd_sectors - 1UL;
  p->ux_slave_class_storage_parameter_lun[idx].ux_slave_class_storage_media_block_length =
    (ULONG)k_microsd_block_size;
  p->ux_slave_class_storage_parameter_lun[idx].ux_slave_class_storage_media_type =
    UX_SLAVE_CLASS_STORAGE_MEDIA_FAT_DISK;
  p->ux_slave_class_storage_parameter_lun[idx].ux_slave_class_storage_media_removable_flag =
    UX_SLAVE_CLASS_STORAGE_MEDIA_IS_REMOVABLE;
  p->ux_slave_class_storage_parameter_lun[idx].ux_slave_class_storage_media_read_only_flag =
    UX_TRUE;
  p->ux_slave_class_storage_parameter_lun[idx].ux_slave_class_storage_media_read = microsd_msc_read;
  p->ux_slave_class_storage_parameter_lun[idx].ux_slave_class_storage_media_write =
    microsd_msc_write;
  p->ux_slave_class_storage_parameter_lun[idx].ux_slave_class_storage_media_status =
    microsd_msc_status;
}

static UINT microsd_class_register(void)
{
  UX_SLAVE_CLASS_STORAGE_PARAMETER msc_params;
  (void)memset(&msc_params, 0, sizeof(msc_params));
  msc_params.ux_slave_class_storage_parameter_number_lun  = (ULONG)k_microsd_count;
  msc_params.ux_slave_class_storage_parameter_vendor_id   = s_msc_vendor_id;
  msc_params.ux_slave_class_storage_parameter_product_id  = s_msc_product_id;
  msc_params.ux_slave_class_storage_parameter_product_rev = s_msc_product_rev;
  for (uint32_t idx = 0U; idx < (uint32_t)k_microsd_count; idx++) {
    microsd_fill_lun(&msc_params, idx);
  }
  static UCHAR s_class_name[] = "ux_slave_class_storage";
 
  return _ux_device_stack_class_register(s_class_name,
                                         _ux_device_class_storage_entry,
                                         1,
                                         0,
                                         &msc_params);
}
 
VOID microsd_device_worker(ULONG arg)
{
  (void)arg;
 
  UINT ux = microsd_usbx_stack_up();
  if (ux != UX_SUCCESS) {
    s_dbg_dev_err = (uint32_t)ux;
    return;
  }
  s_dbg_dev_step = (uint32_t)k_microsd_dev_step_stack;
  ux             = microsd_class_register();
  if (ux != UX_SUCCESS) {
    s_dbg_dev_err = (uint32_t)ux;
    return;
  }
  s_dbg_dev_step = (uint32_t)k_microsd_dev_step_class;
  ra8_err_t e    = ux_dcd_ra8_usb_initialize(k_ra8_usb_speed_fs);
  if (e != k_ra8_ok) {
    s_dbg_dev_err = (uint32_t)e;
    return;
  }
  s_dbg_dev_step = (uint32_t)k_microsd_dev_step_dcd;
  e              = ra8_usb_device_attach(k_ra8_usb_speed_fs, true);
  if (e != k_ra8_ok) {
    s_dbg_dev_err = (uint32_t)e;
    return;
  }
  s_dbg_dev_step = (uint32_t)k_microsd_dev_step_attach;
 
  while (1) {
    s_dbg_dev_step = (uint32_t)k_microsd_dev_step_parked;
    tx_thread_sleep(k_microsd_idle_ticks);
  }
}
 
/* -------------------------------------------------------------------------- */
/* Host side: ra8_usb_hmsc enumerate + per-LUN read/verify */
/* -------------------------------------------------------------------------- */

[[nodiscard]] static ra8_err_t microsd_verify_one(uint32_t lun)
{
  static uint8_t s_burst[k_microsd_burst_bytes] = {};
 
  uint32_t  block_count = 0U;
  uint32_t  block_size  = 0U;
  ra8_err_t err         = ra8_usb_hmsc_read_capacity((uint8_t)lun, &block_count, &block_size);
  if (err != k_ra8_ok) {
    (void)microsd_print_fail("read_capacity", err);
    return err;
  }
  if (block_count != (uint32_t)k_microsd_sectors) {
    (void)microsd_print_fail("capacity mismatch", k_ra8_err_invalid_size);
    return k_ra8_err_invalid_size;
  }
  if (s_usb_selftest_microsd_dbg_bootsig == 0U) {
    (void)microsd_print_fail("no 0x55AA boot sig on SD LBA0", k_ra8_err_invalid_state);
    return k_ra8_err_invalid_state;
  }
  for (uint32_t blk = 0U; blk < (uint32_t)k_microsd_sectors;
       blk += (uint32_t)k_microsd_burst_blocks) {
    err = ra8_usb_hmsc_read10((uint8_t)lun, blk, (uint16_t)k_microsd_burst_blocks, s_burst);
    if (err != k_ra8_ok) {
      (void)microsd_print_fail("READ(10)", err);
      return err;
    }
    const uint32_t off = blk * (uint32_t)k_microsd_block_size;
    if (memcmp(s_burst, &s_usb_selftest_microsd_sd_snapshot[off], (size_t)k_microsd_burst_bytes) !=
        0) {
      s_dbg_mismatch = blk;
      (void)microsd_print_fail("SD data mismatch vs snapshot", k_ra8_err_invalid_state);
      return k_ra8_err_invalid_state;
    }
  }
  return k_ra8_ok;
}

[[nodiscard]] static ra8_err_t microsd_print_lun_ok(uint32_t lun)
{
  ra8_err_t err = microsd_print("ra8d2 microsd: LUN ");
  if (err != k_ra8_ok) {
    return err;
  }
  err = microsd_print_dec(lun);
  if (err != k_ra8_ok) {
    return err;
  }
  return microsd_print(" OK (64 sectors, SD vs snapshot)\r\n");
}

[[nodiscard]] static ra8_err_t microsd_host_enumerate(ra8_usb_hmsc_device_t* device)
{
  s_dbg_phase   = (uint32_t)k_microsd_phase_enum;
  ra8_err_t err = ra8_usb_hmsc_enumerate(device);
  if (err != k_ra8_ok) {
    (void)microsd_print_fail("enumerate", err);
    (void)ra8_usb_hmsc_close();
    return err;
  }
  s_dbg_max_lun = (uint32_t)device->max_lun;
  err           = microsd_print("ra8d2 microsd: enumerated pid=0x");
  if (err != k_ra8_ok) {
    return err;
  }
  err = microsd_print_hex((uint32_t)device->product_id, (uint8_t)k_microsd_hex_chars_u16);
  if (err != k_ra8_ok) {
    return err;
  }
  err = microsd_print(", GET_MAX_LUN=");
  if (err != k_ra8_ok) {
    return err;
  }
  err = microsd_print_dec(s_dbg_max_lun);
  if (err != k_ra8_ok) {
    return err;
  }
  return microsd_print("\r\n");
}

[[nodiscard]] static ra8_err_t microsd_host_pass(void)
{
  s_dbg_phase   = (uint32_t)k_microsd_phase_init;
  ra8_err_t err = microsd_print("ra8d2 microsd: host up on USB-HS, probing the loop...\r\n");
  if (err != k_ra8_ok) {
    return err;
  }
  err = ra8_usb_hmsc_init(k_ra8_usb_speed_hs);
  if (err != k_ra8_ok) {
    (void)microsd_print_fail("host init", err);
    return err;
  }
 
  ra8_usb_hmsc_device_t device = {};
  err                          = microsd_host_enumerate(&device);
  if (err != k_ra8_ok) {
    return err;
  }
 
  s_dbg_phase   = (uint32_t)k_microsd_phase_verify;
  s_dbg_luns_ok = 0U;
  for (uint32_t lun = 0U; lun < (uint32_t)k_microsd_count; lun++) {
    err = microsd_verify_one(lun);
    if (err != k_ra8_ok) {
      (void)ra8_usb_hmsc_close();
      return err;
    }
    s_dbg_luns_ok++;
    err = microsd_print_lun_ok(lun);
    if (err != k_ra8_ok) {
      return err;
    }
  }
 
  s_dbg_phase = (uint32_t)k_microsd_phase_pass;
  s_dbg_pass_count++;
  err = microsd_print("ra8d2 microsd: USB SELFTEST MICROSD PASS\r\n");
  if (err != k_ra8_ok) {
    return err;
  }
  (void)ra8_board_led_on(k_ra8_board_led2);
  return k_ra8_ok;
}
 
VOID microsd_host_worker(ULONG arg)
{
  (void)arg;
 
  tx_thread_sleep(k_microsd_boot_wait_ticks);
  for (;;) {
    const ra8_err_t err = microsd_host_pass();
    if (err == k_ra8_ok) {
      break;
    }
    tx_thread_sleep(k_microsd_retry_ticks);
  }
  while (1) {
    tx_thread_sleep(k_microsd_idle_ticks);
  }
}
 
#endif /* !RA8_OFF_TARGET */