---
title: IOFireWireSBP2Login
framework: kernel
role: symbol
role_heading: Class
path: kernel/iofirewiresbp2login
---

# IOFireWireSBP2Login

Supplies the login maintenance and Normal Command ORB execution portions of the API.

## Declaration

```occ
class IOFireWireSBP2Login : OSObject
```

## Overview

Overview 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

- [createORB](kernel/iofirewiresbp2login/1813411-createorb.md)
- [enableUnsolicitedStatus](kernel/iofirewiresbp2login/1813441-enableunsolicitedstatus.md)
- [getLoginFlags](kernel/iofirewiresbp2login/1813479-getloginflags.md)
- [getLoginID](kernel/iofirewiresbp2login/1813507-getloginid.md)
- [getMaxCommandBlockSize](kernel/iofirewiresbp2login/1813539-getmaxcommandblocksize.md)
- [getMaxPayloadSize](kernel/iofirewiresbp2login/1813578-getmaxpayloadsize.md)
- [getReconnectTime](kernel/iofirewiresbp2login/1813610-getreconnecttime.md)
- [getRefCon](kernel/iofirewiresbp2login/1813628-getrefcon.md)
- [getStatusNotifyProc](kernel/iofirewiresbp2login/1813642-getstatusnotifyproc.md)
- [getUnsolicitedStatusNotifyProc](kernel/iofirewiresbp2login/1813655-getunsolicitedstatusnotifyproc.md)
- [release](kernel/iofirewiresbp2login/1813662-release.md)
- [ringDoorbell](kernel/iofirewiresbp2login/1813671-ringdoorbell.md)
- [setBusyTimeoutRegisterValue](kernel/iofirewiresbp2login/1813679-setbusytimeoutregistervalue.md)
- [setFetchAgentResetCompletion](kernel/iofirewiresbp2login/1813686-setfetchagentresetcompletion.md)
- [setFetchAgentWriteCompletion](kernel/iofirewiresbp2login/1813693-setfetchagentwritecompletion.md)
- [setLoginCompletion](kernel/iofirewiresbp2login/1813704-setlogincompletion.md)
- [setLoginFlags](kernel/iofirewiresbp2login/1813712-setloginflags.md)
- [setLoginRetryCountAndDelayTime](kernel/iofirewiresbp2login/1813721-setloginretrycountanddelaytime.md)
- [setLogoutCompletion](kernel/iofirewiresbp2login/1813730-setlogoutcompletion.md)
- [setMaxPayloadSize](kernel/iofirewiresbp2login/1813735-setmaxpayloadsize.md)
- [setPassword(IOMemoryDescriptor *)](kernel/iofirewiresbp2login/1813740-setpassword.md)
- [setPassword(void *, UInt32)](kernel/iofirewiresbp2login/1813743-setpassword.md)
- [setReconnectTime](kernel/iofirewiresbp2login/1813747-setreconnecttime.md)
- [setRefCon](kernel/iofirewiresbp2login/1813752-setrefcon.md)
- [setStatusNotifyProc](kernel/iofirewiresbp2login/1813755-setstatusnotifyproc.md)
- [setUnsolicitedStatusNotifyProc](kernel/iofirewiresbp2login/1813759-setunsolicitedstatusnotifyproc.md)
- [submitFetchAgentReset](kernel/iofirewiresbp2login/1813764-submitfetchagentreset.md)
- [submitLogin](kernel/iofirewiresbp2login/1813766-submitlogin.md)
- [submitLogout](kernel/iofirewiresbp2login/1813770-submitlogout.md)
- [submitORB](kernel/iofirewiresbp2login/1813772-submitorb.md)

### Instance Methods

