exfield.c 11.6 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4 5 6 7
/******************************************************************************
 *
 * Module Name: exfield - ACPI AML (p-code) execution - field manipulation
 *
 *****************************************************************************/

/*
Bob Moore's avatar
Bob Moore committed
8
 * Copyright (C) 2000 - 2006, R. Byron Moore
Linus Torvalds's avatar
Linus Torvalds committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
 * 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 <acpi/acdispat.h>
#include <acpi/acinterp.h>

#define _COMPONENT          ACPI_EXECUTER
Len Brown's avatar
Len Brown committed
49
ACPI_MODULE_NAME("exfield")
Linus Torvalds's avatar
Linus Torvalds committed
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65

/*******************************************************************************
 *
 * 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
Len Brown's avatar
Len Brown committed
66 67 68
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)
Linus Torvalds's avatar
Linus Torvalds committed
69
{
Len Brown's avatar
Len Brown committed
70 71 72 73 74
	acpi_status status;
	union acpi_operand_object *buffer_desc;
	acpi_size length;
	void *buffer;
	u8 locked;
Linus Torvalds's avatar
Linus Torvalds committed
75

Len Brown's avatar
Len Brown committed
76
	ACPI_FUNCTION_TRACE_PTR("ex_read_data_from_field", obj_desc);
Linus Torvalds's avatar
Linus Torvalds committed
77 78 79 80

	/* Parameter validation */

	if (!obj_desc) {
Len Brown's avatar
Len Brown committed
81
		return_ACPI_STATUS(AE_AML_NO_OPERAND);
Linus Torvalds's avatar
Linus Torvalds committed
82
	}
83
	if (!ret_buffer_desc) {
Len Brown's avatar
Len Brown committed
84
		return_ACPI_STATUS(AE_BAD_PARAMETER);
85
	}
Linus Torvalds's avatar
Linus Torvalds committed
86

Len Brown's avatar
Len Brown committed
87
	if (ACPI_GET_OBJECT_TYPE(obj_desc) == ACPI_TYPE_BUFFER_FIELD) {
Linus Torvalds's avatar
Linus Torvalds committed
88 89 90 91 92
		/*
		 * 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)) {
Len Brown's avatar
Len Brown committed
93 94 95
			status = acpi_ds_get_buffer_field_arguments(obj_desc);
			if (ACPI_FAILURE(status)) {
				return_ACPI_STATUS(status);
Linus Torvalds's avatar
Linus Torvalds committed
96 97
			}
		}
Len Brown's avatar
Len Brown committed
98 99 100 101
	} else
	    if ((ACPI_GET_OBJECT_TYPE(obj_desc) == ACPI_TYPE_LOCAL_REGION_FIELD)
		&& (obj_desc->field.region_obj->region.space_id ==
		    ACPI_ADR_SPACE_SMBUS)) {
Linus Torvalds's avatar
Linus Torvalds committed
102 103 104 105
		/*
		 * This is an SMBus read.  We must create a buffer to hold the data
		 * and directly access the region handler.
		 */
Len Brown's avatar
Len Brown committed
106 107
		buffer_desc =
		    acpi_ut_create_buffer_object(ACPI_SMBUS_BUFFER_SIZE);
Linus Torvalds's avatar
Linus Torvalds committed
108
		if (!buffer_desc) {
Len Brown's avatar
Len Brown committed
109
			return_ACPI_STATUS(AE_NO_MEMORY);
Linus Torvalds's avatar
Linus Torvalds committed
110 111 112 113
		}

		/* Lock entire transaction if requested */

Len Brown's avatar
Len Brown committed
114 115 116
		locked =
		    acpi_ex_acquire_global_lock(obj_desc->common_field.
						field_flags);
Linus Torvalds's avatar
Linus Torvalds committed
117 118 119 120 121

		/*
		 * Perform the read.
		 * Note: Smbus protocol value is passed in upper 16-bits of Function
		 */
Len Brown's avatar
Len Brown committed
122 123 124 125 126 127 128
		status = acpi_ex_access_region(obj_desc, 0,
					       ACPI_CAST_PTR(acpi_integer,
							     buffer_desc->
							     buffer.pointer),
					       ACPI_READ | (obj_desc->field.
							    attribute << 16));
		acpi_ex_release_global_lock(locked);
Linus Torvalds's avatar
Linus Torvalds committed
129 130 131 132 133 134 135 136 137 138 139 140 141
		goto exit;
	}

	/*
	 * Allocate a buffer for the contents of the field.
	 *
	 * If the field is larger than the size of an acpi_integer, 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.
	 */
