blob: de74a4c25085b63b1b0fa8d0d29e8ac1a0b93521 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*******************************************************************************
2 *
3 * Module Name: hwregs - Read/write access functions for the various ACPI
4 * control and status registers.
5 *
6 ******************************************************************************/
7
8/*
Bob Moore7735ca02017-02-08 11:00:08 +08009 * Copyright (C) 2000 - 2017, Intel Corp.
Linus Torvalds1da177e2005-04-16 15:20:36 -070010 * All rights reserved.
11 *
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.
26 *
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.
30 *
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.
43 */
44
Linus Torvalds1da177e2005-04-16 15:20:36 -070045#include <acpi/acpi.h>
Len Browne2f7a772009-01-09 00:30:03 -050046#include "accommon.h"
Len Browne2f7a772009-01-09 00:30:03 -050047#include "acevents.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070048
49#define _COMPONENT ACPI_HARDWARE
Len Brown4be44fc2005-08-05 00:44:28 -040050ACPI_MODULE_NAME("hwregs")
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
Bob Moore33620c52012-02-14 18:14:27 +080052#if (!ACPI_REDUCED_HARDWARE)
Bob Moorec520aba2009-02-18 14:20:12 +080053/* Local Prototypes */
Lv Zhengb314a172016-05-05 12:58:39 +080054static u8
Lv Zheng04cf0532016-12-28 15:28:36 +080055acpi_hw_get_access_bit_width(u64 address,
56 struct acpi_generic_address *reg,
Lv Zhengb314a172016-05-05 12:58:39 +080057 u8 max_bit_width);
58
Bob Moorec520aba2009-02-18 14:20:12 +080059static acpi_status
60acpi_hw_read_multiple(u32 *value,
61 struct acpi_generic_address *register_a,
62 struct acpi_generic_address *register_b);
63
64static acpi_status
65acpi_hw_write_multiple(u32 value,
66 struct acpi_generic_address *register_a,
67 struct acpi_generic_address *register_b);
68
Bob Moore33620c52012-02-14 18:14:27 +080069#endif /* !ACPI_REDUCED_HARDWARE */
70
Bob Moorec6b57742009-06-24 09:44:06 +080071/******************************************************************************
72 *
Lv Zhengb314a172016-05-05 12:58:39 +080073 * FUNCTION: acpi_hw_get_access_bit_width
74 *
Lv Zheng04cf0532016-12-28 15:28:36 +080075 * PARAMETERS: address - GAS register address
76 * reg - GAS register structure
Lv Zhengb314a172016-05-05 12:58:39 +080077 * max_bit_width - Max bit_width supported (32 or 64)
78 *
79 * RETURN: Status
80 *
81 * DESCRIPTION: Obtain optimal access bit width
82 *
83 ******************************************************************************/
84
85static u8
Lv Zheng04cf0532016-12-28 15:28:36 +080086acpi_hw_get_access_bit_width(u64 address,
87 struct acpi_generic_address *reg, u8 max_bit_width)
Lv Zhengb314a172016-05-05 12:58:39 +080088{
Lv Zheng04cf0532016-12-28 15:28:36 +080089 u8 access_bit_width;
Lv Zheng7f9bef92016-06-01 11:03:20 +080090
Lv Zheng04cf0532016-12-28 15:28:36 +080091 /*
92 * GAS format "register", used by FADT:
93 * 1. Detected if bit_offset is 0 and bit_width is 8/16/32/64;
94 * 2. access_size field is ignored and bit_width field is used for
95 * determining the boundary of the IO accesses.
96 * GAS format "region", used by APEI registers:
97 * 1. Detected if bit_offset is not 0 or bit_width is not 8/16/32/64;
98 * 2. access_size field is used for determining the boundary of the
99 * IO accesses;
100 * 3. bit_offset/bit_width fields are used to describe the "region".
101 *
102 * Note: This algorithm assumes that the "Address" fields should always
103 * contain aligned values.
104 */
105 if (!reg->bit_offset && reg->bit_width &&
106 ACPI_IS_POWER_OF_TWO(reg->bit_width) &&
107 ACPI_IS_ALIGNED(reg->bit_width, 8)) {
108 access_bit_width = reg->bit_width;
109 } else if (reg->access_width) {
110 access_bit_width = (1 << (reg->access_width + 2));
Lv Zhengb314a172016-05-05 12:58:39 +0800111 } else {
Lv Zheng04cf0532016-12-28 15:28:36 +0800112 access_bit_width =
113 ACPI_ROUND_UP_POWER_OF_TWO_8(reg->bit_offset +
114 reg->bit_width);
115 if (access_bit_width <= 8) {
116 access_bit_width = 8;
117 } else {
118 while (!ACPI_IS_ALIGNED(address, access_bit_width >> 3)) {
119 access_bit_width >>= 1;
120 }
121 }
Lv Zhengb314a172016-05-05 12:58:39 +0800122 }
Lv Zheng04cf0532016-12-28 15:28:36 +0800123
124 /* Maximum IO port access bit width is 32 */
125
126 if (reg->space_id == ACPI_ADR_SPACE_SYSTEM_IO) {
127 max_bit_width = 32;
128 }
129
130 /*
131 * Return access width according to the requested maximum access bit width,
132 * as the caller should know the format of the register and may enforce
133 * a 32-bit accesses.
134 */
135 if (access_bit_width < max_bit_width) {
136 return (access_bit_width);
137 }
138 return (max_bit_width);
Lv Zhengb314a172016-05-05 12:58:39 +0800139}
140
141/******************************************************************************
142 *
Bob Moorec6b57742009-06-24 09:44:06 +0800143 * FUNCTION: acpi_hw_validate_register
144 *
Bob Mooreba494be2012-07-12 09:40:10 +0800145 * PARAMETERS: reg - GAS register structure
Bob Moorec6b57742009-06-24 09:44:06 +0800146 * max_bit_width - Max bit_width supported (32 or 64)
Bob Mooreba494be2012-07-12 09:40:10 +0800147 * address - Pointer to where the gas->address
Bob Moorec6b57742009-06-24 09:44:06 +0800148 * is returned
149 *
150 * RETURN: Status
151 *
152 * DESCRIPTION: Validate the contents of a GAS register. Checks the GAS
153 * pointer, Address, space_id, bit_width, and bit_offset.
154 *
155 ******************************************************************************/
156
157acpi_status
158acpi_hw_validate_register(struct acpi_generic_address *reg,
159 u8 max_bit_width, u64 *address)
160{
Lv Zheng920de6e2016-03-24 09:41:09 +0800161 u8 bit_width;
162 u8 access_width;
Bob Moorec6b57742009-06-24 09:44:06 +0800163
164 /* Must have a valid pointer to a GAS structure */
165
166 if (!reg) {
167 return (AE_BAD_PARAMETER);
168 }
169
170 /*
171 * Copy the target address. This handles possible alignment issues.
172 * Address must not be null. A null address also indicates an optional
173 * ACPI register that is not supported, so no error message.
174 */
175 ACPI_MOVE_64_TO_64(address, &reg->address);
176 if (!(*address)) {
177 return (AE_BAD_ADDRESS);
178 }
179
Bob Mooreba494be2012-07-12 09:40:10 +0800180 /* Validate the space_ID */
Bob Moorec6b57742009-06-24 09:44:06 +0800181
182 if ((reg->space_id != ACPI_ADR_SPACE_SYSTEM_MEMORY) &&
183 (reg->space_id != ACPI_ADR_SPACE_SYSTEM_IO)) {
184 ACPI_ERROR((AE_INFO,
185 "Unsupported address space: 0x%X", reg->space_id));
186 return (AE_SUPPORT);
187 }
188
Lv Zheng920de6e2016-03-24 09:41:09 +0800189 /* Validate the access_width */
Bob Moorec6b57742009-06-24 09:44:06 +0800190
Lv Zheng920de6e2016-03-24 09:41:09 +0800191 if (reg->access_width > 4) {
Bob Moorec6b57742009-06-24 09:44:06 +0800192 ACPI_ERROR((AE_INFO,
Lv Zheng920de6e2016-03-24 09:41:09 +0800193 "Unsupported register access width: 0x%X",
194 reg->access_width));
Bob Moorec6b57742009-06-24 09:44:06 +0800195 return (AE_SUPPORT);
196 }
197
Lv Zheng920de6e2016-03-24 09:41:09 +0800198 /* Validate the bit_width, convert access_width into number of bits */
Bob Moorec6b57742009-06-24 09:44:06 +0800199
Lv Zheng04cf0532016-12-28 15:28:36 +0800200 access_width =
201 acpi_hw_get_access_bit_width(*address, reg, max_bit_width);
Lv Zheng920de6e2016-03-24 09:41:09 +0800202 bit_width =
203 ACPI_ROUND_UP(reg->bit_offset + reg->bit_width, access_width);
204 if (max_bit_width < bit_width) {
Bob Moorec6b57742009-06-24 09:44:06 +0800205 ACPI_WARNING((AE_INFO,
Lv Zheng920de6e2016-03-24 09:41:09 +0800206 "Requested bit width 0x%X is smaller than register bit width 0x%X",
207 max_bit_width, bit_width));
208 return (AE_SUPPORT);
Bob Moorec6b57742009-06-24 09:44:06 +0800209 }
210
211 return (AE_OK);
212}
213
214/******************************************************************************
215 *
216 * FUNCTION: acpi_hw_read
217 *
Bob Mooreba494be2012-07-12 09:40:10 +0800218 * PARAMETERS: value - Where the value is returned
219 * reg - GAS register structure
Bob Moorec6b57742009-06-24 09:44:06 +0800220 *
221 * RETURN: Status
222 *
223 * DESCRIPTION: Read from either memory or IO space. This is a 32-bit max
224 * version of acpi_read, used internally since the overhead of
225 * 64-bit values is not needed.
226 *
227 * LIMITATIONS: <These limitations also apply to acpi_hw_write>
Bob Mooreba494be2012-07-12 09:40:10 +0800228 * space_ID must be system_memory or system_IO.
Bob Moorec6b57742009-06-24 09:44:06 +0800229 *
230 ******************************************************************************/
231
232acpi_status acpi_hw_read(u32 *value, struct acpi_generic_address *reg)
233{
234 u64 address;
Lv Zhengc3bc26d2016-05-05 12:58:52 +0800235 u8 access_width;
236 u32 bit_width;
237 u8 bit_offset;
Bob Moore653f4b52012-02-14 18:29:55 +0800238 u64 value64;
Lv Zhengc3bc26d2016-05-05 12:58:52 +0800239 u32 value32;
240 u8 index;
Bob Moorec6b57742009-06-24 09:44:06 +0800241 acpi_status status;
242
243 ACPI_FUNCTION_NAME(hw_read);
244
245 /* Validate contents of the GAS register */
246
247 status = acpi_hw_validate_register(reg, 32, &address);
248 if (ACPI_FAILURE(status)) {
249 return (status);
250 }
251
Lv Zhengc3bc26d2016-05-05 12:58:52 +0800252 /*
253 * Initialize entire 32-bit return value to zero, convert access_width
254 * into number of bits based
255 */
Bob Moorec6b57742009-06-24 09:44:06 +0800256 *value = 0;
Lv Zheng04cf0532016-12-28 15:28:36 +0800257 access_width = acpi_hw_get_access_bit_width(address, reg, 32);
Lv Zhengc3bc26d2016-05-05 12:58:52 +0800258 bit_width = reg->bit_offset + reg->bit_width;
259 bit_offset = reg->bit_offset;
Bob Moorec6b57742009-06-24 09:44:06 +0800260
261 /*
262 * Two address spaces supported: Memory or IO. PCI_Config is
263 * not supported here because the GAS structure is insufficient
264 */
Lv Zhengc3bc26d2016-05-05 12:58:52 +0800265 index = 0;
266 while (bit_width) {
267 if (bit_offset >= access_width) {
268 value32 = 0;
269 bit_offset -= access_width;
270 } else {
271 if (reg->space_id == ACPI_ADR_SPACE_SYSTEM_MEMORY) {
272 status =
273 acpi_os_read_memory((acpi_physical_address)
274 address +
275 index *
276 ACPI_DIV_8
277 (access_width),
278 &value64, access_width);
279 value32 = (u32)value64;
280 } else { /* ACPI_ADR_SPACE_SYSTEM_IO, validated earlier */
Bob Moore653f4b52012-02-14 18:29:55 +0800281
Lv Zhengc3bc26d2016-05-05 12:58:52 +0800282 status = acpi_hw_read_port((acpi_io_address)
283 address +
284 index *
285 ACPI_DIV_8
286 (access_width),
287 &value32,
288 access_width);
289 }
Lv Zhengc3bc26d2016-05-05 12:58:52 +0800290 }
291
292 /*
293 * Use offset style bit writes because "Index * AccessWidth" is
294 * ensured to be less than 32-bits by acpi_hw_validate_register().
295 */
296 ACPI_SET_BITS(value, index * access_width,
297 ACPI_MASK_BITS_ABOVE_32(access_width), value32);
298
299 bit_width -=
300 bit_width > access_width ? access_width : bit_width;
301 index++;
Bob Moorec6b57742009-06-24 09:44:06 +0800302 }
303
304 ACPI_DEBUG_PRINT((ACPI_DB_IO,
305 "Read: %8.8X width %2d from %8.8X%8.8X (%s)\n",
Lv Zhengc3bc26d2016-05-05 12:58:52 +0800306 *value, access_width, ACPI_FORMAT_UINT64(address),
Bob Moorec6b57742009-06-24 09:44:06 +0800307 acpi_ut_get_region_name(reg->space_id)));
308
309 return (status);
310}
311
312/******************************************************************************
313 *
314 * FUNCTION: acpi_hw_write
315 *
Bob Mooreba494be2012-07-12 09:40:10 +0800316 * PARAMETERS: value - Value to be written
317 * reg - GAS register structure
Bob Moorec6b57742009-06-24 09:44:06 +0800318 *
319 * RETURN: Status
320 *
321 * DESCRIPTION: Write to either memory or IO space. This is a 32-bit max
322 * version of acpi_write, used internally since the overhead of
323 * 64-bit values is not needed.
324 *
325 ******************************************************************************/
326
327acpi_status acpi_hw_write(u32 value, struct acpi_generic_address *reg)
328{
329 u64 address;
Lv Zhengdc4c7372016-12-28 15:28:23 +0800330 u8 access_width;
331 u32 bit_width;
332 u8 bit_offset;
333 u64 value64;
334 u32 value32;
335 u8 index;
Bob Moorec6b57742009-06-24 09:44:06 +0800336 acpi_status status;
337
338 ACPI_FUNCTION_NAME(hw_write);
339
340 /* Validate contents of the GAS register */
341
342 status = acpi_hw_validate_register(reg, 32, &address);
343 if (ACPI_FAILURE(status)) {
344 return (status);
345 }
346
Lv Zhengdc4c7372016-12-28 15:28:23 +0800347 /* Convert access_width into number of bits based */
348
Lv Zheng04cf0532016-12-28 15:28:36 +0800349 access_width = acpi_hw_get_access_bit_width(address, reg, 32);
Lv Zhengdc4c7372016-12-28 15:28:23 +0800350 bit_width = reg->bit_offset + reg->bit_width;
351 bit_offset = reg->bit_offset;
352
Bob Moorec6b57742009-06-24 09:44:06 +0800353 /*
354 * Two address spaces supported: Memory or IO. PCI_Config is
355 * not supported here because the GAS structure is insufficient
356 */
Lv Zhengdc4c7372016-12-28 15:28:23 +0800357 index = 0;
358 while (bit_width) {
359 /*
360 * Use offset style bit reads because "Index * AccessWidth" is
361 * ensured to be less than 32-bits by acpi_hw_validate_register().
362 */
363 value32 = ACPI_GET_BITS(&value, index * access_width,
364 ACPI_MASK_BITS_ABOVE_32(access_width));
Bob Moorec6b57742009-06-24 09:44:06 +0800365
Lv Zhengdc4c7372016-12-28 15:28:23 +0800366 if (bit_offset >= access_width) {
367 bit_offset -= access_width;
368 } else {
369 if (reg->space_id == ACPI_ADR_SPACE_SYSTEM_MEMORY) {
370 value64 = (u64)value32;
371 status =
372 acpi_os_write_memory((acpi_physical_address)
373 address +
374 index *
375 ACPI_DIV_8
376 (access_width),
377 value64, access_width);
378 } else { /* ACPI_ADR_SPACE_SYSTEM_IO, validated earlier */
379
380 status = acpi_hw_write_port((acpi_io_address)
381 address +
382 index *
383 ACPI_DIV_8
384 (access_width),
385 value32,
386 access_width);
387 }
388 }
389
390 /*
391 * Index * access_width is ensured to be less than 32-bits by
392 * acpi_hw_validate_register().
393 */
394 bit_width -=
395 bit_width > access_width ? access_width : bit_width;
396 index++;
Bob Moorec6b57742009-06-24 09:44:06 +0800397 }
398
399 ACPI_DEBUG_PRINT((ACPI_DB_IO,
400 "Wrote: %8.8X width %2d to %8.8X%8.8X (%s)\n",
Lv Zhengdc4c7372016-12-28 15:28:23 +0800401 value, access_width, ACPI_FORMAT_UINT64(address),
Bob Moorec6b57742009-06-24 09:44:06 +0800402 acpi_ut_get_region_name(reg->space_id)));
403
404 return (status);
405}
406
Bob Moore33620c52012-02-14 18:14:27 +0800407#if (!ACPI_REDUCED_HARDWARE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408/*******************************************************************************
409 *
410 * FUNCTION: acpi_hw_clear_acpi_status
411 *
Bob Moored8c71b62007-02-02 19:48:21 +0300412 * PARAMETERS: None
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413 *
Bob Moore7db5d822008-12-30 11:04:48 +0800414 * RETURN: Status
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 *
416 * DESCRIPTION: Clears all fixed and general purpose status bits
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417 *
418 ******************************************************************************/
Bob Moorec520aba2009-02-18 14:20:12 +0800419
Bob Moored8c71b62007-02-02 19:48:21 +0300420acpi_status acpi_hw_clear_acpi_status(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421{
Len Brown4be44fc2005-08-05 00:44:28 -0400422 acpi_status status;
Bob Moore4c90ece2006-06-08 16:29:00 -0400423 acpi_cpu_flags lock_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424
Bob Mooreb229cf92006-04-21 17:15:00 -0400425 ACPI_FUNCTION_TRACE(hw_clear_acpi_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426
Bob Moore8eb7b242009-04-22 10:28:22 +0800427 ACPI_DEBUG_PRINT((ACPI_DB_IO, "About to write %04X to %8.8X%8.8X\n",
Len Brown4be44fc2005-08-05 00:44:28 -0400428 ACPI_BITMASK_ALL_FIXED_STATUS,
Bob Moore8eb7b242009-04-22 10:28:22 +0800429 ACPI_FORMAT_UINT64(acpi_gbl_xpm1a_status.address)));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430
Bob Moore4c90ece2006-06-08 16:29:00 -0400431 lock_flags = acpi_os_acquire_lock(acpi_gbl_hardware_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432
Bob Moore227243a2009-02-18 14:24:50 +0800433 /* Clear the fixed events in PM1 A/B */
Bob Moore531c6332009-02-18 14:06:12 +0800434
Alexey Starikovskiyd30dc9ab2007-09-30 22:39:36 +0400435 status = acpi_hw_register_write(ACPI_REGISTER_PM1_STATUS,
Len Brown4be44fc2005-08-05 00:44:28 -0400436 ACPI_BITMASK_ALL_FIXED_STATUS);
Rakib Mullickf7f71cf2011-11-06 21:18:17 +0600437
438 acpi_os_release_lock(acpi_gbl_hardware_lock, lock_flags);
439
Lv Zheng7d3e83b2014-07-08 10:08:19 +0800440 if (ACPI_FAILURE(status)) {
Rakib Mullickf7f71cf2011-11-06 21:18:17 +0600441 goto exit;
Lv Zheng7d3e83b2014-07-08 10:08:19 +0800442 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 /* Clear the GPE Bits in all GPE registers in all GPE blocks */
445
Bob Mooree97d6bf2008-12-30 09:45:17 +0800446 status = acpi_ev_walk_gpe_list(acpi_hw_clear_gpe_block, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447
Rakib Mullickf7f71cf2011-11-06 21:18:17 +0600448exit:
Len Brown4be44fc2005-08-05 00:44:28 -0400449 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450}
451
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452/*******************************************************************************
453 *
Bob Moore33620c52012-02-14 18:14:27 +0800454 * FUNCTION: acpi_hw_get_bit_register_info
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 *
456 * PARAMETERS: register_id - Index of ACPI Register to access
457 *
Robert Moore44f6c012005-04-18 22:49:35 -0400458 * RETURN: The bitmask to be used when accessing the register
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459 *
Robert Moore44f6c012005-04-18 22:49:35 -0400460 * DESCRIPTION: Map register_id into a register bitmask.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 *
462 ******************************************************************************/
Bob Moore7db5d822008-12-30 11:04:48 +0800463
Len Brown4be44fc2005-08-05 00:44:28 -0400464struct acpi_bit_register_info *acpi_hw_get_bit_register_info(u32 register_id)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465{
Bob Moore4a90c7e2006-01-13 16:22:00 -0500466 ACPI_FUNCTION_ENTRY();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467
468 if (register_id > ACPI_BITREG_MAX) {
Bob Mooref6a22b02010-03-05 17:56:40 +0800469 ACPI_ERROR((AE_INFO, "Invalid BitRegister ID: 0x%X",
Bob Mooreb8e4d892006-01-27 16:43:00 -0500470 register_id));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 return (NULL);
472 }
473
474 return (&acpi_gbl_bit_register_info[register_id]);
475}
476
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477/******************************************************************************
478 *
Bob Moore32c9ef92009-02-18 14:36:05 +0800479 * FUNCTION: acpi_hw_write_pm1_control
480 *
481 * PARAMETERS: pm1a_control - Value to be written to PM1A control
482 * pm1b_control - Value to be written to PM1B control
483 *
484 * RETURN: Status
485 *
486 * DESCRIPTION: Write the PM1 A/B control registers. These registers are
487 * different than than the PM1 A/B status and enable registers
488 * in that different values can be written to the A/B registers.
489 * Most notably, the SLP_TYP bits can be different, as per the
490 * values returned from the _Sx predefined methods.
491 *
492 ******************************************************************************/
493
494acpi_status acpi_hw_write_pm1_control(u32 pm1a_control, u32 pm1b_control)
495{
496 acpi_status status;
497
498 ACPI_FUNCTION_TRACE(hw_write_pm1_control);
499
Bob Moorec6b57742009-06-24 09:44:06 +0800500 status =
501 acpi_hw_write(pm1a_control, &acpi_gbl_FADT.xpm1a_control_block);
Bob Moore32c9ef92009-02-18 14:36:05 +0800502 if (ACPI_FAILURE(status)) {
503 return_ACPI_STATUS(status);
504 }
505
506 if (acpi_gbl_FADT.xpm1b_control_block.address) {
507 status =
Bob Moorec6b57742009-06-24 09:44:06 +0800508 acpi_hw_write(pm1b_control,
509 &acpi_gbl_FADT.xpm1b_control_block);
Bob Moore32c9ef92009-02-18 14:36:05 +0800510 }
511 return_ACPI_STATUS(status);
512}
513
514/******************************************************************************
515 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 * FUNCTION: acpi_hw_register_read
517 *
Alexey Starikovskiyd30dc9ab2007-09-30 22:39:36 +0400518 * PARAMETERS: register_id - ACPI Register ID
Robert Moore44f6c012005-04-18 22:49:35 -0400519 * return_value - Where the register value is returned
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520 *
521 * RETURN: Status and the value read.
522 *
Bob Moore967440e32006-06-23 17:04:00 -0400523 * DESCRIPTION: Read from the specified ACPI register
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 *
525 ******************************************************************************/
Lv Zheng3e8214e2012-12-19 05:37:15 +0000526acpi_status acpi_hw_register_read(u32 register_id, u32 *return_value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527{
Bob Moorec520aba2009-02-18 14:20:12 +0800528 u32 value = 0;
Len Brown4be44fc2005-08-05 00:44:28 -0400529 acpi_status status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530
Bob Mooreb229cf92006-04-21 17:15:00 -0400531 ACPI_FUNCTION_TRACE(hw_register_read);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533 switch (register_id) {
Bob Moorec520aba2009-02-18 14:20:12 +0800534 case ACPI_REGISTER_PM1_STATUS: /* PM1 A/B: 16-bit access each */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535
Bob Moorec520aba2009-02-18 14:20:12 +0800536 status = acpi_hw_read_multiple(&value,
537 &acpi_gbl_xpm1a_status,
538 &acpi_gbl_xpm1b_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539 break;
540
Bob Moorec520aba2009-02-18 14:20:12 +0800541 case ACPI_REGISTER_PM1_ENABLE: /* PM1 A/B: 16-bit access each */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542
Bob Moorec520aba2009-02-18 14:20:12 +0800543 status = acpi_hw_read_multiple(&value,
544 &acpi_gbl_xpm1a_enable,
545 &acpi_gbl_xpm1b_enable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546 break;
547
Bob Moorec520aba2009-02-18 14:20:12 +0800548 case ACPI_REGISTER_PM1_CONTROL: /* PM1 A/B: 16-bit access each */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549
Bob Moorec520aba2009-02-18 14:20:12 +0800550 status = acpi_hw_read_multiple(&value,
551 &acpi_gbl_FADT.
552 xpm1a_control_block,
553 &acpi_gbl_FADT.
554 xpm1b_control_block);
Lin Mingc3dd25f2009-03-19 09:51:01 +0800555
556 /*
557 * Zero the write-only bits. From the ACPI specification, "Hardware
558 * Write-Only Bits": "Upon reads to registers with write-only bits,
559 * software masks out all write-only bits."
560 */
561 value &= ~ACPI_PM1_CONTROL_WRITEONLY_BITS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 break;
563
Len Brown4be44fc2005-08-05 00:44:28 -0400564 case ACPI_REGISTER_PM2_CONTROL: /* 8-bit access */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565
Bob Moorec6b57742009-06-24 09:44:06 +0800566 status =
567 acpi_hw_read(&value, &acpi_gbl_FADT.xpm2_control_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 break;
569
Len Brown4be44fc2005-08-05 00:44:28 -0400570 case ACPI_REGISTER_PM_TIMER: /* 32-bit access */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571
Bob Moorec6b57742009-06-24 09:44:06 +0800572 status = acpi_hw_read(&value, &acpi_gbl_FADT.xpm_timer_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573 break;
574
Len Brown4be44fc2005-08-05 00:44:28 -0400575 case ACPI_REGISTER_SMI_COMMAND_BLOCK: /* 8-bit access */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576
Bob Mooref3d2e782007-02-02 19:48:18 +0300577 status =
Bob Moore7f071902009-03-19 09:37:47 +0800578 acpi_hw_read_port(acpi_gbl_FADT.smi_command, &value, 8);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 break;
580
581 default:
Chao Guan1d1ea1b2013-06-08 00:58:14 +0000582
Bob Mooref6a22b02010-03-05 17:56:40 +0800583 ACPI_ERROR((AE_INFO, "Unknown Register ID: 0x%X", register_id));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 status = AE_BAD_PARAMETER;
585 break;
586 }
587
Len Brown4be44fc2005-08-05 00:44:28 -0400588 if (ACPI_SUCCESS(status)) {
Bob Moorec520aba2009-02-18 14:20:12 +0800589 *return_value = value;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 }
591
Len Brown4be44fc2005-08-05 00:44:28 -0400592 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593}
594
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595/******************************************************************************
596 *
597 * FUNCTION: acpi_hw_register_write
598 *
Alexey Starikovskiyd30dc9ab2007-09-30 22:39:36 +0400599 * PARAMETERS: register_id - ACPI Register ID
Bob Mooreba494be2012-07-12 09:40:10 +0800600 * value - The value to write
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601 *
602 * RETURN: Status
603 *
Bob Moore967440e32006-06-23 17:04:00 -0400604 * DESCRIPTION: Write to the specified ACPI register
605 *
606 * NOTE: In accordance with the ACPI specification, this function automatically
607 * preserves the value of the following bits, meaning that these bits cannot be
608 * changed via this interface:
609 *
610 * PM1_CONTROL[0] = SCI_EN
611 * PM1_CONTROL[9]
612 * PM1_STATUS[11]
613 *
614 * ACPI References:
615 * 1) Hardware Ignored Bits: When software writes to a register with ignored
616 * bit fields, it preserves the ignored bit fields
617 * 2) SCI_EN: OSPM always preserves this bit position
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618 *
619 ******************************************************************************/
620
Alexey Starikovskiyd30dc9ab2007-09-30 22:39:36 +0400621acpi_status acpi_hw_register_write(u32 register_id, u32 value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622{
Len Brown4be44fc2005-08-05 00:44:28 -0400623 acpi_status status;
Bob Moore967440e32006-06-23 17:04:00 -0400624 u32 read_value;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625
Bob Mooreb229cf92006-04-21 17:15:00 -0400626 ACPI_FUNCTION_TRACE(hw_register_write);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 switch (register_id) {
Bob Moorec520aba2009-02-18 14:20:12 +0800629 case ACPI_REGISTER_PM1_STATUS: /* PM1 A/B: 16-bit access each */
Bob Moore8636f8d2009-03-09 16:32:20 +0800630 /*
631 * Handle the "ignored" bit in PM1 Status. According to the ACPI
632 * specification, ignored bits are to be preserved when writing.
633 * Normally, this would mean a read/modify/write sequence. However,
634 * preserving a bit in the status register is different. Writing a
635 * one clears the status, and writing a zero preserves the status.
636 * Therefore, we must always write zero to the ignored bit.
637 *
638 * This behavior is clarified in the ACPI 4.0 specification.
639 */
640 value &= ~ACPI_PM1_STATUS_PRESERVED_BITS;
Bob Moore967440e32006-06-23 17:04:00 -0400641
Bob Moorec520aba2009-02-18 14:20:12 +0800642 status = acpi_hw_write_multiple(value,
643 &acpi_gbl_xpm1a_status,
644 &acpi_gbl_xpm1b_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645 break;
646
Lv Zheng75c80442012-12-19 05:36:49 +0000647 case ACPI_REGISTER_PM1_ENABLE: /* PM1 A/B: 16-bit access each */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648
Bob Moorec520aba2009-02-18 14:20:12 +0800649 status = acpi_hw_write_multiple(value,
650 &acpi_gbl_xpm1a_enable,
651 &acpi_gbl_xpm1b_enable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652 break;
653
Bob Moorec520aba2009-02-18 14:20:12 +0800654 case ACPI_REGISTER_PM1_CONTROL: /* PM1 A/B: 16-bit access each */
Bob Moore967440e32006-06-23 17:04:00 -0400655 /*
656 * Perform a read first to preserve certain bits (per ACPI spec)
Bob Moorec520aba2009-02-18 14:20:12 +0800657 * Note: This includes SCI_EN, we never want to change this bit
Bob Moore967440e32006-06-23 17:04:00 -0400658 */
Bob Moorec520aba2009-02-18 14:20:12 +0800659 status = acpi_hw_read_multiple(&read_value,
660 &acpi_gbl_FADT.
661 xpm1a_control_block,
662 &acpi_gbl_FADT.
663 xpm1b_control_block);
Bob Moore967440e32006-06-23 17:04:00 -0400664 if (ACPI_FAILURE(status)) {
Alexey Starikovskiyd30dc9ab2007-09-30 22:39:36 +0400665 goto exit;
Bob Moore967440e32006-06-23 17:04:00 -0400666 }
667
668 /* Insert the bits to be preserved */
669
670 ACPI_INSERT_BITS(value, ACPI_PM1_CONTROL_PRESERVED_BITS,
671 read_value);
672
673 /* Now we can write the data */
674
Bob Moorec520aba2009-02-18 14:20:12 +0800675 status = acpi_hw_write_multiple(value,
676 &acpi_gbl_FADT.
677 xpm1a_control_block,
678 &acpi_gbl_FADT.
679 xpm1b_control_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680 break;
681
Len Brown4be44fc2005-08-05 00:44:28 -0400682 case ACPI_REGISTER_PM2_CONTROL: /* 8-bit access */
Bob Moore20869dc2009-03-13 09:10:46 +0800683 /*
684 * For control registers, all reserved bits must be preserved,
685 * as per the ACPI spec.
686 */
687 status =
Bob Moorec6b57742009-06-24 09:44:06 +0800688 acpi_hw_read(&read_value,
689 &acpi_gbl_FADT.xpm2_control_block);
Bob Moore20869dc2009-03-13 09:10:46 +0800690 if (ACPI_FAILURE(status)) {
691 goto exit;
692 }
693
694 /* Insert the bits to be preserved */
695
696 ACPI_INSERT_BITS(value, ACPI_PM2_CONTROL_PRESERVED_BITS,
697 read_value);
698
Bob Moorec6b57742009-06-24 09:44:06 +0800699 status =
700 acpi_hw_write(value, &acpi_gbl_FADT.xpm2_control_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701 break;
702
Len Brown4be44fc2005-08-05 00:44:28 -0400703 case ACPI_REGISTER_PM_TIMER: /* 32-bit access */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704
Bob Moorec6b57742009-06-24 09:44:06 +0800705 status = acpi_hw_write(value, &acpi_gbl_FADT.xpm_timer_block);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706 break;
707
Len Brown4be44fc2005-08-05 00:44:28 -0400708 case ACPI_REGISTER_SMI_COMMAND_BLOCK: /* 8-bit access */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709
710 /* SMI_CMD is currently always in IO space */
711
Bob Mooref3d2e782007-02-02 19:48:18 +0300712 status =
Bob Moore7f071902009-03-19 09:37:47 +0800713 acpi_hw_write_port(acpi_gbl_FADT.smi_command, value, 8);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714 break;
715
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716 default:
Chao Guan1d1ea1b2013-06-08 00:58:14 +0000717
Bob Mooref6a22b02010-03-05 17:56:40 +0800718 ACPI_ERROR((AE_INFO, "Unknown Register ID: 0x%X", register_id));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719 status = AE_BAD_PARAMETER;
720 break;
721 }
722
Lv Zheng10622bf2013-10-29 09:30:02 +0800723exit:
Len Brown4be44fc2005-08-05 00:44:28 -0400724 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725}
Bob Moorec520aba2009-02-18 14:20:12 +0800726
727/******************************************************************************
728 *
729 * FUNCTION: acpi_hw_read_multiple
730 *
Bob Mooreba494be2012-07-12 09:40:10 +0800731 * PARAMETERS: value - Where the register value is returned
Bob Moorec520aba2009-02-18 14:20:12 +0800732 * register_a - First ACPI register (required)
733 * register_b - Second ACPI register (optional)
734 *
735 * RETURN: Status
736 *
737 * DESCRIPTION: Read from the specified two-part ACPI register (such as PM1 A/B)
738 *
739 ******************************************************************************/
740
741static acpi_status
742acpi_hw_read_multiple(u32 *value,
743 struct acpi_generic_address *register_a,
744 struct acpi_generic_address *register_b)
745{
746 u32 value_a = 0;
747 u32 value_b = 0;
748 acpi_status status;
749
750 /* The first register is always required */
751
Bob Moorec6b57742009-06-24 09:44:06 +0800752 status = acpi_hw_read(&value_a, register_a);
Bob Moorec520aba2009-02-18 14:20:12 +0800753 if (ACPI_FAILURE(status)) {
754 return (status);
755 }
756
757 /* Second register is optional */
758
759 if (register_b->address) {
Bob Moorec6b57742009-06-24 09:44:06 +0800760 status = acpi_hw_read(&value_b, register_b);
Bob Moorec520aba2009-02-18 14:20:12 +0800761 if (ACPI_FAILURE(status)) {
762 return (status);
763 }
764 }
765
Bob Mooreaefc7f92009-02-18 14:26:02 +0800766 /*
767 * OR the two return values together. No shifting or masking is necessary,
768 * because of how the PM1 registers are defined in the ACPI specification:
769 *
770 * "Although the bits can be split between the two register blocks (each
771 * register block has a unique pointer within the FADT), the bit positions
772 * are maintained. The register block with unimplemented bits (that is,
773 * those implemented in the other register block) always returns zeros,
774 * and writes have no side effects"
775 */
776 *value = (value_a | value_b);
Bob Moorec520aba2009-02-18 14:20:12 +0800777 return (AE_OK);
778}
779
780/******************************************************************************
781 *
782 * FUNCTION: acpi_hw_write_multiple
783 *
Bob Mooreba494be2012-07-12 09:40:10 +0800784 * PARAMETERS: value - The value to write
Bob Moorec520aba2009-02-18 14:20:12 +0800785 * register_a - First ACPI register (required)
786 * register_b - Second ACPI register (optional)
787 *
788 * RETURN: Status
789 *
790 * DESCRIPTION: Write to the specified two-part ACPI register (such as PM1 A/B)
791 *
792 ******************************************************************************/
793
794static acpi_status
795acpi_hw_write_multiple(u32 value,
796 struct acpi_generic_address *register_a,
797 struct acpi_generic_address *register_b)
798{
799 acpi_status status;
800
801 /* The first register is always required */
802
Bob Moorec6b57742009-06-24 09:44:06 +0800803 status = acpi_hw_write(value, register_a);
Bob Moorec520aba2009-02-18 14:20:12 +0800804 if (ACPI_FAILURE(status)) {
805 return (status);
806 }
807
Bob Mooreaefc7f92009-02-18 14:26:02 +0800808 /*
809 * Second register is optional
810 *
811 * No bit shifting or clearing is necessary, because of how the PM1
812 * registers are defined in the ACPI specification:
813 *
814 * "Although the bits can be split between the two register blocks (each
815 * register block has a unique pointer within the FADT), the bit positions
816 * are maintained. The register block with unimplemented bits (that is,
817 * those implemented in the other register block) always returns zeros,
818 * and writes have no side effects"
819 */
Bob Moorec520aba2009-02-18 14:20:12 +0800820 if (register_b->address) {
Bob Moorec6b57742009-06-24 09:44:06 +0800821 status = acpi_hw_write(value, register_b);
Bob Moorec520aba2009-02-18 14:20:12 +0800822 }
823
824 return (status);
825}
Bob Moore33620c52012-02-14 18:14:27 +0800826
827#endif /* !ACPI_REDUCED_HARDWARE */