- [abortLogin](kernel/iofirewiresbp2login/1572200-abortlogin.md)
- [addORB](kernel/iofirewiresbp2login/1572184-addorb.md)
- [allocateResources](kernel/iofirewiresbp2login/1572137-allocateresources.md)
- [appendORB](kernel/iofirewiresbp2login/1572215-appendorb.md)
- [appendORBImmediate](kernel/iofirewiresbp2login/1572253-appendorbimmediate.md)
- [cancelORBTimer](kernel/iofirewiresbp2login/1572180-cancelorbtimer.md)
- [clearAllTasksInSet](kernel/iofirewiresbp2login/1572228-clearalltasksinset.md)
- [clearLoginGeneration](kernel/iofirewiresbp2login/1572238-clearlogingeneration.md)
- [completeLogin](kernel/iofirewiresbp2login/1572259-completelogin.md)
- [completeLogout](kernel/iofirewiresbp2login/1572182-completelogout.md)
- [createORB](kernel/iofirewiresbp2login/1572197-createorb.md)
- [doReconnect](kernel/iofirewiresbp2login/1572252-doreconnect.md)
- [doorbellComplete](kernel/iofirewiresbp2login/1572287-doorbellcomplete.md)
- [enableUnsolicitedStatus](kernel/iofirewiresbp2login/1572227-enableunsolicitedstatus.md)
- [executeAddORB](kernel/iofirewiresbp2login/1572219-executeaddorb.md)
- [executeDoorbell](kernel/iofirewiresbp2login/1572181-executedoorbell.md)
- [executeFetchAgentReset](kernel/iofirewiresbp2login/1572235-executefetchagentreset.md)
- [executeLogin](kernel/iofirewiresbp2login/1572248-executelogin.md)
- [executeLogout](kernel/iofirewiresbp2login/1572169-executelogout.md)
- [executeORB](kernel/iofirewiresbp2login/1572282-executeorb.md)
- [executeRemoveORB](kernel/iofirewiresbp2login/1572199-executeremoveorb.md)
- [executeSetBusyTimeout](kernel/iofirewiresbp2login/1572138-executesetbusytimeout.md)
- [executeUnsolicitedStatusEnable](kernel/iofirewiresbp2login/1572166-executeunsolicitedstatusenable.md)
- [fetchAgentResetComplete](kernel/iofirewiresbp2login/1572268-fetchagentresetcomplete.md)
- [fetchAgentRetryTimer](kernel/iofirewiresbp2login/1572168-fetchagentretrytimer.md)
- [fetchAgentWriteComplete](kernel/iofirewiresbp2login/1572254-fetchagentwritecomplete.md)
- [fetchAgentWriteComplete](kernel/iofirewiresbp2login/3516724-fetchagentwritecomplete.md)
- [free](kernel/iofirewiresbp2login/1572232-free.md)
- [getARDMMax](kernel/iofirewiresbp2login/1572132-getardmmax.md)
- [getFireWireLUN](kernel/iofirewiresbp2login/1572271-getfirewirelun.md)
- [getFireWireUnit](kernel/iofirewiresbp2login/1572113-getfirewireunit.md)
- [getLoginFlags](kernel/iofirewiresbp2login/1572226-getloginflags.md)
- [getLoginID](kernel/iofirewiresbp2login/1572136-getloginid.md)
- [getMaxCommandBlockSize](kernel/iofirewiresbp2login/1572118-getmaxcommandblocksize.md)
- [getMaxPayloadSize](kernel/iofirewiresbp2login/1572190-getmaxpayloadsize.md)
- [getMetaClass](kernel/iofirewiresbp2login/1572158-getmetaclass.md)
- [getReconnectTime](kernel/iofirewiresbp2login/1572173-getreconnecttime.md)
- [getRefCon](kernel/iofirewiresbp2login/1572129-getrefcon.md)
- [getStatusNotifyProc](kernel/iofirewiresbp2login/1572280-getstatusnotifyproc.md)
- [getTarget](kernel/iofirewiresbp2login/1572205-gettarget.md)
- [getUnitInformation](kernel/iofirewiresbp2login/1572189-getunitinformation.md)
- [getUnsolicitedStatusNotifyProc](kernel/iofirewiresbp2login/1572244-getunsolicitedstatusnotifyproc.md)
- [initORBWithLogin](kernel/iofirewiresbp2login/1572176-initorbwithlogin.md)
- [initWithLUN](kernel/iofirewiresbp2login/1572127-initwithlun.md)
- [initialExecuteLogin](kernel/iofirewiresbp2login/1572154-initialexecutelogin.md)
- [isConnected](kernel/iofirewiresbp2login/1572165-isconnected.md)
- [isFetchAgentWriteInProgress](kernel/iofirewiresbp2login/1572109-isfetchagentwriteinprogress.md)
- [isORBAppended](kernel/iofirewiresbp2login/1572217-isorbappended.md)
- [isORBTimerSet](kernel/iofirewiresbp2login/1572157-isorbtimerset.md)
- [isPhysicalAccessEnabled](kernel/iofirewiresbp2login/1572288-isphysicalaccessenabled.md)
- [loginRetryTimeout](kernel/iofirewiresbp2login/1572171-loginretrytimeout.md)
- [loginTimeout](kernel/iofirewiresbp2login/1572278-logintimeout.md)
- [loginWriteComplete](kernel/iofirewiresbp2login/1572223-loginwritecomplete.md)
- [logoutTimeout](kernel/iofirewiresbp2login/1572162-logouttimeout.md)
- [logoutWriteComplete](kernel/iofirewiresbp2login/1572216-logoutwritecomplete.md)
- [prepareORBForExecution](kernel/iofirewiresbp2login/1572123-prepareorbforexecution.md)
- [processLoginWrite](kernel/iofirewiresbp2login/1572224-processloginwrite.md)
- [reconnectRetryTimeout](kernel/iofirewiresbp2login/1572111-reconnectretrytimeout.md)
- [reconnectStatusBlockWrite](kernel/iofirewiresbp2login/1572265-reconnectstatusblockwrite.md)
- [reconnectTimeout](kernel/iofirewiresbp2login/1572112-reconnecttimeout.md)
- [reconnectWriteComplete](kernel/iofirewiresbp2login/1572163-reconnectwritecomplete.md)
- [release](kernel/iofirewiresbp2login/1572125-release.md)
- [removeLogin](kernel/iofirewiresbp2login/1572203-removelogin.md)
- [removeORB](kernel/iofirewiresbp2login/1572264-removeorb.md)
- [restartReconnect](kernel/iofirewiresbp2login/1572140-restartreconnect.md)
- [resumeNotify](kernel/iofirewiresbp2login/1572260-resumenotify.md)
- [ringDoorbell](kernel/iofirewiresbp2login/1572192-ringdoorbell.md)
- [sendReconnectNotification](kernel/iofirewiresbp2login/1572233-sendreconnectnotification.md)
- [sendReconnectNotificationWithStatusBlock](kernel/iofirewiresbp2login/1572272-sendreconnectnotificationwithsta.md)
- [sendTimeoutNotification](kernel/iofirewiresbp2login/1572239-sendtimeoutnotification.md)
- [setAddressLoForLoginORBAndResponse](kernel/iofirewiresbp2login/1572106-setaddressloforloginorbandrespon.md)
- [setBusyTimeoutComplete](kernel/iofirewiresbp2login/1572188-setbusytimeoutcomplete.md)
- [setBusyTimeoutRegisterValue](kernel/iofirewiresbp2login/1572126-setbusytimeoutregistervalue.md)
- [setFetchAgentResetCompletion](kernel/iofirewiresbp2login/1572247-setfetchagentresetcompletion.md)
- [setFetchAgentWriteCompletion](kernel/iofirewiresbp2login/1572115-setfetchagentwritecompletion.md)
- [setLoginCompletion](kernel/iofirewiresbp2login/1572117-setlogincompletion.md)
- [setLoginFlags](kernel/iofirewiresbp2login/1572119-setloginflags.md)
- [setLoginGeneration](kernel/iofirewiresbp2login/1572231-setlogingeneration.md)
- [setLoginRetryCountAndDelayTime](kernel/iofirewiresbp2login/1572195-setloginretrycountanddelaytime.md)
- [setLogoutCompletion](kernel/iofirewiresbp2login/1572256-setlogoutcompletion.md)
- [setMaxPayloadSize](kernel/iofirewiresbp2login/1572145-setmaxpayloadsize.md)
- [setNextORBAddress](kernel/iofirewiresbp2login/1572251-setnextorbaddress.md)
- [setORBIsAppended](kernel/iofirewiresbp2login/1572107-setorbisappended.md)
- [setPassword](kernel/iofirewiresbp2login/1572237-setpassword.md)
- [setPassword](kernel/iofirewiresbp2login/3516725-setpassword.md)
- [setReconnectTime](kernel/iofirewiresbp2login/1572110-setreconnecttime.md)
- [setRefCon](kernel/iofirewiresbp2login/1572135-setrefcon.md)
- [setStatusNotifyProc](kernel/iofirewiresbp2login/1572214-setstatusnotifyproc.md)
- [setUnsolicitedStatusNotifyProc](kernel/iofirewiresbp2login/1572191-setunsolicitedstatusnotifyproc.md)
- [startFetchAgentRetryTimer](kernel/iofirewiresbp2login/1572229-startfetchagentretrytimer.md)
- [startLoginRetryTimer](kernel/iofirewiresbp2login/1572196-startloginretrytimer.md)
- [startORBTimer](kernel/iofirewiresbp2login/1572286-startorbtimer.md)
- [startReconnectRetryTimer](kernel/iofirewiresbp2login/1572221-startreconnectretrytimer.md)
- [startReconnectTimer](kernel/iofirewiresbp2login/1572277-startreconnecttimer.md)
- [statusBlockWrite](kernel/iofirewiresbp2login/1572194-statusblockwrite.md)
- [stopFetchAgentRetryTimer](kernel/iofirewiresbp2login/1572170-stopfetchagentretrytimer.md)
- [stopLoginRetryTimer](kernel/iofirewiresbp2login/1572146-stoploginretrytimer.md)
- [stopReconnectRetryTimer](kernel/iofirewiresbp2login/1572267-stopreconnectretrytimer.md)
- [submitFetchAgentReset](kernel/iofirewiresbp2login/1572193-submitfetchagentreset.md)
- [submitLogin](kernel/iofirewiresbp2login/1572172-submitlogin.md)
- [submitLogout](kernel/iofirewiresbp2login/1572240-submitlogout.md)
- [submitORB](kernel/iofirewiresbp2login/1572266-submitorb.md)
- [suspendedNotify](kernel/iofirewiresbp2login/1572222-suspendednotify.md)
- [terminateNotify](kernel/iofirewiresbp2login/1572250-terminatenotify.md)
- [unsolicitedStatusEnableComplete](kernel/iofirewiresbp2login/1572160-unsolicitedstatusenablecomplete.md)

