cfn_hal_spi.h

Go to the documentation of this file.

 
#ifndef CAFFEINE_HAL_HAL_SPI_H
#define CAFFEINE_HAL_HAL_SPI_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_SPI_EVENT_NONE        = 0,
    CFN_HAL_SPI_EVENT_TX_COMPLETE = CFN_HAL_BIT(0), 
    CFN_HAL_SPI_EVENT_RX_READY    = CFN_HAL_BIT(1), 
} cfn_hal_spi_event_t;
 
typedef enum
{
    CFN_HAL_SPI_ERROR_NONE    = 0,
    CFN_HAL_SPI_ERROR_FRAMING = CFN_HAL_BIT(0), 
    CFN_HAL_SPI_ERROR_OVERRUN = CFN_HAL_BIT(1), 
    CFN_HAL_SPI_ERROR_CRC     = CFN_HAL_BIT(2), 
    CFN_HAL_SPI_ERROR_GENERAL = CFN_HAL_BIT(3), 
} cfn_hal_spi_error_t;
 
typedef enum
{
    CFN_HAL_SPI_CONFIG_FMT_POL0_PHA0, 
    CFN_HAL_SPI_CONFIG_FMT_POL0_PHA1, 
    CFN_HAL_SPI_CONFIG_FMT_POL1_PHA0, 
    CFN_HAL_SPI_CONFIG_FMT_POL1_PHA1, 
    CFN_HAL_SPI_CONFIG_FMT_MAX
} cfn_hal_spi_config_format_t;
 
typedef enum
{
    CFN_HAL_SPI_CONFIG_CS_USER_CONTROLLED, 
    CFN_HAL_SPI_CONFIG_CS_HAL_CONTROLLED,  
    CFN_HAL_SPI_CONFIG_CS_HW_CONTROLLED,   
    CFN_HAL_SPI_CONFIG_CS_MAX
} cfn_hal_spi_config_cs_mode_t;
 
/* Types Structs ----------------------------------------------------*/
 
typedef struct
{
    void                      *instance;  
    cfn_hal_gpio_pin_handle_t *mosi;      
    cfn_hal_gpio_pin_handle_t *miso;      
    cfn_hal_gpio_pin_handle_t *sck;       
    void                      *user_data; 
} cfn_hal_spi_phy_t;
 
typedef struct
{
    uint32_t                     bitrate;   
    uint32_t                     data_size; 
    cfn_hal_spi_config_format_t  fmt;       
    cfn_hal_spi_config_cs_mode_t cs_mode;   
    void                        *custom;    
} cfn_hal_spi_config_t;
 
typedef struct
{
    const uint8_t             *tx_payload;   
    uint8_t                   *rx_payload;   
    size_t                     nbr_of_bytes; 
    cfn_hal_gpio_pin_handle_t *cs;           
} cfn_hal_spi_transaction_t;
 
typedef struct cfn_hal_spi_s cfn_hal_spi_t;
 
typedef struct
{
    cfn_hal_spi_t             *spi;    
    cfn_hal_gpio_pin_handle_t *cs_pin; 
} cfn_hal_spi_device_t;
 
typedef struct cfn_hal_spi_api_s cfn_hal_spi_api_t;
 
typedef void (*cfn_hal_spi_callback_t)(cfn_hal_spi_t *driver,
                                       uint32_t       event_mask,
                                       uint32_t       error_mask,
                                       uint8_t       *data,
                                       size_t         nbr_of_bytes,
                                       void          *user_arg);
 
struct cfn_hal_spi_api_s
{
    cfn_hal_api_base_t base;
 
    /* SPI Specific Extensions */
    cfn_hal_error_code_t (*xfr_irq)(cfn_hal_spi_t *driver, const cfn_hal_spi_transaction_t *xfr);
    cfn_hal_error_code_t (*xfr_irq_abort)(cfn_hal_spi_t *driver);
    cfn_hal_error_code_t (*xfr_polling)(cfn_hal_spi_t *driver, const cfn_hal_spi_transaction_t *xfr, uint32_t timeout);
    cfn_hal_error_code_t (*xfr_dma)(cfn_hal_spi_t *driver, const cfn_hal_spi_transaction_t *xfr);
};
 
CFN_HAL_VMT_CHECK(struct cfn_hal_spi_api_s);
 
CFN_HAL_CREATE_DRIVER_TYPE(spi, cfn_hal_spi_config_t, cfn_hal_spi_api_t, cfn_hal_spi_phy_t, cfn_hal_spi_callback_t);
 
