[mirror_edk2.git] / MdeModulePkg / Universal / Network / Ip4Dxe / ComponentName.c

/** @file\r
  \r
Copyright (c) 2005 - 2007, Intel Corporation. All rights reserved.<BR>\r
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<BR>\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 "Ip4Impl.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[in]  This              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
                                EFI_COMPONENT_NAME_PROTOCOL instance.\r
\r
  @param[in]  Language          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[out]  DriverName       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
Ip4ComponentNameGetDriverName (\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[in]  This              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
                                EFI_COMPONENT_NAME_PROTOCOL instance.\r
\r
  @param[in]  ControllerHandle  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[in]  ChildHandle       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[in]  Language          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[out]  ControllerName   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
Ip4ComponentNameGetControllerName (\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  gIp4ComponentName = {\r
  Ip4ComponentNameGetDriverName,\r
  Ip4ComponentNameGetControllerName,\r
  "eng"\r
};\r
\r
//\r
// EFI Component Name 2 Protocol\r
//\r
GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gIp4ComponentName2 = {\r
  (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) Ip4ComponentNameGetDriverName,\r
  (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) Ip4ComponentNameGetControllerName,\r
  "en"\r
};\r
\r
\r
GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mIp4DriverNameTable[] = {\r
  {\r
    "eng;en",\r
    L"IP4 Network Service 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[in]  This              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
                                EFI_COMPONENT_NAME_PROTOCOL instance.\r
\r
  @param[in]  Language          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[out]  DriverName       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
Ip4ComponentNameGetDriverName (\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
           mIp4DriverNameTable,\r
           DriverName,\r
           (BOOLEAN)(This == &gIp4ComponentName)\r
           );\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[in]  This              A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
                                EFI_COMPONENT_NAME_PROTOCOL instance.\r
\r
  @param[in]  ControllerHandle  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[in]  ChildHandle       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[in]  Language          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[out]  ControllerName   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
Ip4ComponentNameGetControllerName (\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
  return EFI_UNSUPPORTED;\r
}\r
Commit	Line	Data
772db4bb	1	/** @file\r
3e8c18da	2	\r
e5eed7d3 HT	3	Copyright (c) 2005 - 2007, Intel Corporation. All rights reserved.<BR>\r
e5eed7d3 HT	4	This program and the accompanying materials\r
772db4bb	5	are licensed and made available under the terms and conditions of the BSD License\r
3e8c18da	6	which accompanies this distribution. The full text of the license may be found at<BR>\r
772db4bb	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
772db4bb	12	**/\r
	13	\r
	14	#include "Ip4Impl.h"\r
	15	\r
	16	//\r
	17	// EFI Component Name Functions\r
	18	//\r
83cbd279	19	/**\r
	20	Retrieves a Unicode string that is the user readable name of the driver.\r
	21	\r
	22	This function retrieves the user readable name of a driver in the form of a\r
	23	Unicode string. If the driver specified by This has a user readable name in\r
	24	the language specified by Language, then a pointer to the driver name is\r
	25	returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r
	26	by This does not support the language specified by Language,\r
	27	then EFI_UNSUPPORTED is returned.\r
	28	\r
3e8c18da	29	@param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
83cbd279	30	EFI_COMPONENT_NAME_PROTOCOL instance.\r
83cbd279	31	\r
3e8c18da	32	@param[in] Language A pointer to a Null-terminated ASCII string\r
83cbd279	33	array indicating the language. This is the\r
	34	language of the driver name that the caller is\r
	35	requesting, and it must match one of the\r
	36	languages specified in SupportedLanguages. The\r
	37	number of languages supported by a driver is up\r
	38	to the driver writer. Language is specified\r
0254efc0	39	in RFC 4646 or ISO 639-2 language code format.\r
83cbd279	40	\r
3e8c18da	41	@param[out] DriverName A pointer to the Unicode string to return.\r
83cbd279	42	This Unicode string is the name of the\r
	43	driver specified by This in the language\r
	44	specified by Language.\r
	45	\r
	46	@retval EFI_SUCCESS The Unicode string for the Driver specified by\r
	47	This and the language specified by Language was\r
	48	returned in DriverName.\r
	49	\r
	50	@retval EFI_INVALID_PARAMETER Language is NULL.\r
	51	\r
	52	@retval EFI_INVALID_PARAMETER DriverName is NULL.\r
	53	\r
	54	@retval EFI_UNSUPPORTED The driver specified by This does not support\r
	55	the language specified by Language.\r
	56	\r
	57	**/\r
772db4bb	58	EFI_STATUS\r
	59	EFIAPI\r
	60	Ip4ComponentNameGetDriverName (\r
	61	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
	62	IN CHAR8 *Language,\r
	63	OUT CHAR16 **DriverName\r
	64	);\r
	65	\r
