2 /******************************************************************************
4 * Module Name: hwxface - Public ACPICA hardware interfaces
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2008, Intel Corp.
10 * All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
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.
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.
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.
45 #include <acpi/acpi.h>
49 #define _COMPONENT ACPI_HARDWARE
50 ACPI_MODULE_NAME("hwxface")
52 /******************************************************************************
54 * FUNCTION: acpi_reset
60 * DESCRIPTION: Set reset register in memory or IO space. Note: Does not
61 * support reset register in PCI config space, this must be
64 ******************************************************************************/
65 acpi_status
acpi_reset(void)
67 struct acpi_generic_address
*reset_reg
;
70 ACPI_FUNCTION_TRACE(acpi_reset
);
72 reset_reg
= &acpi_gbl_FADT
.reset_register
;
74 /* Check if the reset register is supported */
76 if (!(acpi_gbl_FADT
.flags
& ACPI_FADT_RESET_REGISTER
) ||
77 !reset_reg
->address
) {
78 return_ACPI_STATUS(AE_NOT_EXIST
);
81 if (reset_reg
->space_id
== ACPI_ADR_SPACE_SYSTEM_IO
) {
83 * For I/O space, write directly to the OSL. This bypasses the port
84 * validation mechanism, which may block a valid write to the reset
88 acpi_os_write_port((acpi_io_address
) reset_reg
->address
,
89 acpi_gbl_FADT
.reset_value
,
90 reset_reg
->bit_width
);
92 /* Write the reset value to the reset register */
94 status
= acpi_hw_write(acpi_gbl_FADT
.reset_value
, reset_reg
);
97 return_ACPI_STATUS(status
);
100 ACPI_EXPORT_SYMBOL(acpi_reset
)
102 /******************************************************************************
104 * FUNCTION: acpi_read
106 * PARAMETERS: Value - Where the value is returned
107 * Reg - GAS register structure
111 * DESCRIPTION: Read from either memory or IO space.
113 * LIMITATIONS: <These limitations also apply to acpi_write>
114 * bit_width must be exactly 8, 16, 32, or 64.
115 * space_iD must be system_memory or system_iO.
116 * bit_offset and access_width are currently ignored, as there has
117 * not been a need to implement these.
119 ******************************************************************************/
120 acpi_status
acpi_read(u64
*return_value
, struct acpi_generic_address
*reg
)
127 ACPI_FUNCTION_NAME(acpi_read
);
130 return (AE_BAD_PARAMETER
);
133 /* Validate contents of the GAS register. Allow 64-bit transfers */
135 status
= acpi_hw_validate_register(reg
, 64, &address
);
136 if (ACPI_FAILURE(status
)) {
140 width
= reg
->bit_width
;
142 width
= 32; /* Break into two 32-bit transfers */
145 /* Initialize entire 64-bit return value to zero */
151 * Two address spaces supported: Memory or IO. PCI_Config is
152 * not supported here because the GAS structure is insufficient
154 if (reg
->space_id
== ACPI_ADR_SPACE_SYSTEM_MEMORY
) {
155 status
= acpi_os_read_memory((acpi_physical_address
)
156 address
, &value
, width
);
157 if (ACPI_FAILURE(status
)) {
160 *return_value
= value
;
162 if (reg
->bit_width
== 64) {
164 /* Read the top 32 bits */
166 status
= acpi_os_read_memory((acpi_physical_address
)
167 (address
+ 4), &value
, 32);
168 if (ACPI_FAILURE(status
)) {
171 *return_value
|= ((u64
)value
<< 32);
173 } else { /* ACPI_ADR_SPACE_SYSTEM_IO, validated earlier */
175 status
= acpi_hw_read_port((acpi_io_address
)
176 address
, &value
, width
);
177 if (ACPI_FAILURE(status
)) {
180 *return_value
= value
;
182 if (reg
->bit_width
== 64) {
184 /* Read the top 32 bits */
186 status
= acpi_hw_read_port((acpi_io_address
)
187 (address
+ 4), &value
, 32);
188 if (ACPI_FAILURE(status
)) {
191 *return_value
|= ((u64
)value
<< 32);
195 ACPI_DEBUG_PRINT((ACPI_DB_IO
,
196 "Read: %8.8X%8.8X width %2d from %8.8X%8.8X (%s)\n",
197 ACPI_FORMAT_UINT64(*return_value
), reg
->bit_width
,
198 ACPI_FORMAT_UINT64(address
),
199 acpi_ut_get_region_name(reg
->space_id
)));
204 ACPI_EXPORT_SYMBOL(acpi_read
)
206 /******************************************************************************
208 * FUNCTION: acpi_write
210 * PARAMETERS: Value - Value to be written
211 * Reg - GAS register structure
215 * DESCRIPTION: Write to either memory or IO space.
217 ******************************************************************************/
218 acpi_status
acpi_write(u64 value
, struct acpi_generic_address
*reg
)
224 ACPI_FUNCTION_NAME(acpi_write
);
226 /* Validate contents of the GAS register. Allow 64-bit transfers */
228 status
= acpi_hw_validate_register(reg
, 64, &address
);
229 if (ACPI_FAILURE(status
)) {
233 width
= reg
->bit_width
;
235 width
= 32; /* Break into two 32-bit transfers */
239 * Two address spaces supported: Memory or IO. PCI_Config is
240 * not supported here because the GAS structure is insufficient
242 if (reg
->space_id
== ACPI_ADR_SPACE_SYSTEM_MEMORY
) {
243 status
= acpi_os_write_memory((acpi_physical_address
)
244 address
, ACPI_LODWORD(value
),
246 if (ACPI_FAILURE(status
)) {
250 if (reg
->bit_width
== 64) {
251 status
= acpi_os_write_memory((acpi_physical_address
)
253 ACPI_HIDWORD(value
), 32);
254 if (ACPI_FAILURE(status
)) {
258 } else { /* ACPI_ADR_SPACE_SYSTEM_IO, validated earlier */
260 status
= acpi_hw_write_port((acpi_io_address
)
261 address
, ACPI_LODWORD(value
),
263 if (ACPI_FAILURE(status
)) {
267 if (reg
->bit_width
== 64) {
268 status
= acpi_hw_write_port((acpi_io_address
)
270 ACPI_HIDWORD(value
), 32);
271 if (ACPI_FAILURE(status
)) {
277 ACPI_DEBUG_PRINT((ACPI_DB_IO
,
278 "Wrote: %8.8X%8.8X width %2d to %8.8X%8.8X (%s)\n",
279 ACPI_FORMAT_UINT64(value
), reg
->bit_width
,
280 ACPI_FORMAT_UINT64(address
),
281 acpi_ut_get_region_name(reg
->space_id
)));
286 ACPI_EXPORT_SYMBOL(acpi_write
)
288 /*******************************************************************************
290 * FUNCTION: acpi_read_bit_register
292 * PARAMETERS: register_id - ID of ACPI Bit Register to access
293 * return_value - Value that was read from the register,
294 * normalized to bit position zero.
296 * RETURN: Status and the value read from the specified Register. Value
297 * returned is normalized to bit0 (is shifted all the way right)
299 * DESCRIPTION: ACPI bit_register read function. Does not acquire the HW lock.
301 * SUPPORTS: Bit fields in PM1 Status, PM1 Enable, PM1 Control, and
304 * Note: The hardware lock is not required when reading the ACPI bit registers
305 * since almost all of them are single bit and it does not matter that
306 * the parent hardware register can be split across two physical
307 * registers. The only multi-bit field is SLP_TYP in the PM1 control
308 * register, but this field does not cross an 8-bit boundary (nor does
309 * it make much sense to actually read this field.)
311 ******************************************************************************/
312 acpi_status
acpi_read_bit_register(u32 register_id
, u32
*return_value
)
314 struct acpi_bit_register_info
*bit_reg_info
;
319 ACPI_FUNCTION_TRACE_U32(acpi_read_bit_register
, register_id
);
321 /* Get the info structure corresponding to the requested ACPI Register */
323 bit_reg_info
= acpi_hw_get_bit_register_info(register_id
);
325 return_ACPI_STATUS(AE_BAD_PARAMETER
);
328 /* Read the entire parent register */
330 status
= acpi_hw_register_read(bit_reg_info
->parent_register
,
332 if (ACPI_FAILURE(status
)) {
333 return_ACPI_STATUS(status
);
336 /* Normalize the value that was read, mask off other bits */
338 value
= ((register_value
& bit_reg_info
->access_bit_mask
)
339 >> bit_reg_info
->bit_position
);
341 ACPI_DEBUG_PRINT((ACPI_DB_IO
,
342 "BitReg %X, ParentReg %X, Actual %8.8X, ReturnValue %8.8X\n",
343 register_id
, bit_reg_info
->parent_register
,
344 register_value
, value
));
346 *return_value
= value
;
347 return_ACPI_STATUS(AE_OK
);
350 ACPI_EXPORT_SYMBOL(acpi_read_bit_register
)
352 /*******************************************************************************
354 * FUNCTION: acpi_write_bit_register
356 * PARAMETERS: register_id - ID of ACPI Bit Register to access
357 * Value - Value to write to the register, in bit
358 * position zero. The bit is automaticallly
359 * shifted to the correct position.
363 * DESCRIPTION: ACPI Bit Register write function. Acquires the hardware lock
364 * since most operations require a read/modify/write sequence.
366 * SUPPORTS: Bit fields in PM1 Status, PM1 Enable, PM1 Control, and
369 * Note that at this level, the fact that there may be actually two
370 * hardware registers (A and B - and B may not exist) is abstracted.
372 ******************************************************************************/
373 acpi_status
acpi_write_bit_register(u32 register_id
, u32 value
)
375 struct acpi_bit_register_info
*bit_reg_info
;
376 acpi_cpu_flags lock_flags
;
378 acpi_status status
= AE_OK
;
380 ACPI_FUNCTION_TRACE_U32(acpi_write_bit_register
, register_id
);
382 /* Get the info structure corresponding to the requested ACPI Register */
384 bit_reg_info
= acpi_hw_get_bit_register_info(register_id
);
386 return_ACPI_STATUS(AE_BAD_PARAMETER
);
389 lock_flags
= acpi_os_acquire_lock(acpi_gbl_hardware_lock
);
392 * At this point, we know that the parent register is one of the
393 * following: PM1 Status, PM1 Enable, PM1 Control, or PM2 Control
395 if (bit_reg_info
->parent_register
!= ACPI_REGISTER_PM1_STATUS
) {
397 * 1) Case for PM1 Enable, PM1 Control, and PM2 Control
399 * Perform a register read to preserve the bits that we are not
402 status
= acpi_hw_register_read(bit_reg_info
->parent_register
,
404 if (ACPI_FAILURE(status
)) {
405 goto unlock_and_exit
;
409 * Insert the input bit into the value that was just read
410 * and write the register
412 ACPI_REGISTER_INSERT_VALUE(register_value
,
413 bit_reg_info
->bit_position
,
414 bit_reg_info
->access_bit_mask
,
417 status
= acpi_hw_register_write(bit_reg_info
->parent_register
,
421 * 2) Case for PM1 Status
423 * The Status register is different from the rest. Clear an event
424 * by writing 1, writing 0 has no effect. So, the only relevant
425 * information is the single bit we're interested in, all others
426 * should be written as 0 so they will be left unchanged.
428 register_value
= ACPI_REGISTER_PREPARE_BITS(value
,
434 /* No need to write the register if value is all zeros */
436 if (register_value
) {
438 acpi_hw_register_write(ACPI_REGISTER_PM1_STATUS
,
443 ACPI_DEBUG_PRINT((ACPI_DB_IO
,
444 "BitReg %X, ParentReg %X, Value %8.8X, Actual %8.8X\n",
445 register_id
, bit_reg_info
->parent_register
, value
,
450 acpi_os_release_lock(acpi_gbl_hardware_lock
, lock_flags
);
451 return_ACPI_STATUS(status
);
454 ACPI_EXPORT_SYMBOL(acpi_write_bit_register
)
456 /*******************************************************************************
458 * FUNCTION: acpi_get_sleep_type_data
460 * PARAMETERS: sleep_state - Numeric sleep state
461 * *sleep_type_a - Where SLP_TYPa is returned
462 * *sleep_type_b - Where SLP_TYPb is returned
464 * RETURN: Status - ACPI status
466 * DESCRIPTION: Obtain the SLP_TYPa and SLP_TYPb values for the requested sleep
469 ******************************************************************************/
471 acpi_get_sleep_type_data(u8 sleep_state
, u8
*sleep_type_a
, u8
*sleep_type_b
)
473 acpi_status status
= AE_OK
;
474 struct acpi_evaluate_info
*info
;
476 ACPI_FUNCTION_TRACE(acpi_get_sleep_type_data
);
478 /* Validate parameters */
480 if ((sleep_state
> ACPI_S_STATES_MAX
) || !sleep_type_a
|| !sleep_type_b
) {
481 return_ACPI_STATUS(AE_BAD_PARAMETER
);
484 /* Allocate the evaluation information block */
486 info
= ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info
));
488 return_ACPI_STATUS(AE_NO_MEMORY
);
492 ACPI_CAST_PTR(char, acpi_gbl_sleep_state_names
[sleep_state
]);
494 /* Evaluate the namespace object containing the values for this state */
496 status
= acpi_ns_evaluate(info
);
497 if (ACPI_FAILURE(status
)) {
498 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
499 "%s while evaluating SleepState [%s]\n",
500 acpi_format_exception(status
),
506 /* Must have a return object */
508 if (!info
->return_object
) {
509 ACPI_ERROR((AE_INFO
, "No Sleep State object returned from [%s]",
511 status
= AE_NOT_EXIST
;
514 /* It must be of type Package */
516 else if (info
->return_object
->common
.type
!= ACPI_TYPE_PACKAGE
) {
518 "Sleep State return object is not a Package"));
519 status
= AE_AML_OPERAND_TYPE
;
523 * The package must have at least two elements. NOTE (March 2005): This
524 * goes against the current ACPI spec which defines this object as a
525 * package with one encoded DWORD element. However, existing practice
526 * by BIOS vendors seems to be to have 2 or more elements, at least
527 * one per sleep type (A/B).
529 else if (info
->return_object
->package
.count
< 2) {
531 "Sleep State return package does not have at least two elements"));
532 status
= AE_AML_NO_OPERAND
;
535 /* The first two elements must both be of type Integer */
537 else if (((info
->return_object
->package
.elements
[0])->common
.type
538 != ACPI_TYPE_INTEGER
) ||
539 ((info
->return_object
->package
.elements
[1])->common
.type
540 != ACPI_TYPE_INTEGER
)) {
542 "Sleep State return package elements are not both Integers "
544 acpi_ut_get_object_type_name(info
->return_object
->
545 package
.elements
[0]),
546 acpi_ut_get_object_type_name(info
->return_object
->
547 package
.elements
[1])));
548 status
= AE_AML_OPERAND_TYPE
;
550 /* Valid _Sx_ package size, type, and value */
553 (info
->return_object
->package
.elements
[0])->integer
.value
;
555 (info
->return_object
->package
.elements
[1])->integer
.value
;
558 if (ACPI_FAILURE(status
)) {
559 ACPI_EXCEPTION((AE_INFO
, status
,
560 "While evaluating SleepState [%s], bad Sleep object %p type %s",
561 info
->pathname
, info
->return_object
,
562 acpi_ut_get_object_type_name(info
->
566 acpi_ut_remove_reference(info
->return_object
);
570 return_ACPI_STATUS(status
);
573 ACPI_EXPORT_SYMBOL(acpi_get_sleep_type_data
)