acpi.h 30.0 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
/*
 * acpi.h - ACPI Interface
 *
 * Copyright (C) 2001 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 */

#ifndef _LINUX_ACPI_H
#define _LINUX_ACPI_H

24
#include <linux/errno.h>
25
#include <linux/ioport.h>	/* for struct resource */
26
#include <linux/resource_ext.h>
27
#include <linux/device.h>
28
#include <linux/property.h>
29

L
Linus Torvalds 已提交
30 31 32
#ifndef _LINUX
#define _LINUX
#endif
33 34 35
#include <acpi/acpi.h>

#ifdef	CONFIG_ACPI
L
Linus Torvalds 已提交
36 37

#include <linux/list.h>
38
#include <linux/mod_devicetable.h>
B
Bjørn Mork 已提交
39
#include <linux/dynamic_debug.h>
40 41
#include <linux/module.h>
#include <linux/mutex.h>
L
Linus Torvalds 已提交
42 43 44

#include <acpi/acpi_bus.h>
#include <acpi/acpi_drivers.h>
45
#include <acpi/acpi_numa.h>
46
#include <acpi/acpi_io.h>
L
Linus Torvalds 已提交
47 48
#include <asm/acpi.h>

49 50 51 52 53
static inline acpi_handle acpi_device_handle(struct acpi_device *adev)
{
	return adev ? adev->handle : NULL;
}

54
#define ACPI_COMPANION(dev)		to_acpi_device_node((dev)->fwnode)
55 56
#define ACPI_COMPANION_SET(dev, adev)	set_primary_fwnode(dev, (adev) ? \
	acpi_fwnode_handle(adev) : NULL)
57 58
#define ACPI_HANDLE(dev)		acpi_device_handle(ACPI_COMPANION(dev))

59 60 61 62 63 64 65 66 67 68 69 70 71
/**
 * ACPI_DEVICE_CLASS - macro used to describe an ACPI device with
 * the PCI-defined class-code information
 *
 * @_cls : the class, subclass, prog-if triple for this device
 * @_msk : the class mask for this device
 *
 * This macro is used to create a struct acpi_device_id that matches a
 * specific PCI class. The .id and .driver_data fields will be left
 * initialized with the default value.
 */
#define ACPI_DEVICE_CLASS(_cls, _msk)	.cls = (_cls), .cls_msk = (_msk),

72 73
static inline bool has_acpi_companion(struct device *dev)
{
74
	return is_acpi_device_node(dev->fwnode);
75 76
}

77 78 79 80 81 82
static inline void acpi_preset_companion(struct device *dev,
					 struct acpi_device *parent, u64 addr)
{
	ACPI_COMPANION_SET(dev, acpi_find_child_device(parent, addr, NULL));
}

83 84 85 86 87
static inline const char *acpi_dev_name(struct acpi_device *adev)
{
	return dev_name(&adev->dev);
}

L
Linus Torvalds 已提交
88 89 90 91
enum acpi_irq_model_id {
	ACPI_IRQ_MODEL_PIC = 0,
	ACPI_IRQ_MODEL_IOAPIC,
	ACPI_IRQ_MODEL_IOSAPIC,
J
John Keller 已提交
92
	ACPI_IRQ_MODEL_PLATFORM,
93
	ACPI_IRQ_MODEL_GIC,
L
Linus Torvalds 已提交
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
	ACPI_IRQ_MODEL_COUNT
};

extern enum acpi_irq_model_id	acpi_irq_model;

enum acpi_interrupt_id {
	ACPI_INTERRUPT_PMI	= 1,
	ACPI_INTERRUPT_INIT,
	ACPI_INTERRUPT_CPEI,
	ACPI_INTERRUPT_COUNT
};

#define	ACPI_SPACE_MEM		0

enum acpi_address_range_id {
	ACPI_ADDRESS_RANGE_MEMORY = 1,
	ACPI_ADDRESS_RANGE_RESERVED = 2,
	ACPI_ADDRESS_RANGE_ACPI = 3,
	ACPI_ADDRESS_RANGE_NVS	= 4,
	ACPI_ADDRESS_RANGE_COUNT
};


/* Table Handlers */

119
typedef int (*acpi_tbl_table_handler)(struct acpi_table_header *table);
L
Linus Torvalds 已提交
120

121 122
typedef int (*acpi_tbl_entry_handler)(struct acpi_subtable_header *header,
				      const unsigned long end);
L
Linus Torvalds 已提交
123

124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
/* Debugger support */

struct acpi_debugger_ops {
	int (*create_thread)(acpi_osd_exec_callback function, void *context);
	ssize_t (*write_log)(const char *msg);
	ssize_t (*read_cmd)(char *buffer, size_t length);
	int (*wait_command_ready)(bool single_step, char *buffer, size_t length);
	int (*notify_command_complete)(void);
};

struct acpi_debugger {
	const struct acpi_debugger_ops *ops;
	struct module *owner;
	struct mutex lock;
};

#ifdef CONFIG_ACPI_DEBUGGER
int __init acpi_debugger_init(void);
int acpi_register_debugger(struct module *owner,
			   const struct acpi_debugger_ops *ops);
void acpi_unregister_debugger(const struct acpi_debugger_ops *ops);
int acpi_debugger_create_thread(acpi_osd_exec_callback function, void *context);
ssize_t acpi_debugger_write_log(const char *msg);
ssize_t acpi_debugger_read_cmd(char *buffer, size_t buffer_length);
int acpi_debugger_wait_command_ready(void);
int acpi_debugger_notify_command_complete(void);
#else
static inline int acpi_debugger_init(void)
{
	return -ENODEV;
}

