ON Semiconductor / mbed-os

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   mbed-TFT-example-NCS36510 mbed-Accelerometer-example-NCS36510 mbed-Accelerometer-example-NCS36510

targets/TARGET_Freescale/TARGET_MCUXpresso_MCUS/TARGET_K66F/drivers/fsl_lpuart_edma.h@1:f30bdcd2b33b, 2017-02-27 (annotated)

Committer:
jacobjohnson
Date:
Mon Feb 27 17:45:05 2017 +0000
Revision:
1:f30bdcd2b33b
Parent:
0:098463de4c5d 
changed the inputscale from 1 to 7 in analogin_api.c.  This will need to be changed later, and accessed from the main level, but for now this allows the  adc to read a value from 0 to 3.7V, instead of just up to 1V.;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
group-onsemi 0:098463de4c5d 1 /*
group-onsemi 0:098463de4c5d 2 * Copyright (c) 2015, Freescale Semiconductor, Inc.
group-onsemi 0:098463de4c5d 3 * All rights reserved.
group-onsemi 0:098463de4c5d 4 *
group-onsemi 0:098463de4c5d 5 * Redistribution and use in source and binary forms, with or without modification,
group-onsemi 0:098463de4c5d 6 * are permitted provided that the following conditions are met:
group-onsemi 0:098463de4c5d 7 *
group-onsemi 0:098463de4c5d 8 * o Redistributions of source code must retain the above copyright notice, this list
group-onsemi 0:098463de4c5d 9 * of conditions and the following disclaimer.
group-onsemi 0:098463de4c5d 10 *
group-onsemi 0:098463de4c5d 11 * o Redistributions in binary form must reproduce the above copyright notice, this
group-onsemi 0:098463de4c5d 12 * list of conditions and the following disclaimer in the documentation and/or
group-onsemi 0:098463de4c5d 13 * other materials provided with the distribution.
group-onsemi 0:098463de4c5d 14 *
group-onsemi 0:098463de4c5d 15 * o Neither the name of Freescale Semiconductor, Inc. nor the names of its
group-onsemi 0:098463de4c5d 16 * contributors may be used to endorse or promote products derived from this
group-onsemi 0:098463de4c5d 17 * software without specific prior written permission.
group-onsemi 0:098463de4c5d 18 *
group-onsemi 0:098463de4c5d 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
group-onsemi 0:098463de4c5d 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
group-onsemi 0:098463de4c5d 21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
group-onsemi 0:098463de4c5d 22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
group-onsemi 0:098463de4c5d 23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
group-onsemi 0:098463de4c5d 24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
group-onsemi 0:098463de4c5d 25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
group-onsemi 0:098463de4c5d 26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
group-onsemi 0:098463de4c5d 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
group-onsemi 0:098463de4c5d 28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
group-onsemi 0:098463de4c5d 29 */
group-onsemi 0:098463de4c5d 30 #ifndef _FSL_LPUART_EDMA_H_
group-onsemi 0:098463de4c5d 31 #define _FSL_LPUART_EDMA_H_
group-onsemi 0:098463de4c5d 32
group-onsemi 0:098463de4c5d 33 #include "fsl_lpuart.h"
group-onsemi 0:098463de4c5d 34 #include "fsl_dmamux.h"
group-onsemi 0:098463de4c5d 35 #include "fsl_edma.h"
group-onsemi 0:098463de4c5d 36
group-onsemi 0:098463de4c5d 37 /*!
group-onsemi 0:098463de4c5d 38 * @addtogroup lpuart_edma_driver
group-onsemi 0:098463de4c5d 39 * @{
group-onsemi 0:098463de4c5d 40 */
group-onsemi 0:098463de4c5d 41
group-onsemi 0:098463de4c5d 42 /*! @file*/
group-onsemi 0:098463de4c5d 43
group-onsemi 0:098463de4c5d 44 /*******************************************************************************
group-onsemi 0:098463de4c5d 45 * Definitions
group-onsemi 0:098463de4c5d 46 ******************************************************************************/
group-onsemi 0:098463de4c5d 47
group-onsemi 0:098463de4c5d 48 /* Forward declaration of the handle typedef. */
group-onsemi 0:098463de4c5d 49 typedef struct _lpuart_edma_handle lpuart_edma_handle_t;
group-onsemi 0:098463de4c5d 50
group-onsemi 0:098463de4c5d 51 /*! @brief LPUART transfer callback function. */
group-onsemi 0:098463de4c5d 52 typedef void (*lpuart_edma_transfer_callback_t)(LPUART_Type *base,
group-onsemi 0:098463de4c5d 53 lpuart_edma_handle_t *handle,
group-onsemi 0:098463de4c5d 54 status_t status,
group-onsemi 0:098463de4c5d 55 void *userData);
group-onsemi 0:098463de4c5d 56
group-onsemi 0:098463de4c5d 57 /*!
group-onsemi 0:098463de4c5d 58 * @brief LPUART eDMA handle
group-onsemi 0:098463de4c5d 59 */
group-onsemi 0:098463de4c5d 60 struct _lpuart_edma_handle
group-onsemi 0:098463de4c5d 61 {
group-onsemi 0:098463de4c5d 62 lpuart_edma_transfer_callback_t callback; /*!< Callback function. */
group-onsemi 0:098463de4c5d 63 void *userData; /*!< LPUART callback function parameter.*/
group-onsemi 0:098463de4c5d 64 size_t rxDataSizeAll; /*!< Size of the data to receive. */
group-onsemi 0:098463de4c5d 65 size_t txDataSizeAll; /*!< Size of the data to send out. */
group-onsemi 0:098463de4c5d 66
group-onsemi 0:098463de4c5d 67 edma_handle_t *txEdmaHandle; /*!< The eDMA TX channel used. */
group-onsemi 0:098463de4c5d 68 edma_handle_t *rxEdmaHandle; /*!< The eDMA RX channel used. */
group-onsemi 0:098463de4c5d 69
group-onsemi 0:098463de4c5d 70 volatile uint8_t txState; /*!< TX transfer state. */
group-onsemi 0:098463de4c5d 71 volatile uint8_t rxState; /*!< RX transfer state */
group-onsemi 0:098463de4c5d 72 };
group-onsemi 0:098463de4c5d 73
group-onsemi 0:098463de4c5d 74 /*******************************************************************************
group-onsemi 0:098463de4c5d 75 * API
group-onsemi 0:098463de4c5d 76 ******************************************************************************/
group-onsemi 0:098463de4c5d 77
group-onsemi 0:098463de4c5d 78 #if defined(__cplusplus)
group-onsemi 0:098463de4c5d 79 extern "C" {
group-onsemi 0:098463de4c5d 80 #endif
group-onsemi 0:098463de4c5d 81
group-onsemi 0:098463de4c5d 82 /*!
group-onsemi 0:098463de4c5d 83 * @name eDMA transactional
group-onsemi 0:098463de4c5d 84 * @{
group-onsemi 0:098463de4c5d 85 */
group-onsemi 0:098463de4c5d 86
group-onsemi 0:098463de4c5d 87 /*!
group-onsemi 0:098463de4c5d 88 * @brief Initializes the LPUART handle which is used in transactional functions.
group-onsemi 0:098463de4c5d 89 * @param base LPUART peripheral base address.
group-onsemi 0:098463de4c5d 90 * @param handle Pointer to lpuart_edma_handle_t structure.
group-onsemi 0:098463de4c5d 91 * @param callback Callback function.
group-onsemi 0:098463de4c5d 92 * @param userData User data.
group-onsemi 0:098463de4c5d 93 * @param txEdmaHandle User requested DMA handle for TX DMA transfer.
group-onsemi 0:098463de4c5d 94 * @param rxEdmaHandle User requested DMA handle for RX DMA transfer.
group-onsemi 0:098463de4c5d 95 */
group-onsemi 0:098463de4c5d 96 void LPUART_TransferCreateHandleEDMA(LPUART_Type *base,
group-onsemi 0:098463de4c5d 97 lpuart_edma_handle_t *handle,
group-onsemi 0:098463de4c5d 98 lpuart_edma_transfer_callback_t callback,
group-onsemi 0:098463de4c5d 99 void *userData,
group-onsemi 0:098463de4c5d 100 edma_handle_t *txEdmaHandle,
group-onsemi 0:098463de4c5d 101 edma_handle_t *rxEdmaHandle);
group-onsemi 0:098463de4c5d 102
group-onsemi 0:098463de4c5d 103 /*!
group-onsemi 0:098463de4c5d 104 * @brief Sends data using eDMA.
group-onsemi 0:098463de4c5d 105 *
group-onsemi 0:098463de4c5d 106 * This function sends data using eDMA. This is a non-blocking function, which returns
group-onsemi 0:098463de4c5d 107 * right away. When all data is sent, the send callback function is called.
group-onsemi 0:098463de4c5d 108 *
group-onsemi 0:098463de4c5d 109 * @param base LPUART peripheral base address.
group-onsemi 0:098463de4c5d 110 * @param handle LPUART handle pointer.
group-onsemi 0:098463de4c5d 111 * @param xfer LPUART eDMA transfer structure. See #lpuart_transfer_t.
group-onsemi 0:098463de4c5d 112 * @retval kStatus_Success if succeed, others failed.
group-onsemi 0:098463de4c5d 113 * @retval kStatus_LPUART_TxBusy Previous transfer on going.
group-onsemi 0:098463de4c5d 114 * @retval kStatus_InvalidArgument Invalid argument.
group-onsemi 0:098463de4c5d 115 */
group-onsemi 0:098463de4c5d 116 status_t LPUART_SendEDMA(LPUART_Type *base, lpuart_edma_handle_t *handle, lpuart_transfer_t *xfer);
group-onsemi 0:098463de4c5d 117
group-onsemi 0:098463de4c5d 118 /*!
group-onsemi 0:098463de4c5d 119 * @brief Receives data using eDMA.
group-onsemi 0:098463de4c5d 120 *
group-onsemi 0:098463de4c5d 121 * This function receives data using eDMA. This is non-blocking function, which returns
group-onsemi 0:098463de4c5d 122 * right away. When all data is received, the receive callback function is called.
group-onsemi 0:098463de4c5d 123 *
group-onsemi 0:098463de4c5d 124 * @param base LPUART peripheral base address.
group-onsemi 0:098463de4c5d 125 * @param handle Pointer to lpuart_edma_handle_t structure.
group-onsemi 0:098463de4c5d 126 * @param xfer LPUART eDMA transfer structure, refer to #lpuart_transfer_t.
group-onsemi 0:098463de4c5d 127 * @retval kStatus_Success if succeed, others fail.
group-onsemi 0:098463de4c5d 128 * @retval kStatus_LPUART_RxBusy Previous transfer ongoing.
group-onsemi 0:098463de4c5d 129 * @retval kStatus_InvalidArgument Invalid argument.
group-onsemi 0:098463de4c5d 130 */
group-onsemi 0:098463de4c5d 131 status_t LPUART_ReceiveEDMA(LPUART_Type *base, lpuart_edma_handle_t *handle, lpuart_transfer_t *xfer);
group-onsemi 0:098463de4c5d 132
group-onsemi 0:098463de4c5d 133 /*!
group-onsemi 0:098463de4c5d 134 * @brief Aborts the sent data using eDMA.
group-onsemi 0:098463de4c5d 135 *
group-onsemi 0:098463de4c5d 136 * This function aborts the sent data using eDMA.
group-onsemi 0:098463de4c5d 137 *
group-onsemi 0:098463de4c5d 138 * @param base LPUART peripheral base address.
group-onsemi 0:098463de4c5d 139 * @param handle Pointer to lpuart_edma_handle_t structure.
group-onsemi 0:098463de4c5d 140 */
group-onsemi 0:098463de4c5d 141 void LPUART_TransferAbortSendEDMA(LPUART_Type *base, lpuart_edma_handle_t *handle);
group-onsemi 0:098463de4c5d 142
group-onsemi 0:098463de4c5d 143 /*!
group-onsemi 0:098463de4c5d 144 * @brief Aborts the received data using eDMA.
group-onsemi 0:098463de4c5d 145 *
group-onsemi 0:098463de4c5d 146 * This function aborts the received data using eDMA.
group-onsemi 0:098463de4c5d 147 *
group-onsemi 0:098463de4c5d 148 * @param base LPUART peripheral base address.
group-onsemi 0:098463de4c5d 149 * @param handle Pointer to lpuart_edma_handle_t structure.
group-onsemi 0:098463de4c5d 150 */
group-onsemi 0:098463de4c5d 151 void LPUART_TransferAbortReceiveEDMA(LPUART_Type *base, lpuart_edma_handle_t *handle);
group-onsemi 0:098463de4c5d 152
group-onsemi 0:098463de4c5d 153 /*!
group-onsemi 0:098463de4c5d 154 * @brief Get the number of bytes that have been written to LPUART TX register.
group-onsemi 0:098463de4c5d 155 *
group-onsemi 0:098463de4c5d 156 * This function gets the number of bytes that have been written to LPUART TX
group-onsemi 0:098463de4c5d 157 * register by DMA.
group-onsemi 0:098463de4c5d 158 *
group-onsemi 0:098463de4c5d 159 * @param base LPUART peripheral base address.
group-onsemi 0:098463de4c5d 160 * @param handle LPUART handle pointer.
group-onsemi 0:098463de4c5d 161 * @param count Send bytes count.
group-onsemi 0:098463de4c5d 162 * @retval kStatus_NoTransferInProgress No send in progress.
group-onsemi 0:098463de4c5d 163 * @retval kStatus_InvalidArgument Parameter is invalid.
group-onsemi 0:098463de4c5d 164 * @retval kStatus_Success Get successfully through the parameter \p count;
group-onsemi 0:098463de4c5d 165 */
group-onsemi 0:098463de4c5d 166 status_t LPUART_TransferGetSendCountEDMA(LPUART_Type *base, lpuart_edma_handle_t *handle, uint32_t *count);
group-onsemi 0:098463de4c5d 167
group-onsemi 0:098463de4c5d 168 /*!
group-onsemi 0:098463de4c5d 169 * @brief Get the number of bytes that have been received.
group-onsemi 0:098463de4c5d 170 *
group-onsemi 0:098463de4c5d 171 * This function gets the number of bytes that have been received.
group-onsemi 0:098463de4c5d 172 *
group-onsemi 0:098463de4c5d 173 * @param base LPUART peripheral base address.
group-onsemi 0:098463de4c5d 174 * @param handle LPUART handle pointer.
group-onsemi 0:098463de4c5d 175 * @param count Receive bytes count.
group-onsemi 0:098463de4c5d 176 * @retval kStatus_NoTransferInProgress No receive in progress.
group-onsemi 0:098463de4c5d 177 * @retval kStatus_InvalidArgument Parameter is invalid.
group-onsemi 0:098463de4c5d 178 * @retval kStatus_Success Get successfully through the parameter \p count;
group-onsemi 0:098463de4c5d 179 */
group-onsemi 0:098463de4c5d 180 status_t LPUART_TransferGetReceiveCountEDMA(LPUART_Type *base, lpuart_edma_handle_t *handle, uint32_t *count);
group-onsemi 0:098463de4c5d 181
group-onsemi 0:098463de4c5d 182 /*@}*/
group-onsemi 0:098463de4c5d 183
group-onsemi 0:098463de4c5d 184 #if defined(__cplusplus)
group-onsemi 0:098463de4c5d 185 }
group-onsemi 0:098463de4c5d 186 #endif
group-onsemi 0:098463de4c5d 187
group-onsemi 0:098463de4c5d 188 /*! @}*/
group-onsemi 0:098463de4c5d 189
group-onsemi 0:098463de4c5d 190 #endif /* _FSL_LPUART_EDMA_H_ */