exprep.c revision 1.1.1.2.8.2
1 1.1.1.2.8.2 jruoho 2 1.1.1.2.8.2 jruoho /****************************************************************************** 3 1.1.1.2.8.2 jruoho * 4 1.1.1.2.8.2 jruoho * Module Name: exprep - ACPI AML (p-code) execution - field prep utilities 5 1.1.1.2.8.2 jruoho * 6 1.1.1.2.8.2 jruoho *****************************************************************************/ 7 1.1.1.2.8.2 jruoho 8 1.1.1.2.8.2 jruoho /* 9 1.1.1.2.8.2 jruoho * Copyright (C) 2000 - 2011, Intel Corp. 10 1.1.1.2.8.2 jruoho * All rights reserved. 11 1.1.1.2.8.2 jruoho * 12 1.1.1.2.8.2 jruoho * Redistribution and use in source and binary forms, with or without 13 1.1.1.2.8.2 jruoho * modification, are permitted provided that the following conditions 14 1.1.1.2.8.2 jruoho * are met: 15 1.1.1.2.8.2 jruoho * 1. Redistributions of source code must retain the above copyright 16 1.1.1.2.8.2 jruoho * notice, this list of conditions, and the following disclaimer, 17 1.1.1.2.8.2 jruoho * without modification. 18 1.1.1.2.8.2 jruoho * 2. Redistributions in binary form must reproduce at minimum a disclaimer 19 1.1.1.2.8.2 jruoho * substantially similar to the "NO WARRANTY" disclaimer below 20 1.1.1.2.8.2 jruoho * ("Disclaimer") and any redistribution must be conditioned upon 21 1.1.1.2.8.2 jruoho * including a substantially similar Disclaimer requirement for further 22 1.1.1.2.8.2 jruoho * binary redistribution. 23 1.1.1.2.8.2 jruoho * 3. Neither the names of the above-listed copyright holders nor the names 24 1.1.1.2.8.2 jruoho * of any contributors may be used to endorse or promote products derived 25 1.1.1.2.8.2 jruoho * from this software without specific prior written permission. 26 1.1.1.2.8.2 jruoho * 27 1.1.1.2.8.2 jruoho * Alternatively, this software may be distributed under the terms of the 28 1.1.1.2.8.2 jruoho * GNU General Public License ("GPL") version 2 as published by the Free 29 1.1.1.2.8.2 jruoho * Software Foundation. 30 1.1.1.2.8.2 jruoho * 31 1.1.1.2.8.2 jruoho * NO WARRANTY 32 1.1.1.2.8.2 jruoho * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 33 1.1.1.2.8.2 jruoho * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 34 1.1.1.2.8.2 jruoho * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 35 1.1.1.2.8.2 jruoho * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 36 1.1.1.2.8.2 jruoho * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 37 1.1.1.2.8.2 jruoho * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 38 1.1.1.2.8.2 jruoho * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 39 1.1.1.2.8.2 jruoho * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 40 1.1.1.2.8.2 jruoho * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 41 1.1.1.2.8.2 jruoho * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 42 1.1.1.2.8.2 jruoho * POSSIBILITY OF SUCH DAMAGES. 43 1.1.1.2.8.2 jruoho */ 44 1.1.1.2.8.2 jruoho 45 1.1.1.2.8.2 jruoho #define __EXPREP_C__ 46 1.1.1.2.8.2 jruoho 47 1.1.1.2.8.2 jruoho #include "acpi.h" 48 1.1.1.2.8.2 jruoho #include "accommon.h" 49 1.1.1.2.8.2 jruoho #include "acinterp.h" 50 1.1.1.2.8.2 jruoho #include "amlcode.h" 51 1.1.1.2.8.2 jruoho #include "acnamesp.h" 52 1.1.1.2.8.2 jruoho 53 1.1.1.2.8.2 jruoho 54 1.1.1.2.8.2 jruoho #define _COMPONENT ACPI_EXECUTER 55 1.1.1.2.8.2 jruoho ACPI_MODULE_NAME ("exprep") 56 1.1.1.2.8.2 jruoho 57 1.1.1.2.8.2 jruoho /* Local prototypes */ 58 1.1.1.2.8.2 jruoho 59 1.1.1.2.8.2 jruoho static UINT32 60 1.1.1.2.8.2 jruoho AcpiExDecodeFieldAccess ( 61 1.1.1.2.8.2 jruoho ACPI_OPERAND_OBJECT *ObjDesc, 62 1.1.1.2.8.2 jruoho UINT8 FieldFlags, 63 1.1.1.2.8.2 jruoho UINT32 *ReturnByteAlignment); 64 1.1.1.2.8.2 jruoho 65 1.1.1.2.8.2 jruoho 66 1.1.1.2.8.2 jruoho #ifdef ACPI_UNDER_DEVELOPMENT 67 1.1.1.2.8.2 jruoho 68 1.1.1.2.8.2 jruoho static UINT32 69 1.1.1.2.8.2 jruoho AcpiExGenerateAccess ( 70 1.1.1.2.8.2 jruoho UINT32 FieldBitOffset, 71 1.1.1.2.8.2 jruoho UINT32 FieldBitLength, 72 1.1.1.2.8.2 jruoho UINT32 RegionLength); 73 1.1.1.2.8.2 jruoho 74 1.1.1.2.8.2 jruoho /******************************************************************************* 75 1.1.1.2.8.2 jruoho * 76 1.1.1.2.8.2 jruoho * FUNCTION: AcpiExGenerateAccess 77 1.1.1.2.8.2 jruoho * 78 1.1.1.2.8.2 jruoho * PARAMETERS: FieldBitOffset - Start of field within parent region/buffer 79 1.1.1.2.8.2 jruoho * FieldBitLength - Length of field in bits 80 1.1.1.2.8.2 jruoho * RegionLength - Length of parent in bytes 81 1.1.1.2.8.2 jruoho * 82 1.1.1.2.8.2 jruoho * RETURN: Field granularity (8, 16, 32 or 64) and 83 1.1.1.2.8.2 jruoho * ByteAlignment (1, 2, 3, or 4) 84 1.1.1.2.8.2 jruoho * 85 1.1.1.2.8.2 jruoho * DESCRIPTION: Generate an optimal access width for fields defined with the 86 1.1.1.2.8.2 jruoho * AnyAcc keyword. 87 1.1.1.2.8.2 jruoho * 88 1.1.1.2.8.2 jruoho * NOTE: Need to have the RegionLength in order to check for boundary 89 1.1.1.2.8.2 jruoho * conditions (end-of-region). However, the RegionLength is a deferred 90 1.1.1.2.8.2 jruoho * operation. Therefore, to complete this implementation, the generation 91 1.1.1.2.8.2 jruoho * of this access width must be deferred until the region length has 92 1.1.1.2.8.2 jruoho * been evaluated. 93 1.1.1.2.8.2 jruoho * 94 1.1.1.2.8.2 jruoho ******************************************************************************/ 95 1.1.1.2.8.2 jruoho 96 1.1.1.2.8.2 jruoho static UINT32 97 1.1.1.2.8.2 jruoho AcpiExGenerateAccess ( 98 1.1.1.2.8.2 jruoho UINT32 FieldBitOffset, 99 1.1.1.2.8.2 jruoho UINT32 FieldBitLength, 100 1.1.1.2.8.2 jruoho UINT32 RegionLength) 101 1.1.1.2.8.2 jruoho { 102 1.1.1.2.8.2 jruoho UINT32 FieldByteLength; 103 1.1.1.2.8.2 jruoho UINT32 FieldByteOffset; 104 1.1.1.2.8.2 jruoho UINT32 FieldByteEndOffset; 105 1.1.1.2.8.2 jruoho UINT32 AccessByteWidth; 106 1.1.1.2.8.2 jruoho UINT32 FieldStartOffset; 107 1.1.1.2.8.2 jruoho UINT32 FieldEndOffset; 108 1.1.1.2.8.2 jruoho UINT32 MinimumAccessWidth = 0xFFFFFFFF; 109 1.1.1.2.8.2 jruoho UINT32 MinimumAccesses = 0xFFFFFFFF; 110 1.1.1.2.8.2 jruoho UINT32 Accesses; 111 1.1.1.2.8.2 jruoho 112 1.1.1.2.8.2 jruoho 113 1.1.1.2.8.2 jruoho ACPI_FUNCTION_TRACE (ExGenerateAccess); 114 1.1.1.2.8.2 jruoho 115 1.1.1.2.8.2 jruoho 116 1.1.1.2.8.2 jruoho /* Round Field start offset and length to "minimal" byte boundaries */ 117 1.1.1.2.8.2 jruoho 118 1.1.1.2.8.2 jruoho FieldByteOffset = ACPI_DIV_8 (ACPI_ROUND_DOWN (FieldBitOffset, 8)); 119 1.1.1.2.8.2 jruoho FieldByteEndOffset = ACPI_DIV_8 (ACPI_ROUND_UP (FieldBitLength + 120 1.1.1.2.8.2 jruoho FieldBitOffset, 8)); 121 1.1.1.2.8.2 jruoho FieldByteLength = FieldByteEndOffset - FieldByteOffset; 122 1.1.1.2.8.2 jruoho 123 1.1.1.2.8.2 jruoho ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD, 124 1.1.1.2.8.2 jruoho "Bit length %u, Bit offset %u\n", 125 1.1.1.2.8.2 jruoho FieldBitLength, FieldBitOffset)); 126 1.1.1.2.8.2 jruoho 127 1.1.1.2.8.2 jruoho ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD, 128 1.1.1.2.8.2 jruoho "Byte Length %u, Byte Offset %u, End Offset %u\n", 129 1.1.1.2.8.2 jruoho FieldByteLength, FieldByteOffset, FieldByteEndOffset)); 130 1.1.1.2.8.2 jruoho 131 1.1.1.2.8.2 jruoho /* 132 1.1.1.2.8.2 jruoho * Iterative search for the maximum access width that is both aligned 133 1.1.1.2.8.2 jruoho * and does not go beyond the end of the region 134 1.1.1.2.8.2 jruoho * 135 1.1.1.2.8.2 jruoho * Start at ByteAcc and work upwards to QwordAcc max. (1,2,4,8 bytes) 136 1.1.1.2.8.2 jruoho */ 137 1.1.1.2.8.2 jruoho for (AccessByteWidth = 1; AccessByteWidth <= 8; AccessByteWidth <<= 1) 138 1.1.1.2.8.2 jruoho { 139 1.1.1.2.8.2 jruoho /* 140 1.1.1.2.8.2 jruoho * 1) Round end offset up to next access boundary and make sure that 141 1.1.1.2.8.2 jruoho * this does not go beyond the end of the parent region. 142 1.1.1.2.8.2 jruoho * 2) When the Access width is greater than the FieldByteLength, we 143 1.1.1.2.8.2 jruoho * are done. (This does not optimize for the perfectly aligned 144 1.1.1.2.8.2 jruoho * case yet). 145 1.1.1.2.8.2 jruoho */ 146 1.1.1.2.8.2 jruoho if (ACPI_ROUND_UP (FieldByteEndOffset, AccessByteWidth) <= RegionLength) 147 1.1.1.2.8.2 jruoho { 148 1.1.1.2.8.2 jruoho FieldStartOffset = 149 1.1.1.2.8.2 jruoho ACPI_ROUND_DOWN (FieldByteOffset, AccessByteWidth) / 150 1.1.1.2.8.2 jruoho AccessByteWidth; 151 1.1.1.2.8.2 jruoho 152 1.1.1.2.8.2 jruoho FieldEndOffset = 153 1.1.1.2.8.2 jruoho ACPI_ROUND_UP ((FieldByteLength + FieldByteOffset), 154 1.1.1.2.8.2 jruoho AccessByteWidth) / AccessByteWidth; 155 1.1.1.2.8.2 jruoho 156 1.1.1.2.8.2 jruoho Accesses = FieldEndOffset - FieldStartOffset; 157 1.1.1.2.8.2 jruoho 158 1.1.1.2.8.2 jruoho ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD, 159 1.1.1.2.8.2 jruoho "AccessWidth %u end is within region\n", AccessByteWidth)); 160 1.1.1.2.8.2 jruoho 161 1.1.1.2.8.2 jruoho ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD, 162 1.1.1.2.8.2 jruoho "Field Start %u, Field End %u -- requires %u accesses\n", 163 1.1.1.2.8.2 jruoho FieldStartOffset, FieldEndOffset, Accesses)); 164 1.1.1.2.8.2 jruoho 165 1.1.1.2.8.2 jruoho /* Single access is optimal */ 166 1.1.1.2.8.2 jruoho 167 1.1.1.2.8.2 jruoho if (Accesses <= 1) 168 1.1.1.2.8.2 jruoho { 169 1.1.1.2.8.2 jruoho ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD, 170 1.1.1.2.8.2 jruoho "Entire field can be accessed with one operation of size %u\n", 171 1.1.1.2.8.2 jruoho AccessByteWidth)); 172 1.1.1.2.8.2 jruoho return_VALUE (AccessByteWidth); 173 1.1.1.2.8.2 jruoho } 174 1.1.1.2.8.2 jruoho 175 1.1.1.2.8.2 jruoho /* 176 1.1.1.2.8.2 jruoho * Fits in the region, but requires more than one read/write. 177 1.1.1.2.8.2 jruoho * try the next wider access on next iteration 178 1.1.1.2.8.2 jruoho */ 179 1.1.1.2.8.2 jruoho if (Accesses < MinimumAccesses) 180 1.1.1.2.8.2 jruoho { 181 1.1.1.2.8.2 jruoho MinimumAccesses = Accesses; 182 1.1.1.2.8.2 jruoho MinimumAccessWidth = AccessByteWidth; 183 1.1.1.2.8.2 jruoho } 184 1.1.1.2.8.2 jruoho } 185 1.1.1.2.8.2 jruoho else 186 1.1.1.2.8.2 jruoho { 187 1.1.1.2.8.2 jruoho ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD, 188 1.1.1.2.8.2 jruoho "AccessWidth %u end is NOT within region\n", AccessByteWidth)); 189 1.1.1.2.8.2 jruoho if (AccessByteWidth == 1) 190 1.1.1.2.8.2 jruoho { 191 1.1.1.2.8.2 jruoho ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD, 192 1.1.1.2.8.2 jruoho "Field goes beyond end-of-region!\n")); 193 1.1.1.2.8.2 jruoho 194 1.1.1.2.8.2 jruoho /* Field does not fit in the region at all */ 195 1.1.1.2.8.2 jruoho 196 1.1.1.2.8.2 jruoho return_VALUE (0); 197 1.1.1.2.8.2 jruoho } 198 1.1.1.2.8.2 jruoho 199 1.1.1.2.8.2 jruoho /* 200 1.1.1.2.8.2 jruoho * This width goes beyond the end-of-region, back off to 201 1.1.1.2.8.2 jruoho * previous access 202 1.1.1.2.8.2 jruoho */ 203 1.1.1.2.8.2 jruoho ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD, 204 1.1.1.2.8.2 jruoho "Backing off to previous optimal access width of %u\n", 205 1.1.1.2.8.2 jruoho MinimumAccessWidth)); 206 1.1.1.2.8.2 jruoho return_VALUE (MinimumAccessWidth); 207 1.1.1.2.8.2 jruoho } 208 1.1.1.2.8.2 jruoho } 209 1.1.1.2.8.2 jruoho 210 1.1.1.2.8.2 jruoho /* 211 1.1.1.2.8.2 jruoho * Could not read/write field with one operation, 212 1.1.1.2.8.2 jruoho * just use max access width 213 1.1.1.2.8.2 jruoho */ 214 1.1.1.2.8.2 jruoho ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD, 215 1.1.1.2.8.2 jruoho "Cannot access field in one operation, using width 8\n")); 216 1.1.1.2.8.2 jruoho return_VALUE (8); 217 1.1.1.2.8.2 jruoho } 218 1.1.1.2.8.2 jruoho #endif /* ACPI_UNDER_DEVELOPMENT */ 219 1.1.1.2.8.2 jruoho 220 1.1.1.2.8.2 jruoho 221 1.1.1.2.8.2 jruoho /******************************************************************************* 222 1.1.1.2.8.2 jruoho * 223 1.1.1.2.8.2 jruoho * FUNCTION: AcpiExDecodeFieldAccess 224 1.1.1.2.8.2 jruoho * 225 1.1.1.2.8.2 jruoho * PARAMETERS: ObjDesc - Field object 226 1.1.1.2.8.2 jruoho * FieldFlags - Encoded fieldflags (contains access bits) 227 1.1.1.2.8.2 jruoho * ReturnByteAlignment - Where the byte alignment is returned 228 1.1.1.2.8.2 jruoho * 229 1.1.1.2.8.2 jruoho * RETURN: Field granularity (8, 16, 32 or 64) and 230 1.1.1.2.8.2 jruoho * ByteAlignment (1, 2, 3, or 4) 231 1.1.1.2.8.2 jruoho * 232 1.1.1.2.8.2 jruoho * DESCRIPTION: Decode the AccessType bits of a field definition. 233 1.1.1.2.8.2 jruoho * 234 1.1.1.2.8.2 jruoho ******************************************************************************/ 235 1.1.1.2.8.2 jruoho 236 1.1.1.2.8.2 jruoho static UINT32 237 1.1.1.2.8.2 jruoho AcpiExDecodeFieldAccess ( 238 1.1.1.2.8.2 jruoho ACPI_OPERAND_OBJECT *ObjDesc, 239 1.1.1.2.8.2 jruoho UINT8 FieldFlags, 240 1.1.1.2.8.2 jruoho UINT32 *ReturnByteAlignment) 241 1.1.1.2.8.2 jruoho { 242 1.1.1.2.8.2 jruoho UINT32 Access; 243 1.1.1.2.8.2 jruoho UINT32 ByteAlignment; 244 1.1.1.2.8.2 jruoho UINT32 BitLength; 245 1.1.1.2.8.2 jruoho 246 1.1.1.2.8.2 jruoho 247 1.1.1.2.8.2 jruoho ACPI_FUNCTION_TRACE (ExDecodeFieldAccess); 248 1.1.1.2.8.2 jruoho 249 1.1.1.2.8.2 jruoho 250 1.1.1.2.8.2 jruoho Access = (FieldFlags & AML_FIELD_ACCESS_TYPE_MASK); 251 1.1.1.2.8.2 jruoho 252 1.1.1.2.8.2 jruoho switch (Access) 253 1.1.1.2.8.2 jruoho { 254 1.1.1.2.8.2 jruoho case AML_FIELD_ACCESS_ANY: 255 1.1.1.2.8.2 jruoho 256 1.1.1.2.8.2 jruoho #ifdef ACPI_UNDER_DEVELOPMENT 257 1.1.1.2.8.2 jruoho ByteAlignment = 258 1.1.1.2.8.2 jruoho AcpiExGenerateAccess (ObjDesc->CommonField.StartFieldBitOffset, 259 1.1.1.2.8.2 jruoho ObjDesc->CommonField.BitLength, 260 1.1.1.2.8.2 jruoho 0xFFFFFFFF /* Temp until we pass RegionLength as parameter */); 261 1.1.1.2.8.2 jruoho BitLength = ByteAlignment * 8; 262 1.1.1.2.8.2 jruoho #endif 263 1.1.1.2.8.2 jruoho 264 1.1.1.2.8.2 jruoho ByteAlignment = 1; 265 1.1.1.2.8.2 jruoho BitLength = 8; 266 1.1.1.2.8.2 jruoho break; 267 1.1.1.2.8.2 jruoho 268 1.1.1.2.8.2 jruoho case AML_FIELD_ACCESS_BYTE: 269 1.1.1.2.8.2 jruoho case AML_FIELD_ACCESS_BUFFER: /* ACPI 2.0 (SMBus Buffer) */ 270 1.1.1.2.8.2 jruoho ByteAlignment = 1; 271 1.1.1.2.8.2 jruoho BitLength = 8; 272 1.1.1.2.8.2 jruoho break; 273 1.1.1.2.8.2 jruoho 274 1.1.1.2.8.2 jruoho case AML_FIELD_ACCESS_WORD: 275 1.1.1.2.8.2 jruoho ByteAlignment = 2; 276 1.1.1.2.8.2 jruoho BitLength = 16; 277 1.1.1.2.8.2 jruoho break; 278 1.1.1.2.8.2 jruoho 279 1.1.1.2.8.2 jruoho case AML_FIELD_ACCESS_DWORD: 280 1.1.1.2.8.2 jruoho ByteAlignment = 4; 281 1.1.1.2.8.2 jruoho BitLength = 32; 282 1.1.1.2.8.2 jruoho break; 283 1.1.1.2.8.2 jruoho 284 1.1.1.2.8.2 jruoho case AML_FIELD_ACCESS_QWORD: /* ACPI 2.0 */ 285 1.1.1.2.8.2 jruoho ByteAlignment = 8; 286 1.1.1.2.8.2 jruoho BitLength = 64; 287 1.1.1.2.8.2 jruoho break; 288 1.1.1.2.8.2 jruoho 289 1.1.1.2.8.2 jruoho default: 290 1.1.1.2.8.2 jruoho /* Invalid field access type */ 291 1.1.1.2.8.2 jruoho 292 1.1.1.2.8.2 jruoho ACPI_ERROR ((AE_INFO, 293 1.1.1.2.8.2 jruoho "Unknown field access type 0x%X", 294 1.1.1.2.8.2 jruoho Access)); 295 1.1.1.2.8.2 jruoho return_UINT32 (0); 296 1.1.1.2.8.2 jruoho } 297 1.1.1.2.8.2 jruoho 298 1.1.1.2.8.2 jruoho if (ObjDesc->Common.Type == ACPI_TYPE_BUFFER_FIELD) 299 1.1.1.2.8.2 jruoho { 300 1.1.1.2.8.2 jruoho /* 301 1.1.1.2.8.2 jruoho * BufferField access can be on any byte boundary, so the 302 1.1.1.2.8.2 jruoho * ByteAlignment is always 1 byte -- regardless of any ByteAlignment 303 1.1.1.2.8.2 jruoho * implied by the field access type. 304 1.1.1.2.8.2 jruoho */ 305 1.1.1.2.8.2 jruoho ByteAlignment = 1; 306 1.1.1.2.8.2 jruoho } 307 1.1.1.2.8.2 jruoho 308 1.1.1.2.8.2 jruoho *ReturnByteAlignment = ByteAlignment; 309 1.1.1.2.8.2 jruoho return_UINT32 (BitLength); 310 1.1.1.2.8.2 jruoho } 311 1.1.1.2.8.2 jruoho 312 1.1.1.2.8.2 jruoho 313 1.1.1.2.8.2 jruoho /******************************************************************************* 314 1.1.1.2.8.2 jruoho * 315 1.1.1.2.8.2 jruoho * FUNCTION: AcpiExPrepCommonFieldObject 316 1.1.1.2.8.2 jruoho * 317 1.1.1.2.8.2 jruoho * PARAMETERS: ObjDesc - The field object 318 1.1.1.2.8.2 jruoho * FieldFlags - Access, LockRule, and UpdateRule. 319 1.1.1.2.8.2 jruoho * The format of a FieldFlag is described 320 1.1.1.2.8.2 jruoho * in the ACPI specification 321 1.1.1.2.8.2 jruoho * FieldAttribute - Special attributes (not used) 322 1.1.1.2.8.2 jruoho * FieldBitPosition - Field start position 323 1.1.1.2.8.2 jruoho * FieldBitLength - Field length in number of bits 324 1.1.1.2.8.2 jruoho * 325 1.1.1.2.8.2 jruoho * RETURN: Status 326 1.1.1.2.8.2 jruoho * 327 1.1.1.2.8.2 jruoho * DESCRIPTION: Initialize the areas of the field object that are common 328 1.1.1.2.8.2 jruoho * to the various types of fields. Note: This is very "sensitive" 329 1.1.1.2.8.2 jruoho * code because we are solving the general case for field 330 1.1.1.2.8.2 jruoho * alignment. 331 1.1.1.2.8.2 jruoho * 332 1.1.1.2.8.2 jruoho ******************************************************************************/ 333 1.1.1.2.8.2 jruoho 334 1.1.1.2.8.2 jruoho ACPI_STATUS 335 1.1.1.2.8.2 jruoho AcpiExPrepCommonFieldObject ( 336 1.1.1.2.8.2 jruoho ACPI_OPERAND_OBJECT *ObjDesc, 337 1.1.1.2.8.2 jruoho UINT8 FieldFlags, 338 1.1.1.2.8.2 jruoho UINT8 FieldAttribute, 339 1.1.1.2.8.2 jruoho UINT32 FieldBitPosition, 340 1.1.1.2.8.2 jruoho UINT32 FieldBitLength) 341 1.1.1.2.8.2 jruoho { 342 1.1.1.2.8.2 jruoho UINT32 AccessBitWidth; 343 1.1.1.2.8.2 jruoho UINT32 ByteAlignment; 344 1.1.1.2.8.2 jruoho UINT32 NearestByteAddress; 345 1.1.1.2.8.2 jruoho 346 1.1.1.2.8.2 jruoho 347 1.1.1.2.8.2 jruoho ACPI_FUNCTION_TRACE (ExPrepCommonFieldObject); 348 1.1.1.2.8.2 jruoho 349 1.1.1.2.8.2 jruoho 350 1.1.1.2.8.2 jruoho /* 351 1.1.1.2.8.2 jruoho * Note: the structure being initialized is the 352 1.1.1.2.8.2 jruoho * ACPI_COMMON_FIELD_INFO; No structure fields outside of the common 353 1.1.1.2.8.2 jruoho * area are initialized by this procedure. 354 1.1.1.2.8.2 jruoho */ 355 1.1.1.2.8.2 jruoho ObjDesc->CommonField.FieldFlags = FieldFlags; 356 1.1.1.2.8.2 jruoho ObjDesc->CommonField.Attribute = FieldAttribute; 357 1.1.1.2.8.2 jruoho ObjDesc->CommonField.BitLength = FieldBitLength; 358 1.1.1.2.8.2 jruoho 359 1.1.1.2.8.2 jruoho /* 360 1.1.1.2.8.2 jruoho * Decode the access type so we can compute offsets. The access type gives 361 1.1.1.2.8.2 jruoho * two pieces of information - the width of each field access and the 362 1.1.1.2.8.2 jruoho * necessary ByteAlignment (address granularity) of the access. 363 1.1.1.2.8.2 jruoho * 364 1.1.1.2.8.2 jruoho * For AnyAcc, the AccessBitWidth is the largest width that is both 365 1.1.1.2.8.2 jruoho * necessary and possible in an attempt to access the whole field in one 366 1.1.1.2.8.2 jruoho * I/O operation. However, for AnyAcc, the ByteAlignment is always one 367 1.1.1.2.8.2 jruoho * byte. 368 1.1.1.2.8.2 jruoho * 369 1.1.1.2.8.2 jruoho * For all Buffer Fields, the ByteAlignment is always one byte. 370 1.1.1.2.8.2 jruoho * 371 1.1.1.2.8.2 jruoho * For all other access types (Byte, Word, Dword, Qword), the Bitwidth is 372 1.1.1.2.8.2 jruoho * the same (equivalent) as the ByteAlignment. 373 1.1.1.2.8.2 jruoho */ 374 1.1.1.2.8.2 jruoho AccessBitWidth = AcpiExDecodeFieldAccess (ObjDesc, FieldFlags, 375 1.1.1.2.8.2 jruoho &ByteAlignment); 376 1.1.1.2.8.2 jruoho if (!AccessBitWidth) 377 1.1.1.2.8.2 jruoho { 378 1.1.1.2.8.2 jruoho return_ACPI_STATUS (AE_AML_OPERAND_VALUE); 379 1.1.1.2.8.2 jruoho } 380 1.1.1.2.8.2 jruoho 381 1.1.1.2.8.2 jruoho /* Setup width (access granularity) fields (values are: 1, 2, 4, 8) */ 382 1.1.1.2.8.2 jruoho 383 1.1.1.2.8.2 jruoho ObjDesc->CommonField.AccessByteWidth = (UINT8) 384 1.1.1.2.8.2 jruoho ACPI_DIV_8 (AccessBitWidth); 385 1.1.1.2.8.2 jruoho 386 1.1.1.2.8.2 jruoho /* 387 1.1.1.2.8.2 jruoho * BaseByteOffset is the address of the start of the field within the 388 1.1.1.2.8.2 jruoho * region. It is the byte address of the first *datum* (field-width data 389 1.1.1.2.8.2 jruoho * unit) of the field. (i.e., the first datum that contains at least the 390 1.1.1.2.8.2 jruoho * first *bit* of the field.) 391 1.1.1.2.8.2 jruoho * 392 1.1.1.2.8.2 jruoho * Note: ByteAlignment is always either equal to the AccessBitWidth or 8 393 1.1.1.2.8.2 jruoho * (Byte access), and it defines the addressing granularity of the parent 394 1.1.1.2.8.2 jruoho * region or buffer. 395 1.1.1.2.8.2 jruoho */ 396 1.1.1.2.8.2 jruoho NearestByteAddress = 397 1.1.1.2.8.2 jruoho ACPI_ROUND_BITS_DOWN_TO_BYTES (FieldBitPosition); 398 1.1.1.2.8.2 jruoho ObjDesc->CommonField.BaseByteOffset = (UINT32) 399 1.1.1.2.8.2 jruoho ACPI_ROUND_DOWN (NearestByteAddress, ByteAlignment); 400 1.1.1.2.8.2 jruoho 401 1.1.1.2.8.2 jruoho /* 402 1.1.1.2.8.2 jruoho * StartFieldBitOffset is the offset of the first bit of the field within 403 1.1.1.2.8.2 jruoho * a field datum. 404 1.1.1.2.8.2 jruoho */ 405 1.1.1.2.8.2 jruoho ObjDesc->CommonField.StartFieldBitOffset = (UINT8) 406 1.1.1.2.8.2 jruoho (FieldBitPosition - ACPI_MUL_8 (ObjDesc->CommonField.BaseByteOffset)); 407 1.1.1.2.8.2 jruoho 408 1.1.1.2.8.2 jruoho return_ACPI_STATUS (AE_OK); 409 1.1.1.2.8.2 jruoho } 410 1.1.1.2.8.2 jruoho 411 1.1.1.2.8.2 jruoho 412 1.1.1.2.8.2 jruoho /******************************************************************************* 413 1.1.1.2.8.2 jruoho * 414 1.1.1.2.8.2 jruoho * FUNCTION: AcpiExPrepFieldValue 415 1.1.1.2.8.2 jruoho * 416 1.1.1.2.8.2 jruoho * PARAMETERS: Info - Contains all field creation info 417 1.1.1.2.8.2 jruoho * 418 1.1.1.2.8.2 jruoho * RETURN: Status 419 1.1.1.2.8.2 jruoho * 420 1.1.1.2.8.2 jruoho * DESCRIPTION: Construct an ACPI_OPERAND_OBJECT of type DefField and 421 1.1.1.2.8.2 jruoho * connect it to the parent Node. 422 1.1.1.2.8.2 jruoho * 423 1.1.1.2.8.2 jruoho ******************************************************************************/ 424 1.1.1.2.8.2 jruoho 425 1.1.1.2.8.2 jruoho ACPI_STATUS 426 1.1.1.2.8.2 jruoho AcpiExPrepFieldValue ( 427 1.1.1.2.8.2 jruoho ACPI_CREATE_FIELD_INFO *Info) 428 1.1.1.2.8.2 jruoho { 429 1.1.1.2.8.2 jruoho ACPI_OPERAND_OBJECT *ObjDesc; 430 1.1.1.2.8.2 jruoho ACPI_OPERAND_OBJECT *SecondDesc = NULL; 431 1.1.1.2.8.2 jruoho ACPI_STATUS Status; 432 1.1.1.2.8.2 jruoho UINT32 AccessByteWidth; 433 1.1.1.2.8.2 jruoho UINT32 Type; 434 1.1.1.2.8.2 jruoho 435 1.1.1.2.8.2 jruoho 436 1.1.1.2.8.2 jruoho ACPI_FUNCTION_TRACE (ExPrepFieldValue); 437 1.1.1.2.8.2 jruoho 438 1.1.1.2.8.2 jruoho 439 1.1.1.2.8.2 jruoho /* Parameter validation */ 440 1.1.1.2.8.2 jruoho 441 1.1.1.2.8.2 jruoho if (Info->FieldType != ACPI_TYPE_LOCAL_INDEX_FIELD) 442 1.1.1.2.8.2 jruoho { 443 1.1.1.2.8.2 jruoho if (!Info->RegionNode) 444 1.1.1.2.8.2 jruoho { 445 1.1.1.2.8.2 jruoho ACPI_ERROR ((AE_INFO, "Null RegionNode")); 446 1.1.1.2.8.2 jruoho return_ACPI_STATUS (AE_AML_NO_OPERAND); 447 1.1.1.2.8.2 jruoho } 448 1.1.1.2.8.2 jruoho 449 1.1.1.2.8.2 jruoho Type = AcpiNsGetType (Info->RegionNode); 450 1.1.1.2.8.2 jruoho if (Type != ACPI_TYPE_REGION) 451 1.1.1.2.8.2 jruoho { 452 1.1.1.2.8.2 jruoho ACPI_ERROR ((AE_INFO, "Needed Region, found type 0x%X (%s)", 453 1.1.1.2.8.2 jruoho Type, AcpiUtGetTypeName (Type))); 454 1.1.1.2.8.2 jruoho 455 1.1.1.2.8.2 jruoho return_ACPI_STATUS (AE_AML_OPERAND_TYPE); 456 1.1.1.2.8.2 jruoho } 457 1.1.1.2.8.2 jruoho } 458 1.1.1.2.8.2 jruoho 459 1.1.1.2.8.2 jruoho /* Allocate a new field object */ 460 1.1.1.2.8.2 jruoho 461 1.1.1.2.8.2 jruoho ObjDesc = AcpiUtCreateInternalObject (Info->FieldType); 462 1.1.1.2.8.2 jruoho if (!ObjDesc) 463 1.1.1.2.8.2 jruoho { 464 1.1.1.2.8.2 jruoho return_ACPI_STATUS (AE_NO_MEMORY); 465 1.1.1.2.8.2 jruoho } 466 1.1.1.2.8.2 jruoho 467 1.1.1.2.8.2 jruoho /* Initialize areas of the object that are common to all fields */ 468 1.1.1.2.8.2 jruoho 469 1.1.1.2.8.2 jruoho ObjDesc->CommonField.Node = Info->FieldNode; 470 1.1.1.2.8.2 jruoho Status = AcpiExPrepCommonFieldObject (ObjDesc, 471 1.1.1.2.8.2 jruoho Info->FieldFlags, Info->Attribute, 472 1.1.1.2.8.2 jruoho Info->FieldBitPosition, Info->FieldBitLength); 473 1.1.1.2.8.2 jruoho if (ACPI_FAILURE (Status)) 474 1.1.1.2.8.2 jruoho { 475 1.1.1.2.8.2 jruoho AcpiUtDeleteObjectDesc (ObjDesc); 476 1.1.1.2.8.2 jruoho return_ACPI_STATUS (Status); 477 1.1.1.2.8.2 jruoho } 478 1.1.1.2.8.2 jruoho 479 1.1.1.2.8.2 jruoho /* Initialize areas of the object that are specific to the field type */ 480 1.1.1.2.8.2 jruoho 481 1.1.1.2.8.2 jruoho switch (Info->FieldType) 482 1.1.1.2.8.2 jruoho { 483 1.1.1.2.8.2 jruoho case ACPI_TYPE_LOCAL_REGION_FIELD: 484 1.1.1.2.8.2 jruoho 485 1.1.1.2.8.2 jruoho ObjDesc->Field.RegionObj = AcpiNsGetAttachedObject (Info->RegionNode); 486 1.1.1.2.8.2 jruoho 487 1.1.1.2.8.2 jruoho /* Allow full data read from EC address space */ 488 1.1.1.2.8.2 jruoho 489 1.1.1.2.8.2 jruoho if ((ObjDesc->Field.RegionObj->Region.SpaceId == ACPI_ADR_SPACE_EC) && 490 1.1.1.2.8.2 jruoho (ObjDesc->CommonField.BitLength > 8)) 491 1.1.1.2.8.2 jruoho { 492 1.1.1.2.8.2 jruoho AccessByteWidth = ACPI_ROUND_BITS_UP_TO_BYTES ( 493 1.1.1.2.8.2 jruoho ObjDesc->CommonField.BitLength); 494 1.1.1.2.8.2 jruoho 495 1.1.1.2.8.2 jruoho /* Maximum byte width supported is 255 */ 496 1.1.1.2.8.2 jruoho 497 1.1.1.2.8.2 jruoho if (AccessByteWidth < 256) 498 1.1.1.2.8.2 jruoho { 499 1.1.1.2.8.2 jruoho ObjDesc->CommonField.AccessByteWidth = (UINT8) AccessByteWidth; 500 1.1.1.2.8.2 jruoho } 501 1.1.1.2.8.2 jruoho } 502 1.1.1.2.8.2 jruoho 503 1.1.1.2.8.2 jruoho /* An additional reference for the container */ 504 1.1.1.2.8.2 jruoho 505 1.1.1.2.8.2 jruoho AcpiUtAddReference (ObjDesc->Field.RegionObj); 506 1.1.1.2.8.2 jruoho 507 1.1.1.2.8.2 jruoho ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD, 508 1.1.1.2.8.2 jruoho "RegionField: BitOff %X, Off %X, Gran %X, Region %p\n", 509 1.1.1.2.8.2 jruoho ObjDesc->Field.StartFieldBitOffset, ObjDesc->Field.BaseByteOffset, 510 1.1.1.2.8.2 jruoho ObjDesc->Field.AccessByteWidth, ObjDesc->Field.RegionObj)); 511 1.1.1.2.8.2 jruoho break; 512 1.1.1.2.8.2 jruoho 513 1.1.1.2.8.2 jruoho 514 1.1.1.2.8.2 jruoho case ACPI_TYPE_LOCAL_BANK_FIELD: 515 1.1.1.2.8.2 jruoho 516 1.1.1.2.8.2 jruoho ObjDesc->BankField.Value = Info->BankValue; 517 1.1.1.2.8.2 jruoho ObjDesc->BankField.RegionObj = 518 1.1.1.2.8.2 jruoho AcpiNsGetAttachedObject (Info->RegionNode); 519 1.1.1.2.8.2 jruoho ObjDesc->BankField.BankObj = 520 1.1.1.2.8.2 jruoho AcpiNsGetAttachedObject (Info->RegisterNode); 521 1.1.1.2.8.2 jruoho 522 1.1.1.2.8.2 jruoho /* An additional reference for the attached objects */ 523 1.1.1.2.8.2 jruoho 524 1.1.1.2.8.2 jruoho AcpiUtAddReference (ObjDesc->BankField.RegionObj); 525 1.1.1.2.8.2 jruoho AcpiUtAddReference (ObjDesc->BankField.BankObj); 526 1.1.1.2.8.2 jruoho 527 1.1.1.2.8.2 jruoho ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD, 528 1.1.1.2.8.2 jruoho "Bank Field: BitOff %X, Off %X, Gran %X, Region %p, BankReg %p\n", 529 1.1.1.2.8.2 jruoho ObjDesc->BankField.StartFieldBitOffset, 530 1.1.1.2.8.2 jruoho ObjDesc->BankField.BaseByteOffset, 531 1.1.1.2.8.2 jruoho ObjDesc->Field.AccessByteWidth, 532 1.1.1.2.8.2 jruoho ObjDesc->BankField.RegionObj, 533 1.1.1.2.8.2 jruoho ObjDesc->BankField.BankObj)); 534 1.1.1.2.8.2 jruoho 535 1.1.1.2.8.2 jruoho /* 536 1.1.1.2.8.2 jruoho * Remember location in AML stream of the field unit 537 1.1.1.2.8.2 jruoho * opcode and operands -- since the BankValue 538 1.1.1.2.8.2 jruoho * operands must be evaluated. 539 1.1.1.2.8.2 jruoho */ 540 1.1.1.2.8.2 jruoho SecondDesc = ObjDesc->Common.NextObject; 541 1.1.1.2.8.2 jruoho SecondDesc->Extra.AmlStart = ACPI_CAST_PTR (ACPI_PARSE_OBJECT, 542 1.1.1.2.8.2 jruoho Info->DataRegisterNode)->Named.Data; 543 1.1.1.2.8.2 jruoho SecondDesc->Extra.AmlLength = ACPI_CAST_PTR (ACPI_PARSE_OBJECT, 544 1.1.1.2.8.2 jruoho Info->DataRegisterNode)->Named.Length; 545 1.1.1.2.8.2 jruoho 546 1.1.1.2.8.2 jruoho break; 547 1.1.1.2.8.2 jruoho 548 1.1.1.2.8.2 jruoho 549 1.1.1.2.8.2 jruoho case ACPI_TYPE_LOCAL_INDEX_FIELD: 550 1.1.1.2.8.2 jruoho 551 1.1.1.2.8.2 jruoho /* Get the Index and Data registers */ 552 1.1.1.2.8.2 jruoho 553 1.1.1.2.8.2 jruoho ObjDesc->IndexField.IndexObj = 554 1.1.1.2.8.2 jruoho AcpiNsGetAttachedObject (Info->RegisterNode); 555 1.1.1.2.8.2 jruoho ObjDesc->IndexField.DataObj = 556 1.1.1.2.8.2 jruoho AcpiNsGetAttachedObject (Info->DataRegisterNode); 557 1.1.1.2.8.2 jruoho 558 1.1.1.2.8.2 jruoho if (!ObjDesc->IndexField.DataObj || !ObjDesc->IndexField.IndexObj) 559 1.1.1.2.8.2 jruoho { 560 1.1.1.2.8.2 jruoho ACPI_ERROR ((AE_INFO, "Null Index Object during field prep")); 561 1.1.1.2.8.2 jruoho AcpiUtDeleteObjectDesc (ObjDesc); 562 1.1.1.2.8.2 jruoho return_ACPI_STATUS (AE_AML_INTERNAL); 563 1.1.1.2.8.2 jruoho } 564 1.1.1.2.8.2 jruoho 565 1.1.1.2.8.2 jruoho /* An additional reference for the attached objects */ 566 1.1.1.2.8.2 jruoho 567 1.1.1.2.8.2 jruoho AcpiUtAddReference (ObjDesc->IndexField.DataObj); 568 1.1.1.2.8.2 jruoho AcpiUtAddReference (ObjDesc->IndexField.IndexObj); 569 1.1.1.2.8.2 jruoho 570 1.1.1.2.8.2 jruoho /* 571 1.1.1.2.8.2 jruoho * April 2006: Changed to match MS behavior 572 1.1.1.2.8.2 jruoho * 573 1.1.1.2.8.2 jruoho * The value written to the Index register is the byte offset of the 574 1.1.1.2.8.2 jruoho * target field in units of the granularity of the IndexField 575 1.1.1.2.8.2 jruoho * 576 1.1.1.2.8.2 jruoho * Previously, the value was calculated as an index in terms of the 577 1.1.1.2.8.2 jruoho * width of the Data register, as below: 578 1.1.1.2.8.2 jruoho * 579 1.1.1.2.8.2 jruoho * ObjDesc->IndexField.Value = (UINT32) 580 1.1.1.2.8.2 jruoho * (Info->FieldBitPosition / ACPI_MUL_8 ( 581 1.1.1.2.8.2 jruoho * ObjDesc->Field.AccessByteWidth)); 582 1.1.1.2.8.2 jruoho * 583 1.1.1.2.8.2 jruoho * February 2006: Tried value as a byte offset: 584 1.1.1.2.8.2 jruoho * ObjDesc->IndexField.Value = (UINT32) 585 1.1.1.2.8.2 jruoho * ACPI_DIV_8 (Info->FieldBitPosition); 586 1.1.1.2.8.2 jruoho */ 587 1.1.1.2.8.2 jruoho ObjDesc->IndexField.Value = (UINT32) ACPI_ROUND_DOWN ( 588 1.1.1.2.8.2 jruoho ACPI_DIV_8 (Info->FieldBitPosition), 589 1.1.1.2.8.2 jruoho ObjDesc->IndexField.AccessByteWidth); 590 1.1.1.2.8.2 jruoho 591 1.1.1.2.8.2 jruoho ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD, 592 1.1.1.2.8.2 jruoho "IndexField: BitOff %X, Off %X, Value %X, Gran %X, Index %p, Data %p\n", 593 1.1.1.2.8.2 jruoho ObjDesc->IndexField.StartFieldBitOffset, 594 1.1.1.2.8.2 jruoho ObjDesc->IndexField.BaseByteOffset, 595 1.1.1.2.8.2 jruoho ObjDesc->IndexField.Value, 596 1.1.1.2.8.2 jruoho ObjDesc->Field.AccessByteWidth, 597 1.1.1.2.8.2 jruoho ObjDesc->IndexField.IndexObj, 598 1.1.1.2.8.2 jruoho ObjDesc->IndexField.DataObj)); 599 1.1.1.2.8.2 jruoho break; 600 1.1.1.2.8.2 jruoho 601 1.1.1.2.8.2 jruoho default: 602 1.1.1.2.8.2 jruoho /* No other types should get here */ 603 1.1.1.2.8.2 jruoho break; 604 1.1.1.2.8.2 jruoho } 605 1.1.1.2.8.2 jruoho 606 1.1.1.2.8.2 jruoho /* 607 1.1.1.2.8.2 jruoho * Store the constructed descriptor (ObjDesc) into the parent Node, 608 1.1.1.2.8.2 jruoho * preserving the current type of that NamedObj. 609 1.1.1.2.8.2 jruoho */ 610 1.1.1.2.8.2 jruoho Status = AcpiNsAttachObject (Info->FieldNode, ObjDesc, 611 1.1.1.2.8.2 jruoho AcpiNsGetType (Info->FieldNode)); 612 1.1.1.2.8.2 jruoho 613 1.1.1.2.8.2 jruoho ACPI_DEBUG_PRINT ((ACPI_DB_BFIELD, "Set NamedObj %p [%4.4s], ObjDesc %p\n", 614 1.1.1.2.8.2 jruoho Info->FieldNode, AcpiUtGetNodeName (Info->FieldNode), ObjDesc)); 615 1.1.1.2.8.2 jruoho 616 1.1.1.2.8.2 jruoho /* Remove local reference to the object */ 617 1.1.1.2.8.2 jruoho 618 1.1.1.2.8.2 jruoho AcpiUtRemoveReference (ObjDesc); 619 1.1.1.2.8.2 jruoho return_ACPI_STATUS (Status); 620 1.1.1.2.8.2 jruoho } 621 1.1.1.2.8.2 jruoho 622
Indexes created Wed Oct 15 16:09:53 GMT 2025