Back to home page

OSCL-LXR

 
 

    


0001 /* SPDX-License-Identifier: GPL-2.0-or-later */
0002 /*
0003  * acpi.h - ACPI Interface
0004  *
0005  * Copyright (C) 2001 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
0006  */
0007 
0008 #ifndef _LINUX_ACPI_H
0009 #define _LINUX_ACPI_H
0010 
0011 #include <linux/errno.h>
0012 #include <linux/ioport.h>   /* for struct resource */
0013 #include <linux/irqdomain.h>
0014 #include <linux/resource_ext.h>
0015 #include <linux/device.h>
0016 #include <linux/property.h>
0017 #include <linux/uuid.h>
0018 
0019 #ifndef _LINUX
0020 #define _LINUX
0021 #endif
0022 #include <acpi/acpi.h>
0023 
0024 #ifdef  CONFIG_ACPI
0025 
0026 #include <linux/list.h>
0027 #include <linux/mod_devicetable.h>
0028 #include <linux/dynamic_debug.h>
0029 #include <linux/module.h>
0030 #include <linux/mutex.h>
0031 
0032 #include <acpi/acpi_bus.h>
0033 #include <acpi/acpi_drivers.h>
0034 #include <acpi/acpi_numa.h>
0035 #include <acpi/acpi_io.h>
0036 #include <asm/acpi.h>
0037 
0038 static inline acpi_handle acpi_device_handle(struct acpi_device *adev)
0039 {
0040     return adev ? adev->handle : NULL;
0041 }
0042 
0043 #define ACPI_COMPANION(dev)     to_acpi_device_node((dev)->fwnode)
0044 #define ACPI_COMPANION_SET(dev, adev)   set_primary_fwnode(dev, (adev) ? \
0045     acpi_fwnode_handle(adev) : NULL)
0046 #define ACPI_HANDLE(dev)        acpi_device_handle(ACPI_COMPANION(dev))
0047 #define ACPI_HANDLE_FWNODE(fwnode)  \
0048                 acpi_device_handle(to_acpi_device_node(fwnode))
0049 
0050 static inline struct fwnode_handle *acpi_alloc_fwnode_static(void)
0051 {
0052     struct fwnode_handle *fwnode;
0053 
0054     fwnode = kzalloc(sizeof(struct fwnode_handle), GFP_KERNEL);
0055     if (!fwnode)
0056         return NULL;
0057 
0058     fwnode_init(fwnode, &acpi_static_fwnode_ops);
0059 
0060     return fwnode;
0061 }
0062 
0063 static inline void acpi_free_fwnode_static(struct fwnode_handle *fwnode)
0064 {
0065     if (WARN_ON(!is_acpi_static_node(fwnode)))
0066         return;
0067 
0068     kfree(fwnode);
0069 }
0070 
0071 /**
0072  * ACPI_DEVICE_CLASS - macro used to describe an ACPI device with
0073  * the PCI-defined class-code information
0074  *
0075  * @_cls : the class, subclass, prog-if triple for this device
0076  * @_msk : the class mask for this device
0077  *
0078  * This macro is used to create a struct acpi_device_id that matches a
0079  * specific PCI class. The .id and .driver_data fields will be left
0080  * initialized with the default value.
0081  */
0082 #define ACPI_DEVICE_CLASS(_cls, _msk)   .cls = (_cls), .cls_msk = (_msk),
0083 
0084 static inline bool has_acpi_companion(struct device *dev)
0085 {
0086     return is_acpi_device_node(dev->fwnode);
0087 }
0088 
0089 static inline void acpi_preset_companion(struct device *dev,
0090                      struct acpi_device *parent, u64 addr)
0091 {
0092     ACPI_COMPANION_SET(dev, acpi_find_child_device(parent, addr, false));
0093 }
0094 
0095 static inline const char *acpi_dev_name(struct acpi_device *adev)
0096 {
0097     return dev_name(&adev->dev);
0098 }
0099 
0100 struct device *acpi_get_first_physical_node(struct acpi_device *adev);
0101 
0102 enum acpi_irq_model_id {
0103     ACPI_IRQ_MODEL_PIC = 0,
0104     ACPI_IRQ_MODEL_IOAPIC,
0105     ACPI_IRQ_MODEL_IOSAPIC,
0106     ACPI_IRQ_MODEL_PLATFORM,
0107     ACPI_IRQ_MODEL_GIC,
0108     ACPI_IRQ_MODEL_LPIC,
0109     ACPI_IRQ_MODEL_COUNT
0110 };
0111 
0112 extern enum acpi_irq_model_id   acpi_irq_model;
0113 
0114 enum acpi_interrupt_id {
0115     ACPI_INTERRUPT_PMI  = 1,
0116     ACPI_INTERRUPT_INIT,
0117     ACPI_INTERRUPT_CPEI,
0118     ACPI_INTERRUPT_COUNT
0119 };
0120 
0121 #define ACPI_SPACE_MEM      0
0122 
0123 enum acpi_address_range_id {
0124     ACPI_ADDRESS_RANGE_MEMORY = 1,
0125     ACPI_ADDRESS_RANGE_RESERVED = 2,
0126     ACPI_ADDRESS_RANGE_ACPI = 3,
0127     ACPI_ADDRESS_RANGE_NVS  = 4,
0128     ACPI_ADDRESS_RANGE_COUNT
0129 };
0130 
0131 
0132 /* Table Handlers */
0133 union acpi_subtable_headers {
0134     struct acpi_subtable_header common;
0135     struct acpi_hmat_structure hmat;
0136     struct acpi_prmt_module_header prmt;
0137     struct acpi_cedt_header cedt;
0138 };
0139 
0140 typedef int (*acpi_tbl_table_handler)(struct acpi_table_header *table);
0141 
0142 typedef int (*acpi_tbl_entry_handler)(union acpi_subtable_headers *header,
0143                       const unsigned long end);
0144 
0145 typedef int (*acpi_tbl_entry_handler_arg)(union acpi_subtable_headers *header,
0146                       void *arg, const unsigned long end);
0147 
0148 /* Debugger support */
0149 
0150 struct acpi_debugger_ops {
0151     int (*create_thread)(acpi_osd_exec_callback function, void *context);
0152     ssize_t (*write_log)(const char *msg);
0153     ssize_t (*read_cmd)(char *buffer, size_t length);
0154     int (*wait_command_ready)(bool single_step, char *buffer, size_t length);
0155     int (*notify_command_complete)(void);
0156 };
0157 
0158 struct acpi_debugger {
0159     const struct acpi_debugger_ops *ops;
0160     struct module *owner;
0161     struct mutex lock;
0162 };
0163 
0164 #ifdef CONFIG_ACPI_DEBUGGER
0165 int __init acpi_debugger_init(void);
0166 int acpi_register_debugger(struct module *owner,
0167                const struct acpi_debugger_ops *ops);
0168 void acpi_unregister_debugger(const struct acpi_debugger_ops *ops);
0169 int acpi_debugger_create_thread(acpi_osd_exec_callback function, void *context);
0170 ssize_t acpi_debugger_write_log(const char *msg);
0171 ssize_t acpi_debugger_read_cmd(char *buffer, size_t buffer_length);
0172 int acpi_debugger_wait_command_ready(void);
0173 int acpi_debugger_notify_command_complete(void);
0174 #else
0175 static inline int acpi_debugger_init(void)
0176 {
0177     return -ENODEV;
0178 }
0179 
0180 static inline int acpi_register_debugger(struct module *owner,
0181                      const struct acpi_debugger_ops *ops)
0182 {
0183     return -ENODEV;
0184 }
0185 
0186 static inline void acpi_unregister_debugger(const struct acpi_debugger_ops *ops)
0187 {
0188 }
0189 
0190 static inline int acpi_debugger_create_thread(acpi_osd_exec_callback function,
0191                           void *context)
0192 {
0193     return -ENODEV;
0194 }
0195 
0196 static inline int acpi_debugger_write_log(const char *msg)
0197 {
0198     return -ENODEV;
0199 }
0200 
0201 static inline int acpi_debugger_read_cmd(char *buffer, u32 buffer_length)
0202 {
0203     return -ENODEV;
0204 }
0205 
0206 static inline int acpi_debugger_wait_command_ready(void)
0207 {
0208     return -ENODEV;
0209 }
0210 
0211 static inline int acpi_debugger_notify_command_complete(void)
0212 {
0213     return -ENODEV;
0214 }
0215 #endif
0216 
0217 #define BAD_MADT_ENTRY(entry, end) (                        \
0218         (!entry) || (unsigned long)entry + sizeof(*entry) > end ||  \
0219         ((struct acpi_subtable_header *)entry)->length < sizeof(*entry))
0220 
0221 struct acpi_subtable_proc {
0222     int id;
0223     acpi_tbl_entry_handler handler;
0224     acpi_tbl_entry_handler_arg handler_arg;
0225     void *arg;
0226     int count;
0227 };
0228 
0229 void __iomem *__acpi_map_table(unsigned long phys, unsigned long size);
0230 void __acpi_unmap_table(void __iomem *map, unsigned long size);
0231 int early_acpi_boot_init(void);
0232 int acpi_boot_init (void);
0233 void acpi_boot_table_prepare (void);
0234 void acpi_boot_table_init (void);
0235 int acpi_mps_check (void);
0236 int acpi_numa_init (void);
0237 
0238 int acpi_locate_initial_tables (void);
0239 void acpi_reserve_initial_tables (void);
0240 void acpi_table_init_complete (void);
0241 int acpi_table_init (void);
0242 
0243 #ifdef CONFIG_ACPI_TABLE_LIB
0244 #define EXPORT_SYMBOL_ACPI_LIB(x) EXPORT_SYMBOL_NS_GPL(x, ACPI)
0245 #define __init_or_acpilib
0246 #define __initdata_or_acpilib
0247 #else
0248 #define EXPORT_SYMBOL_ACPI_LIB(x)
0249 #define __init_or_acpilib __init
0250 #define __initdata_or_acpilib __initdata
0251 #endif
0252 
0253 int acpi_table_parse(char *id, acpi_tbl_table_handler handler);
0254 int __init_or_acpilib acpi_table_parse_entries(char *id,
0255         unsigned long table_size, int entry_id,
0256         acpi_tbl_entry_handler handler, unsigned int max_entries);
0257 int __init_or_acpilib acpi_table_parse_entries_array(char *id,
0258         unsigned long table_size, struct acpi_subtable_proc *proc,
0259         int proc_num, unsigned int max_entries);
0260 int acpi_table_parse_madt(enum acpi_madt_type id,
0261               acpi_tbl_entry_handler handler,
0262               unsigned int max_entries);
0263 int __init_or_acpilib
0264 acpi_table_parse_cedt(enum acpi_cedt_type id,
0265               acpi_tbl_entry_handler_arg handler_arg, void *arg);
0266 
0267 int acpi_parse_mcfg (struct acpi_table_header *header);
0268 void acpi_table_print_madt_entry (struct acpi_subtable_header *madt);
0269 
0270 /* the following numa functions are architecture-dependent */
0271 void acpi_numa_slit_init (struct acpi_table_slit *slit);
0272 
0273 #if defined(CONFIG_X86) || defined(CONFIG_IA64) || defined(CONFIG_LOONGARCH)
0274 void acpi_numa_processor_affinity_init (struct acpi_srat_cpu_affinity *pa);
0275 #else
0276 static inline void
0277 acpi_numa_processor_affinity_init(struct acpi_srat_cpu_affinity *pa) { }
0278 #endif
0279 
0280 void acpi_numa_x2apic_affinity_init(struct acpi_srat_x2apic_cpu_affinity *pa);
0281 
0282 #ifdef CONFIG_ARM64
0283 void acpi_numa_gicc_affinity_init(struct acpi_srat_gicc_affinity *pa);
0284 void acpi_arch_dma_setup(struct device *dev, u64 *dma_addr, u64 *dma_size);
0285 #else
0286 static inline void
0287 acpi_numa_gicc_affinity_init(struct acpi_srat_gicc_affinity *pa) { }
0288 static inline void
0289 acpi_arch_dma_setup(struct device *dev, u64 *dma_addr, u64 *dma_size) { }
0290 #endif
0291 
0292 int acpi_numa_memory_affinity_init (struct acpi_srat_mem_affinity *ma);
0293 
0294 #ifndef PHYS_CPUID_INVALID
0295 typedef u32 phys_cpuid_t;
0296 #define PHYS_CPUID_INVALID (phys_cpuid_t)(-1)
0297 #endif
0298 
0299 static inline bool invalid_logical_cpuid(u32 cpuid)
0300 {
0301     return (int)cpuid < 0;
0302 }
0303 
0304 static inline bool invalid_phys_cpuid(phys_cpuid_t phys_id)
0305 {
0306     return phys_id == PHYS_CPUID_INVALID;
0307 }
0308 
0309 /* Validate the processor object's proc_id */
0310 bool acpi_duplicate_processor_id(int proc_id);
0311 /* Processor _CTS control */
0312 struct acpi_processor_power;
0313 
0314 #ifdef CONFIG_ACPI_PROCESSOR_CSTATE
0315 bool acpi_processor_claim_cst_control(void);
0316 int acpi_processor_evaluate_cst(acpi_handle handle, u32 cpu,
0317                 struct acpi_processor_power *info);
0318 #else
0319 static inline bool acpi_processor_claim_cst_control(void) { return false; }
0320 static inline int acpi_processor_evaluate_cst(acpi_handle handle, u32 cpu,
0321                           struct acpi_processor_power *info)
0322 {
0323     return -ENODEV;
0324 }
0325 #endif
0326 
0327 #ifdef CONFIG_ACPI_HOTPLUG_CPU
0328 /* Arch dependent functions for cpu hotplug support */
0329 int acpi_map_cpu(acpi_handle handle, phys_cpuid_t physid, u32 acpi_id,
0330          int *pcpu);
0331 int acpi_unmap_cpu(int cpu);
0332 #endif /* CONFIG_ACPI_HOTPLUG_CPU */
0333 
0334 #ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
0335 int acpi_get_ioapic_id(acpi_handle handle, u32 gsi_base, u64 *phys_addr);
0336 #endif
0337 
0338 int acpi_register_ioapic(acpi_handle handle, u64 phys_addr, u32 gsi_base);
0339 int acpi_unregister_ioapic(acpi_handle handle, u32 gsi_base);
0340 int acpi_ioapic_registered(acpi_handle handle, u32 gsi_base);
0341 void acpi_irq_stats_init(void);
0342 extern u32 acpi_irq_handled;
0343 extern u32 acpi_irq_not_handled;
0344 extern unsigned int acpi_sci_irq;
0345 extern bool acpi_no_s5;
0346 #define INVALID_ACPI_IRQ    ((unsigned)-1)
0347 static inline bool acpi_sci_irq_valid(void)
0348 {
0349     return acpi_sci_irq != INVALID_ACPI_IRQ;
0350 }
0351 
0352 extern int sbf_port;
0353 extern unsigned long acpi_realmode_flags;
0354 
0355 int acpi_register_gsi (struct device *dev, u32 gsi, int triggering, int polarity);
0356 int acpi_gsi_to_irq (u32 gsi, unsigned int *irq);
0357 int acpi_isa_irq_to_gsi (unsigned isa_irq, u32 *gsi);
0358 
0359 void acpi_set_irq_model(enum acpi_irq_model_id model,
0360             struct fwnode_handle *(*)(u32));
0361 void acpi_set_gsi_to_irq_fallback(u32 (*)(u32));
0362 
0363 struct irq_domain *acpi_irq_create_hierarchy(unsigned int flags,
0364                          unsigned int size,
0365                          struct fwnode_handle *fwnode,
0366                          const struct irq_domain_ops *ops,
0367                          void *host_data);
0368 
0369 #ifdef CONFIG_X86_IO_APIC
0370 extern int acpi_get_override_irq(u32 gsi, int *trigger, int *polarity);
0371 #else
0372 static inline int acpi_get_override_irq(u32 gsi, int *trigger, int *polarity)
0373 {
0374     return -1;
0375 }
0376 #endif
0377 /*
0378  * This function undoes the effect of one call to acpi_register_gsi().
0379  * If this matches the last registration, any IRQ resources for gsi
0380  * are freed.
0381  */
0382 void acpi_unregister_gsi (u32 gsi);
0383 
0384 struct pci_dev;
0385 
0386 int acpi_pci_irq_enable (struct pci_dev *dev);
0387 void acpi_penalize_isa_irq(int irq, int active);
0388 bool acpi_isa_irq_available(int irq);
0389 #ifdef CONFIG_PCI
0390 void acpi_penalize_sci_irq(int irq, int trigger, int polarity);
0391 #else
0392 static inline void acpi_penalize_sci_irq(int irq, int trigger,
0393                     int polarity)
0394 {
0395 }
0396 #endif
0397 void acpi_pci_irq_disable (struct pci_dev *dev);
0398 
0399 extern int ec_read(u8 addr, u8 *val);
0400 extern int ec_write(u8 addr, u8 val);
0401 extern int ec_transaction(u8 command,
0402                           const u8 *wdata, unsigned wdata_len,
0403                           u8 *rdata, unsigned rdata_len);
0404 extern acpi_handle ec_get_handle(void);
0405 
0406 extern bool acpi_is_pnp_device(struct acpi_device *);
0407 
0408 #if defined(CONFIG_ACPI_WMI) || defined(CONFIG_ACPI_WMI_MODULE)
0409 
0410 typedef void (*wmi_notify_handler) (u32 value, void *context);
0411 
0412 extern acpi_status wmi_evaluate_method(const char *guid, u8 instance,
0413                     u32 method_id,
0414                     const struct acpi_buffer *in,
0415                     struct acpi_buffer *out);
0416 extern acpi_status wmi_query_block(const char *guid, u8 instance,
0417                     struct acpi_buffer *out);
0418 extern acpi_status wmi_set_block(const char *guid, u8 instance,
0419                     const struct acpi_buffer *in);
0420 extern acpi_status wmi_install_notify_handler(const char *guid,
0421                     wmi_notify_handler handler, void *data);
0422 extern acpi_status wmi_remove_notify_handler(const char *guid);
0423 extern acpi_status wmi_get_event_data(u32 event, struct acpi_buffer *out);
0424 extern bool wmi_has_guid(const char *guid);
0425 extern char *wmi_get_acpi_device_uid(const char *guid);
0426 
0427 #endif  /* CONFIG_ACPI_WMI */
0428 
0429 #define ACPI_VIDEO_OUTPUT_SWITCHING         0x0001
0430 #define ACPI_VIDEO_DEVICE_POSTING           0x0002
0431 #define ACPI_VIDEO_ROM_AVAILABLE            0x0004
0432 #define ACPI_VIDEO_BACKLIGHT                0x0008
0433 #define ACPI_VIDEO_BACKLIGHT_FORCE_VENDOR       0x0010
0434 #define ACPI_VIDEO_BACKLIGHT_FORCE_VIDEO        0x0020
0435 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VENDOR    0x0040
0436 #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VIDEO     0x0080
0437 #define ACPI_VIDEO_BACKLIGHT_DMI_VENDOR         0x0100
0438 #define ACPI_VIDEO_BACKLIGHT_DMI_VIDEO          0x0200
0439 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VENDOR      0x0400
0440 #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VIDEO       0x0800
0441 
0442 extern char acpi_video_backlight_string[];
0443 extern long acpi_is_video_device(acpi_handle handle);
0444 extern int acpi_blacklisted(void);
0445 extern void acpi_osi_setup(char *str);
0446 extern bool acpi_osi_is_win8(void);
0447 
0448 #ifdef CONFIG_ACPI_NUMA
0449 int acpi_map_pxm_to_node(int pxm);
0450 int acpi_get_node(acpi_handle handle);
0451 
0452 /**
0453  * pxm_to_online_node - Map proximity ID to online node
0454  * @pxm: ACPI proximity ID
0455  *
0456  * This is similar to pxm_to_node(), but always returns an online
0457  * node.  When the mapped node from a given proximity ID is offline, it
0458  * looks up the node distance table and returns the nearest online node.
0459  *
0460  * ACPI device drivers, which are called after the NUMA initialization has
0461  * completed in the kernel, can call this interface to obtain their device
0462  * NUMA topology from ACPI tables.  Such drivers do not have to deal with
0463  * offline nodes.  A node may be offline when SRAT memory entry does not exist,
0464  * or NUMA is disabled, ex. "numa=off" on x86.
0465  */
0466 static inline int pxm_to_online_node(int pxm)
0467 {
0468     int node = pxm_to_node(pxm);
0469 
0470     return numa_map_to_online_node(node);
0471 }
0472 #else
0473 static inline int pxm_to_online_node(int pxm)
0474 {
0475     return 0;
0476 }
0477 static inline int acpi_map_pxm_to_node(int pxm)
0478 {
0479     return 0;
0480 }
0481 static inline int acpi_get_node(acpi_handle handle)
0482 {
0483     return 0;
0484 }
0485 #endif
0486 extern int acpi_paddr_to_node(u64 start_addr, u64 size);
0487 
0488 extern int pnpacpi_disabled;
0489 
0490 #define PXM_INVAL   (-1)
0491 
0492 bool acpi_dev_resource_memory(struct acpi_resource *ares, struct resource *res);
0493 bool acpi_dev_resource_io(struct acpi_resource *ares, struct resource *res);
0494 bool acpi_dev_resource_address_space(struct acpi_resource *ares,
0495                      struct resource_win *win);
0496 bool acpi_dev_resource_ext_address_space(struct acpi_resource *ares,
0497                      struct resource_win *win);
0498 unsigned long acpi_dev_irq_flags(u8 triggering, u8 polarity, u8 shareable);
0499 unsigned int acpi_dev_get_irq_type(int triggering, int polarity);
0500 bool acpi_dev_resource_interrupt(struct acpi_resource *ares, int index,
0501                  struct resource *res);
0502 
0503 void acpi_dev_free_resource_list(struct list_head *list);
0504 int acpi_dev_get_resources(struct acpi_device *adev, struct list_head *list,
0505                int (*preproc)(struct acpi_resource *, void *),
0506                void *preproc_data);
0507 int acpi_dev_get_dma_resources(struct acpi_device *adev,
0508                    struct list_head *list);
0509 int acpi_dev_filter_resource_type(struct acpi_resource *ares,
0510                   unsigned long types);
0511 
0512 static inline int acpi_dev_filter_resource_type_cb(struct acpi_resource *ares,
0513                            void *arg)
0514 {
0515     return acpi_dev_filter_resource_type(ares, (unsigned long)arg);
0516 }
0517 
0518 struct acpi_device *acpi_resource_consumer(struct resource *res);
0519 
0520 int acpi_check_resource_conflict(const struct resource *res);
0521 
0522 int acpi_check_region(resource_size_t start, resource_size_t n,
0523               const char *name);
0524 
0525 int acpi_resources_are_enforced(void);
0526 
0527 #ifdef CONFIG_HIBERNATION
0528 extern int acpi_check_s4_hw_signature;
0529 #endif
0530 
0531 #ifdef CONFIG_PM_SLEEP
0532 void __init acpi_old_suspend_ordering(void);
0533 void __init acpi_nvs_nosave(void);
0534 void __init acpi_nvs_nosave_s3(void);
0535 void __init acpi_sleep_no_blacklist(void);
0536 #endif /* CONFIG_PM_SLEEP */
0537 
0538 int acpi_register_wakeup_handler(
0539     int wake_irq, bool (*wakeup)(void *context), void *context);
0540 void acpi_unregister_wakeup_handler(
0541     bool (*wakeup)(void *context), void *context);
0542 
0543 struct acpi_osc_context {
0544     char *uuid_str;         /* UUID string */
0545     int rev;
0546     struct acpi_buffer cap;     /* list of DWORD capabilities */
0547     struct acpi_buffer ret;     /* free by caller if success */
0548 };
0549 
0550 acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context);
0551 
0552 /* Number of _OSC capability DWORDS depends on bridge type */
0553 #define OSC_PCI_CAPABILITY_DWORDS       3
0554 #define OSC_CXL_CAPABILITY_DWORDS       5
0555 
0556 /* Indexes into _OSC Capabilities Buffer (DWORDs 2 to 5 are device-specific) */
0557 #define OSC_QUERY_DWORD             0   /* DWORD 1 */
0558 #define OSC_SUPPORT_DWORD           1   /* DWORD 2 */
0559 #define OSC_CONTROL_DWORD           2   /* DWORD 3 */
0560 #define OSC_EXT_SUPPORT_DWORD           3   /* DWORD 4 */
0561 #define OSC_EXT_CONTROL_DWORD           4   /* DWORD 5 */
0562 
0563 /* _OSC Capabilities DWORD 1: Query/Control and Error Returns (generic) */
0564 #define OSC_QUERY_ENABLE            0x00000001  /* input */
0565 #define OSC_REQUEST_ERROR           0x00000002  /* return */
0566 #define OSC_INVALID_UUID_ERROR          0x00000004  /* return */
0567 #define OSC_INVALID_REVISION_ERROR      0x00000008  /* return */
0568 #define OSC_CAPABILITIES_MASK_ERROR     0x00000010  /* return */
0569 
0570 /* Platform-Wide Capabilities _OSC: Capabilities DWORD 2: Support Field */
0571 #define OSC_SB_PAD_SUPPORT          0x00000001
0572 #define OSC_SB_PPC_OST_SUPPORT          0x00000002
0573 #define OSC_SB_PR3_SUPPORT          0x00000004
0574 #define OSC_SB_HOTPLUG_OST_SUPPORT      0x00000008
0575 #define OSC_SB_APEI_SUPPORT         0x00000010
0576 #define OSC_SB_CPC_SUPPORT          0x00000020
0577 #define OSC_SB_CPCV2_SUPPORT            0x00000040
0578 #define OSC_SB_PCLPI_SUPPORT            0x00000080
0579 #define OSC_SB_OSLPI_SUPPORT            0x00000100
0580 #define OSC_SB_CPC_DIVERSE_HIGH_SUPPORT     0x00001000
0581 #define OSC_SB_GENERIC_INITIATOR_SUPPORT    0x00002000
0582 #define OSC_SB_CPC_FLEXIBLE_ADR_SPACE       0x00004000
0583 #define OSC_SB_NATIVE_USB4_SUPPORT      0x00040000
0584 #define OSC_SB_PRM_SUPPORT          0x00200000
0585 
0586 extern bool osc_sb_apei_support_acked;
0587 extern bool osc_pc_lpi_support_confirmed;
0588 extern bool osc_sb_native_usb4_support_confirmed;
0589 extern bool osc_sb_cppc2_support_acked;
0590 extern bool osc_cpc_flexible_adr_space_confirmed;
0591 
0592 /* USB4 Capabilities */
0593 #define OSC_USB_USB3_TUNNELING          0x00000001
0594 #define OSC_USB_DP_TUNNELING            0x00000002
0595 #define OSC_USB_PCIE_TUNNELING          0x00000004
0596 #define OSC_USB_XDOMAIN             0x00000008
0597 
0598 extern u32 osc_sb_native_usb4_control;
0599 
0600 /* PCI Host Bridge _OSC: Capabilities DWORD 2: Support Field */
0601 #define OSC_PCI_EXT_CONFIG_SUPPORT      0x00000001
0602 #define OSC_PCI_ASPM_SUPPORT            0x00000002
0603 #define OSC_PCI_CLOCK_PM_SUPPORT        0x00000004
0604 #define OSC_PCI_SEGMENT_GROUPS_SUPPORT      0x00000008
0605 #define OSC_PCI_MSI_SUPPORT         0x00000010
0606 #define OSC_PCI_EDR_SUPPORT         0x00000080
0607 #define OSC_PCI_HPX_TYPE_3_SUPPORT      0x00000100
0608 
0609 /* PCI Host Bridge _OSC: Capabilities DWORD 3: Control Field */
0610 #define OSC_PCI_EXPRESS_NATIVE_HP_CONTROL   0x00000001
0611 #define OSC_PCI_SHPC_NATIVE_HP_CONTROL      0x00000002
0612 #define OSC_PCI_EXPRESS_PME_CONTROL     0x00000004
0613 #define OSC_PCI_EXPRESS_AER_CONTROL     0x00000008
0614 #define OSC_PCI_EXPRESS_CAPABILITY_CONTROL  0x00000010
0615 #define OSC_PCI_EXPRESS_LTR_CONTROL     0x00000020
0616 #define OSC_PCI_EXPRESS_DPC_CONTROL     0x00000080
0617 
0618 /* CXL _OSC: Capabilities DWORD 4: Support Field */
0619 #define OSC_CXL_1_1_PORT_REG_ACCESS_SUPPORT 0x00000001
0620 #define OSC_CXL_2_0_PORT_DEV_REG_ACCESS_SUPPORT 0x00000002
0621 #define OSC_CXL_PROTOCOL_ERR_REPORTING_SUPPORT  0x00000004
0622 #define OSC_CXL_NATIVE_HP_SUPPORT       0x00000008
0623 
0624 /* CXL _OSC: Capabilities DWORD 5: Control Field */
0625 #define OSC_CXL_ERROR_REPORTING_CONTROL     0x00000001
0626 
0627 static inline u32 acpi_osc_ctx_get_pci_control(struct acpi_osc_context *context)
0628 {
0629     u32 *ret = context->ret.pointer;
0630 
0631     return ret[OSC_CONTROL_DWORD];
0632 }
0633 
0634 static inline u32 acpi_osc_ctx_get_cxl_control(struct acpi_osc_context *context)
0635 {
0636     u32 *ret = context->ret.pointer;
0637 
0638     return ret[OSC_EXT_CONTROL_DWORD];
0639 }
0640 
0641 #define ACPI_GSB_ACCESS_ATTRIB_QUICK        0x00000002
0642 #define ACPI_GSB_ACCESS_ATTRIB_SEND_RCV         0x00000004
0643 #define ACPI_GSB_ACCESS_ATTRIB_BYTE     0x00000006
0644 #define ACPI_GSB_ACCESS_ATTRIB_WORD     0x00000008
0645 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK        0x0000000A
0646 #define ACPI_GSB_ACCESS_ATTRIB_MULTIBYTE    0x0000000B
0647 #define ACPI_GSB_ACCESS_ATTRIB_WORD_CALL    0x0000000C
0648 #define ACPI_GSB_ACCESS_ATTRIB_BLOCK_CALL   0x0000000D
0649 #define ACPI_GSB_ACCESS_ATTRIB_RAW_BYTES    0x0000000E
0650 #define ACPI_GSB_ACCESS_ATTRIB_RAW_PROCESS  0x0000000F
0651 
0652 /* Enable _OST when all relevant hotplug operations are enabled */
0653 #if defined(CONFIG_ACPI_HOTPLUG_CPU) &&         \
0654     defined(CONFIG_ACPI_HOTPLUG_MEMORY) &&      \
0655     defined(CONFIG_ACPI_CONTAINER)
0656 #define ACPI_HOTPLUG_OST
0657 #endif
0658 
0659 /* _OST Source Event Code (OSPM Action) */
0660 #define ACPI_OST_EC_OSPM_SHUTDOWN       0x100
0661 #define ACPI_OST_EC_OSPM_EJECT          0x103
0662 #define ACPI_OST_EC_OSPM_INSERTION      0x200
0663 
0664 /* _OST General Processing Status Code */
0665 #define ACPI_OST_SC_SUCCESS         0x0
0666 #define ACPI_OST_SC_NON_SPECIFIC_FAILURE    0x1
0667 #define ACPI_OST_SC_UNRECOGNIZED_NOTIFY     0x2
0668 
0669 /* _OST OS Shutdown Processing (0x100) Status Code */
0670 #define ACPI_OST_SC_OS_SHUTDOWN_DENIED      0x80
0671 #define ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS 0x81
0672 #define ACPI_OST_SC_OS_SHUTDOWN_COMPLETED   0x82
0673 #define ACPI_OST_SC_OS_SHUTDOWN_NOT_SUPPORTED   0x83
0674 
0675 /* _OST Ejection Request (0x3, 0x103) Status Code */
0676 #define ACPI_OST_SC_EJECT_NOT_SUPPORTED     0x80
0677 #define ACPI_OST_SC_DEVICE_IN_USE       0x81
0678 #define ACPI_OST_SC_DEVICE_BUSY         0x82
0679 #define ACPI_OST_SC_EJECT_DEPENDENCY_BUSY   0x83
0680 #define ACPI_OST_SC_EJECT_IN_PROGRESS       0x84
0681 
0682 /* _OST Insertion Request (0x200) Status Code */
0683 #define ACPI_OST_SC_INSERT_IN_PROGRESS      0x80
0684 #define ACPI_OST_SC_DRIVER_LOAD_FAILURE     0x81
0685 #define ACPI_OST_SC_INSERT_NOT_SUPPORTED    0x82
0686 
0687 enum acpi_predicate {
0688     all_versions,
0689     less_than_or_equal,
0690     equal,
0691     greater_than_or_equal,
0692 };
0693 
0694 /* Table must be terminted by a NULL entry */
0695 struct acpi_platform_list {
0696     char    oem_id[ACPI_OEM_ID_SIZE+1];
0697     char    oem_table_id[ACPI_OEM_TABLE_ID_SIZE+1];
0698     u32 oem_revision;
0699     char    *table;
0700     enum acpi_predicate pred;
0701     char    *reason;
0702     u32 data;
0703 };
0704 int acpi_match_platform_list(const struct acpi_platform_list *plat);
0705 
0706 extern void acpi_early_init(void);
0707 extern void acpi_subsystem_init(void);
0708 extern void arch_post_acpi_subsys_init(void);
0709 
0710 extern int acpi_nvs_register(__u64 start, __u64 size);
0711 
0712 extern int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
0713                     void *data);
0714 
0715 const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids,
0716                            const struct device *dev);
0717 
0718 const void *acpi_device_get_match_data(const struct device *dev);
0719 extern bool acpi_driver_match_device(struct device *dev,
0720                      const struct device_driver *drv);
0721 int acpi_device_uevent_modalias(struct device *, struct kobj_uevent_env *);
0722 int acpi_device_modalias(struct device *, char *, int);
0723 
0724 struct platform_device *acpi_create_platform_device(struct acpi_device *,
0725                             const struct property_entry *);
0726 #define ACPI_PTR(_ptr)  (_ptr)
0727 
0728 static inline void acpi_device_set_enumerated(struct acpi_device *adev)
0729 {
0730     adev->flags.visited = true;
0731 }
0732 
0733 static inline void acpi_device_clear_enumerated(struct acpi_device *adev)
0734 {
0735     adev->flags.visited = false;
0736 }
0737 
0738 enum acpi_reconfig_event  {
0739     ACPI_RECONFIG_DEVICE_ADD = 0,
0740     ACPI_RECONFIG_DEVICE_REMOVE,
0741 };
0742 
0743 int acpi_reconfig_notifier_register(struct notifier_block *nb);
0744 int acpi_reconfig_notifier_unregister(struct notifier_block *nb);
0745 
0746 #ifdef CONFIG_ACPI_GTDT
0747 int acpi_gtdt_init(struct acpi_table_header *table, int *platform_timer_count);
0748 int acpi_gtdt_map_ppi(int type);
0749 bool acpi_gtdt_c3stop(int type);
0750 int acpi_arch_timer_mem_init(struct arch_timer_mem *timer_mem, int *timer_count);
0751 #endif
0752 
0753 #ifndef ACPI_HAVE_ARCH_SET_ROOT_POINTER
0754 static inline void acpi_arch_set_root_pointer(u64 addr)
0755 {
0756 }
0757 #endif
0758 
0759 #ifndef ACPI_HAVE_ARCH_GET_ROOT_POINTER
0760 static inline u64 acpi_arch_get_root_pointer(void)
0761 {
0762     return 0;
0763 }
0764 #endif
0765 
0766 int acpi_get_local_address(acpi_handle handle, u32 *addr);
0767 const char *acpi_get_subsystem_id(acpi_handle handle);
0768 
0769 #else   /* !CONFIG_ACPI */
0770 
0771 #define acpi_disabled 1
0772 
0773 #define ACPI_COMPANION(dev)     (NULL)
0774 #define ACPI_COMPANION_SET(dev, adev)   do { } while (0)
0775 #define ACPI_HANDLE(dev)        (NULL)
0776 #define ACPI_HANDLE_FWNODE(fwnode)  (NULL)
0777 #define ACPI_DEVICE_CLASS(_cls, _msk)   .cls = (0), .cls_msk = (0),
0778 
0779 #include <acpi/acpi_numa.h>
0780 
0781 struct fwnode_handle;
0782 
0783 static inline bool acpi_dev_found(const char *hid)
0784 {
0785     return false;
0786 }
0787 
0788 static inline bool acpi_dev_present(const char *hid, const char *uid, s64 hrv)
0789 {
0790     return false;
0791 }
0792 
0793 struct acpi_device;
0794 
0795 static inline bool
0796 acpi_dev_hid_uid_match(struct acpi_device *adev, const char *hid2, const char *uid2)
0797 {
0798     return false;
0799 }
0800 
0801 static inline struct acpi_device *
0802 acpi_dev_get_first_match_dev(const char *hid, const char *uid, s64 hrv)
0803 {
0804     return NULL;
0805 }
0806 
0807 static inline bool acpi_reduced_hardware(void)
0808 {
0809     return false;
0810 }
0811 
0812 static inline void acpi_dev_put(struct acpi_device *adev) {}
0813 
0814 static inline bool is_acpi_node(const struct fwnode_handle *fwnode)
0815 {
0816     return false;
0817 }
0818 
0819 static inline bool is_acpi_device_node(const struct fwnode_handle *fwnode)
0820 {
0821     return false;
0822 }
0823 
0824 static inline struct acpi_device *to_acpi_device_node(const struct fwnode_handle *fwnode)
0825 {
0826     return NULL;
0827 }
0828 
0829 static inline bool is_acpi_data_node(const struct fwnode_handle *fwnode)
0830 {
0831     return false;
0832 }
0833 
0834 static inline struct acpi_data_node *to_acpi_data_node(const struct fwnode_handle *fwnode)
0835 {
0836     return NULL;
0837 }
0838 
0839 static inline bool acpi_data_node_match(const struct fwnode_handle *fwnode,
0840                     const char *name)
0841 {
0842     return false;
0843 }
0844 
0845 static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
0846 {
0847     return NULL;
0848 }
0849 
0850 static inline bool has_acpi_companion(struct device *dev)
0851 {
0852     return false;
0853 }
0854 
0855 static inline void acpi_preset_companion(struct device *dev,
0856                      struct acpi_device *parent, u64 addr)
0857 {
0858 }
0859 
0860 static inline const char *acpi_dev_name(struct acpi_device *adev)
0861 {
0862     return NULL;
0863 }
0864 
0865 static inline struct device *acpi_get_first_physical_node(struct acpi_device *adev)
0866 {
0867     return NULL;
0868 }
0869 
0870 static inline void acpi_early_init(void) { }
0871 static inline void acpi_subsystem_init(void) { }
0872 
0873 static inline int early_acpi_boot_init(void)
0874 {
0875     return 0;
0876 }
0877 static inline int acpi_boot_init(void)
0878 {
0879     return 0;
0880 }
0881 
0882 static inline void acpi_boot_table_prepare(void)
0883 {
0884 }
0885 
0886 static inline void acpi_boot_table_init(void)
0887 {
0888 }
0889 
0890 static inline int acpi_mps_check(void)
0891 {
0892     return 0;
0893 }
0894 
0895 static inline int acpi_check_resource_conflict(struct resource *res)
0896 {
0897     return 0;
0898 }
0899 
0900 static inline int acpi_check_region(resource_size_t start, resource_size_t n,
0901                     const char *name)
0902 {
0903     return 0;
0904 }
0905 
0906 struct acpi_table_header;
0907 static inline int acpi_table_parse(char *id,
0908                 int (*handler)(struct acpi_table_header *))
0909 {
0910     return -ENODEV;
0911 }
0912 
0913 static inline int acpi_nvs_register(__u64 start, __u64 size)
0914 {
0915     return 0;
0916 }
0917 
0918 static inline int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
0919                        void *data)
0920 {
0921     return 0;
0922 }
0923 
0924 struct acpi_device_id;
0925 
0926 static inline const struct acpi_device_id *acpi_match_device(
0927     const struct acpi_device_id *ids, const struct device *dev)
0928 {
0929     return NULL;
0930 }
0931 
0932 static inline const void *acpi_device_get_match_data(const struct device *dev)
0933 {
0934     return NULL;
0935 }
0936 
0937 static inline bool acpi_driver_match_device(struct device *dev,
0938                         const struct device_driver *drv)
0939 {
0940     return false;
0941 }
0942 
0943 static inline union acpi_object *acpi_evaluate_dsm(acpi_handle handle,
0944                            const guid_t *guid,
0945                            u64 rev, u64 func,
0946                            union acpi_object *argv4)
0947 {
0948     return NULL;
0949 }
0950 
0951 static inline int acpi_device_uevent_modalias(struct device *dev,
0952                 struct kobj_uevent_env *env)
0953 {
0954     return -ENODEV;
0955 }
0956 
0957 static inline int acpi_device_modalias(struct device *dev,
0958                 char *buf, int size)
0959 {
0960     return -ENODEV;
0961 }
0962 
0963 static inline struct platform_device *
0964 acpi_create_platform_device(struct acpi_device *adev,
0965                 const struct property_entry *properties)
0966 {
0967     return NULL;
0968 }
0969 
0970 static inline bool acpi_dma_supported(const struct acpi_device *adev)
0971 {
0972     return false;
0973 }
0974 
0975 static inline enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev)
0976 {
0977     return DEV_DMA_NOT_SUPPORTED;
0978 }
0979 
0980 static inline int acpi_dma_get_range(struct device *dev, u64 *dma_addr,
0981                      u64 *offset, u64 *size)
0982 {
0983     return -ENODEV;
0984 }
0985 
0986 static inline int acpi_dma_configure(struct device *dev,
0987                      enum dev_dma_attr attr)
0988 {
0989     return 0;
0990 }
0991 
0992 static inline int acpi_dma_configure_id(struct device *dev,
0993                     enum dev_dma_attr attr,
0994                     const u32 *input_id)
0995 {
0996     return 0;
0997 }
0998 
0999 #define ACPI_PTR(_ptr)  (NULL)
1000 
1001 static inline void acpi_device_set_enumerated(struct acpi_device *adev)
1002 {
1003 }
1004 
1005 static inline void acpi_device_clear_enumerated(struct acpi_device *adev)
1006 {
1007 }
1008 
1009 static inline int acpi_reconfig_notifier_register(struct notifier_block *nb)
1010 {
1011     return -EINVAL;
1012 }
1013 
1014 static inline int acpi_reconfig_notifier_unregister(struct notifier_block *nb)
1015 {
1016     return -EINVAL;
1017 }
1018 
1019 static inline struct acpi_device *acpi_resource_consumer(struct resource *res)
1020 {
1021     return NULL;
1022 }
1023 
1024 static inline int acpi_get_local_address(acpi_handle handle, u32 *addr)
1025 {
1026     return -ENODEV;
1027 }
1028 
1029 static inline const char *acpi_get_subsystem_id(acpi_handle handle)
1030 {
1031     return ERR_PTR(-ENODEV);
1032 }
1033 
1034 static inline int acpi_register_wakeup_handler(int wake_irq,
1035     bool (*wakeup)(void *context), void *context)
1036 {
1037     return -ENXIO;
1038 }
1039 
1040 static inline void acpi_unregister_wakeup_handler(
1041     bool (*wakeup)(void *context), void *context) { }
1042 
1043 struct acpi_osc_context;
1044 static inline u32 acpi_osc_ctx_get_pci_control(struct acpi_osc_context *context)
1045 {
1046     return 0;
1047 }
1048 
1049 static inline u32 acpi_osc_ctx_get_cxl_control(struct acpi_osc_context *context)
1050 {
1051     return 0;
1052 }
1053 
1054 #endif  /* !CONFIG_ACPI */
1055 
1056 #ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
1057 int acpi_ioapic_add(acpi_handle root);
1058 #else
1059 static inline int acpi_ioapic_add(acpi_handle root) { return 0; }
1060 #endif
1061 
1062 #ifdef CONFIG_ACPI
1063 void acpi_os_set_prepare_sleep(int (*func)(u8 sleep_state,
1064                    u32 pm1a_ctrl,  u32 pm1b_ctrl));
1065 
1066 acpi_status acpi_os_prepare_sleep(u8 sleep_state,
1067                   u32 pm1a_control, u32 pm1b_control);
1068 
1069 void acpi_os_set_prepare_extended_sleep(int (*func)(u8 sleep_state,
1070                         u32 val_a,  u32 val_b));
1071 
1072 acpi_status acpi_os_prepare_extended_sleep(u8 sleep_state,
1073                        u32 val_a, u32 val_b);
1074 #ifdef CONFIG_X86
1075 struct acpi_s2idle_dev_ops {
1076     struct list_head list_node;
1077     void (*prepare)(void);
1078     void (*restore)(void);
1079 };
1080 int acpi_register_lps0_dev(struct acpi_s2idle_dev_ops *arg);
1081 void acpi_unregister_lps0_dev(struct acpi_s2idle_dev_ops *arg);
1082 #endif /* CONFIG_X86 */
1083 #ifndef CONFIG_IA64
1084 void arch_reserve_mem_area(acpi_physical_address addr, size_t size);
1085 #else
1086 static inline void arch_reserve_mem_area(acpi_physical_address addr,
1087                       size_t size)
1088 {
1089 }
1090 #endif /* CONFIG_X86 */
1091 #else
1092 #define acpi_os_set_prepare_sleep(func, pm1a_ctrl, pm1b_ctrl) do { } while (0)
1093 #endif
1094 
1095 #if defined(CONFIG_ACPI) && defined(CONFIG_PM)
1096 int acpi_dev_suspend(struct device *dev, bool wakeup);
1097 int acpi_dev_resume(struct device *dev);
1098 int acpi_subsys_runtime_suspend(struct device *dev);
1099 int acpi_subsys_runtime_resume(struct device *dev);
1100 int acpi_dev_pm_attach(struct device *dev, bool power_on);
1101 bool acpi_storage_d3(struct device *dev);
1102 bool acpi_dev_state_d0(struct device *dev);
1103 #else
1104 static inline int acpi_subsys_runtime_suspend(struct device *dev) { return 0; }
1105 static inline int acpi_subsys_runtime_resume(struct device *dev) { return 0; }
1106 static inline int acpi_dev_pm_attach(struct device *dev, bool power_on)
1107 {
1108     return 0;
1109 }
1110 static inline bool acpi_storage_d3(struct device *dev)
1111 {
1112     return false;
1113 }
1114 static inline bool acpi_dev_state_d0(struct device *dev)
1115 {
1116     return true;
1117 }
1118 #endif
1119 
1120 #if defined(CONFIG_ACPI) && defined(CONFIG_PM_SLEEP)
1121 int acpi_subsys_prepare(struct device *dev);
1122 void acpi_subsys_complete(struct device *dev);
1123 int acpi_subsys_suspend_late(struct device *dev);
1124 int acpi_subsys_suspend_noirq(struct device *dev);
1125 int acpi_subsys_suspend(struct device *dev);
1126 int acpi_subsys_freeze(struct device *dev);
1127 int acpi_subsys_poweroff(struct device *dev);
1128 void acpi_ec_mark_gpe_for_wake(void);
1129 void acpi_ec_set_gpe_wake_mask(u8 action);
1130 #else
1131 static inline int acpi_subsys_prepare(struct device *dev) { return 0; }
1132 static inline void acpi_subsys_complete(struct device *dev) {}
1133 static inline int acpi_subsys_suspend_late(struct device *dev) { return 0; }
1134 static inline int acpi_subsys_suspend_noirq(struct device *dev) { return 0; }
1135 static inline int acpi_subsys_suspend(struct device *dev) { return 0; }
1136 static inline int acpi_subsys_freeze(struct device *dev) { return 0; }
1137 static inline int acpi_subsys_poweroff(struct device *dev) { return 0; }
1138 static inline void acpi_ec_mark_gpe_for_wake(void) {}
1139 static inline void acpi_ec_set_gpe_wake_mask(u8 action) {}
1140 #endif
1141 
1142 #ifdef CONFIG_ACPI
1143 __printf(3, 4)
1144 void acpi_handle_printk(const char *level, acpi_handle handle,
1145             const char *fmt, ...);
1146 void acpi_evaluation_failure_warn(acpi_handle handle, const char *name,
1147                   acpi_status status);
1148 #else   /* !CONFIG_ACPI */
1149 static inline __printf(3, 4) void
1150 acpi_handle_printk(const char *level, void *handle, const char *fmt, ...) {}
1151 static inline void acpi_evaluation_failure_warn(acpi_handle handle,
1152                         const char *name,
1153                         acpi_status status) {}
1154 #endif  /* !CONFIG_ACPI */
1155 
1156 #if defined(CONFIG_ACPI) && defined(CONFIG_DYNAMIC_DEBUG)
1157 __printf(3, 4)
1158 void __acpi_handle_debug(struct _ddebug *descriptor, acpi_handle handle, const char *fmt, ...);
1159 #endif
1160 
1161 /*
1162  * acpi_handle_<level>: Print message with ACPI prefix and object path
1163  *
1164  * These interfaces acquire the global namespace mutex to obtain an object
1165  * path.  In interrupt context, it shows the object path as <n/a>.
1166  */
1167 #define acpi_handle_emerg(handle, fmt, ...)             \
1168     acpi_handle_printk(KERN_EMERG, handle, fmt, ##__VA_ARGS__)
1169 #define acpi_handle_alert(handle, fmt, ...)             \
1170     acpi_handle_printk(KERN_ALERT, handle, fmt, ##__VA_ARGS__)
1171 #define acpi_handle_crit(handle, fmt, ...)              \
1172     acpi_handle_printk(KERN_CRIT, handle, fmt, ##__VA_ARGS__)
1173 #define acpi_handle_err(handle, fmt, ...)               \
1174     acpi_handle_printk(KERN_ERR, handle, fmt, ##__VA_ARGS__)
1175 #define acpi_handle_warn(handle, fmt, ...)              \
1176     acpi_handle_printk(KERN_WARNING, handle, fmt, ##__VA_ARGS__)
1177 #define acpi_handle_notice(handle, fmt, ...)                \
1178     acpi_handle_printk(KERN_NOTICE, handle, fmt, ##__VA_ARGS__)
1179 #define acpi_handle_info(handle, fmt, ...)              \
1180     acpi_handle_printk(KERN_INFO, handle, fmt, ##__VA_ARGS__)
1181 
1182 #if defined(DEBUG)
1183 #define acpi_handle_debug(handle, fmt, ...)             \
1184     acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__)
1185 #else
1186 #if defined(CONFIG_DYNAMIC_DEBUG)
1187 #define acpi_handle_debug(handle, fmt, ...)             \
1188     _dynamic_func_call(fmt, __acpi_handle_debug,            \
1189                handle, pr_fmt(fmt), ##__VA_ARGS__)
1190 #else
1191 #define acpi_handle_debug(handle, fmt, ...)             \
1192 ({                                  \
1193     if (0)                              \
1194         acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__); \
1195     0;                              \
1196 })
1197 #endif
1198 #endif
1199 
1200 #if defined(CONFIG_ACPI) && defined(CONFIG_GPIOLIB)
1201 bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
1202                 struct acpi_resource_gpio **agpio);
1203 bool acpi_gpio_get_io_resource(struct acpi_resource *ares,
1204                    struct acpi_resource_gpio **agpio);
1205 int acpi_dev_gpio_irq_get_by(struct acpi_device *adev, const char *name, int index);
1206 #else
1207 static inline bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
1208                           struct acpi_resource_gpio **agpio)
1209 {
1210     return false;
1211 }
1212 static inline bool acpi_gpio_get_io_resource(struct acpi_resource *ares,
1213                          struct acpi_resource_gpio **agpio)
1214 {
1215     return false;
1216 }
1217 static inline int acpi_dev_gpio_irq_get_by(struct acpi_device *adev,
1218                        const char *name, int index)
1219 {
1220     return -ENXIO;
1221 }
1222 #endif
1223 
1224 static inline int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index)
1225 {
1226     return acpi_dev_gpio_irq_get_by(adev, NULL, index);
1227 }
1228 
1229 /* Device properties */
1230 
1231 #ifdef CONFIG_ACPI
1232 int acpi_dev_get_property(const struct acpi_device *adev, const char *name,
1233               acpi_object_type type, const union acpi_object **obj);
1234 int __acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1235                 const char *name, size_t index, size_t num_args,
1236                 struct fwnode_reference_args *args);
1237 
1238 static inline int acpi_node_get_property_reference(
1239                 const struct fwnode_handle *fwnode,
1240                 const char *name, size_t index,
1241                 struct fwnode_reference_args *args)
1242 {
1243     return __acpi_node_get_property_reference(fwnode, name, index,
1244         NR_FWNODE_REFERENCE_ARGS, args);
1245 }
1246 
1247 static inline bool acpi_dev_has_props(const struct acpi_device *adev)
1248 {
1249     return !list_empty(&adev->data.properties);
1250 }
1251 
1252 struct acpi_device_properties *
1253 acpi_data_add_props(struct acpi_device_data *data, const guid_t *guid,
1254             union acpi_object *properties);
1255 
1256 int acpi_node_prop_get(const struct fwnode_handle *fwnode, const char *propname,
1257                void **valptr);
1258 
1259 struct fwnode_handle *acpi_get_next_subnode(const struct fwnode_handle *fwnode,
1260                         struct fwnode_handle *child);
1261 
1262 struct acpi_probe_entry;
1263 typedef bool (*acpi_probe_entry_validate_subtbl)(struct acpi_subtable_header *,
1264                          struct acpi_probe_entry *);
1265 
1266 #define ACPI_TABLE_ID_LEN   5
1267 
1268 /**
1269  * struct acpi_probe_entry - boot-time probing entry
1270  * @id:         ACPI table name
1271  * @type:       Optional subtable type to match
1272  *          (if @id contains subtables)
1273  * @subtable_valid: Optional callback to check the validity of
1274  *          the subtable
1275  * @probe_table:    Callback to the driver being probed when table
1276  *          match is successful
1277  * @probe_subtbl:   Callback to the driver being probed when table and
1278  *          subtable match (and optional callback is successful)
1279  * @driver_data:    Sideband data provided back to the driver
1280  */
1281 struct acpi_probe_entry {
1282     __u8 id[ACPI_TABLE_ID_LEN];
1283     __u8 type;
1284     acpi_probe_entry_validate_subtbl subtable_valid;
1285     union {
1286         acpi_tbl_table_handler probe_table;
1287         acpi_tbl_entry_handler probe_subtbl;
1288     };
1289     kernel_ulong_t driver_data;
1290 };
1291 
1292 #define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable,   \
1293                  valid, data, fn)           \
1294     static const struct acpi_probe_entry __acpi_probe_##name    \
1295         __used __section("__" #table "_acpi_probe_table") = {   \
1296             .id = table_id,                 \
1297             .type = subtable,               \
1298             .subtable_valid = valid,            \
1299             .probe_table = fn,              \
1300             .driver_data = data,                \
1301         }
1302 
1303 #define ACPI_DECLARE_SUBTABLE_PROBE_ENTRY(table, name, table_id,    \
1304                       subtable, valid, data, fn)    \
1305     static const struct acpi_probe_entry __acpi_probe_##name    \
1306         __used __section("__" #table "_acpi_probe_table") = {   \
1307             .id = table_id,                 \
1308             .type = subtable,               \
1309             .subtable_valid = valid,            \
1310             .probe_subtbl = fn,             \
1311             .driver_data = data,                \
1312         }
1313 
1314 #define ACPI_PROBE_TABLE(name)      __##name##_acpi_probe_table
1315 #define ACPI_PROBE_TABLE_END(name)  __##name##_acpi_probe_table_end
1316 
1317 int __acpi_probe_device_table(struct acpi_probe_entry *start, int nr);
1318 
1319 #define acpi_probe_device_table(t)                  \
1320     ({                              \
1321         extern struct acpi_probe_entry ACPI_PROBE_TABLE(t), \
1322                                    ACPI_PROBE_TABLE_END(t); \
1323         __acpi_probe_device_table(&ACPI_PROBE_TABLE(t),     \
1324                       (&ACPI_PROBE_TABLE_END(t) -   \
1325                        &ACPI_PROBE_TABLE(t)));  \
1326     })
1327 #else
1328 static inline int acpi_dev_get_property(struct acpi_device *adev,
1329                     const char *name, acpi_object_type type,
1330                     const union acpi_object **obj)
1331 {
1332     return -ENXIO;
1333 }
1334 
1335 static inline int
1336 __acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1337                 const char *name, size_t index, size_t num_args,
1338                 struct fwnode_reference_args *args)
1339 {
1340     return -ENXIO;
1341 }
1342 
1343 static inline int
1344 acpi_node_get_property_reference(const struct fwnode_handle *fwnode,
1345                  const char *name, size_t index,
1346                  struct fwnode_reference_args *args)
1347 {
1348     return -ENXIO;
1349 }
1350 
1351 static inline int acpi_node_prop_get(const struct fwnode_handle *fwnode,
1352                      const char *propname,
1353                      void **valptr)
1354 {
1355     return -ENXIO;
1356 }
1357 
1358 static inline struct fwnode_handle *
1359 acpi_get_next_subnode(const struct fwnode_handle *fwnode,
1360               struct fwnode_handle *child)
1361 {
1362     return NULL;
1363 }
1364 
1365 static inline struct fwnode_handle *
1366 acpi_graph_get_next_endpoint(const struct fwnode_handle *fwnode,
1367                  struct fwnode_handle *prev)
1368 {
1369     return ERR_PTR(-ENXIO);
1370 }
1371 
1372 static inline int
1373 acpi_graph_get_remote_endpoint(const struct fwnode_handle *fwnode,
1374                    struct fwnode_handle **remote,
1375                    struct fwnode_handle **port,
1376                    struct fwnode_handle **endpoint)
1377 {
1378     return -ENXIO;
1379 }
1380 
1381 #define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, valid, data, fn) \
1382     static const void * __acpi_table_##name[]           \
1383         __attribute__((unused))                 \
1384          = { (void *) table_id,                 \
1385              (void *) subtable,                 \
1386              (void *) valid,                    \
1387              (void *) fn,                   \
1388              (void *) data }
1389 
1390 #define acpi_probe_device_table(t)  ({ int __r = 0; __r;})
1391 #endif
1392 
1393 #ifdef CONFIG_ACPI_TABLE_UPGRADE
1394 void acpi_table_upgrade(void);
1395 #else
1396 static inline void acpi_table_upgrade(void) { }
1397 #endif
1398 
1399 #if defined(CONFIG_ACPI) && defined(CONFIG_ACPI_WATCHDOG)
1400 extern bool acpi_has_watchdog(void);
1401 #else
1402 static inline bool acpi_has_watchdog(void) { return false; }
1403 #endif
1404 
1405 #ifdef CONFIG_ACPI_SPCR_TABLE
1406 extern bool qdf2400_e44_present;
1407 int acpi_parse_spcr(bool enable_earlycon, bool enable_console);
1408 #else
1409 static inline int acpi_parse_spcr(bool enable_earlycon, bool enable_console)
1410 {
1411     return 0;
1412 }
1413 #endif
1414 
1415 #if IS_ENABLED(CONFIG_ACPI_GENERIC_GSI)
1416 int acpi_irq_get(acpi_handle handle, unsigned int index, struct resource *res);
1417 #else
1418 static inline
1419 int acpi_irq_get(acpi_handle handle, unsigned int index, struct resource *res)
1420 {
1421     return -EINVAL;
1422 }
1423 #endif
1424 
1425 #ifdef CONFIG_ACPI_LPIT
1426 int lpit_read_residency_count_address(u64 *address);
1427 #else
1428 static inline int lpit_read_residency_count_address(u64 *address)
1429 {
1430     return -EINVAL;
1431 }
1432 #endif
1433 
1434 #ifdef CONFIG_ACPI_PPTT
1435 int acpi_pptt_cpu_is_thread(unsigned int cpu);
1436 int find_acpi_cpu_topology(unsigned int cpu, int level);
1437 int find_acpi_cpu_topology_cluster(unsigned int cpu);
1438 int find_acpi_cpu_topology_package(unsigned int cpu);
1439 int find_acpi_cpu_topology_hetero_id(unsigned int cpu);
1440 #else
1441 static inline int acpi_pptt_cpu_is_thread(unsigned int cpu)
1442 {
1443     return -EINVAL;
1444 }
1445 static inline int find_acpi_cpu_topology(unsigned int cpu, int level)
1446 {
1447     return -EINVAL;
1448 }
1449 static inline int find_acpi_cpu_topology_cluster(unsigned int cpu)
1450 {
1451     return -EINVAL;
1452 }
1453 static inline int find_acpi_cpu_topology_package(unsigned int cpu)
1454 {
1455     return -EINVAL;
1456 }
1457 static inline int find_acpi_cpu_topology_hetero_id(unsigned int cpu)
1458 {
1459     return -EINVAL;
1460 }
1461 #endif
1462 
1463 #ifdef CONFIG_ACPI_PCC
1464 void acpi_init_pcc(void);
1465 #else
1466 static inline void acpi_init_pcc(void) { }
1467 #endif
1468 
1469 #ifdef CONFIG_ACPI
1470 extern void acpi_device_notify(struct device *dev);
1471 extern void acpi_device_notify_remove(struct device *dev);
1472 #else
1473 static inline void acpi_device_notify(struct device *dev) { }
1474 static inline void acpi_device_notify_remove(struct device *dev) { }
1475 #endif
1476 
1477 #endif  /*_LINUX_ACPI_H*/