]> git.proxmox.com Git - mirror_edk2.git/blob - IntelFrameworkPkg/Include/Protocol/SmmIchnDispatch.h
Update to BSD license header.
[mirror_edk2.git] / IntelFrameworkPkg / Include / Protocol / SmmIchnDispatch.h
1 /** @file
2 This file declares EFI Smm ICH [N] Specific Smi Child Protocol
3
4 Copyright (c) 2007, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
9
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12
13 Module Name: SmmIchnDispatch.h
14
15 @par Revision Reference:
16 This Protocol is defined in Framework of EFI SMM Core Interface Spec
17 Version 0.9.
18
19 **/
20
21 #ifndef _EFI_SMM_ICHN_DISPATCH_H_
22 #define _EFI_SMM_ICHN_DISPATCH_H_
23
24 #include <PiDxe.h>
25
26 //
27 // Global ID for the ICH SMI Protocol
28 //
29 #define EFI_SMM_ICHN_DISPATCH_PROTOCOL_GUID \
30 { \
31 0xc50b323e, 0x9075, 0x4f2a, {0xac, 0x8e, 0xd2, 0x59, 0x6a, 0x10, 0x85, 0xcc } \
32 }
33
34 typedef struct _EFI_SMM_ICHN_DISPATCH_PROTOCOL EFI_SMM_ICHN_DISPATCH_PROTOCOL;
35
36 //
37 // Related Definitions
38 //
39 //
40 // ICHN Specific SMIs. These are miscellaneous SMI sources that are supported by the
41 // ICHN specific SMI implementation. These may change over time. TrapNumber is only
42 // valid if the Type is Trap.
43 //
44 typedef enum {
45 //
46 // NOTE: NEVER delete items from this list/enumeration! Doing so will prevent other versions
47 // of the code from compiling. If the ICH version your driver is written for doesn't support
48 // some of these SMIs, then simply return EFI_UNSUPPORTED when a child/client tries to register
49 // for them.
50 //
51 IchnMch,
52 IchnPme,
53 IchnRtcAlarm,
54 IchnRingIndicate,
55 IchnAc97Wake,
56 IchnSerialIrq,
57 IchnY2KRollover,
58 IchnTcoTimeout,
59 IchnOsTco,
60 IchnNmi,
61 IchnIntruderDetect,
62 IchnBiosWp,
63 IchnMcSmi,
64 IchnPmeB0,
65 IchnThrmSts,
66 IchnSmBus,
67 IchnIntelUsb2,
68 IchnMonSmi7,
69 IchnMonSmi6,
70 IchnMonSmi5,
71 IchnMonSmi4,
72 IchnDevTrap13,
73 IchnDevTrap12,
74 IchnDevTrap11,
75 IchnDevTrap10,
76 IchnDevTrap9,
77 IchnDevTrap8,
78 IchnDevTrap7,
79 IchnDevTrap6,
80 IchnDevTrap5,
81 IchnDevTrap3,
82 IchnDevTrap2,
83 IchnDevTrap1,
84 IchnDevTrap0,
85 IchnIoTrap3,
86 IchnIoTrap2,
87 IchnIoTrap1,
88 IchnIoTrap0,
89 //
90 // INSERT NEW ITEMS JUST BEFORE THIS LINE
91 //
92 NUM_ICHN_TYPES // the number of items in this enumeration
93 } EFI_SMM_ICHN_SMI_TYPE;
94
95 typedef struct {
96 EFI_SMM_ICHN_SMI_TYPE Type;
97 } EFI_SMM_ICHN_DISPATCH_CONTEXT;
98
99 //
100 // Member functions
101 //
102 /**
103 Dispatch function for a ICH n specific SMI handler.
104
105 @param DispatchHandle Handle of this dispatch function.
106 @param DispatchContext Pointer to the dispatch function's context.
107 The DispatchContext fields are filled in
108 by the dispatching driver prior to
109 invoking this dispatch function.
110
111 Nothing
112
113 **/
114 typedef
115 VOID
116 (EFIAPI *EFI_SMM_ICHN_DISPATCH) (
117 IN EFI_HANDLE DispatchHandle,
118 IN EFI_SMM_ICHN_DISPATCH_CONTEXT *DispatchContext
119 );
120
121 /**
122 Register a child SMI source dispatch function with a parent SMM driver
123
124 @param This Protocol instance pointer.
125 @param DispatchFunction Pointer to dispatch function to be invoked for
126 this SMI source
127 @param DispatchContext Pointer to the dispatch function's context.
128 The caller fills this context in before calling
129 the register function to indicate to the register
130 function the ICHN SMI source for which the dispatch
131 function should be invoked.
132 @param DispatchHandle Handle of dispatch function, for when interfacing
133 with the parent Sx state SMM driver.
134
135 @retval EFI_SUCCESS The dispatch function has been successfully
136 registered and the SMI source has been enabled.
137 @retval EFI_DEVICE_ERROR The driver was unable to enable the SMI source.
138 @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
139 child.
140 @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The ICHN input value
141 is not within valid range.
142
143 **/
144 typedef
145 EFI_STATUS
146 (EFIAPI *EFI_SMM_ICHN_REGISTER) (
147 IN EFI_SMM_ICHN_DISPATCH_PROTOCOL *This,
148 IN EFI_SMM_ICHN_DISPATCH DispatchFunction,
149 IN EFI_SMM_ICHN_DISPATCH_CONTEXT *DispatchContext,
150 OUT EFI_HANDLE *DispatchHandle
151 );
152
153 /**
154 Unregister a child SMI source dispatch function with a parent SMM driver
155
156 @param This Protocol instance pointer.
157 @param DispatchHandle Handle of dispatch function to deregister.
158
159 @retval EFI_SUCCESS The dispatch function has been successfully
160 unregistered and the SMI source has been disabled
161 if there are no other registered child dispatch
162 functions for this SMI source.
163 @retval EFI_INVALID_PARAMETER Handle is invalid.
164 @retval other TBD
165
166 **/
167 typedef
168 EFI_STATUS
169 (EFIAPI *EFI_SMM_ICHN_UNREGISTER) (
170 IN EFI_SMM_ICHN_DISPATCH_PROTOCOL *This,
171 IN EFI_HANDLE DispatchHandle
172 );
173
174 //
175 // Interface structure for the SMM Ich n specific SMI Dispatch Protocol
176 //
177 /**
178 @par Protocol Description:
179 Provides the parent dispatch service for a given SMI source generator.
180
181 @param Register
182 Installs a child service to be dispatched by this protocol.
183
184 @param UnRegister
185 Removes a child service dispatched by this protocol.
186
187 **/
188 struct _EFI_SMM_ICHN_DISPATCH_PROTOCOL {
189 EFI_SMM_ICHN_REGISTER Register;
190 EFI_SMM_ICHN_UNREGISTER UnRegister;
191 };
192
193 extern EFI_GUID gEfiSmmIchnDispatchProtocolGuid;
194
195 #endif