[mirror_edk2.git] / MdeModulePkg / Core / PiSmmCore / Handle.c

/** @file\r
  SMM handle & protocol handling.\r
\r
  Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "PiSmmCore.h"\r
\r
//\r
// mProtocolDatabase     - A list of all protocols in the system.  (simple list for now)\r
// gHandleList           - A list of all the handles in the system\r
//\r
LIST_ENTRY  mProtocolDatabase  = INITIALIZE_LIST_HEAD_VARIABLE (mProtocolDatabase);\r
LIST_ENTRY  gHandleList        = INITIALIZE_LIST_HEAD_VARIABLE (gHandleList);\r
\r
/**\r
  Check whether a handle is a valid EFI_HANDLE\r
\r
  @param  UserHandle             The handle to check\r
\r
  @retval EFI_INVALID_PARAMETER  The handle is NULL or not a valid EFI_HANDLE.\r
  @retval EFI_SUCCESS            The handle is valid EFI_HANDLE.\r
\r
**/\r
EFI_STATUS\r
SmmValidateHandle (\r
  IN EFI_HANDLE  UserHandle\r
  )\r
{\r
  IHANDLE  *Handle;\r
\r
  Handle = (IHANDLE *)UserHandle;\r
  if (Handle == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
  if (Handle->Signature != EFI_HANDLE_SIGNATURE) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Finds the protocol entry for the requested protocol.\r
\r
  @param  Protocol               The ID of the protocol\r
  @param  Create                 Create a new entry if not found\r
\r
  @return Protocol entry\r
\r
**/\r
PROTOCOL_ENTRY  *\r
SmmFindProtocolEntry (\r
  IN EFI_GUID   *Protocol,\r
  IN BOOLEAN    Create\r
  )\r
{\r
  LIST_ENTRY          *Link;\r
  PROTOCOL_ENTRY      *Item;\r
  PROTOCOL_ENTRY      *ProtEntry;\r
\r
  //\r
  // Search the database for the matching GUID\r
  //\r
\r
  ProtEntry = NULL;\r
  for (Link = mProtocolDatabase.ForwardLink;\r
       Link != &mProtocolDatabase;\r
       Link = Link->ForwardLink) {\r
\r
    Item = CR(Link, PROTOCOL_ENTRY, AllEntries, PROTOCOL_ENTRY_SIGNATURE);\r
    if (CompareGuid (&Item->ProtocolID, Protocol)) {\r
      //\r
      // This is the protocol entry\r
      //\r
      ProtEntry = Item;\r
      break;\r
    }\r
  }\r
\r
  //\r
  // If the protocol entry was not found and Create is TRUE, then\r
  // allocate a new entry\r
  //\r
  if ((ProtEntry == NULL) && Create) {\r
    ProtEntry = AllocatePool (sizeof(PROTOCOL_ENTRY));\r
    if (ProtEntry != NULL) {\r
      //\r
      // Initialize new protocol entry structure\r
      //\r
      ProtEntry->Signature = PROTOCOL_ENTRY_SIGNATURE;\r
      CopyGuid ((VOID *)&ProtEntry->ProtocolID, Protocol);\r
      InitializeListHead (&ProtEntry->Protocols);\r
      InitializeListHead (&ProtEntry->Notify);\r
\r
      //\r
      // Add it to protocol database\r
      //\r
      InsertTailList (&mProtocolDatabase, &ProtEntry->AllEntries);\r
    }\r
  }\r
  return ProtEntry;\r
}\r
\r
/**\r
  Finds the protocol instance for the requested handle and protocol.\r
  Note: This function doesn't do parameters checking, it's caller's responsibility\r
  to pass in valid parameters.\r
\r
  @param  Handle                 The handle to search the protocol on\r
  @param  Protocol               GUID of the protocol\r
  @param  Interface              The interface for the protocol being searched\r
\r
  @return Protocol instance (NULL: Not found)\r
\r
**/\r
PROTOCOL_INTERFACE *\r
SmmFindProtocolInterface (\r
  IN IHANDLE   *Handle,\r
  IN EFI_GUID  *Protocol,\r
  IN VOID      *Interface\r
  )\r
{\r
  PROTOCOL_INTERFACE  *Prot;\r
  PROTOCOL_ENTRY      *ProtEntry;\r
  LIST_ENTRY          *Link;\r
\r
  Prot = NULL;\r
\r
  //\r
  // Lookup the protocol entry for this protocol ID\r
  //\r
  ProtEntry = SmmFindProtocolEntry (Protocol, FALSE);\r
  if (ProtEntry != NULL) {\r
    //\r
    // Look at each protocol interface for any matches\r
    //\r
    for (Link = Handle->Protocols.ForwardLink; Link != &Handle->Protocols; Link=Link->ForwardLink) {\r
      //\r
      // If this protocol interface matches, remove it\r
      //\r
      Prot = CR(Link, PROTOCOL_INTERFACE, Link, PROTOCOL_INTERFACE_SIGNATURE);\r
      if (Prot->Interface == Interface && Prot->Protocol == ProtEntry) {\r
        break;\r
      }\r
      Prot = NULL;\r
    }\r
  }\r
  return Prot;\r
}\r
\r
/**\r
  Wrapper function to SmmInstallProtocolInterfaceNotify.  This is the public API which\r
  Calls the private one which contains a BOOLEAN parameter for notifications\r
\r
  @param  UserHandle             The handle to install the protocol handler on,\r
                                 or NULL if a new handle is to be allocated\r
  @param  Protocol               The protocol to add to the handle\r
  @param  InterfaceType          Indicates whether Interface is supplied in\r
                                 native form.\r
  @param  Interface              The interface for the protocol being added\r
\r
  @return Status code\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SmmInstallProtocolInterface (\r
  IN OUT EFI_HANDLE      *UserHandle,\r
  IN EFI_GUID            *Protocol,\r
  IN EFI_INTERFACE_TYPE  InterfaceType,\r
  IN VOID                *Interface\r
  )\r
{\r
  return SmmInstallProtocolInterfaceNotify (\r
           UserHandle,\r
           Protocol,\r
           InterfaceType,\r
           Interface,\r
           TRUE\r
           );\r
}\r
\r
/**\r
  Installs a protocol interface into the boot services environment.\r
\r
  @param  UserHandle             The handle to install the protocol handler on,\r
                                 or NULL if a new handle is to be allocated\r
  @param  Protocol               The protocol to add to the handle\r
  @param  InterfaceType          Indicates whether Interface is supplied in\r
                                 native form.\r
  @param  Interface              The interface for the protocol being added\r
  @param  Notify                 indicates whether notify the notification list\r
                                 for this protocol\r
\r
  @retval EFI_INVALID_PARAMETER  Invalid parameter\r
  @retval EFI_OUT_OF_RESOURCES   No enough buffer to allocate\r
  @retval EFI_SUCCESS            Protocol interface successfully installed\r
\r
**/\r
EFI_STATUS\r
SmmInstallProtocolInterfaceNotify (\r
  IN OUT EFI_HANDLE          *UserHandle,\r
  IN     EFI_GUID            *Protocol,\r
  IN     EFI_INTERFACE_TYPE  InterfaceType,\r
  IN     VOID                *Interface,\r
  IN     BOOLEAN             Notify\r
  )\r
{\r
  PROTOCOL_INTERFACE  *Prot;\r
  PROTOCOL_ENTRY      *ProtEntry;\r
  IHANDLE             *Handle;\r
  EFI_STATUS          Status;\r
  VOID                *ExistingInterface;\r
\r
  //\r
  // returns EFI_INVALID_PARAMETER if InterfaceType is invalid.\r
  // Also added check for invalid UserHandle and Protocol pointers.\r
  //\r
  if (UserHandle == NULL || Protocol == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (InterfaceType != EFI_NATIVE_INTERFACE) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Print debug message\r
  //\r
  DEBUG((DEBUG_LOAD | DEBUG_INFO, "SmmInstallProtocolInterface: %g %p\n", Protocol, Interface));\r
\r
  Status = EFI_OUT_OF_RESOURCES;\r
  Prot = NULL;\r
  Handle = NULL;\r
\r
  if (*UserHandle != NULL) {\r
    Status = SmmHandleProtocol (*UserHandle, Protocol, (VOID **)&ExistingInterface);\r
    if (!EFI_ERROR (Status)) {\r
      return EFI_INVALID_PARAMETER;\r
    }\r
  }\r
\r
  //\r
  // Lookup the Protocol Entry for the requested protocol\r
  //\r
  ProtEntry = SmmFindProtocolEntry (Protocol, TRUE);\r
  if (ProtEntry == NULL) {\r
    goto Done;\r
  }\r
\r
  //\r
  // Allocate a new protocol interface structure\r
  //\r
  Prot = AllocateZeroPool (sizeof(PROTOCOL_INTERFACE));\r
  if (Prot == NULL) {\r
    Status = EFI_OUT_OF_RESOURCES;\r
    goto Done;\r
  }\r
\r
  //\r
  // If caller didn't supply a handle, allocate a new one\r
  //\r
  Handle = (IHANDLE *)*UserHandle;\r
  if (Handle == NULL) {\r
    Handle = AllocateZeroPool (sizeof(IHANDLE));\r
    if (Handle == NULL) {\r
      Status = EFI_OUT_OF_RESOURCES;\r
      goto Done;\r
    }\r
\r
    //\r
    // Initialize new handler structure\r
    //\r
    Handle->Signature = EFI_HANDLE_SIGNATURE;\r
    InitializeListHead (&Handle->Protocols);\r
\r
    //\r
    // Add this handle to the list global list of all handles\r
    // in the system\r
    //\r
    InsertTailList (&gHandleList, &Handle->AllHandles);\r
  } else {\r
    Status = SmmValidateHandle (Handle);\r
    if (EFI_ERROR (Status)) {\r
      DEBUG((DEBUG_ERROR, "SmmInstallProtocolInterface: input handle at 0x%x is invalid\n", Handle));\r
      goto Done;\r
    }\r
  }\r
\r
  //\r
  // Each interface that is added must be unique\r
  //\r
  ASSERT (SmmFindProtocolInterface (Handle, Protocol, Interface) == NULL);\r
\r
  //\r
  // Initialize the protocol interface structure\r
  //\r
  Prot->Signature = PROTOCOL_INTERFACE_SIGNATURE;\r
  Prot->Handle = Handle;\r
  Prot->Protocol = ProtEntry;\r
  Prot->Interface = Interface;\r
\r
  //\r
  // Add this protocol interface to the head of the supported\r
  // protocol list for this handle\r
  //\r
  InsertHeadList (&Handle->Protocols, &Prot->Link);\r
\r
  //\r
  // Add this protocol interface to the tail of the\r
  // protocol entry\r
  //\r
  InsertTailList (&ProtEntry->Protocols, &Prot->ByProtocol);\r
\r
  //\r
  // Notify the notification list for this protocol\r
  //\r
  if (Notify) {\r
    SmmNotifyProtocol (Prot);\r
  }\r
  Status = EFI_SUCCESS;\r
\r
Done:\r
  if (!EFI_ERROR (Status)) {\r
    //\r
    // Return the new handle back to the caller\r
    //\r
    *UserHandle = Handle;\r
  } else {\r
    //\r
    // There was an error, clean up\r
    //\r
    if (Prot != NULL) {\r
      FreePool (Prot);\r
    }\r
    DEBUG((DEBUG_ERROR, "SmmInstallProtocolInterface: %g %p failed with %r\n", Protocol, Interface, Status));\r
  }\r
  return Status;\r
}\r
\r
/**\r
  Uninstalls all instances of a protocol:interfacer from a handle.\r
  If the last protocol interface is remove from the handle, the\r
  handle is freed.\r
\r
  @param  UserHandle             The handle to remove the protocol handler from\r
  @param  Protocol               The protocol, of protocol:interface, to remove\r
  @param  Interface              The interface, of protocol:interface, to remove\r
\r
  @retval EFI_INVALID_PARAMETER  Protocol is NULL.\r
  @retval EFI_SUCCESS            Protocol interface successfully uninstalled.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SmmUninstallProtocolInterface (\r
  IN EFI_HANDLE  UserHandle,\r
  IN EFI_GUID    *Protocol,\r
  IN VOID        *Interface\r
  )\r
{\r
  EFI_STATUS          Status;\r
  IHANDLE             *Handle;\r
  PROTOCOL_INTERFACE  *Prot;\r
\r
  //\r
  // Check that Protocol is valid\r
  //\r
  if (Protocol == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Check that UserHandle is a valid handle\r
  //\r
  Status = SmmValidateHandle (UserHandle);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Check that Protocol exists on UserHandle, and Interface matches the interface in the database\r
  //\r
  Prot = SmmFindProtocolInterface (UserHandle, Protocol, Interface);\r
  if (Prot == NULL) {\r
    return EFI_NOT_FOUND;\r
  }\r
\r
  //\r
  // Remove the protocol interface from the protocol\r
  //\r
  Status = EFI_NOT_FOUND;\r
  Handle = (IHANDLE *)UserHandle;\r
  Prot   = SmmRemoveInterfaceFromProtocol (Handle, Protocol, Interface);\r
\r
  if (Prot != NULL) {\r
    //\r
    // Remove the protocol interface from the handle\r
    //\r
    RemoveEntryList (&Prot->Link);\r
\r
    //\r
    // Free the memory\r
    //\r
    Prot->Signature = 0;\r
    FreePool (Prot);\r
    Status = EFI_SUCCESS;\r
  }\r
\r
  //\r
  // If there are no more handlers for the handle, free the handle\r
  //\r
  if (IsListEmpty (&Handle->Protocols)) {\r
    Handle->Signature = 0;\r
    RemoveEntryList (&Handle->AllHandles);\r
    FreePool (Handle);\r
  }\r
  return Status;\r
}\r
\r
/**\r
  Locate a certain GUID protocol interface in a Handle's protocols.\r
\r
  @param  UserHandle             The handle to obtain the protocol interface on\r
  @param  Protocol               The GUID of the protocol\r
\r
  @return The requested protocol interface for the handle\r
\r
**/\r
PROTOCOL_INTERFACE  *\r
SmmGetProtocolInterface (\r
  IN EFI_HANDLE  UserHandle,\r
  IN EFI_GUID    *Protocol\r
  )\r
{\r
  EFI_STATUS          Status;\r
  PROTOCOL_ENTRY      *ProtEntry;\r
  PROTOCOL_INTERFACE  *Prot;\r
  IHANDLE             *Handle;\r
  LIST_ENTRY          *Link;\r
\r
  Status = SmmValidateHandle (UserHandle);\r
  if (EFI_ERROR (Status)) {\r
    return NULL;\r
  }\r
\r
  Handle = (IHANDLE *)UserHandle;\r
\r
  //\r
  // Look at each protocol interface for a match\r
  //\r
  for (Link = Handle->Protocols.ForwardLink; Link != &Handle->Protocols; Link = Link->ForwardLink) {\r
    Prot = CR(Link, PROTOCOL_INTERFACE, Link, PROTOCOL_INTERFACE_SIGNATURE);\r
    ProtEntry = Prot->Protocol;\r
    if (CompareGuid (&ProtEntry->ProtocolID, Protocol)) {\r
      return Prot;\r
    }\r
  }\r
  return NULL;\r
}\r
\r
/**\r
  Queries a handle to determine if it supports a specified protocol.\r
\r
  @param  UserHandle             The handle being queried.\r
  @param  Protocol               The published unique identifier of the protocol.\r
  @param  Interface              Supplies the address where a pointer to the\r
                                 corresponding Protocol Interface is returned.\r
\r
  @retval EFI_SUCCESS            The interface information for the specified protocol was returned.\r
  @retval EFI_UNSUPPORTED        The device does not support the specified protocol.\r
  @retval EFI_INVALID_PARAMETER  Handle is not a valid EFI_HANDLE..\r
  @retval EFI_INVALID_PARAMETER  Protocol is NULL.\r
  @retval EFI_INVALID_PARAMETER  Interface is NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SmmHandleProtocol (\r
  IN  EFI_HANDLE  UserHandle,\r
  IN  EFI_GUID    *Protocol,\r
  OUT VOID        **Interface\r
  )\r
{\r
  EFI_STATUS          Status;\r
  PROTOCOL_INTERFACE  *Prot;\r
\r
  //\r
  // Check for invalid Protocol\r
  //\r
  if (Protocol == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  //\r
  // Check for invalid Interface\r
  //\r
  if (Interface == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  } else {\r
    *Interface = NULL;\r
  }\r
\r
  //\r
  // Check for invalid UserHandle\r
  //\r
  Status = SmmValidateHandle (UserHandle);\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Look at each protocol interface for a match\r
  //\r
  Prot = SmmGetProtocolInterface (UserHandle, Protocol);\r
  if (Prot == NULL) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  //\r
  // This is the protocol interface entry for this protocol\r
  //\r
  *Interface = Prot->Interface;\r
\r
  return EFI_SUCCESS;\r
}\r
Commit	Line	Data
e42e9404	1	/** @file\r
	2	SMM handle & protocol handling.\r
	3	\r
d1102dba	4	Copyright (c) 2009 - 2018, Intel Corporation. All rights reserved.<BR>\r
9d510e61	5	SPDX-License-Identifier: BSD-2-Clause-Patent\r
e42e9404	6	\r
	7	**/\r
	8	\r
	9	#include "PiSmmCore.h"\r
	10	\r
	11	//\r
	12	// mProtocolDatabase - A list of all protocols in the system. (simple list for now)\r
	13	// gHandleList - A list of all the handles in the system\r
	14	//\r
	15	LIST_ENTRY mProtocolDatabase = INITIALIZE_LIST_HEAD_VARIABLE (mProtocolDatabase);\r
	16	LIST_ENTRY gHandleList = INITIALIZE_LIST_HEAD_VARIABLE (gHandleList);\r
	17	\r
	18	/**\r
	19	Check whether a handle is a valid EFI_HANDLE\r
	20	\r
	21	@param UserHandle The handle to check\r
	22	\r
	23	@retval EFI_INVALID_PARAMETER The handle is NULL or not a valid EFI_HANDLE.\r
	24	@retval EFI_SUCCESS The handle is valid EFI_HANDLE.\r
	25	\r
	26	**/\r
	27	EFI_STATUS\r
	28	SmmValidateHandle (\r
	29	IN EFI_HANDLE UserHandle\r
	30	)\r
	31	{\r
	32	IHANDLE *Handle;\r
	33	\r
	34	Handle = (IHANDLE *)UserHandle;\r
	35	if (Handle == NULL) {\r
	36	return EFI_INVALID_PARAMETER;\r
	37	}\r
	38	if (Handle->Signature != EFI_HANDLE_SIGNATURE) {\r
	39	return EFI_INVALID_PARAMETER;\r
	40	}\r
	41	return EFI_SUCCESS;\r
	42	}\r
	43	\r
	44	/**\r
	45	Finds the protocol entry for the requested protocol.\r
	46	\r
	47	@param Protocol The ID of the protocol\r
	48	@param Create Create a new entry if not found\r
	49	\r
	50	@return Protocol entry\r
	51	\r
	52	**/\r
	53	PROTOCOL_ENTRY *\r
	54	SmmFindProtocolEntry (\r
	55	IN EFI_GUID *Protocol,\r
	56	IN BOOLEAN Create\r
	57	)\r
	58	{\r
	59	LIST_ENTRY *Link;\r
	60	PROTOCOL_ENTRY *Item;\r
	61	PROTOCOL_ENTRY *ProtEntry;\r
	62	\r
	63	//\r
	64	// Search the database for the matching GUID\r
	65	//\r
	66	\r
	67	ProtEntry = NULL;\r
	68	for (Link = mProtocolDatabase.ForwardLink;\r
	69	Link != &mProtocolDatabase;\r
70	Link = Link->ForwardLink) {\r
71	\r
72	Item = CR(Link, PROTOCOL_ENTRY, AllEntries, PROTOCOL_ENTRY_SIGNATURE);\r
73	if (CompareGuid (&Item->ProtocolID, Protocol)) {\r
74	//\r
75	// This is the protocol entry\r
76	//\r
77	ProtEntry = Item;\r
78	break;\r
79	}\r
80	}\r
81	\r
82	//\r
83	// If the protocol entry was not found and Create is TRUE, then\r
84	// allocate a new entry\r
85	//\r
86	if ((ProtEntry == NULL) && Create) {\r
87	ProtEntry = AllocatePool (sizeof(PROTOCOL_ENTRY));\r
88	if (ProtEntry != NULL) {\r
89	//\r
90	// Initialize new protocol entry structure\r
91	//\r
92	ProtEntry->Signature = PROTOCOL_ENTRY_SIGNATURE;\r
93	CopyGuid ((VOID *)&ProtEntry->ProtocolID, Protocol);\r
94	InitializeListHead (&ProtEntry->Protocols);\r
95	InitializeListHead (&ProtEntry->Notify);\r
96	\r
97	//\r
98	// Add it to protocol database\r
99	//\r
100	InsertTailList (&mProtocolDatabase, &ProtEntry->AllEntries);\r
101	}\r
102	}\r
103	return ProtEntry;\r
104	}\r
105	\r
106	/**\r
107	Finds the protocol instance for the requested handle and protocol.\r
108	Note: This function doesn't do parameters checking, it's caller's responsibility\r
109	to pass in valid parameters.\r
110	\r
111	@param Handle The handle to search the protocol on\r
112	@param Protocol GUID of the protocol\r
113	@param Interface The interface for the protocol being searched\r
114	\r
115	@return Protocol instance (NULL: Not found)\r
116	\r
117	**/\r
118	PROTOCOL_INTERFACE *\r
119	SmmFindProtocolInterface (\r
120	IN IHANDLE *Handle,\r
121	IN EFI_GUID *Protocol,\r
122	IN VOID *Interface\r
123	)\r
124	{\r
125	PROTOCOL_INTERFACE *Prot;\r
126	PROTOCOL_ENTRY *ProtEntry;\r
127	LIST_ENTRY *Link;\r
128	\r
129	Prot = NULL;\r
130	\r
131	//\r
132	// Lookup the protocol entry for this protocol ID\r
133	//\r
134	ProtEntry = SmmFindProtocolEntry (Protocol, FALSE);\r
135	if (ProtEntry != NULL) {\r
136	//\r
137	// Look at each protocol interface for any matches\r
138	//\r
139	for (Link = Handle->Protocols.ForwardLink; Link != &Handle->Protocols; Link=Link->ForwardLink) {\r
140	//\r
141	// If this protocol interface matches, remove it\r
142	//\r
143	Prot = CR(Link, PROTOCOL_INTERFACE, Link, PROTOCOL_INTERFACE_SIGNATURE);\r
144	if (Prot->Interface == Interface && Prot->Protocol == ProtEntry) {\r
145	break;\r
146	}\r
147	Prot = NULL;\r
148	}\r
149	}\r
150	return Prot;\r
151	}\r
152	\r
153	/**\r
154	Wrapper function to SmmInstallProtocolInterfaceNotify. This is the public API which\r
155	Calls the private one which contains a BOOLEAN parameter for notifications\r
156	\r
157	@param UserHandle The handle to install the protocol handler on,\r
158	or NULL if a new handle is to be allocated\r
159	@param Protocol The protocol to add to the handle\r
160	@param InterfaceType Indicates whether Interface is supplied in\r
161	native form.\r
162	@param Interface The interface for the protocol being added\r
163	\r
164	@return Status code\r
165	\r
166	**/\r
167	EFI_STATUS\r
168	EFIAPI\r
169	SmmInstallProtocolInterface (\r
170	IN OUT EFI_HANDLE *UserHandle,\r
171	IN EFI_GUID *Protocol,\r
172	IN EFI_INTERFACE_TYPE InterfaceType,\r
173	IN VOID *Interface\r
174	)\r
175	{\r
176	return SmmInstallProtocolInterfaceNotify (\r
177	UserHandle,\r
178	Protocol,\r
179	InterfaceType,\r
180	Interface,\r
181	TRUE\r
182	);\r
183	}\r
184	\r
185	/**\r
186	Installs a protocol interface into the boot services environment.\r
187	\r
188	@param UserHandle The handle to install the protocol handler on,\r
189	or NULL if a new handle is to be allocated\r
190	@param Protocol The protocol to add to the handle\r
191	@param InterfaceType Indicates whether Interface is supplied in\r
192	native form.\r
193	@param Interface The interface for the protocol being added\r
194	@param Notify indicates whether notify the notification list\r
195	for this protocol\r
196	\r
197	@retval EFI_INVALID_PARAMETER Invalid parameter\r
198	@retval EFI_OUT_OF_RESOURCES No enough buffer to allocate\r
199	@retval EFI_SUCCESS Protocol interface successfully installed\r
200	\r
201	**/\r
202	EFI_STATUS\r
203	SmmInstallProtocolInterfaceNotify (\r
204	IN OUT EFI_HANDLE *UserHandle,\r
205	IN EFI_GUID *Protocol,\r
206	IN EFI_INTERFACE_TYPE InterfaceType,\r
207	IN VOID *Interface,\r
208	IN BOOLEAN Notify\r
209	)\r
210	{\r
211	PROTOCOL_INTERFACE *Prot;\r
212	PROTOCOL_ENTRY *ProtEntry;\r
213	IHANDLE *Handle;\r
214	EFI_STATUS Status;\r
215	VOID *ExistingInterface;\r
216	\r
217	//\r
218	// returns EFI_INVALID_PARAMETER if InterfaceType is invalid.\r
219	// Also added check for invalid UserHandle and Protocol pointers.\r
220	//\r
221	if (UserHandle == NULL \|\| Protocol == NULL) {\r
222	return EFI_INVALID_PARAMETER;\r
223	}\r
224	\r
225	if (InterfaceType != EFI_NATIVE_INTERFACE) {\r
226	return EFI_INVALID_PARAMETER;\r
227	}\r
228	\r
229	//\r
230	// Print debug message\r
231	//\r
232	DEBUG((DEBUG_LOAD \| DEBUG_INFO, "SmmInstallProtocolInterface: %g %p\n", Protocol, Interface));\r
233	\r
234	Status = EFI_OUT_OF_RESOURCES;\r
235	Prot = NULL;\r
236	Handle = NULL;\r
237	\r
238	if (*UserHandle != NULL) {\r
239	Status = SmmHandleProtocol (UserHandle, Protocol, (VOID *)&ExistingInterface);\r
240	if (!EFI_ERROR (Status)) {\r
241	return EFI_INVALID_PARAMETER;\r
242	}\r
243	}\r
244	\r
245	//\r
246	// Lookup the Protocol Entry for the requested protocol\r
247	//\r
248	ProtEntry = SmmFindProtocolEntry (Protocol, TRUE);\r
249	if (ProtEntry == NULL) {\r
250	goto Done;\r
251	}\r
252	\r
253	//\r
254	// Allocate a new protocol interface structure\r
255	//\r
256	Prot = AllocateZeroPool (sizeof(PROTOCOL_INTERFACE));\r
257	if (Prot == NULL) {\r
258	Status = EFI_OUT_OF_RESOURCES;\r
259	goto Done;\r
260	}\r
261	\r
262	//\r
263	// If caller didn't supply a handle, allocate a new one\r
264	//\r
265	Handle = (IHANDLE )UserHandle;\r
266	if (Handle == NULL) {\r
267	Handle = AllocateZeroPool (sizeof(IHANDLE));\r
268	if (Handle == NULL) {\r
269	Status = EFI_OUT_OF_RESOURCES;\r
270	goto Done;\r
271	}\r
272	\r
273	//\r
274	// Initialize new handler structure\r
275	//\r
276	Handle->Signature = EFI_HANDLE_SIGNATURE;\r
277	InitializeListHead (&Handle->Protocols);\r
278	\r
279	//\r
280	// Add this handle to the list global list of all handles\r
281	// in the system\r
282	//\r
283	InsertTailList (&gHandleList, &Handle->AllHandles);\r
c01f13d5 SZ	284	} else {\r
	285	Status = SmmValidateHandle (Handle);\r
	286	if (EFI_ERROR (Status)) {\r
	287	DEBUG((DEBUG_ERROR, "SmmInstallProtocolInterface: input handle at 0x%x is invalid\n", Handle));\r
	288	goto Done;\r
	289	}\r
e42e9404	290	}\r
	291	\r
	292	//\r
	293	// Each interface that is added must be unique\r
	294	//\r
	295	ASSERT (SmmFindProtocolInterface (Handle, Protocol, Interface) == NULL);\r
	296	\r
	297	//\r
	298	// Initialize the protocol interface structure\r
	299	//\r
	300	Prot->Signature = PROTOCOL_INTERFACE_SIGNATURE;\r
	301	Prot->Handle = Handle;\r
	302	Prot->Protocol = ProtEntry;\r
	303	Prot->Interface = Interface;\r
	304	\r
	305	//\r
	306	// Add this protocol interface to the head of the supported\r
	307	// protocol list for this handle\r
	308	//\r
	309	InsertHeadList (&Handle->Protocols, &Prot->Link);\r
	310	\r
	311	//\r
	312	// Add this protocol interface to the tail of the\r
	313	// protocol entry\r
	314	//\r
	315	InsertTailList (&ProtEntry->Protocols, &Prot->ByProtocol);\r
	316	\r
	317	//\r
	318	// Notify the notification list for this protocol\r
	319	//\r
	320	if (Notify) {\r
	321	SmmNotifyProtocol (Prot);\r
	322	}\r
	323	Status = EFI_SUCCESS;\r
	324	\r
	325	Done:\r
	326	if (!EFI_ERROR (Status)) {\r
	327	//\r
	328	// Return the new handle back to the caller\r
	329	//\r
	330	*UserHandle = Handle;\r
	331	} else {\r
	332	//\r
	333	// There was an error, clean up\r
	334	//\r
	335	if (Prot != NULL) {\r
	336	FreePool (Prot);\r
	337	}\r
c01f13d5	338	DEBUG((DEBUG_ERROR, "SmmInstallProtocolInterface: %g %p failed with %r\n", Protocol, Interface, Status));\r
e42e9404	339	}\r
	340	return Status;\r
	341	}\r
	342	\r
	343	/**\r
	344	Uninstalls all instances of a protocol:interfacer from a handle.\r
	345	If the last protocol interface is remove from the handle, the\r
	346	handle is freed.\r
	347	\r
	348	@param UserHandle The handle to remove the protocol handler from\r
	349	@param Protocol The protocol, of protocol:interface, to remove\r
	350	@param Interface The interface, of protocol:interface, to remove\r
	351	\r
	352	@retval EFI_INVALID_PARAMETER Protocol is NULL.\r
	353	@retval EFI_SUCCESS Protocol interface successfully uninstalled.\r
	354	\r
	355	**/\r
	356	EFI_STATUS\r
	357	EFIAPI\r
	358	SmmUninstallProtocolInterface (\r
	359	IN EFI_HANDLE UserHandle,\r
	360	IN EFI_GUID *Protocol,\r
	361	IN VOID *Interface\r
	362	)\r
	363	{\r
	364	EFI_STATUS Status;\r
	365	IHANDLE *Handle;\r
	366	PROTOCOL_INTERFACE *Prot;\r
	367	\r
	368	//\r
	369	// Check that Protocol is valid\r
	370	//\r
	371	if (Protocol == NULL) {\r
	372	return EFI_INVALID_PARAMETER;\r
	373	}\r
	374	\r
	375	//\r
	376	// Check that UserHandle is a valid handle\r
	377	//\r
	378	Status = SmmValidateHandle (UserHandle);\r
	379	if (EFI_ERROR (Status)) {\r
	380	return Status;\r
	381	}\r
	382	\r
	383	//\r
	384	// Check that Protocol exists on UserHandle, and Interface matches the interface in the database\r
	385	//\r
	386	Prot = SmmFindProtocolInterface (UserHandle, Protocol, Interface);\r
	387	if (Prot == NULL) {\r
	388	return EFI_NOT_FOUND;\r
	389	}\r
	390	\r
	391	//\r
	392	// Remove the protocol interface from the protocol\r
	393	//\r
	394	Status = EFI_NOT_FOUND;\r
	395	Handle = (IHANDLE *)UserHandle;\r
	396	Prot = SmmRemoveInterfaceFromProtocol (Handle, Protocol, Interface);\r
	397	\r
	398	if (Prot != NULL) {\r
	399	//\r
	400	// Remove the protocol interface from the handle\r
	401	//\r
	402	RemoveEntryList (&Prot->Link);\r
403	\r
404	//\r
405	// Free the memory\r
406	//\r
407	Prot->Signature = 0;\r
408	FreePool (Prot);\r
409	Status = EFI_SUCCESS;\r
410	}\r
411	\r
412	//\r
413	// If there are no more handlers for the handle, free the handle\r
414	//\r
415	if (IsListEmpty (&Handle->Protocols)) {\r
416	Handle->Signature = 0;\r
417	RemoveEntryList (&Handle->AllHandles);\r
418	FreePool (Handle);\r
419	}\r
420	return Status;\r
421	}\r
422	\r
423	/**\r
424	Locate a certain GUID protocol interface in a Handle's protocols.\r
425	\r
426	@param UserHandle The handle to obtain the protocol interface on\r
427	@param Protocol The GUID of the protocol\r
428	\r
429	@return The requested protocol interface for the handle\r
430	\r
431	**/\r
432	PROTOCOL_INTERFACE *\r
433	SmmGetProtocolInterface (\r
434	IN EFI_HANDLE UserHandle,\r
435	IN EFI_GUID *Protocol\r
436	)\r
437	{\r
438	EFI_STATUS Status;\r
439	PROTOCOL_ENTRY *ProtEntry;\r
440	PROTOCOL_INTERFACE *Prot;\r
441	IHANDLE *Handle;\r
442	LIST_ENTRY *Link;\r
443	\r
444	Status = SmmValidateHandle (UserHandle);\r
445	if (EFI_ERROR (Status)) {\r
446	return NULL;\r
447	}\r
448	\r
449	Handle = (IHANDLE *)UserHandle;\r
450	\r
451	//\r
452	// Look at each protocol interface for a match\r
453	//\r
454	for (Link = Handle->Protocols.ForwardLink; Link != &Handle->Protocols; Link = Link->ForwardLink) {\r
455	Prot = CR(Link, PROTOCOL_INTERFACE, Link, PROTOCOL_INTERFACE_SIGNATURE);\r
456	ProtEntry = Prot->Protocol;\r
457	if (CompareGuid (&ProtEntry->ProtocolID, Protocol)) {\r
458	return Prot;\r
459	}\r
460	}\r
461	return NULL;\r
462	}\r
463	\r
464	/**\r
465	Queries a handle to determine if it supports a specified protocol.\r
466	\r
467	@param UserHandle The handle being queried.\r
468	@param Protocol The published unique identifier of the protocol.\r
469	@param Interface Supplies the address where a pointer to the\r
470	corresponding Protocol Interface is returned.\r
471	\r
472	@retval EFI_SUCCESS The interface information for the specified protocol was returned.\r
473	@retval EFI_UNSUPPORTED The device does not support the specified protocol.\r
474	@retval EFI_INVALID_PARAMETER Handle is not a valid EFI_HANDLE..\r
475	@retval EFI_INVALID_PARAMETER Protocol is NULL.\r
476	@retval EFI_INVALID_PARAMETER Interface is NULL.\r
477	\r
478	**/\r
479	EFI_STATUS\r
480	EFIAPI\r
481	SmmHandleProtocol (\r
482	IN EFI_HANDLE UserHandle,\r
483	IN EFI_GUID *Protocol,\r
484	OUT VOID **Interface\r
485	)\r
486	{\r
487	EFI_STATUS Status;\r
488	PROTOCOL_INTERFACE *Prot;\r
489	\r
490	//\r
491	// Check for invalid Protocol\r
492	//\r
493	if (Protocol == NULL) {\r
494	return EFI_INVALID_PARAMETER;\r
495	}\r
496	\r
497	//\r
498	// Check for invalid Interface\r
499	//\r
500	if (Interface == NULL) {\r
501	return EFI_INVALID_PARAMETER;\r
502	} else {\r
503	*Interface = NULL;\r
504	}\r
505	\r
506	//\r
507	// Check for invalid UserHandle\r
508	//\r
509	Status = SmmValidateHandle (UserHandle);\r
510	if (EFI_ERROR (Status)) {\r
511	return Status;\r
512	}\r
513	\r
514	//\r
515	// Look at each protocol interface for a match\r
516	//\r
517	Prot = SmmGetProtocolInterface (UserHandle, Protocol);\r
518	if (Prot == NULL) {\r
519	return EFI_UNSUPPORTED;\r
520	}\r
521	\r
522	//\r
523	// This is the protocol interface entry for this protocol\r
524	//\r
525	*Interface = Prot->Interface;\r
526	\r
527	return EFI_SUCCESS;\r
528	}\r