]>
Commit | Line | Data |
---|---|---|
2ef2b01e A |
1 | /** @file\r |
2 | Abstraction for hardware based interrupt routine\r | |
3402aac7 | 3 | \r |
2ef2b01e A |
4 | On non IA-32 systems it is common to have a single hardware interrupt vector\r |
5 | and a 2nd layer of software that routes the interrupt handlers based on the\r | |
3402aac7 RC |
6 | interrupt source. This protocol enables this routing. The driver implementing\r |
7 | this protocol is responsible for clearing the pending interrupt in the\r | |
8 | interrupt routing hardware. The HARDWARE_INTERRUPT_HANDLER is responsible\r | |
2ef2b01e A |
9 | for clearing interrupt sources from individual devices.\r |
10 | \r | |
11 | \r | |
60274cca | 12 | Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>\r |
2ef2b01e | 13 | \r |
878b807a | 14 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
2ef2b01e A |
15 | \r |
16 | **/\r | |
17 | \r | |
18 | #ifndef __HARDWARE_INTERRUPT_H__\r | |
19 | #define __HARDWARE_INTERRUPT_H__\r | |
20 | \r | |
21 | #include <Protocol/DebugSupport.h>\r | |
22 | \r | |
2ef2b01e A |
23 | //\r |
24 | // Protocol GUID\r | |
25 | //\r | |
26 | // EAB39028-3D05-4316-AD0C-D64808DA3FF1\r | |
27 | \r | |
28 | #define EFI_HARDWARE_INTERRUPT_PROTOCOL_GGUID \\r | |
29 | { 0x2890B3EA, 0x053D, 0x1643, { 0xAD, 0x0C, 0xD6, 0x48, 0x08, 0xDA, 0x3F, 0xF1 } }\r | |
30 | \r | |
2ef2b01e A |
31 | typedef struct _EFI_HARDWARE_INTERRUPT_PROTOCOL EFI_HARDWARE_INTERRUPT_PROTOCOL;\r |
32 | \r | |
2ef2b01e A |
33 | typedef UINTN HARDWARE_INTERRUPT_SOURCE;\r |
34 | \r | |
2ef2b01e A |
35 | /**\r |
36 | C Interrupt Handler calledin the interrupt context when Source interrupt is active.\r | |
37 | \r | |
38 | @param Source Source of the interrupt. Hardware routing off a specific platform defines\r | |
39 | what source means.\r | |
40 | @param SystemContext Pointer to system register context. Mostly used by debuggers and will\r | |
3402aac7 | 41 | update the system context after the return from the interrupt if\r |
2ef2b01e A |
42 | modified. Don't change these values unless you know what you are doing\r |
43 | \r | |
44 | **/\r | |
45 | typedef\r | |
46 | VOID\r | |
e7108d0e | 47 | (EFIAPI *HARDWARE_INTERRUPT_HANDLER)(\r |
2ef2b01e | 48 | IN HARDWARE_INTERRUPT_SOURCE Source,\r |
3402aac7 | 49 | IN EFI_SYSTEM_CONTEXT SystemContext\r |
2ef2b01e A |
50 | );\r |
51 | \r | |
2ef2b01e A |
52 | /**\r |
53 | Register Handler for the specified interrupt source.\r | |
54 | \r | |
55 | @param This Instance pointer for this protocol\r | |
56 | @param Source Hardware source of the interrupt\r | |
57 | @param Handler Callback for interrupt. NULL to unregister\r | |
58 | \r | |
59 | @retval EFI_SUCCESS Source was updated to support Handler.\r | |
60 | @retval EFI_DEVICE_ERROR Hardware could not be programmed.\r | |
61 | \r | |
62 | **/\r | |
63 | typedef\r | |
64 | EFI_STATUS\r | |
e7108d0e | 65 | (EFIAPI *HARDWARE_INTERRUPT_REGISTER)(\r |
2ef2b01e A |
66 | IN EFI_HARDWARE_INTERRUPT_PROTOCOL *This,\r |
67 | IN HARDWARE_INTERRUPT_SOURCE Source,\r | |
68 | IN HARDWARE_INTERRUPT_HANDLER Handler\r | |
69 | );\r | |
70 | \r | |
2ef2b01e A |
71 | /**\r |
72 | Enable interrupt source Source.\r | |
73 | \r | |
74 | @param This Instance pointer for this protocol\r | |
75 | @param Source Hardware source of the interrupt\r | |
76 | \r | |
77 | @retval EFI_SUCCESS Source interrupt enabled.\r | |
78 | @retval EFI_DEVICE_ERROR Hardware could not be programmed.\r | |
79 | \r | |
80 | **/\r | |
81 | typedef\r | |
82 | EFI_STATUS\r | |
e7108d0e | 83 | (EFIAPI *HARDWARE_INTERRUPT_ENABLE)(\r |
2ef2b01e A |
84 | IN EFI_HARDWARE_INTERRUPT_PROTOCOL *This,\r |
85 | IN HARDWARE_INTERRUPT_SOURCE Source\r | |
86 | );\r | |
87 | \r | |
2ef2b01e A |
88 | /**\r |
89 | Disable interrupt source Source.\r | |
90 | \r | |
91 | @param This Instance pointer for this protocol\r | |
92 | @param Source Hardware source of the interrupt\r | |
93 | \r | |
94 | @retval EFI_SUCCESS Source interrupt disabled.\r | |
95 | @retval EFI_DEVICE_ERROR Hardware could not be programmed.\r | |
96 | \r | |
97 | **/\r | |
98 | typedef\r | |
99 | EFI_STATUS\r | |
e7108d0e | 100 | (EFIAPI *HARDWARE_INTERRUPT_DISABLE)(\r |
2ef2b01e A |
101 | IN EFI_HARDWARE_INTERRUPT_PROTOCOL *This,\r |
102 | IN HARDWARE_INTERRUPT_SOURCE Source\r | |
103 | );\r | |
104 | \r | |
2ef2b01e A |
105 | /**\r |
106 | Return current state of interrupt source Source.\r | |
107 | \r | |
108 | @param This Instance pointer for this protocol\r | |
109 | @param Source Hardware source of the interrupt\r | |
110 | @param InterruptState TRUE: source enabled, FALSE: source disabled.\r | |
111 | \r | |
112 | @retval EFI_SUCCESS InterruptState is valid\r | |
113 | @retval EFI_DEVICE_ERROR InterruptState is not valid\r | |
114 | \r | |
115 | **/\r | |
116 | typedef\r | |
117 | EFI_STATUS\r | |
e7108d0e | 118 | (EFIAPI *HARDWARE_INTERRUPT_INTERRUPT_STATE)(\r |
2ef2b01e A |
119 | IN EFI_HARDWARE_INTERRUPT_PROTOCOL *This,\r |
120 | IN HARDWARE_INTERRUPT_SOURCE Source,\r | |
3402aac7 | 121 | IN BOOLEAN *InterruptState\r |
753816a3 | 122 | );\r |
123 | \r | |
124 | /**\r | |
c6a72cd7 | 125 | Signal to the hardware that the End Of Interrupt state\r |
753816a3 | 126 | has been reached.\r |
127 | \r | |
128 | @param This Instance pointer for this protocol\r | |
129 | @param Source Hardware source of the interrupt\r | |
130 | \r | |
131 | @retval EFI_SUCCESS Source interrupt EOI'ed.\r | |
132 | @retval EFI_DEVICE_ERROR Hardware could not be programmed.\r | |
133 | \r | |
134 | **/\r | |
135 | typedef\r | |
136 | EFI_STATUS\r | |
e7108d0e | 137 | (EFIAPI *HARDWARE_INTERRUPT_END_OF_INTERRUPT)(\r |
753816a3 | 138 | IN EFI_HARDWARE_INTERRUPT_PROTOCOL *This,\r |
139 | IN HARDWARE_INTERRUPT_SOURCE Source\r | |
2ef2b01e A |
140 | );\r |
141 | \r | |
2ef2b01e | 142 | struct _EFI_HARDWARE_INTERRUPT_PROTOCOL {\r |
e7108d0e MK |
143 | HARDWARE_INTERRUPT_REGISTER RegisterInterruptSource;\r |
144 | HARDWARE_INTERRUPT_ENABLE EnableInterruptSource;\r | |
145 | HARDWARE_INTERRUPT_DISABLE DisableInterruptSource;\r | |
146 | HARDWARE_INTERRUPT_INTERRUPT_STATE GetInterruptSourceState;\r | |
147 | HARDWARE_INTERRUPT_END_OF_INTERRUPT EndOfInterrupt;\r | |
2ef2b01e A |
148 | };\r |
149 | \r | |
e7108d0e | 150 | extern EFI_GUID gHardwareInterruptProtocolGuid;\r |
2ef2b01e A |
151 | \r |
152 | #endif\r |