cfn_hal_nvm.h

Go to the documentation of this file.

 
#ifndef CAFFEINE_HAL_HAL_NVM_H
#define CAFFEINE_HAL_HAL_NVM_H
 
#ifdef __cplusplus
extern "C"
{
#endif
 
/* Includes ---------------------------------------------------------*/
#include "cfn_hal.h"
#include "cfn_hal_base.h"
#include "cfn_hal_types.h"
 
/* Defines ----------------------------------------------------------*/
 
/* Types Enums ------------------------------------------------------*/
 
typedef enum
{
    CFN_HAL_NVM_EVENT_NONE           = 0,
    CFN_HAL_NVM_EVENT_WRITE_COMPLETE = CFN_HAL_BIT(0), 
    CFN_HAL_NVM_EVENT_ERASE_COMPLETE = CFN_HAL_BIT(1), 
} cfn_hal_nvm_event_t;
 
typedef enum
{
    CFN_HAL_NVM_ERROR_NONE      = 0,
    CFN_HAL_NVM_ERROR_PROTECTED = CFN_HAL_BIT(0), 
    CFN_HAL_NVM_ERROR_ALIGNMENT = CFN_HAL_BIT(1), 
    CFN_HAL_NVM_ERROR_GENERAL   = CFN_HAL_BIT(2), 
} cfn_hal_nvm_error_t;
 
/* Types Structs ----------------------------------------------------*/
 
typedef struct
{
    size_t   total_size;   
    size_t   sector_size;  
    size_t   page_size;    
    uint32_t write_cycles; 
} cfn_hal_nvm_info_t;
 
typedef struct
{
    void *user_config; 
} cfn_hal_nvm_config_t;
 
typedef struct
{
    void *instance; 
    void *user_arg; 
} cfn_hal_nvm_phy_t;
 
typedef struct cfn_hal_nvm_s     cfn_hal_nvm_t;
typedef struct cfn_hal_nvm_api_s cfn_hal_nvm_api_t;
 
typedef void (*cfn_hal_nvm_callback_t)(cfn_hal_nvm_t *driver, uint32_t event_mask, uint32_t error_mask, void *user_arg);
 
struct cfn_hal_nvm_api_s
{
    cfn_hal_api_base_t base;
 
    /* NVM Specific Extensions */
    cfn_hal_error_code_t (*read)(cfn_hal_nvm_t *driver, uint32_t addr, uint8_t *buffer, size_t size, uint32_t timeout);
    cfn_hal_error_code_t (*write)(
        cfn_hal_nvm_t *driver, uint32_t addr, const uint8_t *data, size_t size, uint32_t timeout);
    cfn_hal_error_code_t (*erase_sector)(cfn_hal_nvm_t *driver, uint32_t sector_addr, uint32_t timeout);
    cfn_hal_error_code_t (*erase_chip)(cfn_hal_nvm_t *driver, uint32_t timeout);
    cfn_hal_error_code_t (*get_info)(cfn_hal_nvm_t *driver, uint32_t addr, cfn_hal_nvm_info_t *info);
};
 
CFN_HAL_VMT_CHECK(struct cfn_hal_nvm_api_s);
 
CFN_HAL_CREATE_DRIVER_TYPE(nvm, cfn_hal_nvm_config_t, cfn_hal_nvm_api_t, cfn_hal_nvm_phy_t, cfn_hal_nvm_callback_t);
/* Functions inline ------------------------------------------------- */
CFN_HAL_INLINE void cfn_hal_nvm_populate(cfn_hal_nvm_t              *driver,
                                         uint32_t                    peripheral_id,
                                         struct cfn_hal_clock_s     *clock,
                                         void                       *dependency,
                                         const cfn_hal_nvm_api_t    *api,
                                         const cfn_hal_nvm_phy_t    *phy,
                                         const cfn_hal_nvm_config_t *config,
                                         cfn_hal_nvm_callback_t      callback,
                                         void                       *user_arg)
{
    CFN_HAL_POPULATE_DRIVER(
        driver, CFN_HAL_PERIPHERAL_TYPE_NVM, peripheral_id, clock, dependency, api, phy, config, callback, user_arg);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_nvm_config_validate(const cfn_hal_nvm_t        *driver,
                                                                const cfn_hal_nvm_config_t *config)
{
    if (driver == NULL || config == NULL)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
 
    return cfn_hal_base_config_validate(&driver->base, CFN_HAL_PERIPHERAL_TYPE_NVM, config);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_nvm_init(cfn_hal_nvm_t *driver)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    driver->base.vmt           = (const struct cfn_hal_api_base_s *) driver->api;
    cfn_hal_error_code_t error = cfn_hal_nvm_config_validate(driver, driver->config);
    if (error != CFN_HAL_ERROR_OK)
    {
        return error;
    }
    return cfn_hal_base_init(&driver->base, CFN_HAL_PERIPHERAL_TYPE_NVM);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_nvm_deinit(cfn_hal_nvm_t *driver)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_base_deinit(&driver->base, CFN_HAL_PERIPHERAL_TYPE_NVM);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_nvm_config_set(cfn_hal_nvm_t *driver, const cfn_hal_nvm_config_t *config)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    cfn_hal_error_code_t error = cfn_hal_nvm_config_validate(driver, config);
    if (error != CFN_HAL_ERROR_OK)
    {
        return error;
    }
    {
        driver->config = config;
    }
    return cfn_hal_base_config_set(&driver->base, CFN_HAL_PERIPHERAL_TYPE_NVM, (const void *) config);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_nvm_config_get(cfn_hal_nvm_t *driver, cfn_hal_nvm_config_t *config)
{
    if (!driver || !config || !driver->config)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    *config = *(driver->config);
    return CFN_HAL_ERROR_OK;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_nvm_callback_register(cfn_hal_nvm_t               *driver,
                                                                  const cfn_hal_nvm_callback_t callback,
                                                                  void                        *user_arg)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    {
        driver->cb          = callback;
        driver->cb_user_arg = user_arg;
    }
    return cfn_hal_base_callback_register(
        &driver->base, CFN_HAL_PERIPHERAL_TYPE_NVM, (cfn_hal_callback_t) callback, user_arg);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_nvm_power_state_set(cfn_hal_nvm_t *driver, cfn_hal_power_state_t state)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_power_state_set(&driver->base, CFN_HAL_PERIPHERAL_TYPE_NVM, state);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_nvm_event_enable(cfn_hal_nvm_t *driver, uint32_t event_mask)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_base_event_enable(&driver->base, CFN_HAL_PERIPHERAL_TYPE_NVM, event_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_nvm_event_disable(cfn_hal_nvm_t *driver, uint32_t event_mask)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_base_event_disable(&driver->base, CFN_HAL_PERIPHERAL_TYPE_NVM, event_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_nvm_event_get(cfn_hal_nvm_t *driver, uint32_t *event_mask)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_base_event_get(&driver->base, CFN_HAL_PERIPHERAL_TYPE_NVM, event_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_nvm_error_enable(cfn_hal_nvm_t *driver, uint32_t error_mask)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_base_error_enable(&driver->base, CFN_HAL_PERIPHERAL_TYPE_NVM, error_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_nvm_error_disable(cfn_hal_nvm_t *driver, uint32_t error_mask)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_base_error_disable(&driver->base, CFN_HAL_PERIPHERAL_TYPE_NVM, error_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_nvm_error_get(cfn_hal_nvm_t *driver, uint32_t *error_mask)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_base_error_get(&driver->base, CFN_HAL_PERIPHERAL_TYPE_NVM, error_mask);
}
 
/* NVM Specific Functions ------------------------------------------- */
 
CFN_HAL_INLINE cfn_hal_error_code_t
cfn_hal_nvm_read(cfn_hal_nvm_t *driver, uint32_t addr, uint8_t *buffer, size_t size, uint32_t timeout)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(CFN_HAL_PERIPHERAL_TYPE_NVM, read, driver, error, addr, buffer, size, timeout);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t
cfn_hal_nvm_write(cfn_hal_nvm_t *driver, uint32_t addr, const uint8_t *data, size_t size, uint32_t timeout)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(CFN_HAL_PERIPHERAL_TYPE_NVM, write, driver, error, addr, data, size, timeout);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_nvm_erase_sector(cfn_hal_nvm_t *driver,
                                                             uint32_t       sector_addr,
                                                             uint32_t       timeout)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(CFN_HAL_PERIPHERAL_TYPE_NVM, erase_sector, driver, error, sector_addr, timeout);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_nvm_erase_chip(cfn_hal_nvm_t *driver, uint32_t timeout)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(CFN_HAL_PERIPHERAL_TYPE_NVM, erase_chip, driver, error, timeout);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_nvm_get_info(cfn_hal_nvm_t *driver, uint32_t addr, cfn_hal_nvm_info_t *info)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(CFN_HAL_PERIPHERAL_TYPE_NVM, get_info, driver, error, addr, info);
    return error;
}
cfn_hal_error_code_t cfn_hal_nvm_construct(cfn_hal_nvm_t              *driver,
                                           const cfn_hal_nvm_config_t *config,
                                           const cfn_hal_nvm_phy_t    *phy,
                                           struct cfn_hal_clock_s     *clock,
                                           void                       *dependency,
                                           cfn_hal_nvm_callback_t      callback,
                                           void                       *user_arg);
cfn_hal_error_code_t cfn_hal_nvm_destruct(cfn_hal_nvm_t *driver);
#ifdef __cplusplus
}
#endif
 
#endif // CAFFEINE_HAL_HAL_NVM_H