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
|
/** @file
Header file for chipset Serial ATA controller driver.
@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 _SERIAL_ATA_CONTROLLER_H_
#define _SERIAL_ATA_CONTROLLER_H_
//
// External include files do NOT need to be explicitly specified in real EDKII
// environment
//
#if !defined(EDK_RELEASE_VERSION) || (EDK_RELEASE_VERSION < 0x00020000)
#include "EdkIIGlueDxe.h"
#include "pci22.h"
#include "EFIScriptLib.h"
#include EFI_PROTOCOL_PRODUCER (IdeControllerInit)
#include EFI_PROTOCOL_CONSUMER (PciIo)
#include "PchAccess.h"
#include "PchPlatformLib.h"
#endif
//
// Global Variables definitions
//
extern EFI_DRIVER_BINDING_PROTOCOL mSataControllerDriverBinding;
extern EFI_COMPONENT_NAME_PROTOCOL mSataControllerName;
extern UINTN mPchGpioBase;
///
/// {BB929DA9-68F7-4035-B22C-A3BB3F23DA55}
///
///
/// Define the protocol GUID
///
/// Only EdkII defines EDK_RELEASE_VERSION as 0x00020000
///
#if (EDK_RELEASE_VERSION != 0x00020000)
#define PCH_SATA_CONTROLLER_DRIVER_GUID \
{ \
0xbb929da9, 0x68f7, 0x4035, 0xb2, 0x2c, 0xa3, 0xbb, 0x3f, 0x23, 0xda, 0x55 \
};
#else
#define PCH_SATA_CONTROLLER_DRIVER_GUID \
{ \
0xbb929da9, 0x68f7, 0x4035, \
{ \
0xb2, 0x2c, 0xa3, 0xbb, 0x3f, 0x23, 0xda, 0x55 \
} \
};
#endif
#define PCH_SATA_ENUMER_ALL FALSE
#define PCH_SATA_MASTER_DRIVE 0x00
#define PCH_SATA_SLAVE_DRIVE 0x01
///
/// SATA controller driver private data structure
///
#define SATA_CONTROLLER_SIGNATURE EFI_SIGNATURE_32 ('S', 'A', 'T', 'A')
typedef struct _EFI_SATA_CONTROLLER_PRIVATE_DATA {
///
/// Standard signature used to identify SATA controller private data
///
UINT32 Signature;
///
/// Protocol instance of IDE_CONTROLLER_INIT produced by this driver
///
EFI_IDE_CONTROLLER_INIT_PROTOCOL IdeInit;
///
/// copy of protocol pointers used by this driver
///
EFI_PCI_IO_PROTOCOL *PciIo;
///
/// The highest disqulified mode for each attached SATA device.
/// Per ATA/ATAPI spec, if a mode is not supported, the modes higher than
/// it should not be supported
///
EFI_ATA_COLLECTIVE_MODE DisqulifiedModes[LPTH_AHCI_MAX_PORTS][PCH_IDE_1_MAX_DEVICES];
///
/// A copy of IDENTIFY data for each attached SATA device and its flag
///
EFI_IDENTIFY_DATA IdentifyData[LPTH_AHCI_MAX_PORTS][PCH_IDE_1_MAX_DEVICES];
BOOLEAN IdentifyValid[LPTH_AHCI_MAX_PORTS][PCH_IDE_1_MAX_DEVICES];
} EFI_SATA_CONTROLLER_PRIVATE_DATA;
#define SATA_CONTROLLER_PRIVATE_DATA_FROM_THIS(a) \
CR ( \
a, \
EFI_SATA_CONTROLLER_PRIVATE_DATA, \
IdeInit, \
SATA_CONTROLLER_SIGNATURE \
)
//
// Driver binding functions declaration
//
/**
This function checks to see if the driver supports a device specified by
"Controller handle" parameter. It is called by DXE Core StartImage() or
ConnectController() routines. The driver uses 'device path' and/or
'services' from the Bus I/O abstraction attached to the controller handle
to determine if the driver support this controller handle.
Note: In the BDS (Boot Device Selection) phase, the DXE core enumerate all
devices (or, controller) and assigns GUIDs to them.
@param[in] This A pointer points to the Binding Protocol instance
@param[in] Controller The handle of controller to be tested.
@param[in] RemainingDevicePath A pointer to the device path. Ignored by device
driver but used by bus driver
@retval EFI_SUCCESS The device is supported
@exception EFI_UNSUPPORTED The device is not supported
**/
EFI_STATUS
EFIAPI
SataControllerSupported (
IN EFI_DRIVER_BINDING_PROTOCOL *This,
IN EFI_HANDLE Controller,
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
);
/**
This routine is called right after the .Supported() is called and returns
EFI_SUCCESS. Notes: The supported protocols are checked but the Protocols
are closed.
@param[in] This A pointer points to the Binding Protocol instance
@param[in] Controller The handle of controller to be tested. Parameter
passed by the caller
@param[in] RemainingDevicePath A pointer to the device path. Should be ignored by
device driver
@retval EFI_SUCCESS The device is started
@retval Other values Something error happened
**/
EFI_STATUS
EFIAPI
SataControllerStart (
IN EFI_DRIVER_BINDING_PROTOCOL *This,
IN EFI_HANDLE Controller,
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
);
/**
Stop managing the target device
@param[in] This A pointer pointing to the Binding Protocol instance
@param[in] Controller The handle of controller to be stopped
@param[in] NumberOfChildren Number of child devices
@param[in] ChildHandleBuffer Buffer holding child device handles
@retval EFI_SUCCESS The target device is stopped
**/
EFI_STATUS
EFIAPI
SataControllerStop (
IN EFI_DRIVER_BINDING_PROTOCOL *This,
IN EFI_HANDLE Controller,
IN UINTN NumberOfChildren,
IN EFI_HANDLE *ChildHandleBuffer
);
//
// IDE controller init functions declaration
//
/**
This function can be used to obtain information about a specified channel.
It's usually used by IDE Bus driver during enumeration process.
@param[in] This the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
@param[in] Channel Channel number (0 based, either 0 or 1)
@param[out] Enabled TRUE if the channel is enabled. If the channel is disabled,
then it will no be enumerated.
@param[out] MaxDevices The Max number of IDE devices that the bus driver can expect
on this channel. For ATA/ATAPI, this number is either 1 or 2.
@retval EFI_SUCCESS Function completes successfully
@retval Other Values Something error happened
@retval EFI_INVALID_PARAMETER The Channel parameter is invalid
**/
EFI_STATUS
EFIAPI
IdeInitGetChannelInfo (
IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This,
IN UINT8 Channel,
OUT BOOLEAN *Enabled,
OUT UINT8 *MaxDevices
);
/**
This function is called by IdeBus driver before executing certain actions.
This allows IDE Controller Init to prepare for each action.
@param[in] This the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
@param[in] Phase phase indicator defined by IDE_CONTROLLER_INIT protocol
@param[out] Channel Channel number (0 based, either 0 or 1)
@retval EFI_SUCCESS Function completes successfully
@retval EFI_INVALID_PARAMETER Channel parameter is out of range
@exception EFI_UNSUPPORTED Phase is not supported
**/
EFI_STATUS
EFIAPI
IdeInitNotifyPhase (
IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This,
IN EFI_IDE_CONTROLLER_ENUM_PHASE Phase,
OUT UINT8 Channel
);
/**
This function is called by IdeBus driver to submit EFI_IDENTIFY_DATA data structure
obtained from IDE deivce. This structure is used to set IDE timing
@param[in] This the EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
@param[in] Channel IDE channel number (0 based, either 0 or 1)
@param[in] Device IDE device number
@param[in] IdentifyData A pointer to EFI_IDENTIFY_DATA data structure
@retval EFI_SUCCESS Function completes successfully
@retval EFI_INVALID_PARAMETER Channel or Device parameter is out of range
**/
EFI_STATUS
EFIAPI
IdeInitSubmitData (
IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This,
IN UINT8 Channel,
IN UINT8 Device,
IN EFI_IDENTIFY_DATA *IdentifyData
);
/**
This function is called by IdeBus driver to disqualify unsupported operation
mode on specfic IDE device
@param[in] This The EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
@param[in] Channel IDE channel number (0 based, either 0 or 1)
@param[in] Device IDE device number
@param[in] BadModes Operation mode indicator
@retval EFI_SUCCESS Function completes successfully
@retval EFI_INVALID_PARAMETER Channel parameter or Devicde parameter is out of range,
or BadModes is NULL
**/
EFI_STATUS
EFIAPI
IdeInitDisqualifyMode (
IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This,
IN UINT8 Channel,
IN UINT8 Device,
IN EFI_ATA_COLLECTIVE_MODE *BadModes
);
/**
This function is called by IdeBus driver to calculate the best operation mode
supported by specific IDE device
@param[in] This The EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
@param[in] Channel IDE channel number (0 based, either 0 or 1)
@param[in] Device IDE device number
@param[in, out] SupportedModes Modes collection supported by IDE device
@retval EFI_SUCCESS Function completes successfully
@retval EFI_INVALID_PARAMETER Channel parameter or Device parameter is out of range;
Or SupportedModes is NULL
@retval EFI_NOT_READY Identify data is not valid
@retval EFI_OUT_OF_RESOURCES SupportedModes is out of range
**/
EFI_STATUS
EFIAPI
IdeInitCalculateMode (
IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This,
IN UINT8 Channel,
IN UINT8 Device,
IN OUT EFI_ATA_COLLECTIVE_MODE **SupportedModes
);
/**
This function is called by IdeBus driver to set appropriate timing on IDE
controller according supported operation mode
@param[in] This The EFI_IDE_CONTROLLER_INIT_PROTOCOL instance.
@param[in] Channel IDE channel number (0 based, either 0 or 1)
@param[in] Device IDE device number
@param[in] Modes Operation modes
@retval EFI_SUCCESS This function always returns EFI_SUCCESS
**/
EFI_STATUS
EFIAPI
IdeInitSetTiming (
IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This,
IN UINT8 Channel,
IN UINT8 Device,
IN EFI_ATA_COLLECTIVE_MODE *Modes
);
#endif
|
