1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
|
/*++
Copyright (c) 2006, Intel Corporation. All rights reserved.
This software and associated documentation (if any) is furnished
under a license and may only be used or copied in accordance
with the terms of the license. Except as permitted by such
license, no part of this software or documentation may be
reproduced, stored in a retrieval system, or transmitted in any
form or by any means without the express written consent of
Intel Corporation.
Module Name:
EfiScriptLib.h
Abstract:
--*/
#ifndef _BOOT_SCRIPT_LIB_H_
#define _BOOT_SCRIPT_LIB_H_
#include <PiPei.h>
#include <Ppi/BootScriptExecuter.h>
#include <IndustryStandard/SmBus.h>
EFI_STATUS
EFIAPI
BootScriptSaveIoWrite (
IN UINT16 TableName,
IN EFI_BOOT_SCRIPT_WIDTH Width,
IN UINT64 Address,
IN UINTN Count,
IN VOID *Buffer
)
/*++
Routine Description:
Save I/O write to boot script with opcode EFI_BOOT_SCRIPT_IO_WRITE_OPCODE
Arguments:
TableName - Desired boot script table
Width - The width of the I/O operations.
Address - The base address of the I/O operations.
Count - The number of I/O operations to perform.
Buffer - The source buffer from which to write data.
Returns:
EFI_NOT_FOUND - BootScriptSave Protocol not exist.
EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS
--*/
;
EFI_STATUS
EFIAPI
BootScriptSaveIoReadWrite (
IN UINT16 TableName,
IN EFI_BOOT_SCRIPT_WIDTH Width,
IN UINT64 Address,
IN VOID *Data,
IN VOID *DataMask
)
/*++
Routine Description:
Save I/O modify to boot script with opcode EFI_BOOT_SCRIPT_IO_READ_WRITE_OPCODE
Arguments:
TableName - Desired boot script table
Width - The width of the I/O operations.
Address - The base address of the I/O operations.
Data - A pointer to the data to be OR-ed.
DataMask - A pointer to the data mask to be AND-ed with the data read from the register.
Returns:
EFI_NOT_FOUND - BootScriptSave Protocol not exist.
EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS
--*/
;
EFI_STATUS
EFIAPI
BootScriptSaveMemWrite (
IN UINT16 TableName,
IN EFI_BOOT_SCRIPT_WIDTH Width,
IN UINT64 Address,
IN UINTN Count,
IN VOID *Buffer
)
/*++
Routine Description:
Save memory write to boot script with opcode EFI_BOOT_SCRIPT_MEM_WRITE_OPCODE
Arguments:
TableName - Desired boot script table
Width - The width of the memory operations.
Address - The base address of the memory operations.
Count - The number of memory operations to perform.
Buffer - The source buffer from which to write the data.
Returns:
EFI_NOT_FOUND - BootScriptSave Protocol not exist.
EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS
--*/
;
EFI_STATUS
EFIAPI
BootScriptSaveMemReadWrite (
IN UINT16 TableName,
IN EFI_BOOT_SCRIPT_WIDTH Width,
IN UINT64 Address,
IN VOID *Data,
IN VOID *DataMask
)
/*++
Routine Description:
Save memory modify to boot script with opcode EFI_BOOT_SCRIPT_MEM_READ_WRITE_OPCODE
Arguments:
TableName - Desired boot script table
Width - The width of the memory operations.
Address - The base address of the memory operations.
Data - A pointer to the data to be OR-ed.
DataMask - A pointer to the data mask to be AND-ed with the data read from the register.
Returns:
EFI_NOT_FOUND - BootScriptSave Protocol not exist.
EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS
--*/
;
EFI_STATUS
EFIAPI
BootScriptSavePciCfgWrite (
IN UINT16 TableName,
IN EFI_BOOT_SCRIPT_WIDTH Width,
IN UINT64 Address,
IN UINTN Count,
IN VOID *Buffer
)
/*++
Routine Description:
Save PCI configuration space write operation to boot script with opcode
EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE_OPCODE
Arguments:
TableName - Desired boot script table
Width - The width of the PCI operations
Address - The address within the PCI configuration space.
Count - The number of PCI operations to perform.
Buffer - The source buffer from which to write the data.
Returns:
EFI_NOT_FOUND - BootScriptSave Protocol not exist.
EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS
--*/
;
EFI_STATUS
EFIAPI
BootScriptSavePciCfgReadWrite (
IN UINT16 TableName,
IN EFI_BOOT_SCRIPT_WIDTH Width,
IN UINT64 Address,
IN VOID *Data,
IN VOID *DataMask
)
/*++
Routine Description:
Save PCI configuration space modify operation to boot script with opcode
EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE_OPCODE
Arguments:
TableName - Desired boot script table
Width - The width of the PCI operations
Address - The address within the PCI configuration space.
Data - A pointer to the data to be OR-ed.
DataMask - A pointer to the data mask to be AND-ed with the data read from the register.
Returns:
EFI_NOT_FOUND - BootScriptSave Protocol not exist.
EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS
--*/
;
EFI_STATUS
EFIAPI
BootScriptSaveSmbusExecute (
IN UINT16 TableName,
IN EFI_SMBUS_DEVICE_ADDRESS SlaveAddress,
IN EFI_SMBUS_DEVICE_COMMAND Command,
IN EFI_SMBUS_OPERATION Operation,
IN BOOLEAN PecCheck,
IN UINTN *Length,
IN VOID *Buffer
)
/*++
Routine Description:
Save SMBus command execution to boot script with opcode
EFI_BOOT_SCRIPT_SMBUS_EXECUTE_OPCODE
Arguments:
TableName - Desired boot script table
SlaveAddress - The SMBus address for the slave device that the operation is targeting.
Command - The command that is transmitted by the SMBus host controller to the
SMBus slave device.
Operation - Indicates which particular SMBus protocol it will use to execute the
SMBus transactions.
PecCheck - Defines if Packet Error Code (PEC) checking is required for this operation.
Length - A pointer to signify the number of bytes that this operation will do.
Buffer - Contains the value of data to execute to the SMBUS slave device.
Returns:
EFI_NOT_FOUND - BootScriptSave Protocol not exist.
EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS
--*/
;
EFI_STATUS
EFIAPI
BootScriptSaveStall (
IN UINT16 TableName,
IN UINTN Duration
)
/*++
Routine Description:
Save execution stall on the processor to boot script with opcode
EFI_BOOT_SCRIPT_STALL_OPCODE
Arguments:
TableName - Desired boot script table
Duration - Duration in microseconds of the stall.
Returns:
EFI_NOT_FOUND - BootScriptSave Protocol not exist.
EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS
--*/
;
EFI_STATUS
EFIAPI
BootScriptSaveDispatch (
IN UINT16 TableName,
IN EFI_PHYSICAL_ADDRESS EntryPoint
)
/*++
Routine Description:
Save dispatching specified arbitrary code to boot script with opcode
EFI_BOOT_SCRIPT_DISPATCH_OPCODE
Arguments:
TableName - Desired boot script table
EntryPoint - Entry point of the code to be dispatched.
Returns:
EFI_NOT_FOUND - BootScriptSave Protocol not exist.
EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS
--*/
;
EFI_STATUS
EFIAPI
BootScriptSaveDispatch2 (
IN UINT16 TableName,
IN EFI_PHYSICAL_ADDRESS EntryPoint,
IN EFI_PHYSICAL_ADDRESS Context
)
/*++
Routine Description:
Save dispatching specified arbitrary code to boot script with opcode
EFI_BOOT_SCRIPT_DISPATCH_OPCODE
Arguments:
TableName - Desired boot script table
EntryPoint - Entry point of the code to be dispatched.
Context - The data that will be passed into code.
Returns:
EFI_NOT_FOUND - BootScriptSave Protocol not exist.
EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS
--*/
;
EFI_STATUS
EFIAPI
BootScriptSaveDispatch2Image (
IN UINT16 TableName,
IN EFI_GUID *FfsName,
IN EFI_PHYSICAL_ADDRESS Context,
IN EFI_HANDLE ParentHandle
)
/*++
Routine Description:
Save dispatching specified arbitrary code to boot script with opcode
EFI_BOOT_SCRIPT_DISPATCH_OPCODE
Arguments:
TableName - Desired boot script table
FfsName - The file name of the code to be dispatched.
Context - The data that will be passed into code.
ParentHandle - The caller's image handle.
Returns:
EFI_NOT_FOUND - BootScriptSave Protocol not exist.
EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS
--*/
;
EFI_STATUS
EFIAPI
BootScriptSaveInformation (
IN UINT16 TableName,
IN UINT32 Length,
IN EFI_PHYSICAL_ADDRESS Buffer
)
/*++
Routine Description:
Save information specified by Buffer, length is specified by Length, to
boot script with opcode EFI_BOOT_SCRIPT_INFORMATION_OPCODE
Arguments:
TableName - Desired boot script table
FfsName - The file name of the code to be dispatched.
Context - The data that will be passed into code.
ParentHandle - The caller's image handle.
Returns:
EFI_NOT_FOUND - BootScriptSave Protocol not exist.
EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS
--*/
;
EFI_STATUS
EFIAPI
BootScriptSaveInformationUnicodeString (
IN UINT16 TableName,
IN CONST CHAR16 *String
)
/*++
Routine Description:
Save unicode string information specified by Buffer to
boot script with opcode EFI_BOOT_SCRIPT_INFORMATION_OPCODE
Arguments:
TableName - Desired boot script table
FfsName - The file name of the code to be dispatched.
Context - The data that will be passed into code.
ParentHandle - The caller's image handle.
Returns:
EFI_NOT_FOUND - BootScriptSave Protocol not exist.
EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS
--*/
;
EFI_STATUS
EFIAPI
BootScriptSaveInformationAsciiString (
IN UINT16 TableName,
IN CONST CHAR8 *String
)
/*++
Routine Description:
Save ASCII string information specified by Buffer to
boot script with opcode EFI_BOOT_SCRIPT_INFORMATION_OPCODE
Arguments:
TableName - Desired boot script table
FfsName - The file name of the code to be dispatched.
Context - The data that will be passed into code.
ParentHandle - The caller's image handle.
Returns:
EFI_NOT_FOUND - BootScriptSave Protocol not exist.
EFI_STATUS - BootScriptSave Protocol exist, always returns EFI_SUCCESS
--*/
;
EFI_STATUS
EFIAPI
BootScriptSaveInitialize (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
)
/*++
Routine Description:
Intialize Boot Script Lib if it has not yet been initialized.
Arguments:
ImageHandle - The firmware allocated handle for the EFI image.
SystemTable - A pointer to the EFI System Table.
Returns:
EFI_STATUS always returns EFI_SUCCESS
--*/
;
#endif
|
