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
|
/** @file
Header file for function definitions
@copyright
Copyright (c) 1999 - 2012 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.
This file contains an 'Intel Peripheral Driver' and uniquely
identified as "Intel Reference Module" and is
licensed for Intel CPUs and chipsets under the terms of your
license agreement with Intel or your vendor. This file may
be modified by the user, subject to additional terms of the
license agreement
**/
#ifndef RAPID_START_AHCI_H_
#define RAPID_START_AHCI_H_
#include <RapidStartAhciReg.h>
#pragma pack(1)
typedef struct {
UINT32 Abar;
UINT32 PortBase;
UINT32 PortSize;
UINTN Port;
BOOLEAN PollCancellation;
// Internal fields
UINT16 *Identify;
enum {
AHCI_STATE_UNKNOWN,
AHCI_STATE_INIT,
AHCI_STATE_INUSE,
AHCI_STATE_MAX,
} State;
struct {
UINT8 HybridPriority : 4;
UINT8 Reserved : 3;
UINT8 HybridInfoValid : 1;
} HybridInfo;
UINT32 TotalRemainingCacheCapacityInSector;
} AHCI_CONTEXT;
typedef union {
UINT32 Data;
struct {
UINT32 ByteReserved1 : 8;
UINT32 ByteReserved2 : 8;
UINT32 HybridPriority : 4;
UINT32 Reserved : 1;
UINT32 HybridInfoValid : 1;
UINT32 Reserved1 : 2;
UINT32 ByteReserved4 : 8;
} r;
} ATA_AUX;
typedef struct {
UINT64 MemAddr;
UINT64 Lba;
UINT32 SectorCount;
UINT16 Feature;
UINT8 Command;
UINT8 Direction;
ATA_AUX Auxiliary;
} ATA_COMMAND;
#pragma pack()
#define AhciSpinUp(Ahci) \
AhciSpinUpPort (Ahci, Ahci->Port)
#define AhciPostCommand(Ahci, AtaCmd, CmdIdx) \
AhciPostCommandWithZeroFilter (Ahci, AtaCmd, CmdIdx, NULL, NULL)
/**
Initialize SATA controller and enable decode
@param[in] Ahci - SATA controller information structure
@retval EFI_SUCCESS - SATA controller has been initialized successfully
**/
EFI_STATUS
AhciInit (
IN AHCI_CONTEXT *Ahci
);
/**
Returns SATA enabled port bitmap basing on PCS value.
@retval Enabled ports map.
**/
UINT32
AhciGetEnabledPorts (
VOID
);
/**
Returns SATA present port bitmap basing on PCS value.
@retval Present ports map.
**/
UINT32
AhciGetPresentPorts (
VOID
);
/**
Check whether device is password locked.
@param[in] Ahci - SATA controller information structure
@retval EFI_SUCCESS - Device not locked
@retval EFI_ACCESS_DENIED - Drive is in LOCKED state and need to execute UNLOCK command before accessing
@retval EFI_SECURITY_VIOLATION - Drive is already in SECURITY FREEZE state and will not accept UNLOCK command
@retval EFI_TIMEOUT - Timeout occured
@retval EFI_DEVICE_ERROR - Error occurred on device side.
**/
EFI_STATUS
AhciGetLockStatus (
IN AHCI_CONTEXT *Ahci
);
/**
Disable SATA controller after all AHCI commands have completed
@param[in] Ahci - SATA controller information structure
**/
VOID
AhciDone (
IN AHCI_CONTEXT *Ahci
);
/**
Spin up Ahci port
@param[in] Ahci - SATA controller information structure
@param[in] Port - SATA port number
@retval EFI_SUCCESS - AHCI Port has been spun up successfully
**/
EFI_STATUS
AhciSpinUpPort (
IN AHCI_CONTEXT *Ahci,
IN UINTN Port
);
/**
Initialize AHCI port for reading/writing RapidStart Store
@param[in] Ahci - SATA controller information structure
@retval EFI_DEVICE_ERROR - AHCI port initialization failed
@retval EFI_SUCCESS - AHCI port initialized successfully and RapidStart Store is ready for reading/writing
**/
EFI_STATUS
AhciPortInit (
IN AHCI_CONTEXT *Ahci
);
/**
Stops AHCI port.
@param[in] Ahci - SATA controller information structure
**/
VOID
AhciPortDone (
IN AHCI_CONTEXT *Ahci
);
/**
Executes AHCI command.
@param[in] Ahci - SATA controller information structure
@param[in,out] AtaCmd - ATA command structure
@retval EFI_SUCCESS - Command successfull
@retval EFI_TIMEOUT - Timeout occured
@retval EFI_DEVICE_ERROR - Command failed
**/
EFI_STATUS
AhciExecCommand (
IN AHCI_CONTEXT *Ahci,
IN OUT ATA_COMMAND *AtaCmd
);
/**
Enqueues ahci command and for read/write it is optionally with Zero filter.
@param[in] Ahci - SATA controller information structure
@param[in,out] AtaCmd - ATA command structure
@param[out] CmdMask - If given a bit corresponding to allocated command slot is set
@param[in] ZeroPageBitMap - A pointer for ZeroPageTable
@param[out] SmRamBufferLba - If given the drive LBA storing original SMRAM buffer content will be passed by it.
@retval EFI_SUCCESS - AHCI command successfully posted
@retval EFI_TIMEOUT - Timeout occured
@retval EFI_DEVICE_ERROR - Command failed
**/
EFI_STATUS
AhciPostCommandWithZeroFilter (
IN AHCI_CONTEXT *Ahci,
IN OUT ATA_COMMAND *AtaCmd,
OUT OPTIONAL UINT32 *CmdMask,
IN OPTIONAL UINT32 *ZeroPageBitMap,
OUT OPTIONAL UINT64 *SmRamBufferLba
);
/**
Issues ATA command with no data transfer.
@param[in] Ahci - SATA controller information structure
@param[in] Command - Command to be issued
@retval EFI_SUCCESS - fucntion executed successfully
@retval EFI_TIMEOUT - Timeout occured
@retval EFI_DEVICE_ERROR - Command failed
**/
EFI_STATUS
AhciSimpleCommand (
IN AHCI_CONTEXT *Ahci,
IN UINT8 Command
);
/**
Check whether there are available command slots.
@param[in] Ahci - SATA controller information structure
@retval TRUE if there is an available slot, FALSE otherwise.
**/
BOOLEAN
AhciHasFreeCmdSlot (
IN AHCI_CONTEXT *Ahci
);
/**
Waits untill given command(s) complete.
@param[in] Ahci - SATA controller information structure
@param[in] CmdMask - Command(s) mask
@retval EFI_SUCCESS - Command complete
@retval EFI_TIMEOUT - Timeout occured
@retval EFI_DEVICE_ERROR - Error occurred on device side.
@retval EFI_NOT_STARTED - The RapidStart Entry flow should be canceled and do S3 resume back to OS
**/
EFI_STATUS
AhciWaitComplete (
IN AHCI_CONTEXT *Ahci,
IN UINT32 CmdMask
);
/**
Waits for all AHCI commands completed.
@param[in] Ahci - SATA controller information structure
@retval EFI_SUCCESS - All AHCI commands have completed
@retval EFI_TIMEOUT - Timeout occured
@retval EFI_DEVICE_ERROR - Error occurred on device side.
@retval EFI_NOT_STARTED - The RapidStart Entry flow should be canceled and do S3 resume back to OS
**/
EFI_STATUS
AhciWaitAllComplete (
IN AHCI_CONTEXT *Ahci
);
/**
Sends Identify Device ATA command to port
@param[in] Ahci - SATA controller information structure
@param[out] Buffer - Buffer to store device information
@retval EFI_SUCCESS - function executed successfully
@retval EFI_TIMEOUT - Timeout occured
@retval EFI_DEVICE_ERROR - Command failed
**/
EFI_STATUS
AhciIdentifyDevice (
IN AHCI_CONTEXT *Ahci,
OUT VOID *Buffer
);
/**
Performs TRIM command on given LBA range
@param[in] Ahci - SATA controller information structure
@param[in] Lba - First block to be trimmed
@param[in] Count - Number of blocks to trim
@retval EFI_SUCCESS - fucntion executed successfully
@retval EFI_TIMEOUT - Timeout occured
@exception EFI_UNSUPPORTED - TRIM is not supported by the device
@retval EFI_DEVICE_ERROR - Command failed
**/
EFI_STATUS
AhciTrimRange (
IN AHCI_CONTEXT *Ahci,
IN UINT64 Lba,
IN UINT32 Count
);
/**
Unlocks ATA device.
@param[in] Ahci - SATA controller information structure
@param[in] Password - security credential
@retval EFI_SUCCESS - Command executed successfully
@retval EFI_SECURITY_VIOLATION - Device security lock freeze
@exception EFI_UNSUPPORTED - Security is not supported by the device
@retval EFI_TIMEOUT - Timeout occured
@retval EFI_DEVICE_ERROR - Command failed
**/
EFI_STATUS
AhciSecurityUnlock (
IN AHCI_CONTEXT *Ahci,
IN CHAR8 *Password
);
/**
Hybrid Hard Disk Support.
@param[in] Ahci - SATA controller information structure
@retval EFI_SUCCESS - fucntion executed successfully
@retval EFI_TIMEOUT - Timeout occured
@exception EFI_UNSUPPORTED - TRIM is not supported by the device
@retval EFI_DEVICE_ERROR - Command failed
**/
EFI_STATUS
AhciHybridHardDiskSupport (
IN AHCI_CONTEXT *Ahci
);
#endif
|