[deliverable/linux.git] / drivers / acpi / acpica / exfield.c

/******************************************************************************
 *
 * Module Name: exfield - ACPI AML (p-code) execution - field manipulation
 *
 *****************************************************************************/

/*
 * Copyright (C) 2000 - 2016, Intel Corp.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions, and the following disclaimer,
 *    without modification.
 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 *    substantially similar to the "NO WARRANTY" disclaimer below
 *    ("Disclaimer") and any redistribution must be conditioned upon
 *    including a substantially similar Disclaimer requirement for further
 *    binary redistribution.
 * 3. Neither the names of the above-listed copyright holders nor the names
 *    of any contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * Alternatively, this software may be distributed under the terms of the
 * GNU General Public License ("GPL") version 2 as published by the Free
 * Software Foundation.
 *
 * NO WARRANTY
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGES.
 */

#include <acpi/acpi.h>
#include "accommon.h"
#include "acdispat.h"
#include "acinterp.h"
#include "amlcode.h"

#define _COMPONENT          ACPI_EXECUTER
ACPI_MODULE_NAME("exfield")

/* Local prototypes */
static u32
acpi_ex_get_serial_access_length(u32 accessor_type, u32 access_length);

/*******************************************************************************
 *
 * FUNCTION:    acpi_ex_get_serial_access_length
 *
 * PARAMETERS:  accessor_type   - The type of the protocol indicated by region
 *                                field access attributes
 *              access_length   - The access length of the region field
 *
 * RETURN:      Decoded access length
 *
 * DESCRIPTION: This routine returns the length of the generic_serial_bus
 *              protocol bytes
 *
 ******************************************************************************/

