HttpBootComponentName.h 4.7 KB

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