acutils.h revision 571909175b4f9a1ef15ec4afead6d6d463dbe760
/******************************************************************************
*
* Name: acutils.h -- prototypes for the common (subsystem-wide) procedures
*
*****************************************************************************/
/******************************************************************************
*
* 1. Copyright Notice
*
* Some or all of this work - Copyright (c) 1999 - 2009, Intel Corp.
* All rights reserved.
*
* 2. License
*
* 2.1. This is your license from Intel Corp. under its intellectual property
* rights. You may have additional license terms from the party that provided
* you this software, covering your right to use that party's intellectual
* property rights.
*
* 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
* copy of the source code appearing in this file ("Covered Code") an
* irrevocable, perpetual, worldwide license under Intel's copyrights in the
* base code distributed originally by Intel ("Original Intel Code") to copy,
* make derivatives, distribute, use and display any portion of the Covered
* Code in any form, with the right to sublicense such rights; and
*
* 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
* license (with the right to sublicense), under only those claims of Intel
* patents that are infringed by the Original Intel Code, to make, use, sell,
* offer to sell, and import the Covered Code and derivative works thereof
* solely to the minimum extent necessary to exercise the above copyright
* license, and in no event shall the patent license extend to any additions
* to or modifications of the Original Intel Code. No other license or right
* is granted directly or by implication, estoppel or otherwise;
*
* The above copyright and patent license is granted only if the following
* conditions are met:
*
* 3. Conditions
*
* 3.1. Redistribution of Source with Rights to Further Distribute Source.
* Redistribution of source code of any substantial portion of the Covered
* Code or modification with rights to further distribute source must include
* the above Copyright Notice, the above License, this list of Conditions,
* and the following Disclaimer and Export Compliance provision. In addition,
* Licensee must cause all Covered Code to which Licensee contributes to
* contain a file documenting the changes Licensee made to create that Covered
* Code and the date of any change. Licensee must include in that file the
* documentation of any changes made by any predecessor Licensee. Licensee
* must include a prominent statement that the modification is derived,
* directly or indirectly, from Original Intel Code.
*
* 3.2. Redistribution of Source with no Rights to Further Distribute Source.
* Redistribution of source code of any substantial portion of the Covered
* Code or modification without rights to further distribute source must
* include the following Disclaimer and Export Compliance provision in the
* addition, Licensee may not authorize further sublicense of source of any
* portion of the Covered Code, and must include terms to the effect that the
* license from Licensee to its licensee is limited to the intellectual
* property embodied in the software Licensee provides to its licensee, and
* not to intellectual property embodied in modifications its licensee may
* make.
*
* 3.3. Redistribution of Executable. Redistribution in executable form of any
* substantial portion of the Covered Code or modification must reproduce the
* above Copyright Notice, and the following Disclaimer and Export Compliance
* distribution.
*
* 3.4. Intel retains all right, title, and interest in and to the Original
* Intel Code.
*
* 3.5. Neither the name Intel nor any other trademark owned or controlled by
* Intel shall be used in advertising or otherwise to promote the sale, use or
* other dealings in products derived from or relating to the Covered Code
* without prior written authorization from Intel.
*
* 4. Disclaimer and Export Compliance
*
* 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
* HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
* IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
* INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
* UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
* IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
* PARTICULAR PURPOSE.
*
* 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
* OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
* COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
* SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
* CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
* HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
* SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
* LIMITED REMEDY.
*
* 4.3. Licensee shall not export, either directly or indirectly, any of this
* software or system incorporating such software without first obtaining any
* required license or other approval from the U. S. Department of Commerce or
* any other agency or department of the United States Government. In the
* event Licensee exports any such software from the United States or
* re-exports any such software from a foreign destination, Licensee shall
* compliance with all laws, regulations, orders, or other restrictions of the
* U.S. Export Administration Regulations. Licensee agrees that neither it nor
* software, or service, directly or indirectly, to any country for which the
* United States government or any agency thereof requires an export license,
* other governmental approval, or letter of assurance, without first obtaining
* such license, approval or letter.
*
*****************************************************************************/
#ifndef _ACUTILS_H
#define _ACUTILS_H
extern const UINT8 AcpiGbl_ResourceAmlSizes[];
/* Strings used by the disassembler and debugger resource dump routines */
#if defined(ACPI_DISASSEMBLER) || defined (ACPI_DEBUGGER)
extern const char *AcpiGbl_BmDecode[];
extern const char *AcpiGbl_ConfigDecode[];
extern const char *AcpiGbl_ConsumeDecode[];
extern const char *AcpiGbl_DecDecode[];
extern const char *AcpiGbl_HeDecode[];
extern const char *AcpiGbl_IoDecode[];
extern const char *AcpiGbl_LlDecode[];
extern const char *AcpiGbl_MaxDecode[];
extern const char *AcpiGbl_MemDecode[];
extern const char *AcpiGbl_MinDecode[];
extern const char *AcpiGbl_MtpDecode[];
extern const char *AcpiGbl_RngDecode[];
extern const char *AcpiGbl_RwDecode[];
extern const char *AcpiGbl_ShrDecode[];
extern const char *AcpiGbl_SizDecode[];
extern const char *AcpiGbl_TrsDecode[];
extern const char *AcpiGbl_TtpDecode[];
extern const char *AcpiGbl_TypDecode[];
#endif
/* Types for Resource descriptor entries */
#define ACPI_INVALID_RESOURCE 0
#define ACPI_FIXED_LENGTH 1
#define ACPI_VARIABLE_LENGTH 2
#define ACPI_SMALL_VARIABLE_LENGTH 3
typedef
void *Context);
typedef
void *Context);
typedef struct acpi_pkg_info
{
#define REF_INCREMENT (UINT16) 0
/* AcpiUtDumpBuffer */
#define DB_BYTE_DISPLAY 1
#define DB_WORD_DISPLAY 2
#define DB_DWORD_DISPLAY 4
#define DB_QWORD_DISPLAY 8
/*
* utglobal - Global data structures and procedures
*/
void);
#if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
char *
const char *
#endif
char *
char *
void *Object);
char *
void *Object);
const char *
char *
char *
char *
char
/*
* utinit - miscellaneous initialization and shutdown
*/
void);
void
void);
/*
* utclib - Local implementations of C library functions
*/
#ifndef ACPI_USE_SYSTEM_CLIBRARY
const char *String);
char *
char *DstString,
const char *SrcString);
char *
char *DstString,
const char *SrcString,
int
const char *Buffer1,
const char *Buffer2,
int
const char *String1,
const char *String2,
int
const char *String1,
const char *String2);
char *
char *DstString,
const char *SrcString);
char *
char *DstString,
const char *SrcString,
const char *String,
char **Terminator,
char *
char *String1,
char *String2);
void *
void *Dest,
const void *Src,
void *
void *Dest,
int
int c);
int
int c);
extern const UINT8 _acpi_ctype[];
#define ACPI_IS_PRINT(c) (_acpi_ctype[(unsigned char)(c)] & (_ACPI_LO | _ACPI_UP | _ACPI_DI | _ACPI_SP | _ACPI_PU))
#endif /* !ACPI_USE_SYSTEM_CLIBRARY */
#define ACPI_IS_ASCII(c) ((c) < 0x80)
/*
* utcopy - Object construction and conversion interfaces
*/
/*
* utcreate - Object creation
*/
/*
* utdebug - Debug interfaces
*/
void
void);
void
void);
void
const char *FunctionName,
const char *ModuleName,
void
const char *FunctionName,
const char *ModuleName,
void *Pointer);
void
const char *FunctionName,
const char *ModuleName,
void
const char *FunctionName,
const char *ModuleName,
char *String);
void
const char *FunctionName,
const char *ModuleName,
void
const char *FunctionName,
const char *ModuleName,
void
const char *FunctionName,
const char *ModuleName,
void
const char *FunctionName,
const char *ModuleName,
void
void
void
char *ModuleName,
void
char *ModuleName,
void
char *ModuleName,
/*
* utdelete - Object deletion and reference counts
*/
void
void
void
void
void
/*
* uteval - object evaluation
*/
char *Path,
char *ObjectName,
const char **MethodNames,
/*
* utids - device ID support
*/
/*
*/
ACPI_RW_LOCK *Lock);
void
ACPI_RW_LOCK *Lock);
ACPI_RW_LOCK *Lock);
ACPI_RW_LOCK *Lock);
ACPI_RW_LOCK *Lock);
void
ACPI_RW_LOCK *Lock);
/*
*/
const char *ModuleName,
void *
const char *ModuleName,
#define AcpiUtCreateInternalObject(t) AcpiUtCreateInternalObjectDbg (_AcpiModuleName,__LINE__,_COMPONENT,t)
#define AcpiUtAllocateObjectDesc() AcpiUtAllocateObjectDescDbg (_AcpiModuleName,__LINE__,_COMPONENT)
void
void *Object);
/*
*/
void
void);
void);
void *InternalObject,
void *ExternalObject,
void *InternalObject,
void *ExternalObject,
void);
void
/*
* utmath
*/
/*
* utmisc
*/
const char *
char *Id);
void
void *TargetObject,
void *Context);
void
char *SrcString);
void
char *String,
void
char *Name);
char Character,
char *String,
const char *ModuleName,
char *Pathname,
const char *Format,
...);
const char *ModuleName,
char *Pathname,
const char *Format,
...);
/* Values for Base above (16=Hex, 10=Decimal) */
#define ACPI_ANY_BASE 0
void
#ifdef ACPI_DEBUG_OUTPUT
void
char *Path);
#endif
/*
* utresrc
*/
void *Context);
void *Aml,
UINT8 *ReturnIndex);
void *Aml);
void *Aml);
void *Aml);
void *Aml);
/*
* utmutex - mutex support
*/
void);
void
void);
/*
* utalloc - memory allocation and object caching
*/
void);
void);
void *
const char *Module,
void *
const char *Module,
#ifdef ACPI_DBG_TRACK_ALLOCATIONS
void *
const char *Module,
void *
const char *Module,
void
void *Address,
const char *Module,
void
void);
void
const char *Module);
char *ListName,
#endif
#endif /* _ACUTILS_H */