static u32
acpi_ex_get_serial_access_length(u32 accessor_type, u32 access_length)
{
	u32 length;

	switch (accessor_type) {
	case AML_FIELD_ATTRIB_QUICK:

		length = 0;
		break;

	case AML_FIELD_ATTRIB_SEND_RCV:
	case AML_FIELD_ATTRIB_BYTE:

		length = 1;
		break;

	case AML_FIELD_ATTRIB_WORD:
	case AML_FIELD_ATTRIB_WORD_CALL:

		length = 2;
		break;

	case AML_FIELD_ATTRIB_MULTIBYTE:
	case AML_FIELD_ATTRIB_RAW_BYTES:
	case AML_FIELD_ATTRIB_RAW_PROCESS:

		length = access_length;
		break;

	case AML_FIELD_ATTRIB_BLOCK:
	case AML_FIELD_ATTRIB_BLOCK_CALL:
	default:

		length = ACPI_GSBUS_BUFFER_SIZE - 2;
		break;
	}

	return (length);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ex_read_data_from_field
 *
 * PARAMETERS:  walk_state          - Current execution state
 *              obj_desc            - The named field
 *              ret_buffer_desc     - Where the return data object is stored
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Read from a named field. Returns either an Integer or a
 *              Buffer, depending on the size of the field.
 *
 ******************************************************************************/

acpi_status
acpi_ex_read_data_from_field(struct acpi_walk_state *walk_state,
			     union acpi_operand_object *obj_desc,
			     union acpi_operand_object **ret_buffer_desc)
{
	acpi_status status;
	union acpi_operand_object *buffer_desc;
	acpi_size length;
	void *buffer;
	u32 function;
	u16 accessor_type;

	ACPI_FUNCTION_TRACE_PTR(ex_read_data_from_field, obj_desc);

	/* Parameter validation */

	if (!obj_desc) {
		return_ACPI_STATUS(AE_AML_NO_OPERAND);
	}
	if (!ret_buffer_desc) {
		return_ACPI_STATUS(AE_BAD_PARAMETER);
	}

	if (obj_desc->common.type == ACPI_TYPE_BUFFER_FIELD) {
		/*
		 * If the buffer_field arguments have not been previously evaluated,
		 * evaluate them now and save the results.
		 */
		if (!(obj_desc->common.flags & AOPOBJ_DATA_VALID)) {
			status = acpi_ds_get_buffer_field_arguments(obj_desc);
			if (ACPI_FAILURE(status)) {
				return_ACPI_STATUS(status);
			}
		}
	} else if ((obj_desc->common.type == ACPI_TYPE_LOCAL_REGION_FIELD) &&
		   (obj_desc->field.region_obj->region.space_id ==
		    ACPI_ADR_SPACE_SMBUS
		    || obj_desc->field.region_obj->region.space_id ==
		    ACPI_ADR_SPACE_GSBUS
		    || obj_desc->field.region_obj->region.space_id ==
		    ACPI_ADR_SPACE_IPMI)) {
		/*
		 * This is an SMBus, GSBus or IPMI read. We must create a buffer to
		 * hold the data and then directly access the region handler.
		 *
		 * Note: SMBus and GSBus protocol value is passed in upper 16-bits
		 * of Function
		 */
		if (obj_desc->field.region_obj->region.space_id ==
		    ACPI_ADR_SPACE_SMBUS) {
			length = ACPI_SMBUS_BUFFER_SIZE;
			function =
			    ACPI_READ | (obj_desc->field.attribute << 16);
		} else if (obj_desc->field.region_obj->region.space_id ==
			   ACPI_ADR_SPACE_GSBUS) {
			accessor_type = obj_desc->field.attribute;
			length =
			    acpi_ex_get_serial_access_length(accessor_type,
							     obj_desc->field.
							     access_length);

			/*
			 * Add additional 2 bytes for the generic_serial_bus data buffer:
			 *
			 *     Status;    (Byte 0 of the data buffer)
			 *     Length;    (Byte 1 of the data buffer)
			 *     Data[x-1]: (Bytes 2-x of the arbitrary length data buffer)
			 */
			length += 2;
			function = ACPI_READ | (accessor_type << 16);
		} else {	/* IPMI */

			length = ACPI_IPMI_BUFFER_SIZE;
			function = ACPI_READ;
		}

		buffer_desc = acpi_ut_create_buffer_object(length);
		if (!buffer_desc) {
			return_ACPI_STATUS(AE_NO_MEMORY);
		}

		/* Lock entire transaction if requested */

		acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);

		/* Call the region handler for the read */

		status = acpi_ex_access_region(obj_desc, 0,
					       ACPI_CAST_PTR(u64,
							     buffer_desc->
							     buffer.pointer),
					       function);

		acpi_ex_release_global_lock(obj_desc->common_field.field_flags);
		goto exit;
	}

	/*
	 * Allocate a buffer for the contents of the field.
	 *
	 * If the field is larger than the current integer width, create
	 * a BUFFER to hold it. Otherwise, use an INTEGER. This allows
	 * the use of arithmetic operators on the returned value if the
	 * field size is equal or smaller than an Integer.
	 *
	 * Note: Field.length is in bits.
	 */
	length =
	    (acpi_size)ACPI_ROUND_BITS_UP_TO_BYTES(obj_desc->field.bit_length);

	if (length > acpi_gbl_integer_byte_width) {

		/* Field is too large for an Integer, create a Buffer instead */

		buffer_desc = acpi_ut_create_buffer_object(length);
		if (!buffer_desc) {
			return_ACPI_STATUS(AE_NO_MEMORY);
		}
		buffer = buffer_desc->buffer.pointer;
	} else {
		/* Field will fit within an Integer (normal case) */

		buffer_desc = acpi_ut_create_integer_object((u64) 0);
		if (!buffer_desc) {
			return_ACPI_STATUS(AE_NO_MEMORY);
		}

		length = acpi_gbl_integer_byte_width;
		buffer = &buffer_desc->integer.value;
	}

	if ((obj_desc->common.type == ACPI_TYPE_LOCAL_REGION_FIELD) &&
	    (obj_desc->field.region_obj->region.space_id ==
	     ACPI_ADR_SPACE_GPIO)) {
		/*
		 * For GPIO (general_purpose_io), the Address will be the bit offset
		 * from the previous Connection() operator, making it effectively a
		 * pin number index. The bit_length is the length of the field, which
		 * is thus the number of pins.
		 */
		ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
				  "GPIO FieldRead [FROM]:  Pin %u Bits %u\n",
				  obj_desc->field.pin_number_index,
				  obj_desc->field.bit_length));

		/* Lock entire transaction if requested */

		acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);

		/* Perform the write */

		status =
		    acpi_ex_access_region(obj_desc, 0, (u64 *)buffer,
					  ACPI_READ);

		acpi_ex_release_global_lock(obj_desc->common_field.field_flags);
		if (ACPI_FAILURE(status)) {
			acpi_ut_remove_reference(buffer_desc);
		} else {
			*ret_buffer_desc = buffer_desc;
		}
		return_ACPI_STATUS(status);
	}

	ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
			  "FieldRead [TO]:   Obj %p, Type %X, Buf %p, ByteLen %X\n",
			  obj_desc, obj_desc->common.type, buffer,
			  (u32) length));
	ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
			  "FieldRead [FROM]: BitLen %X, BitOff %X, ByteOff %X\n",
			  obj_desc->common_field.bit_length,
			  obj_desc->common_field.start_field_bit_offset,
			  obj_desc->common_field.base_byte_offset));

	/* Lock entire transaction if requested */

	acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);

	/* Read from the field */

	status = acpi_ex_extract_from_field(obj_desc, buffer, (u32) length);
	acpi_ex_release_global_lock(obj_desc->common_field.field_flags);

exit:
	if (ACPI_FAILURE(status)) {
		acpi_ut_remove_reference(buffer_desc);
	} else {
		*ret_buffer_desc = buffer_desc;
	}

	return_ACPI_STATUS(status);
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ex_write_data_to_field
 *
 * PARAMETERS:  source_desc         - Contains data to write
 *              obj_desc            - The named field
 *              result_desc         - Where the return value is returned, if any
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Write to a named field
 *
 ******************************************************************************/

acpi_status
acpi_ex_write_data_to_field(union acpi_operand_object *source_desc,
			    union acpi_operand_object *obj_desc,
			    union acpi_operand_object **result_desc)
{
	acpi_status status;
	u32 length;
	void *buffer;
	union acpi_operand_object *buffer_desc;
	u32 function;
	u16 accessor_type;

	ACPI_FUNCTION_TRACE_PTR(ex_write_data_to_field, obj_desc);

	/* Parameter validation */

	if (!source_desc || !obj_desc) {
		return_ACPI_STATUS(AE_AML_NO_OPERAND);
	}

