Merge branch 'topic/convert-bint' into topic/hda
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / acpi / acpica / exfield.c
CommitLineData
1da177e4
LT
1/******************************************************************************
2 *
3 * Module Name: exfield - ACPI AML (p-code) execution - field manipulation
4 *
5 *****************************************************************************/
6
7/*
77848130 8 * Copyright (C) 2000 - 2012, 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"
1da177e4 48
1da177e4 49#define _COMPONENT ACPI_EXECUTER
4be44fcd 50ACPI_MODULE_NAME("exfield")
1da177e4
LT
51
52/*******************************************************************************
53 *
54 * FUNCTION: acpi_ex_read_data_from_field
55 *
56 * PARAMETERS: walk_state - Current execution state
57 * obj_desc - The named field
58 * ret_buffer_desc - Where the return data object is stored
59 *
60 * RETURN: Status
61 *
62 * DESCRIPTION: Read from a named field. Returns either an Integer or a
63 * Buffer, depending on the size of the field.
64 *
65 ******************************************************************************/
1da177e4 66acpi_status
4be44fcd
LB
67acpi_ex_read_data_from_field(struct acpi_walk_state *walk_state,
68 union acpi_operand_object *obj_desc,
69 union acpi_operand_object **ret_buffer_desc)
1da177e4 70{
4be44fcd
LB
71 acpi_status status;
72 union acpi_operand_object *buffer_desc;
73 acpi_size length;
74 void *buffer;
6557a49a 75 u32 function;
1da177e4 76
b229cf92 77 ACPI_FUNCTION_TRACE_PTR(ex_read_data_from_field, obj_desc);
1da177e4
LT
78
79 /* Parameter validation */
80
81 if (!obj_desc) {
4be44fcd 82 return_ACPI_STATUS(AE_AML_NO_OPERAND);
1da177e4 83 }
88ac00f5 84 if (!ret_buffer_desc) {
4be44fcd 85 return_ACPI_STATUS(AE_BAD_PARAMETER);
88ac00f5 86 }
1da177e4 87
3371c19c 88 if (obj_desc->common.type == ACPI_TYPE_BUFFER_FIELD) {
1da177e4
LT
89 /*
90 * If the buffer_field arguments have not been previously evaluated,
91 * evaluate them now and save the results.
92 */
93 if (!(obj_desc->common.flags & AOPOBJ_DATA_VALID)) {
4be44fcd
LB
94 status = acpi_ds_get_buffer_field_arguments(obj_desc);
95 if (ACPI_FAILURE(status)) {
96 return_ACPI_STATUS(status);
1da177e4
LT
97 }
98 }
3371c19c
BM
99 } else if ((obj_desc->common.type == ACPI_TYPE_LOCAL_REGION_FIELD) &&
100 (obj_desc->field.region_obj->region.space_id ==
6557a49a
LM
101 ACPI_ADR_SPACE_SMBUS
102 || obj_desc->field.region_obj->region.space_id ==
2da120b6
BM
103 ACPI_ADR_SPACE_GSBUS
104 || obj_desc->field.region_obj->region.space_id ==
6557a49a 105 ACPI_ADR_SPACE_IPMI)) {
1da177e4 106 /*
2da120b6 107 * This is an SMBus, GSBus or IPMI read. We must create a buffer to hold
6557a49a
LM
108 * the data and then directly access the region handler.
109 *
2da120b6 110 * Note: SMBus and GSBus protocol value is passed in upper 16-bits of Function
1da177e4 111 */
6557a49a
LM
112 if (obj_desc->field.region_obj->region.space_id ==
113 ACPI_ADR_SPACE_SMBUS) {
114 length = ACPI_SMBUS_BUFFER_SIZE;
115 function =
116 ACPI_READ | (obj_desc->field.attribute << 16);
2da120b6
BM
117 } else if (obj_desc->field.region_obj->region.space_id ==
118 ACPI_ADR_SPACE_GSBUS) {
119 length = ACPI_GSBUS_BUFFER_SIZE;
120 function =
121 ACPI_READ | (obj_desc->field.attribute << 16);
6557a49a
LM
122 } else { /* IPMI */
123
124 length = ACPI_IPMI_BUFFER_SIZE;
125 function = ACPI_READ;
126 }
127
128 buffer_desc = acpi_ut_create_buffer_object(length);
1da177e4 129 if (!buffer_desc) {
4be44fcd 130 return_ACPI_STATUS(AE_NO_MEMORY);
1da177e4
LT
131 }
132
133 /* Lock entire transaction if requested */
134
ba886cd4 135 acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);
1da177e4 136
6557a49a
LM
137 /* Call the region handler for the read */
138
4be44fcd 139 status = acpi_ex_access_region(obj_desc, 0,
5df7e6cb 140 ACPI_CAST_PTR(u64,
4be44fcd
LB
141 buffer_desc->
142 buffer.pointer),
6557a49a 143 function);
f02e9fa1 144 acpi_ex_release_global_lock(obj_desc->common_field.field_flags);
1da177e4
LT
145 goto exit;
146 }
147
148 /*
149 * Allocate a buffer for the contents of the field.
150 *
5df7e6cb 151 * If the field is larger than the current integer width, create
1da177e4
LT
152 * a BUFFER to hold it. Otherwise, use an INTEGER. This allows
153 * the use of arithmetic operators on the returned value if the
154 * field size is equal or smaller than an Integer.
155 *
156 * Note: Field.length is in bits.
157 */
4be44fcd
LB
158 length =
159 (acpi_size) ACPI_ROUND_BITS_UP_TO_BYTES(obj_desc->field.bit_length);
1da177e4 160 if (length > acpi_gbl_integer_byte_width) {
52fc0b02 161
1da177e4
LT
162 /* Field is too large for an Integer, create a Buffer instead */
163
4be44fcd 164 buffer_desc = acpi_ut_create_buffer_object(length);
1da177e4 165 if (!buffer_desc) {
4be44fcd 166 return_ACPI_STATUS(AE_NO_MEMORY);
1da177e4
LT
167 }
168 buffer = buffer_desc->buffer.pointer;
4be44fcd 169 } else {
1da177e4
LT
170 /* Field will fit within an Integer (normal case) */
171
dc95a270 172 buffer_desc = acpi_ut_create_integer_object((u64) 0);
1da177e4 173 if (!buffer_desc) {
4be44fcd 174 return_ACPI_STATUS(AE_NO_MEMORY);
1da177e4
LT
175 }
176
177 length = acpi_gbl_integer_byte_width;
1da177e4
LT
178 buffer = &buffer_desc->integer.value;
179 }
180
4be44fcd 181 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
b229cf92 182 "FieldRead [TO]: Obj %p, Type %X, Buf %p, ByteLen %X\n",
3371c19c 183 obj_desc, obj_desc->common.type, buffer,
4be44fcd
LB
184 (u32) length));
185 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
b229cf92 186 "FieldRead [FROM]: BitLen %X, BitOff %X, ByteOff %X\n",
4be44fcd
LB
187 obj_desc->common_field.bit_length,
188 obj_desc->common_field.start_field_bit_offset,
189 obj_desc->common_field.base_byte_offset));
1da177e4
LT
190
191 /* Lock entire transaction if requested */
192
ba886cd4 193 acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);
1da177e4
LT
194
195 /* Read from the field */
196
4be44fcd 197 status = acpi_ex_extract_from_field(obj_desc, buffer, (u32) length);
f02e9fa1 198 acpi_ex_release_global_lock(obj_desc->common_field.field_flags);
1da177e4 199
4be44fcd
LB
200 exit:
201 if (ACPI_FAILURE(status)) {
202 acpi_ut_remove_reference(buffer_desc);
203 } else {
1da177e4
LT
204 *ret_buffer_desc = buffer_desc;
205 }
206
4be44fcd 207 return_ACPI_STATUS(status);
1da177e4
LT
208}
209
1da177e4
LT
210/*******************************************************************************
211 *
212 * FUNCTION: acpi_ex_write_data_to_field
213 *
214 * PARAMETERS: source_desc - Contains data to write
215 * obj_desc - The named field
44f6c012 216 * result_desc - Where the return value is returned, if any
1da177e4
LT
217 *
218 * RETURN: Status
219 *
220 * DESCRIPTION: Write to a named field
221 *
222 ******************************************************************************/
223
224acpi_status
4be44fcd
LB
225acpi_ex_write_data_to_field(union acpi_operand_object *source_desc,
226 union acpi_operand_object *obj_desc,
227 union acpi_operand_object **result_desc)
1da177e4 228{
4be44fcd
LB
229 acpi_status status;
230 u32 length;
4be44fcd 231 void *buffer;
4be44fcd 232 union acpi_operand_object *buffer_desc;
6557a49a 233 u32 function;
1da177e4 234
b229cf92 235 ACPI_FUNCTION_TRACE_PTR(ex_write_data_to_field, obj_desc);
1da177e4
LT
236
237 /* Parameter validation */
238
239 if (!source_desc || !obj_desc) {
4be44fcd 240 return_ACPI_STATUS(AE_AML_NO_OPERAND);
1da177e4
LT
241 }
242
3371c19c 243 if (obj_desc->common.type == ACPI_TYPE_BUFFER_FIELD) {
1da177e4
LT
244 /*
245 * If the buffer_field arguments have not been previously evaluated,
246 * evaluate them now and save the results.
247 */
248 if (!(obj_desc->common.flags & AOPOBJ_DATA_VALID)) {
4be44fcd
LB
249 status = acpi_ds_get_buffer_field_arguments(obj_desc);
250 if (ACPI_FAILURE(status)) {
251 return_ACPI_STATUS(status);
1da177e4
LT
252 }
253 }
3371c19c
BM
254 } else if ((obj_desc->common.type == ACPI_TYPE_LOCAL_REGION_FIELD) &&
255 (obj_desc->field.region_obj->region.space_id ==
6557a49a
LM
256 ACPI_ADR_SPACE_SMBUS
257 || obj_desc->field.region_obj->region.space_id ==
2da120b6
BM
258 ACPI_ADR_SPACE_GSBUS
259 || obj_desc->field.region_obj->region.space_id ==
6557a49a 260 ACPI_ADR_SPACE_IPMI)) {
1da177e4 261 /*
2da120b6 262 * This is an SMBus, GSBus or IPMI write. We will bypass the entire field
6557a49a
LM
263 * mechanism and handoff the buffer directly to the handler. For
264 * these address spaces, the buffer is bi-directional; on a write,
265 * return data is returned in the same buffer.
266 *
267 * Source must be a buffer of sufficient size:
2da120b6 268 * ACPI_SMBUS_BUFFER_SIZE, ACPI_GSBUS_BUFFER_SIZE, or ACPI_IPMI_BUFFER_SIZE.
1da177e4 269 *
2da120b6 270 * Note: SMBus and GSBus protocol type is passed in upper 16-bits of Function
1da177e4 271 */
3371c19c 272 if (source_desc->common.type != ACPI_TYPE_BUFFER) {
b8e4d893 273 ACPI_ERROR((AE_INFO,
2da120b6 274 "SMBus/IPMI/GenericSerialBus write requires Buffer, found type %s",
b8e4d893 275 acpi_ut_get_object_type_name(source_desc)));
44f6c012 276
4be44fcd 277 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
1da177e4
LT
278 }
279
6557a49a
LM
280 if (obj_desc->field.region_obj->region.space_id ==
281 ACPI_ADR_SPACE_SMBUS) {
282 length = ACPI_SMBUS_BUFFER_SIZE;
283 function =
284 ACPI_WRITE | (obj_desc->field.attribute << 16);
2da120b6
BM
285 } else if (obj_desc->field.region_obj->region.space_id ==
286 ACPI_ADR_SPACE_GSBUS) {
287 length = ACPI_GSBUS_BUFFER_SIZE;
288 function =
289 ACPI_WRITE | (obj_desc->field.attribute << 16);
6557a49a
LM
290 } else { /* IPMI */
291
292 length = ACPI_IPMI_BUFFER_SIZE;
293 function = ACPI_WRITE;
294 }
295
296 if (source_desc->buffer.length < length) {
b8e4d893 297 ACPI_ERROR((AE_INFO,
2da120b6 298 "SMBus/IPMI/GenericSerialBus write requires Buffer of length %u, found length %u",
6557a49a 299 length, source_desc->buffer.length));
44f6c012 300
4be44fcd 301 return_ACPI_STATUS(AE_AML_BUFFER_LIMIT);
1da177e4
LT
302 }
303
6557a49a
LM
304 /* Create the bi-directional buffer */
305
306 buffer_desc = acpi_ut_create_buffer_object(length);
1da177e4 307 if (!buffer_desc) {
4be44fcd 308 return_ACPI_STATUS(AE_NO_MEMORY);
1da177e4
LT
309 }
310
311 buffer = buffer_desc->buffer.pointer;
6557a49a 312 ACPI_MEMCPY(buffer, source_desc->buffer.pointer, length);
1da177e4
LT
313
314 /* Lock entire transaction if requested */
315
ba886cd4 316 acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);
1da177e4
LT
317
318 /*
44f6c012
RM
319 * Perform the write (returns status and perhaps data in the
320 * same buffer)
1da177e4 321 */
4be44fcd 322 status = acpi_ex_access_region(obj_desc, 0,
5df7e6cb 323 (u64 *) buffer, function);
f02e9fa1 324 acpi_ex_release_global_lock(obj_desc->common_field.field_flags);
1da177e4
LT
325
326 *result_desc = buffer_desc;
4be44fcd 327 return_ACPI_STATUS(status);
1da177e4
LT
328 }
329
44f6c012
RM
330 /* Get a pointer to the data to be written */
331
3371c19c 332 switch (source_desc->common.type) {
1da177e4
LT
333 case ACPI_TYPE_INTEGER:
334 buffer = &source_desc->integer.value;
4be44fcd 335 length = sizeof(source_desc->integer.value);
1da177e4
LT
336 break;
337
338 case ACPI_TYPE_BUFFER:
339 buffer = source_desc->buffer.pointer;
340 length = source_desc->buffer.length;
341 break;
342
343 case ACPI_TYPE_STRING:
344 buffer = source_desc->string.pointer;
345 length = source_desc->string.length;
346 break;
347
348 default:
4be44fcd 349 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
1da177e4
LT
350 }
351
4be44fcd 352 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
b229cf92 353 "FieldWrite [FROM]: Obj %p (%s:%X), Buf %p, ByteLen %X\n",
4be44fcd 354 source_desc,
3371c19c
BM
355 acpi_ut_get_type_name(source_desc->common.type),
356 source_desc->common.type, buffer, length));
4be44fcd
LB
357
358 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
b229cf92 359 "FieldWrite [TO]: Obj %p (%s:%X), BitLen %X, BitOff %X, ByteOff %X\n",
4be44fcd 360 obj_desc,
3371c19c
BM
361 acpi_ut_get_type_name(obj_desc->common.type),
362 obj_desc->common.type,
4be44fcd
LB
363 obj_desc->common_field.bit_length,
364 obj_desc->common_field.start_field_bit_offset,
365 obj_desc->common_field.base_byte_offset));
1da177e4
LT
366
367 /* Lock entire transaction if requested */
368
ba886cd4 369 acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);
1da177e4
LT
370
371 /* Write to the field */
372
4be44fcd 373 status = acpi_ex_insert_into_field(obj_desc, buffer, length);
f02e9fa1 374 acpi_ex_release_global_lock(obj_desc->common_field.field_flags);
1da177e4 375
4be44fcd 376 return_ACPI_STATUS(status);
1da177e4 377}