drivers/acpi/acpica/achware.h

   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 - 2020, 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 /*
  77  * hwgpe - GPE support
  78  */
  79 u32 acpi_hw_get_gpe_register_bit(struct acpi_gpe_event_info *gpe_event_info);
  80
  81 acpi_status
  82 acpi_hw_low_set_gpe(struct acpi_gpe_event_info *gpe_event_info, u32 action);
  83
  84 acpi_status
  85 acpi_hw_disable_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
  86                           struct acpi_gpe_block_info *gpe_block, void *context);
  87
  88 acpi_status acpi_hw_clear_gpe(struct acpi_gpe_event_info *gpe_event_info);
  89
  90 acpi_status
  91 acpi_hw_clear_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
  92                         struct acpi_gpe_block_info *gpe_block, void *context);
  93
  94 acpi_status
  95 acpi_hw_get_gpe_status(struct acpi_gpe_event_info *gpe_event_info,
  96                        acpi_event_status *event_status);
  97
  98 acpi_status acpi_hw_disable_all_gpes(void);
  99
 100 acpi_status acpi_hw_enable_all_runtime_gpes(void);
 101
 102 acpi_status acpi_hw_enable_all_wakeup_gpes(void);
 103
 104 acpi_status
 105 acpi_hw_enable_runtime_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
 106                                  struct acpi_gpe_block_info *gpe_block,
 107                                  void *context);
 108
 109 #ifdef ACPI_PCI_CONFIGURED
 110 /*
 111  * hwpci - PCI configuration support
 112  */
 113 acpi_status
 114 acpi_hw_derive_pci_id(struct acpi_pci_id *pci_id,
 115                       acpi_handle root_pci_device, acpi_handle pci_region);
 116 #else
 117 static inline acpi_status
 118 acpi_hw_derive_pci_id(struct acpi_pci_id *pci_id, acpi_handle root_pci_device,
 119                       acpi_handle pci_region)
 120 {
 121         return AE_SUPPORT;
 122 }
 123 #endif
 124
 125 #endif                          /* __ACHWARE_H__ */