NetBSD-5.0.2/sys/dev/acpi/acpivar.h
/* $NetBSD: acpivar.h,v 1.33.4.1 2008/11/25 18:22:37 snj Exp $ */
/*
* Copyright 2001 Wasabi Systems, Inc.
* All rights reserved.
*
* Written by Jason R. Thorpe for Wasabi Systems, Inc.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. All advertising materials mentioning features or use of this software
* must display the following acknowledgement:
* This product includes software developed for the NetBSD Project by
* Wasabi Systems, Inc.
* 4. The name of Wasabi Systems, Inc. may not be used to endorse
* or promote products derived from this software without specific prior
* written permission.
*
* THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WASABI SYSTEMS, INC
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
/*
* This file defines the ACPI interface provided to the rest of the
* kernel, as well as the autoconfiguration structures for ACPI
* support.
*/
#include <sys/bus.h>
#include <dev/pci/pcivar.h>
#include <dev/isa/isavar.h>
#include <dev/acpi/acpica.h>
#include <dev/sysmon/sysmonvar.h>
/*
* acpibus_attach_args:
*
* This structure is used to attach the ACPI "bus".
*/
struct acpibus_attach_args {
bus_space_tag_t aa_iot; /* PCI I/O space tag */
bus_space_tag_t aa_memt; /* PCI MEM space tag */
pci_chipset_tag_t aa_pc; /* PCI chipset */
int aa_pciflags; /* PCI bus flags */
isa_chipset_tag_t aa_ic; /* ISA chipset */
};
/*
* Types of switches that ACPI understands.
*/
#define ACPI_SWITCH_POWERBUTTON 0
#define ACPI_SWITCH_SLEEPBUTTON 1
#define ACPI_SWITCH_LID 2
#define ACPI_NSWITCHES 3
/*
* acpi_devnode:
*
* An ACPI device node.
*/
struct acpi_devnode {
TAILQ_ENTRY(acpi_devnode) ad_list;
ACPI_HANDLE ad_handle; /* our ACPI handle */
u_int32_t ad_level; /* ACPI level */
u_int32_t ad_type; /* ACPI object type */
ACPI_DEVICE_INFO *ad_devinfo; /* our ACPI device info */
struct acpi_scope *ad_scope; /* backpointer to scope */
struct device *ad_device; /* pointer to configured device */
char ad_name[5]; /* Human-readable device name */
};
/*
* acpi_scope:
*
* Description of an ACPI scope.
*/
struct acpi_scope {
TAILQ_ENTRY(acpi_scope) as_list;
const char *as_name; /* scope name */
/*
* Device nodes we manage.
*/
TAILQ_HEAD(, acpi_devnode) as_devnodes;
};
/*
* acpi_softc:
*
* Software state of the ACPI subsystem.
*/
struct acpi_softc {
device_t sc_dev; /* base device info */
bus_space_tag_t sc_iot; /* PCI I/O space tag */
bus_space_tag_t sc_memt; /* PCI MEM space tag */
pci_chipset_tag_t sc_pc; /* PCI chipset tag */
int sc_pciflags; /* PCI bus flags */
int sc_pci_bus; /* internal PCI fixup */
isa_chipset_tag_t sc_ic; /* ISA chipset tag */
void *sc_sdhook; /* shutdown hook */
/*
* Power switch handlers for fixed-feature buttons.
*/
struct sysmon_pswitch sc_smpsw_power;
struct sysmon_pswitch sc_smpsw_sleep;
/*
* Sleep state to transition to when a given
* switch is activated.
*/
int sc_switch_sleep[ACPI_NSWITCHES];
int sc_sleepstate; /* current sleep state */
int sc_quirks;
/*
* Scopes we manage.
*/
TAILQ_HEAD(, acpi_scope) sc_scopes;
};
/*
* acpi_attach_args:
*
* Used to attach a device instance to the acpi "bus".
*/
struct acpi_attach_args {
struct acpi_devnode *aa_node; /* ACPI device node */
bus_space_tag_t aa_iot; /* PCI I/O space tag */
bus_space_tag_t aa_memt; /* PCI MEM space tag */
pci_chipset_tag_t aa_pc; /* PCI chipset tag */
int aa_pciflags; /* PCI bus flags */
isa_chipset_tag_t aa_ic; /* ISA chipset */
};
/*
* ACPI resources:
*
* acpi_io I/O ports
* acpi_iorange I/O port range
* acpi_mem memory region
* acpi_memrange memory range
* acpi_irq Interrupt Request
* acpi_drq DMA request
*/
struct acpi_io {
SIMPLEQ_ENTRY(acpi_io) ar_list;
int ar_index;
uint32_t ar_base;
uint32_t ar_length;
};
struct acpi_iorange {
SIMPLEQ_ENTRY(acpi_iorange) ar_list;
int ar_index;
uint32_t ar_low;
uint32_t ar_high;
uint32_t ar_length;
uint32_t ar_align;
};
struct acpi_mem {
SIMPLEQ_ENTRY(acpi_mem) ar_list;
int ar_index;
uint32_t ar_base;
uint32_t ar_length;
};
struct acpi_memrange {
SIMPLEQ_ENTRY(acpi_memrange) ar_list;
int ar_index;
uint32_t ar_low;
uint32_t ar_high;
uint32_t ar_length;
uint32_t ar_align;
};
struct acpi_irq {
SIMPLEQ_ENTRY(acpi_irq) ar_list;
int ar_index;
uint32_t ar_irq;
uint32_t ar_type;
};
struct acpi_drq {
SIMPLEQ_ENTRY(acpi_drq) ar_list;
int ar_index;
uint32_t ar_drq;
};
struct acpi_resources {
SIMPLEQ_HEAD(, acpi_io) ar_io;
int ar_nio;
SIMPLEQ_HEAD(, acpi_iorange) ar_iorange;
int ar_niorange;
SIMPLEQ_HEAD(, acpi_mem) ar_mem;
int ar_nmem;
SIMPLEQ_HEAD(, acpi_memrange) ar_memrange;
int ar_nmemrange;
SIMPLEQ_HEAD(, acpi_irq) ar_irq;
int ar_nirq;
SIMPLEQ_HEAD(, acpi_drq) ar_drq;
int ar_ndrq;
};
/*
* acpi_resource_parse_ops:
*
* The client of ACPI resources specifies these operations
* when the resources are parsed.
*/
struct acpi_resource_parse_ops {
void (*init)(struct device *, void *, void **);
void (*fini)(struct device *, void *);
void (*ioport)(struct device *, void *, uint32_t, uint32_t);
void (*iorange)(struct device *, void *, uint32_t, uint32_t,
uint32_t, uint32_t);
void (*memory)(struct device *, void *, uint32_t, uint32_t);
void (*memrange)(struct device *, void *, uint32_t, uint32_t,
uint32_t, uint32_t);
void (*irq)(struct device *, void *, uint32_t, uint32_t);
void (*drq)(struct device *, void *, uint32_t);
void (*start_dep)(struct device *, void *, int);
void (*end_dep)(struct device *, void *);
};
extern struct acpi_softc *acpi_softc;
extern int acpi_active;
extern const struct acpi_resource_parse_ops acpi_resource_parse_ops_default;
int acpi_check(device_t, const char *);
int acpi_probe(void);
ACPI_PHYSICAL_ADDRESS acpi_OsGetRootPointer(void);
int acpi_match_hid(ACPI_DEVICE_INFO *, const char * const *);
void acpi_set_wake_gpe(ACPI_HANDLE);
void acpi_clear_wake_gpe(ACPI_HANDLE);
ACPI_STATUS acpi_eval_integer(ACPI_HANDLE, const char *, ACPI_INTEGER *);
ACPI_STATUS acpi_eval_string(ACPI_HANDLE, const char *, char **);
ACPI_STATUS acpi_eval_struct(ACPI_HANDLE, const char *, ACPI_BUFFER *);
ACPI_STATUS acpi_foreach_package_object(ACPI_OBJECT *,
ACPI_STATUS (*)(ACPI_OBJECT *, void *), void *);
ACPI_STATUS acpi_get(ACPI_HANDLE, ACPI_BUFFER *,
ACPI_STATUS (*)(ACPI_HANDLE, ACPI_BUFFER *));
const char* acpi_name(ACPI_HANDLE);
ACPI_STATUS acpi_resource_parse(struct device *, ACPI_HANDLE, const char *,
void *, const struct acpi_resource_parse_ops *);
void acpi_resource_print(struct device *, struct acpi_resources *);
void acpi_resource_cleanup(struct acpi_resources *);
ACPI_STATUS acpi_allocate_resources(ACPI_HANDLE);
ACPI_STATUS acpi_pwr_switch_consumer(ACPI_HANDLE, int);
void * acpi_pci_link_devbyhandle(ACPI_HANDLE);
void acpi_pci_link_add_reference(void *, int, int, int, int);
int acpi_pci_link_route_interrupt(void *, int, int *, int *, int *);
char * acpi_pci_link_name(void *);
ACPI_HANDLE acpi_pci_link_handle(void *);
void acpi_pci_link_state(void);
void acpi_pci_link_resume(void);
struct acpi_io *acpi_res_io(struct acpi_resources *, int);
struct acpi_iorange *acpi_res_iorange(struct acpi_resources *, int);
struct acpi_mem *acpi_res_mem(struct acpi_resources *, int);
struct acpi_memrange *acpi_res_memrange(struct acpi_resources *, int);
struct acpi_irq *acpi_res_irq(struct acpi_resources *, int);
struct acpi_drq *acpi_res_drq(struct acpi_resources *, int);
/*
* power state transition
*/
ACPI_STATUS acpi_enter_sleep_state(struct acpi_softc *, int);
/*
* quirk handling
*/
struct acpi_quirk {
const char *aq_tabletype; /* what type of table (FADT, DSDT, etc) */
const char *aq_oemid; /* compared against the table OemId */
int aq_oemrev; /* compared against the table OemRev */
int aq_cmpop; /* how to compare the oemrev number */
const char *aq_tabid; /* compared against the table TableId */
int aq_quirks; /* the actual quirks */
};
#define AQ_GT 0 /* > */
#define AQ_LT 1 /* < */
#define AQ_GTE 2 /* >= */
#define AQ_LTE 3 /* <= */
#define AQ_EQ 4 /* == */
#define ACPI_QUIRK_BROKEN 0x00000001 /* totally broken */
#define ACPI_QUIRK_BADPCI 0x00000002 /* bad PCI hierarchy */
#define ACPI_QUIRK_BADBBN 0x00000004 /* _BBN broken */
#define ACPI_QUIRK_IRQ0 0x00000008 /* bad 0->2 irq override */
int acpi_find_quirks(void);