1 /******************************************************************************
3 * Module Name: exfield - ACPI AML (p-code) execution - field manipulation
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2014, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
44 #include <acpi/acpi.h>
50 #define _COMPONENT ACPI_EXECUTER
51 ACPI_MODULE_NAME("exfield")
53 /* Local prototypes */
55 acpi_ex_get_serial_access_length(u32 accessor_type, u32 access_length);
57 /*******************************************************************************
59 * FUNCTION: acpi_ex_get_serial_access_length
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
65 * RETURN: Decoded access length
67 * DESCRIPTION: This routine returns the length of the generic_serial_bus
70 ******************************************************************************/
73 acpi_ex_get_serial_access_length(u32 accessor_type, u32 access_length)
77 switch (accessor_type) {
78 case AML_FIELD_ATTRIB_QUICK:
83 case AML_FIELD_ATTRIB_SEND_RCV:
84 case AML_FIELD_ATTRIB_BYTE:
89 case AML_FIELD_ATTRIB_WORD:
90 case AML_FIELD_ATTRIB_WORD_CALL:
95 case AML_FIELD_ATTRIB_MULTIBYTE:
96 case AML_FIELD_ATTRIB_RAW_BYTES:
97 case AML_FIELD_ATTRIB_RAW_PROCESS:
99 length = access_length;
102 case AML_FIELD_ATTRIB_BLOCK:
103 case AML_FIELD_ATTRIB_BLOCK_CALL:
106 length = ACPI_GSBUS_BUFFER_SIZE - 2;
113 /*******************************************************************************
115 * FUNCTION: acpi_ex_read_data_from_field
117 * PARAMETERS: walk_state - Current execution state
118 * obj_desc - The named field
119 * ret_buffer_desc - Where the return data object is stored
123 * DESCRIPTION: Read from a named field. Returns either an Integer or a
124 * Buffer, depending on the size of the field.
126 ******************************************************************************/
129 acpi_ex_read_data_from_field(struct acpi_walk_state * walk_state,
130 union acpi_operand_object *obj_desc,
131 union acpi_operand_object **ret_buffer_desc)
134 union acpi_operand_object *buffer_desc;
140 ACPI_FUNCTION_TRACE_PTR(ex_read_data_from_field, obj_desc);
142 /* Parameter validation */
145 return_ACPI_STATUS(AE_AML_NO_OPERAND);
147 if (!ret_buffer_desc) {
148 return_ACPI_STATUS(AE_BAD_PARAMETER);
151 if (obj_desc->common.type == ACPI_TYPE_BUFFER_FIELD) {
153 * If the buffer_field arguments have not been previously evaluated,
154 * evaluate them now and save the results.
156 if (!(obj_desc->common.flags & AOPOBJ_DATA_VALID)) {
157 status = acpi_ds_get_buffer_field_arguments(obj_desc);
158 if (ACPI_FAILURE(status)) {
159 return_ACPI_STATUS(status);
162 } else if ((obj_desc->common.type == ACPI_TYPE_LOCAL_REGION_FIELD) &&
163 (obj_desc->field.region_obj->region.space_id ==
165 || obj_desc->field.region_obj->region.space_id ==
167 || obj_desc->field.region_obj->region.space_id ==
168 ACPI_ADR_SPACE_IPMI)) {
170 * This is an SMBus, GSBus or IPMI read. We must create a buffer to hold
171 * the data and then directly access the region handler.
173 * Note: SMBus and GSBus protocol value is passed in upper 16-bits of Function
175 if (obj_desc->field.region_obj->region.space_id ==
176 ACPI_ADR_SPACE_SMBUS) {
177 length = ACPI_SMBUS_BUFFER_SIZE;
179 ACPI_READ | (obj_desc->field.attribute << 16);
180 } else if (obj_desc->field.region_obj->region.space_id ==
181 ACPI_ADR_SPACE_GSBUS) {
182 accessor_type = obj_desc->field.attribute;
183 length = acpi_ex_get_serial_access_length(accessor_type,
189 * Add additional 2 bytes for the generic_serial_bus data buffer:
191 * Status; (Byte 0 of the data buffer)
192 * Length; (Byte 1 of the data buffer)
193 * Data[x-1]; (Bytes 2-x of the arbitrary length data buffer)
196 function = ACPI_READ | (accessor_type << 16);
199 length = ACPI_IPMI_BUFFER_SIZE;
200 function = ACPI_READ;
203 buffer_desc = acpi_ut_create_buffer_object(length);
205 return_ACPI_STATUS(AE_NO_MEMORY);
208 /* Lock entire transaction if requested */
210 acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);
212 /* Call the region handler for the read */
214 status = acpi_ex_access_region(obj_desc, 0,
219 acpi_ex_release_global_lock(obj_desc->common_field.field_flags);
224 * Allocate a buffer for the contents of the field.
226 * If the field is larger than the current integer width, create
227 * a BUFFER to hold it. Otherwise, use an INTEGER. This allows
228 * the use of arithmetic operators on the returned value if the
229 * field size is equal or smaller than an Integer.
231 * Note: Field.length is in bits.
234 (acpi_size) ACPI_ROUND_BITS_UP_TO_BYTES(obj_desc->field.bit_length);
235 if (length > acpi_gbl_integer_byte_width) {
237 /* Field is too large for an Integer, create a Buffer instead */
239 buffer_desc = acpi_ut_create_buffer_object(length);
241 return_ACPI_STATUS(AE_NO_MEMORY);
243 buffer = buffer_desc->buffer.pointer;
245 /* Field will fit within an Integer (normal case) */
247 buffer_desc = acpi_ut_create_integer_object((u64) 0);
249 return_ACPI_STATUS(AE_NO_MEMORY);
252 length = acpi_gbl_integer_byte_width;
253 buffer = &buffer_desc->integer.value;
256 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
257 "FieldRead [TO]: Obj %p, Type %X, Buf %p, ByteLen %X\n",
258 obj_desc, obj_desc->common.type, buffer,
260 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
261 "FieldRead [FROM]: BitLen %X, BitOff %X, ByteOff %X\n",
262 obj_desc->common_field.bit_length,
263 obj_desc->common_field.start_field_bit_offset,
264 obj_desc->common_field.base_byte_offset));
266 /* Lock entire transaction if requested */
268 acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);
270 /* Read from the field */
272 status = acpi_ex_extract_from_field(obj_desc, buffer, (u32) length);
273 acpi_ex_release_global_lock(obj_desc->common_field.field_flags);
276 if (ACPI_FAILURE(status)) {
277 acpi_ut_remove_reference(buffer_desc);
279 *ret_buffer_desc = buffer_desc;
282 return_ACPI_STATUS(status);
285 /*******************************************************************************
287 * FUNCTION: acpi_ex_write_data_to_field
289 * PARAMETERS: source_desc - Contains data to write
290 * obj_desc - The named field
291 * result_desc - Where the return value is returned, if any
295 * DESCRIPTION: Write to a named field
297 ******************************************************************************/
300 acpi_ex_write_data_to_field(union acpi_operand_object *source_desc,
301 union acpi_operand_object *obj_desc,
302 union acpi_operand_object **result_desc)
307 union acpi_operand_object *buffer_desc;
311 ACPI_FUNCTION_TRACE_PTR(ex_write_data_to_field, obj_desc);
313 /* Parameter validation */
315 if (!source_desc || !obj_desc) {
316 return_ACPI_STATUS(AE_AML_NO_OPERAND);
319 if (obj_desc->common.type == ACPI_TYPE_BUFFER_FIELD) {
321 * If the buffer_field arguments have not been previously evaluated,
322 * evaluate them now and save the results.
324 if (!(obj_desc->common.flags & AOPOBJ_DATA_VALID)) {
325 status = acpi_ds_get_buffer_field_arguments(obj_desc);
326 if (ACPI_FAILURE(status)) {
327 return_ACPI_STATUS(status);
330 } else if ((obj_desc->common.type == ACPI_TYPE_LOCAL_REGION_FIELD) &&
331 (obj_desc->field.region_obj->region.space_id ==
333 || obj_desc->field.region_obj->region.space_id ==
335 || obj_desc->field.region_obj->region.space_id ==
336 ACPI_ADR_SPACE_IPMI)) {
338 * This is an SMBus, GSBus or IPMI write. We will bypass the entire field
339 * mechanism and handoff the buffer directly to the handler. For
340 * these address spaces, the buffer is bi-directional; on a write,
341 * return data is returned in the same buffer.
343 * Source must be a buffer of sufficient size:
344 * ACPI_SMBUS_BUFFER_SIZE, ACPI_GSBUS_BUFFER_SIZE, or ACPI_IPMI_BUFFER_SIZE.
346 * Note: SMBus and GSBus protocol type is passed in upper 16-bits of Function
348 if (source_desc->common.type != ACPI_TYPE_BUFFER) {
350 "SMBus/IPMI/GenericSerialBus write requires Buffer, found type %s",
351 acpi_ut_get_object_type_name(source_desc)));
353 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
356 if (obj_desc->field.region_obj->region.space_id ==
357 ACPI_ADR_SPACE_SMBUS) {
358 length = ACPI_SMBUS_BUFFER_SIZE;
360 ACPI_WRITE | (obj_desc->field.attribute << 16);
361 } else if (obj_desc->field.region_obj->region.space_id ==
362 ACPI_ADR_SPACE_GSBUS) {
363 accessor_type = obj_desc->field.attribute;
364 length = acpi_ex_get_serial_access_length(accessor_type,
370 * Add additional 2 bytes for the generic_serial_bus data buffer:
372 * Status; (Byte 0 of the data buffer)
373 * Length; (Byte 1 of the data buffer)
374 * Data[x-1]; (Bytes 2-x of the arbitrary length data buffer)
377 function = ACPI_WRITE | (accessor_type << 16);
380 length = ACPI_IPMI_BUFFER_SIZE;
381 function = ACPI_WRITE;
384 if (source_desc->buffer.length < length) {
386 "SMBus/IPMI/GenericSerialBus write requires Buffer of length %u, found length %u",
387 length, source_desc->buffer.length));
389 return_ACPI_STATUS(AE_AML_BUFFER_LIMIT);
392 /* Create the bi-directional buffer */
394 buffer_desc = acpi_ut_create_buffer_object(length);
396 return_ACPI_STATUS(AE_NO_MEMORY);
399 buffer = buffer_desc->buffer.pointer;
400 ACPI_MEMCPY(buffer, source_desc->buffer.pointer, length);
402 /* Lock entire transaction if requested */
404 acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);
407 * Perform the write (returns status and perhaps data in the
410 status = acpi_ex_access_region(obj_desc, 0,
411 (u64 *) buffer, function);
412 acpi_ex_release_global_lock(obj_desc->common_field.field_flags);
414 *result_desc = buffer_desc;
415 return_ACPI_STATUS(status);
418 /* Get a pointer to the data to be written */
420 switch (source_desc->common.type) {
421 case ACPI_TYPE_INTEGER:
423 buffer = &source_desc->integer.value;
424 length = sizeof(source_desc->integer.value);
427 case ACPI_TYPE_BUFFER:
429 buffer = source_desc->buffer.pointer;
430 length = source_desc->buffer.length;
433 case ACPI_TYPE_STRING:
435 buffer = source_desc->string.pointer;
436 length = source_desc->string.length;
441 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
444 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
445 "FieldWrite [FROM]: Obj %p (%s:%X), Buf %p, ByteLen %X\n",
447 acpi_ut_get_type_name(source_desc->common.type),
448 source_desc->common.type, buffer, length));
450 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
451 "FieldWrite [TO]: Obj %p (%s:%X), BitLen %X, BitOff %X, ByteOff %X\n",
453 acpi_ut_get_type_name(obj_desc->common.type),
454 obj_desc->common.type,
455 obj_desc->common_field.bit_length,
456 obj_desc->common_field.start_field_bit_offset,
457 obj_desc->common_field.base_byte_offset));
459 /* Lock entire transaction if requested */
461 acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);
463 /* Write to the field */
465 status = acpi_ex_insert_into_field(obj_desc, buffer, length);
466 acpi_ex_release_global_lock(obj_desc->common_field.field_flags);
468 return_ACPI_STATUS(status);