drivers/acpi/acpica/exprep.c

   1
   2 /******************************************************************************
   3  *
   4  * Module Name: exprep - ACPI AML (p-code) execution - field prep utilities
   5  *
   6  *****************************************************************************/
   7
   8 /*
   9  * Copyright (C) 2000 - 2011, Intel Corp.
  10  * All rights reserved.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions, and the following disclaimer,
  17  *    without modification.
  18  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  19  *    substantially similar to the "NO WARRANTY" disclaimer below
  20  *    ("Disclaimer") and any redistribution must be conditioned upon
  21  *    including a substantially similar Disclaimer requirement for further
  22  *    binary redistribution.
  23  * 3. Neither the names of the above-listed copyright holders nor the names
  24  *    of any contributors may be used to endorse or promote products derived
  25  *    from this software without specific prior written permission.
  26  *
  27  * Alternatively, this software may be distributed under the terms of the
  28  * GNU General Public License ("GPL") version 2 as published by the Free
  29  * Software Foundation.
  30  *
  31  * NO WARRANTY
  32  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  33  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  34  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  35  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  36  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  37  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  38  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  39  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  40  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  41  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  42  * POSSIBILITY OF SUCH DAMAGES.
  43  */
  44
  45 #include <acpi/acpi.h>
  46 #include "accommon.h"
  47 #include "acinterp.h"
  48 #include "amlcode.h"
  49 #include "acnamesp.h"
  50
  51 #define _COMPONENT          ACPI_EXECUTER
  52 ACPI_MODULE_NAME("exprep")
  53
  54 /* Local prototypes */
  55 static u32
  56 acpi_ex_decode_field_access(union acpi_operand_object *obj_desc,
  57                             u8 field_flags, u32 * return_byte_alignment);
  58
  59 #ifdef ACPI_UNDER_DEVELOPMENT
  60
  61 static u32
  62 acpi_ex_generate_access(u32 field_bit_offset,
  63                         u32 field_bit_length, u32 region_length);
  64
  65 /*******************************************************************************
  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
  80  *       conditions (end-of-region).  However, the region_length is a deferred
  81  *       operation.  Therefore, to complete this implementation, the generation
  82  *       of this access width must be deferred until the region length has
  83  *       been evaluated.
  84  *
  85  ******************************************************************************/
  86
  87 static u32
  88 acpi_ex_generate_access(u32 field_bit_offset,
  89                         u32 field_bit_length, u32 region_length)
  90 {
  91         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;
 100
 101         ACPI_FUNCTION_TRACE(ex_generate_access);
 102
 103         /* Round Field start offset and length to "minimal" byte boundaries */
 104
 105         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;
 109
 110         ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
 111                           "Bit length %u, Bit offset %u\n",
 112                           field_bit_length, field_bit_offset));
 113
 114         ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
 115                           "Byte Length %u, Byte Offset %u, End Offset %u\n",
 116                           field_byte_length, field_byte_offset,
 117                           field_byte_end_offset));
 118
 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          */
 125         for (access_byte_width = 1; access_byte_width <= 8;
 126              access_byte_width <<= 1) {
 127                 /*
 128                  * 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).
 133                  */
 134                 if (ACPI_ROUND_UP(field_byte_end_offset, access_byte_width) <=
 135                     region_length) {
 136                         field_start_offset =
 137                             ACPI_ROUND_DOWN(field_byte_offset,
 138                                             access_byte_width) /
 139                             access_byte_width;
 140
 141                         field_end_offset =
 142                             ACPI_ROUND_UP((field_byte_length +
 143                                            field_byte_offset),
 144                                           access_byte_width) /
 145                             access_byte_width;
 146
 147                         accesses = field_end_offset - field_start_offset;
 148
 149                         ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
 150                                           "AccessWidth %u end is within region\n",
 151                                           access_byte_width));
 152
 153                         ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
 154                                           "Field Start %u, Field End %u -- requires %u accesses\n",
 155                                           field_start_offset, field_end_offset,
 156                                           accesses));
 157
 158                         /* Single access is optimal */
 159
 160                         if (accesses <= 1) {
 161                                 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
 162                                                   "Entire field can be accessed with one operation of size %u\n",
 163                                                   access_byte_width));
 164                                 return_VALUE(access_byte_width);
 165                         }
 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) {
 172                                 minimum_accesses = accesses;
 173                                 minimum_access_width = access_byte_width;
 174                         }
 175                 } else {
 176                         ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
 177                                           "AccessWidth %u end is NOT within region\n",
 178                                           access_byte_width));
 179                         if (access_byte_width == 1) {
 180                                 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
 181                                                   "Field goes beyond end-of-region!\n"));
 182
 183                                 /* Field does not fit in the region at all */
 184
 185                                 return_VALUE(0);
 186                         }
 187
 188                         /*
 189                          * This width goes beyond the end-of-region, back off to
 190                          * previous access
 191                          */
 192                         ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
 193                                           "Backing off to previous optimal access width of %u\n",
 194                                           minimum_access_width));
 195                         return_VALUE(minimum_access_width);
 196                 }
 197         }
 198
 199         /*
 200          * Could not read/write field with one operation,
 201          * just use max access width
 202          */
 203         ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
 204                           "Cannot access field in one operation, using width 8\n"));
 205         return_VALUE(8);
 206 }
 207 #endif                          /* ACPI_UNDER_DEVELOPMENT */
 208
 209 /*******************************************************************************
 210  *
 211  * FUNCTION:    acpi_ex_decode_field_access
 212  *
 213  * PARAMETERS:  obj_desc            - Field object
 214  *              field_flags         - Encoded fieldflags (contains access bits)
 215  *              return_byte_alignment - Where the byte alignment is returned
 216  *
 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
 224 static u32
 225 acpi_ex_decode_field_access(union acpi_operand_object *obj_desc,
 226                             u8 field_flags, u32 * return_byte_alignment)
 227 {
 228         u32 access;
 229         u32 byte_alignment;
 230         u32 bit_length;
 231
 232         ACPI_FUNCTION_TRACE(ex_decode_field_access);
 233
 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
 240                 byte_alignment =
 241                     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 */
 246                     );
 247                 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:
 255         case AML_FIELD_ACCESS_BUFFER:   /* ACPI 2.0 (SMBus Buffer) */
 256                 byte_alignment = 1;
 257                 bit_length = 8;
 258                 break;
 259
 260         case AML_FIELD_ACCESS_WORD:
 261                 byte_alignment = 2;
 262                 bit_length = 16;
 263                 break;
 264
 265         case AML_FIELD_ACCESS_DWORD:
 266                 byte_alignment = 4;
 267                 bit_length = 32;
 268                 break;
 269
 270         case AML_FIELD_ACCESS_QWORD:    /* ACPI 2.0 */
 271                 byte_alignment = 8;
 272                 bit_length = 64;
 273                 break;
 274
 275         default:
 276                 /* Invalid field access type */
 277
 278                 ACPI_ERROR((AE_INFO, "Unknown field access type 0x%X", access));
 279                 return_UINT32(0);
 280         }
 281
 282         if (obj_desc->common.type == ACPI_TYPE_BUFFER_FIELD) {
 283                 /*
 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;
 292         return_UINT32(bit_length);
 293 }
 294
 295 /*******************************************************************************
 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
 303  *              field_attribute     - Special attributes (not used)
 304  *              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
 310  *              to the various types of fields.  Note: This is very "sensitive"
 311  *              code because we are solving the general case for field
 312  *              alignment.
 313  *
 314  ******************************************************************************/
 315
 316 acpi_status
 317 acpi_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)
 321 {
 322         u32 access_bit_width;
 323         u32 byte_alignment;
 324         u32 nearest_byte_address;
 325
 326         ACPI_FUNCTION_TRACE(ex_prep_common_field_object);
 327
 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         /*
 338          * Decode the access type so we can compute offsets.  The access type gives
 339          * 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
 344          * I/O operation.  However, for any_acc, the byte_alignment is always one
 345          * 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          */
 352         access_bit_width = acpi_ex_decode_field_access(obj_desc, field_flags,
 353                                                        &byte_alignment);
 354         if (!access_bit_width) {
 355                 return_ACPI_STATUS(AE_AML_OPERAND_VALUE);
 356         }
 357
 358         /* Setup width (access granularity) fields (values are: 1, 2, 4, 8) */
 359
 360         obj_desc->common_field.access_byte_width = (u8)
 361             ACPI_DIV_8(access_bit_width);
 362
 363         /*
 364          * base_byte_offset is the address of the start of the field within the
 365          * region.  It is the byte address of the first *datum* (field-width data
 366          * 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 =
 374             ACPI_ROUND_BITS_DOWN_TO_BYTES(field_bit_position);
 375         obj_desc->common_field.base_byte_offset = (u32)
 376             ACPI_ROUND_DOWN(nearest_byte_address, byte_alignment);
 377
 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)
 383             (field_bit_position -
 384              ACPI_MUL_8(obj_desc->common_field.base_byte_offset));
 385
 386         return_ACPI_STATUS(AE_OK);
 387 }
 388
 389 /*******************************************************************************
 390  *
 391  * FUNCTION:    acpi_ex_prep_field_value
 392  *
 393  * PARAMETERS:  Info    - Contains all field creation info
 394  *
 395  * RETURN:      Status
 396  *
 397  * DESCRIPTION: Construct a union acpi_operand_object of type def_field and
 398  *              connect it to the parent Node.
 399  *
 400  ******************************************************************************/
 401
 402 acpi_status acpi_ex_prep_field_value(struct acpi_create_field_info *info)
 403 {
 404         union acpi_operand_object *obj_desc;
 405         union acpi_operand_object *second_desc = NULL;
 406         acpi_status status;
 407         u32 access_byte_width;
 408         u32 type;
 409
 410         ACPI_FUNCTION_TRACE(ex_prep_field_value);
 411
 412         /* Parameter validation */
 413
 414         if (info->field_type != ACPI_TYPE_LOCAL_INDEX_FIELD) {
 415                 if (!info->region_node) {
 416                         ACPI_ERROR((AE_INFO, "Null RegionNode"));
 417                         return_ACPI_STATUS(AE_AML_NO_OPERAND);
 418                 }
 419
 420                 type = acpi_ns_get_type(info->region_node);
 421                 if (type != ACPI_TYPE_REGION) {
 422                         ACPI_ERROR((AE_INFO,
 423                                     "Needed Region, found type 0x%X (%s)", type,
 424                                     acpi_ut_get_type_name(type)));
 425
 426                         return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
 427                 }
 428         }
 429
 430         /* Allocate a new field object */
 431
 432         obj_desc = acpi_ut_create_internal_object(info->field_type);
 433         if (!obj_desc) {
 434                 return_ACPI_STATUS(AE_NO_MEMORY);
 435         }
 436
 437         /* Initialize areas of the object that are common to all fields */
 438
 439         obj_desc->common_field.node = info->field_node;
 440         status = acpi_ex_prep_common_field_object(obj_desc,
 441                                                   info->field_flags,
 442                                                   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);
 448         }
 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
 455                 obj_desc->field.region_obj =
 456                     acpi_ns_get_attached_object(info->region_node);
 457
 458                 /* Allow full data read from EC address space */
 459
 460                 if ((obj_desc->field.region_obj->region.space_id ==
 461                      ACPI_ADR_SPACE_EC)
 462                     && (obj_desc->common_field.bit_length > 8)) {
 463                         access_byte_width =
 464                             ACPI_ROUND_BITS_UP_TO_BYTES(obj_desc->common_field.
 465                                                         bit_length);
 466
 467                         /* Maximum byte width supported is 255 */
 468
 469                         if (access_byte_width < 256) {
 470                                 obj_desc->common_field.access_byte_width =
 471                                     (u8)access_byte_width;
 472                         }
 473                 }
 474                 /* An additional reference for the container */
 475
 476                 acpi_ut_add_reference(obj_desc->field.region_obj);
 477
 478                 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
 479                                   "RegionField: BitOff %X, Off %X, Gran %X, Region %p\n",
 480                                   obj_desc->field.start_field_bit_offset,
 481                                   obj_desc->field.base_byte_offset,
 482                                   obj_desc->field.access_byte_width,
 483                                   obj_desc->field.region_obj));
 484                 break;
 485
 486         case ACPI_TYPE_LOCAL_BANK_FIELD:
 487
 488                 obj_desc->bank_field.value = info->bank_value;
 489                 obj_desc->bank_field.region_obj =
 490                     acpi_ns_get_attached_object(info->region_node);
 491                 obj_desc->bank_field.bank_obj =
 492                     acpi_ns_get_attached_object(info->register_node);
 493
 494                 /* An additional reference for the attached objects */
 495
 496                 acpi_ut_add_reference(obj_desc->bank_field.region_obj);
 497                 acpi_ut_add_reference(obj_desc->bank_field.bank_obj);
 498
 499                 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
 500                                   "Bank Field: BitOff %X, Off %X, Gran %X, Region %p, BankReg %p\n",
 501                                   obj_desc->bank_field.start_field_bit_offset,
 502                                   obj_desc->bank_field.base_byte_offset,
 503                                   obj_desc->field.access_byte_width,
 504                                   obj_desc->bank_field.region_obj,
 505                                   obj_desc->bank_field.bank_obj));
 506
 507                 /*
 508                  * Remember location in AML stream of the field unit
 509                  * opcode and operands -- since the bank_value
 510                  * operands must be evaluated.
 511                  */
 512                 second_desc = obj_desc->common.next_object;
 513                 second_desc->extra.aml_start =
 514                     ACPI_CAST_PTR(union acpi_parse_object,
 515                                   info->data_register_node)->named.data;
 516                 second_desc->extra.aml_length =
 517                     ACPI_CAST_PTR(union acpi_parse_object,
 518                                   info->data_register_node)->named.length;
 519
 520                 break;
 521
 522         case ACPI_TYPE_LOCAL_INDEX_FIELD:
 523
 524                 /* Get the Index and Data registers */
 525
 526                 obj_desc->index_field.index_obj =
 527                     acpi_ns_get_attached_object(info->register_node);
 528                 obj_desc->index_field.data_obj =
 529                     acpi_ns_get_attached_object(info->data_register_node);
 530
 531                 if (!obj_desc->index_field.data_obj
 532                     || !obj_desc->index_field.index_obj) {
 533                         ACPI_ERROR((AE_INFO,
 534                                     "Null Index Object during field prep"));
 535                         acpi_ut_delete_object_desc(obj_desc);
 536                         return_ACPI_STATUS(AE_AML_INTERNAL);
 537                 }
 538
 539                 /* An additional reference for the attached objects */
 540
 541                 acpi_ut_add_reference(obj_desc->index_field.data_obj);
 542                 acpi_ut_add_reference(obj_desc->index_field.index_obj);
 543
 544                 /*
 545                  * April 2006: Changed to match MS behavior
 546                  *
 547                  * The value written to the Index register is the byte offset of the
 548                  * target field in units of the granularity of the index_field
 549                  *
 550                  * Previously, the value was calculated as an index in terms of the
 551                  * width of the Data register, as below:
 552                  *
 553                  *      obj_desc->index_field.Value = (u32)
 554                  *          (Info->field_bit_position / ACPI_MUL_8 (
 555                  *              obj_desc->Field.access_byte_width));
 556                  *
 557                  * February 2006: Tried value as a byte offset:
 558                  *      obj_desc->index_field.Value = (u32)
 559                  *          ACPI_DIV_8 (Info->field_bit_position);
 560                  */
 561                 obj_desc->index_field.value =
 562                     (u32) ACPI_ROUND_DOWN(ACPI_DIV_8(info->field_bit_position),
 563                                           obj_desc->index_field.
 564                                           access_byte_width);
 565
 566                 ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
 567                                   "IndexField: BitOff %X, Off %X, Value %X, Gran %X, Index %p, Data %p\n",
 568                                   obj_desc->index_field.start_field_bit_offset,
 569                                   obj_desc->index_field.base_byte_offset,
 570                                   obj_desc->index_field.value,
 571                                   obj_desc->field.access_byte_width,
 572                                   obj_desc->index_field.index_obj,
 573                                   obj_desc->index_field.data_obj));
 574                 break;
 575
 576         default:
 577                 /* No other types should get here */
 578                 break;
 579         }
 580
 581         /*
 582          * Store the constructed descriptor (obj_desc) into the parent Node,
 583          * preserving the current type of that named_obj.
 584          */
 585         status = acpi_ns_attach_object(info->field_node, obj_desc,
 586                                        acpi_ns_get_type(info->field_node));
 587
 588         ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
 589                           "Set NamedObj %p [%4.4s], ObjDesc %p\n",
 590                           info->field_node,
 591                           acpi_ut_get_node_name(info->field_node), obj_desc));
 592
 593         /* Remove local reference to the object */
 594
 595         acpi_ut_remove_reference(obj_desc);
 596         return_ACPI_STATUS(status);
 597 }