c198d870c688055f81bbf550b8d5f04f9e17dd9f
[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Isa / IsaBusDxe / ComponentName.h
1 /**@file
2 Header file for implementation of UEFI Component Name(2) protocol.
3
4 Copyright (c) 2006 - 2009, Intel Corporation<BR>
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
9
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12
13 **/
14
15 #ifndef _COMPONENT_NAME_H_
16 #define _COMPONENT_NAME_H_
17
18 #include "InternalIsaBus.h"
19
20 extern EFI_COMPONENT_NAME_PROTOCOL gIsaBusComponentName;
21 extern EFI_COMPONENT_NAME2_PROTOCOL gIsaBusComponentName2;
22
23 /**
24 Retrieves a Unicode string that is the user readable name of the driver.
25
26 This function retrieves the user readable name of a driver in the form of a
27 Unicode string. If the driver specified by This has a user readable name in
28 the language specified by Language, then a pointer to the driver name is
29 returned in DriverName, and EFI_SUCCESS is returned. If the driver specified
30 by This does not support the language specified by Language,
31 then EFI_UNSUPPORTED is returned.
32
33 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
34 EFI_COMPONENT_NAME_PROTOCOL instance.
35
36 @param Language[in] A pointer to a Null-terminated ASCII string
37 array indicating the language. This is the
38 language of the driver name that the caller is
39 requesting, and it must match one of the
40 languages specified in SupportedLanguages. The
41 number of languages supported by a driver is up
42 to the driver writer. Language is specified
43 in RFC 4646 or ISO 639-2 language code format.
44
45 @param DriverName[out] A pointer to the Unicode string to return.
46 This Unicode string is the name of the
47 driver specified by This in the language
48 specified by Language.
49
50 @retval EFI_SUCCESS The Unicode string for the Driver specified by
51 This and the language specified by Language was
52 returned in DriverName.
53
54 @retval EFI_INVALID_PARAMETER Language is NULL.
55
56 @retval EFI_INVALID_PARAMETER DriverName is NULL.
57
58 @retval EFI_UNSUPPORTED The driver specified by This does not support
59 the language specified by Language.
60
61 **/
62 EFI_STATUS
63 EFIAPI
64 IsaBusComponentNameGetDriverName (
65 IN EFI_COMPONENT_NAME_PROTOCOL *This,
66 IN CHAR8 *Language,
67 OUT CHAR16 **DriverName
68 );
69
70
71 /**
72 Retrieves a Unicode string that is the user readable name of the controller
73 that is being managed by a driver.
74
75 This function retrieves the user readable name of the controller specified by
76 ControllerHandle and ChildHandle in the form of a Unicode string. If the
77 driver specified by This has a user readable name in the language specified by
78 Language, then a pointer to the controller name is returned in ControllerName,
79 and EFI_SUCCESS is returned. If the driver specified by This is not currently
80 managing the controller specified by ControllerHandle and ChildHandle,
81 then EFI_UNSUPPORTED is returned. If the driver specified by This does not
82 support the language specified by Language, then EFI_UNSUPPORTED is returned.
83
84 @param This[in] A pointer to the EFI_COMPONENT_NAME2_PROTOCOL or
85 EFI_COMPONENT_NAME_PROTOCOL instance.
86
87 @param ControllerHandle[in] The handle of a controller that the driver
88 specified by This is managing. This handle
89 specifies the controller whose name is to be
90 returned.
91
92 @param ChildHandle[in] The handle of the child controller to retrieve
93 the name of. This is an optional parameter that
94 may be NULL. It will be NULL for device
95 drivers. It will also be NULL for a bus drivers
96 that wish to retrieve the name of the bus
97 controller. It will not be NULL for a bus
98 driver that wishes to retrieve the name of a
99 child controller.
100
101 @param Language[in] A pointer to a Null-terminated ASCII string
102 array indicating the language. This is the
103 language of the driver name that the caller is
104 requesting, and it must match one of the
105 languages specified in SupportedLanguages. The
106 number of languages supported by a driver is up
107 to the driver writer. Language is specified in
108 RFC 4646 or ISO 639-2 language code format.
109
110 @param ControllerName[out] A pointer to the Unicode string to return.
111 This Unicode string is the name of the
112 controller specified by ControllerHandle and
113 ChildHandle in the language specified by
114 Language from the point of view of the driver
115 specified by This.
116
117 @retval EFI_SUCCESS The Unicode string for the user readable name in
118 the language specified by Language for the
119 driver specified by This was returned in
120 DriverName.
121
122 @retval EFI_INVALID_PARAMETER ControllerHandle is not a valid EFI_HANDLE.
123
124 @retval EFI_INVALID_PARAMETER ChildHandle is not NULL and it is not a valid
125 EFI_HANDLE.
126
127 @retval EFI_INVALID_PARAMETER Language is NULL.
128
129 @retval EFI_INVALID_PARAMETER ControllerName is NULL.
130
131 @retval EFI_UNSUPPORTED The driver specified by This is not currently
132 managing the controller specified by
133 ControllerHandle and ChildHandle.
134
135 @retval EFI_UNSUPPORTED The driver specified by This does not support
136 the language specified by Language.
137
138 **/
139 EFI_STATUS
140 EFIAPI
141 IsaBusComponentNameGetControllerName (
142 IN EFI_COMPONENT_NAME_PROTOCOL *This,
143 IN EFI_HANDLE ControllerHandle,
144 IN EFI_HANDLE ChildHandle OPTIONAL,
145 IN CHAR8 *Language,
146 OUT CHAR16 **ControllerName
147 );
148
149 #endif
150