summaryrefslogtreecommitdiff
path: root/Core/EM/IdeBus/IdePowerManagement.c
blob: 4275d294b4185147d28728de392906e79e3ff25d (plain)
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
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
//**********************************************************************
//**********************************************************************
//**                                                                  **
//**        (C)Copyright 1985-2010, American Megatrends, Inc.         **
//**                                                                  **
//**                       All Rights Reserved.                       **
//**                                                                  **
//**         5555 Oakbrook Pkwy, Suite 200, Norcross, GA 30093        **
//**                                                                  **
//**                       Phone: (770)-246-8600                      **
//**                                                                  **
//**********************************************************************
//**********************************************************************
// $Header: /Alaska/SOURCE/Core/Modules/IdeBus/IdePowerManagement.c 11    10/11/10 11:32a Krishnakumarg $
//
// $Revision: 11 $
//
// $Date: 10/11/10 11:32a $
//**********************************************************************
// Revision History
// ----------------
// $Log: /Alaska/SOURCE/Core/Modules/IdeBus/IdePowerManagement.c $
// 
// 11    10/11/10 11:32a Krishnakumarg
// [TAG] - EIP 43249
// [Category] - IMPROVEMENT
// [Severity] - Minor
// [Symptom]  - Non-Ascii character in comments causing build problem in
// japanese XP
// [RootCause]- Presence of Non-Ascii character
// [Solution] -  Remove Non-Ascii character present in the file
// [Files] - IdeSecurity.c,IDESMM.c, InstallIdeSmi, Ata.c, Atapi.c,
// IDEBusComponentName.c, IdeBusMaster.c, IdeHPA.c, IdePowerManagement.c
// 
// 10    8/25/10 4:10a Rameshr
// New Feature: EIP 37748
// Description: Move all the IDEBus Source driver SDL token into IdeBus
// Bin Driver.
// FilesModified: Ata.c, Atapi.c, idebus.c, IdeBus.h,
// IdebuscomponentName.c, IdeBusmaster.c IdeBusSrc.mak IdebusSrc.sdl
// IdeHpa.c, IdePowerManagement.c
// 
// 9     8/31/09 10:40a Felixp
// IDLE_CMD is used instead of STANDBY_CMD if standby time is zero to
// avoid HDD spin up and down-EIP 22135
// 

// 
// 6     7/01/09 12:23p Rameshr
// Coding Standard and File header updated.
// 
// 5     13/04/07 3:05p Anandakrishnanl
// Ide Bus Module - Update source files to comply with AMI coding
// standard"!!!
// 
// 4     1/09/06 11:36a Felixp
// 
// 2     12/14/05 3:10p Srinin
// 
// 1     12/01/05 9:43a Felixp
// 
// 4     3/04/05 11:35a Mandal
// 
// 3     1/18/05 3:22p Felixp
// PrintDebugMessage renamed to Trace
// 
// 1     1/11/05 2:26p Srinin
// IDE Power Management Support added.
// 
// 
//<AMI_FHDR_START>
//---------------------------------------------------------------------------
//
// Name: IDEPOWERMANAGEMENT.c
//
// Description:	IDE Power Management Support
//
//---------------------------------------------------------------------------
//<AMI_FHDR_END>

#include "IdeBus.h"
#include <Protocol\IdeBusBoard.h>

//
//External variables
//
extern PLATFORM_IDE_PROTOCOL    *gPlatformIdeProtocol;
extern EFI_GUID                 gPowerMgmtProtocolGuid;

//<AMI_PHDR_START>
//---------------------------------------------------------------------------
//
// Procedure:	InitIDEPowerManagement
//
// Description:	Initializes IDE power Management
//
// Input:
//	IDE_BUS_PROTOCOL			*IdeBusInterface;
//
// Output:
//	EFI_STATUS
//
// Modified:
//      
// Referrals: ConfigureIdeDevice
//
// Notes:	
//
//
//---------------------------------------------------------------------------
//<AMI_PHDR_END>

