registers.h File Reference

#include <uacpi/types.h>

Include dependency graph for registers.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef enum uacpi_register	uacpi_register
typedef enum uacpi_register_field	uacpi_register_field

Enumerations
enum	uacpi_register {   UACPI_REGISTER_PM1_STS = 0 , UACPI_REGISTER_PM1_EN , UACPI_REGISTER_PM1_CNT , UACPI_REGISTER_PM_TMR ,   UACPI_REGISTER_PM2_CNT , UACPI_REGISTER_SLP_CNT , UACPI_REGISTER_SLP_STS , UACPI_REGISTER_RESET ,   UACPI_REGISTER_SMI_CMD , UACPI_REGISTER_MAX = UACPI_REGISTER_SMI_CMD }
enum	uacpi_register_field {   UACPI_REGISTER_FIELD_TMR_STS = 0 , UACPI_REGISTER_FIELD_BM_STS , UACPI_REGISTER_FIELD_GBL_STS , UACPI_REGISTER_FIELD_PWRBTN_STS ,   UACPI_REGISTER_FIELD_SLPBTN_STS , UACPI_REGISTER_FIELD_RTC_STS , UACPI_REGISTER_FIELD_PCIEX_WAKE_STS , UACPI_REGISTER_FIELD_HWR_WAK_STS ,   UACPI_REGISTER_FIELD_WAK_STS , UACPI_REGISTER_FIELD_TMR_EN , UACPI_REGISTER_FIELD_GBL_EN , UACPI_REGISTER_FIELD_PWRBTN_EN ,   UACPI_REGISTER_FIELD_SLPBTN_EN , UACPI_REGISTER_FIELD_RTC_EN , UACPI_REGISTER_FIELD_PCIEXP_WAKE_DIS , UACPI_REGISTER_FIELD_SCI_EN ,   UACPI_REGISTER_FIELD_BM_RLD , UACPI_REGISTER_FIELD_GBL_RLS , UACPI_REGISTER_FIELD_SLP_TYP , UACPI_REGISTER_FIELD_HWR_SLP_TYP ,   UACPI_REGISTER_FIELD_SLP_EN , UACPI_REGISTER_FIELD_HWR_SLP_EN , UACPI_REGISTER_FIELD_ARB_DIS , UACPI_REGISTER_FIELD_MAX = UACPI_REGISTER_FIELD_ARB_DIS }

Functions
uacpi_status	uacpi_read_register (uacpi_register, uacpi_u64 *)
uacpi_status	uacpi_write_register (uacpi_register, uacpi_u64)
uacpi_status	uacpi_write_registers (uacpi_register, uacpi_u64, uacpi_u64)
uacpi_status	uacpi_read_register_field (uacpi_register_field, uacpi_u64 *)
uacpi_status	uacpi_write_register_field (uacpi_register_field, uacpi_u64)

Typedef Documentation

uacpi_register

typedef enum uacpi_register uacpi_register

BEFORE YOU USE THIS API: uACPI manages FADT registers on its own entirely, you should only use this API directly if there's absolutely no other way for your use case, e.g. implementing a CPU idle state driver that does C state switching or similar.

uacpi_register_field

typedef enum uacpi_register_field uacpi_register_field

Enumeration Type Documentation

uacpi_register

enum uacpi_register

BEFORE YOU USE THIS API: uACPI manages FADT registers on its own entirely, you should only use this API directly if there's absolutely no other way for your use case, e.g. implementing a CPU idle state driver that does C state switching or similar.

Enumerator
UACPI_REGISTER_PM1_STS
UACPI_REGISTER_PM1_EN
UACPI_REGISTER_PM1_CNT
UACPI_REGISTER_PM_TMR
UACPI_REGISTER_PM2_CNT
UACPI_REGISTER_SLP_CNT
UACPI_REGISTER_SLP_STS
UACPI_REGISTER_RESET
UACPI_REGISTER_SMI_CMD
UACPI_REGISTER_MAX

Definition at line 16 of file registers.h.

                            {
    UACPI_REGISTER_PM1_STS = 0,
    UACPI_REGISTER_PM1_EN,
    UACPI_REGISTER_PM1_CNT,
    UACPI_REGISTER_PM_TMR,
    UACPI_REGISTER_PM2_CNT,
    UACPI_REGISTER_SLP_CNT,
    UACPI_REGISTER_SLP_STS,
    UACPI_REGISTER_RESET,
    UACPI_REGISTER_SMI_CMD,
    UACPI_REGISTER_MAX = UACPI_REGISTER_SMI_CMD,
} uacpi_register;

uacpi_register_field

enum uacpi_register_field