83cbd279	66	\r
	67	/**\r
	68	Retrieves a Unicode string that is the user readable name of the controller\r
	69	that is being managed by a driver.\r
	70	\r
	71	This function retrieves the user readable name of the controller specified by\r
	72	ControllerHandle and ChildHandle in the form of a Unicode string. If the\r
	73	driver specified by This has a user readable name in the language specified by\r
	74	Language, then a pointer to the controller name is returned in ControllerName,\r
	75	and EFI_SUCCESS is returned. If the driver specified by This is not currently\r
	76	managing the controller specified by ControllerHandle and ChildHandle,\r
	77	then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r
	78	support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
	79	\r
3e8c18da	80	@param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
83cbd279	81	EFI_COMPONENT_NAME_PROTOCOL instance.\r
83cbd279	82	\r
3e8c18da	83	@param[in] ControllerHandle The handle of a controller that the driver\r
83cbd279	84	specified by This is managing. This handle\r
	85	specifies the controller whose name is to be\r
	86	returned.\r
	87	\r
3e8c18da	88	@param[in] ChildHandle The handle of the child controller to retrieve\r
83cbd279	89	the name of. This is an optional parameter that\r
	90	may be NULL. It will be NULL for device\r
	91	drivers. It will also be NULL for a bus drivers\r
	92	that wish to retrieve the name of the bus\r
	93	controller. It will not be NULL for a bus\r
	94	driver that wishes to retrieve the name of a\r
	95	child controller.\r
	96	\r
3e8c18da	97	@param[in] Language A pointer to a Null-terminated ASCII string\r
83cbd279	98	array indicating the language. This is the\r
	99	language of the driver name that the caller is\r
	100	requesting, and it must match one of the\r
	101	languages specified in SupportedLanguages. The\r
	102	number of languages supported by a driver is up\r
	103	to the driver writer. Language is specified in\r
0254efc0	104	RFC 4646 or ISO 639-2 language code format.\r
83cbd279	105	\r
3e8c18da	106	@param[out] ControllerName A pointer to the Unicode string to return.\r
83cbd279	107	This Unicode string is the name of the\r
	108	controller specified by ControllerHandle and\r
	109	ChildHandle in the language specified by\r
	110	Language from the point of view of the driver\r
	111	specified by This.\r
	112	\r
	113	@retval EFI_SUCCESS The Unicode string for the user readable name in\r
	114	the language specified by Language for the\r
	115	driver specified by This was returned in\r
	116	DriverName.\r
	117	\r
	118	@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
	119	\r
	120	@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
	121	EFI_HANDLE.\r
	122	\r
	123	@retval EFI_INVALID_PARAMETER Language is NULL.\r
	124	\r
	125	@retval EFI_INVALID_PARAMETER ControllerName is NULL.\r
	126	\r
	127	@retval EFI_UNSUPPORTED The driver specified by This is not currently\r
	128	managing the controller specified by\r
	129	ControllerHandle and ChildHandle.\r
	130	\r
	131	@retval EFI_UNSUPPORTED The driver specified by This does not support\r
	132	the language specified by Language.\r
	133	\r
	134	**/\r
772db4bb	135	EFI_STATUS\r
	136	EFIAPI\r
	137	Ip4ComponentNameGetControllerName (\r
	138	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
	139	IN EFI_HANDLE ControllerHandle,\r
	140	IN EFI_HANDLE ChildHandle OPTIONAL,\r
	141	IN CHAR8 *Language,\r
	142	OUT CHAR16 **ControllerName\r
	143	);\r
	144	\r
83cbd279	145	\r
772db4bb	146	//\r
	147	// EFI Component Name Protocol\r
	148	//\r
1307dcd7	149	GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME_PROTOCOL gIp4ComponentName = {\r
772db4bb	150	Ip4ComponentNameGetDriverName,\r
	151	Ip4ComponentNameGetControllerName,\r
	152	"eng"\r
1307dcd7	153	};\r
83cbd279	154	\r
	155	//\r
	156	// EFI Component Name 2 Protocol\r
	157	//\r
1307dcd7	158	GLOBAL_REMOVE_IF_UNREFERENCED EFI_COMPONENT_NAME2_PROTOCOL gIp4ComponentName2 = {\r
83cbd279	159	(EFI_COMPONENT_NAME2_GET_DRIVER_NAME) Ip4ComponentNameGetDriverName,\r
	160	(EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) Ip4ComponentNameGetControllerName,\r
	161	"en"\r
1307dcd7	162	};\r
83cbd279	163	\r
772db4bb	164	\r
d1aeb0bd	165	GLOBAL_REMOVE_IF_UNREFERENCED EFI_UNICODE_STRING_TABLE mIp4DriverNameTable[] = {\r
772db4bb	166	{\r
83cbd279	167	"eng;en",\r
772db4bb	168	L"IP4 Network Service Driver"\r
	169	},\r
	170	{\r
	171	NULL,\r
	172	NULL\r
	173	}\r
	174	};\r
	175	\r
