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