field_unit.h

Go to the documentation of this file.

#pragma once
 
#include <modules/acpi/aml/object.h>
 
#include <stdint.h>
 
/**
 * @brief Opregion and Field Access
 * @defgroup modules_acpi_aml_field Field Access
 * @ingroup modules_acpi_aml
 *
 * This module provides functionality for accessing Opregions and Fields.
 *
 * Good luck understanding all the bit shifting and masking, im pretty sure I got it all right but who knows.
 *
 * @{
 */
 
/**
 * @brief Read the value stored in a FieldUnit. FieldUnits include Fields, IndexFields and BankFields.
 *
 * A IndexField works by having two fields, an index field and a data field. The index field is written to with the
 * "selector" or "index" of the data to read, and then the data field is read to get the actual data.
 *
 * A BankField works similarly to a field, but it has an additional "bank" object which it writes its "BankValue" to
 * (which is like the BankFields id), before performing any access. Think of this like reconfiguring the opregion to a
 * different structure before accessing it.
 *
 * Will acquire the global mutex if the FieldUnits LockRule is set to `AML_LOCK_RULE_LOCK`.
 *
 * @see @ref modules_acpi_aml_evaluate
 * @see Section 19.6.48, 19.6.64 and 19.6.7 of the ACPI specification for more details.
 *
 * @param state Pointer to the current AML state.
 * @param field The field to read from.
 * @param out Pointer to the buffer where the result will be stored, will be an integer or a buffer.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_field_unit_load(aml_state_t* state, aml_field_unit_t* fieldUnit, aml_object_t* out);
 
/**
 * @brief Write a value to a FieldUnit. FieldUnits include Fields, IndexFields and BankFields.
 *
 * Will acquire the global mutex if the FieldUnits LockRule is set to `AML_LOCK_RULE_LOCK`.
 *
 * @see @ref modules_acpi_aml_evaluate
 * @see Section 19.6.48, 19.6.64 and 19.6.7 of the ACPI specification for more details.
 *
 * @param state Pointer to the current AML state.
 * @param field The field to write to.
 * @param in Pointer to the object containing the value to write, must be an integer or a buffer.
 * @return On success, `0`. On failure, `ERR` and `errno` is set.
 */
uint64_t aml_field_unit_store(aml_state_t* state, aml_field_unit_t* fieldUnit, aml_object_t* in);
 
/** @} */