]>
Commit | Line | Data |
---|---|---|
5e6b870a GL |
1 | /** @file\r |
2 | \r | |
3 | Internal definitions for the LSI 53C895A SCSI driver, which produces\r | |
4 | Extended SCSI Pass Thru Protocol instances for LSI 53C895A SCSI devices.\r | |
5 | \r | |
6 | Copyright (C) 2020, SUSE LLC.\r | |
7 | \r | |
8 | SPDX-License-Identifier: BSD-2-Clause-Patent\r | |
9 | \r | |
10 | **/\r | |
11 | \r | |
12 | #ifndef _LSI_SCSI_DXE_H_\r | |
13 | #define _LSI_SCSI_DXE_H_\r | |
14 | \r | |
f1d6c1eb | 15 | typedef struct {\r |
31830b07 GL |
16 | //\r |
17 | // Allocate 32 UINT32 entries for the script and it's sufficient for\r | |
18 | // 16 instructions.\r | |
19 | //\r | |
ac0a286f | 20 | UINT32 Script[32];\r |
97e60818 GL |
21 | //\r |
22 | // The max size of CDB is 32.\r | |
23 | //\r | |
ac0a286f | 24 | UINT8 Cdb[32];\r |
f1d6c1eb GL |
25 | //\r |
26 | // Allocate 64KB for read/write buffer. It seems sufficient for the common\r | |
27 | // boot scenarios.\r | |
28 | //\r | |
29 | // NOTE: The number of bytes for data transmission is bounded by DMA Byte\r | |
30 | // Count (DBC), a 24-bit register, so the maximum is 0xFFFFFF (16MB-1).\r | |
31 | //\r | |
ac0a286f | 32 | UINT8 Data[SIZE_64KB];\r |
31830b07 GL |
33 | //\r |
34 | // For SCSI Message In phase\r | |
35 | //\r | |
ac0a286f | 36 | UINT8 MsgIn[2];\r |
31830b07 GL |
37 | //\r |
38 | // For SCSI Message Out phase\r | |
39 | //\r | |
ac0a286f | 40 | UINT8 MsgOut;\r |
31830b07 GL |
41 | //\r |
42 | // For SCSI Status phase\r | |
43 | //\r | |
ac0a286f | 44 | UINT8 Status;\r |
f1d6c1eb GL |
45 | } LSI_SCSI_DMA_BUFFER;\r |
46 | \r | |
23d982e2 | 47 | typedef struct {\r |
ac0a286f MK |
48 | UINT32 Signature;\r |
49 | UINT64 OrigPciAttrs;\r | |
50 | EFI_EVENT ExitBoot;\r | |
51 | EFI_PCI_IO_PROTOCOL *PciIo;\r | |
52 | UINT8 MaxTarget;\r | |
53 | UINT8 MaxLun;\r | |
54 | UINT32 StallPerPollUsec;\r | |
55 | LSI_SCSI_DMA_BUFFER *Dma;\r | |
56 | EFI_PHYSICAL_ADDRESS DmaPhysical;\r | |
57 | VOID *DmaMapping;\r | |
58 | EFI_EXT_SCSI_PASS_THRU_MODE PassThruMode;\r | |
59 | EFI_EXT_SCSI_PASS_THRU_PROTOCOL PassThru;\r | |
23d982e2 GL |
60 | } LSI_SCSI_DEV;\r |
61 | \r | |
ac0a286f | 62 | #define LSI_SCSI_DEV_SIGNATURE SIGNATURE_32 ('L','S','I','S')\r |
23d982e2 GL |
63 | \r |
64 | #define LSI_SCSI_FROM_PASS_THRU(PassThruPtr) \\r | |
65 | CR (PassThruPtr, LSI_SCSI_DEV, PassThru, LSI_SCSI_DEV_SIGNATURE)\r | |
66 | \r | |
31830b07 GL |
67 | #define LSI_SCSI_DMA_ADDR(Dev, MemberName) \\r |
68 | ((UINT32)(Dev->DmaPhysical + OFFSET_OF (LSI_SCSI_DMA_BUFFER, MemberName)))\r | |
69 | \r | |
5e6b870a GL |
70 | //\r |
71 | // Probe, start and stop functions of this driver, called by the DXE core for\r | |
72 | // specific devices.\r | |
73 | //\r | |
74 | // The following specifications document these interfaces:\r | |
75 | // - Driver Writer's Guide for UEFI 2.3.1 v1.01, 9 Driver Binding Protocol\r | |
76 | // - UEFI Spec 2.3.1 + Errata C, 10.1 EFI Driver Binding Protocol\r | |
77 | //\r | |
78 | \r | |
79 | EFI_STATUS\r | |
80 | EFIAPI\r | |
81 | LsiScsiControllerSupported (\r | |
ac0a286f MK |
82 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r |
83 | IN EFI_HANDLE ControllerHandle,\r | |
84 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r | |
5e6b870a GL |
85 | );\r |
86 | \r | |
87 | EFI_STATUS\r | |
88 | EFIAPI\r | |
89 | LsiScsiControllerStart (\r | |
ac0a286f MK |
90 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r |
91 | IN EFI_HANDLE ControllerHandle,\r | |
92 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath OPTIONAL\r | |
5e6b870a GL |
93 | );\r |
94 | \r | |
95 | EFI_STATUS\r | |
96 | EFIAPI\r | |
97 | LsiScsiControllerStop (\r | |
ac0a286f MK |
98 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r |
99 | IN EFI_HANDLE ControllerHandle,\r | |
100 | IN UINTN NumberOfChildren,\r | |
101 | IN EFI_HANDLE *ChildHandleBuffer\r | |
5e6b870a GL |
102 | );\r |
103 | \r | |
23d982e2 GL |
104 | //\r |
105 | // The next seven functions implement EFI_EXT_SCSI_PASS_THRU_PROTOCOL\r | |
106 | // for the LSI 53C895A SCSI Controller. Refer to UEFI Spec 2.3.1 + Errata C,\r | |
107 | // sections\r | |
108 | // - 14.1 SCSI Driver Model Overview,\r | |
109 | // - 14.7 Extended SCSI Pass Thru Protocol.\r | |
110 | //\r | |
111 | \r | |
112 | EFI_STATUS\r | |
113 | EFIAPI\r | |
114 | LsiScsiPassThru (\r | |
ac0a286f MK |
115 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r |
116 | IN UINT8 *Target,\r | |
117 | IN UINT64 Lun,\r | |
118 | IN OUT EFI_EXT_SCSI_PASS_THRU_SCSI_REQUEST_PACKET *Packet,\r | |
119 | IN EFI_EVENT Event OPTIONAL\r | |
23d982e2 GL |
120 | );\r |
121 | \r | |
122 | EFI_STATUS\r | |
123 | EFIAPI\r | |
124 | LsiScsiGetNextTargetLun (\r | |
ac0a286f MK |
125 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r |
126 | IN OUT UINT8 **TargetPointer,\r | |
127 | IN OUT UINT64 *Lun\r | |
23d982e2 GL |
128 | );\r |
129 | \r | |
130 | EFI_STATUS\r | |
131 | EFIAPI\r | |
132 | LsiScsiBuildDevicePath (\r | |
ac0a286f MK |
133 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r |
134 | IN UINT8 *Target,\r | |
135 | IN UINT64 Lun,\r | |
136 | IN OUT EFI_DEVICE_PATH_PROTOCOL **DevicePath\r | |
23d982e2 GL |
137 | );\r |
138 | \r | |
139 | EFI_STATUS\r | |
140 | EFIAPI\r | |
141 | LsiScsiGetTargetLun (\r | |
ac0a286f MK |
142 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r |
143 | IN EFI_DEVICE_PATH_PROTOCOL *DevicePath,\r | |
144 | OUT UINT8 **TargetPointer,\r | |
145 | OUT UINT64 *Lun\r | |
23d982e2 GL |
146 | );\r |
147 | \r | |
148 | EFI_STATUS\r | |
149 | EFIAPI\r | |
150 | LsiScsiResetChannel (\r | |
ac0a286f | 151 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This\r |
23d982e2 GL |
152 | );\r |
153 | \r | |
154 | EFI_STATUS\r | |
155 | EFIAPI\r | |
156 | LsiScsiResetTargetLun (\r | |
ac0a286f MK |
157 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r |
158 | IN UINT8 *Target,\r | |
159 | IN UINT64 Lun\r | |
23d982e2 GL |
160 | );\r |
161 | \r | |
162 | EFI_STATUS\r | |
163 | EFIAPI\r | |
164 | LsiScsiGetNextTarget (\r | |
ac0a286f MK |
165 | IN EFI_EXT_SCSI_PASS_THRU_PROTOCOL *This,\r |
166 | IN OUT UINT8 **TargetPointer\r | |
23d982e2 GL |
167 | );\r |
168 | \r | |
386ca8ab GL |
169 | //\r |
170 | // The purpose of the following scaffolding (EFI_COMPONENT_NAME_PROTOCOL and\r | |
171 | // EFI_COMPONENT_NAME2_PROTOCOL implementation) is to format the driver's name\r | |
172 | // in English, for display on standard console devices. This is recommended for\r | |
173 | // UEFI drivers that follow the UEFI Driver Model. Refer to the Driver Writer's\r | |
174 | // Guide for UEFI 2.3.1 v1.01, 11 UEFI Driver and Controller Names.\r | |
175 | //\r | |
176 | // Device type names ("LSI 53C895A SCSI Controller") are not formatted because\r | |
177 | // the driver supports only that device type. Therefore the driver name\r | |
178 | // suffices for unambiguous identification.\r | |
179 | //\r | |
180 | \r | |
181 | EFI_STATUS\r | |
182 | EFIAPI\r | |
183 | LsiScsiGetDriverName (\r | |
ac0a286f MK |
184 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r |
185 | IN CHAR8 *Language,\r | |
186 | OUT CHAR16 **DriverName\r | |
386ca8ab GL |
187 | );\r |
188 | \r | |
189 | EFI_STATUS\r | |
190 | EFIAPI\r | |
191 | LsiScsiGetDeviceName (\r | |
ac0a286f MK |
192 | IN EFI_COMPONENT_NAME_PROTOCOL *This,\r |
193 | IN EFI_HANDLE DeviceHandle,\r | |
194 | IN EFI_HANDLE ChildHandle,\r | |
195 | IN CHAR8 *Language,\r | |
196 | OUT CHAR16 **ControllerName\r | |
386ca8ab GL |
197 | );\r |
198 | \r | |
5e6b870a | 199 | #endif // _LSI_SCSI_DXE_H_\r |