]>
Commit | Line | Data |
---|---|---|
878ddf1f | 1 | /*++\r |
2 | \r | |
3 | Copyright (c) 2006, 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 | WinNtBlockIo.c\r | |
15 | \r | |
16 | Abstract:\r | |
17 | \r | |
18 | Produce block IO abstractions for real devices on your PC using Win32 APIs.\r | |
19 | The configuration of what devices to mount or emulate comes from NT\r | |
20 | environment variables. The variables must be visible to the Microsoft*\r | |
21 | Developer Studio for them to work.\r | |
22 | \r | |
23 | <F>ixed - Fixed disk like a hard drive.\r | |
24 | <R>emovable - Removable media like a floppy or CD-ROM.\r | |
25 | Read <O>nly - Write protected device.\r | |
26 | Read <W>rite - Read write device.\r | |
27 | <block count> - Decimal number of blocks a device supports.\r | |
28 | <block size> - Decimal number of bytes per block.\r | |
29 | \r | |
30 | NT envirnonment variable contents. '<' and '>' are not part of the variable,\r | |
31 | they are just used to make this help more readable. There should be no\r | |
32 | spaces between the ';'. Extra spaces will break the variable. A '!' is\r | |
33 | used to seperate multiple devices in a variable.\r | |
34 | \r | |
35 | EFI_WIN_NT_VIRTUAL_DISKS =\r | |
36 | <F | R><O | W>;<block count>;<block size>[!...]\r | |
37 | \r | |
38 | EFI_WIN_NT_PHYSICAL_DISKS =\r | |
39 | <drive letter>:<F | R><O | W>;<block count>;<block size>[!...]\r | |
40 | \r | |
41 | Virtual Disks: These devices use a file to emulate a hard disk or removable\r | |
42 | media device.\r | |
43 | \r | |
44 | Thus a 20 MB emulated hard drive would look like:\r | |
45 | EFI_WIN_NT_VIRTUAL_DISKS=FW;40960;512\r | |
46 | \r | |
47 | A 1.44MB emulated floppy with a block size of 1024 would look like:\r | |
48 | EFI_WIN_NT_VIRTUAL_DISKS=RW;1440;1024\r | |
49 | \r | |
50 | Physical Disks: These devices use NT to open a real device in your system\r | |
51 | \r | |
52 | Thus a 120 MB floppy would look like:\r | |
53 | EFI_WIN_NT_PHYSICAL_DISKS=B:RW;245760;512\r | |
54 | \r | |
55 | Thus a standard CD-ROM floppy would look like:\r | |
56 | EFI_WIN_NT_PHYSICAL_DISKS=Z:RO;307200;2048\r | |
57 | \r | |
58 | \r | |
59 | * Other names and brands may be claimed as the property of others.\r | |
60 | \r | |
61 | --*/\r | |
62 | \r | |
63 | #include "WinNtBlockIo.h"\r | |
64 | \r | |
65 | EFI_DRIVER_BINDING_PROTOCOL gWinNtBlockIoDriverBinding = {\r | |
66 | WinNtBlockIoDriverBindingSupported,\r | |
67 | WinNtBlockIoDriverBindingStart,\r | |
68 | WinNtBlockIoDriverBindingStop,\r | |
8b018de6 | 69 | 0xa,\r |
878ddf1f | 70 | NULL,\r |
71 | NULL\r | |
72 | };\r | |
73 | \r | |
74 | \r | |
75 | EFI_STATUS\r | |
76 | EFIAPI\r | |
77 | WinNtBlockIoDriverBindingSupported (\r | |
78 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
79 | IN EFI_HANDLE Handle,\r | |
80 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r | |
81 | )\r | |
82 | /*++\r | |
83 | \r | |
84 | Routine Description:\r | |
85 | \r | |
86 | Arguments:\r | |
87 | \r | |
88 | Returns:\r | |
89 | \r | |
90 | None\r | |
91 | \r | |
92 | --*/\r | |
93 | // TODO: This - add argument and description to function comment\r | |
94 | // TODO: Handle - add argument and description to function comment\r | |
95 | // TODO: RemainingDevicePath - add argument and description to function comment\r | |
96 | {\r | |
97 | EFI_STATUS Status;\r | |
98 | EFI_WIN_NT_IO_PROTOCOL *WinNtIo;\r | |
99 | \r | |
100 | //\r | |
101 | // Open the IO Abstraction(s) needed to perform the supported test\r | |
102 | //\r | |
103 | Status = gBS->OpenProtocol (\r | |
104 | Handle,\r | |
105 | &gEfiWinNtIoProtocolGuid,\r | |
106 | &WinNtIo,\r | |
107 | This->DriverBindingHandle,\r | |
108 | Handle,\r | |
109 | EFI_OPEN_PROTOCOL_BY_DRIVER\r | |
110 | );\r | |
111 | if (EFI_ERROR (Status)) {\r | |
112 | return Status;\r | |
113 | }\r | |
114 | \r | |
115 | //\r | |
116 | // Make sure the WinNtThunkProtocol is valid\r | |
117 | //\r | |
118 | Status = EFI_UNSUPPORTED;\r | |
119 | if (WinNtIo->WinNtThunk->Signature == EFI_WIN_NT_THUNK_PROTOCOL_SIGNATURE) {\r | |
120 | \r | |
121 | //\r | |
122 | // Check the GUID to see if this is a handle type the driver supports\r | |
123 | //\r | |
124 | if (CompareGuid (WinNtIo->TypeGuid, &gEfiWinNtVirtualDisksGuid) ||\r | |
125 | CompareGuid (WinNtIo->TypeGuid, &gEfiWinNtPhysicalDisksGuid) ) {\r | |
126 | Status = EFI_SUCCESS;\r | |
127 | }\r | |
128 | }\r | |
129 | \r | |
130 | //\r | |
131 | // Close the I/O Abstraction(s) used to perform the supported test\r | |
132 | //\r | |
133 | gBS->CloseProtocol (\r | |
134 | Handle,\r | |
135 | &gEfiWinNtIoProtocolGuid,\r | |
136 | This->DriverBindingHandle,\r | |
137 | Handle\r | |
138 | );\r | |
139 | \r | |
140 | return Status;\r | |
141 | }\r | |
142 | \r | |
143 | EFI_STATUS\r | |
144 | EFIAPI\r | |
145 | WinNtBlockIoDriverBindingStart (\r | |
146 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
147 | IN EFI_HANDLE Handle,\r | |
148 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r | |
149 | )\r | |
150 | /*++\r | |
151 | \r | |
152 | Routine Description:\r | |
153 | \r | |
154 | Arguments:\r | |
155 | \r | |
156 | Returns:\r | |
157 | \r | |
158 | None\r | |
159 | \r | |
160 | --*/\r | |
161 | // TODO: This - add argument and description to function comment\r | |
162 | // TODO: Handle - add argument and description to function comment\r | |
163 | // TODO: RemainingDevicePath - add argument and description to function comment\r | |
164 | {\r | |
165 | EFI_STATUS Status;\r | |
166 | EFI_WIN_NT_IO_PROTOCOL *WinNtIo;\r | |
167 | WIN_NT_RAW_DISK_DEVICE_TYPE DiskType;\r | |
168 | UINT16 Buffer[FILENAME_BUFFER_SIZE];\r | |
169 | CHAR16 *Str;\r | |
170 | BOOLEAN RemovableMedia;\r | |
171 | BOOLEAN WriteProtected;\r | |
172 | UINTN NumberOfBlocks;\r | |
173 | UINTN BlockSize;\r | |
174 | \r | |
175 | //\r | |
176 | // Grab the protocols we need\r | |
177 | //\r | |
178 | Status = gBS->OpenProtocol (\r | |
179 | Handle,\r | |
180 | &gEfiWinNtIoProtocolGuid,\r | |
181 | &WinNtIo,\r | |
182 | This->DriverBindingHandle,\r | |
183 | Handle,\r | |
184 | EFI_OPEN_PROTOCOL_BY_DRIVER\r | |
185 | );\r | |
186 | if (EFI_ERROR (Status)) {\r | |
187 | return Status;\r | |
188 | }\r | |
189 | \r | |
190 | //\r | |
191 | // Set DiskType\r | |
192 | //\r | |
193 | if (CompareGuid (WinNtIo->TypeGuid, &gEfiWinNtVirtualDisksGuid)) {\r | |
194 | DiskType = EfiWinNtVirtualDisks;\r | |
195 | } else if (CompareGuid (WinNtIo->TypeGuid, &gEfiWinNtPhysicalDisksGuid)) {\r | |
196 | DiskType = EfiWinNtPhysicalDisks;\r | |
197 | } else {\r | |
198 | Status = EFI_UNSUPPORTED;\r | |
199 | goto Done;\r | |
200 | }\r | |
201 | \r | |
202 | Status = EFI_NOT_FOUND;\r | |
203 | Str = WinNtIo->EnvString;\r | |
204 | if (DiskType == EfiWinNtVirtualDisks) {\r | |
205 | WinNtIo->WinNtThunk->SPrintf (\r | |
206 | Buffer,\r | |
c4bbb32b | 207 | sizeof (Buffer),\r |
878ddf1f | 208 | L"Diskfile%d",\r |
209 | WinNtIo->InstanceNumber\r | |
210 | );\r | |
211 | } else {\r | |
212 | if (*Str >= 'A' && *Str <= 'Z' || *Str >= 'a' && *Str <= 'z') {\r | |
c4bbb32b | 213 | WinNtIo->WinNtThunk->SPrintf (Buffer, sizeof (Buffer), L"\\\\.\\%c:", *Str);\r |
878ddf1f | 214 | } else {\r |
c4bbb32b | 215 | WinNtIo->WinNtThunk->SPrintf (Buffer, sizeof (Buffer), L"\\\\.\\PHYSICALDRIVE%c", *Str);\r |
878ddf1f | 216 | }\r |
217 | \r | |
218 | Str++;\r | |
219 | if (*Str != ':') {\r | |
220 | Status = EFI_NOT_FOUND;\r | |
221 | goto Done;\r | |
222 | }\r | |
223 | \r | |
224 | Str++;\r | |
225 | }\r | |
226 | \r | |
227 | if (*Str == 'R' || *Str == 'F') {\r | |
228 | RemovableMedia = (BOOLEAN) (*Str == 'R');\r | |
229 | Str++;\r | |
230 | if (*Str == 'O' || *Str == 'W') {\r | |
231 | WriteProtected = (BOOLEAN) (*Str == 'O');\r | |
232 | Str = GetNextElementPastTerminator (Str, ';');\r | |
233 | \r | |
234 | NumberOfBlocks = Atoi (Str);\r | |
235 | if (NumberOfBlocks != 0) {\r | |
236 | Str = GetNextElementPastTerminator (Str, ';');\r | |
237 | BlockSize = Atoi (Str);\r | |
238 | if (BlockSize != 0) {\r | |
239 | //\r | |
240 | // If we get here the variable is valid so do the work.\r | |
241 | //\r | |
242 | Status = WinNtBlockIoCreateMapping (\r | |
243 | WinNtIo,\r | |
244 | Handle,\r | |
245 | Buffer,\r | |
246 | WriteProtected,\r | |
247 | RemovableMedia,\r | |
248 | NumberOfBlocks,\r | |
249 | BlockSize,\r | |
250 | DiskType\r | |
251 | );\r | |
252 | \r | |
253 | }\r | |
254 | }\r | |
255 | }\r | |
256 | }\r | |
257 | \r | |
258 | Done:\r | |
259 | if (EFI_ERROR (Status)) {\r | |
260 | gBS->CloseProtocol (\r | |
261 | Handle,\r | |
262 | &gEfiWinNtIoProtocolGuid,\r | |
263 | This->DriverBindingHandle,\r | |
264 | Handle\r | |
265 | );\r | |
266 | }\r | |
267 | \r | |
268 | return Status;\r | |
269 | }\r | |
270 | \r | |
271 | EFI_STATUS\r | |
272 | EFIAPI\r | |
273 | WinNtBlockIoDriverBindingStop (\r | |
274 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
275 | IN EFI_HANDLE Handle,\r | |
276 | IN UINTN NumberOfChildren,\r | |
277 | IN EFI_HANDLE *ChildHandleBuffer\r | |
278 | )\r | |
279 | /*++\r | |
280 | \r | |
281 | Routine Description:\r | |
282 | \r | |
283 | TODO: Add function description\r | |
284 | \r | |
285 | Arguments:\r | |
286 | \r | |
287 | This - TODO: add argument description\r | |
288 | Handle - TODO: add argument description\r | |
289 | NumberOfChildren - TODO: add argument description\r | |
290 | ChildHandleBuffer - TODO: add argument description\r | |
291 | \r | |
292 | Returns:\r | |
293 | \r | |
294 | EFI_UNSUPPORTED - TODO: Add description for return value\r | |
295 | \r | |
296 | --*/\r | |
297 | {\r | |
298 | EFI_BLOCK_IO_PROTOCOL *BlockIo;\r | |
299 | EFI_STATUS Status;\r | |
300 | WIN_NT_BLOCK_IO_PRIVATE *Private;\r | |
301 | \r | |
302 | //\r | |
303 | // Get our context back\r | |
304 | //\r | |
305 | Status = gBS->OpenProtocol (\r | |
306 | Handle,\r | |
307 | &gEfiBlockIoProtocolGuid,\r | |
308 | &BlockIo,\r | |
309 | This->DriverBindingHandle,\r | |
310 | Handle,\r | |
311 | EFI_OPEN_PROTOCOL_GET_PROTOCOL\r | |
312 | );\r | |
313 | if (EFI_ERROR (Status)) {\r | |
314 | return EFI_UNSUPPORTED;\r | |
315 | }\r | |
316 | \r | |
317 | Private = WIN_NT_BLOCK_IO_PRIVATE_DATA_FROM_THIS (BlockIo);\r | |
318 | \r | |
319 | //\r | |
320 | // BugBug: If we need to kick people off, we need to make Uninstall Close the handles.\r | |
321 | // We could pass in our image handle or FLAG our open to be closed via\r | |
322 | // Unistall (== to saying any CloseProtocol will close our open)\r | |
323 | //\r | |
324 | Status = gBS->UninstallMultipleProtocolInterfaces (\r | |
325 | Private->EfiHandle,\r | |
326 | &gEfiBlockIoProtocolGuid,\r | |
327 | &Private->BlockIo,\r | |
328 | NULL\r | |
329 | );\r | |
330 | if (!EFI_ERROR (Status)) {\r | |
331 | \r | |
332 | Status = gBS->CloseProtocol (\r | |
333 | Handle,\r | |
334 | &gEfiWinNtIoProtocolGuid,\r | |
335 | This->DriverBindingHandle,\r | |
336 | Handle\r | |
337 | );\r | |
338 | \r | |
339 | //\r | |
340 | // Shut down our device\r | |
341 | //\r | |
342 | Private->WinNtThunk->CloseHandle (Private->NtHandle);\r | |
343 | \r | |
344 | //\r | |
345 | // Free our instance data\r | |
346 | //\r | |
347 | FreeUnicodeStringTable (Private->ControllerNameTable);\r | |
348 | \r | |
349 | gBS->FreePool (Private);\r | |
350 | }\r | |
351 | \r | |
352 | return Status;\r | |
353 | }\r | |
354 | \r | |
355 | STATIC\r | |
356 | CHAR16 *\r | |
357 | GetNextElementPastTerminator (\r | |
358 | IN CHAR16 *EnvironmentVariable,\r | |
359 | IN CHAR16 Terminator\r | |
360 | )\r | |
361 | /*++\r | |
362 | \r | |
363 | Routine Description:\r | |
364 | \r | |
365 | Worker function to parse environment variables.\r | |
366 | \r | |
367 | Arguments:\r | |
368 | EnvironmentVariable - Envirnment variable to parse.\r | |
369 | \r | |
370 | Terminator - Terminator to parse for.\r | |
371 | \r | |
372 | Returns:\r | |
373 | \r | |
374 | Pointer to next eliment past the first occurence of Terminator or the '\0'\r | |
375 | at the end of the string.\r | |
376 | \r | |
377 | --*/\r | |
378 | {\r | |
379 | CHAR16 *Ptr;\r | |
380 | \r | |
381 | for (Ptr = EnvironmentVariable; *Ptr != '\0'; Ptr++) {\r | |
382 | if (*Ptr == Terminator) {\r | |
383 | Ptr++;\r | |
384 | break;\r | |
385 | }\r | |
386 | }\r | |
387 | \r | |
388 | return Ptr;\r | |
389 | }\r | |
390 | \r | |
391 | STATIC\r | |
392 | EFI_STATUS\r | |
393 | WinNtBlockIoCreateMapping (\r | |
394 | IN EFI_WIN_NT_IO_PROTOCOL *WinNtIo,\r | |
395 | IN EFI_HANDLE EfiDeviceHandle,\r | |
396 | IN CHAR16 *Filename,\r | |
397 | IN BOOLEAN ReadOnly,\r | |
398 | IN BOOLEAN RemovableMedia,\r | |
399 | IN UINTN NumberOfBlocks,\r | |
400 | IN UINTN BlockSize,\r | |
401 | IN WIN_NT_RAW_DISK_DEVICE_TYPE DeviceType\r | |
402 | )\r | |
403 | /*++\r | |
404 | \r | |
405 | Routine Description:\r | |
406 | \r | |
407 | TODO: Add function description\r | |
408 | \r | |
409 | Arguments:\r | |
410 | \r | |
411 | WinNtIo - TODO: add argument description\r | |
412 | EfiDeviceHandle - TODO: add argument description\r | |
413 | Filename - TODO: add argument description\r | |
414 | ReadOnly - TODO: add argument description\r | |
415 | RemovableMedia - TODO: add argument description\r | |
416 | NumberOfBlocks - TODO: add argument description\r | |
417 | BlockSize - TODO: add argument description\r | |
418 | DeviceType - TODO: add argument description\r | |
419 | \r | |
420 | Returns:\r | |
421 | \r | |
422 | TODO: add return values\r | |
423 | \r | |
424 | --*/\r | |
425 | {\r | |
426 | EFI_STATUS Status;\r | |
427 | EFI_BLOCK_IO_PROTOCOL *BlockIo;\r | |
428 | WIN_NT_BLOCK_IO_PRIVATE *Private;\r | |
429 | UINTN Index;\r | |
430 | \r | |
431 | WinNtIo->WinNtThunk->SetErrorMode (SEM_FAILCRITICALERRORS);\r | |
432 | \r | |
433 | Status = gBS->AllocatePool (\r | |
434 | EfiBootServicesData,\r | |
435 | sizeof (WIN_NT_BLOCK_IO_PRIVATE),\r | |
436 | &Private\r | |
437 | );\r | |
438 | ASSERT_EFI_ERROR (Status);\r | |
439 | \r | |
440 | EfiInitializeLock (&Private->Lock, EFI_TPL_NOTIFY);\r | |
441 | \r | |
442 | Private->WinNtThunk = WinNtIo->WinNtThunk;\r | |
443 | \r | |
444 | Private->Signature = WIN_NT_BLOCK_IO_PRIVATE_SIGNATURE;\r | |
445 | Private->LastBlock = NumberOfBlocks - 1;\r | |
446 | Private->BlockSize = BlockSize;\r | |
447 | \r | |
448 | for (Index = 0; Filename[Index] != 0; Index++) {\r | |
449 | Private->Filename[Index] = Filename[Index];\r | |
450 | }\r | |
451 | \r | |
452 | Private->Filename[Index] = 0;\r | |
453 | \r | |
454 | Private->ReadMode = GENERIC_READ | (ReadOnly ? 0 : GENERIC_WRITE);\r | |
455 | Private->ShareMode = FILE_SHARE_READ | FILE_SHARE_WRITE;\r | |
456 | \r | |
457 | Private->NumberOfBlocks = NumberOfBlocks;\r | |
458 | Private->DeviceType = DeviceType;\r | |
459 | Private->NtHandle = INVALID_HANDLE_VALUE;\r | |
460 | \r | |
461 | Private->ControllerNameTable = NULL;\r | |
462 | \r | |
463 | AddUnicodeString (\r | |
464 | "eng",\r | |
465 | gWinNtBlockIoComponentName.SupportedLanguages,\r | |
466 | &Private->ControllerNameTable,\r | |
467 | Private->Filename\r | |
468 | );\r | |
469 | \r | |
470 | BlockIo = &Private->BlockIo;\r | |
471 | BlockIo->Revision = EFI_BLOCK_IO_PROTOCOL_REVISION;\r | |
472 | BlockIo->Media = &Private->Media;\r | |
473 | BlockIo->Media->BlockSize = Private->BlockSize;\r | |
474 | BlockIo->Media->LastBlock = Private->NumberOfBlocks - 1;\r | |
475 | BlockIo->Media->MediaId = 0;;\r | |
476 | \r | |
477 | BlockIo->Reset = WinNtBlockIoResetBlock;\r | |
478 | BlockIo->ReadBlocks = WinNtBlockIoReadBlocks;\r | |
479 | BlockIo->WriteBlocks = WinNtBlockIoWriteBlocks;\r | |
480 | BlockIo->FlushBlocks = WinNtBlockIoFlushBlocks;\r | |
481 | \r | |
482 | BlockIo->Media->ReadOnly = ReadOnly;\r | |
483 | BlockIo->Media->RemovableMedia = RemovableMedia;\r | |
484 | BlockIo->Media->LogicalPartition = FALSE;\r | |
485 | BlockIo->Media->MediaPresent = TRUE;\r | |
486 | BlockIo->Media->WriteCaching = FALSE;\r | |
487 | \r | |
488 | if (DeviceType == EfiWinNtVirtualDisks) {\r | |
489 | BlockIo->Media->IoAlign = 1;\r | |
490 | \r | |
491 | //\r | |
492 | // Create a file to use for a virtual disk even if it does not exist.\r | |
493 | //\r | |
494 | Private->OpenMode = OPEN_ALWAYS;\r | |
495 | } else if (DeviceType == EfiWinNtPhysicalDisks) {\r | |
496 | //\r | |
497 | // Physical disk and floppy devices require 4 byte alignment.\r | |
498 | //\r | |
499 | BlockIo->Media->IoAlign = 4;\r | |
500 | \r | |
501 | //\r | |
502 | // You can only open a physical device if it exists.\r | |
503 | //\r | |
504 | Private->OpenMode = OPEN_EXISTING;\r | |
505 | } else {\r | |
506 | ASSERT (FALSE);\r | |
507 | }\r | |
508 | \r | |
509 | Private->EfiHandle = EfiDeviceHandle;\r | |
510 | Status = WinNtBlockIoOpenDevice (Private);\r | |
511 | if (!EFI_ERROR (Status)) {\r | |
512 | \r | |
513 | Status = gBS->InstallMultipleProtocolInterfaces (\r | |
514 | &Private->EfiHandle,\r | |
515 | &gEfiBlockIoProtocolGuid,\r | |
516 | &Private->BlockIo,\r | |
517 | NULL\r | |
518 | );\r | |
519 | if (EFI_ERROR (Status)) {\r | |
520 | FreeUnicodeStringTable (Private->ControllerNameTable);\r | |
521 | gBS->FreePool (Private);\r | |
522 | }\r | |
523 | \r | |
524 | DEBUG ((EFI_D_INIT, "BlockDevice added: %s\n", Filename));\r | |
525 | }\r | |
526 | \r | |
527 | return Status;\r | |
528 | }\r | |
529 | \r | |
530 | STATIC\r | |
531 | EFI_STATUS\r | |
532 | WinNtBlockIoOpenDevice (\r | |
533 | WIN_NT_BLOCK_IO_PRIVATE *Private\r | |
534 | )\r | |
535 | /*++\r | |
536 | \r | |
537 | Routine Description:\r | |
538 | \r | |
539 | TODO: Add function description\r | |
540 | \r | |
541 | Arguments:\r | |
542 | \r | |
543 | Private - TODO: add argument description\r | |
544 | \r | |
545 | Returns:\r | |
546 | \r | |
547 | TODO: add return values\r | |
548 | \r | |
549 | --*/\r | |
550 | {\r | |
551 | EFI_STATUS Status;\r | |
552 | UINT64 FileSize;\r | |
553 | UINT64 EndOfFile;\r | |
554 | EFI_BLOCK_IO_PROTOCOL *BlockIo;\r | |
555 | \r | |
556 | BlockIo = &Private->BlockIo;\r | |
557 | EfiAcquireLock (&Private->Lock);\r | |
558 | \r | |
559 | //\r | |
560 | // If the device is already opened, close it\r | |
561 | //\r | |
562 | if (Private->NtHandle != INVALID_HANDLE_VALUE) {\r | |
563 | BlockIo->Reset (BlockIo, FALSE);\r | |
564 | }\r | |
565 | \r | |
566 | //\r | |
567 | // Open the device\r | |
568 | //\r | |
569 | Private->NtHandle = Private->WinNtThunk->CreateFile (\r | |
570 | Private->Filename,\r | |
571 | Private->ReadMode,\r | |
572 | Private->ShareMode,\r | |
573 | NULL,\r | |
574 | Private->OpenMode,\r | |
575 | 0,\r | |
576 | NULL\r | |
577 | );\r | |
578 | \r | |
579 | Status = Private->WinNtThunk->GetLastError ();\r | |
580 | \r | |
581 | if (Private->NtHandle == INVALID_HANDLE_VALUE) {\r | |
582 | DEBUG ((EFI_D_INFO, "PlOpenBlock: Could not open %s, %x\n", Private->Filename, Private->WinNtThunk->GetLastError ()));\r | |
583 | BlockIo->Media->MediaPresent = FALSE;\r | |
584 | Status = EFI_NO_MEDIA;\r | |
585 | goto Done;\r | |
586 | }\r | |
587 | \r | |
588 | if (!BlockIo->Media->MediaPresent) {\r | |
589 | //\r | |
590 | // BugBug: try to emulate if a CD appears - notify drivers to check it out\r | |
591 | //\r | |
592 | BlockIo->Media->MediaPresent = TRUE;\r | |
593 | EfiReleaseLock (&Private->Lock);\r | |
594 | EfiAcquireLock (&Private->Lock);\r | |
595 | }\r | |
596 | \r | |
597 | //\r | |
598 | // get the size of the file\r | |
599 | //\r | |
600 | Status = SetFilePointer64 (Private, 0, &FileSize, FILE_END);\r | |
601 | \r | |
602 | if (EFI_ERROR (Status)) {\r | |
603 | FileSize = MultU64x32 (Private->NumberOfBlocks, Private->BlockSize);\r | |
604 | if (Private->DeviceType == EfiWinNtVirtualDisks) {\r | |
605 | DEBUG ((EFI_D_ERROR, "PlOpenBlock: Could not get filesize of %s\n", Private->Filename));\r | |
606 | Status = EFI_UNSUPPORTED;\r | |
607 | goto Done;\r | |
608 | }\r | |
609 | }\r | |
610 | \r | |
611 | if (Private->NumberOfBlocks == 0) {\r | |
612 | Private->NumberOfBlocks = DivU64x32 (FileSize, Private->BlockSize);\r | |
613 | }\r | |
614 | \r | |
615 | EndOfFile = MultU64x32 (Private->NumberOfBlocks, Private->BlockSize);\r | |
616 | \r | |
617 | if (FileSize != EndOfFile) {\r | |
618 | //\r | |
619 | // file is not the proper size, change it\r | |
620 | //\r | |
621 | DEBUG ((EFI_D_INIT, "PlOpenBlock: Initializing block device: %hs\n", Private->Filename));\r | |
622 | \r | |
623 | //\r | |
624 | // first set it to 0\r | |
625 | //\r | |
626 | SetFilePointer64 (Private, 0, NULL, FILE_BEGIN);\r | |
627 | Private->WinNtThunk->SetEndOfFile (Private->NtHandle);\r | |
628 | \r | |
629 | //\r | |
630 | // then set it to the needed file size (OS will zero fill it)\r | |
631 | //\r | |
632 | SetFilePointer64 (Private, EndOfFile, NULL, FILE_BEGIN);\r | |
633 | Private->WinNtThunk->SetEndOfFile (Private->NtHandle);\r | |
634 | }\r | |
635 | \r | |
636 | DEBUG ((EFI_D_INIT, "%HPlOpenBlock: opened %s%N\n", Private->Filename));\r | |
637 | Status = EFI_SUCCESS;\r | |
638 | \r | |
639 | Done:\r | |
640 | if (EFI_ERROR (Status)) {\r | |
641 | if (Private->NtHandle != INVALID_HANDLE_VALUE) {\r | |
642 | BlockIo->Reset (BlockIo, FALSE);\r | |
643 | }\r | |
644 | }\r | |
645 | \r | |
646 | EfiReleaseLock (&Private->Lock);\r | |
647 | return Status;\r | |
648 | }\r | |
649 | \r | |
650 | STATIC\r | |
651 | EFI_STATUS\r | |
652 | WinNtBlockIoError (\r | |
653 | IN WIN_NT_BLOCK_IO_PRIVATE *Private\r | |
654 | )\r | |
655 | /*++\r | |
656 | \r | |
657 | Routine Description:\r | |
658 | \r | |
659 | TODO: Add function description\r | |
660 | \r | |
661 | Arguments:\r | |
662 | \r | |
663 | Private - TODO: add argument description\r | |
664 | \r | |
665 | Returns:\r | |
666 | \r | |
667 | TODO: add return values\r | |
668 | \r | |
669 | --*/\r | |
670 | {\r | |
671 | EFI_BLOCK_IO_PROTOCOL *BlockIo;\r | |
672 | EFI_STATUS Status;\r | |
673 | BOOLEAN ReinstallBlockIoFlag;\r | |
674 | \r | |
675 | BlockIo = &Private->BlockIo;\r | |
676 | \r | |
677 | switch (Private->WinNtThunk->GetLastError ()) {\r | |
678 | \r | |
679 | case ERROR_NOT_READY:\r | |
680 | Status = EFI_NO_MEDIA;\r | |
681 | BlockIo->Media->ReadOnly = FALSE;\r | |
682 | BlockIo->Media->MediaPresent = FALSE;\r | |
683 | ReinstallBlockIoFlag = FALSE;\r | |
684 | break;\r | |
685 | \r | |
686 | case ERROR_WRONG_DISK:\r | |
687 | BlockIo->Media->ReadOnly = FALSE;\r | |
688 | BlockIo->Media->MediaPresent = TRUE;\r | |
689 | BlockIo->Media->MediaId += 1;\r | |
690 | ReinstallBlockIoFlag = TRUE;\r | |
691 | Status = EFI_MEDIA_CHANGED;\r | |
692 | break;\r | |
693 | \r | |
694 | case ERROR_WRITE_PROTECT:\r | |
695 | BlockIo->Media->ReadOnly = TRUE;\r | |
696 | ReinstallBlockIoFlag = FALSE;\r | |
697 | Status = EFI_WRITE_PROTECTED;\r | |
698 | break;\r | |
699 | \r | |
700 | default:\r | |
701 | ReinstallBlockIoFlag = FALSE;\r | |
702 | Status = EFI_DEVICE_ERROR;\r | |
703 | break;\r | |
704 | }\r | |
705 | \r | |
706 | if (ReinstallBlockIoFlag) {\r | |
707 | BlockIo->Reset (BlockIo, FALSE);\r | |
708 | \r | |
709 | gBS->ReinstallProtocolInterface (\r | |
710 | Private->EfiHandle,\r | |
711 | &gEfiBlockIoProtocolGuid,\r | |
712 | BlockIo,\r | |
713 | BlockIo\r | |
714 | );\r | |
715 | }\r | |
716 | \r | |
717 | return Status;\r | |
718 | }\r | |
719 | \r | |
720 | STATIC\r | |
721 | EFI_STATUS\r | |
722 | WinNtBlockIoReadWriteCommon (\r | |
723 | IN WIN_NT_BLOCK_IO_PRIVATE *Private,\r | |
724 | IN UINT32 MediaId,\r | |
725 | IN EFI_LBA Lba,\r | |
726 | IN UINTN BufferSize,\r | |
727 | IN VOID *Buffer,\r | |
728 | IN CHAR8 *CallerName\r | |
729 | )\r | |
730 | /*++\r | |
731 | \r | |
732 | Routine Description:\r | |
733 | \r | |
734 | TODO: Add function description\r | |
735 | \r | |
736 | Arguments:\r | |
737 | \r | |
738 | Private - TODO: add argument description\r | |
739 | MediaId - TODO: add argument description\r | |
740 | Lba - TODO: add argument description\r | |
741 | BufferSize - TODO: add argument description\r | |
742 | Buffer - TODO: add argument description\r | |
743 | CallerName - TODO: add argument description\r | |
744 | \r | |
745 | Returns:\r | |
746 | \r | |
747 | EFI_NO_MEDIA - TODO: Add description for return value\r | |
748 | EFI_MEDIA_CHANGED - TODO: Add description for return value\r | |
749 | EFI_INVALID_PARAMETER - TODO: Add description for return value\r | |
750 | EFI_SUCCESS - TODO: Add description for return value\r | |
751 | EFI_BAD_BUFFER_SIZE - TODO: Add description for return value\r | |
752 | EFI_INVALID_PARAMETER - TODO: Add description for return value\r | |
753 | EFI_SUCCESS - TODO: Add description for return value\r | |
754 | \r | |
755 | --*/\r | |
756 | {\r | |
757 | EFI_STATUS Status;\r | |
758 | UINTN BlockSize;\r | |
759 | UINT64 LastBlock;\r | |
760 | INT64 DistanceToMove;\r | |
761 | UINT64 DistanceMoved;\r | |
762 | \r | |
763 | if (Private->NtHandle == INVALID_HANDLE_VALUE) {\r | |
764 | Status = WinNtBlockIoOpenDevice (Private);\r | |
765 | if (EFI_ERROR (Status)) {\r | |
766 | return Status;\r | |
767 | }\r | |
768 | }\r | |
769 | \r | |
770 | if (!Private->Media.MediaPresent) {\r | |
771 | DEBUG ((EFI_D_INIT, "%s: No Media\n", CallerName));\r | |
772 | return EFI_NO_MEDIA;\r | |
773 | }\r | |
774 | \r | |
775 | if (Private->Media.MediaId != MediaId) {\r | |
776 | return EFI_MEDIA_CHANGED;\r | |
777 | }\r | |
778 | \r | |
779 | if ((UINT32) Buffer % Private->Media.IoAlign != 0) {\r | |
780 | return EFI_INVALID_PARAMETER;\r | |
781 | }\r | |
782 | \r | |
783 | //\r | |
784 | // Verify buffer size\r | |
785 | //\r | |
786 | BlockSize = Private->BlockSize;\r | |
787 | if (BufferSize == 0) {\r | |
788 | DEBUG ((EFI_D_INIT, "%s: Zero length read\n", CallerName));\r | |
789 | return EFI_SUCCESS;\r | |
790 | }\r | |
791 | \r | |
792 | if ((BufferSize % BlockSize) != 0) {\r | |
793 | DEBUG ((EFI_D_INIT, "%s: Invalid read size\n", CallerName));\r | |
794 | return EFI_BAD_BUFFER_SIZE;\r | |
795 | }\r | |
796 | \r | |
797 | LastBlock = Lba + (BufferSize / BlockSize) - 1;\r | |
798 | if (LastBlock > Private->LastBlock) {\r | |
799 | DEBUG ((EFI_D_INIT, "ReadBlocks: Attempted to read off end of device\n"));\r | |
800 | return EFI_INVALID_PARAMETER;\r | |
801 | }\r | |
802 | //\r | |
803 | // Seek to End of File\r | |
804 | //\r | |
805 | DistanceToMove = MultU64x32 (Lba, BlockSize);\r | |
806 | Status = SetFilePointer64 (Private, DistanceToMove, &DistanceMoved, FILE_BEGIN);\r | |
807 | \r | |
808 | if (EFI_ERROR (Status)) {\r | |
809 | DEBUG ((EFI_D_INIT, "WriteBlocks: SetFilePointer failed\n"));\r | |
810 | return WinNtBlockIoError (Private);\r | |
811 | }\r | |
812 | \r | |
813 | return EFI_SUCCESS;\r | |
814 | }\r | |
815 | \r | |
816 | STATIC\r | |
817 | EFI_STATUS\r | |
818 | EFIAPI\r | |
819 | WinNtBlockIoReadBlocks (\r | |
820 | IN EFI_BLOCK_IO_PROTOCOL *This,\r | |
821 | IN UINT32 MediaId,\r | |
822 | IN EFI_LBA Lba,\r | |
823 | IN UINTN BufferSize,\r | |
824 | OUT VOID *Buffer\r | |
825 | )\r | |
826 | /*++\r | |
827 | \r | |
828 | Routine Description:\r | |
829 | Read BufferSize bytes from Lba into Buffer.\r | |
830 | \r | |
831 | Arguments:\r | |
832 | This - Protocol instance pointer.\r | |
833 | MediaId - Id of the media, changes every time the media is replaced.\r | |
834 | Lba - The starting Logical Block Address to read from\r | |
835 | BufferSize - Size of Buffer, must be a multiple of device block size.\r | |
836 | Buffer - Buffer containing read data\r | |
837 | \r | |
838 | Returns:\r | |
839 | EFI_SUCCESS - The data was read correctly from the device.\r | |
840 | EFI_DEVICE_ERROR - The device reported an error while performing the read.\r | |
841 | EFI_NO_MEDIA - There is no media in the device.\r | |
842 | EFI_MEDIA_CHANGED - The MediaId does not matched the current device.\r | |
843 | EFI_BAD_BUFFER_SIZE - The Buffer was not a multiple of the block size of the\r | |
844 | device.\r | |
845 | EFI_INVALID_PARAMETER - The read request contains device addresses that are not\r | |
846 | valid for the device.\r | |
847 | \r | |
848 | --*/\r | |
849 | {\r | |
850 | WIN_NT_BLOCK_IO_PRIVATE *Private;\r | |
851 | BOOL Flag;\r | |
852 | EFI_STATUS Status;\r | |
853 | DWORD BytesRead;\r | |
854 | \r | |
855 | Private = WIN_NT_BLOCK_IO_PRIVATE_DATA_FROM_THIS (This);\r | |
856 | \r | |
857 | Status = WinNtBlockIoReadWriteCommon (Private, MediaId, Lba, BufferSize, Buffer, "WinNtReadBlocks");\r | |
858 | if (EFI_ERROR (Status)) {\r | |
859 | return Status;\r | |
860 | }\r | |
861 | \r | |
862 | Flag = Private->WinNtThunk->ReadFile (Private->NtHandle, Buffer, (DWORD) BufferSize, (LPDWORD) &BytesRead, NULL);\r | |
863 | if (!Flag || (BytesRead != BufferSize)) {\r | |
864 | DEBUG ((EFI_D_INIT, "ReadBlocks: ReadFile failed. (%d)\n", Private->WinNtThunk->GetLastError ()));\r | |
865 | return WinNtBlockIoError (Private);\r | |
866 | }\r | |
867 | \r | |
868 | //\r | |
869 | // If we wrote then media is present.\r | |
870 | //\r | |
871 | This->Media->MediaPresent = TRUE;\r | |
872 | return EFI_SUCCESS;\r | |
873 | }\r | |
874 | \r | |
875 | STATIC\r | |
876 | EFI_STATUS\r | |
877 | EFIAPI\r | |
878 | WinNtBlockIoWriteBlocks (\r | |
879 | IN EFI_BLOCK_IO_PROTOCOL *This,\r | |
880 | IN UINT32 MediaId,\r | |
881 | IN EFI_LBA Lba,\r | |
882 | IN UINTN BufferSize,\r | |
883 | IN VOID *Buffer\r | |
884 | )\r | |
885 | /*++\r | |
886 | \r | |
887 | Routine Description:\r | |
888 | Write BufferSize bytes from Lba into Buffer.\r | |
889 | \r | |
890 | Arguments:\r | |
891 | This - Protocol instance pointer.\r | |
892 | MediaId - Id of the media, changes every time the media is replaced.\r | |
893 | Lba - The starting Logical Block Address to read from\r | |
894 | BufferSize - Size of Buffer, must be a multiple of device block size.\r | |
895 | Buffer - Buffer containing read data\r | |
896 | \r | |
897 | Returns:\r | |
898 | EFI_SUCCESS - The data was written correctly to the device.\r | |
899 | EFI_WRITE_PROTECTED - The device can not be written to.\r | |
900 | EFI_DEVICE_ERROR - The device reported an error while performing the write.\r | |
901 | EFI_NO_MEDIA - There is no media in the device.\r | |
902 | EFI_MEDIA_CHNAGED - The MediaId does not matched the current device.\r | |
903 | EFI_BAD_BUFFER_SIZE - The Buffer was not a multiple of the block size of the\r | |
904 | device.\r | |
905 | EFI_INVALID_PARAMETER - The write request contains a LBA that is not\r | |
906 | valid for the device.\r | |
907 | \r | |
908 | --*/\r | |
909 | {\r | |
910 | WIN_NT_BLOCK_IO_PRIVATE *Private;\r | |
911 | UINTN BytesWritten;\r | |
912 | BOOL Flag;\r | |
913 | EFI_STATUS Status;\r | |
914 | \r | |
915 | Private = WIN_NT_BLOCK_IO_PRIVATE_DATA_FROM_THIS (This);\r | |
916 | \r | |
917 | Status = WinNtBlockIoReadWriteCommon (Private, MediaId, Lba, BufferSize, Buffer, "WinNtWriteBlocks");\r | |
918 | if (EFI_ERROR (Status)) {\r | |
919 | return Status;\r | |
920 | }\r | |
921 | \r | |
922 | Flag = Private->WinNtThunk->WriteFile (Private->NtHandle, Buffer, (DWORD) BufferSize, (LPDWORD) &BytesWritten, NULL);\r | |
923 | if (!Flag || (BytesWritten != BufferSize)) {\r | |
924 | DEBUG ((EFI_D_INIT, "ReadBlocks: WriteFile failed. (%d)\n", Private->WinNtThunk->GetLastError ()));\r | |
925 | return WinNtBlockIoError (Private);\r | |
926 | }\r | |
927 | \r | |
928 | //\r | |
929 | // If the write succeeded, we are not write protected and media is present.\r | |
930 | //\r | |
931 | This->Media->MediaPresent = TRUE;\r | |
932 | This->Media->ReadOnly = FALSE;\r | |
933 | return EFI_SUCCESS;\r | |
934 | }\r | |
935 | \r | |
936 | STATIC\r | |
937 | EFI_STATUS\r | |
938 | EFIAPI\r | |
939 | WinNtBlockIoFlushBlocks (\r | |
940 | IN EFI_BLOCK_IO_PROTOCOL *This\r | |
941 | )\r | |
942 | /*++\r | |
943 | \r | |
944 | Routine Description:\r | |
945 | Flush the Block Device.\r | |
946 | \r | |
947 | Arguments:\r | |
948 | This - Protocol instance pointer.\r | |
949 | \r | |
950 | Returns:\r | |
951 | EFI_SUCCESS - All outstanding data was written to the device\r | |
952 | EFI_DEVICE_ERROR - The device reported an error while writting back the data\r | |
953 | EFI_NO_MEDIA - There is no media in the device.\r | |
954 | \r | |
955 | --*/\r | |
956 | {\r | |
957 | return EFI_SUCCESS;\r | |
958 | }\r | |
959 | \r | |
960 | STATIC\r | |
961 | EFI_STATUS\r | |
962 | EFIAPI\r | |
963 | WinNtBlockIoResetBlock (\r | |
964 | IN EFI_BLOCK_IO_PROTOCOL *This,\r | |
965 | IN BOOLEAN ExtendedVerification\r | |
966 | )\r | |
967 | /*++\r | |
968 | \r | |
969 | Routine Description:\r | |
970 | Reset the Block Device.\r | |
971 | \r | |
972 | Arguments:\r | |
973 | This - Protocol instance pointer.\r | |
974 | ExtendedVerification - Driver may perform diagnostics on reset.\r | |
975 | \r | |
976 | Returns:\r | |
977 | EFI_SUCCESS - The device was reset.\r | |
978 | EFI_DEVICE_ERROR - The device is not functioning properly and could\r | |
979 | not be reset.\r | |
980 | \r | |
981 | --*/\r | |
982 | {\r | |
983 | WIN_NT_BLOCK_IO_PRIVATE *Private;\r | |
984 | \r | |
985 | Private = WIN_NT_BLOCK_IO_PRIVATE_DATA_FROM_THIS (This);\r | |
986 | \r | |
987 | if (Private->NtHandle != INVALID_HANDLE_VALUE) {\r | |
988 | Private->WinNtThunk->CloseHandle (Private->NtHandle);\r | |
989 | Private->NtHandle = INVALID_HANDLE_VALUE;\r | |
990 | }\r | |
991 | \r | |
992 | return EFI_SUCCESS;\r | |
993 | }\r | |
994 | \r | |
995 | UINTN\r | |
996 | Atoi (\r | |
997 | CHAR16 *String\r | |
998 | )\r | |
999 | /*++\r | |
1000 | \r | |
1001 | Routine Description:\r | |
1002 | \r | |
1003 | Convert a unicode string to a UINTN\r | |
1004 | \r | |
1005 | Arguments:\r | |
1006 | \r | |
1007 | String - Unicode string.\r | |
1008 | \r | |
1009 | Returns:\r | |
1010 | \r | |
1011 | UINTN of the number represented by String.\r | |
1012 | \r | |
1013 | --*/\r | |
1014 | {\r | |
1015 | UINTN Number;\r | |
1016 | CHAR16 *Str;\r | |
1017 | \r | |
1018 | //\r | |
1019 | // skip preceeding white space\r | |
1020 | //\r | |
1021 | Str = String;\r | |
1022 | while ((*Str) && (*Str == ' ')) {\r | |
1023 | Str++;\r | |
1024 | }\r | |
1025 | //\r | |
1026 | // Convert ot a Number\r | |
1027 | //\r | |
1028 | Number = 0;\r | |
1029 | while (*Str != '\0') {\r | |
1030 | if ((*Str >= '0') && (*Str <= '9')) {\r | |
1031 | Number = (Number * 10) +*Str - '0';\r | |
1032 | } else {\r | |
1033 | break;\r | |
1034 | }\r | |
1035 | \r | |
1036 | Str++;\r | |
1037 | }\r | |
1038 | \r | |
1039 | return Number;\r | |
1040 | }\r | |
1041 | \r | |
1042 | EFI_STATUS\r | |
1043 | SetFilePointer64 (\r | |
1044 | IN WIN_NT_BLOCK_IO_PRIVATE *Private,\r | |
1045 | IN INT64 DistanceToMove,\r | |
1046 | OUT UINT64 *NewFilePointer,\r | |
1047 | IN DWORD MoveMethod\r | |
1048 | )\r | |
1049 | /*++\r | |
1050 | \r | |
1051 | This function extends the capability of SetFilePointer to accept 64 bit parameters\r | |
1052 | \r | |
1053 | --*/\r | |
1054 | // TODO: function comment is missing 'Routine Description:'\r | |
1055 | // TODO: function comment is missing 'Arguments:'\r | |
1056 | // TODO: function comment is missing 'Returns:'\r | |
1057 | // TODO: Private - add argument and description to function comment\r | |
1058 | // TODO: DistanceToMove - add argument and description to function comment\r | |
1059 | // TODO: NewFilePointer - add argument and description to function comment\r | |
1060 | // TODO: MoveMethod - add argument and description to function comment\r | |
1061 | {\r | |
1062 | EFI_STATUS Status;\r | |
1063 | LARGE_INTEGER LargeInt;\r | |
1064 | UINT32 ErrorCode;\r | |
1065 | \r | |
1066 | LargeInt.QuadPart = DistanceToMove;\r | |
1067 | Status = EFI_SUCCESS;\r | |
1068 | \r | |
1069 | LargeInt.LowPart = Private->WinNtThunk->SetFilePointer (\r | |
1070 | Private->NtHandle,\r | |
1071 | LargeInt.LowPart,\r | |
1072 | &LargeInt.HighPart,\r | |
1073 | MoveMethod\r | |
1074 | );\r | |
1075 | \r | |
1076 | if (LargeInt.LowPart == -1 &&\r | |
1077 | (ErrorCode = Private->WinNtThunk->GetLastError ()) != NO_ERROR) {\r | |
1078 | Status = EFI_INVALID_PARAMETER;\r | |
1079 | }\r | |
1080 | \r | |
1081 | if (NewFilePointer != NULL) {\r | |
1082 | *NewFilePointer = LargeInt.QuadPart;\r | |
1083 | }\r | |
1084 | \r | |
1085 | return Status;\r | |
1086 | }\r |