ACPICA: Add support for complex _PLD buffers.

_PLD (Physical Location of Device) returns a bit-packed buffer that
is difficult to parse. This change adds a new interface,
AcpiDecodePldBuffer that parses the buffer into a more usable
local struct. Also adds macros to both get and set individual
fields within the packed _PLD buffer. Adds a new include file,
acbuffer.h - which will be expanded to add structs for other
ACPI names that return buffers. ACPICA BZ 954.

Emit (in comments) the decoded contents of a static _PLD buffer
in order to improve comprehension of this bit-packed buffer.

Add multi-endian support to the _PLD decode routine. Deploy the
multi-endian macros to extract data from the _PLD buffer.

Signed-off-by: Bob Moore <robert.moore@intel.com>
Signed-off-by: Feng Tang <feng.tang@intel.com>
Signed-off-by: Len Brown <len.brown@intel.com>

3 files changed, 126 insertions, 12 deletions

diff --git a/drivers/acpi/acpica/aclocal.h b/drivers/acpi/acpica/aclocal.h
index 493529a3500..c816ee67509 100644
--- a/drivers/acpi/acpica/aclocal.h
+++ b/drivers/acpi/acpica/aclocal.h
@@ -707,15 +707,18 @@ union acpi_parse_value {
         u8                              disasm_opcode;  /* Subtype used for disassembly */\
         char                            aml_op_name[16])        /* Op name (debug only) */
 
