acpi.h 30 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022
  1. /*
  2. * acpi.h - ACPI Interface
  3. *
  4. * Copyright (C) 2001 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
  5. *
  6. * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  7. *
  8. * This program is free software; you can redistribute it and/or modify
  9. * it under the terms of the GNU General Public License as published by
  10. * the Free Software Foundation; either version 2 of the License, or
  11. * (at your option) any later version.
  12. *
  13. * This program is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. * GNU General Public License for more details.
  17. *
  18. * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  19. */
  20. #ifndef _LINUX_ACPI_H
  21. #define _LINUX_ACPI_H
  22. #include <linux/errno.h>
  23. #include <linux/ioport.h> /* for struct resource */
  24. #include <linux/resource_ext.h>
  25. #include <linux/device.h>
  26. #include <linux/property.h>
  27. #ifndef _LINUX
  28. #define _LINUX
  29. #endif
  30. #include <acpi/acpi.h>
  31. #ifdef CONFIG_ACPI
  32. #include <linux/list.h>
  33. #include <linux/mod_devicetable.h>
  34. #include <linux/dynamic_debug.h>
  35. #include <linux/module.h>
  36. #include <linux/mutex.h>
  37. #include <acpi/acpi_bus.h>
  38. #include <acpi/acpi_drivers.h>
  39. #include <acpi/acpi_numa.h>
  40. #include <acpi/acpi_io.h>
  41. #include <asm/acpi.h>
  42. static inline acpi_handle acpi_device_handle(struct acpi_device *adev)
  43. {
  44. return adev ? adev->handle : NULL;
  45. }
  46. #define ACPI_COMPANION(dev) to_acpi_device_node((dev)->fwnode)
  47. #define ACPI_COMPANION_SET(dev, adev) set_primary_fwnode(dev, (adev) ? \
  48. acpi_fwnode_handle(adev) : NULL)
  49. #define ACPI_HANDLE(dev) acpi_device_handle(ACPI_COMPANION(dev))
  50. /**
  51. * ACPI_DEVICE_CLASS - macro used to describe an ACPI device with
  52. * the PCI-defined class-code information
  53. *
  54. * @_cls : the class, subclass, prog-if triple for this device
  55. * @_msk : the class mask for this device
  56. *
  57. * This macro is used to create a struct acpi_device_id that matches a
  58. * specific PCI class. The .id and .driver_data fields will be left
  59. * initialized with the default value.
  60. */
  61. #define ACPI_DEVICE_CLASS(_cls, _msk) .cls = (_cls), .cls_msk = (_msk),
  62. static inline bool has_acpi_companion(struct device *dev)
  63. {
  64. return is_acpi_device_node(dev->fwnode);
  65. }
  66. static inline void acpi_preset_companion(struct device *dev,
  67. struct acpi_device *parent, u64 addr)
  68. {
  69. ACPI_COMPANION_SET(dev, acpi_find_child_device(parent, addr, NULL));
  70. }
  71. static inline const char *acpi_dev_name(struct acpi_device *adev)
  72. {
  73. return dev_name(&adev->dev);
  74. }
  75. enum acpi_irq_model_id {
  76. ACPI_IRQ_MODEL_PIC = 0,
  77. ACPI_IRQ_MODEL_IOAPIC,
  78. ACPI_IRQ_MODEL_IOSAPIC,
  79. ACPI_IRQ_MODEL_PLATFORM,
  80. ACPI_IRQ_MODEL_GIC,
  81. ACPI_IRQ_MODEL_COUNT
  82. };
  83. extern enum acpi_irq_model_id acpi_irq_model;
  84. enum acpi_interrupt_id {
  85. ACPI_INTERRUPT_PMI = 1,
  86. ACPI_INTERRUPT_INIT,
  87. ACPI_INTERRUPT_CPEI,
  88. ACPI_INTERRUPT_COUNT
  89. };
  90. #define ACPI_SPACE_MEM 0
  91. enum acpi_address_range_id {
  92. ACPI_ADDRESS_RANGE_MEMORY = 1,
  93. ACPI_ADDRESS_RANGE_RESERVED = 2,
  94. ACPI_ADDRESS_RANGE_ACPI = 3,
  95. ACPI_ADDRESS_RANGE_NVS = 4,
  96. ACPI_ADDRESS_RANGE_COUNT
  97. };
  98. /* Table Handlers */
  99. typedef int (*acpi_tbl_table_handler)(struct acpi_table_header *table);
  100. typedef int (*acpi_tbl_entry_handler)(struct acpi_subtable_header *header,
  101. const unsigned long end);
  102. /* Debugger support */
  103. struct acpi_debugger_ops {
  104. int (*create_thread)(acpi_osd_exec_callback function, void *context);
  105. ssize_t (*write_log)(const char *msg);
  106. ssize_t (*read_cmd)(char *buffer, size_t length);
  107. int (*wait_command_ready)(bool single_step, char *buffer, size_t length);
  108. int (*notify_command_complete)(void);
  109. };
  110. struct acpi_debugger {
  111. const struct acpi_debugger_ops *ops;
  112. struct module *owner;
  113. struct mutex lock;
  114. };
  115. #ifdef CONFIG_ACPI_DEBUGGER
  116. int __init acpi_debugger_init(void);
  117. int acpi_register_debugger(struct module *owner,
  118. const struct acpi_debugger_ops *ops);
  119. void acpi_unregister_debugger(const struct acpi_debugger_ops *ops);
  120. int acpi_debugger_create_thread(acpi_osd_exec_callback function, void *context);
  121. ssize_t acpi_debugger_write_log(const char *msg);
  122. ssize_t acpi_debugger_read_cmd(char *buffer, size_t buffer_length);
  123. int acpi_debugger_wait_command_ready(void);
  124. int acpi_debugger_notify_command_complete(void);
  125. #else
  126. static inline int acpi_debugger_init(void)
  127. {
  128. return -ENODEV;
  129. }
  130. static inline int acpi_register_debugger(struct module *owner,
  131. const struct acpi_debugger_ops *ops)
  132. {
  133. return -ENODEV;
  134. }
  135. static inline void acpi_unregister_debugger(const struct acpi_debugger_ops *ops)
  136. {
  137. }
  138. static inline int acpi_debugger_create_thread(acpi_osd_exec_callback function,
  139. void *context)
  140. {
  141. return -ENODEV;
  142. }
  143. static inline int acpi_debugger_write_log(const char *msg)
  144. {
  145. return -ENODEV;
  146. }
  147. static inline int acpi_debugger_read_cmd(char *buffer, u32 buffer_length)
  148. {
  149. return -ENODEV;
  150. }
  151. static inline int acpi_debugger_wait_command_ready(void)
  152. {
  153. return -ENODEV;
  154. }
  155. static inline int acpi_debugger_notify_command_complete(void)
  156. {
  157. return -ENODEV;
  158. }
  159. #endif
  160. #define BAD_MADT_ENTRY(entry, end) ( \
  161. (!entry) || (unsigned long)entry + sizeof(*entry) > end || \
  162. ((struct acpi_subtable_header *)entry)->length < sizeof(*entry))
  163. struct acpi_subtable_proc {
  164. int id;
  165. acpi_tbl_entry_handler handler;
  166. int count;
  167. };
  168. char * __acpi_map_table (unsigned long phys_addr, unsigned long size);
  169. void __acpi_unmap_table(char *map, unsigned long size);
  170. int early_acpi_boot_init(void);
  171. int acpi_boot_init (void);
  172. void acpi_boot_table_init (void);
  173. int acpi_mps_check (void);
  174. int acpi_numa_init (void);
  175. int acpi_table_init (void);
  176. int acpi_table_parse(char *id, acpi_tbl_table_handler handler);
  177. int __init acpi_parse_entries(char *id, unsigned long table_size,
  178. acpi_tbl_entry_handler handler,
  179. struct acpi_table_header *table_header,
  180. int entry_id, unsigned int max_entries);
  181. int __init acpi_table_parse_entries(char *id, unsigned long table_size,
  182. int entry_id,
  183. acpi_tbl_entry_handler handler,
  184. unsigned int max_entries);
  185. int __init acpi_table_parse_entries(char *id, unsigned long table_size,
  186. int entry_id,
  187. acpi_tbl_entry_handler handler,
  188. unsigned int max_entries);
  189. int __init acpi_table_parse_entries_array(char *id, unsigned long table_size,
  190. struct acpi_subtable_proc *proc, int proc_num,
  191. unsigned int max_entries);
  192. int acpi_table_parse_madt(enum acpi_madt_type id,
  193. acpi_tbl_entry_handler handler,
  194. unsigned int max_entries);
  195. int acpi_parse_mcfg (struct acpi_table_header *header);
  196. void acpi_table_print_madt_entry (struct acpi_subtable_header *madt);
  197. /* the following four functions are architecture-dependent */
  198. void acpi_numa_slit_init (struct acpi_table_slit *slit);
  199. void acpi_numa_processor_affinity_init (struct acpi_srat_cpu_affinity *pa);
  200. void acpi_numa_x2apic_affinity_init(struct acpi_srat_x2apic_cpu_affinity *pa);
  201. int acpi_numa_memory_affinity_init (struct acpi_srat_mem_affinity *ma);
  202. void acpi_numa_arch_fixup(void);
  203. #ifndef PHYS_CPUID_INVALID
  204. typedef u32 phys_cpuid_t;
  205. #define PHYS_CPUID_INVALID (phys_cpuid_t)(-1)
  206. #endif
  207. static inline bool invalid_logical_cpuid(u32 cpuid)
  208. {
  209. return (int)cpuid < 0;
  210. }
  211. static inline bool invalid_phys_cpuid(phys_cpuid_t phys_id)
  212. {
  213. return phys_id == PHYS_CPUID_INVALID;
  214. }
  215. #ifdef CONFIG_ACPI_HOTPLUG_CPU
  216. /* Arch dependent functions for cpu hotplug support */
  217. int acpi_map_cpu(acpi_handle handle, phys_cpuid_t physid, int *pcpu);
  218. int acpi_unmap_cpu(int cpu);
  219. #endif /* CONFIG_ACPI_HOTPLUG_CPU */
  220. #ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
  221. int acpi_get_ioapic_id(acpi_handle handle, u32 gsi_base, u64 *phys_addr);
  222. #endif
  223. int acpi_register_ioapic(acpi_handle handle, u64 phys_addr, u32 gsi_base);
  224. int acpi_unregister_ioapic(acpi_handle handle, u32 gsi_base);
  225. int acpi_ioapic_registered(acpi_handle handle, u32 gsi_base);
  226. void acpi_irq_stats_init(void);
  227. extern u32 acpi_irq_handled;
  228. extern u32 acpi_irq_not_handled;
  229. extern unsigned int acpi_sci_irq;
  230. extern bool acpi_no_s5;
  231. #define INVALID_ACPI_IRQ ((unsigned)-1)
  232. static inline bool acpi_sci_irq_valid(void)
  233. {
  234. return acpi_sci_irq != INVALID_ACPI_IRQ;
  235. }
  236. extern int sbf_port;
  237. extern unsigned long acpi_realmode_flags;
  238. int acpi_register_gsi (struct device *dev, u32 gsi, int triggering, int polarity);
  239. int acpi_gsi_to_irq (u32 gsi, unsigned int *irq);
  240. int acpi_isa_irq_to_gsi (unsigned isa_irq, u32 *gsi);
  241. void acpi_set_irq_model(enum acpi_irq_model_id model,
  242. struct fwnode_handle *fwnode);
  243. #ifdef CONFIG_X86_IO_APIC
  244. extern int acpi_get_override_irq(u32 gsi, int *trigger, int *polarity);
  245. #else
  246. #define acpi_get_override_irq(gsi, trigger, polarity) (-1)
  247. #endif
  248. /*
  249. * This function undoes the effect of one call to acpi_register_gsi().
  250. * If this matches the last registration, any IRQ resources for gsi
  251. * are freed.
  252. */
  253. void acpi_unregister_gsi (u32 gsi);
  254. struct pci_dev;
  255. int acpi_pci_irq_enable (struct pci_dev *dev);
  256. void acpi_penalize_isa_irq(int irq, int active);
  257. bool acpi_isa_irq_available(int irq);
  258. void acpi_pci_irq_disable (struct pci_dev *dev);
  259. extern int ec_read(u8 addr, u8 *val);
  260. extern int ec_write(u8 addr, u8 val);
  261. extern int ec_transaction(u8 command,
  262. const u8 *wdata, unsigned wdata_len,
  263. u8 *rdata, unsigned rdata_len);
  264. extern acpi_handle ec_get_handle(void);
  265. extern bool acpi_is_pnp_device(struct acpi_device *);
  266. #if defined(CONFIG_ACPI_WMI) || defined(CONFIG_ACPI_WMI_MODULE)
  267. typedef void (*wmi_notify_handler) (u32 value, void *context);
  268. extern acpi_status wmi_evaluate_method(const char *guid, u8 instance,
  269. u32 method_id,
  270. const struct acpi_buffer *in,
  271. struct acpi_buffer *out);
  272. extern acpi_status wmi_query_block(const char *guid, u8 instance,
  273. struct acpi_buffer *out);
  274. extern acpi_status wmi_set_block(const char *guid, u8 instance,
  275. const struct acpi_buffer *in);
  276. extern acpi_status wmi_install_notify_handler(const char *guid,
  277. wmi_notify_handler handler, void *data);
  278. extern acpi_status wmi_remove_notify_handler(const char *guid);
  279. extern acpi_status wmi_get_event_data(u32 event, struct acpi_buffer *out);
  280. extern bool wmi_has_guid(const char *guid);
  281. #endif /* CONFIG_ACPI_WMI */
  282. #define ACPI_VIDEO_OUTPUT_SWITCHING 0x0001
  283. #define ACPI_VIDEO_DEVICE_POSTING 0x0002
  284. #define ACPI_VIDEO_ROM_AVAILABLE 0x0004
  285. #define ACPI_VIDEO_BACKLIGHT 0x0008
  286. #define ACPI_VIDEO_BACKLIGHT_FORCE_VENDOR 0x0010
  287. #define ACPI_VIDEO_BACKLIGHT_FORCE_VIDEO 0x0020
  288. #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VENDOR 0x0040
  289. #define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VIDEO 0x0080
  290. #define ACPI_VIDEO_BACKLIGHT_DMI_VENDOR 0x0100
  291. #define ACPI_VIDEO_BACKLIGHT_DMI_VIDEO 0x0200
  292. #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VENDOR 0x0400
  293. #define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VIDEO 0x0800
  294. extern char acpi_video_backlight_string[];
  295. extern long acpi_is_video_device(acpi_handle handle);
  296. extern int acpi_blacklisted(void);
  297. extern void acpi_osi_setup(char *str);
  298. extern bool acpi_osi_is_win8(void);
  299. #ifdef CONFIG_ACPI_NUMA
  300. int acpi_map_pxm_to_online_node(int pxm);
  301. int acpi_get_node(acpi_handle handle);
  302. #else
  303. static inline int acpi_map_pxm_to_online_node(int pxm)
  304. {
  305. return 0;
  306. }
  307. static inline int acpi_get_node(acpi_handle handle)
  308. {
  309. return 0;
  310. }
  311. #endif
  312. extern int acpi_paddr_to_node(u64 start_addr, u64 size);
  313. extern int pnpacpi_disabled;
  314. #define PXM_INVAL (-1)
  315. bool acpi_dev_resource_memory(struct acpi_resource *ares, struct resource *res);
  316. bool acpi_dev_resource_io(struct acpi_resource *ares, struct resource *res);
  317. bool acpi_dev_resource_address_space(struct acpi_resource *ares,
  318. struct resource_win *win);
  319. bool acpi_dev_resource_ext_address_space(struct acpi_resource *ares,
  320. struct resource_win *win);
  321. unsigned long acpi_dev_irq_flags(u8 triggering, u8 polarity, u8 shareable);
  322. unsigned int acpi_dev_get_irq_type(int triggering, int polarity);
  323. bool acpi_dev_resource_interrupt(struct acpi_resource *ares, int index,
  324. struct resource *res);
  325. void acpi_dev_free_resource_list(struct list_head *list);
  326. int acpi_dev_get_resources(struct acpi_device *adev, struct list_head *list,
  327. int (*preproc)(struct acpi_resource *, void *),
  328. void *preproc_data);
  329. int acpi_dev_filter_resource_type(struct acpi_resource *ares,
  330. unsigned long types);
  331. static inline int acpi_dev_filter_resource_type_cb(struct acpi_resource *ares,
  332. void *arg)
  333. {
  334. return acpi_dev_filter_resource_type(ares, (unsigned long)arg);
  335. }
  336. int acpi_check_resource_conflict(const struct resource *res);
  337. int acpi_check_region(resource_size_t start, resource_size_t n,
  338. const char *name);
  339. int acpi_resources_are_enforced(void);
  340. #ifdef CONFIG_HIBERNATION
  341. void __init acpi_no_s4_hw_signature(void);
  342. #endif
  343. #ifdef CONFIG_PM_SLEEP
  344. void __init acpi_old_suspend_ordering(void);
  345. void __init acpi_nvs_nosave(void);
  346. void __init acpi_nvs_nosave_s3(void);
  347. #endif /* CONFIG_PM_SLEEP */
  348. struct acpi_osc_context {
  349. char *uuid_str; /* UUID string */
  350. int rev;
  351. struct acpi_buffer cap; /* list of DWORD capabilities */
  352. struct acpi_buffer ret; /* free by caller if success */
  353. };
  354. acpi_status acpi_str_to_uuid(char *str, u8 *uuid);
  355. acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context);
  356. /* Indexes into _OSC Capabilities Buffer (DWORDs 2 & 3 are device-specific) */
  357. #define OSC_QUERY_DWORD 0 /* DWORD 1 */
  358. #define OSC_SUPPORT_DWORD 1 /* DWORD 2 */
  359. #define OSC_CONTROL_DWORD 2 /* DWORD 3 */
  360. /* _OSC Capabilities DWORD 1: Query/Control and Error Returns (generic) */
  361. #define OSC_QUERY_ENABLE 0x00000001 /* input */
  362. #define OSC_REQUEST_ERROR 0x00000002 /* return */
  363. #define OSC_INVALID_UUID_ERROR 0x00000004 /* return */
  364. #define OSC_INVALID_REVISION_ERROR 0x00000008 /* return */
  365. #define OSC_CAPABILITIES_MASK_ERROR 0x00000010 /* return */
  366. /* Platform-Wide Capabilities _OSC: Capabilities DWORD 2: Support Field */
  367. #define OSC_SB_PAD_SUPPORT 0x00000001
  368. #define OSC_SB_PPC_OST_SUPPORT 0x00000002
  369. #define OSC_SB_PR3_SUPPORT 0x00000004
  370. #define OSC_SB_HOTPLUG_OST_SUPPORT 0x00000008
  371. #define OSC_SB_APEI_SUPPORT 0x00000010
  372. #define OSC_SB_CPC_SUPPORT 0x00000020
  373. extern bool osc_sb_apei_support_acked;
  374. /* PCI Host Bridge _OSC: Capabilities DWORD 2: Support Field */
  375. #define OSC_PCI_EXT_CONFIG_SUPPORT 0x00000001
  376. #define OSC_PCI_ASPM_SUPPORT 0x00000002
  377. #define OSC_PCI_CLOCK_PM_SUPPORT 0x00000004
  378. #define OSC_PCI_SEGMENT_GROUPS_SUPPORT 0x00000008
  379. #define OSC_PCI_MSI_SUPPORT 0x00000010
  380. #define OSC_PCI_SUPPORT_MASKS 0x0000001f
  381. /* PCI Host Bridge _OSC: Capabilities DWORD 3: Control Field */
  382. #define OSC_PCI_EXPRESS_NATIVE_HP_CONTROL 0x00000001
  383. #define OSC_PCI_SHPC_NATIVE_HP_CONTROL 0x00000002
  384. #define OSC_PCI_EXPRESS_PME_CONTROL 0x00000004
  385. #define OSC_PCI_EXPRESS_AER_CONTROL 0x00000008
  386. #define OSC_PCI_EXPRESS_CAPABILITY_CONTROL 0x00000010
  387. #define OSC_PCI_CONTROL_MASKS 0x0000001f
  388. #define ACPI_GSB_ACCESS_ATTRIB_QUICK 0x00000002
  389. #define ACPI_GSB_ACCESS_ATTRIB_SEND_RCV 0x00000004
  390. #define ACPI_GSB_ACCESS_ATTRIB_BYTE 0x00000006
  391. #define ACPI_GSB_ACCESS_ATTRIB_WORD 0x00000008
  392. #define ACPI_GSB_ACCESS_ATTRIB_BLOCK 0x0000000A
  393. #define ACPI_GSB_ACCESS_ATTRIB_MULTIBYTE 0x0000000B
  394. #define ACPI_GSB_ACCESS_ATTRIB_WORD_CALL 0x0000000C
  395. #define ACPI_GSB_ACCESS_ATTRIB_BLOCK_CALL 0x0000000D
  396. #define ACPI_GSB_ACCESS_ATTRIB_RAW_BYTES 0x0000000E
  397. #define ACPI_GSB_ACCESS_ATTRIB_RAW_PROCESS 0x0000000F
  398. extern acpi_status acpi_pci_osc_control_set(acpi_handle handle,
  399. u32 *mask, u32 req);
  400. /* Enable _OST when all relevant hotplug operations are enabled */
  401. #if defined(CONFIG_ACPI_HOTPLUG_CPU) && \
  402. defined(CONFIG_ACPI_HOTPLUG_MEMORY) && \
  403. defined(CONFIG_ACPI_CONTAINER)
  404. #define ACPI_HOTPLUG_OST
  405. #endif
  406. /* _OST Source Event Code (OSPM Action) */
  407. #define ACPI_OST_EC_OSPM_SHUTDOWN 0x100
  408. #define ACPI_OST_EC_OSPM_EJECT 0x103
  409. #define ACPI_OST_EC_OSPM_INSERTION 0x200
  410. /* _OST General Processing Status Code */
  411. #define ACPI_OST_SC_SUCCESS 0x0
  412. #define ACPI_OST_SC_NON_SPECIFIC_FAILURE 0x1
  413. #define ACPI_OST_SC_UNRECOGNIZED_NOTIFY 0x2
  414. /* _OST OS Shutdown Processing (0x100) Status Code */
  415. #define ACPI_OST_SC_OS_SHUTDOWN_DENIED 0x80
  416. #define ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS 0x81
  417. #define ACPI_OST_SC_OS_SHUTDOWN_COMPLETED 0x82
  418. #define ACPI_OST_SC_OS_SHUTDOWN_NOT_SUPPORTED 0x83
  419. /* _OST Ejection Request (0x3, 0x103) Status Code */
  420. #define ACPI_OST_SC_EJECT_NOT_SUPPORTED 0x80
  421. #define ACPI_OST_SC_DEVICE_IN_USE 0x81
  422. #define ACPI_OST_SC_DEVICE_BUSY 0x82
  423. #define ACPI_OST_SC_EJECT_DEPENDENCY_BUSY 0x83
  424. #define ACPI_OST_SC_EJECT_IN_PROGRESS 0x84
  425. /* _OST Insertion Request (0x200) Status Code */
  426. #define ACPI_OST_SC_INSERT_IN_PROGRESS 0x80
  427. #define ACPI_OST_SC_DRIVER_LOAD_FAILURE 0x81
  428. #define ACPI_OST_SC_INSERT_NOT_SUPPORTED 0x82
  429. extern void acpi_early_init(void);
  430. extern void acpi_subsystem_init(void);
  431. extern int acpi_nvs_register(__u64 start, __u64 size);
  432. extern int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
  433. void *data);
  434. const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids,
  435. const struct device *dev);
  436. extern bool acpi_driver_match_device(struct device *dev,
  437. const struct device_driver *drv);
  438. int acpi_device_uevent_modalias(struct device *, struct kobj_uevent_env *);
  439. int acpi_device_modalias(struct device *, char *, int);
  440. void acpi_walk_dep_device_list(acpi_handle handle);
  441. struct platform_device *acpi_create_platform_device(struct acpi_device *);
  442. #define ACPI_PTR(_ptr) (_ptr)
  443. static inline void acpi_device_set_enumerated(struct acpi_device *adev)
  444. {
  445. adev->flags.visited = true;
  446. }
  447. static inline void acpi_device_clear_enumerated(struct acpi_device *adev)
  448. {
  449. adev->flags.visited = false;
  450. }
  451. #else /* !CONFIG_ACPI */
  452. #define acpi_disabled 1
  453. #define ACPI_COMPANION(dev) (NULL)
  454. #define ACPI_COMPANION_SET(dev, adev) do { } while (0)
  455. #define ACPI_HANDLE(dev) (NULL)
  456. #define ACPI_DEVICE_CLASS(_cls, _msk) .cls = (0), .cls_msk = (0),
  457. struct fwnode_handle;
  458. static inline bool is_acpi_node(struct fwnode_handle *fwnode)
  459. {
  460. return false;
  461. }
  462. static inline bool is_acpi_device_node(struct fwnode_handle *fwnode)
  463. {
  464. return false;
  465. }
  466. static inline struct acpi_device *to_acpi_device_node(struct fwnode_handle *fwnode)
  467. {
  468. return NULL;
  469. }
  470. static inline bool is_acpi_data_node(struct fwnode_handle *fwnode)
  471. {
  472. return false;
  473. }
  474. static inline struct acpi_data_node *to_acpi_data_node(struct fwnode_handle *fwnode)
  475. {
  476. return NULL;
  477. }
  478. static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
  479. {
  480. return NULL;
  481. }
  482. static inline bool has_acpi_companion(struct device *dev)
  483. {
  484. return false;
  485. }
  486. static inline void acpi_preset_companion(struct device *dev,
  487. struct acpi_device *parent, u64 addr)
  488. {
  489. }
  490. static inline const char *acpi_dev_name(struct acpi_device *adev)
  491. {
  492. return NULL;
  493. }
  494. static inline void acpi_early_init(void) { }
  495. static inline void acpi_subsystem_init(void) { }
  496. static inline int early_acpi_boot_init(void)
  497. {
  498. return 0;
  499. }
  500. static inline int acpi_boot_init(void)
  501. {
  502. return 0;
  503. }
  504. static inline void acpi_boot_table_init(void)
  505. {
  506. return;
  507. }
  508. static inline int acpi_mps_check(void)
  509. {
  510. return 0;
  511. }
  512. static inline int acpi_check_resource_conflict(struct resource *res)
  513. {
  514. return 0;
  515. }
  516. static inline int acpi_check_region(resource_size_t start, resource_size_t n,
  517. const char *name)
  518. {
  519. return 0;
  520. }
  521. struct acpi_table_header;
  522. static inline int acpi_table_parse(char *id,
  523. int (*handler)(struct acpi_table_header *))
  524. {
  525. return -ENODEV;
  526. }
  527. static inline int acpi_nvs_register(__u64 start, __u64 size)
  528. {
  529. return 0;
  530. }
  531. static inline int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
  532. void *data)
  533. {
  534. return 0;
  535. }
  536. struct acpi_device_id;
  537. static inline const struct acpi_device_id *acpi_match_device(
  538. const struct acpi_device_id *ids, const struct device *dev)
  539. {
  540. return NULL;
  541. }
  542. static inline bool acpi_driver_match_device(struct device *dev,
  543. const struct device_driver *drv)
  544. {
  545. return false;
  546. }
  547. static inline int acpi_device_uevent_modalias(struct device *dev,
  548. struct kobj_uevent_env *env)
  549. {
  550. return -ENODEV;
  551. }
  552. static inline int acpi_device_modalias(struct device *dev,
  553. char *buf, int size)
  554. {
  555. return -ENODEV;
  556. }
  557. static inline bool acpi_dma_supported(struct acpi_device *adev)
  558. {
  559. return false;
  560. }
  561. static inline enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev)
  562. {
  563. return DEV_DMA_NOT_SUPPORTED;
  564. }
  565. #define ACPI_PTR(_ptr) (NULL)
  566. static inline void acpi_device_set_enumerated(struct acpi_device *adev)
  567. {
  568. }
  569. static inline void acpi_device_clear_enumerated(struct acpi_device *adev)
  570. {
  571. }
  572. #endif /* !CONFIG_ACPI */
  573. #ifdef CONFIG_ACPI
  574. void acpi_os_set_prepare_sleep(int (*func)(u8 sleep_state,
  575. u32 pm1a_ctrl, u32 pm1b_ctrl));
  576. acpi_status acpi_os_prepare_sleep(u8 sleep_state,
  577. u32 pm1a_control, u32 pm1b_control);
  578. void acpi_os_set_prepare_extended_sleep(int (*func)(u8 sleep_state,
  579. u32 val_a, u32 val_b));
  580. acpi_status acpi_os_prepare_extended_sleep(u8 sleep_state,
  581. u32 val_a, u32 val_b);
  582. #ifdef CONFIG_X86
  583. void arch_reserve_mem_area(acpi_physical_address addr, size_t size);
  584. #else
  585. static inline void arch_reserve_mem_area(acpi_physical_address addr,
  586. size_t size)
  587. {
  588. }
  589. #endif /* CONFIG_X86 */
  590. #else
  591. #define acpi_os_set_prepare_sleep(func, pm1a_ctrl, pm1b_ctrl) do { } while (0)
  592. #endif
  593. #if defined(CONFIG_ACPI) && defined(CONFIG_PM)
  594. int acpi_dev_runtime_suspend(struct device *dev);
  595. int acpi_dev_runtime_resume(struct device *dev);
  596. int acpi_subsys_runtime_suspend(struct device *dev);
  597. int acpi_subsys_runtime_resume(struct device *dev);
  598. struct acpi_device *acpi_dev_pm_get_node(struct device *dev);
  599. int acpi_dev_pm_attach(struct device *dev, bool power_on);
  600. #else
  601. static inline int acpi_dev_runtime_suspend(struct device *dev) { return 0; }
  602. static inline int acpi_dev_runtime_resume(struct device *dev) { return 0; }
  603. static inline int acpi_subsys_runtime_suspend(struct device *dev) { return 0; }
  604. static inline int acpi_subsys_runtime_resume(struct device *dev) { return 0; }
  605. static inline struct acpi_device *acpi_dev_pm_get_node(struct device *dev)
  606. {
  607. return NULL;
  608. }
  609. static inline int acpi_dev_pm_attach(struct device *dev, bool power_on)
  610. {
  611. return -ENODEV;
  612. }
  613. #endif
  614. #if defined(CONFIG_ACPI) && defined(CONFIG_PM_SLEEP)
  615. int acpi_dev_suspend_late(struct device *dev);
  616. int acpi_dev_resume_early(struct device *dev);
  617. int acpi_subsys_prepare(struct device *dev);
  618. void acpi_subsys_complete(struct device *dev);
  619. int acpi_subsys_suspend_late(struct device *dev);
  620. int acpi_subsys_resume_early(struct device *dev);
  621. int acpi_subsys_suspend(struct device *dev);
  622. int acpi_subsys_freeze(struct device *dev);
  623. #else
  624. static inline int acpi_dev_suspend_late(struct device *dev) { return 0; }
  625. static inline int acpi_dev_resume_early(struct device *dev) { return 0; }
  626. static inline int acpi_subsys_prepare(struct device *dev) { return 0; }
  627. static inline void acpi_subsys_complete(struct device *dev) {}
  628. static inline int acpi_subsys_suspend_late(struct device *dev) { return 0; }
  629. static inline int acpi_subsys_resume_early(struct device *dev) { return 0; }
  630. static inline int acpi_subsys_suspend(struct device *dev) { return 0; }
  631. static inline int acpi_subsys_freeze(struct device *dev) { return 0; }
  632. #endif
  633. #ifdef CONFIG_ACPI
  634. __printf(3, 4)
  635. void acpi_handle_printk(const char *level, acpi_handle handle,
  636. const char *fmt, ...);
  637. #else /* !CONFIG_ACPI */
  638. static inline __printf(3, 4) void
  639. acpi_handle_printk(const char *level, void *handle, const char *fmt, ...) {}
  640. #endif /* !CONFIG_ACPI */
  641. #if defined(CONFIG_ACPI) && defined(CONFIG_DYNAMIC_DEBUG)
  642. __printf(3, 4)
  643. void __acpi_handle_debug(struct _ddebug *descriptor, acpi_handle handle, const char *fmt, ...);
  644. #else
  645. #define __acpi_handle_debug(descriptor, handle, fmt, ...) \
  646. acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__);
  647. #endif
  648. /*
  649. * acpi_handle_<level>: Print message with ACPI prefix and object path
  650. *
  651. * These interfaces acquire the global namespace mutex to obtain an object
  652. * path. In interrupt context, it shows the object path as <n/a>.
  653. */
  654. #define acpi_handle_emerg(handle, fmt, ...) \
  655. acpi_handle_printk(KERN_EMERG, handle, fmt, ##__VA_ARGS__)
  656. #define acpi_handle_alert(handle, fmt, ...) \
  657. acpi_handle_printk(KERN_ALERT, handle, fmt, ##__VA_ARGS__)
  658. #define acpi_handle_crit(handle, fmt, ...) \
  659. acpi_handle_printk(KERN_CRIT, handle, fmt, ##__VA_ARGS__)
  660. #define acpi_handle_err(handle, fmt, ...) \
  661. acpi_handle_printk(KERN_ERR, handle, fmt, ##__VA_ARGS__)
  662. #define acpi_handle_warn(handle, fmt, ...) \
  663. acpi_handle_printk(KERN_WARNING, handle, fmt, ##__VA_ARGS__)
  664. #define acpi_handle_notice(handle, fmt, ...) \
  665. acpi_handle_printk(KERN_NOTICE, handle, fmt, ##__VA_ARGS__)
  666. #define acpi_handle_info(handle, fmt, ...) \
  667. acpi_handle_printk(KERN_INFO, handle, fmt, ##__VA_ARGS__)
  668. #if defined(DEBUG)
  669. #define acpi_handle_debug(handle, fmt, ...) \
  670. acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__)
  671. #else
  672. #if defined(CONFIG_DYNAMIC_DEBUG)
  673. #define acpi_handle_debug(handle, fmt, ...) \
  674. do { \
  675. DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt); \
  676. if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT)) \
  677. __acpi_handle_debug(&descriptor, handle, pr_fmt(fmt), \
  678. ##__VA_ARGS__); \
  679. } while (0)
  680. #else
  681. #define acpi_handle_debug(handle, fmt, ...) \
  682. ({ \
  683. if (0) \
  684. acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__); \
  685. 0; \
  686. })
  687. #endif
  688. #endif
  689. struct acpi_gpio_params {
  690. unsigned int crs_entry_index;
  691. unsigned int line_index;
  692. bool active_low;
  693. };
  694. struct acpi_gpio_mapping {
  695. const char *name;
  696. const struct acpi_gpio_params *data;
  697. unsigned int size;
  698. };
  699. #if defined(CONFIG_ACPI) && defined(CONFIG_GPIOLIB)
  700. int acpi_dev_add_driver_gpios(struct acpi_device *adev,
  701. const struct acpi_gpio_mapping *gpios);
  702. static inline void acpi_dev_remove_driver_gpios(struct acpi_device *adev)
  703. {
  704. if (adev)
  705. adev->driver_gpios = NULL;
  706. }
  707. int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index);
  708. #else
  709. static inline int acpi_dev_add_driver_gpios(struct acpi_device *adev,
  710. const struct acpi_gpio_mapping *gpios)
  711. {
  712. return -ENXIO;
  713. }
  714. static inline void acpi_dev_remove_driver_gpios(struct acpi_device *adev) {}
  715. static inline int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index)
  716. {
  717. return -ENXIO;
  718. }
  719. #endif
  720. /* Device properties */
  721. #define MAX_ACPI_REFERENCE_ARGS 8
  722. struct acpi_reference_args {
  723. struct acpi_device *adev;
  724. size_t nargs;
  725. u64 args[MAX_ACPI_REFERENCE_ARGS];
  726. };
  727. #ifdef CONFIG_ACPI
  728. int acpi_dev_get_property(struct acpi_device *adev, const char *name,
  729. acpi_object_type type, const union acpi_object **obj);
  730. int acpi_node_get_property_reference(struct fwnode_handle *fwnode,
  731. const char *name, size_t index,
  732. struct acpi_reference_args *args);
  733. int acpi_node_prop_get(struct fwnode_handle *fwnode, const char *propname,
  734. void **valptr);
  735. int acpi_dev_prop_read_single(struct acpi_device *adev, const char *propname,
  736. enum dev_prop_type proptype, void *val);
  737. int acpi_node_prop_read(struct fwnode_handle *fwnode, const char *propname,
  738. enum dev_prop_type proptype, void *val, size_t nval);
  739. int acpi_dev_prop_read(struct acpi_device *adev, const char *propname,
  740. enum dev_prop_type proptype, void *val, size_t nval);
  741. struct fwnode_handle *acpi_get_next_subnode(struct device *dev,
  742. struct fwnode_handle *subnode);
  743. struct acpi_probe_entry;
  744. typedef bool (*acpi_probe_entry_validate_subtbl)(struct acpi_subtable_header *,
  745. struct acpi_probe_entry *);
  746. #define ACPI_TABLE_ID_LEN 5
  747. /**
  748. * struct acpi_probe_entry - boot-time probing entry
  749. * @id: ACPI table name
  750. * @type: Optional subtable type to match
  751. * (if @id contains subtables)
  752. * @subtable_valid: Optional callback to check the validity of
  753. * the subtable
  754. * @probe_table: Callback to the driver being probed when table
  755. * match is successful
  756. * @probe_subtbl: Callback to the driver being probed when table and
  757. * subtable match (and optional callback is successful)
  758. * @driver_data: Sideband data provided back to the driver
  759. */
  760. struct acpi_probe_entry {
  761. __u8 id[ACPI_TABLE_ID_LEN];
  762. __u8 type;
  763. acpi_probe_entry_validate_subtbl subtable_valid;
  764. union {
  765. acpi_tbl_table_handler probe_table;
  766. acpi_tbl_entry_handler probe_subtbl;
  767. };
  768. kernel_ulong_t driver_data;
  769. };
  770. #define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, valid, data, fn) \
  771. static const struct acpi_probe_entry __acpi_probe_##name \
  772. __used __section(__##table##_acpi_probe_table) \
  773. = { \
  774. .id = table_id, \
  775. .type = subtable, \
  776. .subtable_valid = valid, \
  777. .probe_table = (acpi_tbl_table_handler)fn, \
  778. .driver_data = data, \
  779. }
  780. #define ACPI_PROBE_TABLE(name) __##name##_acpi_probe_table
  781. #define ACPI_PROBE_TABLE_END(name) __##name##_acpi_probe_table_end
  782. int __acpi_probe_device_table(struct acpi_probe_entry *start, int nr);
  783. #define acpi_probe_device_table(t) \
  784. ({ \
  785. extern struct acpi_probe_entry ACPI_PROBE_TABLE(t), \
  786. ACPI_PROBE_TABLE_END(t); \
  787. __acpi_probe_device_table(&ACPI_PROBE_TABLE(t), \
  788. (&ACPI_PROBE_TABLE_END(t) - \
  789. &ACPI_PROBE_TABLE(t))); \
  790. })
  791. #else
  792. static inline int acpi_dev_get_property(struct acpi_device *adev,
  793. const char *name, acpi_object_type type,
  794. const union acpi_object **obj)
  795. {
  796. return -ENXIO;
  797. }
  798. static inline int acpi_node_get_property_reference(struct fwnode_handle *fwnode,
  799. const char *name, size_t index,
  800. struct acpi_reference_args *args)
  801. {
  802. return -ENXIO;
  803. }
  804. static inline int acpi_node_prop_get(struct fwnode_handle *fwnode,
  805. const char *propname,
  806. void **valptr)
  807. {
  808. return -ENXIO;
  809. }
  810. static inline int acpi_dev_prop_get(struct acpi_device *adev,
  811. const char *propname,
  812. void **valptr)
  813. {
  814. return -ENXIO;
  815. }
  816. static inline int acpi_dev_prop_read_single(struct acpi_device *adev,
  817. const char *propname,
  818. enum dev_prop_type proptype,
  819. void *val)
  820. {
  821. return -ENXIO;
  822. }
  823. static inline int acpi_node_prop_read(struct fwnode_handle *fwnode,
  824. const char *propname,
  825. enum dev_prop_type proptype,
  826. void *val, size_t nval)
  827. {
  828. return -ENXIO;
  829. }
  830. static inline int acpi_dev_prop_read(struct acpi_device *adev,
  831. const char *propname,
  832. enum dev_prop_type proptype,
  833. void *val, size_t nval)
  834. {
  835. return -ENXIO;
  836. }
  837. static inline struct fwnode_handle *acpi_get_next_subnode(struct device *dev,
  838. struct fwnode_handle *subnode)
  839. {
  840. return NULL;
  841. }
  842. #define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, validate, data, fn) \
  843. static const void * __acpi_table_##name[] \
  844. __attribute__((unused)) \
  845. = { (void *) table_id, \
  846. (void *) subtable, \
  847. (void *) valid, \
  848. (void *) fn, \
  849. (void *) data }
  850. #define acpi_probe_device_table(t) ({ int __r = 0; __r;})
  851. #endif
  852. #ifdef CONFIG_ACPI_TABLE_UPGRADE
  853. void acpi_table_upgrade(void);
  854. #else
  855. static inline void acpi_table_upgrade(void) { }
  856. #endif
  857. #endif /*_LINUX_ACPI_H*/