This repository has been archived by the owner on Jul 21, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
IOATAController.cpp
2919 lines (2209 loc) · 73.6 KB
/
IOATAController.cpp
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
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (c) 2000-2008 Apple, Inc. All rights reserved.
*
* @APPLE_LICENSE_HEADER_START@
*
* The contents of this file constitute Original Code as defined in and
* are subject to the Apple Public Source License Version 1.1 (the
* "License"). You may not use this file except in compliance with the
* License. Please obtain a copy of the License at
* http://www.apple.com/publicsource and read it before using this file.
*
* This Original Code and all software distributed under the License are
* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
* License for the specific language governing rights and limitations
* under the License.
*
* @APPLE_LICENSE_HEADER_END@
*/
/*
*
* IOATAController.cpp
*
*/
#include <IOKit/assert.h>
#include <IOKit/IOCommandGate.h>
#include <IOKit/IOTypes.h>
#include <IOKit/IOTimerEventSource.h>
#include <IOKit/storage/IOStorageProtocolCharacteristics.h>
#include "IOATATypes.h"
#include "IOATAController.h"
#include "IOATACommand.h"
#include "IOATADevice.h"
#include "IOATABusInfo.h"
#include "IOATADevConfig.h"
#include "IOATABusCommand.h"
#include "ATATimerEventSource.h"
#include <libkern/OSByteOrder.h>
#include <libkern/OSAtomic.h>
// for wait U8Status, loop time in uS
#define kStatusDelayTime 5
// how many times through the loop for a MS.
#define kStatusDelayLoopMS 1000 / kStatusDelayTime
#define _doubleBufferDesc reserved->_doubleBufferDesc
#ifdef DLOG
#undef DLOG
#endif
//#define ATA_DEBUG 1
#ifdef ATA_DEBUG
#define DLOG(fmt, args...) IOLog(fmt, ## args)
#else
#define DLOG(fmt, args...)
#endif
#pragma mark -IOService Overrides -
//---------------------------------------------------------------------------
#define super IOService
OSDefineMetaClass( IOATAController, IOService )
OSDefineAbstractStructors( IOATAController, IOService )
OSMetaClassDefineReservedUnused(IOATAController, 0);
OSMetaClassDefineReservedUnused(IOATAController, 1);
OSMetaClassDefineReservedUnused(IOATAController, 2);
OSMetaClassDefineReservedUnused(IOATAController, 3);
OSMetaClassDefineReservedUnused(IOATAController, 4);
OSMetaClassDefineReservedUnused(IOATAController, 5);
OSMetaClassDefineReservedUnused(IOATAController, 6);
OSMetaClassDefineReservedUnused(IOATAController, 7);
OSMetaClassDefineReservedUnused(IOATAController, 8);
OSMetaClassDefineReservedUnused(IOATAController, 9);
OSMetaClassDefineReservedUnused(IOATAController, 10);
OSMetaClassDefineReservedUnused(IOATAController, 11);
OSMetaClassDefineReservedUnused(IOATAController, 12);
OSMetaClassDefineReservedUnused(IOATAController, 13);
OSMetaClassDefineReservedUnused(IOATAController, 14);
OSMetaClassDefineReservedUnused(IOATAController, 15);
OSMetaClassDefineReservedUnused(IOATAController, 16);
OSMetaClassDefineReservedUnused(IOATAController, 17);
OSMetaClassDefineReservedUnused(IOATAController, 18);
OSMetaClassDefineReservedUnused(IOATAController, 19);
OSMetaClassDefineReservedUnused(IOATAController, 20);
//---------------------------------------------------------------------------
bool
IOATAController::init(OSDictionary * properties)
{
DLOG("IOATAController::init() starting\n");
// Initialize instance variables.
//
_workLoop = 0;
_cmdGate = 0;
_provider = 0;
_timer = 0;
queue_init( &_commandQueue );
if (super::init(properties) == false)
{
DLOG("IOATAController: super::init() failed\n");
return false;
}
DLOG("IOATAController::init() done\n");
return true;
}
/*---------------------------------------------------------------------------
*
* Check and see if we really match this device.
* override to accept or reject close matches based on further information
---------------------------------------------------------------------------*/
IOService*
IOATAController::probe(IOService* provider, SInt32* score)
{
return this;
}
/*---------------------------------------------------------------------------
*
* Override IOService start.
*
* Subclasses should override the start method, call the super::start
* first then add interrupt sources and probe their busses for devices
* and create device nubs as needed.
---------------------------------------------------------------------------*/
bool
IOATAController::start(IOService *provider)
{
OSObject * prop;
DLOG("IOATAController::start() begin\n");
_provider = provider;
_busState = IOATAController::kBusFree;
_currentCommand = 0L;
_selectedUnit = kATAInvalidDeviceID;
_queueState = IOATAController::kQueueOpen;
// call start on the superclass
if (!super::start(_provider))
{
DLOG("IOATAController: super::start() failed\n");
return false;
}
prop = getProperty ( kIOPropertyPhysicalInterconnectTypeKey, gIOServicePlane );
if ( prop == NULL )
{
setProperty ( kIOPropertyPhysicalInterconnectTypeKey, kIOPropertyPhysicalInterconnectTypeATA);
}
prop = getProperty ( kIOPropertyPhysicalInterconnectLocationKey, gIOServicePlane );
if ( prop == NULL )
{
setProperty ( kIOPropertyPhysicalInterconnectLocationKey, kIOPropertyInternalKey);
}
reserved = ( ExpansionData * ) IOMalloc ( sizeof ( ExpansionData ) );
if ( !reserved )
return false;
bzero ( reserved, sizeof ( ExpansionData ) );
if( !configureTFPointers() )
{
DLOG("IOATA TF Pointers failed\n");
return false;
}
if( !scanForDrives() )
{
DLOG("IOATA scan for drives failed\n");
return false;
}
// Allocate the double buffer for PIO (and non-aligned DMA if needed) transfers.
if(! allocateDoubleBuffer() )
{
DLOG("IOATA doubleBuffer alloc failed\n");
return false;
}
// a device specific subclass will create the work loop and attach
_workLoop = getWorkLoop();
if (!_workLoop)
{
DLOG("IOATA: IOWorkLoop allocation failed\n");
return false;
}
_workLoop->retain();
// create a timer event source and attach it to the work loop
_timer = ATATimerEventSource::ataTimerEventSource(this,
(ATATimerEventSource::Action) timeoutOccured);
if (!_timer || _workLoop->addEventSource(_timer))
{
DLOG("IOATA: ATATImerEventSource allocation failed\n");
return false;
}
// create a commandGate and attach it to the work loop.
_cmdGate = IOCommandGate::commandGate(this);
if (!_cmdGate || _workLoop->addEventSource(_cmdGate))
{
DLOG("IOATAController: IOCommandGate failed\n");
return false;
}
//3643376 make it easier for ASP to find disk drives in the system.
registerService();
DLOG("IOATAController::start() done\n");
return true;
}
/*---------------------------------------------------------------------------
* free() - the pseudo destructor. Let go of what we don't need anymore.
*
*
---------------------------------------------------------------------------*/
void
IOATAController::free()
{
if ( _workLoop )
{
if ( _cmdGate )
{
_workLoop->removeEventSource(_cmdGate);
_cmdGate = NULL;
}
if ( _timer )
{
_workLoop->removeEventSource(_timer);
_timer = NULL;
}
_workLoop->release();
}
if ( reserved )
{
if ( _doubleBufferDesc )
{
_doubleBufferDesc->complete();
_doubleBufferDesc->release();
_doubleBuffer.bufferSize = 0;
_doubleBuffer.logicalBuffer = 0;
_doubleBuffer.physicalBuffer = 0;
_doubleBufferDesc = NULL;
}
}
if ( reserved )
{
IOFree ( reserved, sizeof ( ExpansionData ) );
reserved = NULL;
}
super::free();
}
#pragma mark -initialization-
/*---------------------------------------------------------------------------
*
// false if couldn't allocate the per-bus double buffer.
// controllers should provide implementation where needed
// for DMA hardware compatibility. The default method provides
// a 4K buffer for PIO since MemoryDescriptors do not by default have
// logical addresses in the kernel space.
---------------------------------------------------------------------------*/
bool
IOATAController::allocateDoubleBuffer( void )
{
DLOG("IOATAController::allocateDoubleBuffer() started\n");
_doubleBufferDesc = IOBufferMemoryDescriptor::inTaskWithPhysicalMask(
kernel_task,
kIODirectionInOut | kIOMemoryPhysicallyContiguous,
(kATADefaultSectorSize * 8),
0xFFFFF000UL );
if ( !_doubleBufferDesc )
{
IOLog("%s: double buffer allocation failed\n", getName());
return false;
}
_doubleBufferDesc->prepare();
_doubleBuffer.logicalBuffer = (IOLogicalAddress)_doubleBufferDesc->getBytesNoCopy();
_doubleBuffer.physicalBuffer = _doubleBufferDesc->getPhysicalAddress();
_doubleBuffer.bufferSize = kATADefaultSectorSize * 8;
DLOG("IOATAController::allocateDoubleBuffer() done\n");
return true;
}
/*---------------------------------------------------------------------------
*
* Initialize the taskfile pointers to the addresses of the ATA registers
* in your hardware. Subclasses must provide implementation.
*
---------------------------------------------------------------------------*/
bool
IOATAController::configureTFPointers(void)
{
DLOG("IOATA: configureTFPointers. must provide implementation.\n");
return false;
}
#pragma mark -client interface-
/*---------------------------------------------------------------------------
*
* select the bus timing configuration for a particular device
* should be called by device driver after doing an identify device command and working out
* the desired timing configuration.
* should be followed by a Set Features comand to the device to set it in a
* matching transfer mode.
---------------------------------------------------------------------------*/
IOReturn
IOATAController::selectConfig( IOATADevConfig* configRequest, UInt32 unitNumber)
{
DLOG("IOATA: sublcass must implement selectConfig.\n");
return kATAModeNotSupported;
}
/*---------------------------------------------------------------------------
*
* Find out what the current bus timing configuration is for a particular
* device.
* Subclasses must implement
*
---------------------------------------------------------------------------*/
IOReturn
IOATAController::getConfig( IOATADevConfig* configOut, UInt32 unitNumber)
{
DLOG("IOATA: sublcass must implement getConfig.\n");
return kATAModeNotSupported;
}
/*---------------------------------------------------------------------------
*
* All ata controller subclasses must provide an implementation.
*
*
---------------------------------------------------------------------------*/
IOReturn
IOATAController::provideBusInfo( IOATABusInfo* infoOut)
{
DLOG(" IOATA: sublcass must implement provideBusInfo\n");
return -1;
}
/*---------------------------------------------------------------------------
*
* The main call which puts something on the work loop
*
---------------------------------------------------------------------------*/
IOReturn
IOATAController::executeCommand(IOATADevice* nub, IOATABusCommand* command)
{
if( !command || !nub )
return -1;
IOReturn resultCode = kATANoErr;
// flag the command as in use.
command->setCommandInUse();
_cmdGate->runAction( (IOCommandGate::Action)
&IOATAController::executeCommandAction,
(void *) command, // arg 0
(void *) &resultCode, // arg 1
0, 0); // arg2 arg 3
return resultCode;
}
#pragma mark -workloop entry-
/*---------------------------------------------------------------------------
*
* Static function called by the internal IOCommandGate object to
* handle a runAction() request invoked by executeCommand().
*
---------------------------------------------------------------------------*/
void
IOATAController::executeCommandAction(OSObject * owner,
void * arg0,
void * arg1,
void * /* arg2 */,
void * /* arg3 */)
{
IOATAController* self = (IOATAController*) owner;
IOATABusCommand* command = (IOATABusCommand*) arg0;
IOReturn* result = (IOReturn*) arg1;
// do a little reality check.
assert(command && result);
*result = self->handleCommand( (void*)command );
}
/*---------------------------------------------------------------------------
*
* Do something with the command
*
---------------------------------------------------------------------------*/
IOReturn
IOATAController::handleCommand( void* param0, /* the command */
void* param1, /* not used = 0 */
void* param2, /* not used = 0 */
void* param3 ) /* not used = 0 */
{
IOATABusCommand* command = (IOATABusCommand*) param0;
if( command == 0L )
{
DLOG("IOATAController::handleCmd nill ptr\n");
return -1;
}
// set the state flag on the transaction.
command->state = kATAInitial;
// Put the command on the queue.
enqueueCommand( command );
// wake up it is time to go to work
dispatchNext();
// No error on async commands
return kATANoErr;
}
/*---------------------------------------------------------------------------
*
* enqueueCommand looks at the command flags and queues it at the tail if
* unless it is immediate, then it puts it at the head of the queue.
*
---------------------------------------------------------------------------*/
IOReturn
IOATAController::enqueueCommand( IOATABusCommand* command)
{
// immediate means go to the head of the queue.
// This could get sticky - if there's already an
// immediate command at the head of the queue.
// whether a new immediate should go to the head, or behind the
// most recent already queued immediate is unsettled at this time.
if( command->getFlags() & mATAFlagImmediate )
{
queue_enter_first( &_commandQueue,
command,
IOATABusCommand*,
queueChain );
} else {
// put at the tail.
queue_enter( &_commandQueue,
command,
IOATABusCommand*,
queueChain );
}
return kATANoErr;
}
/*---------------------------------------------------------------------------
*
* dequeueFirstCommand take the first command off the head of the queue
* returns a IOATABusCommand*, or nil if empty.
*
---------------------------------------------------------------------------*/
IOATABusCommand*
IOATAController::dequeueFirstCommand( void )
{
IOATABusCommand* cmdPtr = 0L;
if( !queue_empty( &_commandQueue ) )
{
queue_remove_first( &_commandQueue,
cmdPtr,
IOATABusCommand*,
queueChain );
}
return cmdPtr;
}
/*---------------------------------------------------------------------------
* true - bus is ready to dispatch commands
* false - bus is busy with a current command.
*
---------------------------------------------------------------------------*/
bool
IOATAController::busCanDispatch( void )
{
// normal case
if( _busState == IOATAController::kBusFree
&& _queueState == IOATAController::kQueueOpen )
{
return true;
}
// special case if we are dispatching immediate commands only
if( _busState == IOATAController::kBusFree
&& _queueState == IOATAController::kQueueLocked
&& _immediateGate == kImmediateOK
&& !queue_empty( &_commandQueue ) )
{
DLOG("IOATA Qfrozen check for immediate\n");
// make sure the head of the queue is immediate
IOATABusCommand* cmdPtr = (IOATABusCommand*) queue_first( & _commandQueue ) ;
if( cmdPtr != 0
&& (cmdPtr->getFlags() & mATAFlagImmediate) )
{
DLOG("IOTA q-head is immediate\n");
return true;
}
}
// otherwise no dispatch.
return false;
}
/*---------------------------------------------------------------------------
*
* this should only be called on the single-threaded side of the command gate.
*
*
---------------------------------------------------------------------------*/
IOReturn
IOATAController::dispatchNext( void )
{
IOReturn result = kATANoErr;
DLOG("IOATAController::dispatchNext start\n");
// check that the hardware is free and ready to accept commands
if( !busCanDispatch() )
return result;
// set the bus state flag
_busState = IOATAController::kBusBusy;
// take the command at the head of the queue and make current.
_currentCommand = dequeueFirstCommand();
if( _currentCommand == 0L )
{
// if there's nothing in the queue, free the bus and
// return.
DLOG("IOATAController::dispatchNext queue empty\n");
_busState = IOATAController::kBusFree;
return kATAQueueEmpty;
}
// set the state flag on the transaction.
_currentCommand->state = IOATAController::kATAStarted;
// IF we are in the special case circumstance of running commands
// that re-enter the command gate because they were dispatched during
// an executeEventCallout(), we MUST poll the device for command completion
// This is an ugly artifact of the workloop design.
if( _queueState == IOATAController::kQueueLocked
&& _immediateGate == kImmediateOK
&& _currentCommand->getFlags() & mATAFlagImmediate)
{
_currentCommand->setFlags(_currentCommand->getFlags() | mATAFlagUseNoIRQ );
}
// in case someone tries to slip a reset command through as an exec IO.
if( _currentCommand->getTaskFilePtr()->ataTFCommand == 0x08 )
{
_currentCommand->setOpcode(kATAFnBusReset);
}
switch( _currentCommand->getOpcode() )
{
case kATAFnExecIO: /* Execute ATA I/O */
case kATAPIFnExecIO: /* ATAPI I/O */
result = handleExecIO();
break;
case kATAFnRegAccess: /* Register Access */
result = handleRegAccess();
break;
case kATAFnBusReset: /* Reset ATA bus */
result = handleBusReset();
break;
case kATAFnQFlush: /* I/O Queue Release */
result = handleQueueFlush();
break;
default:
_currentCommand->setResult( kATAUnknownOpcode );
result = kATAUnknownOpcode;
_currentCommand->state = IOATAController::kATAComplete;
completeIO(kATAUnknownOpcode);
break;
}
DLOG("IOATAController::dispatchNext done return = %ld\n", (long int)result);
return result;
}
/*---------------------------------------------------------------------------
* Calls the device driver(s) which are connected to this bus in order to
* inform them that an event occurred that may require their attention.
* Resets would be such an event, as the drivers may need to immediately
* reconfigure their devices BEFORE any other commands may be issued.
*
---------------------------------------------------------------------------*/
void
IOATAController::executeEventCallouts( ataEventCode event, ataUnitID unit )
{
// make the current command local, in preparation for allowing
// immediate commands through.
IOATABusCommand* currCommand = _currentCommand;
UInt32 currQueueState = _queueState;
UInt32 currBusState = _busState;
UInt32 currImmed = _immediateGate;
// unbusy the bus, but freeze the queue
// this allows immediate commands to run
_queueState = kQueueLocked;
_busState = kBusFree;
_immediateGate = kImmediateOK;
_currentCommand = 0;
for( int i = 0; i < 2; i++)
{
// call the device as requested, or both devices if the unit id
// isn't 0 or 1.
if( (_nub[i] != 0L )
&& ( (unit == kATAInvalidDeviceID) || (unit == i) ) )
{
// during notify event, device drivers will have an opportunity
// to execute commands to their devices in immediate mode on this thread.
_nub[i]->notifyEvent( event );
}
}
// retore the state of the bus, queue, immediate gate and current commands
_queueState = currQueueState;
_busState = currBusState;
_immediateGate = currImmed;
_currentCommand = currCommand;
}
/*---------------------------------------------------------------------------
*
*
*
*
---------------------------------------------------------------------------*/
void
IOATAController::completeIO( IOReturn commandResult )
{
DLOG("IOATAController::completeIO start = %ld\n",(long int)commandResult);
// make the current command local and nil the command in execution.
IOATABusCommand* finishedCmd = _currentCommand;
// someone called completeIO with no command executing.
if( finishedCmd == 0L )
return;
// nil the current command
_currentCommand = 0L;
finishedCmd->state = IOATAController::kATADone;
// clear the timer if it is running.
stopTimer();
stopDMA();
// set the bus state to free to allow next dispatch.
_busState = IOATAController::kBusFree;
// set the result code in case someone didn't update it already.
finishedCmd->setResult(commandResult);
// complete the IO and execute the callback if any prior to
// dispatching next command. Gives device drivers a chance to
// recover from error.
finishedCmd->executeCallback();
dispatchNext();
DLOG("IOATAController::completeIO done\n");
}
#pragma mark -timers-
/*---------------------------------------------------------------------------
* start the transaction timer for a transaction.
*
*
*
---------------------------------------------------------------------------*/
IOReturn
IOATAController::startTimer( UInt32 inMS)
{
IOReturn err = kATANoErr;
// make sure it is not armed first.
_timer->disable();
_timer->cancelTimeout();
// arm the timer
_timer->enable();
err = _timer->setTimeoutMS( inMS );
if( err )
{
DLOG("IOATAController::startTimer failed\n");
}
return err;
}
/*---------------------------------------------------------------------------
*
* Kill a running timer.
*
*
---------------------------------------------------------------------------*/
void
IOATAController::stopTimer(void)
{
_timer->disable();
_timer->cancelTimeout();
}
/*---------------------------------------------------------------------------
*
* simple static function that is called by the timerEventSource via the
* command gate.
*
---------------------------------------------------------------------------*/
void
IOATAController::timeoutOccured(OSObject *owner, IOTimerEventSource *sender)
{
IOATAController* self = (IOATAController*) owner;
self->handleTimeout();
}
/*---------------------------------------------------------------------------
* Timer event sources can't fire while we're on the safe side of a command gate
* so we need a way to check for a timeout happening while we are inside
* the thread-safe part of the code. Unfortunately, TimerEventSource provides
* no means to check if it has expired, so this function always returns false
* for now. Eventually, either Timer will get an subclass that allows this.
---------------------------------------------------------------------------*/
bool
IOATAController::checkTimeout( void )
{
// check to see if the timer has expired while on the
// safe side of the command-gate.
return _timer->hasTimedOut();
}
/*---------------------------------------------------------------------------
*
* Do what is necessary to fail the current IO command because the HW did not
* respond within the alloted time.
*
---------------------------------------------------------------------------*/
void
IOATAController::handleTimeout( void )
{
// if there's a current command, kill it with timeout error
if( _currentCommand != 0L )
{
if( (_currentCommand->getFlags() & mATAFlagUseDMA ) == mATAFlagUseDMA )
{
stopDMA();
}
_currentCommand->setResult( kATATimeoutErr );
_currentCommand->state = IOATAController::kATAComplete;
asyncStatus();
completeIO(kATATimeoutErr);
} else {
// otherwise, check and see if there's anything to dispatch
// that has been overlooked somehow.
dispatchNext();
}
}
#pragma mark -Workloop handlers-
/*---------------------------------------------------------------------------
*
* handleDeviceInterrupt - once the primary part of the device interrupt
* service routine determines that a device interrupt has occured and is
* valid, this routine should be called to handle the post interrupt service
*
---------------------------------------------------------------------------*/
IOReturn
IOATAController::handleDeviceInterrupt(void)
{
// mark volatile to enforce reading the register.
volatile UInt8 status = 0x00;
// make sure there's a command active
if( !_currentCommand )
{
DLOG("IOATA Device Int no command active\n");
return kATADevIntNoCmd;
}
// read the actual status register to clear the interrupt.
status = *_tfStatusCmdReg;
OSSynchronizeIO();
return asyncIO();
}
/*---------------------------------------------------------------------------
*
*
*
*
---------------------------------------------------------------------------*/
IOReturn
IOATAController::handleExecIO( void )
{
IOReturn err = kATANoErr;
// select the desired device
// don't start the IOTimer until after selection as there are no
// generation counts in the IOTimerEventSource. Device Selection will honor
// the timeout value in ms on its own.
err = selectDevice( _currentCommand->getUnit() );
if( err )
{
IOLog("IOATAController device blocking bus.\n");
_currentCommand->state = IOATAController::kATAComplete;
if( _currentCommand->getFlags() & mATAFlagUseNoIRQ )
{
completeIO( kIOReturnOffline );
return kIOReturnOffline;