nrf_cc3xx_platform_mutex.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
#ifndef NRF_CC3XX_PLATFORM_MUTEX_H__
#define NRF_CC3XX_PLATFORM_MUTEX_H__
 
#include <stdint.h>
#include <stddef.h>
 
#include "nrf_cc3xx_platform_abort.h"
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#define NRF_CC3XX_PLATFORM_MUTEX_MASK_INVALID                        (0xA95C5F2C)   
#define NRF_CC3XX_PLATFORM_MUTEX_MASK_IS_VALID                       (0x3A<<0)      
#define NRF_CC3XX_PLATFORM_MUTEX_MASK_IS_ALLOCATED                   (0x3A<<6)      
#define NRF_CC3XX_PLATFORM_MUTEX_MASK_IS_ATOMIC                      (0x3A<<12)     
#define NRF_CC3XX_PLATFORM_MUTEX_MASK_IS_HW_MUTEX                    (0x3A<<18)     
#define NRF_CC3XX_PLATFORM_MUTEX_MASK_IS_INTERNAL_MUTEX              (0x3A<<24)     
typedef struct nrf_cc3xx_platform_mutex
{
    void *              mutex;
    uint32_t    flags;
 
} nrf_cc3xx_platform_mutex_t;
 
typedef void (*nrf_cc3xx_platform_mutex_init_fn_t)(nrf_cc3xx_platform_mutex_t *mutex);
 
 
typedef void (*nrf_cc3xx_platform_mutex_free_fn_t)(nrf_cc3xx_platform_mutex_t *mutex);
 
 
typedef int (*nrf_cc3xx_platform_mutex_lock_fn_t)(nrf_cc3xx_platform_mutex_t *mutex);
 
 
typedef int (*nrf_cc3xx_platform_mutex_unlock_fn_t)(nrf_cc3xx_platform_mutex_t *mutex);
 
 
typedef struct nrf_cc3xx_platform_mutex_apis_t
{
    /* The platform mutex init function */
    nrf_cc3xx_platform_mutex_init_fn_t          mutex_init_fn;
 
    /* The platform mutex free function */
    nrf_cc3xx_platform_mutex_free_fn_t          mutex_free_fn;
 
    /* The platform lock function */
    nrf_cc3xx_platform_mutex_lock_fn_t          mutex_lock_fn;
 
    /* The platform unlock function */
    nrf_cc3xx_platform_mutex_unlock_fn_t        mutex_unlock_fn;
} nrf_cc3xx_platform_mutex_apis_t;
 
 
typedef struct nrf_cc3xx_platform_mutexes_t
{
    /* Mutex for symmetric operations. */
    void * sym_mutex;
 
    /* Mutex for asymetric operations. */
    void * asym_mutex;
 
    /* Mutex for rng operations. */
    void * rng_mutex;
 
    /* Mutex reserved for future use. */
    void * reserved;
 
    /* Mutex for power mode changes */
    void * power_mutex;
} nrf_cc3xx_platform_mutexes_t;
 
 
extern nrf_cc3xx_platform_mutex_apis_t  platform_mutex_apis;
 
 
extern nrf_cc3xx_platform_mutexes_t     platform_mutexes;
 
 
void nrf_cc3xx_platform_set_mutexes(
    nrf_cc3xx_platform_mutex_apis_t const * const apis,
    nrf_cc3xx_platform_mutexes_t const * const mutexes);
 
 
void nrf_cc3xx_platform_mutex_init(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* NRF_CC3XX_PLATFORM_MUTEX_H__ */