static inline int acpi_register_debugger(struct module *owner,
					 const struct acpi_debugger_ops *ops)
{
	return -ENODEV;
}

static inline void acpi_unregister_debugger(const struct acpi_debugger_ops *ops)
{
}

static inline int acpi_debugger_create_thread(acpi_osd_exec_callback function,
					      void *context)
{
	return -ENODEV;
}

static inline int acpi_debugger_write_log(const char *msg)
{
	return -ENODEV;
}

static inline int acpi_debugger_read_cmd(char *buffer, u32 buffer_length)
{
	return -ENODEV;
}

static inline int acpi_debugger_wait_command_ready(void)
{
	return -ENODEV;
}

static inline int acpi_debugger_notify_command_complete(void)
{
	return -ENODEV;
}
#endif

193 194 195 196
#define BAD_MADT_ENTRY(entry, end) (					    \
		(!entry) || (unsigned long)entry + sizeof(*entry) > end ||  \
		((struct acpi_subtable_header *)entry)->length < sizeof(*entry))

197 198 199 200 201 202
struct acpi_subtable_proc {
	int id;
	acpi_tbl_entry_handler handler;
	int count;
};

L
Linus Torvalds 已提交
203
char * __acpi_map_table (unsigned long phys_addr, unsigned long size);
Y
Yinghai Lu 已提交
204
void __acpi_unmap_table(char *map, unsigned long size);
205
int early_acpi_boot_init(void);
L
Linus Torvalds 已提交
206
int acpi_boot_init (void);
207
void acpi_boot_table_init (void);
208
int acpi_mps_check (void);
L
Linus Torvalds 已提交
209 210
int acpi_numa_init (void);

211
void early_acpi_table_init(void *data, size_t size);
L
Linus Torvalds 已提交
212
int acpi_table_init (void);
213
int acpi_table_parse(char *id, acpi_tbl_table_handler handler);
214 215 216 217
int __init acpi_parse_entries(char *id, unsigned long table_size,
			      acpi_tbl_entry_handler handler,
			      struct acpi_table_header *table_header,
			      int entry_id, unsigned int max_entries);
218
int __init acpi_table_parse_entries(char *id, unsigned long table_size,
219 220 221 222 223 224 225 226 227 228
			      int entry_id,
			      acpi_tbl_entry_handler handler,
			      unsigned int max_entries);
int __init acpi_table_parse_entries(char *id, unsigned long table_size,
			      int entry_id,
			      acpi_tbl_entry_handler handler,
			      unsigned int max_entries);
int __init acpi_table_parse_entries_array(char *id, unsigned long table_size,
			      struct acpi_subtable_proc *proc, int proc_num,
			      unsigned int max_entries);
229 230 231
int acpi_table_parse_madt(enum acpi_madt_type id,
			  acpi_tbl_entry_handler handler,
			  unsigned int max_entries);
232
int acpi_parse_mcfg (struct acpi_table_header *header);
233
void acpi_table_print_madt_entry (struct acpi_subtable_header *madt);
L
Linus Torvalds 已提交
234 235 236

/* the following four functions are architecture-dependent */
void acpi_numa_slit_init (struct acpi_table_slit *slit);
237
void acpi_numa_processor_affinity_init (struct acpi_srat_cpu_affinity *pa);
238
void acpi_numa_x2apic_affinity_init(struct acpi_srat_x2apic_cpu_affinity *pa);
239
int acpi_numa_memory_affinity_init (struct acpi_srat_mem_affinity *ma);
L
Linus Torvalds 已提交
240 241
void acpi_numa_arch_fixup(void);

242 243 244 245 246
#ifndef PHYS_CPUID_INVALID
typedef u32 phys_cpuid_t;
#define PHYS_CPUID_INVALID (phys_cpuid_t)(-1)
#endif

247 248 249 250 251
static inline bool invalid_logical_cpuid(u32 cpuid)
{
	return (int)cpuid < 0;
}

252 253 254 255 256
static inline bool invalid_phys_cpuid(phys_cpuid_t phys_id)
{
	return phys_id == PHYS_CPUID_INVALID;
}

L
Linus Torvalds 已提交
257 258
#ifdef CONFIG_ACPI_HOTPLUG_CPU
/* Arch dependent functions for cpu hotplug support */
259
int acpi_map_cpu(acpi_handle handle, phys_cpuid_t physid, int *pcpu);
260
int acpi_unmap_cpu(int cpu);
L
Linus Torvalds 已提交
261 262
#endif /* CONFIG_ACPI_HOTPLUG_CPU */

263 264 265 266
#ifdef CONFIG_ACPI_HOTPLUG_IOAPIC
int acpi_get_ioapic_id(acpi_handle handle, u32 gsi_base, u64 *phys_addr);
#endif

267 268
int acpi_register_ioapic(acpi_handle handle, u64 phys_addr, u32 gsi_base);
int acpi_unregister_ioapic(acpi_handle handle, u32 gsi_base);
269
int acpi_ioapic_registered(acpi_handle handle, u32 gsi_base);
270 271
void acpi_irq_stats_init(void);
extern u32 acpi_irq_handled;
272
extern u32 acpi_irq_not_handled;
273 274 275 276 277 278
extern unsigned int acpi_sci_irq;
#define INVALID_ACPI_IRQ	((unsigned)-1)
static inline bool acpi_sci_irq_valid(void)
{
	return acpi_sci_irq != INVALID_ACPI_IRQ;
}
L
Linus Torvalds 已提交
279

