Add brief. Add example callout functions. Use tokenToInt to compute date time stamp...
[bertos.git] / bertos / cpu / arm / io / at91sam7.h
1 /**
2  * \file
3  * <!--
4  * This file is part of BeRTOS.
5  *
6  * Bertos is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  * As a special exception, you may use this file as part of a free software
21  * library without restriction.  Specifically, if other files instantiate
22  * templates or use macros or inline functions from this file, or you compile
23  * this file and link it with other files to produce an executable, this
24  * file does not by itself cause the resulting executable to be covered by
25  * the GNU General Public License.  This exception does not however
26  * invalidate any other reasons why the executable file might be covered by
27  * the GNU General Public License.
28  *
29  * Copyright 2007 Develer S.r.l. (http://www.develer.com/)
30  *
31  * -->
32  *
33  * \version $Id$
34  *
35  * \author Francesco Sacchi <batt@develer.com>
36  * \author Daniele Basile <asterix@develer.com>
37  *
38  * AT91SAM7 register definitions.
39  * This file is based on NUT/OS implementation. See license below.
40  */
41
42 /*
43  * Copyright (C) 2006-2007 by egnite Software GmbH. All rights reserved.
44  *
45  * Redistribution and use in source and binary forms, with or without
46  * modification, are permitted provided that the following conditions
47  * are met:
48  *
49  * 1. Redistributions of source code must retain the above copyright
50  *    notice, this list of conditions and the following disclaimer.
51  * 2. Redistributions in binary form must reproduce the above copyright
52  *    notice, this list of conditions and the following disclaimer in the
53  *    documentation and/or other materials provided with the distribution.
54  * 3. Neither the name of the copyright holders nor the names of
55  *    contributors may be used to endorse or promote products derived
56  *    from this software without specific prior written permission.
57  *
58  * THIS SOFTWARE IS PROVIDED BY EGNITE SOFTWARE GMBH AND CONTRIBUTORS
59  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
60  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
61  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL EGNITE
62  * SOFTWARE GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
63  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
64  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
65  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
66  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
67  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
68  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
69  * SUCH DAMAGE.
70  *
71  * For additional information see http://www.ethernut.de/
72  */
73
74 #ifndef AT91SAM7_H
75 #define AT91SAM7_H
76
77 #include <cfg/compiler.h>
78
79 #if CPU_ARM_SAM7X || CPU_ARM_SAM7S_LARGE
80         #define FLASH_BASE      0x100000UL
81         #define RAM_BASE        0x200000UL
82
83         #define TC_BASE         0xFFFA0000      ///< Timer/counter base address.
84         #define UDP_BASE        0xFFFB0000      ///< USB device port base address.
85         #define TWI_BASE        0xFFFB8000      ///< Two-wire interface base address.
86         #define USART0_BASE     0xFFFC0000      ///< USART 0 base address.
87         #define USART1_BASE     0xFFFC4000      ///< USART 1 base address.
88         #define PWMC_BASE       0xFFFCC000      ///< PWM controller base address.
89         #define SSC_BASE        0xFFFD4000      ///< Serial synchronous controller base address.
90         #define ADC_BASE        0xFFFD8000      ///< ADC base address.
91
92         #define AIC_BASE        0xFFFFF000      ///< AIC base address.
93         #define DBGU_BASE       0xFFFFF200      ///< DBGU base address.
94         #define PIOA_BASE       0xFFFFF400      ///< PIO A base address.
95         #define PMC_BASE        0xFFFFFC00      ///< PMC base address.
96         #define RSTC_BASE       0xFFFFFD00      ///< Resect controller register base address.
97         #define RTT_BASE        0xFFFFFD20      ///< Realtime timer base address.
98         #define PIT_BASE        0xFFFFFD30      ///< Periodic interval timer base address.
99         #define WDT_BASE        0xFFFFFD40      ///< Watch Dog register base address.
100         #define VREG_BASE       0xFFFFFD60      ///< Voltage regulator mode controller base address.
101         #define MC_BASE         0xFFFFFF00      ///< Memory controller base.
102
103         #if CPU_ARM_SAM7X
104                 #define CAN_BASE        0xFFFD0000      ///< PWM controller base address.
105                 #define EMAC_BASE       0xFFFDC000      ///< Ethernet MAC address.
106                 #define SPI0_BASE       0xFFFE0000      ///< SPI0 base address.
107                 #define SPI1_BASE       0xFFFE4000      ///< SPI1 base address.
108                 #define PIOB_BASE       0xFFFFF600      ///< PIO base address.
109         #endif
110
111         #if CPU_ARM_SAM7S_LARGE
112                 #define SPI_BASE        0xFFFE0000      ///< SPI0 base address.
113         #endif
114
115         #define PIO_HAS_MULTIDRIVER        1
116         #define PIO_HAS_PULLUP             1
117         #define PIO_HAS_PERIPHERALSELECT   1
118         #define PIO_HAS_OUTPUTWRITEENABLE  1
119
120         #define DBGU_HAS_PDC               1
121         #define SPI_HAS_PDC                1
122         #define SSC_HAS_PDC                1
123         #define USART_HAS_PDC              1
124
125         /* PDC registers */
126         #define PERIPH_RPR_OFF  0x100  ///< Receive Pointer Register.
127         #define PERIPH_RCR_OFF  0x104  ///< Receive Counter Register.
128         #define PERIPH_TPR_OFF  0x108  ///< Transmit Pointer Register.
129         #define PERIPH_TCR_OFF  0x10C  ///< Transmit Counter Register.
130         #define PERIPH_RNPR_OFF 0x110  ///< Receive Next Pointer Register.
131         #define PERIPH_RNCR_OFF 0x114  ///< Receive Next Counter Register.
132         #define PERIPH_TNPR_OFF 0x118  ///< Transmit Next Pointer Register.
133         #define PERIPH_TNCR_OFF 0x11C  ///< Transmit Next Counter Register.
134         #define PERIPH_PTCR_OFF 0x120  ///< PDC Transfer Control Register.
135         #define PERIPH_PTSR_OFF 0x124  ///< PDC Transfer Status Register.
136
137         #define PDC_RXTEN  0
138         #define PDC_RXTDIS 1
139         #define PDC_TXTEN  8
140         #define PDC_TXTDIS 9
141
142 #else
143         #error No base address register definition for selected ARM CPU
144
145 #endif
146
147 #include "at91_aic.h"
148 #include "at91_pit.h"
149 #include "at91_pmc.h"
150 #include "at91_mc.h"
151 #include "at91_wdt.h"
152 #include "at91_rstc.h"
153 #include "at91_pio.h"
154 #include "at91_us.h"
155 #include "at91_dbgu.h"
156 #include "at91_tc.h"
157 #include "at91_adc.h"
158 #include "at91_pwm.h"
159 #include "at91_spi.h"
160 #include "at91_twi.h"
161 #include "at91_ssc.h"
162 //TODO: add other peripherals
163
164 /**
165  * Peripheral Identifiers and Interrupts
166  *\{
167  */
168 #if CPU_ARM_SAM7X || CPU_ARM_SAM7S_LARGE
169         #define FIQ_ID      0       ///< Fast interrupt ID.
170         #define SYSC_ID     1       ///< System controller interrupt.
171         #define US0_ID      6       ///< USART 0 ID.
172         #define US1_ID      7       ///< USART 1 ID.
173         #define SSC_ID      8       ///< Synchronous serial controller ID.
174         #define TWI_ID      9       ///< Two-wire interface ID.
175         #define PWMC_ID     10      ///< PWM controller ID.
176         #define UDP_ID      11      ///< USB device port ID.
177         #define TC0_ID      12      ///< Timer 0 ID.
178         #define TC1_ID      13      ///< Timer 1 ID.
179         #define TC2_ID      14      ///< Timer 2 ID.
180
181         #define IRQ0_ID     30      ///< External interrupt 0 ID.
182         #define IRQ1_ID     31      ///< External interrupt 1 ID.
183
184         #if CPU_ARM_SAM7X
185                 #define PIOA_ID     2       ///< Parallel A I/O controller ID.
186                 #define PIOB_ID     3       ///< Parallel B I/O controller ID.
187                 #define SPI0_ID     4       ///< Serial peripheral interface 0 ID.
188                 #define SPI1_ID     5       ///< Serial peripheral interface 1 ID.
189                 #define CAN_ID      15      ///< CAN controller ID.
190                 #define EMAC_ID     16      ///< Ethernet MAC ID.
191                 #define ADC_ID      17      ///< Analog to digital converter ID.
192                 /* 18-29 Reserved */
193
194         #endif
195
196         #if CPU_ARM_SAM7S_LARGE
197                 #define PIOA_ID     2       ///< Parallel I/O controller ID.
198                 /* ID 3 is reserved */
199                 #define ADC_ID      4       ///< Analog to digital converter ID.
200                 #define SPI_ID      5       ///< Serial peripheral interface ID.
201                 #define SPI0_ID     SPI_ID  ///< Alias
202         #endif
203
204 #else
205         #error No peripheral ID and interrupts definition for selected ARM CPU
206
207 #endif
208 /*\}*/
209
210 /**
211  * USART & DEBUG pin names
212  *\{
213  */
214 #if CPU_ARM_SAM7S_LARGE
215         #define RXD0        5
216         #define TXD0        6
217         #define RXD1       21
218         #define TXD1       22
219         #define DTXD       10
220         #define DRXD        9
221 #elif CPU_ARM_SAM7X
222         #define RXD0        0 // PA0
223         #define TXD0        1 // PA1
224         #define RXD1        5 // PA5
225         #define TXD1        6 // PA6
226         #define DTXD       28 // PA28
227         #define DRXD       27 // PA27
228 #else
229         #error No USART & debug pin names definition for selected ARM CPU
230 #endif
231 /*\}*/
232
233 /**
234  * SPI pins name
235  *\{
236  */
237 #if CPU_ARM_SAM7S_LARGE
238         #define SPI0_NPCS0      11  // Same as NSS pin.
239         #define SPI0_MISO       12
240         #define SPI0_MOSI       13
241         #define SPI0_SPCK       14
242
243 #elif CPU_ARM_SAM7X
244         #define SPI0_NPCS0  12 // Same as NSS pin. PA12
245         #define SPI0_NPCS1  13 // PA13
246         #define SPI0_NPCS2  14 // PA14
247         #define SPI0_NPCS3  15 // PA15
248         #define SPI0_MISO   16 // PA16
249         #define SPI0_MOSI   17 // PA17
250         #define SPI0_SPCK   18 // PA18
251
252         #define SPI1_NPCS0  21 // Same as NSS pin. PA21
253         #define SPI1_NPCS1  25 // PA25
254         #define SPI1_NPCS2  26 // PA26
255         #define SPI1_NPCS3  29 // PA29
256         #define SPI1_MISO   24 // PA24
257         #define SPI1_MOSI   23 // PA23
258         #define SPI1_SPCK   22 // PA22
259
260 #else
261         #error No SPI pins name definition for selected ARM CPU
262
263 #endif
264 /*\}*/
265
266 /**
267  * SSC pins name
268  *\{
269  */
270 #if CPU_ARM_SAM7S_LARGE
271
272         #define SSC_TF     15 // PA15
273         #define SSC_TK     16 // PA16
274         #define SSC_TD     17 // PA17
275         #define SSC_RD     18 // PA18
276         #define SSC_RK     19 // PA19
277         #define SSC_RF     20 // PA20
278
279 #elif CPU_ARM_SAM7X
280
281         #define SSC_TF     21 // PA21
282         #define SSC_TK     22 // PA22
283         #define SSC_TD     23 // PA23
284         #define SSC_RD     24 // PA24
285         #define SSC_RK     25 // PA25
286         #define SSC_RF     26 // PA26
287
288 #else
289         #error No SSC pins name definition for selected ARM CPU
290
291 #endif
292 /*\}*/
293
294 /**
295  * Timer counter pins definition.
296  *\{
297  */
298 #if CPU_ARM_SAM7X
299         #define TIOA0  23 // PB23
300         #define TIOB0  24 // PB24
301         #define TIOA1  25 // PB25
302         #define TIOB1  26 // PB26
303         #define TIOA2  27 // PB27
304         #define TIOB2  28 // PB28
305
306         #define TIO_PIO_PDR     PIOB_PDR
307         #define TIO_PIO_ABSR    PIOB_ASR
308
309 #elif CPU_ARM_SAM7S_LARGE
310         #define TIOA0  0 // PA0
311         #define TIOB0  1 // PA1
312         #define TIOA1  15 // PA15
313         #define TIOB1  16 // PA16
314         #define TIOA2  26 // PA26
315         #define TIOB2  27 // PA27
316
317         #define TIO_PIO_PDR     PIOA_PDR
318         #define TIO_PIO_ABSR    PIOA_BSR
319
320 #else
321         #error No Timer Counter names of pins definition for selected ARM CPU
322
323 #endif
324 /*\}*/
325
326
327 /**
328  * PWM pins definition.
329  *\{
330  */
331 #if CPU_ARM_SAM7X
332         #define PWM0  19 // PB19
333         #define PWM1  20 // PB20
334         #define PWM2  21 // PB21
335         #define PWM3  22 // PB22
336
337         #define PWM_PIO_PDR     PIOB_PDR
338         #define PWM_PIO_PER     PIOB_PER
339         #define PWM_PIO_CODR    PIOB_CODR
340         #define PWM_PIO_OER     PIOB_OER
341         #define PWM_PIO_ABSR    PIOB_ASR
342
343 #elif CPU_ARM_SAM7S_LARGE
344         #define PWM0  11 // PA11
345         #define PWM1  12 // PA12
346         #define PWM2  13 // PA13
347         #define PWM3  14 // PA14
348
349         #define PWM_PIO_PDR     PIOA_PDR
350         #define PWM_PIO_PER     PIOA_PER
351         #define PWM_PIO_CODR    PIOA_CODR
352         #define PWM_PIO_OER     PIOA_OER
353         #define PWM_PIO_ABSR    PIOA_BSR
354
355 #else
356         #error No PWM names of pins definition for selected ARM CPU
357
358 #endif
359 /*\}*/
360
361 /**
362  * TWI pins definition.
363  *\{
364  */
365 #if CPU_ARM_SAM7X
366         #define TWD  10
367         #define TWCK 11
368
369 #elif CPU_ARM_SAM7S_LARGE
370         #define TWD  3    //PA3
371         #define TWCK 4    //PA4
372
373 #else
374         #error No TWI names of pins definition for selected ARM CPU
375 #endif
376
377 /**
378  * ADC pins definition.
379  *\{
380  */
381 #if CPU_ARM_SAM7X
382         #define ADTRG   18 // PB18
383         #define AD0     23 // PB27
384         #define AD1     24 // PB28
385         #define AD2     25 // PB29
386         #define AD3     26 // PB30
387
388 #elif CPU_ARM_SAM7S_LARGE
389         #define ADTRG   18 // PA8
390         #define AD0      0 // PA17
391         #define AD1      1 // PA18
392         #define AD2     15 // PA19
393         #define AD3     16 // PA20
394
395 #else
396         #error No ADC names of pins definition for selected ARM CPU
397
398 #endif
399 /*\}*/
400
401 #endif /* AT91SAM7_H */