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
|
/* ----------------------------------------------------------------------------
* ATMEL Microcontroller Software Support
* ----------------------------------------------------------------------------
* Copyright (c) 2008, Atmel Corporation
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* - Redistributions of source code must retain the above copyright notice,
* this list of conditions and the disclaimer below.
*
* Atmel's name may not be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
* DISCLAIMED. IN NO EVENT SHALL ATMEL 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.
* ----------------------------------------------------------------------------
*/
//------------------------------------------------------------------------------
/// \unit
///
/// !!!Purpose
///
/// The %Dma driver is a high level dma driver which performs DMA device Initializes,
/// tansfer mode configuration and dma transfer.
///
/// !!!Usage
///
/// -# Initializes a %Dma controller and dma transfer instance.
/// Initializes dma for specified channel using DMAD_Initialize().
/// -# Configures the %Dma transfer buffer by giving transfer mode, transfer mode
/// for source peripheral and destination peripheral could be single buffer or
/// multi-buffer(LLI/auto-reload/contiguous buffers) with or without
/// Picture-In-Picture mode.
/// DMAD_Configure_Buffer()
/// \code
/// // Configure multi-buffer transfer with source address auto-reloaded and
/// contiguous destination address.
/// DMAD_Configure_Buffer(DMA_CHANNEL_1,
/// DMA_TRANSFER_RELOAD,
/// DMA_TRANSFER_CONTIGUOUS,
/// 0,
/// 0);
/// \endcode
/// -# Configures the %Dma characteristics (such as source/destination
/// single transfer width, buffer transfer size and source/destionation
/// start addreass for the device corresponding to the specified channle
/// using DMAD_Configure_TransferController().
/// -# Starts a %Dma transfer using DMAD_BufferTransfer().
/// The transfer is performed using the %Dma channels.
/// -# Initialize the total size to be transfered.
/// -# Initialize the callback function if specified.
/// -# Enable the interrupt for specified %dma channel.
/// -# Enable the specified %dma channel.
/// -# Example for transfering buffer through the %Dma.
/// \code
/// // Start channel 1 transfer. Source image auto-reload 4 times.
/// and transfer to destination continguous.
/// DMAD_BufferTransfer(DMA_CHANNEL_1, bufferSize * 4, TestCallback, 0);
/// while (!DMAD_IsFinished(DMA_CHANNEL_1));
/// \endcode
/// -# The DMAD_Handler() must be called by the DMA Interrupt Service Routine
/// with the corresponding %Dma instance. It is invokes to check for pending
/// interrupts.
/// - Example for initializing %Dma interrupt handler in upper application.
/// \code
/// AIC_ConfigureIT(AT91C_ID_HDMA, 0, DMAD_Handler);
/// \endcode
//------------------------------------------------------------------------------
#ifndef DMAD_H
#define DMAD_H
//------------------------------------------------------------------------------
// Global definitions
//------------------------------------------------------------------------------
/// DMA driver is currently busy.
#define DMAD_ERROR_BUSY 1
/// Using the default interrupt handler of the DMAD
#define DMAD_USE_DEFAULT_IT 1
#define DMAD_NO_DEFAULT_IT 0
//------------------------------------------------------------------------------
// Types
//------------------------------------------------------------------------------
/// DMA driver callback function.
typedef void (*DmaCallback)();
//------------------------------------------------------------------------------
/// DMA multi buffer transfer Linker List Item structure.
//------------------------------------------------------------------------------
typedef struct _DmaLinkList {
/// Source address.
unsigned int sourceAddress;
/// Destination address.
unsigned int destAddress;
/// Control A value.
unsigned int controlA;
/// Control B value.
unsigned int controlB;
/// Descriptor Address.
unsigned int descriptor;
} DmaLinkList;
//------------------------------------------------------------------------------
/// DMA picture-in-picture mode configuration structure.
//------------------------------------------------------------------------------
typedef struct _PictureInPicture {
/// Size in byte add to the source address in PIP.
unsigned short pipSourceHoleSize;
/// Number of transfer in byte to perform before the source address increase.
unsigned short pipSourceBoundarySize;
/// Size in byte add to the destination address in PIP.
unsigned short pipDestHoleSize;
/// Number of transfer in byte to perform before the destination address increase.
unsigned short pipDestBoundarySize;
} PictureInPicture;
//------------------------------------------------------------------------------
// Global functions
//------------------------------------------------------------------------------
extern void DMAD_Initialize(unsigned char channel, unsigned char defaultHandler);
extern unsigned char DMAD_Configure_Buffer(unsigned char channel,
unsigned char sourceTransferMode,
unsigned char destTransferMode,
DmaLinkList *lli,
PictureInPicture *pip);
extern unsigned char DMAD_Configure_TransferController(unsigned char channel,
unsigned int bufSize,
unsigned char sourceWidth,
unsigned char destWidth,
unsigned int sourceAddress,
unsigned int destAddress);
extern unsigned char DMAD_BufferTransfer(unsigned char channel,
unsigned int size,
DmaCallback callback,
unsigned char polling);
extern unsigned char DMAD_IsFinished(unsigned char channel);
#endif //#ifndef DMAD_H
|
