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