ra8_hal_internal.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdint.h>
 
#include "ra8_attributes.h"
#include "ra8_canfd_regs.h"
#include "ra8_dotf.h"
#include "ra8_err.h"
#include "ra8_rmac_regs.h"
#include "ra8_ssie_regs.h"
#include "ra8_usb_hmsc.h"

RA8_INTERNAL static inline bool internal_ra8_dotf_internal_channel_in_range(uint8_t channel)
{
  return (uint16_t)channel < (uint16_t)k_ra8_dotf_channel_count;
}
 
/* =============================================================================
 * ra8_rmac: split between ra8_rmac.c (lifecycle / config / MDIO primitives /
 * status / dispatch) and ra8_rmac_mgmt.c (statistic-counter snapshot + IEEE
 * 802.3 Clause-22 PHY management). Both translation units range-check the
 * port argument before touching the RMAC register window, so the port-bounds
 * predicate is shared here as a header ``static inline`` -- each TU gets its
 * own copy with no external linkage symbol, keeping the split link-clean.
 * =============================================================================
 */

RA8_INTERNAL static inline bool internal_port_ok(ra8_rmac_port_t port)
{
  return (uint8_t)port < k_ra8_rmac_port_count;
}
 
/* =============================================================================
 * ra8_mipi_csi: split between ra8_mipi_csi.c (lifecycle / register knobs) and
 * ra8_mipi_csi_irq.c (interrupt path + per-VC framing). The interrupt TU owns
 * every callback function-pointer / context static, so lifecycle teardown in
 * ra8_mipi_csi.c detaches them through this promoted helper rather than
 * touching the statics across the TU boundary.
 * =============================================================================
 */

RA8_PRIV void priv_ra8_mipi_csi_detach_all_handlers(void);
 
/* =============================================================================
 * ra8_ssie: split between ra8_ssie.c (lifecycle / register knobs / polled FIFO /
 * status / IRQ) and ra8_ssie_stream.c (DMA channel attach/detach + polled ISO
 * bulk send/recv). Both translation units read and write the per-channel
 * runtime bookkeeping array and call the channel-validating register accessor,
 * so the runtime state stays a single object and the accessor is promoted to
 * TU-external linkage here.
 * =============================================================================
 */

typedef enum : uint8_t {
  k_ra8_ssie_dma_ch_unused = 0xFFU, 
  k_ra8_ssie_dma_max_ch    = 8U,    
  k_ra8_ssie_thresh_max    = 0x1FU, 
} ra8_ssie_internal_const_t;

typedef struct {
  uint8_t tx_dma_channel; 
  uint8_t rx_dma_channel; 
  bool    initialized;    
  bool    dma_attached;   
} ra8_ssie_runtime_t;

extern ra8_ssie_runtime_t g_ssie_runtime[k_ra8_ssie_channel_count];

RA8_PRIV volatile r_ssie_regs_t* priv_ra8_ssie_internal_regs(uint8_t channel);
 
/* =============================================================================
 * ra8_usb_hmsc: split between ra8_usb_hmsc.c (CBW/CSW helpers, lifecycle, attach
 * callback, BOT/SCSI command path) and ra8_usb_hmsc_enum.c (the polled
 * enumeration ladder). Both translation units read and write the singleton
 * shadow state, so it stays a single object: the type and the extern
 * declaration live here, the one definition lives in ra8_usb_hmsc.c.
 * =============================================================================
 */

typedef struct {
  bool                     initialized;  
  bool                     attached;     
  ra8_usb_speed_t          speed;        
  ra8_usb_hmsc_attach_fn_t attach_cb;    
  void*                    attach_ctx;   
  ra8_usb_hmsc_device_t    device;       
  uint32_t                 next_cbw_tag; 
} ra8_usb_hmsc_state_t;

extern ra8_usb_hmsc_state_t g_usb_hmsc_state;
 
/* =============================================================================
 * ra8_canfd: split between ra8_canfd.c (clock / MSTP / global+channel mode state
 * machine, AFL / RX-FIFO bring-up, lifecycle, status / IRQ / filter / test-mode
 * / power) and two siblings: ra8_canfd_frame.c (TX/RX frame data path) and
 * ra8_canfd_timing.c (bit-timing solver + bitrate / BRS configuration). The
 * timing TU has to drive the channel mode state machine to land NCFG / DCFG
 * edits in CH_RESET, so the channel-mode helper -- whose definition stays in
 * ra8_canfd.c next to the rest of the mode machinery -- is promoted to
 * TU-external linkage here. No mutable state crosses the split.
 * =============================================================================
 */

RA8_PRIV ra8_err_t priv_ra8_canfd_internal_set_channel_mode(volatile r_canfd_t* reg,
                                                            ra8_chmdc_mode_t    mode);