Rizky Ardi Maulana / 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.

targets/TARGET_Freescale/TARGET_KSDK2_MCUS/TARGET_K22F/drivers/fsl_lpuart_edma.c@0:f269e3021894, 2016-10-23 (annotated)

Committer:
elessair
Date:
Sun Oct 23 15:10:02 2016 +0000
Revision:
0:f269e3021894
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
elessair 0:f269e3021894 1 /*
elessair 0:f269e3021894 2 * Copyright (c) 2015, Freescale Semiconductor, Inc.
elessair 0:f269e3021894 3 * All rights reserved.
elessair 0:f269e3021894 4 *
elessair 0:f269e3021894 5 * Redistribution and use in source and binary forms, with or without modification,
elessair 0:f269e3021894 6 * are permitted provided that the following conditions are met:
elessair 0:f269e3021894 7 *
elessair 0:f269e3021894 8 * o Redistributions of source code must retain the above copyright notice, this list
elessair 0:f269e3021894 9 * of conditions and the following disclaimer.
elessair 0:f269e3021894 10 *
elessair 0:f269e3021894 11 * o Redistributions in binary form must reproduce the above copyright notice, this
elessair 0:f269e3021894 12 * list of conditions and the following disclaimer in the documentation and/or
elessair 0:f269e3021894 13 * other materials provided with the distribution.
elessair 0:f269e3021894 14 *
elessair 0:f269e3021894 15 * o Neither the name of Freescale Semiconductor, Inc. nor the names of its
elessair 0:f269e3021894 16 * contributors may be used to endorse or promote products derived from this
elessair 0:f269e3021894 17 * software without specific prior written permission.
elessair 0:f269e3021894 18 *
elessair 0:f269e3021894 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
elessair 0:f269e3021894 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
elessair 0:f269e3021894 21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
elessair 0:f269e3021894 22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
elessair 0:f269e3021894 23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
elessair 0:f269e3021894 24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
elessair 0:f269e3021894 25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
elessair 0:f269e3021894 26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
elessair 0:f269e3021894 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
elessair 0:f269e3021894 28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
elessair 0:f269e3021894 29 */
elessair 0:f269e3021894 30
elessair 0:f269e3021894 31 #include "fsl_lpuart_edma.h"
elessair 0:f269e3021894 32 #include "fsl_dmamux.h"
elessair 0:f269e3021894 33
elessair 0:f269e3021894 34 /*******************************************************************************
elessair 0:f269e3021894 35 * Definitions
elessair 0:f269e3021894 36 ******************************************************************************/
elessair 0:f269e3021894 37
elessair 0:f269e3021894 38 /*<! Structure definition for lpuart_edma_private_handle_t. The structure is private. */
elessair 0:f269e3021894 39 typedef struct _lpuart_edma_private_handle
elessair 0:f269e3021894 40 {
elessair 0:f269e3021894 41 LPUART_Type *base;
elessair 0:f269e3021894 42 lpuart_edma_handle_t *handle;
elessair 0:f269e3021894 43 } lpuart_edma_private_handle_t;
elessair 0:f269e3021894 44
elessair 0:f269e3021894 45 /* LPUART EDMA transfer handle. */
elessair 0:f269e3021894 46 enum _lpuart_edma_tansfer_states
elessair 0:f269e3021894 47 {
elessair 0:f269e3021894 48 kLPUART_TxIdle, /* TX idle. */
elessair 0:f269e3021894 49 kLPUART_TxBusy, /* TX busy. */
elessair 0:f269e3021894 50 kLPUART_RxIdle, /* RX idle. */
elessair 0:f269e3021894 51 kLPUART_RxBusy /* RX busy. */
elessair 0:f269e3021894 52 };
elessair 0:f269e3021894 53
elessair 0:f269e3021894 54 /*******************************************************************************
elessair 0:f269e3021894 55 * Definitions
elessair 0:f269e3021894 56 ******************************************************************************/
elessair 0:f269e3021894 57
elessair 0:f269e3021894 58 /*<! Private handle only used for internally. */
elessair 0:f269e3021894 59 static lpuart_edma_private_handle_t s_edmaPrivateHandle[FSL_FEATURE_SOC_LPUART_COUNT];
elessair 0:f269e3021894 60
elessair 0:f269e3021894 61 /*******************************************************************************
elessair 0:f269e3021894 62 * Prototypes
elessair 0:f269e3021894 63 ******************************************************************************/
elessair 0:f269e3021894 64
elessair 0:f269e3021894 65 /*!
elessair 0:f269e3021894 66 * @brief LPUART EDMA send finished callback function.
elessair 0:f269e3021894 67 *
elessair 0:f269e3021894 68 * This function is called when LPUART EDMA send finished. It disables the LPUART
elessair 0:f269e3021894 69 * TX EDMA request and sends @ref kStatus_LPUART_TxIdle to LPUART callback.
elessair 0:f269e3021894 70 *
elessair 0:f269e3021894 71 * @param handle The EDMA handle.
elessair 0:f269e3021894 72 * @param param Callback function parameter.
elessair 0:f269e3021894 73 */
elessair 0:f269e3021894 74 static void LPUART_SendEDMACallback(edma_handle_t *handle, void *param, bool transferDone, uint32_t tcds);
elessair 0:f269e3021894 75
elessair 0:f269e3021894 76 /*!
elessair 0:f269e3021894 77 * @brief LPUART EDMA receive finished callback function.
elessair 0:f269e3021894 78 *
elessair 0:f269e3021894 79 * This function is called when LPUART EDMA receive finished. It disables the LPUART
elessair 0:f269e3021894 80 * RX EDMA request and sends @ref kStatus_LPUART_RxIdle to LPUART callback.
elessair 0:f269e3021894 81 *
elessair 0:f269e3021894 82 * @param handle The EDMA handle.
elessair 0:f269e3021894 83 * @param param Callback function parameter.
elessair 0:f269e3021894 84 */
elessair 0:f269e3021894 85 static void LPUART_ReceiveEDMACallback(edma_handle_t *handle, void *param, bool transferDone, uint32_t tcds);
elessair 0:f269e3021894 86
elessair 0:f269e3021894 87 /*!
elessair 0:f269e3021894 88 * @brief Get the LPUART instance from peripheral base address.
elessair 0:f269e3021894 89 *
elessair 0:f269e3021894 90 * @param base LPUART peripheral base address.
elessair 0:f269e3021894 91 * @return LPUART instance.
elessair 0:f269e3021894 92 */
elessair 0:f269e3021894 93 extern uint32_t LPUART_GetInstance(LPUART_Type *base);
elessair 0:f269e3021894 94
elessair 0:f269e3021894 95 /*******************************************************************************
elessair 0:f269e3021894 96 * Code
elessair 0:f269e3021894 97 ******************************************************************************/
elessair 0:f269e3021894 98
elessair 0:f269e3021894 99 static void LPUART_SendEDMACallback(edma_handle_t *handle, void *param, bool transferDone, uint32_t tcds)
elessair 0:f269e3021894 100 {
elessair 0:f269e3021894 101 lpuart_edma_private_handle_t *lpuartPrivateHandle = (lpuart_edma_private_handle_t *)param;
elessair 0:f269e3021894 102
elessair 0:f269e3021894 103 /* Avoid the warning for unused variables. */
elessair 0:f269e3021894 104 handle = handle;
elessair 0:f269e3021894 105 tcds = tcds;
elessair 0:f269e3021894 106
elessair 0:f269e3021894 107 if (transferDone)
elessair 0:f269e3021894 108 {
elessair 0:f269e3021894 109 LPUART_TransferAbortSendEDMA(lpuartPrivateHandle->base, lpuartPrivateHandle->handle);
elessair 0:f269e3021894 110
elessair 0:f269e3021894 111 if (lpuartPrivateHandle->handle->callback)
elessair 0:f269e3021894 112 {
elessair 0:f269e3021894 113 lpuartPrivateHandle->handle->callback(lpuartPrivateHandle->base, lpuartPrivateHandle->handle,
elessair 0:f269e3021894 114 kStatus_LPUART_TxIdle, lpuartPrivateHandle->handle->userData);
elessair 0:f269e3021894 115 }
elessair 0:f269e3021894 116 }
elessair 0:f269e3021894 117 }
elessair 0:f269e3021894 118
elessair 0:f269e3021894 119 static void LPUART_ReceiveEDMACallback(edma_handle_t *handle, void *param, bool transferDone, uint32_t tcds)
elessair 0:f269e3021894 120 {
elessair 0:f269e3021894 121 lpuart_edma_private_handle_t *lpuartPrivateHandle = (lpuart_edma_private_handle_t *)param;
elessair 0:f269e3021894 122
elessair 0:f269e3021894 123 /* Avoid warning for unused parameters. */
elessair 0:f269e3021894 124 handle = handle;
elessair 0:f269e3021894 125 tcds = tcds;
elessair 0:f269e3021894 126
elessair 0:f269e3021894 127 if (transferDone)
elessair 0:f269e3021894 128 {
elessair 0:f269e3021894 129 /* Disable transfer. */
elessair 0:f269e3021894 130 LPUART_TransferAbortReceiveEDMA(lpuartPrivateHandle->base, lpuartPrivateHandle->handle);
elessair 0:f269e3021894 131
elessair 0:f269e3021894 132 if (lpuartPrivateHandle->handle->callback)
elessair 0:f269e3021894 133 {
elessair 0:f269e3021894 134 lpuartPrivateHandle->handle->callback(lpuartPrivateHandle->base, lpuartPrivateHandle->handle,
elessair 0:f269e3021894 135 kStatus_LPUART_RxIdle, lpuartPrivateHandle->handle->userData);
elessair 0:f269e3021894 136 }
elessair 0:f269e3021894 137 }
elessair 0:f269e3021894 138 }
elessair 0:f269e3021894 139
elessair 0:f269e3021894 140 void LPUART_TransferCreateHandleEDMA(LPUART_Type *base,
elessair 0:f269e3021894 141 lpuart_edma_handle_t *handle,
elessair 0:f269e3021894 142 lpuart_edma_transfer_callback_t callback,
elessair 0:f269e3021894 143 void *userData,
elessair 0:f269e3021894 144 edma_handle_t *txEdmaHandle,
elessair 0:f269e3021894 145 edma_handle_t *rxEdmaHandle)
elessair 0:f269e3021894 146 {
elessair 0:f269e3021894 147 assert(handle);
elessair 0:f269e3021894 148
elessair 0:f269e3021894 149 uint32_t instance = LPUART_GetInstance(base);
elessair 0:f269e3021894 150
elessair 0:f269e3021894 151 s_edmaPrivateHandle[instance].base = base;
elessair 0:f269e3021894 152 s_edmaPrivateHandle[instance].handle = handle;
elessair 0:f269e3021894 153
elessair 0:f269e3021894 154 memset(handle, 0, sizeof(*handle));
elessair 0:f269e3021894 155
elessair 0:f269e3021894 156 handle->rxState = kLPUART_RxIdle;
elessair 0:f269e3021894 157 handle->txState = kLPUART_TxIdle;
elessair 0:f269e3021894 158
elessair 0:f269e3021894 159 handle->rxEdmaHandle = rxEdmaHandle;
elessair 0:f269e3021894 160 handle->txEdmaHandle = txEdmaHandle;
elessair 0:f269e3021894 161
elessair 0:f269e3021894 162 handle->callback = callback;
elessair 0:f269e3021894 163 handle->userData = userData;
elessair 0:f269e3021894 164
elessair 0:f269e3021894 165 #if defined(FSL_FEATURE_LPUART_HAS_FIFO) && FSL_FEATURE_LPUART_HAS_FIFO
elessair 0:f269e3021894 166 /* Note:
elessair 0:f269e3021894 167 Take care of the RX FIFO, EDMA request only assert when received bytes
elessair 0:f269e3021894 168 equal or more than RX water mark, there is potential issue if RX water
elessair 0:f269e3021894 169 mark larger than 1.
elessair 0:f269e3021894 170 For example, if RX FIFO water mark is 2, upper layer needs 5 bytes and
elessair 0:f269e3021894 171 5 bytes are received. the last byte will be saved in FIFO but not trigger
elessair 0:f269e3021894 172 EDMA transfer because the water mark is 2.
elessair 0:f269e3021894 173 */
elessair 0:f269e3021894 174 if (rxEdmaHandle)
elessair 0:f269e3021894 175 {
elessair 0:f269e3021894 176 base->WATER &= (~LPUART_WATER_RXWATER_MASK);
elessair 0:f269e3021894 177 }
elessair 0:f269e3021894 178 #endif
elessair 0:f269e3021894 179
elessair 0:f269e3021894 180 /* Configure TX. */
elessair 0:f269e3021894 181 if (txEdmaHandle)
elessair 0:f269e3021894 182 {
elessair 0:f269e3021894 183 EDMA_SetCallback(handle->txEdmaHandle, LPUART_SendEDMACallback, &s_edmaPrivateHandle[instance]);
elessair 0:f269e3021894 184 }
elessair 0:f269e3021894 185
elessair 0:f269e3021894 186 /* Configure RX. */
elessair 0:f269e3021894 187 if (rxEdmaHandle)
elessair 0:f269e3021894 188 {
elessair 0:f269e3021894 189 EDMA_SetCallback(handle->rxEdmaHandle, LPUART_ReceiveEDMACallback, &s_edmaPrivateHandle[instance]);
elessair 0:f269e3021894 190 }
elessair 0:f269e3021894 191 }
elessair 0:f269e3021894 192 status_t LPUART_SendEDMA(LPUART_Type *base, lpuart_edma_handle_t *handle, lpuart_transfer_t *xfer)
elessair 0:f269e3021894 193 {
elessair 0:f269e3021894 194 assert(handle->txEdmaHandle);
elessair 0:f269e3021894 195
elessair 0:f269e3021894 196 edma_transfer_config_t xferConfig;
elessair 0:f269e3021894 197 status_t status;
elessair 0:f269e3021894 198
elessair 0:f269e3021894 199 /* Return error if xfer invalid. */
elessair 0:f269e3021894 200 if ((0U == xfer->dataSize) || (NULL == xfer->data))
elessair 0:f269e3021894 201 {
elessair 0:f269e3021894 202 return kStatus_InvalidArgument;
elessair 0:f269e3021894 203 }
elessair 0:f269e3021894 204
elessair 0:f269e3021894 205 /* If previous TX not finished. */
elessair 0:f269e3021894 206 if (kLPUART_TxBusy == handle->txState)
elessair 0:f269e3021894 207 {
elessair 0:f269e3021894 208 status = kStatus_LPUART_TxBusy;
elessair 0:f269e3021894 209 }
elessair 0:f269e3021894 210 else
elessair 0:f269e3021894 211 {
elessair 0:f269e3021894 212 handle->txState = kLPUART_TxBusy;
elessair 0:f269e3021894 213 handle->txDataSizeAll = xfer->dataSize;
elessair 0:f269e3021894 214
elessair 0:f269e3021894 215 /* Prepare transfer. */
elessair 0:f269e3021894 216 EDMA_PrepareTransfer(&xferConfig, xfer->data, sizeof(uint8_t), (void *)LPUART_GetDataRegisterAddress(base),
elessair 0:f269e3021894 217 sizeof(uint8_t), sizeof(uint8_t), xfer->dataSize, kEDMA_MemoryToPeripheral);
elessair 0:f269e3021894 218
elessair 0:f269e3021894 219 /* Submit transfer. */
elessair 0:f269e3021894 220 EDMA_SubmitTransfer(handle->txEdmaHandle, &xferConfig);
elessair 0:f269e3021894 221 EDMA_StartTransfer(handle->txEdmaHandle);
elessair 0:f269e3021894 222
elessair 0:f269e3021894 223 /* Enable LPUART TX EDMA. */
elessair 0:f269e3021894 224 LPUART_EnableTxDMA(base, true);
elessair 0:f269e3021894 225
elessair 0:f269e3021894 226 status = kStatus_Success;
elessair 0:f269e3021894 227 }
elessair 0:f269e3021894 228
elessair 0:f269e3021894 229 return status;
elessair 0:f269e3021894 230 }
elessair 0:f269e3021894 231
elessair 0:f269e3021894 232 status_t LPUART_ReceiveEDMA(LPUART_Type *base, lpuart_edma_handle_t *handle, lpuart_transfer_t *xfer)
elessair 0:f269e3021894 233 {
elessair 0:f269e3021894 234 assert(handle->rxEdmaHandle);
elessair 0:f269e3021894 235
elessair 0:f269e3021894 236 edma_transfer_config_t xferConfig;
elessair 0:f269e3021894 237 status_t status;
elessair 0:f269e3021894 238
elessair 0:f269e3021894 239 /* Return error if xfer invalid. */
elessair 0:f269e3021894 240 if ((0U == xfer->dataSize) || (NULL == xfer->data))
elessair 0:f269e3021894 241 {
elessair 0:f269e3021894 242 return kStatus_InvalidArgument;
elessair 0:f269e3021894 243 }
elessair 0:f269e3021894 244
elessair 0:f269e3021894 245 /* If previous RX not finished. */
elessair 0:f269e3021894 246 if (kLPUART_RxBusy == handle->rxState)
elessair 0:f269e3021894 247 {
elessair 0:f269e3021894 248 status = kStatus_LPUART_RxBusy;
elessair 0:f269e3021894 249 }
elessair 0:f269e3021894 250 else
elessair 0:f269e3021894 251 {
elessair 0:f269e3021894 252 handle->rxState = kLPUART_RxBusy;
elessair 0:f269e3021894 253 handle->rxDataSizeAll = xfer->dataSize;
elessair 0:f269e3021894 254
elessair 0:f269e3021894 255 /* Prepare transfer. */
elessair 0:f269e3021894 256 EDMA_PrepareTransfer(&xferConfig, (void *)LPUART_GetDataRegisterAddress(base), sizeof(uint8_t), xfer->data,
elessair 0:f269e3021894 257 sizeof(uint8_t), sizeof(uint8_t), xfer->dataSize, kEDMA_PeripheralToMemory);
elessair 0:f269e3021894 258
elessair 0:f269e3021894 259 /* Submit transfer. */
elessair 0:f269e3021894 260 EDMA_SubmitTransfer(handle->rxEdmaHandle, &xferConfig);
elessair 0:f269e3021894 261 EDMA_StartTransfer(handle->rxEdmaHandle);
elessair 0:f269e3021894 262
elessair 0:f269e3021894 263 /* Enable LPUART RX EDMA. */
elessair 0:f269e3021894 264 LPUART_EnableRxDMA(base, true);
elessair 0:f269e3021894 265
elessair 0:f269e3021894 266 status = kStatus_Success;
elessair 0:f269e3021894 267 }
elessair 0:f269e3021894 268
elessair 0:f269e3021894 269 return status;
elessair 0:f269e3021894 270 }
elessair 0:f269e3021894 271
elessair 0:f269e3021894 272 void LPUART_TransferAbortSendEDMA(LPUART_Type *base, lpuart_edma_handle_t *handle)
elessair 0:f269e3021894 273 {
elessair 0:f269e3021894 274 assert(handle->txEdmaHandle);
elessair 0:f269e3021894 275
elessair 0:f269e3021894 276 /* Disable LPUART TX EDMA. */
elessair 0:f269e3021894 277 LPUART_EnableTxDMA(base, false);
elessair 0:f269e3021894 278
elessair 0:f269e3021894 279 /* Stop transfer. */
elessair 0:f269e3021894 280 EDMA_AbortTransfer(handle->txEdmaHandle);
elessair 0:f269e3021894 281
elessair 0:f269e3021894 282 handle->txState = kLPUART_TxIdle;
elessair 0:f269e3021894 283 }
elessair 0:f269e3021894 284
elessair 0:f269e3021894 285 void LPUART_TransferAbortReceiveEDMA(LPUART_Type *base, lpuart_edma_handle_t *handle)
elessair 0:f269e3021894 286 {
elessair 0:f269e3021894 287 assert(handle->rxEdmaHandle);
elessair 0:f269e3021894 288
elessair 0:f269e3021894 289 /* Disable LPUART RX EDMA. */
elessair 0:f269e3021894 290 LPUART_EnableRxDMA(base, false);
elessair 0:f269e3021894 291
elessair 0:f269e3021894 292 /* Stop transfer. */
elessair 0:f269e3021894 293 EDMA_AbortTransfer(handle->rxEdmaHandle);
elessair 0:f269e3021894 294
elessair 0:f269e3021894 295 handle->rxState = kLPUART_RxIdle;
elessair 0:f269e3021894 296 }
elessair 0:f269e3021894 297
elessair 0:f269e3021894 298 status_t LPUART_TransferGetReceiveCountEDMA(LPUART_Type *base, lpuart_edma_handle_t *handle, uint32_t *count)
elessair 0:f269e3021894 299 {
elessair 0:f269e3021894 300 assert(handle->rxEdmaHandle);
elessair 0:f269e3021894 301
elessair 0:f269e3021894 302 if (kLPUART_RxIdle == handle->rxState)
elessair 0:f269e3021894 303 {
elessair 0:f269e3021894 304 return kStatus_NoTransferInProgress;
elessair 0:f269e3021894 305 }
elessair 0:f269e3021894 306
elessair 0:f269e3021894 307 if (!count)
elessair 0:f269e3021894 308 {
elessair 0:f269e3021894 309 return kStatus_InvalidArgument;
elessair 0:f269e3021894 310 }
elessair 0:f269e3021894 311
elessair 0:f269e3021894 312 *count = handle->rxDataSizeAll - EDMA_GetRemainingBytes(handle->rxEdmaHandle->base, handle->rxEdmaHandle->channel);
elessair 0:f269e3021894 313
elessair 0:f269e3021894 314 return kStatus_Success;
elessair 0:f269e3021894 315 }
elessair 0:f269e3021894 316
elessair 0:f269e3021894 317 status_t LPUART_TransferGetSendCountEDMA(LPUART_Type *base, lpuart_edma_handle_t *handle, uint32_t *count)
elessair 0:f269e3021894 318 {
elessair 0:f269e3021894 319 assert(handle->txEdmaHandle);
elessair 0:f269e3021894 320
elessair 0:f269e3021894 321 if (kLPUART_TxIdle == handle->txState)
elessair 0:f269e3021894 322 {
elessair 0:f269e3021894 323 return kStatus_NoTransferInProgress;
elessair 0:f269e3021894 324 }
elessair 0:f269e3021894 325
elessair 0:f269e3021894 326 if (!count)
elessair 0:f269e3021894 327 {
elessair 0:f269e3021894 328 return kStatus_InvalidArgument;
elessair 0:f269e3021894 329 }
elessair 0:f269e3021894 330
elessair 0:f269e3021894 331 *count = handle->txDataSizeAll - EDMA_GetRemainingBytes(handle->txEdmaHandle->base, handle->txEdmaHandle->channel);
elessair 0:f269e3021894 332
elessair 0:f269e3021894 333 return kStatus_Success;
elessair 0:f269e3021894 334 }