exprep.c revision 1.1 1 1.1 jruoho
2 1.1 jruoho /******************************************************************************
3 1.1 jruoho *
4 1.1 jruoho * Module Name: exprep - ACPI AML (p-code) execution - field prep utilities
5 1.1 jruoho *
6 1.1 jruoho *****************************************************************************/
7 1.1 jruoho
8 1.1 jruoho /******************************************************************************
9 1.1 jruoho *
10 1.1 jruoho * 1. Copyright Notice
11 1.1 jruoho *
12 1.1 jruoho * Some or all of this work - Copyright (c) 1999 - 2010, Intel Corp.
13 1.1 jruoho * All rights reserved.
14 1.1 jruoho *
15 1.1 jruoho * 2. License
16 1.1 jruoho *
17 1.1 jruoho * 2.1. This is your license from Intel Corp. under its intellectual property
18 1.1 jruoho * rights. You may have additional license terms from the party that provided
19 1.1 jruoho * you this software, covering your right to use that party's intellectual
20 1.1 jruoho * property rights.
21 1.1 jruoho *
22 1.1 jruoho * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 1.1 jruoho * copy of the source code appearing in this file ("Covered Code") an
24 1.1 jruoho * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 1.1 jruoho * base code distributed originally by Intel ("Original Intel Code") to copy,
26 1.1 jruoho * make derivatives, distribute, use and display any portion of the Covered
27 1.1 jruoho * Code in any form, with the right to sublicense such rights; and
28 1.1 jruoho *
29 1.1 jruoho * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 1.1 jruoho * license (with the right to sublicense), under only those claims of Intel
31 1.1 jruoho * patents that are infringed by the Original Intel Code, to make, use, sell,
32 1.1 jruoho * offer to sell, and import the Covered Code and derivative works thereof
33 1.1 jruoho * solely to the minimum extent necessary to exercise the above copyright
34 1.1 jruoho * license, and in no event shall the patent license extend to any additions
35 1.1 jruoho * to or modifications of the Original Intel Code. No other license or right
36 1.1 jruoho * is granted directly or by implication, estoppel or otherwise;
37 1.1 jruoho *
38 1.1 jruoho * The above copyright and patent license is granted only if the following
39 1.1 jruoho * conditions are met:
40 1.1 jruoho *
41 1.1 jruoho * 3. Conditions
42 1.1 jruoho *
43 1.1 jruoho * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 1.1 jruoho * Redistribution of source code of any substantial portion of the Covered
45 1.1 jruoho * Code or modification with rights to further distribute source must include
46 1.1 jruoho * the above Copyright Notice, the above License, this list of Conditions,
47 1.1 jruoho * and the following Disclaimer and Export Compliance provision. In addition,
48 1.1 jruoho * Licensee must cause all Covered Code to which Licensee contributes to
49 1.1 jruoho * contain a file documenting the changes Licensee made to create that Covered
50 1.1 jruoho * Code and the date of any change. Licensee must include in that file the
51 1.1 jruoho * documentation of any changes made by any predecessor Licensee. Licensee
52 1.1 jruoho * must include a prominent statement that the modification is derived,
53 1.1 jruoho * directly or indirectly, from Original Intel Code.
54 1.1 jruoho *
55 1.1 jruoho * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 1.1 jruoho * Redistribution of source code of any substantial portion of the Covered
57 1.1 jruoho * Code or modification without rights to further distribute source must
58 1.1 jruoho * include the following Disclaimer and Export Compliance provision in the
59 1.1 jruoho * documentation and/or other materials provided with distribution. In
60 1.1 jruoho * addition, Licensee may not authorize further sublicense of source of any
61 1.1 jruoho * portion of the Covered Code, and must include terms to the effect that the
62 1.1 jruoho * license from Licensee to its licensee is limited to the intellectual
63 1.1 jruoho * property embodied in the software Licensee provides to its licensee, and
64 1.1 jruoho * not to intellectual property embodied in modifications its licensee may
65 1.1 jruoho * make.
66 1.1 jruoho *
67 1.1 jruoho * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 1.1 jruoho * substantial portion of the Covered Code or modification must reproduce the
69 1.1 jruoho * above Copyright Notice, and the following Disclaimer and Export Compliance
70 1.1 jruoho * provision in the documentation and/or other materials provided with the
71 1.1 jruoho * distribution.
72 1.1 jruoho *
73 1.1 jruoho * 3.4. Intel retains all right, title, and interest in and to the Original
74 1.1 jruoho * Intel Code.
75 1.1 jruoho *
76 1.1 jruoho * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 1.1 jruoho * Intel shall be used in advertising or otherwise to promote the sale, use or
78 1.1 jruoho * other dealings in products derived from or relating to the Covered Code
79 1.1 jruoho * without prior written authorization from Intel.
80 1.1 jruoho *
81 1.1 jruoho * 4. Disclaimer and Export Compliance
82 1.1 jruoho *
83 1.1 jruoho * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 1.1 jruoho * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 1.1 jruoho * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86 1.1 jruoho * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87 1.1 jruoho * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88 1.1 jruoho * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
89 1.1 jruoho * PARTICULAR PURPOSE.
90 1.1 jruoho *
91 1.1 jruoho * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 1.1 jruoho * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 1.1 jruoho * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 1.1 jruoho * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 1.1 jruoho * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 1.1 jruoho * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97 1.1 jruoho * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
98 1.1 jruoho * LIMITED REMEDY.
99 1.1 jruoho *
100 1.1 jruoho * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 1.1 jruoho * software or system incorporating such software without first obtaining any
102 1.1 jruoho * required license or other approval from the U. S. Department of Commerce or
103 1.1 jruoho * any other agency or department of the United States Government. In the
104 1.1 jruoho * event Licensee exports any such software from the United States or
105 1.1 jruoho * re-exports any such software from a foreign destination, Licensee shall
106 1.1 jruoho * ensure that the distribution and export/re-export of the software is in
107 1.1 jruoho * compliance with all laws, regulations, orders, or other restrictions of the
108 1.1 jruoho * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 1.1 jruoho * any of its subsidiaries will export/re-export any technical data, process,
110 1.1 jruoho * software, or service, directly or indirectly, to any country for which the
111 1.1 jruoho * United States government or any agency thereof requires an export license,
112 1.1 jruoho * other governmental approval, or letter of assurance, without first obtaining
113 1.1 jruoho * such license, approval or letter.
114 1.1 jruoho *
115 1.1 jruoho *****************************************************************************/
116 1.1 jruoho
117 1.1 jruoho #define __EXPREP_C__
118 1.1 jruoho
119 1.1 jruoho #include "acpi.h"
120 1.1 jruoho #include "accommon.h"
121 1.1 jruoho #include "acinterp.h"
122 1.1 jruoho #include "amlcode.h"
123 1.1 jruoho #include "acnamesp.h"
124 1.1 jruoho
125 1.1 jruoho
126 1.1 jruoho #define _COMPONENT ACPI_EXECUTER
127 1.1 jruoho ACPI_MODULE_NAME ("exprep")
128 1.1 jruoho
129 1.1 jruoho /* Local prototypes */
130 1.1 jruoho
131 1.1 jruoho static UINT32
132 1.1 jruoho AcpiExDecodeFieldAccess (
133 1.1 jruoho ACPI_OPERAND_OBJECT *ObjDesc,
134 1.1 jruoho UINT8 FieldFlags,
135 1.1 jruoho UINT32 *ReturnByteAlignment);
136 1.1 jruoho
137 1.1 jruoho
138 1.1 jruoho #ifdef ACPI_UNDER_DEVELOPMENT
139 1.1 jruoho
140 1.1 jruoho static UINT32
141 1.1 jruoho AcpiExGenerateAccess (
142 1.1 jruoho UINT32 FieldBitOffset,
143 1.1 jruoho UINT32 FieldBitLength,
144 1.1 jruoho UINT32 RegionLength);
145 1.1 jruoho
146 1.1 jruoho /*******************************************************************************
147 1.1 jruoho *
148 1.1 jruoho * FUNCTION: AcpiExGenerateAccess
149 1.1 jruoho *
150 1.1 jruoho * PARAMETERS: FieldBitOffset - Start of field within parent region/buffer
151 1.1 jruoho * FieldBitLength - Length of field in bits
152 1.1 jruoho * RegionLength - Length of parent in bytes
153 1.1 jruoho *
154 1.1 jruoho * RETURN: Field granularity (8, 16, 32 or 64) and
155 1.1 jruoho * ByteAlignment (1, 2, 3, or 4)
156 1.1 jruoho *
157 1.1 jruoho * DESCRIPTION: Generate an optimal access width for fields defined with the
158 1.1 jruoho * AnyAcc keyword.
159 1.1 jruoho *
160 1.1 jruoho * NOTE: Need to have the RegionLength in order to check for boundary
161 1.1 jruoho * conditions (end-of-region). However, the RegionLength is a deferred
162 1.1 jruoho * operation. Therefore, to complete this implementation, the generation
163 1.1 jruoho * of this access width must be deferred until the region length has
164 1.1 jruoho * been evaluated.
165 1.1 jruoho *
166 1.1 jruoho ******************************************************************************/
167 1.1 jruoho
168 1.1 jruoho static UINT32
169 1.1 jruoho AcpiExGenerateAccess (
170 1.1 jruoho UINT32 FieldBitOffset,
171 1.1 jruoho UINT32 FieldBitLength,
172 1.1 jruoho UINT32 RegionLength)
173 1.1 jruoho {
174 1.1 jruoho UINT32 FieldByteLength;
175 1.1 jruoho UINT32 FieldByteOffset;
176 1.1 jruoho UINT32 FieldByteEndOffset;
177 1.1 jruoho UINT32 AccessByteWidth;
178 1.1 jruoho UINT32 FieldStartOffset;
179 1.1 jruoho UINT32 FieldEndOffset;
180 1.1 jruoho UINT32 MinimumAccessWidth = 0xFFFFFFFF;
181 1.1 jruoho UINT32 MinimumAccesses = 0xFFFFFFFF;
182 1.1 jruoho UINT32 Accesses;
183 1.1 jruoho
184 1.1 jruoho
185 1.1 jruoho ACPI_FUNCTION_TRACE (ExGenerateAccess);
186 1.1 jruoho
187 1.1 jruoho
188 1.1 jruoho /* Round Field start offset and length to "minimal" byte boundaries */
189 1.1 jruoho
190 1.1 jruoho FieldByteOffset = ACPI_DIV_8 (ACPI_ROUND_DOWN (FieldBitOffset, 8));
191 1.1 jruoho FieldByteEndOffset = ACPI_DIV_8 (ACPI_ROUND_UP (FieldBitLength +
192 1.1 jruoho FieldBitOffset, 8));
193 1.1 jruoho FieldByteLength = FieldByteEndOffset - FieldByteOffset;
194 1.1 jruoho
195 1.1 jruoho ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
196 1.1 jruoho "Bit length %u, Bit offset %u\n",
197 1.1 jruoho FieldBitLength, FieldBitOffset));
198 1.1 jruoho
199 1.1 jruoho ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
200 1.1 jruoho "Byte Length %u, Byte Offset %u, End Offset %u\n",
201 1.1 jruoho FieldByteLength, FieldByteOffset, FieldByteEndOffset));
202 1.1 jruoho
203 1.1 jruoho /*
204 1.1 jruoho * Iterative search for the maximum access width that is both aligned
205 1.1 jruoho * and does not go beyond the end of the region
206 1.1 jruoho *
207 1.1 jruoho * Start at ByteAcc and work upwards to QwordAcc max. (1,2,4,8 bytes)
208 1.1 jruoho */
209 1.1 jruoho for (AccessByteWidth = 1; AccessByteWidth <= 8; AccessByteWidth <<= 1)
210 1.1 jruoho {
211 1.1 jruoho /*
212 1.1 jruoho * 1) Round end offset up to next access boundary and make sure that
213 1.1 jruoho * this does not go beyond the end of the parent region.
214 1.1 jruoho * 2) When the Access width is greater than the FieldByteLength, we
215 1.1 jruoho * are done. (This does not optimize for the perfectly aligned
216 1.1 jruoho * case yet).
217 1.1 jruoho */
218 1.1 jruoho if (ACPI_ROUND_UP (FieldByteEndOffset, AccessByteWidth) <= RegionLength)
219 1.1 jruoho {
220 1.1 jruoho FieldStartOffset =
221 1.1 jruoho ACPI_ROUND_DOWN (FieldByteOffset, AccessByteWidth) /
222 1.1 jruoho AccessByteWidth;
223 1.1 jruoho
224 1.1 jruoho FieldEndOffset =
225 1.1 jruoho ACPI_ROUND_UP ((FieldByteLength + FieldByteOffset),
226 1.1 jruoho AccessByteWidth) / AccessByteWidth;
227 1.1 jruoho
228 1.1 jruoho Accesses = FieldEndOffset - FieldStartOffset;
229 1.1 jruoho
230 1.1 jruoho ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
231 1.1 jruoho "AccessWidth %u end is within region\n", AccessByteWidth));
232 1.1 jruoho
233 1.1 jruoho ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
234 1.1 jruoho "Field Start %u, Field End %u -- requires %u accesses\n",
235 1.1 jruoho FieldStartOffset, FieldEndOffset, Accesses));
236 1.1 jruoho
237 1.1 jruoho /* Single access is optimal */
238 1.1 jruoho
239 1.1 jruoho if (Accesses <= 1)
240 1.1 jruoho {
241 1.1 jruoho ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
242 1.1 jruoho "Entire field can be accessed with one operation of size %u\n",
243 1.1 jruoho AccessByteWidth));
244 1.1 jruoho return_VALUE (AccessByteWidth);
245 1.1 jruoho }
246 1.1 jruoho
247 1.1 jruoho /*
248 1.1 jruoho * Fits in the region, but requires more than one read/write.
249 1.1 jruoho * try the next wider access on next iteration
250 1.1 jruoho */
251 1.1 jruoho if (Accesses < MinimumAccesses)
252 1.1 jruoho {
253 1.1 jruoho MinimumAccesses = Accesses;
254 1.1 jruoho MinimumAccessWidth = AccessByteWidth;
255 1.1 jruoho }
256 1.1 jruoho }
257 1.1 jruoho else
258 1.1 jruoho {
259 1.1 jruoho ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
260 1.1 jruoho "AccessWidth %u end is NOT within region\n", AccessByteWidth));
261 1.1 jruoho if (AccessByteWidth == 1)
262 1.1 jruoho {
263 1.1 jruoho ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
264 1.1 jruoho "Field goes beyond end-of-region!\n"));
265 1.1 jruoho
266 1.1 jruoho /* Field does not fit in the region at all */
267 1.1 jruoho
268 1.1 jruoho return_VALUE (0);
269 1.1 jruoho }
270 1.1 jruoho
271 1.1 jruoho /*
272 1.1 jruoho * This width goes beyond the end-of-region, back off to
273 1.1 jruoho * previous access
274 1.1 jruoho */
275 1.1 jruoho ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
276 1.1 jruoho "Backing off to previous optimal access width of %u\n",
277 1.1 jruoho MinimumAccessWidth));
278 1.1 jruoho return_VALUE (MinimumAccessWidth);
279 1.1 jruoho }
280 1.1 jruoho }
281 1.1 jruoho
282 1.1 jruoho /*
283 1.1 jruoho * Could not read/write field with one operation,
284 1.1 jruoho * just use max access width
285 1.1 jruoho */
286 1.1 jruoho ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
287 1.1 jruoho "Cannot access field in one operation, using width 8\n"));
288 1.1 jruoho return_VALUE (8);
289 1.1 jruoho }
290 1.1 jruoho #endif /* ACPI_UNDER_DEVELOPMENT */
291 1.1 jruoho
292 1.1 jruoho
293 1.1 jruoho /*******************************************************************************
294 1.1 jruoho *
295 1.1 jruoho * FUNCTION: AcpiExDecodeFieldAccess
296 1.1 jruoho *
297 1.1 jruoho * PARAMETERS: ObjDesc - Field object
298 1.1 jruoho * FieldFlags - Encoded fieldflags (contains access bits)
299 1.1 jruoho * ReturnByteAlignment - Where the byte alignment is returned
300 1.1 jruoho *
301 1.1 jruoho * RETURN: Field granularity (8, 16, 32 or 64) and
302 1.1 jruoho * ByteAlignment (1, 2, 3, or 4)
303 1.1 jruoho *
304 1.1 jruoho * DESCRIPTION: Decode the AccessType bits of a field definition.
305 1.1 jruoho *
306 1.1 jruoho ******************************************************************************/
307 1.1 jruoho
308 1.1 jruoho static UINT32
309 1.1 jruoho AcpiExDecodeFieldAccess (
310 1.1 jruoho ACPI_OPERAND_OBJECT *ObjDesc,
311 1.1 jruoho UINT8 FieldFlags,
312 1.1 jruoho UINT32 *ReturnByteAlignment)
313 1.1 jruoho {
314 1.1 jruoho UINT32 Access;
315 1.1 jruoho UINT32 ByteAlignment;
316 1.1 jruoho UINT32 BitLength;
317 1.1 jruoho
318 1.1 jruoho
319 1.1 jruoho ACPI_FUNCTION_TRACE (ExDecodeFieldAccess);
320 1.1 jruoho
321 1.1 jruoho
322 1.1 jruoho Access = (FieldFlags & AML_FIELD_ACCESS_TYPE_MASK);
323 1.1 jruoho
324 1.1 jruoho switch (Access)
325 1.1 jruoho {
326 1.1 jruoho case AML_FIELD_ACCESS_ANY:
327 1.1 jruoho
328 1.1 jruoho #ifdef ACPI_UNDER_DEVELOPMENT
329 1.1 jruoho ByteAlignment =
330 1.1 jruoho AcpiExGenerateAccess (ObjDesc->CommonField.StartFieldBitOffset,
331 1.1 jruoho ObjDesc->CommonField.BitLength,
332 1.1 jruoho 0xFFFFFFFF /* Temp until we pass RegionLength as parameter */);
333 1.1 jruoho BitLength = ByteAlignment * 8;
334 1.1 jruoho #endif
335 1.1 jruoho
336 1.1 jruoho ByteAlignment = 1;
337 1.1 jruoho BitLength = 8;
338 1.1 jruoho break;
339 1.1 jruoho
340 1.1 jruoho case AML_FIELD_ACCESS_BYTE:
341 1.1 jruoho case AML_FIELD_ACCESS_BUFFER: /* ACPI 2.0 (SMBus Buffer) */
342 1.1 jruoho ByteAlignment = 1;
343 1.1 jruoho BitLength = 8;
344 1.1 jruoho break;
345 1.1 jruoho
346 1.1 jruoho case AML_FIELD_ACCESS_WORD:
347 1.1 jruoho ByteAlignment = 2;
348 1.1 jruoho BitLength = 16;
349 1.1 jruoho break;
350 1.1 jruoho
351 1.1 jruoho case AML_FIELD_ACCESS_DWORD:
352 1.1 jruoho ByteAlignment = 4;
353 1.1 jruoho BitLength = 32;
354 1.1 jruoho break;
355 1.1 jruoho
356 1.1 jruoho case AML_FIELD_ACCESS_QWORD: /* ACPI 2.0 */
357 1.1 jruoho ByteAlignment = 8;
358 1.1 jruoho BitLength = 64;
359 1.1 jruoho break;
360 1.1 jruoho
361 1.1 jruoho default:
362 1.1 jruoho /* Invalid field access type */
363 1.1 jruoho
364 1.1 jruoho ACPI_ERROR ((AE_INFO,
365 1.1 jruoho "Unknown field access type 0x%X",
366 1.1 jruoho Access));
367 1.1 jruoho return_UINT32 (0);
368 1.1 jruoho }
369 1.1 jruoho
370 1.1 jruoho if (ObjDesc->Common.Type == ACPI_TYPE_BUFFER_FIELD)
371 1.1 jruoho {
372 1.1 jruoho /*
373 1.1 jruoho * BufferField access can be on any byte boundary, so the
374 1.1 jruoho * ByteAlignment is always 1 byte -- regardless of any ByteAlignment
375 1.1 jruoho * implied by the field access type.
376 1.1 jruoho */
377 1.1 jruoho ByteAlignment = 1;
378 1.1 jruoho }
379 1.1 jruoho
380 1.1 jruoho *ReturnByteAlignment = ByteAlignment;
381 1.1 jruoho return_UINT32 (BitLength);
382 1.1 jruoho }
383 1.1 jruoho
384 1.1 jruoho
385 1.1 jruoho /*******************************************************************************
386 1.1 jruoho *
387 1.1 jruoho * FUNCTION: AcpiExPrepCommonFieldObject
388 1.1 jruoho *
389 1.1 jruoho * PARAMETERS: ObjDesc - The field object
390 1.1 jruoho * FieldFlags - Access, LockRule, and UpdateRule.
391 1.1 jruoho * The format of a FieldFlag is described
392 1.1 jruoho * in the ACPI specification
393 1.1 jruoho * FieldAttribute - Special attributes (not used)
394 1.1 jruoho * FieldBitPosition - Field start position
395 1.1 jruoho * FieldBitLength - Field length in number of bits
396 1.1 jruoho *
397 1.1 jruoho * RETURN: Status
398 1.1 jruoho *
399 1.1 jruoho * DESCRIPTION: Initialize the areas of the field object that are common
400 1.1 jruoho * to the various types of fields. Note: This is very "sensitive"
401 1.1 jruoho * code because we are solving the general case for field
402 1.1 jruoho * alignment.
403 1.1 jruoho *
404 1.1 jruoho ******************************************************************************/
405 1.1 jruoho
406 1.1 jruoho ACPI_STATUS
407 1.1 jruoho AcpiExPrepCommonFieldObject (
408 1.1 jruoho ACPI_OPERAND_OBJECT *ObjDesc,
409 1.1 jruoho UINT8 FieldFlags,
410 1.1 jruoho UINT8 FieldAttribute,
411 1.1 jruoho UINT32 FieldBitPosition,
412 1.1 jruoho UINT32 FieldBitLength)
413 1.1 jruoho {
414 1.1 jruoho UINT32 AccessBitWidth;
415 1.1 jruoho UINT32 ByteAlignment;
416 1.1 jruoho UINT32 NearestByteAddress;
417 1.1 jruoho
418 1.1 jruoho
419 1.1 jruoho ACPI_FUNCTION_TRACE (ExPrepCommonFieldObject);
420 1.1 jruoho
421 1.1 jruoho
422 1.1 jruoho /*
423 1.1 jruoho * Note: the structure being initialized is the
424 1.1 jruoho * ACPI_COMMON_FIELD_INFO; No structure fields outside of the common
425 1.1 jruoho * area are initialized by this procedure.
426 1.1 jruoho */
427 1.1 jruoho ObjDesc->CommonField.FieldFlags = FieldFlags;
428 1.1 jruoho ObjDesc->CommonField.Attribute = FieldAttribute;
429 1.1 jruoho ObjDesc->CommonField.BitLength = FieldBitLength;
430 1.1 jruoho
431 1.1 jruoho /*
432 1.1 jruoho * Decode the access type so we can compute offsets. The access type gives
433 1.1 jruoho * two pieces of information - the width of each field access and the
434 1.1 jruoho * necessary ByteAlignment (address granularity) of the access.
435 1.1 jruoho *
436 1.1 jruoho * For AnyAcc, the AccessBitWidth is the largest width that is both
437 1.1 jruoho * necessary and possible in an attempt to access the whole field in one
438 1.1 jruoho * I/O operation. However, for AnyAcc, the ByteAlignment is always one
439 1.1 jruoho * byte.
440 1.1 jruoho *
441 1.1 jruoho * For all Buffer Fields, the ByteAlignment is always one byte.
442 1.1 jruoho *
443 1.1 jruoho * For all other access types (Byte, Word, Dword, Qword), the Bitwidth is
444 1.1 jruoho * the same (equivalent) as the ByteAlignment.
445 1.1 jruoho */
446 1.1 jruoho AccessBitWidth = AcpiExDecodeFieldAccess (ObjDesc, FieldFlags,
447 1.1 jruoho &ByteAlignment);
448 1.1 jruoho if (!AccessBitWidth)
449 1.1 jruoho {
450 1.1 jruoho return_ACPI_STATUS (AE_AML_OPERAND_VALUE);
451 1.1 jruoho }
452 1.1 jruoho
453 1.1 jruoho /* Setup width (access granularity) fields (values are: 1, 2, 4, 8) */
454 1.1 jruoho
455 1.1 jruoho ObjDesc->CommonField.AccessByteWidth = (UINT8)
456 1.1 jruoho ACPI_DIV_8 (AccessBitWidth);
457 1.1 jruoho
458 1.1 jruoho /*
459 1.1 jruoho * BaseByteOffset is the address of the start of the field within the
460 1.1 jruoho * region. It is the byte address of the first *datum* (field-width data
461 1.1 jruoho * unit) of the field. (i.e., the first datum that contains at least the
462 1.1 jruoho * first *bit* of the field.)
463 1.1 jruoho *
464 1.1 jruoho * Note: ByteAlignment is always either equal to the AccessBitWidth or 8
465 1.1 jruoho * (Byte access), and it defines the addressing granularity of the parent
466 1.1 jruoho * region or buffer.
467 1.1 jruoho */
468 1.1 jruoho NearestByteAddress =
469 1.1 jruoho ACPI_ROUND_BITS_DOWN_TO_BYTES (FieldBitPosition);
470 1.1 jruoho ObjDesc->CommonField.BaseByteOffset = (UINT32)
471 1.1 jruoho ACPI_ROUND_DOWN (NearestByteAddress, ByteAlignment);
472 1.1 jruoho
473 1.1 jruoho /*
474 1.1 jruoho * StartFieldBitOffset is the offset of the first bit of the field within
475 1.1 jruoho * a field datum.
476 1.1 jruoho */
477 1.1 jruoho ObjDesc->CommonField.StartFieldBitOffset = (UINT8)
478 1.1 jruoho (FieldBitPosition - ACPI_MUL_8 (ObjDesc->CommonField.BaseByteOffset));
479 1.1 jruoho
480 1.1 jruoho return_ACPI_STATUS (AE_OK);
481 1.1 jruoho }
482 1.1 jruoho
483 1.1 jruoho
484 1.1 jruoho /*******************************************************************************
485 1.1 jruoho *
486 1.1 jruoho * FUNCTION: AcpiExPrepFieldValue
487 1.1 jruoho *
488 1.1 jruoho * PARAMETERS: Info - Contains all field creation info
489 1.1 jruoho *
490 1.1 jruoho * RETURN: Status
491 1.1 jruoho *
492 1.1 jruoho * DESCRIPTION: Construct an ACPI_OPERAND_OBJECT of type DefField and
493 1.1 jruoho * connect it to the parent Node.
494 1.1 jruoho *
495 1.1 jruoho ******************************************************************************/
496 1.1 jruoho
497 1.1 jruoho ACPI_STATUS
498 1.1 jruoho AcpiExPrepFieldValue (
499 1.1 jruoho ACPI_CREATE_FIELD_INFO *Info)
500 1.1 jruoho {
501 1.1 jruoho ACPI_OPERAND_OBJECT *ObjDesc;
502 1.1 jruoho ACPI_OPERAND_OBJECT *SecondDesc = NULL;
503 1.1 jruoho ACPI_STATUS Status;
504 1.1 jruoho UINT32 AccessByteWidth;
505 1.1 jruoho UINT32 Type;
506 1.1 jruoho
507 1.1 jruoho
508 1.1 jruoho ACPI_FUNCTION_TRACE (ExPrepFieldValue);
509 1.1 jruoho
510 1.1 jruoho
511 1.1 jruoho /* Parameter validation */
512 1.1 jruoho
513 1.1 jruoho if (Info->FieldType != ACPI_TYPE_LOCAL_INDEX_FIELD)
514 1.1 jruoho {
515 1.1 jruoho if (!Info->RegionNode)
516 1.1 jruoho {
517 1.1 jruoho ACPI_ERROR ((AE_INFO, "Null RegionNode"));
518 1.1 jruoho return_ACPI_STATUS (AE_AML_NO_OPERAND);
519 1.1 jruoho }
520 1.1 jruoho
521 1.1 jruoho Type = AcpiNsGetType (Info->RegionNode);
522 1.1 jruoho if (Type != ACPI_TYPE_REGION)
523 1.1 jruoho {
524 1.1 jruoho ACPI_ERROR ((AE_INFO, "Needed Region, found type 0x%X (%s)",
525 1.1 jruoho Type, AcpiUtGetTypeName (Type)));
526 1.1 jruoho
527 1.1 jruoho return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
528 1.1 jruoho }
529 1.1 jruoho }
530 1.1 jruoho
531 1.1 jruoho /* Allocate a new field object */
532 1.1 jruoho
533 1.1 jruoho ObjDesc = AcpiUtCreateInternalObject (Info->FieldType);
534 1.1 jruoho if (!ObjDesc)
535 1.1 jruoho {
536 1.1 jruoho return_ACPI_STATUS (AE_NO_MEMORY);
537 1.1 jruoho }
538 1.1 jruoho
539 1.1 jruoho /* Initialize areas of the object that are common to all fields */
540 1.1 jruoho
541 1.1 jruoho ObjDesc->CommonField.Node = Info->FieldNode;
542 1.1 jruoho Status = AcpiExPrepCommonFieldObject (ObjDesc,
543 1.1 jruoho Info->FieldFlags, Info->Attribute,
544 1.1 jruoho Info->FieldBitPosition, Info->FieldBitLength);
545 1.1 jruoho if (ACPI_FAILURE (Status))
546 1.1 jruoho {
547 1.1 jruoho AcpiUtDeleteObjectDesc (ObjDesc);
548 1.1 jruoho return_ACPI_STATUS (Status);
549 1.1 jruoho }
550 1.1 jruoho
551 1.1 jruoho /* Initialize areas of the object that are specific to the field type */
552 1.1 jruoho
553 1.1 jruoho switch (Info->FieldType)
554 1.1 jruoho {
555 1.1 jruoho case ACPI_TYPE_LOCAL_REGION_FIELD:
556 1.1 jruoho
557 1.1 jruoho ObjDesc->Field.RegionObj = AcpiNsGetAttachedObject (Info->RegionNode);
558 1.1 jruoho
559 1.1 jruoho /* Allow full data read from EC address space */
560 1.1 jruoho
561 1.1 jruoho if ((ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_EC) &&
562 1.1 jruoho (ObjDesc->CommonField.BitLength > 8))
563 1.1 jruoho {
564 1.1 jruoho AccessByteWidth = ACPI_ROUND_BITS_UP_TO_BYTES (
565 1.1 jruoho ObjDesc->CommonField.BitLength);
566 1.1 jruoho
567 1.1 jruoho /* Maximum byte width supported is 255 */
568 1.1 jruoho
569 1.1 jruoho if (AccessByteWidth < 256)
570 1.1 jruoho {
571 1.1 jruoho ObjDesc->CommonField.AccessByteWidth = (UINT8) AccessByteWidth;
572 1.1 jruoho }
573 1.1 jruoho }
574 1.1 jruoho
575 1.1 jruoho /* An additional reference for the container */
576 1.1 jruoho
577 1.1 jruoho AcpiUtAddReference (ObjDesc->Field.RegionObj);
578 1.1 jruoho
579 1.1 jruoho ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
580 1.1 jruoho "RegionField: BitOff %X, Off %X, Gran %X, Region %p\n",
581 1.1 jruoho ObjDesc->Field.StartFieldBitOffset, ObjDesc->Field.BaseByteOffset,
582 1.1 jruoho ObjDesc->Field.AccessByteWidth, ObjDesc->Field.RegionObj));
583 1.1 jruoho break;
584 1.1 jruoho
585 1.1 jruoho
586 1.1 jruoho case ACPI_TYPE_LOCAL_BANK_FIELD:
587 1.1 jruoho
588 1.1 jruoho ObjDesc->BankField.Value = Info->BankValue;
589 1.1 jruoho ObjDesc->BankField.RegionObj =
590 1.1 jruoho AcpiNsGetAttachedObject (Info->RegionNode);
591 1.1 jruoho ObjDesc->BankField.BankObj =
592 1.1 jruoho AcpiNsGetAttachedObject (Info->RegisterNode);
593 1.1 jruoho
594 1.1 jruoho /* An additional reference for the attached objects */
595 1.1 jruoho
596 1.1 jruoho AcpiUtAddReference (ObjDesc->BankField.RegionObj);
597 1.1 jruoho AcpiUtAddReference (ObjDesc->BankField.BankObj);
598 1.1 jruoho
599 1.1 jruoho ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
600 1.1 jruoho "Bank Field: BitOff %X, Off %X, Gran %X, Region %p, BankReg %p\n",
601 1.1 jruoho ObjDesc->BankField.StartFieldBitOffset,
602 1.1 jruoho ObjDesc->BankField.BaseByteOffset,
603 1.1 jruoho ObjDesc->Field.AccessByteWidth,
604 1.1 jruoho ObjDesc->BankField.RegionObj,
605 1.1 jruoho ObjDesc->BankField.BankObj));
606 1.1 jruoho
607 1.1 jruoho /*
608 1.1 jruoho * Remember location in AML stream of the field unit
609 1.1 jruoho * opcode and operands -- since the BankValue
610 1.1 jruoho * operands must be evaluated.
611 1.1 jruoho */
612 1.1 jruoho SecondDesc = ObjDesc->Common.NextObject;
613 1.1 jruoho SecondDesc->Extra.AmlStart = ACPI_CAST_PTR (ACPI_PARSE_OBJECT,
614 1.1 jruoho Info->DataRegisterNode)->Named.Data;
615 1.1 jruoho SecondDesc->Extra.AmlLength = ACPI_CAST_PTR (ACPI_PARSE_OBJECT,
616 1.1 jruoho Info->DataRegisterNode)->Named.Length;
617 1.1 jruoho
618 1.1 jruoho break;
619 1.1 jruoho
620 1.1 jruoho
621 1.1 jruoho case ACPI_TYPE_LOCAL_INDEX_FIELD:
622 1.1 jruoho
623 1.1 jruoho /* Get the Index and Data registers */
624 1.1 jruoho
625 1.1 jruoho ObjDesc->IndexField.IndexObj =
626 1.1 jruoho AcpiNsGetAttachedObject (Info->RegisterNode);
627 1.1 jruoho ObjDesc->IndexField.DataObj =
628 1.1 jruoho AcpiNsGetAttachedObject (Info->DataRegisterNode);
629 1.1 jruoho
630 1.1 jruoho if (!ObjDesc->IndexField.DataObj || !ObjDesc->IndexField.IndexObj)
631 1.1 jruoho {
632 1.1 jruoho ACPI_ERROR ((AE_INFO, "Null Index Object during field prep"));
633 1.1 jruoho AcpiUtDeleteObjectDesc (ObjDesc);
634 1.1 jruoho return_ACPI_STATUS (AE_AML_INTERNAL);
635 1.1 jruoho }
636 1.1 jruoho
637 1.1 jruoho /* An additional reference for the attached objects */
638 1.1 jruoho
639 1.1 jruoho AcpiUtAddReference (ObjDesc->IndexField.DataObj);
640 1.1 jruoho AcpiUtAddReference (ObjDesc->IndexField.IndexObj);
641 1.1 jruoho
642 1.1 jruoho /*
643 1.1 jruoho * April 2006: Changed to match MS behavior
644 1.1 jruoho *
645 1.1 jruoho * The value written to the Index register is the byte offset of the
646 1.1 jruoho * target field in units of the granularity of the IndexField
647 1.1 jruoho *
648 1.1 jruoho * Previously, the value was calculated as an index in terms of the
649 1.1 jruoho * width of the Data register, as below:
650 1.1 jruoho *
651 1.1 jruoho * ObjDesc->IndexField.Value = (UINT32)
652 1.1 jruoho * (Info->FieldBitPosition / ACPI_MUL_8 (
653 1.1 jruoho * ObjDesc->Field.AccessByteWidth));
654 1.1 jruoho *
655 1.1 jruoho * February 2006: Tried value as a byte offset:
656 1.1 jruoho * ObjDesc->IndexField.Value = (UINT32)
657 1.1 jruoho * ACPI_DIV_8 (Info->FieldBitPosition);
658 1.1 jruoho */
659 1.1 jruoho ObjDesc->IndexField.Value = (UINT32) ACPI_ROUND_DOWN (
660 1.1 jruoho ACPI_DIV_8 (Info->FieldBitPosition),
661 1.1 jruoho ObjDesc->IndexField.AccessByteWidth);
662 1.1 jruoho
663 1.1 jruoho ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD,
664 1.1 jruoho "IndexField: BitOff %X, Off %X, Value %X, Gran %X, Index %p, Data %p\n",
665 1.1 jruoho ObjDesc->IndexField.StartFieldBitOffset,
666 1.1 jruoho ObjDesc->IndexField.BaseByteOffset,
667 1.1 jruoho ObjDesc->IndexField.Value,
668 1.1 jruoho ObjDesc->Field.AccessByteWidth,
669 1.1 jruoho ObjDesc->IndexField.IndexObj,
670 1.1 jruoho ObjDesc->IndexField.DataObj));
671 1.1 jruoho break;
672 1.1 jruoho
673 1.1 jruoho default:
674 1.1 jruoho /* No other types should get here */
675 1.1 jruoho break;
676 1.1 jruoho }
677 1.1 jruoho
678 1.1 jruoho /*
679 1.1 jruoho * Store the constructed descriptor (ObjDesc) into the parent Node,
680 1.1 jruoho * preserving the current type of that NamedObj.
681 1.1 jruoho */
682 1.1 jruoho Status = AcpiNsAttachObject (Info->FieldNode, ObjDesc,
683 1.1 jruoho AcpiNsGetType (Info->FieldNode));
684 1.1 jruoho
685 1.1 jruoho ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD, "Set NamedObj %p [%4.4s], ObjDesc %p\n",
686 1.1 jruoho Info->FieldNode, AcpiUtGetNodeName (Info->FieldNode), ObjDesc));
687 1.1 jruoho
688 1.1 jruoho /* Remove local reference to the object */
689 1.1 jruoho
690 1.1 jruoho AcpiUtRemoveReference (ObjDesc);
691 1.1 jruoho return_ACPI_STATUS (Status);
692 1.1 jruoho }
693 1.1 jruoho
694