2 /*******************************************************************************
4 * Module Name: hwregs - Read/write access functions for the various ACPI
5 * control and status registers.
7 ******************************************************************************/
10 * Copyright (C) 2000 - 2006, R. Byron Moore
11 * All rights reserved.
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions, and the following disclaimer,
18 * without modification.
19 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
20 * substantially similar to the "NO WARRANTY" disclaimer below
21 * ("Disclaimer") and any redistribution must be conditioned upon
22 * including a substantially similar Disclaimer requirement for further
23 * binary redistribution.
24 * 3. Neither the names of the above-listed copyright holders nor the names
25 * of any contributors may be used to endorse or promote products derived
26 * from this software without specific prior written permission.
28 * Alternatively, this software may be distributed under the terms of the
29 * GNU General Public License ("GPL") version 2 as published by the Free
30 * Software Foundation.
33 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
34 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
35 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
36 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
37 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
38 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
39 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
40 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
41 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
42 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
43 * POSSIBILITY OF SUCH DAMAGES.
46 #include <acpi/acpi.h>
47 #include <acpi/acnamesp.h>
48 #include <acpi/acevents.h>
50 #define _COMPONENT ACPI_HARDWARE
51 ACPI_MODULE_NAME("hwregs")
53 /*******************************************************************************
55 * FUNCTION: acpi_hw_clear_acpi_status
57 * PARAMETERS: Flags - Lock the hardware or not
61 * DESCRIPTION: Clears all fixed and general purpose status bits
62 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
64 * NOTE: TBD: Flags parameter is obsolete, to be removed
66 ******************************************************************************/
67 acpi_status acpi_hw_clear_acpi_status(u32 flags)
70 acpi_cpu_flags lock_flags = 0;
72 ACPI_FUNCTION_TRACE(hw_clear_acpi_status);
74 ACPI_DEBUG_PRINT((ACPI_DB_IO, "About to write %04X to %04X\n",
75 ACPI_BITMASK_ALL_FIXED_STATUS,
76 (u16) acpi_gbl_FADT->xpm1a_evt_blk.address));
78 lock_flags = acpi_os_acquire_lock(acpi_gbl_hardware_lock);
80 status = acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
81 ACPI_REGISTER_PM1_STATUS,
82 ACPI_BITMASK_ALL_FIXED_STATUS);
83 if (ACPI_FAILURE(status)) {
87 /* Clear the fixed events */
89 if (acpi_gbl_FADT->xpm1b_evt_blk.address) {
91 acpi_hw_low_level_write(16, ACPI_BITMASK_ALL_FIXED_STATUS,
92 &acpi_gbl_FADT->xpm1b_evt_blk);
93 if (ACPI_FAILURE(status)) {
98 /* Clear the GPE Bits in all GPE registers in all GPE blocks */
100 status = acpi_ev_walk_gpe_list(acpi_hw_clear_gpe_block);
103 acpi_os_release_lock(acpi_gbl_hardware_lock, lock_flags);
104 return_ACPI_STATUS(status);
107 /*******************************************************************************
109 * FUNCTION: acpi_get_sleep_type_data
111 * PARAMETERS: sleep_state - Numeric sleep state
112 * *sleep_type_a - Where SLP_TYPa is returned
113 * *sleep_type_b - Where SLP_TYPb is returned
115 * RETURN: Status - ACPI status
117 * DESCRIPTION: Obtain the SLP_TYPa and SLP_TYPb values for the requested sleep
120 ******************************************************************************/
123 acpi_get_sleep_type_data(u8 sleep_state, u8 * sleep_type_a, u8 * sleep_type_b)
125 acpi_status status = AE_OK;
126 struct acpi_evaluate_info *info;
128 ACPI_FUNCTION_TRACE(acpi_get_sleep_type_data);
130 /* Validate parameters */
132 if ((sleep_state > ACPI_S_STATES_MAX) || !sleep_type_a || !sleep_type_b) {
133 return_ACPI_STATUS(AE_BAD_PARAMETER);
136 /* Allocate the evaluation information block */
138 info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info));
140 return_ACPI_STATUS(AE_NO_MEMORY);
144 ACPI_CAST_PTR(char, acpi_gbl_sleep_state_names[sleep_state]);
146 /* Evaluate the namespace object containing the values for this state */
148 status = acpi_ns_evaluate(info);
149 if (ACPI_FAILURE(status)) {
150 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
151 "%s while evaluating SleepState [%s]\n",
152 acpi_format_exception(status),
158 /* Must have a return object */
160 if (!info->return_object) {
161 ACPI_ERROR((AE_INFO, "No Sleep State object returned from [%s]",
163 status = AE_NOT_EXIST;
166 /* It must be of type Package */
168 else if (ACPI_GET_OBJECT_TYPE(info->return_object) != ACPI_TYPE_PACKAGE) {
170 "Sleep State return object is not a Package"));
171 status = AE_AML_OPERAND_TYPE;
175 * The package must have at least two elements. NOTE (March 2005): This
176 * goes against the current ACPI spec which defines this object as a
177 * package with one encoded DWORD element. However, existing practice
178 * by BIOS vendors seems to be to have 2 or more elements, at least
179 * one per sleep type (A/B).
181 else if (info->return_object->package.count < 2) {
183 "Sleep State return package does not have at least two elements"));
184 status = AE_AML_NO_OPERAND;
187 /* The first two elements must both be of type Integer */
189 else if ((ACPI_GET_OBJECT_TYPE(info->return_object->package.elements[0])
190 != ACPI_TYPE_INTEGER) ||
191 (ACPI_GET_OBJECT_TYPE(info->return_object->package.elements[1])
192 != ACPI_TYPE_INTEGER)) {
194 "Sleep State return package elements are not both Integers (%s, %s)",
195 acpi_ut_get_object_type_name(info->return_object->
196 package.elements[0]),
197 acpi_ut_get_object_type_name(info->return_object->
198 package.elements[1])));
199 status = AE_AML_OPERAND_TYPE;
201 /* Valid _Sx_ package size, type, and value */
204 (info->return_object->package.elements[0])->integer.value;
206 (info->return_object->package.elements[1])->integer.value;
209 if (ACPI_FAILURE(status)) {
210 ACPI_EXCEPTION((AE_INFO, status,
211 "While evaluating SleepState [%s], bad Sleep object %p type %s",
212 info->pathname, info->return_object,
213 acpi_ut_get_object_type_name(info->
217 acpi_ut_remove_reference(info->return_object);
221 return_ACPI_STATUS(status);
224 ACPI_EXPORT_SYMBOL(acpi_get_sleep_type_data)
226 /*******************************************************************************
228 * FUNCTION: acpi_hw_get_register_bit_mask
230 * PARAMETERS: register_id - Index of ACPI Register to access
232 * RETURN: The bitmask to be used when accessing the register
234 * DESCRIPTION: Map register_id into a register bitmask.
236 ******************************************************************************/
237 struct acpi_bit_register_info *acpi_hw_get_bit_register_info(u32 register_id)
239 ACPI_FUNCTION_ENTRY();
241 if (register_id > ACPI_BITREG_MAX) {
242 ACPI_ERROR((AE_INFO, "Invalid BitRegister ID: %X",
247 return (&acpi_gbl_bit_register_info[register_id]);
250 /*******************************************************************************
252 * FUNCTION: acpi_get_register
254 * PARAMETERS: register_id - ID of ACPI bit_register to access
255 * return_value - Value that was read from the register
256 * Flags - Lock the hardware or not
258 * RETURN: Status and the value read from specified Register. Value
259 * returned is normalized to bit0 (is shifted all the way right)
261 * DESCRIPTION: ACPI bit_register read function.
263 * NOTE: TBD: Flags parameter is obsolete, to be removed
265 ******************************************************************************/
267 acpi_status acpi_get_register(u32 register_id, u32 * return_value, u32 flags)
269 u32 register_value = 0;
270 struct acpi_bit_register_info *bit_reg_info;
273 ACPI_FUNCTION_TRACE(acpi_get_register);
275 /* Get the info structure corresponding to the requested ACPI Register */
277 bit_reg_info = acpi_hw_get_bit_register_info(register_id);
279 return_ACPI_STATUS(AE_BAD_PARAMETER);
282 /* Read from the register */
284 status = acpi_hw_register_read(ACPI_MTX_LOCK,
285 bit_reg_info->parent_register,
288 if (ACPI_SUCCESS(status)) {
290 /* Normalize the value that was read */
293 ((register_value & bit_reg_info->access_bit_mask)
294 >> bit_reg_info->bit_position);
296 *return_value = register_value;
298 ACPI_DEBUG_PRINT((ACPI_DB_IO, "Read value %8.8X register %X\n",
300 bit_reg_info->parent_register));
303 return_ACPI_STATUS(status);
306 ACPI_EXPORT_SYMBOL(acpi_get_register)
308 /*******************************************************************************
310 * FUNCTION: acpi_set_register
312 * PARAMETERS: register_id - ID of ACPI bit_register to access
313 * Value - (only used on write) value to write to the
314 * Register, NOT pre-normalized to the bit pos
315 * Flags - Lock the hardware or not
319 * DESCRIPTION: ACPI Bit Register write function.
321 * NOTE: TBD: Flags parameter is obsolete, to be removed
323 ******************************************************************************/
324 acpi_status acpi_set_register(u32 register_id, u32 value, u32 flags)
326 u32 register_value = 0;
327 struct acpi_bit_register_info *bit_reg_info;
329 acpi_cpu_flags lock_flags;
331 ACPI_FUNCTION_TRACE_U32(acpi_set_register, register_id);
333 /* Get the info structure corresponding to the requested ACPI Register */
335 bit_reg_info = acpi_hw_get_bit_register_info(register_id);
337 ACPI_ERROR((AE_INFO, "Bad ACPI HW RegisterId: %X",
339 return_ACPI_STATUS(AE_BAD_PARAMETER);
342 lock_flags = acpi_os_acquire_lock(acpi_gbl_hardware_lock);
344 /* Always do a register read first so we can insert the new bits */
346 status = acpi_hw_register_read(ACPI_MTX_DO_NOT_LOCK,
347 bit_reg_info->parent_register,
349 if (ACPI_FAILURE(status)) {
350 goto unlock_and_exit;
354 * Decode the Register ID
355 * Register ID = [Register block ID] | [bit ID]
357 * Check bit ID to fine locate Register offset.
358 * Check Mask to determine Register offset, and then read-write.
360 switch (bit_reg_info->parent_register) {
361 case ACPI_REGISTER_PM1_STATUS:
364 * Status Registers are different from the rest. Clear by
365 * writing 1, and writing 0 has no effect. So, the only relevant
366 * information is the single bit we're interested in, all others should
367 * be written as 0 so they will be left unchanged.
369 value = ACPI_REGISTER_PREPARE_BITS(value,
370 bit_reg_info->bit_position,
374 status = acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
375 ACPI_REGISTER_PM1_STATUS,
381 case ACPI_REGISTER_PM1_ENABLE:
383 ACPI_REGISTER_INSERT_VALUE(register_value,
384 bit_reg_info->bit_position,
385 bit_reg_info->access_bit_mask,
388 status = acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
389 ACPI_REGISTER_PM1_ENABLE,
390 (u16) register_value);
393 case ACPI_REGISTER_PM1_CONTROL:
396 * Write the PM1 Control register.
397 * Note that at this level, the fact that there are actually TWO
398 * registers (A and B - and B may not exist) is abstracted.
400 ACPI_DEBUG_PRINT((ACPI_DB_IO, "PM1 control: Read %X\n",
403 ACPI_REGISTER_INSERT_VALUE(register_value,
404 bit_reg_info->bit_position,
405 bit_reg_info->access_bit_mask,
408 status = acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
409 ACPI_REGISTER_PM1_CONTROL,
410 (u16) register_value);
413 case ACPI_REGISTER_PM2_CONTROL:
415 status = acpi_hw_register_read(ACPI_MTX_DO_NOT_LOCK,
416 ACPI_REGISTER_PM2_CONTROL,
418 if (ACPI_FAILURE(status)) {
419 goto unlock_and_exit;
422 ACPI_DEBUG_PRINT((ACPI_DB_IO,
423 "PM2 control: Read %X from %8.8X%8.8X\n",
425 ACPI_FORMAT_UINT64(acpi_gbl_FADT->
426 xpm2_cnt_blk.address)));
428 ACPI_REGISTER_INSERT_VALUE(register_value,
429 bit_reg_info->bit_position,
430 bit_reg_info->access_bit_mask,
433 ACPI_DEBUG_PRINT((ACPI_DB_IO,
434 "About to write %4.4X to %8.8X%8.8X\n",
436 ACPI_FORMAT_UINT64(acpi_gbl_FADT->
437 xpm2_cnt_blk.address)));
439 status = acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK,
440 ACPI_REGISTER_PM2_CONTROL,
441 (u8) (register_value));
450 acpi_os_release_lock(acpi_gbl_hardware_lock, lock_flags);
452 /* Normalize the value that was read */
454 ACPI_DEBUG_EXEC(register_value =
455 ((register_value & bit_reg_info->access_bit_mask) >>
456 bit_reg_info->bit_position));
458 ACPI_DEBUG_PRINT((ACPI_DB_IO,
459 "Set bits: %8.8X actual %8.8X register %X\n", value,
460 register_value, bit_reg_info->parent_register));
461 return_ACPI_STATUS(status);
464 ACPI_EXPORT_SYMBOL(acpi_set_register)
466 /******************************************************************************
468 * FUNCTION: acpi_hw_register_read
470 * PARAMETERS: use_lock - Mutex hw access
471 * register_id - register_iD + Offset
472 * return_value - Where the register value is returned
474 * RETURN: Status and the value read.
476 * DESCRIPTION: Acpi register read function. Registers are read at the
479 ******************************************************************************/
481 acpi_hw_register_read(u8 use_lock, u32 register_id, u32 * return_value)
486 acpi_cpu_flags lock_flags = 0;
488 ACPI_FUNCTION_TRACE(hw_register_read);
490 if (ACPI_MTX_LOCK == use_lock) {
491 lock_flags = acpi_os_acquire_lock(acpi_gbl_hardware_lock);
494 switch (register_id) {
495 case ACPI_REGISTER_PM1_STATUS: /* 16-bit access */
498 acpi_hw_low_level_read(16, &value1,
499 &acpi_gbl_FADT->xpm1a_evt_blk);
500 if (ACPI_FAILURE(status)) {
501 goto unlock_and_exit;
504 /* PM1B is optional */
507 acpi_hw_low_level_read(16, &value2,
508 &acpi_gbl_FADT->xpm1b_evt_blk);
512 case ACPI_REGISTER_PM1_ENABLE: /* 16-bit access */
515 acpi_hw_low_level_read(16, &value1, &acpi_gbl_xpm1a_enable);
516 if (ACPI_FAILURE(status)) {
517 goto unlock_and_exit;
520 /* PM1B is optional */
523 acpi_hw_low_level_read(16, &value2, &acpi_gbl_xpm1b_enable);
527 case ACPI_REGISTER_PM1_CONTROL: /* 16-bit access */
530 acpi_hw_low_level_read(16, &value1,
531 &acpi_gbl_FADT->xpm1a_cnt_blk);
532 if (ACPI_FAILURE(status)) {
533 goto unlock_and_exit;
537 acpi_hw_low_level_read(16, &value2,
538 &acpi_gbl_FADT->xpm1b_cnt_blk);
542 case ACPI_REGISTER_PM2_CONTROL: /* 8-bit access */
545 acpi_hw_low_level_read(8, &value1,
546 &acpi_gbl_FADT->xpm2_cnt_blk);
549 case ACPI_REGISTER_PM_TIMER: /* 32-bit access */
552 acpi_hw_low_level_read(32, &value1,
553 &acpi_gbl_FADT->xpm_tmr_blk);
556 case ACPI_REGISTER_SMI_COMMAND_BLOCK: /* 8-bit access */
558 status = acpi_os_read_port(acpi_gbl_FADT->smi_cmd, &value1, 8);
562 ACPI_ERROR((AE_INFO, "Unknown Register ID: %X", register_id));
563 status = AE_BAD_PARAMETER;
568 if (ACPI_MTX_LOCK == use_lock) {
569 acpi_os_release_lock(acpi_gbl_hardware_lock, lock_flags);
572 if (ACPI_SUCCESS(status)) {
573 *return_value = value1;
576 return_ACPI_STATUS(status);
579 /******************************************************************************
581 * FUNCTION: acpi_hw_register_write
583 * PARAMETERS: use_lock - Mutex hw access
584 * register_id - register_iD + Offset
585 * Value - The value to write
589 * DESCRIPTION: Acpi register Write function. Registers are written at the
592 ******************************************************************************/
594 acpi_status acpi_hw_register_write(u8 use_lock, u32 register_id, u32 value)
597 acpi_cpu_flags lock_flags = 0;
599 ACPI_FUNCTION_TRACE(hw_register_write);
601 if (ACPI_MTX_LOCK == use_lock) {
602 lock_flags = acpi_os_acquire_lock(acpi_gbl_hardware_lock);
605 switch (register_id) {
606 case ACPI_REGISTER_PM1_STATUS: /* 16-bit access */
609 acpi_hw_low_level_write(16, value,
610 &acpi_gbl_FADT->xpm1a_evt_blk);
611 if (ACPI_FAILURE(status)) {
612 goto unlock_and_exit;
615 /* PM1B is optional */
618 acpi_hw_low_level_write(16, value,
619 &acpi_gbl_FADT->xpm1b_evt_blk);
622 case ACPI_REGISTER_PM1_ENABLE: /* 16-bit access */
625 acpi_hw_low_level_write(16, value, &acpi_gbl_xpm1a_enable);
626 if (ACPI_FAILURE(status)) {
627 goto unlock_and_exit;
630 /* PM1B is optional */
633 acpi_hw_low_level_write(16, value, &acpi_gbl_xpm1b_enable);
636 case ACPI_REGISTER_PM1_CONTROL: /* 16-bit access */
639 acpi_hw_low_level_write(16, value,
640 &acpi_gbl_FADT->xpm1a_cnt_blk);
641 if (ACPI_FAILURE(status)) {
642 goto unlock_and_exit;
646 acpi_hw_low_level_write(16, value,
647 &acpi_gbl_FADT->xpm1b_cnt_blk);
650 case ACPI_REGISTER_PM1A_CONTROL: /* 16-bit access */
653 acpi_hw_low_level_write(16, value,
654 &acpi_gbl_FADT->xpm1a_cnt_blk);
657 case ACPI_REGISTER_PM1B_CONTROL: /* 16-bit access */
660 acpi_hw_low_level_write(16, value,
661 &acpi_gbl_FADT->xpm1b_cnt_blk);
664 case ACPI_REGISTER_PM2_CONTROL: /* 8-bit access */
667 acpi_hw_low_level_write(8, value,
668 &acpi_gbl_FADT->xpm2_cnt_blk);
671 case ACPI_REGISTER_PM_TIMER: /* 32-bit access */
674 acpi_hw_low_level_write(32, value,
675 &acpi_gbl_FADT->xpm_tmr_blk);
678 case ACPI_REGISTER_SMI_COMMAND_BLOCK: /* 8-bit access */
680 /* SMI_CMD is currently always in IO space */
682 status = acpi_os_write_port(acpi_gbl_FADT->smi_cmd, value, 8);
686 status = AE_BAD_PARAMETER;
691 if (ACPI_MTX_LOCK == use_lock) {
692 acpi_os_release_lock(acpi_gbl_hardware_lock, lock_flags);
695 return_ACPI_STATUS(status);
698 /******************************************************************************
700 * FUNCTION: acpi_hw_low_level_read
702 * PARAMETERS: Width - 8, 16, or 32
703 * Value - Where the value is returned
704 * Reg - GAS register structure
708 * DESCRIPTION: Read from either memory or IO space.
710 ******************************************************************************/
713 acpi_hw_low_level_read(u32 width, u32 * value, struct acpi_generic_address *reg)
718 ACPI_FUNCTION_NAME(hw_low_level_read);
721 * Must have a valid pointer to a GAS structure, and
722 * a non-zero address within. However, don't return an error
723 * because the PM1A/B code must not fail if B isn't present.
729 /* Get a local copy of the address. Handles possible alignment issues */
731 ACPI_MOVE_64_TO_64(&address, ®->address);
738 * Two address spaces supported: Memory or IO.
739 * PCI_Config is not supported here because the GAS struct is insufficient
741 switch (reg->address_space_id) {
742 case ACPI_ADR_SPACE_SYSTEM_MEMORY:
744 status = acpi_os_read_memory((acpi_physical_address) address,
748 case ACPI_ADR_SPACE_SYSTEM_IO:
750 status = acpi_os_read_port((acpi_io_address) address,
756 "Unsupported address space: %X",
757 reg->address_space_id));
758 return (AE_BAD_PARAMETER);
761 ACPI_DEBUG_PRINT((ACPI_DB_IO,
762 "Read: %8.8X width %2d from %8.8X%8.8X (%s)\n",
764 ACPI_FORMAT_UINT64(address),
765 acpi_ut_get_region_name(reg->address_space_id)));
770 /******************************************************************************
772 * FUNCTION: acpi_hw_low_level_write
774 * PARAMETERS: Width - 8, 16, or 32
775 * Value - To be written
776 * Reg - GAS register structure
780 * DESCRIPTION: Write to either memory or IO space.
782 ******************************************************************************/
785 acpi_hw_low_level_write(u32 width, u32 value, struct acpi_generic_address * reg)
790 ACPI_FUNCTION_NAME(hw_low_level_write);
793 * Must have a valid pointer to a GAS structure, and
794 * a non-zero address within. However, don't return an error
795 * because the PM1A/B code must not fail if B isn't present.
801 /* Get a local copy of the address. Handles possible alignment issues */
803 ACPI_MOVE_64_TO_64(&address, ®->address);
809 * Two address spaces supported: Memory or IO.
810 * PCI_Config is not supported here because the GAS struct is insufficient
812 switch (reg->address_space_id) {
813 case ACPI_ADR_SPACE_SYSTEM_MEMORY:
815 status = acpi_os_write_memory((acpi_physical_address) address,
819 case ACPI_ADR_SPACE_SYSTEM_IO:
821 status = acpi_os_write_port((acpi_io_address) address,
827 "Unsupported address space: %X",
828 reg->address_space_id));
829 return (AE_BAD_PARAMETER);
832 ACPI_DEBUG_PRINT((ACPI_DB_IO,
833 "Wrote: %8.8X width %2d to %8.8X%8.8X (%s)\n",
835 ACPI_FORMAT_UINT64(address),
836 acpi_ut_get_region_name(reg->address_space_id)));