280
extern int sbf_port;
281
extern unsigned long acpi_realmode_flags;
L
Linus Torvalds 已提交
282

283
int acpi_register_gsi (struct device *dev, u32 gsi, int triggering, int polarity);
L
Linus Torvalds 已提交
284
int acpi_gsi_to_irq (u32 gsi, unsigned int *irq);
285
int acpi_isa_irq_to_gsi (unsigned isa_irq, u32 *gsi);
L
Linus Torvalds 已提交
286

287 288 289
void acpi_set_irq_model(enum acpi_irq_model_id model,
			struct fwnode_handle *fwnode);

290
#ifdef CONFIG_X86_IO_APIC
291
extern int acpi_get_override_irq(u32 gsi, int *trigger, int *polarity);
292
#else
293
#define acpi_get_override_irq(gsi, trigger, polarity) (-1)
294
#endif
L
Linus Torvalds 已提交
295 296 297 298 299 300 301 302 303 304
/*
 * This function undoes the effect of one call to acpi_register_gsi().
 * If this matches the last registration, any IRQ resources for gsi
 * are freed.
 */
void acpi_unregister_gsi (u32 gsi);

struct pci_dev;

int acpi_pci_irq_enable (struct pci_dev *dev);
D
David Shaohua Li 已提交
305
void acpi_penalize_isa_irq(int irq, int active);
306
bool acpi_isa_irq_available(int irq);
307
void acpi_penalize_sci_irq(int irq, int trigger, int polarity);
L
Linus Torvalds 已提交
308 309 310 311
void acpi_pci_irq_disable (struct pci_dev *dev);

extern int ec_read(u8 addr, u8 *val);
extern int ec_write(u8 addr, u8 val);
312 313
extern int ec_transaction(u8 command,
                          const u8 *wdata, unsigned wdata_len,
T
Thomas Renninger 已提交
314
                          u8 *rdata, unsigned rdata_len);
S
Seth Forshee 已提交
315
extern acpi_handle ec_get_handle(void);
L
Linus Torvalds 已提交
316

317 318
extern bool acpi_is_pnp_device(struct acpi_device *);

319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338
#if defined(CONFIG_ACPI_WMI) || defined(CONFIG_ACPI_WMI_MODULE)

typedef void (*wmi_notify_handler) (u32 value, void *context);

extern acpi_status wmi_evaluate_method(const char *guid, u8 instance,
					u32 method_id,
					const struct acpi_buffer *in,
					struct acpi_buffer *out);
extern acpi_status wmi_query_block(const char *guid, u8 instance,
					struct acpi_buffer *out);
extern acpi_status wmi_set_block(const char *guid, u8 instance,
					const struct acpi_buffer *in);
extern acpi_status wmi_install_notify_handler(const char *guid,
					wmi_notify_handler handler, void *data);
extern acpi_status wmi_remove_notify_handler(const char *guid);
extern acpi_status wmi_get_event_data(u32 event, struct acpi_buffer *out);
extern bool wmi_has_guid(const char *guid);

#endif	/* CONFIG_ACPI_WMI */

339 340 341 342 343 344 345 346 347 348 349 350 351
#define ACPI_VIDEO_OUTPUT_SWITCHING			0x0001
#define ACPI_VIDEO_DEVICE_POSTING			0x0002
#define ACPI_VIDEO_ROM_AVAILABLE			0x0004
#define ACPI_VIDEO_BACKLIGHT				0x0008
#define ACPI_VIDEO_BACKLIGHT_FORCE_VENDOR		0x0010
#define ACPI_VIDEO_BACKLIGHT_FORCE_VIDEO		0x0020
#define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VENDOR	0x0040
#define ACPI_VIDEO_OUTPUT_SWITCHING_FORCE_VIDEO		0x0080
#define ACPI_VIDEO_BACKLIGHT_DMI_VENDOR			0x0100
#define ACPI_VIDEO_BACKLIGHT_DMI_VIDEO			0x0200
#define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VENDOR		0x0400
#define ACPI_VIDEO_OUTPUT_SWITCHING_DMI_VIDEO		0x0800

352
extern char acpi_video_backlight_string[];
353
extern long acpi_is_video_device(acpi_handle handle);
L
Linus Torvalds 已提交
354
extern int acpi_blacklisted(void);
355
extern void acpi_dmi_osi_linux(int enable, const struct dmi_system_id *d);
L
Lin Ming 已提交
356
extern void acpi_osi_setup(char *str);
357
extern bool acpi_osi_is_win8(void);
L
Linus Torvalds 已提交
358 359

#ifdef CONFIG_ACPI_NUMA
360
int acpi_map_pxm_to_online_node(int pxm);
361
int acpi_get_node(acpi_handle handle);
L
Linus Torvalds 已提交
362
#else
363 364 365 366
static inline int acpi_map_pxm_to_online_node(int pxm)
{
	return 0;
}
367
static inline int acpi_get_node(acpi_handle handle)
368 369 370
{
	return 0;
}
L
Linus Torvalds 已提交
371
#endif
372
extern int acpi_paddr_to_node(u64 start_addr, u64 size);
L
Linus Torvalds 已提交
373 374 375

extern int pnpacpi_disabled;

