IOFireWireSBP2Login
Supplies the login maintenance and Normal Command ORB execution portions of the API.
Declaration
class IOFireWireSBP2Login : OSObjectOverview
Supplies APIs for login maintenance and command execution. Drivers can use this object to create IOFireWireSBP2ORB objects and execute them. Solicited and unsolicited status callback routines can be registered and the SBP2 services will notify the driver when the appropriate status arrives. This class also handles login maintenance. Supplies APIs for logging in and logging out and attempts to reconnect to the LUN after bus resets. The base FireWire services deliver bus reset notification via the IOKit message routine. The SBP2 services build on this behavior and deliver reconnectFailed and reconnectComplete through the message routine as well.
Topics
Miscellaneous
createORBenableUnsolicitedStatusgetLoginFlagsgetLoginIDgetMaxCommandBlockSizegetMaxPayloadSizegetReconnectTimegetRefCongetStatusNotifyProcgetUnsolicitedStatusNotifyProcreleaseringDoorbellsetBusyTimeoutRegisterValuesetFetchAgentResetCompletionsetFetchAgentWriteCompletionsetLoginCompletionsetLoginFlagssetLoginRetryCountAndDelayTimesetLogoutCompletionsetMaxPayloadSizesetPassword(IOMemoryDescriptor *)setPassword(void *, UInt32)setReconnectTimesetRefConsetStatusNotifyProcsetUnsolicitedStatusNotifyProcsubmitFetchAgentResetsubmitLoginsubmitLogoutsubmitORB
Instance Methods
abortLoginaddORBallocateResourcesappendORBappendORBImmediatecancelORBTimerclearAllTasksInSetclearLoginGenerationcompleteLogincompleteLogoutcreateORBdoReconnectdoorbellCompleteenableUnsolicitedStatusexecuteAddORBexecuteDoorbellexecuteFetchAgentResetexecuteLoginexecuteLogoutexecuteORBexecuteRemoveORBexecuteSetBusyTimeoutexecuteUnsolicitedStatusEnablefetchAgentResetCompletefetchAgentRetryTimerfetchAgentWriteCompletefetchAgentWriteCompletefreegetARDMMaxgetFireWireLUNgetFireWireUnitgetLoginFlagsgetLoginIDgetMaxCommandBlockSizegetMaxPayloadSizegetMetaClassgetReconnectTimegetRefCongetStatusNotifyProcgetTargetgetUnitInformationgetUnsolicitedStatusNotifyProcinitORBWithLogininitWithLUNinitialExecuteLoginisConnectedisFetchAgentWriteInProgressisORBAppendedisORBTimerSetisPhysicalAccessEnabledloginRetryTimeoutloginTimeoutloginWriteCompletelogoutTimeoutlogoutWriteCompleteprepareORBForExecutionprocessLoginWritereconnectRetryTimeoutreconnectStatusBlockWritereconnectTimeoutreconnectWriteCompletereleaseremoveLoginremoveORBrestartReconnectresumeNotifyringDoorbellsendReconnectNotificationsendReconnectNotificationWithStatusBlocksendTimeoutNotificationsetAddressLoForLoginORBAndResponsesetBusyTimeoutCompletesetBusyTimeoutRegisterValuesetFetchAgentResetCompletionsetFetchAgentWriteCompletionsetLoginCompletionsetLoginFlagssetLoginGenerationsetLoginRetryCountAndDelayTimesetLogoutCompletionsetMaxPayloadSizesetNextORBAddresssetORBIsAppendedsetPasswordsetPasswordsetReconnectTimesetRefConsetStatusNotifyProcsetUnsolicitedStatusNotifyProcstartFetchAgentRetryTimerstartLoginRetryTimerstartORBTimerstartReconnectRetryTimerstartReconnectTimerstatusBlockWritestopFetchAgentRetryTimerstopLoginRetryTimerstopReconnectRetryTimersubmitFetchAgentResetsubmitLoginsubmitLogoutsubmitORBsuspendedNotifyterminateNotifyunsolicitedStatusEnableComplete
Type Methods
doorbellCompleteStaticfetchAgentResetCompleteStaticfetchAgentRetryTimerStaticfetchAgentWriteCompleteStaticloginRetryTimeoutStaticloginTimeoutStaticloginWriteCompleteStaticlogoutTimeoutStaticlogoutWriteCompleteStaticreconnectRetryTimeoutStaticreconnectStatusBlockWriteStaticreconnectTimeoutStaticreconnectWriteCompleteStaticsetBusyTimeoutCompleteStaticstaticExecuteAddORBstaticExecuteDoorbellstaticExecuteFetchAgentResetstaticExecuteLoginstaticExecuteLogoutstaticExecuteORBstaticExecuteRemoveORBstaticExecuteUnsolicitedStatusEnablestatusBlockWriteStaticunsolicitedStatusEnableCompleteStatic
See Also
Serial Bus Protocol 2
IOFireWireSBP2ManagementORBIOFireWireSBP2ORBFWSBP2FetchAgentWriteCallbackFWSBP2LoginCallbackFWSBP2LoginCompleteParamsFWSBP2LoginCompleteParamsPtrFWSBP2LoginResponseFWSBP2LoginResponsePtrFWSBP2LogoutCallbackFWSBP2LogoutCompleteParamsFWSBP2LogoutCompleteParamsPtrFWSBP2ManagementCallbackFWSBP2NotifyCallbackFWSBP2NotifyParamsFWSBP2NotifyParamsPtrFWSBP2ReconnectParamsFWSBP2ReconnectParamsPtrFWSBP2StatusBlockFWSBP2StatusCallback