mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_FF_LPC546XX/TOOLCHAIN_ARM_STD/fsl_dmic_dma.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 171:3a7713b1edbc 1 /*
AnnaBridge 171:3a7713b1edbc 2 * The Clear BSD License
AnnaBridge 171:3a7713b1edbc 3 * Copyright (c) 2016, Freescale Semiconductor, Inc.
AnnaBridge 171:3a7713b1edbc 4 * Copyright 2016-2017 NXP
AnnaBridge 171:3a7713b1edbc 5 * All rights reserved.
AnnaBridge 171:3a7713b1edbc 6 *
AnnaBridge 171:3a7713b1edbc 7 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 171:3a7713b1edbc 8 * are permitted (subject to the limitations in the disclaimer below) provided
AnnaBridge 171:3a7713b1edbc 9 * that the following conditions are met:
AnnaBridge 171:3a7713b1edbc 10 *
AnnaBridge 171:3a7713b1edbc 11 * o Redistributions of source code must retain the above copyright notice, this list
AnnaBridge 171:3a7713b1edbc 12 * of conditions and the following disclaimer.
AnnaBridge 171:3a7713b1edbc 13 *
AnnaBridge 171:3a7713b1edbc 14 * o Redistributions in binary form must reproduce the above copyright notice, this
AnnaBridge 171:3a7713b1edbc 15 * list of conditions and the following disclaimer in the documentation and/or
AnnaBridge 171:3a7713b1edbc 16 * other materials provided with the distribution.
AnnaBridge 171:3a7713b1edbc 17 *
AnnaBridge 171:3a7713b1edbc 18 * o Neither the name of the copyright holder nor the names of its
AnnaBridge 171:3a7713b1edbc 19 * contributors may be used to endorse or promote products derived from this
AnnaBridge 171:3a7713b1edbc 20 * software without specific prior written permission.
AnnaBridge 171:3a7713b1edbc 21 *
AnnaBridge 171:3a7713b1edbc 22 * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS LICENSE.
AnnaBridge 171:3a7713b1edbc 23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
AnnaBridge 171:3a7713b1edbc 24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
AnnaBridge 171:3a7713b1edbc 25 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 171:3a7713b1edbc 26 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
AnnaBridge 171:3a7713b1edbc 27 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
AnnaBridge 171:3a7713b1edbc 28 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
AnnaBridge 171:3a7713b1edbc 29 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
AnnaBridge 171:3a7713b1edbc 30 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
AnnaBridge 171:3a7713b1edbc 31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
AnnaBridge 171:3a7713b1edbc 32 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 171:3a7713b1edbc 33 */
AnnaBridge 171:3a7713b1edbc 34 #ifndef _FSL_DMIC_DMA_H_
AnnaBridge 171:3a7713b1edbc 35 #define _FSL_DMIC_DMA_H_
AnnaBridge 171:3a7713b1edbc 36
AnnaBridge 171:3a7713b1edbc 37 #include "fsl_common.h"
AnnaBridge 171:3a7713b1edbc 38 #include "fsl_dma.h"
AnnaBridge 171:3a7713b1edbc 39
AnnaBridge 171:3a7713b1edbc 40 /*!
AnnaBridge 171:3a7713b1edbc 41 * @addtogroup dmic_dma_driver
AnnaBridge 171:3a7713b1edbc 42 * @{
AnnaBridge 171:3a7713b1edbc 43 */
AnnaBridge 171:3a7713b1edbc 44
AnnaBridge 171:3a7713b1edbc 45 /*! @file */
AnnaBridge 171:3a7713b1edbc 46
AnnaBridge 171:3a7713b1edbc 47 /*******************************************************************************
AnnaBridge 171:3a7713b1edbc 48 * Definitions
AnnaBridge 171:3a7713b1edbc 49 ******************************************************************************/
AnnaBridge 171:3a7713b1edbc 50
AnnaBridge 171:3a7713b1edbc 51 /*! @brief DMIC transfer structure. */
AnnaBridge 171:3a7713b1edbc 52 typedef struct _dmic_transfer
AnnaBridge 171:3a7713b1edbc 53 {
AnnaBridge 171:3a7713b1edbc 54 uint16_t *data; /*!< The buffer of data to be transfer.*/
AnnaBridge 171:3a7713b1edbc 55 size_t dataSize; /*!< The byte count to be transfer. */
AnnaBridge 171:3a7713b1edbc 56 } dmic_transfer_t;
AnnaBridge 171:3a7713b1edbc 57
AnnaBridge 171:3a7713b1edbc 58 /*! @brief DMIC transfer structure. */
AnnaBridge 171:3a7713b1edbc 59 typedef enum dmic_bitwidth
AnnaBridge 171:3a7713b1edbc 60 {
AnnaBridge 171:3a7713b1edbc 61 kDMICBitWidth16Bits = 2U, /*!< 16 bits mode.*/
AnnaBridge 171:3a7713b1edbc 62 kDMICBitWidth32Bits = 4U, /*!< 32 bits mode. */
AnnaBridge 171:3a7713b1edbc 63 } dmic_bitwidth_t;
AnnaBridge 171:3a7713b1edbc 64
AnnaBridge 171:3a7713b1edbc 65 /* Forward declaration of the handle typedef. */
AnnaBridge 171:3a7713b1edbc 66 typedef struct _dmic_dma_handle dmic_dma_handle_t;
AnnaBridge 171:3a7713b1edbc 67
AnnaBridge 171:3a7713b1edbc 68 /*! @brief DMIC transfer callback function. */
AnnaBridge 171:3a7713b1edbc 69 typedef void (*dmic_dma_transfer_callback_t)(DMIC_Type *base,
AnnaBridge 171:3a7713b1edbc 70 dmic_dma_handle_t *handle,
AnnaBridge 171:3a7713b1edbc 71 status_t status,
AnnaBridge 171:3a7713b1edbc 72 void *userData);
AnnaBridge 171:3a7713b1edbc 73
AnnaBridge 171:3a7713b1edbc 74 /*!
AnnaBridge 171:3a7713b1edbc 75 * @brief DMIC DMA handle
AnnaBridge 171:3a7713b1edbc 76 */
AnnaBridge 171:3a7713b1edbc 77 struct _dmic_dma_handle
AnnaBridge 171:3a7713b1edbc 78 {
AnnaBridge 171:3a7713b1edbc 79 DMIC_Type *base; /*!< DMIC peripheral base address. */
AnnaBridge 171:3a7713b1edbc 80 dma_handle_t *rxDmaHandle; /*!< The DMA RX channel used. */
AnnaBridge 171:3a7713b1edbc 81 dmic_dma_transfer_callback_t callback; /*!< Callback function. */
AnnaBridge 171:3a7713b1edbc 82 uint8_t dataWidth; /*!< Data bit width */
AnnaBridge 171:3a7713b1edbc 83 void *userData; /*!< DMIC callback function parameter.*/
AnnaBridge 171:3a7713b1edbc 84 size_t transferSize; /*!< Size of the data to receive. */
AnnaBridge 171:3a7713b1edbc 85 volatile uint8_t state; /*!< Internal state of DMIC DMA transfer */
AnnaBridge 171:3a7713b1edbc 86 };
AnnaBridge 171:3a7713b1edbc 87
AnnaBridge 171:3a7713b1edbc 88 /*******************************************************************************
AnnaBridge 171:3a7713b1edbc 89 * API
AnnaBridge 171:3a7713b1edbc 90 ******************************************************************************/
AnnaBridge 171:3a7713b1edbc 91
AnnaBridge 171:3a7713b1edbc 92 #ifdef __cplusplus
AnnaBridge 171:3a7713b1edbc 93 extern "C" {
AnnaBridge 171:3a7713b1edbc 94 #endif /* _cplusplus */
AnnaBridge 171:3a7713b1edbc 95
AnnaBridge 171:3a7713b1edbc 96 /*!
AnnaBridge 171:3a7713b1edbc 97 * @name DMA transactional
AnnaBridge 171:3a7713b1edbc 98 * @{
AnnaBridge 171:3a7713b1edbc 99 */
AnnaBridge 171:3a7713b1edbc 100
AnnaBridge 171:3a7713b1edbc 101 /*!
AnnaBridge 171:3a7713b1edbc 102 * @brief Initializes the DMIC handle which is used in transactional functions.
AnnaBridge 171:3a7713b1edbc 103 * @param base DMIC peripheral base address.
AnnaBridge 171:3a7713b1edbc 104 * @param handle Pointer to dmic_dma_handle_t structure.
AnnaBridge 171:3a7713b1edbc 105 * @param callback Callback function.
AnnaBridge 171:3a7713b1edbc 106 * @param userData User data.
AnnaBridge 171:3a7713b1edbc 107 * @param rxDmaHandle User-requested DMA handle for RX DMA transfer.
AnnaBridge 171:3a7713b1edbc 108 */
AnnaBridge 171:3a7713b1edbc 109 status_t DMIC_TransferCreateHandleDMA(DMIC_Type *base,
AnnaBridge 171:3a7713b1edbc 110 dmic_dma_handle_t *handle,
AnnaBridge 171:3a7713b1edbc 111 dmic_dma_transfer_callback_t callback,
AnnaBridge 171:3a7713b1edbc 112 void *userData,
AnnaBridge 171:3a7713b1edbc 113 dma_handle_t *rxDmaHandle);
AnnaBridge 171:3a7713b1edbc 114
AnnaBridge 171:3a7713b1edbc 115 /*!
AnnaBridge 171:3a7713b1edbc 116 * @brief Configure the transfer data width.
AnnaBridge 171:3a7713b1edbc 117 *
AnnaBridge 171:3a7713b1edbc 118 * This function is optional to users, the default data width is set to 16 bits if not call this fuction.
AnnaBridge 171:3a7713b1edbc 119 * DMIC only support 16 bits and 32 bits setting. As DMA cannot support 24 bits directly, please set to 32 bits
AnnaBridge 171:3a7713b1edbc 120 * while need a 24 bits data. In 32 bit mode, the MSB 8 bits always 0, as the register can only have 24 bits valid bits.
AnnaBridge 171:3a7713b1edbc 121 *
AnnaBridge 171:3a7713b1edbc 122 * @param base DMIC peripheral base address.
AnnaBridge 171:3a7713b1edbc 123 * @param handle Pointer to usart_dma_handle_t structure.
AnnaBridge 171:3a7713b1edbc 124 * @param width DMIC width. See #dmic_bitwidth_t.
AnnaBridge 171:3a7713b1edbc 125 * @retval kStatus_Success
AnnaBridge 171:3a7713b1edbc 126 */
AnnaBridge 171:3a7713b1edbc 127 static inline void DMIC_TransferSetBitWidthDMA(DMIC_Type *base, dmic_dma_handle_t *handle, dmic_bitwidth_t width)
AnnaBridge 171:3a7713b1edbc 128 {
AnnaBridge 171:3a7713b1edbc 129 handle->dataWidth = width;
AnnaBridge 171:3a7713b1edbc 130 }
AnnaBridge 171:3a7713b1edbc 131
AnnaBridge 171:3a7713b1edbc 132 /*!
AnnaBridge 171:3a7713b1edbc 133 * @brief Receives data using DMA.
AnnaBridge 171:3a7713b1edbc 134 *
AnnaBridge 171:3a7713b1edbc 135 * This function receives data using DMA. This is a non-blocking function, which returns
AnnaBridge 171:3a7713b1edbc 136 * right away. When all data is received, the receive callback function is called.
AnnaBridge 171:3a7713b1edbc 137 *
AnnaBridge 171:3a7713b1edbc 138 * @param base DMIC peripheral base address.
AnnaBridge 171:3a7713b1edbc 139 * @param handle Pointer to usart_dma_handle_t structure.
AnnaBridge 171:3a7713b1edbc 140 * @param xfer DMIC DMA transfer structure. See #dmic_transfer_t.
AnnaBridge 171:3a7713b1edbc 141 * @param dmic_channel DMIC channel
AnnaBridge 171:3a7713b1edbc 142 * @retval kStatus_Success
AnnaBridge 171:3a7713b1edbc 143 */
AnnaBridge 171:3a7713b1edbc 144 status_t DMIC_TransferReceiveDMA(DMIC_Type *base,
AnnaBridge 171:3a7713b1edbc 145 dmic_dma_handle_t *handle,
AnnaBridge 171:3a7713b1edbc 146 dmic_transfer_t *xfer,
AnnaBridge 171:3a7713b1edbc 147 uint32_t dmic_channel);
AnnaBridge 171:3a7713b1edbc 148
AnnaBridge 171:3a7713b1edbc 149 /*!
AnnaBridge 171:3a7713b1edbc 150 * @brief Aborts the received data using DMA.
AnnaBridge 171:3a7713b1edbc 151 *
AnnaBridge 171:3a7713b1edbc 152 * This function aborts the received data using DMA.
AnnaBridge 171:3a7713b1edbc 153 *
AnnaBridge 171:3a7713b1edbc 154 * @param base DMIC peripheral base address
AnnaBridge 171:3a7713b1edbc 155 * @param handle Pointer to dmic_dma_handle_t structure
AnnaBridge 171:3a7713b1edbc 156 */
AnnaBridge 171:3a7713b1edbc 157 void DMIC_TransferAbortReceiveDMA(DMIC_Type *base, dmic_dma_handle_t *handle);
AnnaBridge 171:3a7713b1edbc 158
AnnaBridge 171:3a7713b1edbc 159 /*!
AnnaBridge 171:3a7713b1edbc 160 * @brief Get the number of bytes that have been received.
AnnaBridge 171:3a7713b1edbc 161 *
AnnaBridge 171:3a7713b1edbc 162 * This function gets the number of bytes that have been received.
AnnaBridge 171:3a7713b1edbc 163 *
AnnaBridge 171:3a7713b1edbc 164 * @param base DMIC peripheral base address.
AnnaBridge 171:3a7713b1edbc 165 * @param handle DMIC handle pointer.
AnnaBridge 171:3a7713b1edbc 166 * @param count Receive bytes count.
AnnaBridge 171:3a7713b1edbc 167 * @retval kStatus_NoTransferInProgress No receive in progress.
AnnaBridge 171:3a7713b1edbc 168 * @retval kStatus_InvalidArgument Parameter is invalid.
AnnaBridge 171:3a7713b1edbc 169 * @retval kStatus_Success Get successfully through the parameter count;
AnnaBridge 171:3a7713b1edbc 170 */
AnnaBridge 171:3a7713b1edbc 171 status_t DMIC_TransferGetReceiveCountDMA(DMIC_Type *base, dmic_dma_handle_t *handle, uint32_t *count);
AnnaBridge 171:3a7713b1edbc 172
AnnaBridge 171:3a7713b1edbc 173 /* @} */
AnnaBridge 171:3a7713b1edbc 174
AnnaBridge 171:3a7713b1edbc 175 #if defined(__cplusplus)
AnnaBridge 171:3a7713b1edbc 176 }
AnnaBridge 171:3a7713b1edbc 177 #endif
AnnaBridge 171:3a7713b1edbc 178
AnnaBridge 171:3a7713b1edbc 179 /*! @}*/
AnnaBridge 171:3a7713b1edbc 180
AnnaBridge 171:3a7713b1edbc 181 #endif /* _FSL_DMIC_DMA_H_ */