ACPICA: Update comments in module header

Enhance the explanations of the various package return types
for clarity.

Signed-off-by: Bob Moore <robert.moore@intel.com>
Signed-off-by: Lin Ming <ming.m.lin@intel.com>
Signed-off-by: Len Brown <len.brown@intel.com>
This commit is contained in:
Bob Moore 2009-02-18 14:07:58 +08:00 committed by Len Brown
parent 5e053e77f2
commit d3319d1717

View file

@ -52,41 +52,44 @@
* 1) PTYPE1 packages do not contain sub-packages. * 1) PTYPE1 packages do not contain sub-packages.
* *
* ACPI_PTYPE1_FIXED: Fixed length, 1 or 2 object types: * ACPI_PTYPE1_FIXED: Fixed length, 1 or 2 object types:
* object type * object type
* count * count
* object type * object type
* count * count
* *
* ACPI_PTYPE1_VAR: Variable length: * ACPI_PTYPE1_VAR: Variable length:
* object type (Int/Buf/Ref) * object type (Int/Buf/Ref)
* *
* ACPI_PTYPE1_OPTION: Package has some required and some optional elements: * ACPI_PTYPE1_OPTION: Package has some required and some optional elements
* Used for _PRW * (Used for _PRW)
* *
* *
* 2) PTYPE2 packages contain a variable number of sub-packages. Each of the * 2) PTYPE2 packages contain a variable number of sub-packages. Each of the
* different types describe the contents of each of the sub-packages. * different types describe the contents of each of the sub-packages.
* *
* ACPI_PTYPE2: Each subpackage contains 1 or 2 object types: * ACPI_PTYPE2: Each subpackage contains 1 or 2 object types:
* object type * object type
* count * count
* object type * object type
* count * count
* (Used for _ALR,_MLS,_PSS,_TRT,_TSS)
* *
* ACPI_PTYPE2_COUNT: Each subpackage has a count as first element: * ACPI_PTYPE2_COUNT: Each subpackage has a count as first element:
* object type * object type
* (Used for _CSD,_PSD,_TSD)
* *
* ACPI_PTYPE2_PKG_COUNT: Count of subpackages at start, 1 or 2 object types: * ACPI_PTYPE2_PKG_COUNT: Count of subpackages at start, 1 or 2 object types:
* object type * object type
* count * count
* object type * object type
* count * count
* (Used for _CST)
* *
* ACPI_PTYPE2_FIXED: Each subpackage is of fixed length: * ACPI_PTYPE2_FIXED: Each subpackage is of fixed length
* Used for _PRT * (Used for _PRT)
* *
* ACPI_PTYPE2_MIN: Each subpackage has a variable but minimum length * ACPI_PTYPE2_MIN: Each subpackage has a variable but minimum length
* Used for _HPX * (Used for _HPX)
* *
*****************************************************************************/ *****************************************************************************/