[mirror_edk2.git] / Nt32Pkg / WinNtSerialIoDxe / ComponentName.c

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