ReactOS 0.4.17-dev-1281-g065abb3
portsm.h
Go to the documentation of this file.
1/*
2 * PROJECT: ReactOS USB Hub Driver
3 * LICENSE: MIT (https://spdx.org/licenses/MIT)
4 * PURPOSE: Port state machine for USB 2 and USB 3 hub ports
5 * COPYRIGHT: Copyright 2026 Justin Miller <justin.miller@reactos.org>
6 */
7
8#pragma once
9
10#include <drivers/usb3/smengine.h>
11
12class HubPort;
13
14enum class PortEvent : UCHAR
15{
16 /* Timers and port control transfers */
17 TimerExpired,
18 ResetPollExpired,
19 TransferDone,
20 TransferFailed,
21
22 /* Hub machine fan out and port object lifetime */
23 PortCleanup,
24 HubStarted,
25 HubResumed,
26 HubResumedInS0,
27 HubResumedWithReset,
28 HubStopping,
29 HubSuspending,
30 HubResetting,
31 StatusChanged,
32 HubRemoved,
33 UserOverCurrentReset,
34
35 /* From the device machine */
36 DeviceGone,
37 HibernateRequest,
38 CycleRequest,
39 DisableRequest,
40 DisableSuperSpeedRequest,
41 ResetRequest,
42 WarmResetRequest,
43 ResumeRequest,
44 SuspendRequest,
45 SetU1Timeout,
46 SetU2Timeout,
47
48 /* Results handed back by called states and change queries, never posted */
49 ChangeConnect,
50 ChangeOverCurrent,
51 ChangeOverCurrentCleared,
52 ChangeResetDone,
53 ChangeResumed,
54 ChangeDisabled,
55 ChangeError,
56 ChangeLinkError,
57 ChangeNone,
58 ChangeResetBusy,
59 ChangeNeedsHubReset,
60 ChangeNeedsReset,
61 ErrorIgnore,
62 ErrorCycle,
63 ErrorDisableAndCycle,
64 ErrorEnabledOnConnect,
65 ErrorEnabledWhileReset,
66 SubDone,
67
68 Count
69};
70
72typedef enum _PSM_DEVICE_NOTICE
73{
74 PsmNoticeFailed,
75 PsmNoticeDisabled,
76 PsmNoticeResetRefused,
77 PsmNoticeResumed,
78 PsmNoticeSuspended,
79 PsmNoticeResumeRefused,
80 PsmNoticeResumeTimedOut,
81 PsmNoticeStateDisabled,
82 PsmNoticeStateEnabled,
83 PsmNoticeStateSuspended,
84 PsmNoticeResetTimedOut,
85 PsmNoticeResetComplete,
86 PsmNoticeTimeoutUpdated,
87 PsmNoticeEnabledOnReconnect
88} PSM_DEVICE_NOTICE;
89
91typedef enum _PSM_TIMER
92{
93 PsmTimerDebounce,
94 PsmTimerOverCurrent,
95 PsmTimerResetCompletion,
96 PsmTimerResumeCompletion,
97 PsmTimerResumeRecovery,
98 PsmTimerPowerOn,
99 PsmTimerReconnect,
100 PsmTimerD3ColdReconnect,
101 PsmTimerSuperSpeedDisable,
102 PsmTimerResetPoll
103} PSM_TIMER;
104
106typedef enum _PSM_PENDING
107{
108 PsmPendingChange,
109 PsmPendingNone,
110 PsmPendingError
111} PSM_PENDING;
112
114typedef struct _PSM_PORT_BITS
115{
116 BOOLEAN Connected;
117 BOOLEAN Enabled;
118 BOOLEAN OverCurrent;
119 BOOLEAN OverCurrentChanged;
120} PSM_PORT_BITS, *PPSM_PORT_BITS;
121
122/* Port specific state flags, inherited from parents like the engine flags */
123#define PSM_STATE_IDLE_USB2 0x00000100
124#define PSM_STATE_IDLE_USB3 0x00000200
125#define PSM_STATE_IDLE (PSM_STATE_IDLE_USB2 | PSM_STATE_IDLE_USB3)
126
127class PortMachine : public SmMachine<PortMachine, PortEvent>
128{
129 friend class SmMachine<PortMachine, PortEvent>;
130
131public:
132 VOID
133 Initialize(
134 _In_ HubPort* Port,
135 _In_ BOOLEAN SuperSpeed);
136
137 HubPort*
138 Port() const
139 {
140 return m_Port;
141 }
142
143 BOOLEAN
144 IsSuperSpeed() const
145 {
146 return m_Usb3;
147 }
148
149 BOOLEAN
150 HoldsHubPower() const
151 {
152 return m_HubPowerHeld;
153 }
154
155 static const SM_EVENT_INFO EventInfo[];
156
157private:
159 enum TIMER_FOLLOW_UP
160 {
161 FollowConnect,
162 FollowCycle,
163 FollowOverCurrent,
164 FollowOverCurrentCleared
165 };
166
168 enum OLD_DEVICE_KIND
169 {
170 OldDevicePlain,
171 OldDeviceResetNeeded,
172 OldDeviceResetInProgress
173 };
174
176 enum READ_KIND
177 {
178 ReadPlain,
179 ReadNoChange,
180 ReadStartResume
181 };
182
184 enum D3_PENDING
185 {
186 D3PendingStop,
187 D3PendingOverCurrent,
188 D3PendingOverCurrentCleared,
189 D3PendingReattach,
190 D3PendingHubReset
191 };
192
193public:
194 /* States, defined in portsm.cpp, portsm_port.cpp and portsm_frames.cpp */
195 static const State Off;
196 static const State OffInitial;
197 static const State OffEmpty;
198 static const State OffAttached;
199 static const State OffResetNeeded;
200 static const State OffSuperSpeedDisabled;
201 static const State OffSuspendedUsb3;
202 static const State OffSuspendedUsb2;
203 static const State CleaningUp;
204 static const State Deleted;
205
206 static const State Empty;
207 static const State Disconnected;
208 static const State StartingEmpty;
209 static const State Debouncing;
210 static const State DebouncingUsb2;
211 static const State DebouncingUsb3;
212 static const State OldDeviceWait;
213 static const State OverCurrentWait;
214 static const State NotifyingOverCurrent;
215 static const State UserResetWait;
216 static const State TimerFlush;
217 static const State FlushBeforeOffEmpty;
218 static const State FlushBeforeOffAttached;
219 static const State FlushBeforeSuperSpeedOff;
220
221 static const State Attached;
222 static const State Enabled;
223 static const State AttachedDisabled;
224 static const State Suspended;
225 static const State DisabledInSuspend;
226 static const State SuspendedD3Cold;
227 static const State ResumeAckWait;
228 static const State ResetRequestWait;
229 static const State StartingAttached;
230 static const State ResumingAttached;
231 static const State ResumingDisabled;
232 static const State SystemResuming;
233 static const State ErrorRestarting;
234 static const State ResumeAckWaitStopped;
235
236 static const State Timed;
237 static const State ResetWait;
238 static const State ResetEnabledWait;
239 static const State ResetFlush;
240 static const State ResumeWait;
241 static const State ResumeRecovery;
242 static const State ResumeFlush;
243
244 static const State HubResetIssued;
245 static const State HubResetWait;
246 static const State HubResetTimerWait;
247 static const State EmptyHubResetWait;
248 static const State EmptyHubResetTimerWait;
249 static const State AttachFailedWait;
250 static const State SuperSpeedOffWait;
251 static const State SsLinkDisabled;
252
253 static const State Transfer;
254 static const State PoweringPort;
255 static const State QueryingOverCurrent;
256 static const State SendingReset;
257 static const State SendingWarmReset;
258 static const State SendingResume;
259 static const State SendingSuspend;
260 static const State DisablingOnRequest;
261 static const State DisablingForCycle;
262 static const State DisablingBeforeConnect;
263 static const State QuiescingForHubSuspend;
264 static const State DisablingForCycleTimed;
265 static const State DisablingOnSuspendTimed;
266 static const State DisablingOnResetTimeout;
267 static const State ReadingForResume;
268 static const State ReadingAfterResumeTimeout;
269 static const State SettingLpmTimeout;
270 static const State DisablingSuperSpeed;
271 static const State DisablingSuperSpeedOnRequest;
272 static const State EnablingSuperSpeedOnStop;
273 static const State EnablingSuperSpeedOnTimer;
274 static const State ResetTimeoutStatus;
275 static const State ArmingWake;
276
277 /* Called frames */
278 static const State ChangeIdle20;
279 static const State ChangeReading20;
280 static const State ChangeAcking20;
281 static const State ChangeReporting20;
282 static const State ChangeParked20;
283
284 static const State ChangeIdle30;
285 static const State ChangeChecking30;
286 static const State ResetChangeIdle;
287 static const State ResetChangeChecking;
288 static const State ResetPollWait;
289 static const State ResetPollChecking;
290 static const State ResumeChangeIdle;
291 static const State ResumeChangeChecking;
292
293 static const State StatusReading;
294 static const State StatusAcking;
295 static const State StatusReporting;
296 static const State StatusFailing;
297
298 static const State DrainIdle;
299 static const State DrainEmptyIdleUsb2;
300 static const State DrainEmptyIdleUsb3;
301 static const State DrainReading;
302 static const State DrainAcking;
303 static const State DrainRearming;
304 static const State DrainChecking;
305
306 static const State PowerOnSending;
307 static const State PowerOnSettling;
308 static const State StartReading20;
309 static const State StartReadingFirst;
310 static const State StartReading30;
311 static const State PowerUpResetHub;
312 static const State PowerUpRearming;
313
314 static const State ResumePowering;
315 static const State ResumeSettling;
316 static const State ResumeReading;
317 static const State ResumeAckingConnect;
318 static const State ReconnectWait;
319 static const State ReconnectReading;
320 static const State ReconnectAcking;
321 static const State ReconnectRearming;
322 static const State ReconnectFlush;
323 static const State ResumeRereading;
324 static const State SystemResumeReading;
325 static const State SystemReconnectWait;
326 static const State SystemResumeRereading;
327
328 static const State SuspendIdle;
329 static const State SuspendReading;
330 static const State SuspendAcking;
331 static const State SuspendRecovery;
332 static const State SuspendReporting;
333 static const State D3Idle;
334 static const State D3PoweredOff;
335 static const State D3PoweringUp;
336 static const State D3Debouncing;
337 static const State D3DebounceFlush;
338 static const State D3FlushThenReturn;
339 static const State D3ResumeAckWait;
340 static const State D3ReconnectWait;
341 static const State D3ReconnectFlush;
342
343 static const State WakeArming;
344 static const State Returning;
345
346private:
347 /* Engine hooks */
348 static const BOOLEAN SmCompletionsFirst = FALSE;
349
350 VOID SmReference();
351 VOID SmDereference();
352 VOID SmQueuePassive();
353 VOID SmStateChanged();
354
355 VOID
356 SmOnDequeue(
357 _In_ PortEvent Event);
358
359 /* Frame 0 handlers */
360 SM_RESULT
361 OnOff(
362 _In_ PortEvent Event);
363 SM_RESULT
364 OnOffEmpty(
365 _In_ PortEvent Event);
366 SM_RESULT
367 OnOffAttached(
368 _In_ PortEvent Event);
369 SM_RESULT
370 OnOffResetNeeded(
371 _In_ PortEvent Event);
372 SM_RESULT
373 OnOffSuperSpeedDisabled(
374 _In_ PortEvent Event);
375 SM_RESULT
376 OnOffSuspended(
377 _In_ PortEvent Event);
378 SM_RESULT
379 OnCleaningUp(
380 _In_ PortEvent Event);
381 SM_RESULT
382 OnEmpty(
383 _In_ PortEvent Event);
384 SM_RESULT
385 OnStartingEmpty(
386 _In_ PortEvent Event);
387 SM_RESULT
388 OnDebouncing(
389 _In_ PortEvent Event);
390 SM_RESULT
391 OnOldDeviceWait(
392 _In_ PortEvent Event);
393 SM_RESULT
394 OnOverCurrentWait(
395 _In_ PortEvent Event);
396 SM_RESULT
397 OnUserResetWait(
398 _In_ PortEvent Event);
399 SM_RESULT
400 OnTimerFlush(
401 _In_ PortEvent Event);
402 SM_RESULT
403 OnFlushBeforeOff(
404 _In_ PortEvent Event);
405 SM_RESULT
406 OnAttached(
407 _In_ PortEvent Event);
408 SM_RESULT
409 OnEnabled(
410 _In_ PortEvent Event);
411 SM_RESULT
412 OnAttachedDisabled(
413 _In_ PortEvent Event);
414 SM_RESULT
415 OnSuspended(
416 _In_ PortEvent Event);
417 SM_RESULT
418 OnDisabledInSuspend(
419 _In_ PortEvent Event);
420 SM_RESULT
421 OnResumeAckWait(
422 _In_ PortEvent Event);
423 SM_RESULT
424 OnResetRequestWait(
425 _In_ PortEvent Event);
426 SM_RESULT
427 OnStartingAttached(
428 _In_ PortEvent Event);
429 SM_RESULT
430 OnResumingAttached(
431 _In_ PortEvent Event);
432 SM_RESULT
433 OnResumingDisabled(
434 _In_ PortEvent Event);
435 SM_RESULT
436 OnSystemResuming(
437 _In_ PortEvent Event);
438 SM_RESULT
439 OnErrorRestarting(
440 _In_ PortEvent Event);
441 SM_RESULT
442 OnResumeAckWaitStopped(
443 _In_ PortEvent Event);
444 SM_RESULT
445 OnTimed(
446 _In_ PortEvent Event);
447 SM_RESULT
448 OnResetWait(
449 _In_ PortEvent Event);
450 SM_RESULT
451 OnResetEnabledWait(
452 _In_ PortEvent Event);
453 SM_RESULT
454 OnResetFlush(
455 _In_ PortEvent Event);
456 SM_RESULT
457 OnResumeWait(
458 _In_ PortEvent Event);
459 SM_RESULT
460 OnResumeRecovery(
461 _In_ PortEvent Event);
462 SM_RESULT
463 OnResumeFlush(
464 _In_ PortEvent Event);
465 SM_RESULT
466 OnHubResetIssued(
467 _In_ PortEvent Event);
468 SM_RESULT
469 OnHubResetWait(
470 _In_ PortEvent Event);
471 SM_RESULT
472 OnHubResetTimerWait(
473 _In_ PortEvent Event);
474 SM_RESULT
475 OnEmptyHubResetWait(
476 _In_ PortEvent Event);
477 SM_RESULT
478 OnEmptyHubResetTimerWait(
479 _In_ PortEvent Event);
480 SM_RESULT
481 OnAttachFailedWait(
482 _In_ PortEvent Event);
483 SM_RESULT
484 OnSuperSpeedOffWait(
485 _In_ PortEvent Event);
486 SM_RESULT
487 OnSsLinkDisabled(
488 _In_ PortEvent Event);
489 SM_RESULT
490 OnPoweringPort(
491 _In_ PortEvent Event);
492 SM_RESULT
493 OnQueryingOverCurrent(
494 _In_ PortEvent Event);
495 SM_RESULT
496 OnSendingReset(
497 _In_ PortEvent Event);
498 SM_RESULT
499 OnSendingResume(
500 _In_ PortEvent Event);
501 SM_RESULT
502 OnSendingSuspend(
503 _In_ PortEvent Event);
504 SM_RESULT
505 OnDisablingOnRequest(
506 _In_ PortEvent Event);
507 SM_RESULT
508 OnDisablingForCycle(
509 _In_ PortEvent Event);
510 SM_RESULT
511 OnDisablingBeforeConnect(
512 _In_ PortEvent Event);
513 SM_RESULT
514 OnQuiescingForHubSuspend(
515 _In_ PortEvent Event);
516 SM_RESULT
517 OnDisablingForCycleTimed(
518 _In_ PortEvent Event);
519 SM_RESULT
520 OnDisablingOnSuspendTimed(
521 _In_ PortEvent Event);
522 SM_RESULT
523 OnDisablingOnResetTimeout(
524 _In_ PortEvent Event);
525 SM_RESULT
526 OnReadingForResume(
527 _In_ PortEvent Event);
528 SM_RESULT
529 OnReadingAfterResumeTimeout(
530 _In_ PortEvent Event);
531 SM_RESULT
532 OnSettingLpmTimeout(
533 _In_ PortEvent Event);
534 SM_RESULT
535 OnDisablingSuperSpeed(
536 _In_ PortEvent Event);
537 SM_RESULT
538 OnDisablingSuperSpeedOnRequest(
539 _In_ PortEvent Event);
540 SM_RESULT
541 OnEnablingSuperSpeedOnStop(
542 _In_ PortEvent Event);
543 SM_RESULT
544 OnEnablingSuperSpeedOnTimer(
545 _In_ PortEvent Event);
546 SM_RESULT
547 OnResetTimeoutStatus(
548 _In_ PortEvent Event);
549 SM_RESULT
550 OnArmingWake(
551 _In_ PortEvent Event);
552
553 /* Frame 0 entries */
554 SM_RESULT EnterOffEmpty();
555 SM_RESULT EnterOffSuspended();
556 SM_RESULT EnterCleaningUp();
557 SM_RESULT EnterDisconnected();
558 SM_RESULT EnterWithPortChange();
559 SM_RESULT EnterStartingEmpty();
560 SM_RESULT EnterDebouncing();
561 SM_RESULT EnterNotifyingOverCurrent();
562 SM_RESULT EnterSuspended();
563 SM_RESULT EnterSuspendedD3Cold();
564 SM_RESULT EnterStartingAttached();
565 SM_RESULT EnterResumingAttached();
566 SM_RESULT EnterSystemResuming();
567 SM_RESULT EnterErrorRestarting();
568 SM_RESULT EnterResetWait();
569 SM_RESULT EnterResumeWait();
570 SM_RESULT EnterHubResetIssued();
571 SM_RESULT EnterDraining();
572 SM_RESULT EnterDrainingEmpty();
573 SM_RESULT EnterPoweringPort();
574 SM_RESULT EnterSendingReset();
575 SM_RESULT EnterSendingWarmReset();
576 SM_RESULT EnterSendingResume();
577 SM_RESULT EnterSendingSuspend();
578 SM_RESULT EnterDisablingOnRequest();
579 SM_RESULT EnterDisablingPort();
580 SM_RESULT EnterQuiescingForHubSuspend();
581 SM_RESULT EnterReadingStatus();
582 SM_RESULT EnterSettingLpmTimeout();
583 SM_RESULT EnterDisablingSuperSpeed();
584 SM_RESULT EnterDisablingSuperSpeedOnRequest();
585 SM_RESULT EnterEnablingSuperSpeed();
586 SM_RESULT EnterResetTimeoutStatus();
587 SM_RESULT EnterArmingWake();
588
589 /* Called frame handlers and entries, portsm_frames.cpp */
590 SM_RESULT
591 OnChangeIdle20(
592 _In_ PortEvent Event);
593 SM_RESULT
594 OnChangeReading20(
595 _In_ PortEvent Event);
596 SM_RESULT
597 OnChangeAcking20(
598 _In_ PortEvent Event);
599 SM_RESULT
600 OnChangeParked20(
601 _In_ PortEvent Event);
602 SM_RESULT EnterChangeReporting20();
603 SM_RESULT EnterChangeParked20();
604
605 SM_RESULT
606 OnChangeIdle30(
607 _In_ PortEvent Event);
608 SM_RESULT
609 OnChangeChecking30(
610 _In_ PortEvent Event);
611 SM_RESULT
612 OnResetChangeIdle(
613 _In_ PortEvent Event);
614 SM_RESULT
615 OnResetChangeChecking(
616 _In_ PortEvent Event);
617 SM_RESULT
618 OnResetPollWait(
619 _In_ PortEvent Event);
620 SM_RESULT
621 OnResetPollChecking(
622 _In_ PortEvent Event);
623 SM_RESULT
624 OnResumeChangeIdle(
625 _In_ PortEvent Event);
626 SM_RESULT
627 OnResumeChangeChecking(
628 _In_ PortEvent Event);
629 SM_RESULT EnterPlainStatusRead();
630 SM_RESULT EnterResetPollWait();
631 SM_RESULT EnterResetPollChecking();
632
633 SM_RESULT
634 OnStatusReading(
635 _In_ PortEvent Event);
636 SM_RESULT
637 OnStatusAcking(
638 _In_ PortEvent Event);
639 SM_RESULT EnterStatusReading();
640 SM_RESULT EnterStatusReporting();
641 SM_RESULT EnterStatusFailing();
642
643 SM_RESULT
644 OnDrainIdle(
645 _In_ PortEvent Event);
646 SM_RESULT
647 OnDrainEmptyIdle(
648 _In_ PortEvent Event);
649 SM_RESULT
650 OnDrainReading(
651 _In_ PortEvent Event);
652 SM_RESULT
653 OnDrainAcking(
654 _In_ PortEvent Event);
655 SM_RESULT
656 OnDrainChecking(
657 _In_ PortEvent Event);
658 SM_RESULT EnterDrainRearming();
659
660 SM_RESULT
661 OnPowerOnSending(
662 _In_ PortEvent Event);
663 SM_RESULT
664 OnPowerOnSettling(
665 _In_ PortEvent Event);
666 SM_RESULT
667 OnStartReading20(
668 _In_ PortEvent Event);
669 SM_RESULT
670 OnStartReadingFirst(
671 _In_ PortEvent Event);
672 SM_RESULT
673 OnStartReading30(
674 _In_ PortEvent Event);
675 SM_RESULT
676 OnPowerUpParked(
677 _In_ PortEvent Event);
678 SM_RESULT EnterPowerOnSettling();
679 SM_RESULT EnterPowerUpResetHub();
680 SM_RESULT EnterPowerUpRearming();
681
682 SM_RESULT
683 OnResumePowering(
684 _In_ PortEvent Event);
685 SM_RESULT
686 OnResumeSettling(
687 _In_ PortEvent Event);
688 SM_RESULT
689 OnResumeReading(
690 _In_ PortEvent Event);
691 SM_RESULT
692 OnResumeAckingConnect(
693 _In_ PortEvent Event);
694 SM_RESULT
695 OnReconnectWait(
696 _In_ PortEvent Event);
697 SM_RESULT
698 OnReconnectReading(
699 _In_ PortEvent Event);
700 SM_RESULT
701 OnReconnectAcking(
702 _In_ PortEvent Event);
703 SM_RESULT
704 OnReconnectFlush(
705 _In_ PortEvent Event);
706 SM_RESULT
707 OnResumeRereading(
708 _In_ PortEvent Event);
709 SM_RESULT
710 OnSystemResumeReading(
711 _In_ PortEvent Event);
712 SM_RESULT
713 OnSystemReconnectWait(
714 _In_ PortEvent Event);
715 SM_RESULT
716 OnSystemResumeRereading(
717 _In_ PortEvent Event);
718 SM_RESULT EnterAckingChange();
719 SM_RESULT EnterReconnectRearming();
720 SM_RESULT EnterStartResumeStatusRead();
721
722 SM_RESULT
723 OnSuspendIdle(
724 _In_ PortEvent Event);
725 SM_RESULT
726 OnSuspendReading(
727 _In_ PortEvent Event);
728 SM_RESULT
729 OnSuspendAcking(
730 _In_ PortEvent Event);
731 SM_RESULT
732 OnSuspendRecovery(
733 _In_ PortEvent Event);
734 SM_RESULT EnterSuspendRecovery();
735 SM_RESULT EnterSuspendReporting();
736 SM_RESULT
737 OnD3Idle(
738 _In_ PortEvent Event);
739 SM_RESULT
740 OnD3PoweredOff(
741 _In_ PortEvent Event);
742 SM_RESULT
743 OnD3PoweringUp(
744 _In_ PortEvent Event);
745 SM_RESULT
746 OnD3Debouncing(
747 _In_ PortEvent Event);
748 SM_RESULT
749 OnD3DebounceFlush(
750 _In_ PortEvent Event);
751 SM_RESULT
752 OnD3FlushThenReturn(
753 _In_ PortEvent Event);
754 SM_RESULT
755 OnD3ResumeAckWait(
756 _In_ PortEvent Event);
757 SM_RESULT
758 OnD3ReconnectWait(
759 _In_ PortEvent Event);
760 SM_RESULT
761 OnD3ReconnectFlush(
762 _In_ PortEvent Event);
763 SM_RESULT EnterD3PoweringUp();
764
765 SM_RESULT
766 OnWakeArming(
767 _In_ PortEvent Event);
768 SM_RESULT EnterWakeArming();
769 SM_RESULT EnterReturning();
770
771 /* Shared code for the previous decision and one shot states */
772 SM_RESULT
773 PowerDown(
774 _In_ const State* Target);
775 SM_RESULT
776 PowerUp(
777 _In_ const State* Target);
778 SM_RESULT
779 ResetHubThen(
780 _In_ const State* Target);
781 SM_RESULT CheckConnection();
782 SM_RESULT StartOverCurrentWait();
783 SM_RESULT
784 DetachThen(
785 _In_ PortEvent Change);
786 SM_RESULT
787 DetachTimed(
788 _In_ PortEvent Change);
789 SM_RESULT
790 StopTimerThen(
791 _In_ TIMER_FOLLOW_UP FollowUp);
792 SM_RESULT
793 FollowTimer(
794 _In_ TIMER_FOLLOW_UP FollowUp);
795 SM_RESULT
796 HandleConnectedFault(
797 _In_ const State* Stay);
798 SM_RESULT
799 TimedError(
800 _In_ const State* Stay,
801 _In_ BOOLEAN DuringReset);
802 SM_RESULT TimedHubReset();
803 SM_RESULT ReleaseAndStopTimer();
804 SM_RESULT
805 ReattachOrCreate(
806 _In_ OLD_DEVICE_KIND Kind);
807 SM_RESULT
808 CheckOldDevice(
809 _In_ OLD_DEVICE_KIND Kind);
810 SM_RESULT
811 DeviceArrived(
812 _In_ OLD_DEVICE_KIND Kind);
813 SM_RESULT
814 TakeInterruptForReset(
815 _In_ const State* Start,
816 _In_ const State* Refused);
817 SM_RESULT ResumeSucceeded();
818 SM_RESULT FailToHubReset();
819 SM_RESULT ResetSucceeded();
820 SM_RESULT
821 CallStatusRead(
822 _In_ READ_KIND Kind);
823 SM_RESULT
824 CheckPending20(
825 _In_ const State* Acking,
826 _In_ const State* Quiet);
827 SM_RESULT
828 ParkChange20(
829 _In_ BOOLEAN ResetHub);
830 SM_RESULT ResumeReadDone();
831 SM_RESULT ResumeConnectCheck();
832 SM_RESULT ResumeStateDisabled();
833 SM_RESULT ReconnectCheck();
834 SM_RESULT ReconnectStatusFailed();
835 SM_RESULT
836 D3ConnectCheck(
837 _In_ BOOLEAN AfterResume);
838 SM_RESULT
839 D3StopReconnectTimer(
840 _In_ D3_PENDING Pending);
841 SM_RESULT
842 D3PendingDone(
843 _In_ D3_PENDING Pending);
844 SM_RESULT D3StopDebounceTimer();
845 SM_RESULT SystemResumeFailed();
846 SM_RESULT
847 ReportSuspendChange(
848 _In_ PortEvent Report);
849 SM_RESULT
850 ReturnFromFrame(
851 _In_ PortEvent Event);
852 SM_RESULT CycleDetach();
853 SM_RESULT ResetTransferFailed();
854 SM_RESULT StatusFailed();
855 SM_RESULT StatusQuiet();
856 SM_RESULT DrainDone();
857 SM_RESULT FailDeviceRequest();
858 BOOLEAN
859 AllowsHubSuspend(
860 _In_ const State* Target) const;
861 VOID
862 UpdateHubPower(
863 _In_ BOOLEAN Idle);
864 VOID KeepHubAwake();
865
866public:
867 /* Actions, implemented by the port object */
868 VOID ReferencePort();
869 VOID DereferencePort();
870 VOID QueuePassiveWork();
871 VOID ForgetDetachedDevice();
872 BOOLEAN HubPowerTake();
873 VOID HubPowerDrop();
874
875 VOID
876 TellDevice(
877 _In_ PSM_DEVICE_NOTICE Notice);
878 VOID
879 StartTimer(
880 _In_ PSM_TIMER Timer);
881 BOOLEAN StopTimer();
882
883 VOID ClearPortStatus();
884 VOID TakePortPowerReference();
885 VOID DropPortPowerReference();
886 VOID DropHubResetReference();
887 BOOLEAN TakeInterruptReference();
888 VOID DropInterruptReference();
889 VOID RequestHubReset();
890 VOID ResumeInterruptTransfer();
891 VOID ResetChangeAccumulator();
892 VOID FixPortStateAfterPowerUp();
893
894 VOID DisconnectDevice();
895 VOID ReattachBootDevice();
896 VOID NotifyBootDeviceRemoval();
897 VOID MarkUsb2Device();
898 VOID MarkUsb3Device();
899 VOID ForceResetOnEnumeration();
900 VOID RecordPortDisabled();
901 VOID RecordPortSuspended();
902 VOID CancelUserOverCurrentReset();
903 VOID NotifyUserOfOverCurrent();
904 VOID LogLinkStateError();
905 VOID MarkOverCurrentCause();
906
907 VOID SendGetStatus();
908 VOID SendAckChange();
909 VOID SendReset();
910 VOID SendWarmReset();
911 VOID SendDisable();
912 VOID SendResume();
913 VOID SendSuspend();
914 VOID SendPortPower();
915 VOID SendU1Timeout();
916 VOID SendU2Timeout();
917 VOID SendLinkDisable();
918 VOID SendLinkRxDetect();
919 VOID
920 SendRemoteWake(
921 _In_ BOOLEAN Enable);
922
923 /* Queries, implemented by the port object */
924 BOOLEAN DeviceConnected();
925 BOOLEAN DevicePresent();
926 BOOLEAN OverCurrentActive();
927 BOOLEAN OverCurrentPersists();
928 BOOLEAN CreateDevice();
929 BOOLEAN ConnectDevice();
930 BOOLEAN BootDeviceReturning();
931 BOOLEAN OldDevicePresent();
932 BOOLEAN ConnectChangedOnResume();
933 BOOLEAN D3ColdEnabled();
934 BOOLEAN NeedsDebounce();
935 BOOLEAN LinkInU0();
936 BOOLEAN SuperSpeedBlocked();
937 BOOLEAN PortPowered();
938 BOOLEAN PollResetCompletion();
939 BOOLEAN HubArmedForWake();
940 PSM_PENDING PendingChange();
941 PortEvent NextChange();
942 PortEvent LostChange();
943 PortEvent ErrorResponse();
944 PortEvent ErrorResponseDuringReset();
945 VOID
946 ReadPortBits(
947 _Out_ PPSM_PORT_BITS Bits);
948
949private:
950 HubPort* m_Port;
951 BOOLEAN m_Usb3;
952 BOOLEAN m_HubPowerHeld;
953 TIMER_FOLLOW_UP m_AfterTimer;
954 OLD_DEVICE_KIND m_OldDevice;
955 READ_KIND m_ReadKind;
956 D3_PENDING m_D3Pending;
957 PortEvent m_SuspendReport;
958 PortEvent m_D3FlushReturn;
959 PortEvent m_ReturnEvent;
960 BOOLEAN m_ReadFresh;
961 BOOLEAN m_WarmResume;
962 BOOLEAN m_AttachForcedReset;
963 BOOLEAN m_LpmU2;
964 BOOLEAN m_ArmForEmpty;
965 BOOLEAN m_ParkResetsHub;
966 BOOLEAN m_D3AfterResume;
967 BOOLEAN m_D3PowerUpWarm;
968 BOOLEAN m_ReconnectFlushOnStop;
969 BOOLEAN m_DrainReturnsEmpty;
970};
Start
static _Out_opt_ PULONGLONG Start
Definition: RtlMemIoResource.c:16
BOOLEAN
unsigned char BOOLEAN
Definition: actypes.h:127
Change
USHORT Change
Definition: bootdev.cpp:133
PortMachine::OnOverCurrentWait
SM_RESULT OnOverCurrentWait(_In_ PortEvent Event)
Definition: portsm_port.cpp:544
PortMachine::EnterErrorRestarting
SM_RESULT EnterErrorRestarting()
Definition: portsm_port.cpp:1122
PortMachine::EmptyHubResetWait
static const State EmptyHubResetWait
Definition: portsm.h:247
PortMachine::EnterStartingEmpty
SM_RESULT EnterStartingEmpty()
Definition: portsm_port.cpp:362
PortMachine::OnSystemResumeReading
SM_RESULT OnSystemResumeReading(_In_ PortEvent Event)
Definition: portsm_frames.cpp:1099
PortMachine::EnterDisablingOnRequest
SM_RESULT EnterDisablingOnRequest()
Definition: portsm_port.cpp:1529
PortMachine::OnHubResetTimerWait
SM_RESULT OnHubResetTimerWait(_In_ PortEvent Event)
Definition: portsm_port.cpp:1403
PortMachine::Attached
static const State Attached
Definition: portsm.h:221
PortMachine::ChangeIdle30
static const State ChangeIdle30
Definition: portsm.h:284
PortMachine::SendRemoteWake
VOID SendRemoteWake(_In_ BOOLEAN Enable)
Definition: portxfer.cpp:263
PortMachine::EnterEnablingSuperSpeed
SM_RESULT EnterEnablingSuperSpeed()
Definition: portsm_port.cpp:1581
PortMachine::ReattachBootDevice
VOID ReattachBootDevice()
Definition: hubport.cpp:380
PortMachine::OnReconnectWait
SM_RESULT OnReconnectWait(_In_ PortEvent Event)
Definition: portsm_frames.cpp:975
PortMachine::EnterQuiescingForHubSuspend
SM_RESULT EnterQuiescingForHubSuspend()
Definition: portsm_port.cpp:1544
PortMachine::SmCompletionsFirst
static const BOOLEAN SmCompletionsFirst
Definition: portsm.h:348
PortMachine::OnHubResetWait
SM_RESULT OnHubResetWait(_In_ PortEvent Event)
Definition: portsm_port.cpp:1393
PortMachine::OnChangeAcking20
SM_RESULT OnChangeAcking20(_In_ PortEvent Event)
Definition: portsm_frames.cpp:335
PortMachine::StartReadingFirst
static const State StartReadingFirst
Definition: portsm.h:309
PortMachine::CleaningUp
static const State CleaningUp
Definition: portsm.h:203
PortMachine::ResumeRereading
static const State ResumeRereading
Definition: portsm.h:323
PortMachine::UpdateHubPower
VOID UpdateHubPower(_In_ BOOLEAN Idle)
Definition: portsm.cpp:238
PortMachine::DropInterruptReference
VOID DropInterruptReference()
Definition: fanout.cpp:1000
PortMachine::OnStatusAcking
SM_RESULT OnStatusAcking(_In_ PortEvent Event)
Definition: portsm_frames.cpp:615
PortMachine::ResetRequestWait
static const State ResetRequestWait
Definition: portsm.h:228
PortMachine::OnResumeAckingConnect
SM_RESULT OnResumeAckingConnect(_In_ PortEvent Event)
Definition: portsm_frames.cpp:962
PortMachine::OnWakeArming
SM_RESULT OnWakeArming(_In_ PortEvent Event)
Definition: portsm_frames.cpp:1693
PortMachine::EmptyHubResetTimerWait
static const State EmptyHubResetTimerWait
Definition: portsm.h:248
PortMachine::TimerFlush
static const State TimerFlush
Definition: portsm.h:216
PortMachine::CallStatusRead
SM_RESULT CallStatusRead(_In_ READ_KIND Kind)
Definition: portsm_frames.cpp:383
PortMachine::ErrorResponseDuringReset
PortEvent ErrorResponseDuringReset()
Definition: portxfer.cpp:640
PortMachine::DrainIdle
static const State DrainIdle
Definition: portsm.h:298
PortMachine::EnterDisablingSuperSpeed
SM_RESULT EnterDisablingSuperSpeed()
Definition: portsm_port.cpp:1566
PortMachine::OffEmpty
static const State OffEmpty
Definition: portsm.h:197
PortMachine::m_D3AfterResume
BOOLEAN m_D3AfterResume
Definition: portsm.h:966
PortMachine::OnResumeFlush
SM_RESULT OnResumeFlush(_In_ PortEvent Event)
Definition: portsm_port.cpp:1332
PortMachine::D3PendingOverCurrentCleared
@ D3PendingOverCurrentCleared
Definition: portsm.h:188
PortMachine::D3PendingStop
@ D3PendingStop
Definition: portsm.h:186
PortMachine::D3PendingReattach
@ D3PendingReattach
Definition: portsm.h:189
PortMachine::D3PendingOverCurrent
@ D3PendingOverCurrent
Definition: portsm.h:187
PortMachine::D3PendingHubReset
@ D3PendingHubReset
Definition: portsm.h:190
PortMachine::SuspendAcking
static const State SuspendAcking
Definition: portsm.h:330
PortMachine::OnArmingWake
SM_RESULT OnArmingWake(_In_ PortEvent Event)
Definition: portsm_port.cpp:1953
PortMachine::OnQuiescingForHubSuspend
SM_RESULT OnQuiescingForHubSuspend(_In_ PortEvent Event)
Definition: portsm_port.cpp:1732
PortMachine::OnResumeReading
SM_RESULT OnResumeReading(_In_ PortEvent Event)
An over-current seen now, or one that came and went while suspended, is reported.
Definition: portsm_frames.cpp:930
PortMachine::OnPoweringPort
SM_RESULT OnPoweringPort(_In_ PortEvent Event)
Definition: portsm_port.cpp:1600
PortMachine::DisablingForCycleTimed
static const State DisablingForCycleTimed
Definition: portsm.h:264
PortMachine::EnterResetPollChecking
SM_RESULT EnterResetPollChecking()
Definition: portsm_frames.cpp:488
PortMachine::OldDevicePresent
BOOLEAN OldDevicePresent()
Definition: hubport.cpp:552
PortMachine::DisablingForCycle
static const State DisablingForCycle
Definition: portsm.h:261
PortMachine::OnReconnectFlush
SM_RESULT OnReconnectFlush(_In_ PortEvent Event)
Definition: portsm_frames.cpp:1060
PortMachine::OnSuperSpeedOffWait
SM_RESULT OnSuperSpeedOffWait(_In_ PortEvent Event)
Definition: portsm_port.cpp:1455
PortMachine::ResumeAckWaitStopped
static const State ResumeAckWaitStopped
Definition: portsm.h:234
PortMachine::SendReset
VOID SendReset()
Definition: portxfer.cpp:177
PortMachine::OnAttachFailedWait
SM_RESULT OnAttachFailedWait(_In_ PortEvent Event)
Definition: portsm_port.cpp:1439
PortMachine::EnterDisablingPort
SM_RESULT EnterDisablingPort()
Definition: portsm_port.cpp:1522
PortMachine::ResumeReadDone
SM_RESULT ResumeReadDone()
Definition: portsm_frames.cpp:887
PortMachine::OnSystemReconnectWait
SM_RESULT OnSystemReconnectWait(_In_ PortEvent Event)
Definition: portsm_frames.cpp:1139
PortMachine::EnterSuspendedD3Cold
SM_RESULT EnterSuspendedD3Cold()
Definition: portsm_port.cpp:935
PortMachine::TIMER_FOLLOW_UP
TIMER_FOLLOW_UP
Definition: portsm.h:160
PortMachine::FollowOverCurrent
@ FollowOverCurrent
Definition: portsm.h:163
PortMachine::FollowOverCurrentCleared
@ FollowOverCurrentCleared
Definition: portsm.h:164
PortMachine::FollowConnect
@ FollowConnect
Definition: portsm.h:161
PortMachine::FollowCycle
@ FollowCycle
Definition: portsm.h:162
PortMachine::CheckPending20
SM_RESULT CheckPending20(_In_ const State *Acking, _In_ const State *Quiet)
Definition: portsm_frames.cpp:296
PortMachine::OnHubResetIssued
SM_RESULT OnHubResetIssued(_In_ PortEvent Event)
Definition: portsm_port.cpp:1380
PortMachine::DetachThen
SM_RESULT DetachThen(_In_ PortEvent Change)
Definition: portsm.cpp:426
PortMachine::OnResetEnabledWait
SM_RESULT OnResetEnabledWait(_In_ PortEvent Event)
Definition: portsm_port.cpp:1221
PortMachine::DetachTimed
SM_RESULT DetachTimed(_In_ PortEvent Change)
Definition: portsm.cpp:442
PortMachine::OnOldDeviceWait
SM_RESULT OnOldDeviceWait(_In_ PortEvent Event)
Definition: portsm_port.cpp:476
PortMachine::EnterPoweringPort
SM_RESULT EnterPoweringPort()
Definition: portsm_port.cpp:1480
PortMachine::ResetChangeChecking
static const State ResetChangeChecking
Definition: portsm.h:287
PortMachine::EnterResetWait
SM_RESULT EnterResetWait()
Definition: portsm_port.cpp:1175
PortMachine::EnterSettingLpmTimeout
SM_RESULT EnterSettingLpmTimeout()
Definition: portsm_port.cpp:1555
PortMachine::EnterResetTimeoutStatus
SM_RESULT EnterResetTimeoutStatus()
Definition: portsm_port.cpp:1588
PortMachine::OnOff
SM_RESULT OnOff(_In_ PortEvent Event)
Definition: portsm.cpp:657
PortMachine::OnD3DebounceFlush
SM_RESULT OnD3DebounceFlush(_In_ PortEvent Event)
Definition: portsm_frames.cpp:1532
PortMachine::DrainEmptyIdleUsb2
static const State DrainEmptyIdleUsb2
Definition: portsm.h:299
PortMachine::OnResetChangeIdle
SM_RESULT OnResetChangeIdle(_In_ PortEvent Event)
Definition: portsm_frames.cpp:437
PortMachine::EnterReadingStatus
SM_RESULT EnterReadingStatus()
Definition: portsm_port.cpp:1487
PortMachine::Returning
static const State Returning
Definition: portsm.h:344
PortMachine::EnterSendingSuspend
SM_RESULT EnterSendingSuspend()
Definition: portsm_port.cpp:1515
PortMachine::DebouncingUsb2
static const State DebouncingUsb2
Definition: portsm.h:210
PortMachine::OnDrainIdle
SM_RESULT OnDrainIdle(_In_ PortEvent Event)
Definition: portsm_frames.cpp:670
PortMachine::EnterStatusReporting
SM_RESULT EnterStatusReporting()
Definition: portsm_frames.cpp:638
PortMachine::SmStateChanged
VOID SmStateChanged()
The innermost frame that does not yield to its caller decides whether the port holds the hub awake.
Definition: portsm.cpp:227
PortMachine::HubResetTimerWait
static const State HubResetTimerWait
Definition: portsm.h:246
PortMachine::EnterD3PoweringUp
SM_RESULT EnterD3PoweringUp()
Definition: portsm_frames.cpp:1461
PortMachine::AttachFailedWait
static const State AttachFailedWait
Definition: portsm.h:249
PortMachine::EnterChangeReporting20
SM_RESULT EnterChangeReporting20()
Definition: portsm_frames.cpp:348
PortMachine::OnResetPollWait
SM_RESULT OnResetPollWait(_In_ PortEvent Event)
Definition: portsm_frames.cpp:478
PortMachine::m_Port
HubPort * m_Port
Definition: portsm.h:950
PortMachine::OnAttached
SM_RESULT OnAttached(_In_ PortEvent Event)
Definition: portsm_port.cpp:705
PortMachine::OnResetTimeoutStatus
SM_RESULT OnResetTimeoutStatus(_In_ PortEvent Event)
Definition: portsm_port.cpp:1904
PortMachine::FailToHubReset
SM_RESULT FailToHubReset()
Definition: portsm.cpp:648
PortMachine::m_ParkResetsHub
BOOLEAN m_ParkResetsHub
Definition: portsm.h:965
PortMachine::StatusQuiet
SM_RESULT StatusQuiet()
Definition: portsm_frames.cpp:577
PortMachine::EnterSuspendRecovery
SM_RESULT EnterSuspendRecovery()
Definition: portsm_frames.cpp:1282
PortMachine::ResumingAttached
static const State ResumingAttached
Definition: portsm.h:230
PortMachine::m_ReadKind
READ_KIND m_ReadKind
Definition: portsm.h:955
PortMachine::RecordPortSuspended
VOID RecordPortSuspended()
Definition: hubport.cpp:471
PortMachine::SendSuspend
VOID SendSuspend()
Definition: portxfer.cpp:206
PortMachine::ResetPollChecking
static const State ResetPollChecking
Definition: portsm.h:289
PortMachine::DisconnectDevice
VOID DisconnectDevice()
Definition: hubport.cpp:369
PortMachine::SmQueuePassive
VOID SmQueuePassive()
Definition: portsm.cpp:186
PortMachine::OverCurrentActive
BOOLEAN OverCurrentActive()
Definition: hubport.cpp:493
PortMachine::D3Idle
static const State D3Idle
Definition: portsm.h:333
PortMachine::m_HubPowerHeld
BOOLEAN m_HubPowerHeld
Definition: portsm.h:952
PortMachine::ResumeChangeIdle
static const State ResumeChangeIdle
Definition: portsm.h:290
PortMachine::EnterPowerUpResetHub
SM_RESULT EnterPowerUpResetHub()
Definition: portsm_frames.cpp:854
PortMachine::OnD3ReconnectWait
SM_RESULT OnD3ReconnectWait(_In_ PortEvent Event)
Definition: portsm_frames.cpp:1614
PortMachine::SendWarmReset
VOID SendWarmReset()
Definition: portxfer.cpp:184
PortMachine::m_SuspendReport
PortEvent m_SuspendReport
Definition: portsm.h:957
PortMachine::ChangeAcking20
static const State ChangeAcking20
Definition: portsm.h:280
PortMachine::BootDeviceReturning
BOOLEAN BootDeviceReturning()
Definition: hubport.cpp:558
PortMachine::EnterPlainStatusRead
SM_RESULT EnterPlainStatusRead()
Definition: portsm_frames.cpp:392
PortMachine::OnDisablingSuperSpeedOnRequest
SM_RESULT OnDisablingSuperSpeedOnRequest(_In_ PortEvent Event)
Definition: portsm_port.cpp:1861
PortMachine::ErrorRestarting
static const State ErrorRestarting
Definition: portsm.h:233
PortMachine::RecordPortDisabled
VOID RecordPortDisabled()
Definition: hubport.cpp:465
PortMachine::OnDrainEmptyIdle
SM_RESULT OnDrainEmptyIdle(_In_ PortEvent Event)
Definition: portsm_frames.cpp:700
PortMachine::ResumeSettling
static const State ResumeSettling
Definition: portsm.h:315
PortMachine::OnD3ReconnectFlush
SM_RESULT OnD3ReconnectFlush(_In_ PortEvent Event)
Definition: portsm_frames.cpp:1661
PortMachine::OnChangeIdle20
SM_RESULT OnChangeIdle20(_In_ PortEvent Event)
Definition: portsm_frames.cpp:285
PortMachine::OnResetChangeChecking
SM_RESULT OnResetChangeChecking(_In_ PortEvent Event)
Definition: portsm_frames.cpp:447
PortMachine::OnResetRequestWait
SM_RESULT OnResetRequestWait(_In_ PortEvent Event)
Definition: portsm_port.cpp:984
PortMachine::DrainEmptyIdleUsb3
static const State DrainEmptyIdleUsb3
Definition: portsm.h:300
PortMachine::OnErrorRestarting
SM_RESULT OnErrorRestarting(_In_ PortEvent Event)
Definition: portsm_port.cpp:1128
PortMachine::OnResumeSettling
SM_RESULT OnResumeSettling(_In_ PortEvent Event)
Definition: portsm_frames.cpp:916
PortMachine::PowerUpResetHub
static const State PowerUpResetHub
Definition: portsm.h:311
PortMachine::ReportSuspendChange
SM_RESULT ReportSuspendChange(_In_ PortEvent Report)
Definition: portsm_frames.cpp:1205
PortMachine::OnReadingForResume
SM_RESULT OnReadingForResume(_In_ PortEvent Event)
Definition: portsm_port.cpp:1794
PortMachine::EnterChangeParked20
SM_RESULT EnterChangeParked20()
Definition: portsm_frames.cpp:357
PortMachine::ResumeConnectCheck
SM_RESULT ResumeConnectCheck()
Definition: portsm_frames.cpp:893
PortMachine::D3DebounceFlush
static const State D3DebounceFlush
Definition: portsm.h:337
PortMachine::PowerUpRearming
static const State PowerUpRearming
Definition: portsm.h:312
PortMachine::QueryingOverCurrent
static const State QueryingOverCurrent
Definition: portsm.h:255
PortMachine::SendAckChange
VOID SendAckChange()
Definition: portxfer.cpp:167
PortMachine::D3PoweredOff
static const State D3PoweredOff
Definition: portsm.h:334
PortMachine::OnResumingAttached
SM_RESULT OnResumingAttached(_In_ PortEvent Event)
Definition: portsm_port.cpp:1046
PortMachine::OnSuspended
SM_RESULT OnSuspended(_In_ PortEvent Event)
Definition: portsm_port.cpp:839
PortMachine::DrainReading
static const State DrainReading
Definition: portsm.h:301
PortMachine::EnterNotifyingOverCurrent
SM_RESULT EnterNotifyingOverCurrent()
Definition: portsm_port.cpp:587
PortMachine::StatusFailed
SM_RESULT StatusFailed()
Definition: portsm_frames.cpp:565
PortMachine::OnResumeChangeIdle
SM_RESULT OnResumeChangeIdle(_In_ PortEvent Event)
Definition: portsm_frames.cpp:517
PortMachine::AllowsHubSuspend
BOOLEAN AllowsHubSuspend(_In_ const State *Target) const
Definition: portsm.cpp:216
PortMachine::OnOffResetNeeded
SM_RESULT OnOffResetNeeded(_In_ PortEvent Event)
Definition: portsm.cpp:738
PortMachine::LinkInU0
BOOLEAN LinkInU0()
Definition: hubport.cpp:510
PortMachine::DeviceConnected
BOOLEAN DeviceConnected()
Definition: hubport.cpp:477
PortMachine::NeedsDebounce
BOOLEAN NeedsDebounce()
Definition: hubport.cpp:565
PortMachine::EnablingSuperSpeedOnStop
static const State EnablingSuperSpeedOnStop
Definition: portsm.h:272
PortMachine::D3FlushThenReturn
static const State D3FlushThenReturn
Definition: portsm.h:338
PortMachine::Port
HubPort * Port() const
Definition: portsm.h:138
PortMachine::SendLinkDisable
VOID SendLinkDisable()
Definition: portxfer.cpp:215
PortMachine::EnterWithPortChange
SM_RESULT EnterWithPortChange()
Definition: portsm_port.cpp:305
PortMachine::OnD3Idle
SM_RESULT OnD3Idle(_In_ PortEvent Event)
Definition: portsm_frames.cpp:1391
PortMachine::m_D3PowerUpWarm
BOOLEAN m_D3PowerUpWarm
Definition: portsm.h:967
PortMachine::EnterArmingWake
SM_RESULT EnterArmingWake()
Definition: portsm_port.cpp:1594
PortMachine::EnterReconnectRearming
SM_RESULT EnterReconnectRearming()
Definition: portsm_frames.cpp:1049
PortMachine::SuperSpeedBlocked
BOOLEAN SuperSpeedBlocked()
Definition: portxfer.cpp:697
PortMachine::OverCurrentPersists
BOOLEAN OverCurrentPersists()
Definition: portxfer.cpp:704
PortMachine::OnAttachedDisabled
SM_RESULT OnAttachedDisabled(_In_ PortEvent Event)
Definition: portsm_port.cpp:786
PortMachine::EnterDraining
SM_RESULT EnterDraining()
Definition: portsm_port.cpp:1366
PortMachine::SendLinkRxDetect
VOID SendLinkRxDetect()
Definition: portxfer.cpp:221
PortMachine::OnDisabledInSuspend
SM_RESULT OnDisabledInSuspend(_In_ PortEvent Event)
Definition: portsm_port.cpp:903
PortMachine::m_ReadFresh
BOOLEAN m_ReadFresh
Definition: portsm.h:960
PortMachine::LogLinkStateError
VOID LogLinkStateError()
Definition: hubport.cpp:619
PortMachine::ArmingWake
static const State ArmingWake
Definition: portsm.h:275
PortMachine::ChangeChecking30
static const State ChangeChecking30
Definition: portsm.h:285
PortMachine::SendDisable
VOID SendDisable()
Definition: portxfer.cpp:191
PortMachine::HubResetWait
static const State HubResetWait
Definition: portsm.h:245
PortMachine::EnablingSuperSpeedOnTimer
static const State EnablingSuperSpeedOnTimer
Definition: portsm.h:273
PortMachine::ResumeAckWait
static const State ResumeAckWait
Definition: portsm.h:227
PortMachine::OnDrainAcking
SM_RESULT OnDrainAcking(_In_ PortEvent Event)
Definition: portsm_frames.cpp:726
PortMachine::OnOffSuspended
SM_RESULT OnOffSuspended(_In_ PortEvent Event)
Definition: portsm.cpp:796
PortMachine::StartReading30
static const State StartReading30
Definition: portsm.h:310
PortMachine::Off
static const State Off
Definition: portsm.h:195
PortMachine::NotifyUserOfOverCurrent
VOID NotifyUserOfOverCurrent()
Definition: hubport.cpp:604
PortMachine::ResumeSucceeded
SM_RESULT ResumeSucceeded()
Definition: portsm.cpp:631
PortMachine::D3ConnectCheck
SM_RESULT D3ConnectCheck(_In_ BOOLEAN AfterResume)
Definition: portsm_frames.cpp:1324
PortMachine::ResumeAckingConnect
static const State ResumeAckingConnect
Definition: portsm.h:317
PortMachine::DrainDone
SM_RESULT DrainDone()
Definition: portsm_frames.cpp:661
PortMachine::OnSendingReset
SM_RESULT OnSendingReset(_In_ PortEvent Event)
Definition: portsm_port.cpp:1632
PortMachine::TimedHubReset
SM_RESULT TimedHubReset()
Definition: portsm.cpp:576
PortMachine::TakeInterruptForReset
SM_RESULT TakeInterruptForReset(_In_ const State *Start, _In_ const State *Refused)
Definition: portsm.cpp:594
PortMachine::ResetChangeAccumulator
VOID ResetChangeAccumulator()
Definition: hubport.cpp:459
PortMachine::StopTimer
BOOLEAN StopTimer()
Definition: hubport.cpp:301
PortMachine::OffResetNeeded
static const State OffResetNeeded
Definition: portsm.h:199
PortMachine::StatusReporting
static const State StatusReporting
Definition: portsm.h:295
PortMachine::SmOnDequeue
VOID SmOnDequeue(_In_ PortEvent Event)
Definition: portsm.cpp:192
PortMachine::EnterReturning
SM_RESULT EnterReturning()
Definition: portsm.cpp:297
PortMachine::DrainRearming
static const State DrainRearming
Definition: portsm.h:303
PortMachine::EnterWakeArming
SM_RESULT EnterWakeArming()
Definition: portsm_frames.cpp:1680
PortMachine::OnD3FlushThenReturn
SM_RESULT OnD3FlushThenReturn(_In_ PortEvent Event)
Definition: portsm_frames.cpp:1556
PortMachine::HubArmedForWake
BOOLEAN HubArmedForWake()
Definition: fanout.cpp:1018
PortMachine::EnterStatusFailing
SM_RESULT EnterStatusFailing()
Definition: portsm_frames.cpp:645
PortMachine::ForceResetOnEnumeration
VOID ForceResetOnEnumeration()
Definition: hubport.cpp:451
PortMachine::ReconnectRearming
static const State ReconnectRearming
Definition: portsm.h:321
PortMachine::OffSuperSpeedDisabled
static const State OffSuperSpeedDisabled
Definition: portsm.h:200
PortMachine::FixPortStateAfterPowerUp
VOID FixPortStateAfterPowerUp()
Definition: portxfer.cpp:692
PortMachine::QuiescingForHubSuspend
static const State QuiescingForHubSuspend
Definition: portsm.h:263
PortMachine::OnSuspendReading
SM_RESULT OnSuspendReading(_In_ PortEvent Event)
An error on a port that is connected but no longer enabled counts as a connect.
Definition: portsm_frames.cpp:1217
PortMachine::PendingChange
PSM_PENDING PendingChange()
Definition: portxfer.cpp:301
PortMachine::SuspendIdle
static const State SuspendIdle
Definition: portsm.h:328
PortMachine::ReferencePort
VOID ReferencePort()
Definition: hubport.cpp:176
PortMachine::ReleaseAndStopTimer
SM_RESULT ReleaseAndStopTimer()
Definition: portsm.cpp:584
PortMachine::D3ReconnectWait
static const State D3ReconnectWait
Definition: portsm.h:340
PortMachine::ResetSucceeded
SM_RESULT ResetSucceeded()
Definition: portsm.cpp:606
PortMachine::FailDeviceRequest
SM_RESULT FailDeviceRequest()
Definition: portsm_frames.cpp:654
PortMachine::OnStatusReading
SM_RESULT OnStatusReading(_In_ PortEvent Event)
Definition: portsm_frames.cpp:592
PortMachine::EnterOffSuspended
SM_RESULT EnterOffSuspended()
Definition: portsm.cpp:789
PortMachine::PortPowered
BOOLEAN PortPowered()
Definition: hubport.cpp:516
PortMachine::PollResetCompletion
BOOLEAN PollResetCompletion()
Definition: hubport.cpp:545
PortMachine::HoldsHubPower
BOOLEAN HoldsHubPower() const
Definition: portsm.h:150
PortMachine::SendingSuspend
static const State SendingSuspend
Definition: portsm.h:259
PortMachine::OnSettingLpmTimeout
SM_RESULT OnSettingLpmTimeout(_In_ PortEvent Event)
Definition: portsm_port.cpp:1832
PortMachine::ReconnectAcking
static const State ReconnectAcking
Definition: portsm.h:320
PortMachine::OnOffSuperSpeedDisabled
SM_RESULT OnOffSuperSpeedDisabled(_In_ PortEvent Event)
Definition: portsm.cpp:763
PortMachine::UserResetWait
static const State UserResetWait
Definition: portsm.h:215
PortMachine::OnTimerFlush
SM_RESULT OnTimerFlush(_In_ PortEvent Event)
Definition: portsm_port.cpp:641
PortMachine::OffAttached
static const State OffAttached
Definition: portsm.h:198
PortMachine::DisablingSuperSpeed
static const State DisablingSuperSpeed
Definition: portsm.h:270
PortMachine::m_OldDevice
OLD_DEVICE_KIND m_OldDevice
Definition: portsm.h:954
PortMachine::TakeInterruptReference
BOOLEAN TakeInterruptReference()
Definition: fanout.cpp:994
PortMachine::Enabled
static const State Enabled
Definition: portsm.h:222
PortMachine::DisabledInSuspend
static const State DisabledInSuspend
Definition: portsm.h:225
PortMachine::OnEmptyHubResetTimerWait
SM_RESULT OnEmptyHubResetTimerWait(_In_ PortEvent Event)
Definition: portsm_port.cpp:1426
PortMachine::ClearPortStatus
VOID ClearPortStatus()
Definition: portxfer.cpp:685
PortMachine::m_D3FlushReturn
PortEvent m_D3FlushReturn
Definition: portsm.h:958
PortMachine::EnterDrainingEmpty
SM_RESULT EnterDrainingEmpty()
Definition: portsm_port.cpp:1373
PortMachine::HubPowerDrop
VOID HubPowerDrop()
Definition: hubport.cpp:218
PortMachine::OnResumeWait
SM_RESULT OnResumeWait(_In_ PortEvent Event)
Definition: portsm_port.cpp:1276
PortMachine::EnterDisablingSuperSpeedOnRequest
SM_RESULT EnterDisablingSuperSpeedOnRequest()
Definition: portsm_port.cpp:1573
PortMachine::ReconnectWait
static const State ReconnectWait
Definition: portsm.h:318
PortMachine::EnterPowerUpRearming
SM_RESULT EnterPowerUpRearming()
Definition: portsm_frames.cpp:861
PortMachine::D3PoweringUp
static const State D3PoweringUp
Definition: portsm.h:335
PortMachine::SystemResuming
static const State SystemResuming
Definition: portsm.h:232
PortMachine::OnStartReading30
SM_RESULT OnStartReading30(_In_ PortEvent Event)
Definition: portsm_frames.cpp:835
PortMachine::CheckConnection
SM_RESULT CheckConnection()
Definition: portsm.cpp:304
PortMachine::OnDisablingSuperSpeed
SM_RESULT OnDisablingSuperSpeed(_In_ PortEvent Event)
Definition: portsm_port.cpp:1851
PortMachine::DropHubResetReference
VOID DropHubResetReference()
Definition: fanout.cpp:988
PortMachine::DereferencePort
VOID DereferencePort()
Definition: hubport.cpp:182
PortMachine::ReconnectCheck
SM_RESULT ReconnectCheck()
Definition: portsm_frames.cpp:1007
PortMachine::OnDisablingOnResetTimeout
SM_RESULT OnDisablingOnResetTimeout(_In_ PortEvent Event)
Definition: portsm_port.cpp:1779
PortMachine::Transfer
static const State Transfer
Definition: portsm.h:253
PortMachine::Deleted
static const State Deleted
Definition: portsm.h:204
PortMachine::DisablingOnResetTimeout
static const State DisablingOnResetTimeout
Definition: portsm.h:266
PortMachine::SystemResumeFailed
SM_RESULT SystemResumeFailed()
Definition: portsm_frames.cpp:1091
PortMachine::IsSuperSpeed
BOOLEAN IsSuperSpeed() const
Definition: portsm.h:144
PortMachine::OverCurrentWait
static const State OverCurrentWait
Definition: portsm.h:213
PortMachine::ResetEnabledWait
static const State ResetEnabledWait
Definition: portsm.h:238
PortMachine::SuperSpeedOffWait
static const State SuperSpeedOffWait
Definition: portsm.h:250
PortMachine::SendingResume
static const State SendingResume
Definition: portsm.h:258
PortMachine::ReadingAfterResumeTimeout
static const State ReadingAfterResumeTimeout
Definition: portsm.h:268
PortMachine::StartOverCurrentWait
SM_RESULT StartOverCurrentWait()
Definition: portsm.cpp:418
PortMachine::OnSendingResume
SM_RESULT OnSendingResume(_In_ PortEvent Event)
Definition: portsm_port.cpp:1651
PortMachine::TakePortPowerReference
VOID TakePortPowerReference()
Definition: fanout.cpp:976
PortMachine::OnStartReading20
SM_RESULT OnStartReading20(_In_ PortEvent Event)
Definition: portsm_frames.cpp:802
PortMachine::OnPowerOnSettling
SM_RESULT OnPowerOnSettling(_In_ PortEvent Event)
Definition: portsm_frames.cpp:792
PortMachine::OnChangeReading20
SM_RESULT OnChangeReading20(_In_ PortEvent Event)
Definition: portsm_frames.cpp:322
PortMachine::OnDrainChecking
SM_RESULT OnDrainChecking(_In_ PortEvent Event)
Definition: portsm_frames.cpp:743
PortMachine::D3ResumeAckWait
static const State D3ResumeAckWait
Definition: portsm.h:339
PortMachine::ReconnectFlush
static const State ReconnectFlush
Definition: portsm.h:322
PortMachine::EnterSuspended
SM_RESULT EnterSuspended()
Definition: portsm_port.cpp:833
PortMachine::OnOffAttached
SM_RESULT OnOffAttached(_In_ PortEvent Event)
Definition: portsm.cpp:702
PortMachine::EnterSendingReset
SM_RESULT EnterSendingReset()
Definition: portsm_port.cpp:1494
PortMachine::m_AttachForcedReset
BOOLEAN m_AttachForcedReset
Definition: portsm.h:962
PortMachine::TellDevice
VOID TellDevice(_In_ PSM_DEVICE_NOTICE Notice)
Definition: hubport.cpp:309
PortMachine::m_LpmU2
BOOLEAN m_LpmU2
Definition: portsm.h:963
PortMachine::NextChange
PortEvent NextChange()
Definition: portxfer.cpp:555
PortMachine::OnEnabled
SM_RESULT OnEnabled(_In_ PortEvent Event)
Definition: portsm_port.cpp:729
PortMachine::Suspended
static const State Suspended
Definition: portsm.h:224
PortMachine::OnResumePowering
SM_RESULT OnResumePowering(_In_ PortEvent Event)
Definition: portsm_frames.cpp:902
PortMachine::OnDisablingForCycleTimed
SM_RESULT OnDisablingForCycleTimed(_In_ PortEvent Event)
Definition: portsm_port.cpp:1750
PortMachine::D3PendingDone
SM_RESULT D3PendingDone(_In_ D3_PENDING Pending)
Definition: portsm_frames.cpp:1361
PortMachine::ReadPlain
@ ReadPlain
Definition: portsm.h:178
PortMachine::ReadNoChange
@ ReadNoChange
Definition: portsm.h:179
PortMachine::ReadStartResume
@ ReadStartResume
Definition: portsm.h:180
PortMachine::ResumePowering
static const State ResumePowering
Definition: portsm.h:314
PortMachine::OnDisablingOnRequest
SM_RESULT OnDisablingOnRequest(_In_ PortEvent Event)
Definition: portsm_port.cpp:1685
PortMachine::OnDisablingOnSuspendTimed
SM_RESULT OnDisablingOnSuspendTimed(_In_ PortEvent Event)
Definition: portsm_port.cpp:1766
PortMachine::m_ArmForEmpty
BOOLEAN m_ArmForEmpty
Definition: portsm.h:964
PortMachine::D3StopReconnectTimer
SM_RESULT D3StopReconnectTimer(_In_ D3_PENDING Pending)
Definition: portsm_frames.cpp:1350
PortMachine::ResumeWait
static const State ResumeWait
Definition: portsm.h:240
PortMachine::StatusAcking
static const State StatusAcking
Definition: portsm.h:294
PortMachine::CancelUserOverCurrentReset
VOID CancelUserOverCurrentReset()
Definition: hubport.cpp:612
PortMachine::ResetHubThen
SM_RESULT ResetHubThen(_In_ const State *Target)
Definition: portsm.cpp:281
PortMachine::EnterResumingAttached
SM_RESULT EnterResumingAttached()
Definition: portsm_port.cpp:1037
PortMachine::SendGetStatus
VOID SendGetStatus()
Definition: portxfer.cpp:152
PortMachine::OffInitial
static const State OffInitial
Definition: portsm.h:196
PortMachine::OnReconnectAcking
SM_RESULT OnReconnectAcking(_In_ PortEvent Event)
Definition: portsm_frames.cpp:1036
PortMachine::FlushBeforeSuperSpeedOff
static const State FlushBeforeSuperSpeedOff
Definition: portsm.h:219
PortMachine::PowerOnSending
static const State PowerOnSending
Definition: portsm.h:306
PortMachine::ChangeReporting20
static const State ChangeReporting20
Definition: portsm.h:281
PortMachine::OnResumeRereading
SM_RESULT OnResumeRereading(_In_ PortEvent Event)
Definition: portsm_frames.cpp:1073
PortMachine::OnPowerUpParked
SM_RESULT OnPowerUpParked(_In_ PortEvent Event)
Definition: portsm_frames.cpp:868
PortMachine::OnResumeAckWaitStopped
SM_RESULT OnResumeAckWaitStopped(_In_ PortEvent Event)
Definition: portsm_port.cpp:968
PortMachine::OnDisablingBeforeConnect
SM_RESULT OnDisablingBeforeConnect(_In_ PortEvent Event)
Definition: portsm_port.cpp:1719
PortMachine::OnSuspendIdle
SM_RESULT OnSuspendIdle(_In_ PortEvent Event)
Definition: portsm_frames.cpp:1194
PortMachine::OnOffEmpty
SM_RESULT OnOffEmpty(_In_ PortEvent Event)
Definition: portsm.cpp:672
PortMachine::QueuePassiveWork
VOID QueuePassiveWork()
Definition: hubport.cpp:188
PortMachine::EnterHubResetIssued
SM_RESULT EnterHubResetIssued()
Definition: portsm_port.cpp:1359
PortMachine::MarkUsb3Device
VOID MarkUsb3Device()
Definition: hubport.cpp:445
PortMachine::OLD_DEVICE_KIND
OLD_DEVICE_KIND
Definition: portsm.h:169
PortMachine::OldDeviceResetInProgress
@ OldDeviceResetInProgress
Definition: portsm.h:172
PortMachine::OldDeviceResetNeeded
@ OldDeviceResetNeeded
Definition: portsm.h:171
PortMachine::OldDevicePlain
@ OldDevicePlain
Definition: portsm.h:170
PortMachine::OnStartingAttached
SM_RESULT OnStartingAttached(_In_ PortEvent Event)
Definition: portsm_port.cpp:1014
PortMachine::AttachedDisabled
static const State AttachedDisabled
Definition: portsm.h:223
PortMachine::ReadPortBits
VOID ReadPortBits(_Out_ PPSM_PORT_BITS Bits)
Definition: hubport.cpp:589
PortMachine::EnterOffEmpty
SM_RESULT EnterOffEmpty()
Definition: portsm.cpp:665
PortMachine::FlushBeforeOffEmpty
static const State FlushBeforeOffEmpty
Definition: portsm.h:217
PortMachine::HandleConnectedFault
SM_RESULT HandleConnectedFault(_In_ const State *Stay)
Handles a 2.0 port status that makes no sense for an attached port.
Definition: portsm.cpp:502
PortMachine::WakeArming
static const State WakeArming
Definition: portsm.h:343
PortMachine::ResetFlush
static const State ResetFlush
Definition: portsm.h:239
PortMachine::OnSuspendRecovery
SM_RESULT OnSuspendRecovery(_In_ PortEvent Event)
Definition: portsm_frames.cpp:1289
PortMachine::EnterAckingChange
SM_RESULT EnterAckingChange()
Definition: portsm_frames.cpp:276
PortMachine::OnEmptyHubResetWait
SM_RESULT OnEmptyHubResetWait(_In_ PortEvent Event)
Definition: portsm_port.cpp:1416
PortMachine::Timed
static const State Timed
Definition: portsm.h:236
PortMachine::StartReading20
static const State StartReading20
Definition: portsm.h:308
PortMachine::NotifyingOverCurrent
static const State NotifyingOverCurrent
Definition: portsm.h:214
PortMachine::ResetPollWait
static const State ResetPollWait
Definition: portsm.h:288
PortMachine::OnEmpty
SM_RESULT OnEmpty(_In_ PortEvent Event)
Definition: portsm_port.cpp:313
PortMachine::CheckOldDevice
SM_RESULT CheckOldDevice(_In_ OLD_DEVICE_KIND Kind)
Definition: portsm.cpp:316
PortMachine::m_D3Pending
D3_PENDING m_D3Pending
Definition: portsm.h:956
PortMachine::OnDrainReading
SM_RESULT OnDrainReading(_In_ PortEvent Event)
Definition: portsm_frames.cpp:710
PortMachine::Empty
static const State Empty
Definition: portsm.h:206
PortMachine::OffSuspendedUsb3
static const State OffSuspendedUsb3
Definition: portsm.h:201
PortMachine::OnStartingEmpty
SM_RESULT OnStartingEmpty(_In_ PortEvent Event)
Definition: portsm_port.cpp:368
PortMachine::ChangeReading20
static const State ChangeReading20
Definition: portsm.h:279
PortMachine::NotifyBootDeviceRemoval
VOID NotifyBootDeviceRemoval()
Definition: hubport.cpp:416
PortMachine::OnResetFlush
SM_RESULT OnResetFlush(_In_ PortEvent Event)
Definition: portsm_port.cpp:1248
PortMachine::OnD3PoweredOff
SM_RESULT OnD3PoweredOff(_In_ PortEvent Event)
Definition: portsm_frames.cpp:1437
PortMachine::PoweringPort
static const State PoweringPort
Definition: portsm.h:254
PortMachine::StatusFailing
static const State StatusFailing
Definition: portsm.h:296
PortMachine::ConnectDevice
BOOLEAN ConnectDevice()
Definition: hubport.cpp:346
PortMachine::MarkOverCurrentCause
VOID MarkOverCurrentCause()
Definition: hubport.cpp:504
PortMachine::EnterCleaningUp
SM_RESULT EnterCleaningUp()
Definition: portsm.cpp:827
PortMachine::OnDebouncing
SM_RESULT OnDebouncing(_In_ PortEvent Event)
Definition: portsm_port.cpp:396
PortMachine::SystemResumeReading
static const State SystemResumeReading
Definition: portsm.h:324
PortMachine::MarkUsb2Device
VOID MarkUsb2Device()
Definition: hubport.cpp:439
PortMachine::SuspendedD3Cold
static const State SuspendedD3Cold
Definition: portsm.h:226
PortMachine::ReattachOrCreate
SM_RESULT ReattachOrCreate(_In_ OLD_DEVICE_KIND Kind)
Definition: portsm.cpp:381
PortMachine::SuspendRecovery
static const State SuspendRecovery
Definition: portsm.h:331
PortMachine::ResumeFlush
static const State ResumeFlush
Definition: portsm.h:242
PortMachine::EnterResetPollWait
SM_RESULT EnterResetPollWait()
Definition: portsm_frames.cpp:471
PortMachine::PowerOnSettling
static const State PowerOnSettling
Definition: portsm.h:307
PortMachine::EnterSuspendReporting
SM_RESULT EnterSuspendReporting()
Definition: portsm_frames.cpp:1299
PortMachine::SendU2Timeout
VOID SendU2Timeout()
Definition: portxfer.cpp:250
PortMachine::OnCleaningUp
SM_RESULT OnCleaningUp(_In_ PortEvent Event)
Definition: portsm.cpp:834
PortMachine::SendingReset
static const State SendingReset
Definition: portsm.h:256
PortMachine::Debouncing
static const State Debouncing
Definition: portsm.h:209
PortMachine::DropPortPowerReference
VOID DropPortPowerReference()
Definition: fanout.cpp:982
PortMachine::SystemResumeRereading
static const State SystemResumeRereading
Definition: portsm.h:326
PortMachine::OnFlushBeforeOff
SM_RESULT OnFlushBeforeOff(_In_ PortEvent Event)
Definition: portsm_port.cpp:690
PortMachine::StartingAttached
static const State StartingAttached
Definition: portsm.h:229
PortMachine::OnResetPollChecking
SM_RESULT OnResetPollChecking(_In_ PortEvent Event)
Definition: portsm_frames.cpp:494
PortMachine::ResetWait
static const State ResetWait
Definition: portsm.h:237
PortMachine::SendPortPower
VOID SendPortPower()
Definition: portxfer.cpp:228
PortMachine::DisablingOnSuspendTimed
static const State DisablingOnSuspendTimed
Definition: portsm.h:265
PortMachine::m_ReturnEvent
PortEvent m_ReturnEvent
Definition: portsm.h:959
PortMachine::StartTimer
VOID StartTimer(_In_ PSM_TIMER Timer)
Definition: hubport.cpp:230
PortMachine::EnterPowerOnSettling
SM_RESULT EnterPowerOnSettling()
Definition: portsm_frames.cpp:785
PortMachine::OldDeviceWait
static const State OldDeviceWait
Definition: portsm.h:212
PortMachine::OnDisablingForCycle
SM_RESULT OnDisablingForCycle(_In_ PortEvent Event)
Definition: portsm_port.cpp:1706
PortMachine::ResumeReading
static const State ResumeReading
Definition: portsm.h:316
PortMachine::SmDereference
VOID SmDereference()
Definition: portsm.cpp:180
PortMachine::HubPowerTake
BOOLEAN HubPowerTake()
Definition: hubport.cpp:198
PortMachine::OnD3PoweringUp
SM_RESULT OnD3PoweringUp(_In_ PortEvent Event)
Definition: portsm_frames.cpp:1467
PortMachine::DeviceArrived
SM_RESULT DeviceArrived(_In_ OLD_DEVICE_KIND Kind)
Drops requests the previous device left behind, then reattaches or creates a device.
Definition: portsm.cpp:333
PortMachine::DrainAcking
static const State DrainAcking
Definition: portsm.h:302
PortMachine::OnEnablingSuperSpeedOnStop
SM_RESULT OnEnablingSuperSpeedOnStop(_In_ PortEvent Event)
Definition: portsm_port.cpp:1877
PortMachine::OnReadingAfterResumeTimeout
SM_RESULT OnReadingAfterResumeTimeout(_In_ PortEvent Event)
Definition: portsm_port.cpp:1814
PortMachine::SmReference
VOID SmReference()
Definition: portsm.cpp:174
PortMachine::OnResumeAckWait
SM_RESULT OnResumeAckWait(_In_ PortEvent Event)
Definition: portsm_port.cpp:941
PortMachine::EnterResumeWait
SM_RESULT EnterResumeWait()
Definition: portsm_port.cpp:1270
PortMachine::m_AfterTimer
TIMER_FOLLOW_UP m_AfterTimer
Definition: portsm.h:953
PortMachine::SsLinkDisabled
static const State SsLinkDisabled
Definition: portsm.h:251
PortMachine::OnReconnectReading
SM_RESULT OnReconnectReading(_In_ PortEvent Event)
Definition: portsm_frames.cpp:1023
PortMachine::ResumeStateDisabled
SM_RESULT ResumeStateDisabled()
Definition: portsm_frames.cpp:880
PortMachine::DisablingBeforeConnect
static const State DisablingBeforeConnect
Definition: portsm.h:262
PortMachine::EnterDebouncing
SM_RESULT EnterDebouncing()
Definition: portsm_port.cpp:389
PortMachine::ResumeInterruptTransfer
VOID ResumeInterruptTransfer()
Definition: fanout.cpp:1012
PortMachine::EnterDrainRearming
SM_RESULT EnterDrainRearming()
Definition: portsm_frames.cpp:736
PortMachine::EnterDisconnected
SM_RESULT EnterDisconnected()
Definition: portsm_port.cpp:355
PortMachine::ReturnFromFrame
SM_RESULT ReturnFromFrame(_In_ PortEvent Event)
Definition: portsm.cpp:289
PortMachine::DevicePresent
BOOLEAN DevicePresent()
Definition: hubport.cpp:484
PortMachine::D3ColdEnabled
BOOLEAN D3ColdEnabled()
Definition: hubport.cpp:572
PortMachine::OnSsLinkDisabled
SM_RESULT OnSsLinkDisabled(_In_ PortEvent Event)
Definition: portsm_port.cpp:1468
PortMachine::OnTimed
SM_RESULT OnTimed(_In_ PortEvent Event)
Definition: portsm_port.cpp:1154
PortMachine::ErrorResponse
PortEvent ErrorResponse()
Definition: portxfer.cpp:673
PortMachine::LostChange
PortEvent LostChange()
Definition: portxfer.cpp:593
PortMachine::CreateDevice
BOOLEAN CreateDevice()
Definition: hubport.cpp:339
PortMachine::CycleDetach
SM_RESULT CycleDetach()
Definition: portsm.cpp:466
PortMachine::D3Debouncing
static const State D3Debouncing
Definition: portsm.h:336
PortMachine::DebouncingUsb3
static const State DebouncingUsb3
Definition: portsm.h:211
PortMachine::OnEnablingSuperSpeedOnTimer
SM_RESULT OnEnablingSuperSpeedOnTimer(_In_ PortEvent Event)
Definition: portsm_port.cpp:1890
PortMachine::m_WarmResume
BOOLEAN m_WarmResume
Definition: portsm.h:961
PortMachine::EnterStartingAttached
SM_RESULT EnterStartingAttached()
Definition: portsm_port.cpp:1008
PortMachine::OnStartReadingFirst
SM_RESULT OnStartReadingFirst(_In_ PortEvent Event)
Definition: portsm_frames.cpp:819
PortMachine::SendU1Timeout
VOID SendU1Timeout()
Definition: portxfer.cpp:238
PortMachine::ParkChange20
SM_RESULT ParkChange20(_In_ BOOLEAN ResetHub)
Definition: portsm_frames.cpp:314
PortMachine::OnResumeRecovery
SM_RESULT OnResumeRecovery(_In_ PortEvent Event)
Definition: portsm_port.cpp:1312
PortMachine::ReconnectStatusFailed
SM_RESULT ReconnectStatusFailed()
Definition: portsm_frames.cpp:999
PortMachine::OnD3ResumeAckWait
SM_RESULT OnD3ResumeAckWait(_In_ PortEvent Event)
Definition: portsm_frames.cpp:1566
PortMachine::SuspendReading
static const State SuspendReading
Definition: portsm.h:329
PortMachine::TimedError
SM_RESULT TimedError(_In_ const State *Stay, _In_ BOOLEAN DuringReset)
Definition: portsm.cpp:537
PortMachine::ResetTransferFailed
SM_RESULT ResetTransferFailed()
Definition: portsm.cpp:614
PortMachine::DisablingSuperSpeedOnRequest
static const State DisablingSuperSpeedOnRequest
Definition: portsm.h:271
PortMachine::OnSendingSuspend
SM_RESULT OnSendingSuspend(_In_ PortEvent Event)
Definition: portsm_port.cpp:1668
PortMachine::SystemReconnectWait
static const State SystemReconnectWait
Definition: portsm.h:325
PortMachine::StopTimerThen
SM_RESULT StopTimerThen(_In_ TIMER_FOLLOW_UP FollowUp)
Definition: portsm.cpp:474
PortMachine::OnPowerOnSending
SM_RESULT OnPowerOnSending(_In_ PortEvent Event)
Definition: portsm_frames.cpp:768
PortMachine::OnUserResetWait
SM_RESULT OnUserResetWait(_In_ PortEvent Event)
Definition: portsm_port.cpp:594
PortMachine::OnResetWait
SM_RESULT OnResetWait(_In_ PortEvent Event)
Definition: portsm_port.cpp:1187
PortMachine::FollowTimer
SM_RESULT FollowTimer(_In_ TIMER_FOLLOW_UP FollowUp)
Definition: portsm.cpp:485
PortMachine::ResetTimeoutStatus
static const State ResetTimeoutStatus
Definition: portsm.h:274
PortMachine::m_ReconnectFlushOnStop
BOOLEAN m_ReconnectFlushOnStop
Definition: portsm.h:968
PortMachine::EnterSendingResume
SM_RESULT EnterSendingResume()
Definition: portsm_port.cpp:1508
PortMachine::HubResetIssued
static const State HubResetIssued
Definition: portsm.h:244
PortMachine::SendingWarmReset
static const State SendingWarmReset
Definition: portsm.h:257
PortMachine::OnD3Debouncing
SM_RESULT OnD3Debouncing(_In_ PortEvent Event)
Definition: portsm_frames.cpp:1492
PortMachine::EnterSendingWarmReset
SM_RESULT EnterSendingWarmReset()
Definition: portsm_port.cpp:1501
PortMachine::EventInfo
static const SM_EVENT_INFO EventInfo[]
Definition: portsm.h:155
PortMachine::ResumeRecovery
static const State ResumeRecovery
Definition: portsm.h:241
PortMachine::D3ReconnectFlush
static const State D3ReconnectFlush
Definition: portsm.h:341
PortMachine::KeepHubAwake
VOID KeepHubAwake()
Definition: portsm.cpp:257
PortMachine::OnChangeIdle30
SM_RESULT OnChangeIdle30(_In_ PortEvent Event)
Definition: portsm_frames.cpp:404
PortMachine::D3StopDebounceTimer
SM_RESULT D3StopDebounceTimer()
Definition: portsm_frames.cpp:1341
PortMachine::ChangeParked20
static const State ChangeParked20
Definition: portsm.h:282
PortMachine::OnQueryingOverCurrent
SM_RESULT OnQueryingOverCurrent(_In_ PortEvent Event)
Definition: portsm_port.cpp:1613
PortMachine::ReadingForResume
static const State ReadingForResume
Definition: portsm.h:267
PortMachine::ReconnectReading
static const State ReconnectReading
Definition: portsm.h:319
PortMachine::SuspendReporting
static const State SuspendReporting
Definition: portsm.h:332
PortMachine::ChangeIdle20
static const State ChangeIdle20
Definition: portsm.h:278
PortMachine::OnSuspendAcking
SM_RESULT OnSuspendAcking(_In_ PortEvent Event)
Definition: portsm_frames.cpp:1269
PortMachine::m_Usb3
BOOLEAN m_Usb3
Definition: portsm.h:951
PortMachine::EnterStatusReading
SM_RESULT EnterStatusReading()
Definition: portsm_frames.cpp:551
PortMachine::OnResumingDisabled
SM_RESULT OnResumingDisabled(_In_ PortEvent Event)
Definition: portsm_port.cpp:1071
PortMachine::RequestHubReset
VOID RequestHubReset()
Definition: fanout.cpp:1006
PortMachine::EnterSystemResuming
SM_RESULT EnterSystemResuming()
Definition: portsm_port.cpp:1093
PortMachine::ResetChangeIdle
static const State ResetChangeIdle
Definition: portsm.h:286
PortMachine::Disconnected
static const State Disconnected
Definition: portsm.h:207
PortMachine::OffSuspendedUsb2
static const State OffSuspendedUsb2
Definition: portsm.h:202
PortMachine::ConnectChangedOnResume
BOOLEAN ConnectChangedOnResume()
Definition: hubport.cpp:523
PortMachine::ResumeChangeChecking
static const State ResumeChangeChecking
Definition: portsm.h:291
PortMachine::StatusReading
static const State StatusReading
Definition: portsm.h:293
PortMachine::OnSystemResuming
SM_RESULT OnSystemResuming(_In_ PortEvent Event)
Definition: portsm_port.cpp:1099
PortMachine::SettingLpmTimeout
static const State SettingLpmTimeout
Definition: portsm.h:269
PortMachine::ForgetDetachedDevice
VOID ForgetDetachedDevice()
Definition: hubport.cpp:389
PortMachine::OnSystemResumeRereading
SM_RESULT OnSystemResumeRereading(_In_ PortEvent Event)
Definition: portsm_frames.cpp:1165
PortMachine::EnterStartResumeStatusRead
SM_RESULT EnterStartResumeStatusRead()
Definition: portsm_frames.cpp:398
PortMachine::OnChangeParked20
SM_RESULT OnChangeParked20(_In_ PortEvent Event)
Definition: portsm_frames.cpp:371
PortMachine::m_DrainReturnsEmpty
BOOLEAN m_DrainReturnsEmpty
Definition: portsm.h:969
PortMachine::FlushBeforeOffAttached
static const State FlushBeforeOffAttached
Definition: portsm.h:218
PortMachine::StartingEmpty
static const State StartingEmpty
Definition: portsm.h:208
PortMachine::SendResume
VOID SendResume()
Definition: portxfer.cpp:197
PortMachine::OnChangeChecking30
SM_RESULT OnChangeChecking30(_In_ PortEvent Event)
Definition: portsm_frames.cpp:414
PortMachine::DrainChecking
static const State DrainChecking
Definition: portsm.h:304
PortMachine::ResumingDisabled
static const State ResumingDisabled
Definition: portsm.h:231
PortMachine::OnResumeChangeChecking
SM_RESULT OnResumeChangeChecking(_In_ PortEvent Event)
Definition: portsm_frames.cpp:527
PortMachine::DisablingOnRequest
static const State DisablingOnRequest
Definition: portsm.h:260
SmMachine
Run to completion engine. The first thread to post into an idle machine drains the queue; everyone el...
Definition: smengine.h:114
Event
_Check_return_ _In_ DXGK_EVENT_TYPE _In_ ULONG Event
Definition: dispmprt.h:1287
FALSE
#define FALSE
Definition: types.h:117
Pending
@ Pending
Definition: fs_rec.h:186
Report
static void Report(const char *msg)
Definition: glmodeswitch.c:58
_Out_
#define _Out_
Definition: no_sal2.h:160
_In_
#define _In_
Definition: no_sal2.h:158
Idle
@ Idle
Definition: ntdd8042.h:62
Enable
_In_ ULONGLONG _In_ ULONGLONG _In_ BOOLEAN Enable
Definition: ntddpcm.h:142
PPSM_PORT_BITS
struct _PSM_PORT_BITS * PPSM_PORT_BITS
PSM_PORT_BITS
struct _PSM_PORT_BITS PSM_PORT_BITS
PSM_TIMER
enum _PSM_TIMER PSM_TIMER
PortEvent
PortEvent
Definition: portsm.h:15
PortEvent::ErrorEnabledOnConnect
@ ErrorEnabledOnConnect
PortEvent::HubResumedWithReset
@ HubResumedWithReset
PortEvent::ChangeOverCurrentCleared
@ ChangeOverCurrentCleared
PortEvent::ErrorDisableAndCycle
@ ErrorDisableAndCycle
PortEvent::ChangeNeedsHubReset
@ ChangeNeedsHubReset
PortEvent::DisableSuperSpeedRequest
@ DisableSuperSpeedRequest
PortEvent::ChangeNeedsReset
@ ChangeNeedsReset
PortEvent::WarmResetRequest
@ WarmResetRequest
PortEvent::ResetPollExpired
@ ResetPollExpired
PortEvent::ErrorEnabledWhileReset
@ ErrorEnabledWhileReset
PortEvent::UserOverCurrentReset
@ UserOverCurrentReset
PortEvent::HibernateRequest
@ HibernateRequest
PortEvent::ChangeOverCurrent
@ ChangeOverCurrent
_PSM_DEVICE_NOTICE
_PSM_DEVICE_NOTICE
Definition: portsm.h:73
PsmNoticeDisabled
@ PsmNoticeDisabled
Definition: portsm.h:75
PsmNoticeResumeTimedOut
@ PsmNoticeResumeTimedOut
Definition: portsm.h:80
PsmNoticeSuspended
@ PsmNoticeSuspended
Definition: portsm.h:78
PsmNoticeStateEnabled
@ PsmNoticeStateEnabled
Definition: portsm.h:82
PsmNoticeResetRefused
@ PsmNoticeResetRefused
Definition: portsm.h:76
PsmNoticeResumeRefused
@ PsmNoticeResumeRefused
Definition: portsm.h:79
PsmNoticeResetTimedOut
@ PsmNoticeResetTimedOut
Definition: portsm.h:84
PsmNoticeEnabledOnReconnect
@ PsmNoticeEnabledOnReconnect
Definition: portsm.h:87
PsmNoticeStateSuspended
@ PsmNoticeStateSuspended
Definition: portsm.h:83
PsmNoticeResumed
@ PsmNoticeResumed
Definition: portsm.h:77
PsmNoticeFailed
@ PsmNoticeFailed
Definition: portsm.h:74
PsmNoticeStateDisabled
@ PsmNoticeStateDisabled
Definition: portsm.h:81
PsmNoticeResetComplete
@ PsmNoticeResetComplete
Definition: portsm.h:85
PsmNoticeTimeoutUpdated
@ PsmNoticeTimeoutUpdated
Definition: portsm.h:86
_PSM_PENDING
_PSM_PENDING
Definition: portsm.h:107
PsmPendingNone
@ PsmPendingNone
Definition: portsm.h:109
PsmPendingError
@ PsmPendingError
Definition: portsm.h:110
PsmPendingChange
@ PsmPendingChange
Definition: portsm.h:108
_PSM_TIMER
_PSM_TIMER
Definition: portsm.h:92
PsmTimerResetPoll
@ PsmTimerResetPoll
Definition: portsm.h:102
PsmTimerResumeCompletion
@ PsmTimerResumeCompletion
Definition: portsm.h:96
PsmTimerReconnect
@ PsmTimerReconnect
Definition: portsm.h:99
PsmTimerOverCurrent
@ PsmTimerOverCurrent
Definition: portsm.h:94
PsmTimerResumeRecovery
@ PsmTimerResumeRecovery
Definition: portsm.h:97
PsmTimerPowerOn
@ PsmTimerPowerOn
Definition: portsm.h:98
PsmTimerSuperSpeedDisable
@ PsmTimerSuperSpeedDisable
Definition: portsm.h:101
PsmTimerDebounce
@ PsmTimerDebounce
Definition: portsm.h:93
PsmTimerD3ColdReconnect
@ PsmTimerD3ColdReconnect
Definition: portsm.h:100
PsmTimerResetCompletion
@ PsmTimerResetCompletion
Definition: portsm.h:95
PSM_DEVICE_NOTICE
enum _PSM_DEVICE_NOTICE PSM_DEVICE_NOTICE
PSM_PENDING
enum _PSM_PENDING PSM_PENDING
SmState
One state. Handler gets every event the state sees.
Definition: smengine.h:93
_PSM_PORT_BITS
Definition: portsm.h:115
_PSM_PORT_BITS::OverCurrentChanged
BOOLEAN OverCurrentChanged
Definition: portsm.h:119
_PSM_PORT_BITS::Connected
BOOLEAN Connected
Definition: portsm.h:116
_PSM_PORT_BITS::Enabled
BOOLEAN Enabled
Definition: portsm.h:117
_PSM_PORT_BITS::OverCurrent
BOOLEAN OverCurrent
Definition: portsm.h:118
_SM_EVENT_INFO
Definition: smengine.h:31
_SM_RESULT
Definition: smengine.h:56
UCHAR
unsigned char UCHAR
Definition: typedefs.h:53
Target
_In_ WDFIOTARGET Target
Definition: wdfrequest.h:306
Initialize
static void Initialize()
Definition: xlate.c:212