lx_nor_ram.c

Go to the documentation of this file.

 
#include "lx_nor_ram.h"
 
#include "lx_api.h"
#include "ra8_attributes.h"

typedef enum : uint32_t {
  k_lx_nor_ram_total_blocks    = 64U,         
  k_lx_nor_ram_words_per_block = 512U,        
  k_lx_nor_ram_total_words     = 64U * 512U,  
  k_lx_nor_ram_erased          = 0xFFFFFFFFU, 
} lx_nor_ram_const_t;

static ULONG s_ram_backing[k_lx_nor_ram_total_words];

static ULONG s_ram_sector_buf[LX_NOR_SECTOR_SIZE];

/* Signature is fixed by the LevelX driver-read callback type (non-const). */
/* cppcheck-suppress constParameterCallback -- bound to the LevelX LX_NOR_FLASH read callback typedef; the ULONG* signature is fixed by the driver seam. */
/* NOLINTNEXTLINE(readability-non-const-parameter) -- LevelX driver callback signature is fixed by the vendor seam. */
RA8_INTERNAL static UINT internal_ram_read(ULONG* flash_address, ULONG* destination, ULONG words)
{
  if (flash_address == LX_NULL) {
    return (UINT)LX_ERROR;
  }
  if (destination == LX_NULL) {
    return (UINT)LX_ERROR;
  }
  for (ULONG i = 0U; i < words; i++) {
    destination[i] = flash_address[i];
  }
  return (UINT)LX_SUCCESS;
}

/* Signature is fixed by the LevelX driver-write callback type (non-const). */
/* cppcheck-suppress constParameterCallback -- bound to the LevelX LX_NOR_FLASH write callback typedef; the ULONG* signature is fixed by the driver seam. */
/* NOLINTNEXTLINE(readability-non-const-parameter) -- LevelX driver callback signature is fixed by the vendor seam. */
RA8_INTERNAL static UINT internal_ram_write(ULONG* flash_address, ULONG* source, ULONG words)
{
  if (flash_address == LX_NULL) {
    return (UINT)LX_ERROR;
  }
  if (source == LX_NULL) {
    return (UINT)LX_ERROR;
  }
  for (ULONG i = 0U; i < words; i++) {
    flash_address[i] = source[i];
  }
  return (UINT)LX_SUCCESS;
}

RA8_INTERNAL static UINT internal_ram_block_erase(ULONG block, ULONG erase_count)
{
  LX_PARAMETER_NOT_USED(erase_count);
  if (block >= (ULONG)k_lx_nor_ram_total_blocks) {
    return (UINT)LX_ERROR;
  }
  ULONG base = block * (ULONG)k_lx_nor_ram_words_per_block;
  for (ULONG i = 0U; i < (ULONG)k_lx_nor_ram_words_per_block; i++) {
    s_ram_backing[base + i] = (ULONG)k_lx_nor_ram_erased;
  }
  return (UINT)LX_SUCCESS;
}

RA8_INTERNAL static UINT internal_ram_block_erased_verify(ULONG block)
{
  if (block >= (ULONG)k_lx_nor_ram_total_blocks) {
    return (UINT)LX_ERROR;
  }
  ULONG base = block * (ULONG)k_lx_nor_ram_words_per_block;
  for (ULONG i = 0U; i < (ULONG)k_lx_nor_ram_words_per_block; i++) {
    if (s_ram_backing[base + i] != (ULONG)k_lx_nor_ram_erased) {
      return (UINT)LX_ERROR;
    }
  }
  return (UINT)LX_SUCCESS;
}
 
unsigned int lx_nor_ram_init(struct LX_NOR_FLASH_STRUCT* nor_flash)
{
  if (nor_flash == LX_NULL) {
    return (UINT)LX_ERROR;
  }
  nor_flash->lx_nor_flash_base_address               = &s_ram_backing[0];
  nor_flash->lx_nor_flash_total_blocks               = (ULONG)k_lx_nor_ram_total_blocks;
  nor_flash->lx_nor_flash_words_per_block            = (ULONG)k_lx_nor_ram_words_per_block;
  nor_flash->lx_nor_flash_driver_read                = internal_ram_read;
  nor_flash->lx_nor_flash_driver_write               = internal_ram_write;
  nor_flash->lx_nor_flash_driver_block_erase         = internal_ram_block_erase;
  nor_flash->lx_nor_flash_driver_block_erased_verify = internal_ram_block_erased_verify;
  nor_flash->lx_nor_flash_sector_buffer              = &s_ram_sector_buf[0];
  return (UINT)LX_SUCCESS;
}
 
void lx_nor_ram_wipe(void)
{
  for (ULONG i = 0U; i < (ULONG)k_lx_nor_ram_total_words; i++) {
    s_ram_backing[i] = (ULONG)k_lx_nor_ram_erased;
  }
}