376 377
#define PXM_INVAL	(-1)

378 379 380
bool acpi_dev_resource_memory(struct acpi_resource *ares, struct resource *res);
bool acpi_dev_resource_io(struct acpi_resource *ares, struct resource *res);
bool acpi_dev_resource_address_space(struct acpi_resource *ares,
381
				     struct resource_win *win);
382
bool acpi_dev_resource_ext_address_space(struct acpi_resource *ares,
383
					 struct resource_win *win);
384
unsigned long acpi_dev_irq_flags(u8 triggering, u8 polarity, u8 shareable);
385
unsigned int acpi_dev_get_irq_type(int triggering, int polarity);
386 387 388
bool acpi_dev_resource_interrupt(struct acpi_resource *ares, int index,
				 struct resource *res);

389 390 391 392
void acpi_dev_free_resource_list(struct list_head *list);
int acpi_dev_get_resources(struct acpi_device *adev, struct list_head *list,
			   int (*preproc)(struct acpi_resource *, void *),
			   void *preproc_data);
393 394 395 396 397 398 399 400
int acpi_dev_filter_resource_type(struct acpi_resource *ares,
				  unsigned long types);

static inline int acpi_dev_filter_resource_type_cb(struct acpi_resource *ares,
						   void *arg)
{
	return acpi_dev_filter_resource_type(ares, (unsigned long)arg);
}
401

402
int acpi_check_resource_conflict(const struct resource *res);
403

404 405 406
int acpi_check_region(resource_size_t start, resource_size_t n,
		      const char *name);

407 408
int acpi_resources_are_enforced(void);

409
#ifdef CONFIG_HIBERNATION
410
void __init acpi_no_s4_hw_signature(void);
411 412 413
#endif

#ifdef CONFIG_PM_SLEEP
414
void __init acpi_old_suspend_ordering(void);
415
void __init acpi_nvs_nosave(void);
416
void __init acpi_nvs_nosave_s3(void);
417
#endif /* CONFIG_PM_SLEEP */
418

S
Shaohua Li 已提交
419
struct acpi_osc_context {
420
	char *uuid_str;			/* UUID string */
S
Shaohua Li 已提交
421
	int rev;
422 423
	struct acpi_buffer cap;		/* list of DWORD capabilities */
	struct acpi_buffer ret;		/* free by caller if success */
S
Shaohua Li 已提交
424 425
};

426
acpi_status acpi_str_to_uuid(char *str, u8 *uuid);
S
Shaohua Li 已提交
427 428
acpi_status acpi_run_osc(acpi_handle handle, struct acpi_osc_context *context);

429 430 431 432
/* Indexes into _OSC Capabilities Buffer (DWORDs 2 & 3 are device-specific) */
#define OSC_QUERY_DWORD				0	/* DWORD 1 */
#define OSC_SUPPORT_DWORD			1	/* DWORD 2 */
#define OSC_CONTROL_DWORD			2	/* DWORD 3 */
433

434 435 436 437 438 439
/* _OSC Capabilities DWORD 1: Query/Control and Error Returns (generic) */
#define OSC_QUERY_ENABLE			0x00000001  /* input */
#define OSC_REQUEST_ERROR			0x00000002  /* return */
#define OSC_INVALID_UUID_ERROR			0x00000004  /* return */
#define OSC_INVALID_REVISION_ERROR		0x00000008  /* return */
#define OSC_CAPABILITIES_MASK_ERROR		0x00000010  /* return */
440

441 442 443 444 445 446 447
/* Platform-Wide Capabilities _OSC: Capabilities DWORD 2: Support Field */
#define OSC_SB_PAD_SUPPORT			0x00000001
#define OSC_SB_PPC_OST_SUPPORT			0x00000002
#define OSC_SB_PR3_SUPPORT			0x00000004
#define OSC_SB_HOTPLUG_OST_SUPPORT		0x00000008
#define OSC_SB_APEI_SUPPORT			0x00000010
#define OSC_SB_CPC_SUPPORT			0x00000020
S
Shaohua Li 已提交
448

449 450
extern bool osc_sb_apei_support_acked;

451
/* PCI Host Bridge _OSC: Capabilities DWORD 2: Support Field */
452 453 454
#define OSC_PCI_EXT_CONFIG_SUPPORT		0x00000001
#define OSC_PCI_ASPM_SUPPORT			0x00000002
#define OSC_PCI_CLOCK_PM_SUPPORT		0x00000004
455
#define OSC_PCI_SEGMENT_GROUPS_SUPPORT		0x00000008
456
#define OSC_PCI_MSI_SUPPORT			0x00000010
457 458 459 460
#define OSC_PCI_SUPPORT_MASKS			0x0000001f

/* PCI Host Bridge _OSC: Capabilities DWORD 3: Control Field */
#define OSC_PCI_EXPRESS_NATIVE_HP_CONTROL	0x00000001
461
#define OSC_PCI_SHPC_NATIVE_HP_CONTROL		0x00000002
462 463
#define OSC_PCI_EXPRESS_PME_CONTROL		0x00000004
#define OSC_PCI_EXPRESS_AER_CONTROL		0x00000008
464
#define OSC_PCI_EXPRESS_CAPABILITY_CONTROL	0x00000010
465
#define OSC_PCI_CONTROL_MASKS			0x0000001f
466

