[mirror_edk2.git] / MdeModulePkg / Bus / Usb / UsbMouseDxe / ComponentName.c

/** @file\r
\r
  UEFI Component Name(2) protocol implementation for Usb Mouse driver.\r
\r
Copyright (c) 2004 - 2008, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#include "UsbMouse.h"\r
#include <Library/DebugLib.h>\r
\r
//\r
// EFI Component Name Functions\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 3066 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
UsbMouseComponentNameGetDriverName (\r
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,\r
  IN  CHAR8                        *Language,\r
  OUT CHAR16                       **DriverName\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 3066 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 not a valid EFI_HANDLE.\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
UsbMouseComponentNameGetControllerName (\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
\r
//\r
// EFI Component Name Protocol\r
//\r
GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL  gUsbMouseComponentName = {\r
  UsbMouseComponentNameGetDriverName,\r
  UsbMouseComponentNameGetControllerName,\r
  "eng"\r
};\r
\r
//\r
// EFI Component Name 2 Protocol\r
//\r
GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gUsbMouseComponentName2 = {\r
  (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) UsbMouseComponentNameGetDriverName,\r
  (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) UsbMouseComponentNameGetControllerName,\r
  "en"\r
};\r
\r
\r
\r
GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mUsbMouseDriverNameTable[] = {\r
  { "eng;en", L"Usb Mouse Driver" },\r
  { NULL , 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 3066 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
UsbMouseComponentNameGetDriverName (\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
           mUsbMouseDriverNameTable,\r
           DriverName,\r
           (BOOLEAN)(This == &gUsbMouseComponentName)\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 3066 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 not a valid EFI_HANDLE.\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
UsbMouseComponentNameGetControllerName (\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
  USB_MOUSE_DEV               *UsbMouseDev;\r
  EFI_SIMPLE_POINTER_PROTOCOL *SimplePointerProtocol;\r
  EFI_USB_IO_PROTOCOL         *UsbIoProtocol;\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 = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                  &gEfiUsbIoProtocolGuid,\r
                  (VOID **) &UsbIoProtocol,\r
                  gUsbMouseDriverBinding.DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_BY_DRIVER\r
                  );\r
  if (!EFI_ERROR (Status)) {\r
    gBS->CloseProtocol (\r
          ControllerHandle,\r
          &gEfiUsbIoProtocolGuid,\r
          gUsbMouseDriverBinding.DriverBindingHandle,\r
          ControllerHandle\r
          );\r
\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  if (Status != EFI_ALREADY_STARTED) {\r
    return EFI_UNSUPPORTED;\r
  }\r
  //\r
  // Get the device context\r
  //\r
  Status = gBS->OpenProtocol (\r
                  ControllerHandle,\r
                 &gEfiSimplePointerProtocolGuid,\r
                  (VOID **) &SimplePointerProtocol,\r
                  gUsbMouseDriverBinding.DriverBindingHandle,\r
                  ControllerHandle,\r
                  EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
                  );\r
\r
  if (EFI_ERROR (Status)) {\r
    return Status;\r
  }\r
\r
  UsbMouseDev = USB_MOUSE_DEV_FROM_MOUSE_PROTOCOL (SimplePointerProtocol);\r
\r
  return LookupUnicodeString2 (\r
           Language,\r
           This->SupportedLanguages,\r
           UsbMouseDev->ControllerNameTable,\r
           ControllerName,\r
           (BOOLEAN)(This == &gUsbMouseComponentName)\r
           );\r
\r
}\r
Commit	Line	Data
ed838d0c	1	/** @file\r
ed838d0c	2	\r
bb80e3b2	3	UEFI Component Name(2) protocol implementation for Usb Mouse driver.\r
	4	\r
	5	Copyright (c) 2004 - 2008, Intel Corporation\r
ed838d0c	6	All rights reserved. This program and the accompanying materials\r
	7	are licensed and made available under the terms and conditions of the BSD License\r
	8	which accompanies this distribution. The full text of the license may be found at\r
	9	http://opensource.org/licenses/bsd-license.php\r
	10	\r
	11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	13	\r
ed838d0c	14	**/\r
ed838d0c	15	\r
c4b578e8	16	#include "UsbMouse.h"\r
ed838d0c	17	#include <Library/DebugLib.h>\r
	18	\r
	19	//\r
	20	// EFI Component Name Functions\r
	21	//\r
