ComponentName.h 4.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  1. /** @file
  2. Component Name functions declaration for XenPvBlk driver.
  3. Copyright (C) 2014, Citrix Ltd.
  4. SPDX-License-Identifier: BSD-2-Clause-Patent
  5. **/
  6. /**
  7. Retrieves a Unicode string that is the user-readable name of the EFI Driver.
  8. @param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
  9. @param Language A pointer to a three-character ISO 639-2 language identifier.
  10. This is the language of the driver name that the caller
  11. is requesting, and it must match one of the languages specified
  12. in SupportedLanguages. The number of languages supported by a
  13. driver is up to the driver writer.
  14. @param DriverName A pointer to the Unicode string to return. This Unicode string
  15. is the name of the driver specified by This in the language
  16. specified by Language.
  17. @retval EFI_SUCCESS The Unicode string for the Driver specified by This
  18. and the language specified by Language was returned
  19. in DriverName.
  20. @retval EFI_INVALID_PARAMETER Language is NULL.
  21. @retval EFI_INVALID_PARAMETER DriverName is NULL.
  22. @retval EFI_UNSUPPORTED The driver specified by This does not support the
  23. language specified by Language.
  24. **/
  25. EFI_STATUS
  26. EFIAPI
  27. XenPvBlkDxeComponentNameGetDriverName (
  28. IN EFI_COMPONENT_NAME2_PROTOCOL *This,
  29. IN CHAR8 *Language,
  30. OUT CHAR16 **DriverName
  31. );
  32. /**
  33. Retrieves a Unicode string that is the user readable name of the controller
  34. that is being managed by an EFI Driver.
  35. @param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.
  36. @param ControllerHandle The handle of a controller that the driver specified by
  37. This is managing. This handle specifies the controller
  38. whose name is to be returned.
  39. @param ChildHandle The handle of the child controller to retrieve the name
  40. of. This is an optional parameter that may be NULL. It
  41. will be NULL for device drivers. It will also be NULL
  42. for a bus drivers that wish to retrieve the name of the
  43. bus controller. It will not be NULL for a bus driver
  44. that wishes to retrieve the name of a child controller.
  45. @param Language A pointer to a three character ISO 639-2 language
  46. identifier. This is the language of the controller name
  47. that the caller is requesting, and it must match one
  48. of the languages specified in SupportedLanguages. The
  49. number of languages supported by a driver is up to the
  50. driver writer.
  51. @param ControllerName A pointer to the Unicode string to return. This Unicode
  52. string is the name of the controller specified by
  53. ControllerHandle and ChildHandle in the language specified
  54. by Language, from the point of view of the driver specified
  55. by This.
  56. @retval EFI_SUCCESS The Unicode string for the user-readable name in the
  57. language specified by Language for the driver
  58. specified by This was returned in DriverName.
  59. @retval EFI_INVALID_PARAMETER ControllerHandle is NULL.
  60. @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE.
  61. @retval EFI_INVALID_PARAMETER Language is NULL.
  62. @retval EFI_INVALID_PARAMETER ControllerName is NULL.
  63. @retval EFI_UNSUPPORTED The driver specified by This is not currently managing
  64. the controller specified by ControllerHandle and
  65. ChildHandle.
  66. @retval EFI_UNSUPPORTED The driver specified by This does not support the
  67. language specified by Language.
  68. **/
  69. EFI_STATUS
  70. EFIAPI
  71. XenPvBlkDxeComponentNameGetControllerName (
  72. IN EFI_COMPONENT_NAME2_PROTOCOL *This,
  73. IN EFI_HANDLE ControllerHandle,
  74. IN EFI_HANDLE ChildHandle OPTIONAL,
  75. IN CHAR8 *Language,
  76. OUT CHAR16 **ControllerName
  77. );