devices/MIMX8MQ6/drivers/fsl_ecspi_freertos.h

/*
 * Copyright (c) 2016, Freescale Semiconductor, Inc.
 * Copyright 2016-2019 NXP
 * All rights reserved.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
#ifndef __FSL_ECSPI_FREERTOS_H__
#define __FSL_ECSPI_FREERTOS_H__

#include "FreeRTOS.h"
#include "portable.h"
#include "semphr.h"

#include "fsl_ecspi.h"

/*!
 * @addtogroup ecspi_freertos_driver
 * @{
 */

/*******************************************************************************
 * Definitions
 ******************************************************************************/

/*! @name Driver version */
/*@{*/
/*! @brief ECSPI FreeRTOS driver version 2.0.2. */
#define FSL_ECSPI_FREERTOS_DRIVER_VERSION (MAKE_VERSION(2, 0, 2))
/*@}*/

/*!
 * @cond RTOS_PRIVATE
 * @brief ECSPI FreeRTOS handle
 */
typedef struct _ecspi_rtos_handle
{
    ECSPI_Type *base;                 /*!< ECSPI base address */
    ecspi_master_handle_t drv_handle; /*!< Handle of the underlying driver, treated as opaque by the RTOS layer */
    status_t async_status;            /*!< Transactional state of the underlying driver */
    SemaphoreHandle_t mutex;          /*!< Mutex to lock the handle during a trasfer */
    SemaphoreHandle_t event;          /*!< Semaphore to notify and unblock task when transfer ends */
#if (configSUPPORT_STATIC_ALLOCATION == 1)
    StaticSemaphore_t mutexBuffer;     /*!< Statically allocated memory for mutex */
    StaticSemaphore_t semaphoreBuffer; /*!< Statically allocated memory for event */
#endif
} ecspi_rtos_handle_t;
/*! \endcond */

/*******************************************************************************
 * API
 ******************************************************************************/

#if defined(__cplusplus)
extern "C" {
#endif

/*!
 * @name ECSPI RTOS Operation
 * @{
 */

/*!
 * @brief Initializes ECSPI.
 *
 * This function initializes the ECSPI module and related RTOS context.
 *
 * @param handle The RTOS ECSPI handle, the pointer to an allocated space for RTOS context.
 * @param base The pointer base address of the ECSPI instance to initialize.
 * @param masterConfig Configuration structure to set-up ECSPI in master mode.
 * @param srcClock_Hz Frequency of input clock of the ECSPI module.
 * @return status of the operation.
 */
status_t ECSPI_RTOS_Init(ecspi_rtos_handle_t *handle,
                         ECSPI_Type *base,
                         const ecspi_master_config_t *masterConfig,
                         uint32_t srcClock_Hz);

/*!
 * @brief Deinitializes the ECSPI.
 *
 * This function deinitializes the ECSPI module and related RTOS context.
 *
 * @param handle The RTOS ECSPI handle.
 */
status_t ECSPI_RTOS_Deinit(ecspi_rtos_handle_t *handle);

/*!
 * @brief Performs ECSPI transfer.
 *
 * This function performs an ECSPI transfer according to data given in the transfer structure.
 *
 * @param handle The RTOS ECSPI handle.
 * @param transfer Structure specifying the transfer parameters.
 * @return status of the operation.
 */
status_t ECSPI_RTOS_Transfer(ecspi_rtos_handle_t *handle, ecspi_transfer_t *transfer);

/*!
 * @}
 */

#if defined(__cplusplus)
}
#endif

/*!
 * @}
 */

#endif /* __FSL_ECSPI_FREERTOS_H__ */