-/**@file\r
+/** @file\r
+ Header file for implementation of UEFI Component Name(2) protocol.\r
\r
-Copyright (c) 2006 - 2007, Intel Corporation.<BR>\r
+Copyright (c) 2006 - 2009, Intel Corporation<BR>\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
\r
**/\r
\r
-#ifndef _ISA_FLOPPY_COMPONENT_NAME_H\r
-#define _ISA_FLOPPY_COMPONENT_NAME_H\r
+#ifndef _COMPONENT_NAME_H_\r
+#define _COMPONENT_NAME_H_\r
\r
-#define FLOPPY_DRIVE_NAME L"ISA Floppy Drive # "\r
-#define FLOPPY_DRIVE_NAME_ASCII_LEN (sizeof ("ISA Floppy Drive # ") - 1)\r
-#define ADD_FLOPPY_NAME(x) AddName ((x))\r
+#define FLOPPY_DRIVE_NAME L"ISA Floppy Drive # "\r
+#define FLOPPY_DRIVE_NAME_LEN ((sizeof (FLOPPY_DRIVE_NAME) / sizeof (CHAR16)) - 1)\r
\r
extern EFI_COMPONENT_NAME_PROTOCOL gIsaFloppyComponentName;\r
extern EFI_COMPONENT_NAME2_PROTOCOL gIsaFloppyComponentName2;\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
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
+ @param[in] This 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
+ @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
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
+ @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
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
+ @param[in] This 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
+ @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 ChildHandle[in] The handle of the child controller to retrieve\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
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
+ @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
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
+ @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
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
IsaFloppyComponentNameGetControllerName (\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
+ 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
-VOID\r
-AddName (\r
- IN FDC_BLK_IO_DEV *FdcDev\r
- )\r
/**\r
+ Add the component name for the floppy device\r
\r
-Routine Description:\r
-\r
- GC_TODO: Add function description\r
-\r
-Arguments:\r
-\r
- FdcDev - GC_TODO: add argument description\r
-\r
-Returns:\r
-\r
- GC_TODO: add return values\r
+ @param[in] FdcDev A pointer to the FDC_BLK_IO_DEV instance.\r
\r
**/\r
-;\r
+VOID\r
+AddName (\r
+ IN FDC_BLK_IO_DEV *FdcDev\r
+ );\r
\r
#endif\r
+\r
projects / mirror_edk2.git / blobdiff