include/acpi/acpi.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSBSPsX8664AMD64
0007  *
0008  * @ingroup RTEMSBSPsX8664AMD64EFI
0009  *
0010  * @brief ACPI header file
0011  */
0012
0013 /*
0014  * Copyright (C) 2024 Matheus Pecoraro
0015  *
0016  * Redistribution and use in source and binary forms, with or without
0017  * modification, are permitted provided that the following conditions
0018  * are met:
0019  * 1. Redistributions of source code must retain the above copyright
0020  *    notice, this list of conditions and the following disclaimer.
0021  * 2. Redistributions in binary form must reproduce the above copyright
0022  *    notice, this list of conditions and the following disclaimer in the
0023  *    documentation and/or other materials provided with the distribution.
0024  *
0025  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0026  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0027  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0028  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0029  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0030  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0031  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0032  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0033  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0034  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0035  * POSSIBILITY OF SUCH DAMAGE.
0036  */
0037
0038 #ifndef _AMD64_ACPI_H_
0039 #define _AMD64_ACPI_H_
0040
0041 #include <bsp.h>
0042 #include <acpi/acpica/acpi.h>
0043
0044 #define ACPI_MAX_INIT_TABLES 16
0045
0046 extern uint64_t acpi_rsdp_addr;
0047
0048 /**
0049  * @brief Initializes the ACPICA Table Manager. Requires dynamic memory.
0050  *
0051  * The ACPICA Table Manager is independent of the rest of the ACPICA subsystem
0052  * and only requires dynamic memory to be initialized (unless a statically
0053  * allocated array for the tables is provided). Since access to ACPI tables
0054  * may be required before the entire ACPICA subsystem can be initialized
0055  * this routine can be used earlier in the system intialization.
0056  *
0057  * @return true if successful.
0058  */
0059 bool acpi_tables_initialize(void);
0060
0061 /**
0062  * @brief Walks through the subtables of an ACPI table.
0063  *
0064  * @param table Pointer to the table.
0065  * @param size_of_header Size of the table header (used to offset into first subtable).
0066  * @param handler Handler that is called for each subtable found.
0067  */
0068 void acpi_walk_subtables(
0069   ACPI_TABLE_HEADER *table,
0070   size_t size_of_header,
0071   void (*handler)(ACPI_SUBTABLE_HEADER*)
0072 );
0073
0074 #endif /* _AMD64_ACPI_H_ */