Mac OS X Reference Library Apple Developer
Search

IOFireWireSBP2Login.h

Overview

Contains the class definition for IOFireWireSBP2Login.



Classes

IOFireWireSBP2Login

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



Typedefs

FWSBP2FetchAgentWriteCallback
FWSBP2LoginCallback
FWSBP2LoginCompleteParams
FWSBP2LoginCompleteParamsPtr
FWSBP2LoginResponse
FWSBP2LoginResponsePtr
FWSBP2LogoutCallback
FWSBP2LogoutCompleteParams
FWSBP2LogoutCompleteParams
FWSBP2LogoutCompleteParamsPtr
FWSBP2NotifyCallback
FWSBP2NotifyParams
FWSBP2NotifyParamsPtr
FWSBP2ReconnectParamsPtr
FWSBP2StatusBlock
FWSBP2StatusCallback

FWSBP2FetchAgentWriteCallback



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

Reference constant supplied when the notification was registered.

status

Indicates success or failure of operation.

orb

Indicates current last orb in chain.


FWSBP2LoginCallback



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

Reference constant supplied when the notification was registered.

params

Structure containing additional information about the status of the login.


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;  
Fields
login

Pointer to IOFireWireSBP2Login object.

generation

FireWire generation value.

status

Status of login attempt.

loginResponse

Pointer to login response struct.

statusBlock

Pointer to status block buffer.

statusBlockLength

Length of entire status block.

See Also


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;  
Fields
login

Pointer to IOFireWireSBP2Login object.

generation

FireWire generation value.

status

Status of login attempt.

loginResponse

Pointer to login response struct.

statusBlock

Pointer to status block buffer.

statusBlockLength

Length of entire status block.

See Also


FWSBP2LoginResponse



typedef struct { 
    UInt16 length; 
    UInt16 loginID; 
    UInt32 commandBlockAgentAddressHi; 
    UInt32 commandBlockAgentAddressLo; 
    UInt16 reserved; 
    UInt16 reconnectHold; 
} FWSBP2LoginResponse, *FWSBP2LoginResponsePtr;  
Fields
length

Length of login response.

loginID

Unique id representing this login.

commandBlockAgentAddressHi

High 32 bits of command block agent address.

commandBlockAgentAddressLo

Low 32 bits of command block agent address.

reserved

Reserved.

reconnectHold

Reconnect timeout encoded as 2^reconnectHold seconds.

See Also


FWSBP2LoginResponsePtr



typedef struct { 
    UInt16 length; 
    UInt16 loginID; 
    UInt32 commandBlockAgentAddressHi; 
    UInt32 commandBlockAgentAddressLo; 
    UInt16 reserved; 
    UInt16 reconnectHold; 
} FWSBP2LoginResponse, *FWSBP2LoginResponsePtr;  
Fields
length

Length of login response.

loginID

Unique id representing this login.

commandBlockAgentAddressHi

High 32 bits of command block agent address.

commandBlockAgentAddressLo

Low 32 bits of command block agent address.

reserved

Reserved.

reconnectHold

Reconnect timeout encoded as 2^reconnectHold seconds.

See Also


FWSBP2LogoutCallback



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

Reference constant supplied when the notification was registered.

params

Structure containing additional information about the status of the logout.


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;  
Fields
login

Pointer to IOFireWireSBP2Login object.

generation

FireWire generation value.

status

Status of login attempt.

statusBlock

Pointer to status block buffer.

statusBlockLength

Length of entire status block.

See Also


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;  
Fields
login

Pointer to IOFireWireSBP2Login object.

generation

FireWire generation value.

status

Status of login attempt.

reconnectStatusBlock

Pointer to status block buffer.

reconnectStatusBlockLength

Length of entire status block.

See Also


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;  
Fields
login

Pointer to IOFireWireSBP2Login object.

generation

FireWire generation value.

status

Status of login attempt.

statusBlock

Pointer to status block buffer.

statusBlockLength

Length of entire status block.

See Also


FWSBP2NotifyCallback



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

Reference constant supplied when the notification was registered.

params

FWSBP2NotifyParams containing notification information.


FWSBP2NotifyParams



typedef struct { 
    void *commandObject; 
    UInt32 notificationEvent; 
    const void *message; 
    UInt32 length; 
    UInt32 generation; 
} FWSBP2NotifyParams, *FWSBP2NotifyParamsPtr;  
Fields
notificationEvent

Type of event we are being notified of.

message

buffer containing message.

length

length of message field.

generation

FireWire generation value.

See Also


FWSBP2NotifyParamsPtr



typedef struct { 
    void *commandObject; 
    UInt32 notificationEvent; 
    const void *message; 
    UInt32 length; 
    UInt32 generation; 
} FWSBP2NotifyParams, *FWSBP2NotifyParamsPtr;  
Fields
notificationEvent

Type of event we are being notified of.

message

buffer containing message.

length

length of message field.

generation

FireWire generation value.

See Also


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;  
Fields
login

Pointer to IOFireWireSBP2Login object.

generation

FireWire generation value.

status

Status of login attempt.

reconnectStatusBlock

Pointer to status block buffer.

reconnectStatusBlockLength

Length of entire status block.

See Also


FWSBP2StatusBlock



typedef struct { 
    UInt8 details; 
    UInt8 sbpStatus; 
    UInt16 orbOffsetHi; 
    UInt32 orbOffsetLo; 
    UInt32 status[6]; 
} FWSBP2StatusBlock;  
Fields
details

Src, Resp, D, Len fields of status block format

sbpStatus

SBP2 specific status

orbOffsetHi

High 32 bits of address of orb status is for.

orbOffsetLo

Low 32 bits of address of orb status is for.

status[6]

Up to 48 bytes of additional data. Length is determined by len field.


FWSBP2StatusCallback



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

Reference constant supplied when the notification was registered.

status

Indicates success or failure of operation.

 

Did this document help you? Yes It's good, but... Not helpful...

Last Updated: 2010-07-29