diff options
author | Dominik Sliwa <dominik.sliwa@toradex.com> | 2017-05-16 14:31:59 +0200 |
---|---|---|
committer | Dominik Sliwa <dominik.sliwa@toradex.com> | 2017-05-16 14:31:59 +0200 |
commit | c9d5d6b248a12f7c6b66d8a64b93fb0c8c6cae4d (patch) | |
tree | dc9f3329f9fd2fc67aa8202b2d3cb4e537deb17d /drivers/fsl_dspi_edma.h | |
parent | d0e5a94a55334b0a27652959fba5066f56128135 (diff) |
ksd:ksdk update to 2.2
This include FreeRTOS update to version 9.0.0
Signed-off-by: Dominik Sliwa <dominik.sliwa@toradex.com>
Diffstat (limited to 'drivers/fsl_dspi_edma.h')
-rw-r--r-- | drivers/fsl_dspi_edma.h | 111 |
1 files changed, 55 insertions, 56 deletions
diff --git a/drivers/fsl_dspi_edma.h b/drivers/fsl_dspi_edma.h index 643efad..23e29ce 100644 --- a/drivers/fsl_dspi_edma.h +++ b/drivers/fsl_dspi_edma.h @@ -1,6 +1,6 @@ /* * Copyright (c) 2015, Freescale Semiconductor, Inc. - * All rights reserved. + * Copyright 2016-2017 NXP * * Redistribution and use in source and binary forms, with or without modification, * are permitted provided that the following conditions are met: @@ -12,7 +12,7 @@ * list of conditions and the following disclaimer in the documentation and/or * other materials provided with the distribution. * - * o Neither the name of Freescale Semiconductor, Inc. nor the names of its + * o Neither the name of the copyright holder nor the names of its * contributors may be used to endorse or promote products derived from this * software without specific prior written permission. * @@ -37,7 +37,6 @@ * @{ */ - /*********************************************************************************************************************** * Definitions **********************************************************************************************************************/ @@ -56,9 +55,9 @@ typedef struct _dspi_slave_edma_handle dspi_slave_edma_handle_t; * @brief Completion callback function pointer type. * * @param base DSPI peripheral base address. - * @param handle Pointer to the handle for the DSPI master. + * @param handle A pointer to the handle for the DSPI master. * @param status Success or error code describing whether the transfer completed. - * @param userData Arbitrary pointer-dataSized value passed from the application. + * @param userData An arbitrary pointer-dataSized value passed from the application. */ typedef void (*dspi_master_edma_transfer_callback_t)(SPI_Type *base, dspi_master_edma_handle_t *handle, @@ -68,38 +67,39 @@ typedef void (*dspi_master_edma_transfer_callback_t)(SPI_Type *base, * @brief Completion callback function pointer type. * * @param base DSPI peripheral base address. - * @param handle Pointer to the handle for the DSPI slave. + * @param handle A pointer to the handle for the DSPI slave. * @param status Success or error code describing whether the transfer completed. - * @param userData Arbitrary pointer-dataSized value passed from the application. + * @param userData An arbitrary pointer-dataSized value passed from the application. */ typedef void (*dspi_slave_edma_transfer_callback_t)(SPI_Type *base, dspi_slave_edma_handle_t *handle, status_t status, void *userData); -/*! @brief DSPI master eDMA transfer handle structure used for transactional API. */ +/*! @brief DSPI master eDMA transfer handle structure used for the transactional API. */ struct _dspi_master_edma_handle { - uint32_t bitsPerFrame; /*!< Desired number of bits per frame. */ - volatile uint32_t command; /*!< Desired data command. */ - volatile uint32_t lastCommand; /*!< Desired last data command. */ + uint32_t bitsPerFrame; /*!< The desired number of bits per frame. */ + volatile uint32_t command; /*!< The desired data command. */ + volatile uint32_t lastCommand; /*!< The desired last data command. */ uint8_t fifoSize; /*!< FIFO dataSize. */ - volatile bool isPcsActiveAfterTransfer; /*!< Is PCS signal keep active after the last frame transfer.*/ - volatile bool isThereExtraByte; /*!< Is there extra byte.*/ + volatile bool + isPcsActiveAfterTransfer; /*!< Indicates whether the PCS signal keeps active after the last frame transfer.*/ + + uint8_t nbytes; /*!< eDMA minor byte transfer count initially configured. */ + volatile uint8_t state; /*!< DSPI transfer state , _dspi_transfer_state.*/ uint8_t *volatile txData; /*!< Send buffer. */ uint8_t *volatile rxData; /*!< Receive buffer. */ - volatile size_t remainingSendByteCount; /*!< Number of bytes remaining to send.*/ - volatile size_t remainingReceiveByteCount; /*!< Number of bytes remaining to receive.*/ - size_t totalByteCount; /*!< Number of transfer bytes*/ + volatile size_t remainingSendByteCount; /*!< A number of bytes remaining to send.*/ + volatile size_t remainingReceiveByteCount; /*!< A number of bytes remaining to receive.*/ + size_t totalByteCount; /*!< A number of transfer bytes*/ uint32_t rxBuffIfNull; /*!< Used if there is not rxData for DMA purpose.*/ uint32_t txBuffIfNull; /*!< Used if there is not txData for DMA purpose.*/ - volatile uint8_t state; /*!< DSPI transfer state , _dspi_transfer_state.*/ - dspi_master_edma_transfer_callback_t callback; /*!< Completion callback. */ void *userData; /*!< Callback user data. */ @@ -110,33 +110,30 @@ struct _dspi_master_edma_handle edma_tcd_t dspiSoftwareTCD[2]; /*!<SoftwareTCD , internal used*/ }; -/*! @brief DSPI slave eDMA transfer handle structure used for transactional API.*/ +/*! @brief DSPI slave eDMA transfer handle structure used for the transactional API.*/ struct _dspi_slave_edma_handle { - uint32_t bitsPerFrame; /*!< Desired number of bits per frame. */ - volatile bool isThereExtraByte; /*!< Is there extra byte.*/ + uint32_t bitsPerFrame; /*!< The desired number of bits per frame. */ uint8_t *volatile txData; /*!< Send buffer. */ uint8_t *volatile rxData; /*!< Receive buffer. */ - volatile size_t remainingSendByteCount; /*!< Number of bytes remaining to send.*/ - volatile size_t remainingReceiveByteCount; /*!< Number of bytes remaining to receive.*/ - size_t totalByteCount; /*!< Number of transfer bytes*/ + volatile size_t remainingSendByteCount; /*!< A number of bytes remaining to send.*/ + volatile size_t remainingReceiveByteCount; /*!< A number of bytes remaining to receive.*/ + size_t totalByteCount; /*!< A number of transfer bytes*/ uint32_t rxBuffIfNull; /*!< Used if there is not rxData for DMA purpose.*/ uint32_t txBuffIfNull; /*!< Used if there is not txData for DMA purpose.*/ uint32_t txLastData; /*!< Used if there is an extra byte when 16bits per frame for DMA purpose.*/ - volatile uint8_t state; /*!< DSPI transfer state.*/ + uint8_t nbytes; /*!< eDMA minor byte transfer count initially configured. */ - uint32_t errorCount; /*!< Error count for slave transfer.*/ + volatile uint8_t state; /*!< DSPI transfer state.*/ dspi_slave_edma_transfer_callback_t callback; /*!< Completion callback. */ void *userData; /*!< Callback user data. */ edma_handle_t *edmaRxRegToRxDataHandle; /*!<edma_handle_t handle point used for RxReg to RxData buff*/ edma_handle_t *edmaTxDataToTxRegHandle; /*!<edma_handle_t handle point used for TxData to TxReg*/ - - edma_tcd_t dspiSoftwareTCD[2]; /*!<SoftwareTCD , internal used*/ }; /*********************************************************************************************************************** @@ -152,17 +149,18 @@ extern "C" { * @brief Initializes the DSPI master eDMA handle. * * This function initializes the DSPI eDMA handle which can be used for other DSPI transactional APIs. Usually, for a - * specified DSPI instance, user need only call this API once to get the initialized handle. + * specified DSPI instance, call this API once to get the initialized handle. * - * Note that DSPI eDMA has separated (RX and TX as two sources) or shared (RX and TX are the same source) DMA request source. - * (1)For the separated DMA request source, enable and set the RX DMAMUX source for edmaRxRegToRxDataHandle and + * Note that DSPI eDMA has separated (RX and TX as two sources) or shared (RX and TX are the same source) DMA request + * source. + * (1) For the separated DMA request source, enable and set the RX DMAMUX source for edmaRxRegToRxDataHandle and * TX DMAMUX source for edmaIntermediaryToTxRegHandle. - * (2)For the shared DMA request source, enable and set the RX/RX DMAMUX source for the edmaRxRegToRxDataHandle. + * (2) For the shared DMA request source, enable and set the RX/RX DMAMUX source for the edmaRxRegToRxDataHandle. * * @param base DSPI peripheral base address. * @param handle DSPI handle pointer to dspi_master_edma_handle_t. * @param callback DSPI callback. - * @param userData callback function parameter. + * @param userData A callback function parameter. * @param edmaRxRegToRxDataHandle edmaRxRegToRxDataHandle pointer to edma_handle_t. * @param edmaTxDataToIntermediaryHandle edmaTxDataToIntermediaryHandle pointer to edma_handle_t. * @param edmaIntermediaryToTxRegHandle edmaIntermediaryToTxRegHandle pointer to edma_handle_t. @@ -178,34 +176,34 @@ void DSPI_MasterTransferCreateHandleEDMA(SPI_Type *base, /*! * @brief DSPI master transfer data using eDMA. * - * This function transfer data using eDMA. This is non-blocking function, which returns right away. When all data - * have been transfer, the callback function is called. + * This function transfers data using eDMA. This is a non-blocking function, which returns right away. When all data + * is transferred, the callback function is called. * * @param base DSPI peripheral base address. - * @param handle pointer to dspi_master_edma_handle_t structure which stores the transfer state. - * @param transfer pointer to dspi_transfer_t structure. + * @param handle A pointer to the dspi_master_edma_handle_t structure which stores the transfer state. + * @param transfer A pointer to the dspi_transfer_t structure. * @return status of status_t. */ status_t DSPI_MasterTransferEDMA(SPI_Type *base, dspi_master_edma_handle_t *handle, dspi_transfer_t *transfer); /*! - * @brief DSPI master aborts a transfer which using eDMA. + * @brief DSPI master aborts a transfer which is using eDMA. * - * This function aborts a transfer which using eDMA. + * This function aborts a transfer which is using eDMA. * * @param base DSPI peripheral base address. - * @param handle pointer to dspi_master_edma_handle_t structure which stores the transfer state. + * @param handle A pointer to the dspi_master_edma_handle_t structure which stores the transfer state. */ void DSPI_MasterTransferAbortEDMA(SPI_Type *base, dspi_master_edma_handle_t *handle); /*! * @brief Gets the master eDMA transfer count. * - * This function get the master eDMA transfer count. + * This function gets the master eDMA transfer count. * * @param base DSPI peripheral base address. - * @param handle pointer to dspi_master_edma_handle_t structure which stores the transfer state. - * @param count Number of bytes transferred so far by the non-blocking transaction. + * @param handle A pointer to the dspi_master_edma_handle_t structure which stores the transfer state. + * @param count A number of bytes transferred by the non-blocking transaction. * @return status of status_t. */ status_t DSPI_MasterTransferGetCountEDMA(SPI_Type *base, dspi_master_edma_handle_t *handle, size_t *count); @@ -216,7 +214,8 @@ status_t DSPI_MasterTransferGetCountEDMA(SPI_Type *base, dspi_master_edma_handle * This function initializes the DSPI eDMA handle which can be used for other DSPI transactional APIs. Usually, for a * specified DSPI instance, call this API once to get the initialized handle. * - * Note that DSPI eDMA has separated (RN and TX in 2 sources) or shared (RX and TX are the same source) DMA request source. + * Note that DSPI eDMA has separated (RN and TX in 2 sources) or shared (RX and TX are the same source) DMA request + * source. * (1)For the separated DMA request source, enable and set the RX DMAMUX source for edmaRxRegToRxDataHandle and * TX DMAMUX source for edmaTxDataToTxRegHandle. * (2)For the shared DMA request source, enable and set the RX/RX DMAMUX source for the edmaRxRegToRxDataHandle. @@ -224,7 +223,7 @@ status_t DSPI_MasterTransferGetCountEDMA(SPI_Type *base, dspi_master_edma_handle * @param base DSPI peripheral base address. * @param handle DSPI handle pointer to dspi_slave_edma_handle_t. * @param callback DSPI callback. - * @param userData callback function parameter. + * @param userData A callback function parameter. * @param edmaRxRegToRxDataHandle edmaRxRegToRxDataHandle pointer to edma_handle_t. * @param edmaTxDataToTxRegHandle edmaTxDataToTxRegHandle pointer to edma_handle_t. */ @@ -238,25 +237,25 @@ void DSPI_SlaveTransferCreateHandleEDMA(SPI_Type *base, /*! * @brief DSPI slave transfer data using eDMA. * - * This function transfer data using eDMA. This is non-blocking function, which returns right away. When all data - * have been transfer, the callback function is called. - * Note that slave EDMA transfer cannot support the situation that transfer_size is 1 when the bitsPerFrame is greater - * than 8 . + * This function transfers data using eDMA. This is a non-blocking function, which returns right away. When all data + * is transferred, the callback function is called. + * Note that the slave eDMA transfer doesn't support transfer_size is 1 when the bitsPerFrame is greater + * than eight. * @param base DSPI peripheral base address. - * @param handle pointer to dspi_slave_edma_handle_t structure which stores the transfer state. - * @param transfer pointer to dspi_transfer_t structure. + * @param handle A pointer to the dspi_slave_edma_handle_t structure which stores the transfer state. + * @param transfer A pointer to the dspi_transfer_t structure. * @return status of status_t. */ status_t DSPI_SlaveTransferEDMA(SPI_Type *base, dspi_slave_edma_handle_t *handle, dspi_transfer_t *transfer); /*! - * @brief DSPI slave aborts a transfer which using eDMA. + * @brief DSPI slave aborts a transfer which is using eDMA. * - * This function aborts a transfer which using eDMA. + * This function aborts a transfer which is using eDMA. * * @param base DSPI peripheral base address. - * @param handle pointer to dspi_slave_edma_handle_t structure which stores the transfer state. + * @param handle A pointer to the dspi_slave_edma_handle_t structure which stores the transfer state. */ void DSPI_SlaveTransferAbortEDMA(SPI_Type *base, dspi_slave_edma_handle_t *handle); @@ -266,8 +265,8 @@ void DSPI_SlaveTransferAbortEDMA(SPI_Type *base, dspi_slave_edma_handle_t *handl * This function gets the slave eDMA transfer count. * * @param base DSPI peripheral base address. - * @param handle pointer to dspi_slave_edma_handle_t structure which stores the transfer state. - * @param count Number of bytes transferred so far by the non-blocking transaction. + * @param handle A pointer to the dspi_slave_edma_handle_t structure which stores the transfer state. + * @param count A number of bytes transferred so far by the non-blocking transaction. * @return status of status_t. */ status_t DSPI_SlaveTransferGetCountEDMA(SPI_Type *base, dspi_slave_edma_handle_t *handle, size_t *count); |