portsm.h File Reference

#include <drivers/usb3/smengine.h>

Include dependency graph for portsm.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	_PSM_PORT_BITS
class	PortMachine

Macros
#define	PSM_STATE_IDLE_USB2   0x00000100
#define	PSM_STATE_IDLE_USB3   0x00000200
#define	PSM_STATE_IDLE   (PSM_STATE_IDLE_USB2 | PSM_STATE_IDLE_USB3)

Typedefs
typedef enum _PSM_DEVICE_NOTICE	PSM_DEVICE_NOTICE
typedef enum _PSM_TIMER	PSM_TIMER
typedef enum _PSM_PENDING	PSM_PENDING
typedef struct _PSM_PORT_BITS	PSM_PORT_BITS
typedef struct _PSM_PORT_BITS *	PPSM_PORT_BITS

Enumerations
enum class	PortEvent : UCHAR {   TimerExpired , ResetPollExpired , TransferDone , TransferFailed ,   PortCleanup , HubStarted , HubResumed , HubResumedInS0 ,   HubResumedWithReset , HubStopping , HubSuspending , HubResetting ,   StatusChanged , HubRemoved , UserOverCurrentReset , DeviceGone ,   HibernateRequest , CycleRequest , DisableRequest , DisableSuperSpeedRequest ,   ResetRequest , WarmResetRequest , ResumeRequest , SuspendRequest ,   SetU1Timeout , SetU2Timeout , ChangeConnect , ChangeOverCurrent ,   ChangeOverCurrentCleared , ChangeResetDone , ChangeResumed , ChangeDisabled ,   ChangeError , ChangeLinkError , ChangeNone , ChangeResetBusy ,   ChangeNeedsHubReset , ChangeNeedsReset , ErrorIgnore , ErrorCycle ,   ErrorDisableAndCycle , ErrorEnabledOnConnect , ErrorEnabledWhileReset , SubDone ,   Count }
enum	_PSM_DEVICE_NOTICE {   PsmNoticeFailed , PsmNoticeDisabled , PsmNoticeResetRefused , PsmNoticeResumed ,   PsmNoticeSuspended , PsmNoticeResumeRefused , PsmNoticeResumeTimedOut , PsmNoticeStateDisabled ,   PsmNoticeStateEnabled , PsmNoticeStateSuspended , PsmNoticeResetTimedOut , PsmNoticeResetComplete ,   PsmNoticeTimeoutUpdated , PsmNoticeEnabledOnReconnect }
enum	_PSM_TIMER {   PsmTimerDebounce , PsmTimerOverCurrent , PsmTimerResetCompletion , PsmTimerResumeCompletion ,   PsmTimerResumeRecovery , PsmTimerPowerOn , PsmTimerReconnect , PsmTimerD3ColdReconnect ,   PsmTimerSuperSpeedDisable , PsmTimerResetPoll }
enum	_PSM_PENDING { PsmPendingChange , PsmPendingNone , PsmPendingError }

Macro Definition Documentation

PSM_STATE_IDLE

#define PSM_STATE_IDLE   (PSM_STATE_IDLE_USB2 | PSM_STATE_IDLE_USB3)

Definition at line 125 of file portsm.h.

PSM_STATE_IDLE_USB2

#define PSM_STATE_IDLE_USB2   0x00000100

A 2.0 port resting here lets the hub suspend

Definition at line 123 of file portsm.h.

PSM_STATE_IDLE_USB3

#define PSM_STATE_IDLE_USB3   0x00000200

Same for a 3.0 port

Definition at line 124 of file portsm.h.

Typedef Documentation

PPSM_PORT_BITS

typedef struct _PSM_PORT_BITS * PPSM_PORT_BITS

PSM_DEVICE_NOTICE

typedef enum _PSM_DEVICE_NOTICE PSM_DEVICE_NOTICE

Notices the port sends to the device machine.

PSM_PENDING

typedef enum _PSM_PENDING PSM_PENDING

Answer of the "is a change bit still set" query.

PSM_PORT_BITS

typedef struct _PSM_PORT_BITS PSM_PORT_BITS

Saved 2.0 port status bits the two status decisions look at.

PSM_TIMER

typedef enum _PSM_TIMER PSM_TIMER

What the single port timer is armed for.

Enumeration Type Documentation

_PSM_DEVICE_NOTICE

enum _PSM_DEVICE_NOTICE

Notices the port sends to the device machine.

