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