]> git.proxmox.com Git - mirror_edk2.git/blame - ShellPkg/Library/UefiShellDebug1CommandsLib/SerMode.c
ShellPkg: Standardized HP Copyright Message String
[mirror_edk2.git] / ShellPkg / Library / UefiShellDebug1CommandsLib / SerMode.c
CommitLineData
5d73d92f 1/** @file\r
2 Main file for SerMode shell Debug1 function.\r
3\r
c011b6c9 4 (C) Copyright 2015 Hewlett-Packard Development Company, L.P.<BR>\r
3737ac2b 5 Copyright (c) 2005 - 2011, Intel Corporation. All rights reserved.<BR>\r
5d73d92f 6 This program and the accompanying materials\r
7 are licensed and made available under the terms and conditions of the BSD License\r
8 which accompanies this distribution. The full text of the license may be found at\r
9 http://opensource.org/licenses/bsd-license.php\r
10\r
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
13\r
14**/\r
15\r
16#include "UefiShellDebug1CommandsLib.h"\r
17#include <Library/ShellLib.h>\r
18#include <Protocol/SerialIo.h>\r
19\r
3737ac2b 20/**\r
21 Display information about a serial device by it's handle.\r
22\r
23 If HandleValid is FALSE, do all devices.\r
24\r
25 @param[in] HandleIdx The handle index for the device.\r
26 @param[in] HandleValid TRUE if HandleIdx is valid.\r
27\r
28 @retval SHELL_INVALID_PARAMETER A parameter was invalid.\r
29 @retval SHELL_SUCCESS The operation was successful.\r
30**/\r
5d73d92f 31SHELL_STATUS\r
32EFIAPI\r
3737ac2b 33DisplaySettings (\r
5d73d92f 34 IN UINTN HandleIdx,\r
35 IN BOOLEAN HandleValid\r
36 )\r
37{\r
38 EFI_SERIAL_IO_PROTOCOL *SerialIo;\r
39 UINTN NoHandles;\r
40 EFI_HANDLE *Handles;\r
41 EFI_STATUS Status;\r
42 UINTN Index;\r
43 CHAR16 *StopBits;\r
44 CHAR16 Parity;\r
45 SHELL_STATUS ShellStatus;\r
46\r
47 Handles = NULL;\r
48 StopBits = NULL;\r
49\r
50 ShellStatus = SHELL_SUCCESS;\r
51\r
52 Status = gBS->LocateHandleBuffer (ByProtocol, &gEfiSerialIoProtocolGuid, NULL, &NoHandles, &Handles);\r
53 if (EFI_ERROR (Status)) {\r
4092a8f6 54 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SERMODE_NO_FOUND), gShellDebug1HiiHandle, L"sermode"); \r
5d73d92f 55 return SHELL_INVALID_PARAMETER;\r
56 }\r
57\r
58 for (Index = 0; Index < NoHandles; Index++) {\r
59 if (HandleValid) {\r
60 if (ConvertHandleIndexToHandle(HandleIdx) != Handles[Index]) {\r
61 continue;\r
62 }\r
63 }\r
64\r
65 Status = gBS->HandleProtocol (Handles[Index], &gEfiSerialIoProtocolGuid, (VOID**)&SerialIo);\r
66 if (!EFI_ERROR (Status)) {\r
67 switch (SerialIo->Mode->Parity) {\r
68 case DefaultParity:\r
69\r
70 Parity = 'D';\r
71 break;\r
72\r
73 case NoParity:\r
74\r
75 Parity = 'N';\r
76 break;\r
77\r
78 case EvenParity:\r
79\r
80 Parity = 'E';\r
81 break;\r
82\r
83 case OddParity:\r
84\r
85 Parity = 'O';\r
86 break;\r
87\r
88 case MarkParity:\r
89\r
90 Parity = 'M';\r
91 break;\r
92\r
93 case SpaceParity:\r
94\r
95 Parity = 'S';\r
96 break;\r
97\r
98 default:\r
99\r
100 Parity = 'U';\r
101 }\r
102\r
103 switch (SerialIo->Mode->StopBits) {\r
104 case DefaultStopBits:\r
105\r
106 StopBits = L"Default";\r
107 break;\r
108\r
109 case OneStopBit:\r
110\r
111 StopBits = L"1";\r
112 break;\r
113\r
114 case TwoStopBits:\r
115\r
116 StopBits = L"2";\r
117 break;\r
118\r
119 case OneFiveStopBits:\r
120\r
121 StopBits = L"1.5";\r
122 break;\r
123\r
124 default:\r
125\r
126 StopBits = L"Unknown";\r
127 }\r
128 ShellPrintHiiEx(\r
129 -1,\r
130 -1,\r
131 NULL,\r
132 STRING_TOKEN (STR_SERMODE_DISPLAY),\r
133 gShellDebug1HiiHandle,\r
134 ConvertHandleToHandleIndex (Handles[Index]),\r
135 Handles[Index],\r
136 SerialIo->Mode->BaudRate,\r
137 Parity,\r
138 SerialIo->Mode->DataBits,\r
139 StopBits\r
140 );\r
141 } else {\r
4092a8f6 142 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SERMODE_NO_FOUND), gShellDebug1HiiHandle, L"sermode"); \r
5d73d92f 143 ShellStatus = SHELL_NOT_FOUND;\r
144 break;\r
145 }\r
146\r
147 if (HandleValid) {\r
148 break;\r
149 }\r
150 }\r
151\r
152 if (Index == NoHandles) {\r
153 if ((NoHandles != 0 && HandleValid) || 0 == NoHandles) {\r
4092a8f6 154 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SERMODE_NOT_FOUND), gShellDebug1HiiHandle, L"sermode"); \r
5d73d92f 155 ShellStatus = SHELL_NOT_FOUND;\r
156 }\r
157 }\r
158\r
159 return ShellStatus;\r
160}\r
161\r
3737ac2b 162/**\r
163 Function for 'sermode' command.\r
164\r
165 @param[in] ImageHandle Handle to the Image (NULL if Internal).\r
166 @param[in] SystemTable Pointer to the System Table (NULL if Internal).\r
167**/\r
5d73d92f 168SHELL_STATUS\r
169EFIAPI\r
170ShellCommandRunSerMode (\r
171 IN EFI_HANDLE ImageHandle,\r
172 IN EFI_SYSTEM_TABLE *SystemTable\r
173 )\r
174{\r
175 EFI_STATUS Status;\r
176 SHELL_STATUS ShellStatus;\r
177 UINTN Index;\r
178 UINTN NoHandles;\r
179 EFI_HANDLE *Handles;\r
180 EFI_PARITY_TYPE Parity;\r
181 EFI_STOP_BITS_TYPE StopBits;\r
182 UINTN HandleIdx;\r
183 UINTN BaudRate;\r
184 UINTN DataBits;\r
185 UINTN Value;\r
186 EFI_SERIAL_IO_PROTOCOL *SerialIo;\r
187 LIST_ENTRY *Package;\r
188 CHAR16 *ProblemParam;\r
189 CONST CHAR16 *Temp;\r
3737ac2b 190 UINT64 Intermediate;\r
5d73d92f 191\r
192 ShellStatus = SHELL_SUCCESS;\r
193 HandleIdx = 0;\r
194 Parity = DefaultParity;\r
195 Handles = NULL;\r
196 NoHandles = 0;\r
197 Index = 0;\r
198 Package = NULL;\r
199\r
200 Status = ShellCommandLineParse (EmptyParamList, &Package, &ProblemParam, TRUE);\r
201 if (EFI_ERROR(Status)) {\r
202 if (Status == EFI_VOLUME_CORRUPTED && ProblemParam != NULL) {\r
4092a8f6 203 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PROBLEM), gShellDebug1HiiHandle, L"sermode", ProblemParam); \r
5d73d92f 204 FreePool(ProblemParam);\r
205 ShellStatus = SHELL_INVALID_PARAMETER;\r
206 } else {\r
207 ASSERT(FALSE);\r
208 }\r
209 } else {\r
3737ac2b 210 if (ShellCommandLineGetCount(Package) < 6 && ShellCommandLineGetCount(Package) > 2) {\r
4092a8f6 211 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_FEW), gShellDebug1HiiHandle, L"sermode"); \r
5d73d92f 212 ShellStatus = SHELL_INVALID_PARAMETER;\r
3737ac2b 213 } else if (ShellCommandLineGetCount(Package) > 6) {\r
4092a8f6 214 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_TOO_MANY), gShellDebug1HiiHandle, L"sermode"); \r
5d73d92f 215 ShellStatus = SHELL_INVALID_PARAMETER;\r
216 } else {\r
217 Temp = ShellCommandLineGetRawValue(Package, 1);\r
218 if (Temp != NULL) {\r
3737ac2b 219 Status = ShellConvertStringToUint64(Temp, &Intermediate, TRUE, FALSE);\r
220 HandleIdx = (UINTN)Intermediate;\r
5d73d92f 221 Temp = ShellCommandLineGetRawValue(Package, 2);\r
222 if (Temp == NULL) {\r
3737ac2b 223 ShellStatus = DisplaySettings (HandleIdx, TRUE);\r
5d73d92f 224 goto Done;\r
225 }\r
226 } else {\r
3737ac2b 227 ShellStatus = DisplaySettings (0, FALSE);\r
5d73d92f 228 goto Done;\r
229 }\r
230 Temp = ShellCommandLineGetRawValue(Package, 2);\r
231 if (Temp != NULL) {\r
3737ac2b 232 BaudRate = ShellStrToUintn(Temp);\r
5d73d92f 233 } else {\r
234 ASSERT(FALSE);\r
235 BaudRate = 0;\r
236 }\r
237 Temp = ShellCommandLineGetRawValue(Package, 3);\r
238 if (Temp == NULL || StrLen(Temp)>1) {\r
4092a8f6 239 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellDebug1HiiHandle, L"sermode", Temp); \r
5d73d92f 240 ShellStatus = SHELL_INVALID_PARAMETER;\r
241 } else {\r
242 switch(Temp[0]){\r
243 case 'd':\r
244 case 'D':\r
245 Parity = DefaultParity;\r
246 break;\r
247 case 'n':\r
248 case 'N':\r
249 Parity = NoParity;\r
250 break;\r
251 case 'e':\r
252 case 'E':\r
253 Parity = EvenParity;\r
254 break;\r
255 case 'o':\r
256 case 'O':\r
257 Parity = OddParity;\r
258 break;\r
259 case 'm':\r
260 case 'M':\r
261 Parity = MarkParity;\r
262 break;\r
263 case 's':\r
264 case 'S':\r
265 Parity = SpaceParity;\r
266 break;\r
267 default:\r
4092a8f6 268 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellDebug1HiiHandle, L"sermode", Temp); \r
5d73d92f 269 ShellStatus = SHELL_INVALID_PARAMETER;\r
270 goto Done;\r
271 }\r
272 }\r
273 Temp = ShellCommandLineGetRawValue(Package, 4);\r
274 if (Temp != NULL) {\r
3737ac2b 275 DataBits = ShellStrToUintn(Temp);\r
5d73d92f 276 } else {\r
277 //\r
278 // make sure this is some number not in the list below.\r
279 //\r
280 DataBits = 0;\r
281 }\r
282 switch (DataBits) {\r
283 case 4:\r
284 case 7:\r
285 case 8:\r
286 break;\r
287 default:\r
4092a8f6 288 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellDebug1HiiHandle, L"sermode", Temp); \r
5d73d92f 289 ShellStatus = SHELL_INVALID_PARAMETER;\r
290 goto Done;\r
291 }\r
292 Temp = ShellCommandLineGetRawValue(Package, 5);\r
3737ac2b 293 Value = ShellStrToUintn(Temp);\r
5d73d92f 294 switch (Value) {\r
295 case 0:\r
296 StopBits = DefaultStopBits;\r
297 break;\r
298\r
299 case 1:\r
300 StopBits = OneStopBit;\r
301 break;\r
302\r
303 case 2:\r
304 StopBits = TwoStopBits;\r
305 break;\r
306\r
307 case 15:\r
308 StopBits = OneFiveStopBits;\r
309 break;\r
310\r
311 default:\r
4092a8f6 312 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_GEN_PARAM_INV), gShellDebug1HiiHandle, L"sermode", Temp); \r
5d73d92f 313 ShellStatus = SHELL_INVALID_PARAMETER;\r
314 goto Done;\r
315 }\r
316 Status = gBS->LocateHandleBuffer(ByProtocol, &gEfiSerialIoProtocolGuid, NULL, &NoHandles, &Handles);\r
317 if (EFI_ERROR (Status)) {\r
4092a8f6 318 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SERMODE_NO_FOUND), gShellDebug1HiiHandle, L"sermode"); \r
5d73d92f 319 ShellStatus = SHELL_INVALID_PARAMETER;\r
320 goto Done;\r
321 }\r
322\r
323 for (Index = 0; Index < NoHandles; Index++) {\r
324 if (ConvertHandleIndexToHandle (HandleIdx) != Handles[Index]) {\r
325 continue;\r
326 }\r
327\r
328 Status = gBS->HandleProtocol (Handles[Index], &gEfiSerialIoProtocolGuid, (VOID**)&SerialIo);\r
329 if (!EFI_ERROR (Status)) {\r
330 Status = SerialIo->SetAttributes (\r
331 SerialIo,\r
332 (UINT64) BaudRate,\r
333 SerialIo->Mode->ReceiveFifoDepth,\r
334 SerialIo->Mode->Timeout,\r
335 Parity,\r
336 (UINT8) DataBits,\r
337 StopBits\r
338 );\r
339 if (EFI_ERROR (Status)) {\r
4092a8f6 340 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SERMODE_SET_FAIL), gShellDebug1HiiHandle, L"sermode", ConvertHandleToHandleIndex(Handles[Index])); \r
5d73d92f 341 ShellStatus = SHELL_ACCESS_DENIED;\r
342 } else {\r
343 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SERMODE_SET_HANDLE), gShellDebug1HiiHandle, ConvertHandleToHandleIndex(Handles[Index]));\r
344 }\r
345 break;\r
346 }\r
347 }\r
348 }\r
349 }\r
350\r
3737ac2b 351 if (ShellStatus == SHELL_SUCCESS && Index == NoHandles) {\r
4092a8f6 352 ShellPrintHiiEx(-1, -1, NULL, STRING_TOKEN (STR_SERMODE_BAD_HANDLE), gShellDebug1HiiHandle, L"sermode", HandleIdx); \r
5d73d92f 353 ShellStatus = SHELL_INVALID_PARAMETER;\r
354 }\r
355\r
356Done:\r
357 if (Package != NULL) {\r
358 ShellCommandLineFreeVarList (Package);\r
359 }\r
360 if (Handles != NULL) {\r
361 FreePool (Handles);\r
362 }\r
363 return ShellStatus;\r
364}\r