ux_dcd_ra8_usb_internal.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdint.h>
 
#include "ra8_attributes.h"
#include "ra8_isr.h"
#include "ra8_usb.h"
#include "ux_dcd_ra8_usb.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* -------------------------------------------------------------------------- */
/* Shared typed enums and structs */
/* -------------------------------------------------------------------------- */

typedef enum : uint8_t {
  k_ra8_int0_dvsq_shift = 4U, 
} ra8_usb_dcd_intsts0_field_shift_t;

typedef struct {
  struct UX_SLAVE_TRANSFER_STRUCT* xfer;    
  uint8_t                          ep_addr; 
  uint8_t                          dir_in;  
  uint16_t                         max_pkt; 
} ra8_usb_dcd_pipe_slot_t;

typedef struct {
  ra8_usb_dcd_state_t         state;                             
  ra8_usb_speed_t             speed;                             
  struct UX_SLAVE_DCD_STRUCT* owner;                             
  ra8_usb_dcd_pipe_slot_t     pipes[k_ux_dcd_ra8_usb_max_pipes]; 
} ra8_usb_dcd_t;
 
/* Orphan bulk-OUT holding buffer. A host OUT packet can land in the
 * controller bank during the brief PID=BUF window between one transfer
 * completing and the next being armed -- the host pipelines a CBW's
 * data phase straight after the CBW. With no USBX waiter stashed the
 * IRQ walk cannot drain it, BRDYSTS stays latched, and the USBFS IRQ
 * storms at the full bus rate: BRDY is a real event so the event-less
 * storm guard never masks it and RTOS thread mode starves (GitHub
 * issue #6). internal_irq_drain_orphan_out pulls that packet into
 * g_orphan_buf -- which W0C-clears BRDYSTS and parks the pipe -- and
 * internal_submit_pipe hands it to the next bulk-OUT transfer. The
 * bulk-OUT wire is strictly serial, so a held packet always belongs to
 * the next OUT transfer USBX submits. */
typedef enum : uint16_t {
  k_ra8_usb_orphan_bytes = 64U, 
} ux_dcd_ra8_usb_orphan_cfg_t;

typedef struct {
  volatile uint32_t xfer_req_total;          
  volatile uint32_t xfer_req_null_arg;       
  volatile uint32_t xfer_req_bad_pipe;       
  volatile uint32_t xfer_req_pipe2_in;       
  volatile uint32_t xfer_req_pipe2_out_dir;  
  volatile uint32_t xfer_req_pipe2_stashed;  
  volatile uint32_t xfer_req_pipe2_block;    
  volatile uint32_t xfer_req_pipe2_woken;    
  volatile uint32_t irq_walk_total;          
  volatile uint32_t irq_walk_pipe2_seen;     
  volatile uint32_t irq_walk_pipe2_complete; 
  volatile uint32_t irq_walk_pipe2_no_data;  
  volatile uint32_t in_rearm_nak;            
  volatile uint32_t in_restage_nak;          
  volatile uint32_t in_stage_fail;           
  volatile uint32_t ep_create_calls;         
  volatile uint32_t ep_create_fail;          
  volatile uint32_t chg_state_attached;      
  volatile uint32_t chg_state_configured;    
} ra8_usb_dcd_diag_t;

typedef enum : uint32_t {
  k_dcd_trace_entries    = 64U,   
  k_dcd_trace_kind_out   = 1U,    
  k_dcd_trace_kind_in    = 2U,    
  k_dcd_trace_kind_setup = 3U,    
  k_dcd_trace_kind_shift = 24U,   
  k_dcd_trace_code_shift = 16U,   
  k_dcd_trace_no_code    = 0xFFU, 
  k_dcd_trace_cbw_len    = 31U,   
  k_dcd_trace_cbw_op_off = 15U,   
  k_dcd_trace_byte_shift = 8U,    
  k_dcd_trace_op_read10  = 0x28U, 
  k_dcd_trace_op_write10 = 0x2AU, 
  k_dcd_trace_cdb_lba_hi = 4U,    
  k_dcd_trace_cdb_lba_lo = 5U,    
  k_dcd_trace_kind_ocap  = 5U,    
  k_dcd_trace_kind_ouse  = 6U,    
  k_dcd_trace_kind_ccpl  = 7U,    
  k_dcd_trace_kind_dvst  = 9U,    
  k_dcd_trace_nibble     = 0x0FU, 
  k_dcd_trace_nib_shift  = 4U,    
  k_dcd_out_drain_max    = 4U,    
} ra8_usb_dcd_trace_t;