83cbd279	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
3e8c18da	186	@param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
83cbd279	187	EFI_COMPONENT_NAME_PROTOCOL instance.\r
83cbd279	188	\r
3e8c18da	189	@param[in] Language A pointer to a Null-terminated ASCII string\r
83cbd279	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
0254efc0	196	in RFC 4646 or ISO 639-2 language code format.\r
83cbd279	197	\r
3e8c18da	198	@param[out] DriverName A pointer to the Unicode string to return.\r
83cbd279	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
772db4bb	215	EFI_STATUS\r
	216	EFIAPI\r
	217	Ip4ComponentNameGetDriverName (\r
	218	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
	219	IN CHAR8 *Language,\r
	220	OUT CHAR16 **DriverName\r
	221	)\r
772db4bb	222	{\r
83cbd279	223	return LookupUnicodeString2 (\r
	224	Language,\r
	225	This->SupportedLanguages,\r
	226	mIp4DriverNameTable,\r
	227	DriverName,\r
	228	(BOOLEAN)(This == &gIp4ComponentName)\r
	229	);\r
772db4bb	230	\r
	231	}\r
	232	\r
83cbd279	233	/**\r
	234	Retrieves a Unicode string that is the user readable name of the controller\r
	235	that is being managed by a driver.\r
	236	\r
	237	This function retrieves the user readable name of the controller specified by\r
	238	ControllerHandle and ChildHandle in the form of a Unicode string. If the\r
	239	driver specified by This has a user readable name in the language specified by\r
	240	Language, then a pointer to the controller name is returned in ControllerName,\r
	241	and EFI_SUCCESS is returned. If the driver specified by This is not currently\r
	242	managing the controller specified by ControllerHandle and ChildHandle,\r
	243	then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r
	244	support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
	245	\r
3e8c18da	246	@param[in] This A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
83cbd279	247	EFI_COMPONENT_NAME_PROTOCOL instance.\r
83cbd279	248	\r
3e8c18da	249	@param[in] ControllerHandle The handle of a controller that the driver\r
83cbd279	250	specified by This is managing. This handle\r
	251	specifies the controller whose name is to be\r
	252	returned.\r
	253	\r
3e8c18da	254	@param[in] ChildHandle The handle of the child controller to retrieve\r
83cbd279	255	the name of. This is an optional parameter that\r
	256	may be NULL. It will be NULL for device\r
	257	drivers. It will also be NULL for a bus drivers\r
	258	that wish to retrieve the name of the bus\r
	259	controller. It will not be NULL for a bus\r
	260	driver that wishes to retrieve the name of a\r
	261	child controller.\r
	262	\r
3e8c18da	263	@param[in] Language A pointer to a Null-terminated ASCII string\r
83cbd279	264	array indicating the language. This is the\r
	265	language of the driver name that the caller is\r
	266	requesting, and it must match one of the\r
	267	languages specified in SupportedLanguages. The\r
	268	number of languages supported by a driver is up\r
	269	to the driver writer. Language is specified in\r
0254efc0	270	RFC 4646 or ISO 639-2 language code format.\r
83cbd279	271	\r
3e8c18da	272	@param[out] ControllerName A pointer to the Unicode string to return.\r
83cbd279	273	This Unicode string is the name of the\r
	274	controller specified by ControllerHandle and\r
	275	ChildHandle in the language specified by\r
	276	Language from the point of view of the driver\r
	277	specified by This.\r
	278	\r
	279	@retval EFI_SUCCESS The Unicode string for the user readable name in\r
	280	the language specified by Language for the\r
	281	driver specified by This was returned in\r
	282	DriverName.\r
	283	\r
	284	@retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.\r
	285	\r
	286	@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
	287	EFI_HANDLE.\r
	288	\r
	289	@retval EFI_INVALID_PARAMETER Language is NULL.\r
	290	\r
	291	@retval EFI_INVALID_PARAMETER ControllerName is NULL.\r
	292	\r
	293	@retval EFI_UNSUPPORTED The driver specified by This is not currently\r
	294	managing the controller specified by\r
	295	ControllerHandle and ChildHandle.\r
	296	\r
	297	@retval EFI_UNSUPPORTED The driver specified by This does not support\r
	298	the language specified by Language.\r
	299	\r
	300	**/\r
772db4bb	301	EFI_STATUS\r
	302	EFIAPI\r
	303	Ip4ComponentNameGetControllerName (\r
	304	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
	305	IN EFI_HANDLE ControllerHandle,\r
	306	IN EFI_HANDLE ChildHandle OPTIONAL,\r
	307	IN CHAR8 *Language,\r
	308	OUT CHAR16 **ControllerName\r
	309	)\r
772db4bb	310	{\r
	311	return EFI_UNSUPPORTED;\r
	312	}\r