1 /******************************************************************************
3 * Module Name: exfldio - Aml Field I/O
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2013, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
44 #include <acpi/acpi.h>
51 #define _COMPONENT ACPI_EXECUTER
52 ACPI_MODULE_NAME("exfldio")
54 /* Local prototypes */
56 acpi_ex_field_datum_io(union acpi_operand_object
*obj_desc
,
57 u32 field_datum_byte_offset
, u64
*value
, u32 read_write
);
60 acpi_ex_register_overflow(union acpi_operand_object
*obj_desc
, u64 value
);
63 acpi_ex_setup_region(union acpi_operand_object
*obj_desc
,
64 u32 field_datum_byte_offset
);
66 /*******************************************************************************
68 * FUNCTION: acpi_ex_setup_region
70 * PARAMETERS: obj_desc - Field to be read or written
71 * field_datum_byte_offset - Byte offset of this datum within the
76 * DESCRIPTION: Common processing for acpi_ex_extract_from_field and
77 * acpi_ex_insert_into_field. Initialize the Region if necessary and
78 * validate the request.
80 ******************************************************************************/
83 acpi_ex_setup_region(union acpi_operand_object
*obj_desc
,
84 u32 field_datum_byte_offset
)
86 acpi_status status
= AE_OK
;
87 union acpi_operand_object
*rgn_desc
;
90 ACPI_FUNCTION_TRACE_U32(ex_setup_region
, field_datum_byte_offset
);
92 rgn_desc
= obj_desc
->common_field
.region_obj
;
94 /* We must have a valid region */
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
)));
101 return_ACPI_STATUS(AE_AML_OPERAND_TYPE
);
104 space_id
= rgn_desc
->region
.space_id
;
106 /* Validate the Space ID */
108 if (!acpi_is_valid_space_id(space_id
)) {
110 "Invalid/unknown Address Space ID: 0x%2.2X",
112 return_ACPI_STATUS(AE_AML_INVALID_SPACE_ID
);
116 * If the Region Address and Length have not been previously evaluated,
117 * evaluate them now and save the results.
119 if (!(rgn_desc
->common
.flags
& AOPOBJ_DATA_VALID
)) {
120 status
= acpi_ds_get_region_arguments(rgn_desc
);
121 if (ACPI_FAILURE(status
)) {
122 return_ACPI_STATUS(status
);
126 /* Exit if Address/Length have been disallowed by the host OS */
128 if (rgn_desc
->common
.flags
& AOPOBJ_INVALID
) {
129 return_ACPI_STATUS(AE_AML_ILLEGAL_ADDRESS
);
133 * Exit now for SMBus, GSBus or IPMI address space, it has a non-linear
134 * address space and the request cannot be directly validated
136 if (space_id
== ACPI_ADR_SPACE_SMBUS
||
137 space_id
== ACPI_ADR_SPACE_GSBUS
||
138 space_id
== ACPI_ADR_SPACE_IPMI
) {
140 /* SMBus or IPMI has a non-linear address space */
142 return_ACPI_STATUS(AE_OK
);
144 #ifdef ACPI_UNDER_DEVELOPMENT
146 * If the Field access is any_acc, we can now compute the optimal
147 * access (because we know know the length of the parent region)
149 if (!(obj_desc
->common
.flags
& AOPOBJ_DATA_VALID
)) {
150 if (ACPI_FAILURE(status
)) {
151 return_ACPI_STATUS(status
);
157 * Validate the request. The entire request from the byte offset for a
158 * length of one field datum (access width) must fit within the region.
159 * (Region length is specified in bytes)
161 if (rgn_desc
->region
.length
<
162 (obj_desc
->common_field
.base_byte_offset
+ field_datum_byte_offset
+
163 obj_desc
->common_field
.access_byte_width
)) {
164 if (acpi_gbl_enable_interpreter_slack
) {
166 * Slack mode only: We will go ahead and allow access to this
167 * field if it is within the region length rounded up to the next
168 * access width boundary. acpi_size cast for 64-bit compile.
170 if (ACPI_ROUND_UP(rgn_desc
->region
.length
,
171 obj_desc
->common_field
.
172 access_byte_width
) >=
173 ((acpi_size
) obj_desc
->common_field
.
175 obj_desc
->common_field
.access_byte_width
+
176 field_datum_byte_offset
)) {
177 return_ACPI_STATUS(AE_OK
);
181 if (rgn_desc
->region
.length
<
182 obj_desc
->common_field
.access_byte_width
) {
184 * This is the case where the access_type (acc_word, etc.) is wider
185 * than the region itself. For example, a region of length one
186 * byte, and a field with Dword access specified.
189 "Field [%4.4s] access width (%u bytes) too large for region [%4.4s] (length %u)",
190 acpi_ut_get_node_name(obj_desc
->
192 obj_desc
->common_field
.access_byte_width
,
193 acpi_ut_get_node_name(rgn_desc
->region
.
195 rgn_desc
->region
.length
));
199 * Offset rounded up to next multiple of field width
200 * exceeds region length, indicate an error
203 "Field [%4.4s] Base+Offset+Width %u+%u+%u is beyond end of region [%4.4s] (length %u)",
204 acpi_ut_get_node_name(obj_desc
->common_field
.node
),
205 obj_desc
->common_field
.base_byte_offset
,
206 field_datum_byte_offset
,
207 obj_desc
->common_field
.access_byte_width
,
208 acpi_ut_get_node_name(rgn_desc
->region
.node
),
209 rgn_desc
->region
.length
));
211 return_ACPI_STATUS(AE_AML_REGION_LIMIT
);
214 return_ACPI_STATUS(AE_OK
);
217 /*******************************************************************************
219 * FUNCTION: acpi_ex_access_region
221 * PARAMETERS: obj_desc - Field to be read
222 * field_datum_byte_offset - Byte offset of this datum within the
224 * value - Where to store value (must at least
226 * function - Read or Write flag plus other region-
231 * DESCRIPTION: Read or Write a single field datum to an Operation Region.
233 ******************************************************************************/
236 acpi_ex_access_region(union acpi_operand_object
*obj_desc
,
237 u32 field_datum_byte_offset
, u64
*value
, u32 function
)
240 union acpi_operand_object
*rgn_desc
;
243 ACPI_FUNCTION_TRACE(ex_access_region
);
246 * Ensure that the region operands are fully evaluated and verify
247 * the validity of the request
249 status
= acpi_ex_setup_region(obj_desc
, field_datum_byte_offset
);
250 if (ACPI_FAILURE(status
)) {
251 return_ACPI_STATUS(status
);
255 * The physical address of this field datum is:
257 * 1) The base of the region, plus
258 * 2) The base offset of the field, plus
259 * 3) The current offset into the field
261 rgn_desc
= obj_desc
->common_field
.region_obj
;
263 obj_desc
->common_field
.base_byte_offset
+ field_datum_byte_offset
;
265 if ((function
& ACPI_IO_MASK
) == ACPI_READ
) {
266 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD
, "[READ]"));
268 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD
, "[WRITE]"));
271 ACPI_DEBUG_PRINT_RAW((ACPI_DB_BFIELD
,
272 " Region [%s:%X], Width %X, ByteBase %X, Offset %X at %8.8X%8.8X\n",
273 acpi_ut_get_region_name(rgn_desc
->region
.
275 rgn_desc
->region
.space_id
,
276 obj_desc
->common_field
.access_byte_width
,
277 obj_desc
->common_field
.base_byte_offset
,
278 field_datum_byte_offset
,
279 ACPI_FORMAT_UINT64(rgn_desc
->region
.address
+
282 /* Invoke the appropriate address_space/op_region handler */
284 status
= acpi_ev_address_space_dispatch(rgn_desc
, obj_desc
,
285 function
, region_offset
,
286 ACPI_MUL_8(obj_desc
->
291 if (ACPI_FAILURE(status
)) {
292 if (status
== AE_NOT_IMPLEMENTED
) {
294 "Region %s (ID=%u) not implemented",
295 acpi_ut_get_region_name(rgn_desc
->region
.
297 rgn_desc
->region
.space_id
));
298 } else if (status
== AE_NOT_EXIST
) {
300 "Region %s (ID=%u) has no handler",
301 acpi_ut_get_region_name(rgn_desc
->region
.
303 rgn_desc
->region
.space_id
));
307 return_ACPI_STATUS(status
);
310 /*******************************************************************************
312 * FUNCTION: acpi_ex_register_overflow
314 * PARAMETERS: obj_desc - Register(Field) to be written
315 * value - Value to be stored
317 * RETURN: TRUE if value overflows the field, FALSE otherwise
319 * DESCRIPTION: Check if a value is out of range of the field being written.
320 * Used to check if the values written to Index and Bank registers
321 * are out of range. Normally, the value is simply truncated
322 * to fit the field, but this case is most likely a serious
323 * coding error in the ASL.
325 ******************************************************************************/
328 acpi_ex_register_overflow(union acpi_operand_object
*obj_desc
, u64 value
)
331 if (obj_desc
->common_field
.bit_length
>= ACPI_INTEGER_BIT_SIZE
) {
333 * The field is large enough to hold the maximum integer, so we can
339 if (value
>= ((u64
) 1 << obj_desc
->common_field
.bit_length
)) {
341 * The Value is larger than the maximum value that can fit into
345 "Index value 0x%8.8X%8.8X overflows field width 0x%X",
346 ACPI_FORMAT_UINT64(value
),
347 obj_desc
->common_field
.bit_length
));
352 /* The Value will fit into the field with no truncation */
357 /*******************************************************************************
359 * FUNCTION: acpi_ex_field_datum_io
361 * PARAMETERS: obj_desc - Field to be read
362 * field_datum_byte_offset - Byte offset of this datum within the
364 * value - Where to store value (must be 64 bits)
365 * read_write - Read or Write flag
369 * DESCRIPTION: Read or Write a single datum of a field. The field_type is
370 * demultiplexed here to handle the different types of fields
371 * (buffer_field, region_field, index_field, bank_field)
373 ******************************************************************************/
376 acpi_ex_field_datum_io(union acpi_operand_object
*obj_desc
,
377 u32 field_datum_byte_offset
, u64
*value
, u32 read_write
)
382 ACPI_FUNCTION_TRACE_U32(ex_field_datum_io
, field_datum_byte_offset
);
384 if (read_write
== ACPI_READ
) {
388 /* To support reads without saving return value */
389 value
= &local_value
;
392 /* Clear the entire return buffer first, [Very Important!] */
398 * The four types of fields are:
400 * buffer_field - Read/write from/to a Buffer
401 * region_field - Read/write from/to a Operation Region.
402 * bank_field - Write to a Bank Register, then read/write from/to an
404 * index_field - Write to an Index Register, then read/write from/to a
407 switch (obj_desc
->common
.type
) {
408 case ACPI_TYPE_BUFFER_FIELD
:
410 * If the buffer_field arguments have not been previously evaluated,
411 * evaluate them now and save the results.
413 if (!(obj_desc
->common
.flags
& AOPOBJ_DATA_VALID
)) {
414 status
= acpi_ds_get_buffer_field_arguments(obj_desc
);
415 if (ACPI_FAILURE(status
)) {
416 return_ACPI_STATUS(status
);
420 if (read_write
== ACPI_READ
) {
422 * Copy the data from the source buffer.
423 * Length is the field width in bytes.
426 (obj_desc
->buffer_field
.buffer_obj
)->buffer
.
428 obj_desc
->buffer_field
.base_byte_offset
+
429 field_datum_byte_offset
,
430 obj_desc
->common_field
.access_byte_width
);
433 * Copy the data to the target buffer.
434 * Length is the field width in bytes.
436 ACPI_MEMCPY((obj_desc
->buffer_field
.buffer_obj
)->buffer
.
438 obj_desc
->buffer_field
.base_byte_offset
+
439 field_datum_byte_offset
, value
,
440 obj_desc
->common_field
.access_byte_width
);
446 case ACPI_TYPE_LOCAL_BANK_FIELD
:
449 * Ensure that the bank_value is not beyond the capacity of
452 if (acpi_ex_register_overflow(obj_desc
->bank_field
.bank_obj
,
453 (u64
) obj_desc
->bank_field
.
455 return_ACPI_STATUS(AE_AML_REGISTER_LIMIT
);
459 * For bank_fields, we must write the bank_value to the bank_register
460 * (itself a region_field) before we can access the data.
463 acpi_ex_insert_into_field(obj_desc
->bank_field
.bank_obj
,
464 &obj_desc
->bank_field
.value
,
465 sizeof(obj_desc
->bank_field
.
467 if (ACPI_FAILURE(status
)) {
468 return_ACPI_STATUS(status
);
472 * Now that the Bank has been selected, fall through to the
473 * region_field case and write the datum to the Operation Region
476 /*lint -fallthrough */
478 case ACPI_TYPE_LOCAL_REGION_FIELD
:
480 * For simple region_fields, we just directly access the owning
484 acpi_ex_access_region(obj_desc
, field_datum_byte_offset
,
488 case ACPI_TYPE_LOCAL_INDEX_FIELD
:
491 * Ensure that the index_value is not beyond the capacity of
494 if (acpi_ex_register_overflow(obj_desc
->index_field
.index_obj
,
495 (u64
) obj_desc
->index_field
.
497 return_ACPI_STATUS(AE_AML_REGISTER_LIMIT
);
500 /* Write the index value to the index_register (itself a region_field) */
502 field_datum_byte_offset
+= obj_desc
->index_field
.value
;
504 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD
,
505 "Write to Index Register: Value %8.8X\n",
506 field_datum_byte_offset
));
509 acpi_ex_insert_into_field(obj_desc
->index_field
.index_obj
,
510 &field_datum_byte_offset
,
511 sizeof(field_datum_byte_offset
));
512 if (ACPI_FAILURE(status
)) {
513 return_ACPI_STATUS(status
);
516 if (read_write
== ACPI_READ
) {
518 /* Read the datum from the data_register */
520 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD
,
521 "Read from Data Register\n"));
524 acpi_ex_extract_from_field(obj_desc
->index_field
.
528 /* Write the datum to the data_register */
530 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD
,
531 "Write to Data Register: Value %8.8X%8.8X\n",
532 ACPI_FORMAT_UINT64(*value
)));
535 acpi_ex_insert_into_field(obj_desc
->index_field
.
543 ACPI_ERROR((AE_INFO
, "Wrong object type in field I/O %u",
544 obj_desc
->common
.type
));
545 status
= AE_AML_INTERNAL
;
549 if (ACPI_SUCCESS(status
)) {
550 if (read_write
== ACPI_READ
) {
551 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD
,
552 "Value Read %8.8X%8.8X, Width %u\n",
553 ACPI_FORMAT_UINT64(*value
),
554 obj_desc
->common_field
.
557 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD
,
558 "Value Written %8.8X%8.8X, Width %u\n",
559 ACPI_FORMAT_UINT64(*value
),
560 obj_desc
->common_field
.
565 return_ACPI_STATUS(status
);
568 /*******************************************************************************
570 * FUNCTION: acpi_ex_write_with_update_rule
572 * PARAMETERS: obj_desc - Field to be written
573 * mask - bitmask within field datum
574 * field_value - Value to write
575 * field_datum_byte_offset - Offset of datum within field
579 * DESCRIPTION: Apply the field update rule to a field write
581 ******************************************************************************/
584 acpi_ex_write_with_update_rule(union acpi_operand_object
*obj_desc
,
586 u64 field_value
, u32 field_datum_byte_offset
)
588 acpi_status status
= AE_OK
;
592 ACPI_FUNCTION_TRACE_U32(ex_write_with_update_rule
, mask
);
594 /* Start with the new bits */
596 merged_value
= field_value
;
598 /* If the mask is all ones, we don't need to worry about the update rule */
600 if (mask
!= ACPI_UINT64_MAX
) {
602 /* Decode the update rule */
604 switch (obj_desc
->common_field
.
605 field_flags
& AML_FIELD_UPDATE_RULE_MASK
) {
606 case AML_FIELD_UPDATE_PRESERVE
:
608 * Check if update rule needs to be applied (not if mask is all
609 * ones) The left shift drops the bits we want to ignore.
611 if ((~mask
<< (ACPI_MUL_8(sizeof(mask
)) -
612 ACPI_MUL_8(obj_desc
->common_field
.
613 access_byte_width
))) != 0) {
615 * Read the current contents of the byte/word/dword containing
616 * the field, and merge with the new field value.
619 acpi_ex_field_datum_io(obj_desc
,
620 field_datum_byte_offset
,
623 if (ACPI_FAILURE(status
)) {
624 return_ACPI_STATUS(status
);
627 merged_value
|= (current_value
& ~mask
);
631 case AML_FIELD_UPDATE_WRITE_AS_ONES
:
633 /* Set positions outside the field to all ones */
635 merged_value
|= ~mask
;
638 case AML_FIELD_UPDATE_WRITE_AS_ZEROS
:
640 /* Set positions outside the field to all zeros */
642 merged_value
&= mask
;
648 "Unknown UpdateRule value: 0x%X",
649 (obj_desc
->common_field
.
651 AML_FIELD_UPDATE_RULE_MASK
)));
652 return_ACPI_STATUS(AE_AML_OPERAND_VALUE
);
656 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD
,
657 "Mask %8.8X%8.8X, DatumOffset %X, Width %X, Value %8.8X%8.8X, MergedValue %8.8X%8.8X\n",
658 ACPI_FORMAT_UINT64(mask
),
659 field_datum_byte_offset
,
660 obj_desc
->common_field
.access_byte_width
,
661 ACPI_FORMAT_UINT64(field_value
),
662 ACPI_FORMAT_UINT64(merged_value
)));
664 /* Write the merged value */
666 status
= acpi_ex_field_datum_io(obj_desc
, field_datum_byte_offset
,
667 &merged_value
, ACPI_WRITE
);
669 return_ACPI_STATUS(status
);
672 /*******************************************************************************
674 * FUNCTION: acpi_ex_extract_from_field
676 * PARAMETERS: obj_desc - Field to be read
677 * buffer - Where to store the field data
678 * buffer_length - Length of Buffer
682 * DESCRIPTION: Retrieve the current value of the given field
684 ******************************************************************************/
687 acpi_ex_extract_from_field(union acpi_operand_object
*obj_desc
,
688 void *buffer
, u32 buffer_length
)
693 u32 field_offset
= 0;
694 u32 buffer_offset
= 0;
695 u32 buffer_tail_bits
;
697 u32 field_datum_count
;
698 u32 access_bit_width
;
701 ACPI_FUNCTION_TRACE(ex_extract_from_field
);
703 /* Validate target buffer and clear it */
706 ACPI_ROUND_BITS_UP_TO_BYTES(obj_desc
->common_field
.bit_length
)) {
708 "Field size %u (bits) is too large for buffer (%u)",
709 obj_desc
->common_field
.bit_length
, buffer_length
));
711 return_ACPI_STATUS(AE_BUFFER_OVERFLOW
);
714 ACPI_MEMSET(buffer
, 0, buffer_length
);
715 access_bit_width
= ACPI_MUL_8(obj_desc
->common_field
.access_byte_width
);
717 /* Handle the simple case here */
719 if ((obj_desc
->common_field
.start_field_bit_offset
== 0) &&
720 (obj_desc
->common_field
.bit_length
== access_bit_width
)) {
721 if (buffer_length
>= sizeof(u64
)) {
723 acpi_ex_field_datum_io(obj_desc
, 0, buffer
,
726 /* Use raw_datum (u64) to handle buffers < 64 bits */
729 acpi_ex_field_datum_io(obj_desc
, 0, &raw_datum
,
731 ACPI_MEMCPY(buffer
, &raw_datum
, buffer_length
);
734 return_ACPI_STATUS(status
);
737 /* TBD: Move to common setup code */
739 /* Field algorithm is limited to sizeof(u64), truncate if needed */
741 if (obj_desc
->common_field
.access_byte_width
> sizeof(u64
)) {
742 obj_desc
->common_field
.access_byte_width
= sizeof(u64
);
743 access_bit_width
= sizeof(u64
) * 8;
746 /* Compute the number of datums (access width data items) */
749 ACPI_ROUND_UP_TO(obj_desc
->common_field
.bit_length
,
752 field_datum_count
= ACPI_ROUND_UP_TO(obj_desc
->common_field
.bit_length
+
753 obj_desc
->common_field
.
754 start_field_bit_offset
,
757 /* Priming read from the field */
760 acpi_ex_field_datum_io(obj_desc
, field_offset
, &raw_datum
,
762 if (ACPI_FAILURE(status
)) {
763 return_ACPI_STATUS(status
);
766 raw_datum
>> obj_desc
->common_field
.start_field_bit_offset
;
768 /* Read the rest of the field */
770 for (i
= 1; i
< field_datum_count
; i
++) {
772 /* Get next input datum from the field */
774 field_offset
+= obj_desc
->common_field
.access_byte_width
;
775 status
= acpi_ex_field_datum_io(obj_desc
, field_offset
,
776 &raw_datum
, ACPI_READ
);
777 if (ACPI_FAILURE(status
)) {
778 return_ACPI_STATUS(status
);
782 * Merge with previous datum if necessary.
784 * Note: Before the shift, check if the shift value will be larger than
785 * the integer size. If so, there is no need to perform the operation.
786 * This avoids the differences in behavior between different compilers
787 * concerning shift values larger than the target data width.
789 if (access_bit_width
-
790 obj_desc
->common_field
.start_field_bit_offset
<
791 ACPI_INTEGER_BIT_SIZE
) {
793 raw_datum
<< (access_bit_width
-
794 obj_desc
->common_field
.
795 start_field_bit_offset
);
798 if (i
== datum_count
) {
802 /* Write merged datum to target buffer */
804 ACPI_MEMCPY(((char *)buffer
) + buffer_offset
, &merged_datum
,
805 ACPI_MIN(obj_desc
->common_field
.access_byte_width
,
806 buffer_length
- buffer_offset
));
808 buffer_offset
+= obj_desc
->common_field
.access_byte_width
;
810 raw_datum
>> obj_desc
->common_field
.start_field_bit_offset
;
813 /* Mask off any extra bits in the last datum */
815 buffer_tail_bits
= obj_desc
->common_field
.bit_length
% access_bit_width
;
816 if (buffer_tail_bits
) {
817 merged_datum
&= ACPI_MASK_BITS_ABOVE(buffer_tail_bits
);
820 /* Write the last datum to the buffer */
822 ACPI_MEMCPY(((char *)buffer
) + buffer_offset
, &merged_datum
,
823 ACPI_MIN(obj_desc
->common_field
.access_byte_width
,
824 buffer_length
- buffer_offset
));
826 return_ACPI_STATUS(AE_OK
);
829 /*******************************************************************************
831 * FUNCTION: acpi_ex_insert_into_field
833 * PARAMETERS: obj_desc - Field to be written
834 * buffer - Data to be written
835 * buffer_length - Length of Buffer
839 * DESCRIPTION: Store the Buffer contents into the given field
841 ******************************************************************************/
844 acpi_ex_insert_into_field(union acpi_operand_object
*obj_desc
,
845 void *buffer
, u32 buffer_length
)
853 u32 field_offset
= 0;
854 u32 buffer_offset
= 0;
855 u32 buffer_tail_bits
;
857 u32 field_datum_count
;
858 u32 access_bit_width
;
862 ACPI_FUNCTION_TRACE(ex_insert_into_field
);
864 /* Validate input buffer */
868 ACPI_ROUND_BITS_UP_TO_BYTES(obj_desc
->common_field
.bit_length
);
870 * We must have a buffer that is at least as long as the field
871 * we are writing to. This is because individual fields are
872 * indivisible and partial writes are not supported -- as per
873 * the ACPI specification.
875 if (buffer_length
< required_length
) {
877 /* We need to create a new buffer */
879 new_buffer
= ACPI_ALLOCATE_ZEROED(required_length
);
881 return_ACPI_STATUS(AE_NO_MEMORY
);
885 * Copy the original data to the new buffer, starting
886 * at Byte zero. All unused (upper) bytes of the
889 ACPI_MEMCPY((char *)new_buffer
, (char *)buffer
, buffer_length
);
891 buffer_length
= required_length
;
894 /* TBD: Move to common setup code */
896 /* Algo is limited to sizeof(u64), so cut the access_byte_width */
897 if (obj_desc
->common_field
.access_byte_width
> sizeof(u64
)) {
898 obj_desc
->common_field
.access_byte_width
= sizeof(u64
);
901 access_bit_width
= ACPI_MUL_8(obj_desc
->common_field
.access_byte_width
);
904 * Create the bitmasks used for bit insertion.
905 * Note: This if/else is used to bypass compiler differences with the
908 if (access_bit_width
== ACPI_INTEGER_BIT_SIZE
) {
909 width_mask
= ACPI_UINT64_MAX
;
911 width_mask
= ACPI_MASK_BITS_ABOVE(access_bit_width
);
915 ACPI_MASK_BITS_BELOW(obj_desc
->common_field
.start_field_bit_offset
);
917 /* Compute the number of datums (access width data items) */
919 datum_count
= ACPI_ROUND_UP_TO(obj_desc
->common_field
.bit_length
,
922 field_datum_count
= ACPI_ROUND_UP_TO(obj_desc
->common_field
.bit_length
+
923 obj_desc
->common_field
.
924 start_field_bit_offset
,
927 /* Get initial Datum from the input buffer */
929 ACPI_MEMCPY(&raw_datum
, buffer
,
930 ACPI_MIN(obj_desc
->common_field
.access_byte_width
,
931 buffer_length
- buffer_offset
));
934 raw_datum
<< obj_desc
->common_field
.start_field_bit_offset
;
936 /* Write the entire field */
938 for (i
= 1; i
< field_datum_count
; i
++) {
940 /* Write merged datum to the target field */
942 merged_datum
&= mask
;
943 status
= acpi_ex_write_with_update_rule(obj_desc
, mask
,
946 if (ACPI_FAILURE(status
)) {
950 field_offset
+= obj_desc
->common_field
.access_byte_width
;
953 * Start new output datum by merging with previous input datum
956 * Note: Before the shift, check if the shift value will be larger than
957 * the integer size. If so, there is no need to perform the operation.
958 * This avoids the differences in behavior between different compilers
959 * concerning shift values larger than the target data width.
961 if ((access_bit_width
-
962 obj_desc
->common_field
.start_field_bit_offset
) <
963 ACPI_INTEGER_BIT_SIZE
) {
965 raw_datum
>> (access_bit_width
-
966 obj_desc
->common_field
.
967 start_field_bit_offset
);
974 if (i
== datum_count
) {
978 /* Get the next input datum from the buffer */
980 buffer_offset
+= obj_desc
->common_field
.access_byte_width
;
981 ACPI_MEMCPY(&raw_datum
, ((char *)buffer
) + buffer_offset
,
982 ACPI_MIN(obj_desc
->common_field
.access_byte_width
,
983 buffer_length
- buffer_offset
));
986 raw_datum
<< obj_desc
->common_field
.start_field_bit_offset
;
989 /* Mask off any extra bits in the last datum */
991 buffer_tail_bits
= (obj_desc
->common_field
.bit_length
+
992 obj_desc
->common_field
.start_field_bit_offset
) %
994 if (buffer_tail_bits
) {
995 mask
&= ACPI_MASK_BITS_ABOVE(buffer_tail_bits
);
998 /* Write the last datum to the field */
1000 merged_datum
&= mask
;
1001 status
= acpi_ex_write_with_update_rule(obj_desc
,
1006 /* Free temporary buffer if we used one */
1009 ACPI_FREE(new_buffer
);
1011 return_ACPI_STATUS(status
);