467 468 469 470 471 472 473 474 475 476 477
#define ACPI_GSB_ACCESS_ATTRIB_QUICK		0x00000002
#define ACPI_GSB_ACCESS_ATTRIB_SEND_RCV         0x00000004
#define ACPI_GSB_ACCESS_ATTRIB_BYTE		0x00000006
#define ACPI_GSB_ACCESS_ATTRIB_WORD		0x00000008
#define ACPI_GSB_ACCESS_ATTRIB_BLOCK		0x0000000A
#define ACPI_GSB_ACCESS_ATTRIB_MULTIBYTE	0x0000000B
#define ACPI_GSB_ACCESS_ATTRIB_WORD_CALL	0x0000000C
#define ACPI_GSB_ACCESS_ATTRIB_BLOCK_CALL	0x0000000D
#define ACPI_GSB_ACCESS_ATTRIB_RAW_BYTES	0x0000000E
#define ACPI_GSB_ACCESS_ATTRIB_RAW_PROCESS	0x0000000F

478 479
extern acpi_status acpi_pci_osc_control_set(acpi_handle handle,
					     u32 *mask, u32 req);
480 481 482

/* Enable _OST when all relevant hotplug operations are enabled */
#if defined(CONFIG_ACPI_HOTPLUG_CPU) &&			\
483
	defined(CONFIG_ACPI_HOTPLUG_MEMORY) &&		\
484
	defined(CONFIG_ACPI_CONTAINER)
485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515
#define ACPI_HOTPLUG_OST
#endif

/* _OST Source Event Code (OSPM Action) */
#define ACPI_OST_EC_OSPM_SHUTDOWN		0x100
#define ACPI_OST_EC_OSPM_EJECT			0x103
#define ACPI_OST_EC_OSPM_INSERTION		0x200

/* _OST General Processing Status Code */
#define ACPI_OST_SC_SUCCESS			0x0
#define ACPI_OST_SC_NON_SPECIFIC_FAILURE	0x1
#define ACPI_OST_SC_UNRECOGNIZED_NOTIFY		0x2

/* _OST OS Shutdown Processing (0x100) Status Code */
#define ACPI_OST_SC_OS_SHUTDOWN_DENIED		0x80
#define ACPI_OST_SC_OS_SHUTDOWN_IN_PROGRESS	0x81
#define ACPI_OST_SC_OS_SHUTDOWN_COMPLETED	0x82
#define ACPI_OST_SC_OS_SHUTDOWN_NOT_SUPPORTED	0x83

/* _OST Ejection Request (0x3, 0x103) Status Code */
#define ACPI_OST_SC_EJECT_NOT_SUPPORTED		0x80
#define ACPI_OST_SC_DEVICE_IN_USE		0x81
#define ACPI_OST_SC_DEVICE_BUSY			0x82
#define ACPI_OST_SC_EJECT_DEPENDENCY_BUSY	0x83
#define ACPI_OST_SC_EJECT_IN_PROGRESS		0x84

/* _OST Insertion Request (0x200) Status Code */
#define ACPI_OST_SC_INSERT_IN_PROGRESS		0x80
#define ACPI_OST_SC_DRIVER_LOAD_FAILURE		0x81
#define ACPI_OST_SC_INSERT_NOT_SUPPORTED	0x82

516
extern void acpi_early_init(void);
517
extern void acpi_subsystem_init(void);
518

H
Huang Ying 已提交
519 520 521 522 523
extern int acpi_nvs_register(__u64 start, __u64 size);

extern int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
				    void *data);

524 525 526
const struct acpi_device_id *acpi_match_device(const struct acpi_device_id *ids,
					       const struct device *dev);

527 528
extern bool acpi_driver_match_device(struct device *dev,
				     const struct device_driver *drv);
529 530
int acpi_device_uevent_modalias(struct device *, struct kobj_uevent_env *);
int acpi_device_modalias(struct device *, char *, int);
531
void acpi_walk_dep_device_list(acpi_handle handle);
532

533
struct platform_device *acpi_create_platform_device(struct acpi_device *);
534 535
#define ACPI_PTR(_ptr)	(_ptr)

536 537 538 539
#else	/* !CONFIG_ACPI */

#define acpi_disabled 1

540 541 542
#define ACPI_COMPANION(dev)		(NULL)
#define ACPI_COMPANION_SET(dev, adev)	do { } while (0)
#define ACPI_HANDLE(dev)		(NULL)
543
#define ACPI_DEVICE_CLASS(_cls, _msk)	.cls = (0), .cls_msk = (0),
544

545 546 547 548 549 550 551
struct fwnode_handle;

static inline bool is_acpi_node(struct fwnode_handle *fwnode)
{
	return false;
}

552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567
static inline bool is_acpi_device_node(struct fwnode_handle *fwnode)
{
	return false;
}

static inline struct acpi_device *to_acpi_device_node(struct fwnode_handle *fwnode)
{
	return NULL;
}

static inline bool is_acpi_data_node(struct fwnode_handle *fwnode)
{
	return false;
}

static inline struct acpi_data_node *to_acpi_data_node(struct fwnode_handle *fwnode)
568 569 570 571 572 573 574 575 576
{
	return NULL;
}

static inline struct fwnode_handle *acpi_fwnode_handle(struct acpi_device *adev)
{
	return NULL;
}

577 578 579 580 581
static inline bool has_acpi_companion(struct device *dev)
{
	return false;
}

582 583 584 585 586
static inline void acpi_preset_companion(struct device *dev,
					 struct acpi_device *parent, u64 addr)
{
}

