blob: 6b728aef2dcab54804d11509e23660b06e11d21e [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/******************************************************************************
2 *
3 * Module Name: exprep - ACPI AML (p-code) execution - field prep utilities
4 *
5 *****************************************************************************/
6
7/*
Bob Moore25f044e2013-01-25 05:38:56 +00008 * Copyright (C) 2000 - 2013, 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 "acnamesp.h"
Bob Moore9ce81782011-11-16 13:39:07 +080049#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("exprep")
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 u32
Len Brown4be44fc2005-08-05 00:44:28 -040056acpi_ex_decode_field_access(union acpi_operand_object *obj_desc,
57 u8 field_flags, u32 * return_byte_alignment);
Linus Torvalds1da177e2005-04-16 15:20:36 -070058
59#ifdef ACPI_UNDER_DEVELOPMENT
Robert Moore44f6c012005-04-18 22:49:35 -040060
61static u32
Len Brown4be44fc2005-08-05 00:44:28 -040062acpi_ex_generate_access(u32 field_bit_offset,
63 u32 field_bit_length, u32 region_length);
Robert Moore44f6c012005-04-18 22:49:35 -040064
Linus Torvalds1da177e2005-04-16 15:20:36 -070065/*******************************************************************************
66 *
67 * FUNCTION: acpi_ex_generate_access
68 *
69 * PARAMETERS: field_bit_offset - Start of field within parent region/buffer
70 * field_bit_length - Length of field in bits
71 * region_length - Length of parent in bytes
72 *
73 * RETURN: Field granularity (8, 16, 32 or 64) and
74 * byte_alignment (1, 2, 3, or 4)
75 *
76 * DESCRIPTION: Generate an optimal access width for fields defined with the
77 * any_acc keyword.
78 *
79 * NOTE: Need to have the region_length in order to check for boundary
Bob Moore73a30902012-10-31 02:26:55 +000080 * conditions (end-of-region). However, the region_length is a deferred
81 * operation. Therefore, to complete this implementation, the generation
Linus Torvalds1da177e2005-04-16 15:20:36 -070082 * of this access width must be deferred until the region length has
83 * been evaluated.
84 *
85 ******************************************************************************/
86
87static u32
Len Brown4be44fc2005-08-05 00:44:28 -040088acpi_ex_generate_access(u32 field_bit_offset,
89 u32 field_bit_length, u32 region_length)
Linus Torvalds1da177e2005-04-16 15:20:36 -070090{
Len Brown4be44fc2005-08-05 00:44:28 -040091 u32 field_byte_length;
92 u32 field_byte_offset;
93 u32 field_byte_end_offset;
94 u32 access_byte_width;
95 u32 field_start_offset;
96 u32 field_end_offset;
97 u32 minimum_access_width = 0xFFFFFFFF;
98 u32 minimum_accesses = 0xFFFFFFFF;
99 u32 accesses;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100
Bob Mooreb229cf92006-04-21 17:15:00 -0400101 ACPI_FUNCTION_TRACE(ex_generate_access);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
103 /* Round Field start offset and length to "minimal" byte boundaries */
104
Len Brown4be44fc2005-08-05 00:44:28 -0400105 field_byte_offset = ACPI_DIV_8(ACPI_ROUND_DOWN(field_bit_offset, 8));
106 field_byte_end_offset = ACPI_DIV_8(ACPI_ROUND_UP(field_bit_length +
107 field_bit_offset, 8));
108 field_byte_length = field_byte_end_offset - field_byte_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109
Len Brown4be44fc2005-08-05 00:44:28 -0400110 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
Bob Mooreb27d6592010-05-26 11:47:13 +0800111 "Bit length %u, Bit offset %u\n",
Len Brown4be44fc2005-08-05 00:44:28 -0400112 field_bit_length, field_bit_offset));
Robert Moore44f6c012005-04-18 22:49:35 -0400113
Len Brown4be44fc2005-08-05 00:44:28 -0400114 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
Bob Mooreb27d6592010-05-26 11:47:13 +0800115 "Byte Length %u, Byte Offset %u, End Offset %u\n",
Len Brown4be44fc2005-08-05 00:44:28 -0400116 field_byte_length, field_byte_offset,
117 field_byte_end_offset));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118
119 /*
120 * Iterative search for the maximum access width that is both aligned
121 * and does not go beyond the end of the region
122 *
123 * Start at byte_acc and work upwards to qword_acc max. (1,2,4,8 bytes)
124 */
Len Brown4be44fc2005-08-05 00:44:28 -0400125 for (access_byte_width = 1; access_byte_width <= 8;
126 access_byte_width <<= 1) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 /*
Robert Moore44f6c012005-04-18 22:49:35 -0400128 * 1) Round end offset up to next access boundary and make sure that
129 * this does not go beyond the end of the parent region.
130 * 2) When the Access width is greater than the field_byte_length, we
131 * are done. (This does not optimize for the perfectly aligned
132 * case yet).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 */
Len Brown4be44fc2005-08-05 00:44:28 -0400134 if (ACPI_ROUND_UP(field_byte_end_offset, access_byte_width) <=
135 region_length) {
Robert Moore44f6c012005-04-18 22:49:35 -0400136 field_start_offset =
Len Brown4be44fc2005-08-05 00:44:28 -0400137 ACPI_ROUND_DOWN(field_byte_offset,
138 access_byte_width) /
139 access_byte_width;
Robert Moore44f6c012005-04-18 22:49:35 -0400140
141 field_end_offset =
Len Brown4be44fc2005-08-05 00:44:28 -0400142 ACPI_ROUND_UP((field_byte_length +
143 field_byte_offset),
144 access_byte_width) /
145 access_byte_width;
Robert Moore44f6c012005-04-18 22:49:35 -0400146
147 accesses = field_end_offset - field_start_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
Len Brown4be44fc2005-08-05 00:44:28 -0400149 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
Bob Mooreb27d6592010-05-26 11:47:13 +0800150 "AccessWidth %u end is within region\n",
Len Brown4be44fc2005-08-05 00:44:28 -0400151 access_byte_width));
Robert Moore44f6c012005-04-18 22:49:35 -0400152
Len Brown4be44fc2005-08-05 00:44:28 -0400153 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
Bob Mooreb27d6592010-05-26 11:47:13 +0800154 "Field Start %u, Field End %u -- requires %u accesses\n",
Len Brown4be44fc2005-08-05 00:44:28 -0400155 field_start_offset, field_end_offset,
156 accesses));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157
158 /* Single access is optimal */
159
160 if (accesses <= 1) {
Len Brown4be44fc2005-08-05 00:44:28 -0400161 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
Bob Mooreb27d6592010-05-26 11:47:13 +0800162 "Entire field can be accessed with one operation of size %u\n",
Len Brown4be44fc2005-08-05 00:44:28 -0400163 access_byte_width));
164 return_VALUE(access_byte_width);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165 }
166
167 /*
168 * Fits in the region, but requires more than one read/write.
169 * try the next wider access on next iteration
170 */
171 if (accesses < minimum_accesses) {
Len Brown4be44fc2005-08-05 00:44:28 -0400172 minimum_accesses = accesses;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 minimum_access_width = access_byte_width;
174 }
Len Brown4be44fc2005-08-05 00:44:28 -0400175 } else {
176 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
Bob Mooreb27d6592010-05-26 11:47:13 +0800177 "AccessWidth %u end is NOT within region\n",
Len Brown4be44fc2005-08-05 00:44:28 -0400178 access_byte_width));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179 if (access_byte_width == 1) {
Len Brown4be44fc2005-08-05 00:44:28 -0400180 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
181 "Field goes beyond end-of-region!\n"));
Robert Moore44f6c012005-04-18 22:49:35 -0400182
183 /* Field does not fit in the region at all */
184
Len Brown4be44fc2005-08-05 00:44:28 -0400185 return_VALUE(0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 }
187
Robert Moore44f6c012005-04-18 22:49:35 -0400188 /*
189 * This width goes beyond the end-of-region, back off to
190 * previous access
191 */
Len Brown4be44fc2005-08-05 00:44:28 -0400192 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
Bob Mooreb27d6592010-05-26 11:47:13 +0800193 "Backing off to previous optimal access width of %u\n",
Len Brown4be44fc2005-08-05 00:44:28 -0400194 minimum_access_width));
195 return_VALUE(minimum_access_width);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196 }
197 }
198
Robert Moore44f6c012005-04-18 22:49:35 -0400199 /*
200 * Could not read/write field with one operation,
201 * just use max access width
202 */
Len Brown4be44fc2005-08-05 00:44:28 -0400203 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
204 "Cannot access field in one operation, using width 8\n"));
205 return_VALUE(8);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206}
Len Brown4be44fc2005-08-05 00:44:28 -0400207#endif /* ACPI_UNDER_DEVELOPMENT */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208
209/*******************************************************************************
210 *
211 * FUNCTION: acpi_ex_decode_field_access
212 *
Robert Moore44f6c012005-04-18 22:49:35 -0400213 * PARAMETERS: obj_desc - Field object
214 * field_flags - Encoded fieldflags (contains access bits)
215 * return_byte_alignment - Where the byte alignment is returned
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 *
217 * RETURN: Field granularity (8, 16, 32 or 64) and
218 * byte_alignment (1, 2, 3, or 4)
219 *
220 * DESCRIPTION: Decode the access_type bits of a field definition.
221 *
222 ******************************************************************************/
223
224static u32
Len Brown4be44fc2005-08-05 00:44:28 -0400225acpi_ex_decode_field_access(union acpi_operand_object *obj_desc,
226 u8 field_flags, u32 * return_byte_alignment)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227{
Len Brown4be44fc2005-08-05 00:44:28 -0400228 u32 access;
229 u32 byte_alignment;
230 u32 bit_length;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231
Bob Mooreb229cf92006-04-21 17:15:00 -0400232 ACPI_FUNCTION_TRACE(ex_decode_field_access);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233
234 access = (field_flags & AML_FIELD_ACCESS_TYPE_MASK);
235
236 switch (access) {
237 case AML_FIELD_ACCESS_ANY:
238
239#ifdef ACPI_UNDER_DEVELOPMENT
Robert Moore44f6c012005-04-18 22:49:35 -0400240 byte_alignment =
Len Brown4be44fc2005-08-05 00:44:28 -0400241 acpi_ex_generate_access(obj_desc->common_field.
242 start_field_bit_offset,
243 obj_desc->common_field.bit_length,
244 0xFFFFFFFF
245 /* Temp until we pass region_length as parameter */
Len Brownfd350942007-05-09 23:34:35 -0400246 );
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 bit_length = byte_alignment * 8;
248#endif
249
250 byte_alignment = 1;
251 bit_length = 8;
252 break;
253
254 case AML_FIELD_ACCESS_BYTE:
Len Brown4be44fc2005-08-05 00:44:28 -0400255 case AML_FIELD_ACCESS_BUFFER: /* ACPI 2.0 (SMBus Buffer) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 byte_alignment = 1;
Len Brown4be44fc2005-08-05 00:44:28 -0400257 bit_length = 8;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 break;
259
260 case AML_FIELD_ACCESS_WORD:
261 byte_alignment = 2;
Len Brown4be44fc2005-08-05 00:44:28 -0400262 bit_length = 16;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 break;
264
265 case AML_FIELD_ACCESS_DWORD:
266 byte_alignment = 4;
Len Brown4be44fc2005-08-05 00:44:28 -0400267 bit_length = 32;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 break;
269
Len Brown4be44fc2005-08-05 00:44:28 -0400270 case AML_FIELD_ACCESS_QWORD: /* ACPI 2.0 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271 byte_alignment = 8;
Len Brown4be44fc2005-08-05 00:44:28 -0400272 bit_length = 64;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 break;
274
275 default:
276 /* Invalid field access type */
277
Bob Mooref6a22b02010-03-05 17:56:40 +0800278 ACPI_ERROR((AE_INFO, "Unknown field access type 0x%X", access));
Bob Moorefd1af712013-03-08 09:22:23 +0000279 return_UINT32(0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280 }
281
Bob Moore3371c192009-02-18 14:44:03 +0800282 if (obj_desc->common.type == ACPI_TYPE_BUFFER_FIELD) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283 /*
284 * buffer_field access can be on any byte boundary, so the
285 * byte_alignment is always 1 byte -- regardless of any byte_alignment
286 * implied by the field access type.
287 */
288 byte_alignment = 1;
289 }
290
291 *return_byte_alignment = byte_alignment;
Bob Moorefd1af712013-03-08 09:22:23 +0000292 return_UINT32(bit_length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293}
294
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295/*******************************************************************************
296 *
297 * FUNCTION: acpi_ex_prep_common_field_object
298 *
299 * PARAMETERS: obj_desc - The field object
300 * field_flags - Access, lock_rule, and update_rule.
301 * The format of a field_flag is described
302 * in the ACPI specification
Robert Moore44f6c012005-04-18 22:49:35 -0400303 * field_attribute - Special attributes (not used)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 * field_bit_position - Field start position
305 * field_bit_length - Field length in number of bits
306 *
307 * RETURN: Status
308 *
309 * DESCRIPTION: Initialize the areas of the field object that are common
Bob Moore73a30902012-10-31 02:26:55 +0000310 * to the various types of fields. Note: This is very "sensitive"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311 * code because we are solving the general case for field
312 * alignment.
313 *
314 ******************************************************************************/
315
316acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400317acpi_ex_prep_common_field_object(union acpi_operand_object *obj_desc,
318 u8 field_flags,
319 u8 field_attribute,
320 u32 field_bit_position, u32 field_bit_length)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321{
Len Brown4be44fc2005-08-05 00:44:28 -0400322 u32 access_bit_width;
323 u32 byte_alignment;
324 u32 nearest_byte_address;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325
Bob Mooreb229cf92006-04-21 17:15:00 -0400326 ACPI_FUNCTION_TRACE(ex_prep_common_field_object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327
328 /*
329 * Note: the structure being initialized is the
330 * ACPI_COMMON_FIELD_INFO; No structure fields outside of the common
331 * area are initialized by this procedure.
332 */
333 obj_desc->common_field.field_flags = field_flags;
334 obj_desc->common_field.attribute = field_attribute;
335 obj_desc->common_field.bit_length = field_bit_length;
336
337 /*
Bob Moore73a30902012-10-31 02:26:55 +0000338 * Decode the access type so we can compute offsets. The access type gives
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339 * two pieces of information - the width of each field access and the
340 * necessary byte_alignment (address granularity) of the access.
341 *
342 * For any_acc, the access_bit_width is the largest width that is both
343 * necessary and possible in an attempt to access the whole field in one
Bob Moore73a30902012-10-31 02:26:55 +0000344 * I/O operation. However, for any_acc, the byte_alignment is always one
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345 * byte.
346 *
347 * For all Buffer Fields, the byte_alignment is always one byte.
348 *
349 * For all other access types (Byte, Word, Dword, Qword), the Bitwidth is
350 * the same (equivalent) as the byte_alignment.
351 */
Len Brown4be44fc2005-08-05 00:44:28 -0400352 access_bit_width = acpi_ex_decode_field_access(obj_desc, field_flags,
353 &byte_alignment);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 if (!access_bit_width) {
Len Brown4be44fc2005-08-05 00:44:28 -0400355 return_ACPI_STATUS(AE_AML_OPERAND_VALUE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356 }
357
Bob Moore09387b42010-08-06 09:09:33 +0800358 /* Setup width (access granularity) fields (values are: 1, 2, 4, 8) */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359
360 obj_desc->common_field.access_byte_width = (u8)
Bob Moore09387b42010-08-06 09:09:33 +0800361 ACPI_DIV_8(access_bit_width);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362
363 /*
364 * base_byte_offset is the address of the start of the field within the
Bob Moore73a30902012-10-31 02:26:55 +0000365 * region. It is the byte address of the first *datum* (field-width data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366 * unit) of the field. (i.e., the first datum that contains at least the
367 * first *bit* of the field.)
368 *
369 * Note: byte_alignment is always either equal to the access_bit_width or 8
370 * (Byte access), and it defines the addressing granularity of the parent
371 * region or buffer.
372 */
373 nearest_byte_address =
Len Brown4be44fc2005-08-05 00:44:28 -0400374 ACPI_ROUND_BITS_DOWN_TO_BYTES(field_bit_position);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375 obj_desc->common_field.base_byte_offset = (u32)
Len Brown4be44fc2005-08-05 00:44:28 -0400376 ACPI_ROUND_DOWN(nearest_byte_address, byte_alignment);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377
378 /*
379 * start_field_bit_offset is the offset of the first bit of the field within
380 * a field datum.
381 */
382 obj_desc->common_field.start_field_bit_offset = (u8)
Len Brown4be44fc2005-08-05 00:44:28 -0400383 (field_bit_position -
384 ACPI_MUL_8(obj_desc->common_field.base_byte_offset));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385
Len Brown4be44fc2005-08-05 00:44:28 -0400386 return_ACPI_STATUS(AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387}
388
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389/*******************************************************************************
390 *
391 * FUNCTION: acpi_ex_prep_field_value
392 *
Bob Mooreba494be2012-07-12 09:40:10 +0800393 * PARAMETERS: info - Contains all field creation info
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 *
395 * RETURN: Status
396 *
Bob Moorecf489582012-07-16 09:52:27 +0800397 * DESCRIPTION: Construct an object of type union acpi_operand_object with a
398 * subtype of def_field and connect it to the parent Node.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 *
400 ******************************************************************************/
401
Len Brown4be44fc2005-08-05 00:44:28 -0400402acpi_status acpi_ex_prep_field_value(struct acpi_create_field_info *info)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403{
Len Brown4be44fc2005-08-05 00:44:28 -0400404 union acpi_operand_object *obj_desc;
Lin Mingef805d92008-04-10 19:06:41 +0400405 union acpi_operand_object *second_desc = NULL;
Len Brown4be44fc2005-08-05 00:44:28 -0400406 acpi_status status;
Bob Moore09387b42010-08-06 09:09:33 +0800407 u32 access_byte_width;
408 u32 type;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409
Bob Mooreb229cf92006-04-21 17:15:00 -0400410 ACPI_FUNCTION_TRACE(ex_prep_field_value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411
412 /* Parameter validation */
413
414 if (info->field_type != ACPI_TYPE_LOCAL_INDEX_FIELD) {
415 if (!info->region_node) {
Bob Mooreb229cf92006-04-21 17:15:00 -0400416 ACPI_ERROR((AE_INFO, "Null RegionNode"));
Len Brown4be44fc2005-08-05 00:44:28 -0400417 return_ACPI_STATUS(AE_AML_NO_OPERAND);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 }
419
Len Brown4be44fc2005-08-05 00:44:28 -0400420 type = acpi_ns_get_type(info->region_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 if (type != ACPI_TYPE_REGION) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500422 ACPI_ERROR((AE_INFO,
Bob Moore09387b42010-08-06 09:09:33 +0800423 "Needed Region, found type 0x%X (%s)", type,
424 acpi_ut_get_type_name(type)));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425
Len Brown4be44fc2005-08-05 00:44:28 -0400426 return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427 }
428 }
429
430 /* Allocate a new field object */
431
Len Brown4be44fc2005-08-05 00:44:28 -0400432 obj_desc = acpi_ut_create_internal_object(info->field_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 if (!obj_desc) {
Len Brown4be44fc2005-08-05 00:44:28 -0400434 return_ACPI_STATUS(AE_NO_MEMORY);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 }
436
437 /* Initialize areas of the object that are common to all fields */
438
439 obj_desc->common_field.node = info->field_node;
Bob Moore09387b42010-08-06 09:09:33 +0800440 status = acpi_ex_prep_common_field_object(obj_desc,
441 info->field_flags,
Len Brown4be44fc2005-08-05 00:44:28 -0400442 info->attribute,
443 info->field_bit_position,
444 info->field_bit_length);
445 if (ACPI_FAILURE(status)) {
446 acpi_ut_delete_object_desc(obj_desc);
447 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 }
449
450 /* Initialize areas of the object that are specific to the field type */
451
452 switch (info->field_type) {
453 case ACPI_TYPE_LOCAL_REGION_FIELD:
454
Len Brown4be44fc2005-08-05 00:44:28 -0400455 obj_desc->field.region_obj =
456 acpi_ns_get_attached_object(info->region_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457
Bob Moore9ce81782011-11-16 13:39:07 +0800458 /* Fields specific to generic_serial_bus fields */
459
460 obj_desc->field.access_length = info->access_length;
461
462 if (info->connection_node) {
463 second_desc = info->connection_node->object;
464 if (!(second_desc->common.flags & AOPOBJ_DATA_VALID)) {
465 status =
466 acpi_ds_get_buffer_arguments(second_desc);
467 if (ACPI_FAILURE(status)) {
468 acpi_ut_delete_object_desc(obj_desc);
469 return_ACPI_STATUS(status);
470 }
471 }
472
473 obj_desc->field.resource_buffer =
474 second_desc->buffer.pointer;
475 obj_desc->field.resource_length =
476 (u16)second_desc->buffer.length;
477 } else if (info->resource_buffer) {
478 obj_desc->field.resource_buffer = info->resource_buffer;
479 obj_desc->field.resource_length = info->resource_length;
480 }
481
Bob Moore09387b42010-08-06 09:09:33 +0800482 /* Allow full data read from EC address space */
483
484 if ((obj_desc->field.region_obj->region.space_id ==
485 ACPI_ADR_SPACE_EC)
486 && (obj_desc->common_field.bit_length > 8)) {
487 access_byte_width =
488 ACPI_ROUND_BITS_UP_TO_BYTES(obj_desc->common_field.
489 bit_length);
490
491 /* Maximum byte width supported is 255 */
492
493 if (access_byte_width < 256) {
494 obj_desc->common_field.access_byte_width =
495 (u8)access_byte_width;
496 }
497 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498 /* An additional reference for the container */
499
Len Brown4be44fc2005-08-05 00:44:28 -0400500 acpi_ut_add_reference(obj_desc->field.region_obj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501
Len Brown4be44fc2005-08-05 00:44:28 -0400502 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
Bob Mooreb229cf92006-04-21 17:15:00 -0400503 "RegionField: BitOff %X, Off %X, Gran %X, Region %p\n",
Len Brown4be44fc2005-08-05 00:44:28 -0400504 obj_desc->field.start_field_bit_offset,
505 obj_desc->field.base_byte_offset,
506 obj_desc->field.access_byte_width,
507 obj_desc->field.region_obj));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508 break;
509
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510 case ACPI_TYPE_LOCAL_BANK_FIELD:
511
Len Brown4be44fc2005-08-05 00:44:28 -0400512 obj_desc->bank_field.value = info->bank_value;
513 obj_desc->bank_field.region_obj =
514 acpi_ns_get_attached_object(info->region_node);
515 obj_desc->bank_field.bank_obj =
516 acpi_ns_get_attached_object(info->register_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517
518 /* An additional reference for the attached objects */
519
Len Brown4be44fc2005-08-05 00:44:28 -0400520 acpi_ut_add_reference(obj_desc->bank_field.region_obj);
521 acpi_ut_add_reference(obj_desc->bank_field.bank_obj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522
Len Brown4be44fc2005-08-05 00:44:28 -0400523 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
Bob Mooreb229cf92006-04-21 17:15:00 -0400524 "Bank Field: BitOff %X, Off %X, Gran %X, Region %p, BankReg %p\n",
Len Brown4be44fc2005-08-05 00:44:28 -0400525 obj_desc->bank_field.start_field_bit_offset,
526 obj_desc->bank_field.base_byte_offset,
527 obj_desc->field.access_byte_width,
528 obj_desc->bank_field.region_obj,
529 obj_desc->bank_field.bank_obj));
Lin Mingef805d92008-04-10 19:06:41 +0400530
531 /*
532 * Remember location in AML stream of the field unit
533 * opcode and operands -- since the bank_value
534 * operands must be evaluated.
535 */
536 second_desc = obj_desc->common.next_object;
537 second_desc->extra.aml_start =
Bob Mooreb5243762008-06-10 13:44:48 +0800538 ACPI_CAST_PTR(union acpi_parse_object,
539 info->data_register_node)->named.data;
Lin Mingef805d92008-04-10 19:06:41 +0400540 second_desc->extra.aml_length =
Bob Mooreb5243762008-06-10 13:44:48 +0800541 ACPI_CAST_PTR(union acpi_parse_object,
542 info->data_register_node)->named.length;
Lin Mingef805d92008-04-10 19:06:41 +0400543
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544 break;
545
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546 case ACPI_TYPE_LOCAL_INDEX_FIELD:
547
Bob Mooreb8e4d892006-01-27 16:43:00 -0500548 /* Get the Index and Data registers */
549
Len Brown4be44fc2005-08-05 00:44:28 -0400550 obj_desc->index_field.index_obj =
551 acpi_ns_get_attached_object(info->register_node);
552 obj_desc->index_field.data_obj =
553 acpi_ns_get_attached_object(info->data_register_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554
Len Brown4be44fc2005-08-05 00:44:28 -0400555 if (!obj_desc->index_field.data_obj
556 || !obj_desc->index_field.index_obj) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500557 ACPI_ERROR((AE_INFO,
558 "Null Index Object during field prep"));
Len Brown4be44fc2005-08-05 00:44:28 -0400559 acpi_ut_delete_object_desc(obj_desc);
560 return_ACPI_STATUS(AE_AML_INTERNAL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 }
562
563 /* An additional reference for the attached objects */
564
Len Brown4be44fc2005-08-05 00:44:28 -0400565 acpi_ut_add_reference(obj_desc->index_field.data_obj);
566 acpi_ut_add_reference(obj_desc->index_field.index_obj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567
Bob Mooreb8e4d892006-01-27 16:43:00 -0500568 /*
Bob Mooreb229cf92006-04-21 17:15:00 -0400569 * April 2006: Changed to match MS behavior
Bob Mooreea936b72006-02-17 00:00:00 -0500570 *
Bob Mooreb8e4d892006-01-27 16:43:00 -0500571 * The value written to the Index register is the byte offset of the
Bob Mooreb229cf92006-04-21 17:15:00 -0400572 * target field in units of the granularity of the index_field
Bob Mooreea936b72006-02-17 00:00:00 -0500573 *
574 * Previously, the value was calculated as an index in terms of the
575 * width of the Data register, as below:
576 *
Bob Mooreb229cf92006-04-21 17:15:00 -0400577 * obj_desc->index_field.Value = (u32)
578 * (Info->field_bit_position / ACPI_MUL_8 (
579 * obj_desc->Field.access_byte_width));
580 *
581 * February 2006: Tried value as a byte offset:
582 * obj_desc->index_field.Value = (u32)
583 * ACPI_DIV_8 (Info->field_bit_position);
Bob Mooreb8e4d892006-01-27 16:43:00 -0500584 */
Bob Mooreea936b72006-02-17 00:00:00 -0500585 obj_desc->index_field.value =
Bob Mooreb229cf92006-04-21 17:15:00 -0400586 (u32) ACPI_ROUND_DOWN(ACPI_DIV_8(info->field_bit_position),
587 obj_desc->index_field.
588 access_byte_width);
Bob Mooreb8e4d892006-01-27 16:43:00 -0500589
Len Brown4be44fc2005-08-05 00:44:28 -0400590 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
Bob Mooreb229cf92006-04-21 17:15:00 -0400591 "IndexField: BitOff %X, Off %X, Value %X, Gran %X, Index %p, Data %p\n",
Len Brown4be44fc2005-08-05 00:44:28 -0400592 obj_desc->index_field.start_field_bit_offset,
593 obj_desc->index_field.base_byte_offset,
594 obj_desc->index_field.value,
595 obj_desc->field.access_byte_width,
596 obj_desc->index_field.index_obj,
597 obj_desc->index_field.data_obj));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 break;
599
600 default:
601 /* No other types should get here */
602 break;
603 }
604
605 /*
606 * Store the constructed descriptor (obj_desc) into the parent Node,
607 * preserving the current type of that named_obj.
608 */
Len Brown4be44fc2005-08-05 00:44:28 -0400609 status = acpi_ns_attach_object(info->field_node, obj_desc,
610 acpi_ns_get_type(info->field_node));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611
Len Brown4be44fc2005-08-05 00:44:28 -0400612 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
Bob Mooreb229cf92006-04-21 17:15:00 -0400613 "Set NamedObj %p [%4.4s], ObjDesc %p\n",
Len Brown4be44fc2005-08-05 00:44:28 -0400614 info->field_node,
615 acpi_ut_get_node_name(info->field_node), obj_desc));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616
617 /* Remove local reference to the object */
618
Len Brown4be44fc2005-08-05 00:44:28 -0400619 acpi_ut_remove_reference(obj_desc);
620 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621}