cfn_hal_crypto.h

Go to the documentation of this file.

 
#ifndef CAFFEINE_HAL_HAL_CRYPTO_H
#define CAFFEINE_HAL_HAL_CRYPTO_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_CRYPTO_EVENT_NONE        = 0,
    CFN_HAL_CRYPTO_EVENT_OP_COMPLETE = CFN_HAL_BIT(0), 
} cfn_hal_crypto_event_t;
 
typedef enum
{
    CFN_HAL_CRYPTO_ERROR_NONE    = 0,
    CFN_HAL_CRYPTO_ERROR_AUTH    = CFN_HAL_BIT(0), 
    CFN_HAL_CRYPTO_ERROR_GENERAL = CFN_HAL_BIT(1), 
} cfn_hal_crypto_error_t;
 
typedef enum
{
    CFN_HAL_CRYPTO_ALGO_AES_ECB,
    CFN_HAL_CRYPTO_ALGO_AES_CBC,
    CFN_HAL_CRYPTO_ALGO_AES_GCM,
    CFN_HAL_CRYPTO_ALGO_SHA256,
    CFN_HAL_CRYPTO_ALGO_SHA512,
 
    CFN_HAL_CRYPTO_ALGO_MAX
} cfn_hal_crypto_algo_t;
 
/* Types Structs ----------------------------------------------------*/
 
typedef struct
{
    cfn_hal_crypto_algo_t algo;        
    void                 *user_config; 
} cfn_hal_crypto_config_t;
 
typedef struct
{
    void *instance; 
    void *user_arg; 
} cfn_hal_crypto_phy_t;
 
typedef struct cfn_hal_crypto_s     cfn_hal_crypto_t;
typedef struct cfn_hal_crypto_api_s cfn_hal_crypto_api_t;
 
typedef void (*cfn_hal_crypto_callback_t)(cfn_hal_crypto_t *driver,
                                          uint32_t          event_mask,
                                          uint32_t          error_mask,
                                          void             *user_arg);
 
struct cfn_hal_crypto_api_s
{
    cfn_hal_api_base_t base;
 
    /* Crypto Specific Extensions */
    cfn_hal_error_code_t (*encrypt)(
        cfn_hal_crypto_t *driver, const uint8_t *in, uint8_t *out, size_t size, uint32_t timeout);
    cfn_hal_error_code_t (*decrypt)(
        cfn_hal_crypto_t *driver, const uint8_t *in, uint8_t *out, size_t size, uint32_t timeout);
    cfn_hal_error_code_t (*hash_update)(cfn_hal_crypto_t *driver, const uint8_t *data, size_t size);
    cfn_hal_error_code_t (*hash_finish)(cfn_hal_crypto_t *driver, uint8_t *hash, uint32_t timeout);
    cfn_hal_error_code_t (*generate_random)(cfn_hal_crypto_t *driver, uint8_t *buffer, size_t size);
    cfn_hal_error_code_t (*set_key)(cfn_hal_crypto_t *driver, const uint8_t *key, size_t key_size);
};
 
CFN_HAL_VMT_CHECK(struct cfn_hal_crypto_api_s);
 
CFN_HAL_CREATE_DRIVER_TYPE(
    crypto, cfn_hal_crypto_config_t, cfn_hal_crypto_api_t, cfn_hal_crypto_phy_t, cfn_hal_crypto_callback_t);
