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 | /* | |
4a90c7e8 | 10 | * Copyright (C) 2000 - 2006, R. Byron Moore |
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 LT |
46 | #include <acpi/acpi.h> |
47 | #include <acpi/acnamesp.h> | |
48 | #include <acpi/acevents.h> | |
49 | ||
50 | #define _COMPONENT ACPI_HARDWARE | |
4be44fcd | 51 | ACPI_MODULE_NAME("hwregs") |
1da177e4 LT |
52 | |
53 | /******************************************************************************* | |
54 | * | |
55 | * FUNCTION: acpi_hw_clear_acpi_status | |
56 | * | |
57 | * PARAMETERS: Flags - Lock the hardware or not | |
58 | * | |
59 | * RETURN: none | |
60 | * | |
61 | * DESCRIPTION: Clears all fixed and general purpose status bits | |
62 | * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED | |
63 | * | |
4c90ece2 BM |
64 | * NOTE: TBD: Flags parameter is obsolete, to be removed |
65 | * | |
1da177e4 | 66 | ******************************************************************************/ |
4be44fcd | 67 | acpi_status acpi_hw_clear_acpi_status(u32 flags) |
1da177e4 | 68 | { |
4be44fcd | 69 | acpi_status status; |
4c90ece2 | 70 | acpi_cpu_flags lock_flags = 0; |
1da177e4 | 71 | |
b229cf92 | 72 | ACPI_FUNCTION_TRACE(hw_clear_acpi_status); |
1da177e4 | 73 | |
4be44fcd LB |
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)); | |
1da177e4 | 77 | |
4c90ece2 | 78 | lock_flags = acpi_os_acquire_lock(acpi_gbl_hardware_lock); |
1da177e4 | 79 | |
4be44fcd LB |
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)) { | |
1da177e4 LT |
84 | goto unlock_and_exit; |
85 | } | |
86 | ||
87 | /* Clear the fixed events */ | |
88 | ||
89 | if (acpi_gbl_FADT->xpm1b_evt_blk.address) { | |
4be44fcd LB |
90 | status = |
91 | acpi_hw_low_level_write(16, ACPI_BITMASK_ALL_FIXED_STATUS, | |
92 | &acpi_gbl_FADT->xpm1b_evt_blk); | |
93 | if (ACPI_FAILURE(status)) { | |
1da177e4 LT |
94 | goto unlock_and_exit; |
95 | } | |
96 | } | |
97 | ||
98 | /* Clear the GPE Bits in all GPE registers in all GPE blocks */ | |
99 | ||
4be44fcd | 100 | status = acpi_ev_walk_gpe_list(acpi_hw_clear_gpe_block); |
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_get_sleep_type_data | |
110 | * | |
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 | |
114 | * | |
115 | * RETURN: Status - ACPI status | |
116 | * | |
117 | * DESCRIPTION: Obtain the SLP_TYPa and SLP_TYPb values for the requested sleep | |
118 | * state. | |
119 | * | |
120 | ******************************************************************************/ | |
121 | ||
122 | acpi_status | |
4be44fcd | 123 | acpi_get_sleep_type_data(u8 sleep_state, u8 * sleep_type_a, u8 * sleep_type_b) |
1da177e4 | 124 | { |
4be44fcd | 125 | acpi_status status = AE_OK; |
4119532c | 126 | struct acpi_evaluate_info *info; |
1da177e4 | 127 | |
b229cf92 | 128 | ACPI_FUNCTION_TRACE(acpi_get_sleep_type_data); |
1da177e4 | 129 | |
44f6c012 RM |
130 | /* Validate parameters */ |
131 | ||
4be44fcd LB |
132 | if ((sleep_state > ACPI_S_STATES_MAX) || !sleep_type_a || !sleep_type_b) { |
133 | return_ACPI_STATUS(AE_BAD_PARAMETER); | |
1da177e4 LT |
134 | } |
135 | ||
4119532c BM |
136 | /* Allocate the evaluation information block */ |
137 | ||
138 | info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info)); | |
139 | if (!info) { | |
140 | return_ACPI_STATUS(AE_NO_MEMORY); | |
141 | } | |
44f6c012 | 142 | |
4119532c | 143 | info->pathname = |
defba1d8 | 144 | ACPI_CAST_PTR(char, acpi_gbl_sleep_state_names[sleep_state]); |
44f6c012 | 145 | |
4119532c BM |
146 | /* Evaluate the namespace object containing the values for this state */ |
147 | ||
148 | status = acpi_ns_evaluate(info); | |
4be44fcd LB |
149 | if (ACPI_FAILURE(status)) { |
150 | ACPI_DEBUG_PRINT((ACPI_DB_EXEC, | |
b229cf92 | 151 | "%s while evaluating SleepState [%s]\n", |
4be44fcd | 152 | acpi_format_exception(status), |
4119532c | 153 | info->pathname)); |
1da177e4 | 154 | |
4119532c | 155 | goto cleanup; |
1da177e4 LT |
156 | } |
157 | ||
158 | /* Must have a return object */ | |
159 | ||
4119532c | 160 | if (!info->return_object) { |
b8e4d893 | 161 | ACPI_ERROR((AE_INFO, "No Sleep State object returned from [%s]", |
4119532c | 162 | info->pathname)); |
1da177e4 LT |
163 | status = AE_NOT_EXIST; |
164 | } | |
165 | ||
166 | /* It must be of type Package */ | |
167 | ||
4119532c | 168 | else if (ACPI_GET_OBJECT_TYPE(info->return_object) != ACPI_TYPE_PACKAGE) { |
b8e4d893 BM |
169 | ACPI_ERROR((AE_INFO, |
170 | "Sleep State return object is not a Package")); | |
1da177e4 LT |
171 | status = AE_AML_OPERAND_TYPE; |
172 | } | |
173 | ||
44f6c012 | 174 | /* |
967440e3 | 175 | * The package must have at least two elements. NOTE (March 2005): This |
44f6c012 | 176 | * goes against the current ACPI spec which defines this object as a |
967440e3 | 177 | * package with one encoded DWORD element. However, existing practice |
44f6c012 RM |
178 | * by BIOS vendors seems to be to have 2 or more elements, at least |
179 | * one per sleep type (A/B). | |
180 | */ | |
4119532c | 181 | else if (info->return_object->package.count < 2) { |
b8e4d893 BM |
182 | ACPI_ERROR((AE_INFO, |
183 | "Sleep State return package does not have at least two elements")); | |
1da177e4 LT |
184 | status = AE_AML_NO_OPERAND; |
185 | } | |
186 | ||
187 | /* The first two elements must both be of type Integer */ | |
188 | ||
4119532c | 189 | else if ((ACPI_GET_OBJECT_TYPE(info->return_object->package.elements[0]) |
4be44fcd | 190 | != ACPI_TYPE_INTEGER) || |
4119532c | 191 | (ACPI_GET_OBJECT_TYPE(info->return_object->package.elements[1]) |
4be44fcd | 192 | != ACPI_TYPE_INTEGER)) { |
b8e4d893 BM |
193 | ACPI_ERROR((AE_INFO, |
194 | "Sleep State return package elements are not both Integers (%s, %s)", | |
4119532c | 195 | acpi_ut_get_object_type_name(info->return_object-> |
b8e4d893 | 196 | package.elements[0]), |
4119532c | 197 | acpi_ut_get_object_type_name(info->return_object-> |
b8e4d893 | 198 | package.elements[1]))); |
1da177e4 | 199 | status = AE_AML_OPERAND_TYPE; |
4be44fcd | 200 | } else { |
44f6c012 RM |
201 | /* Valid _Sx_ package size, type, and value */ |
202 | ||
203 | *sleep_type_a = (u8) | |
4119532c | 204 | (info->return_object->package.elements[0])->integer.value; |
44f6c012 | 205 | *sleep_type_b = (u8) |
4119532c | 206 | (info->return_object->package.elements[1])->integer.value; |
1da177e4 LT |
207 | } |
208 | ||
4be44fcd | 209 | if (ACPI_FAILURE(status)) { |
b8e4d893 | 210 | ACPI_EXCEPTION((AE_INFO, status, |
b229cf92 | 211 | "While evaluating SleepState [%s], bad Sleep object %p type %s", |
4119532c BM |
212 | info->pathname, info->return_object, |
213 | acpi_ut_get_object_type_name(info-> | |
b8e4d893 | 214 | return_object))); |
1da177e4 LT |
215 | } |
216 | ||
4119532c BM |
217 | acpi_ut_remove_reference(info->return_object); |
218 | ||
219 | cleanup: | |
220 | ACPI_FREE(info); | |
4be44fcd | 221 | return_ACPI_STATUS(status); |
1da177e4 | 222 | } |
1da177e4 | 223 | |
8313524a | 224 | ACPI_EXPORT_SYMBOL(acpi_get_sleep_type_data) |
1da177e4 LT |
225 | |
226 | /******************************************************************************* | |
227 | * | |
228 | * FUNCTION: acpi_hw_get_register_bit_mask | |
229 | * | |
230 | * PARAMETERS: register_id - Index of ACPI Register to access | |
231 | * | |
44f6c012 | 232 | * RETURN: The bitmask to be used when accessing the register |
1da177e4 | 233 | * |
44f6c012 | 234 | * DESCRIPTION: Map register_id into a register bitmask. |
1da177e4 LT |
235 | * |
236 | ******************************************************************************/ | |
4be44fcd | 237 | struct acpi_bit_register_info *acpi_hw_get_bit_register_info(u32 register_id) |
1da177e4 | 238 | { |
4a90c7e8 | 239 | ACPI_FUNCTION_ENTRY(); |
1da177e4 LT |
240 | |
241 | if (register_id > ACPI_BITREG_MAX) { | |
b229cf92 | 242 | ACPI_ERROR((AE_INFO, "Invalid BitRegister ID: %X", |
b8e4d893 | 243 | register_id)); |
1da177e4 LT |
244 | return (NULL); |
245 | } | |
246 | ||
247 | return (&acpi_gbl_bit_register_info[register_id]); | |
248 | } | |
249 | ||
1da177e4 LT |
250 | /******************************************************************************* |
251 | * | |
252 | * FUNCTION: acpi_get_register | |
253 | * | |
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 | |
257 | * | |
967440e3 | 258 | * RETURN: Status and the value read from specified Register. Value |
1da177e4 LT |
259 | * returned is normalized to bit0 (is shifted all the way right) |
260 | * | |
261 | * DESCRIPTION: ACPI bit_register read function. | |
262 | * | |
4c90ece2 BM |
263 | * NOTE: TBD: Flags parameter is obsolete, to be removed |
264 | * | |
1da177e4 LT |
265 | ******************************************************************************/ |
266 | ||
4be44fcd | 267 | acpi_status acpi_get_register(u32 register_id, u32 * return_value, u32 flags) |
1da177e4 | 268 | { |
4be44fcd LB |
269 | u32 register_value = 0; |
270 | struct acpi_bit_register_info *bit_reg_info; | |
271 | acpi_status status; | |
1da177e4 | 272 | |
b229cf92 | 273 | ACPI_FUNCTION_TRACE(acpi_get_register); |
1da177e4 LT |
274 | |
275 | /* Get the info structure corresponding to the requested ACPI Register */ | |
276 | ||
4be44fcd | 277 | bit_reg_info = acpi_hw_get_bit_register_info(register_id); |
1da177e4 | 278 | if (!bit_reg_info) { |
4be44fcd | 279 | return_ACPI_STATUS(AE_BAD_PARAMETER); |
1da177e4 LT |
280 | } |
281 | ||
1da177e4 LT |
282 | /* Read from the register */ |
283 | ||
4c90ece2 | 284 | status = acpi_hw_register_read(ACPI_MTX_LOCK, |
4be44fcd LB |
285 | bit_reg_info->parent_register, |
286 | ®ister_value); | |
1da177e4 | 287 | |
4be44fcd | 288 | if (ACPI_SUCCESS(status)) { |
52fc0b02 | 289 | |
1da177e4 LT |
290 | /* Normalize the value that was read */ |
291 | ||
4be44fcd LB |
292 | register_value = |
293 | ((register_value & bit_reg_info->access_bit_mask) | |
294 | >> bit_reg_info->bit_position); | |
1da177e4 LT |
295 | |
296 | *return_value = register_value; | |
297 | ||
4be44fcd LB |
298 | ACPI_DEBUG_PRINT((ACPI_DB_IO, "Read value %8.8X register %X\n", |
299 | register_value, | |
300 | bit_reg_info->parent_register)); | |
1da177e4 LT |
301 | } |
302 | ||
4be44fcd | 303 | return_ACPI_STATUS(status); |
1da177e4 | 304 | } |
1da177e4 | 305 | |
8313524a | 306 | ACPI_EXPORT_SYMBOL(acpi_get_register) |
1da177e4 LT |
307 | |
308 | /******************************************************************************* | |
309 | * | |
310 | * FUNCTION: acpi_set_register | |
311 | * | |
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 | |
316 | * | |
317 | * RETURN: Status | |
318 | * | |
319 | * DESCRIPTION: ACPI Bit Register write function. | |
320 | * | |
4c90ece2 BM |
321 | * NOTE: TBD: Flags parameter is obsolete, to be removed |
322 | * | |
1da177e4 | 323 | ******************************************************************************/ |
4be44fcd | 324 | acpi_status acpi_set_register(u32 register_id, u32 value, u32 flags) |
1da177e4 | 325 | { |
4be44fcd LB |
326 | u32 register_value = 0; |
327 | struct acpi_bit_register_info *bit_reg_info; | |
328 | acpi_status status; | |
4c90ece2 | 329 | acpi_cpu_flags lock_flags; |
1da177e4 | 330 | |
b229cf92 | 331 | ACPI_FUNCTION_TRACE_U32(acpi_set_register, register_id); |
1da177e4 LT |
332 | |
333 | /* Get the info structure corresponding to the requested ACPI Register */ | |
334 | ||
4be44fcd | 335 | bit_reg_info = acpi_hw_get_bit_register_info(register_id); |
1da177e4 | 336 | if (!bit_reg_info) { |
b229cf92 | 337 | ACPI_ERROR((AE_INFO, "Bad ACPI HW RegisterId: %X", |
b8e4d893 | 338 | register_id)); |
4be44fcd | 339 | return_ACPI_STATUS(AE_BAD_PARAMETER); |
1da177e4 LT |
340 | } |
341 | ||
4c90ece2 | 342 | lock_flags = acpi_os_acquire_lock(acpi_gbl_hardware_lock); |
1da177e4 LT |
343 | |
344 | /* Always do a register read first so we can insert the new bits */ | |
345 | ||
4be44fcd LB |
346 | status = acpi_hw_register_read(ACPI_MTX_DO_NOT_LOCK, |
347 | bit_reg_info->parent_register, | |
348 | ®ister_value); | |
349 | if (ACPI_FAILURE(status)) { | |
1da177e4 LT |
350 | goto unlock_and_exit; |
351 | } | |
352 | ||
353 | /* | |
354 | * Decode the Register ID | |
355 | * Register ID = [Register block ID] | [bit ID] | |
356 | * | |
357 | * Check bit ID to fine locate Register offset. | |
358 | * Check Mask to determine Register offset, and then read-write. | |
359 | */ | |
360 | switch (bit_reg_info->parent_register) { | |
361 | case ACPI_REGISTER_PM1_STATUS: | |
362 | ||
363 | /* | |
967440e3 BM |
364 | * Status Registers are different from the rest. Clear by |
365 | * writing 1, and writing 0 has no effect. So, the only relevant | |
1da177e4 LT |
366 | * information is the single bit we're interested in, all others should |
367 | * be written as 0 so they will be left unchanged. | |
368 | */ | |
4be44fcd LB |
369 | value = ACPI_REGISTER_PREPARE_BITS(value, |
370 | bit_reg_info->bit_position, | |
371 | bit_reg_info-> | |
372 | access_bit_mask); | |
1da177e4 | 373 | if (value) { |
4be44fcd LB |
374 | status = acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK, |
375 | ACPI_REGISTER_PM1_STATUS, | |
376 | (u16) value); | |
1da177e4 LT |
377 | register_value = 0; |
378 | } | |
379 | break; | |
380 | ||
1da177e4 LT |
381 | case ACPI_REGISTER_PM1_ENABLE: |
382 | ||
4be44fcd LB |
383 | ACPI_REGISTER_INSERT_VALUE(register_value, |
384 | bit_reg_info->bit_position, | |
385 | bit_reg_info->access_bit_mask, | |
386 | value); | |
1da177e4 | 387 | |
4be44fcd LB |
388 | status = acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK, |
389 | ACPI_REGISTER_PM1_ENABLE, | |
390 | (u16) register_value); | |
1da177e4 LT |
391 | break; |
392 | ||
1da177e4 LT |
393 | case ACPI_REGISTER_PM1_CONTROL: |
394 | ||
395 | /* | |
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. | |
399 | */ | |
4be44fcd LB |
400 | ACPI_DEBUG_PRINT((ACPI_DB_IO, "PM1 control: Read %X\n", |
401 | register_value)); | |
1da177e4 | 402 | |
4be44fcd LB |
403 | ACPI_REGISTER_INSERT_VALUE(register_value, |
404 | bit_reg_info->bit_position, | |
405 | bit_reg_info->access_bit_mask, | |
406 | value); | |
1da177e4 | 407 | |
4be44fcd LB |
408 | status = acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK, |
409 | ACPI_REGISTER_PM1_CONTROL, | |
410 | (u16) register_value); | |
1da177e4 LT |
411 | break; |
412 | ||
1da177e4 LT |
413 | case ACPI_REGISTER_PM2_CONTROL: |
414 | ||
4be44fcd LB |
415 | status = acpi_hw_register_read(ACPI_MTX_DO_NOT_LOCK, |
416 | ACPI_REGISTER_PM2_CONTROL, | |
417 | ®ister_value); | |
418 | if (ACPI_FAILURE(status)) { | |
1da177e4 LT |
419 | goto unlock_and_exit; |
420 | } | |
421 | ||
4be44fcd LB |
422 | ACPI_DEBUG_PRINT((ACPI_DB_IO, |
423 | "PM2 control: Read %X from %8.8X%8.8X\n", | |
424 | register_value, | |
425 | ACPI_FORMAT_UINT64(acpi_gbl_FADT-> | |
426 | xpm2_cnt_blk.address))); | |
427 | ||
428 | ACPI_REGISTER_INSERT_VALUE(register_value, | |
429 | bit_reg_info->bit_position, | |
430 | bit_reg_info->access_bit_mask, | |
431 | value); | |
432 | ||
433 | ACPI_DEBUG_PRINT((ACPI_DB_IO, | |
434 | "About to write %4.4X to %8.8X%8.8X\n", | |
435 | register_value, | |
436 | ACPI_FORMAT_UINT64(acpi_gbl_FADT-> | |
437 | xpm2_cnt_blk.address))); | |
438 | ||
439 | status = acpi_hw_register_write(ACPI_MTX_DO_NOT_LOCK, | |
440 | ACPI_REGISTER_PM2_CONTROL, | |
441 | (u8) (register_value)); | |
1da177e4 LT |
442 | break; |
443 | ||
1da177e4 LT |
444 | default: |
445 | break; | |
446 | } | |
447 | ||
4be44fcd | 448 | unlock_and_exit: |
1da177e4 | 449 | |
4c90ece2 | 450 | acpi_os_release_lock(acpi_gbl_hardware_lock, lock_flags); |
1da177e4 LT |
451 | |
452 | /* Normalize the value that was read */ | |
453 | ||
4be44fcd LB |
454 | ACPI_DEBUG_EXEC(register_value = |
455 | ((register_value & bit_reg_info->access_bit_mask) >> | |
456 | bit_reg_info->bit_position)); | |
1da177e4 | 457 | |
4be44fcd LB |
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); | |
1da177e4 | 462 | } |
1da177e4 | 463 | |
8313524a | 464 | ACPI_EXPORT_SYMBOL(acpi_set_register) |
1da177e4 LT |
465 | |
466 | /****************************************************************************** | |
467 | * | |
468 | * FUNCTION: acpi_hw_register_read | |
469 | * | |
967440e3 BM |
470 | * PARAMETERS: use_lock - Lock hardware? True/False |
471 | * register_id - ACPI Register ID | |
44f6c012 | 472 | * return_value - Where the register value is returned |
1da177e4 LT |
473 | * |
474 | * RETURN: Status and the value read. | |
475 | * | |
967440e3 | 476 | * DESCRIPTION: Read from the specified ACPI register |
1da177e4 LT |
477 | * |
478 | ******************************************************************************/ | |
1da177e4 | 479 | acpi_status |
4be44fcd | 480 | acpi_hw_register_read(u8 use_lock, u32 register_id, u32 * return_value) |
1da177e4 | 481 | { |
4be44fcd LB |
482 | u32 value1 = 0; |
483 | u32 value2 = 0; | |
484 | acpi_status status; | |
4c90ece2 | 485 | acpi_cpu_flags lock_flags = 0; |
1da177e4 | 486 | |
b229cf92 | 487 | ACPI_FUNCTION_TRACE(hw_register_read); |
1da177e4 LT |
488 | |
489 | if (ACPI_MTX_LOCK == use_lock) { | |
4c90ece2 | 490 | lock_flags = acpi_os_acquire_lock(acpi_gbl_hardware_lock); |
1da177e4 LT |
491 | } |
492 | ||
493 | switch (register_id) { | |
4be44fcd | 494 | case ACPI_REGISTER_PM1_STATUS: /* 16-bit access */ |
1da177e4 | 495 | |
4be44fcd LB |
496 | status = |
497 | acpi_hw_low_level_read(16, &value1, | |
498 | &acpi_gbl_FADT->xpm1a_evt_blk); | |
499 | if (ACPI_FAILURE(status)) { | |
1da177e4 LT |
500 | goto unlock_and_exit; |
501 | } | |
502 | ||
503 | /* PM1B is optional */ | |
504 | ||
4be44fcd LB |
505 | status = |
506 | acpi_hw_low_level_read(16, &value2, | |
507 | &acpi_gbl_FADT->xpm1b_evt_blk); | |
1da177e4 LT |
508 | value1 |= value2; |
509 | break; | |
510 | ||
4be44fcd | 511 | case ACPI_REGISTER_PM1_ENABLE: /* 16-bit access */ |
1da177e4 | 512 | |
4be44fcd LB |
513 | status = |
514 | acpi_hw_low_level_read(16, &value1, &acpi_gbl_xpm1a_enable); | |
515 | if (ACPI_FAILURE(status)) { | |
1da177e4 LT |
516 | goto unlock_and_exit; |
517 | } | |
518 | ||
519 | /* PM1B is optional */ | |
520 | ||
4be44fcd LB |
521 | status = |
522 | acpi_hw_low_level_read(16, &value2, &acpi_gbl_xpm1b_enable); | |
1da177e4 LT |
523 | value1 |= value2; |
524 | break; | |
525 | ||
4be44fcd | 526 | case ACPI_REGISTER_PM1_CONTROL: /* 16-bit access */ |
1da177e4 | 527 | |
4be44fcd LB |
528 | status = |
529 | acpi_hw_low_level_read(16, &value1, | |
530 | &acpi_gbl_FADT->xpm1a_cnt_blk); | |
531 | if (ACPI_FAILURE(status)) { | |
1da177e4 LT |
532 | goto unlock_and_exit; |
533 | } | |
534 | ||
4be44fcd LB |
535 | status = |
536 | acpi_hw_low_level_read(16, &value2, | |
537 | &acpi_gbl_FADT->xpm1b_cnt_blk); | |
1da177e4 LT |
538 | value1 |= value2; |
539 | break; | |
540 | ||
4be44fcd | 541 | case ACPI_REGISTER_PM2_CONTROL: /* 8-bit access */ |
1da177e4 | 542 | |
4be44fcd LB |
543 | status = |
544 | acpi_hw_low_level_read(8, &value1, | |
545 | &acpi_gbl_FADT->xpm2_cnt_blk); | |
1da177e4 LT |
546 | break; |
547 | ||
4be44fcd | 548 | case ACPI_REGISTER_PM_TIMER: /* 32-bit access */ |
1da177e4 | 549 | |
4be44fcd LB |
550 | status = |
551 | acpi_hw_low_level_read(32, &value1, | |
552 | &acpi_gbl_FADT->xpm_tmr_blk); | |
1da177e4 LT |
553 | break; |
554 | ||
4be44fcd | 555 | case ACPI_REGISTER_SMI_COMMAND_BLOCK: /* 8-bit access */ |
1da177e4 | 556 | |
4be44fcd | 557 | status = acpi_os_read_port(acpi_gbl_FADT->smi_cmd, &value1, 8); |
1da177e4 LT |
558 | break; |
559 | ||
560 | default: | |
b8e4d893 | 561 | ACPI_ERROR((AE_INFO, "Unknown Register ID: %X", register_id)); |
1da177e4 LT |
562 | status = AE_BAD_PARAMETER; |
563 | break; | |
564 | } | |
565 | ||
4be44fcd | 566 | unlock_and_exit: |
1da177e4 | 567 | if (ACPI_MTX_LOCK == use_lock) { |
4c90ece2 | 568 | acpi_os_release_lock(acpi_gbl_hardware_lock, lock_flags); |
1da177e4 LT |
569 | } |
570 | ||
4be44fcd | 571 | if (ACPI_SUCCESS(status)) { |
1da177e4 LT |
572 | *return_value = value1; |
573 | } | |
574 | ||
4be44fcd | 575 | return_ACPI_STATUS(status); |
1da177e4 LT |
576 | } |
577 | ||
1da177e4 LT |
578 | /****************************************************************************** |
579 | * | |
580 | * FUNCTION: acpi_hw_register_write | |
581 | * | |
967440e3 BM |
582 | * PARAMETERS: use_lock - Lock hardware? True/False |
583 | * register_id - ACPI Register ID | |
1da177e4 LT |
584 | * Value - The value to write |
585 | * | |
586 | * RETURN: Status | |
587 | * | |
967440e3 BM |
588 | * DESCRIPTION: Write to the specified ACPI register |
589 | * | |
590 | * NOTE: In accordance with the ACPI specification, this function automatically | |
591 | * preserves the value of the following bits, meaning that these bits cannot be | |
592 | * changed via this interface: | |
593 | * | |
594 | * PM1_CONTROL[0] = SCI_EN | |
595 | * PM1_CONTROL[9] | |
596 | * PM1_STATUS[11] | |
597 | * | |
598 | * ACPI References: | |
599 | * 1) Hardware Ignored Bits: When software writes to a register with ignored | |
600 | * bit fields, it preserves the ignored bit fields | |
601 | * 2) SCI_EN: OSPM always preserves this bit position | |
1da177e4 LT |
602 | * |
603 | ******************************************************************************/ | |
604 | ||
4be44fcd | 605 | acpi_status acpi_hw_register_write(u8 use_lock, u32 register_id, u32 value) |
1da177e4 | 606 | { |
4be44fcd | 607 | acpi_status status; |
4c90ece2 | 608 | acpi_cpu_flags lock_flags = 0; |
967440e3 | 609 | u32 read_value; |
1da177e4 | 610 | |
b229cf92 | 611 | ACPI_FUNCTION_TRACE(hw_register_write); |
1da177e4 LT |
612 | |
613 | if (ACPI_MTX_LOCK == use_lock) { | |
4c90ece2 | 614 | lock_flags = acpi_os_acquire_lock(acpi_gbl_hardware_lock); |
1da177e4 LT |
615 | } |
616 | ||
617 | switch (register_id) { | |
4be44fcd | 618 | case ACPI_REGISTER_PM1_STATUS: /* 16-bit access */ |
1da177e4 | 619 | |
967440e3 BM |
620 | /* Perform a read first to preserve certain bits (per ACPI spec) */ |
621 | ||
622 | status = acpi_hw_register_read(ACPI_MTX_DO_NOT_LOCK, | |
623 | ACPI_REGISTER_PM1_STATUS, | |
624 | &read_value); | |
625 | if (ACPI_FAILURE(status)) { | |
626 | goto unlock_and_exit; | |
627 | } | |
628 | ||
629 | /* Insert the bits to be preserved */ | |
630 | ||
631 | ACPI_INSERT_BITS(value, ACPI_PM1_STATUS_PRESERVED_BITS, | |
632 | read_value); | |
633 | ||
634 | /* Now we can write the data */ | |
635 | ||
4be44fcd LB |
636 | status = |
637 | acpi_hw_low_level_write(16, value, | |
638 | &acpi_gbl_FADT->xpm1a_evt_blk); | |
639 | if (ACPI_FAILURE(status)) { | |
1da177e4 LT |
640 | goto unlock_and_exit; |
641 | } | |
642 | ||
643 | /* PM1B is optional */ | |
644 | ||
4be44fcd LB |
645 | status = |
646 | acpi_hw_low_level_write(16, value, | |
647 | &acpi_gbl_FADT->xpm1b_evt_blk); | |
1da177e4 LT |
648 | break; |
649 | ||
4be44fcd | 650 | case ACPI_REGISTER_PM1_ENABLE: /* 16-bit access */ |
1da177e4 | 651 | |
4be44fcd LB |
652 | status = |
653 | acpi_hw_low_level_write(16, value, &acpi_gbl_xpm1a_enable); | |
654 | if (ACPI_FAILURE(status)) { | |
1da177e4 LT |
655 | goto unlock_and_exit; |
656 | } | |
657 | ||
658 | /* PM1B is optional */ | |
659 | ||
4be44fcd LB |
660 | status = |
661 | acpi_hw_low_level_write(16, value, &acpi_gbl_xpm1b_enable); | |
1da177e4 LT |
662 | break; |
663 | ||
4be44fcd | 664 | case ACPI_REGISTER_PM1_CONTROL: /* 16-bit access */ |
1da177e4 | 665 | |
967440e3 BM |
666 | /* |
667 | * Perform a read first to preserve certain bits (per ACPI spec) | |
668 | * | |
669 | * Note: This includes SCI_EN, we never want to change this bit | |
670 | */ | |
671 | status = acpi_hw_register_read(ACPI_MTX_DO_NOT_LOCK, | |
672 | ACPI_REGISTER_PM1_CONTROL, | |
673 | &read_value); | |
674 | if (ACPI_FAILURE(status)) { | |
675 | goto unlock_and_exit; | |
676 | } | |
677 | ||
678 | /* Insert the bits to be preserved */ | |
679 | ||
680 | ACPI_INSERT_BITS(value, ACPI_PM1_CONTROL_PRESERVED_BITS, | |
681 | read_value); | |
682 | ||
683 | /* Now we can write the data */ | |
684 | ||
4be44fcd LB |
685 | status = |
686 | acpi_hw_low_level_write(16, value, | |
687 | &acpi_gbl_FADT->xpm1a_cnt_blk); | |
688 | if (ACPI_FAILURE(status)) { | |
1da177e4 LT |
689 | goto unlock_and_exit; |
690 | } | |
691 | ||
4be44fcd LB |
692 | status = |
693 | acpi_hw_low_level_write(16, value, | |
694 | &acpi_gbl_FADT->xpm1b_cnt_blk); | |
1da177e4 LT |
695 | break; |
696 | ||
4be44fcd | 697 | case ACPI_REGISTER_PM1A_CONTROL: /* 16-bit access */ |
1da177e4 | 698 | |
4be44fcd LB |
699 | status = |
700 | acpi_hw_low_level_write(16, value, | |
701 | &acpi_gbl_FADT->xpm1a_cnt_blk); | |
1da177e4 LT |
702 | break; |
703 | ||
4be44fcd | 704 | case ACPI_REGISTER_PM1B_CONTROL: /* 16-bit access */ |
1da177e4 | 705 | |
4be44fcd LB |
706 | status = |
707 | acpi_hw_low_level_write(16, value, | |
708 | &acpi_gbl_FADT->xpm1b_cnt_blk); | |
1da177e4 LT |
709 | break; |
710 | ||
4be44fcd | 711 | case ACPI_REGISTER_PM2_CONTROL: /* 8-bit access */ |
1da177e4 | 712 | |
4be44fcd LB |
713 | status = |
714 | acpi_hw_low_level_write(8, value, | |
715 | &acpi_gbl_FADT->xpm2_cnt_blk); | |
1da177e4 LT |
716 | break; |
717 | ||
4be44fcd | 718 | case ACPI_REGISTER_PM_TIMER: /* 32-bit access */ |
1da177e4 | 719 | |
4be44fcd LB |
720 | status = |
721 | acpi_hw_low_level_write(32, value, | |
722 | &acpi_gbl_FADT->xpm_tmr_blk); | |
1da177e4 LT |
723 | break; |
724 | ||
4be44fcd | 725 | case ACPI_REGISTER_SMI_COMMAND_BLOCK: /* 8-bit access */ |
1da177e4 LT |
726 | |
727 | /* SMI_CMD is currently always in IO space */ | |
728 | ||
4be44fcd | 729 | status = acpi_os_write_port(acpi_gbl_FADT->smi_cmd, value, 8); |
1da177e4 LT |
730 | break; |
731 | ||
1da177e4 LT |
732 | default: |
733 | status = AE_BAD_PARAMETER; | |
734 | break; | |
735 | } | |
736 | ||
4be44fcd | 737 | unlock_and_exit: |
1da177e4 | 738 | if (ACPI_MTX_LOCK == use_lock) { |
4c90ece2 | 739 | acpi_os_release_lock(acpi_gbl_hardware_lock, lock_flags); |
1da177e4 LT |
740 | } |
741 | ||
4be44fcd | 742 | return_ACPI_STATUS(status); |
1da177e4 LT |
743 | } |
744 | ||
1da177e4 LT |
745 | /****************************************************************************** |
746 | * | |
747 | * FUNCTION: acpi_hw_low_level_read | |
748 | * | |
749 | * PARAMETERS: Width - 8, 16, or 32 | |
750 | * Value - Where the value is returned | |
751 | * Reg - GAS register structure | |
752 | * | |
753 | * RETURN: Status | |
754 | * | |
755 | * DESCRIPTION: Read from either memory or IO space. | |
756 | * | |
757 | ******************************************************************************/ | |
758 | ||
759 | acpi_status | |
4be44fcd | 760 | acpi_hw_low_level_read(u32 width, u32 * value, struct acpi_generic_address *reg) |
1da177e4 | 761 | { |
4be44fcd LB |
762 | u64 address; |
763 | acpi_status status; | |
1da177e4 | 764 | |
b229cf92 | 765 | ACPI_FUNCTION_NAME(hw_low_level_read); |
1da177e4 LT |
766 | |
767 | /* | |
768 | * Must have a valid pointer to a GAS structure, and | |
769 | * a non-zero address within. However, don't return an error | |
770 | * because the PM1A/B code must not fail if B isn't present. | |
771 | */ | |
772 | if (!reg) { | |
773 | return (AE_OK); | |
774 | } | |
775 | ||
967440e3 | 776 | /* Get a local copy of the address. Handles possible alignment issues */ |
1da177e4 | 777 | |
4be44fcd | 778 | ACPI_MOVE_64_TO_64(&address, ®->address); |
1da177e4 LT |
779 | if (!address) { |
780 | return (AE_OK); | |
781 | } | |
782 | *value = 0; | |
783 | ||
784 | /* | |
785 | * Two address spaces supported: Memory or IO. | |
786 | * PCI_Config is not supported here because the GAS struct is insufficient | |
787 | */ | |
788 | switch (reg->address_space_id) { | |
789 | case ACPI_ADR_SPACE_SYSTEM_MEMORY: | |
790 | ||
4be44fcd LB |
791 | status = acpi_os_read_memory((acpi_physical_address) address, |
792 | value, width); | |
1da177e4 LT |
793 | break; |
794 | ||
1da177e4 LT |
795 | case ACPI_ADR_SPACE_SYSTEM_IO: |
796 | ||
4be44fcd LB |
797 | status = acpi_os_read_port((acpi_io_address) address, |
798 | value, width); | |
1da177e4 LT |
799 | break; |
800 | ||
1da177e4 | 801 | default: |
b8e4d893 BM |
802 | ACPI_ERROR((AE_INFO, |
803 | "Unsupported address space: %X", | |
804 | reg->address_space_id)); | |
1da177e4 LT |
805 | return (AE_BAD_PARAMETER); |
806 | } | |
807 | ||
4be44fcd LB |
808 | ACPI_DEBUG_PRINT((ACPI_DB_IO, |
809 | "Read: %8.8X width %2d from %8.8X%8.8X (%s)\n", | |
810 | *value, width, | |
811 | ACPI_FORMAT_UINT64(address), | |
812 | acpi_ut_get_region_name(reg->address_space_id))); | |
1da177e4 LT |
813 | |
814 | return (status); | |
815 | } | |
816 | ||
1da177e4 LT |
817 | /****************************************************************************** |
818 | * | |
819 | * FUNCTION: acpi_hw_low_level_write | |
820 | * | |
821 | * PARAMETERS: Width - 8, 16, or 32 | |
822 | * Value - To be written | |
823 | * Reg - GAS register structure | |
824 | * | |
825 | * RETURN: Status | |
826 | * | |
827 | * DESCRIPTION: Write to either memory or IO space. | |
828 | * | |
829 | ******************************************************************************/ | |
830 | ||
831 | acpi_status | |
4be44fcd | 832 | acpi_hw_low_level_write(u32 width, u32 value, struct acpi_generic_address * reg) |
1da177e4 | 833 | { |
4be44fcd LB |
834 | u64 address; |
835 | acpi_status status; | |
1da177e4 | 836 | |
b229cf92 | 837 | ACPI_FUNCTION_NAME(hw_low_level_write); |
1da177e4 LT |
838 | |
839 | /* | |
840 | * Must have a valid pointer to a GAS structure, and | |
841 | * a non-zero address within. However, don't return an error | |
842 | * because the PM1A/B code must not fail if B isn't present. | |
843 | */ | |
844 | if (!reg) { | |
845 | return (AE_OK); | |
846 | } | |
847 | ||
967440e3 | 848 | /* Get a local copy of the address. Handles possible alignment issues */ |
1da177e4 | 849 | |
4be44fcd | 850 | ACPI_MOVE_64_TO_64(&address, ®->address); |
1da177e4 LT |
851 | if (!address) { |
852 | return (AE_OK); | |
853 | } | |
854 | ||
855 | /* | |
856 | * Two address spaces supported: Memory or IO. | |
857 | * PCI_Config is not supported here because the GAS struct is insufficient | |
858 | */ | |
859 | switch (reg->address_space_id) { | |
860 | case ACPI_ADR_SPACE_SYSTEM_MEMORY: | |
861 | ||
4be44fcd LB |
862 | status = acpi_os_write_memory((acpi_physical_address) address, |
863 | value, width); | |
1da177e4 LT |
864 | break; |
865 | ||
1da177e4 LT |
866 | case ACPI_ADR_SPACE_SYSTEM_IO: |
867 | ||
4be44fcd LB |
868 | status = acpi_os_write_port((acpi_io_address) address, |
869 | value, width); | |
1da177e4 LT |
870 | break; |
871 | ||
1da177e4 | 872 | default: |
b8e4d893 BM |
873 | ACPI_ERROR((AE_INFO, |
874 | "Unsupported address space: %X", | |
875 | reg->address_space_id)); | |
1da177e4 LT |
876 | return (AE_BAD_PARAMETER); |
877 | } | |
878 | ||
4be44fcd LB |
879 | ACPI_DEBUG_PRINT((ACPI_DB_IO, |
880 | "Wrote: %8.8X width %2d to %8.8X%8.8X (%s)\n", | |
881 | value, width, | |
882 | ACPI_FORMAT_UINT64(address), | |
883 | acpi_ut_get_region_name(reg->address_space_id))); | |
1da177e4 LT |
884 | |
885 | return (status); | |
886 | } |