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