	if (obj_desc->common.type == ACPI_TYPE_BUFFER_FIELD) {
		/*
		 * If the buffer_field arguments have not been previously evaluated,
		 * evaluate them now and save the results.
		 */
		if (!(obj_desc->common.flags & AOPOBJ_DATA_VALID)) {
			status = acpi_ds_get_buffer_field_arguments(obj_desc);
			if (ACPI_FAILURE(status)) {
				return_ACPI_STATUS(status);
			}
		}
	} else if ((obj_desc->common.type == ACPI_TYPE_LOCAL_REGION_FIELD) &&
		   (obj_desc->field.region_obj->region.space_id ==
		    ACPI_ADR_SPACE_SMBUS
		    || obj_desc->field.region_obj->region.space_id ==
		    ACPI_ADR_SPACE_GSBUS
		    || obj_desc->field.region_obj->region.space_id ==
		    ACPI_ADR_SPACE_IPMI)) {
		/*
		 * This is an SMBus, GSBus or IPMI write. We will bypass the entire
		 * field mechanism and handoff the buffer directly to the handler.
		 * For these address spaces, the buffer is bi-directional; on a
		 * write, return data is returned in the same buffer.
		 *
		 * Source must be a buffer of sufficient size:
		 * ACPI_SMBUS_BUFFER_SIZE, ACPI_GSBUS_BUFFER_SIZE, or
		 * ACPI_IPMI_BUFFER_SIZE.
		 *
		 * Note: SMBus and GSBus protocol type is passed in upper 16-bits
		 * of Function
		 */
		if (source_desc->common.type != ACPI_TYPE_BUFFER) {
			ACPI_ERROR((AE_INFO,
				    "SMBus/IPMI/GenericSerialBus write requires "
				    "Buffer, found type %s",
				    acpi_ut_get_object_type_name(source_desc)));

			return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
		}

		if (obj_desc->field.region_obj->region.space_id ==
		    ACPI_ADR_SPACE_SMBUS) {
			length = ACPI_SMBUS_BUFFER_SIZE;
			function =
			    ACPI_WRITE | (obj_desc->field.attribute << 16);
		} else if (obj_desc->field.region_obj->region.space_id ==
			   ACPI_ADR_SPACE_GSBUS) {
			accessor_type = obj_desc->field.attribute;
			length =
			    acpi_ex_get_serial_access_length(accessor_type,
							     obj_desc->field.
							     access_length);

			/*
			 * Add additional 2 bytes for the generic_serial_bus data buffer:
			 *
			 *     Status;    (Byte 0 of the data buffer)
			 *     Length;    (Byte 1 of the data buffer)
			 *     Data[x-1]: (Bytes 2-x of the arbitrary length data buffer)
			 */
			length += 2;
			function = ACPI_WRITE | (accessor_type << 16);
		} else {	/* IPMI */

			length = ACPI_IPMI_BUFFER_SIZE;
			function = ACPI_WRITE;
		}

		if (source_desc->buffer.length < length) {
			ACPI_ERROR((AE_INFO,
				    "SMBus/IPMI/GenericSerialBus write requires "
				    "Buffer of length %u, found length %u",
				    length, source_desc->buffer.length));

			return_ACPI_STATUS(AE_AML_BUFFER_LIMIT);
		}

		/* Create the bi-directional buffer */

		buffer_desc = acpi_ut_create_buffer_object(length);
		if (!buffer_desc) {
			return_ACPI_STATUS(AE_NO_MEMORY);
		}

		buffer = buffer_desc->buffer.pointer;
		memcpy(buffer, source_desc->buffer.pointer, length);

		/* Lock entire transaction if requested */

		acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);

		/*
		 * Perform the write (returns status and perhaps data in the
		 * same buffer)
		 */
		status =
		    acpi_ex_access_region(obj_desc, 0, (u64 *)buffer, function);
		acpi_ex_release_global_lock(obj_desc->common_field.field_flags);