-#define ACPI_DASM_BUFFER                0x00
-#define ACPI_DASM_RESOURCE              0x01
-#define ACPI_DASM_STRING                0x02
-#define ACPI_DASM_UNICODE               0x03
-#define ACPI_DASM_EISAID                0x04
-#define ACPI_DASM_MATCHOP               0x05
-#define ACPI_DASM_LNOT_PREFIX           0x06
-#define ACPI_DASM_LNOT_SUFFIX           0x07
-#define ACPI_DASM_IGNORE                0x08
+/* Flags for disasm_flags field above */
+
+#define ACPI_DASM_BUFFER                0x00    /* Buffer is a simple data buffer */
+#define ACPI_DASM_RESOURCE              0x01    /* Buffer is a Resource Descriptor */
+#define ACPI_DASM_STRING                0x02    /* Buffer is a ASCII string */
+#define ACPI_DASM_UNICODE               0x03    /* Buffer is a Unicode string */
+#define ACPI_DASM_PLD_METHOD            0x04    /* Buffer is a _PLD method bit-packed buffer */
+#define ACPI_DASM_EISAID                0x05    /* Integer is an EISAID */
+#define ACPI_DASM_MATCHOP               0x06    /* Parent opcode is a Match() operator */
+#define ACPI_DASM_LNOT_PREFIX           0x07    /* Start of a Lnot_equal (etc.) pair of opcodes */
+#define ACPI_DASM_LNOT_SUFFIX           0x08    /* End  of a Lnot_equal (etc.) pair of opcodes */
+#define ACPI_DASM_IGNORE                0x09    /* Not used at this time */
 
 /*
  * Generic operation (for example:  If, While, Store)
@@ -1025,6 +1028,7 @@ struct acpi_port_info {
  ****************************************************************************/
 
 struct acpi_db_method_info {
+        acpi_handle method;
         acpi_handle main_thread_gate;
         acpi_handle thread_complete_gate;
         acpi_thread_id *threads;
diff --git a/drivers/acpi/acpica/acmacros.h b/drivers/acpi/acpica/acmacros.h
index 832b6198652..a7f68c47f51 100644
--- a/drivers/acpi/acpica/acmacros.h
+++ b/drivers/acpi/acpica/acmacros.h
@@ -277,10 +277,33 @@
 
 /* Bitfields within ACPI registers */
 
-#define ACPI_REGISTER_PREPARE_BITS(val, pos, mask)      ((val << pos) & mask)
-#define ACPI_REGISTER_INSERT_VALUE(reg, pos, mask, val)  reg = (reg & (~(mask))) | ACPI_REGISTER_PREPARE_BITS(val, pos, mask)
+#define ACPI_REGISTER_PREPARE_BITS(val, pos, mask) \
+        ((val << pos) & mask)
 
-#define ACPI_INSERT_BITS(target, mask, source)          target = ((target & (~(mask))) | (source & mask))
+#define ACPI_REGISTER_INSERT_VALUE(reg, pos, mask, val) \
+        reg = (reg & (~(mask))) | ACPI_REGISTER_PREPARE_BITS(val, pos, mask)
+
+#define ACPI_INSERT_BITS(target, mask, source) \
+        target = ((target & (~(mask))) | (source & mask))
+
+/* Generic bitfield macros and masks */
+
+#define ACPI_GET_BITS(source_ptr, position, mask) \
+        ((*source_ptr >> position) & mask)
+
+#define ACPI_SET_BITS(target_ptr, position, mask, value) \
+        (*target_ptr |= ((value & mask) << position))
+
+#define ACPI_1BIT_MASK      0x00000001
+#define ACPI_2BIT_MASK      0x00000003
+#define ACPI_3BIT_MASK      0x00000007
+#define ACPI_4BIT_MASK      0x0000000F
+#define ACPI_5BIT_MASK      0x0000001F
+#define ACPI_6BIT_MASK      0x0000003F
+#define ACPI_7BIT_MASK      0x0000007F
+#define ACPI_8BIT_MASK      0x000000FF
+#define ACPI_16BIT_MASK     0x0000FFFF
+#define ACPI_24BIT_MASK     0x00FFFFFF
 
 /*
  * An object of type struct acpi_namespace_node can appear in some contexts
diff --git a/drivers/acpi/acpica/utxface.c b/drivers/acpi/acpica/utxface.c
index 667229dbcba..b09632b4f5b 100644
--- a/drivers/acpi/acpica/utxface.c
+++ b/drivers/acpi/acpica/utxface.c
@@ -418,3 +418,90 @@ acpi_check_address_range(acpi_adr_space_type space_id,
 
 ACPI_EXPORT_SYMBOL(acpi_check_address_range)
 #endif                          /* !ACPI_ASL_COMPILER */
+/*******************************************************************************
+ *
+ * FUNCTION:    acpi_decode_pld_buffer
+ *
+ * PARAMETERS:  in_buffer           - Buffer returned by _PLD method
+ *              length              - Length of the in_buffer
+ *              return_buffer       - Where the decode buffer is returned
+ *
+ * RETURN:      Status and the decoded _PLD buffer. User must deallocate
+ *              the buffer via ACPI_FREE.
+ *
+ * DESCRIPTION: Decode the bit-packed buffer returned by the _PLD method into
+ *              a local struct that is much more useful to an ACPI driver.
+ *
+ ******************************************************************************/
+acpi_status
+acpi_decode_pld_buffer(u8 *in_buffer,
+                       acpi_size length, struct acpi_pld_info ** return_buffer)
+{
+        struct acpi_pld_info *pld_info;
+        u32 *buffer = ACPI_CAST_PTR(u32, in_buffer);
+        u32 dword;
+
+        /* Parameter validation */
+
+        if (!in_buffer || !return_buffer || (length < 16)) {
+                return (AE_BAD_PARAMETER);
+        }
+
+        pld_info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_pld_info));
+        if (!pld_info) {
+                return (AE_NO_MEMORY);
+        }
+
+        /* First 32-bit DWord */
+
+        ACPI_MOVE_32_TO_32(&dword, &buffer[0]);
+        pld_info->revision = ACPI_PLD_GET_REVISION(&dword);
+        pld_info->ignore_color = ACPI_PLD_GET_IGNORE_COLOR(&dword);
+        pld_info->color = ACPI_PLD_GET_COLOR(&dword);
+
+        /* Second 32-bit DWord */
+
+        ACPI_MOVE_32_TO_32(&dword, &buffer[1]);
+        pld_info->width = ACPI_PLD_GET_WIDTH(&dword);
+        pld_info->height = ACPI_PLD_GET_HEIGHT(&dword);
+
+        /* Third 32-bit DWord */
+
+        ACPI_MOVE_32_TO_32(&dword, &buffer[2]);
+        pld_info->user_visible = ACPI_PLD_GET_USER_VISIBLE(&dword);
+        pld_info->dock = ACPI_PLD_GET_DOCK(&dword);
+        pld_info->lid = ACPI_PLD_GET_LID(&dword);
+        pld_info->panel = ACPI_PLD_GET_PANEL(&dword);
+        pld_info->vertical_position = ACPI_PLD_GET_VERTICAL(&dword);
+        pld_info->horizontal_position = ACPI_PLD_GET_HORIZONTAL(&dword);
+        pld_info->shape = ACPI_PLD_GET_SHAPE(&dword);
+        pld_info->group_orientation = ACPI_PLD_GET_ORIENTATION(&dword);
+        pld_info->group_token = ACPI_PLD_GET_TOKEN(&dword);
+        pld_info->group_position = ACPI_PLD_GET_POSITION(&dword);
+        pld_info->bay = ACPI_PLD_GET_BAY(&dword);
+
+        /* Fourth 32-bit DWord */
+
+        ACPI_MOVE_32_TO_32(&dword, &buffer[3]);
+        pld_info->ejectable = ACPI_PLD_GET_EJECTABLE(&dword);
+        pld_info->ospm_eject_required = ACPI_PLD_GET_OSPM_EJECT(&dword);
+        pld_info->cabinet_number = ACPI_PLD_GET_CABINET(&dword);
+        pld_info->card_cage_number = ACPI_PLD_GET_CARD_CAGE(&dword);
+        pld_info->reference = ACPI_PLD_GET_REFERENCE(&dword);
+        pld_info->rotation = ACPI_PLD_GET_ROTATION(&dword);
+        pld_info->order = ACPI_PLD_GET_ORDER(&dword);
+
+        if (length >= ACPI_PLD_BUFFER_SIZE) {
+
+                /* Fifth 32-bit DWord (Revision 2 of _PLD) */
+
+                ACPI_MOVE_32_TO_32(&dword, &buffer[4]);
+                pld_info->vertical_offset = ACPI_PLD_GET_VERT_OFFSET(&dword);
+                pld_info->horizontal_offset = ACPI_PLD_GET_HORIZ_OFFSET(&dword);
+        }
+
+        *return_buffer = pld_info;
+        return (AE_OK);
+}
+
+ACPI_EXPORT_SYMBOL(acpi_decode_pld_buffer)