Len Brown's avatar
Len Brown committed
142 143
	length =
	    (acpi_size) ACPI_ROUND_BITS_UP_TO_BYTES(obj_desc->field.bit_length);
Linus Torvalds's avatar
Linus Torvalds committed
144 145 146
	if (length > acpi_gbl_integer_byte_width) {
		/* Field is too large for an Integer, create a Buffer instead */

Len Brown's avatar
Len Brown committed
147
		buffer_desc = acpi_ut_create_buffer_object(length);
Linus Torvalds's avatar
Linus Torvalds committed
148
		if (!buffer_desc) {
Len Brown's avatar
Len Brown committed
149
			return_ACPI_STATUS(AE_NO_MEMORY);
Linus Torvalds's avatar
Linus Torvalds committed
150 151
		}
		buffer = buffer_desc->buffer.pointer;
Len Brown's avatar
Len Brown committed
152
	} else {
Linus Torvalds's avatar
Linus Torvalds committed
153 154
		/* Field will fit within an Integer (normal case) */

Len Brown's avatar
Len Brown committed
155
		buffer_desc = acpi_ut_create_internal_object(ACPI_TYPE_INTEGER);
Linus Torvalds's avatar
Linus Torvalds committed
156
		if (!buffer_desc) {
Len Brown's avatar
Len Brown committed
157
			return_ACPI_STATUS(AE_NO_MEMORY);
Linus Torvalds's avatar
Linus Torvalds committed
158 159 160 161 162 163 164
		}

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

Len Brown's avatar
Len Brown committed
165 166 167 168 169 170 171 172 173
	ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
			  "field_read [TO]:  Obj %p, Type %X, Buf %p, byte_len %X\n",
			  obj_desc, ACPI_GET_OBJECT_TYPE(obj_desc), buffer,
			  (u32) length));
	ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
			  "field_read [FROM]: bit_len %X, bit_off %X, byte_off %X\n",
			  obj_desc->common_field.bit_length,
			  obj_desc->common_field.start_field_bit_offset,
			  obj_desc->common_field.base_byte_offset));
Linus Torvalds's avatar
Linus Torvalds committed
174 175 176

	/* Lock entire transaction if requested */

Len Brown's avatar
Len Brown committed
177 178
	locked =
	    acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);
Linus Torvalds's avatar
Linus Torvalds committed
179 180 181

	/* Read from the field */

Len Brown's avatar
Len Brown committed
182 183
	status = acpi_ex_extract_from_field(obj_desc, buffer, (u32) length);
	acpi_ex_release_global_lock(locked);
Linus Torvalds's avatar
Linus Torvalds committed
184

Len Brown's avatar
Len Brown committed
185 186 187 188
      exit:
	if (ACPI_FAILURE(status)) {
		acpi_ut_remove_reference(buffer_desc);
	} else {
Linus Torvalds's avatar
Linus Torvalds committed
189 190 191
		*ret_buffer_desc = buffer_desc;
	}

Len Brown's avatar
Len Brown committed
192
	return_ACPI_STATUS(status);
Linus Torvalds's avatar
Linus Torvalds committed
193 194 195 196 197 198 199 200
}

/*******************************************************************************
 *
 * FUNCTION:    acpi_ex_write_data_to_field
 *
 * PARAMETERS:  source_desc         - Contains data to write
 *              obj_desc            - The named field
201
 *              result_desc         - Where the return value is returned, if any
Linus Torvalds's avatar
Linus Torvalds committed
202 203 204 205 206 207 208 209
 *
 * RETURN:      Status
 *
 * DESCRIPTION: Write to a named field
 *
 ******************************************************************************/

acpi_status
Len Brown's avatar
Len Brown committed
210 211 212
acpi_ex_write_data_to_field(union acpi_operand_object *source_desc,
			    union acpi_operand_object *obj_desc,
			    union acpi_operand_object **result_desc)
