main.c

Go to the documentation of this file.

 
#include <stdint.h>
#include <string.h>
 
#include "ra8_board_ek_ra8d2.h"
#include "ra8_boot_entry.h"
#include "ra8_cgc.h"
#include "ra8_err.h"
#include "ra8_gpio_constants.h"
#include "ra8_isr.h"
#include "ra8_port_constants.h"
#include "ra8_port_utils.h"
#include "ra8_time.h"
#include "ra8_usb.h"
#include "ra8_usb_hmsc.h"
#include "usb_selftest_wlun_steps.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"
 
/* Strong SysTick override: route the tick into BOTH the ra8_time millisecond
 * counter (for ra8_delay_ms and the polled host stack's timeouts) AND
 * ThreadX's timer; the 1 ms pulse also recovers the DCD's storm-guard mask. */
 
extern void _tx_timer_interrupt(void);

static volatile bool s_tx_kernel_up = false;
 
void SysTick_Handler(void);
void SysTick_Handler(void)
{
  ra8_time_on_tick();
  if (s_tx_kernel_up) {
    _tx_timer_interrupt();
    ux_dcd_ra8_usb_irq_reenable();
  }
}
#endif
 
/* -------------------------------------------------------------------------- */
/* Pinout (FSP-aligned, EK-RA8D2 v1 User's Manual) */
/* -------------------------------------------------------------------------- */

static const ra8_port_pin_t k_wlun_pin_fs_vbus = (ra8_port_pin_t)k_ra8_board_usbfs_pin_vbus;

static const ra8_port_pin_t k_wlun_pin_fs_vbusen = (ra8_port_pin_t)k_ra8_board_usbfs_pin_vbusen;

static const ra8_port_pin_t k_wlun_pin_fs_dp = (ra8_port_pin_t)k_ra8_board_usbfs_pin_dp;

static const ra8_port_pin_t k_wlun_pin_fs_dm = (ra8_port_pin_t)k_ra8_board_usbfs_pin_dm;

static const ra8_port_pin_t k_wlun_pin_hs_vbus = (ra8_port_pin_t)k_ra8_board_usbhs_pin_vbus;

static const ra8_port_pin_t k_wlun_pin_hs_pwr = (ra8_port_pin_t)k_ra8_board_usbhs_pin_pwr;
 
/* -------------------------------------------------------------------------- */
/* Tunables */
/* -------------------------------------------------------------------------- */
 
/* The compile-time tunables (::wlun_config_t), hex/decimal formatter sizing
 * (::wlun_hex_t), text-formatter masks (::wlun_mask_t), LUN geometry
 * (::wlun_geom_t), and host-ladder phase markers (::wlun_phase_t) live in the
 * shared seam usb_selftest_wlun_steps.h alongside the helpers that consume
 * them. */

typedef enum : uint32_t {
  k_wlun_dev_step_stack  = 1U, 
  k_wlun_dev_step_class  = 2U, 
  k_wlun_dev_step_dcd    = 3U, 
  k_wlun_dev_step_attach = 4U, 
  k_wlun_dev_step_parked = 5U, 
} wlun_dev_step_t;

typedef enum : uint8_t {
  k_scsi_sense_illegal_request = 0x05U, 
  k_scsi_asc_lba_out_of_range  = 0x21U, 
  k_scsi_ascq_none             = 0x00U, 
  k_scsi_sense_data_protect    = 0x07U, 
  k_scsi_asc_write_protected   = 0x27U, 
} scsi_sense_code_t;
 
#ifndef RA8_OFF_TARGET
 
/* -------------------------------------------------------------------------- */
/* ThreadX workers + USBX pool storage */
/* -------------------------------------------------------------------------- */

static TX_THREAD s_device_thread;

static UCHAR s_device_stack[k_wlun_thread_stack];

static TX_THREAD s_host_thread;

static UCHAR s_host_stack[k_wlun_host_stack];