62b9bb55	22	/**\r
	23	Retrieves a Unicode string that is the user readable name of the driver.\r
	24	\r
	25	This function retrieves the user readable name of a driver in the form of a\r
	26	Unicode string. If the driver specified by This has a user readable name in\r
	27	the language specified by Language, then a pointer to the driver name is\r
	28	returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r
	29	by This does not support the language specified by Language,\r
	30	then EFI_UNSUPPORTED is returned.\r
	31	\r
	32	@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
	33	EFI_COMPONENT_NAME_PROTOCOL instance.\r
	34	\r
	35	@param Language[in] A pointer to a Null-terminated ASCII string\r
	36	array indicating the language. This is the\r
	37	language of the driver name that the caller is\r
	38	requesting, and it must match one of the\r
	39	languages specified in SupportedLanguages. The\r
	40	number of languages supported by a driver is up\r
	41	to the driver writer. Language is specified\r
	42	in RFC 3066 or ISO 639-2 language code format.\r
	43	\r
	44	@param DriverName[out] A pointer to the Unicode string to return.\r
	45	This Unicode string is the name of the\r
	46	driver specified by This in the language\r
	47	specified by Language.\r
	48	\r
	49	@retval EFI_SUCCESS The Unicode string for the Driver specified by\r
	50	This and the language specified by Language was\r
	51	returned in DriverName.\r
	52	\r
	53	@retval EFI_INVALID_PARAMETER Language is NULL.\r
	54	\r
	55	@retval EFI_INVALID_PARAMETER DriverName is NULL.\r
	56	\r
	57	@retval EFI_UNSUPPORTED The driver specified by This does not support\r
	58	the language specified by Language.\r
	59	\r
	60	**/\r
ed838d0c	61	EFI_STATUS\r
	62	EFIAPI\r
	63	UsbMouseComponentNameGetDriverName (\r
	64	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
	65	IN CHAR8 *Language,\r
	66	OUT CHAR16 **DriverName\r
	67	);\r
	68	\r
