[mirror_edk2.git] / MdeModulePkg / Bus / Pci / UhciDxe / ComponentName.h

/** @file\r
\r
  This file contains the delarations for componet name routines.\r
\r
Copyright (c) 2008, 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\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
#ifndef _COMPONENT_NAME_H_\r
#define _COMPONENT_NAME_H_\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
UhciComponentNameGetDriverName (\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 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 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
UhciComponentNameGetControllerName (\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
#endif\r
Commit	Line	Data
aa79b0b3	1	/** @file\r
	2	\r
	3	This file contains the delarations for componet name routines.\r
	4	\r
cd5ebaa0 HT	5	Copyright (c) 2008, Intel Corporation. All rights reserved.<BR>\r
cd5ebaa0 HT	6	This program and the accompanying materials\r
aa79b0b3	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
	14	**/\r
	15	\r
	16	#ifndef _COMPONENT_NAME_H_\r
	17	#define _COMPONENT_NAME_H_\r
	18	\r
	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
	29	@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
	30	EFI_COMPONENT_NAME_PROTOCOL instance.\r
	31	\r
	32	@param Language[in] A pointer to a Null-terminated ASCII string\r
	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
aa79b0b3	40	\r
	41	@param DriverName[out] A pointer to the Unicode string to return.\r
	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
	58	EFI_STATUS\r
	59	EFIAPI\r
	60	UhciComponentNameGetDriverName (\r
	61	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
	62	IN CHAR8 *Language,\r
	63	OUT CHAR16 **DriverName\r
	64	);\r
	65	\r
	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
	80	@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
	81	EFI_COMPONENT_NAME_PROTOCOL instance.\r
	82	\r
	83	@param ControllerHandle[in] The handle of a controller that the driver\r
	84	specified by This is managing. This handle\r
	85	specifies the controller whose name is to be\r
	86	returned.\r
	87	\r
	88	@param ChildHandle[in] The handle of the child controller to retrieve\r
	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
	97	@param Language[in] A pointer to a Null-terminated ASCII string\r
	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
aa79b0b3	105	\r
	106	@param ControllerName[out] A pointer to the Unicode string to return.\r
	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
	135	EFI_STATUS\r
	136	EFIAPI\r
	137	UhciComponentNameGetControllerName (\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
	145	#endif\r