587 588 589 590 591
static inline const char *acpi_dev_name(struct acpi_device *adev)
{
	return NULL;
}

592
static inline void early_acpi_table_init(void *data, size_t size) { }
593
static inline void acpi_early_init(void) { }
594
static inline void acpi_subsystem_init(void) { }
A
Andrew Morton 已提交
595

596 597 598 599
static inline int early_acpi_boot_init(void)
{
	return 0;
}
A
Andrew Morton 已提交
600 601 602 603 604
static inline int acpi_boot_init(void)
{
	return 0;
}

605
static inline void acpi_boot_table_init(void)
A
Andrew Morton 已提交
606
{
607
	return;
A
Andrew Morton 已提交
608 609
}

610 611 612 613 614
static inline int acpi_mps_check(void)
{
	return 0;
}

615 616 617 618 619
static inline int acpi_check_resource_conflict(struct resource *res)
{
	return 0;
}

620 621 622 623 624 625
static inline int acpi_check_region(resource_size_t start, resource_size_t n,
				    const char *name)
{
	return 0;
}

626 627 628 629
struct acpi_table_header;
static inline int acpi_table_parse(char *id,
				int (*handler)(struct acpi_table_header *))
{
630
	return -ENODEV;
631
}
632

H
Huang Ying 已提交
633
static inline int acpi_nvs_register(__u64 start, __u64 size)
634 635 636
{
	return 0;
}
H
Huang Ying 已提交
637 638 639 640 641 642 643

static inline int acpi_nvs_for_each_region(int (*func)(__u64, __u64, void *),
					   void *data)
{
	return 0;
}

644 645 646 647 648 649 650 651 652 653 654 655 656 657
struct acpi_device_id;

static inline const struct acpi_device_id *acpi_match_device(
	const struct acpi_device_id *ids, const struct device *dev)
{
	return NULL;
}

static inline bool acpi_driver_match_device(struct device *dev,
					    const struct device_driver *drv)
{
	return false;
}

658 659 660 661 662 663 664 665 666 667 668 669
static inline int acpi_device_uevent_modalias(struct device *dev,
				struct kobj_uevent_env *env)
{
	return -ENODEV;
}

static inline int acpi_device_modalias(struct device *dev,
				char *buf, int size)
{
	return -ENODEV;
}

670
static inline bool acpi_dma_supported(struct acpi_device *adev)
671 672 673 674
{
	return false;
}

675 676 677 678 679
static inline enum dev_dma_attr acpi_get_dma_attr(struct acpi_device *adev)
{
	return DEV_DMA_NOT_SUPPORTED;
}

680 681
#define ACPI_PTR(_ptr)	(NULL)

H
Huang Ying 已提交
682
#endif	/* !CONFIG_ACPI */
683

684 685 686 687 688 689
#ifdef CONFIG_ACPI
void acpi_os_set_prepare_sleep(int (*func)(u8 sleep_state,
			       u32 pm1a_ctrl,  u32 pm1b_ctrl));

acpi_status acpi_os_prepare_sleep(u8 sleep_state,
				  u32 pm1a_control, u32 pm1b_control);
690 691 692 693 694 695 696

void acpi_os_set_prepare_extended_sleep(int (*func)(u8 sleep_state,
				        u32 val_a,  u32 val_b));

acpi_status acpi_os_prepare_extended_sleep(u8 sleep_state,
					   u32 val_a, u32 val_b);

697
#ifdef CONFIG_X86
698 699 700 701 702 703 704
void arch_reserve_mem_area(acpi_physical_address addr, size_t size);
#else
static inline void arch_reserve_mem_area(acpi_physical_address addr,
					  size_t size)
{
}
#endif /* CONFIG_X86 */
705 706 707 708
#else
#define acpi_os_set_prepare_sleep(func, pm1a_ctrl, pm1b_ctrl) do { } while (0)
#endif

709
#if defined(CONFIG_ACPI) && defined(CONFIG_PM)
710 711 712 713
int acpi_dev_runtime_suspend(struct device *dev);
int acpi_dev_runtime_resume(struct device *dev);
int acpi_subsys_runtime_suspend(struct device *dev);
int acpi_subsys_runtime_resume(struct device *dev);
714 715
struct acpi_device *acpi_dev_pm_get_node(struct device *dev);
int acpi_dev_pm_attach(struct device *dev, bool power_on);
716 717 718 719 720
#else
static inline int acpi_dev_runtime_suspend(struct device *dev) { return 0; }
static inline int acpi_dev_runtime_resume(struct device *dev) { return 0; }
static inline int acpi_subsys_runtime_suspend(struct device *dev) { return 0; }
static inline int acpi_subsys_runtime_resume(struct device *dev) { return 0; }
721 722 723 724 725 726 727 728
static inline struct acpi_device *acpi_dev_pm_get_node(struct device *dev)
{
	return NULL;
}
static inline int acpi_dev_pm_attach(struct device *dev, bool power_on)
{
	return -ENODEV;
}
729 730
#endif

