IOFireWireSBP2Login.h Reference

Declared in
IOFireWireSBP2Lib.h
IOFireWireSBP2Login.h

Overview

Contains the class definition for IOFireWireSBP2Login.

Included Headers

  • <IOKit/IOCommandGate.h>

  • <IOKit/firewire/IOFireWireUnit.h>

  • <IOKit/sbp2/IOFireWireSBP2ORB.h>

  • <IOKit/sbp2/IOFireWireSBP2Target.h>

Callbacks

See the Overview section above for header-level documentation.

FWSBP2FetchAgentWriteCallback

typedef void ( *FWSBP2FetchAgentWriteCallback)(
   void *refCon,
   IOReturn status,
   IOFireWireSBP2ORB *orb);

Parameters
refCon

Reference constant supplied when the notification was registered.

status

Indicates success or failure of operation.

orb

Indicates current last orb in chain.

Availability
  • Available in OS X v10.0 and later.
Declared In
IOFireWireSBP2Login.h

FWSBP2LoginCallback

typedef void ( *FWSBP2LoginCallback)(
   void *refCon,
   FWSBP2LoginCompleteParamsPtr params);

Parameters
refCon

Reference constant supplied when the notification was registered.

params

Structure containing additional information about the status of the login.

Availability
  • Available in OS X v10.0 and later.
Declared In
IOFireWireSBP2Login.h

FWSBP2LogoutCallback

typedef void ( *FWSBP2LogoutCallback)(
   void *refCon,
   FWSBP2LogoutCompleteParamsPtr params);

Parameters
refCon

Reference constant supplied when the notification was registered.

params

Structure containing additional information about the status of the logout.

Availability
  • Available in OS X v10.0 and later.
Declared In
IOFireWireSBP2Login.h

FWSBP2NotifyCallback

typedef void ( *FWSBP2NotifyCallback)(
   void *refCon,
   FWSBP2NotifyParamsPtr params);

Parameters
refCon

Reference constant supplied when the notification was registered.

params

FWSBP2NotifyParams containing notification information.

Availability
  • Available in OS X v10.0 and later.
Declared In
IOFireWireSBP2Login.h

FWSBP2StatusCallback

typedef void ( *FWSBP2StatusCallback)(
   void *refCon,
   IOReturn status);

Parameters
refCon

Reference constant supplied when the notification was registered.

status

Indicates success or failure of operation.

Availability
  • Available in OS X v10.0 and later.
Declared In
IOFireWireSBP2Login.h

Data Types

See the Overview section above for header-level documentation.

FWSBP2LoginCompleteParams

typedef struct {
      IOFireWireSBP2Login *login; // login object this param is sent from
      UInt32 generation; // generation this login was attempted in
      IOReturn status; // status of login attempt
      FWSBP2LoginResponsePtr loginResponse; // pointer to loginResponse buffer
      FWSBP2StatusBlock *statusBlock; // pointer to statusBlock buffer
      UInt32 statusBlockLength; // size of statusBlock buffer
} FWSBP2LoginCompleteParams, *FWSBP2LoginCompleteParamsPtr;
Availability
  • Available in OS X v10.0 and later.
Declared In
IOFireWireSBP2Login.h

FWSBP2LoginCompleteParamsPtr

typedef struct {
      IOFireWireSBP2Login *login; // login object this param is sent from
      UInt32 generation; // generation this login was attempted in
      IOReturn status; // status of login attempt
      FWSBP2LoginResponsePtr loginResponse; // pointer to loginResponse buffer
      FWSBP2StatusBlock *statusBlock; // pointer to statusBlock buffer
      UInt32 statusBlockLength; // size of statusBlock buffer
} FWSBP2LoginCompleteParams, *FWSBP2LoginCompleteParamsPtr;
Availability
  • Available in OS X v10.0 and later.
Declared In
IOFireWireSBP2Login.h

FWSBP2LoginResponse

typedef struct {
      UInt16 length;
      UInt16 loginID;
      UInt32 commandBlockAgentAddressHi;
      UInt32 commandBlockAgentAddressLo;
      UInt16 reserved;
      UInt16 reconnectHold;
} FWSBP2LoginResponse, *FWSBP2LoginResponsePtr;
Availability
  • Available in OS X v10.0 and later.