static UCHAR s_usbx_pool[k_wlun_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[]  = "WRITABLE-RAM RW ";
static UCHAR s_msc_product_rev[] = "0001";
static UCHAR s_msc_class_name[]     = "ux_slave_class_storage";
static CHAR  s_device_thread_name[] = "wlun_device";
static CHAR  s_host_thread_name[]   = "wlun_host";
 
/* -------------------------------------------------------------------------- */
/* J-Link probes */
/* -------------------------------------------------------------------------- */
 
/* The host-ladder probes (s_dbg_phase / s_dbg_luns_ok / s_dbg_max_lun /
 * s_dbg_mismatch / s_dbg_pass_count) live with the host worker in
 * usb_selftest_wlun_host.c. */

static volatile uint32_t s_dbg_read_calls;
static volatile uint32_t s_dbg_write_calls;
static volatile uint32_t s_dbg_write_blocks;
static volatile uint32_t s_dbg_dev_step;
static volatile uint32_t s_dbg_dev_err;

static UCHAR s_disk[(size_t)k_wlun_sectors * (size_t)k_wlun_block_size];
 
/* -------------------------------------------------------------------------- */
/* USB descriptors (single-interface MSC; one writable logical unit) */
/* -------------------------------------------------------------------------- */
 
/* 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 0x0014 marks the writable-LUN 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,
  0x14U, /* PID = 0x0014 (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',
};
 
/* USBX LANGID descriptor 0x0409 (English-US), little-endian byte pair. */
typedef enum : uint8_t {
  k_usb_langid_en_us_lo = 0x09U, 
  k_usb_langid_en_us_hi = 0x04U, 
} usb_langid_byte_t;

static UCHAR s_language_id_framework[] = {k_usb_langid_en_us_lo, k_usb_langid_en_us_hi};
 
/* The shared per-(LUN,LBA) pattern generator ::wlun_pattern_fill lives in
 * usb_selftest_wlun_console.c (shared with the host verifier). */
 
/* -------------------------------------------------------------------------- */
/* Storage class media callbacks (single writable RAM-disk LUN) */
/* -------------------------------------------------------------------------- */

static UINT wlun_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_wlun_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_disk[lba * (ULONG)k_wlun_block_size],
               (size_t)(number_blocks * (ULONG)k_wlun_block_size));
  *media_status = 0UL;
  (void)ra8_board_led_toggle(k_ra8_board_led1);
  return UX_SUCCESS;
}

/* cppcheck-suppress-begin [constParameterCallback] -- USBX's
 * ux_slave_class_storage_media_write function-pointer signature takes
 * non-const UCHAR*; we cannot const-qualify the parameter. */
static UINT wlun_msc_write(VOID*  storage,
                           ULONG  lun,
                           UCHAR* data_pointer,
                           ULONG  number_blocks,
                           ULONG  lba,
                           ULONG* media_status)
{
  (void)storage;
  (void)lun;
  s_dbg_write_calls++;
  if ((lba + number_blocks) > (ULONG)k_wlun_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(&s_disk[lba * (ULONG)k_wlun_block_size],
               data_pointer,
               (size_t)(number_blocks * (ULONG)k_wlun_block_size));
  s_dbg_write_blocks += (uint32_t)number_blocks;
  *media_status = 0UL;
  (void)ra8_board_led_toggle(k_ra8_board_led2);
  return UX_SUCCESS;
}
/* cppcheck-suppress-end [constParameterCallback] */

static UINT wlun_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;
}
 
/* The SCI8 polled console helpers (wlun_nibble_to_hex / wlun_str_len /
 * wlun_sci_write / wlun_print / wlun_print_dec / wlun_print_hex /
 * wlun_print_fail) live in usb_selftest_wlun_console.c. */
 
/* -------------------------------------------------------------------------- */
/* Device side: USBX MSC with two LUNs */
/* -------------------------------------------------------------------------- */

static UINT wlun_usbx_stack_up(void)
{
  if (_ux_system_initialize(s_usbx_pool, k_wlun_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 wlun_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_wlun_sectors - 1UL;
  p->ux_slave_class_storage_parameter_lun[idx].ux_slave_class_storage_media_block_length =
    (ULONG)k_wlun_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_FALSE;
  p->ux_slave_class_storage_parameter_lun[idx].ux_slave_class_storage_media_read  = wlun_msc_read;
  p->ux_slave_class_storage_parameter_lun[idx].ux_slave_class_storage_media_write = wlun_msc_write;
  p->ux_slave_class_storage_parameter_lun[idx].ux_slave_class_storage_media_status =
    wlun_msc_status;
}

static UINT wlun_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_wlun_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_wlun_count; idx++) {
    wlun_fill_lun(&msc_params, idx);
  }
  return _ux_device_stack_class_register(s_msc_class_name,
                                         _ux_device_class_storage_entry,
                                         1,
                                         0,
                                         &msc_params);
}

static VOID wlun_device_worker(ULONG arg)
{
  (void)arg;
 
  UINT ux = wlun_usbx_stack_up();
  if (ux != UX_SUCCESS) {
    s_dbg_dev_err = (uint32_t)ux;
    return;
  }
  s_dbg_dev_step = (uint32_t)k_wlun_dev_step_stack;
  ux             = wlun_class_register();
  if (ux != UX_SUCCESS) {
    s_dbg_dev_err = (uint32_t)ux;
    return;
  }
  s_dbg_dev_step = (uint32_t)k_wlun_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_wlun_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_wlun_dev_step_attach;
 
  while (1) {
    s_dbg_dev_step = (uint32_t)k_wlun_dev_step_parked;
    tx_thread_sleep(k_wlun_idle_ticks);
  }
}
 
