Porting R8's PI-enabled ScsiBus driver
[mirror_edk2.git] / MdeModulePkg / Bus / Scsi / ScsiBusDxe / ComponentName.c
CommitLineData
3a10d471 1/*++\r
2\r
3Copyright (c) 2006, Intel Corporation \r
4All rights reserved. This program and the accompanying materials \r
5are licensed and made available under the terms and conditions of the BSD License \r
6which accompanies this distribution. The full text of the license may be found at \r
7http://opensource.org/licenses/bsd-license.php \r
8 \r
9THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
10WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
11\r
12Module Name:\r
13\r
14 ComponentName.c\r
15\r
16Abstract:\r
17\r
18--*/\r
19\r
20//\r
21// The package level header files this module uses\r
22//\r
23#include <PiDxe.h>\r
24\r
25//\r
26// The protocols, PPI and GUID defintions for this module\r
27//\r
28#include <Protocol/ScsiPassThru.h>\r
70c94b3b 29#include <Protocol/ScsiPassThruExt.h>\r
3a10d471 30#include <Protocol/ScsiIo.h>\r
31#include <Protocol/ComponentName.h>\r
32#include <Protocol/DriverBinding.h>\r
33#include <Protocol/DevicePath.h>\r
34//\r
35// The Library classes this module consumes\r
36//\r
37#include <Library/DebugLib.h>\r
38#include <Library/UefiDriverEntryPoint.h>\r
39#include <Library/UefiLib.h>\r
40#include <Library/BaseMemoryLib.h>\r
41#include <Library/ScsiLib.h>\r
42#include <Library/UefiBootServicesTableLib.h>\r
43#include <Library/DevicePathLib.h>\r
44\r
45\r
46#include "ScsiBus.h"\r
47\r
48//\r
49// EFI Component Name Protocol\r
50//\r
51EFI_COMPONENT_NAME_PROTOCOL gScsiBusComponentName = {\r
52 ScsiBusComponentNameGetDriverName,\r
53 ScsiBusComponentNameGetControllerName,\r
54 "eng"\r
55};\r
56\r
57static EFI_UNICODE_STRING_TABLE mScsiBusDriverNameTable[] = {\r
58 { "eng", (CHAR16 *) L"SCSI Bus Driver" },\r
59 { NULL , NULL }\r
60};\r
61\r
62EFI_STATUS\r
63EFIAPI\r
64ScsiBusComponentNameGetDriverName (\r
65 IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
66 IN CHAR8 *Language,\r
67 OUT CHAR16 **DriverName\r
68 )\r
69/*++\r
70\r
71 Routine Description:\r
72 Retrieves a Unicode string that is the user readable name of the EFI Driver.\r
73\r
74 Arguments:\r
75 This - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r
76 Language - A pointer to a three character ISO 639-2 language identifier.\r
77 This is the language of the driver name that that the caller \r
78 is requesting, and it must match one of the languages specified\r
79 in SupportedLanguages. The number of languages supported by a \r
80 driver is up to the driver writer.\r
81 DriverName - A pointer to the Unicode string to return. This Unicode string\r
82 is the name of the driver specified by This in the language \r
83 specified by Language.\r
84\r
85 Returns:\r
86 EFI_SUCCESS - The Unicode string for the Driver specified by This\r
87 and the language specified by Language was returned \r
88 in DriverName.\r
89 EFI_INVALID_PARAMETER - Language is NULL.\r
90 EFI_INVALID_PARAMETER - DriverName is NULL.\r
91 EFI_UNSUPPORTED - The driver specified by This does not support the \r
92 language specified by Language.\r
93\r
94--*/\r
95{\r
96 return LookupUnicodeString (\r
97 Language,\r
98 gScsiBusComponentName.SupportedLanguages,\r
99 mScsiBusDriverNameTable,\r
100 DriverName\r
101 );\r
102}\r
103\r
104EFI_STATUS\r
105EFIAPI\r
106ScsiBusComponentNameGetControllerName (\r
107 IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
108 IN EFI_HANDLE ControllerHandle,\r
109 IN EFI_HANDLE ChildHandle OPTIONAL,\r
110 IN CHAR8 *Language,\r
111 OUT CHAR16 **ControllerName\r
112 )\r
113/*++\r
114\r
115 Routine Description:\r
116 Retrieves a Unicode string that is the user readable name of the controller\r
117 that is being managed by an EFI Driver.\r
118\r
119 Arguments:\r
120 This - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r
121 ControllerHandle - The handle of a controller that the driver specified by \r
122 This is managing. This handle specifies the controller \r
123 whose name is to be returned.\r
124 ChildHandle - The handle of the child controller to retrieve the name \r
125 of. This is an optional parameter that may be NULL. It \r
126 will be NULL for device drivers. It will also be NULL \r
127 for a bus drivers that wish to retrieve the name of the \r
128 bus controller. It will not be NULL for a bus driver \r
129 that wishes to retrieve the name of a child controller.\r
130 Language - A pointer to a three character ISO 639-2 language \r
131 identifier. This is the language of the controller name \r
132 that that the caller is requesting, and it must match one\r
133 of the languages specified in SupportedLanguages. The \r
134 number of languages supported by a driver is up to the \r
135 driver writer.\r
136 ControllerName - A pointer to the Unicode string to return. This Unicode\r
137 string is the name of the controller specified by \r
138 ControllerHandle and ChildHandle in the language \r
139 specified by Language from the point of view of the \r
140 driver specified by This. \r
141\r
142 Returns:\r
143 EFI_SUCCESS - The Unicode string for the user readable name in the\r
144 language specified by Language for the driver \r
145 specified by This was returned in DriverName.\r
146 EFI_INVALID_PARAMETER - ControllerHandle is not a valid EFI_HANDLE.\r
147 EFI_INVALID_PARAMETER - ChildHandle is not NULL and it is not a valid \r
148 EFI_HANDLE.\r
149 EFI_INVALID_PARAMETER - Language is NULL.\r
150 EFI_INVALID_PARAMETER - ControllerName is NULL.\r
151 EFI_UNSUPPORTED - The driver specified by This is not currently \r
152 managing the controller specified by \r
153 ControllerHandle and ChildHandle.\r
154 EFI_UNSUPPORTED - The driver specified by This does not support the \r
155 language specified by Language.\r
156\r
157--*/\r
158{\r
159 return EFI_UNSUPPORTED;\r
160}\r