Release version 2.5.1.
[bertos.git] / 2.5 / boards / at91sam7s-ek / hw / hw_spi.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 2008 Develer S.r.l. (http://www.develer.com/)
30  * All Rights Reserved.
31  * -->
32  *
33  * \brief Hardware macro definition.
34  *
35  *
36  * \version $Id$
37  * \author Daniele Basile <asterix@develer.com>
38  */
39
40 #ifndef HW_SPI_H
41 #define HW_SPI_H
42
43 #warning TODO:This is an example implentation, you must implement it!
44
45 #include <cfg/macros.h>
46
47 /**
48  * SPI pin definition.
49  *
50  * \note CS is assert when level
51  * is low.
52  *
53  * \{
54  */
55 #define CS       /* pin */   ///Connect to CS pin of Flash memory.
56 #define SCK      /* pin */   ///Connect to SCK pin of Flash memory.
57 #define MOSI     /* pin */   ///Connect to SI pin of Flash memory.
58 #define MISO     /* pin */   ///Connect to SO pin of Flash memory.
59 #define SPI_PORT /* pin */   ///Micro pin PORT register.
60 #define SPI_PIN  /* pin */   ///Micro pin PIN register.
61 #define SPI_DDR  /* pin */   ///Micro pin DDR register.
62 /*\}*/
63
64 /**
65  * Pin logic level.
66  *
67  * \{
68  */
69 #define MOSI_LOW()       do { /* Implement me! */ } while(0)
70 #define MOSI_HIGH()      do { /* Implement me! */ } while(0)
71 #define MISO_HIGH()      do { /* Implement me! */ } while(0)
72 #define SCK_LOW()        do { /* Implement me! */ } while(0)
73 #define SCK_HIGH()       do { /* Implement me! */ } while(0)
74 #define CS_LOW()         do { /* Implement me! */ } while(0)
75 #define CS_HIGH()        do { /* Implement me! */ } while(0)
76 /*\}*/
77
78 /**
79  * SPI pin commands.
80  *
81  * \{
82  */
83 #define CS_ENABLE()      CS_LOW()
84 #define CS_DISABLE()     CS_HIGH()
85 #define SS_ACTIVE()      CS_LOW()
86 #define SS_INACTIVE()    CS_HIGH()
87 #define SCK_INACTIVE()   SCK_LOW()
88 #define SCK_ACTIVE()     SCK_HIGH()
89 #define CS_OUT()         do { /* Implement me! */ } while(0)
90 #define MOSI_IN()        do { /* Implement me! */ } while(0)
91 #define MOSI_OUT()       do { /* Implement me! */ } while(0)
92 #define IS_MISO_HIGH()   (false /* Implement me! */ )
93 #define MISO_IN()        do { /* Implement me! */ } while(0)
94 #define MISO_OUT()       do { /* Implement me! */ } while(0)
95 #define SCK_OUT()        do { /* Implement me! */ } while(0)
96
97 #define SCK_PULSE()\
98         do {\
99                         SCK_HIGH();\
100                         SCK_LOW();\
101         } while (0)
102 /*\}*/
103
104
105 #define SPI_HW_INIT() \
106         CS_DISABLE();\
107         MOSI_LOW();\
108         SCK_LOW();\
109         MISO_IN();\
110         MOSI_OUT();\
111         SCK_OUT();\
112         CS_OUT();
113
114 #endif /* HW_SPI_H */
115