### Type Methods

- [doorbellCompleteStatic](kernel/iofirewiresbp2login/1572177-doorbellcompletestatic.md)
- [fetchAgentResetCompleteStatic](kernel/iofirewiresbp2login/1572201-fetchagentresetcompletestatic.md)
- [fetchAgentRetryTimerStatic](kernel/iofirewiresbp2login/1572255-fetchagentretrytimerstatic.md)
- [fetchAgentWriteCompleteStatic](kernel/iofirewiresbp2login/1572206-fetchagentwritecompletestatic.md)
- [loginRetryTimeoutStatic](kernel/iofirewiresbp2login/1572208-loginretrytimeoutstatic.md)
- [loginTimeoutStatic](kernel/iofirewiresbp2login/1572147-logintimeoutstatic.md)
- [loginWriteCompleteStatic](kernel/iofirewiresbp2login/1572174-loginwritecompletestatic.md)
- [logoutTimeoutStatic](kernel/iofirewiresbp2login/1572249-logouttimeoutstatic.md)
- [logoutWriteCompleteStatic](kernel/iofirewiresbp2login/1572185-logoutwritecompletestatic.md)
- [reconnectRetryTimeoutStatic](kernel/iofirewiresbp2login/1572210-reconnectretrytimeoutstatic.md)
- [reconnectStatusBlockWriteStatic](kernel/iofirewiresbp2login/1572209-reconnectstatusblockwritestatic.md)
- [reconnectTimeoutStatic](kernel/iofirewiresbp2login/1572143-reconnecttimeoutstatic.md)
- [reconnectWriteCompleteStatic](kernel/iofirewiresbp2login/1572178-reconnectwritecompletestatic.md)
- [setBusyTimeoutCompleteStatic](kernel/iofirewiresbp2login/1572148-setbusytimeoutcompletestatic.md)
- [staticExecuteAddORB](kernel/iofirewiresbp2login/1572142-staticexecuteaddorb.md)
- [staticExecuteDoorbell](kernel/iofirewiresbp2login/1572236-staticexecutedoorbell.md)
- [staticExecuteFetchAgentReset](kernel/iofirewiresbp2login/1572186-staticexecutefetchagentreset.md)
- [staticExecuteLogin](kernel/iofirewiresbp2login/1572257-staticexecutelogin.md)
- [staticExecuteLogout](kernel/iofirewiresbp2login/1572261-staticexecutelogout.md)
- [staticExecuteORB](kernel/iofirewiresbp2login/1572151-staticexecuteorb.md)
- [staticExecuteRemoveORB](kernel/iofirewiresbp2login/1572263-staticexecuteremoveorb.md)
- [staticExecuteUnsolicitedStatusEnable](kernel/iofirewiresbp2login/1572262-staticexecuteunsolicitedstatusen.md)
- [statusBlockWriteStatic](kernel/iofirewiresbp2login/1572144-statusblockwritestatic.md)
- [unsolicitedStatusEnableCompleteStatic](kernel/iofirewiresbp2login/1572198-unsolicitedstatusenablecompletes.md)