731
#if defined(CONFIG_ACPI) && defined(CONFIG_PM_SLEEP)
732 733 734
int acpi_dev_suspend_late(struct device *dev);
int acpi_dev_resume_early(struct device *dev);
int acpi_subsys_prepare(struct device *dev);
735
void acpi_subsys_complete(struct device *dev);
736 737
int acpi_subsys_suspend_late(struct device *dev);
int acpi_subsys_resume_early(struct device *dev);
738 739
int acpi_subsys_suspend(struct device *dev);
int acpi_subsys_freeze(struct device *dev);
740 741 742 743
#else
static inline int acpi_dev_suspend_late(struct device *dev) { return 0; }
static inline int acpi_dev_resume_early(struct device *dev) { return 0; }
static inline int acpi_subsys_prepare(struct device *dev) { return 0; }
744
static inline void acpi_subsys_complete(struct device *dev) {}
745 746
static inline int acpi_subsys_suspend_late(struct device *dev) { return 0; }
static inline int acpi_subsys_resume_early(struct device *dev) { return 0; }
747 748
static inline int acpi_subsys_suspend(struct device *dev) { return 0; }
static inline int acpi_subsys_freeze(struct device *dev) { return 0; }
749 750
#endif

751 752 753 754 755 756 757 758 759
#ifdef CONFIG_ACPI
__printf(3, 4)
void acpi_handle_printk(const char *level, acpi_handle handle,
			const char *fmt, ...);
#else	/* !CONFIG_ACPI */
static inline __printf(3, 4) void
acpi_handle_printk(const char *level, void *handle, const char *fmt, ...) {}
#endif	/* !CONFIG_ACPI */

B
Bjørn Mork 已提交
760 761 762 763 764 765 766 767
#if defined(CONFIG_ACPI) && defined(CONFIG_DYNAMIC_DEBUG)
__printf(3, 4)
void __acpi_handle_debug(struct _ddebug *descriptor, acpi_handle handle, const char *fmt, ...);
#else
#define __acpi_handle_debug(descriptor, handle, fmt, ...)		\
	acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__);
#endif

768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788
/*
 * acpi_handle_<level>: Print message with ACPI prefix and object path
 *
 * These interfaces acquire the global namespace mutex to obtain an object
 * path.  In interrupt context, it shows the object path as <n/a>.
 */