		*result_desc = buffer_desc;
		return_ACPI_STATUS(status);
	} else if ((obj_desc->common.type == ACPI_TYPE_LOCAL_REGION_FIELD) &&
		   (obj_desc->field.region_obj->region.space_id ==
		    ACPI_ADR_SPACE_GPIO)) {
		/*
		 * For GPIO (general_purpose_io), we will bypass the entire field
		 * mechanism and handoff the bit address and bit width directly to
		 * the handler. The Address will be the bit offset
		 * from the previous Connection() operator, making it effectively a
		 * pin number index. The bit_length is the length of the field, which
		 * is thus the number of pins.
		 */
		if (source_desc->common.type != ACPI_TYPE_INTEGER) {
			return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
		}

		ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
				  "GPIO FieldWrite [FROM]: (%s:%X), Val %.8X  [TO]: Pin %u Bits %u\n",
				  acpi_ut_get_type_name(source_desc->common.
							type),
				  source_desc->common.type,
				  (u32)source_desc->integer.value,
				  obj_desc->field.pin_number_index,
				  obj_desc->field.bit_length));

		buffer = &source_desc->integer.value;

		/* Lock entire transaction if requested */

		acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);

		/* Perform the write */

		status =
		    acpi_ex_access_region(obj_desc, 0, (u64 *)buffer,
					  ACPI_WRITE);
		acpi_ex_release_global_lock(obj_desc->common_field.field_flags);
		return_ACPI_STATUS(status);
	}

	/* Get a pointer to the data to be written */

	switch (source_desc->common.type) {
	case ACPI_TYPE_INTEGER:

		buffer = &source_desc->integer.value;
		length = sizeof(source_desc->integer.value);
		break;

	case ACPI_TYPE_BUFFER:

		buffer = source_desc->buffer.pointer;
		length = source_desc->buffer.length;
		break;

	case ACPI_TYPE_STRING:

		buffer = source_desc->string.pointer;
		length = source_desc->string.length;
		break;

	default:

		return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
	}

	ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
			  "FieldWrite [FROM]: Obj %p (%s:%X), Buf %p, ByteLen %X\n",
			  source_desc,
			  acpi_ut_get_type_name(source_desc->common.type),
			  source_desc->common.type, buffer, length));

	ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
			  "FieldWrite [TO]:   Obj %p (%s:%X), BitLen %X, BitOff %X, ByteOff %X\n",
			  obj_desc,
			  acpi_ut_get_type_name(obj_desc->common.type),
			  obj_desc->common.type,
			  obj_desc->common_field.bit_length,
			  obj_desc->common_field.start_field_bit_offset,
			  obj_desc->common_field.base_byte_offset));

	/* Lock entire transaction if requested */

	acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);

	/* Write to the field */

	status = acpi_ex_insert_into_field(obj_desc, buffer, length);
	acpi_ex_release_global_lock(obj_desc->common_field.field_flags);

	return_ACPI_STATUS(status);
}
Commit	Line	Data
1da177e4 LT	1	/******************************************************************************
	2	*
	3	* Module Name: exfield - ACPI AML (p-code) execution - field manipulation
	4	*
	5	*****************************************************************************/
	6
	7	/*
c8100dc4	8	* Copyright (C) 2000 - 2016, Intel Corp.
1da177e4 LT	9	* All rights reserved.
	10	*
	11	* Redistribution and use in source and binary forms, with or without
	12	* modification, are permitted provided that the following conditions
	13	* are met:
	14	* 1. Redistributions of source code must retain the above copyright
	15	* notice, this list of conditions, and the following disclaimer,
	16	* without modification.
	17	* 2. Redistributions in binary form must reproduce at minimum a disclaimer
	18	* substantially similar to the "NO WARRANTY" disclaimer below
	19	* ("Disclaimer") and any redistribution must be conditioned upon
	20	* including a substantially similar Disclaimer requirement for further
	21	* binary redistribution.
	22	* 3. Neither the names of the above-listed copyright holders nor the names
	23	* of any contributors may be used to endorse or promote products derived
	24	* from this software without specific prior written permission.
	25	*
	26	* Alternatively, this software may be distributed under the terms of the
	27	* GNU General Public License ("GPL") version 2 as published by the Free
	28	* Software Foundation.
	29	*
	30	* NO WARRANTY
	31	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	32	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	33	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
	34	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	35	* HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	36	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	37	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	38	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
	39	* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
	40	* IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
	41	* POSSIBILITY OF SUCH DAMAGES.
	42	*/
	43
1da177e4	44	#include <acpi/acpi.h>
e2f7a777 LB	45	#include "accommon.h"
	46	#include "acdispat.h"
	47	#include "acinterp.h"
6273f00e	48	#include "amlcode.h"
1da177e4	49
1da177e4	50	#define _COMPONENT ACPI_EXECUTER
4be44fcd	51	ACPI_MODULE_NAME("exfield")
1da177e4	52
6273f00e LZ	53	/* Local prototypes */
	54	static u32
	55	acpi_ex_get_serial_access_length(u32 accessor_type, u32 access_length);
	56
	57	/*******************************************************************************
	58	*
c0469129	59	* FUNCTION: acpi_ex_get_serial_access_length
6273f00e LZ	60	*
	61	* PARAMETERS: accessor_type - The type of the protocol indicated by region
	62	* field access attributes
	63	* access_length - The access length of the region field
	64	*
	65	* RETURN: Decoded access length
	66	*
	67	* DESCRIPTION: This routine returns the length of the generic_serial_bus
	68	* protocol bytes
	69	*
	70	******************************************************************************/
	71
	72	static u32
	73	acpi_ex_get_serial_access_length(u32 accessor_type, u32 access_length)
	74	{
	75	u32 length;
	76
	77	switch (accessor_type) {
	78	case AML_FIELD_ATTRIB_QUICK:
	79
	80	length = 0;
	81	break;
	82
	83	case AML_FIELD_ATTRIB_SEND_RCV:
	84	case AML_FIELD_ATTRIB_BYTE:
	85
	86	length = 1;
	87	break;
	88
	89	case AML_FIELD_ATTRIB_WORD:
	90	case AML_FIELD_ATTRIB_WORD_CALL:
	91
	92	length = 2;
	93	break;
	94
	95	case AML_FIELD_ATTRIB_MULTIBYTE:
	96	case AML_FIELD_ATTRIB_RAW_BYTES:
	97	case AML_FIELD_ATTRIB_RAW_PROCESS:
	98
	99	length = access_length;
	100	break;
	101
	102	case AML_FIELD_ATTRIB_BLOCK:
	103	case AML_FIELD_ATTRIB_BLOCK_CALL:
	104	default:
	105
c0469129	106	length = ACPI_GSBUS_BUFFER_SIZE - 2;
6273f00e LZ	107	break;
	108	}
	109
	110	return (length);
	111	}
	112