## Relationships

### Inherits From

- [OSObject](kernel/osobject.md)

## See Also

### Serial Bus Protocol 2

- [IOFireWireSBP2ManagementORB](kernel/iofirewiresbp2managementorb.md)
- [IOFireWireSBP2ORB](kernel/iofirewiresbp2orb.md)
- [FWSBP2FetchAgentWriteCallback](kernel/fwsbp2fetchagentwritecallback.md)
- [FWSBP2LoginCallback](kernel/fwsbp2logincallback.md)
- [FWSBP2LoginCompleteParams](kernel/fwsbp2logincompleteparams.md)
- [FWSBP2LoginCompleteParamsPtr](kernel/fwsbp2logincompleteparamsptr.md)
- [FWSBP2LoginResponse](kernel/fwsbp2loginresponse.md)
- [FWSBP2LoginResponsePtr](kernel/fwsbp2loginresponseptr.md)
- [FWSBP2LogoutCallback](kernel/fwsbp2logoutcallback.md)
- [FWSBP2LogoutCompleteParams](kernel/fwsbp2logoutcompleteparams.md)
- [FWSBP2LogoutCompleteParamsPtr](kernel/fwsbp2logoutcompleteparamsptr.md)
- [FWSBP2ManagementCallback](kernel/fwsbp2managementcallback.md)
- [FWSBP2NotifyCallback](kernel/fwsbp2notifycallback.md)
- [FWSBP2NotifyParams](kernel/fwsbp2notifyparams.md)
- [FWSBP2NotifyParamsPtr](kernel/fwsbp2notifyparamsptr.md)
- [FWSBP2ReconnectParams](kernel/fwsbp2reconnectparams.md)
- [FWSBP2ReconnectParamsPtr](kernel/fwsbp2reconnectparamsptr.md)
- [FWSBP2StatusBlock](kernel/fwsbp2statusblock.md)
- [FWSBP2StatusCallback](kernel/fwsbp2statuscallback.md)