Skip to content

Commit

Permalink
Comment update: spelling/format. No functional change
Browse files Browse the repository at this point in the history 
Fix some spelling errors and reformat some long lines
With assistance from
Cao jin <caoj.fnst@cn.fujitsu.com>
  • Loading branch information
@acpibob
acpibob committed Apr 20, 2017
1 parent 0f9aaa3 commit d9861da
Showing 1 changed file with 34 additions and 30 deletions.
64 changes: 34 additions & 30 deletions source/include/actypes.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -155,9 +155,9 @@
/* acpisrc:StructDefs -- for acpisrc conversion */

/*
* ACPI_MACHINE_WIDTH must be specified in an OS- or compiler-dependent header
* and must be either 32 or 64. 16-bit ACPICA is no longer supported, as of
* 12/2006.
* ACPI_MACHINE_WIDTH must be specified in an OS- or compiler-dependent
* header and must be either 32 or 64. 16-bit ACPICA is no longer
* supported, as of 12/2006.
*/
#ifndef ACPI_MACHINE_WIDTH
#error ACPI_MACHINE_WIDTH not defined
Expand Down Expand Up @@ -196,9 +196,9 @@
* INT64 64-bit (8 byte) signed value
*
* COMPILER_DEPENDENT_UINT64/INT64 - These types are defined in the
* compiler-dependent header(s) and were introduced because there is no common
* 64-bit integer type across the various compilation models, as shown in
* the table below.
* compiler-dependent header(s) and were introduced because there is no
* common 64-bit integer type across the various compilation models, as
* shown in the table below.
*
* Datatype LP64 ILP64 LLP64 ILP32 LP32 16bit
* char 8 8 8 8 8 8
Expand All @@ -215,10 +215,10 @@
* 2) These types represent the native word size of the target mode of the
* processor, and may be 16-bit, 32-bit, or 64-bit as required. They are
* usually used for memory allocation, efficient loop counters, and array
* indexes. The types are similar to the size_t type in the C library and are
* required because there is no C type that consistently represents the native
* data width. ACPI_SIZE is needed because there is no guarantee that a
* kernel-level C library is present.
* indexes. The types are similar to the size_t type in the C library and
* are required because there is no C type that consistently represents the
* native data width. ACPI_SIZE is needed because there is no guarantee
* that a kernel-level C library is present.
*
* ACPI_SIZE 16/32/64-bit unsigned value
* ACPI_NATIVE_INT 16/32/64-bit signed value
Expand Down Expand Up @@ -279,9 +279,10 @@ typedef UINT64 ACPI_PHYSICAL_ADDRESS;

/*
* In the case of the Itanium Processor Family (IPF), the hardware does not
* support misaligned memory transfers. Set the MISALIGNMENT_NOT_SUPPORTED flag
* to indicate that special precautions must be taken to avoid alignment faults.
* (IA64 or ia64 is currently used by existing compilers to indicate IPF.)
* support misaligned memory transfers. Set the MISALIGNMENT_NOT_SUPPORTED
* flag to indicate that special precautions must be taken to avoid alignment
* faults. (IA64 or ia64 is currently used by existing compilers to indicate
* IPF.)
*
* Note: EM64T and other X86-64 processors support misaligned transfers,
* so there is no need to define this flag.
Expand Down Expand Up @@ -422,8 +423,8 @@ typedef UINT64 ACPI_PHYSICAL_ADDRESS;
#endif

/*
* Some compilers complain about unused variables. Sometimes we don't want to
* use all the variables (for example, _AcpiModuleName). This allows us
* Some compilers complain about unused variables. Sometimes we don't want
* to use all the variables (for example, _AcpiModuleName). This allows us
* to tell the compiler in a per-variable manner that a variable
* is unused
*/
Expand All @@ -432,8 +433,9 @@ typedef UINT64 ACPI_PHYSICAL_ADDRESS;
#endif

/*
* All ACPICA external functions that are available to the rest of the kernel
* are tagged with thes macros which can be defined as appropriate for the host.
* All ACPICA external functions that are available to the rest of the
* kernel are tagged with these macros which can be defined as appropriate
* for the host.
*
* Notes:
* ACPI_EXPORT_SYMBOL_INIT is used for initialization and termination
Expand Down Expand Up @@ -498,7 +500,8 @@ typedef UINT64 ACPI_PHYSICAL_ADDRESS;

/******************************************************************************
*
* ACPI Specification constants (Do not change unless the specification changes)
* ACPI Specification constants (Do not change unless the specification
* changes)
*
*****************************************************************************/

Expand Down Expand Up @@ -604,10 +607,10 @@ typedef UINT8 ACPI_OWNER_ID;
#define ACPI_DO_NOT_WAIT 0

/*
* Obsolete: Acpi integer width. In ACPI version 1 (1996), integers are 32 bits.
* In ACPI version 2 (2000) and later, integers are 64 bits. Note that this
* pertains to the ACPI integer type only, not to other integers used in the
* implementation of the ACPICA subsystem.
* Obsolete: Acpi integer width. In ACPI version 1 (1996), integers are
* 32 bits. In ACPI version 2 (2000) and later, integers are max 64 bits.
* Note that this pertains to the ACPI integer type only, not to other
* integers used in the implementation of the ACPICA subsystem.
*
* 01/2010: This type is obsolete and has been removed from the entire ACPICA
* code base. It remains here for compatibility with device drivers that use
Expand Down Expand Up @@ -788,10 +791,11 @@ typedef UINT32 ACPI_OBJECT_TYPE;

/*
* These are object types that do not map directly to the ACPI
* ObjectType() operator. They are used for various internal purposes only.
* If new predefined ACPI_TYPEs are added (via the ACPI specification), these
* internal types must move upwards. (There is code that depends on these
* values being contiguous with the external types above.)
* ObjectType() operator. They are used for various internal purposes
* only. If new predefined ACPI_TYPEs are added (via the ACPI
* specification), these internal types must move upwards. (There
* is code that depends on these values being contiguous with the
* external types above.)
*/
#define ACPI_TYPE_LOCAL_REGION_FIELD 0x11
#define ACPI_TYPE_LOCAL_BANK_FIELD 0x12
Expand Down Expand Up @@ -892,7 +896,7 @@ typedef UINT32 ACPI_EVENT_STATUS;
* | | | | +-- Type of dispatch:to method, handler, notify, or none
* | | | +----- Interrupt type: edge or level triggered
* | | +------- Is a Wake GPE
* | +--------- Is GPE masked by the software GPE masking machanism
* | +--------- Is GPE masked by the software GPE masking mechanism
* +------------ <Reserved>
*/
#define ACPI_GPE_DISPATCH_NONE (UINT8) 0x00
Expand Down Expand Up @@ -1038,8 +1042,8 @@ typedef struct acpi_sleep_functions
*/

/*
* Note: Type == ACPI_TYPE_ANY (0) is used to indicate a NULL package element
* or an unresolved named reference.
* Note: Type == ACPI_TYPE_ANY (0) is used to indicate a NULL package
* element or an unresolved named reference.
*/
typedef union acpi_object
{
Expand Down Expand Up @@ -1362,7 +1366,7 @@ typedef struct acpi_pnp_device_id_list

/*
* Structure returned from AcpiGetObjectInfo.
* Optimized for both 32- and 64-bit builds
* Optimized for both 32-bit and 64-bit builds.
*/
typedef struct acpi_device_info
{
Expand Down

0 comments on commit d9861da

Please sign in to comment.