blob: a7784152ed30b5f03d33d348593a1d4b7aa7f207 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/******************************************************************************
2 *
3 * Module Name: exfldio - Aml Field I/O
4 *
5 *****************************************************************************/
6
7/*
Bob Moore77848132012-01-12 13:27:23 +08008 * Copyright (C) 2000 - 2012, Intel Corp.
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 * 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#include <acpi/acpi.h>
Len Browne2f7a772009-01-09 00:30:03 -050045#include "accommon.h"
46#include "acinterp.h"
47#include "amlcode.h"
48#include "acevents.h"
49#include "acdispat.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070050
Linus Torvalds1da177e2005-04-16 15:20:36 -070051#define _COMPONENT ACPI_EXECUTER
Len Brown4be44fc2005-08-05 00:44:28 -040052ACPI_MODULE_NAME("exfldio")
Linus Torvalds1da177e2005-04-16 15:20:36 -070053
Robert Moore44f6c012005-04-18 22:49:35 -040054/* Local prototypes */
Robert Moore44f6c012005-04-18 22:49:35 -040055static acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040056acpi_ex_field_datum_io(union acpi_operand_object *obj_desc,
57 u32 field_datum_byte_offset,
Bob Moore5df7e6c2010-01-21 10:06:32 +080058 u64 *value, u32 read_write);
Robert Moore44f6c012005-04-18 22:49:35 -040059
60static u8
Bob Moore5df7e6c2010-01-21 10:06:32 +080061acpi_ex_register_overflow(union acpi_operand_object *obj_desc, u64 value);
Robert Moore44f6c012005-04-18 22:49:35 -040062
63static acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040064acpi_ex_setup_region(union acpi_operand_object *obj_desc,
65 u32 field_datum_byte_offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -070066
67/*******************************************************************************
68 *
69 * FUNCTION: acpi_ex_setup_region
70 *
Robert Moore44f6c012005-04-18 22:49:35 -040071 * PARAMETERS: obj_desc - Field to be read or written
Linus Torvalds1da177e2005-04-16 15:20:36 -070072 * 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
Robert Moore44f6c012005-04-18 22:49:35 -040083static acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040084acpi_ex_setup_region(union acpi_operand_object *obj_desc,
85 u32 field_datum_byte_offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -070086{
Len Brown4be44fc2005-08-05 00:44:28 -040087 acpi_status status = AE_OK;
88 union acpi_operand_object *rgn_desc;
Bob Mooreec463662011-11-30 09:35:05 +080089 u8 space_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
Bob Mooreb229cf92006-04-21 17:15:00 -040091 ACPI_FUNCTION_TRACE_U32(ex_setup_region, field_datum_byte_offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -070092
93 rgn_desc = obj_desc->common_field.region_obj;
94
95 /* We must have a valid region */
96
Bob Moore3371c192009-02-18 14:44:03 +080097 if (rgn_desc->common.type != ACPI_TYPE_REGION) {
Bob Mooref6a22b02010-03-05 17:56:40 +080098 ACPI_ERROR((AE_INFO, "Needed Region, found type 0x%X (%s)",
Bob Moore3371c192009-02-18 14:44:03 +080099 rgn_desc->common.type,
Bob Mooreb8e4d892006-01-27 16:43:00 -0500100 acpi_ut_get_object_type_name(rgn_desc)));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
Len Brown4be44fc2005-08-05 00:44:28 -0400102 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 }
104
Bob Mooreec463662011-11-30 09:35:05 +0800105 space_id = rgn_desc->region.space_id;
106
107 /* Validate the Space ID */
108
109 if (!acpi_is_valid_space_id(space_id)) {
110 ACPI_ERROR((AE_INFO,
111 "Invalid/unknown Address Space ID: 0x%2.2X",
112 space_id));
113 return_ACPI_STATUS(AE_AML_INVALID_SPACE_ID);
114 }
115
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 /*
117 * If the Region Address and Length have not been previously evaluated,
118 * evaluate them now and save the results.
119 */
120 if (!(rgn_desc->common.flags & AOPOBJ_DATA_VALID)) {
Len Brown4be44fc2005-08-05 00:44:28 -0400121 status = acpi_ds_get_region_arguments(rgn_desc);
122 if (ACPI_FAILURE(status)) {
123 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 }
125 }
126
Len Brown7cb7f452009-07-27 18:42:38 -0400127 /* Exit if Address/Length have been disallowed by the host OS */
128
129 if (rgn_desc->common.flags & AOPOBJ_INVALID) {
130 return_ACPI_STATUS(AE_AML_ILLEGAL_ADDRESS);
131 }
132
Bob Mooreb229cf92006-04-21 17:15:00 -0400133 /*
Bob Moore2da120b2011-11-16 14:14:32 +0800134 * Exit now for SMBus, GSBus or IPMI address space, it has a non-linear
Bob Moore09387b42010-08-06 09:09:33 +0800135 * address space and the request cannot be directly validated
Bob Mooreb229cf92006-04-21 17:15:00 -0400136 */
Bob Mooreec463662011-11-30 09:35:05 +0800137 if (space_id == ACPI_ADR_SPACE_SMBUS ||
Bob Moore2da120b2011-11-16 14:14:32 +0800138 space_id == ACPI_ADR_SPACE_GSBUS ||
Bob Mooreec463662011-11-30 09:35:05 +0800139 space_id == ACPI_ADR_SPACE_IPMI) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400140
Lin Ming6557a492009-06-24 11:32:04 +0800141 /* SMBus or IPMI has a non-linear address space */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142
Len Brown4be44fc2005-08-05 00:44:28 -0400143 return_ACPI_STATUS(AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145#ifdef ACPI_UNDER_DEVELOPMENT
146 /*
147 * If the Field access is any_acc, we can now compute the optimal
148 * access (because we know know the length of the parent region)
149 */
150 if (!(obj_desc->common.flags & AOPOBJ_DATA_VALID)) {
Len Brown4be44fc2005-08-05 00:44:28 -0400151 if (ACPI_FAILURE(status)) {
152 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 }
154 }
155#endif
156
157 /*
158 * Validate the request. The entire request from the byte offset for a
159 * length of one field datum (access width) must fit within the region.
160 * (Region length is specified in bytes)
161 */
Bob Moore41195322006-05-26 16:36:00 -0400162 if (rgn_desc->region.length <
Bob Moore09387b42010-08-06 09:09:33 +0800163 (obj_desc->common_field.base_byte_offset + field_datum_byte_offset +
Bob Moore41195322006-05-26 16:36:00 -0400164 obj_desc->common_field.access_byte_width)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165 if (acpi_gbl_enable_interpreter_slack) {
166 /*
167 * Slack mode only: We will go ahead and allow access to this
168 * field if it is within the region length rounded up to the next
Bob Moore67a119f2008-06-10 13:42:13 +0800169 * access width boundary. acpi_size cast for 64-bit compile.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170 */
Len Brown4be44fc2005-08-05 00:44:28 -0400171 if (ACPI_ROUND_UP(rgn_desc->region.length,
172 obj_desc->common_field.
173 access_byte_width) >=
Bob Moore67a119f2008-06-10 13:42:13 +0800174 ((acpi_size) obj_desc->common_field.
175 base_byte_offset +
176 obj_desc->common_field.access_byte_width +
177 field_datum_byte_offset)) {
Len Brown4be44fc2005-08-05 00:44:28 -0400178 return_ACPI_STATUS(AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179 }
180 }
181
Len Brown4be44fc2005-08-05 00:44:28 -0400182 if (rgn_desc->region.length <
183 obj_desc->common_field.access_byte_width) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184 /*
185 * This is the case where the access_type (acc_word, etc.) is wider
186 * than the region itself. For example, a region of length one
187 * byte, and a field with Dword access specified.
188 */
Bob Mooreb8e4d892006-01-27 16:43:00 -0500189 ACPI_ERROR((AE_INFO,
Bob Mooref6a22b02010-03-05 17:56:40 +0800190 "Field [%4.4s] access width (%u bytes) too large for region [%4.4s] (length %u)",
Bob Mooreb8e4d892006-01-27 16:43:00 -0500191 acpi_ut_get_node_name(obj_desc->
192 common_field.node),
193 obj_desc->common_field.access_byte_width,
194 acpi_ut_get_node_name(rgn_desc->region.
195 node),
196 rgn_desc->region.length));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 }
198
199 /*
200 * Offset rounded up to next multiple of field width
201 * exceeds region length, indicate an error
202 */
Bob Mooreb8e4d892006-01-27 16:43:00 -0500203 ACPI_ERROR((AE_INFO,
Bob Mooref6a22b02010-03-05 17:56:40 +0800204 "Field [%4.4s] Base+Offset+Width %u+%u+%u is beyond end of region [%4.4s] (length %u)",
Bob Mooreb8e4d892006-01-27 16:43:00 -0500205 acpi_ut_get_node_name(obj_desc->common_field.node),
206 obj_desc->common_field.base_byte_offset,
207 field_datum_byte_offset,
208 obj_desc->common_field.access_byte_width,
209 acpi_ut_get_node_name(rgn_desc->region.node),
210 rgn_desc->region.length));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211
Len Brown4be44fc2005-08-05 00:44:28 -0400212 return_ACPI_STATUS(AE_AML_REGION_LIMIT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213 }
214
Len Brown4be44fc2005-08-05 00:44:28 -0400215 return_ACPI_STATUS(AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216}
217
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218/*******************************************************************************
219 *
220 * FUNCTION: acpi_ex_access_region
221 *
Robert Moore44f6c012005-04-18 22:49:35 -0400222 * PARAMETERS: obj_desc - Field to be read
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 * field_datum_byte_offset - Byte offset of this datum within the
224 * parent field
Bob Mooreba494be2012-07-12 09:40:10 +0800225 * value - Where to store value (must at least
Bob Moore5df7e6c2010-01-21 10:06:32 +0800226 * 64 bits)
Bob Mooreba494be2012-07-12 09:40:10 +0800227 * function - Read or Write flag plus other region-
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228 * dependent flags
229 *
230 * RETURN: Status
231 *
232 * DESCRIPTION: Read or Write a single field datum to an Operation Region.
233 *
234 ******************************************************************************/
235
236acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400237acpi_ex_access_region(union acpi_operand_object *obj_desc,
Bob Moore5df7e6c2010-01-21 10:06:32 +0800238 u32 field_datum_byte_offset, u64 *value, u32 function)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239{
Len Brown4be44fc2005-08-05 00:44:28 -0400240 acpi_status status;
241 union acpi_operand_object *rgn_desc;
Bob Mooref5407af2009-05-21 10:56:52 +0800242 u32 region_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243
Bob Mooreb229cf92006-04-21 17:15:00 -0400244 ACPI_FUNCTION_TRACE(ex_access_region);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245
246 /*
247 * Ensure that the region operands are fully evaluated and verify
248 * the validity of the request
249 */
Len Brown4be44fc2005-08-05 00:44:28 -0400250 status = acpi_ex_setup_region(obj_desc, field_datum_byte_offset);
251 if (ACPI_FAILURE(status)) {
252 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253 }
254
255 /*
256 * The physical address of this field datum is:
257 *
258 * 1) The base of the region, plus
259 * 2) The base offset of the field, plus
260 * 3) The current offset into the field
261 */
262 rgn_desc = obj_desc->common_field.region_obj;
Bob Mooref5407af2009-05-21 10:56:52 +0800263 region_offset =
Len Brown4be44fc2005-08-05 00:44:28 -0400264 obj_desc->common_field.base_byte_offset + field_datum_byte_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265
266 if ((function & ACPI_IO_MASK) == ACPI_READ) {
Len Brown4be44fc2005-08-05 00:44:28 -0400267 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD, "[READ]"));
268 } else {
269 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD, "[WRITE]"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270 }
271
Len Brown4be44fc2005-08-05 00:44:28 -0400272 ACPI_DEBUG_PRINT_RAW((ACPI_DB_BFIELD,
Bob Mooref3d2e782007-02-02 19:48:18 +0300273 " Region [%s:%X], Width %X, ByteBase %X, Offset %X at %p\n",
Len Brown4be44fc2005-08-05 00:44:28 -0400274 acpi_ut_get_region_name(rgn_desc->region.
275 space_id),
276 rgn_desc->region.space_id,
277 obj_desc->common_field.access_byte_width,
278 obj_desc->common_field.base_byte_offset,
Bob Mooreb7f9f042008-04-10 19:06:40 +0400279 field_datum_byte_offset, ACPI_CAST_PTR(void,
Bob Mooref5407af2009-05-21 10:56:52 +0800280 (rgn_desc->
281 region.
282 address +
283 region_offset))));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284
285 /* Invoke the appropriate address_space/op_region handler */
286
Bob Moore9ce81782011-11-16 13:39:07 +0800287 status = acpi_ev_address_space_dispatch(rgn_desc, obj_desc,
288 function, region_offset,
289 ACPI_MUL_8(obj_desc->
290 common_field.
291 access_byte_width),
292 value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293
Len Brown4be44fc2005-08-05 00:44:28 -0400294 if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 if (status == AE_NOT_IMPLEMENTED) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500296 ACPI_ERROR((AE_INFO,
Bob Moore1b74dfb2011-02-14 15:52:56 +0800297 "Region %s (ID=%u) not implemented",
Bob Mooreb8e4d892006-01-27 16:43:00 -0500298 acpi_ut_get_region_name(rgn_desc->region.
299 space_id),
300 rgn_desc->region.space_id));
Len Brown4be44fc2005-08-05 00:44:28 -0400301 } else if (status == AE_NOT_EXIST) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500302 ACPI_ERROR((AE_INFO,
Bob Moore1b74dfb2011-02-14 15:52:56 +0800303 "Region %s (ID=%u) has no handler",
Bob Mooreb8e4d892006-01-27 16:43:00 -0500304 acpi_ut_get_region_name(rgn_desc->region.
305 space_id),
306 rgn_desc->region.space_id));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307 }
308 }
309
Len Brown4be44fc2005-08-05 00:44:28 -0400310 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311}
312
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313/*******************************************************************************
314 *
315 * FUNCTION: acpi_ex_register_overflow
316 *
Robert Moore44f6c012005-04-18 22:49:35 -0400317 * PARAMETERS: obj_desc - Register(Field) to be written
Bob Mooreba494be2012-07-12 09:40:10 +0800318 * value - Value to be stored
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 *
320 * RETURN: TRUE if value overflows the field, FALSE otherwise
321 *
322 * DESCRIPTION: Check if a value is out of range of the field being written.
323 * Used to check if the values written to Index and Bank registers
324 * are out of range. Normally, the value is simply truncated
325 * to fit the field, but this case is most likely a serious
326 * coding error in the ASL.
327 *
328 ******************************************************************************/
329
Robert Moore44f6c012005-04-18 22:49:35 -0400330static u8
Bob Moore5df7e6c2010-01-21 10:06:32 +0800331acpi_ex_register_overflow(union acpi_operand_object *obj_desc, u64 value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332{
Bob Moore46dfb092011-11-28 10:10:10 +0800333 ACPI_FUNCTION_NAME(ex_register_overflow);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334
335 if (obj_desc->common_field.bit_length >= ACPI_INTEGER_BIT_SIZE) {
336 /*
337 * The field is large enough to hold the maximum integer, so we can
338 * never overflow it.
339 */
340 return (FALSE);
341 }
342
Bob Moore5df7e6c2010-01-21 10:06:32 +0800343 if (value >= ((u64) 1 << obj_desc->common_field.bit_length)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 /*
345 * The Value is larger than the maximum value that can fit into
346 * the register.
347 */
Bob Moore46dfb092011-11-28 10:10:10 +0800348 ACPI_ERROR((AE_INFO,
349 "Index value 0x%8.8X%8.8X overflows field width 0x%X",
350 ACPI_FORMAT_UINT64(value),
351 obj_desc->common_field.bit_length));
352
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 return (TRUE);
354 }
355
356 /* The Value will fit into the field with no truncation */
357
358 return (FALSE);
359}
360
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361/*******************************************************************************
362 *
363 * FUNCTION: acpi_ex_field_datum_io
364 *
Robert Moore44f6c012005-04-18 22:49:35 -0400365 * PARAMETERS: obj_desc - Field to be read
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366 * field_datum_byte_offset - Byte offset of this datum within the
367 * parent field
Bob Mooreba494be2012-07-12 09:40:10 +0800368 * value - Where to store value (must be 64 bits)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 * read_write - Read or Write flag
370 *
371 * RETURN: Status
372 *
373 * DESCRIPTION: Read or Write a single datum of a field. The field_type is
374 * demultiplexed here to handle the different types of fields
375 * (buffer_field, region_field, index_field, bank_field)
376 *
377 ******************************************************************************/
378
Robert Moore44f6c012005-04-18 22:49:35 -0400379static acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400380acpi_ex_field_datum_io(union acpi_operand_object *obj_desc,
Bob Moore5df7e6c2010-01-21 10:06:32 +0800381 u32 field_datum_byte_offset, u64 *value, u32 read_write)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382{
Len Brown4be44fc2005-08-05 00:44:28 -0400383 acpi_status status;
Bob Moore5df7e6c2010-01-21 10:06:32 +0800384 u64 local_value;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385
Bob Mooreb229cf92006-04-21 17:15:00 -0400386 ACPI_FUNCTION_TRACE_U32(ex_field_datum_io, field_datum_byte_offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387
388 if (read_write == ACPI_READ) {
389 if (!value) {
390 local_value = 0;
Robert Moore44f6c012005-04-18 22:49:35 -0400391
392 /* To support reads without saving return value */
393 value = &local_value;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 }
395
396 /* Clear the entire return buffer first, [Very Important!] */
397
398 *value = 0;
399 }
400
401 /*
402 * The four types of fields are:
403 *
404 * buffer_field - Read/write from/to a Buffer
405 * region_field - Read/write from/to a Operation Region.
Robert Moore44f6c012005-04-18 22:49:35 -0400406 * bank_field - Write to a Bank Register, then read/write from/to an
407 * operation_region
408 * index_field - Write to an Index Register, then read/write from/to a
409 * Data Register
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 */
Bob Moore3371c192009-02-18 14:44:03 +0800411 switch (obj_desc->common.type) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412 case ACPI_TYPE_BUFFER_FIELD:
413 /*
414 * If the buffer_field arguments have not been previously evaluated,
415 * evaluate them now and save the results.
416 */
417 if (!(obj_desc->common.flags & AOPOBJ_DATA_VALID)) {
Len Brown4be44fc2005-08-05 00:44:28 -0400418 status = acpi_ds_get_buffer_field_arguments(obj_desc);
419 if (ACPI_FAILURE(status)) {
420 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 }
422 }
423
424 if (read_write == ACPI_READ) {
425 /*
426 * Copy the data from the source buffer.
427 * Length is the field width in bytes.
428 */
Len Brown4be44fc2005-08-05 00:44:28 -0400429 ACPI_MEMCPY(value,
430 (obj_desc->buffer_field.buffer_obj)->buffer.
431 pointer +
432 obj_desc->buffer_field.base_byte_offset +
433 field_datum_byte_offset,
434 obj_desc->common_field.access_byte_width);
435 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436 /*
437 * Copy the data to the target buffer.
438 * Length is the field width in bytes.
439 */
Len Brown4be44fc2005-08-05 00:44:28 -0400440 ACPI_MEMCPY((obj_desc->buffer_field.buffer_obj)->buffer.
441 pointer +
442 obj_desc->buffer_field.base_byte_offset +
443 field_datum_byte_offset, value,
444 obj_desc->common_field.access_byte_width);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445 }
446
447 status = AE_OK;
448 break;
449
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 case ACPI_TYPE_LOCAL_BANK_FIELD:
451
Robert Moore44f6c012005-04-18 22:49:35 -0400452 /*
453 * Ensure that the bank_value is not beyond the capacity of
454 * the register
455 */
Len Brown4be44fc2005-08-05 00:44:28 -0400456 if (acpi_ex_register_overflow(obj_desc->bank_field.bank_obj,
Bob Moore5df7e6c2010-01-21 10:06:32 +0800457 (u64) obj_desc->bank_field.
458 value)) {
Len Brown4be44fc2005-08-05 00:44:28 -0400459 return_ACPI_STATUS(AE_AML_REGISTER_LIMIT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460 }
461
462 /*
463 * For bank_fields, we must write the bank_value to the bank_register
464 * (itself a region_field) before we can access the data.
465 */
Len Brown4be44fc2005-08-05 00:44:28 -0400466 status =
467 acpi_ex_insert_into_field(obj_desc->bank_field.bank_obj,
468 &obj_desc->bank_field.value,
469 sizeof(obj_desc->bank_field.
470 value));
471 if (ACPI_FAILURE(status)) {
472 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 }
474
475 /*
476 * Now that the Bank has been selected, fall through to the
477 * region_field case and write the datum to the Operation Region
478 */
479
480 /*lint -fallthrough */
481
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 case ACPI_TYPE_LOCAL_REGION_FIELD:
483 /*
484 * For simple region_fields, we just directly access the owning
485 * Operation Region.
486 */
Len Brown4be44fc2005-08-05 00:44:28 -0400487 status =
488 acpi_ex_access_region(obj_desc, field_datum_byte_offset,
489 value, read_write);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490 break;
491
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 case ACPI_TYPE_LOCAL_INDEX_FIELD:
493
Robert Moore44f6c012005-04-18 22:49:35 -0400494 /*
495 * Ensure that the index_value is not beyond the capacity of
496 * the register
497 */
Len Brown4be44fc2005-08-05 00:44:28 -0400498 if (acpi_ex_register_overflow(obj_desc->index_field.index_obj,
Bob Moore5df7e6c2010-01-21 10:06:32 +0800499 (u64) obj_desc->index_field.
500 value)) {
Len Brown4be44fc2005-08-05 00:44:28 -0400501 return_ACPI_STATUS(AE_AML_REGISTER_LIMIT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 }
503
504 /* Write the index value to the index_register (itself a region_field) */
505
506 field_datum_byte_offset += obj_desc->index_field.value;
507
Len Brown4be44fc2005-08-05 00:44:28 -0400508 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
509 "Write to Index Register: Value %8.8X\n",
510 field_datum_byte_offset));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511
Len Brown4be44fc2005-08-05 00:44:28 -0400512 status =
513 acpi_ex_insert_into_field(obj_desc->index_field.index_obj,
514 &field_datum_byte_offset,
515 sizeof(field_datum_byte_offset));
516 if (ACPI_FAILURE(status)) {
517 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 }
519
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520 if (read_write == ACPI_READ) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400521
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522 /* Read the datum from the data_register */
523
Bob Mooree9a8c6a2008-11-12 15:16:49 +0800524 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
525 "Read from Data Register\n"));
526
Len Brown4be44fc2005-08-05 00:44:28 -0400527 status =
528 acpi_ex_extract_from_field(obj_desc->index_field.
529 data_obj, value,
Bob Moore5df7e6c2010-01-21 10:06:32 +0800530 sizeof(u64));
Len Brown4be44fc2005-08-05 00:44:28 -0400531 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 /* Write the datum to the data_register */
533
Bob Mooree9a8c6a2008-11-12 15:16:49 +0800534 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
535 "Write to Data Register: Value %8.8X%8.8X\n",
536 ACPI_FORMAT_UINT64(*value)));
537
Len Brown4be44fc2005-08-05 00:44:28 -0400538 status =
539 acpi_ex_insert_into_field(obj_desc->index_field.
540 data_obj, value,
Bob Moore5df7e6c2010-01-21 10:06:32 +0800541 sizeof(u64));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 }
543 break;
544
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545 default:
546
Bob Mooref6a22b02010-03-05 17:56:40 +0800547 ACPI_ERROR((AE_INFO, "Wrong object type in field I/O %u",
Bob Moore3371c192009-02-18 14:44:03 +0800548 obj_desc->common.type));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549 status = AE_AML_INTERNAL;
550 break;
551 }
552
Len Brown4be44fc2005-08-05 00:44:28 -0400553 if (ACPI_SUCCESS(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 if (read_write == ACPI_READ) {
Len Brown4be44fc2005-08-05 00:44:28 -0400555 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
Bob Mooreb27d6592010-05-26 11:47:13 +0800556 "Value Read %8.8X%8.8X, Width %u\n",
Len Brown4be44fc2005-08-05 00:44:28 -0400557 ACPI_FORMAT_UINT64(*value),
558 obj_desc->common_field.
559 access_byte_width));
560 } else {
561 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
Bob Mooreb27d6592010-05-26 11:47:13 +0800562 "Value Written %8.8X%8.8X, Width %u\n",
Len Brown4be44fc2005-08-05 00:44:28 -0400563 ACPI_FORMAT_UINT64(*value),
564 obj_desc->common_field.
565 access_byte_width));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 }
567 }
568
Len Brown4be44fc2005-08-05 00:44:28 -0400569 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570}
571
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572/*******************************************************************************
573 *
574 * FUNCTION: acpi_ex_write_with_update_rule
575 *
Robert Moore44f6c012005-04-18 22:49:35 -0400576 * PARAMETERS: obj_desc - Field to be written
Bob Mooreba494be2012-07-12 09:40:10 +0800577 * mask - bitmask within field datum
Robert Moore44f6c012005-04-18 22:49:35 -0400578 * field_value - Value to write
579 * field_datum_byte_offset - Offset of datum within field
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 *
581 * RETURN: Status
582 *
583 * DESCRIPTION: Apply the field update rule to a field write
584 *
585 ******************************************************************************/
586
587acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400588acpi_ex_write_with_update_rule(union acpi_operand_object *obj_desc,
Bob Moore5df7e6c2010-01-21 10:06:32 +0800589 u64 mask,
590 u64 field_value, u32 field_datum_byte_offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591{
Len Brown4be44fc2005-08-05 00:44:28 -0400592 acpi_status status = AE_OK;
Bob Moore5df7e6c2010-01-21 10:06:32 +0800593 u64 merged_value;
594 u64 current_value;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595
Bob Mooreb229cf92006-04-21 17:15:00 -0400596 ACPI_FUNCTION_TRACE_U32(ex_write_with_update_rule, mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597
598 /* Start with the new bits */
599
600 merged_value = field_value;
601
602 /* If the mask is all ones, we don't need to worry about the update rule */
603
Bob Moore5df7e6c2010-01-21 10:06:32 +0800604 if (mask != ACPI_UINT64_MAX) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400605
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 /* Decode the update rule */
607
Len Brown4be44fc2005-08-05 00:44:28 -0400608 switch (obj_desc->common_field.
609 field_flags & AML_FIELD_UPDATE_RULE_MASK) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610 case AML_FIELD_UPDATE_PRESERVE:
611 /*
612 * Check if update rule needs to be applied (not if mask is all
613 * ones) The left shift drops the bits we want to ignore.
614 */
Len Brown4be44fc2005-08-05 00:44:28 -0400615 if ((~mask << (ACPI_MUL_8(sizeof(mask)) -
616 ACPI_MUL_8(obj_desc->common_field.
617 access_byte_width))) != 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618 /*
619 * Read the current contents of the byte/word/dword containing
620 * the field, and merge with the new field value.
621 */
Len Brown4be44fc2005-08-05 00:44:28 -0400622 status =
623 acpi_ex_field_datum_io(obj_desc,
624 field_datum_byte_offset,
625 &current_value,
626 ACPI_READ);
627 if (ACPI_FAILURE(status)) {
628 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629 }
630
631 merged_value |= (current_value & ~mask);
632 }
633 break;
634
635 case AML_FIELD_UPDATE_WRITE_AS_ONES:
636
637 /* Set positions outside the field to all ones */
638
639 merged_value |= ~mask;
640 break;
641
642 case AML_FIELD_UPDATE_WRITE_AS_ZEROS:
643
644 /* Set positions outside the field to all zeros */
645
646 merged_value &= mask;
647 break;
648
649 default:
650
Bob Mooreb8e4d892006-01-27 16:43:00 -0500651 ACPI_ERROR((AE_INFO,
Bob Mooref6a22b02010-03-05 17:56:40 +0800652 "Unknown UpdateRule value: 0x%X",
Bob Mooreb8e4d892006-01-27 16:43:00 -0500653 (obj_desc->common_field.
654 field_flags &
655 AML_FIELD_UPDATE_RULE_MASK)));
Len Brown4be44fc2005-08-05 00:44:28 -0400656 return_ACPI_STATUS(AE_AML_OPERAND_VALUE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 }
658 }
659
Len Brown4be44fc2005-08-05 00:44:28 -0400660 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
Bob Mooreb229cf92006-04-21 17:15:00 -0400661 "Mask %8.8X%8.8X, DatumOffset %X, Width %X, Value %8.8X%8.8X, MergedValue %8.8X%8.8X\n",
Len Brown4be44fc2005-08-05 00:44:28 -0400662 ACPI_FORMAT_UINT64(mask),
663 field_datum_byte_offset,
664 obj_desc->common_field.access_byte_width,
665 ACPI_FORMAT_UINT64(field_value),
666 ACPI_FORMAT_UINT64(merged_value)));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667
668 /* Write the merged value */
669
Len Brown4be44fc2005-08-05 00:44:28 -0400670 status = acpi_ex_field_datum_io(obj_desc, field_datum_byte_offset,
671 &merged_value, ACPI_WRITE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672
Len Brown4be44fc2005-08-05 00:44:28 -0400673 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674}
675
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676/*******************************************************************************
677 *
678 * FUNCTION: acpi_ex_extract_from_field
679 *
680 * PARAMETERS: obj_desc - Field to be read
Bob Mooreba494be2012-07-12 09:40:10 +0800681 * buffer - Where to store the field data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 * buffer_length - Length of Buffer
683 *
684 * RETURN: Status
685 *
686 * DESCRIPTION: Retrieve the current value of the given field
687 *
688 ******************************************************************************/
689
690acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400691acpi_ex_extract_from_field(union acpi_operand_object *obj_desc,
692 void *buffer, u32 buffer_length)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693{
Len Brown4be44fc2005-08-05 00:44:28 -0400694 acpi_status status;
Bob Moore5df7e6c2010-01-21 10:06:32 +0800695 u64 raw_datum;
696 u64 merged_datum;
Len Brown4be44fc2005-08-05 00:44:28 -0400697 u32 field_offset = 0;
698 u32 buffer_offset = 0;
699 u32 buffer_tail_bits;
700 u32 datum_count;
701 u32 field_datum_count;
Bob Moore09387b42010-08-06 09:09:33 +0800702 u32 access_bit_width;
Len Brown4be44fc2005-08-05 00:44:28 -0400703 u32 i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704
Bob Mooreb229cf92006-04-21 17:15:00 -0400705 ACPI_FUNCTION_TRACE(ex_extract_from_field);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706
707 /* Validate target buffer and clear it */
708
Len Brown4be44fc2005-08-05 00:44:28 -0400709 if (buffer_length <
710 ACPI_ROUND_BITS_UP_TO_BYTES(obj_desc->common_field.bit_length)) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500711 ACPI_ERROR((AE_INFO,
Bob Mooref6a22b02010-03-05 17:56:40 +0800712 "Field size %u (bits) is too large for buffer (%u)",
Bob Mooreb8e4d892006-01-27 16:43:00 -0500713 obj_desc->common_field.bit_length, buffer_length));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714
Len Brown4be44fc2005-08-05 00:44:28 -0400715 return_ACPI_STATUS(AE_BUFFER_OVERFLOW);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716 }
Bob Moore09387b42010-08-06 09:09:33 +0800717
Len Brown4be44fc2005-08-05 00:44:28 -0400718 ACPI_MEMSET(buffer, 0, buffer_length);
Bob Moore09387b42010-08-06 09:09:33 +0800719 access_bit_width = ACPI_MUL_8(obj_desc->common_field.access_byte_width);
720
721 /* Handle the simple case here */
722
723 if ((obj_desc->common_field.start_field_bit_offset == 0) &&
724 (obj_desc->common_field.bit_length == access_bit_width)) {
725 status = acpi_ex_field_datum_io(obj_desc, 0, buffer, ACPI_READ);
726 return_ACPI_STATUS(status);
727 }
728
729/* TBD: Move to common setup code */
730
731 /* Field algorithm is limited to sizeof(u64), truncate if needed */
732
733 if (obj_desc->common_field.access_byte_width > sizeof(u64)) {
734 obj_desc->common_field.access_byte_width = sizeof(u64);
735 access_bit_width = sizeof(u64) * 8;
736 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737
738 /* Compute the number of datums (access width data items) */
739
Bob Moore09387b42010-08-06 09:09:33 +0800740 datum_count =
741 ACPI_ROUND_UP_TO(obj_desc->common_field.bit_length,
742 access_bit_width);
743
Len Brown4be44fc2005-08-05 00:44:28 -0400744 field_datum_count = ACPI_ROUND_UP_TO(obj_desc->common_field.bit_length +
745 obj_desc->common_field.
746 start_field_bit_offset,
Len Brown4be44fc2005-08-05 00:44:28 -0400747 access_bit_width);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748
749 /* Priming read from the field */
750
Len Brown4be44fc2005-08-05 00:44:28 -0400751 status =
752 acpi_ex_field_datum_io(obj_desc, field_offset, &raw_datum,
753 ACPI_READ);
754 if (ACPI_FAILURE(status)) {
755 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 }
Len Brown4be44fc2005-08-05 00:44:28 -0400757 merged_datum =
758 raw_datum >> obj_desc->common_field.start_field_bit_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759
760 /* Read the rest of the field */
761
762 for (i = 1; i < field_datum_count; i++) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400763
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764 /* Get next input datum from the field */
765
766 field_offset += obj_desc->common_field.access_byte_width;
Len Brown4be44fc2005-08-05 00:44:28 -0400767 status = acpi_ex_field_datum_io(obj_desc, field_offset,
768 &raw_datum, ACPI_READ);
769 if (ACPI_FAILURE(status)) {
770 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771 }
772
Bob Moore967440e32006-06-23 17:04:00 -0400773 /*
774 * Merge with previous datum if necessary.
775 *
776 * Note: Before the shift, check if the shift value will be larger than
777 * the integer size. If so, there is no need to perform the operation.
778 * This avoids the differences in behavior between different compilers
779 * concerning shift values larger than the target data width.
780 */
Bob Moore09387b42010-08-06 09:09:33 +0800781 if (access_bit_width -
782 obj_desc->common_field.start_field_bit_offset <
Bob Moore967440e32006-06-23 17:04:00 -0400783 ACPI_INTEGER_BIT_SIZE) {
784 merged_datum |=
Bob Moore09387b42010-08-06 09:09:33 +0800785 raw_datum << (access_bit_width -
Bob Moore967440e32006-06-23 17:04:00 -0400786 obj_desc->common_field.
787 start_field_bit_offset);
788 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789
790 if (i == datum_count) {
791 break;
792 }
793
794 /* Write merged datum to target buffer */
795
Len Brown4be44fc2005-08-05 00:44:28 -0400796 ACPI_MEMCPY(((char *)buffer) + buffer_offset, &merged_datum,
797 ACPI_MIN(obj_desc->common_field.access_byte_width,
798 buffer_length - buffer_offset));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799
800 buffer_offset += obj_desc->common_field.access_byte_width;
Len Brown4be44fc2005-08-05 00:44:28 -0400801 merged_datum =
802 raw_datum >> obj_desc->common_field.start_field_bit_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803 }
804
805 /* Mask off any extra bits in the last datum */
806
Bob Moore09387b42010-08-06 09:09:33 +0800807 buffer_tail_bits = obj_desc->common_field.bit_length % access_bit_width;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808 if (buffer_tail_bits) {
Len Brown4be44fc2005-08-05 00:44:28 -0400809 merged_datum &= ACPI_MASK_BITS_ABOVE(buffer_tail_bits);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810 }
811
812 /* Write the last datum to the buffer */
813
Len Brown4be44fc2005-08-05 00:44:28 -0400814 ACPI_MEMCPY(((char *)buffer) + buffer_offset, &merged_datum,
815 ACPI_MIN(obj_desc->common_field.access_byte_width,
816 buffer_length - buffer_offset));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817
Len Brown4be44fc2005-08-05 00:44:28 -0400818 return_ACPI_STATUS(AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819}
820
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821/*******************************************************************************
822 *
823 * FUNCTION: acpi_ex_insert_into_field
824 *
825 * PARAMETERS: obj_desc - Field to be written
Bob Mooreba494be2012-07-12 09:40:10 +0800826 * buffer - Data to be written
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 * buffer_length - Length of Buffer
828 *
829 * RETURN: Status
830 *
831 * DESCRIPTION: Store the Buffer contents into the given field
832 *
833 ******************************************************************************/
834
835acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400836acpi_ex_insert_into_field(union acpi_operand_object *obj_desc,
837 void *buffer, u32 buffer_length)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838{
Bob Moore09387b42010-08-06 09:09:33 +0800839 void *new_buffer;
Len Brown4be44fc2005-08-05 00:44:28 -0400840 acpi_status status;
Bob Moore5df7e6c2010-01-21 10:06:32 +0800841 u64 mask;
842 u64 width_mask;
843 u64 merged_datum;
844 u64 raw_datum = 0;
Len Brown4be44fc2005-08-05 00:44:28 -0400845 u32 field_offset = 0;
846 u32 buffer_offset = 0;
847 u32 buffer_tail_bits;
848 u32 datum_count;
849 u32 field_datum_count;
Bob Moore09387b42010-08-06 09:09:33 +0800850 u32 access_bit_width;
Bob Moore9aa61692008-04-10 19:06:41 +0400851 u32 required_length;
Bob Moore09387b42010-08-06 09:09:33 +0800852 u32 i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853
Bob Mooreb229cf92006-04-21 17:15:00 -0400854 ACPI_FUNCTION_TRACE(ex_insert_into_field);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855
856 /* Validate input buffer */
857
Bob Moore9aa61692008-04-10 19:06:41 +0400858 new_buffer = NULL;
859 required_length =
860 ACPI_ROUND_BITS_UP_TO_BYTES(obj_desc->common_field.bit_length);
861 /*
862 * We must have a buffer that is at least as long as the field
863 * we are writing to. This is because individual fields are
864 * indivisible and partial writes are not supported -- as per
865 * the ACPI specification.
866 */
867 if (buffer_length < required_length) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868
Bob Moore9aa61692008-04-10 19:06:41 +0400869 /* We need to create a new buffer */
870
871 new_buffer = ACPI_ALLOCATE_ZEROED(required_length);
872 if (!new_buffer) {
873 return_ACPI_STATUS(AE_NO_MEMORY);
874 }
875
876 /*
877 * Copy the original data to the new buffer, starting
878 * at Byte zero. All unused (upper) bytes of the
879 * buffer will be 0.
880 */
881 ACPI_MEMCPY((char *)new_buffer, (char *)buffer, buffer_length);
882 buffer = new_buffer;
883 buffer_length = required_length;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884 }
885
Bob Moore09387b42010-08-06 09:09:33 +0800886/* TBD: Move to common setup code */
887
888 /* Algo is limited to sizeof(u64), so cut the access_byte_width */
889 if (obj_desc->common_field.access_byte_width > sizeof(u64)) {
890 obj_desc->common_field.access_byte_width = sizeof(u64);
891 }
892
893 access_bit_width = ACPI_MUL_8(obj_desc->common_field.access_byte_width);
894
Bob Moore967440e32006-06-23 17:04:00 -0400895 /*
896 * Create the bitmasks used for bit insertion.
897 * Note: This if/else is used to bypass compiler differences with the
898 * shift operator
899 */
Bob Moore09387b42010-08-06 09:09:33 +0800900 if (access_bit_width == ACPI_INTEGER_BIT_SIZE) {
Bob Moore5df7e6c2010-01-21 10:06:32 +0800901 width_mask = ACPI_UINT64_MAX;
Bob Moore967440e32006-06-23 17:04:00 -0400902 } else {
Bob Moore09387b42010-08-06 09:09:33 +0800903 width_mask = ACPI_MASK_BITS_ABOVE(access_bit_width);
Bob Moore967440e32006-06-23 17:04:00 -0400904 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905
Bob Moore967440e32006-06-23 17:04:00 -0400906 mask = width_mask &
907 ACPI_MASK_BITS_BELOW(obj_desc->common_field.start_field_bit_offset);
908
909 /* Compute the number of datums (access width data items) */
Bob Moore41195322006-05-26 16:36:00 -0400910
911 datum_count = ACPI_ROUND_UP_TO(obj_desc->common_field.bit_length,
Bob Moore09387b42010-08-06 09:09:33 +0800912 access_bit_width);
Bob Moore41195322006-05-26 16:36:00 -0400913
914 field_datum_count = ACPI_ROUND_UP_TO(obj_desc->common_field.bit_length +
915 obj_desc->common_field.
916 start_field_bit_offset,
Bob Moore41195322006-05-26 16:36:00 -0400917 access_bit_width);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918
919 /* Get initial Datum from the input buffer */
920
Len Brown4be44fc2005-08-05 00:44:28 -0400921 ACPI_MEMCPY(&raw_datum, buffer,
922 ACPI_MIN(obj_desc->common_field.access_byte_width,
923 buffer_length - buffer_offset));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924
Len Brown4be44fc2005-08-05 00:44:28 -0400925 merged_datum =
926 raw_datum << obj_desc->common_field.start_field_bit_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927
928 /* Write the entire field */
929
930 for (i = 1; i < field_datum_count; i++) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400931
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932 /* Write merged datum to the target field */
933
934 merged_datum &= mask;
Len Brown4be44fc2005-08-05 00:44:28 -0400935 status = acpi_ex_write_with_update_rule(obj_desc, mask,
936 merged_datum,
937 field_offset);
938 if (ACPI_FAILURE(status)) {
Bob Moore9aa61692008-04-10 19:06:41 +0400939 goto exit;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940 }
941
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942 field_offset += obj_desc->common_field.access_byte_width;
Bob Moore967440e32006-06-23 17:04:00 -0400943
944 /*
945 * Start new output datum by merging with previous input datum
946 * if necessary.
947 *
948 * Note: Before the shift, check if the shift value will be larger than
949 * the integer size. If so, there is no need to perform the operation.
950 * This avoids the differences in behavior between different compilers
951 * concerning shift values larger than the target data width.
952 */
Bob Moore09387b42010-08-06 09:09:33 +0800953 if ((access_bit_width -
Bob Moore967440e32006-06-23 17:04:00 -0400954 obj_desc->common_field.start_field_bit_offset) <
955 ACPI_INTEGER_BIT_SIZE) {
956 merged_datum =
Bob Moore09387b42010-08-06 09:09:33 +0800957 raw_datum >> (access_bit_width -
Bob Moore967440e32006-06-23 17:04:00 -0400958 obj_desc->common_field.
959 start_field_bit_offset);
960 } else {
961 merged_datum = 0;
962 }
963
Bob Moore4c90ece2006-06-08 16:29:00 -0400964 mask = width_mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965
966 if (i == datum_count) {
967 break;
968 }
969
970 /* Get the next input datum from the buffer */
971
972 buffer_offset += obj_desc->common_field.access_byte_width;
Len Brown4be44fc2005-08-05 00:44:28 -0400973 ACPI_MEMCPY(&raw_datum, ((char *)buffer) + buffer_offset,
974 ACPI_MIN(obj_desc->common_field.access_byte_width,
975 buffer_length - buffer_offset));
Bob Moore09387b42010-08-06 09:09:33 +0800976
Len Brown4be44fc2005-08-05 00:44:28 -0400977 merged_datum |=
978 raw_datum << obj_desc->common_field.start_field_bit_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979 }
980
981 /* Mask off any extra bits in the last datum */
982
983 buffer_tail_bits = (obj_desc->common_field.bit_length +
Len Brown4be44fc2005-08-05 00:44:28 -0400984 obj_desc->common_field.start_field_bit_offset) %
Bob Moore09387b42010-08-06 09:09:33 +0800985 access_bit_width;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986 if (buffer_tail_bits) {
Len Brown4be44fc2005-08-05 00:44:28 -0400987 mask &= ACPI_MASK_BITS_ABOVE(buffer_tail_bits);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988 }
989
990 /* Write the last datum to the field */
991
992 merged_datum &= mask;
Len Brown4be44fc2005-08-05 00:44:28 -0400993 status = acpi_ex_write_with_update_rule(obj_desc,
994 mask, merged_datum,
995 field_offset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996
Bob Moore9aa61692008-04-10 19:06:41 +0400997 exit:
998 /* Free temporary buffer if we used one */
999
1000 if (new_buffer) {
1001 ACPI_FREE(new_buffer);
1002 }
Len Brown4be44fc2005-08-05 00:44:28 -04001003 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004}