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