xref: /freebsd/sys/contrib/dev/acpica/components/hardware/hwregs.c (revision 284829482ea5f5830d817e77e52e1a8af6486e93)
1a159c266SJung-uk Kim /*******************************************************************************
2a159c266SJung-uk Kim  *
3a159c266SJung-uk Kim  * Module Name: hwregs - Read/write access functions for the various ACPI
4a159c266SJung-uk Kim  *                       control and status registers.
5a159c266SJung-uk Kim  *
6a159c266SJung-uk Kim  ******************************************************************************/
7a159c266SJung-uk Kim 
8a159c266SJung-uk Kim /*
9f8146b88SJung-uk Kim  * Copyright (C) 2000 - 2016, Intel Corp.
10a159c266SJung-uk Kim  * All rights reserved.
11a159c266SJung-uk Kim  *
12a159c266SJung-uk Kim  * Redistribution and use in source and binary forms, with or without
13a159c266SJung-uk Kim  * modification, are permitted provided that the following conditions
14a159c266SJung-uk Kim  * are met:
15a159c266SJung-uk Kim  * 1. Redistributions of source code must retain the above copyright
16a159c266SJung-uk Kim  *    notice, this list of conditions, and the following disclaimer,
17a159c266SJung-uk Kim  *    without modification.
18a159c266SJung-uk Kim  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
19a159c266SJung-uk Kim  *    substantially similar to the "NO WARRANTY" disclaimer below
20a159c266SJung-uk Kim  *    ("Disclaimer") and any redistribution must be conditioned upon
21a159c266SJung-uk Kim  *    including a substantially similar Disclaimer requirement for further
22a159c266SJung-uk Kim  *    binary redistribution.
23a159c266SJung-uk Kim  * 3. Neither the names of the above-listed copyright holders nor the names
24a159c266SJung-uk Kim  *    of any contributors may be used to endorse or promote products derived
25a159c266SJung-uk Kim  *    from this software without specific prior written permission.
26a159c266SJung-uk Kim  *
27a159c266SJung-uk Kim  * Alternatively, this software may be distributed under the terms of the
28a159c266SJung-uk Kim  * GNU General Public License ("GPL") version 2 as published by the Free
29a159c266SJung-uk Kim  * Software Foundation.
30a159c266SJung-uk Kim  *
31a159c266SJung-uk Kim  * NO WARRANTY
32a159c266SJung-uk Kim  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33a159c266SJung-uk Kim  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34a159c266SJung-uk Kim  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
35a159c266SJung-uk Kim  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36a159c266SJung-uk Kim  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37a159c266SJung-uk Kim  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38a159c266SJung-uk Kim  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39a159c266SJung-uk Kim  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40a159c266SJung-uk Kim  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
41a159c266SJung-uk Kim  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
42a159c266SJung-uk Kim  * POSSIBILITY OF SUCH DAMAGES.
43a159c266SJung-uk Kim  */
44a159c266SJung-uk Kim 
45a159c266SJung-uk Kim #include <contrib/dev/acpica/include/acpi.h>
46a159c266SJung-uk Kim #include <contrib/dev/acpica/include/accommon.h>
47a159c266SJung-uk Kim #include <contrib/dev/acpica/include/acevents.h>
48a159c266SJung-uk Kim 
49a159c266SJung-uk Kim #define _COMPONENT          ACPI_HARDWARE
50a159c266SJung-uk Kim         ACPI_MODULE_NAME    ("hwregs")
51a159c266SJung-uk Kim 
52a159c266SJung-uk Kim 
53a159c266SJung-uk Kim #if (!ACPI_REDUCED_HARDWARE)
54a159c266SJung-uk Kim 
55a159c266SJung-uk Kim /* Local Prototypes */
56a159c266SJung-uk Kim 
57*28482948SJung-uk Kim static UINT8
58*28482948SJung-uk Kim AcpiHwGetAccessBitWidth (
59*28482948SJung-uk Kim     UINT64                  Address,
60*28482948SJung-uk Kim     ACPI_GENERIC_ADDRESS    *Reg,
61*28482948SJung-uk Kim     UINT8                   MaxBitWidth);
62*28482948SJung-uk Kim 
63a159c266SJung-uk Kim static ACPI_STATUS
64a159c266SJung-uk Kim AcpiHwReadMultiple (
65a159c266SJung-uk Kim     UINT32                  *Value,
66a159c266SJung-uk Kim     ACPI_GENERIC_ADDRESS    *RegisterA,
67a159c266SJung-uk Kim     ACPI_GENERIC_ADDRESS    *RegisterB);
68a159c266SJung-uk Kim 
69a159c266SJung-uk Kim static ACPI_STATUS
70a159c266SJung-uk Kim AcpiHwWriteMultiple (
71a159c266SJung-uk Kim     UINT32                  Value,
72a159c266SJung-uk Kim     ACPI_GENERIC_ADDRESS    *RegisterA,
73a159c266SJung-uk Kim     ACPI_GENERIC_ADDRESS    *RegisterB);
74a159c266SJung-uk Kim 
75a159c266SJung-uk Kim #endif /* !ACPI_REDUCED_HARDWARE */
76a159c266SJung-uk Kim 
77f8146b88SJung-uk Kim 
78f8146b88SJung-uk Kim /******************************************************************************
79f8146b88SJung-uk Kim  *
80*28482948SJung-uk Kim  * FUNCTION:    AcpiHwGetAccessBitWidth
81*28482948SJung-uk Kim  *
82*28482948SJung-uk Kim  * PARAMETERS:  Address             - GAS register address
83*28482948SJung-uk Kim  *              Reg                 - GAS register structure
84*28482948SJung-uk Kim  *              MaxBitWidth         - Max BitWidth supported (32 or 64)
85*28482948SJung-uk Kim  *
86*28482948SJung-uk Kim  * RETURN:      Status
87*28482948SJung-uk Kim  *
88*28482948SJung-uk Kim  * DESCRIPTION: Obtain optimal access bit width
89*28482948SJung-uk Kim  *
90*28482948SJung-uk Kim  ******************************************************************************/
91*28482948SJung-uk Kim 
92*28482948SJung-uk Kim static UINT8
93*28482948SJung-uk Kim AcpiHwGetAccessBitWidth (
94*28482948SJung-uk Kim     UINT64                  Address,
95*28482948SJung-uk Kim     ACPI_GENERIC_ADDRESS    *Reg,
96*28482948SJung-uk Kim     UINT8                   MaxBitWidth)
97*28482948SJung-uk Kim {
98*28482948SJung-uk Kim     UINT8                   AccessBitWidth;
99*28482948SJung-uk Kim 
100*28482948SJung-uk Kim 
101*28482948SJung-uk Kim     /*
102*28482948SJung-uk Kim      * GAS format "register", used by FADT:
103*28482948SJung-uk Kim      *  1. Detected if BitOffset is 0 and BitWidth is 8/16/32/64;
104*28482948SJung-uk Kim      *  2. AccessSize field is ignored and BitWidth field is used for
105*28482948SJung-uk Kim      *     determining the boundary of the IO accesses.
106*28482948SJung-uk Kim      * GAS format "region", used by APEI registers:
107*28482948SJung-uk Kim      *  1. Detected if BitOffset is not 0 or BitWidth is not 8/16/32/64;
108*28482948SJung-uk Kim      *  2. AccessSize field is used for determining the boundary of the
109*28482948SJung-uk Kim      *     IO accesses;
110*28482948SJung-uk Kim      *  3. BitOffset/BitWidth fields are used to describe the "region".
111*28482948SJung-uk Kim      *
112*28482948SJung-uk Kim      * Note: This algorithm assumes that the "Address" fields should always
113*28482948SJung-uk Kim      *       contain aligned values.
114*28482948SJung-uk Kim      */
115*28482948SJung-uk Kim     if (!Reg->BitOffset && Reg->BitWidth &&
116*28482948SJung-uk Kim         ACPI_IS_POWER_OF_TWO (Reg->BitWidth) &&
117*28482948SJung-uk Kim         ACPI_IS_ALIGNED (Reg->BitWidth, 8))
118*28482948SJung-uk Kim     {
119*28482948SJung-uk Kim         AccessBitWidth = Reg->BitWidth;
120*28482948SJung-uk Kim     }
121*28482948SJung-uk Kim     else if (Reg->AccessWidth)
122*28482948SJung-uk Kim     {
123*28482948SJung-uk Kim         AccessBitWidth = (1 << (Reg->AccessWidth + 2));
124*28482948SJung-uk Kim     }
125*28482948SJung-uk Kim     else
126*28482948SJung-uk Kim     {
127*28482948SJung-uk Kim         AccessBitWidth = ACPI_ROUND_UP_POWER_OF_TWO_8 (
128*28482948SJung-uk Kim             Reg->BitOffset + Reg->BitWidth);
129*28482948SJung-uk Kim         if (AccessBitWidth <= 8)
130*28482948SJung-uk Kim         {
131*28482948SJung-uk Kim             AccessBitWidth = 8;
132*28482948SJung-uk Kim         }
133*28482948SJung-uk Kim         else
134*28482948SJung-uk Kim         {
135*28482948SJung-uk Kim             while (!ACPI_IS_ALIGNED (Address, AccessBitWidth >> 3))
136*28482948SJung-uk Kim             {
137*28482948SJung-uk Kim                 AccessBitWidth >>= 1;
138*28482948SJung-uk Kim             }
139*28482948SJung-uk Kim         }
140*28482948SJung-uk Kim     }
141*28482948SJung-uk Kim 
142*28482948SJung-uk Kim     /* Maximum IO port access bit width is 32 */
143*28482948SJung-uk Kim 
144*28482948SJung-uk Kim     if (Reg->SpaceId == ACPI_ADR_SPACE_SYSTEM_IO)
145*28482948SJung-uk Kim     {
146*28482948SJung-uk Kim         MaxBitWidth = 32;
147*28482948SJung-uk Kim     }
148*28482948SJung-uk Kim 
149*28482948SJung-uk Kim     /*
150*28482948SJung-uk Kim      * Return access width according to the requested maximum access bit width,
151*28482948SJung-uk Kim      * as the caller should know the format of the register and may enforce
152*28482948SJung-uk Kim      * a 32-bit accesses.
153*28482948SJung-uk Kim      */
154*28482948SJung-uk Kim     if (AccessBitWidth < MaxBitWidth)
155*28482948SJung-uk Kim     {
156*28482948SJung-uk Kim         return (AccessBitWidth);
157*28482948SJung-uk Kim     }
158*28482948SJung-uk Kim     return (MaxBitWidth);
159*28482948SJung-uk Kim }
160*28482948SJung-uk Kim 
161*28482948SJung-uk Kim 
162*28482948SJung-uk Kim /******************************************************************************
163*28482948SJung-uk Kim  *
164a159c266SJung-uk Kim  * FUNCTION:    AcpiHwValidateRegister
165a159c266SJung-uk Kim  *
166a159c266SJung-uk Kim  * PARAMETERS:  Reg                 - GAS register structure
167a159c266SJung-uk Kim  *              MaxBitWidth         - Max BitWidth supported (32 or 64)
168a159c266SJung-uk Kim  *              Address             - Pointer to where the gas->address
169a159c266SJung-uk Kim  *                                    is returned
170a159c266SJung-uk Kim  *
171a159c266SJung-uk Kim  * RETURN:      Status
172a159c266SJung-uk Kim  *
173a159c266SJung-uk Kim  * DESCRIPTION: Validate the contents of a GAS register. Checks the GAS
174a159c266SJung-uk Kim  *              pointer, Address, SpaceId, BitWidth, and BitOffset.
175a159c266SJung-uk Kim  *
176a159c266SJung-uk Kim  ******************************************************************************/
177a159c266SJung-uk Kim 
178a159c266SJung-uk Kim ACPI_STATUS
179a159c266SJung-uk Kim AcpiHwValidateRegister (
180a159c266SJung-uk Kim     ACPI_GENERIC_ADDRESS    *Reg,
181a159c266SJung-uk Kim     UINT8                   MaxBitWidth,
182a159c266SJung-uk Kim     UINT64                  *Address)
183a159c266SJung-uk Kim {
184*28482948SJung-uk Kim     UINT8                   BitWidth;
185*28482948SJung-uk Kim     UINT8                   AccessWidth;
186*28482948SJung-uk Kim 
187a159c266SJung-uk Kim 
188a159c266SJung-uk Kim     /* Must have a valid pointer to a GAS structure */
189a159c266SJung-uk Kim 
190a159c266SJung-uk Kim     if (!Reg)
191a159c266SJung-uk Kim     {
192a159c266SJung-uk Kim         return (AE_BAD_PARAMETER);
193a159c266SJung-uk Kim     }
194a159c266SJung-uk Kim 
195a159c266SJung-uk Kim     /*
196a159c266SJung-uk Kim      * Copy the target address. This handles possible alignment issues.
197a159c266SJung-uk Kim      * Address must not be null. A null address also indicates an optional
198a159c266SJung-uk Kim      * ACPI register that is not supported, so no error message.
199a159c266SJung-uk Kim      */
200a159c266SJung-uk Kim     ACPI_MOVE_64_TO_64 (Address, &Reg->Address);
201a159c266SJung-uk Kim     if (!(*Address))
202a159c266SJung-uk Kim     {
203a159c266SJung-uk Kim         return (AE_BAD_ADDRESS);
204a159c266SJung-uk Kim     }
205a159c266SJung-uk Kim 
206a159c266SJung-uk Kim     /* Validate the SpaceID */
207a159c266SJung-uk Kim 
208a159c266SJung-uk Kim     if ((Reg->SpaceId != ACPI_ADR_SPACE_SYSTEM_MEMORY) &&
209a159c266SJung-uk Kim         (Reg->SpaceId != ACPI_ADR_SPACE_SYSTEM_IO))
210a159c266SJung-uk Kim     {
211a159c266SJung-uk Kim         ACPI_ERROR ((AE_INFO,
212a159c266SJung-uk Kim             "Unsupported address space: 0x%X", Reg->SpaceId));
213a159c266SJung-uk Kim         return (AE_SUPPORT);
214a159c266SJung-uk Kim     }
215a159c266SJung-uk Kim 
216*28482948SJung-uk Kim     /* Validate the AccessWidth */
217a159c266SJung-uk Kim 
218*28482948SJung-uk Kim     if (Reg->AccessWidth > 4)
219a159c266SJung-uk Kim     {
220a159c266SJung-uk Kim         ACPI_ERROR ((AE_INFO,
221*28482948SJung-uk Kim             "Unsupported register access width: 0x%X", Reg->AccessWidth));
222a159c266SJung-uk Kim         return (AE_SUPPORT);
223a159c266SJung-uk Kim     }
224a159c266SJung-uk Kim 
225*28482948SJung-uk Kim     /* Validate the BitWidth, convert AccessWidth into number of bits */
226a159c266SJung-uk Kim 
227*28482948SJung-uk Kim     AccessWidth = AcpiHwGetAccessBitWidth (*Address, Reg, MaxBitWidth);
228*28482948SJung-uk Kim     BitWidth = ACPI_ROUND_UP (Reg->BitOffset + Reg->BitWidth, AccessWidth);
229*28482948SJung-uk Kim     if (MaxBitWidth < BitWidth)
230a159c266SJung-uk Kim     {
231a159c266SJung-uk Kim         ACPI_WARNING ((AE_INFO,
232*28482948SJung-uk Kim             "Requested bit width 0x%X is smaller than register bit width 0x%X",
233*28482948SJung-uk Kim             MaxBitWidth, BitWidth));
234*28482948SJung-uk Kim         return (AE_SUPPORT);
235a159c266SJung-uk Kim     }
236a159c266SJung-uk Kim 
237a159c266SJung-uk Kim     return (AE_OK);
238a159c266SJung-uk Kim }
239a159c266SJung-uk Kim 
240a159c266SJung-uk Kim 
241a159c266SJung-uk Kim /******************************************************************************
242a159c266SJung-uk Kim  *
243a159c266SJung-uk Kim  * FUNCTION:    AcpiHwRead
244a159c266SJung-uk Kim  *
245a159c266SJung-uk Kim  * PARAMETERS:  Value               - Where the value is returned
246a159c266SJung-uk Kim  *              Reg                 - GAS register structure
247a159c266SJung-uk Kim  *
248a159c266SJung-uk Kim  * RETURN:      Status
249a159c266SJung-uk Kim  *
250a159c266SJung-uk Kim  * DESCRIPTION: Read from either memory or IO space. This is a 32-bit max
251a159c266SJung-uk Kim  *              version of AcpiRead, used internally since the overhead of
252a159c266SJung-uk Kim  *              64-bit values is not needed.
253a159c266SJung-uk Kim  *
254a159c266SJung-uk Kim  * LIMITATIONS: <These limitations also apply to AcpiHwWrite>
255a159c266SJung-uk Kim  *      SpaceID must be SystemMemory or SystemIO.
256a159c266SJung-uk Kim  *
257a159c266SJung-uk Kim  ******************************************************************************/
258a159c266SJung-uk Kim 
259a159c266SJung-uk Kim ACPI_STATUS
260a159c266SJung-uk Kim AcpiHwRead (
261a159c266SJung-uk Kim     UINT32                  *Value,
262a159c266SJung-uk Kim     ACPI_GENERIC_ADDRESS    *Reg)
263a159c266SJung-uk Kim {
264a159c266SJung-uk Kim     UINT64                  Address;
265*28482948SJung-uk Kim     UINT8                   AccessWidth;
266*28482948SJung-uk Kim     UINT32                  BitWidth;
267*28482948SJung-uk Kim     UINT8                   BitOffset;
268a159c266SJung-uk Kim     UINT64                  Value64;
269*28482948SJung-uk Kim     UINT32                  Value32;
270*28482948SJung-uk Kim     UINT8                   Index;
271a159c266SJung-uk Kim     ACPI_STATUS             Status;
272a159c266SJung-uk Kim 
273a159c266SJung-uk Kim 
274a159c266SJung-uk Kim     ACPI_FUNCTION_NAME (HwRead);
275a159c266SJung-uk Kim 
276a159c266SJung-uk Kim 
277a159c266SJung-uk Kim     /* Validate contents of the GAS register */
278a159c266SJung-uk Kim 
279a159c266SJung-uk Kim     Status = AcpiHwValidateRegister (Reg, 32, &Address);
280a159c266SJung-uk Kim     if (ACPI_FAILURE (Status))
281a159c266SJung-uk Kim     {
282a159c266SJung-uk Kim         return (Status);
283a159c266SJung-uk Kim     }
284a159c266SJung-uk Kim 
285*28482948SJung-uk Kim     /*
286*28482948SJung-uk Kim      * Initialize entire 32-bit return value to zero, convert AccessWidth
287*28482948SJung-uk Kim      * into number of bits based
288*28482948SJung-uk Kim      */
289a159c266SJung-uk Kim     *Value = 0;
290*28482948SJung-uk Kim     AccessWidth = AcpiHwGetAccessBitWidth (Address, Reg, 32);
291*28482948SJung-uk Kim     BitWidth = Reg->BitOffset + Reg->BitWidth;
292*28482948SJung-uk Kim     BitOffset = Reg->BitOffset;
293a159c266SJung-uk Kim 
294a159c266SJung-uk Kim     /*
295a159c266SJung-uk Kim      * Two address spaces supported: Memory or IO. PCI_Config is
296a159c266SJung-uk Kim      * not supported here because the GAS structure is insufficient
297a159c266SJung-uk Kim      */
298*28482948SJung-uk Kim     Index = 0;
299*28482948SJung-uk Kim     while (BitWidth)
300*28482948SJung-uk Kim     {
301*28482948SJung-uk Kim         if (BitOffset >= AccessWidth)
302*28482948SJung-uk Kim         {
303*28482948SJung-uk Kim             Value32 = 0;
304*28482948SJung-uk Kim             BitOffset -= AccessWidth;
305*28482948SJung-uk Kim         }
306*28482948SJung-uk Kim         else
307*28482948SJung-uk Kim         {
308a159c266SJung-uk Kim             if (Reg->SpaceId == ACPI_ADR_SPACE_SYSTEM_MEMORY)
309a159c266SJung-uk Kim             {
310a159c266SJung-uk Kim                 Status = AcpiOsReadMemory ((ACPI_PHYSICAL_ADDRESS)
311*28482948SJung-uk Kim                     Address + Index * ACPI_DIV_8 (AccessWidth),
312*28482948SJung-uk Kim                     &Value64, AccessWidth);
313*28482948SJung-uk Kim                 Value32 = (UINT32) Value64;
314a159c266SJung-uk Kim             }
315a159c266SJung-uk Kim             else /* ACPI_ADR_SPACE_SYSTEM_IO, validated earlier */
316a159c266SJung-uk Kim             {
317a159c266SJung-uk Kim                 Status = AcpiHwReadPort ((ACPI_IO_ADDRESS)
318*28482948SJung-uk Kim                     Address + Index * ACPI_DIV_8 (AccessWidth),
319*28482948SJung-uk Kim                     &Value32, AccessWidth);
320*28482948SJung-uk Kim             }
321*28482948SJung-uk Kim         }
322*28482948SJung-uk Kim 
323*28482948SJung-uk Kim         /*
324*28482948SJung-uk Kim          * Use offset style bit writes because "Index * AccessWidth" is
325*28482948SJung-uk Kim          * ensured to be less than 32-bits by AcpiHwValidateRegister().
326*28482948SJung-uk Kim          */
327*28482948SJung-uk Kim         ACPI_SET_BITS (Value, Index * AccessWidth,
328*28482948SJung-uk Kim             ACPI_MASK_BITS_ABOVE_32 (AccessWidth), Value32);
329*28482948SJung-uk Kim 
330*28482948SJung-uk Kim         BitWidth -= BitWidth > AccessWidth ? AccessWidth : BitWidth;
331*28482948SJung-uk Kim         Index++;
332a159c266SJung-uk Kim     }
333a159c266SJung-uk Kim 
334a159c266SJung-uk Kim     ACPI_DEBUG_PRINT ((ACPI_DB_IO,
335a159c266SJung-uk Kim         "Read:  %8.8X width %2d from %8.8X%8.8X (%s)\n",
336*28482948SJung-uk Kim         *Value, AccessWidth, ACPI_FORMAT_UINT64 (Address),
337a159c266SJung-uk Kim         AcpiUtGetRegionName (Reg->SpaceId)));
338a159c266SJung-uk Kim 
339a159c266SJung-uk Kim     return (Status);
340a159c266SJung-uk Kim }
341a159c266SJung-uk Kim 
342a159c266SJung-uk Kim 
343a159c266SJung-uk Kim /******************************************************************************
344a159c266SJung-uk Kim  *
345a159c266SJung-uk Kim  * FUNCTION:    AcpiHwWrite
346a159c266SJung-uk Kim  *
347a159c266SJung-uk Kim  * PARAMETERS:  Value               - Value to be written
348a159c266SJung-uk Kim  *              Reg                 - GAS register structure
349a159c266SJung-uk Kim  *
350a159c266SJung-uk Kim  * RETURN:      Status
351a159c266SJung-uk Kim  *
352a159c266SJung-uk Kim  * DESCRIPTION: Write to either memory or IO space. This is a 32-bit max
353a159c266SJung-uk Kim  *              version of AcpiWrite, used internally since the overhead of
354a159c266SJung-uk Kim  *              64-bit values is not needed.
355a159c266SJung-uk Kim  *
356a159c266SJung-uk Kim  ******************************************************************************/
357a159c266SJung-uk Kim 
358a159c266SJung-uk Kim ACPI_STATUS
359a159c266SJung-uk Kim AcpiHwWrite (
360a159c266SJung-uk Kim     UINT32                  Value,
361a159c266SJung-uk Kim     ACPI_GENERIC_ADDRESS    *Reg)
362a159c266SJung-uk Kim {
363a159c266SJung-uk Kim     UINT64                  Address;
364*28482948SJung-uk Kim     UINT8                   AccessWidth;
365*28482948SJung-uk Kim     UINT32                  BitWidth;
366*28482948SJung-uk Kim     UINT8                   BitOffset;
367*28482948SJung-uk Kim     UINT64                  Value64;
368*28482948SJung-uk Kim     UINT32                  Value32;
369*28482948SJung-uk Kim     UINT8                   Index;
370a159c266SJung-uk Kim     ACPI_STATUS             Status;
371a159c266SJung-uk Kim 
372a159c266SJung-uk Kim 
373a159c266SJung-uk Kim     ACPI_FUNCTION_NAME (HwWrite);
374a159c266SJung-uk Kim 
375a159c266SJung-uk Kim 
376a159c266SJung-uk Kim     /* Validate contents of the GAS register */
377a159c266SJung-uk Kim 
378a159c266SJung-uk Kim     Status = AcpiHwValidateRegister (Reg, 32, &Address);
379a159c266SJung-uk Kim     if (ACPI_FAILURE (Status))
380a159c266SJung-uk Kim     {
381a159c266SJung-uk Kim         return (Status);
382a159c266SJung-uk Kim     }
383a159c266SJung-uk Kim 
384*28482948SJung-uk Kim     /* Convert AccessWidth into number of bits based */
385*28482948SJung-uk Kim 
386*28482948SJung-uk Kim     AccessWidth = AcpiHwGetAccessBitWidth (Address, Reg, 32);
387*28482948SJung-uk Kim     BitWidth = Reg->BitOffset + Reg->BitWidth;
388*28482948SJung-uk Kim     BitOffset = Reg->BitOffset;
389*28482948SJung-uk Kim 
390a159c266SJung-uk Kim     /*
391a159c266SJung-uk Kim      * Two address spaces supported: Memory or IO. PCI_Config is
392a159c266SJung-uk Kim      * not supported here because the GAS structure is insufficient
393a159c266SJung-uk Kim      */
394*28482948SJung-uk Kim     Index = 0;
395*28482948SJung-uk Kim     while (BitWidth)
396*28482948SJung-uk Kim     {
397*28482948SJung-uk Kim         /*
398*28482948SJung-uk Kim          * Use offset style bit reads because "Index * AccessWidth" is
399*28482948SJung-uk Kim          * ensured to be less than 32-bits by AcpiHwValidateRegister().
400*28482948SJung-uk Kim          */
401*28482948SJung-uk Kim         Value32 = ACPI_GET_BITS (&Value, Index * AccessWidth,
402*28482948SJung-uk Kim             ACPI_MASK_BITS_ABOVE_32 (AccessWidth));
403*28482948SJung-uk Kim 
404*28482948SJung-uk Kim         if (BitOffset >= AccessWidth)
405*28482948SJung-uk Kim         {
406*28482948SJung-uk Kim             BitOffset -= AccessWidth;
407*28482948SJung-uk Kim         }
408*28482948SJung-uk Kim         else
409*28482948SJung-uk Kim         {
410a159c266SJung-uk Kim             if (Reg->SpaceId == ACPI_ADR_SPACE_SYSTEM_MEMORY)
411a159c266SJung-uk Kim             {
412*28482948SJung-uk Kim                 Value64 = (UINT64) Value32;
413a159c266SJung-uk Kim                 Status = AcpiOsWriteMemory ((ACPI_PHYSICAL_ADDRESS)
414*28482948SJung-uk Kim                     Address + Index * ACPI_DIV_8 (AccessWidth),
415*28482948SJung-uk Kim                     Value64, AccessWidth);
416a159c266SJung-uk Kim             }
417a159c266SJung-uk Kim             else /* ACPI_ADR_SPACE_SYSTEM_IO, validated earlier */
418a159c266SJung-uk Kim             {
419a159c266SJung-uk Kim                 Status = AcpiHwWritePort ((ACPI_IO_ADDRESS)
420*28482948SJung-uk Kim                     Address + Index * ACPI_DIV_8 (AccessWidth),
421*28482948SJung-uk Kim                     Value32, AccessWidth);
422*28482948SJung-uk Kim             }
423*28482948SJung-uk Kim         }
424*28482948SJung-uk Kim 
425*28482948SJung-uk Kim         /*
426*28482948SJung-uk Kim          * Index * AccessWidth is ensured to be less than 32-bits by
427*28482948SJung-uk Kim          * AcpiHwValidateRegister().
428*28482948SJung-uk Kim          */
429*28482948SJung-uk Kim         BitWidth -= BitWidth > AccessWidth ? AccessWidth : BitWidth;
430*28482948SJung-uk Kim         Index++;
431a159c266SJung-uk Kim     }
432a159c266SJung-uk Kim 
433a159c266SJung-uk Kim     ACPI_DEBUG_PRINT ((ACPI_DB_IO,
434a159c266SJung-uk Kim         "Wrote: %8.8X width %2d   to %8.8X%8.8X (%s)\n",
435*28482948SJung-uk Kim         Value, AccessWidth, ACPI_FORMAT_UINT64 (Address),
436a159c266SJung-uk Kim         AcpiUtGetRegionName (Reg->SpaceId)));
437a159c266SJung-uk Kim 
438a159c266SJung-uk Kim     return (Status);
439a159c266SJung-uk Kim }
440a159c266SJung-uk Kim 
441a159c266SJung-uk Kim 
442a159c266SJung-uk Kim #if (!ACPI_REDUCED_HARDWARE)
443a159c266SJung-uk Kim /*******************************************************************************
444a159c266SJung-uk Kim  *
445a159c266SJung-uk Kim  * FUNCTION:    AcpiHwClearAcpiStatus
446a159c266SJung-uk Kim  *
447a159c266SJung-uk Kim  * PARAMETERS:  None
448a159c266SJung-uk Kim  *
449a159c266SJung-uk Kim  * RETURN:      Status
450a159c266SJung-uk Kim  *
451a159c266SJung-uk Kim  * DESCRIPTION: Clears all fixed and general purpose status bits
452a159c266SJung-uk Kim  *
453a159c266SJung-uk Kim  ******************************************************************************/
454a159c266SJung-uk Kim 
455a159c266SJung-uk Kim ACPI_STATUS
456a159c266SJung-uk Kim AcpiHwClearAcpiStatus (
457a159c266SJung-uk Kim     void)
458a159c266SJung-uk Kim {
459a159c266SJung-uk Kim     ACPI_STATUS             Status;
460a159c266SJung-uk Kim     ACPI_CPU_FLAGS          LockFlags = 0;
461a159c266SJung-uk Kim 
462a159c266SJung-uk Kim 
463a159c266SJung-uk Kim     ACPI_FUNCTION_TRACE (HwClearAcpiStatus);
464a159c266SJung-uk Kim 
465a159c266SJung-uk Kim 
466a159c266SJung-uk Kim     ACPI_DEBUG_PRINT ((ACPI_DB_IO, "About to write %04X to %8.8X%8.8X\n",
467a159c266SJung-uk Kim         ACPI_BITMASK_ALL_FIXED_STATUS,
468a159c266SJung-uk Kim         ACPI_FORMAT_UINT64 (AcpiGbl_XPm1aStatus.Address)));
469a159c266SJung-uk Kim 
470a159c266SJung-uk Kim     LockFlags = AcpiOsAcquireLock (AcpiGbl_HardwareLock);
471a159c266SJung-uk Kim 
472a159c266SJung-uk Kim     /* Clear the fixed events in PM1 A/B */
473a159c266SJung-uk Kim 
474a159c266SJung-uk Kim     Status = AcpiHwRegisterWrite (ACPI_REGISTER_PM1_STATUS,
475a159c266SJung-uk Kim         ACPI_BITMASK_ALL_FIXED_STATUS);
476313a0c13SJung-uk Kim 
477313a0c13SJung-uk Kim     AcpiOsReleaseLock (AcpiGbl_HardwareLock, LockFlags);
478313a0c13SJung-uk Kim 
479a159c266SJung-uk Kim     if (ACPI_FAILURE (Status))
480a159c266SJung-uk Kim     {
481313a0c13SJung-uk Kim         goto Exit;
482a159c266SJung-uk Kim     }
483a159c266SJung-uk Kim 
484a159c266SJung-uk Kim     /* Clear the GPE Bits in all GPE registers in all GPE blocks */
485a159c266SJung-uk Kim 
486a159c266SJung-uk Kim     Status = AcpiEvWalkGpeList (AcpiHwClearGpeBlock, NULL);
487a159c266SJung-uk Kim 
488313a0c13SJung-uk Kim Exit:
489a159c266SJung-uk Kim     return_ACPI_STATUS (Status);
490a159c266SJung-uk Kim }
491a159c266SJung-uk Kim 
492a159c266SJung-uk Kim 
493a159c266SJung-uk Kim /*******************************************************************************
494a159c266SJung-uk Kim  *
495a159c266SJung-uk Kim  * FUNCTION:    AcpiHwGetBitRegisterInfo
496a159c266SJung-uk Kim  *
497a159c266SJung-uk Kim  * PARAMETERS:  RegisterId          - Index of ACPI Register to access
498a159c266SJung-uk Kim  *
499a159c266SJung-uk Kim  * RETURN:      The bitmask to be used when accessing the register
500a159c266SJung-uk Kim  *
501a159c266SJung-uk Kim  * DESCRIPTION: Map RegisterId into a register bitmask.
502a159c266SJung-uk Kim  *
503a159c266SJung-uk Kim  ******************************************************************************/
504a159c266SJung-uk Kim 
505a159c266SJung-uk Kim ACPI_BIT_REGISTER_INFO *
506a159c266SJung-uk Kim AcpiHwGetBitRegisterInfo (
507a159c266SJung-uk Kim     UINT32                  RegisterId)
508a159c266SJung-uk Kim {
509a159c266SJung-uk Kim     ACPI_FUNCTION_ENTRY ();
510a159c266SJung-uk Kim 
511a159c266SJung-uk Kim 
512a159c266SJung-uk Kim     if (RegisterId > ACPI_BITREG_MAX)
513a159c266SJung-uk Kim     {
514a159c266SJung-uk Kim         ACPI_ERROR ((AE_INFO, "Invalid BitRegister ID: 0x%X", RegisterId));
515a159c266SJung-uk Kim         return (NULL);
516a159c266SJung-uk Kim     }
517a159c266SJung-uk Kim 
518a159c266SJung-uk Kim     return (&AcpiGbl_BitRegisterInfo[RegisterId]);
519a159c266SJung-uk Kim }
520a159c266SJung-uk Kim 
521a159c266SJung-uk Kim 
522a159c266SJung-uk Kim /******************************************************************************
523a159c266SJung-uk Kim  *
524a159c266SJung-uk Kim  * FUNCTION:    AcpiHwWritePm1Control
525a159c266SJung-uk Kim  *
526a159c266SJung-uk Kim  * PARAMETERS:  Pm1aControl         - Value to be written to PM1A control
527a159c266SJung-uk Kim  *              Pm1bControl         - Value to be written to PM1B control
528a159c266SJung-uk Kim  *
529a159c266SJung-uk Kim  * RETURN:      Status
530a159c266SJung-uk Kim  *
531a159c266SJung-uk Kim  * DESCRIPTION: Write the PM1 A/B control registers. These registers are
532a159c266SJung-uk Kim  *              different than than the PM1 A/B status and enable registers
533a159c266SJung-uk Kim  *              in that different values can be written to the A/B registers.
534a159c266SJung-uk Kim  *              Most notably, the SLP_TYP bits can be different, as per the
535a159c266SJung-uk Kim  *              values returned from the _Sx predefined methods.
536a159c266SJung-uk Kim  *
537a159c266SJung-uk Kim  ******************************************************************************/
538a159c266SJung-uk Kim 
539a159c266SJung-uk Kim ACPI_STATUS
540a159c266SJung-uk Kim AcpiHwWritePm1Control (
541a159c266SJung-uk Kim     UINT32                  Pm1aControl,
542a159c266SJung-uk Kim     UINT32                  Pm1bControl)
543a159c266SJung-uk Kim {
544a159c266SJung-uk Kim     ACPI_STATUS             Status;
545a159c266SJung-uk Kim 
546a159c266SJung-uk Kim 
547a159c266SJung-uk Kim     ACPI_FUNCTION_TRACE (HwWritePm1Control);
548a159c266SJung-uk Kim 
549a159c266SJung-uk Kim 
550a159c266SJung-uk Kim     Status = AcpiHwWrite (Pm1aControl, &AcpiGbl_FADT.XPm1aControlBlock);
551a159c266SJung-uk Kim     if (ACPI_FAILURE (Status))
552a159c266SJung-uk Kim     {
553a159c266SJung-uk Kim         return_ACPI_STATUS (Status);
554a159c266SJung-uk Kim     }
555a159c266SJung-uk Kim 
556a159c266SJung-uk Kim     if (AcpiGbl_FADT.XPm1bControlBlock.Address)
557a159c266SJung-uk Kim     {
558a159c266SJung-uk Kim         Status = AcpiHwWrite (Pm1bControl, &AcpiGbl_FADT.XPm1bControlBlock);
559a159c266SJung-uk Kim     }
560a159c266SJung-uk Kim     return_ACPI_STATUS (Status);
561a159c266SJung-uk Kim }
562a159c266SJung-uk Kim 
563a159c266SJung-uk Kim 
564a159c266SJung-uk Kim /******************************************************************************
565a159c266SJung-uk Kim  *
566a159c266SJung-uk Kim  * FUNCTION:    AcpiHwRegisterRead
567a159c266SJung-uk Kim  *
568a159c266SJung-uk Kim  * PARAMETERS:  RegisterId          - ACPI Register ID
569a159c266SJung-uk Kim  *              ReturnValue         - Where the register value is returned
570a159c266SJung-uk Kim  *
571a159c266SJung-uk Kim  * RETURN:      Status and the value read.
572a159c266SJung-uk Kim  *
573a159c266SJung-uk Kim  * DESCRIPTION: Read from the specified ACPI register
574a159c266SJung-uk Kim  *
575a159c266SJung-uk Kim  ******************************************************************************/
576a159c266SJung-uk Kim 
577a159c266SJung-uk Kim ACPI_STATUS
578a159c266SJung-uk Kim AcpiHwRegisterRead (
579a159c266SJung-uk Kim     UINT32                  RegisterId,
580a159c266SJung-uk Kim     UINT32                  *ReturnValue)
581a159c266SJung-uk Kim {
582a159c266SJung-uk Kim     UINT32                  Value = 0;
583a159c266SJung-uk Kim     ACPI_STATUS             Status;
584a159c266SJung-uk Kim 
585a159c266SJung-uk Kim 
586a159c266SJung-uk Kim     ACPI_FUNCTION_TRACE (HwRegisterRead);
587a159c266SJung-uk Kim 
588a159c266SJung-uk Kim 
589a159c266SJung-uk Kim     switch (RegisterId)
590a159c266SJung-uk Kim     {
591a159c266SJung-uk Kim     case ACPI_REGISTER_PM1_STATUS:           /* PM1 A/B: 16-bit access each */
592a159c266SJung-uk Kim 
593a159c266SJung-uk Kim         Status = AcpiHwReadMultiple (&Value,
594a159c266SJung-uk Kim             &AcpiGbl_XPm1aStatus,
595a159c266SJung-uk Kim             &AcpiGbl_XPm1bStatus);
596a159c266SJung-uk Kim         break;
597a159c266SJung-uk Kim 
598a159c266SJung-uk Kim     case ACPI_REGISTER_PM1_ENABLE:           /* PM1 A/B: 16-bit access each */
599a159c266SJung-uk Kim 
600a159c266SJung-uk Kim         Status = AcpiHwReadMultiple (&Value,
601a159c266SJung-uk Kim             &AcpiGbl_XPm1aEnable,
602a159c266SJung-uk Kim             &AcpiGbl_XPm1bEnable);
603a159c266SJung-uk Kim         break;
604a159c266SJung-uk Kim 
605a159c266SJung-uk Kim     case ACPI_REGISTER_PM1_CONTROL:          /* PM1 A/B: 16-bit access each */
606a159c266SJung-uk Kim 
607a159c266SJung-uk Kim         Status = AcpiHwReadMultiple (&Value,
608a159c266SJung-uk Kim             &AcpiGbl_FADT.XPm1aControlBlock,
609a159c266SJung-uk Kim             &AcpiGbl_FADT.XPm1bControlBlock);
610a159c266SJung-uk Kim 
611a159c266SJung-uk Kim         /*
612a159c266SJung-uk Kim          * Zero the write-only bits. From the ACPI specification, "Hardware
613a159c266SJung-uk Kim          * Write-Only Bits": "Upon reads to registers with write-only bits,
614a159c266SJung-uk Kim          * software masks out all write-only bits."
615a159c266SJung-uk Kim          */
616a159c266SJung-uk Kim         Value &= ~ACPI_PM1_CONTROL_WRITEONLY_BITS;
617a159c266SJung-uk Kim         break;
618a159c266SJung-uk Kim 
619a159c266SJung-uk Kim     case ACPI_REGISTER_PM2_CONTROL:          /* 8-bit access */
620a159c266SJung-uk Kim 
621a159c266SJung-uk Kim         Status = AcpiHwRead (&Value, &AcpiGbl_FADT.XPm2ControlBlock);
622a159c266SJung-uk Kim         break;
623a159c266SJung-uk Kim 
624a159c266SJung-uk Kim     case ACPI_REGISTER_PM_TIMER:             /* 32-bit access */
625a159c266SJung-uk Kim 
626a159c266SJung-uk Kim         Status = AcpiHwRead (&Value, &AcpiGbl_FADT.XPmTimerBlock);
627a159c266SJung-uk Kim         break;
628a159c266SJung-uk Kim 
629a159c266SJung-uk Kim     case ACPI_REGISTER_SMI_COMMAND_BLOCK:    /* 8-bit access */
630a159c266SJung-uk Kim 
631a159c266SJung-uk Kim         Status = AcpiHwReadPort (AcpiGbl_FADT.SmiCommand, &Value, 8);
632a159c266SJung-uk Kim         break;
633a159c266SJung-uk Kim 
634a159c266SJung-uk Kim     default:
635a9d8d09cSJung-uk Kim 
636a159c266SJung-uk Kim         ACPI_ERROR ((AE_INFO, "Unknown Register ID: 0x%X",
637a159c266SJung-uk Kim             RegisterId));
638a159c266SJung-uk Kim         Status = AE_BAD_PARAMETER;
639a159c266SJung-uk Kim         break;
640a159c266SJung-uk Kim     }
641a159c266SJung-uk Kim 
642a159c266SJung-uk Kim     if (ACPI_SUCCESS (Status))
643a159c266SJung-uk Kim     {
644a159c266SJung-uk Kim         *ReturnValue = Value;
645a159c266SJung-uk Kim     }
646a159c266SJung-uk Kim 
647a159c266SJung-uk Kim     return_ACPI_STATUS (Status);
648a159c266SJung-uk Kim }
649a159c266SJung-uk Kim 
650a159c266SJung-uk Kim 
651a159c266SJung-uk Kim /******************************************************************************
652a159c266SJung-uk Kim  *
653a159c266SJung-uk Kim  * FUNCTION:    AcpiHwRegisterWrite
654a159c266SJung-uk Kim  *
655a159c266SJung-uk Kim  * PARAMETERS:  RegisterId          - ACPI Register ID
656a159c266SJung-uk Kim  *              Value               - The value to write
657a159c266SJung-uk Kim  *
658a159c266SJung-uk Kim  * RETURN:      Status
659a159c266SJung-uk Kim  *
660a159c266SJung-uk Kim  * DESCRIPTION: Write to the specified ACPI register
661a159c266SJung-uk Kim  *
662a159c266SJung-uk Kim  * NOTE: In accordance with the ACPI specification, this function automatically
663a159c266SJung-uk Kim  * preserves the value of the following bits, meaning that these bits cannot be
664a159c266SJung-uk Kim  * changed via this interface:
665a159c266SJung-uk Kim  *
666a159c266SJung-uk Kim  * PM1_CONTROL[0] = SCI_EN
667a159c266SJung-uk Kim  * PM1_CONTROL[9]
668a159c266SJung-uk Kim  * PM1_STATUS[11]
669a159c266SJung-uk Kim  *
670a159c266SJung-uk Kim  * ACPI References:
671a159c266SJung-uk Kim  * 1) Hardware Ignored Bits: When software writes to a register with ignored
672a159c266SJung-uk Kim  *      bit fields, it preserves the ignored bit fields
673a159c266SJung-uk Kim  * 2) SCI_EN: OSPM always preserves this bit position
674a159c266SJung-uk Kim  *
675a159c266SJung-uk Kim  ******************************************************************************/
676a159c266SJung-uk Kim 
677a159c266SJung-uk Kim ACPI_STATUS
678a159c266SJung-uk Kim AcpiHwRegisterWrite (
679a159c266SJung-uk Kim     UINT32                  RegisterId,
680a159c266SJung-uk Kim     UINT32                  Value)
681a159c266SJung-uk Kim {
682a159c266SJung-uk Kim     ACPI_STATUS             Status;
683a159c266SJung-uk Kim     UINT32                  ReadValue;
684a159c266SJung-uk Kim 
685a159c266SJung-uk Kim 
686a159c266SJung-uk Kim     ACPI_FUNCTION_TRACE (HwRegisterWrite);
687a159c266SJung-uk Kim 
688a159c266SJung-uk Kim 
689a159c266SJung-uk Kim     switch (RegisterId)
690a159c266SJung-uk Kim     {
691a159c266SJung-uk Kim     case ACPI_REGISTER_PM1_STATUS:           /* PM1 A/B: 16-bit access each */
692a159c266SJung-uk Kim         /*
693a159c266SJung-uk Kim          * Handle the "ignored" bit in PM1 Status. According to the ACPI
694a159c266SJung-uk Kim          * specification, ignored bits are to be preserved when writing.
695a159c266SJung-uk Kim          * Normally, this would mean a read/modify/write sequence. However,
696a159c266SJung-uk Kim          * preserving a bit in the status register is different. Writing a
697a159c266SJung-uk Kim          * one clears the status, and writing a zero preserves the status.
698a159c266SJung-uk Kim          * Therefore, we must always write zero to the ignored bit.
699a159c266SJung-uk Kim          *
700a159c266SJung-uk Kim          * This behavior is clarified in the ACPI 4.0 specification.
701a159c266SJung-uk Kim          */
702a159c266SJung-uk Kim         Value &= ~ACPI_PM1_STATUS_PRESERVED_BITS;
703a159c266SJung-uk Kim 
704a159c266SJung-uk Kim         Status = AcpiHwWriteMultiple (Value,
705a159c266SJung-uk Kim             &AcpiGbl_XPm1aStatus,
706a159c266SJung-uk Kim             &AcpiGbl_XPm1bStatus);
707a159c266SJung-uk Kim         break;
708a159c266SJung-uk Kim 
709a159c266SJung-uk Kim     case ACPI_REGISTER_PM1_ENABLE:           /* PM1 A/B: 16-bit access each */
710a159c266SJung-uk Kim 
711a159c266SJung-uk Kim         Status = AcpiHwWriteMultiple (Value,
712a159c266SJung-uk Kim             &AcpiGbl_XPm1aEnable,
713a159c266SJung-uk Kim             &AcpiGbl_XPm1bEnable);
714a159c266SJung-uk Kim         break;
715a159c266SJung-uk Kim 
716a159c266SJung-uk Kim     case ACPI_REGISTER_PM1_CONTROL:          /* PM1 A/B: 16-bit access each */
717a159c266SJung-uk Kim         /*
718a159c266SJung-uk Kim          * Perform a read first to preserve certain bits (per ACPI spec)
719a159c266SJung-uk Kim          * Note: This includes SCI_EN, we never want to change this bit
720a159c266SJung-uk Kim          */
721a159c266SJung-uk Kim         Status = AcpiHwReadMultiple (&ReadValue,
722a159c266SJung-uk Kim             &AcpiGbl_FADT.XPm1aControlBlock,
723a159c266SJung-uk Kim             &AcpiGbl_FADT.XPm1bControlBlock);
724a159c266SJung-uk Kim         if (ACPI_FAILURE (Status))
725a159c266SJung-uk Kim         {
726a159c266SJung-uk Kim             goto Exit;
727a159c266SJung-uk Kim         }
728a159c266SJung-uk Kim 
729a159c266SJung-uk Kim         /* Insert the bits to be preserved */
730a159c266SJung-uk Kim 
731a159c266SJung-uk Kim         ACPI_INSERT_BITS (Value, ACPI_PM1_CONTROL_PRESERVED_BITS, ReadValue);
732a159c266SJung-uk Kim 
733a159c266SJung-uk Kim         /* Now we can write the data */
734a159c266SJung-uk Kim 
735a159c266SJung-uk Kim         Status = AcpiHwWriteMultiple (Value,
736a159c266SJung-uk Kim             &AcpiGbl_FADT.XPm1aControlBlock,
737a159c266SJung-uk Kim             &AcpiGbl_FADT.XPm1bControlBlock);
738a159c266SJung-uk Kim         break;
739a159c266SJung-uk Kim 
740a159c266SJung-uk Kim     case ACPI_REGISTER_PM2_CONTROL:          /* 8-bit access */
741a159c266SJung-uk Kim         /*
742a159c266SJung-uk Kim          * For control registers, all reserved bits must be preserved,
743a159c266SJung-uk Kim          * as per the ACPI spec.
744a159c266SJung-uk Kim          */
745a159c266SJung-uk Kim         Status = AcpiHwRead (&ReadValue, &AcpiGbl_FADT.XPm2ControlBlock);
746a159c266SJung-uk Kim         if (ACPI_FAILURE (Status))
747a159c266SJung-uk Kim         {
748a159c266SJung-uk Kim             goto Exit;
749a159c266SJung-uk Kim         }
750a159c266SJung-uk Kim 
751a159c266SJung-uk Kim         /* Insert the bits to be preserved */
752a159c266SJung-uk Kim 
753a159c266SJung-uk Kim         ACPI_INSERT_BITS (Value, ACPI_PM2_CONTROL_PRESERVED_BITS, ReadValue);
754a159c266SJung-uk Kim 
755a159c266SJung-uk Kim         Status = AcpiHwWrite (Value, &AcpiGbl_FADT.XPm2ControlBlock);
756a159c266SJung-uk Kim         break;
757a159c266SJung-uk Kim 
758a159c266SJung-uk Kim     case ACPI_REGISTER_PM_TIMER:             /* 32-bit access */
759a159c266SJung-uk Kim 
760a159c266SJung-uk Kim         Status = AcpiHwWrite (Value, &AcpiGbl_FADT.XPmTimerBlock);
761a159c266SJung-uk Kim         break;
762a159c266SJung-uk Kim 
763a159c266SJung-uk Kim     case ACPI_REGISTER_SMI_COMMAND_BLOCK:    /* 8-bit access */
764a159c266SJung-uk Kim 
765a159c266SJung-uk Kim         /* SMI_CMD is currently always in IO space */
766a159c266SJung-uk Kim 
767a159c266SJung-uk Kim         Status = AcpiHwWritePort (AcpiGbl_FADT.SmiCommand, Value, 8);
768a159c266SJung-uk Kim         break;
769a159c266SJung-uk Kim 
770a159c266SJung-uk Kim     default:
771a9d8d09cSJung-uk Kim 
772a159c266SJung-uk Kim         ACPI_ERROR ((AE_INFO, "Unknown Register ID: 0x%X",
773a159c266SJung-uk Kim             RegisterId));
774a159c266SJung-uk Kim         Status = AE_BAD_PARAMETER;
775a159c266SJung-uk Kim         break;
776a159c266SJung-uk Kim     }
777a159c266SJung-uk Kim 
778a159c266SJung-uk Kim Exit:
779a159c266SJung-uk Kim     return_ACPI_STATUS (Status);
780a159c266SJung-uk Kim }
781a159c266SJung-uk Kim 
782a159c266SJung-uk Kim 
783a159c266SJung-uk Kim /******************************************************************************
784a159c266SJung-uk Kim  *
785a159c266SJung-uk Kim  * FUNCTION:    AcpiHwReadMultiple
786a159c266SJung-uk Kim  *
787a159c266SJung-uk Kim  * PARAMETERS:  Value               - Where the register value is returned
788a159c266SJung-uk Kim  *              RegisterA           - First ACPI register (required)
789a159c266SJung-uk Kim  *              RegisterB           - Second ACPI register (optional)
790a159c266SJung-uk Kim  *
791a159c266SJung-uk Kim  * RETURN:      Status
792a159c266SJung-uk Kim  *
793a159c266SJung-uk Kim  * DESCRIPTION: Read from the specified two-part ACPI register (such as PM1 A/B)
794a159c266SJung-uk Kim  *
795a159c266SJung-uk Kim  ******************************************************************************/
796a159c266SJung-uk Kim 
797a159c266SJung-uk Kim static ACPI_STATUS
798a159c266SJung-uk Kim AcpiHwReadMultiple (
799a159c266SJung-uk Kim     UINT32                  *Value,
800a159c266SJung-uk Kim     ACPI_GENERIC_ADDRESS    *RegisterA,
801a159c266SJung-uk Kim     ACPI_GENERIC_ADDRESS    *RegisterB)
802a159c266SJung-uk Kim {
803a159c266SJung-uk Kim     UINT32                  ValueA = 0;
804a159c266SJung-uk Kim     UINT32                  ValueB = 0;
805a159c266SJung-uk Kim     ACPI_STATUS             Status;
806a159c266SJung-uk Kim 
807a159c266SJung-uk Kim 
808a159c266SJung-uk Kim     /* The first register is always required */
809a159c266SJung-uk Kim 
810a159c266SJung-uk Kim     Status = AcpiHwRead (&ValueA, RegisterA);
811a159c266SJung-uk Kim     if (ACPI_FAILURE (Status))
812a159c266SJung-uk Kim     {
813a159c266SJung-uk Kim         return (Status);
814a159c266SJung-uk Kim     }
815a159c266SJung-uk Kim 
816a159c266SJung-uk Kim     /* Second register is optional */
817a159c266SJung-uk Kim 
818a159c266SJung-uk Kim     if (RegisterB->Address)
819a159c266SJung-uk Kim     {
820a159c266SJung-uk Kim         Status = AcpiHwRead (&ValueB, RegisterB);
821a159c266SJung-uk Kim         if (ACPI_FAILURE (Status))
822a159c266SJung-uk Kim         {
823a159c266SJung-uk Kim             return (Status);
824a159c266SJung-uk Kim         }
825a159c266SJung-uk Kim     }
826a159c266SJung-uk Kim 
827a159c266SJung-uk Kim     /*
828a159c266SJung-uk Kim      * OR the two return values together. No shifting or masking is necessary,
829a159c266SJung-uk Kim      * because of how the PM1 registers are defined in the ACPI specification:
830a159c266SJung-uk Kim      *
831a159c266SJung-uk Kim      * "Although the bits can be split between the two register blocks (each
832a159c266SJung-uk Kim      * register block has a unique pointer within the FADT), the bit positions
833a159c266SJung-uk Kim      * are maintained. The register block with unimplemented bits (that is,
834a159c266SJung-uk Kim      * those implemented in the other register block) always returns zeros,
835a159c266SJung-uk Kim      * and writes have no side effects"
836a159c266SJung-uk Kim      */
837a159c266SJung-uk Kim     *Value = (ValueA | ValueB);
838a159c266SJung-uk Kim     return (AE_OK);
839a159c266SJung-uk Kim }
840a159c266SJung-uk Kim 
841a159c266SJung-uk Kim 
842a159c266SJung-uk Kim /******************************************************************************
843a159c266SJung-uk Kim  *
844a159c266SJung-uk Kim  * FUNCTION:    AcpiHwWriteMultiple
845a159c266SJung-uk Kim  *
846a159c266SJung-uk Kim  * PARAMETERS:  Value               - The value to write
847a159c266SJung-uk Kim  *              RegisterA           - First ACPI register (required)
848a159c266SJung-uk Kim  *              RegisterB           - Second ACPI register (optional)
849a159c266SJung-uk Kim  *
850a159c266SJung-uk Kim  * RETURN:      Status
851a159c266SJung-uk Kim  *
852a159c266SJung-uk Kim  * DESCRIPTION: Write to the specified two-part ACPI register (such as PM1 A/B)
853a159c266SJung-uk Kim  *
854a159c266SJung-uk Kim  ******************************************************************************/
855a159c266SJung-uk Kim 
856a159c266SJung-uk Kim static ACPI_STATUS
857a159c266SJung-uk Kim AcpiHwWriteMultiple (
858a159c266SJung-uk Kim     UINT32                  Value,
859a159c266SJung-uk Kim     ACPI_GENERIC_ADDRESS    *RegisterA,
860a159c266SJung-uk Kim     ACPI_GENERIC_ADDRESS    *RegisterB)
861a159c266SJung-uk Kim {
862a159c266SJung-uk Kim     ACPI_STATUS             Status;
863a159c266SJung-uk Kim 
864a159c266SJung-uk Kim 
865a159c266SJung-uk Kim     /* The first register is always required */
866a159c266SJung-uk Kim 
867a159c266SJung-uk Kim     Status = AcpiHwWrite (Value, RegisterA);
868a159c266SJung-uk Kim     if (ACPI_FAILURE (Status))
869a159c266SJung-uk Kim     {
870a159c266SJung-uk Kim         return (Status);
871a159c266SJung-uk Kim     }
872a159c266SJung-uk Kim 
873a159c266SJung-uk Kim     /*
874a159c266SJung-uk Kim      * Second register is optional
875a159c266SJung-uk Kim      *
876a159c266SJung-uk Kim      * No bit shifting or clearing is necessary, because of how the PM1
877a159c266SJung-uk Kim      * registers are defined in the ACPI specification:
878a159c266SJung-uk Kim      *
879a159c266SJung-uk Kim      * "Although the bits can be split between the two register blocks (each
880a159c266SJung-uk Kim      * register block has a unique pointer within the FADT), the bit positions
881a159c266SJung-uk Kim      * are maintained. The register block with unimplemented bits (that is,
882a159c266SJung-uk Kim      * those implemented in the other register block) always returns zeros,
883a159c266SJung-uk Kim      * and writes have no side effects"
884a159c266SJung-uk Kim      */
885a159c266SJung-uk Kim     if (RegisterB->Address)
886a159c266SJung-uk Kim     {
887a159c266SJung-uk Kim         Status = AcpiHwWrite (Value, RegisterB);
888a159c266SJung-uk Kim     }
889a159c266SJung-uk Kim 
890a159c266SJung-uk Kim     return (Status);
891a159c266SJung-uk Kim }
892a159c266SJung-uk Kim 
893a159c266SJung-uk Kim #endif /* !ACPI_REDUCED_HARDWARE */
894