/* Functions inline ------------------------------------------------- */
CFN_HAL_INLINE void cfn_hal_crypto_populate(cfn_hal_crypto_t              *driver,
                                            uint32_t                       peripheral_id,
                                            struct cfn_hal_clock_s        *clock,
                                            void                          *dependency,
                                            const cfn_hal_crypto_api_t    *api,
                                            const cfn_hal_crypto_phy_t    *phy,
                                            const cfn_hal_crypto_config_t *config,
                                            cfn_hal_crypto_callback_t      callback,
                                            void                          *user_arg)
{
    CFN_HAL_POPULATE_DRIVER(
        driver, CFN_HAL_PERIPHERAL_TYPE_CRYPTO, peripheral_id, clock, dependency, api, phy, config, callback, user_arg);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_crypto_config_validate(const cfn_hal_crypto_t        *driver,
                                                                   const cfn_hal_crypto_config_t *config)
{
    if (driver == NULL || config == NULL)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
 
    if (config->algo >= CFN_HAL_CRYPTO_ALGO_MAX)
    {
        return CFN_HAL_ERROR_BAD_CONFIG;
    }
 
    return cfn_hal_base_config_validate(&driver->base, CFN_HAL_PERIPHERAL_TYPE_CRYPTO, config);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_crypto_init(cfn_hal_crypto_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_crypto_config_validate(driver, driver->config);
    if (error != CFN_HAL_ERROR_OK)
    {
        return error;
    }
    return cfn_hal_base_init(&driver->base, CFN_HAL_PERIPHERAL_TYPE_CRYPTO);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_crypto_deinit(cfn_hal_crypto_t *driver)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    return cfn_hal_base_deinit(&driver->base, CFN_HAL_PERIPHERAL_TYPE_CRYPTO);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_crypto_config_set(cfn_hal_crypto_t              *driver,
                                                              const cfn_hal_crypto_config_t *config)
{
    if (!driver)
    {
        return CFN_HAL_ERROR_BAD_PARAM;
    }
    {
        driver->config = config;
    }
    return cfn_hal_base_config_set(&driver->base, CFN_HAL_PERIPHERAL_TYPE_CRYPTO, (const void *) config);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_crypto_config_get(cfn_hal_crypto_t *driver, cfn_hal_crypto_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_crypto_callback_register(cfn_hal_crypto_t               *driver,
                                                                     const cfn_hal_crypto_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_CRYPTO, (cfn_hal_callback_t) callback, user_arg);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_crypto_power_state_set(cfn_hal_crypto_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_CRYPTO, state);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_crypto_event_enable(cfn_hal_crypto_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_CRYPTO, event_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_crypto_event_disable(cfn_hal_crypto_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_CRYPTO, event_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_crypto_event_get(cfn_hal_crypto_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_CRYPTO, event_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_crypto_error_enable(cfn_hal_crypto_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_CRYPTO, error_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_crypto_error_disable(cfn_hal_crypto_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_CRYPTO, error_mask);
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_crypto_error_get(cfn_hal_crypto_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_CRYPTO, error_mask);
}
 
/* CRYPTO Specific Functions ---------------------------------------- */
 
CFN_HAL_INLINE cfn_hal_error_code_t
cfn_hal_crypto_encrypt(cfn_hal_crypto_t *driver, const uint8_t *in, uint8_t *out, 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_CRYPTO, encrypt, driver, error, in, out, size, timeout);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t
cfn_hal_crypto_decrypt(cfn_hal_crypto_t *driver, const uint8_t *in, uint8_t *out, 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_CRYPTO, decrypt, driver, error, in, out, size, timeout);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_crypto_hash_update(cfn_hal_crypto_t *driver,
                                                               const uint8_t    *data,
                                                               size_t            size)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(CFN_HAL_PERIPHERAL_TYPE_CRYPTO, hash_update, driver, error, data, size);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_crypto_hash_finish(cfn_hal_crypto_t *driver,
                                                               uint8_t          *hash,
                                                               uint32_t          timeout)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(CFN_HAL_PERIPHERAL_TYPE_CRYPTO, hash_finish, driver, error, hash, timeout);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_crypto_generate_random(cfn_hal_crypto_t *driver,
                                                                   uint8_t          *buffer,
                                                                   size_t            size)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(CFN_HAL_PERIPHERAL_TYPE_CRYPTO, generate_random, driver, error, buffer, size);
    return error;
}
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_crypto_set_key(cfn_hal_crypto_t *driver,
                                                           const uint8_t    *key,
                                                           size_t            key_size)
{
    cfn_hal_error_code_t error = CFN_HAL_ERROR_OK;
    CFN_HAL_CHECK_AND_CALL_FUNC_VARG(CFN_HAL_PERIPHERAL_TYPE_CRYPTO, set_key, driver, error, key, key_size);
    return error;
}
cfn_hal_error_code_t cfn_hal_crypto_construct(cfn_hal_crypto_t              *driver,
                                              const cfn_hal_crypto_config_t *config,
                                              const cfn_hal_crypto_phy_t    *phy,
                                              struct cfn_hal_clock_s        *clock,
                                              void                          *dependency,
                                              cfn_hal_crypto_callback_t      callback,
                                              void                          *user_arg);
cfn_hal_error_code_t cfn_hal_crypto_destruct(cfn_hal_crypto_t *driver);
#ifdef __cplusplus
}
#endif
 
#endif // CAFFEINE_HAL_HAL_CRYPTO_H