1da177e4 LT	113	/*******************************************************************************
	114	*
	115	* FUNCTION: acpi_ex_read_data_from_field
	116	*
	117	* PARAMETERS: walk_state - Current execution state
	118	* obj_desc - The named field
	119	* ret_buffer_desc - Where the return data object is stored
	120	*
	121	* RETURN: Status
	122	*
73a3090a	123	* DESCRIPTION: Read from a named field. Returns either an Integer or a
1da177e4 LT	124	* Buffer, depending on the size of the field.
	125	*
	126	******************************************************************************/
6273f00e	127
1da177e4	128	acpi_status
f5c1e1c5	129	acpi_ex_read_data_from_field(struct acpi_walk_state *walk_state,
4be44fcd LB	130	union acpi_operand_object *obj_desc,
4be44fcd LB	131	union acpi_operand_object **ret_buffer_desc)
1da177e4	132	{
4be44fcd LB	133	acpi_status status;
	134	union acpi_operand_object *buffer_desc;
	135	acpi_size length;
	136	void *buffer;
6557a49a	137	u32 function;
6273f00e	138	u16 accessor_type;
1da177e4	139
b229cf92	140	ACPI_FUNCTION_TRACE_PTR(ex_read_data_from_field, obj_desc);
1da177e4 LT	141
	142	/* Parameter validation */
	143
	144	if (!obj_desc) {
4be44fcd	145	return_ACPI_STATUS(AE_AML_NO_OPERAND);
1da177e4	146	}
88ac00f5	147	if (!ret_buffer_desc) {
4be44fcd	148	return_ACPI_STATUS(AE_BAD_PARAMETER);
88ac00f5	149	}
1da177e4	150
3371c19c	151	if (obj_desc->common.type == ACPI_TYPE_BUFFER_FIELD) {
1da177e4 LT	152	/*
	153	* If the buffer_field arguments have not been previously evaluated,
	154	* evaluate them now and save the results.
	155	*/
	156	if (!(obj_desc->common.flags & AOPOBJ_DATA_VALID)) {
4be44fcd LB	157	status = acpi_ds_get_buffer_field_arguments(obj_desc);
	158	if (ACPI_FAILURE(status)) {
	159	return_ACPI_STATUS(status);
1da177e4 LT	160	}
1da177e4 LT	161	}
3371c19c BM	162	} else if ((obj_desc->common.type == ACPI_TYPE_LOCAL_REGION_FIELD) &&
3371c19c BM	163	(obj_desc->field.region_obj->region.space_id ==
6557a49a LM	164	ACPI_ADR_SPACE_SMBUS
6557a49a LM	165	\|\| obj_desc->field.region_obj->region.space_id ==
2da120b6 BM	166	ACPI_ADR_SPACE_GSBUS
2da120b6 BM	167	\|\| obj_desc->field.region_obj->region.space_id ==
6557a49a	168	ACPI_ADR_SPACE_IPMI)) {
1da177e4	169	/*
1fad8738 BM	170	* This is an SMBus, GSBus or IPMI read. We must create a buffer to
1fad8738 BM	171	* hold the data and then directly access the region handler.
6557a49a	172	*
1fad8738 BM	173	* Note: SMBus and GSBus protocol value is passed in upper 16-bits
1fad8738 BM	174	* of Function
1da177e4	175	*/
6557a49a LM	176	if (obj_desc->field.region_obj->region.space_id ==
	177	ACPI_ADR_SPACE_SMBUS) {
	178	length = ACPI_SMBUS_BUFFER_SIZE;
	179	function =
	180	ACPI_READ \| (obj_desc->field.attribute << 16);
2da120b6 BM	181	} else if (obj_desc->field.region_obj->region.space_id ==
2da120b6 BM	182	ACPI_ADR_SPACE_GSBUS) {
6273f00e	183	accessor_type = obj_desc->field.attribute;
1fad8738 BM	184	length =
	185	acpi_ex_get_serial_access_length(accessor_type,
	186	obj_desc->field.
	187	access_length);
6273f00e LZ	188
6273f00e LZ	189	/*
d38bb002 BM	190	* Add additional 2 bytes for the generic_serial_bus data buffer:
d38bb002 BM	191	*
1fad8738 BM	192	* Status; (Byte 0 of the data buffer)
	193	* Length; (Byte 1 of the data buffer)
	194	* Data[x-1]: (Bytes 2-x of the arbitrary length data buffer)
6273f00e LZ	195	*/
	196	length += 2;
	197	function = ACPI_READ \| (accessor_type << 16);
6557a49a LM	198	} else { /* IPMI */
	199
	200	length = ACPI_IPMI_BUFFER_SIZE;
	201	function = ACPI_READ;
	202	}
	203
	204	buffer_desc = acpi_ut_create_buffer_object(length);
1da177e4	205	if (!buffer_desc) {
4be44fcd	206	return_ACPI_STATUS(AE_NO_MEMORY);
1da177e4 LT	207	}
	208
	209	/* Lock entire transaction if requested */
	210
ba886cd4	211	acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);
1da177e4	212
6557a49a LM	213	/* Call the region handler for the read */
6557a49a LM	214
4be44fcd	215	status = acpi_ex_access_region(obj_desc, 0,
5df7e6cb	216	ACPI_CAST_PTR(u64,
4be44fcd LB	217	buffer_desc->
4be44fcd LB	218	buffer.pointer),
6557a49a	219	function);
1fad8738	220
f02e9fa1	221	acpi_ex_release_global_lock(obj_desc->common_field.field_flags);
1da177e4 LT	222	goto exit;
	223	}
	224
	225	/*
	226	* Allocate a buffer for the contents of the field.
	227	*
5df7e6cb	228	* If the field is larger than the current integer width, create
73a3090a	229	* a BUFFER to hold it. Otherwise, use an INTEGER. This allows
1da177e4 LT	230	* the use of arithmetic operators on the returned value if the
	231	* field size is equal or smaller than an Integer.
	232	*
	233	* Note: Field.length is in bits.
	234	*/
