drivers/acpi/acpica/hwxface.c

   1
   2 /******************************************************************************
   3  *
   4  * Module Name: hwxface - Public ACPICA hardware interfaces
   5  *
   6  *****************************************************************************/
   7
   8 /*
   9  * Copyright (C) 2000 - 2012, 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 <linux/export.h>
  46 #include <acpi/acpi.h>
  47 #include "accommon.h"
  48 #include "acnamesp.h"
  49
  50 #define _COMPONENT          ACPI_HARDWARE
  51 ACPI_MODULE_NAME("hwxface")
  52
  53 /******************************************************************************
  54  *
  55  * FUNCTION:    acpi_reset
  56  *
  57  * PARAMETERS:  None
  58  *
  59  * RETURN:      Status
  60  *
  61  * DESCRIPTION: Set reset register in memory or IO space. Note: Does not
  62  *              support reset register in PCI config space, this must be
  63  *              handled separately.
  64  *
  65  ******************************************************************************/
  66 acpi_status acpi_reset(void)
  67 {
  68         struct acpi_generic_address *reset_reg;
  69         acpi_status status;
  70
  71         ACPI_FUNCTION_TRACE(acpi_reset);
  72
  73         reset_reg = &acpi_gbl_FADT.reset_register;
  74
  75         /* Check if the reset register is supported */
  76
  77         if (!(acpi_gbl_FADT.flags & ACPI_FADT_RESET_REGISTER) ||
  78             !reset_reg->address) {
  79                 return_ACPI_STATUS(AE_NOT_EXIST);
  80         }
  81
  82         if (reset_reg->space_id == ACPI_ADR_SPACE_SYSTEM_IO) {
  83                 /*
  84                  * For I/O space, write directly to the OSL. This
  85                  * bypasses the port validation mechanism, which may
  86                  * block a valid write to the reset register. Spec
  87                  * section 4.7.3.6 requires register width to be 8.
  88                  */
  89                 status =
  90                     acpi_os_write_port((acpi_io_address) reset_reg->address,
  91                                        acpi_gbl_FADT.reset_value, 8);
  92         } else {
  93                 /* Write the reset value to the reset register */
  94
  95                 status = acpi_hw_write(acpi_gbl_FADT.reset_value, reset_reg);
  96         }
  97
  98         return_ACPI_STATUS(status);
  99 }
 100
 101 ACPI_EXPORT_SYMBOL(acpi_reset)
 102
 103 /******************************************************************************
 104  *
 105  * FUNCTION:    acpi_read
 106  *
 107  * PARAMETERS:  Value               - Where the value is returned
 108  *              Reg                 - GAS register structure
 109  *
 110  * RETURN:      Status
 111  *
 112  * DESCRIPTION: Read from either memory or IO space.
 113  *
 114  * LIMITATIONS: <These limitations also apply to acpi_write>
 115  *      bit_width must be exactly 8, 16, 32, or 64.
 116  *      space_iD must be system_memory or system_iO.
 117  *      bit_offset and access_width are currently ignored, as there has
 118  *          not been a need to implement these.
 119  *
 120  ******************************************************************************/
 121 acpi_status acpi_read(u64 *return_value, struct acpi_generic_address *reg)
 122 {
 123         u32 value;
 124         u32 width;
 125         u64 address;
 126         acpi_status status;
 127
 128         ACPI_FUNCTION_NAME(acpi_read);
 129
 130         if (!return_value) {
 131                 return (AE_BAD_PARAMETER);
 132         }
 133
 134         /* Validate contents of the GAS register. Allow 64-bit transfers */
 135
 136         status = acpi_hw_validate_register(reg, 64, &address);
 137         if (ACPI_FAILURE(status)) {
 138                 return (status);
 139         }
 140
 141         /* Initialize entire 64-bit return value to zero */
 142
 143         *return_value = 0;
 144         value = 0;
 145
 146         /*
 147          * Two address spaces supported: Memory or IO. PCI_Config is
 148          * not supported here because the GAS structure is insufficient
 149          */
 150         if (reg->space_id == ACPI_ADR_SPACE_SYSTEM_MEMORY) {
 151                 status = acpi_os_read_memory((acpi_physical_address)
 152                                              address, return_value,
 153                                              reg->bit_width);
 154                 if (ACPI_FAILURE(status)) {
 155                         return (status);
 156                 }
 157         } else {                /* ACPI_ADR_SPACE_SYSTEM_IO, validated earlier */
 158
 159                 width = reg->bit_width;
 160                 if (width == 64) {
 161                         width = 32;     /* Break into two 32-bit transfers */
 162                 }
 163
 164                 status = acpi_hw_read_port((acpi_io_address)
 165                                            address, &value, width);
 166                 if (ACPI_FAILURE(status)) {
 167                         return (status);
 168                 }
 169                 *return_value = value;
 170
 171                 if (reg->bit_width == 64) {
 172
 173                         /* Read the top 32 bits */
 174
 175                         status = acpi_hw_read_port((acpi_io_address)
 176                                                    (address + 4), &value, 32);
 177                         if (ACPI_FAILURE(status)) {
 178                                 return (status);
 179                         }
 180                         *return_value |= ((u64)value << 32);
 181                 }
 182         }
 183
 184         ACPI_DEBUG_PRINT((ACPI_DB_IO,
 185                           "Read:  %8.8X%8.8X width %2d from %8.8X%8.8X (%s)\n",
 186                           ACPI_FORMAT_UINT64(*return_value), reg->bit_width,
 187                           ACPI_FORMAT_UINT64(address),
 188                           acpi_ut_get_region_name(reg->space_id)));
 189
 190         return (status);
 191 }
 192
 193 ACPI_EXPORT_SYMBOL(acpi_read)
 194
 195 /******************************************************************************
 196  *
 197  * FUNCTION:    acpi_write
 198  *
 199  * PARAMETERS:  Value               - Value to be written
 200  *              Reg                 - GAS register structure
 201  *
 202  * RETURN:      Status
 203  *
 204  * DESCRIPTION: Write to either memory or IO space.
 205  *
 206  ******************************************************************************/
 207 acpi_status acpi_write(u64 value, struct acpi_generic_address *reg)
 208 {
 209         u32 width;
 210         u64 address;
 211         acpi_status status;
 212
 213         ACPI_FUNCTION_NAME(acpi_write);
 214
 215         /* Validate contents of the GAS register. Allow 64-bit transfers */
 216
 217         status = acpi_hw_validate_register(reg, 64, &address);
 218         if (ACPI_FAILURE(status)) {
 219                 return (status);
 220         }
 221
 222         /*
 223          * Two address spaces supported: Memory or IO. PCI_Config is
 224          * not supported here because the GAS structure is insufficient
 225          */
 226         if (reg->space_id == ACPI_ADR_SPACE_SYSTEM_MEMORY) {
 227                 status = acpi_os_write_memory((acpi_physical_address)
 228                                               address, value, reg->bit_width);
 229                 if (ACPI_FAILURE(status)) {
 230                         return (status);
 231                 }
 232         } else {                /* ACPI_ADR_SPACE_SYSTEM_IO, validated earlier */
 233
 234                 width = reg->bit_width;
 235                 if (width == 64) {
 236                         width = 32;     /* Break into two 32-bit transfers */
 237                 }
 238
 239                 status = acpi_hw_write_port((acpi_io_address)
 240                                             address, ACPI_LODWORD(value),
 241                                             width);
 242                 if (ACPI_FAILURE(status)) {
 243                         return (status);
 244                 }
 245
 246                 if (reg->bit_width == 64) {
 247                         status = acpi_hw_write_port((acpi_io_address)
 248                                                     (address + 4),
 249                                                     ACPI_HIDWORD(value), 32);
 250                         if (ACPI_FAILURE(status)) {
 251                                 return (status);
 252                         }
 253                 }
 254         }
 255
 256         ACPI_DEBUG_PRINT((ACPI_DB_IO,
 257                           "Wrote: %8.8X%8.8X width %2d   to %8.8X%8.8X (%s)\n",
 258                           ACPI_FORMAT_UINT64(value), reg->bit_width,
 259                           ACPI_FORMAT_UINT64(address),
 260                           acpi_ut_get_region_name(reg->space_id)));
 261
 262         return (status);
 263 }
 264
 265 ACPI_EXPORT_SYMBOL(acpi_write)
 266
 267 #if (!ACPI_REDUCED_HARDWARE)
 268 /*******************************************************************************
 269  *
 270  * FUNCTION:    acpi_read_bit_register
 271  *
 272  * PARAMETERS:  register_id     - ID of ACPI Bit Register to access
 273  *              return_value    - Value that was read from the register,
 274  *                                normalized to bit position zero.
 275  *
 276  * RETURN:      Status and the value read from the specified Register. Value
 277  *              returned is normalized to bit0 (is shifted all the way right)
 278  *
 279  * DESCRIPTION: ACPI bit_register read function. Does not acquire the HW lock.
 280  *
 281  * SUPPORTS:    Bit fields in PM1 Status, PM1 Enable, PM1 Control, and
 282  *              PM2 Control.
 283  *
 284  * Note: The hardware lock is not required when reading the ACPI bit registers
 285  *       since almost all of them are single bit and it does not matter that
 286  *       the parent hardware register can be split across two physical
 287  *       registers. The only multi-bit field is SLP_TYP in the PM1 control
 288  *       register, but this field does not cross an 8-bit boundary (nor does
 289  *       it make much sense to actually read this field.)
 290  *
 291  ******************************************************************************/
 292 acpi_status acpi_read_bit_register(u32 register_id, u32 *return_value)
 293 {
 294         struct acpi_bit_register_info *bit_reg_info;
 295         u32 register_value;
 296         u32 value;
 297         acpi_status status;
 298
 299         ACPI_FUNCTION_TRACE_U32(acpi_read_bit_register, register_id);
 300
 301         /* Get the info structure corresponding to the requested ACPI Register */
 302
 303         bit_reg_info = acpi_hw_get_bit_register_info(register_id);
 304         if (!bit_reg_info) {
 305                 return_ACPI_STATUS(AE_BAD_PARAMETER);
 306         }
 307
 308         /* Read the entire parent register */
 309
 310         status = acpi_hw_register_read(bit_reg_info->parent_register,
 311                                        &register_value);
 312         if (ACPI_FAILURE(status)) {
 313                 return_ACPI_STATUS(status);
 314         }
 315
 316         /* Normalize the value that was read, mask off other bits */
 317
 318         value = ((register_value & bit_reg_info->access_bit_mask)
 319                  >> bit_reg_info->bit_position);
 320
 321         ACPI_DEBUG_PRINT((ACPI_DB_IO,
 322                           "BitReg %X, ParentReg %X, Actual %8.8X, ReturnValue %8.8X\n",
 323                           register_id, bit_reg_info->parent_register,
 324                           register_value, value));
 325
 326         *return_value = value;
 327         return_ACPI_STATUS(AE_OK);
 328 }
 329
 330 ACPI_EXPORT_SYMBOL(acpi_read_bit_register)
 331
 332 /*******************************************************************************
 333  *
 334  * FUNCTION:    acpi_write_bit_register
 335  *
 336  * PARAMETERS:  register_id     - ID of ACPI Bit Register to access
 337  *              Value           - Value to write to the register, in bit
 338  *                                position zero. The bit is automatically
 339  *                                shifted to the correct position.
 340  *
 341  * RETURN:      Status
 342  *
 343  * DESCRIPTION: ACPI Bit Register write function. Acquires the hardware lock
 344  *              since most operations require a read/modify/write sequence.
 345  *
 346  * SUPPORTS:    Bit fields in PM1 Status, PM1 Enable, PM1 Control, and
 347  *              PM2 Control.
 348  *
 349  * Note that at this level, the fact that there may be actually two
 350  * hardware registers (A and B - and B may not exist) is abstracted.
 351  *
 352  ******************************************************************************/
 353 acpi_status acpi_write_bit_register(u32 register_id, u32 value)
 354 {
 355         struct acpi_bit_register_info *bit_reg_info;
 356         acpi_cpu_flags lock_flags;
 357         u32 register_value;
 358         acpi_status status = AE_OK;
 359
 360         ACPI_FUNCTION_TRACE_U32(acpi_write_bit_register, register_id);
 361
 362         /* Get the info structure corresponding to the requested ACPI Register */
 363
 364         bit_reg_info = acpi_hw_get_bit_register_info(register_id);
 365         if (!bit_reg_info) {
 366                 return_ACPI_STATUS(AE_BAD_PARAMETER);
 367         }
 368
 369         lock_flags = acpi_os_acquire_lock(acpi_gbl_hardware_lock);
 370
 371         /*
 372          * At this point, we know that the parent register is one of the
 373          * following: PM1 Status, PM1 Enable, PM1 Control, or PM2 Control
 374          */
 375         if (bit_reg_info->parent_register != ACPI_REGISTER_PM1_STATUS) {
 376                 /*
 377                  * 1) Case for PM1 Enable, PM1 Control, and PM2 Control
 378                  *
 379                  * Perform a register read to preserve the bits that we are not
 380                  * interested in
 381                  */
 382                 status = acpi_hw_register_read(bit_reg_info->parent_register,
 383                                                &register_value);
 384                 if (ACPI_FAILURE(status)) {
 385                         goto unlock_and_exit;
 386                 }
 387
 388                 /*
 389                  * Insert the input bit into the value that was just read
 390                  * and write the register
 391                  */
 392                 ACPI_REGISTER_INSERT_VALUE(register_value,
 393                                            bit_reg_info->bit_position,
 394                                            bit_reg_info->access_bit_mask,
 395                                            value);
 396
 397                 status = acpi_hw_register_write(bit_reg_info->parent_register,
 398                                                 register_value);
 399         } else {
 400                 /*
 401                  * 2) Case for PM1 Status
 402                  *
 403                  * The Status register is different from the rest. Clear an event
 404                  * by writing 1, writing 0 has no effect. So, the only relevant
 405                  * information is the single bit we're interested in, all others
 406                  * should be written as 0 so they will be left unchanged.
 407                  */
 408                 register_value = ACPI_REGISTER_PREPARE_BITS(value,
 409                                                             bit_reg_info->
 410                                                             bit_position,
 411                                                             bit_reg_info->
 412                                                             access_bit_mask);
 413
 414                 /* No need to write the register if value is all zeros */
 415
 416                 if (register_value) {
 417                         status =
 418                             acpi_hw_register_write(ACPI_REGISTER_PM1_STATUS,
 419                                                    register_value);
 420                 }
 421         }
 422
 423         ACPI_DEBUG_PRINT((ACPI_DB_IO,
 424                           "BitReg %X, ParentReg %X, Value %8.8X, Actual %8.8X\n",
 425                           register_id, bit_reg_info->parent_register, value,
 426                           register_value));
 427
 428 unlock_and_exit:
 429
 430         acpi_os_release_lock(acpi_gbl_hardware_lock, lock_flags);
 431         return_ACPI_STATUS(status);
 432 }
 433
 434 ACPI_EXPORT_SYMBOL(acpi_write_bit_register)
 435 #endif                          /* !ACPI_REDUCED_HARDWARE */
 436 /*******************************************************************************
 437  *
 438  * FUNCTION:    acpi_get_sleep_type_data
 439  *
 440  * PARAMETERS:  sleep_state         - Numeric sleep state
 441  *              *sleep_type_a        - Where SLP_TYPa is returned
 442  *              *sleep_type_b        - Where SLP_TYPb is returned
 443  *
 444  * RETURN:      Status - ACPI status
 445  *
 446  * DESCRIPTION: Obtain the SLP_TYPa and SLP_TYPb values for the requested sleep
 447  *              state.
 448  *
 449  ******************************************************************************/
 450 acpi_status
 451 acpi_get_sleep_type_data(u8 sleep_state, u8 *sleep_type_a, u8 *sleep_type_b)
 452 {
 453         acpi_status status = AE_OK;
 454         struct acpi_evaluate_info *info;
 455
 456         ACPI_FUNCTION_TRACE(acpi_get_sleep_type_data);
 457
 458         /* Validate parameters */
 459
 460         if ((sleep_state > ACPI_S_STATES_MAX) || !sleep_type_a || !sleep_type_b) {
 461                 return_ACPI_STATUS(AE_BAD_PARAMETER);
 462         }
 463
 464         /* Allocate the evaluation information block */
 465
 466         info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info));
 467         if (!info) {
 468                 return_ACPI_STATUS(AE_NO_MEMORY);
 469         }
 470
 471         info->pathname =
 472             ACPI_CAST_PTR(char, acpi_gbl_sleep_state_names[sleep_state]);
 473
 474         /* Evaluate the namespace object containing the values for this state */
 475
 476         status = acpi_ns_evaluate(info);
 477         if (ACPI_FAILURE(status)) {
 478                 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
 479                                   "%s while evaluating SleepState [%s]\n",
 480                                   acpi_format_exception(status),
 481                                   info->pathname));
 482
 483                 goto cleanup;
 484         }
 485
 486         /* Must have a return object */
 487
 488         if (!info->return_object) {
 489                 ACPI_ERROR((AE_INFO, "No Sleep State object returned from [%s]",
 490                             info->pathname));
 491                 status = AE_NOT_EXIST;
 492         }
 493
 494         /* It must be of type Package */
 495
 496         else if (info->return_object->common.type != ACPI_TYPE_PACKAGE) {
 497                 ACPI_ERROR((AE_INFO,
 498                             "Sleep State return object is not a Package"));
 499                 status = AE_AML_OPERAND_TYPE;
 500         }
 501
 502         /*
 503          * The package must have at least two elements. NOTE (March 2005): This
 504          * goes against the current ACPI spec which defines this object as a
 505          * package with one encoded DWORD element. However, existing practice
 506          * by BIOS vendors seems to be to have 2 or more elements, at least
 507          * one per sleep type (A/B).
 508          */
 509         else if (info->return_object->package.count < 2) {
 510                 ACPI_ERROR((AE_INFO,
 511                             "Sleep State return package does not have at least two elements"));
 512                 status = AE_AML_NO_OPERAND;
 513         }
 514
 515         /* The first two elements must both be of type Integer */
 516
 517         else if (((info->return_object->package.elements[0])->common.type
 518                   != ACPI_TYPE_INTEGER) ||
 519                  ((info->return_object->package.elements[1])->common.type
 520                   != ACPI_TYPE_INTEGER)) {
 521                 ACPI_ERROR((AE_INFO,
 522                             "Sleep State return package elements are not both Integers "
 523                             "(%s, %s)",
 524                             acpi_ut_get_object_type_name(info->return_object->
 525                                                          package.elements[0]),
 526                             acpi_ut_get_object_type_name(info->return_object->
 527                                                          package.elements[1])));
 528                 status = AE_AML_OPERAND_TYPE;
 529         } else {
 530                 /* Valid _Sx_ package size, type, and value */
 531
 532                 *sleep_type_a = (u8)
 533                     (info->return_object->package.elements[0])->integer.value;
 534                 *sleep_type_b = (u8)
 535                     (info->return_object->package.elements[1])->integer.value;
 536         }
 537
 538         if (ACPI_FAILURE(status)) {
 539                 ACPI_EXCEPTION((AE_INFO, status,
 540                                 "While evaluating SleepState [%s], bad Sleep object %p type %s",
 541                                 info->pathname, info->return_object,
 542                                 acpi_ut_get_object_type_name(info->
 543                                                              return_object)));
 544         }
 545
 546         acpi_ut_remove_reference(info->return_object);
 547
 548       cleanup:
 549         ACPI_FREE(info);
 550         return_ACPI_STATUS(status);
 551 }
 552
 553 ACPI_EXPORT_SYMBOL(acpi_get_sleep_type_data)