Enumerator
UACPI_REGISTER_FIELD_TMR_STS
UACPI_REGISTER_FIELD_BM_STS
UACPI_REGISTER_FIELD_GBL_STS
UACPI_REGISTER_FIELD_PWRBTN_STS
UACPI_REGISTER_FIELD_SLPBTN_STS
UACPI_REGISTER_FIELD_RTC_STS
UACPI_REGISTER_FIELD_PCIEX_WAKE_STS
UACPI_REGISTER_FIELD_HWR_WAK_STS
UACPI_REGISTER_FIELD_WAK_STS
UACPI_REGISTER_FIELD_TMR_EN
UACPI_REGISTER_FIELD_GBL_EN
UACPI_REGISTER_FIELD_PWRBTN_EN
UACPI_REGISTER_FIELD_SLPBTN_EN
UACPI_REGISTER_FIELD_RTC_EN
UACPI_REGISTER_FIELD_PCIEXP_WAKE_DIS
UACPI_REGISTER_FIELD_SCI_EN
UACPI_REGISTER_FIELD_BM_RLD
UACPI_REGISTER_FIELD_GBL_RLS
UACPI_REGISTER_FIELD_SLP_TYP
UACPI_REGISTER_FIELD_HWR_SLP_TYP
UACPI_REGISTER_FIELD_SLP_EN
UACPI_REGISTER_FIELD_HWR_SLP_EN
UACPI_REGISTER_FIELD_ARB_DIS
UACPI_REGISTER_FIELD_MAX

Definition at line 56 of file registers.h.

                                  {
    UACPI_REGISTER_FIELD_TMR_STS = 0,
    UACPI_REGISTER_FIELD_BM_STS,
    UACPI_REGISTER_FIELD_GBL_STS,
    UACPI_REGISTER_FIELD_PWRBTN_STS,
    UACPI_REGISTER_FIELD_SLPBTN_STS,
    UACPI_REGISTER_FIELD_RTC_STS,
    UACPI_REGISTER_FIELD_PCIEX_WAKE_STS,
    UACPI_REGISTER_FIELD_HWR_WAK_STS,
    UACPI_REGISTER_FIELD_WAK_STS,
    UACPI_REGISTER_FIELD_TMR_EN,
    UACPI_REGISTER_FIELD_GBL_EN,
    UACPI_REGISTER_FIELD_PWRBTN_EN,
    UACPI_REGISTER_FIELD_SLPBTN_EN,
    UACPI_REGISTER_FIELD_RTC_EN,
    UACPI_REGISTER_FIELD_PCIEXP_WAKE_DIS,
    UACPI_REGISTER_FIELD_SCI_EN,
    UACPI_REGISTER_FIELD_BM_RLD,
    UACPI_REGISTER_FIELD_GBL_RLS,
    UACPI_REGISTER_FIELD_SLP_TYP,
    UACPI_REGISTER_FIELD_HWR_SLP_TYP,
    UACPI_REGISTER_FIELD_SLP_EN,
    UACPI_REGISTER_FIELD_HWR_SLP_EN,
    UACPI_REGISTER_FIELD_ARB_DIS,
    UACPI_REGISTER_FIELD_MAX = UACPI_REGISTER_FIELD_ARB_DIS,
} uacpi_register_field;

Function Documentation

uacpi_read_register()

uacpi_status uacpi_read_register	(	uacpi_register	reg_enum,
		uacpi_u64 *	out_value
	)

Read a register from FADT

NOTE: write-only bits (if any) are cleared automatically

Definition at line 227 of file registers.c.

{
    uacpi_status ret;
    const struct register_spec *reg;
    struct register_mapping *mapping;
 
    UACPI_ENSURE_INIT_LEVEL_AT_LEAST(UACPI_INIT_LEVEL_SUBSYSTEM_INITIALIZED);
 
    ret = get_reg(reg_enum, &reg, &mapping);
    if (uacpi_unlikely_error(ret))
        return ret;
 
    ret = ensure_register_mapped(reg, mapping);
    if (uacpi_unlikely_error(ret))
        return ret;
 
    return do_read_register(reg, mapping, out_value);
}

Referenced by enter_sleep_state_hw_full(), handle_fixed_events(), and prepare_for_wake_from_sleep_state_hw_full().

uacpi_read_register_field()

uacpi_status uacpi_read_register_field	(	uacpi_register_field	field_enum,
		uacpi_u64 *	out_value
	)

Read a field from a FADT register

NOTE: The value is automatically masked and shifted down as appropriate, the client code doesn't have to do any bit manipulation. E.g. for a field at 0b???XX??? the returned value will contain just the 0bXX

Definition at line 487 of file registers.c.

{
    uacpi_status ret;
    uacpi_u8 field_idx = field_enum;
    const struct register_field *field;
    const struct register_spec *reg;
    struct register_mapping *mapping;
 
    UACPI_ENSURE_INIT_LEVEL_AT_LEAST(UACPI_INIT_LEVEL_SUBSYSTEM_INITIALIZED);
 
    if (uacpi_unlikely(field_idx > UACPI_REGISTER_FIELD_MAX))
        return UACPI_STATUS_INVALID_ARGUMENT;
 
    field = &g_fields[field_idx];
    reg = &g_registers[field->reg];
    mapping = &g_register_mappings[field->reg];
 
    ret = ensure_register_mapped(reg, mapping);
    if (uacpi_unlikely_error(ret))
        return ret;
 
    ret = do_read_register(reg, mapping, out_value);
    if (uacpi_unlikely_error(ret))
        return ret;
 
    *out_value = (*out_value & field->mask) >> field->offset;
    return UACPI_STATUS_OK;
}