4be44fcd	235	length =
f5c1e1c5	236	(acpi_size)ACPI_ROUND_BITS_UP_TO_BYTES(obj_desc->field.bit_length);
1fad8738	237
1da177e4	238	if (length > acpi_gbl_integer_byte_width) {
52fc0b02	239
1da177e4 LT	240	/* Field is too large for an Integer, create a Buffer instead */
1da177e4 LT	241
4be44fcd	242	buffer_desc = acpi_ut_create_buffer_object(length);
1da177e4	243	if (!buffer_desc) {
4be44fcd	244	return_ACPI_STATUS(AE_NO_MEMORY);
1da177e4 LT	245	}
1da177e4 LT	246	buffer = buffer_desc->buffer.pointer;
4be44fcd	247	} else {
1da177e4 LT	248	/* Field will fit within an Integer (normal case) */
1da177e4 LT	249
dc95a270	250	buffer_desc = acpi_ut_create_integer_object((u64) 0);
1da177e4	251	if (!buffer_desc) {
4be44fcd	252	return_ACPI_STATUS(AE_NO_MEMORY);
1da177e4 LT	253	}
	254
	255	length = acpi_gbl_integer_byte_width;
1da177e4 LT	256	buffer = &buffer_desc->integer.value;
	257	}
	258
75ec6e55 BM	259	if ((obj_desc->common.type == ACPI_TYPE_LOCAL_REGION_FIELD) &&
	260	(obj_desc->field.region_obj->region.space_id ==
	261	ACPI_ADR_SPACE_GPIO)) {
	262	/*
	263	* For GPIO (general_purpose_io), the Address will be the bit offset
	264	* from the previous Connection() operator, making it effectively a
	265	* pin number index. The bit_length is the length of the field, which
	266	* is thus the number of pins.
	267	*/
	268	ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
	269	"GPIO FieldRead [FROM]: Pin %u Bits %u\n",
	270	obj_desc->field.pin_number_index,
	271	obj_desc->field.bit_length));
	272
	273	/* Lock entire transaction if requested */
	274
	275	acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);
	276
	277	/* Perform the write */
	278
1fad8738 BM	279	status =
	280	acpi_ex_access_region(obj_desc, 0, (u64 *)buffer,
	281	ACPI_READ);
	282
75ec6e55 BM	283	acpi_ex_release_global_lock(obj_desc->common_field.field_flags);
	284	if (ACPI_FAILURE(status)) {
	285	acpi_ut_remove_reference(buffer_desc);
	286	} else {
	287	*ret_buffer_desc = buffer_desc;
	288	}
	289	return_ACPI_STATUS(status);
	290	}
	291
4be44fcd	292	ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
b229cf92	293	"FieldRead [TO]: Obj %p, Type %X, Buf %p, ByteLen %X\n",
3371c19c	294	obj_desc, obj_desc->common.type, buffer,
4be44fcd LB	295	(u32) length));
4be44fcd LB	296	ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
b229cf92	297	"FieldRead [FROM]: BitLen %X, BitOff %X, ByteOff %X\n",
4be44fcd LB	298	obj_desc->common_field.bit_length,
	299	obj_desc->common_field.start_field_bit_offset,
	300	obj_desc->common_field.base_byte_offset));
1da177e4 LT	301
	302	/* Lock entire transaction if requested */
	303
ba886cd4	304	acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);
1da177e4 LT	305
	306	/* Read from the field */
	307
4be44fcd	308	status = acpi_ex_extract_from_field(obj_desc, buffer, (u32) length);
f02e9fa1	309	acpi_ex_release_global_lock(obj_desc->common_field.field_flags);
1da177e4	310
10622bf8	311	exit:
4be44fcd LB	312	if (ACPI_FAILURE(status)) {
	313	acpi_ut_remove_reference(buffer_desc);
	314	} else {
1da177e4 LT	315	*ret_buffer_desc = buffer_desc;
	316	}
	317
4be44fcd	318	return_ACPI_STATUS(status);
1da177e4 LT	319	}
1da177e4 LT	320
1da177e4 LT	321	/*******************************************************************************
	322	*
	323	* FUNCTION: acpi_ex_write_data_to_field
	324	*
	325	* PARAMETERS: source_desc - Contains data to write
	326	* obj_desc - The named field
44f6c012	327	* result_desc - Where the return value is returned, if any
1da177e4 LT	328	*
	329	* RETURN: Status
	330	*
	331	* DESCRIPTION: Write to a named field
	332	*
	333	******************************************************************************/
	334
	335	acpi_status
