ACPICA: Fix some comment fields

No functional change. Fixes some typos and linux divergences.

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 2012-07-16 09:52:27 +08:00 committed by Len Brown
parent 3b3ea7759c
commit cf48958e84
9 changed files with 19 additions and 18 deletions

View file

@ -283,8 +283,8 @@
#define ACPI_INSERT_BITS(target, mask, source) target = ((target & (~(mask))) | (source & mask)) #define ACPI_INSERT_BITS(target, mask, source) target = ((target & (~(mask))) | (source & mask))
/* /*
* A struct acpi_namespace_node can appear in some contexts * An object of type struct acpi_namespace_node can appear in some contexts
* where a pointer to a union acpi_operand_object can also * where a pointer to an object of type union acpi_operand_object can also
* appear. This macro is used to distinguish them. * appear. This macro is used to distinguish them.
* *
* The "Descriptor" field is the first field in both structures. * The "Descriptor" field is the first field in both structures.

View file

@ -113,8 +113,8 @@ struct acpi_object_integer {
}; };
/* /*
* Note: The String and Buffer object must be identical through the Pointer * Note: The String and Buffer object must be identical through the
* and length elements. There is code that depends on this. * pointer and length elements. There is code that depends on this.
* *
* Fields common to both Strings and Buffers * Fields common to both Strings and Buffers
*/ */

View file

@ -395,8 +395,8 @@ acpi_ex_prep_common_field_object(union acpi_operand_object *obj_desc,
* *
* RETURN: Status * RETURN: Status
* *
* DESCRIPTION: Construct a union acpi_operand_object of type def_field and * DESCRIPTION: Construct an object of type union acpi_operand_object with a
* connect it to the parent Node. * subtype of def_field and connect it to the parent Node.
* *
******************************************************************************/ ******************************************************************************/

View file

@ -147,7 +147,7 @@ acpi_ex_resolve_object_to_value(union acpi_operand_object **stack_ptr,
stack_desc = *stack_ptr; stack_desc = *stack_ptr;
/* This is a union acpi_operand_object */ /* This is an object of type union acpi_operand_object */
switch (stack_desc->common.type) { switch (stack_desc->common.type) {
case ACPI_TYPE_LOCAL_REFERENCE: case ACPI_TYPE_LOCAL_REFERENCE:

View file

@ -62,8 +62,8 @@ acpi_ex_store_object_to_index(union acpi_operand_object *val_desc,
* FUNCTION: acpi_ex_store * FUNCTION: acpi_ex_store
* *
* PARAMETERS: *source_desc - Value to be stored * PARAMETERS: *source_desc - Value to be stored
* *dest_desc - Where to store it. Must be an NS node * *dest_desc - Where to store it. Must be an NS node
* or a union acpi_operand_object of type * or union acpi_operand_object of type
* Reference; * Reference;
* walk_state - Current walk state * walk_state - Current walk state
* *

View file

@ -109,7 +109,7 @@ void acpi_ex_enter_interpreter(void)
* *
* DESCRIPTION: Reacquire the interpreter execution region from within the * DESCRIPTION: Reacquire the interpreter execution region from within the
* interpreter code. Failure to enter the interpreter region is a * interpreter code. Failure to enter the interpreter region is a
* fatal system error. Used in conjunction with * fatal system error. Used in conjunction with
* relinquish_interpreter * relinquish_interpreter
* *
******************************************************************************/ ******************************************************************************/

View file

@ -190,8 +190,8 @@ acpi_rs_create_resource_list(union acpi_operand_object *aml_buffer,
* *
* FUNCTION: acpi_rs_create_pci_routing_table * FUNCTION: acpi_rs_create_pci_routing_table
* *
* PARAMETERS: package_object - Pointer to a union acpi_operand_object * PARAMETERS: package_object - Pointer to a package containing one
* package * of more ACPI_OPERAND_OBJECTs
* output_buffer - Pointer to the user's buffer * output_buffer - Pointer to the user's buffer
* *
* RETURN: Status AE_OK if okay, else a valid acpi_status code. * RETURN: Status AE_OK if okay, else a valid acpi_status code.
@ -199,7 +199,7 @@ acpi_rs_create_resource_list(union acpi_operand_object *aml_buffer,
* AE_BUFFER_OVERFLOW and output_buffer->Length will point * AE_BUFFER_OVERFLOW and output_buffer->Length will point
* to the size buffer needed. * to the size buffer needed.
* *
* DESCRIPTION: Takes the union acpi_operand_object package and creates a * DESCRIPTION: Takes the union acpi_operand_object package and creates a
* linked list of PCI interrupt descriptions * linked list of PCI interrupt descriptions
* *
* NOTE: It is the caller's responsibility to ensure that the start of the * NOTE: It is the caller's responsibility to ensure that the start of the

View file

@ -247,8 +247,9 @@ struct acpi_fixed_event_info acpi_gbl_fixed_event_info[ACPI_NUM_FIXED_EVENTS] =
* *
* RETURN: Status * RETURN: Status
* *
* DESCRIPTION: Init library globals. All globals that require specific * DESCRIPTION: Initialize ACPICA globals. All globals that require specific
* initialization should be initialized here! * initialization should be initialized here. This allows for
* a warm restart.
* *
******************************************************************************/ ******************************************************************************/

View file

@ -327,7 +327,7 @@ union acpi_operand_object *acpi_ut_create_string_object(acpi_size string_size)
* *
* RETURN: TRUE if object is valid, FALSE otherwise * RETURN: TRUE if object is valid, FALSE otherwise
* *
* DESCRIPTION: Validate a pointer to be a union acpi_operand_object * DESCRIPTION: Validate a pointer to be of type union acpi_operand_object
* *
******************************************************************************/ ******************************************************************************/
@ -348,7 +348,7 @@ u8 acpi_ut_valid_internal_object(void *object)
switch (ACPI_GET_DESCRIPTOR_TYPE(object)) { switch (ACPI_GET_DESCRIPTOR_TYPE(object)) {
case ACPI_DESC_TYPE_OPERAND: case ACPI_DESC_TYPE_OPERAND:
/* The object appears to be a valid union acpi_operand_object */ /* The object appears to be a valid union acpi_operand_object */
return (TRUE); return (TRUE);
@ -419,7 +419,7 @@ void acpi_ut_delete_object_desc(union acpi_operand_object *object)
{ {
ACPI_FUNCTION_TRACE_PTR(ut_delete_object_desc, object); ACPI_FUNCTION_TRACE_PTR(ut_delete_object_desc, object);
/* Object must be a union acpi_operand_object */ /* Object must be a union acpi_operand_object */
if (ACPI_GET_DESCRIPTOR_TYPE(object) != ACPI_DESC_TYPE_OPERAND) { if (ACPI_GET_DESCRIPTOR_TYPE(object) != ACPI_DESC_TYPE_OPERAND) {
ACPI_ERROR((AE_INFO, ACPI_ERROR((AE_INFO,