2 Provides the parent dispatch service for a given SMI source generator.
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
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.
13 Module Name: SmmSwDispatch.h
15 @par Revision Reference:
16 This Protocol is defined in Framework of EFI SMM Core Interface Spec
21 #ifndef _EFI_SMM_SW_DISPATCH_H_
22 #define _EFI_SMM_SW_DISPATCH_H_
27 // Global ID for the SW SMI Protocol
29 #define EFI_SMM_SW_DISPATCH_PROTOCOL_GUID \
31 0xe541b773, 0xdd11, 0x420c, {0xb0, 0x26, 0xdf, 0x99, 0x36, 0x53, 0xf8, 0xbf } \
34 typedef struct _EFI_SMM_SW_DISPATCH_PROTOCOL EFI_SMM_SW_DISPATCH_PROTOCOL
;
37 // Related Definitions
40 // A particular chipset may not support all possible software SMI input values.
41 // For example, the ICH supports only values 00h to 0FFh. The parent only allows a single
42 // child registration for each SwSmiInputValue.
45 UINTN SwSmiInputValue
;
46 } EFI_SMM_SW_DISPATCH_CONTEXT
;
52 Dispatch function for a Software SMI handler.
54 @param DispatchHandle Handle of this dispatch function.
55 @param DispatchContext Pointer to the dispatch function's context.
56 The SwSmiInputValue field is filled in
57 by the software dispatch driver prior to
58 invoking this dispatch function.
59 The dispatch function will only be called
60 for input values for which it is registered.
67 (EFIAPI
*EFI_SMM_SW_DISPATCH
)(
68 IN EFI_HANDLE DispatchHandle
,
69 IN EFI_SMM_SW_DISPATCH_CONTEXT
*DispatchContext
73 Register a child SMI source dispatch function with a parent SMM driver
75 @param This Protocol instance pointer.
76 @param DispatchFunction Pointer to dispatch function to be invoked for
78 @param DispatchContext Pointer to the dispatch function's context.
79 The caller fills this context in before calling
80 the register function to indicate to the register
81 function which Software SMI input value the
82 dispatch function should be invoked for.
83 @param DispatchHandle Handle of dispatch function, for when interfacing
84 with the parent Sx state SMM driver.
86 @retval EFI_SUCCESS The dispatch function has been successfully
87 registered and the SMI source has been enabled.
88 @retval EFI_DEVICE_ERROR The SW driver was unable to enable the SMI source.
89 @retval EFI_OUT_OF_RESOURCES Not enough memory (system or SMM) to manage this
91 @retval EFI_INVALID_PARAMETER DispatchContext is invalid. The SW SMI input value
92 is not within valid range.
97 (EFIAPI
*EFI_SMM_SW_REGISTER
)(
98 IN EFI_SMM_SW_DISPATCH_PROTOCOL
*This
,
99 IN EFI_SMM_SW_DISPATCH DispatchFunction
,
100 IN EFI_SMM_SW_DISPATCH_CONTEXT
*DispatchContext
,
101 OUT EFI_HANDLE
*DispatchHandle
105 Unregister a child SMI source dispatch function with a parent SMM driver
107 @param This Protocol instance pointer.
108 @param DispatchHandle Handle of dispatch function to deregister.
110 @retval EFI_SUCCESS The dispatch function has been successfully
111 unregistered and the SMI source has been disabled
112 if there are no other registered child dispatch
113 functions for this SMI source.
114 @retval EFI_INVALID_PARAMETER Handle is invalid.
120 (EFIAPI
*EFI_SMM_SW_UNREGISTER
)(
121 IN EFI_SMM_SW_DISPATCH_PROTOCOL
*This
,
122 IN EFI_HANDLE DispatchHandle
126 // Interface structure for the SMM Software SMI Dispatch Protocol
129 @par Protocol Description:
130 Provides the parent dispatch service for a given SMI source generator.
133 Installs a child service to be dispatched by this protocol.
136 Removes a child service dispatched by this protocol.
138 @param MaximumSwiValue
139 A read-only field that describes the maximum value that can be used
140 in the EFI_SMM_SW_DISPATCH_PROTOCOL.Register() service.
143 struct _EFI_SMM_SW_DISPATCH_PROTOCOL
{
144 EFI_SMM_SW_REGISTER Register
;
145 EFI_SMM_SW_UNREGISTER UnRegister
;
146 UINTN MaximumSwiValue
;
149 extern EFI_GUID gEfiSmmSwDispatchProtocolGuid
;