62b9bb55	69	\r
	70	/**\r
	71	Retrieves a Unicode string that is the user readable name of the controller\r
	72	that is being managed by a driver.\r
	73	\r
	74	This function retrieves the user readable name of the controller specified by\r
	75	ControllerHandle and ChildHandle in the form of a Unicode string. If the\r
	76	driver specified by This has a user readable name in the language specified by\r
	77	Language, then a pointer to the controller name is returned in ControllerName,\r
	78	and EFI_SUCCESS is returned. If the driver specified by This is not currently\r
	79	managing the controller specified by ControllerHandle and ChildHandle,\r
	80	then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r
	81	support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
	82	\r
	83	@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
	84	EFI_COMPONENT_NAME_PROTOCOL instance.\r
	85	\r
	86	@param ControllerHandle[in] The handle of a controller that the driver\r
	87	specified by This is managing. This handle\r
	88	specifies the controller whose name is to be\r
	89	returned.\r
	90	\r
	91	@param ChildHandle[in] The handle of the child controller to retrieve\r
	92	the name of. This is an optional parameter that\r
	93	may be NULL. It will be NULL for device\r
	94	drivers. It will also be NULL for a bus drivers\r
	95	that wish to retrieve the name of the bus\r
	96	controller. It will not be NULL for a bus\r
	97	driver that wishes to retrieve the name of a\r
	98	child controller.\r
	99	\r
	100	@param Language[in] A pointer to a Null-terminated ASCII string\r
	101	array indicating the language. This is the\r
	102	language of the driver name that the caller is\r
	103	requesting, and it must match one of the\r
	104	languages specified in SupportedLanguages. The\r
	105	number of languages supported by a driver is up\r
	106	to the driver writer. Language is specified in\r
	107	RFC 3066 or ISO 639-2 language code format.\r
	108	\r
	109	@param ControllerName[out] A pointer to the Unicode string to return.\r
	110	This Unicode string is the name of the\r
	111	controller specified by ControllerHandle and\r
	112	ChildHandle in the language specified by\r
	113	Language from the point of view of the driver\r
	114	specified by This.\r
	115	\r
	116	@retval EFI_SUCCESS The Unicode string for the user readable name in\r
	117	the language specified by Language for the\r
	118	driver specified by This was returned in\r
	119	DriverName.\r
	120	\r
	121	@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
	122	\r
	123	@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
	124	EFI_HANDLE.\r
	125	\r
	126	@retval EFI_INVALID_PARAMETER Language is NULL.\r
	127	\r
	128	@retval EFI_INVALID_PARAMETER ControllerName is NULL.\r
	129	\r
	130	@retval EFI_UNSUPPORTED The driver specified by This is not currently\r
	131	managing the controller specified by\r
	132	ControllerHandle and ChildHandle.\r
133	\r
134	@retval EFI_UNSUPPORTED The driver specified by This does not support\r
135	the language specified by Language.\r
136	\r
137	**/\r
ed838d0c	138	EFI_STATUS\r
	139	EFIAPI\r
	140	UsbMouseComponentNameGetControllerName (\r
	141	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
	142	IN EFI_HANDLE ControllerHandle,\r
	143	IN EFI_HANDLE ChildHandle OPTIONAL,\r
	144	IN CHAR8 *Language,\r
	145	OUT CHAR16 **ControllerName\r
	146	);\r
	147	\r
62b9bb55	148	\r
ed838d0c	149	//\r
	150	// EFI Component Name Protocol\r
	151	//\r
1307dcd7	152	GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gUsbMouseComponentName = {\r
ed838d0c	153	UsbMouseComponentNameGetDriverName,\r
	154	UsbMouseComponentNameGetControllerName,\r
	155	"eng"\r
1307dcd7	156	};\r
62b9bb55	157	\r
	158	//\r
	159	// EFI Component Name 2 Protocol\r
	160	//\r
1307dcd7	161	GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gUsbMouseComponentName2 = {\r
62b9bb55	162	(EFI_COMPONENT_NAME2_GET_DRIVER_NAME) UsbMouseComponentNameGetDriverName,\r
	163	(EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) UsbMouseComponentNameGetControllerName,\r
	164	"en"\r
1307dcd7	165	};\r
62b9bb55	166	\r
ed838d0c	167	\r
ed838d0c	168	\r
d1aeb0bd	169	GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mUsbMouseDriverNameTable[] = {\r
62b9bb55	170	{ "eng;en", L"Usb Mouse Driver" },\r
ed838d0c	171	{ NULL , NULL }\r
	172	};\r
	173	\r
	174	\r
