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 | * \section Purpose |
---|
34 | * |
---|
35 | * Interface for configuration the Analog-to-Digital Converter (AFEC) peripheral. |
---|
36 | * |
---|
37 | * \section Usage |
---|
38 | * |
---|
39 | * -# Configurate the pins for AFEC. |
---|
40 | * -# Initialize the AFEC with AFEC_Initialize(). |
---|
41 | * -# Set AFEC clock and timing with AFEC_SetClock() and AFEC_SetTiming(). |
---|
42 | * -# Select the active channel using AFEC_EnableChannel(). |
---|
43 | * -# Start the conversion with AFEC_StartConversion(). |
---|
44 | * -# Wait the end of the conversion by polling status with AFEC_GetStatus(). |
---|
45 | * -# Finally, get the converted data using AFEC_GetConvertedData() or |
---|
46 | * AFEC_GetLastConvertedData(). |
---|
47 | * |
---|
48 | */ |
---|
49 | #ifndef _AFE_DMA_ |
---|
50 | #define _AFE_DMA_ |
---|
51 | |
---|
52 | /*---------------------------------------------------------------------------- |
---|
53 | * Headers |
---|
54 | *----------------------------------------------------------------------------*/ |
---|
55 | |
---|
56 | #include "chip.h" |
---|
57 | |
---|
58 | |
---|
59 | /*---------------------------------------------------------------------------- |
---|
60 | * Types |
---|
61 | *----------------------------------------------------------------------------*/ |
---|
62 | |
---|
63 | /** AFE transfer complete callback. */ |
---|
64 | typedef void (*AfeCallback)(uint8_t, void *); |
---|
65 | |
---|
66 | /** \brief Spi Transfer Request prepared by the application upper layer. |
---|
67 | * |
---|
68 | * This structure is sent to the AFE_SendCommand function to start the transfer. |
---|
69 | * At the end of the transfer, the callback is invoked by the interrupt handler. |
---|
70 | */ |
---|
71 | typedef struct { |
---|
72 | /** Pointer to the Rx data. */ |
---|
73 | uint32_t *pRxBuff; |
---|
74 | /** Rx size in bytes. */ |
---|
75 | uint16_t RxSize; |
---|
76 | /** Callback function invoked at the end of transfer. */ |
---|
77 | AfeCallback callback; |
---|
78 | /** Callback arguments. */ |
---|
79 | void *pArgument; |
---|
80 | } AfeCmd; |
---|
81 | |
---|
82 | |
---|
83 | /** Constant structure associated with AFE port. This structure prevents |
---|
84 | client applications to have access in the same time. */ |
---|
85 | typedef struct { |
---|
86 | /** Pointer to AFE Hardware registers */ |
---|
87 | Afec *pAfeHw; |
---|
88 | /** Current SpiCommand being processed */ |
---|
89 | AfeCmd *pCurrentCommand; |
---|
90 | /** Pointer to DMA driver */ |
---|
91 | sXdmad *pXdmad; |
---|
92 | /** AFEC Id as defined in the product datasheet */ |
---|
93 | uint8_t afeId; |
---|
94 | /** Mutual exclusion semaphore. */ |
---|
95 | volatile int8_t semaphore; |
---|
96 | } AfeDma; |
---|
97 | |
---|
98 | |
---|
99 | /*------------------------------------------------------------------------------ |
---|
100 | * Definitions |
---|
101 | *----------------------------------------------------------------------------*/ |
---|
102 | #define AFE_OK 0 |
---|
103 | #define AFE_ERROR 1 |
---|
104 | #define AFE_ERROR_LOCK 2 |
---|
105 | /*------------------------------------------------------------------------------ |
---|
106 | * Exported functions |
---|
107 | *----------------------------------------------------------------------------*/ |
---|
108 | extern uint32_t Afe_ConfigureDma(AfeDma *pAfed , |
---|
109 | Afec *pAfeHw , |
---|
110 | uint8_t AfeId, |
---|
111 | sXdmad *pXdmad); |
---|
112 | extern uint32_t Afe_SendData(AfeDma *pAfed, AfeCmd *pCommand); |
---|
113 | |
---|
114 | |
---|
115 | #endif /* #ifndef _AFE_DMA_ */ |
---|
116 | |
---|