Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /****************************************************************************** |
2 | * | |
3 | * Module Name: exfldio - Aml Field I/O | |
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/acinterp.h> | |
46 | #include <acpi/amlcode.h> | |
47 | #include <acpi/acevents.h> | |
48 | #include <acpi/acdispat.h> | |
49 | ||
1da177e4 | 50 | #define _COMPONENT ACPI_EXECUTER |
4be44fcd | 51 | ACPI_MODULE_NAME("exfldio") |
1da177e4 | 52 | |
44f6c012 | 53 | /* Local prototypes */ |
44f6c012 | 54 | static acpi_status |
4be44fcd LB |
55 | acpi_ex_field_datum_io(union acpi_operand_object *obj_desc, |
56 | u32 field_datum_byte_offset, | |
57 | acpi_integer * value, u32 read_write); | |
44f6c012 RM |
58 | |
59 | static u8 | |
4be44fcd LB |
60 | acpi_ex_register_overflow(union acpi_operand_object *obj_desc, |
61 | acpi_integer value); | |
44f6c012 RM |
62 | |
63 | static acpi_status | |
4be44fcd LB |
64 | acpi_ex_setup_region(union acpi_operand_object *obj_desc, |
65 | u32 field_datum_byte_offset); | |
1da177e4 LT |
66 | |
67 | /******************************************************************************* | |
68 | * | |
69 | * FUNCTION: acpi_ex_setup_region | |
70 | * | |
44f6c012 | 71 | * PARAMETERS: obj_desc - Field to be read or written |
1da177e4 LT |
72 | * field_datum_byte_offset - Byte offset of this datum within the |
73 | * parent field | |
74 | * | |
75 | * RETURN: Status | |
76 | * | |
77 | * DESCRIPTION: Common processing for acpi_ex_extract_from_field and | |
78 | * acpi_ex_insert_into_field. Initialize the Region if necessary and | |
79 | * validate the request. | |
80 | * | |
81 | ******************************************************************************/ | |
82 | ||
44f6c012 | 83 | static acpi_status |
4be44fcd LB |
84 | acpi_ex_setup_region(union acpi_operand_object *obj_desc, |
85 | u32 field_datum_byte_offset) | |
1da177e4 | 86 | { |
4be44fcd LB |
87 | acpi_status status = AE_OK; |
88 | union acpi_operand_object *rgn_desc; | |
1da177e4 | 89 | |
b229cf92 | 90 | ACPI_FUNCTION_TRACE_U32(ex_setup_region, field_datum_byte_offset); |
1da177e4 LT |
91 | |
92 | rgn_desc = obj_desc->common_field.region_obj; | |
93 | ||
94 | /* We must have a valid region */ | |
95 | ||
4be44fcd | 96 | if (ACPI_GET_OBJECT_TYPE(rgn_desc) != ACPI_TYPE_REGION) { |
b8e4d893 BM |
97 | ACPI_ERROR((AE_INFO, "Needed Region, found type %X (%s)", |
98 | ACPI_GET_OBJECT_TYPE(rgn_desc), | |
99 | acpi_ut_get_object_type_name(rgn_desc))); | |
1da177e4 | 100 | |
4be44fcd | 101 | return_ACPI_STATUS(AE_AML_OPERAND_TYPE); |
1da177e4 LT |
102 | } |
103 | ||
104 | /* | |
105 | * If the Region Address and Length have not been previously evaluated, | |
106 | * evaluate them now and save the results. | |
107 | */ | |
108 | if (!(rgn_desc->common.flags & AOPOBJ_DATA_VALID)) { | |
4be44fcd LB |
109 | status = acpi_ds_get_region_arguments(rgn_desc); |
110 | if (ACPI_FAILURE(status)) { | |
111 | return_ACPI_STATUS(status); | |
1da177e4 LT |
112 | } |
113 | } | |
114 | ||
b229cf92 BM |
115 | /* Exit if Address/Length have been disallowed by the host OS */ |
116 | ||
117 | if (rgn_desc->common.flags & AOPOBJ_INVALID) { | |
118 | return_ACPI_STATUS(AE_AML_ILLEGAL_ADDRESS); | |
119 | } | |
120 | ||
121 | /* | |
122 | * Exit now for SMBus address space, it has a non-linear address space | |
123 | * and the request cannot be directly validated | |
124 | */ | |
1da177e4 | 125 | if (rgn_desc->region.space_id == ACPI_ADR_SPACE_SMBUS) { |
52fc0b02 | 126 | |
1da177e4 LT |
127 | /* SMBus has a non-linear address space */ |
128 | ||
4be44fcd | 129 | return_ACPI_STATUS(AE_OK); |
1da177e4 | 130 | } |
1da177e4 LT |
131 | #ifdef ACPI_UNDER_DEVELOPMENT |
132 | /* | |
133 | * If the Field access is any_acc, we can now compute the optimal | |
134 | * access (because we know know the length of the parent region) | |
135 | */ | |
136 | if (!(obj_desc->common.flags & AOPOBJ_DATA_VALID)) { | |
4be44fcd LB |
137 | if (ACPI_FAILURE(status)) { |
138 | return_ACPI_STATUS(status); | |
1da177e4 LT |
139 | } |
140 | } | |
141 | #endif | |
142 | ||
143 | /* | |
144 | * Validate the request. The entire request from the byte offset for a | |
145 | * length of one field datum (access width) must fit within the region. | |
146 | * (Region length is specified in bytes) | |
147 | */ | |
44f6c012 | 148 | if (rgn_desc->region.length < (obj_desc->common_field.base_byte_offset + |
4be44fcd LB |
149 | field_datum_byte_offset + |
150 | obj_desc->common_field. | |
151 | access_byte_width)) { | |
1da177e4 LT |
152 | if (acpi_gbl_enable_interpreter_slack) { |
153 | /* | |
154 | * Slack mode only: We will go ahead and allow access to this | |
155 | * field if it is within the region length rounded up to the next | |
156 | * access width boundary. | |
157 | */ | |
4be44fcd LB |
158 | if (ACPI_ROUND_UP(rgn_desc->region.length, |
159 | obj_desc->common_field. | |
160 | access_byte_width) >= | |
161 | (obj_desc->common_field.base_byte_offset + | |
162 | (acpi_native_uint) obj_desc->common_field. | |
163 | access_byte_width + field_datum_byte_offset)) { | |
164 | return_ACPI_STATUS(AE_OK); | |
1da177e4 LT |
165 | } |
166 | } | |
167 | ||
4be44fcd LB |
168 | if (rgn_desc->region.length < |
169 | obj_desc->common_field.access_byte_width) { | |
1da177e4 LT |
170 | /* |
171 | * This is the case where the access_type (acc_word, etc.) is wider | |
172 | * than the region itself. For example, a region of length one | |
173 | * byte, and a field with Dword access specified. | |
174 | */ | |
b8e4d893 BM |
175 | ACPI_ERROR((AE_INFO, |
176 | "Field [%4.4s] access width (%d bytes) too large for region [%4.4s] (length %X)", | |
177 | acpi_ut_get_node_name(obj_desc-> | |
178 | common_field.node), | |
179 | obj_desc->common_field.access_byte_width, | |
180 | acpi_ut_get_node_name(rgn_desc->region. | |
181 | node), | |
182 | rgn_desc->region.length)); | |
1da177e4 LT |
183 | } |
184 | ||
185 | /* | |
186 | * Offset rounded up to next multiple of field width | |
187 | * exceeds region length, indicate an error | |
188 | */ | |
b8e4d893 BM |
189 | ACPI_ERROR((AE_INFO, |
190 | "Field [%4.4s] Base+Offset+Width %X+%X+%X is beyond end of region [%4.4s] (length %X)", | |
191 | acpi_ut_get_node_name(obj_desc->common_field.node), | |
192 | obj_desc->common_field.base_byte_offset, | |
193 | field_datum_byte_offset, | |
194 | obj_desc->common_field.access_byte_width, | |
195 | acpi_ut_get_node_name(rgn_desc->region.node), | |
196 | rgn_desc->region.length)); | |
4be44fcd LB |
197 | |
198 | return_ACPI_STATUS(AE_AML_REGION_LIMIT); | |
1da177e4 LT |
199 | } |
200 | ||
4be44fcd | 201 | return_ACPI_STATUS(AE_OK); |
1da177e4 LT |
202 | } |
203 | ||
1da177e4 LT |
204 | /******************************************************************************* |
205 | * | |
206 | * FUNCTION: acpi_ex_access_region | |
207 | * | |
44f6c012 | 208 | * PARAMETERS: obj_desc - Field to be read |
1da177e4 LT |
209 | * field_datum_byte_offset - Byte offset of this datum within the |
210 | * parent field | |
44f6c012 | 211 | * Value - Where to store value (must at least |
1da177e4 LT |
212 | * the size of acpi_integer) |
213 | * Function - Read or Write flag plus other region- | |
214 | * dependent flags | |
215 | * | |
216 | * RETURN: Status | |
217 | * | |
218 | * DESCRIPTION: Read or Write a single field datum to an Operation Region. | |
219 | * | |
220 | ******************************************************************************/ | |
221 | ||
222 | acpi_status | |
4be44fcd LB |
223 | acpi_ex_access_region(union acpi_operand_object *obj_desc, |
224 | u32 field_datum_byte_offset, | |
225 | acpi_integer * value, u32 function) | |
1da177e4 | 226 | { |
4be44fcd LB |
227 | acpi_status status; |
228 | union acpi_operand_object *rgn_desc; | |
229 | acpi_physical_address address; | |
1da177e4 | 230 | |
b229cf92 | 231 | ACPI_FUNCTION_TRACE(ex_access_region); |
1da177e4 LT |
232 | |
233 | /* | |
234 | * Ensure that the region operands are fully evaluated and verify | |
235 | * the validity of the request | |
236 | */ | |
4be44fcd LB |
237 | status = acpi_ex_setup_region(obj_desc, field_datum_byte_offset); |
238 | if (ACPI_FAILURE(status)) { | |
239 | return_ACPI_STATUS(status); | |
1da177e4 LT |
240 | } |
241 | ||
242 | /* | |
243 | * The physical address of this field datum is: | |
244 | * | |
245 | * 1) The base of the region, plus | |
246 | * 2) The base offset of the field, plus | |
247 | * 3) The current offset into the field | |
248 | */ | |
249 | rgn_desc = obj_desc->common_field.region_obj; | |
44f6c012 | 250 | address = rgn_desc->region.address + |
4be44fcd | 251 | obj_desc->common_field.base_byte_offset + field_datum_byte_offset; |
1da177e4 LT |
252 | |
253 | if ((function & ACPI_IO_MASK) == ACPI_READ) { | |
4be44fcd LB |
254 | ACPI_DEBUG_PRINT((ACPI_DB_BFIELD, "[READ]")); |
255 | } else { | |
256 | ACPI_DEBUG_PRINT((ACPI_DB_BFIELD, "[WRITE]")); | |
1da177e4 LT |
257 | } |
258 | ||
4be44fcd | 259 | ACPI_DEBUG_PRINT_RAW((ACPI_DB_BFIELD, |
b229cf92 | 260 | " Region [%s:%X], Width %X, ByteBase %X, Offset %X at %8.8X%8.8X\n", |
4be44fcd LB |
261 | acpi_ut_get_region_name(rgn_desc->region. |
262 | space_id), | |
263 | rgn_desc->region.space_id, | |
264 | obj_desc->common_field.access_byte_width, | |
265 | obj_desc->common_field.base_byte_offset, | |
266 | field_datum_byte_offset, | |
267 | ACPI_FORMAT_UINT64(address))); | |
1da177e4 LT |
268 | |
269 | /* Invoke the appropriate address_space/op_region handler */ | |
270 | ||
4be44fcd LB |
271 | status = acpi_ev_address_space_dispatch(rgn_desc, function, |
272 | address, | |
273 | ACPI_MUL_8(obj_desc-> | |
274 | common_field. | |
275 | access_byte_width), | |
276 | value); | |
1da177e4 | 277 | |
4be44fcd | 278 | if (ACPI_FAILURE(status)) { |
1da177e4 | 279 | if (status == AE_NOT_IMPLEMENTED) { |
b8e4d893 BM |
280 | ACPI_ERROR((AE_INFO, |
281 | "Region %s(%X) not implemented", | |
282 | acpi_ut_get_region_name(rgn_desc->region. | |
283 | space_id), | |
284 | rgn_desc->region.space_id)); | |
4be44fcd | 285 | } else if (status == AE_NOT_EXIST) { |
b8e4d893 BM |
286 | ACPI_ERROR((AE_INFO, |
287 | "Region %s(%X) has no handler", | |
288 | acpi_ut_get_region_name(rgn_desc->region. | |
289 | space_id), | |
290 | rgn_desc->region.space_id)); | |
1da177e4 LT |
291 | } |
292 | } | |
293 | ||
4be44fcd | 294 | return_ACPI_STATUS(status); |
1da177e4 LT |
295 | } |
296 | ||
1da177e4 LT |
297 | /******************************************************************************* |
298 | * | |
299 | * FUNCTION: acpi_ex_register_overflow | |
300 | * | |
44f6c012 | 301 | * PARAMETERS: obj_desc - Register(Field) to be written |
1da177e4 LT |
302 | * Value - Value to be stored |
303 | * | |
304 | * RETURN: TRUE if value overflows the field, FALSE otherwise | |
305 | * | |
306 | * DESCRIPTION: Check if a value is out of range of the field being written. | |
307 | * Used to check if the values written to Index and Bank registers | |
308 | * are out of range. Normally, the value is simply truncated | |
309 | * to fit the field, but this case is most likely a serious | |
310 | * coding error in the ASL. | |
311 | * | |
312 | ******************************************************************************/ | |
313 | ||
44f6c012 | 314 | static u8 |
4be44fcd LB |
315 | acpi_ex_register_overflow(union acpi_operand_object *obj_desc, |
316 | acpi_integer value) | |
1da177e4 LT |
317 | { |
318 | ||
319 | if (obj_desc->common_field.bit_length >= ACPI_INTEGER_BIT_SIZE) { | |
320 | /* | |
321 | * The field is large enough to hold the maximum integer, so we can | |
322 | * never overflow it. | |
323 | */ | |
324 | return (FALSE); | |
325 | } | |
326 | ||
327 | if (value >= ((acpi_integer) 1 << obj_desc->common_field.bit_length)) { | |
328 | /* | |
329 | * The Value is larger than the maximum value that can fit into | |
330 | * the register. | |
331 | */ | |
332 | return (TRUE); | |
333 | } | |
334 | ||
335 | /* The Value will fit into the field with no truncation */ | |
336 | ||
337 | return (FALSE); | |
338 | } | |
339 | ||
1da177e4 LT |
340 | /******************************************************************************* |
341 | * | |
342 | * FUNCTION: acpi_ex_field_datum_io | |
343 | * | |
44f6c012 | 344 | * PARAMETERS: obj_desc - Field to be read |
1da177e4 LT |
345 | * field_datum_byte_offset - Byte offset of this datum within the |
346 | * parent field | |
44f6c012 | 347 | * Value - Where to store value (must be 64 bits) |
1da177e4 LT |
348 | * read_write - Read or Write flag |
349 | * | |
350 | * RETURN: Status | |
351 | * | |
352 | * DESCRIPTION: Read or Write a single datum of a field. The field_type is | |
353 | * demultiplexed here to handle the different types of fields | |
354 | * (buffer_field, region_field, index_field, bank_field) | |
355 | * | |
356 | ******************************************************************************/ | |
357 | ||
44f6c012 | 358 | static acpi_status |
4be44fcd LB |
359 | acpi_ex_field_datum_io(union acpi_operand_object *obj_desc, |
360 | u32 field_datum_byte_offset, | |
361 | acpi_integer * value, u32 read_write) | |
1da177e4 | 362 | { |
4be44fcd LB |
363 | acpi_status status; |
364 | acpi_integer local_value; | |
1da177e4 | 365 | |
b229cf92 | 366 | ACPI_FUNCTION_TRACE_U32(ex_field_datum_io, field_datum_byte_offset); |
1da177e4 LT |
367 | |
368 | if (read_write == ACPI_READ) { | |
369 | if (!value) { | |
370 | local_value = 0; | |
44f6c012 RM |
371 | |
372 | /* To support reads without saving return value */ | |
373 | value = &local_value; | |
1da177e4 LT |
374 | } |
375 | ||
376 | /* Clear the entire return buffer first, [Very Important!] */ | |
377 | ||
378 | *value = 0; | |
379 | } | |
380 | ||
381 | /* | |
382 | * The four types of fields are: | |
383 | * | |
384 | * buffer_field - Read/write from/to a Buffer | |
385 | * region_field - Read/write from/to a Operation Region. | |
44f6c012 RM |
386 | * bank_field - Write to a Bank Register, then read/write from/to an |
387 | * operation_region | |
388 | * index_field - Write to an Index Register, then read/write from/to a | |
389 | * Data Register | |
1da177e4 | 390 | */ |
4be44fcd | 391 | switch (ACPI_GET_OBJECT_TYPE(obj_desc)) { |
1da177e4 LT |
392 | case ACPI_TYPE_BUFFER_FIELD: |
393 | /* | |
394 | * If the buffer_field arguments have not been previously evaluated, | |
395 | * evaluate them now and save the results. | |
396 | */ | |
397 | if (!(obj_desc->common.flags & AOPOBJ_DATA_VALID)) { | |
4be44fcd LB |
398 | status = acpi_ds_get_buffer_field_arguments(obj_desc); |
399 | if (ACPI_FAILURE(status)) { | |
400 | return_ACPI_STATUS(status); | |
1da177e4 LT |
401 | } |
402 | } | |
403 | ||
404 | if (read_write == ACPI_READ) { | |
405 | /* | |
406 | * Copy the data from the source buffer. | |
407 | * Length is the field width in bytes. | |
408 | */ | |
4be44fcd LB |
409 | ACPI_MEMCPY(value, |
410 | (obj_desc->buffer_field.buffer_obj)->buffer. | |
411 | pointer + | |
412 | obj_desc->buffer_field.base_byte_offset + | |
413 | field_datum_byte_offset, | |
414 | obj_desc->common_field.access_byte_width); | |
415 | } else { | |
1da177e4 LT |
416 | /* |
417 | * Copy the data to the target buffer. | |
418 | * Length is the field width in bytes. | |
419 | */ | |
4be44fcd LB |
420 | ACPI_MEMCPY((obj_desc->buffer_field.buffer_obj)->buffer. |
421 | pointer + | |
422 | obj_desc->buffer_field.base_byte_offset + | |
423 | field_datum_byte_offset, value, | |
424 | obj_desc->common_field.access_byte_width); | |
1da177e4 LT |
425 | } |
426 | ||
427 | status = AE_OK; | |
428 | break; | |
429 | ||
1da177e4 LT |
430 | case ACPI_TYPE_LOCAL_BANK_FIELD: |
431 | ||
44f6c012 RM |
432 | /* |
433 | * Ensure that the bank_value is not beyond the capacity of | |
434 | * the register | |
435 | */ | |
4be44fcd LB |
436 | if (acpi_ex_register_overflow(obj_desc->bank_field.bank_obj, |
437 | (acpi_integer) obj_desc-> | |
438 | bank_field.value)) { | |
439 | return_ACPI_STATUS(AE_AML_REGISTER_LIMIT); | |
1da177e4 LT |
440 | } |
441 | ||
442 | /* | |
443 | * For bank_fields, we must write the bank_value to the bank_register | |
444 | * (itself a region_field) before we can access the data. | |
445 | */ | |
4be44fcd LB |
446 | status = |
447 | acpi_ex_insert_into_field(obj_desc->bank_field.bank_obj, | |
448 | &obj_desc->bank_field.value, | |
449 | sizeof(obj_desc->bank_field. | |
450 | value)); | |
451 | if (ACPI_FAILURE(status)) { | |
452 | return_ACPI_STATUS(status); | |
1da177e4 LT |
453 | } |
454 | ||
455 | /* | |
456 | * Now that the Bank has been selected, fall through to the | |
457 | * region_field case and write the datum to the Operation Region | |
458 | */ | |
459 | ||
460 | /*lint -fallthrough */ | |
461 | ||
1da177e4 LT |
462 | case ACPI_TYPE_LOCAL_REGION_FIELD: |
463 | /* | |
464 | * For simple region_fields, we just directly access the owning | |
465 | * Operation Region. | |
466 | */ | |
4be44fcd LB |
467 | status = |
468 | acpi_ex_access_region(obj_desc, field_datum_byte_offset, | |
469 | value, read_write); | |
1da177e4 LT |
470 | break; |
471 | ||
1da177e4 LT |
472 | case ACPI_TYPE_LOCAL_INDEX_FIELD: |
473 | ||
44f6c012 RM |
474 | /* |
475 | * Ensure that the index_value is not beyond the capacity of | |
476 | * the register | |
477 | */ | |
4be44fcd LB |
478 | if (acpi_ex_register_overflow(obj_desc->index_field.index_obj, |
479 | (acpi_integer) obj_desc-> | |
480 | index_field.value)) { | |
481 | return_ACPI_STATUS(AE_AML_REGISTER_LIMIT); | |
1da177e4 LT |
482 | } |
483 | ||
484 | /* Write the index value to the index_register (itself a region_field) */ | |
485 | ||
486 | field_datum_byte_offset += obj_desc->index_field.value; | |
487 | ||
4be44fcd LB |
488 | ACPI_DEBUG_PRINT((ACPI_DB_BFIELD, |
489 | "Write to Index Register: Value %8.8X\n", | |
490 | field_datum_byte_offset)); | |
1da177e4 | 491 | |
4be44fcd LB |
492 | status = |
493 | acpi_ex_insert_into_field(obj_desc->index_field.index_obj, | |
494 | &field_datum_byte_offset, | |
495 | sizeof(field_datum_byte_offset)); | |
496 | if (ACPI_FAILURE(status)) { | |
497 | return_ACPI_STATUS(status); | |
1da177e4 LT |
498 | } |
499 | ||
4be44fcd | 500 | ACPI_DEBUG_PRINT((ACPI_DB_BFIELD, |
b229cf92 | 501 | "I/O to Data Register: ValuePtr %p\n", |
4be44fcd | 502 | value)); |
1da177e4 LT |
503 | |
504 | if (read_write == ACPI_READ) { | |
52fc0b02 | 505 | |
1da177e4 LT |
506 | /* Read the datum from the data_register */ |
507 | ||
4be44fcd LB |
508 | status = |
509 | acpi_ex_extract_from_field(obj_desc->index_field. | |
510 | data_obj, value, | |
511 | sizeof(acpi_integer)); | |
512 | } else { | |
1da177e4 LT |
513 | /* Write the datum to the data_register */ |
514 | ||
4be44fcd LB |
515 | status = |
516 | acpi_ex_insert_into_field(obj_desc->index_field. | |
517 | data_obj, value, | |
518 | sizeof(acpi_integer)); | |
1da177e4 LT |
519 | } |
520 | break; | |
521 | ||
1da177e4 LT |
522 | default: |
523 | ||
b8e4d893 BM |
524 | ACPI_ERROR((AE_INFO, "Wrong object type in field I/O %X", |
525 | ACPI_GET_OBJECT_TYPE(obj_desc))); | |
1da177e4 LT |
526 | status = AE_AML_INTERNAL; |
527 | break; | |
528 | } | |
529 | ||
4be44fcd | 530 | if (ACPI_SUCCESS(status)) { |
1da177e4 | 531 | if (read_write == ACPI_READ) { |
4be44fcd LB |
532 | ACPI_DEBUG_PRINT((ACPI_DB_BFIELD, |
533 | "Value Read %8.8X%8.8X, Width %d\n", | |
534 | ACPI_FORMAT_UINT64(*value), | |
535 | obj_desc->common_field. | |
536 | access_byte_width)); | |
537 | } else { | |
538 | ACPI_DEBUG_PRINT((ACPI_DB_BFIELD, | |
539 | "Value Written %8.8X%8.8X, Width %d\n", | |
540 | ACPI_FORMAT_UINT64(*value), | |
541 | obj_desc->common_field. | |
542 | access_byte_width)); | |
1da177e4 LT |
543 | } |
544 | } | |
545 | ||
4be44fcd | 546 | return_ACPI_STATUS(status); |
1da177e4 LT |
547 | } |
548 | ||
1da177e4 LT |
549 | /******************************************************************************* |
550 | * | |
551 | * FUNCTION: acpi_ex_write_with_update_rule | |
552 | * | |
44f6c012 RM |
553 | * PARAMETERS: obj_desc - Field to be written |
554 | * Mask - bitmask within field datum | |
555 | * field_value - Value to write | |
556 | * field_datum_byte_offset - Offset of datum within field | |
1da177e4 LT |
557 | * |
558 | * RETURN: Status | |
559 | * | |
560 | * DESCRIPTION: Apply the field update rule to a field write | |
561 | * | |
562 | ******************************************************************************/ | |
563 | ||
564 | acpi_status | |
4be44fcd LB |
565 | acpi_ex_write_with_update_rule(union acpi_operand_object *obj_desc, |
566 | acpi_integer mask, | |
567 | acpi_integer field_value, | |
568 | u32 field_datum_byte_offset) | |
1da177e4 | 569 | { |
4be44fcd LB |
570 | acpi_status status = AE_OK; |
571 | acpi_integer merged_value; | |
572 | acpi_integer current_value; | |
1da177e4 | 573 | |
b229cf92 | 574 | ACPI_FUNCTION_TRACE_U32(ex_write_with_update_rule, mask); |
1da177e4 LT |
575 | |
576 | /* Start with the new bits */ | |
577 | ||
578 | merged_value = field_value; | |
579 | ||
580 | /* If the mask is all ones, we don't need to worry about the update rule */ | |
581 | ||
582 | if (mask != ACPI_INTEGER_MAX) { | |
52fc0b02 | 583 | |
1da177e4 LT |
584 | /* Decode the update rule */ |
585 | ||
4be44fcd LB |
586 | switch (obj_desc->common_field. |
587 | field_flags & AML_FIELD_UPDATE_RULE_MASK) { | |
1da177e4 LT |
588 | case AML_FIELD_UPDATE_PRESERVE: |
589 | /* | |
590 | * Check if update rule needs to be applied (not if mask is all | |
591 | * ones) The left shift drops the bits we want to ignore. | |
592 | */ | |
4be44fcd LB |
593 | if ((~mask << (ACPI_MUL_8(sizeof(mask)) - |
594 | ACPI_MUL_8(obj_desc->common_field. | |
595 | access_byte_width))) != 0) { | |
1da177e4 LT |
596 | /* |
597 | * Read the current contents of the byte/word/dword containing | |
598 | * the field, and merge with the new field value. | |
599 | */ | |
4be44fcd LB |
600 | status = |
601 | acpi_ex_field_datum_io(obj_desc, | |
602 | field_datum_byte_offset, | |
603 | ¤t_value, | |
604 | ACPI_READ); | |
605 | if (ACPI_FAILURE(status)) { | |
606 | return_ACPI_STATUS(status); | |
1da177e4 LT |
607 | } |
608 | ||
609 | merged_value |= (current_value & ~mask); | |
610 | } | |
611 | break; | |
612 | ||
613 | case AML_FIELD_UPDATE_WRITE_AS_ONES: | |
614 | ||
615 | /* Set positions outside the field to all ones */ | |
616 | ||
617 | merged_value |= ~mask; | |
618 | break; | |
619 | ||
620 | case AML_FIELD_UPDATE_WRITE_AS_ZEROS: | |
621 | ||
622 | /* Set positions outside the field to all zeros */ | |
623 | ||
624 | merged_value &= mask; | |
625 | break; | |
626 | ||
627 | default: | |
628 | ||
b8e4d893 | 629 | ACPI_ERROR((AE_INFO, |
b229cf92 | 630 | "Unknown UpdateRule value: %X", |
b8e4d893 BM |
631 | (obj_desc->common_field. |
632 | field_flags & | |
633 | AML_FIELD_UPDATE_RULE_MASK))); | |
4be44fcd | 634 | return_ACPI_STATUS(AE_AML_OPERAND_VALUE); |
1da177e4 LT |
635 | } |
636 | } | |
637 | ||
4be44fcd | 638 | ACPI_DEBUG_PRINT((ACPI_DB_BFIELD, |
b229cf92 | 639 | "Mask %8.8X%8.8X, DatumOffset %X, Width %X, Value %8.8X%8.8X, MergedValue %8.8X%8.8X\n", |
4be44fcd LB |
640 | ACPI_FORMAT_UINT64(mask), |
641 | field_datum_byte_offset, | |
642 | obj_desc->common_field.access_byte_width, | |
643 | ACPI_FORMAT_UINT64(field_value), | |
644 | ACPI_FORMAT_UINT64(merged_value))); | |
1da177e4 LT |
645 | |
646 | /* Write the merged value */ | |
647 | ||
4be44fcd LB |
648 | status = acpi_ex_field_datum_io(obj_desc, field_datum_byte_offset, |
649 | &merged_value, ACPI_WRITE); | |
1da177e4 | 650 | |
4be44fcd | 651 | return_ACPI_STATUS(status); |
1da177e4 LT |
652 | } |
653 | ||
1da177e4 LT |
654 | /******************************************************************************* |
655 | * | |
656 | * FUNCTION: acpi_ex_extract_from_field | |
657 | * | |
658 | * PARAMETERS: obj_desc - Field to be read | |
659 | * Buffer - Where to store the field data | |
660 | * buffer_length - Length of Buffer | |
661 | * | |
662 | * RETURN: Status | |
663 | * | |
664 | * DESCRIPTION: Retrieve the current value of the given field | |
665 | * | |
666 | ******************************************************************************/ | |
667 | ||
668 | acpi_status | |
4be44fcd LB |
669 | acpi_ex_extract_from_field(union acpi_operand_object *obj_desc, |
670 | void *buffer, u32 buffer_length) | |
1da177e4 | 671 | { |
4be44fcd LB |
672 | acpi_status status; |
673 | acpi_integer raw_datum; | |
674 | acpi_integer merged_datum; | |
675 | u32 field_offset = 0; | |
676 | u32 buffer_offset = 0; | |
677 | u32 buffer_tail_bits; | |
678 | u32 datum_count; | |
679 | u32 field_datum_count; | |
680 | u32 i; | |
681 | ||
b229cf92 | 682 | ACPI_FUNCTION_TRACE(ex_extract_from_field); |
1da177e4 LT |
683 | |
684 | /* Validate target buffer and clear it */ | |
685 | ||
4be44fcd LB |
686 | if (buffer_length < |
687 | ACPI_ROUND_BITS_UP_TO_BYTES(obj_desc->common_field.bit_length)) { | |
b8e4d893 BM |
688 | ACPI_ERROR((AE_INFO, |
689 | "Field size %X (bits) is too large for buffer (%X)", | |
690 | obj_desc->common_field.bit_length, buffer_length)); | |
1da177e4 | 691 | |
4be44fcd | 692 | return_ACPI_STATUS(AE_BUFFER_OVERFLOW); |
1da177e4 | 693 | } |
4be44fcd | 694 | ACPI_MEMSET(buffer, 0, buffer_length); |
1da177e4 LT |
695 | |
696 | /* Compute the number of datums (access width data items) */ | |
697 | ||
4be44fcd LB |
698 | datum_count = ACPI_ROUND_UP_TO(obj_desc->common_field.bit_length, |
699 | obj_desc->common_field.access_bit_width); | |
700 | field_datum_count = ACPI_ROUND_UP_TO(obj_desc->common_field.bit_length + | |
701 | obj_desc->common_field. | |
702 | start_field_bit_offset, | |
703 | obj_desc->common_field. | |
704 | access_bit_width); | |
1da177e4 LT |
705 | |
706 | /* Priming read from the field */ | |
707 | ||
4be44fcd LB |
708 | status = |
709 | acpi_ex_field_datum_io(obj_desc, field_offset, &raw_datum, | |
710 | ACPI_READ); | |
711 | if (ACPI_FAILURE(status)) { | |
712 | return_ACPI_STATUS(status); | |
1da177e4 | 713 | } |
4be44fcd LB |
714 | merged_datum = |
715 | raw_datum >> obj_desc->common_field.start_field_bit_offset; | |
1da177e4 LT |
716 | |
717 | /* Read the rest of the field */ | |
718 | ||
719 | for (i = 1; i < field_datum_count; i++) { | |
52fc0b02 | 720 | |
1da177e4 LT |
721 | /* Get next input datum from the field */ |
722 | ||
723 | field_offset += obj_desc->common_field.access_byte_width; | |
4be44fcd LB |
724 | status = acpi_ex_field_datum_io(obj_desc, field_offset, |
725 | &raw_datum, ACPI_READ); | |
726 | if (ACPI_FAILURE(status)) { | |
727 | return_ACPI_STATUS(status); | |
1da177e4 LT |
728 | } |
729 | ||
730 | /* Merge with previous datum if necessary */ | |
731 | ||
732 | merged_datum |= raw_datum << | |
4be44fcd LB |
733 | (obj_desc->common_field.access_bit_width - |
734 | obj_desc->common_field.start_field_bit_offset); | |
1da177e4 LT |
735 | |
736 | if (i == datum_count) { | |
737 | break; | |
738 | } | |
739 | ||
740 | /* Write merged datum to target buffer */ | |
741 | ||
4be44fcd LB |
742 | ACPI_MEMCPY(((char *)buffer) + buffer_offset, &merged_datum, |
743 | ACPI_MIN(obj_desc->common_field.access_byte_width, | |
744 | buffer_length - buffer_offset)); | |
1da177e4 LT |
745 | |
746 | buffer_offset += obj_desc->common_field.access_byte_width; | |
4be44fcd LB |
747 | merged_datum = |
748 | raw_datum >> obj_desc->common_field.start_field_bit_offset; | |
1da177e4 LT |
749 | } |
750 | ||
751 | /* Mask off any extra bits in the last datum */ | |
752 | ||
44f6c012 | 753 | buffer_tail_bits = obj_desc->common_field.bit_length % |
4be44fcd | 754 | obj_desc->common_field.access_bit_width; |
1da177e4 | 755 | if (buffer_tail_bits) { |
4be44fcd | 756 | merged_datum &= ACPI_MASK_BITS_ABOVE(buffer_tail_bits); |
1da177e4 LT |
757 | } |
758 | ||
759 | /* Write the last datum to the buffer */ | |
760 | ||
4be44fcd LB |
761 | ACPI_MEMCPY(((char *)buffer) + buffer_offset, &merged_datum, |
762 | ACPI_MIN(obj_desc->common_field.access_byte_width, | |
763 | buffer_length - buffer_offset)); | |
1da177e4 | 764 | |
4be44fcd | 765 | return_ACPI_STATUS(AE_OK); |
1da177e4 LT |
766 | } |
767 | ||
1da177e4 LT |
768 | /******************************************************************************* |
769 | * | |
770 | * FUNCTION: acpi_ex_insert_into_field | |
771 | * | |
772 | * PARAMETERS: obj_desc - Field to be written | |
773 | * Buffer - Data to be written | |
774 | * buffer_length - Length of Buffer | |
775 | * | |
776 | * RETURN: Status | |
777 | * | |
778 | * DESCRIPTION: Store the Buffer contents into the given field | |
779 | * | |
780 | ******************************************************************************/ | |
781 | ||
782 | acpi_status | |
4be44fcd LB |
783 | acpi_ex_insert_into_field(union acpi_operand_object *obj_desc, |
784 | void *buffer, u32 buffer_length) | |
1da177e4 | 785 | { |
4be44fcd LB |
786 | acpi_status status; |
787 | acpi_integer mask; | |
788 | acpi_integer merged_datum; | |
789 | acpi_integer raw_datum = 0; | |
790 | u32 field_offset = 0; | |
791 | u32 buffer_offset = 0; | |
792 | u32 buffer_tail_bits; | |
793 | u32 datum_count; | |
794 | u32 field_datum_count; | |
795 | u32 i; | |
796 | ||
b229cf92 | 797 | ACPI_FUNCTION_TRACE(ex_insert_into_field); |
1da177e4 LT |
798 | |
799 | /* Validate input buffer */ | |
800 | ||
4be44fcd LB |
801 | if (buffer_length < |
802 | ACPI_ROUND_BITS_UP_TO_BYTES(obj_desc->common_field.bit_length)) { | |
b8e4d893 BM |
803 | ACPI_ERROR((AE_INFO, |
804 | "Field size %X (bits) is too large for buffer (%X)", | |
805 | obj_desc->common_field.bit_length, buffer_length)); | |
1da177e4 | 806 | |
4be44fcd | 807 | return_ACPI_STATUS(AE_BUFFER_OVERFLOW); |
1da177e4 LT |
808 | } |
809 | ||
810 | /* Compute the number of datums (access width data items) */ | |
811 | ||
4be44fcd LB |
812 | mask = |
813 | ACPI_MASK_BITS_BELOW(obj_desc->common_field.start_field_bit_offset); | |
814 | datum_count = | |
815 | ACPI_ROUND_UP_TO(obj_desc->common_field.bit_length, | |
816 | obj_desc->common_field.access_bit_width); | |
817 | field_datum_count = | |
818 | ACPI_ROUND_UP_TO(obj_desc->common_field.bit_length + | |
819 | obj_desc->common_field.start_field_bit_offset, | |
820 | obj_desc->common_field.access_bit_width); | |
1da177e4 LT |
821 | |
822 | /* Get initial Datum from the input buffer */ | |
823 | ||
4be44fcd LB |
824 | ACPI_MEMCPY(&raw_datum, buffer, |
825 | ACPI_MIN(obj_desc->common_field.access_byte_width, | |
826 | buffer_length - buffer_offset)); | |
1da177e4 | 827 | |
4be44fcd LB |
828 | merged_datum = |
829 | raw_datum << obj_desc->common_field.start_field_bit_offset; | |
1da177e4 LT |
830 | |
831 | /* Write the entire field */ | |
832 | ||
833 | for (i = 1; i < field_datum_count; i++) { | |
52fc0b02 | 834 | |
1da177e4 LT |
835 | /* Write merged datum to the target field */ |
836 | ||
837 | merged_datum &= mask; | |
4be44fcd LB |
838 | status = acpi_ex_write_with_update_rule(obj_desc, mask, |
839 | merged_datum, | |
840 | field_offset); | |
841 | if (ACPI_FAILURE(status)) { | |
842 | return_ACPI_STATUS(status); | |
1da177e4 LT |
843 | } |
844 | ||
845 | /* Start new output datum by merging with previous input datum */ | |
846 | ||
847 | field_offset += obj_desc->common_field.access_byte_width; | |
848 | merged_datum = raw_datum >> | |
4be44fcd LB |
849 | (obj_desc->common_field.access_bit_width - |
850 | obj_desc->common_field.start_field_bit_offset); | |
1da177e4 LT |
851 | mask = ACPI_INTEGER_MAX; |
852 | ||
853 | if (i == datum_count) { | |
854 | break; | |
855 | } | |
856 | ||
857 | /* Get the next input datum from the buffer */ | |
858 | ||
859 | buffer_offset += obj_desc->common_field.access_byte_width; | |
4be44fcd LB |
860 | ACPI_MEMCPY(&raw_datum, ((char *)buffer) + buffer_offset, |
861 | ACPI_MIN(obj_desc->common_field.access_byte_width, | |
862 | buffer_length - buffer_offset)); | |
863 | merged_datum |= | |
864 | raw_datum << obj_desc->common_field.start_field_bit_offset; | |
1da177e4 LT |
865 | } |
866 | ||
867 | /* Mask off any extra bits in the last datum */ | |
868 | ||
869 | buffer_tail_bits = (obj_desc->common_field.bit_length + | |
4be44fcd LB |
870 | obj_desc->common_field.start_field_bit_offset) % |
871 | obj_desc->common_field.access_bit_width; | |
1da177e4 | 872 | if (buffer_tail_bits) { |
4be44fcd | 873 | mask &= ACPI_MASK_BITS_ABOVE(buffer_tail_bits); |
1da177e4 LT |
874 | } |
875 | ||
876 | /* Write the last datum to the field */ | |
877 | ||
878 | merged_datum &= mask; | |
4be44fcd LB |
879 | status = acpi_ex_write_with_update_rule(obj_desc, |
880 | mask, merged_datum, | |
881 | field_offset); | |
1da177e4 | 882 | |
4be44fcd | 883 | return_ACPI_STATUS(status); |
1da177e4 | 884 | } |