#define acpi_handle_emerg(handle, fmt, ...)				\
	acpi_handle_printk(KERN_EMERG, handle, fmt, ##__VA_ARGS__)
#define acpi_handle_alert(handle, fmt, ...)				\
	acpi_handle_printk(KERN_ALERT, handle, fmt, ##__VA_ARGS__)
#define acpi_handle_crit(handle, fmt, ...)				\
	acpi_handle_printk(KERN_CRIT, handle, fmt, ##__VA_ARGS__)
#define acpi_handle_err(handle, fmt, ...)				\
	acpi_handle_printk(KERN_ERR, handle, fmt, ##__VA_ARGS__)
#define acpi_handle_warn(handle, fmt, ...)				\
	acpi_handle_printk(KERN_WARNING, handle, fmt, ##__VA_ARGS__)
#define acpi_handle_notice(handle, fmt, ...)				\
	acpi_handle_printk(KERN_NOTICE, handle, fmt, ##__VA_ARGS__)
#define acpi_handle_info(handle, fmt, ...)				\
	acpi_handle_printk(KERN_INFO, handle, fmt, ##__VA_ARGS__)

B
Bjørn Mork 已提交
789
#if defined(DEBUG)
790 791 792
#define acpi_handle_debug(handle, fmt, ...)				\
	acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__)
#else
B
Bjørn Mork 已提交
793 794 795 796 797 798 799 800 801
#if defined(CONFIG_DYNAMIC_DEBUG)
#define acpi_handle_debug(handle, fmt, ...)				\
do {									\
	DEFINE_DYNAMIC_DEBUG_METADATA(descriptor, fmt);			\
	if (unlikely(descriptor.flags & _DPRINTK_FLAGS_PRINT))		\
		__acpi_handle_debug(&descriptor, handle, pr_fmt(fmt),	\
				##__VA_ARGS__);				\
} while (0)
#else
802 803 804 805 806 807 808
#define acpi_handle_debug(handle, fmt, ...)				\
({									\
	if (0)								\
		acpi_handle_printk(KERN_DEBUG, handle, fmt, ##__VA_ARGS__); \
	0;								\
})
#endif
B
Bjørn Mork 已提交
809
#endif
810

811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831
struct acpi_gpio_params {
	unsigned int crs_entry_index;
	unsigned int line_index;
	bool active_low;
};

struct acpi_gpio_mapping {
	const char *name;
	const struct acpi_gpio_params *data;
	unsigned int size;
};

#if defined(CONFIG_ACPI) && defined(CONFIG_GPIOLIB)
int acpi_dev_add_driver_gpios(struct acpi_device *adev,
			      const struct acpi_gpio_mapping *gpios);

static inline void acpi_dev_remove_driver_gpios(struct acpi_device *adev)
{
	if (adev)
		adev->driver_gpios = NULL;
}
832 833

int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index);
834 835 836 837 838 839 840
#else
static inline int acpi_dev_add_driver_gpios(struct acpi_device *adev,
			      const struct acpi_gpio_mapping *gpios)
{
	return -ENXIO;
}
static inline void acpi_dev_remove_driver_gpios(struct acpi_device *adev) {}
841 842 843 844 845

static inline int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index)
{
	return -ENXIO;
}
846 847
#endif

848 849 850 851 852 853 854 855 856 857 858 859
/* Device properties */

#define MAX_ACPI_REFERENCE_ARGS	8
struct acpi_reference_args {
	struct acpi_device *adev;
	size_t nargs;
	u64 args[MAX_ACPI_REFERENCE_ARGS];
};

#ifdef CONFIG_ACPI
int acpi_dev_get_property(struct acpi_device *adev, const char *name,
			  acpi_object_type type, const union acpi_object **obj);
860 861 862
int acpi_node_get_property_reference(struct fwnode_handle *fwnode,
				     const char *name, size_t index,
				     struct acpi_reference_args *args);
863

864 865
int acpi_node_prop_get(struct fwnode_handle *fwnode, const char *propname,
		       void **valptr);
866 867
int acpi_dev_prop_read_single(struct acpi_device *adev, const char *propname,
			      enum dev_prop_type proptype, void *val);
868 869
int acpi_node_prop_read(struct fwnode_handle *fwnode, const char *propname,
		        enum dev_prop_type proptype, void *val, size_t nval);
870 871
int acpi_dev_prop_read(struct acpi_device *adev, const char *propname,
		       enum dev_prop_type proptype, void *val, size_t nval);
872

873 874
struct fwnode_handle *acpi_get_next_subnode(struct device *dev,
					    struct fwnode_handle *subnode);
875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929

struct acpi_probe_entry;
typedef bool (*acpi_probe_entry_validate_subtbl)(struct acpi_subtable_header *,
						 struct acpi_probe_entry *);

#define ACPI_TABLE_ID_LEN	5

/**
 * struct acpi_probe_entry - boot-time probing entry
 * @id:			ACPI table name
 * @type:		Optional subtable type to match
 *			(if @id contains subtables)
 * @subtable_valid:	Optional callback to check the validity of
 *			the subtable
 * @probe_table:	Callback to the driver being probed when table
 *			match is successful
 * @probe_subtbl:	Callback to the driver being probed when table and
 *			subtable match (and optional callback is successful)
 * @driver_data:	Sideband data provided back to the driver
 */
struct acpi_probe_entry {
	__u8 id[ACPI_TABLE_ID_LEN];
	__u8 type;
	acpi_probe_entry_validate_subtbl subtable_valid;
	union {
		acpi_tbl_table_handler probe_table;
		acpi_tbl_entry_handler probe_subtbl;
	};
	kernel_ulong_t driver_data;
};

#define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, valid, data, fn)	\
	static const struct acpi_probe_entry __acpi_probe_##name	\
		__used __section(__##table##_acpi_probe_table)		\
		 = {							\
			.id = table_id,					\
			.type = subtable,				\
			.subtable_valid = valid,			\
			.probe_table = (acpi_tbl_table_handler)fn,	\
			.driver_data = data, 				\
		   }

#define ACPI_PROBE_TABLE(name)		__##name##_acpi_probe_table
#define ACPI_PROBE_TABLE_END(name)	__##name##_acpi_probe_table_end

int __acpi_probe_device_table(struct acpi_probe_entry *start, int nr);

#define acpi_probe_device_table(t)					\
	({ 								\
		extern struct acpi_probe_entry ACPI_PROBE_TABLE(t),	\
			                       ACPI_PROBE_TABLE_END(t);	\
		__acpi_probe_device_table(&ACPI_PROBE_TABLE(t),		\
					  (&ACPI_PROBE_TABLE_END(t) -	\
					   &ACPI_PROBE_TABLE(t)));	\
	})
930 931 932 933 934 935 936
#else
static inline int acpi_dev_get_property(struct acpi_device *adev,
					const char *name, acpi_object_type type,
					const union acpi_object **obj)
{
	return -ENXIO;
}
937

938
static inline int acpi_node_get_property_reference(struct fwnode_handle *fwnode,
939 940
				const char *name, size_t index,
				struct acpi_reference_args *args)
941 942 943
{
	return -ENXIO;
}
944

945 946 947
static inline int acpi_node_prop_get(struct fwnode_handle *fwnode,
				     const char *propname,
				     void **valptr)
948 949 950
{
	return -ENXIO;
}
951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966

static inline int acpi_dev_prop_get(struct acpi_device *adev,
				    const char *propname,
				    void **valptr)
{
	return -ENXIO;
}

static inline int acpi_dev_prop_read_single(struct acpi_device *adev,
					    const char *propname,
					    enum dev_prop_type proptype,
					    void *val)
{
	return -ENXIO;
}

967 968 969 970 971 972 973 974
static inline int acpi_node_prop_read(struct fwnode_handle *fwnode,
				      const char *propname,
				      enum dev_prop_type proptype,
				      void *val, size_t nval)
{
	return -ENXIO;
}

975 976 977 978 979 980 981 982
static inline int acpi_dev_prop_read(struct acpi_device *adev,
				     const char *propname,
				     enum dev_prop_type proptype,
				     void *val, size_t nval)
{
	return -ENXIO;
}

983 984
static inline struct fwnode_handle *acpi_get_next_subnode(struct device *dev,
						struct fwnode_handle *subnode)
985 986 987 988
{
	return NULL;
}

989 990 991 992 993 994 995 996 997 998
#define ACPI_DECLARE_PROBE_ENTRY(table, name, table_id, subtable, validate, data, fn) \
	static const void * __acpi_table_##name[]			\
		__attribute__((unused))					\
		 = { (void *) table_id,					\
		     (void *) subtable,					\
		     (void *) valid,					\
		     (void *) fn,					\
		     (void *) data }

#define acpi_probe_device_table(t)	({ int __r = 0; __r;})
999 1000
#endif

L
Len Brown 已提交
1001
#endif	/*_LINUX_ACPI_H*/