Declared In
IOFireWireSBP2Login.h

FWSBP2LoginResponsePtr

typedef struct {
      UInt16 length;
      UInt16 loginID;
      UInt32 commandBlockAgentAddressHi;
      UInt32 commandBlockAgentAddressLo;
      UInt16 reserved;
      UInt16 reconnectHold;
} FWSBP2LoginResponse, *FWSBP2LoginResponsePtr;
Availability
  • Available in OS X v10.0 and later.
Declared In
IOFireWireSBP2Login.h

FWSBP2LogoutCompleteParams

typedef struct {
      IOFireWireSBP2Login *login; // login object this param is sent from
      UInt32 generation; // generation this login was attempted in
      IOReturn status; // status of login attempt
      FWSBP2StatusBlock *statusBlock; // pointer to statusBlock buffer
      UInt32 statusBlockLength; // size of statusBlock buffer
} FWSBP2LogoutCompleteParams, *FWSBP2LogoutCompleteParamsPtr;
Availability
  • Available in OS X v10.0 and later.
Declared In
IOFireWireSBP2Login.h

FWSBP2LogoutCompleteParams

typedef struct {
      IOFireWireSBP2Login *login; // login object this param is sent from
      UInt32 generation; // generation this login was attempted in
      IOReturn status; // status of reconnect attempt
      void *reconnectStatusBlock; // pointer to statusBlock buffer
      UInt32 reconnectStatusBlockLength; // size of statusBlock buffer
} FWSBP2ReconnectParams, *FWSBP2ReconnectParamsPtr;
Availability
  • Available in OS X v10.0 and later.
Declared In
IOFireWireSBP2Login.h

FWSBP2LogoutCompleteParamsPtr

typedef struct {
      IOFireWireSBP2Login *login; // login object this param is sent from
      UInt32 generation; // generation this login was attempted in
      IOReturn status; // status of login attempt
      FWSBP2StatusBlock *statusBlock; // pointer to statusBlock buffer
      UInt32 statusBlockLength; // size of statusBlock buffer
} FWSBP2LogoutCompleteParams, *FWSBP2LogoutCompleteParamsPtr;
Availability
  • Available in OS X v10.0 and later.
Declared In
IOFireWireSBP2Login.h

FWSBP2NotifyParams

typedef struct {
      void *commandObject;
      UInt32 notificationEvent;
      const void *message;
      UInt32 length;
      UInt32 generation;
} FWSBP2NotifyParams, *FWSBP2NotifyParamsPtr;
Availability
  • Available in OS X v10.0 and later.
Declared In
IOFireWireSBP2Login.h

FWSBP2NotifyParamsPtr

typedef struct {
      void *commandObject;
      UInt32 notificationEvent;
      const void *message;
      UInt32 length;
      UInt32 generation;
} FWSBP2NotifyParams, *FWSBP2NotifyParamsPtr;
Availability
  • Available in OS X v10.0 and later.
Declared In
IOFireWireSBP2Login.h

FWSBP2ReconnectParamsPtr

typedef struct {
      IOFireWireSBP2Login *login; // login object this param is sent from
      UInt32 generation; // generation this login was attempted in
      IOReturn status; // status of reconnect attempt
      void *reconnectStatusBlock; // pointer to statusBlock buffer
      UInt32 reconnectStatusBlockLength; // size of statusBlock buffer
} FWSBP2ReconnectParams, *FWSBP2ReconnectParamsPtr;
Availability
  • Available in OS X v10.0 and later.
See Also
  • FWSBP2LogoutCompleteParams
Declared In
IOFireWireSBP2Login.h

FWSBP2StatusBlock

typedef struct {
      UInt8 details;
      UInt8 sbpStatus;
      UInt16 orbOffsetHi;
      UInt32 orbOffsetLo;
      UInt32 status[6];
} FWSBP2StatusBlock;
Availability
  • Available in OS X v10.0 and later.
Declared In
IOFireWireSBP2Lib.h