1
2 /******************************************************************************
3 *
4 * Module Name: hwgpe - Low level GPE enable/disable/clear functions
5 *
6 *****************************************************************************/
7
8 /******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999 - 2009, Intel Corp.
13 * All rights reserved.
14 *
15 * 2. License
16 *
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights. You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
20 * property rights.
21 *
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
28 *
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code. No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
37 *
38 * The above copyright and patent license is granted only if the following
39 * conditions are met:
40 *
41 * 3. Conditions
42 *
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision. In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change. Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee. Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
54 *
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution. In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
65 * make.
66 *
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
71 * distribution.
72 *
73 * 3.4. Intel retains all right, title, and interest in and to the Original
74 * Intel Code.
75 *
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
80 *
81 * 4. Disclaimer and Export Compliance
82 *
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
89 * PARTICULAR PURPOSE.
90 *
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
98 * LIMITED REMEDY.
99 *
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government. In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
114 *
115 *****************************************************************************/
116
117 #include "acpi.h"
118 #include "accommon.h"
119 #include "acevents.h"
120
121 #define _COMPONENT ACPI_HARDWARE
122 ACPI_MODULE_NAME ("hwgpe")
123
124 /* Local prototypes */
125
126 static ACPI_STATUS
127 AcpiHwEnableWakeupGpeBlock (
128 ACPI_GPE_XRUPT_INFO *GpeXruptInfo,
129 ACPI_GPE_BLOCK_INFO *GpeBlock,
130 void *Context);
131
132
133 /******************************************************************************
134 *
135 * FUNCTION: AcpiHwLowDisableGpe
136 *
137 * PARAMETERS: GpeEventInfo - Info block for the GPE to be disabled
138 *
139 * RETURN: Status
140 *
141 * DESCRIPTION: Disable a single GPE in the enable register.
142 *
143 ******************************************************************************/
144
145 ACPI_STATUS
AcpiHwLowDisableGpe(ACPI_GPE_EVENT_INFO * GpeEventInfo)146 AcpiHwLowDisableGpe (
147 ACPI_GPE_EVENT_INFO *GpeEventInfo)
148 {
149 ACPI_GPE_REGISTER_INFO *GpeRegisterInfo;
150 ACPI_STATUS Status;
151 UINT32 EnableMask;
152
153
154 /* Get the info block for the entire GPE register */
155
156 GpeRegisterInfo = GpeEventInfo->RegisterInfo;
157 if (!GpeRegisterInfo)
158 {
159 return (AE_NOT_EXIST);
160 }
161
162 /* Get current value of the enable register that contains this GPE */
163
164 Status = AcpiHwRead (&EnableMask, &GpeRegisterInfo->EnableAddress);
165 if (ACPI_FAILURE (Status))
166 {
167 return (Status);
168 }
169
170 /* Clear just the bit that corresponds to this GPE */
171
172 ACPI_CLEAR_BIT (EnableMask, ((UINT32) 1 <<
173 (GpeEventInfo->GpeNumber - GpeRegisterInfo->BaseGpeNumber)));
174
175
176 /* Write the updated enable mask */
177
178 Status = AcpiHwWrite (EnableMask, &GpeRegisterInfo->EnableAddress);
179 return (Status);
180 }
181
182
183 /******************************************************************************
184 *
185 * FUNCTION: AcpiHwWriteGpeEnableReg
186 *
187 * PARAMETERS: GpeEventInfo - Info block for the GPE to be enabled
188 *
189 * RETURN: Status
190 *
191 * DESCRIPTION: Write a GPE enable register. Note: The bit for this GPE must
192 * already be cleared or set in the parent register
193 * EnableForRun mask.
194 *
195 ******************************************************************************/
196
197 ACPI_STATUS
AcpiHwWriteGpeEnableReg(ACPI_GPE_EVENT_INFO * GpeEventInfo)198 AcpiHwWriteGpeEnableReg (
199 ACPI_GPE_EVENT_INFO *GpeEventInfo)
200 {
201 ACPI_GPE_REGISTER_INFO *GpeRegisterInfo;
202 ACPI_STATUS Status;
203
204
205 ACPI_FUNCTION_ENTRY ();
206
207
208 /* Get the info block for the entire GPE register */
209
210 GpeRegisterInfo = GpeEventInfo->RegisterInfo;
211 if (!GpeRegisterInfo)
212 {
213 return (AE_NOT_EXIST);
214 }
215
216 /* Write the entire GPE (runtime) enable register */
217
218 Status = AcpiHwWrite (GpeRegisterInfo->EnableForRun,
219 &GpeRegisterInfo->EnableAddress);
220
221 return (Status);
222 }
223
224
225 /******************************************************************************
226 *
227 * FUNCTION: AcpiHwClearGpe
228 *
229 * PARAMETERS: GpeEventInfo - Info block for the GPE to be cleared
230 *
231 * RETURN: Status
232 *
233 * DESCRIPTION: Clear the status bit for a single GPE.
234 *
235 ******************************************************************************/
236
237 ACPI_STATUS
AcpiHwClearGpe(ACPI_GPE_EVENT_INFO * GpeEventInfo)238 AcpiHwClearGpe (
239 ACPI_GPE_EVENT_INFO *GpeEventInfo)
240 {
241 ACPI_STATUS Status;
242 UINT8 RegisterBit;
243
244
245 ACPI_FUNCTION_ENTRY ();
246
247
248 RegisterBit = (UINT8) (1 <<
249 (GpeEventInfo->GpeNumber - GpeEventInfo->RegisterInfo->BaseGpeNumber));
250
251 /*
252 * Write a one to the appropriate bit in the status register to
253 * clear this GPE.
254 */
255 Status = AcpiHwWrite (RegisterBit,
256 &GpeEventInfo->RegisterInfo->StatusAddress);
257
258 return (Status);
259 }
260
261
262 /******************************************************************************
263 *
264 * FUNCTION: AcpiHwGetGpeStatus
265 *
266 * PARAMETERS: GpeEventInfo - Info block for the GPE to queried
267 * EventStatus - Where the GPE status is returned
268 *
269 * RETURN: Status
270 *
271 * DESCRIPTION: Return the status of a single GPE.
272 *
273 ******************************************************************************/
274
275 ACPI_STATUS
AcpiHwGetGpeStatus(ACPI_GPE_EVENT_INFO * GpeEventInfo,ACPI_EVENT_STATUS * EventStatus)276 AcpiHwGetGpeStatus (
277 ACPI_GPE_EVENT_INFO *GpeEventInfo,
278 ACPI_EVENT_STATUS *EventStatus)
279 {
280 UINT32 InByte;
281 UINT8 RegisterBit;
282 ACPI_GPE_REGISTER_INFO *GpeRegisterInfo;
283 ACPI_STATUS Status;
284 ACPI_EVENT_STATUS LocalEventStatus = 0;
285
286
287 ACPI_FUNCTION_ENTRY ();
288
289
290 if (!EventStatus)
291 {
292 return (AE_BAD_PARAMETER);
293 }
294
295 /* Get the info block for the entire GPE register */
296
297 GpeRegisterInfo = GpeEventInfo->RegisterInfo;
298
299 /* Get the register bitmask for this GPE */
300
301 RegisterBit = (UINT8) (1 <<
302 (GpeEventInfo->GpeNumber - GpeEventInfo->RegisterInfo->BaseGpeNumber));
303
304 /* GPE currently enabled? (enabled for runtime?) */
305
306 if (RegisterBit & GpeRegisterInfo->EnableForRun)
307 {
308 LocalEventStatus |= ACPI_EVENT_FLAG_ENABLED;
309 }
310
311 /* GPE enabled for wake? */
312
313 if (RegisterBit & GpeRegisterInfo->EnableForWake)
314 {
315 LocalEventStatus |= ACPI_EVENT_FLAG_WAKE_ENABLED;
316 }
317
318 /* GPE currently active (status bit == 1)? */
319
320 Status = AcpiHwRead (&InByte, &GpeRegisterInfo->StatusAddress);
321 if (ACPI_FAILURE (Status))
322 {
323 goto UnlockAndExit;
324 }
325
326 if (RegisterBit & InByte)
327 {
328 LocalEventStatus |= ACPI_EVENT_FLAG_SET;
329 }
330
331 /* Set return value */
332
333 (*EventStatus) = LocalEventStatus;
334
335
336 UnlockAndExit:
337 return (Status);
338 }
339
340
341 /******************************************************************************
342 *
343 * FUNCTION: AcpiHwDisableGpeBlock
344 *
345 * PARAMETERS: GpeXruptInfo - GPE Interrupt info
346 * GpeBlock - Gpe Block info
347 *
348 * RETURN: Status
349 *
350 * DESCRIPTION: Disable all GPEs within a single GPE block
351 *
352 ******************************************************************************/
353
354 ACPI_STATUS
AcpiHwDisableGpeBlock(ACPI_GPE_XRUPT_INFO * GpeXruptInfo,ACPI_GPE_BLOCK_INFO * GpeBlock,void * Context)355 AcpiHwDisableGpeBlock (
356 ACPI_GPE_XRUPT_INFO *GpeXruptInfo,
357 ACPI_GPE_BLOCK_INFO *GpeBlock,
358 void *Context)
359 {
360 UINT32 i;
361 ACPI_STATUS Status;
362
363
364 /* Examine each GPE Register within the block */
365
366 for (i = 0; i < GpeBlock->RegisterCount; i++)
367 {
368 /* Disable all GPEs in this register */
369
370 Status = AcpiHwWrite (0x00, &GpeBlock->RegisterInfo[i].EnableAddress);
371 if (ACPI_FAILURE (Status))
372 {
373 return (Status);
374 }
375 }
376
377 return (AE_OK);
378 }
379
380
381 /******************************************************************************
382 *
383 * FUNCTION: AcpiHwClearGpeBlock
384 *
385 * PARAMETERS: GpeXruptInfo - GPE Interrupt info
386 * GpeBlock - Gpe Block info
387 *
388 * RETURN: Status
389 *
390 * DESCRIPTION: Clear status bits for all GPEs within a single GPE block
391 *
392 ******************************************************************************/
393
394 ACPI_STATUS
AcpiHwClearGpeBlock(ACPI_GPE_XRUPT_INFO * GpeXruptInfo,ACPI_GPE_BLOCK_INFO * GpeBlock,void * Context)395 AcpiHwClearGpeBlock (
396 ACPI_GPE_XRUPT_INFO *GpeXruptInfo,
397 ACPI_GPE_BLOCK_INFO *GpeBlock,
398 void *Context)
399 {
400 UINT32 i;
401 ACPI_STATUS Status;
402
403
404 /* Examine each GPE Register within the block */
405
406 for (i = 0; i < GpeBlock->RegisterCount; i++)
407 {
408 /* Clear status on all GPEs in this register */
409
410 Status = AcpiHwWrite (0xFF, &GpeBlock->RegisterInfo[i].StatusAddress);
411 if (ACPI_FAILURE (Status))
412 {
413 return (Status);
414 }
415 }
416
417 return (AE_OK);
418 }
419
420
421 /******************************************************************************
422 *
423 * FUNCTION: AcpiHwEnableRuntimeGpeBlock
424 *
425 * PARAMETERS: GpeXruptInfo - GPE Interrupt info
426 * GpeBlock - Gpe Block info
427 *
428 * RETURN: Status
429 *
430 * DESCRIPTION: Enable all "runtime" GPEs within a single GPE block. Includes
431 * combination wake/run GPEs.
432 *
433 ******************************************************************************/
434
435 ACPI_STATUS
AcpiHwEnableRuntimeGpeBlock(ACPI_GPE_XRUPT_INFO * GpeXruptInfo,ACPI_GPE_BLOCK_INFO * GpeBlock,void * Context)436 AcpiHwEnableRuntimeGpeBlock (
437 ACPI_GPE_XRUPT_INFO *GpeXruptInfo,
438 ACPI_GPE_BLOCK_INFO *GpeBlock,
439 void *Context)
440 {
441 UINT32 i;
442 ACPI_STATUS Status;
443
444
445 /* NOTE: assumes that all GPEs are currently disabled */
446
447 /* Examine each GPE Register within the block */
448
449 for (i = 0; i < GpeBlock->RegisterCount; i++)
450 {
451 if (!GpeBlock->RegisterInfo[i].EnableForRun)
452 {
453 continue;
454 }
455
456 /* Enable all "runtime" GPEs in this register */
457
458 Status = AcpiHwWrite (GpeBlock->RegisterInfo[i].EnableForRun,
459 &GpeBlock->RegisterInfo[i].EnableAddress);
460 if (ACPI_FAILURE (Status))
461 {
462 return (Status);
463 }
464 }
465
466 return (AE_OK);
467 }
468
469
470 /******************************************************************************
471 *
472 * FUNCTION: AcpiHwEnableWakeupGpeBlock
473 *
474 * PARAMETERS: GpeXruptInfo - GPE Interrupt info
475 * GpeBlock - Gpe Block info
476 *
477 * RETURN: Status
478 *
479 * DESCRIPTION: Enable all "wake" GPEs within a single GPE block. Includes
480 * combination wake/run GPEs.
481 *
482 ******************************************************************************/
483
484 static ACPI_STATUS
AcpiHwEnableWakeupGpeBlock(ACPI_GPE_XRUPT_INFO * GpeXruptInfo,ACPI_GPE_BLOCK_INFO * GpeBlock,void * Context)485 AcpiHwEnableWakeupGpeBlock (
486 ACPI_GPE_XRUPT_INFO *GpeXruptInfo,
487 ACPI_GPE_BLOCK_INFO *GpeBlock,
488 void *Context)
489 {
490 UINT32 i;
491 ACPI_STATUS Status;
492
493
494 /* Examine each GPE Register within the block */
495
496 for (i = 0; i < GpeBlock->RegisterCount; i++)
497 {
498 if (!GpeBlock->RegisterInfo[i].EnableForWake)
499 {
500 continue;
501 }
502
503 /* Enable all "wake" GPEs in this register */
504
505 Status = AcpiHwWrite (GpeBlock->RegisterInfo[i].EnableForWake,
506 &GpeBlock->RegisterInfo[i].EnableAddress);
507 if (ACPI_FAILURE (Status))
508 {
509 return (Status);
510 }
511 }
512
513 return (AE_OK);
514 }
515
516
517 /******************************************************************************
518 *
519 * FUNCTION: AcpiHwDisableAllGpes
520 *
521 * PARAMETERS: None
522 *
523 * RETURN: Status
524 *
525 * DESCRIPTION: Disable and clear all GPEs in all GPE blocks
526 *
527 ******************************************************************************/
528
529 ACPI_STATUS
AcpiHwDisableAllGpes(void)530 AcpiHwDisableAllGpes (
531 void)
532 {
533 ACPI_STATUS Status;
534
535
536 ACPI_FUNCTION_TRACE (HwDisableAllGpes);
537
538
539 Status = AcpiEvWalkGpeList (AcpiHwDisableGpeBlock, NULL);
540 Status = AcpiEvWalkGpeList (AcpiHwClearGpeBlock, NULL);
541 return_ACPI_STATUS (Status);
542 }
543
544
545 /******************************************************************************
546 *
547 * FUNCTION: AcpiHwEnableAllRuntimeGpes
548 *
549 * PARAMETERS: None
550 *
551 * RETURN: Status
552 *
553 * DESCRIPTION: Enable all "runtime" GPEs, in all GPE blocks
554 *
555 ******************************************************************************/
556
557 ACPI_STATUS
AcpiHwEnableAllRuntimeGpes(void)558 AcpiHwEnableAllRuntimeGpes (
559 void)
560 {
561 ACPI_STATUS Status;
562
563
564 ACPI_FUNCTION_TRACE (HwEnableAllRuntimeGpes);
565
566
567 Status = AcpiEvWalkGpeList (AcpiHwEnableRuntimeGpeBlock, NULL);
568 return_ACPI_STATUS (Status);
569 }
570
571
572 /******************************************************************************
573 *
574 * FUNCTION: AcpiHwEnableAllWakeupGpes
575 *
576 * PARAMETERS: None
577 *
578 * RETURN: Status
579 *
580 * DESCRIPTION: Enable all "wakeup" GPEs, in all GPE blocks
581 *
582 ******************************************************************************/
583
584 ACPI_STATUS
AcpiHwEnableAllWakeupGpes(void)585 AcpiHwEnableAllWakeupGpes (
586 void)
587 {
588 ACPI_STATUS Status;
589
590
591 ACPI_FUNCTION_TRACE (HwEnableAllWakeupGpes);
592
593
594 Status = AcpiEvWalkGpeList (AcpiHwEnableWakeupGpeBlock, NULL);
595 return_ACPI_STATUS (Status);
596 }
597
598