62b9bb55	175	/**\r
	176	Retrieves a Unicode string that is the user readable name of the driver.\r
	177	\r
	178	This function retrieves the user readable name of a driver in the form of a\r
	179	Unicode string. If the driver specified by This has a user readable name in\r
	180	the language specified by Language, then a pointer to the driver name is\r
	181	returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r
	182	by This does not support the language specified by Language,\r
	183	then EFI_UNSUPPORTED is returned.\r
	184	\r
	185	@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
	186	EFI_COMPONENT_NAME_PROTOCOL instance.\r
	187	\r
	188	@param Language[in] A pointer to a Null-terminated ASCII string\r
	189	array indicating the language. This is the\r
	190	language of the driver name that the caller is\r
	191	requesting, and it must match one of the\r
	192	languages specified in SupportedLanguages. The\r
	193	number of languages supported by a driver is up\r
	194	to the driver writer. Language is specified\r
	195	in RFC 3066 or ISO 639-2 language code format.\r
	196	\r
	197	@param DriverName[out] A pointer to the Unicode string to return.\r
	198	This Unicode string is the name of the\r
	199	driver specified by This in the language\r
	200	specified by Language.\r
	201	\r
	202	@retval EFI_SUCCESS The Unicode string for the Driver specified by\r
	203	This and the language specified by Language was\r
	204	returned in DriverName.\r
	205	\r
	206	@retval EFI_INVALID_PARAMETER Language is NULL.\r
	207	\r
	208	@retval EFI_INVALID_PARAMETER DriverName is NULL.\r
	209	\r
	210	@retval EFI_UNSUPPORTED The driver specified by This does not support\r
	211	the language specified by Language.\r
	212	\r
	213	**/\r
ed838d0c	214	EFI_STATUS\r
	215	EFIAPI\r
	216	UsbMouseComponentNameGetDriverName (\r
	217	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
	218	IN CHAR8 *Language,\r
	219	OUT CHAR16 **DriverName\r
	220	)\r
ed838d0c	221	{\r
62b9bb55	222	return LookupUnicodeString2 (\r
	223	Language,\r
	224	This->SupportedLanguages,\r
	225	mUsbMouseDriverNameTable,\r
	226	DriverName,\r
	227	(BOOLEAN)(This == &gUsbMouseComponentName)\r
	228	);\r
ed838d0c	229	}\r
ed838d0c	230	\r
62b9bb55	231	/**\r
	232	Retrieves a Unicode string that is the user readable name of the controller\r
	233	that is being managed by a driver.\r
	234	\r
	235	This function retrieves the user readable name of the controller specified by\r
	236	ControllerHandle and ChildHandle in the form of a Unicode string. If the\r
	237	driver specified by This has a user readable name in the language specified by\r
	238	Language, then a pointer to the controller name is returned in ControllerName,\r
	239	and EFI_SUCCESS is returned. If the driver specified by This is not currently\r
	240	managing the controller specified by ControllerHandle and ChildHandle,\r
	241	then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r
	242	support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
	243	\r
	244	@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
	245	EFI_COMPONENT_NAME_PROTOCOL instance.\r
	246	\r
	247	@param ControllerHandle[in] The handle of a controller that the driver\r
	248	specified by This is managing. This handle\r
	249	specifies the controller whose name is to be\r
	250	returned.\r
	251	\r
	252	@param ChildHandle[in] The handle of the child controller to retrieve\r
	253	the name of. This is an optional parameter that\r
	254	may be NULL. It will be NULL for device\r
	255	drivers. It will also be NULL for a bus drivers\r
	256	that wish to retrieve the name of the bus\r
	257	controller. It will not be NULL for a bus\r
	258	driver that wishes to retrieve the name of a\r
	259	child controller.\r
	260	\r
	261	@param Language[in] A pointer to a Null-terminated ASCII string\r
	262	array indicating the language. This is the\r
	263	language of the driver name that the caller is\r
	264	requesting, and it must match one of the\r
	265	languages specified in SupportedLanguages. The\r
	266	number of languages supported by a driver is up\r
	267	to the driver writer. Language is specified in\r
	268	RFC 3066 or ISO 639-2 language code format.\r
	269	\r
	270	@param ControllerName[out] A pointer to the Unicode string to return.\r
	271	This Unicode string is the name of the\r
	272	controller specified by ControllerHandle and\r
	273	ChildHandle in the language specified by\r
	274	Language from the point of view of the driver\r
	275	specified by This.\r
	276	\r
	277	@retval EFI_SUCCESS The Unicode string for the user readable name in\r
	278	the language specified by Language for the\r
	279	driver specified by This was returned in\r
	280	DriverName.\r
	281	\r
	282	@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
	283	\r
	284	@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
	285	EFI_HANDLE.\r
	286	\r
	287	@retval EFI_INVALID_PARAMETER Language is NULL.\r
	288	\r
	289	@retval EFI_INVALID_PARAMETER ControllerName is NULL.\r
	290	\r
	291	@retval EFI_UNSUPPORTED The driver specified by This is not currently\r
	292	managing the controller specified by\r
	293	ControllerHandle and ChildHandle.\r
	294	\r
295	@retval EFI_UNSUPPORTED The driver specified by This does not support\r
296	the language specified by Language.\r
297	\r
298	**/\r
ed838d0c	299	EFI_STATUS\r
	300	EFIAPI\r
	301	UsbMouseComponentNameGetControllerName (\r
	302	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
	303	IN EFI_HANDLE ControllerHandle,\r
	304	IN EFI_HANDLE ChildHandle OPTIONAL,\r
	305	IN CHAR8 *Language,\r
	306	OUT CHAR16 **ControllerName\r
	307	)\r
