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
38 #define EFI_BOOT_SCRIPT_DISPATCH_2_OPCODE 0x09
40 #define EFI_BOOT_SCRIPT_TABLE_OPCODE 0xAA
41 #define EFI_BOOT_SCRIPT_TERMINATE_OPCODE 0xFF
44 // EFI Boot Script Width
47 EfiBootScriptWidthUint8
,
48 EfiBootScriptWidthUint16
,
49 EfiBootScriptWidthUint32
,
50 EfiBootScriptWidthUint64
,
51 EfiBootScriptWidthFifoUint8
,
52 EfiBootScriptWidthFifoUint16
,
53 EfiBootScriptWidthFifoUint32
,
54 EfiBootScriptWidthFifoUint64
,
55 EfiBootScriptWidthFillUint8
,
56 EfiBootScriptWidthFillUint16
,
57 EfiBootScriptWidthFillUint32
,
58 EfiBootScriptWidthFillUint64
,
59 EfiBootScriptWidthMaximum
60 } EFI_BOOT_SCRIPT_WIDTH
;
63 // EFI Smbus Device Address, Smbus Device Command, Smbus Operation
66 UINTN SmbusDeviceAddress
: 7;
67 } EFI_SMBUS_DEVICE_ADDRESS
;
69 typedef UINTN EFI_SMBUS_DEVICE_COMMAND
;
71 typedef enum _EFI_SMBUS_OPERATION
84 EfiSmbusBWBRProcessCall
85 } EFI_SMBUS_OPERATION
;
88 // Boot Script Opcode Header Structure Definitions
94 } EFI_BOOT_SCRIPT_GENERIC_HEADER
;
102 } EFI_BOOT_SCRIPT_TABLE_HEADER
;
107 EFI_BOOT_SCRIPT_WIDTH Width
;
108 } EFI_BOOT_SCRIPT_COMMON_HEADER
;
113 EFI_BOOT_SCRIPT_WIDTH Width
;
116 } EFI_BOOT_SCRIPT_IO_WRITE
;
121 EFI_BOOT_SCRIPT_WIDTH Width
;
123 } EFI_BOOT_SCRIPT_IO_READ_WRITE
;
128 EFI_BOOT_SCRIPT_WIDTH Width
;
131 } EFI_BOOT_SCRIPT_MEM_WRITE
;
136 EFI_BOOT_SCRIPT_WIDTH Width
;
138 } EFI_BOOT_SCRIPT_MEM_READ_WRITE
;
143 EFI_BOOT_SCRIPT_WIDTH Width
;
146 } EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE
;
151 EFI_BOOT_SCRIPT_WIDTH Width
;
153 } EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE
;
158 EFI_SMBUS_DEVICE_ADDRESS SlaveAddress
;
159 EFI_SMBUS_DEVICE_COMMAND Command
;
160 EFI_SMBUS_OPERATION Operation
;
163 } EFI_BOOT_SCRIPT_SMBUS_EXECUTE
;
169 } EFI_BOOT_SCRIPT_STALL
;
174 EFI_PHYSICAL_ADDRESS EntryPoint
;
175 } EFI_BOOT_SCRIPT_DISPATCH
;
180 EFI_PHYSICAL_ADDRESS EntryPoint
;
181 EFI_PHYSICAL_ADDRESS Context
;
182 } EFI_BOOT_SCRIPT_DISPATCH_2
;
187 } EFI_BOOT_SCRIPT_TERMINATE
;
190 EFI_BOOT_SCRIPT_GENERIC_HEADER
*Header
;
191 EFI_BOOT_SCRIPT_TABLE_HEADER
*TableInfo
;
192 EFI_BOOT_SCRIPT_IO_WRITE
*IoWrite
;
193 EFI_BOOT_SCRIPT_IO_READ_WRITE
*IoReadWrite
;
194 EFI_BOOT_SCRIPT_MEM_WRITE
*MemWrite
;
195 EFI_BOOT_SCRIPT_MEM_READ_WRITE
*MemReadWrite
;
196 EFI_BOOT_SCRIPT_PCI_CONFIG_WRITE
*PciWrite
;
197 EFI_BOOT_SCRIPT_PCI_CONFIG_READ_WRITE
*PciReadWrite
;
198 EFI_BOOT_SCRIPT_SMBUS_EXECUTE
*SmbusExecute
;
199 EFI_BOOT_SCRIPT_STALL
*Stall
;
200 EFI_BOOT_SCRIPT_DISPATCH
*Dispatch
;
201 EFI_BOOT_SCRIPT_DISPATCH_2
*Dispatch2
;
202 EFI_BOOT_SCRIPT_TERMINATE
*Terminate
;
203 EFI_BOOT_SCRIPT_COMMON_HEADER
*CommonHeader
;
205 } BOOT_SCRIPT_POINTERS
;