Sync usage with man page.
[netbsd-mini2440.git] / sys / dev / acpi / acpica / README
blob74228ab6e1420ba00ceb5b44959dee66821f2c43
1 #       $NetBSD: README,v 1.2 2001/09/28 01:24:44 thorpej Exp $
3 This is the Intel ACPI Component Architecture, Intel's reference
4 implementation of the core operating system ACPI support.  The
5 portion in the Osd/ subdirectory is provided by the oprerating
6 system as the glue between the OS and the ACPICA.
8 Please, do not import an updated ACPI CA snapshot from Intel unless
9 you absolutely know what you're doing -- The Intel directory layout
10 changes from release to release, and we must munge it (by hand) into
11 something sane that we can use.
13 The routines that the operating system must provide are documented
14 in the following document:
16         ACPI Component Architecture Programmer Reference
17         Intel Corp.
19 Copies of the document may be retrieved from:
21         http://developer.intel.com/technology/iapc/acpi/downloads.htm
23 Machine-dependent code must provide the following routines for Osd:
25 ACPI_STATUS     acpi_md_OsInitialize(void);
26 ACPI_STATUS     acpi_md_OsTerminate(void);
27 ACPI_STATUS     acpi_md_OsGetRootPointer(UINT32 Flags,
28                     ACPI_PHYSICAL_ADDRESS *PhysicalAddress);
30 UINT8           acpi_md_OsIn8(ACPI_IO_ADDRESS InPort);
31 UINT16          acpi_md_OsIn16(ACPI_IO_ADDRESS InPort);
32 UINT32          acpi_md_OsIn32(ACPI_IO_ADDRESS InPort);
34 void            acpi_md_OsOut8(ACPI_IO_ADDRESS OutPort, UINT8 Value);
35 void            acpi_md_OsOut16(ACPI_IO_ADDRESS OutPort, UINT16 Value);
36 void            acpi_md_OsOut32(ACPI_IO_ADDRESS OutPort, UINT32 Value);
38 ACPI_STATUS     acpi_md_OsInstallInterruptHandler(UINT32 InterruptNumber,
39                     OSD_HANDLER ServiceRoutine, void *Context, void **cookiep);
40 void            acpi_md_OsRemoveInterruptHandler(void *cookie);
42 ACPI_STATUS     acpi_md_OsMapMemory(ACPI_PHYSICAL_ADDRESS PhysicalAddress,
43                     UINT32 Length, void **LogicalAddress);
44 void            acpi_md_OsUnmapMemory(void *LogicalAddress, UINT32 Length);
45 ACPI_STATUS     acpi_md_OsGetPhysicalAddress(void *LogicalAddress,
46                     ACPI_PHYSICAL_ADDRESS *PhysicalAddress);
48 BOOLEAN         acpi_md_OsReadable(void *Pointer, UINT32 Length);
49 BOOLEAN         acpi_md_OsWritable(void *Pointer, UINT32 Length);
51         -- Jason R. Thorpe <thorpej@wasabisystems.com>