ed838d0c	308	{\r
	309	EFI_STATUS Status;\r
	310	USB_MOUSE_DEV *UsbMouseDev;\r
	311	EFI_SIMPLE_POINTER_PROTOCOL *SimplePointerProtocol;\r
	312	EFI_USB_IO_PROTOCOL *UsbIoProtocol;\r
	313	\r
	314	//\r
	315	// This is a device driver, so ChildHandle must be NULL.\r
	316	//\r
	317	if (ChildHandle != NULL) {\r
	318	return EFI_UNSUPPORTED;\r
	319	}\r
	320	\r
	321	//\r
	322	// Check Controller's handle\r
	323	//\r
	324	Status = gBS->OpenProtocol (\r
	325	ControllerHandle,\r
	326	&gEfiUsbIoProtocolGuid,\r
	327	(VOID **) &UsbIoProtocol,\r
	328	gUsbMouseDriverBinding.DriverBindingHandle,\r
	329	ControllerHandle,\r
	330	EFI_OPEN_PROTOCOL_BY_DRIVER\r
	331	);\r
	332	if (!EFI_ERROR (Status)) {\r
	333	gBS->CloseProtocol (\r
	334	ControllerHandle,\r
	335	&gEfiUsbIoProtocolGuid,\r
	336	gUsbMouseDriverBinding.DriverBindingHandle,\r
	337	ControllerHandle\r
	338	);\r
	339	\r
	340	return EFI_UNSUPPORTED;\r
	341	}\r
	342	\r
	343	if (Status != EFI_ALREADY_STARTED) {\r
	344	return EFI_UNSUPPORTED;\r
	345	}\r
	346	//\r
	347	// Get the device context\r
	348	//\r
	349	Status = gBS->OpenProtocol (\r
	350	ControllerHandle,\r
	351	&gEfiSimplePointerProtocolGuid,\r
	352	(VOID **) &SimplePointerProtocol,\r
	353	gUsbMouseDriverBinding.DriverBindingHandle,\r
	354	ControllerHandle,\r
	355	EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
	356	);\r
	357	\r
	358	if (EFI_ERROR (Status)) {\r
	359	return Status;\r
	360	}\r
	361	\r
	362	UsbMouseDev = USB_MOUSE_DEV_FROM_MOUSE_PROTOCOL (SimplePointerProtocol);\r
	363	\r
62b9bb55	364	return LookupUnicodeString2 (\r
	365	Language,\r
	366	This->SupportedLanguages,\r
	367	UsbMouseDev->ControllerNameTable,\r
	368	ControllerName,\r
	369	(BOOLEAN)(This == &gUsbMouseComponentName)\r
	370	);\r
ed838d0c	371	\r
ed838d0c	372	}\r