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__)
33 /** enum acpi_dump_option - selects what ACPI information to dump */
34 enum acpi_dump_option {
35 ACPI_DUMP_LIST, /* Just the list of items */
36 ACPI_DUMP_CONTENTS, /* Include the binary contents also */
40 * struct acpi_ctx - Context used for writing ACPI tables
42 * This contains a few useful pieces of information used when writing
44 * @base: Base address of ACPI tables
45 * @current: Current address for writing
46 * @rsdp: Pointer to the Root System Description Pointer, typically used when
47 * adding a new table. The RSDP holds pointers to the RSDT and XSDT.
48 * @rsdt: Pointer to the Root System Description Table
49 * @xsdt: Pointer to the Extended System Description Table
50 * @nhlt: Intel Non-High-Definition-Audio Link Table (NHLT) pointer, used to
51 * build up information that audio codecs need to provide in the NHLT ACPI
53 * @len_stack: Stack of 'length' words to fix up later
54 * @ltop: Points to current top of stack (0 = empty)
59 struct acpi_rsdp *rsdp;
60 struct acpi_rsdt *rsdt;
61 struct acpi_xsdt *xsdt;
63 char *len_stack[ACPIGEN_LENSTACK_SIZE];
68 * struct acpi_ops - ACPI operations supported by driver model
72 * get_name() - Obtain the ACPI name of a device
74 * @dev: Device to check
75 * @out_name: Place to put the name, must hold at least ACPI_NAME_MAX
77 * @return 0 if OK, -ENOENT if no name is available, other -ve value on
80 int (*get_name)(const struct udevice *dev, char *out_name);
83 * write_tables() - Write out any tables required by this device
85 * @dev: Device to write
86 * @ctx: ACPI context to use
87 * @return 0 if OK, -ve on error
89 int (*write_tables)(const struct udevice *dev, struct acpi_ctx *ctx);
92 * fill_ssdt() - Generate SSDT code for a device
94 * This is called to create the SSDT code. The method should write out
95 * whatever ACPI code is needed by this device. It will end up in the
98 * Note that this is called 'fill' because the entire contents of the
99 * SSDT is build by calling this method on all devices.
101 * @dev: Device to write
102 * @ctx: ACPI context to use
103 * @return 0 if OK, -ve on error
105 int (*fill_ssdt)(const struct udevice *dev, struct acpi_ctx *ctx);
108 * inject_dsdt() - Generate DSDT code for a device
110 * This is called to create the DSDT code. The method should write out
111 * whatever ACPI code is needed by this device. It will end up in the
114 * Note that this is called 'inject' because the output of calling this
115 * method on all devices is injected into the DSDT, the bulk of which
116 * is written in .asl files for the board.
118 * @dev: Device to write
119 * @ctx: ACPI context to use
120 * @return 0 if OK, -ve on error
122 int (*inject_dsdt)(const struct udevice *dev, struct acpi_ctx *ctx);
125 * setup_nhlt() - Set up audio information for this device
127 * The method can add information to ctx->nhlt if it likes
129 * @return 0 if OK, -ENODATA if nothing to add, -ve on error
131 int (*setup_nhlt)(const struct udevice *dev, struct acpi_ctx *ctx);
134 #define device_get_acpi_ops(dev) ((dev)->driver->acpi_ops)
137 * acpi_get_name() - Obtain the ACPI name of a device
139 * @dev: Device to check
140 * @out_name: Place to put the name, must hold at least ACPI_NAME_MAX
142 * Return: 0 if OK, -ENOENT if no name is available, other -ve value on
145 int acpi_get_name(const struct udevice *dev, char *out_name);
148 * acpi_copy_name() - Copy an ACPI name to an output buffer
150 * This convenience function can be used to return a literal string as a name
151 * in functions that implement the get_name() method.
155 * static int mydev_get_name(const struct udevice *dev, char *out_name)
157 * return acpi_copy_name(out_name, "WIBB");
160 * @out_name: Place to put the name
161 * @name: Name to copy
164 int acpi_copy_name(char *out_name, const char *name);
167 * acpi_write_dev_tables() - Write ACPI tables required by devices
169 * This scans through all devices and tells them to write any tables they want
172 * Return: 0 if OK, -ve if any device returned an error
174 int acpi_write_dev_tables(struct acpi_ctx *ctx);
177 * acpi_fill_ssdt() - Generate ACPI tables for SSDT
179 * This is called to create the SSDT code for all devices.
181 * @ctx: ACPI context to use
182 * Return: 0 if OK, -ve on error
184 int acpi_fill_ssdt(struct acpi_ctx *ctx);
187 * acpi_inject_dsdt() - Generate ACPI tables for DSDT
189 * This is called to create the DSDT code for all devices.
191 * @ctx: ACPI context to use
192 * Return: 0 if OK, -ve on error
194 int acpi_inject_dsdt(struct acpi_ctx *ctx);
197 * acpi_setup_nhlt() - Set up audio information
199 * This is called to set up the nhlt information for all devices.
201 * @ctx: ACPI context to use
202 * @nhlt: Pointer to nhlt information to add to
203 * Return: 0 if OK, -ve on error
205 int acpi_setup_nhlt(struct acpi_ctx *ctx, struct nhlt *nhlt);
208 * acpi_dump_items() - Dump out the collected ACPI items
210 * This lists the ACPI DSDT and SSDT items generated by the various U-Boot
213 * @option: Sets what should be dumpyed
215 void acpi_dump_items(enum acpi_dump_option option);
218 * acpi_get_path() - Get the full ACPI path for a device
220 * This checks for any override in the device tree and calls acpi_device_path()
223 * @dev: Device to check
224 * @out_path: Buffer to place the path in (should be ACPI_PATH_MAX long)
225 * @maxlen: Size of buffer (typically ACPI_PATH_MAX)
226 * Return: 0 if OK, -ve on error
228 int acpi_get_path(const struct udevice *dev, char *out_path, int maxlen);
231 * acpi_reset_items() - Reset the list of ACPI items to empty
233 * This list keeps track of DSDT and SSDT items that are generated
234 * programmatically. The 'acpi items' command shows the list. Use this function
235 * to empty the list, before writing new items.
237 void acpi_reset_items(void);
239 #endif /* __ACPI__ */