cfn_hal_qspi.h

Go to the documentation of this file.

 
#ifndef CAFFEINE_HAL_HAL_QSPI_H
#define CAFFEINE_HAL_HAL_QSPI_H
 
#ifdef __cplusplus
extern "C"
{
#endif
 
/* Includes ---------------------------------------------------------*/
#include "cfn_hal.h"
#include "cfn_hal_base.h"
#include "cfn_hal_gpio.h"
#include "cfn_hal_types.h"
 
/* Defines ----------------------------------------------------------*/
 
/* Types Enums ------------------------------------------------------*/
 
typedef enum
{
    CFN_HAL_QSPI_EVENT_NONE        = 0,
    CFN_HAL_QSPI_EVENT_TX_COMPLETE = CFN_HAL_BIT(0), 
    CFN_HAL_QSPI_EVENT_RX_READY    = CFN_HAL_BIT(1), 
    CFN_HAL_QSPI_EVENT_CMD_DONE    = CFN_HAL_BIT(2), 
} cfn_hal_qspi_event_t;
 
typedef enum
{
    CFN_HAL_QSPI_ERROR_NONE    = 0,
    CFN_HAL_QSPI_ERROR_TIMEOUT = CFN_HAL_BIT(0), 
    CFN_HAL_QSPI_ERROR_GENERAL = CFN_HAL_BIT(1), 
} cfn_hal_qspi_error_t;
 
typedef enum
{
    CFN_HAL_QSPI_BUS_WIDTH_NONE   = 0,
    CFN_HAL_QSPI_BUS_WIDTH_SINGLE = 1,
    CFN_HAL_QSPI_BUS_WIDTH_DUAL   = 2,
    CFN_HAL_QSPI_BUS_WIDTH_QUAD   = 3,
} cfn_hal_qspi_bus_width_t;
 
/* Types Structs ----------------------------------------------------*/
 
typedef struct
{
    uint32_t                 instruction;      
    uint32_t                 address;          
    uint32_t                 dummy_cycles;     
    cfn_hal_qspi_bus_width_t instruction_mode; 
    cfn_hal_qspi_bus_width_t address_mode;     
    cfn_hal_qspi_bus_width_t data_mode;        
    size_t                   nbr_of_data;      
} cfn_hal_qspi_cmd_t;
 
typedef struct
{
    uint32_t clock_prescaler; 
    uint32_t flash_size;      
    void    *custom;          
} cfn_hal_qspi_config_t;
 
typedef struct
{
    void                      *instance; 
    cfn_hal_gpio_pin_handle_t *clk;      
    cfn_hal_gpio_pin_handle_t *cs;       
    cfn_hal_gpio_pin_handle_t *io0;      
    cfn_hal_gpio_pin_handle_t *io1;      
    cfn_hal_gpio_pin_handle_t *io2;      
    cfn_hal_gpio_pin_handle_t *io3;      
    void                      *user_arg; 
} cfn_hal_qspi_phy_t;
 
typedef struct cfn_hal_qspi_s     cfn_hal_qspi_t;
typedef struct cfn_hal_qspi_api_s cfn_hal_qspi_api_t;
 
typedef void (*cfn_hal_qspi_callback_t)(cfn_hal_qspi_t *driver,
                                        uint32_t        event_mask,
                                        uint32_t        error_mask,
                                        void           *user_arg);
 
struct cfn_hal_qspi_api_s
{
    cfn_hal_api_base_t base;
 
    /* QSPI Specific Extensions */
    cfn_hal_error_code_t (*command)(cfn_hal_qspi_t *driver, const cfn_hal_qspi_cmd_t *cmd, uint32_t timeout);
    cfn_hal_error_code_t (*transmit)(cfn_hal_qspi_t *driver, const uint8_t *data, uint32_t timeout);
    cfn_hal_error_code_t (*receive)(cfn_hal_qspi_t *driver, uint8_t *data, uint32_t timeout);
    cfn_hal_error_code_t (*memory_mapped_enable)(cfn_hal_qspi_t *driver, const cfn_hal_qspi_cmd_t *cmd);
    cfn_hal_error_code_t (*autopolling_enable)(
        cfn_hal_qspi_t *driver, const cfn_hal_qspi_cmd_t *cmd, uint32_t match, uint32_t mask, uint32_t timeout);
};
 
CFN_HAL_VMT_CHECK(struct cfn_hal_qspi_api_s);
 
CFN_HAL_CREATE_DRIVER_TYPE(
    qspi, cfn_hal_qspi_config_t, cfn_hal_qspi_api_t, cfn_hal_qspi_phy_t, cfn_hal_qspi_callback_t);
 
/* Functions inline ------------------------------------------------- */
CFN_HAL_INLINE void cfn_hal_qspi_populate(cfn_hal_qspi_t              *driver,
                                          uint32_t                     peripheral_id,
                                          struct cfn_hal_clock_s      *clock,
                                          void                        *dependency,
                                          const cfn_hal_qspi_api_t    *api,
                                          const cfn_hal_qspi_phy_t    *phy,
                                          const cfn_hal_qspi_config_t *config,
                                          cfn_hal_qspi_callback_t      callback,
                                          void                        *user_arg)
{
    CFN_HAL_POPULATE_DRIVER(
        driver, CFN_HAL_PERIPHERAL_TYPE_QSPI, peripheral_id, clock, dependency, api, phy, config, callback, user_arg);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_qspi_config_validate(const cfn_hal_qspi_t        *driver,
                                                                 const cfn_hal_qspi_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_QSPI, config);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_qspi_init(cfn_hal_qspi_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_qspi_config_validate(driver, driver->config);
    if (error != CFN_HAL_ERROR_OK)
    {
        return error;
    }
    return cfn_hal_base_init(&driver->base, CFN_HAL_PERIPHERAL_TYPE_QSPI);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_qspi_deinit(cfn_hal_qspi_t *driver)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_base_deinit(&driver->base, CFN_HAL_PERIPHERAL_TYPE_QSPI);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_qspi_config_set(cfn_hal_qspi_t *driver, const cfn_hal_qspi_config_t *config)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    cfn_hal_error_code_t error = cfn_hal_qspi_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_QSPI, (const void *) config);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_qspi_config_get(cfn_hal_qspi_t *driver, cfn_hal_qspi_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_qspi_callback_register(cfn_hal_qspi_t               *driver,
                                                                   const cfn_hal_qspi_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_QSPI, (cfn_hal_callback_t) callback, user_arg);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_qspi_power_state_set(cfn_hal_qspi_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_QSPI, state);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_qspi_event_enable(cfn_hal_qspi_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_QSPI, event_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_qspi_event_disable(cfn_hal_qspi_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_QSPI, event_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_qspi_event_get(cfn_hal_qspi_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_QSPI, event_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_qspi_error_enable(cfn_hal_qspi_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_QSPI, error_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_qspi_error_disable(cfn_hal_qspi_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_QSPI, error_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_qspi_error_get(cfn_hal_qspi_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_QSPI, error_mask);
}
 
/* QSPI Specific Functions ------------------------------------------ */
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_qspi_command(cfn_hal_qspi_t           *driver,
                                                         const cfn_hal_qspi_cmd_t *cmd,
                                                         uint32_t                  timeout)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(CFN_HAL_PERIPHERAL_TYPE_QSPI, command, driver, error, cmd, timeout);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_qspi_transmit(cfn_hal_qspi_t *driver, const uint8_t *data, uint32_t timeout)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(CFN_HAL_PERIPHERAL_TYPE_QSPI, transmit, driver, error, data, timeout);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_qspi_receive(cfn_hal_qspi_t *driver, uint8_t *data, uint32_t timeout)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(CFN_HAL_PERIPHERAL_TYPE_QSPI, receive, driver, error, data, timeout);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_qspi_memory_mapped_enable(cfn_hal_qspi_t           *driver,
                                                                      const cfn_hal_qspi_cmd_t *cmd)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(CFN_HAL_PERIPHERAL_TYPE_QSPI, memory_mapped_enable, driver, error, cmd);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_qspi_autopolling_enable(
    cfn_hal_qspi_t *driver, const cfn_hal_qspi_cmd_t *cmd, uint32_t match, uint32_t mask, uint32_t timeout)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(
        CFN_HAL_PERIPHERAL_TYPE_QSPI, autopolling_enable, driver, error, cmd, match, mask, timeout);
    return error;
}
 
cfn_hal_error_code_t cfn_hal_qspi_construct(cfn_hal_qspi_t              *driver,
                                            const cfn_hal_qspi_config_t *config,
                                            const cfn_hal_qspi_phy_t    *phy,
                                            struct cfn_hal_clock_s      *clock,
                                            void                        *dependency,
                                            cfn_hal_qspi_callback_t      callback,
                                            void                        *user_arg);
cfn_hal_error_code_t cfn_hal_qspi_destruct(cfn_hal_qspi_t *driver);
#ifdef __cplusplus
}
#endif
 
#endif // CAFFEINE_HAL_HAL_QSPI_H