LXR linux/drivers/acpi/acpica/exfield.c

   1/******************************************************************************
   2 *
   3 * Module Name: exfield - ACPI AML (p-code) execution - field manipulation
   4 *
   5 *****************************************************************************/
   6
   7/*
   8 * Copyright (C) 2000 - 2017, Intel Corp.
   9 * 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
  44#include <acpi/acpi.h>
  45#include "accommon.h"
  46#include "acdispat.h"
  47#include "acinterp.h"
  48#include "amlcode.h"
  49
  50#define _COMPONENT          ACPI_EXECUTER
  51ACPI_MODULE_NAME("exfield")
  52
  53/* Local prototypes */
  54static u32
  55acpi_ex_get_serial_access_length(u32 accessor_type, u32 access_length);
  56
  57/*******************************************************************************
  58 *
  59 * FUNCTION:    acpi_ex_get_serial_access_length
  60 *
  61 * PARAMETERS:  accessor_type   - The type of the protocol indicated by region
  62 *                                field access attributes
  63 *              access_length   - The access length of the region field
  64 *
  65 * RETURN:      Decoded access length
  66 *
  67 * DESCRIPTION: This routine returns the length of the generic_serial_bus
  68 *              protocol bytes
  69 *
  70 ******************************************************************************/
  71
  72static u32
  73acpi_ex_get_serial_access_length(u32 accessor_type, u32 access_length)
  74{
  75        u32 length;
  76
  77        switch (accessor_type) {
  78        case AML_FIELD_ATTRIB_QUICK:
  79
  80                length = 0;
  81                break;
  82
  83        case AML_FIELD_ATTRIB_SEND_RCV:
  84        case AML_FIELD_ATTRIB_BYTE:
  85
  86                length = 1;
  87                break;
  88
  89        case AML_FIELD_ATTRIB_WORD:
  90        case AML_FIELD_ATTRIB_WORD_CALL:
  91
  92                length = 2;
  93                break;
  94
  95        case AML_FIELD_ATTRIB_MULTIBYTE:
  96        case AML_FIELD_ATTRIB_RAW_BYTES:
  97        case AML_FIELD_ATTRIB_RAW_PROCESS:
  98
  99                length = access_length;
 100                break;
 101
 102        case AML_FIELD_ATTRIB_BLOCK:
 103        case AML_FIELD_ATTRIB_BLOCK_CALL:
 104        default:
 105
 106                length = ACPI_GSBUS_BUFFER_SIZE - 2;
 107                break;
 108        }
 109
 110        return (length);
 111}
 112
 113/*******************************************************************************
 114 *
 115 * FUNCTION:    acpi_ex_read_data_from_field
 116 *
 117 * PARAMETERS:  walk_state          - Current execution state
 118 *              obj_desc            - The named field
 119 *              ret_buffer_desc     - Where the return data object is stored
 120 *
 121 * RETURN:      Status
 122 *
 123 * DESCRIPTION: Read from a named field. Returns either an Integer or a
 124 *              Buffer, depending on the size of the field.
 125 *
 126 ******************************************************************************/
 127
 128acpi_status
 129acpi_ex_read_data_from_field(struct acpi_walk_state *walk_state,
 130                             union acpi_operand_object *obj_desc,
 131                             union acpi_operand_object **ret_buffer_desc)
 132{
 133        acpi_status status;
 134        union acpi_operand_object *buffer_desc;
 135        acpi_size length;
 136        void *buffer;
 137        u32 function;
 138        u16 accessor_type;
 139
 140        ACPI_FUNCTION_TRACE_PTR(ex_read_data_from_field, obj_desc);
 141
 142        /* Parameter validation */
 143
 144        if (!obj_desc) {
 145                return_ACPI_STATUS(AE_AML_NO_OPERAND);
 146        }
 147        if (!ret_buffer_desc) {
 148                return_ACPI_STATUS(AE_BAD_PARAMETER);
 149        }
 150
 151        if (obj_desc->common.type == ACPI_TYPE_BUFFER_FIELD) {
 152                /*
 153                 * If the buffer_field arguments have not been previously evaluated,
 154                 * evaluate them now and save the results.
 155                 */
 156                if (!(obj_desc->common.flags & AOPOBJ_DATA_VALID)) {
 157                        status = acpi_ds_get_buffer_field_arguments(obj_desc);
 158                        if (ACPI_FAILURE(status)) {
 159                                return_ACPI_STATUS(status);
 160                        }
 161                }
 162        } else if ((obj_desc->common.type == ACPI_TYPE_LOCAL_REGION_FIELD) &&
 163                   (obj_desc->field.region_obj->region.space_id ==
 164                    ACPI_ADR_SPACE_SMBUS
 165                    || obj_desc->field.region_obj->region.space_id ==
 166                    ACPI_ADR_SPACE_GSBUS
 167                    || obj_desc->field.region_obj->region.space_id ==
 168                    ACPI_ADR_SPACE_IPMI)) {
 169                /*
 170                 * This is an SMBus, GSBus or IPMI read. We must create a buffer to
 171                 * hold the data and then directly access the region handler.
 172                 *
 173                 * Note: SMBus and GSBus protocol value is passed in upper 16-bits
 174                 * of Function
 175                 */
 176                if (obj_desc->field.region_obj->region.space_id ==
 177                    ACPI_ADR_SPACE_SMBUS) {
 178                        length = ACPI_SMBUS_BUFFER_SIZE;
 179                        function =
 180                            ACPI_READ | (obj_desc->field.attribute << 16);
 181                } else if (obj_desc->field.region_obj->region.space_id ==
 182                           ACPI_ADR_SPACE_GSBUS) {
 183                        accessor_type = obj_desc->field.attribute;
 184                        length =
 185                            acpi_ex_get_serial_access_length(accessor_type,
 186                                                             obj_desc->field.
 187                                                             access_length);
 188
 189                        /*
 190                         * Add additional 2 bytes for the generic_serial_bus data buffer:
 191                         *
 192                         *     Status;    (Byte 0 of the data buffer)
 193                         *     Length;    (Byte 1 of the data buffer)
 194                         *     Data[x-1]: (Bytes 2-x of the arbitrary length data buffer)
 195                         */
 196                        length += 2;
 197                        function = ACPI_READ | (accessor_type << 16);
 198                } else {        /* IPMI */
 199
 200                        length = ACPI_IPMI_BUFFER_SIZE;
 201                        function = ACPI_READ;
 202                }
 203
 204                buffer_desc = acpi_ut_create_buffer_object(length);
 205                if (!buffer_desc) {
 206                        return_ACPI_STATUS(AE_NO_MEMORY);
 207                }
 208
 209                /* Lock entire transaction if requested */
 210
 211                acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);
 212
 213                /* Call the region handler for the read */
 214
 215                status = acpi_ex_access_region(obj_desc, 0,
 216                                               ACPI_CAST_PTR(u64,
 217                                                             buffer_desc->
 218                                                             buffer.pointer),
 219                                               function);
 220
 221                acpi_ex_release_global_lock(obj_desc->common_field.field_flags);
 222                goto exit;
 223        }
 224
 225        /*
 226         * Allocate a buffer for the contents of the field.
 227         *
 228         * If the field is larger than the current integer width, create
 229         * a BUFFER to hold it. Otherwise, use an INTEGER. This allows
 230         * the use of arithmetic operators on the returned value if the
 231         * field size is equal or smaller than an Integer.
 232         *
 233         * Note: Field.length is in bits.
 234         */
 235        length =
 236            (acpi_size)ACPI_ROUND_BITS_UP_TO_BYTES(obj_desc->field.bit_length);
 237
 238        if (length > acpi_gbl_integer_byte_width) {
 239
 240                /* Field is too large for an Integer, create a Buffer instead */
 241
 242                buffer_desc = acpi_ut_create_buffer_object(length);
 243                if (!buffer_desc) {
 244                        return_ACPI_STATUS(AE_NO_MEMORY);
 245                }
 246                buffer = buffer_desc->buffer.pointer;
 247        } else {
 248                /* Field will fit within an Integer (normal case) */
 249
 250                buffer_desc = acpi_ut_create_integer_object((u64) 0);
 251                if (!buffer_desc) {
 252                        return_ACPI_STATUS(AE_NO_MEMORY);
 253                }
 254
 255                length = acpi_gbl_integer_byte_width;
 256                buffer = &buffer_desc->integer.value;
 257        }
 258
 259        if ((obj_desc->common.type == ACPI_TYPE_LOCAL_REGION_FIELD) &&
 260            (obj_desc->field.region_obj->region.space_id ==
 261             ACPI_ADR_SPACE_GPIO)) {
 262                /*
 263                 * For GPIO (general_purpose_io), the Address will be the bit offset
 264                 * from the previous Connection() operator, making it effectively a
 265                 * pin number index. The bit_length is the length of the field, which
 266                 * is thus the number of pins.
 267                 */
 268                ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
 269                                  "GPIO FieldRead [FROM]:  Pin %u Bits %u\n",
 270                                  obj_desc->field.pin_number_index,
 271                                  obj_desc->field.bit_length));
 272
 273                /* Lock entire transaction if requested */
 274
 275                acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);
 276
 277                /* Perform the write */
 278
 279                status =
 280                    acpi_ex_access_region(obj_desc, 0, (u64 *)buffer,
 281                                          ACPI_READ);
 282
 283                acpi_ex_release_global_lock(obj_desc->common_field.field_flags);
 284                if (ACPI_FAILURE(status)) {
 285                        acpi_ut_remove_reference(buffer_desc);
 286                } else {
 287                        *ret_buffer_desc = buffer_desc;
 288                }
 289                return_ACPI_STATUS(status);
 290        }
 291
 292        ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
 293                          "FieldRead [TO]:   Obj %p, Type %X, Buf %p, ByteLen %X\n",
 294                          obj_desc, obj_desc->common.type, buffer,
 295                          (u32) length));
 296        ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
 297                          "FieldRead [FROM]: BitLen %X, BitOff %X, ByteOff %X\n",
 298                          obj_desc->common_field.bit_length,
 299                          obj_desc->common_field.start_field_bit_offset,
 300                          obj_desc->common_field.base_byte_offset));
 301
 302        /* Lock entire transaction if requested */
 303
 304        acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);
 305
 306        /* Read from the field */
 307
 308        status = acpi_ex_extract_from_field(obj_desc, buffer, (u32) length);
 309        acpi_ex_release_global_lock(obj_desc->common_field.field_flags);
 310
 311exit:
 312        if (ACPI_FAILURE(status)) {
 313                acpi_ut_remove_reference(buffer_desc);
 314        } else {
 315                *ret_buffer_desc = buffer_desc;
 316        }
 317
 318        return_ACPI_STATUS(status);
 319}
 320
 321/*******************************************************************************
 322 *
 323 * FUNCTION:    acpi_ex_write_data_to_field
 324 *
 325 * PARAMETERS:  source_desc         - Contains data to write
 326 *              obj_desc            - The named field
 327 *              result_desc         - Where the return value is returned, if any
 328 *
 329 * RETURN:      Status
 330 *
 331 * DESCRIPTION: Write to a named field
 332 *
 333 ******************************************************************************/
 334
 335acpi_status
 336acpi_ex_write_data_to_field(union acpi_operand_object *source_desc,
 337                            union acpi_operand_object *obj_desc,
 338                            union acpi_operand_object **result_desc)
 339{
 340        acpi_status status;
 341        u32 length;
 342        void *buffer;
 343        union acpi_operand_object *buffer_desc;
 344        u32 function;
 345        u16 accessor_type;
 346
 347        ACPI_FUNCTION_TRACE_PTR(ex_write_data_to_field, obj_desc);
 348
 349        /* Parameter validation */
 350
 351        if (!source_desc || !obj_desc) {
 352                return_ACPI_STATUS(AE_AML_NO_OPERAND);
 353        }
 354
 355        if (obj_desc->common.type == ACPI_TYPE_BUFFER_FIELD) {
 356                /*
 357                 * If the buffer_field arguments have not been previously evaluated,
 358                 * evaluate them now and save the results.
 359                 */
 360                if (!(obj_desc->common.flags & AOPOBJ_DATA_VALID)) {
 361                        status = acpi_ds_get_buffer_field_arguments(obj_desc);
 362                        if (ACPI_FAILURE(status)) {
 363                                return_ACPI_STATUS(status);
 364                        }
 365                }
 366        } else if ((obj_desc->common.type == ACPI_TYPE_LOCAL_REGION_FIELD) &&
 367                   (obj_desc->field.region_obj->region.space_id ==
 368                    ACPI_ADR_SPACE_SMBUS
 369                    || obj_desc->field.region_obj->region.space_id ==
 370                    ACPI_ADR_SPACE_GSBUS
 371                    || obj_desc->field.region_obj->region.space_id ==
 372                    ACPI_ADR_SPACE_IPMI)) {
 373                /*
 374                 * This is an SMBus, GSBus or IPMI write. We will bypass the entire
 375                 * field mechanism and handoff the buffer directly to the handler.
 376                 * For these address spaces, the buffer is bi-directional; on a
 377                 * write, return data is returned in the same buffer.
 378                 *
 379                 * Source must be a buffer of sufficient size:
 380                 * ACPI_SMBUS_BUFFER_SIZE, ACPI_GSBUS_BUFFER_SIZE, or
 381                 * ACPI_IPMI_BUFFER_SIZE.
 382                 *
 383                 * Note: SMBus and GSBus protocol type is passed in upper 16-bits
 384                 * of Function
 385                 */
 386                if (source_desc->common.type != ACPI_TYPE_BUFFER) {
 387                        ACPI_ERROR((AE_INFO,
 388                                    "SMBus/IPMI/GenericSerialBus write requires "
 389                                    "Buffer, found type %s",
 390                                    acpi_ut_get_object_type_name(source_desc)));
 391
 392                        return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
 393                }
 394
 395                if (obj_desc->field.region_obj->region.space_id ==
 396                    ACPI_ADR_SPACE_SMBUS) {
 397                        length = ACPI_SMBUS_BUFFER_SIZE;
 398                        function =
 399                            ACPI_WRITE | (obj_desc->field.attribute << 16);
 400                } else if (obj_desc->field.region_obj->region.space_id ==
 401                           ACPI_ADR_SPACE_GSBUS) {
 402                        accessor_type = obj_desc->field.attribute;
 403                        length =
 404                            acpi_ex_get_serial_access_length(accessor_type,
 405                                                             obj_desc->field.
 406                                                             access_length);
 407
 408                        /*
 409                         * Add additional 2 bytes for the generic_serial_bus data buffer:
 410                         *
 411                         *     Status;    (Byte 0 of the data buffer)
 412                         *     Length;    (Byte 1 of the data buffer)
 413                         *     Data[x-1]: (Bytes 2-x of the arbitrary length data buffer)
 414                         */
 415                        length += 2;
 416                        function = ACPI_WRITE | (accessor_type << 16);
 417                } else {        /* IPMI */
 418
 419                        length = ACPI_IPMI_BUFFER_SIZE;
 420                        function = ACPI_WRITE;
 421                }
 422
 423                if (source_desc->buffer.length < length) {
 424                        ACPI_ERROR((AE_INFO,
 425                                    "SMBus/IPMI/GenericSerialBus write requires "
 426                                    "Buffer of length %u, found length %u",
 427                                    length, source_desc->buffer.length));
 428
 429                        return_ACPI_STATUS(AE_AML_BUFFER_LIMIT);
 430                }
 431
 432                /* Create the bi-directional buffer */
 433
 434                buffer_desc = acpi_ut_create_buffer_object(length);
 435                if (!buffer_desc) {
 436                        return_ACPI_STATUS(AE_NO_MEMORY);
 437                }
 438
 439                buffer = buffer_desc->buffer.pointer;
 440                memcpy(buffer, source_desc->buffer.pointer, length);
 441
 442                /* Lock entire transaction if requested */
 443
 444                acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);
 445
 446                /*
 447                 * Perform the write (returns status and perhaps data in the
 448                 * same buffer)
 449                 */
 450                status =
 451                    acpi_ex_access_region(obj_desc, 0, (u64 *)buffer, function);
 452                acpi_ex_release_global_lock(obj_desc->common_field.field_flags);
 453
 454                *result_desc = buffer_desc;
 455                return_ACPI_STATUS(status);
 456        } else if ((obj_desc->common.type == ACPI_TYPE_LOCAL_REGION_FIELD) &&
 457                   (obj_desc->field.region_obj->region.space_id ==
 458                    ACPI_ADR_SPACE_GPIO)) {
 459                /*
 460                 * For GPIO (general_purpose_io), we will bypass the entire field
 461                 * mechanism and handoff the bit address and bit width directly to
 462                 * the handler. The Address will be the bit offset
 463                 * from the previous Connection() operator, making it effectively a
 464                 * pin number index. The bit_length is the length of the field, which
 465                 * is thus the number of pins.
 466                 */
 467                if (source_desc->common.type != ACPI_TYPE_INTEGER) {
 468                        return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
 469                }
 470
 471                ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
 472                                  "GPIO FieldWrite [FROM]: (%s:%X), Val %.8X  [TO]: Pin %u Bits %u\n",
 473                                  acpi_ut_get_type_name(source_desc->common.
 474                                                        type),
 475                                  source_desc->common.type,
 476                                  (u32)source_desc->integer.value,
 477                                  obj_desc->field.pin_number_index,
 478                                  obj_desc->field.bit_length));
 479
 480                buffer = &source_desc->integer.value;
 481
 482                /* Lock entire transaction if requested */
 483
 484                acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);
 485
 486                /* Perform the write */
 487
 488                status =
 489                    acpi_ex_access_region(obj_desc, 0, (u64 *)buffer,
 490                                          ACPI_WRITE);
 491                acpi_ex_release_global_lock(obj_desc->common_field.field_flags);
 492                return_ACPI_STATUS(status);
 493        }
 494
 495        /* Get a pointer to the data to be written */
 496
 497        switch (source_desc->common.type) {
 498        case ACPI_TYPE_INTEGER:
 499
 500                buffer = &source_desc->integer.value;
 501                length = sizeof(source_desc->integer.value);
 502                break;
 503
 504        case ACPI_TYPE_BUFFER:
 505
 506                buffer = source_desc->buffer.pointer;
 507                length = source_desc->buffer.length;
 508                break;
 509
 510        case ACPI_TYPE_STRING:
 511
 512                buffer = source_desc->string.pointer;
 513                length = source_desc->string.length;
 514                break;
 515
 516        default:
 517
 518                return_ACPI_STATUS(AE_AML_OPERAND_TYPE);
 519        }
 520
 521        ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
 522                          "FieldWrite [FROM]: Obj %p (%s:%X), Buf %p, ByteLen %X\n",
 523                          source_desc,
 524                          acpi_ut_get_type_name(source_desc->common.type),
 525                          source_desc->common.type, buffer, length));
 526
 527        ACPI_DEBUG_PRINT((ACPI_DB_BFIELD,
 528                          "FieldWrite [TO]:   Obj %p (%s:%X), BitLen %X, BitOff %X, ByteOff %X\n",
 529                          obj_desc,
 530                          acpi_ut_get_type_name(obj_desc->common.type),
 531                          obj_desc->common.type,
 532                          obj_desc->common_field.bit_length,
 533                          obj_desc->common_field.start_field_bit_offset,
 534                          obj_desc->common_field.base_byte_offset));
 535
 536        /* Lock entire transaction if requested */
 537
 538        acpi_ex_acquire_global_lock(obj_desc->common_field.field_flags);
 539
 540        /* Write to the field */
 541
 542        status = acpi_ex_insert_into_field(obj_desc, buffer, length);
 543        acpi_ex_release_global_lock(obj_desc->common_field.field_flags);
 544
 545        return_ACPI_STATUS(status);
 546}
 547