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
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
|
/** @file
Header file for chipset IDER 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 _IDER_ATA_CONTROLLER_H
#define _IDER_ATA_CONTROLLER_H
#include "pci22.h"
#include "AmtLib.h"
#include "MeAccess.h"
//
// Constant definition
//
#include EFI_PROTOCOL_DEFINITION (PciIo)
#include EFI_PROTOCOL_DEFINITION (IdeControllerInit)
#include EFI_PROTOCOL_CONSUMER (PciRootBridgeIo)
#include EFI_PROTOCOL_DEFINITION (IderControllerDriver)
//
// Global Variables definitions
//
extern EFI_COMPONENT_NAME_PROTOCOL mIdeRControllerName;
extern EFI_DRIVER_BINDING_PROTOCOL mIdeRControllerDriverBinding;
//
// Symbol definition, for PCI IDE configuration field
//
#define PCI_SUB_CLASS_IDE 0x01
#define IDER_MAX_CHANNEL 0x01 ///< Max channels number of single sata controller
#define IDER_MAX_DEVICES 0x02 ///< Max devices number of single sata channel
#define IDER_ENUMER_ALL TRUE
//
// PIO and DMA Mode Timing and Control Registers definition
//
#define PCI_COMMAND_REGISTER 0x04
#define PCI_BUS_MASTER_IDE_BASE 0x20
#define IDE_TIMING_REGISTER_1 0x40
#define IDE_TIMING_REGISTER_2 0x42
#define IDE_SLAVE_TIMING_REGISTER 0x44
#define ULTRA_DMA_CONTROL_REGISTER 0x48
#define ULTRA_DMA_TIMING_REGISTER 0x4A
#define IDE_IO_CONFIG_REGISTER 0x54
#define R_PCI_SVID 0x2C
//
// IDE Register Field definition
//
#define ENABLE_DECODE_PRIMARY 0x8000
#define BME_BUS_MASTER_ENABLE_BIT BIT2
//
// Ide Timing Register 1/2 Field offset 0x40-41 / 0x42-43
//
#define DTE0_DRIVE_0_DMA_TIMING_ENABLE bit3
#define DTE1_DRIVE_1_DMA_TIMING_ENABLE bit7
//
// UDMA Control Register field offset 0x48
//
#define PSDE0_PRIMARY_DRIVE_0_UDMA_ENABLE bit0
#define PSDE1_PRIMARY_DRIVE_1_UDMA_ENABLE bit1
#define SSDE0_SECONDARY_DRIVE_0_UDMA_ENABLE bit2
#define SSDE1_SECONDARY_DRIVE_1_UDMA_ENABLE bit3
//
// UDMA Timing Register
//
#define CT4_RP6 0x00
#define CT3_RP5 0x01
#define CT2_RP4 0x02
#define CT3_RP8 0x01
#define CT2_RP8 0x02
#define CT3_RP16 0x01
//
// Ide I/O Configuration Register Field offset 0x54
//
#define PCB0_PRIMARY_DRIVE_0_BASE_CLOCK bit0
#define PCB1_PRIMARY_DRIVE_1_BASE_CLOCK bit1
#define SCB0_SECONDARY_DRIVE_0_BASE_CLOCK bit2
#define SCB1_SECONDARY_DRIVE_1_BASE_CLOCK bit3
#define ATA_FAST_PCB0_PRIMARY_DRIVE_0 bit12
#define ATA_FAST_PCB1_PRIMARY_DRIVE_1 bit13
#define ATA_FAST_SCB0_SECONDARY_DRIVE_0 bit14
#define ATA_FAST_SCB1_SECONDARY_DRIVE_1 bit15
//
// PCH timing register structure
//
#pragma pack(1)
typedef struct _IDER_TIMING_REG {
//
// PIO/MDMA/SDMA timing control for drive 0
//
UINT16 Time0 : 1;
UINT16 Ie0 : 1;
UINT16 Ppe0 : 1;
UINT16 Dte0 : 1;
//
// PIO/MDMA/SDMA timing control for drive 1
//
UINT16 Time1 : 1;
UINT16 Ie1 : 1;
UINT16 Ppe1 : 1;
UINT16 Dte1 : 1;
//
// PIO/MDMA/SDMA timing
//
UINT16 RecoveryTime : 2;
UINT16 Reserved0 : 2;
UINT16 IoRdySample : 2;
UINT16 Sitre : 1;
UINT16 IdeDecode : 1;
} IDER_TIMING_REG;
typedef struct _IDER_SLAVE_TIMING_REG {
//
// PIO/MDMA/SDMA timing control for primary slave device
//
UINT16 PrimaryRecoveryTime : 2;
UINT16 PrimaryIoRdySample : 2;
//
// PIO/MDMA/SDMA timing control for secondary slave device
//
UINT16 SecondaryRecoveryTime : 2;
UINT16 SecondaryIoRdySample : 2;
} IDER_SLAVE_TIMING_REG;
#pragma pack()
#define IDER_CONTROLLER_SIGNATURE EFI_SIGNATURE_32 ('I', 'D', 'E', 'R')
///
/// Ide controller driver private data structure
///
typedef struct _EFI_IDE_CONTROLLER_PRIVATE_DATA {
///
/// Standard signature used to identify Ide 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 Ide 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[IDER_MAX_CHANNEL][IDER_MAX_DEVICES];
///
/// A copy of EFI_IDENTIFY_DATA data for each attached Ide device and its flag
///
EFI_IDENTIFY_DATA IdentifyData[IDER_MAX_CHANNEL][IDER_MAX_DEVICES];
BOOLEAN IdentifyValid[IDER_MAX_CHANNEL][IDER_MAX_DEVICES];
} EFI_IDE_CONTROLLER_PRIVATE_DATA;
#define IDE_CONTROLLER_PRIVATE_DATA_FROM_THIS(a) \
CR ( \
a, \
EFI_IDE_CONTROLLER_PRIVATE_DATA, \
IdeInit, \
IDER_CONTROLLER_SIGNATURE \
)
//
// IDE-R controller IDE_CONTROLLER_INIT protocol 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[in] Enabled TRUE if the channel is enabled. If the channel is disabled,
then it will no be enumerated.
@param[in] 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 Information copied
@retval EFI_INVALID_PARAMETER Invalid channel
**/
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[in] Channel Channel number (0 based, either 0 or 1)
@retval EFI_SUCCESS Preparation done
@retval EFI_INVALID_PARAMETER Invalid channel
@exception EFI_UNSUPPORTED Invalid phase
**/
EFI_STATUS
EFIAPI
IdeInitNotifyPhase (
IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This,
IN EFI_IDE_CONTROLLER_ENUM_PHASE Phase,
IN 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 Data submitted
@retval EFI_INVALID_PARAMETER Invalid channel
**/
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 Disqulified Modes recorded
@retval EFI_INVALID_PARAMETER Invalid channel or invalid BadModes pointer
**/
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] SupportedModes Modes collection supported by IDE device
@retval EFI_SUCCESS Disqulified Modes recorded
@retval EFI_INVALID_PARAMETER Invalid channel or invalid SupportedModes pointer
@retval EFI_NOT_READY IdentifyData is not valid
@retval EFI_OUT_OF_RESOURCES Unable to allocate necessary data structures
**/
EFI_STATUS
EFIAPI
IdeInitCalculateMode (
IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This,
IN UINT8 Channel,
IN UINT8 Device,
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 IDE device mode
@retval EFI_SUCCESS Disqulified Modes recorded
@retval EFI_INVALID_PARAMETER Invalid channel or invalid Modes pointer
@retval EFI_NOT_READY IdentifyData is not valid
@exception EFI_UNSUPPORTED Failed to set PIO/MDMA/SDMA timing
**/
EFI_STATUS
EFIAPI
IdeInitSetTiming (
IN EFI_IDE_CONTROLLER_INIT_PROTOCOL *This,
IN UINT8 Channel,
IN UINT8 Device,
IN EFI_ATA_COLLECTIVE_MODE *Modes
)
;
//
// IDE-R Controller Binding protocol 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 Have device to support
@retval EFI_NOT_FOUND Relative environment not ready
@exception EFI_UNSUPPORTED The device doesn't support
**/
EFI_STATUS
EFIAPI
IdeRControllerSupported (
IN EFI_DRIVER_BINDING_PROTOCOL *This,
IN EFI_HANDLE Controller,
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
)
;
/**
This routine is called right after the .Supported() called and return
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 driver ready and initial complete.
@retval EFI_OUT_OF_RESOURCES Unable to allocate necessary data structures
@retval EFI_DEVICE_ERROR The device doesn't initial.
**/
EFI_STATUS
EFIAPI
IdeRControllerStart (
IN EFI_DRIVER_BINDING_PROTOCOL *This,
IN EFI_HANDLE Controller,
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath
)
;
/**
Stop.
@param[in] This Pointer to driver binding protocol
@param[in] Controller Controller handle to connect
@param[in] NumberOfChildren Number of children handle created by this driver
@param[in] ChildHandleBuffer Buffer containing child handle created
@retval EFI_SUCCESS Driver disconnected successfully from controller
@exception EFI_UNSUPPORTED Cannot find BIOS_VIDEO_DEV structure
**/
EFI_STATUS
EFIAPI
IdeRControllerStop (
IN EFI_DRIVER_BINDING_PROTOCOL *This,
IN EFI_HANDLE Controller,
IN UINTN NumberOfChildren,
IN EFI_HANDLE *ChildHandleBuffer
)
;
#endif // _IDER_ATA_CONTROLLER_H
|
