acpivar.h revision 1.92
1 /* $NetBSD: acpivar.h,v 1.92 2024/12/09 22:10:25 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 device_t ad_gpiodev; /* GPIO controller device */ 139 int (*ad_gpio_translate)(void *, ACPI_RESOURCE_GPIO *, void **); 140 void *ad_gpio_priv; /* private data for translate */ 141 142 SIMPLEQ_ENTRY(acpi_devnode) ad_list; 143 SIMPLEQ_ENTRY(acpi_devnode) ad_child_list; 144 SIMPLEQ_HEAD(, acpi_devnode) ad_child_head; 145 }; 146 147 /* 148 * ACPI driver capabilities (ad_flags). 149 */ 150 #define ACPI_DEVICE_POWER __BIT(0) /* Support for D-states */ 151 #define ACPI_DEVICE_WAKEUP __BIT(1) /* Support for wake-up */ 152 #define ACPI_DEVICE_EJECT __BIT(2) /* Support for "ejection" */ 153 #define ACPI_DEVICE_DOCK __BIT(3) /* Support for docking */ 154 155 /* 156 * Software state of the ACPI subsystem. 157 */ 158 struct acpi_softc { 159 device_t sc_dev; /* base device info */ 160 device_t sc_apmbus; /* APM pseudo-bus */ 161 device_t sc_hpet; /* hpet(4) pseudo-bus */ 162 device_t sc_wdrt; /* acpiwdrt(4) pseudo-bus */ 163 164 struct acpi_devnode *sc_root; /* root of the device tree */ 165 166 bus_space_tag_t sc_iot; /* PCI I/O space tag */ 167 bus_space_tag_t sc_memt; /* PCI MEM space tag */ 168 int sc_pciflags; /* PCI bus flags */ 169 int sc_pci_bus; /* internal PCI fixup */ 170 isa_chipset_tag_t sc_ic; /* ISA chipset tag */ 171 bus_dma_tag_t sc_dmat; /* PCI DMA tag */ 172 bus_dma_tag_t sc_dmat64; /* PCI 64bit DMA tag */ 173 174 void *sc_sdhook; /* shutdown hook */ 175 176 int sc_quirks; 177 int sc_sleepstate; 178 int sc_sleepstates; 179 180 struct sysmon_pswitch sc_smpsw_power; 181 struct sysmon_pswitch sc_smpsw_sleep; 182 183 SIMPLEQ_HEAD(, acpi_devnode) sc_head; 184 185 /* 186 * Move this section to the other pseudo-bus child pointers 187 * after pullup -- putting it here avoids potential ABI 188 * compatibility issues with kernel modules. 189 */ 190 device_t sc_apei; /* apei(4) pseudo-bus */ 191 }; 192 193 /* 194 * acpi_attach_args: 195 * 196 * Used to attach a device instance to the acpi "bus". 197 */ 198 struct acpi_attach_args { 199 struct acpi_devnode *aa_node; /* ACPI device node */ 200 bus_space_tag_t aa_iot; /* PCI I/O space tag */ 201 bus_space_tag_t aa_memt; /* PCI MEM space tag */ 202 pci_chipset_tag_t aa_pc; /* PCI chipset tag */ 203 int aa_pciflags; /* PCI bus flags */ 204 isa_chipset_tag_t aa_ic; /* ISA chipset */ 205 bus_dma_tag_t aa_dmat; /* PCI DMA tag */ 206 bus_dma_tag_t aa_dmat64; /* PCI 64bit DMA tag */ 207 }; 208 209 /* ACPI driver matching scores. */ 210 #define ACPI_MATCHSCORE_HID 100 /* matched _HID */ 211 #define ACPI_MATCHSCORE_CID_MAX 49 212 #define ACPI_MATCHSCORE_CID 10 /* matched _CID or _DSD 213 * "compatible" 214 */ 215 #define ACPI_MATCHSCORE_CLS 1 /* matched _CLS */ 216 217 /* 218 * ACPI resources: 219 * 220 * acpi_io I/O ports 221 * acpi_iorange I/O port range 222 * acpi_mem memory region 223 * acpi_memrange memory range 224 * acpi_irq Interrupt Request 225 * acpi_drq DMA request 226 */ 227 struct acpi_io { 228 SIMPLEQ_ENTRY(acpi_io) ar_list; 229 int ar_index; 230 uint32_t ar_base; 231 uint32_t ar_length; 232 }; 233 234 struct acpi_iorange { 235 SIMPLEQ_ENTRY(acpi_iorange) ar_list; 236 int ar_index; 237 uint32_t ar_low; 238 uint32_t ar_high; 239 uint32_t ar_length; 240 uint32_t ar_align; 241 }; 242 243 struct acpi_mem { 244 SIMPLEQ_ENTRY(acpi_mem) ar_list; 245 int ar_index; 246 bus_addr_t ar_base; 247 bus_size_t ar_length; 248 bus_addr_t ar_xbase; /* translated base address */ 249 }; 250 251 struct acpi_memrange { 252 SIMPLEQ_ENTRY(acpi_memrange) ar_list; 253 int ar_index; 254 bus_addr_t ar_low; 255 bus_addr_t ar_high; 256 bus_size_t ar_length; 257 bus_size_t ar_align; 258 }; 259 260 struct acpi_irq { 261 SIMPLEQ_ENTRY(acpi_irq) ar_list; 262 int ar_index; 263 uint32_t ar_irq; 264 uint32_t ar_type; 265 }; 266 267 struct acpi_drq { 268 SIMPLEQ_ENTRY(acpi_drq) ar_list; 269 int ar_index; 270 uint32_t ar_drq; 271 }; 272 273 struct acpi_resources { 274 SIMPLEQ_HEAD(, acpi_io) ar_io; 275 int ar_nio; 276 277 SIMPLEQ_HEAD(, acpi_iorange) ar_iorange; 278 int ar_niorange; 279 280 SIMPLEQ_HEAD(, acpi_mem) ar_mem; 281 int ar_nmem; 282 283 SIMPLEQ_HEAD(, acpi_memrange) ar_memrange; 284 int ar_nmemrange; 285 286 SIMPLEQ_HEAD(, acpi_irq) ar_irq; 287 int ar_nirq; 288 289 SIMPLEQ_HEAD(, acpi_drq) ar_drq; 290 int ar_ndrq; 291 }; 292 293 /* 294 * acpi_resource_parse_ops: 295 * 296 * The client of ACPI resources specifies these operations 297 * when the resources are parsed. 298 */ 299 struct acpi_resource_parse_ops { 300 void (*init)(device_t, void *, void **); 301 void (*fini)(device_t, void *); 302 303 void (*ioport)(device_t, void *, uint32_t, uint32_t); 304 void (*iorange)(device_t, void *, uint32_t, uint32_t, 305 uint32_t, uint32_t); 306 307 void (*memory)(device_t, void *, uint64_t, uint64_t, uint64_t); 308 void (*memrange)(device_t, void *, uint64_t, uint64_t, 309 uint64_t, uint64_t); 310 311 void (*irq)(device_t, void *, uint32_t, uint32_t); 312 void (*drq)(device_t, void *, uint32_t); 313 314 void (*start_dep)(device_t, void *, int); 315 void (*end_dep)(device_t, void *); 316 }; 317 318 extern struct acpi_softc *acpi_softc; 319 extern int acpi_active; 320 321 extern const struct acpi_resource_parse_ops acpi_resource_parse_ops_default; 322 extern const struct acpi_resource_parse_ops acpi_resource_parse_ops_quiet; 323 324 int acpi_probe(void); 325 void acpi_disable(void); 326 int acpi_check(device_t, const char *); 327 328 int acpi_compatible_match(const struct acpi_attach_args *, 329 const struct device_compatible_entry *); 330 const struct device_compatible_entry * 331 acpi_compatible_lookup(const struct acpi_attach_args *, 332 const struct device_compatible_entry *); 333 334 bool acpi_device_present(ACPI_HANDLE); 335 336 int acpi_reset(void); 337 338 ACPI_PHYSICAL_ADDRESS acpi_OsGetRootPointer(void); 339 340 bool acpi_register_notify(struct acpi_devnode *, 341 ACPI_NOTIFY_HANDLER); 342 void acpi_deregister_notify(struct acpi_devnode *); 343 344 ACPI_STATUS acpi_resource_parse(device_t, ACPI_HANDLE, const char *, 345 void *, const struct acpi_resource_parse_ops *); 346 ACPI_STATUS acpi_resource_parse_any(device_t, ACPI_HANDLE, const char *, 347 void *, const struct acpi_resource_parse_ops *); 348 void acpi_resource_print(device_t, struct acpi_resources *); 349 void acpi_resource_cleanup(struct acpi_resources *); 350 351 void * acpi_pci_link_devbyhandle(ACPI_HANDLE); 352 void acpi_pci_link_add_reference(void *, pci_chipset_tag_t, int, 353 int, int, int); 354 int acpi_pci_link_route_interrupt(void *, pci_chipset_tag_t, int, 355 int *, int *, int *); 356 char * acpi_pci_link_name(void *); 357 ACPI_HANDLE acpi_pci_link_handle(void *); 358 void acpi_pci_link_state(void); 359 void acpi_pci_link_resume(void); 360 361 struct acpi_io *acpi_res_io(struct acpi_resources *, int); 362 struct acpi_iorange *acpi_res_iorange(struct acpi_resources *, int); 363 struct acpi_mem *acpi_res_mem(struct acpi_resources *, int); 364 struct acpi_memrange *acpi_res_memrange(struct acpi_resources *, int); 365 struct acpi_irq *acpi_res_irq(struct acpi_resources *, int); 366 struct acpi_drq *acpi_res_drq(struct acpi_resources *, int); 367 368 /* 369 * Sleep state transition. 370 */ 371 void acpi_enter_sleep_state(int); 372 373 /* 374 * MADT. 375 */ 376 #define ACPI_PLATFORM_INT_PMI 1 377 #define ACPI_PLATFORM_INT_INIT 2 378 #define ACPI_PLATFORM_INT_CERR 3 379 380 ACPI_STATUS acpi_madt_map(void); 381 void acpi_madt_unmap(void); 382 void acpi_madt_walk(ACPI_STATUS (*)(ACPI_SUBTABLE_HEADER *, 383 void *), void *); 384 385 /* 386 * GTDT. 387 */ 388 ACPI_STATUS acpi_gtdt_map(void); 389 void acpi_gtdt_unmap(void); 390 void acpi_gtdt_walk(ACPI_STATUS (*)(ACPI_GTDT_HEADER *, 391 void *), void *); 392 393 /* 394 * Quirk handling. 395 */ 396 struct acpi_quirk { 397 const char *aq_tabletype; /* Type of table */ 398 const char *aq_oemid; /* "OemId" field */ 399 int aq_oemrev; /* "OemRev" field */ 400 int aq_cmpop; /* "OemRev" comparison */ 401 const char *aq_tabid; /* "TableId */ 402 int aq_quirks; /* The actual quirk */ 403 }; 404 405 #define ACPI_QUIRK_BROKEN 0x00000001 /* totally broken */ 406 #define ACPI_QUIRK_BADPCI 0x00000002 /* bad PCI hierarchy */ 407 #define ACPI_QUIRK_BADBBN 0x00000004 /* _BBN broken */ 408 #define ACPI_QUIRK_IRQ0 0x00000008 /* bad 0->2 irq override */ 409 #define ACPI_QUIRK_OLDBIOS 0x00000010 /* BIOS date blacklisted */ 410 411 int acpi_find_quirks(void); 412 413 #ifdef ACPI_DEBUG 414 void acpi_debug_init(void); 415 #endif 416 417 bus_dma_tag_t acpi_get_dma_tag(struct acpi_softc *, struct acpi_devnode *); 418 bus_dma_tag_t acpi_get_dma64_tag(struct acpi_softc *, struct acpi_devnode *); 419 pci_chipset_tag_t acpi_get_pci_chipset_tag(struct acpi_softc *, int, int); 420 421 /* 422 * Misc routines with vectors updated by acpiverbose module. 423 */ 424 extern void (*acpi_print_verbose)(struct acpi_softc *); 425 extern void (*acpi_print_dev)(const char *); 426 427 void acpi_load_verbose(void); 428 extern int acpi_verbose_loaded; 429 430 #endif /* !_SYS_DEV_ACPI_ACPIVAR_H */ 431
Indexes created Sun Sep 28 16:09:52 GMT 2025