Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /****************************************************************************** |
2 | * | |
3 | * Module Name: exfield - ACPI AML (p-code) execution - field manipulation | |
4 | * | |
5 | *****************************************************************************/ | |
6 | ||
7 | /* | |
4a90c7e8 | 8 | * Copyright (C) 2000 - 2006, R. Byron Moore |
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; | |
74 | u8 locked; | |
1da177e4 | 75 | |
4be44fcd | 76 | ACPI_FUNCTION_TRACE_PTR("ex_read_data_from_field", obj_desc); |
1da177e4 LT |
77 | |
78 | /* Parameter validation */ | |
79 | ||
80 | if (!obj_desc) { | |
4be44fcd | 81 | return_ACPI_STATUS(AE_AML_NO_OPERAND); |
1da177e4 | 82 | } |
88ac00f5 | 83 | if (!ret_buffer_desc) { |
4be44fcd | 84 | return_ACPI_STATUS(AE_BAD_PARAMETER); |
88ac00f5 | 85 | } |
1da177e4 | 86 | |
4be44fcd | 87 | if (ACPI_GET_OBJECT_TYPE(obj_desc) == ACPI_TYPE_BUFFER_FIELD) { |
1da177e4 LT |
88 | /* |
89 | * If the buffer_field arguments have not been previously evaluated, | |
90 | * evaluate them now and save the results. | |
91 | */ | |
92 | if (!(obj_desc->common.flags & AOPOBJ_DATA_VALID)) { | |
4be44fcd LB |
93 | status = acpi_ds_get_buffer_field_arguments(obj_desc); |
94 | if (ACPI_FAILURE(status)) { | |
95 | return_ACPI_STATUS(status); | |
1da177e4 LT |
96 | } |
97 | } | |
4be44fcd LB |
98 | } else |
99 | if ((ACPI_GET_OBJECT_TYPE(obj_desc) == ACPI_TYPE_LOCAL_REGION_FIELD) | |
100 | && (obj_desc->field.region_obj->region.space_id == | |
101 | ACPI_ADR_SPACE_SMBUS)) { | |
1da177e4 LT |
102 | /* |
103 | * This is an SMBus read. We must create a buffer to hold the data | |
104 | * and directly access the region handler. | |
105 | */ | |
4be44fcd LB |
106 | buffer_desc = |
107 | acpi_ut_create_buffer_object(ACPI_SMBUS_BUFFER_SIZE); | |
1da177e4 | 108 | if (!buffer_desc) { |
4be44fcd | 109 | return_ACPI_STATUS(AE_NO_MEMORY); |
1da177e4 LT |
110 | } |
111 | ||
112 | /* Lock entire transaction if requested */ | |
113 | ||
4be44fcd LB |
114 | locked = |
115 | acpi_ex_acquire_global_lock(obj_desc->common_field. | |
116 | field_flags); | |
1da177e4 LT |
117 | |
118 | /* | |
119 | * Perform the read. | |
120 | * Note: Smbus protocol value is passed in upper 16-bits of Function | |
121 | */ | |
4be44fcd LB |
122 | status = acpi_ex_access_region(obj_desc, 0, |
123 | ACPI_CAST_PTR(acpi_integer, | |
124 | buffer_desc-> | |
125 | buffer.pointer), | |
126 | ACPI_READ | (obj_desc->field. | |
127 | attribute << 16)); | |
128 | acpi_ex_release_global_lock(locked); | |
1da177e4 LT |
129 | goto exit; |
130 | } | |
131 | ||
132 | /* | |
133 | * Allocate a buffer for the contents of the field. | |
134 | * | |
135 | * If the field is larger than the size of an acpi_integer, create | |
136 | * a BUFFER to hold it. Otherwise, use an INTEGER. This allows | |
137 | * the use of arithmetic operators on the returned value if the | |
138 | * field size is equal or smaller than an Integer. | |
139 | * | |
140 | * Note: Field.length is in bits. | |
141 | */ | |
4be44fcd LB |
142 | length = |
143 | (acpi_size) ACPI_ROUND_BITS_UP_TO_BYTES(obj_desc->field.bit_length); | |
1da177e4 LT |
144 | if (length > acpi_gbl_integer_byte_width) { |
145 | /* Field is too large for an Integer, create a Buffer instead */ | |
146 | ||
4be44fcd | 147 | buffer_desc = acpi_ut_create_buffer_object(length); |
1da177e4 | 148 | if (!buffer_desc) { |
4be44fcd | 149 | return_ACPI_STATUS(AE_NO_MEMORY); |
1da177e4 LT |
150 | } |
151 | buffer = buffer_desc->buffer.pointer; | |
4be44fcd | 152 | } else { |
1da177e4 LT |
153 | /* Field will fit within an Integer (normal case) */ |
154 | ||
4be44fcd | 155 | buffer_desc = acpi_ut_create_internal_object(ACPI_TYPE_INTEGER); |
1da177e4 | 156 | if (!buffer_desc) { |
4be44fcd | 157 | return_ACPI_STATUS(AE_NO_MEMORY); |
1da177e4 LT |
158 | } |
159 | ||
160 | length = acpi_gbl_integer_byte_width; | |
161 | buffer_desc->integer.value = 0; | |
162 | buffer = &buffer_desc->integer.value; | |
163 | } | |
164 | ||
4be44fcd LB |
165 | ACPI_DEBUG_PRINT((ACPI_DB_BFIELD, |
166 | "field_read [TO]: Obj %p, Type %X, Buf %p, byte_len %X\n", | |
167 | obj_desc, ACPI_GET_OBJECT_TYPE(obj_desc), buffer, | |
168 | (u32) length)); | |
169 | ACPI_DEBUG_PRINT((ACPI_DB_BFIELD, | |
170 | "field_read [FROM]: bit_len %X, bit_off %X, byte_off %X\n", | |
171 | obj_desc->common_field.bit_length, | |
172 | obj_desc->common_field.start_field_bit_offset, | |
173 | obj_desc->common_field.base_byte_offset)); | |
1da177e4 LT |
174 | |
175 | /* Lock entire transaction if requested */ | |
176 | ||
4be44fcd LB |
177 | locked = |
178 | acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags); | |
1da177e4 LT |
179 | |
180 | /* Read from the field */ | |
181 | ||
4be44fcd LB |
182 | status = acpi_ex_extract_from_field(obj_desc, buffer, (u32) length); |
183 | acpi_ex_release_global_lock(locked); | |
1da177e4 | 184 | |
4be44fcd LB |
185 | exit: |
186 | if (ACPI_FAILURE(status)) { | |
187 | acpi_ut_remove_reference(buffer_desc); | |
188 | } else { | |
1da177e4 LT |
189 | *ret_buffer_desc = buffer_desc; |
190 | } | |
191 | ||
4be44fcd | 192 | return_ACPI_STATUS(status); |
1da177e4 LT |
193 | } |
194 | ||
1da177e4 LT |
195 | /******************************************************************************* |
196 | * | |
197 | * FUNCTION: acpi_ex_write_data_to_field | |
198 | * | |
199 | * PARAMETERS: source_desc - Contains data to write | |
200 | * obj_desc - The named field | |
44f6c012 | 201 | * result_desc - Where the return value is returned, if any |
1da177e4 LT |
202 | * |
203 | * RETURN: Status | |
204 | * | |
205 | * DESCRIPTION: Write to a named field | |
206 | * | |
207 | ******************************************************************************/ | |
208 | ||
209 | acpi_status | |
4be44fcd LB |
210 | acpi_ex_write_data_to_field(union acpi_operand_object *source_desc, |
211 | union acpi_operand_object *obj_desc, | |
212 | union acpi_operand_object **result_desc) | |
1da177e4 | 213 | { |
4be44fcd LB |
214 | acpi_status status; |
215 | u32 length; | |
216 | u32 required_length; | |
217 | void *buffer; | |
218 | void *new_buffer; | |
219 | u8 locked; | |
220 | union acpi_operand_object *buffer_desc; | |
1da177e4 | 221 | |
4be44fcd | 222 | ACPI_FUNCTION_TRACE_PTR("ex_write_data_to_field", obj_desc); |
1da177e4 LT |
223 | |
224 | /* Parameter validation */ | |
225 | ||
226 | if (!source_desc || !obj_desc) { | |
4be44fcd | 227 | return_ACPI_STATUS(AE_AML_NO_OPERAND); |
1da177e4 LT |
228 | } |
229 | ||
4be44fcd | 230 | if (ACPI_GET_OBJECT_TYPE(obj_desc) == ACPI_TYPE_BUFFER_FIELD) { |
1da177e4 LT |
231 | /* |
232 | * If the buffer_field arguments have not been previously evaluated, | |
233 | * evaluate them now and save the results. | |
234 | */ | |
235 | if (!(obj_desc->common.flags & AOPOBJ_DATA_VALID)) { | |
4be44fcd LB |
236 | status = acpi_ds_get_buffer_field_arguments(obj_desc); |
237 | if (ACPI_FAILURE(status)) { | |
238 | return_ACPI_STATUS(status); | |
1da177e4 LT |
239 | } |
240 | } | |
4be44fcd LB |
241 | } else |
242 | if ((ACPI_GET_OBJECT_TYPE(obj_desc) == ACPI_TYPE_LOCAL_REGION_FIELD) | |
243 | && (obj_desc->field.region_obj->region.space_id == | |
244 | ACPI_ADR_SPACE_SMBUS)) { | |
1da177e4 LT |
245 | /* |
246 | * This is an SMBus write. We will bypass the entire field mechanism | |
247 | * and handoff the buffer directly to the handler. | |
248 | * | |
249 | * Source must be a buffer of sufficient size (ACPI_SMBUS_BUFFER_SIZE). | |
250 | */ | |
4be44fcd | 251 | if (ACPI_GET_OBJECT_TYPE(source_desc) != ACPI_TYPE_BUFFER) { |
b8e4d893 BM |
252 | ACPI_ERROR((AE_INFO, |
253 | "SMBus write requires Buffer, found type %s", | |
254 | acpi_ut_get_object_type_name(source_desc))); | |
44f6c012 | 255 | |
4be44fcd | 256 | return_ACPI_STATUS(AE_AML_OPERAND_TYPE); |
1da177e4 LT |
257 | } |
258 | ||
259 | if (source_desc->buffer.length < ACPI_SMBUS_BUFFER_SIZE) { | |
b8e4d893 BM |
260 | ACPI_ERROR((AE_INFO, |
261 | "SMBus write requires Buffer of length %X, found length %X", | |
262 | ACPI_SMBUS_BUFFER_SIZE, | |
263 | source_desc->buffer.length)); | |
44f6c012 | 264 | |
4be44fcd | 265 | return_ACPI_STATUS(AE_AML_BUFFER_LIMIT); |
1da177e4 LT |
266 | } |
267 | ||
4be44fcd LB |
268 | buffer_desc = |
269 | acpi_ut_create_buffer_object(ACPI_SMBUS_BUFFER_SIZE); | |
1da177e4 | 270 | if (!buffer_desc) { |
4be44fcd | 271 | return_ACPI_STATUS(AE_NO_MEMORY); |
1da177e4 LT |
272 | } |
273 | ||
274 | buffer = buffer_desc->buffer.pointer; | |
4be44fcd LB |
275 | ACPI_MEMCPY(buffer, source_desc->buffer.pointer, |
276 | ACPI_SMBUS_BUFFER_SIZE); | |
1da177e4 LT |
277 | |
278 | /* Lock entire transaction if requested */ | |
279 | ||
4be44fcd LB |
280 | locked = |
281 | acpi_ex_acquire_global_lock(obj_desc->common_field. | |
282 | field_flags); | |
1da177e4 LT |
283 | |
284 | /* | |
44f6c012 RM |
285 | * Perform the write (returns status and perhaps data in the |
286 | * same buffer) | |
1da177e4 LT |
287 | * Note: SMBus protocol type is passed in upper 16-bits of Function. |
288 | */ | |
4be44fcd LB |
289 | status = acpi_ex_access_region(obj_desc, 0, |
290 | (acpi_integer *) buffer, | |
291 | ACPI_WRITE | (obj_desc->field. | |
292 | attribute << 16)); | |
293 | acpi_ex_release_global_lock(locked); | |
1da177e4 LT |
294 | |
295 | *result_desc = buffer_desc; | |
4be44fcd | 296 | return_ACPI_STATUS(status); |
1da177e4 LT |
297 | } |
298 | ||
44f6c012 RM |
299 | /* Get a pointer to the data to be written */ |
300 | ||
4be44fcd | 301 | switch (ACPI_GET_OBJECT_TYPE(source_desc)) { |
1da177e4 LT |
302 | case ACPI_TYPE_INTEGER: |
303 | buffer = &source_desc->integer.value; | |
4be44fcd | 304 | length = sizeof(source_desc->integer.value); |
1da177e4 LT |
305 | break; |
306 | ||
307 | case ACPI_TYPE_BUFFER: | |
308 | buffer = source_desc->buffer.pointer; | |
309 | length = source_desc->buffer.length; | |
310 | break; | |
311 | ||
312 | case ACPI_TYPE_STRING: | |
313 | buffer = source_desc->string.pointer; | |
314 | length = source_desc->string.length; | |
315 | break; | |
316 | ||
317 | default: | |
4be44fcd | 318 | return_ACPI_STATUS(AE_AML_OPERAND_TYPE); |
1da177e4 LT |
319 | } |
320 | ||
321 | /* | |
322 | * We must have a buffer that is at least as long as the field | |
323 | * we are writing to. This is because individual fields are | |
324 | * indivisible and partial writes are not supported -- as per | |
325 | * the ACPI specification. | |
326 | */ | |
327 | new_buffer = NULL; | |
4be44fcd LB |
328 | required_length = |
329 | ACPI_ROUND_BITS_UP_TO_BYTES(obj_desc->common_field.bit_length); | |
1da177e4 LT |
330 | |
331 | if (length < required_length) { | |
332 | /* We need to create a new buffer */ | |
333 | ||
4be44fcd | 334 | new_buffer = ACPI_MEM_CALLOCATE(required_length); |
1da177e4 | 335 | if (!new_buffer) { |
4be44fcd | 336 | return_ACPI_STATUS(AE_NO_MEMORY); |
1da177e4 LT |
337 | } |
338 | ||
339 | /* | |
340 | * Copy the original data to the new buffer, starting | |
341 | * at Byte zero. All unused (upper) bytes of the | |
342 | * buffer will be 0. | |
343 | */ | |
4be44fcd | 344 | ACPI_MEMCPY((char *)new_buffer, (char *)buffer, length); |
1da177e4 LT |
345 | buffer = new_buffer; |
346 | length = required_length; | |
347 | } | |
348 | ||
4be44fcd LB |
349 | ACPI_DEBUG_PRINT((ACPI_DB_BFIELD, |
350 | "field_write [FROM]: Obj %p (%s:%X), Buf %p, byte_len %X\n", | |
351 | source_desc, | |
352 | acpi_ut_get_type_name(ACPI_GET_OBJECT_TYPE | |
353 | (source_desc)), | |
354 | ACPI_GET_OBJECT_TYPE(source_desc), buffer, length)); | |
355 | ||
356 | ACPI_DEBUG_PRINT((ACPI_DB_BFIELD, | |
357 | "field_write [TO]: Obj %p (%s:%X), bit_len %X, bit_off %X, byte_off %X\n", | |
358 | obj_desc, | |
359 | acpi_ut_get_type_name(ACPI_GET_OBJECT_TYPE(obj_desc)), | |
360 | ACPI_GET_OBJECT_TYPE(obj_desc), | |
361 | obj_desc->common_field.bit_length, | |
362 | obj_desc->common_field.start_field_bit_offset, | |
363 | obj_desc->common_field.base_byte_offset)); | |
1da177e4 LT |
364 | |
365 | /* Lock entire transaction if requested */ | |
366 | ||
4be44fcd LB |
367 | locked = |
368 | acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags); | |
1da177e4 LT |
369 | |
370 | /* Write to the field */ | |
371 | ||
4be44fcd LB |
372 | status = acpi_ex_insert_into_field(obj_desc, buffer, length); |
373 | acpi_ex_release_global_lock(locked); | |
1da177e4 LT |
374 | |
375 | /* Free temporary buffer if we used one */ | |
376 | ||
377 | if (new_buffer) { | |
4be44fcd | 378 | ACPI_MEM_FREE(new_buffer); |
1da177e4 LT |
379 | } |
380 | ||
4be44fcd | 381 | return_ACPI_STATUS(status); |
1da177e4 | 382 | } |