2 This file declares the related BootScript definitions and some SMBus definitions.
4 Copyright (c) 2006, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13 Module Name: BootScript.h
15 @par Revision Reference:
16 These definitions are defined in BootScript Spec 0.91 and SmBus PPI spec 0.9.
20 #ifndef _EFI_SCRIPT_H_
21 #define _EFI_SCRIPT_H_
23 #define EFI_ACPI_S3_RESUME_SCRIPT_TABLE 0x00
26 // Boot Script Opcode Definitions
29 #define EFI_BOOT_SCRIPT_IO_WRITE_OPCODE 0x00
30 #define EFI_BOOT_SCRIPT_IO_READ_WRITE_OPCODE 0x01
31 #define EFI_BOOT_SCRIPT_MEM_WRITE_OPCODE 0x02
32 #define EFI_BOOT_SCRIPT_MEM_READ_WRITE_OPCODE 0x03
33 #define EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE_OPCODE 0x04
34 #define EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE_OPCODE 0x05
35 #define EFI_BOOT_SCRIPT_SMBUS_EXECUTE_OPCODE 0x06
36 #define EFI_BOOT_SCRIPT_STALL_OPCODE 0x07
37 #define EFI_BOOT_SCRIPT_DISPATCH_OPCODE 0x08
39 #define EFI_BOOT_SCRIPT_TABLE_OPCODE 0xAA
40 #define EFI_BOOT_SCRIPT_TERMINATE_OPCODE 0xFF
43 // EFI Boot Script Width
46 EfiBootScriptWidthUint8
,
47 EfiBootScriptWidthUint16
,
48 EfiBootScriptWidthUint32
,
49 EfiBootScriptWidthUint64
,
50 EfiBootScriptWidthFifoUint8
,
51 EfiBootScriptWidthFifoUint16
,
52 EfiBootScriptWidthFifoUint32
,
53 EfiBootScriptWidthFifoUint64
,
54 EfiBootScriptWidthFillUint8
,
55 EfiBootScriptWidthFillUint16
,
56 EfiBootScriptWidthFillUint32
,
57 EfiBootScriptWidthFillUint64
,
58 EfiBootScriptWidthMaximum
59 } EFI_BOOT_SCRIPT_WIDTH
;
62 // EFI Smbus Device Address, Smbus Device Command, Smbus Operation
65 UINTN SmbusDeviceAddress
: 7;
66 } EFI_SMBUS_DEVICE_ADDRESS
;
68 typedef UINTN EFI_SMBUS_DEVICE_COMMAND
;
70 typedef enum _EFI_SMBUS_OPERATION
83 EfiSmbusBWBRProcessCall
84 } EFI_SMBUS_OPERATION
;
87 // Boot Script Opcode Header Structure Definitions
93 } EFI_BOOT_SCRIPT_GENERIC_HEADER
;
101 } EFI_BOOT_SCRIPT_TABLE_HEADER
;
106 EFI_BOOT_SCRIPT_WIDTH Width
;
107 } EFI_BOOT_SCRIPT_COMMON_HEADER
;
112 EFI_BOOT_SCRIPT_WIDTH Width
;
115 } EFI_BOOT_SCRIPT_IO_WRITE
;
120 EFI_BOOT_SCRIPT_WIDTH Width
;
122 } EFI_BOOT_SCRIPT_IO_READ_WRITE
;
127 EFI_BOOT_SCRIPT_WIDTH Width
;
130 } EFI_BOOT_SCRIPT_MEM_WRITE
;
135 EFI_BOOT_SCRIPT_WIDTH Width
;
137 } EFI_BOOT_SCRIPT_MEM_READ_WRITE
;
142 EFI_BOOT_SCRIPT_WIDTH Width
;
145 } EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE
;
150 EFI_BOOT_SCRIPT_WIDTH Width
;
152 } EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE
;
157 EFI_SMBUS_DEVICE_ADDRESS SlaveAddress
;
158 EFI_SMBUS_DEVICE_COMMAND Command
;
159 EFI_SMBUS_OPERATION Operation
;
162 } EFI_BOOT_SCRIPT_SMBUS_EXECUTE
;
168 } EFI_BOOT_SCRIPT_STALL
;
173 EFI_PHYSICAL_ADDRESS EntryPoint
;
174 EFI_PHYSICAL_ADDRESS Context
;
175 } EFI_BOOT_SCRIPT_DISPATCH
;
180 } EFI_BOOT_SCRIPT_TERMINATE
;
183 EFI_BOOT_SCRIPT_GENERIC_HEADER
*Header
;
184 EFI_BOOT_SCRIPT_TABLE_HEADER
*TableInfo
;
185 EFI_BOOT_SCRIPT_IO_WRITE
*IoWrite
;
186 EFI_BOOT_SCRIPT_IO_READ_WRITE
*IoReadWrite
;
187 EFI_BOOT_SCRIPT_MEM_WRITE
*MemWrite
;
188 EFI_BOOT_SCRIPT_MEM_READ_WRITE
*MemReadWrite
;
189 EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE
*PciWrite
;
190 EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE
*PciReadWrite
;
191 EFI_BOOT_SCRIPT_SMBUS_EXECUTE
*SmbusExecute
;
192 EFI_BOOT_SCRIPT_STALL
*Stall
;
193 EFI_BOOT_SCRIPT_DISPATCH
*Dispatch
;
194 EFI_BOOT_SCRIPT_TERMINATE
*Terminate
;
195 EFI_BOOT_SCRIPT_COMMON_HEADER
*CommonHeader
;
197 } BOOT_SCRIPT_POINTERS
;