ADC Home > Reference Library > Reference > Hardware & Drivers > I/O Kit Framework Reference

IOFireWireSBP2LibMgmtORBInterface

Declared In:

Overview

Supplies non login related management ORBs. Management ORBs can be executed independent of a login, if necessary. Management ORBs are created using the IOFireWireSBP2LibLUNInterface.

Functions

getRefCon: Returns the current function of the management ORB.
setCommandFunction: Sets the function of the management ORB.
setManageeLogin: Sets the command to be managed by the management ORB.
setManageeORB: Sets the command to be managed by the management ORB.
setORBCompleteCallback: Sets the ORB completion routine.
setRefCon: Sets the login refCon.
setResponseBuffer: Sets the response buffer for the management ORB.
submitORB: Submits this ORB for execution.

getRefCon

Returns the current function of the management ORB.

void * ( *getRefCon)(
    void *self);

Parameters

self: Pointer to a IOFireWireSBP2LibMgmtORBInterface.

Return Value

Returns the function of the management ORB.

Discussion

Returns the function of the management ORB. This is the same value that was set with setCommandFunction.

setCommandFunction

Sets the function of the management ORB.

IOReturn ( *setCommandFunction)(
    void *self,
    UInt32 function );

Parameters

self: Pointer to a IOFireWireSBP2LibMgmtORBInterface.
function: a value indicating the desired management function.

Return Value

Returns kIOReturnSuccess if function was a legal function.

Discussion

Sets the the function of the management ORB. Legal values are kFWSBP2QueryLogins, kFWSBP2AbortTask, kFWSBP2AbortTaskSet, kFWSBP2LogicalUnitReset, and kFWSBP2TargetReset.

setManageeLogin

Sets the command to be managed by the management ORB.

IOReturn ( *setManageeLogin)(
    void *self,
    void *command );

Parameters

self: Pointer to a IOFireWireSBP2LibMgmtORBInterface.
command: a reference to an IOFireWireSBP2Login or an IOFireWireSBP2ORB.

Return Value

Returns kIOReturnSuccess on a success.

Discussion

All management functions except kFWSBP2QueryLogins require a reference to an ORB of some sort. kFWSBP2AbortTaskSet, kFWSBP2LogicalUnitReset, and kFWSBP2TargetReset require a reference to the login ORB. This method allows you to set the login ORB to be managed.

setManageeORB

Sets the command to be managed by the management ORB.

IOReturn ( *setManageeORB)(
    void *self,
    void *command );

Parameters

self: Pointer to a IOFireWireSBP2LibMgmtORBInterface.
command: a reference to an IOFireWireSBP2Login or an IOFireWireSBP2ORB.

Return Value

Returns kIOReturnSuccess on a success.

Discussion

All management functions except kFWSBP2QueryLogins require a reference to an ORB of some sort. kFWSBP2AbortTask requires a reference to the ORB to be aborted. This method allows you to set the Normal Command ORB to be managed.

setORBCompleteCallback

Sets the ORB completion routine.

void ( *setORBCompleteCallback)(
    void *self,
    void *refCon, 
    IOFWSBP2ORBCompleteCallback callback );

Parameters

self: Pointer to a IOFireWireSBP2LibMgmtORBInterface.
refCon: refCon passed as first argument to completion routine

Discussion

Sets the completion routine to be called when the ORB finishes execution. The refCon set with setRefCon will also be passed as the third argument to the completion handler.

setRefCon

Sets the login refCon.

void ( *setRefCon)(
    void *self,
    void *refCon );

Parameters

self: Pointer to a IOFireWireSBP2LibMgmtORBInterface.
refCon: a user defined value.

Discussion

Sets a user defined value on the login that can be retrieved later with the method getRefCon.

setResponseBuffer

Sets the response buffer for the management ORB.

IOReturn ( *setResponseBuffer)(
    void *self,
    void *buf,
    UInt32 len );

Parameters

self: Pointer to a IOFireWireSBP2LibMgmtORBInterface.
buf: backing store for buffer
len: length of buffer.

Return Value

Returns kIOReturnSuccess on a success.

Discussion

Sets the response buffer for the management ORB. kFWSBP2QueryLogins returns a response to its query and needs to write it somewhere. This routine allows you to specify the location.

submitORB

Submits this ORB for execution.

IOReturn ( *submitORB)(
    void *self );

Parameters

self: Pointer to a IOFireWireSBP2LibMgmtORBInterface.

Discussion

Submits this ORB for execution

Did this document help you?

Yes: Tell us what works for you.

It’s good, but: Report typos, inaccuracies, and so forth.

It wasn’t helpful: Tell us what would have helped.

Last Updated: 2009-02-23