drm: exynos: hdmi: add support for exynos5 hdmiphy
[linux-2.6/btrfs-unstable.git] / drivers / acpi / acpica / hwxface.c
blob7bfd649d1996e6945d2d21787858ca9d0dcbc0e0
2 /******************************************************************************
4 * Module Name: hwxface - Public ACPICA hardware interfaces
6 *****************************************************************************/
8 /*
9 * Copyright (C) 2000 - 2012, 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
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.
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.
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.
45 #include <linux/export.h>
46 #include <acpi/acpi.h>
47 #include "accommon.h"
48 #include "acnamesp.h"
50 #define _COMPONENT ACPI_HARDWARE
51 ACPI_MODULE_NAME("hwxface")
53 /******************************************************************************
55 * FUNCTION: acpi_reset
57 * PARAMETERS: None
59 * RETURN: Status
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.
65 ******************************************************************************/
66 acpi_status acpi_reset(void)
68 struct acpi_generic_address *reset_reg;
69 acpi_status status;
71 ACPI_FUNCTION_TRACE(acpi_reset);
73 reset_reg = &acpi_gbl_FADT.reset_register;
75 /* Check if the reset register is supported */
77 if (!(acpi_gbl_FADT.flags & ACPI_FADT_RESET_REGISTER) ||
78 !reset_reg->address) {
79 return_ACPI_STATUS(AE_NOT_EXIST);
82 if (reset_reg->space_id == ACPI_ADR_SPACE_SYSTEM_IO) {
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.
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 */
95 status = acpi_hw_write(acpi_gbl_FADT.reset_value, reset_reg);
98 return_ACPI_STATUS(status);
101 ACPI_EXPORT_SYMBOL(acpi_reset)
103 /******************************************************************************
105 * FUNCTION: acpi_read
107 * PARAMETERS: value - Where the value is returned
108 * reg - GAS register structure
110 * RETURN: Status
112 * DESCRIPTION: Read from either memory or IO space.
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.
120 ******************************************************************************/
121 acpi_status acpi_read(u64 *return_value, struct acpi_generic_address *reg)
123 u32 value;
124 u32 width;
125 u64 address;
126 acpi_status status;
128 ACPI_FUNCTION_NAME(acpi_read);
130 if (!return_value) {
131 return (AE_BAD_PARAMETER);
134 /* Validate contents of the GAS register. Allow 64-bit transfers */
136 status = acpi_hw_validate_register(reg, 64, &address);
137 if (ACPI_FAILURE(status)) {
138 return (status);
141 /* Initialize entire 64-bit return value to zero */
143 *return_value = 0;
144 value = 0;
147 * Two address spaces supported: Memory or IO. PCI_Config is
148 * not supported here because the GAS structure is insufficient
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);
157 } else { /* ACPI_ADR_SPACE_SYSTEM_IO, validated earlier */
159 width = reg->bit_width;
160 if (width == 64) {
161 width = 32; /* Break into two 32-bit transfers */
164 status = acpi_hw_read_port((acpi_io_address)
165 address, &value, width);
166 if (ACPI_FAILURE(status)) {
167 return (status);
169 *return_value = value;
171 if (reg->bit_width == 64) {
173 /* Read the top 32 bits */
175 status = acpi_hw_read_port((acpi_io_address)
176 (address + 4), &value, 32);
177 if (ACPI_FAILURE(status)) {
178 return (status);
180 *return_value |= ((u64)value << 32);
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)));
190 return (status);
193 ACPI_EXPORT_SYMBOL(acpi_read)
195 /******************************************************************************
197 * FUNCTION: acpi_write
199 * PARAMETERS: value - Value to be written
200 * reg - GAS register structure
202 * RETURN: Status
204 * DESCRIPTION: Write to either memory or IO space.
206 ******************************************************************************/
207 acpi_status acpi_write(u64 value, struct acpi_generic_address *reg)
209 u32 width;
210 u64 address;
211 acpi_status status;
213 ACPI_FUNCTION_NAME(acpi_write);
215 /* Validate contents of the GAS register. Allow 64-bit transfers */
217 status = acpi_hw_validate_register(reg, 64, &address);
218 if (ACPI_FAILURE(status)) {
219 return (status);
223 * Two address spaces supported: Memory or IO. PCI_Config is
224 * not supported here because the GAS structure is insufficient
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);
232 } else { /* ACPI_ADR_SPACE_SYSTEM_IO, validated earlier */
234 width = reg->bit_width;
235 if (width == 64) {
236 width = 32; /* Break into two 32-bit transfers */
239 status = acpi_hw_write_port((acpi_io_address)
240 address, ACPI_LODWORD(value),
241 width);
242 if (ACPI_FAILURE(status)) {
243 return (status);
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);
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)));
262 return (status);
265 ACPI_EXPORT_SYMBOL(acpi_write)
267 #if (!ACPI_REDUCED_HARDWARE)
268 /*******************************************************************************
270 * FUNCTION: acpi_read_bit_register
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.
276 * RETURN: Status and the value read from the specified Register. Value
277 * returned is normalized to bit0 (is shifted all the way right)
279 * DESCRIPTION: ACPI bit_register read function. Does not acquire the HW lock.
281 * SUPPORTS: Bit fields in PM1 Status, PM1 Enable, PM1 Control, and
282 * PM2 Control.
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.)
291 ******************************************************************************/
292 acpi_status acpi_read_bit_register(u32 register_id, u32 *return_value)
294 struct acpi_bit_register_info *bit_reg_info;
295 u32 register_value;
296 u32 value;
297 acpi_status status;
299 ACPI_FUNCTION_TRACE_U32(acpi_read_bit_register, register_id);
301 /* Get the info structure corresponding to the requested ACPI Register */
303 bit_reg_info = acpi_hw_get_bit_register_info(register_id);
304 if (!bit_reg_info) {
305 return_ACPI_STATUS(AE_BAD_PARAMETER);
308 /* Read the entire parent register */
310 status = acpi_hw_register_read(bit_reg_info->parent_register,
311 &register_value);
312 if (ACPI_FAILURE(status)) {
313 return_ACPI_STATUS(status);
316 /* Normalize the value that was read, mask off other bits */
318 value = ((register_value & bit_reg_info->access_bit_mask)
319 >> bit_reg_info->bit_position);
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));
326 *return_value = value;
327 return_ACPI_STATUS(AE_OK);
330 ACPI_EXPORT_SYMBOL(acpi_read_bit_register)
332 /*******************************************************************************
334 * FUNCTION: acpi_write_bit_register
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.
341 * RETURN: Status
343 * DESCRIPTION: ACPI Bit Register write function. Acquires the hardware lock
344 * since most operations require a read/modify/write sequence.
346 * SUPPORTS: Bit fields in PM1 Status, PM1 Enable, PM1 Control, and
347 * PM2 Control.
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.
352 ******************************************************************************/
353 acpi_status acpi_write_bit_register(u32 register_id, u32 value)
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;
360 ACPI_FUNCTION_TRACE_U32(acpi_write_bit_register, register_id);
362 /* Get the info structure corresponding to the requested ACPI Register */
364 bit_reg_info = acpi_hw_get_bit_register_info(register_id);
365 if (!bit_reg_info) {
366 return_ACPI_STATUS(AE_BAD_PARAMETER);
369 lock_flags = acpi_os_acquire_lock(acpi_gbl_hardware_lock);
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
375 if (bit_reg_info->parent_register != ACPI_REGISTER_PM1_STATUS) {
377 * 1) Case for PM1 Enable, PM1 Control, and PM2 Control
379 * Perform a register read to preserve the bits that we are not
380 * interested in
382 status = acpi_hw_register_read(bit_reg_info->parent_register,
383 &register_value);
384 if (ACPI_FAILURE(status)) {
385 goto unlock_and_exit;
389 * Insert the input bit into the value that was just read
390 * and write the register
392 ACPI_REGISTER_INSERT_VALUE(register_value,
393 bit_reg_info->bit_position,
394 bit_reg_info->access_bit_mask,
395 value);
397 status = acpi_hw_register_write(bit_reg_info->parent_register,
398 register_value);
399 } else {
401 * 2) Case for PM1 Status
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.
408 register_value = ACPI_REGISTER_PREPARE_BITS(value,
409 bit_reg_info->
410 bit_position,
411 bit_reg_info->
412 access_bit_mask);
414 /* No need to write the register if value is all zeros */
416 if (register_value) {
417 status =
418 acpi_hw_register_write(ACPI_REGISTER_PM1_STATUS,
419 register_value);
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));
428 unlock_and_exit:
430 acpi_os_release_lock(acpi_gbl_hardware_lock, lock_flags);
431 return_ACPI_STATUS(status);
434 ACPI_EXPORT_SYMBOL(acpi_write_bit_register)
435 #endif /* !ACPI_REDUCED_HARDWARE */
436 /*******************************************************************************
438 * FUNCTION: acpi_get_sleep_type_data
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
444 * RETURN: status - ACPI status
446 * DESCRIPTION: Obtain the SLP_TYPa and SLP_TYPb values for the requested sleep
447 * state.
449 ******************************************************************************/
450 acpi_status
451 acpi_get_sleep_type_data(u8 sleep_state, u8 *sleep_type_a, u8 *sleep_type_b)
453 acpi_status status = AE_OK;
454 struct acpi_evaluate_info *info;
456 ACPI_FUNCTION_TRACE(acpi_get_sleep_type_data);
458 /* Validate parameters */
460 if ((sleep_state > ACPI_S_STATES_MAX) || !sleep_type_a || !sleep_type_b) {
461 return_ACPI_STATUS(AE_BAD_PARAMETER);
464 /* Allocate the evaluation information block */
466 info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info));
467 if (!info) {
468 return_ACPI_STATUS(AE_NO_MEMORY);
471 info->pathname =
472 ACPI_CAST_PTR(char, acpi_gbl_sleep_state_names[sleep_state]);
474 /* Evaluate the namespace object containing the values for this state */
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));
483 goto cleanup;
486 /* Must have a return object */
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;
494 /* It must be of type Package */
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;
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).
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;
515 /* The first two elements must both be of type Integer */
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 */
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;
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)));
546 acpi_ut_remove_reference(info->return_object);
548 cleanup:
549 ACPI_FREE(info);
550 return_ACPI_STATUS(status);
553 ACPI_EXPORT_SYMBOL(acpi_get_sleep_type_data)