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