usb_host_keyboard_steps.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdint.h>
 
#include "ra8_err.h"
 
#ifndef RA8_OFF_TARGET
#include "tx_api.h"
#endif
 
/* -------------------------------------------------------------------------- */
/* Shared compile-time constants */
/* -------------------------------------------------------------------------- */

typedef enum : uint32_t {
  k_hid_thread_stack    = 4096U,   
  k_hid_host_stack      = 8192U,   
  k_hid_usbx_pool_bytes = 32768U,  
  k_hid_idle_ticks      = 50U,     
  k_hid_boot_wait_ticks = 500U,    
  k_hid_retry_ticks     = 3000U,   
  k_hid_baud            = 115200U, 
  k_hid_print_cap       = 160U,    
  k_hid_dev_priority    = 8U,      
  k_hid_host_priority   = 24U,     
} hid_config_t;

typedef enum : uint8_t {
  k_hid_hex_chars_u16   = 4U,  
  k_hid_hex_chars_u32   = 8U,  
  k_hid_dec_chars_u32   = 10U, 
  k_hid_nibble_bits     = 4U,  
  k_hid_hex_digit_split = 10U, 
} hid_hex_t;

typedef enum : uint32_t {
  k_hid_nibble_mask = 0xFU, 
  k_hid_dec_radix   = 10U,  
} hid_mask_t;

typedef enum : uint32_t {
  k_hid_mps         = 64U,         
  k_hid_report_len  = 8U,          
  k_hid_rounds      = 8U,          
  k_hid_read_buf    = 64U,         
  k_hid_dev_addr    = 1U,          
  k_hid_ep_in_num   = 1U,          
  k_hid_pipe_in     = 1U,          
  k_hid_seq_idx     = 0U,          
  k_hid_body_idx    = 1U,          
  k_hid_no_mismatch = 0xFFFFFFFFU, 
  k_hid_pat_idx_mul = 7U,          
  k_hid_pat_bias    = 0x5AU,       
  k_hid_byte_mask   = 0xFFU,       
  k_hid_key0_idx    = 2U,          
  k_hid_nkeys       = 5U,          
} hid_geom_t;

typedef enum : uint8_t {
  k_hid_kc_a = 0x04U, 
  k_hid_kc_z = 0x1DU, 
  k_hid_kc_1 = 0x1EU, 
  k_hid_kc_0 = 0x27U, 
  k_hid_kc_r = 0x15U, 
  k_hid_kc_8 = 0x25U, 
  k_hid_kc_d = 0x07U, 
  k_hid_kc_2 = 0x1FU, 
} hid_keycode_t;
 
#ifndef RA8_OFF_TARGET
 
/* -------------------------------------------------------------------------- */
/* Shared mutable state (defined once in main.c) */
/* -------------------------------------------------------------------------- */

extern TX_SEMAPHORE s_usb_host_keyboard_hid_active_sem;
 
/* -------------------------------------------------------------------------- */
/* Shared HID report pattern */
/* -------------------------------------------------------------------------- */

void hid_fill_report_body(uint8_t* out, uint32_t len);
 
/* -------------------------------------------------------------------------- */
/* Device side: USBX HID interrupt-IN reports */
/* -------------------------------------------------------------------------- */

VOID hid_device_worker(ULONG arg);

void usb_host_keyboard_device_thread_create(void);
 
/* -------------------------------------------------------------------------- */
/* Console helpers (SCI8 -> J-Link OB CDC) */
/* -------------------------------------------------------------------------- */

uint8_t hid_nibble_to_hex(uint32_t nibble);

uint32_t hid_str_len(const char* text);

[[nodiscard]] ra8_err_t hid_sci_write(const uint8_t* data, uint32_t len);

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

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

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

[[nodiscard]] ra8_err_t hid_print_fail(const char* what, ra8_err_t err);
 
#endif /* !RA8_OFF_TARGET */