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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
/* Copyright (c) 2012 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.
*/
/* GPIO module for Chrome EC */
#ifndef __CROS_EC_GPIO_H
#define __CROS_EC_GPIO_H
#include "common.h"
/* Flag definitions for gpio_info and gpio_alt_func */
/* The following are valid for both gpio_info and gpio_alt_func: */
#define GPIO_OPEN_DRAIN (1 << 0) /* Output type is open-drain */
#define GPIO_PULL_UP (1 << 1) /* Enable on-chip pullup */
#define GPIO_PULL_DOWN (1 << 2) /* Enable on-chip pulldown */
/* The following are valid for gpio_alt_func only */
#define GPIO_ANALOG (1 << 3) /* Set pin to analog-mode */
/* The following are valid for gpio_info only */
#define GPIO_INPUT (1 << 4) /* Input */
#define GPIO_OUTPUT (1 << 5) /* Output */
#define GPIO_LOW (1 << 6) /* If GPIO_OUTPUT, set level low */
#define GPIO_HIGH (1 << 7) /* If GPIO_OUTPUT, set level high */
#define GPIO_INT_F_RISING (1 << 8) /* Interrupt on rising edge */
#define GPIO_INT_F_FALLING (1 << 9) /* Interrupt on falling edge */
#define GPIO_INT_F_LOW (1 << 11) /* Interrupt on low level */
#define GPIO_INT_F_HIGH (1 << 12) /* Interrupt on high level */
#define GPIO_DEFAULT (1 << 13) /* Don't set up on boot */
#define GPIO_INT_DSLEEP (1 << 14) /* Interrupt in deep sleep */
#define GPIO_INT_SHARED (1 << 15) /* Shared among multiple pins */
/* Common flag combinations */
#define GPIO_OUT_LOW (GPIO_OUTPUT | GPIO_LOW)
#define GPIO_OUT_HIGH (GPIO_OUTPUT | GPIO_HIGH)
#define GPIO_ODR_HIGH (GPIO_OUTPUT | GPIO_OPEN_DRAIN | GPIO_HIGH)
#define GPIO_ODR_LOW (GPIO_OUTPUT | GPIO_OPEN_DRAIN | GPIO_LOW)
#define GPIO_INT_RISING (GPIO_INPUT | GPIO_INT_F_RISING)
#define GPIO_INT_FALLING (GPIO_INPUT | GPIO_INT_F_FALLING)
/* TODO(crosbug.com/p/24204): "EDGE" would have been clearer than "BOTH". */
#define GPIO_INT_BOTH (GPIO_INT_RISING | GPIO_INT_FALLING)
#define GPIO_INT_LOW (GPIO_INPUT | GPIO_INT_F_LOW)
#define GPIO_INT_HIGH (GPIO_INPUT | GPIO_INT_F_HIGH)
#define GPIO_INT_LEVEL (GPIO_INT_LOW | GPIO_INT_HIGH)
#define GPIO_INT_ANY (GPIO_INT_BOTH | GPIO_INT_LEVEL)
#define GPIO_INT_BOTH_DSLEEP (GPIO_INT_BOTH | GPIO_INT_DSLEEP)
/* GPIO signal definition structure, for use by board.c */
struct gpio_info {
/* Signal name */
const char *name;
/* Port base address */
uint32_t port;
/* Bitmask on that port (1 << N; 0 = signal not implemented) */
int mask;
/* Flags (GPIO_*; see above) */
uint32_t flags;
/*
* Interrupt handler. If non-NULL, and the signal's interrupt is
* enabled, this will be called in the context of the GPIO interrupt
* handler.
*/
void (*irq_handler)(enum gpio_signal signal);
};
/* Signal information from board.c. Must match order from enum gpio_signal. */
extern const struct gpio_info gpio_list[];
/*
* Define the storage size for the pin muxing information.
*
* int8_t is more optimal for storage size and alignment,
* but some chips require to store more information.
*/
#ifdef CONFIG_GPIO_LARGE_ALT_INFO
typedef uint32_t alt_func_t;
#else
typedef int8_t alt_func_t;
#endif
/* GPIO alternate function structure, for use by board.c */
struct gpio_alt_func {
/* Port base address */
uint32_t port;
/* Bitmask on that port (multiple bits allowed) */
uint32_t mask;
/* Alternate function number */
alt_func_t func;
/* Module ID (as uint8_t, since enum would be 32-bit) */
uint8_t module_id;
/* Flags (GPIO_*; see above). */
uint16_t flags;
};
extern const struct gpio_alt_func gpio_alt_funcs[];
extern const int gpio_alt_funcs_count;
/**
* Pre-initialize GPIOs.
*
* This occurs before clocks or tasks are set up.
*/
void gpio_pre_init(void);
/**
* Configure GPIO pin functions for a module.
*
* @param id Module ID to initialize
* @param enable Enable alternate functions if 1; high-Z pins if 0.
*/
void gpio_config_module(enum module_id id, int enable);
/**
* Get the current value of a signal.
*
* @param signal Signal to get
* @return 0 if low, 1 if high.
*/
int gpio_get_level(enum gpio_signal signal);
/**
* Get faster access to a GPIO level.
*
* Use this function to find out the register address and mask for a GPIO
* value. Then you can just check that instead of calling gpio_get_level().
*
* @param signal Signal to return details for
* @param mask Mask value to use
* @return pointer to register to read to get GPIO value
*/
uint16_t *gpio_get_level_reg(enum gpio_signal signal, uint32_t *mask);
/**
* Return the name of a given GPIO signal.
*
* @param signal Signal to name
* @returns name of the given signal
*/
const char *gpio_get_name(enum gpio_signal signal);
/**
* Set the flags for a signal.
*
* @param signal Signal to set flags for
* @param flags New flags for the signal
*/
void gpio_set_flags(enum gpio_signal signal, int flags);
/**
* Set the value of a signal.
*
* @param signal Signal to set
* @param value New value for signal (0 = low, != high */
void gpio_set_level(enum gpio_signal signal, int value);
/**
* Enable interrupts for the signal.
*
* The signal must have been defined with
* an interrupt handler. Normally called by the module which handles the
* interrupt, once it's ready to start processing interrupts.
*
* @param signal Signal to enable interrrupts for
* @return EC_SUCCESS, or non-zero if error.
*/
int gpio_enable_interrupt(enum gpio_signal signal);
/**
* Disable interrupts for the signal.
*
* The signal must have been defined with
* an interrupt handler. Normally called by the module which handles the
* interrupt, if it doesn't want to process interrupts.
*
* @param signal Signal to disable interrupts for
* @return EC_SUCCESS, or non-zero if error.
*/
int gpio_disable_interrupt(enum gpio_signal signal);
/**
* Set flags for GPIO(s) by port and mask.
*
* Use gpio_set_flags() to set flags for an individual GPIO by id.
*
* Note that modules should usually declare their GPIO alternate functions in
* gpio_alt_funcs[] and call gpio_init_module() instead of calling this
* directly.
*
* @param port GPIO port to set (GPIO_*)
* @param mask Bitmask of pins on that port to affect
* @param flags Flags (GPIO_*; see above)
*/
void gpio_set_flags_by_mask(uint32_t port, uint32_t mask, uint32_t flags);
/**
* Set alternate function for GPIO(s).
*
* Note that modules should usually declare their GPIO alternate functions in
* gpio_alt_funcs[] and call gpio_init_module() instead of calling this
* directly.
*
* @param port GPIO port to set (GPIO_*)
* @param mask Bitmask of pins on that port to affect
* @param func Alternate function; if <0, configures the specified
* GPIOs for normal GPIO operation.
*/
void gpio_set_alternate_function(uint32_t port, uint32_t mask, int func);
/**
* Return true if the EC is warm booting.
*
* This function is used by the GPIO implementation and should not be called
* outside of that context.
*/
int gpio_is_reboot_warm(void);
/**
* Enable GPIO peripheral clocks.
*
* This function is used by the GPIO implementation and should not be called
* outside of that context.
*/
void gpio_enable_clocks(void);
#endif /* __CROS_EC_GPIO_H */
|