4be44fcd LB	336	acpi_ex_write_data_to_field(union acpi_operand_object *source_desc,
	337	union acpi_operand_object *obj_desc,
	338	union acpi_operand_object **result_desc)
1da177e4	339	{
4be44fcd LB	340	acpi_status status;
4be44fcd LB	341	u32 length;
4be44fcd	342	void *buffer;
4be44fcd	343	union acpi_operand_object *buffer_desc;
6557a49a	344	u32 function;
6273f00e	345	u16 accessor_type;
1da177e4	346
b229cf92	347	ACPI_FUNCTION_TRACE_PTR(ex_write_data_to_field, obj_desc);
1da177e4 LT	348
	349	/* Parameter validation */
	350
	351	if (!source_desc \|\| !obj_desc) {
4be44fcd	352	return_ACPI_STATUS(AE_AML_NO_OPERAND);
1da177e4 LT	353	}
1da177e4 LT	354
3371c19c	355	if (obj_desc->common.type == ACPI_TYPE_BUFFER_FIELD) {
1da177e4 LT	356	/*
	357	* If the buffer_field arguments have not been previously evaluated,
	358	* evaluate them now and save the results.
	359	*/
	360	if (!(obj_desc->common.flags & AOPOBJ_DATA_VALID)) {
4be44fcd LB	361	status = acpi_ds_get_buffer_field_arguments(obj_desc);
	362	if (ACPI_FAILURE(status)) {
	363	return_ACPI_STATUS(status);
1da177e4 LT	364	}
1da177e4 LT	365	}
3371c19c BM	366	} else if ((obj_desc->common.type == ACPI_TYPE_LOCAL_REGION_FIELD) &&
3371c19c BM	367	(obj_desc->field.region_obj->region.space_id ==
6557a49a LM	368	ACPI_ADR_SPACE_SMBUS
6557a49a LM	369	\|\| obj_desc->field.region_obj->region.space_id ==
2da120b6 BM	370	ACPI_ADR_SPACE_GSBUS
2da120b6 BM	371	\|\| obj_desc->field.region_obj->region.space_id ==
6557a49a	372	ACPI_ADR_SPACE_IPMI)) {
1da177e4	373	/*
1fad8738 BM	374	* This is an SMBus, GSBus or IPMI write. We will bypass the entire
	375	* field mechanism and handoff the buffer directly to the handler.
	376	* For these address spaces, the buffer is bi-directional; on a
	377	* write, return data is returned in the same buffer.
6557a49a LM	378	*
6557a49a LM	379	* Source must be a buffer of sufficient size:
1fad8738 BM	380	* ACPI_SMBUS_BUFFER_SIZE, ACPI_GSBUS_BUFFER_SIZE, or
1fad8738 BM	381	* ACPI_IPMI_BUFFER_SIZE.
1da177e4	382	*
1fad8738 BM	383	* Note: SMBus and GSBus protocol type is passed in upper 16-bits
1fad8738 BM	384	* of Function
1da177e4	385	*/
3371c19c	386	if (source_desc->common.type != ACPI_TYPE_BUFFER) {
b8e4d893	387	ACPI_ERROR((AE_INFO,
1fad8738 BM	388	"SMBus/IPMI/GenericSerialBus write requires "
1fad8738 BM	389	"Buffer, found type %s",
b8e4d893	390	acpi_ut_get_object_type_name(source_desc)));
44f6c012	391
4be44fcd	392	return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
1da177e4 LT	393	}
1da177e4 LT	394
6557a49a LM	395	if (obj_desc->field.region_obj->region.space_id ==
	396	ACPI_ADR_SPACE_SMBUS) {
	397	length = ACPI_SMBUS_BUFFER_SIZE;
	398	function =
	399	ACPI_WRITE \| (obj_desc->field.attribute << 16);
2da120b6 BM	400	} else if (obj_desc->field.region_obj->region.space_id ==
2da120b6 BM	401	ACPI_ADR_SPACE_GSBUS) {
6273f00e	402	accessor_type = obj_desc->field.attribute;
1fad8738 BM	403	length =
	404	acpi_ex_get_serial_access_length(accessor_type,
	405	obj_desc->field.
	406	access_length);
6273f00e LZ	407
6273f00e LZ	408	/*
d38bb002 BM	409	* Add additional 2 bytes for the generic_serial_bus data buffer:
d38bb002 BM	410	*
1fad8738 BM	411	* Status; (Byte 0 of the data buffer)
	412	* Length; (Byte 1 of the data buffer)
	413	* Data[x-1]: (Bytes 2-x of the arbitrary length data buffer)
6273f00e LZ	414	*/
	415	length += 2;
	416	function = ACPI_WRITE \| (accessor_type << 16);
6557a49a LM	417	} else { /* IPMI */
	418
	419	length = ACPI_IPMI_BUFFER_SIZE;
	420	function = ACPI_WRITE;
	421	}
	422
	423	if (source_desc->buffer.length < length) {
b8e4d893	424	ACPI_ERROR((AE_INFO,
1fad8738 BM	425	"SMBus/IPMI/GenericSerialBus write requires "
1fad8738 BM	426	"Buffer of length %u, found length %u",
6557a49a	427	length, source_desc->buffer.length));
44f6c012	428
4be44fcd	429	return_ACPI_STATUS(AE_AML_BUFFER_LIMIT);
1da177e4 LT	430	}
1da177e4 LT	431
6557a49a LM	432	/* Create the bi-directional buffer */
	433
	434	buffer_desc = acpi_ut_create_buffer_object(length);
1da177e4	435	if (!buffer_desc) {
4be44fcd	436	return_ACPI_STATUS(AE_NO_MEMORY);
1da177e4 LT	437	}
	438
	439	buffer = buffer_desc->buffer.pointer;
4fa4616e	440	memcpy(buffer, source_desc->buffer.pointer, length);
1da177e4 LT	441
	442	/* Lock entire transaction if requested */
	443
ba886cd4	444	acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);
1da177e4 LT	445
1da177e4 LT	446	/*
44f6c012 RM	447	* Perform the write (returns status and perhaps data in the
44f6c012 RM	448	* same buffer)
1da177e4	449	*/
1fad8738 BM	450	status =
1fad8738 BM	451	acpi_ex_access_region(obj_desc, 0, (u64 *)buffer, function);
f02e9fa1	452	acpi_ex_release_global_lock(obj_desc->common_field.field_flags);
1da177e4 LT	453
1da177e4 LT	454	*result_desc = buffer_desc;
4be44fcd	455	return_ACPI_STATUS(status);
75ec6e55 BM	456	} else if ((obj_desc->common.type == ACPI_TYPE_LOCAL_REGION_FIELD) &&
	457	(obj_desc->field.region_obj->region.space_id ==
	458	ACPI_ADR_SPACE_GPIO)) {
	459	/*
	460	* For GPIO (general_purpose_io), we will bypass the entire field
	461	* mechanism and handoff the bit address and bit width directly to
	462	* the handler. The Address will be the bit offset
	463	* from the previous Connection() operator, making it effectively a
	464	* pin number index. The bit_length is the length of the field, which
	465	* is thus the number of pins.
	466	*/
	467	if (source_desc->common.type != ACPI_TYPE_INTEGER) {
	468	return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
	469	}
	470
	471	ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
1fad8738	472	"GPIO FieldWrite [FROM]: (%s:%X), Val %.8X [TO]: Pin %u Bits %u\n",
75ec6e55 BM	473	acpi_ut_get_type_name(source_desc->common.
	474	type),
	475	source_desc->common.type,
	476	(u32)source_desc->integer.value,
	477	obj_desc->field.pin_number_index,
	478	obj_desc->field.bit_length));
	479
	480	buffer = &source_desc->integer.value;
	481
	482	/* Lock entire transaction if requested */
	483
	484	acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);
	485
	486	/* Perform the write */
	487
