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