]> git.proxmox.com Git - mirror_edk2.git/blame - IntelFrameworkPkg/Library/DxeBootScriptLibNull/BootScriptLib.c
Update License Headers.
[mirror_edk2.git] / IntelFrameworkPkg / Library / DxeBootScriptLibNull / BootScriptLib.c
CommitLineData
c3902377 1/*++\r
2\r
3e0578d2 3 Copyright (c) 2006 - 2007, Intel Corporation<BR>\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
c3902377 11\r
12Module Name:\r
13 \r
14 BootScriptLib.c\r
15\r
16Abstract:\r
17\r
18 Support for EFI script. \r
19\r
20--*/\r
21\r
22//\r
23// The package level header files this module uses\r
24//\r
25#include <PiDxe.h>\r
26//\r
27// The protocols, PPI and GUID defintions for this module\r
28//\r
29//\r
30// The Library classes this module consumes\r
31//\r
32#include <Library/BootScriptLib.h>\r
33\r
34EFI_STATUS\r
35EFIAPI\r
36BootScriptSaveIoWrite (\r
37 IN UINT16 TableName,\r
38 IN EFI_BOOT_SCRIPT_WIDTH Width,\r
39 IN UINT64 Address,\r
40 IN UINTN Count,\r
41 IN VOID *Buffer\r
42 )\r
43/*++\r
44\r
45Routine Description:\r
46\r
47 Save I/O write to boot script \r
48\r
49Arguments:\r
50\r
51 TableName - Desired boot script table\r
52\r
53 (Standard EFI IO write script parameter) \r
54\r
55Returns: \r
56 \r
57 EFI_NOT_FOUND - BootScriptSave Protocol not exist.\r
58 \r
59 EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS\r
60\r
61--*/\r
62// GC_TODO: Width - add argument and description to function comment\r
63// GC_TODO: Address - add argument and description to function comment\r
64// GC_TODO: Count - add argument and description to function comment\r
65// GC_TODO: Buffer - add argument and description to function comment\r
66{\r
67 return EFI_SUCCESS;\r
68}\r
69\r
70EFI_STATUS\r
71EFIAPI\r
72BootScriptSaveIoReadWrite (\r
73 IN UINT16 TableName,\r
74 IN EFI_BOOT_SCRIPT_WIDTH Width,\r
75 IN UINT64 Address,\r
76 IN VOID *Data,\r
77 IN VOID *DataMask\r
78 )\r
79/*++\r
80\r
81Routine Description:\r
82\r
83 Save I/O write to boot script \r
84\r
85Arguments:\r
86\r
87 TableName - Desired boot script table\r
88\r
89 (Standard EFI IO read write script parameter) \r
90\r
91Returns: \r
92 \r
93 EFI_NOT_FOUND - BootScriptSave Protocol not exist.\r
94 \r
95 EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS\r
96\r
97--*/\r
98// GC_TODO: Width - add argument and description to function comment\r
99// GC_TODO: Address - add argument and description to function comment\r
100// GC_TODO: Data - add argument and description to function comment\r
101// GC_TODO: DataMask - add argument and description to function comment\r
102{\r
103 return EFI_SUCCESS;\r
104}\r
105\r
106EFI_STATUS\r
107EFIAPI\r
108BootScriptSaveMemWrite (\r
109 IN UINT16 TableName,\r
110 IN EFI_BOOT_SCRIPT_WIDTH Width,\r
111 IN UINT64 Address,\r
112 IN UINTN Count,\r
113 IN VOID *Buffer\r
114 )\r
115/*++\r
116\r
117Routine Description:\r
118\r
119 Save I/O write to boot script \r
120\r
121Arguments:\r
122\r
123 TableName - Desired boot script table\r
124\r
125 (Standard EFI MEM write script parameter) \r
126\r
127Returns: \r
128 \r
129 EFI_NOT_FOUND - BootScriptSave Protocol not exist.\r
130 \r
131 EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS\r
132\r
133--*/\r
134// GC_TODO: Width - add argument and description to function comment\r
135// GC_TODO: Address - add argument and description to function comment\r
136// GC_TODO: Count - add argument and description to function comment\r
137// GC_TODO: Buffer - add argument and description to function comment\r
138{\r
139 return EFI_SUCCESS;\r
140}\r
141\r
142EFI_STATUS\r
143EFIAPI\r
144BootScriptSaveMemReadWrite (\r
145 IN UINT16 TableName,\r
146 IN EFI_BOOT_SCRIPT_WIDTH Width,\r
147 IN UINT64 Address,\r
148 IN VOID *Data,\r
149 IN VOID *DataMask\r
150 )\r
151/*++\r
152\r
153Routine Description:\r
154\r
155 Save I/O write to boot script \r
156\r
157Arguments:\r
158\r
159 TableName - Desired boot script table\r
160\r
161 (Standard EFI MEM read write script parameter) \r
162\r
163Returns: \r
164 \r
165 EFI_NOT_FOUND - BootScriptSave Protocol not exist.\r
166 \r
167 EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS\r
168\r
169--*/\r
170// GC_TODO: Width - add argument and description to function comment\r
171// GC_TODO: Address - add argument and description to function comment\r
172// GC_TODO: Data - add argument and description to function comment\r
173// GC_TODO: DataMask - add argument and description to function comment\r
174{\r
175 return EFI_SUCCESS;\r
176}\r
177\r
178EFI_STATUS\r
179EFIAPI\r
180BootScriptSavePciCfgWrite (\r
181 IN UINT16 TableName,\r
182 IN EFI_BOOT_SCRIPT_WIDTH Width,\r
183 IN UINT64 Address,\r
184 IN UINTN Count,\r
185 IN VOID *Buffer\r
186 )\r
187/*++\r
188\r
189Routine Description:\r
190\r
191 Save I/O write to boot script \r
192\r
193Arguments:\r
194\r
195 TableName - Desired boot script table\r
196\r
197 (Standard EFI PCI write script parameter) \r
198\r
199Returns: \r
200 \r
201 EFI_NOT_FOUND - BootScriptSave Protocol not exist.\r
202 \r
203 EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS\r
204\r
205--*/\r
206// GC_TODO: Width - add argument and description to function comment\r
207// GC_TODO: Address - add argument and description to function comment\r
208// GC_TODO: Count - add argument and description to function comment\r
209// GC_TODO: Buffer - add argument and description to function comment\r
210{\r
211 return EFI_SUCCESS;\r
212}\r
213\r
214EFI_STATUS\r
215EFIAPI\r
216BootScriptSavePciCfgReadWrite (\r
217 IN UINT16 TableName,\r
218 IN EFI_BOOT_SCRIPT_WIDTH Width,\r
219 IN UINT64 Address,\r
220 IN VOID *Data,\r
221 IN VOID *DataMask\r
222 )\r
223/*++\r
224\r
225Routine Description:\r
226\r
227 Save I/O write to boot script \r
228\r
229Arguments:\r
230\r
231 TableName - Desired boot script table\r
232\r
233 (Standard EFI PCI read write script parameter) \r
234\r
235Returns: \r
236 \r
237 EFI_NOT_FOUND - BootScriptSave Protocol not exist.\r
238 \r
239 EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS\r
240\r
241--*/\r
242// GC_TODO: Width - add argument and description to function comment\r
243// GC_TODO: Address - add argument and description to function comment\r
244// GC_TODO: Data - add argument and description to function comment\r
245// GC_TODO: DataMask - add argument and description to function comment\r
246{\r
247 return EFI_SUCCESS;\r
248}\r
249\r
250EFI_STATUS\r
251EFIAPI\r
252BootScriptSaveSmbusExecute (\r
253 IN UINT16 TableName,\r
254 IN EFI_SMBUS_DEVICE_ADDRESS SlaveAddress,\r
255 IN EFI_SMBUS_DEVICE_COMMAND Command,\r
256 IN EFI_SMBUS_OPERATION Operation,\r
257 IN BOOLEAN PecCheck,\r
258 IN UINTN *Length,\r
259 IN VOID *Buffer\r
260 )\r
261/*++\r
262\r
263Routine Description:\r
264\r
265 Save I/O write to boot script \r
266\r
267Arguments:\r
268\r
269 TableName - Desired boot script table\r
270\r
271 (Standard EFI Smbus execute script parameter) \r
272\r
273Returns: \r
274 \r
275 EFI_NOT_FOUND - BootScriptSave Protocol not exist.\r
276 \r
277 EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS\r
278\r
279--*/\r
280// GC_TODO: SlaveAddress - add argument and description to function comment\r
281// GC_TODO: Command - add argument and description to function comment\r
282// GC_TODO: Operation - add argument and description to function comment\r
283// GC_TODO: PecCheck - add argument and description to function comment\r
284// GC_TODO: Length - add argument and description to function comment\r
285// GC_TODO: Buffer - add argument and description to function comment\r
286{\r
287 return EFI_SUCCESS;\r
288}\r
289\r
290EFI_STATUS\r
291EFIAPI\r
292BootScriptSaveStall (\r
293 IN UINT16 TableName,\r
294 IN UINTN Duration\r
295 )\r
296/*++\r
297\r
298Routine Description:\r
299\r
300 Save I/O write to boot script \r
301\r
302Arguments:\r
303\r
304 TableName - Desired boot script table\r
305\r
306 (Standard EFI stall script parameter) \r
307\r
308Returns: \r
309 \r
310 EFI_NOT_FOUND - BootScriptSave Protocol not exist.\r
311 \r
312 EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS\r
313\r
314--*/\r
315// GC_TODO: Duration - add argument and description to function comment\r
316{\r
317 return EFI_SUCCESS;\r
318}\r
319\r
320EFI_STATUS\r
321EFIAPI\r
322BootScriptSaveDispatch2 (\r
323 IN UINT16 TableName,\r
324 IN EFI_PHYSICAL_ADDRESS EntryPoint,\r
325 IN EFI_PHYSICAL_ADDRESS Context\r
326 )\r
327/*++\r
328\r
329Routine Description:\r
330\r
331 GC_TODO: Add function description\r
332\r
333Arguments:\r
334\r
335 TableName - GC_TODO: add argument description\r
336 EntryPoint - GC_TODO: add argument description\r
337\r
338Returns:\r
339\r
340 EFI_NOT_FOUND - GC_TODO: Add description for return value\r
341 EFI_SUCCESS - GC_TODO: Add description for return value\r
342\r
343--*/\r
344{\r
345 return EFI_SUCCESS;\r
346}\r
347\r
348EFI_STATUS\r
349EFIAPI\r
350BootScriptSaveInformation (\r
351 IN UINT16 TableName,\r
352 IN UINT32 Length, \r
353 IN EFI_PHYSICAL_ADDRESS Buffer\r
354 )\r
355/*++\r
356\r
357Routine Description:\r
358\r
359 GC_TODO: Add function description\r
360\r
361Arguments:\r
362\r
363 TableName - GC_TODO: add argument description\r
364 EntryPoint - GC_TODO: add argument description\r
365\r
366Returns:\r
367\r
368 EFI_NOT_FOUND - GC_TODO: Add description for return value\r
369 EFI_SUCCESS - GC_TODO: Add description for return value\r
370\r
371--*/\r
372{\r
373 return EFI_SUCCESS;\r
374}\r
375\r
376EFI_STATUS\r
377EFIAPI\r
378BootScriptSaveInformationUnicodeString (\r
379 IN UINT16 TableName,\r
380 IN CONST CHAR16 *String\r
381 )\r
382 /*++\r
383\r
384Routine Description:\r
385\r
386 Save unicode string information specified by Buffer to \r
387 boot script with opcode EFI_BOOT_SCRIPT_INFORMATION_OPCODE\r
388\r
389Arguments:\r
390\r
391 TableName - Desired boot script table\r
392\r
393 FfsName - The file name of the code to be dispatched.\r
394\r
395 Context - The data that will be passed into code.\r
396\r
397 ParentHandle - The caller's image handle.\r
398\r
399Returns:\r
400\r
401 EFI_NOT_FOUND - BootScriptSave Protocol not exist.\r
402 \r
403 EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS\r
404\r
405--*/\r
406{\r
407 return EFI_SUCCESS;\r
408}\r
409\r
410EFI_STATUS\r
411EFIAPI\r
412BootScriptSaveInformationAsciiString (\r
413 IN UINT16 TableName,\r
414 IN CONST CHAR8 *String\r
415 )\r
416 /*++\r
417\r
418Routine Description:\r
419\r
420 Save ASCII string information specified by Buffer to \r
421 boot script with opcode EFI_BOOT_SCRIPT_INFORMATION_OPCODE\r
422\r
423Arguments:\r
424\r
425 TableName - Desired boot script table\r
426\r
427 FfsName - The file name of the code to be dispatched.\r
428\r
429 Context - The data that will be passed into code.\r
430\r
431 ParentHandle - The caller's image handle.\r
432\r
433Returns:\r
434\r
435 EFI_NOT_FOUND - BootScriptSave Protocol not exist.\r
436 \r
437 EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS\r
438\r
439--*/\r
440{\r
441 return EFI_SUCCESS;\r
442}\r
443\r
444\r
445EFI_STATUS\r
446EFIAPI\r
447BootScriptSaveDispatch (\r
448 IN UINT16 TableName,\r
449 IN EFI_PHYSICAL_ADDRESS EntryPoint\r
450 )\r
451/*++\r
452\r
453Routine Description:\r
454\r
455 GC_TODO: Add function description\r
456\r
457Arguments:\r
458\r
459 TableName - GC_TODO: add argument description\r
460 EntryPoint - GC_TODO: add argument description\r
461\r
462Returns:\r
463\r
464 EFI_NOT_FOUND - GC_TODO: Add description for return value\r
465 EFI_SUCCESS - GC_TODO: Add description for return value\r
466\r
467--*/\r
468{\r
469 return EFI_SUCCESS;\r
470}\r
471\r
472EFI_STATUS\r
473EFIAPI\r
474BootScriptSaveDispatch2Image (\r
475 IN UINT16 TableName,\r
476 IN EFI_GUID *FfsName,\r
477 IN EFI_PHYSICAL_ADDRESS Context,\r
478 IN EFI_HANDLE ParentHandle\r
479 )\r
480/*++\r
481\r
482Routine Description:\r
483\r
484 Save dispatching specified arbitrary code to boot script with opcode \r
485 EFI_BOOT_SCRIPT_DISPATCH_OPCODE\r
486\r
487Arguments:\r
488\r
489 TableName - Desired boot script table\r
490\r
491 FfsName - The file name of the code to be dispatched.\r
492\r
493 Context - The data that will be passed into code.\r
494\r
495 ParentHandle - The caller's image handle.\r
496\r
497Returns:\r
498\r
499 EFI_NOT_FOUND - BootScriptSave Protocol not exist.\r
500 \r
501 EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS\r
502\r
503--*/\r
504{\r
505 return EFI_SUCCESS;\r
506}\r