EFI_STATUS
InitIDEPowerManagement (
	IN IDE_BUS_PROTOCOL			    *IdeBusInterface
 )
{

	UINT8							bData = 0;
	EFI_STATUS						Status = EFI_SUCCESS;

    //
    //Check if POWER Managmentfeature is enabled
    //
	if	(IdeBusInterface->IdeDevice.IdentifyData.Command_Set_Enabled_85 & 0x8) {

    //
    //Enable/Disable STANDBY Timer
    //
		    bData = ConvertStanbyTimeoutValue ((UINT8)gPlatformIdeProtocol->StandbyTimeout);
            if ( (gPlatformIdeProtocol->StandbyTimeout) == 0 ) {
		        Status = IdeNonDataCommand (
					     IdeBusInterface,
    					 0,				// Features
				    	 bData,			// Sector Count
    					 0, 			// LBA Low
				    	 0,				// LBA Mid
					     0,				// LBA High
    					 IdeBusInterface->IdeDevice.Device << 4,	// Device
                         IDLE_CMD);     // IDLE_CMD when StandbyTimeout = 0
            } else {
    		    Status = IdeNonDataCommand (
				    	 IdeBusInterface,
					     0,				// Features
    					 bData,			// Sector Count
				    	 0,				// LBA Low
    					 0,				// LBA Mid
				         0,				// LBA High
				  	     IdeBusInterface->IdeDevice.Device << 4,	// Device
                         STANDBY_CMD);	// STANDBY_CMD when StandbyTimeout > 0
           }
            //
            //Enable/Disable STANDBY Timer
            //

	}

    //
    //Check Advanced Power Management Mode
    //
    if ( gPlatformIdeProtocol->AdvPowerManagementSupport ) {
    	if	(IdeBusInterface->IdeDevice.IdentifyData.Command_Set_Supported_83 & 0x8){
            //
            //Enable/Disable Advanced Power Management
            //
	    	bData = ( gPlatformIdeProtocol->AdvPowerManagementLevel ) == 0 ? DISABLE_ADV_POWER_MANAGEMENT : ADV_POWER_MANAGEMENT;
	    	IdeSetFeatureCommand (IdeBusInterface, bData, gPlatformIdeProtocol->AdvPowerManagementLevel );
	    }
    }


    if ( gPlatformIdeProtocol->PowerupInStandbySupport ) {
        //
        //Check Power-up in Standby Mode Support
        //    
    	if	(IdeBusInterface->IdeDevice.IdentifyData.Command_Set_Supported_83 & 0x20){
            //
            //Check if the desires state is already present or not
            //
    		if	(!((IdeBusInterface->IdeDevice.IdentifyData.Command_Set_Enabled_86 & 0x20)  == (gPlatformIdeProtocol->PowerupInStandbyMode))){
    			bData = ( gPlatformIdeProtocol->PowerupInStandbyMode ) == 0 ? DISABLE_POWERUP_IN_STANDBY : ENABLE_POWERUP_IN_STANDBY;			
    			IdeSetFeatureCommand (IdeBusInterface, bData, 0);
    		}
    	}
    }

	return EFI_SUCCESS;
}

//<AMI_PHDR_START>
//---------------------------------------------------------------------------
//
// Procedure:	InstallIDEPowerMgmtInterface
//
// Description:	Install  IDE power Management Interface
//
// Input:
//	IDE_BUS_PROTOCOL			*IdeBusInterface;
//
// Output:
//	EFI_STATUS
//
// Modified:
//      
// Referrals: IdeBusStart
//
// Notes:	
//
//---------------------------------------------------------------------------
//<AMI_PHDR_END>

EFI_STATUS
InstallIDEPowerMgmtInterface (
	IN IDE_BUS_PROTOCOL			    *IdeBusInterface
 )
{

	EFI_STATUS 		                Status = EFI_UNSUPPORTED;
	POWER_MGMT_INTERFACE	        *PowerMgmtInterface;


    //
    //Check if Power Management is Supported or not	
    //
	if	(IdeBusInterface->IdeDevice.IdentifyData.Command_Set_Enabled_85 & 0x8){
		Status = pBS->AllocatePool (EfiBootServicesData,
					sizeof (POWER_MGMT_INTERFACE),
			  	    (VOID**)&PowerMgmtInterface);
		if (EFI_ERROR(Status)) return Status;

		PowerMgmtInterface->CheckPowerMode          = CheckPowerMode;				
		PowerMgmtInterface->IdleMode                = IdleMode;				
		PowerMgmtInterface->StandbyMode             = StandbyMode;				
		PowerMgmtInterface->AdvancePowerMgmtMode    = AdvancePowerMgmtMode;				
		PowerMgmtInterface->IdeBusInterface         = IdeBusInterface;				
		IdeBusInterface->PowerMgmtInterface         = PowerMgmtInterface;				

        //
        //Install the protocol on the device
        //
		Status = pBS->InstallMultipleProtocolInterfaces (
					&(IdeBusInterface->IdeDeviceHandle),
					&gPowerMgmtProtocolGuid, IdeBusInterface->PowerMgmtInterface,
					NULL);

		if (EFI_ERROR(Status)) pBS->FreePool(PowerMgmtInterface);
	}

	return Status;
}