Referenced by enter_sleep_state_hw_full(), enter_sleep_state_hw_reduced(), read_mode(), set_event(), and uacpi_fixed_event_info().

uacpi_write_register()

uacpi_status uacpi_write_register	(	uacpi_register	reg_enum,
		uacpi_u64	in_value
	)

Write a register from FADT

NOTE:

• Preserved bits (if any) are preserved automatically
• If a register is made up of two (e.g. PM1a and PM1b) parts, the input is written to both at the same time

Definition at line 286 of file registers.c.

{
    uacpi_status ret;
    const struct register_spec *reg;
    struct register_mapping *mapping;
 
    UACPI_ENSURE_INIT_LEVEL_AT_LEAST(UACPI_INIT_LEVEL_SUBSYSTEM_INITIALIZED);
 
    ret = get_reg(reg_enum, &reg, &mapping);
    if (uacpi_unlikely_error(ret))
        return ret;
 
    ret = ensure_register_mapped(reg, mapping);
    if (uacpi_unlikely_error(ret))
        return ret;
 
    return do_write_register(reg, mapping, in_value);
}

Referenced by enter_sleep_state_hw_reduced(), prepare_for_wake_from_sleep_state_hw_reduced(), set_mode(), uacpi_clear_all_events(), and uacpi_reboot().

uacpi_write_register_field()

uacpi_status uacpi_write_register_field	(	uacpi_register_field	field_enum,
		uacpi_u64	in_value
	)

Write to a field of a FADT register

NOTE: The value is automatically masked and shifted up as appropriate, the client code doesn't have to do any bit manipulation. E.g. for a field at 0b???XX??? the passed value should be just 0bXX

Definition at line 518 of file registers.c.

{
    uacpi_status ret;
    uacpi_u8 field_idx = field_enum;
    const struct register_field *field;
    const struct register_spec *reg;
    struct register_mapping *mapping;
 
    uacpi_u64 data;
    uacpi_cpu_flags flags;
 
    UACPI_ENSURE_INIT_LEVEL_AT_LEAST(UACPI_INIT_LEVEL_SUBSYSTEM_INITIALIZED);
 
    if (uacpi_unlikely(field_idx > UACPI_REGISTER_FIELD_MAX))
        return UACPI_STATUS_INVALID_ARGUMENT;
 
    field = &g_fields[field_idx];
    reg = &g_registers[field->reg];
    mapping = &g_register_mappings[field->reg];
 
    ret = ensure_register_mapped(reg, mapping);
    if (uacpi_unlikely_error(ret))
        return ret;
 
    in_value = (in_value << field->offset) & field->mask;
 
    flags = uacpi_kernel_lock_spinlock(g_reg_lock);
 
    if (reg->kind == REGISTER_ACCESS_KIND_WRITE_TO_CLEAR) {
        if (in_value == 0) {
            ret = UACPI_STATUS_OK;
            goto out;
        }
 
        ret = do_write_register(reg, mapping, in_value);
        goto out;
    }
 
    ret = do_read_register(reg, mapping, &data);
    if (uacpi_unlikely_error(ret))
        goto out;
 
    data &= ~field->mask;
    data |= in_value;
 
    ret = do_write_register(reg, mapping, data);
 
out:
    uacpi_kernel_unlock_spinlock(g_reg_lock, flags);
    return ret;
}

Referenced by dispatch_fixed_event(), enter_sleep_state_hw_full(), enter_sleep_state_hw_reduced(), initialize_fixed_events(), set_event(), uacpi_clear_fixed_event(), uacpi_release_global_lock_to_firmware(), wake_from_sleep_state_hw_full(), and wake_from_sleep_state_hw_reduced().

uacpi_write_registers()

uacpi_status uacpi_write_registers	(	uacpi_register	reg_enum,
		uacpi_u64	in_value0,
		uacpi_u64	in_value1
	)

Write a register from FADT

NOTE:

• Preserved bits (if any) are preserved automatically
• For registers that are made up of two (e.g. PM1a and PM1b) parts, the provided values are written to their respective physical register

Definition at line 307 of file registers.c.

{
    uacpi_status ret;
    const struct register_spec *reg;
    struct register_mapping *mapping;
 
    UACPI_ENSURE_INIT_LEVEL_AT_LEAST(UACPI_INIT_LEVEL_SUBSYSTEM_INITIALIZED);
 
    ret = get_reg(reg_enum, &reg, &mapping);
    if (uacpi_unlikely_error(ret))
        return ret;
 
    ret = ensure_register_mapped(reg, mapping);
    if (uacpi_unlikely_error(ret))
        return ret;
 
    ret = do_write_one(mapping, 0, in_value0);
    if (uacpi_unlikely_error(ret))
        return ret;
 
    return do_write_one(mapping, 1, in_value1);
}

Referenced by enter_sleep_state_hw_full(), and prepare_for_wake_from_sleep_state_hw_full().