typedef enum : uint8_t {
  k_setup_idx_bmrt   = 0U, 
  k_setup_idx_brq    = 1U, 
  k_setup_idx_val_lo = 2U, 
  k_setup_idx_val_hi = 3U, 
  k_setup_idx_idx_lo = 4U, 
  k_setup_idx_idx_hi = 5U, 
  k_setup_idx_len_lo = 6U, 
  k_setup_idx_len_hi = 7U, 
} ra8_setup_byte_idx_t;

typedef enum : uint16_t {
  k_setup_byte_shift = 8U,    
  k_setup_byte_mask  = 0xFFU, 
} ra8_setup_byte_pack_t;

typedef enum : uint8_t {
  k_ra8_usb_ep_addr_dir_in_bit = 0x80U, 
  k_ra8_usb_ep_addr_num_mask   = 0x0FU, 
} ra8_usb_ep_addr_field_t;

typedef enum : uint16_t {
  k_ra8_usb_dvsq_field_mask = 0x07U,  
  k_ra8_usb_state_unknown   = 0xFFUL, 
} ra8_usb_dcd_field_mask_t;

typedef enum : uint8_t {
  k_ra8_usb_skip_usbreq_unchanged = 0x40U, 
  k_ra8_usb_skip_process_ok       = 0x80U, 
} ra8_usb_dispatch_skip_bit_t;
 
/* -------------------------------------------------------------------------- */
/* Shared mutable state (defined once; externed here) */
/* -------------------------------------------------------------------------- */

extern ra8_usb_dcd_t g_dcd;

extern ra8_usb_dcd_diag_t g_diag;

extern volatile uint32_t g_dcd_auto_echo_enable;

extern uint8_t g_dcd_auto_echo_out_pipe;

extern uint8_t g_dcd_auto_echo_in_pipe;

extern volatile uint32_t g_isr_spurious_run;

extern uint8_t g_orphan_buf[k_ra8_usb_orphan_bytes];

extern uint16_t g_orphan_len;

extern uint8_t g_orphan_pipe;

extern volatile uint32_t g_setup_dispatch_count;

extern volatile uint8_t g_setup_packet_buffer[8];

extern volatile uint32_t g_setup_packet_count;

extern volatile uint32_t g_dispatch_skip_reason;

extern volatile uint64_t g_last_dispatched_setup_fp;

extern volatile uint32_t g_setup_token_observed;
 
/* -------------------------------------------------------------------------- */
/* Shared helpers (formerly static; called across translation units) */
/* -------------------------------------------------------------------------- */

RA8_PRIV uint8_t priv_ep_to_pipe(uint8_t ep_addr);

RA8_PRIV unsigned int priv_transfer_request(struct UX_SLAVE_TRANSFER_STRUCT* tr);

RA8_PRIV void priv_usbfs_irq_mask(void);

RA8_PRIV void priv_trace_event(uint8_t kind, uint8_t code, uint16_t length);

RA8_PRIV ra8_elc_event_t priv_pick_event(ra8_usb_speed_t speed);

RA8_PRIV ra8_isr_handler_t priv_pick_isr(ra8_usb_speed_t speed);

RA8_PRIV void priv_event_cb(void* ctx, ra8_usb_speed_t speed, uint16_t status_mask);

RA8_PRIV unsigned int priv_dispatch_setup(const ra8_usb_setup_t* setup);

RA8_PRIV void priv_handle_ctrt(ra8_usb_speed_t speed, uint16_t intsts0);

RA8_PRIV void priv_handle_ctrl_out_data(ra8_usb_speed_t speed);

RA8_PRIV void priv_dvst_default_state(ra8_usb_speed_t speed);

RA8_PRIV void priv_irq_dvst_prelude(ra8_usb_speed_t speed, uint16_t intsts0);
 
#ifdef __cplusplus
}
#endif