//<AMI_PHDR_START>
//---------------------------------------------------------------------------
//
// Procedure:	StopIDEPowerMgmtInterface
//
// Description:	Uninstall  IDE power Management Interface
//
// Input:
//	IDE_BUS_PROTOCOL			*IdeBusInterface;
//
// Output:
//	EFI_STATUS
//
// Modified:
//      
// Referrals: IdeBusStop
//
// Notes:	
//
//
//---------------------------------------------------------------------------
//<AMI_PHDR_END>

EFI_STATUS
StopIDEPowerMgmtInterface (
	IN IDE_BUS_PROTOCOL			    *IdeBusInterface
 )
{

	EFI_STATUS 			            Status;
	POWER_MGMT_INTERFACE            *PowerMgmtInterface = IdeBusInterface->PowerMgmtInterface;

	if (IdeBusInterface->PowerMgmtInterface == NULL) return EFI_SUCCESS;
	Status = pBS->UninstallMultipleProtocolInterfaces (
					IdeBusInterface->IdeDeviceHandle,
					&gPowerMgmtProtocolGuid, IdeBusInterface->PowerMgmtInterface,
					NULL);
	if (Status == EFI_SUCCESS) {
		pBS->FreePool(IdeBusInterface->PowerMgmtInterface);
		IdeBusInterface->PowerMgmtInterface = NULL;
	}

	return Status;
}
 //IDE_POWER_MANAGEMENT_INTERFACE_SUPPORT ends

//<AMI_PHDR_START>
//---------------------------------------------------------------------------//
// Procedure:	ConvertStanbyTimeoutValue
//
// Description:	Initializes IDE power Managment
//
// Input:
//	IN UINT8		StandbyTimeout (In Minutes)
//
// Output:
//	UINT8		StandbyTimeout  (Converted Timeout period)
//
// Modified:
//      
// Referrals: 
//
// Notes:	
//
//
//---------------------------------------------------------------------------
//<AMI_PHDR_END>

UINT8
ConvertStanbyTimeoutValue (
	IN UINT8	                    StandbyTimeout
 )
{

	if ( StandbyTimeout ) {
		if ( StandbyTimeout < 30 ) {
			if ( StandbyTimeout > 20 ) { 
				StandbyTimeout = 20;	
			}
			return StandbyTimeout * 60 / 5;
		}
		if ( StandbyTimeout < 16 * 30 ) {
			return StandbyTimeout / 30;			
		}
	}
	return 0;							// Standby Timer Disabled

}

//<AMI_PHDR_START>
//---------------------------------------------------------------------------
//
// Procedure:	CheckPowerMode
//
// Description:	Returns the Current State of the device
//
// Input:
//	
//
// Output:
//	EFI_STATUS, Current state of the Device, 
//
// Modified:
//      
// Referrals: 
//
// Notes:	PowerMode : 00 Standby Mode, 80h : Idle Mode, FF : Active/Idle Mode
//
//
//---------------------------------------------------------------------------
//<AMI_PHDR_END>

EFI_STATUS
CheckPowerMode (
	IN IDE_POWER_MGMT_INTERFACE		*IdePowerMgmtInterface,
	IN OUT UINT8					*PowerMode
 )
{
	EFI_STATUS					    Status;
	IDE_BUS_PROTOCOL			    *IdeBusInterface = ((POWER_MGMT_INTERFACE *)IdePowerMgmtInterface)->IdeBusInterface;

	Status = IdeNonDataCommand (
				IdeBusInterface,
				0,				// Features
				0,				// SectorCount
				0,				// LBA Low
				0,				// LBA Mid
				0,				// LBA High
				IdeBusInterface->IdeDevice.Device << 4,	// Device
				CHECK_POWER_MODE);		// Command

	if (Status == EFI_SUCCESS) {		
		IdeReadByte ( IdeBusInterface->PciIO,  
					  IdeBusInterface->IdeDevice.Regs.CommandBlock.SectorCountReg,
					  PowerMode);
    }		

	return Status;

}


//<AMI_PHDR_START>
//---------------------------------------------------------------------------
//
// Procedure:	IdleMode
//
// Description:	Puts the device in Idle Mode
//
// Input:	StandbyTimeout : Value in Minutes. (0 : Disabled)
//	
// Output:
//	EFI_STATUS
//
// Modified:
//      
// Referrals: 
//
// Notes:	
//
//
//---------------------------------------------------------------------------
//<AMI_PHDR_END>

