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
159
160
161
162
|
/* -*- mode:c -*-
*
* Copyright 2014 The Chromium OS Authors. All rights reserved.
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
/**
* @file gpio.wrap
* @brief Include the board specific *gpio.inc* file.
*
* This file is included in many different contexts.
* The macros defined outside of the file (before including)
* determine what parts of *gpio.inc* will be emitted.
*
* @see include/gpio_list.h
* @see common/gpio.c
* @see include/gpio_signal.h
*/
#ifndef GPIO_PIN
#error "Your architecture must define GPIO_PIN and it did not."
#endif
#ifndef GPIO_PIN_MASK
#error "Your architecture must define GPIO_PIN_MASK and it did not."
#endif
/**
* @def GPIO
* @brief The GPIO macro is used to define a new GPIO pin name and function.
*
* The name is used to populate the gpio_signal enum by first
* prepending GPIO_ to the name. It is also used to construct the
* string name that is presented in the shell interface. The pin
* parameter should use PIN macro and will be expand to GPIO_PIN
* defined on each board. The flags parameter is passed on to the
* gpio_info directly.
*/
#ifndef GPIO
#define GPIO(name, pin, flags)
#endif
/**
* @def GPIO_INT
* @brief The GPIO_INT macro is used to define a GPIOs that have an IRQ handler.
*
* The IRQ handler pointers are stored as elements in the gpio_irq_handlers
* array.
*/
#ifndef GPIO_INT
#define GPIO_INT(name, pin, flags, signal)
#endif
/**
* @def ALTERNATE
* @brief The ALTERNATE macro is used associate a GPIO with an alternate
* function.
*
* Alternate functions allow hardware peripherals access to GPIO pins.
* Modules use gpio_config_module to enable and disable the alternate functions
* of GPIOs assigned to that module. So if the module parameter is MODULE_UART
* then when the uart_init function is called the GPIO will be switched to its
* alternate function mode. The function parameter is chip/variant specific
* and will usually need to be looked up in the datasheet. The flags parameter
* has the same meaning as in the GPIO macro above. This macro can assign
* multiple pins on the same port to a module, pinmasks should use PIN_MASK
* and will be expanded as GPIO_PIN_MASK defined in each config_chip.h.
*/
#ifndef ALTERNATE
#define ALTERNATE(pinmask, function, module, flags)
#endif
/**
* @def UNIMPLEMENTED
* @brief The UNIMPLEMENTED macro is used to define a GPIO that doesn't actually exist.
*
* Some GPIO names are well known and used by generic code, ENTERING_RW and WP_L
* are examples. If a particular board doesn't have a GPIO assigned to such a
* function/name then it should specify that that GPIO is not implemented using
* the UNIMPLEMENTED macro below in the board gpio.inc file. This macro creates
* an entry in the gpio_signal enum and the gpio_list array that is initialized
* to use the DUMMY_GPIO_BANK and a bitmask of zero. The chip GPIO layer is
* implemented such that writes to and reads from DUMMY_GPIO_BANK with a bitmask
* of zero are harmless.
*
* This allows common code that expects these GPIOs to exist to compile and have
* some reduced functionality.
*/
#ifndef UNIMPLEMENTED
#define UNIMPLEMENTED(name)
#endif
/*
* RO/RW pin macro.
*
* Some boards may have very different pin configurations between RO and RW, and
* also may vary from revision to revision. The RO/RW pin macros can ease the
* maintenance effort.
*/
#ifdef SECTION_IS_RO
#define GPIO_RO(name, pin, flags) GPIO(name, pin, flags)
#define GPIO_RW(name, pin, flags)
#define GPIO_INT_RO(name, pin, flags, signal) GPIO_INT(name, pin, flags, signal)
#define GPIO_INT_RW(name, pin, flags, signal)
#define ALTERNATE_RO(pinmask, function, module, flags) \
ALTERNATE(pinmask, function, module, flags)
#define ALTERNATE_RW(pinmask, function, module, flags)
#define UNIMPLEMENTED_RO(name) UNIMPLEMENTED(name)
#define UNIMPLEMENTED_RW(name)
#elif defined(SECTION_IS_RW)
#define GPIO_RO(name, pin, flags)
#define GPIO_RW(name, pin, flags) GPIO(name, pin, flags)
#define GPIO_INT_RO(name, pin, flags, signal)
#define GPIO_INT_RW(name, pin, flags, signal) GPIO_INT(name, pin, flags, signal)
#define ALTERNATE_RO(pinmask, function, module, flags)
#define ALTERNATE_RW(pinmask, function, module, flags) \
ALTERNATE(pinmask, function, module, flags)
#define UNIMPLEMENTED_RO(name)
#define UNIMPLEMENTED_RW(name) UNIMPLEMENTED(name)
#else
#define GPIO_RO(name, pin, flags) GPIO(name, pin, flags)
#define GPIO_RW(name, pin, flags) GPIO(name, pin, flags)
#define GPIO_INT_RO(name, pin, flags, signal) GPIO_INT(name, pin, flags, signal)
#define GPIO_INT_RW(name, pin, flags, signal) GPIO_INT(name, pin, flags, signal)
#define ALTERNATE_RO(pinmask, function, module, flags) \
ALTERNATE(pinmask, function, module, flags)
#define ALTERNATE_RW(pinmask, function, module, flags) \
ALTERNATE(pinmask, function, module, flags)
#define UNIMPLEMENTED_RO(name) UNIMPLEMENTED(name)
#define UNIMPLEMENTED_RW(name) UNIMPLEMENTED(name)
#endif
#ifndef IOEX
#define IOEX(name, expin, flags)
#endif
#ifndef IOEX_INT
#define IOEX_INT(name, expin, flags, signal)
#endif
#include "gpio.inc"
/*
* Once the gpio.inc file has been included these macros are no longer needed.
*/
#undef GPIO
#undef GPIO_RO
#undef GPIO_RW
#undef GPIO_INT
#undef GPIO_INT_RO
#undef GPIO_INT_RW
#undef ALTERNATE
#undef ALTERNATE_RO
#undef ALTERNATE_RW
#undef UNIMPLEMENTED
#undef UNIMPLEMENTED_RO
#undef UNIMPLEMENTED_RW
#undef IOEX
#undef IOEX_INT
|
