1 /*****************************************************************************
6 *****************************************************************************/
9 * Copyright (C) 2000, 2001 Andrew Grover
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
33 /*****************************************************************************
35 *****************************************************************************/
38 * Output Flags (Debug):
39 * ---------------------
41 #define BM_PRINT_ALL (0x00000000)
42 #define BM_PRINT_GROUP (0x00000001)
43 #define BM_PRINT_LINKAGE (0x00000002)
44 #define BM_PRINT_IDENTIFICATION (0x00000004)
45 #define BM_PRINT_POWER (0x00000008)
46 #define BM_PRINT_PRESENT (0x00000010)
53 #define BM_PROC_ROOT "acpi"
54 #define BM_PROC_EVENT "event"
56 extern struct proc_dir_entry *bm_proc_root;
63 typedef u32 BM_COMMAND;
65 #define BM_COMMAND_UNKNOWN ((BM_COMMAND) 0x00)
67 #define BM_COMMAND_GET_POWER_STATE ((BM_COMMAND) 0x01)
68 #define BM_COMMAND_SET_POWER_STATE ((BM_COMMAND) 0x02)
70 #define BM_COMMAND_DEVICE_SPECIFIC ((BM_COMMAND) 0x80)
75 * Standard ACPI notification values, from section 5.6.3 of the ACPI 2.0
76 * specification. Note that the Bus Manager internally handles all
77 * standard ACPI notifications -- driver modules are never sent these
78 * values (see "Bus Manager Notifications", below).
80 typedef u32 BM_NOTIFY;
82 #define BM_NOTIFY_BUS_CHECK ((BM_NOTIFY) 0x00)
83 #define BM_NOTIFY_DEVICE_CHECK ((BM_NOTIFY) 0x01)
84 #define BM_NOTIFY_DEVICE_WAKE ((BM_NOTIFY) 0x02)
85 #define BM_NOTIFY_EJECT_REQUEST ((BM_NOTIFY) 0x03)
86 #define BM_NOTIFY_DEVICE_CHECK_LIGHT ((BM_NOTIFY) 0x04)
87 #define BM_NOTIFY_FREQUENCY_MISMATCH ((BM_NOTIFY) 0x05)
88 #define BM_NOTIFY_BUS_MODE_MISMATCH ((BM_NOTIFY) 0x06)
89 #define BM_NOTIFY_POWER_FAULT ((BM_NOTIFY) 0x07)
92 * These are a higher-level abstraction of ACPI notifications, intended
93 * for consumption by driver modules to facilitate PnP.
95 #define BM_NOTIFY_UNKNOWN ((BM_NOTIFY) 0x00)
96 #define BM_NOTIFY_DEVICE_ADDED ((BM_NOTIFY) 0x01)
97 #define BM_NOTIFY_DEVICE_REMOVED ((BM_NOTIFY) 0x02)
104 typedef u32 BM_HANDLE;
106 #define BM_HANDLE_UNKNOWN ((BM_HANDLE) 0x00)
107 #define BM_HANDLE_ROOT ((BM_HANDLE) 0x00)
108 #define BM_HANDLES_MAX 256
119 BM_HANDLE handles[BM_HANDLES_MAX];
127 typedef u32 BM_DEVICE_TYPE;
129 #define BM_TYPE_UNKNOWN ((BM_DEVICE_TYPE) 0x00000000)
131 #define BM_TYPE_SCOPE ((BM_DEVICE_TYPE) 0x00000001)
132 #define BM_TYPE_PROCESSOR ((BM_DEVICE_TYPE) 0x00000002)
133 #define BM_TYPE_THERMAL_ZONE ((BM_DEVICE_TYPE) 0x00000004)
134 #define BM_TYPE_POWER_RESOURCE ((BM_DEVICE_TYPE) 0x00000008)
135 #define BM_TYPE_DEVICE ((BM_DEVICE_TYPE) 0x00000010)
136 #define BM_TYPE_FIXED_BUTTON ((BM_DEVICE_TYPE) 0x00000020)
137 #define BM_TYPE_SYSTEM ((BM_DEVICE_TYPE) 0x80000000)
138 #define BM_TYPE_ALL ((BM_DEVICE_TYPE) 0xFFFFFFFF)
145 typedef char BM_DEVICE_UID[9];
147 #define BM_UID_UNKNOWN '0'
154 typedef char BM_DEVICE_HID[9];
156 #define BM_HID_UNKNOWN '\0'
157 #define BM_HID_POWER_BUTTON "PNP0C0C"
158 #define BM_HID_SLEEP_BUTTON "PNP0C0E"
162 * The compatibility ID can be a string with 44 characters
163 * The extra pad is in case there is a change. It also
164 * provides 8 byte alignment for the BM_DEVICE_ID structure.
165 * -------------------------------------------------------------
167 typedef char BM_DEVICE_CID[46];
174 typedef u32 BM_DEVICE_ADR;
176 #define BM_ADDRESS_UNKNOWN 0
182 * The encoding of BM_DEVICE_FLAGS is illustrated below.
183 * Note that a set bit (1) indicates the property is TRUE
184 * (e.g. if bit 0 is set then the device has dynamic status).
185 * +--+------------+-+-+-+-+-+-+-+
186 * |31| Bits 31:11 |6|5|4|3|2|1|0|
187 * +--+------------+-+-+-+-+-+-+-+
189 * | | | | | | | | +- Dynamic status?
190 * | | | | | | | +--- Identifiable?
191 * | | | | | | +----- Configurable?
192 * | | | | | +------- Power Manageable?
193 * | | | | +--------- Ejectable?
194 * | | | +----------- Docking Station?
195 * | | +------------- Fixed-Feature?
196 * | +-------------------- <Reserved>
197 * +---------------------------- Driver Control?
199 * Dynamic status: Device has a _STA object.
200 * Identifiable: Device has a _HID and/or _ADR and possibly other
201 * identification objects defined.
202 * Configurable: Device has a _CRS and possibly other configuration
204 * Power Control: Device has a _PR0 and/or _PS0 and possibly other
205 * power management objects defined.
206 * Ejectable: Device has an _EJD and/or _EJx and possibly other
207 * dynamic insertion/removal objects defined.
208 * Docking Station: Device has a _DCK object defined.
209 * Fixed-Feature: Device does not exist in the namespace; was
210 * enumerated as a fixed-feature (e.g. power button).
211 * Power Manageable:Can change device's power consumption behavior.
212 * Has a HID: In the BIOS ASL this device has a hardware ID as
213 * defined in section 6.1.4 of ACPI Spec 2.0
214 * Has a CID: In the BIOS ASL this device has a compatible ID as
215 * defined in section 6.1.2 of ACPI Spec 2.0
216 * Has a ADR: In the BIOS ASL this device has an address ID as
217 * defined in section 6.1.1 of ACPI Spec 2.0
218 * Is a bridge: This device is recognized as a bridge to another bus.
219 * Is on PCI bus: This device is on a PCI bus or within PCI configuration
221 * Is on USB bus: This device is on or within USB address space.
222 * Is on SCSI bus: This device is on or within SCSI address space.
223 * Driver Control: A driver has been installed for this device.
225 typedef u32 BM_DEVICE_FLAGS;
227 #define BM_FLAGS_UNKNOWN ((BM_DEVICE_FLAGS) 0x00000000)
229 #define BM_FLAGS_DYNAMIC_STATUS ((BM_DEVICE_FLAGS) 0x00000001)
230 #define BM_FLAGS_IDENTIFIABLE ((BM_DEVICE_FLAGS) 0x00000002)
231 #define BM_FLAGS_CONFIGURABLE ((BM_DEVICE_FLAGS) 0x00000004)
232 #define BM_FLAGS_POWER_CONTROL ((BM_DEVICE_FLAGS) 0x00000008)
233 #define BM_FLAGS_EJECTABLE ((BM_DEVICE_FLAGS) 0x00000010)
234 #define BM_FLAGS_DOCKING_STATION ((BM_DEVICE_FLAGS) 0x00000020)
235 #define BM_FLAGS_FIXED_FEATURE ((BM_DEVICE_FLAGS) 0x00000040)
236 #define BM_FLAGS_IS_POWER_MANAGEABLE ((BM_DEVICE_FLAGS) 0x00000080)
237 #define BM_FLAGS_HAS_A_HID ((BM_DEVICE_FLAGS) 0x00000100)
238 #define BM_FLAGS_HAS_A_CID ((BM_DEVICE_FLAGS) 0x00000200)
239 #define BM_FLAGS_HAS_A_ADR ((BM_DEVICE_FLAGS) 0x00000400)
240 #define BM_FLAGS_IS_A_BRIDGE ((BM_DEVICE_FLAGS) 0x00000800)
241 #define BM_FLAGS_IS_ON_PCI_BUS ((BM_DEVICE_FLAGS) 0x00001000)
242 #define BM_FLAGS_IS_ON_USB_BUS ((BM_DEVICE_FLAGS) 0x00002000)
243 #define BM_FLAGS_IS_ON_SCSI_BUS ((BM_DEVICE_FLAGS) 0x00004000)
244 #define BM_FLAGS_DRIVER_CONTROL ((BM_DEVICE_FLAGS) 0x80000000)
249 * +-----------+-+-+-+-+-+-+-+
250 * | Bits 31:7 |6|5|4|3|2|1|0|
251 * +-----------+-+-+-+-+-+-+-+
253 * | | | | | | | +- D0 Support?
254 * | | | | | | +--- D1 Support?
255 * | | | | | +----- D2 Support?
256 * | | | | +------- D3 Support?
257 * | | | +--------- Power State Queriable?
258 * | | +----------- Inrush Current?
259 * | +------------- Wake Capable?
260 * +-------------------- <Reserved>
262 * D0-D3 Support: Device supports corresponding Dx state.
263 * Power State: Device has a _PSC (current power state) object defined.
264 * Inrush Current: Device has an _IRC (inrush current) object defined.
265 * Wake Capable: Device has a _PRW (wake-capable) object defined.
267 #define BM_FLAGS_D0_SUPPORT ((BM_DEVICE_FLAGS) 0x00000001)
268 #define BM_FLAGS_D1_SUPPORT ((BM_DEVICE_FLAGS) 0x00000002)
269 #define BM_FLAGS_D2_SUPPORT ((BM_DEVICE_FLAGS) 0x00000004)
270 #define BM_FLAGS_D3_SUPPORT ((BM_DEVICE_FLAGS) 0x00000008)
271 #define BM_FLAGS_POWER_STATE ((BM_DEVICE_FLAGS) 0x00000010)
272 #define BM_FLAGS_INRUSH_CURRENT ((BM_DEVICE_FLAGS) 0x00000020)
273 #define BM_FLAGS_WAKE_CAPABLE ((BM_DEVICE_FLAGS) 0x00000040)
279 * The encoding of BM_DEVICE_STATUS is illustrated below.
280 * Note that a set bit (1) indicates the property is TRUE
281 * (e.g. if bit 0 is set then the device is present).
282 * +-----------+-+-+-+-+-+
283 * | Bits 31:4 |4|3|2|1|0|
284 * +-----------+-+-+-+-+-+
286 * | | | | | +- Present?
287 * | | | | +--- Enabled?
288 * | | | +----- Show in UI?
289 * | | +------- Functioning?
290 * | +--------- Battery Present?
291 * +---------------- <Reserved>
293 typedef u32 BM_DEVICE_STATUS;
295 #define BM_STATUS_UNKNOWN ((BM_DEVICE_STATUS) 0x00000000)
296 #define BM_STATUS_PRESENT ((BM_DEVICE_STATUS) 0x00000001)
297 #define BM_STATUS_ENABLED ((BM_DEVICE_STATUS) 0x00000002)
298 #define BM_STATUS_SHOW_UI ((BM_DEVICE_STATUS) 0x00000004)
299 #define BM_STATUS_FUNCTIONING ((BM_DEVICE_STATUS) 0x00000008)
300 #define BM_STATUS_BATTERY_PRESENT ((BM_DEVICE_STATUS) 0x00000010)
301 #define BM_STATUS_DEFAULT ((BM_DEVICE_STATUS) 0x0000000F)
304 typedef u32 BM_POWER_STATE;
306 typedef u8 BM_PCI_BUS_NUM;
307 typedef u8 BM_PCI_DEVICE_NUM;
308 typedef u8 BM_PCI_FUNCTION_NUM;
309 typedef u8 BM_U8_RESERVED;
310 typedef u8 BM_PCI_DEVICE_CLASS_ID;
311 typedef u8 BM_PCI_DEVICE_SUBCLASS_ID;
312 typedef u8 BM_PCI_DEVICE_PROG_IF;
313 typedef u8 BM_PCI_DEVICE_REVISION;
314 typedef u16 BM_PCI_VENDOR_ID;
315 typedef u16 BM_PCI_DEVICE_ID;
316 typedef u32 BM_U32_RESERVED;
321 * This structure, when filled in for a device, provides
322 * an "association" between hardware space and ACPI.
323 * -----------------------------------------------------------
332 BM_PCI_BUS_NUM pci_bus_num;
333 BM_PCI_DEVICE_NUM pci_device_num;
334 BM_PCI_FUNCTION_NUM pci_func_num;
335 BM_U8_RESERVED u8_reserved;
336 BM_PCI_DEVICE_CLASS_ID pci_device_class_id;
337 BM_PCI_DEVICE_SUBCLASS_ID pci_device_subclass_id;
338 BM_PCI_DEVICE_PROG_IF pci_device_prog_if;
339 BM_PCI_DEVICE_REVISION pci_device_rev_num;
340 BM_PCI_VENDOR_ID pci_vendor_id;
341 BM_PCI_DEVICE_ID pci_device_id;
342 BM_U32_RESERVED u32_reserved;
349 * Structure containing basic device power management information.
353 BM_DEVICE_FLAGS flags;
354 BM_POWER_STATE state;
355 BM_DEVICE_FLAGS dx_supported[ACPI_S_STATE_COUNT];
366 ACPI_HANDLE acpi_handle;
367 BM_DEVICE_FLAGS flags;
368 BM_DEVICE_STATUS status;
370 BM_DEVICE_POWER power;
377 * Structure used for searching the ACPI Bus Manager's device hierarchy.
381 BM_DEVICE_ID criteria;
382 BM_HANDLE_LIST results;
389 * Structure used for sending requests to/through the ACPI Bus Manager.
401 * Driver Registration:
402 * --------------------
406 typedef void * BM_DRIVER_CONTEXT;
408 /* Notification Callback Function */
410 ACPI_STATUS (*BM_DRIVER_NOTIFY) (
411 BM_NOTIFY notify_type,
412 BM_HANDLE device_handle,
413 BM_DRIVER_CONTEXT *context);
415 /* Request Callback Function */
417 ACPI_STATUS (*BM_DRIVER_REQUEST) (
419 BM_DRIVER_CONTEXT context);
421 /* Driver Registration */
424 BM_DRIVER_NOTIFY notify;
425 BM_DRIVER_REQUEST request;
426 BM_DRIVER_CONTEXT context;
433 * Structure used to maintain the device hierarchy.
435 typedef struct _BM_NODE
439 struct _BM_NODE *parent;
440 struct _BM_NODE *next;
443 struct _BM_NODE *head;
444 struct _BM_NODE *tail;
452 * Structure used to maintain an array of node pointers.
457 BM_NODE *nodes[BM_HANDLES_MAX];
461 /*****************************************************************************
463 *****************************************************************************/
465 #define BM_DEVICE_PRESENT(d) (d->status & BM_STATUS_PRESENT)
466 #define BM_NODE_PRESENT(n) (n->device.status & BM_STATUS_PRESENT)
469 /*****************************************************************************
470 * Function Prototypes
471 *****************************************************************************/
476 bm_initialize (void);
487 ACPI_HANDLE acpi_handle,
488 BM_HANDLE *device_handle);
492 BM_HANDLE device_handle,
493 ACPI_HANDLE acpi_handle,
500 BM_HANDLE device_handle,
501 BM_DEVICE_ID *criteria,
502 BM_HANDLE_LIST *results);
508 ACPI_HANDLE acpi_handle,
516 BM_REQUEST *request_info);
521 bm_get_device_status (
522 BM_HANDLE device_handle,
523 BM_DEVICE_STATUS *device_status);
527 BM_HANDLE device_handle,
528 BM_DEVICE **device_info);
531 bm_get_device_context (
532 BM_HANDLE device_handle,
533 BM_DRIVER_CONTEXT *context);
537 BM_DEVICE_ID *criteria,
541 bm_unregister_driver (
542 BM_DEVICE_ID *criteria,
548 bm_get_pm_capabilities (
558 BM_POWER_STATE target_state);
563 bm_pr_initialize (void);
566 bm_pr_terminate (void);
583 bm_extract_package_data (
584 ACPI_OBJECT *package,
586 ACPI_BUFFER *buffer);
590 ACPI_HANDLE acpi_handle,
591 ACPI_STRING pathname,
592 ACPI_OBJECT_LIST *arguments,
593 ACPI_BUFFER *buffer);
596 bm_evaluate_simple_integer (
597 ACPI_HANDLE acpi_handle,
598 ACPI_STRING pathname,
602 bm_evaluate_reference_list (
603 ACPI_HANDLE acpi_handle,
604 ACPI_STRING pathname,
605 BM_HANDLE_LIST *reference_list);
610 bm_proc_initialize (void);
613 bm_proc_terminate (void);
617 BM_HANDLE device_handle,
619 char *device_instance,
624 #endif /* __BM_H__ */