EFI_STATUS
IdleMode(
	IN IDE_POWER_MGMT_INTERFACE		*IdePowerMgmtInterface,
	IN UINT8						StandbyTimeout
 )
{
	EFI_STATUS					    Status;
	IDE_BUS_PROTOCOL			    *IdeBusInterface = ((POWER_MGMT_INTERFACE *)IdePowerMgmtInterface)->IdeBusInterface;
	UINT8						    bData;

	bData = ConvertStanbyTimeoutValue (StandbyTimeout);
	Status = IdeNonDataCommand (
				IdeBusInterface,
				0,				// Features
				bData,			// SectorCount
				0,				// LBA Low
				0,				// LBA Mid
				0,				// LBA High
				IdeBusInterface->IdeDevice.Device << 4,	// Device
				IDLE_CMD);		// Command

	return Status;

}


//<AMI_PHDR_START>
//---------------------------------------------------------------------------
//
// Procedure:	StandbyMode
//
// Description:	Puts the device in StandbyMode
//
// Input:	StandbyTimeout : Value in Minutes. (0 : Disabled)
//	
// Output:
//	EFI_STATUS
//
// Modified:
//      
// Referrals: 
//
// Notes:	
//
//---------------------------------------------------------------------------
//<AMI_PHDR_END>

EFI_STATUS
StandbyMode(
	IN IDE_POWER_MGMT_INTERFACE		*IdePowerMgmtInterface,
	IN UINT8						StandbyTimeout
 )
{
	EFI_STATUS					    Status;
	IDE_BUS_PROTOCOL			    *IdeBusInterface = ((POWER_MGMT_INTERFACE *)IdePowerMgmtInterface)->IdeBusInterface;
	UINT8						    bData;

	bData = ConvertStanbyTimeoutValue (StandbyTimeout);
	Status = IdeNonDataCommand (
				IdeBusInterface,
				0,				// Features
				bData,			// SectorCount
				0,				// LBA Low
				0,				// LBA Mid
				0,				// LBA High
				IdeBusInterface->IdeDevice.Device << 4,	// Device
				STANDBY_CMD);		// Command

	return Status;

}

//<AMI_PHDR_START>
//---------------------------------------------------------------------------
//
// Procedure:	AdvancePowerMgmtMode
//
// Description:	Enables Adavance Power Management
//
// Input:	AdvPowerMgmtLevel ( 0 : Disable, FEh : Max. Performance, 81h - FDh Intermediate performance without Standby
//								80h : Min. Power Consumption without Standby, 02h - 7Fh Intermediate Performance with Standby
//								01h : Min. Power Consumption with Standby)
//	
// Output:
//	EFI_STATUS
//
// Modified:
//      
// Referrals: 
//
// Notes:	
//
//---------------------------------------------------------------------------
//<AMI_PHDR_END>
EFI_STATUS
AdvancePowerMgmtMode(
	IN IDE_POWER_MGMT_INTERFACE		*IdePowerMgmtInterface,
	IN UINT8						AdvPowerMgmtLevel
 )
{
	EFI_STATUS					    Status = EFI_UNSUPPORTED;
	IDE_BUS_PROTOCOL                *IdeBusInterface = ((POWER_MGMT_INTERFACE *)IdePowerMgmtInterface)->IdeBusInterface;
	UINT8						    bData;

	if	(IdeBusInterface->IdeDevice.IdentifyData.Command_Set_Supported_83 & 0x8){
        //    
        //Enable/Disable Advanced Power Management
        //
		bData = AdvPowerMgmtLevel == 0 ? DISABLE_ADV_POWER_MANAGEMENT : ADV_POWER_MANAGEMENT;
		Status = IdeSetFeatureCommand (IdeBusInterface, bData, AdvPowerMgmtLevel);
	}

	return Status;

}


//**********************************************************************
//**********************************************************************
//**                                                                  **
//**        (C)Copyright 1985-2010, American Megatrends, Inc.         **
//**                                                                  **
//**                       All Rights Reserved.                       **
//**                                                                  **
//**         5555 Oakbrook Pkwy, Suite 200, Norcross, GA 30093        **
//**                                                                  **
//**                       Phone: (770)-246-8600                      **
//**                                                                  **
//**********************************************************************
//**********************************************************************
//**********************************************************************