Contiki 2.5
gpio.h
1 /*
2  * Copyright (c) 2010, Mariano Alvira <mar@devl.org> and other contributors
3  * to the MC1322x project (http://mc1322x.devl.org)
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the distribution.
14  * 3. Neither the name of the Institute nor the names of its contributors
15  * may be used to endorse or promote products derived from this software
16  * without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  *
30  * This file is part of libmc1322x: see http://mc1322x.devl.org
31  * for details.
32  *
33  *
34  */
35 
36 #ifndef GPIO_H
37 #define GPIO_H
38 
39 /* Structure-based GPIO access
40  Example usage:
41 
42  GPIO->FUNC_SEL0 |= 0x00008000; // set a whole register
43 
44  GPIO->FUNC_SEL_08 = 2; // set just one pin
45 
46  #define MY_PIN GPIO_08
47  GPIO->FUNC_SEL.MY_PIN = 2; // same, to allow #define for pin names
48  GPIO->DATA.MY_PIN = 1;
49 
50  gpio_set(GPIO_08); // efficiently set or clear a single output bit
51  gpio_reset(GPIO_08);
52 */
53 
54 #define _V(x,n,i) uint32_t x##_##i : n;
55 #define _REP(x,n) \
56  _V(x,n,00) _V(x,n,01) _V(x,n,02) _V(x,n,03) _V(x,n,04) _V(x,n,05) _V(x,n,06) _V(x,n,07) \
57  _V(x,n,08) _V(x,n,09) _V(x,n,10) _V(x,n,11) _V(x,n,12) _V(x,n,13) _V(x,n,14) _V(x,n,15) \
58  _V(x,n,16) _V(x,n,17) _V(x,n,18) _V(x,n,19) _V(x,n,20) _V(x,n,21) _V(x,n,22) _V(x,n,23) \
59  _V(x,n,24) _V(x,n,25) _V(x,n,26) _V(x,n,27) _V(x,n,28) _V(x,n,29) _V(x,n,30) _V(x,n,31) \
60  _V(x,n,32) _V(x,n,33) _V(x,n,34) _V(x,n,35) _V(x,n,36) _V(x,n,37) _V(x,n,38) _V(x,n,39) \
61  _V(x,n,40) _V(x,n,41) _V(x,n,42) _V(x,n,43) _V(x,n,44) _V(x,n,45) _V(x,n,46) _V(x,n,47) \
62  _V(x,n,48) _V(x,n,49) _V(x,n,50) _V(x,n,51) _V(x,n,52) _V(x,n,53) _V(x,n,54) _V(x,n,55) \
63  _V(x,n,56) _V(x,n,57) _V(x,n,58) _V(x,n,59) _V(x,n,60) _V(x,n,61) _V(x,n,62) _V(x,n,63)
64 
65 struct GPIO_struct {
66 #define _IO(x) \
67  union { struct { uint32_t x##0; uint32_t x##1; }; \
68  struct { _REP(x, 1) }; \
69  struct GPIO_##x { _REP(GPIO, 1) } x; };
70 #define _IO_2bit(x) \
71  union { struct { uint32_t x##0; uint32_t x##1; uint32_t x##2; uint32_t x##3; }; \
72  struct { _REP(x, 2) }; \
73  struct GPIO_##x { _REP(GPIO, 2) } x; };
74 
75  _IO(PAD_DIR);
76  _IO(DATA);
77  _IO(PAD_PU_EN);
78  _IO_2bit(FUNC_SEL);
79  _IO(DATA_SEL);
80  _IO(PAD_PU_SEL);
81  _IO(PAD_HYST_EN);
82  _IO(PAD_KEEP);
83  _IO(DATA_SET);
84  _IO(DATA_RESET);
85  _IO(PAD_DIR_SET);
86  _IO(PAD_DIR_RESET);
87 };
88 #undef _IO
89 #undef _IO_2bit
90 
91 /* Build an enum lookup to map GPIO_08 -> 8 */
92 #undef _V
93 #define _V(x,n,i) __NUM_GPIO_GPIO_##i,
94 enum { _REP(0,0) };
95 
96 /* Macros to set or reset a data pin in the fastest possible way */
97 #define gpio_set(gpio_xx) __gpio_set(gpio_xx)
98 #define __gpio_set(gpio_xx) \
99  ((__NUM_GPIO_##gpio_xx < 32) \
100  ? (GPIO->DATA_SET0 = (1 << (__NUM_GPIO_##gpio_xx - 0))) \
101  : (GPIO->DATA_SET1 = (1 << (__NUM_GPIO_##gpio_xx - 32))))
102 #define gpio_reset(gpio_xx) __gpio_reset(gpio_xx)
103 #define __gpio_reset(gpio_xx) \
104  ((__NUM_GPIO_##gpio_xx < 32) \
105  ? (GPIO->DATA_RESET0 = (1 << (__NUM_GPIO_##gpio_xx - 0))) \
106  : (GPIO->DATA_RESET1 = (1 << (__NUM_GPIO_##gpio_xx - 32))))
107 
108 #undef _REP
109 #undef _V
110 
111 static volatile struct GPIO_struct * const GPIO = (void *) (0x80000000);
112 
113 
114 /* Old register definitions, for compatibility */
115 #ifndef REG_NO_COMPAT
116 
117 #define GPIO_PAD_DIR0 ((volatile uint32_t *) 0x80000000)
118 #define GPIO_PAD_DIR1 ((volatile uint32_t *) 0x80000004)
119 #define GPIO_DATA0 ((volatile uint32_t *) 0x80000008)
120 #define GPIO_DATA1 ((volatile uint32_t *) 0x8000000c)
121 #define GPIO_PAD_PU_EN0 ((volatile uint32_t *) 0x80000010)
122 #define GPIO_PAD_PU_EN1 ((volatile uint32_t *) 0x80000014)
123 #define GPIO_FUNC_SEL0 ((volatile uint32_t *) 0x80000018) /* GPIO 15 - 0; 2 bit blocks */
124 #define GPIO_FUNC_SEL1 ((volatile uint32_t *) 0x8000001c) /* GPIO 16 - 31; 2 bit blocks */
125 #define GPIO_FUNC_SEL2 ((volatile uint32_t *) 0x80000020) /* GPIO 32 - 47; 2 bit blocks */
126 #define GPIO_FUNC_SEL3 ((volatile uint32_t *) 0x80000024) /* GPIO 48 - 63; 2 bit blocks */
127 #define GPIO_DATA_SEL0 ((volatile uint32_t *) 0x80000028)
128 #define GPIO_DATA_SEL1 ((volatile uint32_t *) 0x8000002c)
129 #define GPIO_PAD_PU_SEL0 ((volatile uint32_t *) 0x80000030)
130 #define GPIO_PAD_PU_SEL1 ((volatile uint32_t *) 0x80000034)
131 
132 #define GPIO_DATA_SET0 ((volatile uint32_t *) 0x80000048)
133 #define GPIO_DATA_SET1 ((volatile uint32_t *) 0x8000004c)
134 #define GPIO_DATA_RESET0 ((volatile uint32_t *) 0x80000050)
135 #define GPIO_DATA_RESET1 ((volatile uint32_t *) 0x80000054)
136 #define GPIO_PAD_DIR_SET0 ((volatile uint32_t *) 0x80000058)
137 #define GPIO_PAD_DIR_SET1 ((volatile uint32_t *) 0x8000005c)
138 #define GPIO_PAD_DIR_RESET0 ((volatile uint32_t *) 0x80000060)
139 #define GPIO_PAD_DIR_RESET1 ((volatile uint32_t *) 0x80000064)
140 
141 inline void gpio_pad_dir(volatile uint64_t data);
142 inline void gpio_data(volatile uint64_t data);
143 inline uint64_t gpio_data_get(volatile uint64_t bits);
144 inline void gpio_pad_pu_en(volatile uint64_t data);
145 inline void gpio_data_sel(volatile uint64_t data);
146 inline void gpio_data_pu_sel(volatile uint64_t data);
147 inline void gpio_data_set(volatile uint64_t data);
148 inline void gpio_data_reset(volatile uint64_t data);
149 inline void gpio_pad_dir_set(volatile uint64_t data);
150 inline void gpio_pad_dir_reset(volatile uint64_t data);
151 
152 /* select pullup or pulldown for GPIO 0-31 (b=0-31) */
153 #define gpio_sel0_pullup(b) (set_bit(*GPIO_PAD_PU_SEL0,b))
154 #define gpio_sel0_pulldown(b) (clear_bit(*GPIO_PAD_PU_SEL0,b))
155 
156 /* select pullup or pulldown for GPIO 32-63 (b=32-63) */
157 #define gpio_sel1_pullup(b) (set_bit(*GPIO_PAD_PU_SEL1,b-32))
158 #define gpio_sel1_pulldown(b) (clear_bit(*GPIO_PAD_PU_SEL1,b-32))
159 
160 /* enable/disable pullup for GPIO 0-31 (b=0-31) */
161 #define gpio_pu0_enable(b) (set_bit(*GPIO_PAD_PU_EN0,b))
162 #define gpio_pu0_disable(b) (clear_bit(*GPIO_PAD_PU_EN0,b))
163 
164 /* enable/disable pullup for GPIO 32-63 (b=32-63) */
165 #define gpio_pu1_enable(b) (set_bit(*GPIO_PAD_PU_EN1,b-32))
166 #define gpio_pu1_disable(b) (clear_bit(*GPIO_PAD_PU_EN1,b-32))
167 
168 #endif /* REG_NO_COMPAT */
169 
170 #endif
Generated on Fri Aug 30 2013 12:34:07 for Contiki 2.5 by   doxygen 1.8.3.1