[mirror_edk2.git] / MdeModulePkg / Bus / Isa / Ps2MouseDxe / ComponentName.c

/** @file\r
  UEFI Component Name(2) protocol implementation for Ps2MouseDxe driver.\r
\r
Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "Ps2Mouse.h"\r
\r
//\r
// EFI Component Name Protocol\r
//\r
GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL  gPs2MouseComponentName = {\r
  Ps2MouseComponentNameGetDriverName,\r
  Ps2MouseComponentNameGetControllerName,\r
  "eng"\r
};\r
\r
//\r
// EFI Component Name 2 Protocol\r
//\r
GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL  gPs2MouseComponentName2 = {\r
  (EFI_COMPONENT_NAME2_GET_DRIVER_NAME)Ps2MouseComponentNameGetDriverName,\r
  (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME)Ps2MouseComponentNameGetControllerName,\r
  "en"\r
};\r
\r
GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE  mPs2MouseDriverNameTable[] = {\r
  {\r
    "eng;en",\r
    L"PS/2 Mouse Driver"\r
  },\r
  {\r
    NULL,\r
    NULL\r
  }\r
};\r
\r
/**\r
  Retrieves a Unicode string that is the user readable name of the driver.\r
\r
  This function retrieves the user readable name of a driver in the form of a\r
  Unicode string. If the driver specified by This has a user readable name in\r
  the language specified by Language, then a pointer to the driver name is\r
  returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r
  by This does not support the language specified by Language,\r
  then EFI_UNSUPPORTED is returned.\r
\r
  @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
                                EFI_COMPONENT_NAME_PROTOCOL instance.\r
\r
  @param  Language[in]          A pointer to a Null-terminated ASCII string\r
                                array indicating the language. This is the\r
                                language of the driver name that the caller is\r
                                requesting, and it must match one of the\r
                                languages specified in SupportedLanguages. The\r
                                number of languages supported by a driver is up\r
                                to the driver writer. Language is specified\r
                                in RFC 4646 or ISO 639-2 language code format.\r
\r
  @param  DriverName[out]       A pointer to the Unicode string to return.\r
                                This Unicode string is the name of the\r
                                driver specified by This in the language\r
                                specified by Language.\r
\r
  @retval EFI_SUCCESS           The Unicode string for the Driver specified by\r
                                This and the language specified by Language was\r
                                returned in DriverName.\r
\r
  @retval EFI_INVALID_PARAMETER Language is NULL.\r
\r
  @retval EFI_INVALID_PARAMETER DriverName is NULL.\r
\r
  @retval EFI_UNSUPPORTED       The driver specified by This does not support\r
                                the language specified by Language.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Ps2MouseComponentNameGetDriverName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,\r
  IN  CHAR8                        *Language,\r
  OUT CHAR16                       **DriverName\r
  )\r
{\r
  return LookupUnicodeString2 (\r
           Language,\r
           This->SupportedLanguages,\r
           mPs2MouseDriverNameTable,\r
           DriverName,\r
           (BOOLEAN)(This == &gPs2MouseComponentName)\r
           );\r
}\r
\r
/**\r
  Retrieves a Unicode string that is the user readable name of the controller\r
  that is being managed by a driver.\r
\r
  This function retrieves the user readable name of the controller specified by\r
  ControllerHandle and ChildHandle in the form of a Unicode string. If the\r
  driver specified by This has a user readable name in the language specified by\r
  Language, then a pointer to the controller name is returned in ControllerName,\r
  and EFI_SUCCESS is returned.  If the driver specified by This is not currently\r
  managing the controller specified by ControllerHandle and ChildHandle,\r
  then EFI_UNSUPPORTED is returned.  If the driver specified by This does not\r
  support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
\r
  @param  This[in]              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
                                EFI_COMPONENT_NAME_PROTOCOL instance.\r
\r
  @param  ControllerHandle[in]  The handle of a controller that the driver\r
                                specified by This is managing.  This handle\r
                                specifies the controller whose name is to be\r
                                returned.\r
\r
  @param  ChildHandle[in]       The handle of the child controller to retrieve\r
                                the name of.  This is an optional parameter that\r
                                may be NULL.  It will be NULL for device\r
                                drivers.  It will also be NULL for a bus drivers\r
                                that wish to retrieve the name of the bus\r
                                controller.  It will not be NULL for a bus\r
                                driver that wishes to retrieve the name of a\r
                                child controller.\r
\r
  @param  Language[in]          A pointer to a Null-terminated ASCII string\r
                                array indicating the language.  This is the\r
                                language of the driver name that the caller is\r
                                requesting, and it must match one of the\r
                                languages specified in SupportedLanguages. The\r
                                number of languages supported by a driver is up\r
                                to the driver writer. Language is specified in\r
                                RFC 4646 or ISO 639-2 language code format.\r
\r
  @param  ControllerName[out]   A pointer to the Unicode string to return.\r
                                This Unicode string is the name of the\r
                                controller specified by ControllerHandle and\r
                                ChildHandle in the language specified by\r
                                Language from the point of view of the driver\r
                                specified by This.\r
\r
  @retval EFI_SUCCESS           The Unicode string for the user readable name in\r
                                the language specified by Language for the\r
                                driver specified by This was returned in\r
                                DriverName.\r
\r
  @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.\r
\r
  @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
                                EFI_HANDLE.\r
\r
  @retval EFI_INVALID_PARAMETER Language is NULL.\r
\r
  @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r
\r
  @retval EFI_UNSUPPORTED       The driver specified by This is not currently\r
                                managing the controller specified by\r
                                ControllerHandle and ChildHandle.\r
\r
  @retval EFI_UNSUPPORTED       The driver specified by This does not support\r
                                the language specified by Language.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
Ps2MouseComponentNameGetControllerName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,\r
  IN  EFI_HANDLE                   ControllerHandle,\r
  IN  EFI_HANDLE                   ChildHandle        OPTIONAL,\r
  IN  CHAR8                        *Language,\r
  OUT CHAR16                       **ControllerName\r
  )\r
{\r
  EFI_STATUS                   Status;\r
  EFI_SIMPLE_POINTER_PROTOCOL  *SimplePointerProtocol;\r
  PS2_MOUSE_DEV                *MouseDev;\r
\r
  //\r
  // This is a device driver, so ChildHandle must be NULL.\r
  //\r
  if (ChildHandle != NULL) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  //\r
  // Check Controller's handle\r
  //\r
  Status = EfiTestManagedDevice (ControllerHandle, gPS2MouseDriver.DriverBindingHandle, &gEfiSioProtocolGuid);\r
\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  //\r
  // Get the device context\r
  //\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &gEfiSimplePointerProtocolGuid,\r
                  (VOID **)&SimplePointerProtocol,\r
                  gPS2MouseDriver.DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  MouseDev = PS2_MOUSE_DEV_FROM_THIS (SimplePointerProtocol);\r
\r
  return LookupUnicodeString2 (\r
           Language,\r
           This->SupportedLanguages,\r
           MouseDev->ControllerNameTable,\r
           ControllerName,\r
           (BOOLEAN)(This == &gPs2MouseComponentName)\r
           );\r
}\r
Commit	Line	Data
77833d0b RN	1	/** @file\r
	2	UEFI Component Name(2) protocol implementation for Ps2MouseDxe driver.\r
	3	\r
	4	Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
9d510e61	5	SPDX-License-Identifier: BSD-2-Clause-Patent\r
77833d0b RN	6	\r
	7	**/\r
	8	\r
	9	#include "Ps2Mouse.h"\r
	10	\r
	11	//\r
	12	// EFI Component Name Protocol\r
	13	//\r
	14	GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gPs2MouseComponentName = {\r
	15	Ps2MouseComponentNameGetDriverName,\r
	16	Ps2MouseComponentNameGetControllerName,\r
	17	"eng"\r
	18	};\r
	19	\r
	20	//\r
	21	// EFI Component Name 2 Protocol\r
	22	//\r
