1 /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
2 /******************************************************************************
3 *
4 * Name: achware.h -- hardware specific interfaces
5 *
6 * Copyright (C) 2000 - 2023, Intel Corp.
7 *
8 *****************************************************************************/
9
10 #ifndef __ACHWARE_H__
11 #define __ACHWARE_H__
12
13 /* Values for the _SST predefined method */
14
15 #define ACPI_SST_INDICATOR_OFF 0
16 #define ACPI_SST_WORKING 1
17 #define ACPI_SST_WAKING 2
18 #define ACPI_SST_SLEEPING 3
19 #define ACPI_SST_SLEEP_CONTEXT 4
20
21 /*
22 * hwacpi - high level functions
23 */
24 acpi_status acpi_hw_set_mode(u32 mode);
25
26 u32 acpi_hw_get_mode(void);
27
28 /*
29 * hwregs - ACPI Register I/O
30 */
31 acpi_status
32 acpi_hw_validate_register(struct acpi_generic_address *reg,
33 u8 max_bit_width, u64 *address);
34
35 acpi_status acpi_hw_read(u64 *value, struct acpi_generic_address *reg);
36
37 acpi_status acpi_hw_write(u64 value, struct acpi_generic_address *reg);
38
39 struct acpi_bit_register_info *acpi_hw_get_bit_register_info(u32 register_id);
40
41 acpi_status acpi_hw_write_pm1_control(u32 pm1a_control, u32 pm1b_control);
42
43 acpi_status acpi_hw_register_read(u32 register_id, u32 *return_value);
44
45 acpi_status acpi_hw_register_write(u32 register_id, u32 value);
46
47 acpi_status acpi_hw_clear_acpi_status(void);
48
49 /*
50 * hwsleep - sleep/wake support (Legacy sleep registers)
51 */
52 acpi_status acpi_hw_legacy_sleep(u8 sleep_state);
53
54 acpi_status acpi_hw_legacy_wake_prep(u8 sleep_state);
55
56 acpi_status acpi_hw_legacy_wake(u8 sleep_state);
57
58 /*
59 * hwesleep - sleep/wake support (Extended FADT-V5 sleep registers)
60 */
61 void acpi_hw_execute_sleep_method(char *method_name, u32 integer_argument);
62
63 acpi_status acpi_hw_extended_sleep(u8 sleep_state);
64
65 acpi_status acpi_hw_extended_wake_prep(u8 sleep_state);
66
67 acpi_status acpi_hw_extended_wake(u8 sleep_state);
68
69 /*
70 * hwvalid - Port I/O with validation
71 */
72 acpi_status acpi_hw_read_port(acpi_io_address address, u32 *value, u32 width);
73
74 acpi_status acpi_hw_write_port(acpi_io_address address, u32 value, u32 width);
75
76 acpi_status acpi_hw_validate_io_block(u64 address, u32 bit_width, u32 count);
77
78 /*
79 * hwgpe - GPE support
80 */
81 acpi_status acpi_hw_gpe_read(u64 *value, struct acpi_gpe_address *reg);
82
83 acpi_status acpi_hw_gpe_write(u64 value, struct acpi_gpe_address *reg);
84
85 u32 acpi_hw_get_gpe_register_bit(struct acpi_gpe_event_info *gpe_event_info);
86
87 acpi_status
88 acpi_hw_low_set_gpe(struct acpi_gpe_event_info *gpe_event_info, u32 action);
89
90 acpi_status
91 acpi_hw_disable_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
92 struct acpi_gpe_block_info *gpe_block, void *context);
93
94 acpi_status acpi_hw_clear_gpe(struct acpi_gpe_event_info *gpe_event_info);
95
96 acpi_status
97 acpi_hw_clear_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
98 struct acpi_gpe_block_info *gpe_block, void *context);
99
100 acpi_status
101 acpi_hw_get_gpe_status(struct acpi_gpe_event_info *gpe_event_info,
102 acpi_event_status *event_status);
103
104 acpi_status acpi_hw_enable_all_runtime_gpes(void);
105
106 acpi_status acpi_hw_enable_all_wakeup_gpes(void);
107
108 u8 acpi_hw_check_all_gpes(acpi_handle gpe_skip_device, u32 gpe_skip_number);
109
110 acpi_status
111 acpi_hw_enable_runtime_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
112 struct acpi_gpe_block_info *gpe_block,
113 void *context);
114
115 #ifdef ACPI_PCI_CONFIGURED
116 /*
117 * hwpci - PCI configuration support
118 */
119 acpi_status
120 acpi_hw_derive_pci_id(struct acpi_pci_id *pci_id,
121 acpi_handle root_pci_device, acpi_handle pci_region);
122 #else
123 static inline acpi_status
acpi_hw_derive_pci_id(struct acpi_pci_id * pci_id,acpi_handle root_pci_device,acpi_handle pci_region)124 acpi_hw_derive_pci_id(struct acpi_pci_id *pci_id, acpi_handle root_pci_device,
125 acpi_handle pci_region)
126 {
127 return AE_SUPPORT;
128 }
129 #endif
130
131 #endif /* __ACHWARE_H__ */
132