/* Functions inline ------------------------------------------------- */
CFN_HAL_INLINE void cfn_hal_spi_populate(cfn_hal_spi_t              *driver,
                                         uint32_t                    peripheral_id,
                                         struct cfn_hal_clock_s     *clock,
                                         void                       *dependency,
                                         const cfn_hal_spi_api_t    *api,
                                         const cfn_hal_spi_phy_t    *phy,
                                         const cfn_hal_spi_config_t *config,
                                         cfn_hal_spi_callback_t      callback,
                                         void                       *user_arg)
{
    CFN_HAL_POPULATE_DRIVER(
        driver, CFN_HAL_PERIPHERAL_TYPE_SPI, peripheral_id, clock, dependency, api, phy, config, callback, user_arg);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_spi_config_validate(const cfn_hal_spi_t        *driver,
                                                                const cfn_hal_spi_config_t *config)
{
    if (driver == NULL || config == NULL)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
 
    if (config->fmt >= CFN_HAL_SPI_CONFIG_FMT_MAX || config->cs_mode >= CFN_HAL_SPI_CONFIG_CS_MAX)
    {
        return CFN_HAL_ERROR_BAD_CONFIG;
    }
 
    return cfn_hal_base_config_validate(&driver->base, CFN_HAL_PERIPHERAL_TYPE_SPI, config);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_spi_init(cfn_hal_spi_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_spi_config_validate(driver, driver->config);
    if (error != CFN_HAL_ERROR_OK)
    {
        return error;
    }
    return cfn_hal_base_init(&driver->base, CFN_HAL_PERIPHERAL_TYPE_SPI);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_spi_deinit(cfn_hal_spi_t *driver)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_base_deinit(&driver->base, CFN_HAL_PERIPHERAL_TYPE_SPI);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_spi_config_set(cfn_hal_spi_t *driver, const cfn_hal_spi_config_t *config)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    cfn_hal_error_code_t error = cfn_hal_spi_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_SPI, (const void *) config);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_spi_config_get(cfn_hal_spi_t *driver, cfn_hal_spi_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_spi_callback_register(cfn_hal_spi_t               *driver,
                                                                  const cfn_hal_spi_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_SPI, (cfn_hal_callback_t) callback, user_arg);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_spi_power_state_set(cfn_hal_spi_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_SPI, state);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_spi_event_enable(cfn_hal_spi_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_SPI, event_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_spi_event_disable(cfn_hal_spi_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_SPI, event_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_spi_event_get(cfn_hal_spi_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_SPI, event_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_spi_error_enable(cfn_hal_spi_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_SPI, error_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_spi_error_disable(cfn_hal_spi_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_SPI, error_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_spi_error_get(cfn_hal_spi_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_SPI, error_mask);
}
 
/* SPI Specific Functions ------------------------------------------- */
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_spi_xfr_irq(cfn_hal_spi_t *driver, const cfn_hal_spi_transaction_t *xfr)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(CFN_HAL_PERIPHERAL_TYPE_SPI, xfr_irq, driver, error, xfr);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_spi_xfr_irq_abort(cfn_hal_spi_t *driver)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC(CFN_HAL_PERIPHERAL_TYPE_SPI, xfr_irq_abort, driver, error);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_spi_xfr_polling(cfn_hal_spi_t                   *driver,
                                                            const cfn_hal_spi_transaction_t *xfr,
                                                            uint32_t                         timeout)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(CFN_HAL_PERIPHERAL_TYPE_SPI, xfr_polling, driver, error, xfr, timeout);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_spi_xfr_dma(cfn_hal_spi_t *driver, const cfn_hal_spi_transaction_t *xfr)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(CFN_HAL_PERIPHERAL_TYPE_SPI, xfr_dma, driver, error, xfr);
    return error;
}
cfn_hal_error_code_t cfn_hal_spi_construct(cfn_hal_spi_t              *driver,
                                           const cfn_hal_spi_config_t *config,
                                           const cfn_hal_spi_phy_t    *phy,
                                           struct cfn_hal_clock_s     *clock,
                                           void                       *dependency,
                                           cfn_hal_spi_callback_t      callback,
                                           void                       *user_arg);
cfn_hal_error_code_t cfn_hal_spi_destruct(cfn_hal_spi_t *driver);
#ifdef __cplusplus
}
#endif
 
#endif // CAFFEINE_HAL_HAL_SPI_H