Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | |
2 | /******************************************************************************* | |
3 | * | |
4 | * Module Name: hwregs - Read/write access functions for the various ACPI | |
5 | * control and status registers. | |
6 | * | |
7 | ******************************************************************************/ | |
8 | ||
9 | /* | |
75a44ce0 | 10 | * Copyright (C) 2000 - 2008, Intel Corp. |
1da177e4 LT |
11 | * All rights reserved. |
12 | * | |
13 | * Redistribution and use in source and binary forms, with or without | |
14 | * modification, are permitted provided that the following conditions | |
15 | * are met: | |
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. | |
27 | * | |
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. | |
31 | * | |
32 | * NO WARRANTY | |
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. | |
44 | */ | |
45 | ||
1da177e4 | 46 | #include <acpi/acpi.h> |
e2f7a777 LB |
47 | #include "accommon.h" |
48 | #include "acnamesp.h" | |
49 | #include "acevents.h" | |
1da177e4 LT |
50 | |
51 | #define _COMPONENT ACPI_HARDWARE | |
4be44fcd | 52 | ACPI_MODULE_NAME("hwregs") |
1da177e4 | 53 | |
c520abad BM |
54 | /* Local Prototypes */ |
55 | static acpi_status | |
56 | acpi_hw_read_multiple(u32 *value, | |
57 | struct acpi_generic_address *register_a, | |
58 | struct acpi_generic_address *register_b); | |
59 | ||
60 | static acpi_status | |
61 | acpi_hw_write_multiple(u32 value, | |
62 | struct acpi_generic_address *register_a, | |
63 | struct acpi_generic_address *register_b); | |
64 | ||
1da177e4 LT |
65 | /******************************************************************************* |
66 | * | |
67 | * FUNCTION: acpi_hw_clear_acpi_status | |
68 | * | |
d8c71b6d | 69 | * PARAMETERS: None |
1da177e4 | 70 | * |
7db5d82d | 71 | * RETURN: Status |
1da177e4 LT |
72 | * |
73 | * DESCRIPTION: Clears all fixed and general purpose status bits | |
1da177e4 LT |
74 | * |
75 | ******************************************************************************/ | |
c520abad | 76 | |
d8c71b6d | 77 | acpi_status acpi_hw_clear_acpi_status(void) |
1da177e4 | 78 | { |
4be44fcd | 79 | acpi_status status; |
4c90ece2 | 80 | acpi_cpu_flags lock_flags = 0; |
1da177e4 | 81 | |
b229cf92 | 82 | ACPI_FUNCTION_TRACE(hw_clear_acpi_status); |
1da177e4 | 83 | |
8eb7b247 | 84 | ACPI_DEBUG_PRINT((ACPI_DB_IO, "About to write %04X to %8.8X%8.8X\n", |
4be44fcd | 85 | ACPI_BITMASK_ALL_FIXED_STATUS, |
8eb7b247 | 86 | ACPI_FORMAT_UINT64(acpi_gbl_xpm1a_status.address))); |
1da177e4 | 87 | |
4c90ece2 | 88 | lock_flags = acpi_os_acquire_lock(acpi_gbl_hardware_lock); |
1da177e4 | 89 | |
227243a0 | 90 | /* Clear the fixed events in PM1 A/B */ |
531c633d | 91 | |
d30dc9ab | 92 | status = acpi_hw_register_write(ACPI_REGISTER_PM1_STATUS, |
4be44fcd LB |
93 | ACPI_BITMASK_ALL_FIXED_STATUS); |
94 | if (ACPI_FAILURE(status)) { | |
1da177e4 LT |
95 | goto unlock_and_exit; |
96 | } | |
97 | ||
1da177e4 LT |
98 | /* Clear the GPE Bits in all GPE registers in all GPE blocks */ |
99 | ||
e97d6bf1 | 100 | status = acpi_ev_walk_gpe_list(acpi_hw_clear_gpe_block, NULL); |
1da177e4 | 101 | |
4be44fcd | 102 | unlock_and_exit: |
4c90ece2 | 103 | acpi_os_release_lock(acpi_gbl_hardware_lock, lock_flags); |
4be44fcd | 104 | return_ACPI_STATUS(status); |
1da177e4 LT |
105 | } |
106 | ||
1da177e4 LT |
107 | /******************************************************************************* |
108 | * | |
109 | * FUNCTION: acpi_hw_get_register_bit_mask | |
110 | * | |
111 | * PARAMETERS: register_id - Index of ACPI Register to access | |
112 | * | |
44f6c012 | 113 | * RETURN: The bitmask to be used when accessing the register |
1da177e4 | 114 | * |
44f6c012 | 115 | * DESCRIPTION: Map register_id into a register bitmask. |
1da177e4 LT |
116 | * |
117 | ******************************************************************************/ | |
7db5d82d | 118 | |
4be44fcd | 119 | struct acpi_bit_register_info *acpi_hw_get_bit_register_info(u32 register_id) |
1da177e4 | 120 | { |
4a90c7e8 | 121 | ACPI_FUNCTION_ENTRY(); |
1da177e4 LT |
122 | |
123 | if (register_id > ACPI_BITREG_MAX) { | |
b229cf92 | 124 | ACPI_ERROR((AE_INFO, "Invalid BitRegister ID: %X", |
b8e4d893 | 125 | register_id)); |
1da177e4 LT |
126 | return (NULL); |
127 | } | |
128 | ||
129 | return (&acpi_gbl_bit_register_info[register_id]); | |
130 | } | |
131 | ||
32c9ef99 BM |
132 | /****************************************************************************** |
133 | * | |
134 | * FUNCTION: acpi_hw_write_pm1_control | |
135 | * | |
136 | * PARAMETERS: pm1a_control - Value to be written to PM1A control | |
137 | * pm1b_control - Value to be written to PM1B control | |
138 | * | |
139 | * RETURN: Status | |
140 | * | |
141 | * DESCRIPTION: Write the PM1 A/B control registers. These registers are | |
142 | * different than than the PM1 A/B status and enable registers | |
143 | * in that different values can be written to the A/B registers. | |
144 | * Most notably, the SLP_TYP bits can be different, as per the | |
145 | * values returned from the _Sx predefined methods. | |
146 | * | |
147 | ******************************************************************************/ | |
148 | ||
149 | acpi_status acpi_hw_write_pm1_control(u32 pm1a_control, u32 pm1b_control) | |
150 | { | |
151 | acpi_status status; | |
152 | ||
153 | ACPI_FUNCTION_TRACE(hw_write_pm1_control); | |
154 | ||
155 | status = acpi_write(pm1a_control, &acpi_gbl_FADT.xpm1a_control_block); | |
156 | if (ACPI_FAILURE(status)) { | |
157 | return_ACPI_STATUS(status); | |
158 | } | |
159 | ||
160 | if (acpi_gbl_FADT.xpm1b_control_block.address) { | |
161 | status = | |
162 | acpi_write(pm1b_control, | |
163 | &acpi_gbl_FADT.xpm1b_control_block); | |
164 | } | |
165 | return_ACPI_STATUS(status); | |
166 | } | |
167 | ||
1da177e4 LT |
168 | /****************************************************************************** |
169 | * | |
170 | * FUNCTION: acpi_hw_register_read | |
171 | * | |
d30dc9ab | 172 | * PARAMETERS: register_id - ACPI Register ID |
44f6c012 | 173 | * return_value - Where the register value is returned |
1da177e4 LT |
174 | * |
175 | * RETURN: Status and the value read. | |
176 | * | |
967440e3 | 177 | * DESCRIPTION: Read from the specified ACPI register |
1da177e4 LT |
178 | * |
179 | ******************************************************************************/ | |
1da177e4 | 180 | acpi_status |
d30dc9ab | 181 | acpi_hw_register_read(u32 register_id, u32 * return_value) |
1da177e4 | 182 | { |
c520abad | 183 | u32 value = 0; |
4be44fcd | 184 | acpi_status status; |
1da177e4 | 185 | |
b229cf92 | 186 | ACPI_FUNCTION_TRACE(hw_register_read); |
1da177e4 | 187 | |
1da177e4 | 188 | switch (register_id) { |
c520abad | 189 | case ACPI_REGISTER_PM1_STATUS: /* PM1 A/B: 16-bit access each */ |
1da177e4 | 190 | |
c520abad BM |
191 | status = acpi_hw_read_multiple(&value, |
192 | &acpi_gbl_xpm1a_status, | |
193 | &acpi_gbl_xpm1b_status); | |
1da177e4 LT |
194 | break; |
195 | ||
c520abad | 196 | case ACPI_REGISTER_PM1_ENABLE: /* PM1 A/B: 16-bit access each */ |
1da177e4 | 197 | |
c520abad BM |
198 | status = acpi_hw_read_multiple(&value, |
199 | &acpi_gbl_xpm1a_enable, | |
200 | &acpi_gbl_xpm1b_enable); | |
1da177e4 LT |
201 | break; |
202 | ||
c520abad | 203 | case ACPI_REGISTER_PM1_CONTROL: /* PM1 A/B: 16-bit access each */ |
1da177e4 | 204 | |
c520abad BM |
205 | status = acpi_hw_read_multiple(&value, |
206 | &acpi_gbl_FADT. | |
207 | xpm1a_control_block, | |
208 | &acpi_gbl_FADT. | |
209 | xpm1b_control_block); | |
c3dd25f4 LM |
210 | |
211 | /* | |
212 | * Zero the write-only bits. From the ACPI specification, "Hardware | |
213 | * Write-Only Bits": "Upon reads to registers with write-only bits, | |
214 | * software masks out all write-only bits." | |
215 | */ | |
216 | value &= ~ACPI_PM1_CONTROL_WRITEONLY_BITS; | |
1da177e4 LT |
217 | break; |
218 | ||
4be44fcd | 219 | case ACPI_REGISTER_PM2_CONTROL: /* 8-bit access */ |
1da177e4 | 220 | |
c520abad | 221 | status = acpi_read(&value, &acpi_gbl_FADT.xpm2_control_block); |
1da177e4 LT |
222 | break; |
223 | ||
4be44fcd | 224 | case ACPI_REGISTER_PM_TIMER: /* 32-bit access */ |
1da177e4 | 225 | |
c520abad | 226 | status = acpi_read(&value, &acpi_gbl_FADT.xpm_timer_block); |
1da177e4 LT |
227 | break; |
228 | ||
4be44fcd | 229 | case ACPI_REGISTER_SMI_COMMAND_BLOCK: /* 8-bit access */ |
1da177e4 | 230 | |
f3d2e786 | 231 | status = |
7f071903 | 232 | acpi_hw_read_port(acpi_gbl_FADT.smi_command, &value, 8); |
1da177e4 LT |
233 | break; |
234 | ||
235 | default: | |
b8e4d893 | 236 | ACPI_ERROR((AE_INFO, "Unknown Register ID: %X", register_id)); |
1da177e4 LT |
237 | status = AE_BAD_PARAMETER; |
238 | break; | |
239 | } | |
240 | ||
4be44fcd | 241 | if (ACPI_SUCCESS(status)) { |
c520abad | 242 | *return_value = value; |
1da177e4 LT |
243 | } |
244 | ||
4be44fcd | 245 | return_ACPI_STATUS(status); |
1da177e4 LT |
246 | } |
247 | ||
1da177e4 LT |
248 | /****************************************************************************** |
249 | * | |
250 | * FUNCTION: acpi_hw_register_write | |
251 | * | |
d30dc9ab | 252 | * PARAMETERS: register_id - ACPI Register ID |
1da177e4 LT |
253 | * Value - The value to write |
254 | * | |
255 | * RETURN: Status | |
256 | * | |
967440e3 BM |
257 | * DESCRIPTION: Write to the specified ACPI register |
258 | * | |
259 | * NOTE: In accordance with the ACPI specification, this function automatically | |
260 | * preserves the value of the following bits, meaning that these bits cannot be | |
261 | * changed via this interface: | |
262 | * | |
263 | * PM1_CONTROL[0] = SCI_EN | |
264 | * PM1_CONTROL[9] | |
265 | * PM1_STATUS[11] | |
266 | * | |
267 | * ACPI References: | |
268 | * 1) Hardware Ignored Bits: When software writes to a register with ignored | |
269 | * bit fields, it preserves the ignored bit fields | |
270 | * 2) SCI_EN: OSPM always preserves this bit position | |
1da177e4 LT |
271 | * |
272 | ******************************************************************************/ | |
273 | ||
d30dc9ab | 274 | acpi_status acpi_hw_register_write(u32 register_id, u32 value) |
1da177e4 | 275 | { |
4be44fcd | 276 | acpi_status status; |
967440e3 | 277 | u32 read_value; |
1da177e4 | 278 | |
b229cf92 | 279 | ACPI_FUNCTION_TRACE(hw_register_write); |
1da177e4 | 280 | |
1da177e4 | 281 | switch (register_id) { |
c520abad | 282 | case ACPI_REGISTER_PM1_STATUS: /* PM1 A/B: 16-bit access each */ |
8636f8d2 BM |
283 | /* |
284 | * Handle the "ignored" bit in PM1 Status. According to the ACPI | |
285 | * specification, ignored bits are to be preserved when writing. | |
286 | * Normally, this would mean a read/modify/write sequence. However, | |
287 | * preserving a bit in the status register is different. Writing a | |
288 | * one clears the status, and writing a zero preserves the status. | |
289 | * Therefore, we must always write zero to the ignored bit. | |
290 | * | |
291 | * This behavior is clarified in the ACPI 4.0 specification. | |
292 | */ | |
293 | value &= ~ACPI_PM1_STATUS_PRESERVED_BITS; | |
967440e3 | 294 | |
c520abad BM |
295 | status = acpi_hw_write_multiple(value, |
296 | &acpi_gbl_xpm1a_status, | |
297 | &acpi_gbl_xpm1b_status); | |
1da177e4 LT |
298 | break; |
299 | ||
c520abad | 300 | case ACPI_REGISTER_PM1_ENABLE: /* PM1 A/B: 16-bit access */ |
1da177e4 | 301 | |
c520abad BM |
302 | status = acpi_hw_write_multiple(value, |
303 | &acpi_gbl_xpm1a_enable, | |
304 | &acpi_gbl_xpm1b_enable); | |
1da177e4 LT |
305 | break; |
306 | ||
c520abad | 307 | case ACPI_REGISTER_PM1_CONTROL: /* PM1 A/B: 16-bit access each */ |
1da177e4 | 308 | |
967440e3 BM |
309 | /* |
310 | * Perform a read first to preserve certain bits (per ACPI spec) | |
c520abad | 311 | * Note: This includes SCI_EN, we never want to change this bit |
967440e3 | 312 | */ |
c520abad BM |
313 | status = acpi_hw_read_multiple(&read_value, |
314 | &acpi_gbl_FADT. | |
315 | xpm1a_control_block, | |
316 | &acpi_gbl_FADT. | |
317 | xpm1b_control_block); | |
967440e3 | 318 | if (ACPI_FAILURE(status)) { |
d30dc9ab | 319 | goto exit; |
967440e3 BM |
320 | } |
321 | ||
322 | /* Insert the bits to be preserved */ | |
323 | ||
324 | ACPI_INSERT_BITS(value, ACPI_PM1_CONTROL_PRESERVED_BITS, | |
325 | read_value); | |
326 | ||
327 | /* Now we can write the data */ | |
328 | ||
c520abad BM |
329 | status = acpi_hw_write_multiple(value, |
330 | &acpi_gbl_FADT. | |
331 | xpm1a_control_block, | |
332 | &acpi_gbl_FADT. | |
333 | xpm1b_control_block); | |
1da177e4 LT |
334 | break; |
335 | ||
4be44fcd | 336 | case ACPI_REGISTER_PM2_CONTROL: /* 8-bit access */ |
1da177e4 | 337 | |
20869dcf BM |
338 | /* |
339 | * For control registers, all reserved bits must be preserved, | |
340 | * as per the ACPI spec. | |
341 | */ | |
342 | status = | |
343 | acpi_read(&read_value, &acpi_gbl_FADT.xpm2_control_block); | |
344 | if (ACPI_FAILURE(status)) { | |
345 | goto exit; | |
346 | } | |
347 | ||
348 | /* Insert the bits to be preserved */ | |
349 | ||
350 | ACPI_INSERT_BITS(value, ACPI_PM2_CONTROL_PRESERVED_BITS, | |
351 | read_value); | |
352 | ||
ecfbbc7b | 353 | status = acpi_write(value, &acpi_gbl_FADT.xpm2_control_block); |
1da177e4 LT |
354 | break; |
355 | ||
4be44fcd | 356 | case ACPI_REGISTER_PM_TIMER: /* 32-bit access */ |
1da177e4 | 357 | |
ecfbbc7b | 358 | status = acpi_write(value, &acpi_gbl_FADT.xpm_timer_block); |
1da177e4 LT |
359 | break; |
360 | ||
4be44fcd | 361 | case ACPI_REGISTER_SMI_COMMAND_BLOCK: /* 8-bit access */ |
1da177e4 LT |
362 | |
363 | /* SMI_CMD is currently always in IO space */ | |
364 | ||
f3d2e786 | 365 | status = |
7f071903 | 366 | acpi_hw_write_port(acpi_gbl_FADT.smi_command, value, 8); |
1da177e4 LT |
367 | break; |
368 | ||
1da177e4 | 369 | default: |
c520abad | 370 | ACPI_ERROR((AE_INFO, "Unknown Register ID: %X", register_id)); |
1da177e4 LT |
371 | status = AE_BAD_PARAMETER; |
372 | break; | |
373 | } | |
374 | ||
d30dc9ab | 375 | exit: |
4be44fcd | 376 | return_ACPI_STATUS(status); |
1da177e4 | 377 | } |
c520abad BM |
378 | |
379 | /****************************************************************************** | |
380 | * | |
381 | * FUNCTION: acpi_hw_read_multiple | |
382 | * | |
383 | * PARAMETERS: Value - Where the register value is returned | |
384 | * register_a - First ACPI register (required) | |
385 | * register_b - Second ACPI register (optional) | |
386 | * | |
387 | * RETURN: Status | |
388 | * | |
389 | * DESCRIPTION: Read from the specified two-part ACPI register (such as PM1 A/B) | |
390 | * | |
391 | ******************************************************************************/ | |
392 | ||
393 | static acpi_status | |
394 | acpi_hw_read_multiple(u32 *value, | |
395 | struct acpi_generic_address *register_a, | |
396 | struct acpi_generic_address *register_b) | |
397 | { | |
398 | u32 value_a = 0; | |
399 | u32 value_b = 0; | |
400 | acpi_status status; | |
401 | ||
402 | /* The first register is always required */ | |
403 | ||
404 | status = acpi_read(&value_a, register_a); | |
405 | if (ACPI_FAILURE(status)) { | |
406 | return (status); | |
407 | } | |
408 | ||
409 | /* Second register is optional */ | |
410 | ||
411 | if (register_b->address) { | |
412 | status = acpi_read(&value_b, register_b); | |
413 | if (ACPI_FAILURE(status)) { | |
414 | return (status); | |
415 | } | |
416 | } | |
417 | ||
aefc7f9a BM |
418 | /* |
419 | * OR the two return values together. No shifting or masking is necessary, | |
420 | * because of how the PM1 registers are defined in the ACPI specification: | |
421 | * | |
422 | * "Although the bits can be split between the two register blocks (each | |
423 | * register block has a unique pointer within the FADT), the bit positions | |
424 | * are maintained. The register block with unimplemented bits (that is, | |
425 | * those implemented in the other register block) always returns zeros, | |
426 | * and writes have no side effects" | |
427 | */ | |
428 | *value = (value_a | value_b); | |
c520abad BM |
429 | return (AE_OK); |
430 | } | |
431 | ||
432 | /****************************************************************************** | |
433 | * | |
434 | * FUNCTION: acpi_hw_write_multiple | |
435 | * | |
436 | * PARAMETERS: Value - The value to write | |
437 | * register_a - First ACPI register (required) | |
438 | * register_b - Second ACPI register (optional) | |
439 | * | |
440 | * RETURN: Status | |
441 | * | |
442 | * DESCRIPTION: Write to the specified two-part ACPI register (such as PM1 A/B) | |
443 | * | |
444 | ******************************************************************************/ | |
445 | ||
446 | static acpi_status | |
447 | acpi_hw_write_multiple(u32 value, | |
448 | struct acpi_generic_address *register_a, | |
449 | struct acpi_generic_address *register_b) | |
450 | { | |
451 | acpi_status status; | |
452 | ||
453 | /* The first register is always required */ | |
454 | ||
455 | status = acpi_write(value, register_a); | |
456 | if (ACPI_FAILURE(status)) { | |
457 | return (status); | |
458 | } | |
459 | ||
aefc7f9a BM |
460 | /* |
461 | * Second register is optional | |
462 | * | |
463 | * No bit shifting or clearing is necessary, because of how the PM1 | |
464 | * registers are defined in the ACPI specification: | |
465 | * | |
466 | * "Although the bits can be split between the two register blocks (each | |
467 | * register block has a unique pointer within the FADT), the bit positions | |
468 | * are maintained. The register block with unimplemented bits (that is, | |
469 | * those implemented in the other register block) always returns zeros, | |
470 | * and writes have no side effects" | |
471 | */ | |
c520abad | 472 | if (register_b->address) { |
aefc7f9a | 473 | status = acpi_write(value, register_b); |
c520abad BM |
474 | } |
475 | ||
476 | return (status); | |
477 | } |