1436aea4 MK	23	GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gPs2MouseComponentName2 = {\r
	24	(EFI_COMPONENT_NAME2_GET_DRIVER_NAME)Ps2MouseComponentNameGetDriverName,\r
	25	(EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME)Ps2MouseComponentNameGetControllerName,\r
77833d0b RN	26	"en"\r
	27	};\r
	28	\r
1436aea4	29	GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mPs2MouseDriverNameTable[] = {\r
77833d0b RN	30	{\r
	31	"eng;en",\r
	32	L"PS/2 Mouse Driver"\r
	33	},\r
	34	{\r
	35	NULL,\r
	36	NULL\r
	37	}\r
	38	};\r
	39	\r
	40	/**\r
	41	Retrieves a Unicode string that is the user readable name of the driver.\r
	42	\r
	43	This function retrieves the user readable name of a driver in the form of a\r
	44	Unicode string. If the driver specified by This has a user readable name in\r
	45	the language specified by Language, then a pointer to the driver name is\r
	46	returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r
	47	by This does not support the language specified by Language,\r
	48	then EFI_UNSUPPORTED is returned.\r
	49	\r
	50	@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
	51	EFI_COMPONENT_NAME_PROTOCOL instance.\r
	52	\r
	53	@param Language[in] A pointer to a Null-terminated ASCII string\r
	54	array indicating the language. This is the\r
	55	language of the driver name that the caller is\r
	56	requesting, and it must match one of the\r
	57	languages specified in SupportedLanguages. The\r
	58	number of languages supported by a driver is up\r
	59	to the driver writer. Language is specified\r
	60	in RFC 4646 or ISO 639-2 language code format.\r
	61	\r
	62	@param DriverName[out] A pointer to the Unicode string to return.\r
	63	This Unicode string is the name of the\r
	64	driver specified by This in the language\r
	65	specified by Language.\r
	66	\r
	67	@retval EFI_SUCCESS The Unicode string for the Driver specified by\r
	68	This and the language specified by Language was\r
	69	returned in DriverName.\r
	70	\r
	71	@retval EFI_INVALID_PARAMETER Language is NULL.\r
	72	\r
	73	@retval EFI_INVALID_PARAMETER DriverName is NULL.\r
	74	\r
	75	@retval EFI_UNSUPPORTED The driver specified by This does not support\r
	76	the language specified by Language.\r
	77	\r
	78	**/\r
	79	EFI_STATUS\r
	80	EFIAPI\r
	81	Ps2MouseComponentNameGetDriverName (\r
	82	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
	83	IN CHAR8 *Language,\r
	84	OUT CHAR16 **DriverName\r
	85	)\r
	86	{\r
	87	return LookupUnicodeString2 (\r
	88	Language,\r
	89	This->SupportedLanguages,\r
	90	mPs2MouseDriverNameTable,\r
	91	DriverName,\r
	92	(BOOLEAN)(This == &gPs2MouseComponentName)\r
	93	);\r
94	}\r
95	\r
96	/**\r
97	Retrieves a Unicode string that is the user readable name of the controller\r
98	that is being managed by a driver.\r
99	\r
100	This function retrieves the user readable name of the controller specified by\r
101	ControllerHandle and ChildHandle in the form of a Unicode string. If the\r
102	driver specified by This has a user readable name in the language specified by\r
103	Language, then a pointer to the controller name is returned in ControllerName,\r
104	and EFI_SUCCESS is returned. If the driver specified by This is not currently\r
105	managing the controller specified by ControllerHandle and ChildHandle,\r
106	then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r
107	support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
108	\r
109	@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
110	EFI_COMPONENT_NAME_PROTOCOL instance.\r
111	\r
112	@param ControllerHandle[in] The handle of a controller that the driver\r
113	specified by This is managing. This handle\r
114	specifies the controller whose name is to be\r
115	returned.\r
116	\r
117	@param ChildHandle[in] The handle of the child controller to retrieve\r
118	the name of. This is an optional parameter that\r
119	may be NULL. It will be NULL for device\r
120	drivers. It will also be NULL for a bus drivers\r
121	that wish to retrieve the name of the bus\r
122	controller. It will not be NULL for a bus\r
123	driver that wishes to retrieve the name of a\r
124	child controller.\r
125	\r
126	@param Language[in] A pointer to a Null-terminated ASCII string\r
127	array indicating the language. This is the\r
128	language of the driver name that the caller is\r
129	requesting, and it must match one of the\r
130	languages specified in SupportedLanguages. The\r
131	number of languages supported by a driver is up\r
132	to the driver writer. Language is specified in\r
133	RFC 4646 or ISO 639-2 language code format.\r
134	\r
135	@param ControllerName[out] A pointer to the Unicode string to return.\r
136	This Unicode string is the name of the\r
137	controller specified by ControllerHandle and\r
138	ChildHandle in the language specified by\r
139	Language from the point of view of the driver\r
140	specified by This.\r
141	\r
142	@retval EFI_SUCCESS The Unicode string for the user readable name in\r
143	the language specified by Language for the\r
144	driver specified by This was returned in\r
145	DriverName.\r
146	\r
147	@retval EFI_INVALID_PARAMETER ControllerHandle is NULL.\r
148	\r
149	@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
150	EFI_HANDLE.\r
151	\r
152	@retval EFI_INVALID_PARAMETER Language is NULL.\r
153	\r
154	@retval EFI_INVALID_PARAMETER ControllerName is NULL.\r
155	\r
156	@retval EFI_UNSUPPORTED The driver specified by This is not currently\r
157	managing the controller specified by\r
158	ControllerHandle and ChildHandle.\r
159	\r
160	@retval EFI_UNSUPPORTED The driver specified by This does not support\r
161	the language specified by Language.\r
162	\r
163	**/\r
164	EFI_STATUS\r
165	EFIAPI\r
166	Ps2MouseComponentNameGetControllerName (\r
1436aea4 MK	167	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
	168	IN EFI_HANDLE ControllerHandle,\r
	169	IN EFI_HANDLE ChildHandle OPTIONAL,\r
	170	IN CHAR8 *Language,\r
	171	OUT CHAR16 **ControllerName\r
77833d0b RN	172	)\r
77833d0b RN	173	{\r
1436aea4 MK	174	EFI_STATUS Status;\r
	175	EFI_SIMPLE_POINTER_PROTOCOL *SimplePointerProtocol;\r
	176	PS2_MOUSE_DEV *MouseDev;\r
77833d0b RN	177	\r
	178	//\r
	179	// This is a device driver, so ChildHandle must be NULL.\r
	180	//\r
	181	if (ChildHandle != NULL) {\r
	182	return EFI_UNSUPPORTED;\r
	183	}\r
1436aea4	184	\r
77833d0b RN	185	//\r
	186	// Check Controller's handle\r
	187	//\r
	188	Status = EfiTestManagedDevice (ControllerHandle, gPS2MouseDriver.DriverBindingHandle, &gEfiSioProtocolGuid);\r
	189	\r
	190	if (EFI_ERROR (Status)) {\r
	191	return Status;\r
	192	}\r
1436aea4	193	\r
77833d0b RN	194	//\r
	195	// Get the device context\r
	196	//\r
	197	Status = gBS->OpenProtocol (\r
	198	ControllerHandle,\r
	199	&gEfiSimplePointerProtocolGuid,\r
1436aea4	200	(VOID **)&SimplePointerProtocol,\r
77833d0b RN	201	gPS2MouseDriver.DriverBindingHandle,\r
	202	ControllerHandle,\r
	203	EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
	204	);\r
	205	if (EFI_ERROR (Status)) {\r
	206	return Status;\r
	207	}\r
	208	\r
	209	MouseDev = PS2_MOUSE_DEV_FROM_THIS (SimplePointerProtocol);\r
	210	\r
	211	return LookupUnicodeString2 (\r
	212	Language,\r
	213	This->SupportedLanguages,\r
	214	MouseDev->ControllerNameTable,\r
	215	ControllerName,\r
	216	(BOOLEAN)(This == &gPs2MouseComponentName)\r
	217	);\r
	218	}\r