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