1 | /* ---------------------------------------------------------------------------- */ |
---|
2 | /* Atmel Microcontroller Software Support */ |
---|
3 | /* SAM Software Package License */ |
---|
4 | /* ---------------------------------------------------------------------------- */ |
---|
5 | /* Copyright (c) 2015, Atmel Corporation */ |
---|
6 | /* */ |
---|
7 | /* All rights reserved. */ |
---|
8 | /* */ |
---|
9 | /* Redistribution and use in source and binary forms, with or without */ |
---|
10 | /* modification, are permitted provided that the following condition is met: */ |
---|
11 | /* */ |
---|
12 | /* - Redistributions of source code must retain the above copyright notice, */ |
---|
13 | /* this list of conditions and the disclaimer below. */ |
---|
14 | /* */ |
---|
15 | /* Atmel's name may not be used to endorse or promote products derived from */ |
---|
16 | /* this software without specific prior written permission. */ |
---|
17 | /* */ |
---|
18 | /* DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR */ |
---|
19 | /* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF */ |
---|
20 | /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE */ |
---|
21 | /* DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT, */ |
---|
22 | /* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT */ |
---|
23 | /* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, */ |
---|
24 | /* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF */ |
---|
25 | /* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING */ |
---|
26 | /* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, */ |
---|
27 | /* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ |
---|
28 | /* ---------------------------------------------------------------------------- */ |
---|
29 | |
---|
30 | /** |
---|
31 | * \file |
---|
32 | * |
---|
33 | * Implementation of USART driver, transfer data through DMA. |
---|
34 | * |
---|
35 | */ |
---|
36 | |
---|
37 | #ifndef _USART_DMA_H_ |
---|
38 | #define _USART_DMA_H_ |
---|
39 | |
---|
40 | /*---------------------------------------------------------------------------- |
---|
41 | * Headers |
---|
42 | *----------------------------------------------------------------------------*/ |
---|
43 | |
---|
44 | #include "chip.h" |
---|
45 | |
---|
46 | /*---------------------------------------------------------------------------- |
---|
47 | * Definitions |
---|
48 | *----------------------------------------------------------------------------*/ |
---|
49 | |
---|
50 | /** An unspecified error has occurred.*/ |
---|
51 | #define USARTD_ERROR 1 |
---|
52 | |
---|
53 | /** USART driver is currently in use.*/ |
---|
54 | #define USARTD_ERROR_LOCK 2 |
---|
55 | |
---|
56 | |
---|
57 | #ifdef __cplusplus |
---|
58 | extern "C" { |
---|
59 | #endif |
---|
60 | |
---|
61 | /*---------------------------------------------------------------------------- |
---|
62 | * Types |
---|
63 | *----------------------------------------------------------------------------*/ |
---|
64 | |
---|
65 | /** USART transfer complete callback. */ |
---|
66 | typedef void (*UsartdCallback)(uint8_t, void *); |
---|
67 | |
---|
68 | /** \brief usart Transfer Request prepared by the application upper layer. |
---|
69 | * |
---|
70 | * This structure is sent to the USART_Send or USART_Rcv to start the transfer. |
---|
71 | * At the end of the transfer, the callback is invoked by the interrupt handler. |
---|
72 | */ |
---|
73 | typedef struct { |
---|
74 | /** Pointer to the Buffer. */ |
---|
75 | uint8_t *pBuff; |
---|
76 | /** Buff size in bytes. */ |
---|
77 | uint32_t BuffSize; |
---|
78 | /** Dma channel num. */ |
---|
79 | uint8_t ChNum; |
---|
80 | /** Callback function invoked at the end of transfer. */ |
---|
81 | UsartdCallback callback; |
---|
82 | /** Callback arguments. */ |
---|
83 | void *pArgument; |
---|
84 | /** flag to indicate the current transfer progress */ |
---|
85 | volatile uint8_t dmaProgress; |
---|
86 | /* DMA LLI structure */ |
---|
87 | LinkedListDescriporView1 *pLLIview; |
---|
88 | /* DMA transfer type */ |
---|
89 | eXdmadProgState dmaProgrammingMode; |
---|
90 | /* DMA LLI size or num of micro block*/ |
---|
91 | uint16_t dmaBlockSize; |
---|
92 | /* Flag using ring buffer or FiFo*/ |
---|
93 | uint8_t dmaRingBuffer; |
---|
94 | } UsartChannel; |
---|
95 | |
---|
96 | /** Constant structure associated with USART port. This structure prevents |
---|
97 | client applications to have access in the same time. */ |
---|
98 | typedef struct { |
---|
99 | /** USART Id as defined in the product datasheet */ |
---|
100 | uint8_t usartId; |
---|
101 | /** Pointer to USART Hardware registers */ |
---|
102 | Usart *pUsartHw; |
---|
103 | /** Current Usart Rx channel */ |
---|
104 | UsartChannel *pRxChannel; |
---|
105 | /** Current Usart Tx channel */ |
---|
106 | UsartChannel *pTxChannel; |
---|
107 | /** Pointer to DMA driver */ |
---|
108 | sXdmad *pXdmad; |
---|
109 | } UsartDma; |
---|
110 | |
---|
111 | /*---------------------------------------------------------------------------- |
---|
112 | * Exported functions |
---|
113 | *----------------------------------------------------------------------------*/ |
---|
114 | |
---|
115 | uint32_t USARTD_Configure(UsartDma *pUsartd , |
---|
116 | uint8_t USARTId, |
---|
117 | uint32_t UsartMode, |
---|
118 | uint32_t BaudRate, |
---|
119 | uint32_t UsartClk); |
---|
120 | |
---|
121 | uint32_t USARTD_EnableTxChannels(UsartDma *pUsartd, UsartChannel *pTxCh); |
---|
122 | |
---|
123 | uint32_t USARTD_EnableRxChannels(UsartDma *pUsartd, UsartChannel *pRxCh); |
---|
124 | |
---|
125 | uint32_t USARTD_DisableTxChannels(UsartDma *pUsartd, UsartChannel *pTxCh); |
---|
126 | |
---|
127 | uint32_t USARTD_DisableRxChannels(UsartDma *pUsartd, UsartChannel *pTxCh); |
---|
128 | |
---|
129 | uint32_t USARTD_SendData(UsartDma *pUsartd); |
---|
130 | |
---|
131 | uint32_t USARTD_RcvData(UsartDma *pUsartd); |
---|
132 | |
---|
133 | #ifdef __cplusplus |
---|
134 | } |
---|
135 | #endif |
---|
136 | |
---|
137 | #endif /* #ifndef _USART_DMA_ */ |
---|