/** @file\r
- Copyright (c) 2006, Intel Corporation\r
- All rights reserved. This program and the accompanying materials\r
+ \r
+ UEFI Component Name(2) protocol implementation header file for IDE Bus driver.\r
+ \r
+ Copyright (c) 2006, 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
**/\r
\r
-#ifndef _IDE_BUS_COMPONENT_NAME_H\r
-#define _IDE_BUS_COMPONENT_NAME_H\r
+#ifndef _IDE_BUS_COMPONENT_NAME_H_\r
+#define _IDE_BUS_COMPONENT_NAME_H_\r
\r
-#define ADD_NAME(x) AddName ((x));\r
+#define ADD_IDE_ATAPI_NAME(x) AddName ((x));\r
\r
-extern EFI_COMPONENT_NAME_PROTOCOL gIDEBusComponentName;\r
+extern EFI_COMPONENT_NAME_PROTOCOL gIDEBusComponentName;\r
+extern EFI_COMPONENT_NAME2_PROTOCOL gIDEBusComponentName2;\r
\r
\r
//\r
// EFI Component Name Functions\r
//\r
/**\r
- TODO: Add function description\r
+ Retrieves a Unicode string that is the user readable name of the driver.\r
\r
- @param This TODO: add argument description\r
- @param Language TODO: add argument description\r
- @param DriverName TODO: add argument description\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
- TODO: add return values\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
IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
IN CHAR8 *Language,\r
OUT CHAR16 **DriverName\r
- )\r
-;\r
+ );\r
\r
-/**\r
- TODO: Add function description\r
-\r
- @param This TODO: add argument description\r
- @param ControllerHandle TODO: add argument description\r
- @param ChildHandle TODO: add argument description\r
- @param Language TODO: add argument description\r
- @param ControllerName TODO: add argument description\r
\r
- TODO: add return values\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
IN EFI_HANDLE ChildHandle OPTIONAL,\r
IN CHAR8 *Language,\r
OUT CHAR16 **ControllerName\r
- )\r
-;\r
+ );\r
\r
-/**\r
- TODO: Add function description\r
\r
- @param IdeBlkIoDevicePtr TODO: add argument description\r
+/**\r
+ Add the component name for the IDE/ATAPI device\r
\r
- TODO: add return values\r
+ @param IdeBlkIoDevicePtr A pointer to the IDE_BLK_IO_DEV instance.\r
\r
**/\r
VOID\r
AddName (\r
IN IDE_BLK_IO_DEV *IdeBlkIoDevicePtr\r
- )\r
-;\r
+ );\r
\r
#endif\r
projects / mirror_edk2.git / blobdiff