[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Isa / IsaBusDxe / ComponentName.h

/** @file\r
  Header file for implementation of UEFI Component Name(2) protocol.\r
\r
Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef _COMPONENT_NAME_H_\r
#define _COMPONENT_NAME_H_\r
\r
extern EFI_COMPONENT_NAME_PROTOCOL   gIsaBusComponentName;\r
extern EFI_COMPONENT_NAME2_PROTOCOL  gIsaBusComponentName2;\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
IsaBusComponentNameGetDriverName (\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 NULL.\r
\r
  @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
                                EFI_HANDLE.\r
\r
  @retval EFI_INVALID_PARAMETER Language is NULL.\r
\r
  @retval EFI_INVALID_PARAMETER ControllerName is NULL.\r
\r
  @retval EFI_UNSUPPORTED       The driver specified by This is not currently\r
                                managing the controller specified by\r
                                ControllerHandle and ChildHandle.\r
\r
  @retval EFI_UNSUPPORTED       The driver specified by This does not support\r
                                the language specified by Language.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
IsaBusComponentNameGetControllerName (\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
\r
Commit	Line	Data
0a2dfa19	1	/** @file\r
6fcb2d91	2	Header file for implementation of UEFI Component Name(2) protocol.\r
c3902377	3	\r
c2d9a4d2	4	Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r
c0a00b14	5	SPDX-License-Identifier: BSD-2-Clause-Patent\r
c3902377	6	\r
f8cd287b	7	**/\r
c3902377	8	\r
6fcb2d91	9	#ifndef _COMPONENT_NAME_H_\r
6fcb2d91	10	#define _COMPONENT_NAME_H_\r
c3902377	11	\r
f3d08ccf	12	extern EFI_COMPONENT_NAME_PROTOCOL gIsaBusComponentName;\r
f3d08ccf	13	extern EFI_COMPONENT_NAME2_PROTOCOL gIsaBusComponentName2;\r
c3902377	14	\r
f3d08ccf	15	/**\r
f3d08ccf	16	Retrieves a Unicode string that is the user readable name of the driver.\r
c3902377	17	\r
f3d08ccf	18	This function retrieves the user readable name of a driver in the form of a\r
	19	Unicode string. If the driver specified by This has a user readable name in\r
	20	the language specified by Language, then a pointer to the driver name is\r
	21	returned in DriverName, and EFI_SUCCESS is returned. If the driver specified\r
	22	by This does not support the language specified by Language,\r
	23	then EFI_UNSUPPORTED is returned.\r
c3902377	24	\r
f3d08ccf	25	@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
f3d08ccf	26	EFI_COMPONENT_NAME_PROTOCOL instance.\r
c3902377	27	\r
f3d08ccf	28	@param Language[in] A pointer to a Null-terminated ASCII string\r
	29	array indicating the language. This is the\r
	30	language of the driver name that the caller is\r
	31	requesting, and it must match one of the\r
	32	languages specified in SupportedLanguages. The\r
	33	number of languages supported by a driver is up\r
	34	to the driver writer. Language is specified\r
4bca47e1	35	in RFC 4646 or ISO 639-2 language code format.\r
c3902377	36	\r
f3d08ccf	37	@param DriverName[out] A pointer to the Unicode string to return.\r
	38	This Unicode string is the name of the\r
	39	driver specified by This in the language\r
	40	specified by Language.\r
c3902377	41	\r
f3d08ccf	42	@retval EFI_SUCCESS The Unicode string for the Driver specified by\r
	43	This and the language specified by Language was\r
	44	returned in DriverName.\r
c3902377	45	\r
f3d08ccf	46	@retval EFI_INVALID_PARAMETER Language is NULL.\r
c3902377	47	\r
f3d08ccf	48	@retval EFI_INVALID_PARAMETER DriverName is NULL.\r
	49	\r
	50	@retval EFI_UNSUPPORTED The driver specified by This does not support\r
	51	the language specified by Language.\r
	52	\r
	53	**/\r
	54	EFI_STATUS\r
	55	EFIAPI\r
	56	IsaBusComponentNameGetDriverName (\r
	57	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
	58	IN CHAR8 *Language,\r
	59	OUT CHAR16 **DriverName\r
	60	);\r
	61	\r
	62	\r
	63	/**\r
	64	Retrieves a Unicode string that is the user readable name of the controller\r
	65	that is being managed by a driver.\r
	66	\r
	67	This function retrieves the user readable name of the controller specified by\r
	68	ControllerHandle and ChildHandle in the form of a Unicode string. If the\r
	69	driver specified by This has a user readable name in the language specified by\r
	70	Language, then a pointer to the controller name is returned in ControllerName,\r
	71	and EFI_SUCCESS is returned. If the driver specified by This is not currently\r
	72	managing the controller specified by ControllerHandle and ChildHandle,\r
	73	then EFI_UNSUPPORTED is returned. If the driver specified by This does not\r
	74	support the language specified by Language, then EFI_UNSUPPORTED is returned.\r
	75	\r
	76	@param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or\r
	77	EFI_COMPONENT_NAME_PROTOCOL instance.\r
	78	\r
	79	@param ControllerHandle[in] The handle of a controller that the driver\r
	80	specified by This is managing. This handle\r
	81	specifies the controller whose name is to be\r
	82	returned.\r
	83	\r
	84	@param ChildHandle[in] The handle of the child controller to retrieve\r
	85	the name of. This is an optional parameter that\r
	86	may be NULL. It will be NULL for device\r
	87	drivers. It will also be NULL for a bus drivers\r
	88	that wish to retrieve the name of the bus\r
	89	controller. It will not be NULL for a bus\r
	90	driver that wishes to retrieve the name of a\r
	91	child controller.\r
	92	\r
	93	@param Language[in] A pointer to a Null-terminated ASCII string\r
	94	array indicating the language. This is the\r
	95	language of the driver name that the caller is\r
	96	requesting, and it must match one of the\r
	97	languages specified in SupportedLanguages. The\r
	98	number of languages supported by a driver is up\r
	99	to the driver writer. Language is specified in\r
4bca47e1	100	RFC 4646 or ISO 639-2 language code format.\r
f3d08ccf	101	\r
	102	@param ControllerName[out] A pointer to the Unicode string to return.\r
	103	This Unicode string is the name of the\r
	104	controller specified by ControllerHandle and\r
	105	ChildHandle in the language specified by\r
	106	Language from the point of view of the driver\r
	107	specified by This.\r
	108	\r
	109	@retval EFI_SUCCESS The Unicode string for the user readable name in\r
	110	the language specified by Language for the\r
	111	driver specified by This was returned in\r
	112	DriverName.\r
	113	\r
c2d9a4d2	114	@retval EFI_INVALID_PARAMETER ControllerHandle is NULL.\r
f3d08ccf	115	\r
	116	@retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid\r
	117	EFI_HANDLE.\r
	118	\r
	119	@retval EFI_INVALID_PARAMETER Language is NULL.\r
	120	\r
	121	@retval EFI_INVALID_PARAMETER ControllerName is NULL.\r
	122	\r
	123	@retval EFI_UNSUPPORTED The driver specified by This is not currently\r
	124	managing the controller specified by\r
	125	ControllerHandle and ChildHandle.\r
	126	\r
	127	@retval EFI_UNSUPPORTED The driver specified by This does not support\r
	128	the language specified by Language.\r
c3902377	129	\r
f3d08ccf	130	**/\r
c3902377	131	EFI_STATUS\r
	132	EFIAPI\r
	133	IsaBusComponentNameGetControllerName (\r
6fcb2d91	134	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
	135	IN EFI_HANDLE ControllerHandle,\r
	136	IN EFI_HANDLE ChildHandle OPTIONAL,\r
	137	IN CHAR8 *Language,\r
	138	OUT CHAR16 **ControllerName\r
f3d08ccf	139	);\r
c3902377	140	\r
c3902377	141	#endif\r
6fcb2d91	142	\r