px_log_fs_glue_at25s.c

/* =============================================================================
     ____    ___    ____    ___    _   _    ___    __  __   ___  __  __ TM
    |  _ \  |_ _|  / ___|  / _ \  | \ | |  / _ \  |  \/  | |_ _| \ \/ /
    | |_) |  | |  | |     | | | | |  \| | | | | | | |\/| |  | |   \  /
    |  __/   | |  | |___  | |_| | | |\  | | |_| | | |  | |  | |   /  \
    |_|     |___|  \____|  \___/  |_| \_|  \___/  |_|  |_| |___| /_/\_\
 
    Copyright (c) 2019 Pieter Conradie <https://piconomix.com>
 
    License: MIT
    https://github.com/piconomix/px-fwlib/blob/master/LICENSE.md
    
    Title:          px_log_fs_glue.h : Physical device glue layer for Log FS
    Author(s):      Pieter Conradie
    Creation Date:  2019-01-11
 
============================================================================= */
 
/* _____STANDARD INCLUDES____________________________________________________ */
 
/* _____PROJECT INCLUDES_____________________________________________________ */
#include "px_log_fs_glue.h"
#include "px_log_fs_cfg.h"
#include "px_at25s.h"
#include "px_log.h"
 
/* _____LOCAL DEFINITIONS____________________________________________________ */
PX_LOG_NAME("px_log_fs_glue");
 
/* _____MACROS_______________________________________________________________ */
 
/* _____GLOBAL VARIABLES_____________________________________________________ */
 
/* _____LOCAL VARIABLES______________________________________________________ */
 
/* _____LOCAL FUNCTION DECLARATIONS__________________________________________ */
 
/* _____LOCAL FUNCTIONS______________________________________________________ */
 
/* _____GLOBAL FUNCTIONS_____________________________________________________ */
void px_log_fs_glue_rd(void *   buf,
                       uint16_t page,
                       uint16_t start_byte_in_page,
                       uint16_t nr_of_bytes)
{
    // Sanity checks
    PX_LOG_ASSERT(start_byte_in_page < PX_LOG_FS_CFG_PAGE_SIZE);
    PX_LOG_ASSERT(nr_of_bytes <= (PX_LOG_FS_CFG_PAGE_SIZE - start_byte_in_page));
 
    // Read data from Serial Flash
    px_at25s_rd_page_offset(buf, page, start_byte_in_page, nr_of_bytes);
}
 
void px_log_fs_glue_wr(const void * buf,
                       uint16_t     page,
                       uint16_t     start_byte_in_page,
                       uint16_t     nr_of_bytes)
{
    // Sanity checks
    PX_LOG_ASSERT(start_byte_in_page < PX_LOG_FS_CFG_PAGE_SIZE);
    PX_LOG_ASSERT(nr_of_bytes <= (PX_LOG_FS_CFG_PAGE_SIZE - start_byte_in_page));
 
    // Write data to Serial Flash
    px_at25s_wr_page_offset(buf, page, start_byte_in_page, nr_of_bytes);
}
 
void px_log_fs_glue_erase_block(uint16_t page)
{
    // Sanity checks
    PX_LOG_ASSERT((page & (PX_LOG_FS_CFG_ERASE_BLOCK_SIZE - 1)) == 0);
    
#if   (PX_LOG_FS_CFG_ERASE_BLOCK_SIZE == PX_AT25S_PAGES_PER_BLOCK_4KB)
 
    // Erase 4 KB block
    px_at25s_erase(PX_AT25S_BLOCK_4KB, page);
 
#elif (PX_LOG_FS_CFG_ERASE_BLOCK_SIZE == PX_AT25S_PAGES_PER_BLOCK_32KB)
 
    // Erase 32 KB block
    px_at25s_erase(PX_AT25S_BLOCK_32KB, page);
 
#elif (PX_LOG_FS_CFG_ERASE_BLOCK_SIZE == PX_AT25S_PAGES_PER_BLOCK_64KB)
 
    // Erase 64 KB block
    px_at25s_erase(PX_AT25S_BLOCK_64KB, page);
 
#else
    #error "Invalid block size specified");
#endif
}