ra8_flash_internal.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_attributes.h"
#include "ra8_err.h"
#include "ra8_flash.h"
 
/* =============================================================================
 * Cross-TU shared state + constants (split across ra8_flash*.c)
 *
 * The ra8_flash driver is split into several translation units that all
 * compile into libra_hal. The runtime state struct, its single
 * definition, the module log tag, and the constant blocks referenced by
 * more than one of those TUs live here so every TU sees one declaration.
 * =============================================================================
 */

typedef struct {
  ra8_flash_callback_t cb;          
  void*                user_ctx;    
  bool                 initialized; 
  bool                 prefetch_on; 
  uintptr_t            win_low;     
  uintptr_t            win_high;    
} ra8_flash_runtime_t;

extern ra8_flash_runtime_t g_flash_rt;

extern const char* g_flash_tag;

typedef enum : uint32_t {
  k_ra8_flash_max_mrcfreq_mhz = 0x000000FAUL, 
  k_ra8_flash_max_mrefreq_mhz = 0x0000007DUL, 
  k_ra8_flash_busy_spin_limit = 0x00010000UL, 
  k_ra8_flash_maci_spin_limit = 0x00100000UL, 
  k_ra8_flash_pe_spin_limit   = 0x00010000UL, 
  k_ra8_flash_zeroize_spin    = 0x00400000UL, 
  k_ra8_flash_max_list_select = 0x0000000FUL, 
} ra8_flash_const_t;

typedef enum : uint32_t {
  k_ra8_flash_freq_key_shift = 24U,   
  k_ra8_flash_mrcfreq_key    = 0x1EU, 
  k_ra8_flash_mrefreq_key    = 0xE1U, 
} ra8_flash_key_t;

RA8_PRIV void priv_ra8_flash_internal_set_prefetch(bool enable);

RA8_PRIV void priv_ra8_flash_internal_maci_cmd8(uint8_t byte);

RA8_PRIV void priv_ra8_flash_internal_maci_cmd16(uint16_t half);

RA8_PRIV ra8_err_t priv_ra8_flash_internal_wait_mrdy(uint32_t limit);

RA8_PRIV bool priv_ra8_flash_internal_window_allows(uintptr_t addr, uint32_t len);

RA8_PRIV bool priv_ra8_flash_internal_window_allows_pure(uintptr_t addr,
                                                         uint32_t  len,
                                                         uintptr_t win_low,
                                                         uintptr_t win_high);

RA8_PRIV ra8_err_t priv_ra8_flash_internal_wait_buffer_ready_call(uint32_t limit);

RA8_PRIV ra8_err_t priv_ra8_flash_internal_wait_commit_done_call(uint32_t limit);
 
#if defined(RA8_OFF_TARGET) && defined(UNIT_TEST)
typedef enum : uint32_t {
  k_ra8_flash_maci_log_cap = 32U, 
} ra8_flash_maci_log_const_t;

extern uint8_t g_ra8_flash_maci_cmd8_log[k_ra8_flash_maci_log_cap];

extern uint32_t g_ra8_flash_maci_cmd8_len;

extern uint16_t g_ra8_flash_maci_cmd16_log[k_ra8_flash_maci_log_cap];

extern uint32_t g_ra8_flash_maci_cmd16_len;

void ra8_flash_internal_maci_log_reset(void);
#endif /* RA8_OFF_TARGET && UNIT_TEST */
 
#ifdef __cplusplus
}
#endif