]>
Commit | Line | Data |
---|---|---|
3eb9473e | 1 | /*++\r |
2 | \r | |
3 | Copyright (c) 2004, Intel Corporation \r | |
4 | All rights reserved. This program and the accompanying materials \r | |
5 | are licensed and made available under the terms and conditions of the BSD License \r | |
6 | which accompanies this distribution. The full text of the license may be found at \r | |
7 | http://opensource.org/licenses/bsd-license.php \r | |
8 | \r | |
9 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r | |
10 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r | |
11 | \r | |
12 | Module Name:\r | |
13 | \r | |
14 | ComponentName.h\r | |
15 | \r | |
16 | Abstract:\r | |
17 | \r | |
18 | EFI Component Name Protocol\r | |
19 | \r | |
20 | Revision History\r | |
21 | \r | |
22 | --*/\r | |
23 | \r | |
24 | #ifndef _EFI_COMPONENT_NAME2_H_\r | |
25 | #define _EFI_COMPONENT_NAME2_H_\r | |
26 | \r | |
27 | //\r | |
28 | // Global ID for the Component Name Protocol\r | |
29 | //\r | |
30 | \r | |
31 | #define EFI_COMPONENT_NAME2_PROTOCOL_GUID \\r | |
32 | { \\r | |
7ccf38a3 | 33 | 0x6a7a5cff, 0xe8d9, 0x4f70, {0xba, 0xda, 0x75, 0xab, 0x30, 0x25, 0xce, 0x14} \\r |
3eb9473e | 34 | }\r |
35 | \r | |
36 | EFI_FORWARD_DECLARATION (EFI_COMPONENT_NAME2_PROTOCOL);\r | |
37 | \r | |
38 | \r | |
39 | typedef\r | |
40 | EFI_STATUS\r | |
41 | (EFIAPI *EFI_COMPONENT_NAME2_GET_DRIVER_NAME) (\r | |
42 | IN EFI_COMPONENT_NAME2_PROTOCOL * This,\r | |
43 | IN CHAR8 *Language,\r | |
44 | OUT CHAR16 **DriverName\r | |
45 | );\r | |
46 | \r | |
47 | /*++\r | |
48 | \r | |
49 | Routine Description:\r | |
50 | Retrieves a Unicode string that is the user readable name of the EFI Driver.\r | |
51 | \r | |
52 | Arguments:\r | |
53 | This - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r | |
54 | Language - A pointer to a three character ISO 639-2 language identifier.\r | |
55 | This is the language of the driver name that that the caller \r | |
56 | is requesting, and it must match one of the languages specified\r | |
57 | in SupportedLanguages. The number of languages supported by a \r | |
58 | driver is up to the driver writer.\r | |
59 | DriverName - A pointer to the Unicode string to return. This Unicode string\r | |
60 | is the name of the driver specified by This in the language \r | |
61 | specified by Language.\r | |
62 | \r | |
63 | Returns:\r | |
64 | EFI_SUCCESS - The Unicode string for the Driver specified by This\r | |
65 | and the language specified by Language was returned \r | |
66 | in DriverName.\r | |
67 | EFI_INVALID_PARAMETER - Language is NULL or DriverName is NULL.\r | |
68 | EFI_UNSUPPORTED - The driver specified by This does not support the \r | |
69 | language specified by Language.\r | |
70 | \r | |
71 | --*/\r | |
72 | typedef\r | |
73 | EFI_STATUS\r | |
74 | (EFIAPI *EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) (\r | |
75 | IN EFI_COMPONENT_NAME2_PROTOCOL * This,\r | |
76 | IN EFI_HANDLE ControllerHandle,\r | |
77 | IN EFI_HANDLE ChildHandle OPTIONAL,\r | |
78 | IN CHAR8 *Language,\r | |
79 | OUT CHAR16 **ControllerName\r | |
80 | );\r | |
81 | \r | |
82 | /*++\r | |
83 | \r | |
84 | Routine Description:\r | |
85 | Retrieves a Unicode string that is the user readable name of the controller\r | |
86 | that is being managed by an EFI Driver.\r | |
87 | \r | |
88 | Arguments:\r | |
89 | This - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r | |
90 | ControllerHandle - The handle of a controller that the driver specified by \r | |
91 | This is managing. This handle specifies the controller \r | |
92 | whose name is to be returned.\r | |
93 | ChildHandle - The handle of the child controller to retrieve the name \r | |
94 | of. This is an optional parameter that may be NULL. It \r | |
95 | will be NULL for device drivers. It will also be NULL \r | |
96 | for a bus drivers that wish to retrieve the name of the \r | |
97 | bus controller. It will not be NULL for a bus driver \r | |
98 | that wishes to retrieve the name of a child controller.\r | |
99 | Language - A pointer to a three character ISO 639-2 language \r | |
100 | identifier. This is the language of the controller name \r | |
101 | that that the caller is requesting, and it must match one\r | |
102 | of the languages specified in SupportedLanguages. The \r | |
103 | number of languages supported by a driver is up to the \r | |
104 | driver writer.\r | |
105 | ControllerName - A pointer to the Unicode string to return. This Unicode\r | |
106 | string is the name of the controller specified by \r | |
107 | ControllerHandle and ChildHandle in the language specified\r | |
108 | by Language from the point of view of the driver specified\r | |
109 | by This. \r | |
110 | \r | |
111 | Returns:\r | |
112 | EFI_SUCCESS - The Unicode string for the user readable name in the \r | |
113 | language specified by Language for the driver \r | |
114 | specified by This was returned in DriverName.\r | |
115 | EFI_INVALID_PARAMETER - ControllerHandle is not a valid EFI_HANDLE; ChildHandle \r | |
116 | is not NULL and it is not a valid EFI_HANDLE;Language \r | |
117 | is NULL;ControllerName is NULL.\r | |
118 | EFI_UNSUPPORTED - The driver specified by This is not currently managing \r | |
119 | the controller specified by ControllerHandle and \r | |
120 | ChildHandle;The driver specified by This does not support the \r | |
121 | language specified by Language.\r | |
122 | \r | |
123 | --*/\r | |
124 | \r | |
125 | //\r | |
126 | // Interface structure for the Component Name Protocol\r | |
127 | //\r | |
e5bce275 | 128 | struct _EFI_COMPONENT_NAME2_PROTOCOL {\r |
3eb9473e | 129 | EFI_COMPONENT_NAME2_GET_DRIVER_NAME GetDriverName;\r |
130 | EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME GetControllerName;\r | |
131 | CHAR8 *SupportedLanguages;\r | |
e5bce275 | 132 | };\r |
3eb9473e | 133 | \r |
134 | extern EFI_GUID gEfiComponentName2ProtocolGuid;\r | |
135 | \r | |
136 | #endif\r |