]>
Commit | Line | Data |
---|---|---|
37078a63 | 1 | /** @file\r |
2 | \r | |
3 | This driver produces Extended SCSI Pass Thru Protocol instances for\r | |
4 | virtio-scsi devices.\r | |
5 | \r | |
6 | The implementation is basic:\r | |
7 | \r | |
8 | - No hotplug / hot-unplug.\r | |
9 | \r | |
10 | - Although EFI_EXT_SCSI_PASS_THRU_PROTOCOL.PassThru() could be a good match\r | |
11 | for multiple in-flight virtio-scsi requests, we stick to synchronous\r | |
12 | requests for now.\r | |
13 | \r | |
14 | - Timeouts are not supported for EFI_EXT_SCSI_PASS_THRU_PROTOCOL.PassThru().\r | |
15 | \r | |
16 | - Only one channel is supported. (At the time of this writing, host-side\r | |
17 | virtio-scsi supports a single channel too.)\r | |
18 | \r | |
19 | - Only one request queue is used (for the one synchronous request).\r | |
20 | \r | |
21 | - The ResetChannel() and ResetTargetLun() functions of\r | |
22 | EFI_EXT_SCSI_PASS_THRU_PROTOCOL are not supported (which is allowed by the\r | |
23 | UEFI 2.3.1 Errata C specification), although\r | |
24 | VIRTIO_SCSI_T_TMF_LOGICAL_UNIT_RESET could be a good match. That would\r | |
25 | however require client code for the control queue, which is deemed\r | |
26 | unreasonable for now.\r | |
27 | \r | |
28 | Copyright (C) 2012, Red Hat, Inc.\r | |
29 | Copyright (c) 2012, Intel Corporation. All rights reserved.<BR>\r | |
30 | \r | |
31 | This program and the accompanying materials are licensed and made available\r | |
32 | under the terms and conditions of the BSD License which accompanies this\r | |
33 | distribution. The full text of the license may be found at\r | |
34 | http://opensource.org/licenses/bsd-license.php\r | |
35 | \r | |
36 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT\r | |
37 | WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
38 | \r | |
39 | **/\r | |
40 | \r | |
37078a63 | 41 | #include <IndustryStandard/VirtioScsi.h>\r |
42 | #include <Library/BaseMemoryLib.h>\r | |
43 | #include <Library/DebugLib.h>\r | |
44 | #include <Library/MemoryAllocationLib.h>\r | |
45 | #include <Library/UefiBootServicesTableLib.h>\r | |
46 | #include <Library/UefiLib.h>\r | |
47 | #include <Library/VirtioLib.h>\r | |
48 | \r | |
49 | #include "VirtioScsi.h"\r | |
50 | \r | |
51 | /**\r | |
52 | \r | |
56f65ed8 OM |
53 | Convenience macros to read and write configuration elements of the\r |
54 | virtio-scsi VirtIo device.\r | |
37078a63 | 55 | \r |
56 | The following macros make it possible to specify only the "core parameters"\r | |
57 | for such accesses and to derive the rest. By the time VIRTIO_CFG_WRITE()\r | |
58 | returns, the transaction will have been completed.\r | |
59 | \r | |
56f65ed8 | 60 | @param[in] Dev Pointer to the VSCSI_DEV structure.\r |
37078a63 | 61 | \r |
62 | @param[in] Field A field name from VSCSI_HDR, identifying the virtio-scsi\r | |
63 | configuration item to access.\r | |
64 | \r | |
65 | @param[in] Value (VIRTIO_CFG_WRITE() only.) The value to write to the\r | |
66 | selected configuration item.\r | |
67 | \r | |
68 | @param[out] Pointer (VIRTIO_CFG_READ() only.) The object to receive the\r | |
69 | value read from the configuration item. Its type must be\r | |
70 | one of UINT8, UINT16, UINT32, UINT64.\r | |
71 | \r | |
72 | \r | |
ece77e40 | 73 | @return Status codes returned by Virtio->WriteDevice() / Virtio->ReadDevice().\r |
37078a63 | 74 | \r |
75 | **/\r | |
76 | \r | |
ece77e40 OM |
77 | #define VIRTIO_CFG_WRITE(Dev, Field, Value) ((Dev)->VirtIo->WriteDevice ( \\r |
78 | (Dev)->VirtIo, \\r | |
79 | OFFSET_OF_VSCSI (Field), \\r | |
80 | SIZE_OF_VSCSI (Field), \\r | |
81 | (Value) \\r | |
37078a63 | 82 | ))\r |
83 | \r | |
ece77e40 OM |
84 | #define VIRTIO_CFG_READ(Dev, Field, Pointer) ((Dev)->VirtIo->ReadDevice ( \\r |
85 | (Dev)->VirtIo, \\r | |
86 | OFFSET_OF_VSCSI (Field), \\r | |
87 | SIZE_OF_VSCSI (Field), \\r | |
88 | sizeof *(Pointer), \\r | |
89 | (Pointer) \\r | |
37078a63 | 90 | ))\r |
91 | \r | |
92 | \r | |
93 | //\r | |
94 | // UEFI Spec 2.3.1 + Errata C, 14.7 Extended SCSI Pass Thru Protocol specifies\r | |
95 | // the PassThru() interface. Beside returning a status code, the function must\r | |
96 | // set some fields in the EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET in/out\r | |
97 | // parameter on return. The following is a full list of those fields, for\r | |
98 | // easier validation of PopulateRequest(), ParseResponse(), and\r | |
99 | // VirtioScsiPassThru() below.\r | |
100 | //\r | |
101 | // - InTransferLength\r | |
102 | // - OutTransferLength\r | |
103 | // - HostAdapterStatus\r | |
104 | // - TargetStatus\r | |
105 | // - SenseDataLength\r | |
106 | // - SenseData\r | |
107 | //\r | |
108 | // On any return from the PassThru() interface, these fields must be set,\r | |
109 | // except if the returned status code is explicitly exempt. (Actually the\r | |
110 | // implementation here conservatively sets these fields even in case not all\r | |
111 | // of them would be required by the specification.)\r | |
112 | //\r | |
113 | \r | |
114 | /**\r | |
115 | \r | |
116 | Populate a virtio-scsi request from the Extended SCSI Pass Thru Protocol\r | |
117 | packet.\r | |
118 | \r | |
119 | The caller is responsible for pre-zeroing the virtio-scsi request. The\r | |
120 | Extended SCSI Pass Thru Protocol packet is modified, to be forwarded outwards\r | |
121 | by VirtioScsiPassThru(), if invalid or unsupported parameters are detected.\r | |
122 | \r | |
123 | @param[in] Dev The virtio-scsi host device the packet targets.\r | |
124 | \r | |
125 | @param[in] Target The SCSI target controlled by the virtio-scsi host\r | |
126 | device.\r | |
127 | \r | |
128 | @param[in] Lun The Logical Unit Number under the SCSI target.\r | |
129 | \r | |
130 | @param[in out] Packet The Extended SCSI Pass Thru Protocol packet the\r | |
131 | function translates to a virtio-scsi request. On\r | |
132 | failure this parameter relays error contents.\r | |
133 | \r | |
134 | @param[out] Request The pre-zeroed virtio-scsi request to populate. This\r | |
135 | parameter is volatile-qualified because we expect the\r | |
136 | caller to append it to a virtio ring, thus\r | |
137 | assignments to Request must be visible when the\r | |
138 | function returns.\r | |
139 | \r | |
140 | \r | |
141 | @retval EFI_SUCCESS The Extended SCSI Pass Thru Protocol packet was valid,\r | |
142 | Request has been populated.\r | |
143 | \r | |
144 | @return Otherwise, invalid or unsupported parameters were\r | |
145 | detected. Status codes are meant for direct forwarding\r | |
146 | by the EFI_EXT_SCSI_PASS_THRU_PROTOCOL.PassThru()\r | |
147 | implementation.\r | |
148 | \r | |
149 | **/\r | |
150 | STATIC\r | |
151 | EFI_STATUS\r | |
152 | EFIAPI\r | |
153 | PopulateRequest (\r | |
154 | IN CONST VSCSI_DEV *Dev,\r | |
155 | IN UINT16 Target,\r | |
156 | IN UINT64 Lun,\r | |
157 | IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet,\r | |
158 | OUT volatile VIRTIO_SCSI_REQ *Request\r | |
159 | )\r | |
160 | {\r | |
161 | UINTN Idx;\r | |
162 | \r | |
163 | if (\r | |
164 | //\r | |
165 | // bidirectional transfer was requested, but the host doesn't support it\r | |
166 | //\r | |
167 | (Packet->InTransferLength > 0 && Packet->OutTransferLength > 0 &&\r | |
168 | !Dev->InOutSupported) ||\r | |
169 | \r | |
170 | //\r | |
171 | // a target / LUN was addressed that's impossible to encode for the host\r | |
172 | //\r | |
173 | Target > 0xFF || Lun >= 0x4000 ||\r | |
174 | \r | |
175 | //\r | |
176 | // Command Descriptor Block bigger than VIRTIO_SCSI_CDB_SIZE\r | |
177 | //\r | |
178 | Packet->CdbLength > VIRTIO_SCSI_CDB_SIZE ||\r | |
179 | \r | |
180 | //\r | |
181 | // From virtio-0.9.5, 2.3.2 Descriptor Table:\r | |
182 | // "no descriptor chain may be more than 2^32 bytes long in total".\r | |
183 | //\r | |
184 | (UINT64) Packet->InTransferLength + Packet->OutTransferLength > SIZE_1GB\r | |
185 | ) {\r | |
186 | \r | |
187 | //\r | |
188 | // this error code doesn't require updates to the Packet output fields\r | |
189 | //\r | |
190 | return EFI_UNSUPPORTED;\r | |
191 | }\r | |
192 | \r | |
193 | if (\r | |
194 | //\r | |
195 | // addressed invalid device\r | |
196 | //\r | |
197 | Target > Dev->MaxTarget || Lun > Dev->MaxLun ||\r | |
198 | \r | |
199 | //\r | |
200 | // invalid direction (there doesn't seem to be a macro for the "no data\r | |
201 | // transferred" "direction", eg. for TEST UNIT READY)\r | |
202 | //\r | |
203 | Packet->DataDirection > EFI_EXT_SCSI_DATA_DIRECTION_BIDIRECTIONAL ||\r | |
204 | \r | |
205 | //\r | |
206 | // trying to receive, but destination pointer is NULL, or contradicting\r | |
207 | // transfer direction\r | |
208 | //\r | |
209 | (Packet->InTransferLength > 0 &&\r | |
210 | (Packet->InDataBuffer == NULL ||\r | |
211 | Packet->DataDirection == EFI_EXT_SCSI_DATA_DIRECTION_WRITE\r | |
212 | )\r | |
213 | ) ||\r | |
214 | \r | |
215 | //\r | |
216 | // trying to send, but source pointer is NULL, or contradicting transfer\r | |
217 | // direction\r | |
218 | //\r | |
219 | (Packet->OutTransferLength > 0 &&\r | |
220 | (Packet->OutDataBuffer == NULL ||\r | |
221 | Packet->DataDirection == EFI_EXT_SCSI_DATA_DIRECTION_READ\r | |
222 | )\r | |
223 | )\r | |
224 | ) {\r | |
225 | \r | |
226 | //\r | |
227 | // this error code doesn't require updates to the Packet output fields\r | |
228 | //\r | |
229 | return EFI_INVALID_PARAMETER;\r | |
230 | }\r | |
231 | \r | |
232 | //\r | |
233 | // Catch oversized requests eagerly. If this condition evaluates to false,\r | |
234 | // then the combined size of a bidirectional request will not exceed the\r | |
235 | // virtio-scsi device's transfer limit either.\r | |
236 | //\r | |
237 | if (ALIGN_VALUE (Packet->OutTransferLength, 512) / 512\r | |
238 | > Dev->MaxSectors / 2 ||\r | |
239 | ALIGN_VALUE (Packet->InTransferLength, 512) / 512\r | |
240 | > Dev->MaxSectors / 2) {\r | |
241 | Packet->InTransferLength = (Dev->MaxSectors / 2) * 512;\r | |
242 | Packet->OutTransferLength = (Dev->MaxSectors / 2) * 512;\r | |
243 | Packet->HostAdapterStatus =\r | |
244 | EFI_EXT_SCSI_STATUS_HOST_ADAPTER_DATA_OVERRUN_UNDERRUN;\r | |
245 | Packet->TargetStatus = EFI_EXT_SCSI_STATUS_TARGET_GOOD;\r | |
246 | Packet->SenseDataLength = 0;\r | |
247 | return EFI_BAD_BUFFER_SIZE;\r | |
248 | }\r | |
249 | \r | |
250 | //\r | |
251 | // target & LUN encoding: see virtio-0.9.5, Appendix I: SCSI Host Device,\r | |
252 | // Device Operation: request queues\r | |
253 | //\r | |
254 | Request->Lun[0] = 1;\r | |
255 | Request->Lun[1] = (UINT8) Target;\r | |
256 | Request->Lun[2] = (UINT8) ((Lun >> 8) | 0x40);\r | |
257 | Request->Lun[3] = (UINT8) Lun;\r | |
258 | \r | |
259 | //\r | |
260 | // CopyMem() would cast away the "volatile" qualifier before access, which is\r | |
261 | // undefined behavior (ISO C99 6.7.3p5)\r | |
262 | //\r | |
263 | for (Idx = 0; Idx < Packet->CdbLength; ++Idx) {\r | |
264 | Request->Cdb[Idx] = ((UINT8 *) Packet->Cdb)[Idx];\r | |
265 | }\r | |
266 | \r | |
267 | return EFI_SUCCESS;\r | |
268 | }\r | |
269 | \r | |
270 | \r | |
271 | /**\r | |
272 | \r | |
273 | Parse the virtio-scsi device's response, translate it to an EFI status code,\r | |
274 | and update the Extended SCSI Pass Thru Protocol packet, to be returned by\r | |
275 | the EFI_EXT_SCSI_PASS_THRU_PROTOCOL.PassThru() implementation.\r | |
276 | \r | |
277 | @param[in out] Packet The Extended SCSI Pass Thru Protocol packet that has\r | |
278 | been translated to a virtio-scsi request with\r | |
279 | PopulateRequest(), and processed by the host. On\r | |
280 | output this parameter is updated with response or\r | |
281 | error contents.\r | |
282 | \r | |
283 | @param[in] Response The virtio-scsi response structure to parse. We expect\r | |
284 | it to come from a virtio ring, thus it is qualified\r | |
285 | volatile.\r | |
286 | \r | |
287 | \r | |
288 | @return PassThru() status codes mandated by UEFI Spec 2.3.1 + Errata C, 14.7\r | |
289 | Extended SCSI Pass Thru Protocol.\r | |
290 | \r | |
291 | **/\r | |
292 | STATIC\r | |
293 | EFI_STATUS\r | |
294 | EFIAPI\r | |
295 | ParseResponse (\r | |
296 | IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet,\r | |
297 | IN CONST volatile VIRTIO_SCSI_RESP *Response\r | |
298 | )\r | |
299 | {\r | |
300 | UINTN ResponseSenseLen;\r | |
301 | UINTN Idx;\r | |
302 | \r | |
303 | //\r | |
304 | // return sense data (length and contents) in all cases, truncated if needed\r | |
305 | //\r | |
306 | ResponseSenseLen = MIN (Response->SenseLen, VIRTIO_SCSI_SENSE_SIZE);\r | |
307 | if (Packet->SenseDataLength > ResponseSenseLen) {\r | |
308 | Packet->SenseDataLength = (UINT8) ResponseSenseLen;\r | |
309 | }\r | |
310 | for (Idx = 0; Idx < Packet->SenseDataLength; ++Idx) {\r | |
311 | ((UINT8 *) Packet->SenseData)[Idx] = Response->Sense[Idx];\r | |
312 | }\r | |
313 | \r | |
314 | //\r | |
315 | // Report actual transfer lengths. The logic below covers all three\r | |
316 | // DataDirections (read, write, bidirectional).\r | |
317 | //\r | |
318 | // -+- @ 0\r | |
319 | // |\r | |
320 | // | write ^ @ Residual (unprocessed)\r | |
321 | // | |\r | |
322 | // -+- @ OutTransferLength -+- @ InTransferLength\r | |
323 | // | |\r | |
324 | // | read |\r | |
325 | // | |\r | |
326 | // V @ OutTransferLength + InTransferLength -+- @ 0\r | |
327 | //\r | |
328 | if (Response->Residual <= Packet->InTransferLength) {\r | |
329 | Packet->InTransferLength -= Response->Residual;\r | |
330 | }\r | |
331 | else {\r | |
332 | Packet->OutTransferLength -= Response->Residual - Packet->InTransferLength;\r | |
333 | Packet->InTransferLength = 0;\r | |
334 | }\r | |
335 | \r | |
336 | //\r | |
337 | // report target status in all cases\r | |
338 | //\r | |
339 | Packet->TargetStatus = Response->Status;\r | |
340 | \r | |
341 | //\r | |
342 | // host adapter status and function return value depend on virtio-scsi\r | |
343 | // response code\r | |
344 | //\r | |
345 | switch (Response->Response) {\r | |
346 | case VIRTIO_SCSI_S_OK:\r | |
347 | Packet->HostAdapterStatus = EFI_EXT_SCSI_STATUS_HOST_ADAPTER_OK;\r | |
348 | return EFI_SUCCESS;\r | |
349 | \r | |
350 | case VIRTIO_SCSI_S_OVERRUN:\r | |
351 | Packet->HostAdapterStatus =\r | |
352 | EFI_EXT_SCSI_STATUS_HOST_ADAPTER_DATA_OVERRUN_UNDERRUN;\r | |
353 | break;\r | |
354 | \r | |
355 | case VIRTIO_SCSI_S_BAD_TARGET:\r | |
356 | //\r | |
357 | // This is non-intuitive but explicitly required by the\r | |
358 | // EFI_EXT_SCSI_PASS_THRU_PROTOCOL.PassThru() specification for\r | |
359 | // disconnected (but otherwise valid) target / LUN addresses.\r | |
360 | //\r | |
361 | Packet->HostAdapterStatus =\r | |
362 | EFI_EXT_SCSI_STATUS_HOST_ADAPTER_TIMEOUT_COMMAND;\r | |
363 | return EFI_TIMEOUT;\r | |
364 | \r | |
365 | case VIRTIO_SCSI_S_RESET:\r | |
366 | Packet->HostAdapterStatus = EFI_EXT_SCSI_STATUS_HOST_ADAPTER_BUS_RESET;\r | |
367 | break;\r | |
368 | \r | |
369 | case VIRTIO_SCSI_S_BUSY:\r | |
370 | Packet->HostAdapterStatus = EFI_EXT_SCSI_STATUS_HOST_ADAPTER_OK;\r | |
371 | return EFI_NOT_READY;\r | |
372 | \r | |
373 | //\r | |
374 | // Lump together the rest. The mapping for VIRTIO_SCSI_S_ABORTED is\r | |
375 | // intentional as well, not an oversight.\r | |
376 | //\r | |
377 | case VIRTIO_SCSI_S_ABORTED:\r | |
378 | case VIRTIO_SCSI_S_TRANSPORT_FAILURE:\r | |
379 | case VIRTIO_SCSI_S_TARGET_FAILURE:\r | |
380 | case VIRTIO_SCSI_S_NEXUS_FAILURE:\r | |
381 | case VIRTIO_SCSI_S_FAILURE:\r | |
382 | default:\r | |
383 | Packet->HostAdapterStatus = EFI_EXT_SCSI_STATUS_HOST_ADAPTER_OTHER;\r | |
384 | }\r | |
385 | \r | |
386 | return EFI_DEVICE_ERROR;\r | |
387 | }\r | |
388 | \r | |
389 | \r | |
390 | //\r | |
391 | // The next seven functions implement EFI_EXT_SCSI_PASS_THRU_PROTOCOL\r | |
392 | // for the virtio-scsi HBA. Refer to UEFI Spec 2.3.1 + Errata C, sections\r | |
393 | // - 14.1 SCSI Driver Model Overview,\r | |
394 | // - 14.7 Extended SCSI Pass Thru Protocol.\r | |
395 | //\r | |
396 | \r | |
397 | EFI_STATUS\r | |
398 | EFIAPI\r | |
399 | VirtioScsiPassThru (\r | |
400 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r | |
401 | IN UINT8 *Target,\r | |
402 | IN UINT64 Lun,\r | |
403 | IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet,\r | |
404 | IN EFI_EVENT Event OPTIONAL\r | |
405 | )\r | |
406 | {\r | |
407 | VSCSI_DEV *Dev;\r | |
408 | UINT16 TargetValue;\r | |
409 | EFI_STATUS Status;\r | |
410 | volatile VIRTIO_SCSI_REQ Request;\r | |
411 | volatile VIRTIO_SCSI_RESP Response;\r | |
412 | DESC_INDICES Indices;\r | |
413 | \r | |
151304d9 | 414 | ZeroMem ((VOID*) &Request, sizeof (Request));\r |
415 | ZeroMem ((VOID*) &Response, sizeof (Response));\r | |
37078a63 | 416 | \r |
417 | Dev = VIRTIO_SCSI_FROM_PASS_THRU (This);\r | |
418 | CopyMem (&TargetValue, Target, sizeof TargetValue);\r | |
419 | \r | |
420 | Status = PopulateRequest (Dev, TargetValue, Lun, Packet, &Request);\r | |
421 | if (EFI_ERROR (Status)) {\r | |
422 | return Status;\r | |
423 | }\r | |
424 | \r | |
425 | VirtioPrepare (&Dev->Ring, &Indices);\r | |
426 | \r | |
427 | //\r | |
428 | // preset a host status for ourselves that we do not accept as success\r | |
429 | //\r | |
430 | Response.Response = VIRTIO_SCSI_S_FAILURE;\r | |
431 | \r | |
432 | //\r | |
433 | // ensured by VirtioScsiInit() -- this predicate, in combination with the\r | |
434 | // lock-step progress, ensures we don't have to track free descriptors.\r | |
435 | //\r | |
436 | ASSERT (Dev->Ring.QueueSize >= 4);\r | |
437 | \r | |
438 | //\r | |
439 | // enqueue Request\r | |
440 | //\r | |
441 | VirtioAppendDesc (&Dev->Ring, (UINTN) &Request, sizeof Request,\r | |
442 | VRING_DESC_F_NEXT, &Indices);\r | |
443 | \r | |
444 | //\r | |
445 | // enqueue "dataout" if any\r | |
446 | //\r | |
447 | if (Packet->OutTransferLength > 0) {\r | |
448 | VirtioAppendDesc (&Dev->Ring, (UINTN) Packet->OutDataBuffer,\r | |
449 | Packet->OutTransferLength, VRING_DESC_F_NEXT, &Indices);\r | |
450 | }\r | |
451 | \r | |
452 | //\r | |
453 | // enqueue Response, to be written by the host\r | |
454 | //\r | |
455 | VirtioAppendDesc (&Dev->Ring, (UINTN) &Response, sizeof Response,\r | |
456 | VRING_DESC_F_WRITE | (Packet->InTransferLength > 0 ?\r | |
457 | VRING_DESC_F_NEXT : 0),\r | |
458 | &Indices);\r | |
459 | \r | |
460 | //\r | |
461 | // enqueue "datain" if any, to be written by the host\r | |
462 | //\r | |
463 | if (Packet->InTransferLength > 0) {\r | |
464 | VirtioAppendDesc (&Dev->Ring, (UINTN) Packet->InDataBuffer,\r | |
465 | Packet->InTransferLength, VRING_DESC_F_WRITE, &Indices);\r | |
466 | }\r | |
467 | \r | |
468 | // If kicking the host fails, we must fake a host adapter error.\r | |
469 | // EFI_NOT_READY would save us the effort, but it would also suggest that the\r | |
470 | // caller retry.\r | |
471 | //\r | |
56f65ed8 | 472 | if (VirtioFlush (Dev->VirtIo, VIRTIO_SCSI_REQUEST_QUEUE, &Dev->Ring,\r |
37078a63 | 473 | &Indices) != EFI_SUCCESS) {\r |
474 | Packet->InTransferLength = 0;\r | |
475 | Packet->OutTransferLength = 0;\r | |
476 | Packet->HostAdapterStatus = EFI_EXT_SCSI_STATUS_HOST_ADAPTER_OTHER;\r | |
477 | Packet->TargetStatus = EFI_EXT_SCSI_STATUS_TARGET_GOOD;\r | |
478 | Packet->SenseDataLength = 0;\r | |
479 | return EFI_DEVICE_ERROR;\r | |
480 | }\r | |
481 | \r | |
482 | return ParseResponse (Packet, &Response);\r | |
483 | }\r | |
484 | \r | |
485 | \r | |
486 | EFI_STATUS\r | |
487 | EFIAPI\r | |
488 | VirtioScsiGetNextTargetLun (\r | |
489 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r | |
490 | IN OUT UINT8 **TargetPointer,\r | |
491 | IN OUT UINT64 *Lun\r | |
492 | )\r | |
493 | {\r | |
494 | UINT8 *Target;\r | |
495 | UINTN Idx;\r | |
496 | UINT16 LastTarget;\r | |
497 | VSCSI_DEV *Dev;\r | |
498 | \r | |
499 | //\r | |
500 | // the TargetPointer input parameter is unnecessarily a pointer-to-pointer\r | |
501 | //\r | |
502 | Target = *TargetPointer;\r | |
503 | \r | |
504 | //\r | |
505 | // Search for first non-0xFF byte. If not found, return first target & LUN.\r | |
506 | //\r | |
507 | for (Idx = 0; Idx < TARGET_MAX_BYTES && Target[Idx] == 0xFF; ++Idx)\r | |
508 | ;\r | |
509 | if (Idx == TARGET_MAX_BYTES) {\r | |
510 | SetMem (Target, TARGET_MAX_BYTES, 0x00);\r | |
511 | *Lun = 0;\r | |
512 | return EFI_SUCCESS;\r | |
513 | }\r | |
514 | \r | |
515 | //\r | |
516 | // see the TARGET_MAX_BYTES check in "VirtioScsi.h"\r | |
517 | //\r | |
518 | CopyMem (&LastTarget, Target, sizeof LastTarget);\r | |
519 | \r | |
520 | //\r | |
521 | // increment (target, LUN) pair if valid on input\r | |
522 | //\r | |
523 | Dev = VIRTIO_SCSI_FROM_PASS_THRU (This);\r | |
524 | if (LastTarget > Dev->MaxTarget || *Lun > Dev->MaxLun) {\r | |
525 | return EFI_INVALID_PARAMETER;\r | |
526 | }\r | |
527 | \r | |
528 | if (*Lun < Dev->MaxLun) {\r | |
529 | ++*Lun;\r | |
530 | return EFI_SUCCESS;\r | |
531 | }\r | |
532 | \r | |
533 | if (LastTarget < Dev->MaxTarget) {\r | |
534 | *Lun = 0;\r | |
535 | ++LastTarget;\r | |
536 | CopyMem (Target, &LastTarget, sizeof LastTarget);\r | |
537 | return EFI_SUCCESS;\r | |
538 | }\r | |
539 | \r | |
540 | return EFI_NOT_FOUND;\r | |
541 | }\r | |
542 | \r | |
543 | \r | |
544 | EFI_STATUS\r | |
545 | EFIAPI\r | |
546 | VirtioScsiBuildDevicePath (\r | |
547 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r | |
548 | IN UINT8 *Target,\r | |
549 | IN UINT64 Lun,\r | |
550 | IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath\r | |
551 | )\r | |
552 | {\r | |
553 | UINT16 TargetValue;\r | |
554 | VSCSI_DEV *Dev;\r | |
555 | SCSI_DEVICE_PATH *ScsiDevicePath;\r | |
556 | \r | |
557 | if (DevicePath == NULL) {\r | |
558 | return EFI_INVALID_PARAMETER;\r | |
559 | }\r | |
560 | \r | |
561 | CopyMem (&TargetValue, Target, sizeof TargetValue);\r | |
562 | Dev = VIRTIO_SCSI_FROM_PASS_THRU (This);\r | |
563 | if (TargetValue > Dev->MaxTarget || Lun > Dev->MaxLun || Lun > 0xFFFF) {\r | |
564 | return EFI_NOT_FOUND;\r | |
565 | }\r | |
566 | \r | |
567 | ScsiDevicePath = AllocatePool (sizeof *ScsiDevicePath);\r | |
568 | if (ScsiDevicePath == NULL) {\r | |
569 | return EFI_OUT_OF_RESOURCES;\r | |
570 | }\r | |
571 | \r | |
572 | ScsiDevicePath->Header.Type = MESSAGING_DEVICE_PATH;\r | |
573 | ScsiDevicePath->Header.SubType = MSG_SCSI_DP;\r | |
574 | ScsiDevicePath->Header.Length[0] = (UINT8) sizeof *ScsiDevicePath;\r | |
575 | ScsiDevicePath->Header.Length[1] = (UINT8) (sizeof *ScsiDevicePath >> 8);\r | |
576 | ScsiDevicePath->Pun = TargetValue;\r | |
577 | ScsiDevicePath->Lun = (UINT16) Lun;\r | |
578 | \r | |
579 | *DevicePath = &ScsiDevicePath->Header;\r | |
580 | return EFI_SUCCESS;\r | |
581 | }\r | |
582 | \r | |
583 | \r | |
584 | EFI_STATUS\r | |
585 | EFIAPI\r | |
586 | VirtioScsiGetTargetLun (\r | |
587 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r | |
588 | IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r | |
589 | OUT UINT8 **TargetPointer,\r | |
590 | OUT UINT64 *Lun\r | |
591 | )\r | |
592 | {\r | |
593 | SCSI_DEVICE_PATH *ScsiDevicePath;\r | |
594 | VSCSI_DEV *Dev;\r | |
595 | UINT8 *Target;\r | |
596 | \r | |
597 | if (DevicePath == NULL || TargetPointer == NULL || *TargetPointer == NULL ||\r | |
598 | Lun == NULL) {\r | |
599 | return EFI_INVALID_PARAMETER;\r | |
600 | }\r | |
601 | \r | |
602 | if (DevicePath->Type != MESSAGING_DEVICE_PATH ||\r | |
603 | DevicePath->SubType != MSG_SCSI_DP) {\r | |
604 | return EFI_UNSUPPORTED;\r | |
605 | }\r | |
606 | \r | |
607 | ScsiDevicePath = (SCSI_DEVICE_PATH *) DevicePath;\r | |
608 | Dev = VIRTIO_SCSI_FROM_PASS_THRU (This);\r | |
609 | if (ScsiDevicePath->Pun > Dev->MaxTarget ||\r | |
610 | ScsiDevicePath->Lun > Dev->MaxLun) {\r | |
611 | return EFI_NOT_FOUND;\r | |
612 | }\r | |
613 | \r | |
614 | //\r | |
615 | // a) the TargetPointer input parameter is unnecessarily a pointer-to-pointer\r | |
616 | // b) see the TARGET_MAX_BYTES check in "VirtioScsi.h"\r | |
617 | // c) ScsiDevicePath->Pun is an UINT16\r | |
618 | //\r | |
619 | Target = *TargetPointer;\r | |
620 | CopyMem (Target, &ScsiDevicePath->Pun, 2);\r | |
621 | SetMem (Target + 2, TARGET_MAX_BYTES - 2, 0x00);\r | |
622 | \r | |
623 | *Lun = ScsiDevicePath->Lun;\r | |
624 | return EFI_SUCCESS;\r | |
625 | }\r | |
626 | \r | |
627 | \r | |
628 | EFI_STATUS\r | |
629 | EFIAPI\r | |
630 | VirtioScsiResetChannel (\r | |
631 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This\r | |
632 | )\r | |
633 | {\r | |
634 | return EFI_UNSUPPORTED;\r | |
635 | }\r | |
636 | \r | |
637 | \r | |
638 | EFI_STATUS\r | |
639 | EFIAPI\r | |
640 | VirtioScsiResetTargetLun (\r | |
641 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r | |
642 | IN UINT8 *Target,\r | |
643 | IN UINT64 Lun\r | |
644 | )\r | |
645 | {\r | |
646 | return EFI_UNSUPPORTED;\r | |
647 | }\r | |
648 | \r | |
649 | \r | |
650 | EFI_STATUS\r | |
651 | EFIAPI\r | |
652 | VirtioScsiGetNextTarget (\r | |
653 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r | |
654 | IN OUT UINT8 **TargetPointer\r | |
655 | )\r | |
656 | {\r | |
657 | UINT8 *Target;\r | |
658 | UINTN Idx;\r | |
659 | UINT16 LastTarget;\r | |
660 | VSCSI_DEV *Dev;\r | |
661 | \r | |
662 | //\r | |
663 | // the TargetPointer input parameter is unnecessarily a pointer-to-pointer\r | |
664 | //\r | |
665 | Target = *TargetPointer;\r | |
666 | \r | |
667 | //\r | |
668 | // Search for first non-0xFF byte. If not found, return first target.\r | |
669 | //\r | |
670 | for (Idx = 0; Idx < TARGET_MAX_BYTES && Target[Idx] == 0xFF; ++Idx)\r | |
671 | ;\r | |
672 | if (Idx == TARGET_MAX_BYTES) {\r | |
673 | SetMem (Target, TARGET_MAX_BYTES, 0x00);\r | |
674 | return EFI_SUCCESS;\r | |
675 | }\r | |
676 | \r | |
677 | //\r | |
678 | // see the TARGET_MAX_BYTES check in "VirtioScsi.h"\r | |
679 | //\r | |
680 | CopyMem (&LastTarget, Target, sizeof LastTarget);\r | |
681 | \r | |
682 | //\r | |
683 | // increment target if valid on input\r | |
684 | //\r | |
685 | Dev = VIRTIO_SCSI_FROM_PASS_THRU (This);\r | |
686 | if (LastTarget > Dev->MaxTarget) {\r | |
687 | return EFI_INVALID_PARAMETER;\r | |
688 | }\r | |
689 | \r | |
690 | if (LastTarget < Dev->MaxTarget) {\r | |
691 | ++LastTarget;\r | |
692 | CopyMem (Target, &LastTarget, sizeof LastTarget);\r | |
693 | return EFI_SUCCESS;\r | |
694 | }\r | |
695 | \r | |
696 | return EFI_NOT_FOUND;\r | |
697 | }\r | |
698 | \r | |
699 | \r | |
700 | STATIC\r | |
701 | EFI_STATUS\r | |
702 | EFIAPI\r | |
703 | VirtioScsiInit (\r | |
704 | IN OUT VSCSI_DEV *Dev\r | |
705 | )\r | |
706 | {\r | |
707 | UINT8 NextDevStat;\r | |
708 | EFI_STATUS Status;\r | |
709 | \r | |
710 | UINT32 Features;\r | |
711 | UINT16 MaxChannel; // for validation only\r | |
712 | UINT32 NumQueues; // for validation only\r | |
713 | UINT16 QueueSize;\r | |
714 | \r | |
715 | //\r | |
716 | // Execute virtio-0.9.5, 2.2.1 Device Initialization Sequence.\r | |
717 | //\r | |
718 | NextDevStat = 0; // step 1 -- reset device\r | |
56f65ed8 | 719 | Status = Dev->VirtIo->SetDeviceStatus (Dev->VirtIo, NextDevStat);\r |
37078a63 | 720 | if (EFI_ERROR (Status)) {\r |
721 | goto Failed;\r | |
722 | }\r | |
723 | \r | |
724 | NextDevStat |= VSTAT_ACK; // step 2 -- acknowledge device presence\r | |
56f65ed8 | 725 | Status = Dev->VirtIo->SetDeviceStatus (Dev->VirtIo, NextDevStat);\r |
37078a63 | 726 | if (EFI_ERROR (Status)) {\r |
727 | goto Failed;\r | |
728 | }\r | |
729 | \r | |
730 | NextDevStat |= VSTAT_DRIVER; // step 3 -- we know how to drive it\r | |
56f65ed8 OM |
731 | Status = Dev->VirtIo->SetDeviceStatus (Dev->VirtIo, NextDevStat);\r |
732 | if (EFI_ERROR (Status)) {\r | |
733 | goto Failed;\r | |
734 | }\r | |
735 | \r | |
736 | //\r | |
737 | // Set Page Size - MMIO VirtIo Specific\r | |
738 | //\r | |
739 | Status = Dev->VirtIo->SetPageSize (Dev->VirtIo, EFI_PAGE_SIZE);\r | |
37078a63 | 740 | if (EFI_ERROR (Status)) {\r |
741 | goto Failed;\r | |
742 | }\r | |
743 | \r | |
744 | //\r | |
745 | // step 4a -- retrieve and validate features\r | |
746 | //\r | |
56f65ed8 | 747 | Status = Dev->VirtIo->GetDeviceFeatures (Dev->VirtIo, &Features);\r |
37078a63 | 748 | if (EFI_ERROR (Status)) {\r |
749 | goto Failed;\r | |
750 | }\r | |
751 | Dev->InOutSupported = !!(Features & VIRTIO_SCSI_F_INOUT);\r | |
752 | \r | |
56f65ed8 | 753 | Status = VIRTIO_CFG_READ (Dev, MaxChannel, &MaxChannel);\r |
37078a63 | 754 | if (EFI_ERROR (Status)) {\r |
755 | goto Failed;\r | |
756 | }\r | |
757 | if (MaxChannel != 0) {\r | |
758 | //\r | |
759 | // this driver is for a single-channel virtio-scsi HBA\r | |
760 | //\r | |
761 | Status = EFI_UNSUPPORTED;\r | |
762 | goto Failed;\r | |
763 | }\r | |
764 | \r | |
56f65ed8 | 765 | Status = VIRTIO_CFG_READ (Dev, NumQueues, &NumQueues);\r |
37078a63 | 766 | if (EFI_ERROR (Status)) {\r |
767 | goto Failed;\r | |
768 | }\r | |
769 | if (NumQueues < 1) {\r | |
770 | Status = EFI_UNSUPPORTED;\r | |
771 | goto Failed;\r | |
772 | }\r | |
773 | \r | |
56f65ed8 | 774 | Status = VIRTIO_CFG_READ (Dev, MaxTarget, &Dev->MaxTarget);\r |
37078a63 | 775 | if (EFI_ERROR (Status)) {\r |
776 | goto Failed;\r | |
777 | }\r | |
778 | if (Dev->MaxTarget > PcdGet16 (PcdVirtioScsiMaxTargetLimit)) {\r | |
779 | Dev->MaxTarget = PcdGet16 (PcdVirtioScsiMaxTargetLimit);\r | |
780 | }\r | |
781 | \r | |
56f65ed8 | 782 | Status = VIRTIO_CFG_READ (Dev, MaxLun, &Dev->MaxLun);\r |
37078a63 | 783 | if (EFI_ERROR (Status)) {\r |
784 | goto Failed;\r | |
785 | }\r | |
786 | if (Dev->MaxLun > PcdGet32 (PcdVirtioScsiMaxLunLimit)) {\r | |
787 | Dev->MaxLun = PcdGet32 (PcdVirtioScsiMaxLunLimit);\r | |
788 | }\r | |
789 | \r | |
56f65ed8 | 790 | Status = VIRTIO_CFG_READ (Dev, MaxSectors, &Dev->MaxSectors);\r |
37078a63 | 791 | if (EFI_ERROR (Status)) {\r |
792 | goto Failed;\r | |
793 | }\r | |
794 | if (Dev->MaxSectors < 2) {\r | |
795 | //\r | |
796 | // We must be able to halve it for bidirectional transfers\r | |
797 | // (see EFI_BAD_BUFFER_SIZE in PopulateRequest()).\r | |
798 | //\r | |
799 | Status = EFI_UNSUPPORTED;\r | |
800 | goto Failed;\r | |
801 | }\r | |
802 | \r | |
803 | //\r | |
804 | // step 4b -- allocate request virtqueue\r | |
805 | //\r | |
56f65ed8 | 806 | Status = Dev->VirtIo->SetQueueSel (Dev->VirtIo, VIRTIO_SCSI_REQUEST_QUEUE);\r |
37078a63 | 807 | if (EFI_ERROR (Status)) {\r |
808 | goto Failed;\r | |
809 | }\r | |
56f65ed8 | 810 | Status = Dev->VirtIo->GetQueueNumMax (Dev->VirtIo, &QueueSize);\r |
37078a63 | 811 | if (EFI_ERROR (Status)) {\r |
812 | goto Failed;\r | |
813 | }\r | |
814 | //\r | |
815 | // VirtioScsiPassThru() uses at most four descriptors\r | |
816 | //\r | |
817 | if (QueueSize < 4) {\r | |
818 | Status = EFI_UNSUPPORTED;\r | |
819 | goto Failed;\r | |
820 | }\r | |
821 | \r | |
822 | Status = VirtioRingInit (QueueSize, &Dev->Ring);\r | |
823 | if (EFI_ERROR (Status)) {\r | |
824 | goto Failed;\r | |
825 | }\r | |
826 | \r | |
827 | //\r | |
56f65ed8 OM |
828 | // Additional steps for MMIO: align the queue appropriately, and set the\r |
829 | // size. If anything fails from here on, we must release the ring resources.\r | |
37078a63 | 830 | //\r |
56f65ed8 OM |
831 | Status = Dev->VirtIo->SetQueueNum (Dev->VirtIo, QueueSize);\r |
832 | if (EFI_ERROR (Status)) {\r | |
833 | goto ReleaseQueue;\r | |
834 | }\r | |
835 | \r | |
836 | Status = Dev->VirtIo->SetQueueAlign (Dev->VirtIo, EFI_PAGE_SIZE);\r | |
837 | if (EFI_ERROR (Status)) {\r | |
838 | goto ReleaseQueue;\r | |
839 | }\r | |
840 | \r | |
841 | //\r | |
842 | // step 4c -- Report GPFN (guest-physical frame number) of queue.\r | |
843 | //\r | |
844 | Status = Dev->VirtIo->SetQueueAddress (Dev->VirtIo,\r | |
71914406 | 845 | (UINT32) ((UINTN) Dev->Ring.Base >> EFI_PAGE_SHIFT));\r |
37078a63 | 846 | if (EFI_ERROR (Status)) {\r |
847 | goto ReleaseQueue;\r | |
848 | }\r | |
849 | \r | |
850 | //\r | |
851 | // step 5 -- Report understood features and guest-tuneables. We want none of\r | |
852 | // the known (or unknown) VIRTIO_SCSI_F_* or VIRTIO_F_* capabilities (see\r | |
853 | // virtio-0.9.5, Appendices B and I), except bidirectional transfers.\r | |
854 | //\r | |
56f65ed8 OM |
855 | Status = Dev->VirtIo->SetGuestFeatures (Dev->VirtIo,\r |
856 | Features & VIRTIO_SCSI_F_INOUT);\r | |
37078a63 | 857 | if (EFI_ERROR (Status)) {\r |
858 | goto ReleaseQueue;\r | |
859 | }\r | |
860 | \r | |
861 | //\r | |
862 | // We expect these maximum sizes from the host. Since they are\r | |
863 | // guest-negotiable, ask for them rather than just checking them.\r | |
864 | //\r | |
56f65ed8 | 865 | Status = VIRTIO_CFG_WRITE (Dev, CdbSize, VIRTIO_SCSI_CDB_SIZE);\r |
37078a63 | 866 | if (EFI_ERROR (Status)) {\r |
867 | goto ReleaseQueue;\r | |
868 | }\r | |
56f65ed8 | 869 | Status = VIRTIO_CFG_WRITE (Dev, SenseSize, VIRTIO_SCSI_SENSE_SIZE);\r |
37078a63 | 870 | if (EFI_ERROR (Status)) {\r |
871 | goto ReleaseQueue;\r | |
872 | }\r | |
873 | \r | |
874 | //\r | |
875 | // step 6 -- initialization complete\r | |
876 | //\r | |
877 | NextDevStat |= VSTAT_DRIVER_OK;\r | |
56f65ed8 | 878 | Status = Dev->VirtIo->SetDeviceStatus (Dev->VirtIo, NextDevStat);\r |
37078a63 | 879 | if (EFI_ERROR (Status)) {\r |
880 | goto ReleaseQueue;\r | |
881 | }\r | |
882 | \r | |
883 | //\r | |
884 | // populate the exported interface's attributes\r | |
885 | //\r | |
886 | Dev->PassThru.Mode = &Dev->PassThruMode;\r | |
887 | Dev->PassThru.PassThru = &VirtioScsiPassThru;\r | |
888 | Dev->PassThru.GetNextTargetLun = &VirtioScsiGetNextTargetLun;\r | |
889 | Dev->PassThru.BuildDevicePath = &VirtioScsiBuildDevicePath;\r | |
890 | Dev->PassThru.GetTargetLun = &VirtioScsiGetTargetLun;\r | |
891 | Dev->PassThru.ResetChannel = &VirtioScsiResetChannel;\r | |
892 | Dev->PassThru.ResetTargetLun = &VirtioScsiResetTargetLun;\r | |
893 | Dev->PassThru.GetNextTarget = &VirtioScsiGetNextTarget;\r | |
894 | \r | |
895 | //\r | |
896 | // AdapterId is a target for which no handle will be created during bus scan.\r | |
897 | // Prevent any conflict with real devices.\r | |
898 | //\r | |
899 | Dev->PassThruMode.AdapterId = 0xFFFFFFFF;\r | |
900 | \r | |
901 | //\r | |
902 | // Set both physical and logical attributes for non-RAID SCSI channel. See\r | |
903 | // Driver Writer's Guide for UEFI 2.3.1 v1.01, 20.1.5 Implementing Extended\r | |
904 | // SCSI Pass Thru Protocol.\r | |
905 | //\r | |
906 | Dev->PassThruMode.Attributes = EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_PHYSICAL |\r | |
907 | EFI_EXT_SCSI_PASS_THRU_ATTRIBUTES_LOGICAL;\r | |
908 | \r | |
909 | //\r | |
910 | // no restriction on transfer buffer alignment\r | |
911 | //\r | |
912 | Dev->PassThruMode.IoAlign = 0;\r | |
913 | \r | |
914 | return EFI_SUCCESS;\r | |
915 | \r | |
916 | ReleaseQueue:\r | |
917 | VirtioRingUninit (&Dev->Ring);\r | |
918 | \r | |
919 | Failed:\r | |
920 | //\r | |
921 | // Notify the host about our failure to setup: virtio-0.9.5, 2.2.2.1 Device\r | |
56f65ed8 | 922 | // Status. VirtIo access failure here should not mask the original error.\r |
37078a63 | 923 | //\r |
924 | NextDevStat |= VSTAT_FAILED;\r | |
56f65ed8 | 925 | Dev->VirtIo->SetDeviceStatus (Dev->VirtIo, NextDevStat);\r |
37078a63 | 926 | \r |
927 | Dev->InOutSupported = FALSE;\r | |
928 | Dev->MaxTarget = 0;\r | |
929 | Dev->MaxLun = 0;\r | |
930 | Dev->MaxSectors = 0;\r | |
931 | \r | |
932 | return Status; // reached only via Failed above\r | |
933 | }\r | |
934 | \r | |
935 | \r | |
936 | \r | |
937 | STATIC\r | |
938 | VOID\r | |
939 | EFIAPI\r | |
940 | VirtioScsiUninit (\r | |
941 | IN OUT VSCSI_DEV *Dev\r | |
942 | )\r | |
943 | {\r | |
944 | //\r | |
945 | // Reset the virtual device -- see virtio-0.9.5, 2.2.2.1 Device Status. When\r | |
946 | // VIRTIO_CFG_WRITE() returns, the host will have learned to stay away from\r | |
947 | // the old comms area.\r | |
948 | //\r | |
56f65ed8 | 949 | Dev->VirtIo->SetDeviceStatus (Dev->VirtIo, 0);\r |
37078a63 | 950 | \r |
951 | Dev->InOutSupported = FALSE;\r | |
952 | Dev->MaxTarget = 0;\r | |
953 | Dev->MaxLun = 0;\r | |
954 | Dev->MaxSectors = 0;\r | |
955 | \r | |
956 | VirtioRingUninit (&Dev->Ring);\r | |
957 | \r | |
958 | SetMem (&Dev->PassThru, sizeof Dev->PassThru, 0x00);\r | |
959 | SetMem (&Dev->PassThruMode, sizeof Dev->PassThruMode, 0x00);\r | |
960 | }\r | |
961 | \r | |
962 | \r | |
963 | //\r | |
964 | // Probe, start and stop functions of this driver, called by the DXE core for\r | |
965 | // specific devices.\r | |
966 | //\r | |
967 | // The following specifications document these interfaces:\r | |
968 | // - Driver Writer's Guide for UEFI 2.3.1 v1.01, 9 Driver Binding Protocol\r | |
969 | // - UEFI Spec 2.3.1 + Errata C, 10.1 EFI Driver Binding Protocol\r | |
970 | //\r | |
971 | // The implementation follows:\r | |
972 | // - Driver Writer's Guide for UEFI 2.3.1 v1.01\r | |
973 | // - 5.1.3.4 OpenProtocol() and CloseProtocol()\r | |
37078a63 | 974 | // - UEFI Spec 2.3.1 + Errata C\r |
975 | // - 6.3 Protocol Handler Services\r | |
37078a63 | 976 | //\r |
977 | \r | |
978 | EFI_STATUS\r | |
979 | EFIAPI\r | |
980 | VirtioScsiDriverBindingSupported (\r | |
981 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
982 | IN EFI_HANDLE DeviceHandle,\r | |
983 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r | |
984 | )\r | |
985 | {\r | |
56f65ed8 OM |
986 | EFI_STATUS Status;\r |
987 | VIRTIO_DEVICE_PROTOCOL *VirtIo;\r | |
37078a63 | 988 | \r |
989 | //\r | |
56f65ed8 OM |
990 | // Attempt to open the device with the VirtIo set of interfaces. On success,\r |
991 | // the protocol is "instantiated" for the VirtIo device. Covers duplicate open\r | |
37078a63 | 992 | // attempts (EFI_ALREADY_STARTED).\r |
993 | //\r | |
994 | Status = gBS->OpenProtocol (\r | |
995 | DeviceHandle, // candidate device\r | |
56f65ed8 OM |
996 | &gVirtioDeviceProtocolGuid, // for generic VirtIo access\r |
997 | (VOID **)&VirtIo, // handle to instantiate\r | |
37078a63 | 998 | This->DriverBindingHandle, // requestor driver identity\r |
999 | DeviceHandle, // ControllerHandle, according to\r | |
1000 | // the UEFI Driver Model\r | |
56f65ed8 | 1001 | EFI_OPEN_PROTOCOL_BY_DRIVER // get exclusive VirtIo access to\r |
37078a63 | 1002 | // the device; to be released\r |
1003 | );\r | |
1004 | if (EFI_ERROR (Status)) {\r | |
1005 | return Status;\r | |
1006 | }\r | |
1007 | \r | |
56f65ed8 OM |
1008 | if (VirtIo->SubSystemDeviceId != VIRTIO_SUBSYSTEM_SCSI_HOST) {\r |
1009 | Status = EFI_UNSUPPORTED;\r | |
37078a63 | 1010 | }\r |
1011 | \r | |
1012 | //\r | |
56f65ed8 | 1013 | // We needed VirtIo access only transitorily, to see whether we support the\r |
37078a63 | 1014 | // device or not.\r |
1015 | //\r | |
56f65ed8 | 1016 | gBS->CloseProtocol (DeviceHandle, &gVirtioDeviceProtocolGuid,\r |
37078a63 | 1017 | This->DriverBindingHandle, DeviceHandle);\r |
1018 | return Status;\r | |
1019 | }\r | |
1020 | \r | |
1021 | \r | |
1022 | EFI_STATUS\r | |
1023 | EFIAPI\r | |
1024 | VirtioScsiDriverBindingStart (\r | |
1025 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
1026 | IN EFI_HANDLE DeviceHandle,\r | |
1027 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r | |
1028 | )\r | |
1029 | {\r | |
1030 | VSCSI_DEV *Dev;\r | |
1031 | EFI_STATUS Status;\r | |
1032 | \r | |
1033 | Dev = (VSCSI_DEV *) AllocateZeroPool (sizeof *Dev);\r | |
1034 | if (Dev == NULL) {\r | |
1035 | return EFI_OUT_OF_RESOURCES;\r | |
1036 | }\r | |
1037 | \r | |
56f65ed8 OM |
1038 | Status = gBS->OpenProtocol (DeviceHandle, &gVirtioDeviceProtocolGuid,\r |
1039 | (VOID **)&Dev->VirtIo, This->DriverBindingHandle,\r | |
37078a63 | 1040 | DeviceHandle, EFI_OPEN_PROTOCOL_BY_DRIVER);\r |
1041 | if (EFI_ERROR (Status)) {\r | |
1042 | goto FreeVirtioScsi;\r | |
1043 | }\r | |
1044 | \r | |
1045 | //\r | |
56f65ed8 | 1046 | // VirtIo access granted, configure virtio-scsi device.\r |
37078a63 | 1047 | //\r |
1048 | Status = VirtioScsiInit (Dev);\r | |
1049 | if (EFI_ERROR (Status)) {\r | |
56f65ed8 | 1050 | goto CloseVirtIo;\r |
37078a63 | 1051 | }\r |
1052 | \r | |
1053 | //\r | |
1054 | // Setup complete, attempt to export the driver instance's PassThru\r | |
1055 | // interface.\r | |
1056 | //\r | |
1057 | Dev->Signature = VSCSI_SIG;\r | |
1058 | Status = gBS->InstallProtocolInterface (&DeviceHandle,\r | |
1059 | &gEfiExtScsiPassThruProtocolGuid, EFI_NATIVE_INTERFACE,\r | |
1060 | &Dev->PassThru);\r | |
1061 | if (EFI_ERROR (Status)) {\r | |
1062 | goto UninitDev;\r | |
1063 | }\r | |
1064 | \r | |
1065 | return EFI_SUCCESS;\r | |
1066 | \r | |
1067 | UninitDev:\r | |
1068 | VirtioScsiUninit (Dev);\r | |
1069 | \r | |
56f65ed8 OM |
1070 | CloseVirtIo:\r |
1071 | gBS->CloseProtocol (DeviceHandle, &gVirtioDeviceProtocolGuid,\r | |
37078a63 | 1072 | This->DriverBindingHandle, DeviceHandle);\r |
1073 | \r | |
1074 | FreeVirtioScsi:\r | |
1075 | FreePool (Dev);\r | |
1076 | \r | |
1077 | return Status;\r | |
1078 | }\r | |
1079 | \r | |
1080 | \r | |
1081 | EFI_STATUS\r | |
1082 | EFIAPI\r | |
1083 | VirtioScsiDriverBindingStop (\r | |
1084 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
1085 | IN EFI_HANDLE DeviceHandle,\r | |
1086 | IN UINTN NumberOfChildren,\r | |
1087 | IN EFI_HANDLE *ChildHandleBuffer\r | |
1088 | )\r | |
1089 | {\r | |
1090 | EFI_STATUS Status;\r | |
1091 | EFI_EXT_SCSI_PASS_THRU_PROTOCOL *PassThru;\r | |
1092 | VSCSI_DEV *Dev;\r | |
1093 | \r | |
1094 | Status = gBS->OpenProtocol (\r | |
1095 | DeviceHandle, // candidate device\r | |
1096 | &gEfiExtScsiPassThruProtocolGuid, // retrieve the SCSI iface\r | |
1097 | (VOID **)&PassThru, // target pointer\r | |
1098 | This->DriverBindingHandle, // requestor driver ident.\r | |
1099 | DeviceHandle, // lookup req. for dev.\r | |
1100 | EFI_OPEN_PROTOCOL_GET_PROTOCOL // lookup only, no new ref.\r | |
1101 | );\r | |
1102 | if (EFI_ERROR (Status)) {\r | |
1103 | return Status;\r | |
1104 | }\r | |
1105 | \r | |
1106 | Dev = VIRTIO_SCSI_FROM_PASS_THRU (PassThru);\r | |
1107 | \r | |
1108 | //\r | |
1109 | // Handle Stop() requests for in-use driver instances gracefully.\r | |
1110 | //\r | |
1111 | Status = gBS->UninstallProtocolInterface (DeviceHandle,\r | |
1112 | &gEfiExtScsiPassThruProtocolGuid, &Dev->PassThru);\r | |
1113 | if (EFI_ERROR (Status)) {\r | |
1114 | return Status;\r | |
1115 | }\r | |
1116 | \r | |
1117 | VirtioScsiUninit (Dev);\r | |
1118 | \r | |
56f65ed8 | 1119 | gBS->CloseProtocol (DeviceHandle, &gVirtioDeviceProtocolGuid,\r |
37078a63 | 1120 | This->DriverBindingHandle, DeviceHandle);\r |
1121 | \r | |
1122 | FreePool (Dev);\r | |
1123 | \r | |
1124 | return EFI_SUCCESS;\r | |
1125 | }\r | |
1126 | \r | |
1127 | \r | |
1128 | //\r | |
1129 | // The static object that groups the Supported() (ie. probe), Start() and\r | |
1130 | // Stop() functions of the driver together. Refer to UEFI Spec 2.3.1 + Errata\r | |
1131 | // C, 10.1 EFI Driver Binding Protocol.\r | |
1132 | //\r | |
1133 | STATIC EFI_DRIVER_BINDING_PROTOCOL gDriverBinding = {\r | |
1134 | &VirtioScsiDriverBindingSupported,\r | |
1135 | &VirtioScsiDriverBindingStart,\r | |
1136 | &VirtioScsiDriverBindingStop,\r | |
1137 | 0x10, // Version, must be in [0x10 .. 0xFFFFFFEF] for IHV-developed drivers\r | |
1138 | NULL, // ImageHandle, to be overwritten by\r | |
1139 | // EfiLibInstallDriverBindingComponentName2() in VirtioScsiEntryPoint()\r | |
1140 | NULL // DriverBindingHandle, ditto\r | |
1141 | };\r | |
1142 | \r | |
1143 | \r | |
1144 | //\r | |
1145 | // The purpose of the following scaffolding (EFI_COMPONENT_NAME_PROTOCOL and\r | |
1146 | // EFI_COMPONENT_NAME2_PROTOCOL implementation) is to format the driver's name\r | |
1147 | // in English, for display on standard console devices. This is recommended for\r | |
1148 | // UEFI drivers that follow the UEFI Driver Model. Refer to the Driver Writer's\r | |
1149 | // Guide for UEFI 2.3.1 v1.01, 11 UEFI Driver and Controller Names.\r | |
1150 | //\r | |
1151 | // Device type names ("Virtio SCSI Host Device") are not formatted because the\r | |
1152 | // driver supports only that device type. Therefore the driver name suffices\r | |
1153 | // for unambiguous identification.\r | |
1154 | //\r | |
1155 | \r | |
1156 | STATIC\r | |
1157 | EFI_UNICODE_STRING_TABLE mDriverNameTable[] = {\r | |
1158 | { "eng;en", L"Virtio SCSI Host Driver" },\r | |
1159 | { NULL, NULL }\r | |
1160 | };\r | |
1161 | \r | |
1162 | STATIC\r | |
1163 | EFI_COMPONENT_NAME_PROTOCOL gComponentName;\r | |
1164 | \r | |
1165 | EFI_STATUS\r | |
1166 | EFIAPI\r | |
1167 | VirtioScsiGetDriverName (\r | |
1168 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r | |
1169 | IN CHAR8 *Language,\r | |
1170 | OUT CHAR16 **DriverName\r | |
1171 | )\r | |
1172 | {\r | |
1173 | return LookupUnicodeString2 (\r | |
1174 | Language,\r | |
1175 | This->SupportedLanguages,\r | |
1176 | mDriverNameTable,\r | |
1177 | DriverName,\r | |
1178 | (BOOLEAN)(This == &gComponentName) // Iso639Language\r | |
1179 | );\r | |
1180 | }\r | |
1181 | \r | |
1182 | EFI_STATUS\r | |
1183 | EFIAPI\r | |
1184 | VirtioScsiGetDeviceName (\r | |
1185 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r | |
1186 | IN EFI_HANDLE DeviceHandle,\r | |
1187 | IN EFI_HANDLE ChildHandle,\r | |
1188 | IN CHAR8 *Language,\r | |
1189 | OUT CHAR16 **ControllerName\r | |
1190 | )\r | |
1191 | {\r | |
1192 | return EFI_UNSUPPORTED;\r | |
1193 | }\r | |
1194 | \r | |
1195 | STATIC\r | |
1196 | EFI_COMPONENT_NAME_PROTOCOL gComponentName = {\r | |
1197 | &VirtioScsiGetDriverName,\r | |
1198 | &VirtioScsiGetDeviceName,\r | |
1199 | "eng" // SupportedLanguages, ISO 639-2 language codes\r | |
1200 | };\r | |
1201 | \r | |
1202 | STATIC\r | |
1203 | EFI_COMPONENT_NAME2_PROTOCOL gComponentName2 = {\r | |
1204 | (EFI_COMPONENT_NAME2_GET_DRIVER_NAME) &VirtioScsiGetDriverName,\r | |
1205 | (EFI_COMPONENT_NAME2_GET_CONTROLLER_NAME) &VirtioScsiGetDeviceName,\r | |
1206 | "en" // SupportedLanguages, RFC 4646 language codes\r | |
1207 | };\r | |
1208 | \r | |
1209 | \r | |
1210 | //\r | |
1211 | // Entry point of this driver.\r | |
1212 | //\r | |
1213 | EFI_STATUS\r | |
1214 | EFIAPI\r | |
1215 | VirtioScsiEntryPoint (\r | |
1216 | IN EFI_HANDLE ImageHandle,\r | |
1217 | IN EFI_SYSTEM_TABLE *SystemTable\r | |
1218 | )\r | |
1219 | {\r | |
1220 | return EfiLibInstallDriverBindingComponentName2 (\r | |
1221 | ImageHandle,\r | |
1222 | SystemTable,\r | |
1223 | &gDriverBinding,\r | |
1224 | ImageHandle,\r | |
1225 | &gComponentName,\r | |
1226 | &gComponentName2\r | |
1227 | );\r | |
1228 | }\r |