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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
|
/*
* This file is part of the coreboot project.
*
* Copyright 2016 Google Inc.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 2 of the License.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*/
#ifndef __ACPI_DEVICE_H
#define __ACPI_DEVICE_H
#include <device/i2c.h>
#include <stdint.h>
#define ACPI_DESCRIPTOR_LARGE (1 << 7)
#define ACPI_DESCRIPTOR_INTERRUPT (ACPI_DESCRIPTOR_LARGE | 9)
#define ACPI_DESCRIPTOR_GPIO (ACPI_DESCRIPTOR_LARGE | 12)
#define ACPI_DESCRIPTOR_SERIAL_BUS (ACPI_DESCRIPTOR_LARGE | 14)
struct device;
const char *acpi_device_name(struct device *dev);
const char *acpi_device_path(struct device *dev);
const char *acpi_device_scope(struct device *dev);
const char *acpi_device_path_join(struct device *dev, const char *name);
/*
* ACPI Descriptor for extended Interrupt()
*/
enum irq_mode {
IRQ_EDGE_TRIGGERED,
IRQ_LEVEL_TRIGGERED
};
enum irq_polarity {
IRQ_ACTIVE_LOW,
IRQ_ACTIVE_HIGH,
IRQ_ACTIVE_BOTH
};
enum irq_shared {
IRQ_EXCLUSIVE,
IRQ_SHARED
};
enum irq_wake {
IRQ_NO_WAKE,
IRQ_WAKE
};
struct acpi_irq {
unsigned int pin;
enum irq_mode mode;
enum irq_polarity polarity;
enum irq_shared shared;
enum irq_wake wake;
};
#define IRQ_EDGE_LOW(x) { \
.pin = (x), \
.mode = IRQ_EDGE_TRIGGERED, \
.polarity = IRQ_ACTIVE_LOW, \
.shared = IRQ_EXCLUSIVE, \
.wake = IRQ_NO_WAKE }
#define IRQ_EDGE_HIGH(x) { \
.pin = (x), \
.mode = IRQ_EDGE_TRIGGERED, \
.polarity = IRQ_ACTIVE_HIGH, \
.shared = IRQ_EXCLUSIVE, \
.wake = IRQ_NO_WAKE }
#define IRQ_LEVEL_LOW(x) { \
.pin = (x), \
.mode = IRQ_LEVEL_TRIGGERED, \
.polarity = IRQ_ACTIVE_LOW, \
.shared = IRQ_SHARED, \
.wake = IRQ_NO_WAKE }
/* Write extended Interrupt() descriptor to SSDT AML output */
void acpi_device_write_interrupt(const struct acpi_irq *irq);
/*
* ACPI Descriptors for GpioIo() and GpioInterrupt()
*/
enum acpi_gpio_type {
ACPI_GPIO_TYPE_INTERRUPT,
ACPI_GPIO_TYPE_IO
};
enum acpi_gpio_pull {
ACPI_GPIO_PULL_DEFAULT,
ACPI_GPIO_PULL_UP,
ACPI_GPIO_PULL_DOWN,
ACPI_GPIO_PULL_NONE
};
enum acpi_gpio_io_restrict {
ACPI_GPIO_IO_RESTRICT_NONE,
ACPI_GPIO_IO_RESTRICT_INPUT,
ACPI_GPIO_IO_RESTRICT_OUTPUT,
ACPI_GPIO_IO_RESTRICT_PRESERVE
};
enum acpi_gpio_polarity {
ACPI_GPIO_ACTIVE_HIGH = 0,
ACPI_GPIO_ACTIVE_LOW = 1,
};
#define ACPI_GPIO_REVISION_ID 1
#define ACPI_GPIO_MAX_PINS 8
struct acpi_gpio {
int pin_count;
uint16_t pins[ACPI_GPIO_MAX_PINS];
enum acpi_gpio_type type;
enum acpi_gpio_pull pull;
const char *resource;
/* GpioInt */
uint16_t interrupt_debounce_timeout; /* 1/100 ms */
struct acpi_irq irq;
/* GpioIo */
uint16_t output_drive_strength; /* 1/100 mA */
int io_shared;
enum acpi_gpio_io_restrict io_restrict;
enum acpi_gpio_polarity polarity;
};
/* Basic output GPIO with default pull settings */
#define ACPI_GPIO_OUTPUT_ACTIVE_HIGH(gpio) { \
.type = ACPI_GPIO_TYPE_IO, \
.pull = ACPI_GPIO_PULL_DEFAULT, \
.io_restrict = ACPI_GPIO_IO_RESTRICT_OUTPUT, \
.polarity = ACPI_GPIO_ACTIVE_HIGH, \
.pin_count = 1, \
.pins = { (gpio) } }
#define ACPI_GPIO_OUTPUT_ACTIVE_LOW(gpio) { \
.type = ACPI_GPIO_TYPE_IO, \
.pull = ACPI_GPIO_PULL_DEFAULT, \
.io_restrict = ACPI_GPIO_IO_RESTRICT_OUTPUT, \
.polarity = ACPI_GPIO_ACTIVE_LOW, \
.pin_count = 1, \
.pins = { (gpio) } }
/* Basic input GPIO with default pull settings */
#define ACPI_GPIO_INPUT(gpio) { \
.type = ACPI_GPIO_TYPE_IO, \
.pull = ACPI_GPIO_PULL_DEFAULT, \
.io_restrict = ACPI_GPIO_IO_RESTRICT_INPUT, \
.pin_count = 1, \
.pins = { (gpio) } }
/* Basic interrupt GPIO with default pull settings */
#define ACPI_GPIO_INTERRUPT(gpio,mode,polarity) { \
.type = ACPI_GPIO_TYPE_INTERRUPT, \
.pull = ACPI_GPIO_PULL_DEFAULT, \
.irq.mode = (mode), \
.irq.polarity = (polarity), \
.pin_count = 1, \
.pins = { (gpio) } }
/* Write GpioIo() or GpioInt() descriptor to SSDT AML output */
void acpi_device_write_gpio(const struct acpi_gpio *gpio);
/*
* ACPI Descriptors for Serial Bus interfaces
*/
#define ACPI_SERIAL_BUS_TYPE_I2C 1
#define ACPI_SERIAL_BUS_TYPE_SPI 2
#define ACPI_SERIAL_BUS_REVISION_ID 1
/*
* ACPI I2C Bus
*/
struct acpi_i2c {
/* I2C Address */
uint16_t address;
/* 7 or 10 bit Address Mode */
enum i2c_address_mode mode_10bit;
/* I2C Bus Speed in Hz */
enum i2c_speed speed;
/* Reference to I2C controller */
const char *resource;
};
/* Write I2cSerialBus() descriptor to SSDT AML output */
void acpi_device_write_i2c(const struct acpi_i2c *i2c);
/*
* ACPI SPI Bus
*/
enum spi_clock_phase {
SPI_CLOCK_PHASE_FIRST,
SPI_CLOCK_PHASE_SECOND
};
/* SPI Flags bit 0 */
enum spi_wire_mode {
SPI_4_WIRE_MODE,
SPI_3_WIRE_MODE
};
/* SPI Flags bit 1 */
enum spi_polarity {
SPI_POLARITY_LOW,
SPI_POLARITY_HIGH
};
struct acpi_spi {
/* Device selection */
uint16_t device_select;
/* Device selection line is active high or low */
enum spi_polarity device_select_polarity;
/* 3 or 4 wire SPI connection */
enum spi_wire_mode wire_mode;
/* Connection speed in HZ */
unsigned int speed;
/* Size in bits of smallest transfer unit */
u8 data_bit_length;
/* Phase of clock pulse on which to capture data */
enum spi_clock_phase clock_phase;
/* Indicate if clock is high or low during first phase */
enum spi_polarity clock_polarity;
/* Reference to SPI controller */
const char *resource;
};
/* Write SPI Bus descriptor to SSDT AML output */
void acpi_device_write_spi(const struct acpi_spi *spi);
/*
* Writing Device Properties objects via _DSD
*
* http://uefi.org/sites/default/files/resources/_DSD-device-properties-UUID.pdf
* http://uefi.org/sites/default/files/resources/_DSD-hierarchical-data-extension-UUID-v1.pdf
*
* The Device Property Hierarchy can be multiple levels deep with multiple
* children possible in each level. In order to support this flexibility
* the device property hierarchy must be built up before being written out.
*
* For example:
*
* // Child table with string and integer
* struct acpi_dp *child = acpi_dp_new_table("CHLD");
* acpi_dp_add_string(child, "childstring", "CHILD");
* acpi_dp_add_integer(child, "childint", 100);
*
* // _DSD table with integer and gpio and child pointer
* struct acpi_dp *dsd = acpi_dp_new_table("_DSD");
* acpi_dp_add_integer(dsd, "number1", 1);
* acpi_dp_add_gpio(dsd, "gpio", "\_SB.PCI0.GPIO", 0, 0, 1);
* acpi_dp_add_child(dsd, "child", child);
*
* // Write entries into SSDT and clean up resources
* acpi_dp_write(dsd);
*
* Name(_DSD, Package() {
* ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301")
* Package() {
* Package() { "gpio", Package() { \_SB.PCI0.GPIO, 0, 0, 0 } }
* Package() { "number1", 1 }
* }
* ToUUID("dbb8e3e6-5886-4ba6-8795-1319f52a966b")
* Package() {
* Package() { "child", CHLD }
* }
* }
* Name(CHLD, Package() {
* ToUUID("daffd814-6eba-4d8c-8a91-bc9bbf4aa301")
* Package() {
* Package() { "childstring", "CHILD" }
* Package() { "childint", 100 }
* }
* }
*/
struct acpi_dp;
/* Start a new Device Property table with provided ACPI reference */
struct acpi_dp *acpi_dp_new_table(const char *ref);
/* Add integer Device Property */
struct acpi_dp *acpi_dp_add_integer(struct acpi_dp *dp, const char *name,
uint64_t value);
/* Add string Device Property */
struct acpi_dp *acpi_dp_add_string(struct acpi_dp *dp, const char *name,
const char *string);
/* Add ACPI reference Device Property */
struct acpi_dp *acpi_dp_add_reference(struct acpi_dp *dp, const char *name,
const char *reference);
/* Add an array of Device Properties */
struct acpi_dp *acpi_dp_add_array(struct acpi_dp *dp, struct acpi_dp *array);
/* Add an array of integers Device Property */
struct acpi_dp *acpi_dp_add_integer_array(struct acpi_dp *dp, const char *name,
uint64_t *array, int len);
/* Add a GPIO binding Device Property */
struct acpi_dp *acpi_dp_add_gpio(struct acpi_dp *dp, const char *name,
const char *ref, int index, int pin,
int active_low);
/* Add a child table of Device Properties */
struct acpi_dp *acpi_dp_add_child(struct acpi_dp *dp, const char *name,
struct acpi_dp *child);
/* Write Device Property hierarchy and clean up resources */
void acpi_dp_write(struct acpi_dp *table);
#endif
|