1 /* SPDX-License-Identifier: GPL-2.0+ */
3 * Core ACPI (Advanced Configuration and Power Interface) support
5 * Copyright 2019 Google LLC
6 * Written by Simon Glass <sjg@chromium.org>
12 /* Allow operations to be optional for ACPI */
13 #if CONFIG_IS_ENABLED(ACPIGEN)
14 #define ACPI_OPS_PTR(_ptr) .acpi_ops = _ptr,
16 #define ACPI_OPS_PTR(_ptr)
19 /* Length of an ACPI name string, excluding null terminator */
20 #define ACPI_NAME_LEN 4
22 /* Length of an ACPI name string including nul terminator */
23 #define ACPI_NAME_MAX (ACPI_NAME_LEN + 1)
25 /* Number of nested objects supported */
26 #define ACPIGEN_LENSTACK_SIZE 10
28 #if !defined(__ACPI__)
30 #include <linker_lists.h>
35 /** enum acpi_dump_option - selects what ACPI information to dump */
36 enum acpi_dump_option {
37 ACPI_DUMP_LIST, /* Just the list of items */
38 ACPI_DUMP_CONTENTS, /* Include the binary contents also */
42 * struct acpi_ctx - Context used for writing ACPI tables
44 * This contains a few useful pieces of information used when writing
46 * @base: Base address of ACPI tables
47 * @current: Current address for writing
48 * @tab_start: Address of start of the table being written. This is set up
49 * before the writer or driver method is called. It must not be changed by the
51 * @rsdp: Pointer to the Root System Description Pointer, typically used when
52 * adding a new table. The RSDP holds pointers to the RSDT and XSDT.
53 * @rsdt: Pointer to the Root System Description Table
54 * @xsdt: Pointer to the Extended System Description Table
55 * @nhlt: Intel Non-High-Definition-Audio Link Table (NHLT) pointer, used to
56 * build up information that audio codecs need to provide in the NHLT ACPI
58 * @len_stack: Stack of 'length' words to fix up later
59 * @ltop: Points to current top of stack (0 = empty)
65 struct acpi_rsdp *rsdp;
66 struct acpi_rsdt *rsdt;
67 struct acpi_xsdt *xsdt;
69 char *len_stack[ACPIGEN_LENSTACK_SIZE];
74 * enum acpi_writer_flags_t - flags to use for the ACPI writers
76 * ACPIWF_ALIGN64 - align to 64 bytes after writing this one (default is 16)
78 enum acpi_writer_flags_t {
79 ACPIWF_ALIGN64 = 1 << 0,
85 * acpi_writer_func() - Function that can write an ACPI table
87 * @ctx: ACPI context to use for writing
88 * @entry: Linker-list entry for this writer
89 * @return 0 if OK, -ve on error
91 typedef int (*acpi_writer_func)(struct acpi_ctx *ctx,
92 const struct acpi_writer *entry);
95 * struct acpi_writer - an ACPI table that can be written
97 * @name: Name of the writer
98 * @table: Table name that is generated (e.g. "DSDT")
99 * @h_write: Writer function
104 acpi_writer_func h_write;
108 /* Declare a new ACPI-table writer */
109 #define ACPI_WRITER(_name, _table, _write, _flags) \
110 ll_entry_declare(struct acpi_writer, _name, acpi_writer) = { \
117 /* Get a pointer to a given ACPI-table writer */
118 #define ACPI_WRITER_GET(_name) \
119 ll_entry_get(struct acpi_writer, _name, acpi_writer)
122 * struct acpi_ops - ACPI operations supported by driver model
126 * get_name() - Obtain the ACPI name of a device
128 * @dev: Device to check
129 * @out_name: Place to put the name, must hold at least ACPI_NAME_MAX
131 * @return 0 if OK, -ENOENT if no name is available, other -ve value on
134 int (*get_name)(const struct udevice *dev, char *out_name);
137 * write_tables() - Write out any tables required by this device
139 * @dev: Device to write
140 * @ctx: ACPI context to use
141 * @return 0 if OK, -ve on error
143 int (*write_tables)(const struct udevice *dev, struct acpi_ctx *ctx);
146 * fill_ssdt() - Generate SSDT code for a device
148 * This is called to create the SSDT code. The method should write out
149 * whatever ACPI code is needed by this device. It will end up in the
152 * Note that this is called 'fill' because the entire contents of the
153 * SSDT is build by calling this method on all devices.
155 * @dev: Device to write
156 * @ctx: ACPI context to use
157 * @return 0 if OK, -ve on error
159 int (*fill_ssdt)(const struct udevice *dev, struct acpi_ctx *ctx);
162 * inject_dsdt() - Generate DSDT code for a device
164 * This is called to create the DSDT code. The method should write out
165 * whatever ACPI code is needed by this device. It will end up in the
168 * Note that this is called 'inject' because the output of calling this
169 * method on all devices is injected into the DSDT, the bulk of which
170 * is written in .asl files for the board.
172 * @dev: Device to write
173 * @ctx: ACPI context to use
174 * @return 0 if OK, -ve on error
176 int (*inject_dsdt)(const struct udevice *dev, struct acpi_ctx *ctx);
179 * setup_nhlt() - Set up audio information for this device
181 * The method can add information to ctx->nhlt if it likes
183 * @return 0 if OK, -ENODATA if nothing to add, -ve on error
185 int (*setup_nhlt)(const struct udevice *dev, struct acpi_ctx *ctx);
188 #define device_get_acpi_ops(dev) ((dev)->driver->acpi_ops)
191 * acpi_get_name() - Obtain the ACPI name of a device
193 * @dev: Device to check
194 * @out_name: Place to put the name, must hold at least ACPI_NAME_MAX
196 * Return: 0 if OK, -ENOENT if no name is available, other -ve value on
199 int acpi_get_name(const struct udevice *dev, char *out_name);
202 * acpi_copy_name() - Copy an ACPI name to an output buffer
204 * This convenience function can be used to return a literal string as a name
205 * in functions that implement the get_name() method.
209 * static int mydev_get_name(const struct udevice *dev, char *out_name)
211 * return acpi_copy_name(out_name, "WIBB");
214 * @out_name: Place to put the name
215 * @name: Name to copy
218 int acpi_copy_name(char *out_name, const char *name);
221 * acpi_write_dev_tables() - Write ACPI tables required by devices
223 * This scans through all devices and tells them to write any tables they want
226 * Return: 0 if OK, -ve if any device returned an error
228 int acpi_write_dev_tables(struct acpi_ctx *ctx);
231 * acpi_fill_ssdt() - Generate ACPI tables for SSDT
233 * This is called to create the SSDT code for all devices.
235 * @ctx: ACPI context to use
236 * Return: 0 if OK, -ve on error
238 int acpi_fill_ssdt(struct acpi_ctx *ctx);
241 * acpi_inject_dsdt() - Generate ACPI tables for DSDT
243 * This is called to create the DSDT code for all devices.
245 * @ctx: ACPI context to use
246 * Return: 0 if OK, -ve on error
248 int acpi_inject_dsdt(struct acpi_ctx *ctx);
251 * acpi_setup_nhlt() - Set up audio information
253 * This is called to set up the nhlt information for all devices.
255 * @ctx: ACPI context to use
256 * @nhlt: Pointer to nhlt information to add to
257 * Return: 0 if OK, -ve on error
259 int acpi_setup_nhlt(struct acpi_ctx *ctx, struct nhlt *nhlt);
262 * acpi_dump_items() - Dump out the collected ACPI items
264 * This lists the ACPI DSDT and SSDT items generated by the various U-Boot
267 * @option: Sets what should be dumpyed
269 void acpi_dump_items(enum acpi_dump_option option);
272 * acpi_get_path() - Get the full ACPI path for a device
274 * This checks for any override in the device tree and calls acpi_device_path()
277 * @dev: Device to check
278 * @out_path: Buffer to place the path in (should be ACPI_PATH_MAX long)
279 * @maxlen: Size of buffer (typically ACPI_PATH_MAX)
280 * Return: 0 if OK, -ve on error
282 int acpi_get_path(const struct udevice *dev, char *out_path, int maxlen);
285 * acpi_reset_items() - Reset the list of ACPI items to empty
287 * This list keeps track of DSDT and SSDT items that are generated
288 * programmatically. The 'acpi items' command shows the list. Use this function
289 * to empty the list, before writing new items.
291 void acpi_reset_items(void);
294 * acpi_write_one() - Call a single ACPI writer entry
296 * This handles aligning the context afterwards, if the entry flags indicate
299 * @ctx: ACPI context to use
300 * @entry: Entry to call
301 * @return 0 if OK, -ENOENT if this writer produced an empty entry, other -ve
304 int acpi_write_one(struct acpi_ctx *ctx, const struct acpi_writer *entry);
307 * acpi_setup_ctx() - Set up a new ACPI context
309 * This zeros the context and sets up the base and current pointers, ensuring
310 * that they are aligned. Then it writes the acpi_start and acpi_ctx values in
313 * @ctx: ACPI context to set up
314 * @start: Start address for ACPI table
316 void acpi_setup_ctx(struct acpi_ctx *ctx, ulong start);
319 * acpi_write_one() - Call a single ACPI writer entry
321 * This handles aligning the context afterwards, if the entry flags indicate
324 * @ctx: ACPI context to use
325 * @entry: Entry to call
326 * @return 0 if OK, -ENOENT if this writer produced an empty entry, other -ve
329 int acpi_write_one(struct acpi_ctx *ctx, const struct acpi_writer *entry);
331 #endif /* __ACPI__ */