1fad8738 BM	488	status =
	489	acpi_ex_access_region(obj_desc, 0, (u64 *)buffer,
	490	ACPI_WRITE);
75ec6e55 BM	491	acpi_ex_release_global_lock(obj_desc->common_field.field_flags);
75ec6e55 BM	492	return_ACPI_STATUS(status);
1da177e4 LT	493	}
1da177e4 LT	494
44f6c012 RM	495	/* Get a pointer to the data to be written */
44f6c012 RM	496
3371c19c	497	switch (source_desc->common.type) {
1da177e4	498	case ACPI_TYPE_INTEGER:
1d1ea1b7	499
1da177e4	500	buffer = &source_desc->integer.value;
4be44fcd	501	length = sizeof(source_desc->integer.value);
1da177e4 LT	502	break;
	503
	504	case ACPI_TYPE_BUFFER:
1d1ea1b7	505
1da177e4 LT	506	buffer = source_desc->buffer.pointer;
	507	length = source_desc->buffer.length;
	508	break;
	509
	510	case ACPI_TYPE_STRING:
1d1ea1b7	511
1da177e4 LT	512	buffer = source_desc->string.pointer;
	513	length = source_desc->string.length;
	514	break;
	515
	516	default:
1d1ea1b7	517
4be44fcd	518	return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
1da177e4 LT	519	}
1da177e4 LT	520
4be44fcd	521	ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
b229cf92	522	"FieldWrite [FROM]: Obj %p (%s:%X), Buf %p, ByteLen %X\n",
4be44fcd	523	source_desc,
3371c19c BM	524	acpi_ut_get_type_name(source_desc->common.type),
3371c19c BM	525	source_desc->common.type, buffer, length));
4be44fcd LB	526
4be44fcd LB	527	ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
b229cf92	528	"FieldWrite [TO]: Obj %p (%s:%X), BitLen %X, BitOff %X, ByteOff %X\n",
4be44fcd	529	obj_desc,
3371c19c BM	530	acpi_ut_get_type_name(obj_desc->common.type),
3371c19c BM	531	obj_desc->common.type,
4be44fcd LB	532	obj_desc->common_field.bit_length,
	533	obj_desc->common_field.start_field_bit_offset,
	534	obj_desc->common_field.base_byte_offset));
1da177e4 LT	535
	536	/* Lock entire transaction if requested */
	537
ba886cd4	538	acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);
1da177e4 LT	539
	540	/* Write to the field */
	541
4be44fcd	542	status = acpi_ex_insert_into_field(obj_desc, buffer, length);
f02e9fa1	543	acpi_ex_release_global_lock(obj_desc->common_field.field_flags);
1da177e4	544
4be44fcd	545	return_ACPI_STATUS(status);
1da177e4	546	}