/* The host-side MSC ladder (wlun_write_disk / wlun_verify_one /
 * wlun_print_lun_ok / wlun_host_enumerate / wlun_host_pass) and the
 * wlun_host_worker entry point live in usb_selftest_wlun_host.c. */

VOID tx_application_define(VOID* first_unused_memory)
{
  (void)first_unused_memory;
  s_tx_kernel_up = true;
  (void)tx_thread_create(&s_device_thread,
                         s_device_thread_name,
                         wlun_device_worker,
                         0UL,
                         s_device_stack,
                         k_wlun_thread_stack,
                         (UINT)k_wlun_dev_priority,
                         (UINT)k_wlun_dev_priority,
                         TX_NO_TIME_SLICE,
                         TX_AUTO_START);
  (void)tx_thread_create(&s_host_thread,
                         s_host_thread_name,
                         wlun_host_worker,
                         0UL,
                         s_host_stack,
                         k_wlun_host_stack,
                         (UINT)k_wlun_host_priority,
                         (UINT)k_wlun_host_priority,
                         TX_NO_TIME_SLICE,
                         TX_AUTO_START);
}
#endif /* !RA8_OFF_TARGET */
 
/* -------------------------------------------------------------------------- */
/* Startup */
/* -------------------------------------------------------------------------- */

static void wlun_panic_halt(void)
{
  while (1) {
    __asm__ volatile("wfi");
  }
}

static void wlun_route_usb_or_halt(void)
{
  if (ra8_pfs_route_peripheral(k_wlun_pin_fs_vbus, k_ra8_psel_usb_fs, "wlun.fs_vbus") != k_ra8_ok) {
    wlun_panic_halt();
  }
  if (ra8_gpio_output_init(k_wlun_pin_fs_vbusen, k_ra8_level_low) != k_ra8_ok) {
    wlun_panic_halt();
  }
  if (ra8_pfs_route_peripheral(k_wlun_pin_fs_dp, k_ra8_psel_usb_fs, "wlun.fs_dp") != k_ra8_ok) {
    wlun_panic_halt();
  }
  if (ra8_pfs_route_peripheral(k_wlun_pin_fs_dm, k_ra8_psel_usb_fs, "wlun.fs_dm") != k_ra8_ok) {
    wlun_panic_halt();
  }
  if (ra8_board_io_expander_set_usbhs_host_mode() != k_ra8_ok) {
    wlun_panic_halt();
  }
  if (ra8_gpio_output_init(k_wlun_pin_hs_pwr, k_ra8_level_high) != k_ra8_ok) {
    wlun_panic_halt();
  }
  if (ra8_pfs_route_peripheral(k_wlun_pin_hs_vbus, k_ra8_psel_usb_hs, "wlun.hs_vbus") != k_ra8_ok) {
    wlun_panic_halt();
  }
}

static void wlun_setup_or_halt(void)
{
  uint32_t cpuclk0_hz = 0U;
  if (ra8_cgc_init() != k_ra8_ok) {
    wlun_panic_halt();
  }
  if (ra8_cgc_usbfs_clock_enable() != k_ra8_ok) {
    wlun_panic_halt();
  }
  if (ra8_cgc_usbhs_pll_enable() != k_ra8_ok) {
    wlun_panic_halt();
  }
  if (ra8_cgc_get_clock_hz(k_ra8_clock_id_cpuclk0, &cpuclk0_hz) != k_ra8_ok) {
    wlun_panic_halt();
  }
  if (ra8_time_init(cpuclk0_hz) != k_ra8_ok) {
    wlun_panic_halt();
  }
  if (ra8_board_uart_console_init((uint32_t)k_wlun_baud) != k_ra8_ok) {
    wlun_panic_halt();
  }
  if (ra8_board_led_init(k_ra8_board_led1) != k_ra8_ok) {
    wlun_panic_halt();
  }
  if (ra8_board_led_init(k_ra8_board_led2) != k_ra8_ok) {
    wlun_panic_halt();
  }
  wlun_route_usb_or_halt();
}

void main(void)
{
  wlun_setup_or_halt();
 
  ra8_isr_globals_enable();
 
#ifndef RA8_OFF_TARGET
  tx_kernel_enter();
#endif
 
  wlun_panic_halt();
}