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