1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
|
/*
* Copyright (c) 2013 - 2014, Freescale Semiconductor, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* o Redistributions of source code must retain the above copyright notice, this list
* of conditions and the following disclaimer.
*
* o Redistributions in binary form must reproduce the above copyright notice, this
* 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
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef __FSL_LPUART_EDMA_DRIVER_H__
#define __FSL_LPUART_EDMA_DRIVER_H__
#include <stdint.h>
#include <stdbool.h>
#include "fsl_os_abstraction.h"
#include "fsl_lpuart_hal.h"
#include "fsl_edma_driver.h"
#include "fsl_clock_manager.h"
/*!
* @addtogroup lpuart_driver
* @{
*/
/*******************************************************************************
* Variables
******************************************************************************/
/*! @brief Table of base addresses for LPUART instances. */
extern LPUART_Type * const g_lpuartBase[LPUART_INSTANCE_COUNT];
/*******************************************************************************
* Definitions
******************************************************************************/
/*!
* @brief Runtime state structure for UART driver with DMA.
*/
typedef struct LpuartEdmaState {
volatile bool isTxBusy; /*!< True if there is an active transmit. */
volatile bool isRxBusy; /*!< True if there is an active receive. */
volatile bool isTxBlocking; /*!< True if transmit is blocking transaction. */
volatile bool isRxBlocking; /*!< True if receive is blocking transaction. */
semaphore_t txIrqSync; /*!< Used to wait for ISR to complete its TX business. */
semaphore_t rxIrqSync; /*!< Used to wait for ISR to complete its RX business. */
edma_chn_state_t edmaLpuartTx; /*!< Structure definition for the eDMA channel */
edma_chn_state_t edmaLpuartRx; /*!< Structure definition for the eDMA channel */
} lpuart_edma_state_t;
/*! @brief LPUART configuration structure*/
typedef struct LpuartEdmaUserConfig {
clock_lpuart_src_t clockSource; /*!< LPUART clock source in fsl_sim_hal_<device>.h */
uint32_t baudRate; /*!< LPUART baud rate*/
lpuart_parity_mode_t parityMode; /*!< parity mode, disabled (default), even, odd */
lpuart_stop_bit_count_t stopBitCount;/*!< number of stop bits, 1 stop bit (default) or 2 stop bits*/
lpuart_bit_count_per_char_t bitCountPerChar; /*!< number of bits, 8-bit (default) or 9-bit in a
char (up to 10-bits in some LPUART instances.*/
} lpuart_edma_user_config_t;
/*******************************************************************************
* API
******************************************************************************/
#if defined(__cplusplus)
extern "C" {
#endif
/*!
* @name LPUART DMA Driver
* @{
*/
/*!
* @brief Initializes an LPUART instance to work with DMA.
*
* This function initializes the run-time state structure to keep track of the on-going
* transfers, un-gates the clock to the LPUART module, initializes the module
* to user-defined settings and default settings, configures the IRQ state structure and enables
* the module-level interrupt to the core, and enables the LPUART module transmitter and receiver.
* This example shows how to set up the lpuart_edma_state_t and the
* lpuart_user_config_t parameters and how to call the LPUART_DRV_EdmaInit function by passing
* in these parameters:
@code
lpuart_user_config_t lpuartConfig;
lpuartConfig.baudRate = 9600;
lpuartConfig.bitCountPerChar = kLpuart8BitsPerChar;
lpuartConfig.parityMode = kLpuartParityDisabled;
lpuartConfig.stopBitCount = kLpuartOneStopBit;
lpuart_edma_state_t lpuartEdmaState;
LPUART_DRV_EdmaInit(instance, &lpuartEdmaState, &lpuartConfig);
@endcode
*
* @param instance The LPUART instance number.
* @param lpuartEdmaStatePtr A pointer to the LPUART driver state structure memory. The user
* passes in the memory for the run-time state structure. The LPUART driver
* populates the members. This run-time state structure keeps track of the
* current transfer in progress.
* @param lpuartUserConfig The user configuration structure of type lpuart_user_config_t. The user
* populates the members of this structure and passes the pointer of this structure
* into this function.
* @return An error code or kStatus_LPUART_Success.
*/
lpuart_status_t LPUART_DRV_EdmaInit(uint32_t instance, lpuart_edma_state_t * lpuartEdmaStatePtr,
const lpuart_edma_user_config_t * lpuartUserConfig);
/*!
* @brief Shuts down the LPUART.
*
* This function disables the LPUART-DMA trigger, the transmitter, and the receiver.
*
* @param instance The LPUART instance number.
* @return An error code or kStatus_LPUART_Success.
*/
lpuart_status_t LPUART_DRV_EdmaDeinit(uint32_t instance);
/*!
* @brief Sends (transmits) data out through the LPUART-DMA module using a blocking method.
*
* @param instance The LPUART instance number.
* @param txBuff A pointer to the source buffer containing 8-bit data chars to send.
* @param txSize The number of bytes to send.
* @param timeout A timeout value for RTOS abstraction sync control in milliseconds (ms).
* @return An error code or kStatus_LPUART_Success.
*/
lpuart_status_t LPUART_DRV_EdmaSendDataBlocking(uint32_t instance,
const uint8_t * txBuff,
uint32_t txSize,
uint32_t timeout);
/*!
* @brief Sends (transmits) data through the LPUART-DMA module using a non-blocking method.
*
* @param instance The LPUART module base address.
* @param txBuff A pointer to the source buffer containing 8-bit data chars to send.
* @param txSize The number of bytes to send.
* @return An error code or kStatus_LPUART_Success.
*/
lpuart_status_t LPUART_DRV_EdmaSendData(uint32_t instance,
const uint8_t * txBuff,
uint32_t txSize);
/*!
* @brief Returns whether the previous LPUART-DMA transmit has finished.
*
* @param instance The LPUART module base address.
* @param bytesRemaining A pointer to a value that is populated with the number of bytes that
* are remaining in the active transfer.
* @return Current transmit status.
* @retval kStatus_LPUART_Success The transmit has completed successfully.
* @retval kStatus_LPUART_TxBusy The transmit is still in progress. @a bytesTransmitted is
* filled with the number of bytes which are transmitted up to that point.
*/
lpuart_status_t LPUART_DRV_EdmaGetTransmitStatus(uint32_t instance, uint32_t * bytesRemaining);
/*!
* @brief Terminates a non-blocking LPUART-DMA transmission early.
*
* @param instance The LPUART module base address.
* @return Whether the abort of transmitting was successful or not.
* @retval kStatus_LPUART_Success The transmit was successful.
* @retval kStatus_LPUART_NoTransmitInProgress No transmission is currently in progress.
*/
lpuart_status_t LPUART_DRV_EdmaAbortSendingData(uint32_t instance);
/*!
* @brief Gets (receives) data from the LPUART-DMA module using a blocking method.
*
* @param instance The LPUART module base address.
* @param rxBuff A pointer to the buffer containing 8-bit read data chars received.
* @param rxSize The number of bytes to receive.
* @param timeout A timeout value for RTOS abstraction sync control in milliseconds (ms).
* @return An error code or kStatus_LPUART_Success.
*/
lpuart_status_t LPUART_DRV_EdmaReceiveDataBlocking(uint32_t instance, uint8_t * rxBuff,
uint32_t rxSize, uint32_t timeout);
/*!
* @brief Gets (receives) data from the LPUART-DMA module using a non-blocking method.
*
* @param instance The LPUART module base address.
* @param rxBuff A pointer to the buffer containing 8-bit read data chars received.
* @param rxSize The number of bytes to receive.
* @return An error code or kStatus_LPUART_Success.
*/
lpuart_status_t LPUART_DRV_EdmaReceiveData(uint32_t instance, uint8_t * rxBuff, uint32_t rxSize);
/*!
* @brief Returns whether the previous LPUART-DMA receive is complete.
*
* @param instance The LPUART module base address.
* @param bytesRemaining A pointer to a value that populated with the number of bytes which
* still need to be received in the active transfer.
* @return Current receiving status.
* @retval kStatus_LPUART_Success The receive has completed successfully.
* @retval kStatus_LPUART_RxBusy The receive is still in progress. @a bytesReceived is
* filled with the number of bytes which are received up to that point.
*/
lpuart_status_t LPUART_DRV_EdmaGetReceiveStatus(uint32_t instance, uint32_t * bytesRemaining);
/*!
* @brief Terminates a non-blocking LPUART-DMA receive early.
*
* @param instance The LPUART module base address.
* @return Whether the abort of receiving was successful or not.
* @retval kStatus_LPUART_Success The receive was successful.
* @retval kStatus_LPUART_NoTransmitInProgress No receive is currently in progress.
*/
lpuart_status_t LPUART_DRV_EdmaAbortReceivingData(uint32_t instance);
/*@}*/
#if defined(__cplusplus)
}
#endif
/*! @}*/
#endif /* __FSL_LPUART_EDMA_DRIVER_H__ */
/******************************************************************************/
/* EOF */
/******************************************************************************/
|
