ComponentName.h 4.6 KB

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