Enumerator
PsmNoticeFailed
PsmNoticeDisabled
PsmNoticeResetRefused
PsmNoticeResumed
PsmNoticeSuspended
PsmNoticeResumeRefused
PsmNoticeResumeTimedOut
PsmNoticeStateDisabled
PsmNoticeStateEnabled
PsmNoticeStateSuspended
PsmNoticeResetTimedOut
PsmNoticeResetComplete
PsmNoticeTimeoutUpdated
PsmNoticeEnabledOnReconnect

Definition at line 72 of file portsm.h.

{
    PsmNoticeFailed,
    PsmNoticeDisabled,
    PsmNoticeResetRefused,
    PsmNoticeResumed,
    PsmNoticeSuspended,
    PsmNoticeResumeRefused,
    PsmNoticeResumeTimedOut,
    PsmNoticeStateDisabled,
    PsmNoticeStateEnabled,
    PsmNoticeStateSuspended,
    PsmNoticeResetTimedOut,
    PsmNoticeResetComplete,
    PsmNoticeTimeoutUpdated,
    PsmNoticeEnabledOnReconnect
} PSM_DEVICE_NOTICE;

_PSM_PENDING

enum _PSM_PENDING

Answer of the "is a change bit still set" query.

Enumerator
PsmPendingChange
PsmPendingNone
PsmPendingError

Definition at line 106 of file portsm.h.

{
    PsmPendingChange,
    PsmPendingNone,
    PsmPendingError
} PSM_PENDING;

_PSM_TIMER

enum _PSM_TIMER

What the single port timer is armed for.

Enumerator
PsmTimerDebounce
PsmTimerOverCurrent
PsmTimerResetCompletion
PsmTimerResumeCompletion
PsmTimerResumeRecovery
PsmTimerPowerOn
PsmTimerReconnect
PsmTimerD3ColdReconnect
PsmTimerSuperSpeedDisable
PsmTimerResetPoll

Definition at line 91 of file portsm.h.

{
    PsmTimerDebounce,
    PsmTimerOverCurrent,
    PsmTimerResetCompletion,
    PsmTimerResumeCompletion,
    PsmTimerResumeRecovery,
    PsmTimerPowerOn,
    PsmTimerReconnect,
    PsmTimerD3ColdReconnect,
    PsmTimerSuperSpeedDisable,
    PsmTimerResetPoll
} PSM_TIMER;

PortEvent

enum class PortEvent : UCHAR

strong

Enumerator
TimerExpired
ResetPollExpired
TransferDone
TransferFailed
PortCleanup
HubStarted
HubResumed
HubResumedInS0
HubResumedWithReset
HubStopping
HubSuspending
HubResetting
StatusChanged
HubRemoved
UserOverCurrentReset
DeviceGone
HibernateRequest
CycleRequest
DisableRequest
DisableSuperSpeedRequest
ResetRequest
WarmResetRequest
ResumeRequest
SuspendRequest
SetU1Timeout
SetU2Timeout
ChangeConnect
ChangeOverCurrent
ChangeOverCurrentCleared
ChangeResetDone
ChangeResumed
ChangeDisabled
ChangeError
ChangeLinkError
ChangeNone
ChangeResetBusy
ChangeNeedsHubReset
ChangeNeedsReset
ErrorIgnore
ErrorCycle
ErrorDisableAndCycle
ErrorEnabledOnConnect
ErrorEnabledWhileReset
SubDone
Count

Definition at line 14 of file portsm.h.

{
    /* Timers and port control transfers */
    TimerExpired,
    ResetPollExpired,
    TransferDone,
    TransferFailed,
 
    /* Hub machine fan out and port object lifetime */
    PortCleanup,
    HubStarted,
    HubResumed,
    HubResumedInS0,
    HubResumedWithReset,
    HubStopping,
    HubSuspending,
    HubResetting,
    StatusChanged,
    HubRemoved,
    UserOverCurrentReset,
 
    /* From the device machine */
    DeviceGone,
    HibernateRequest,
    CycleRequest,
    DisableRequest,
    DisableSuperSpeedRequest,
    ResetRequest,
    WarmResetRequest,
    ResumeRequest,
    SuspendRequest,
    SetU1Timeout,
    SetU2Timeout,
 
    /* Results handed back by called states and change queries, never posted */
    ChangeConnect,
    ChangeOverCurrent,
    ChangeOverCurrentCleared,
    ChangeResetDone,
    ChangeResumed,
    ChangeDisabled,
    ChangeError,
    ChangeLinkError,
    ChangeNone,
    ChangeResetBusy,
    ChangeNeedsHubReset,
    ChangeNeedsReset,
    ErrorIgnore,
    ErrorCycle,
    ErrorDisableAndCycle,
    ErrorEnabledOnConnect,
    ErrorEnabledWhileReset,
    SubDone,
 
    Count
};