]>
Commit | Line | Data |
---|---|---|
c4545d76 FS |
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, Intel Corporation. All rights reserved.<BR> | |
6 | This program and the accompanying materials are licensed and made available under | |
7 | the terms and conditions of the BSD License that accompanies this distribution. | |
8 | The full text of the license may be found at | |
9 | http://opensource.org/licenses/bsd-license.php. | |
10 | ||
11 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, | |
12 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. | |
13 | ||
14 | **/ | |
15 | ||
16 | #ifndef __EFI_UEFI_HTTP_BOOT_COM_NAME_H__ | |
17 | #define __EFI_UEFI_HTTP_BOOT_COM_NAME_H__ | |
18 | ||
19 | /** | |
20 | Retrieves a Unicode string that is the user-readable name of the EFI Driver. | |
21 | ||
22 | @param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance. | |
23 | @param Language A pointer to a three-character ISO 639-2 language identifier. | |
24 | This is the language of the driver name that that the caller | |
25 | is requesting, and it must match one of the languages specified | |
26 | in SupportedLanguages. The number of languages supported by a | |
27 | driver is up to the driver writer. | |
28 | @param DriverName A pointer to the Unicode string to return. This Unicode string | |
29 | is the name of the driver specified by This in the language | |
30 | specified by Language. | |
31 | ||
32 | @retval EFI_SUCCESS The Unicode string for the Driver specified by This | |
33 | and the language specified by Language was returned | |
34 | in DriverName. | |
35 | @retval EFI_INVALID_PARAMETER Language is NULL. | |
36 | @retval EFI_INVALID_PARAMETER DriverName is NULL. | |
37 | @retval EFI_UNSUPPORTED The driver specified by This does not support the | |
38 | language specified by Language. | |
39 | ||
40 | **/ | |
41 | EFI_STATUS | |
42 | EFIAPI | |
43 | HttpBootDxeComponentNameGetDriverName ( | |
44 | IN EFI_COMPONENT_NAME2_PROTOCOL *This, | |
45 | IN CHAR8 *Language, | |
46 | OUT CHAR16 **DriverName | |
47 | ); | |
48 | ||
49 | /** | |
50 | Retrieves a Unicode string that is the user readable name of the controller | |
51 | that is being managed by an EFI Driver. | |
52 | ||
53 | @param This A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance. | |
54 | @param ControllerHandle The handle of a controller that the driver specified by | |
55 | This is managing. This handle specifies the controller | |
56 | whose name is to be returned. | |
57 | @param ChildHandle The handle of the child controller to retrieve the name | |
58 | of. This is an optional parameter that may be NULL. It | |
59 | will be NULL for device drivers. It will also be NULL | |
60 | for a bus drivers that wish to retrieve the name of the | |
61 | bus controller. It will not be NULL for a bus driver | |
62 | that wishes to retrieve the name of a child controller. | |
63 | @param Language A pointer to a three character ISO 639-2 language | |
64 | identifier. This is the language of the controller name | |
65 | that the caller is requesting, and it must match one | |
66 | of the languages specified in SupportedLanguages. The | |
67 | number of languages supported by a driver is up to the | |
68 | driver writer. | |
69 | @param ControllerName A pointer to the Unicode string to return. This Unicode | |
70 | string is the name of the controller specified by | |
71 | ControllerHandle and ChildHandle in the language specified | |
72 | by Language, from the point of view of the driver specified | |
73 | by This. | |
74 | ||
75 | @retval EFI_SUCCESS The Unicode string for the user-readable name in the | |
76 | language specified by Language for the driver | |
77 | specified by This was returned in DriverName. | |
78 | @retval EFI_INVALID_PARAMETER ControllerHandle is NULL. | |
79 | @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid EFI_HANDLE. | |
80 | @retval EFI_INVALID_PARAMETER Language is NULL. | |
81 | @retval EFI_INVALID_PARAMETER ControllerName is NULL. | |
82 | @retval EFI_UNSUPPORTED The driver specified by This is not currently managing | |
83 | the controller specified by ControllerHandle and | |
84 | ChildHandle. | |
85 | @retval EFI_UNSUPPORTED The driver specified by This does not support the | |
86 | language specified by Language. | |
87 | ||
88 | **/ | |
89 | EFI_STATUS | |
90 | EFIAPI | |
91 | HttpBootDxeComponentNameGetControllerName ( | |
92 | IN EFI_COMPONENT_NAME2_PROTOCOL *This, | |
93 | IN EFI_HANDLE ControllerHandle, | |
94 | IN EFI_HANDLE ChildHandle OPTIONAL, | |
95 | IN CHAR8 *Language, | |
96 | OUT CHAR16 **ControllerName | |
97 | ); | |
98 | ||
99 | #endif |