acpivar.h revision 1.89
1 /* $NetBSD: acpivar.h,v 1.89 2021/12/26 14:34:39 jmcneill Exp $ */ 2 3 /* 4 * Copyright 2001 Wasabi Systems, Inc. 5 * All rights reserved. 6 * 7 * Written by Jason R. Thorpe for Wasabi Systems, Inc. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 3. All advertising materials mentioning features or use of this software 18 * must display the following acknowledgement: 19 * This product includes software developed for the NetBSD Project by 20 * Wasabi Systems, Inc. 21 * 4. The name of Wasabi Systems, Inc. may not be used to endorse 22 * or promote products derived from this software without specific prior 23 * written permission. 24 * 25 * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND 26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 27 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 28 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WASABI SYSTEMS, INC 29 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 30 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 31 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 32 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 33 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 34 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 35 * POSSIBILITY OF SUCH DAMAGE. 36 */ 37 38 #ifndef _SYS_DEV_ACPI_ACPIVAR_H 39 #define _SYS_DEV_ACPI_ACPIVAR_H 40 41 /* 42 * This file defines the ACPI interface provided to the rest of the 43 * kernel, as well as the autoconfiguration structures for ACPI 44 * support. 45 */ 46 47 #include <sys/bus.h> 48 #include <dev/pci/pcivar.h> 49 #include <dev/isa/isavar.h> 50 51 #include <dev/acpi/acpica.h> 52 #include <dev/acpi/acpi_util.h> 53 54 #include <dev/sysmon/sysmonvar.h> 55 56 /* 57 * This structure is used to attach the ACPI "bus". 58 */ 59 struct acpibus_attach_args { 60 bus_space_tag_t aa_iot; /* PCI I/O space tag */ 61 bus_space_tag_t aa_memt; /* PCI MEM space tag */ 62 pci_chipset_tag_t aa_pc; /* PCI chipset */ 63 int aa_pciflags; /* PCI bus flags */ 64 isa_chipset_tag_t aa_ic; /* ISA chipset */ 65 bus_dma_tag_t aa_dmat; /* PCI DMA tag */ 66 bus_dma_tag_t aa_dmat64; /* PCI 64bit DMA tag */ 67 }; 68 69 /* 70 * PCI information for ACPI device nodes that correspond to PCI devices. 71 * 72 * Remarks: 73 * 74 * ap_bus <= 255 75 * ap_device <= 31 76 * ap_function <= 7 or ap_function == 0xFFFF 77 * ap_downbus <= 255 78 * 79 * Validity of some fields depends on the value of ap_flags: 80 * 81 * ap_segment always valid 82 * ap_bus, ap_device, ap_function valid for PCI devices 83 * ap_downbus valid for PCI bridges 84 * 85 * The device and function numbers are encoded in the value returned by 86 * _ADR. A function number of 0xFFFF is used to refer to all the 87 * functions on a PCI device (ACPI 4.0a, p. 200). 88 */ 89 struct acpi_pci_info { 90 pci_chipset_tag_t ap_pc; /* PCI chipset tag */ 91 uint16_t ap_flags; /* Flags (cf. below) */ 92 uint16_t ap_segment; /* PCI segment group */ 93 uint16_t ap_bus; /* PCI bus */ 94 uint16_t ap_device; /* PCI device */ 95 uint16_t ap_function; /* PCI function */ 96 uint16_t ap_downbus; /* PCI bridge downstream bus */ 97 }; 98 99 /* 100 * Flags for PCI information. 101 */ 102 #define ACPI_PCI_INFO_DEVICE __BIT(0) /* PCI device */ 103 #define ACPI_PCI_INFO_BRIDGE __BIT(1) /* PCI bridge */ 104 105 /* 106 * An ACPI device node. 107 * 108 * Remarks: 109 * 110 * ad_device NULL if no device has attached to the node 111 * ad_root never NULL 112 * ad_parent only NULL if root of the tree ("\") 113 * ad_pciinfo NULL if not a PCI device 114 * ad_wakedev NULL if no wakeup capabilities 115 * ad_notify NULL if there is no notify handler 116 * ad_devinfo never NULL 117 * ad_handle never NULL 118 * 119 * Each ACPI device node is associated with its handle. The function 120 * acpi_match_node() can be used to get the node structure from a handle. 121 */ 122 struct acpi_devnode { 123 device_t ad_device; /* Device */ 124 device_t ad_root; /* Backpointer to acpi_softc */ 125 struct acpi_devnode *ad_parent; /* Backpointer to parent */ 126 struct acpi_pci_info *ad_pciinfo; /* PCI info */ 127 struct acpi_wakedev *ad_wakedev; /* Device wake */ 128 ACPI_NOTIFY_HANDLER ad_notify; /* Device notify */ 129 ACPI_DEVICE_INFO *ad_devinfo; /* Device info */ 130 ACPI_HANDLE ad_handle; /* Device handle */ 131 char ad_name[5]; /* Device name */ 132 uint32_t ad_flags; /* Device flags */ 133 uint32_t ad_type; /* Device type */ 134 int ad_state; /* Device power state */ 135 bus_dma_tag_t ad_dmat; /* Bus DMA tag for device */ 136 bus_dma_tag_t ad_dmat64; /* Bus DMA tag for device (64-bit) */ 137 138 SIMPLEQ_ENTRY(acpi_devnode) ad_list; 139 SIMPLEQ_ENTRY(acpi_devnode) ad_child_list; 140 SIMPLEQ_HEAD(, acpi_devnode) ad_child_head; 141 }; 142 143 /* 144 * ACPI driver capabilities (ad_flags). 145 */ 146 #define ACPI_DEVICE_POWER __BIT(0) /* Support for D-states */ 147 #define ACPI_DEVICE_WAKEUP __BIT(1) /* Support for wake-up */ 148 #define ACPI_DEVICE_EJECT __BIT(2) /* Support for "ejection" */ 149 #define ACPI_DEVICE_DOCK __BIT(3) /* Support for docking */ 150 151 /* 152 * Software state of the ACPI subsystem. 153 */ 154 struct acpi_softc { 155 device_t sc_dev; /* base device info */ 156 device_t sc_apmbus; /* APM pseudo-bus */ 157 device_t sc_hpet; /* hpet(4) pseudo-bus */ 158 device_t sc_wdrt; /* acpiwdrt(4) pseudo-bus */ 159 160 struct acpi_devnode *sc_root; /* root of the device tree */ 161 162 bus_space_tag_t sc_iot; /* PCI I/O space tag */ 163 bus_space_tag_t sc_memt; /* PCI MEM space tag */ 164 int sc_pciflags; /* PCI bus flags */ 165 int sc_pci_bus; /* internal PCI fixup */ 166 isa_chipset_tag_t sc_ic; /* ISA chipset tag */ 167 bus_dma_tag_t sc_dmat; /* PCI DMA tag */ 168 bus_dma_tag_t sc_dmat64; /* PCI 64bit DMA tag */ 169 170 void *sc_sdhook; /* shutdown hook */ 171 172 int sc_quirks; 173 int sc_sleepstate; 174 int sc_sleepstates; 175 176 struct sysmon_pswitch sc_smpsw_power; 177 struct sysmon_pswitch sc_smpsw_sleep; 178 179 SIMPLEQ_HEAD(, acpi_devnode) sc_head; 180 }; 181 182 /* 183 * acpi_attach_args: 184 * 185 * Used to attach a device instance to the acpi "bus". 186 */ 187 struct acpi_attach_args { 188 struct acpi_devnode *aa_node; /* ACPI device node */ 189 bus_space_tag_t aa_iot; /* PCI I/O space tag */ 190 bus_space_tag_t aa_memt; /* PCI MEM space tag */ 191 pci_chipset_tag_t aa_pc; /* PCI chipset tag */ 192 int aa_pciflags; /* PCI bus flags */ 193 isa_chipset_tag_t aa_ic; /* ISA chipset */ 194 bus_dma_tag_t aa_dmat; /* PCI DMA tag */ 195 bus_dma_tag_t aa_dmat64; /* PCI 64bit DMA tag */ 196 }; 197 198 /* ACPI driver matching scores. */ 199 #define ACPI_MATCHSCORE_HID 100 /* matched _HID */ 200 #define ACPI_MATCHSCORE_CID_MAX 49 201 #define ACPI_MATCHSCORE_CID 10 /* matched _CID or _DSD 202 * "compatible" 203 */ 204 #define ACPI_MATCHSCORE_CLS 1 /* matched _CLS */ 205 206 /* 207 * ACPI resources: 208 * 209 * acpi_io I/O ports 210 * acpi_iorange I/O port range 211 * acpi_mem memory region 212 * acpi_memrange memory range 213 * acpi_irq Interrupt Request 214 * acpi_drq DMA request 215 */ 216 struct acpi_io { 217 SIMPLEQ_ENTRY(acpi_io) ar_list; 218 int ar_index; 219 uint32_t ar_base; 220 uint32_t ar_length; 221 }; 222 223 struct acpi_iorange { 224 SIMPLEQ_ENTRY(acpi_iorange) ar_list; 225 int ar_index; 226 uint32_t ar_low; 227 uint32_t ar_high; 228 uint32_t ar_length; 229 uint32_t ar_align; 230 }; 231 232 struct acpi_mem { 233 SIMPLEQ_ENTRY(acpi_mem) ar_list; 234 int ar_index; 235 bus_addr_t ar_base; 236 bus_size_t ar_length; 237 bus_addr_t ar_xbase; /* translated base address */ 238 }; 239 240 struct acpi_memrange { 241 SIMPLEQ_ENTRY(acpi_memrange) ar_list; 242 int ar_index; 243 bus_addr_t ar_low; 244 bus_addr_t ar_high; 245 bus_size_t ar_length; 246 bus_size_t ar_align; 247 }; 248 249 struct acpi_irq { 250 SIMPLEQ_ENTRY(acpi_irq) ar_list; 251 int ar_index; 252 uint32_t ar_irq; 253 uint32_t ar_type; 254 }; 255 256 struct acpi_drq { 257 SIMPLEQ_ENTRY(acpi_drq) ar_list; 258 int ar_index; 259 uint32_t ar_drq; 260 }; 261 262 struct acpi_resources { 263 SIMPLEQ_HEAD(, acpi_io) ar_io; 264 int ar_nio; 265 266 SIMPLEQ_HEAD(, acpi_iorange) ar_iorange; 267 int ar_niorange; 268 269 SIMPLEQ_HEAD(, acpi_mem) ar_mem; 270 int ar_nmem; 271 272 SIMPLEQ_HEAD(, acpi_memrange) ar_memrange; 273 int ar_nmemrange; 274 275 SIMPLEQ_HEAD(, acpi_irq) ar_irq; 276 int ar_nirq; 277 278 SIMPLEQ_HEAD(, acpi_drq) ar_drq; 279 int ar_ndrq; 280 }; 281 282 /* 283 * acpi_resource_parse_ops: 284 * 285 * The client of ACPI resources specifies these operations 286 * when the resources are parsed. 287 */ 288 struct acpi_resource_parse_ops { 289 void (*init)(device_t, void *, void **); 290 void (*fini)(device_t, void *); 291 292 void (*ioport)(device_t, void *, uint32_t, uint32_t); 293 void (*iorange)(device_t, void *, uint32_t, uint32_t, 294 uint32_t, uint32_t); 295 296 void (*memory)(device_t, void *, uint64_t, uint64_t, uint64_t); 297 void (*memrange)(device_t, void *, uint64_t, uint64_t, 298 uint64_t, uint64_t); 299 300 void (*irq)(device_t, void *, uint32_t, uint32_t); 301 void (*drq)(device_t, void *, uint32_t); 302 303 void (*start_dep)(device_t, void *, int); 304 void (*end_dep)(device_t, void *); 305 }; 306 307 extern struct acpi_softc *acpi_softc; 308 extern int acpi_active; 309 310 extern const struct acpi_resource_parse_ops acpi_resource_parse_ops_default; 311 extern const struct acpi_resource_parse_ops acpi_resource_parse_ops_quiet; 312 313 int acpi_probe(void); 314 void acpi_disable(void); 315 int acpi_check(device_t, const char *); 316 317 int acpi_compatible_match(const struct acpi_attach_args *, 318 const struct device_compatible_entry *); 319 const struct device_compatible_entry * 320 acpi_compatible_lookup(const struct acpi_attach_args *, 321 const struct device_compatible_entry *); 322 323 bool acpi_device_present(ACPI_HANDLE); 324 325 int acpi_reset(void); 326 327 ACPI_PHYSICAL_ADDRESS acpi_OsGetRootPointer(void); 328 329 bool acpi_register_notify(struct acpi_devnode *, 330 ACPI_NOTIFY_HANDLER); 331 void acpi_deregister_notify(struct acpi_devnode *); 332 333 ACPI_STATUS acpi_resource_parse(device_t, ACPI_HANDLE, const char *, 334 void *, const struct acpi_resource_parse_ops *); 335 ACPI_STATUS acpi_resource_parse_any(device_t, ACPI_HANDLE, const char *, 336 void *, const struct acpi_resource_parse_ops *); 337 void acpi_resource_print(device_t, struct acpi_resources *); 338 void acpi_resource_cleanup(struct acpi_resources *); 339 340 void * acpi_pci_link_devbyhandle(ACPI_HANDLE); 341 void acpi_pci_link_add_reference(void *, pci_chipset_tag_t, int, 342 int, int, int); 343 int acpi_pci_link_route_interrupt(void *, pci_chipset_tag_t, int, 344 int *, int *, int *); 345 char * acpi_pci_link_name(void *); 346 ACPI_HANDLE acpi_pci_link_handle(void *); 347 void acpi_pci_link_state(void); 348 void acpi_pci_link_resume(void); 349 350 struct acpi_io *acpi_res_io(struct acpi_resources *, int); 351 struct acpi_iorange *acpi_res_iorange(struct acpi_resources *, int); 352 struct acpi_mem *acpi_res_mem(struct acpi_resources *, int); 353 struct acpi_memrange *acpi_res_memrange(struct acpi_resources *, int); 354 struct acpi_irq *acpi_res_irq(struct acpi_resources *, int); 355 struct acpi_drq *acpi_res_drq(struct acpi_resources *, int); 356 357 /* 358 * Sleep state transition. 359 */ 360 void acpi_enter_sleep_state(int); 361 362 /* 363 * MADT. 364 */ 365 #define ACPI_PLATFORM_INT_PMI 1 366 #define ACPI_PLATFORM_INT_INIT 2 367 #define ACPI_PLATFORM_INT_CERR 3 368 369 ACPI_STATUS acpi_madt_map(void); 370 void acpi_madt_unmap(void); 371 void acpi_madt_walk(ACPI_STATUS (*)(ACPI_SUBTABLE_HEADER *, 372 void *), void *); 373 374 /* 375 * GTDT. 376 */ 377 ACPI_STATUS acpi_gtdt_map(void); 378 void acpi_gtdt_unmap(void); 379 void acpi_gtdt_walk(ACPI_STATUS (*)(ACPI_GTDT_HEADER *, 380 void *), void *); 381 382 /* 383 * Quirk handling. 384 */ 385 struct acpi_quirk { 386 const char *aq_tabletype; /* Type of table */ 387 const char *aq_oemid; /* "OemId" field */ 388 int aq_oemrev; /* "OemRev" field */ 389 int aq_cmpop; /* "OemRev" comparison */ 390 const char *aq_tabid; /* "TableId */ 391 int aq_quirks; /* The actual quirk */ 392 }; 393 394 #define ACPI_QUIRK_BROKEN 0x00000001 /* totally broken */ 395 #define ACPI_QUIRK_BADPCI 0x00000002 /* bad PCI hierarchy */ 396 #define ACPI_QUIRK_BADBBN 0x00000004 /* _BBN broken */ 397 #define ACPI_QUIRK_IRQ0 0x00000008 /* bad 0->2 irq override */ 398 #define ACPI_QUIRK_OLDBIOS 0x00000010 /* BIOS date blacklisted */ 399 400 int acpi_find_quirks(void); 401 402 #ifdef ACPI_DEBUG 403 void acpi_debug_init(void); 404 #endif 405 406 bus_dma_tag_t acpi_get_dma_tag(struct acpi_softc *, struct acpi_devnode *); 407 bus_dma_tag_t acpi_get_dma64_tag(struct acpi_softc *, struct acpi_devnode *); 408 pci_chipset_tag_t acpi_get_pci_chipset_tag(struct acpi_softc *, int, int); 409 410 /* 411 * Misc routines with vectors updated by acpiverbose module. 412 */ 413 extern void (*acpi_print_verbose)(struct acpi_softc *); 414 extern void (*acpi_print_dev)(const char *); 415 416 void acpi_load_verbose(void); 417 extern int acpi_verbose_loaded; 418 419 #endif /* !_SYS_DEV_ACPI_ACPIVAR_H */ 420
Indexes created Mon Sep 29 21:09:56 GMT 2025