Linus Torvalds's avatar
Linus Torvalds committed
213
{
Len Brown's avatar
Len Brown committed
214 215 216 217 218 219 220
	acpi_status status;
	u32 length;
	u32 required_length;
	void *buffer;
	void *new_buffer;
	u8 locked;
	union acpi_operand_object *buffer_desc;
Linus Torvalds's avatar
Linus Torvalds committed
221

Len Brown's avatar
Len Brown committed
222
	ACPI_FUNCTION_TRACE_PTR("ex_write_data_to_field", obj_desc);
Linus Torvalds's avatar
Linus Torvalds committed
223 224 225 226

	/* Parameter validation */

	if (!source_desc || !obj_desc) {
Len Brown's avatar
Len Brown committed
227
		return_ACPI_STATUS(AE_AML_NO_OPERAND);
Linus Torvalds's avatar
Linus Torvalds committed
228 229
	}

Len Brown's avatar
Len Brown committed
230
	if (ACPI_GET_OBJECT_TYPE(obj_desc) == ACPI_TYPE_BUFFER_FIELD) {
Linus Torvalds's avatar
Linus Torvalds committed
231 232 233 234 235
		/*
		 * 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)) {
Len Brown's avatar
Len Brown committed
236 237 238
			status = acpi_ds_get_buffer_field_arguments(obj_desc);
			if (ACPI_FAILURE(status)) {
				return_ACPI_STATUS(status);
Linus Torvalds's avatar
Linus Torvalds committed
239 240
			}
		}
Len Brown's avatar
Len Brown committed
241 242 243 244
	} else
	    if ((ACPI_GET_OBJECT_TYPE(obj_desc) == ACPI_TYPE_LOCAL_REGION_FIELD)
		&& (obj_desc->field.region_obj->region.space_id ==
		    ACPI_ADR_SPACE_SMBUS)) {
Linus Torvalds's avatar
Linus Torvalds committed
245 246 247 248 249 250
		/*
		 * This is an SMBus write.  We will bypass the entire field mechanism
		 * and handoff the buffer directly to the handler.
		 *
		 * Source must be a buffer of sufficient size (ACPI_SMBUS_BUFFER_SIZE).
		 */
Len Brown's avatar
Len Brown committed
251
		if (ACPI_GET_OBJECT_TYPE(source_desc) != ACPI_TYPE_BUFFER) {
Bob Moore's avatar
Bob Moore committed
252 253 254
			ACPI_ERROR((AE_INFO,
				    "SMBus write requires Buffer, found type %s",
				    acpi_ut_get_object_type_name(source_desc)));
255

Len Brown's avatar
Len Brown committed
256
			return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
Linus Torvalds's avatar
Linus Torvalds committed
257 258 259
		}

		if (source_desc->buffer.length < ACPI_SMBUS_BUFFER_SIZE) {
Bob Moore's avatar
Bob Moore committed
260 261 262 263
			ACPI_ERROR((AE_INFO,
				    "SMBus write requires Buffer of length %X, found length %X",
				    ACPI_SMBUS_BUFFER_SIZE,
				    source_desc->buffer.length));
264

Len Brown's avatar
Len Brown committed
265
			return_ACPI_STATUS(AE_AML_BUFFER_LIMIT);
Linus Torvalds's avatar
Linus Torvalds committed
266 267
		}

Len Brown's avatar
Len Brown committed
268 269
		buffer_desc =
		    acpi_ut_create_buffer_object(ACPI_SMBUS_BUFFER_SIZE);
Linus Torvalds's avatar
Linus Torvalds committed
270
		if (!buffer_desc) {
Len Brown's avatar
Len Brown committed
271
			return_ACPI_STATUS(AE_NO_MEMORY);
Linus Torvalds's avatar
Linus Torvalds committed
272 273 274
		}

		buffer = buffer_desc->buffer.pointer;
Len Brown's avatar
Len Brown committed
275 276
		ACPI_MEMCPY(buffer, source_desc->buffer.pointer,
			    ACPI_SMBUS_BUFFER_SIZE);
Linus Torvalds's avatar
Linus Torvalds committed
277 278 279

		/* Lock entire transaction if requested */

Len Brown's avatar
Len Brown committed
280 281 282
		locked =
		    acpi_ex_acquire_global_lock(obj_desc->common_field.
						field_flags);
Linus Torvalds's avatar
Linus Torvalds committed
283 284

		/*
285 286
		 * Perform the write (returns status and perhaps data in the
		 * same buffer)
Linus Torvalds's avatar
Linus Torvalds committed
287 288
		 * Note: SMBus protocol type is passed in upper 16-bits of Function.
		 */
Len Brown's avatar
Len Brown committed
289 290 291 292 293
		status = acpi_ex_access_region(obj_desc, 0,
					       (acpi_integer *) buffer,
					       ACPI_WRITE | (obj_desc->field.
							     attribute << 16));
		acpi_ex_release_global_lock(locked);
Linus Torvalds's avatar
Linus Torvalds committed
294 295

		*result_desc = buffer_desc;
Len Brown's avatar
Len Brown committed
296
		return_ACPI_STATUS(status);
Linus Torvalds's avatar
Linus Torvalds committed
297 298
	}

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

Len Brown's avatar
Len Brown committed
301
	switch (ACPI_GET_OBJECT_TYPE(source_desc)) {
Linus Torvalds's avatar
Linus Torvalds committed
302 303
	case ACPI_TYPE_INTEGER:
		buffer = &source_desc->integer.value;
Len Brown's avatar
Len Brown committed
304
		length = sizeof(source_desc->integer.value);
Linus Torvalds's avatar
Linus Torvalds committed
305 306 307 308 309 310 311 312 313 314 315 316 317
		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:
Len Brown's avatar
Len Brown committed
318
		return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
Linus Torvalds's avatar
Linus Torvalds committed
319 320 321 322 323 324 325 326 327
	}

	/*
	 * We must have a buffer that is at least as long as the field
	 * we are writing to.  This is because individual fields are
	 * indivisible and partial writes are not supported -- as per
	 * the ACPI specification.
	 */
	new_buffer = NULL;
Len Brown's avatar
Len Brown committed
328 329
	required_length =
	    ACPI_ROUND_BITS_UP_TO_BYTES(obj_desc->common_field.bit_length);
Linus Torvalds's avatar
Linus Torvalds committed
330 331 332 333

	if (length < required_length) {
		/* We need to create a new buffer */

Len Brown's avatar
Len Brown committed
334
		new_buffer = ACPI_MEM_CALLOCATE(required_length);
Linus Torvalds's avatar
Linus Torvalds committed
335
		if (!new_buffer) {
Len Brown's avatar
Len Brown committed
336
			return_ACPI_STATUS(AE_NO_MEMORY);
Linus Torvalds's avatar
Linus Torvalds committed
337 338 339 340 341 342 343
		}

		/*
		 * Copy the original data to the new buffer, starting
		 * at Byte zero.  All unused (upper) bytes of the
		 * buffer will be 0.
		 */
Len Brown's avatar
Len Brown committed
344
		ACPI_MEMCPY((char *)new_buffer, (char *)buffer, length);
Linus Torvalds's avatar
Linus Torvalds committed
345 346 347 348
		buffer = new_buffer;
		length = required_length;
	}

Len Brown's avatar
Len Brown committed
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
	ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
			  "field_write [FROM]: Obj %p (%s:%X), Buf %p, byte_len %X\n",
			  source_desc,
			  acpi_ut_get_type_name(ACPI_GET_OBJECT_TYPE
						(source_desc)),
			  ACPI_GET_OBJECT_TYPE(source_desc), buffer, length));

	ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
			  "field_write [TO]:  Obj %p (%s:%X), bit_len %X, bit_off %X, byte_off %X\n",
			  obj_desc,
			  acpi_ut_get_type_name(ACPI_GET_OBJECT_TYPE(obj_desc)),
			  ACPI_GET_OBJECT_TYPE(obj_desc),
			  obj_desc->common_field.bit_length,
			  obj_desc->common_field.start_field_bit_offset,
			  obj_desc->common_field.base_byte_offset));
Linus Torvalds's avatar
Linus Torvalds committed
364 365 366

	/* Lock entire transaction if requested */

Len Brown's avatar
Len Brown committed
367 368
	locked =
	    acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);
Linus Torvalds's avatar
Linus Torvalds committed
369 370 371

	/* Write to the field */

Len Brown's avatar
Len Brown committed
372 373
	status = acpi_ex_insert_into_field(obj_desc, buffer, length);
	acpi_ex_release_global_lock(locked);
Linus Torvalds's avatar
Linus Torvalds committed
374 375 376 377

	/* Free temporary buffer if we used one */

	if (new_buffer) {
Len Brown's avatar
Len Brown committed
378
		ACPI_MEM_FREE(new_buffer);
Linus Torvalds's avatar
Linus Torvalds committed
379 380
	}

Len Brown's avatar
Len Brown committed
381
	return_ACPI_STATUS(status);
Linus Torvalds's avatar
Linus Torvalds committed
382
}