adapter_manager(3K) SDK R4.11 adapter_manager(3K)
NAME
adaptermanager: devscsiadapterconfigure,
devscsiadapterdeconfigure, devscsiadapteropen,
devscsiadapterclose, devscsiadapterdevicetoname,
devscsiadapternametodevice, devscsiadapterregisterrequester,
devscsiadapterderegisterrequester,
devscsiadaptersetadapteroptions,
devscsiadaptersetunitoptions, devscsiadapterioctl,
devscsiadapterissuecommand, devscsiadapterissueasynccommand,
devscsiadapterissuecommandphysicalmode,
devscsiadaptergetdeviceinfo, devscsiadapteropendump -
implement the adapter manager utility
SYNOPSIS
statustype devscsiadapterclose (
iomajordevicenumbertype majornumber, READONLY
iodevicehandletype adapterhandle, READONLY
iochannelflagstype channelflags READONLY )
statustype devscsiadapterconfigure (
charptrtype nameptr READONLY )
statustype devscsiadapterdeconfigure (
charptrtype nameptr READONLY )
void devscsiadapterderegisterrequester (
iomajordevicenumbertype majornumber, READONLY
iodevicehandletype adapterhandle READONLY )
statustype devscsiadapterdevicetoname (
iodevicenumbertype devicenumber, READONLY
charptrtype nameptr, READONLY
uint32type size READONLY )
statustype devscsiadaptergetdeviceinfo (
charptrtype nameptr, READONLY
devscsiadapterunitspectype unitspec, READONLY
bit8type devicetype, READONLY
iodevicehandleptrtype driverhandleptr WRITE ONLY )
statustype devscsiadapterioctl (
iomajordevicenumbertype majornumber, READONLY
iodevicehandletype adapterhandle, READONLY
bit32etype command, READONLY
bit32etype parameter, READWRITE
int32eptrtype returnvalptr WRITEONLY )
statustype devscsiadapterissueasynccommand (
iomajordevicenumbertype majornumber, READONLY
devadapterrequestblockptrtype arbptr READONLY )
statustype devscsiadapterissuecommand (
iomajordevicenumbertype majornumber, READONLY
devadapterrequestblockptrtype arbptr READONLY )
statustype devscsiadapterissuecommandphysicalmode (
iomajordevicenumbertype majornumber, READONLY
devadapterphysicalrequestblkptrtype requestblkptr READONLY )
statustype devscsiadapternametodevice (
charptrtype nameptr, READONLY
iodevicenumberptrtype devicenumberptr WRITE ONLY)
statustype devscsiadapteropen (
iomajordevicenumbertype majornumber, READONLY
iodevicehandletype adapterhandle, READONLY
iochannelflagstype channelflags READONLY )
statustype devscsiadapteropendump (
charptrtype devicename, READONLY
iodevicehandleptrtype devicehandleptr, READONLY
iomajordevicenumberptrtype majornumberptr WRITEONLY)
statustype devscsiadapterregisterrequester (
iomajordevicenumbertype majornumber, READONLY
devscsiadapterunitregistrationblkptrtype rbptr READONLY )
statustype devscsiadaptersetadapteroptions (
iomajordevicenumbertype majornumber, READONLY
iodevicehandletype adapterhandle, READONLY
devscsiadapteroptionsblockptrtype adapoptblkptr READONLY )
statustype devscsiadaptersetunitoptions (
iomajordevicenumbertype majornumber, READONLY
iodevicehandletype adapterhandle, READONLY
devscsiadapterunitoptionsblockptrtype uoptblkptr, READONLY)
where:
adapterhandle The device handle of the target SCSI adapter. This
must be the device handle that was returned by the
adapter manager's register-requester routine.
adapoptblkptr A pointer to an adapter options block that
specifies the options to be selected for the unit.
arbptr A pointer to an adapter request block that holds
all information that describes the request.
channelflags The set of channel flags specifying the type of
access requested on the device.
command A command to the device. The interpretation of the
command is specific to the driver.
devicehandleptr A pointer to the location where the device handle
is to be returned.
devicename A pointer to the null-terminated string identifying
the device to be opened as a dump device.
devicenumber The device number of the target SCSI adapter.
devicenumberptr Pointer to where the SCSI adapter device number
(major and minor number) is to be returned.
devicetype Device type of device expected to be registered for
unit number and SCSI ID.
driverhandleptr Pointer to where driver handle is to be returned.
majornumber The major device number of the target SCSI adapter.
majornumberptr A pointer to the location where the device's major
number is stored.
nameptr A pointer to the target SCSI adapter's device name
as specified in its system file entry, or a pointer
to where the null-terminated character string name
is to be written.
parameter A command argument. The parameter's interpretation
is specific to the driver and the command.
rbptr A pointer to a SCSI adapter registration block.
requestblkptr A pointer to a physical request block that holds
information which specifies the request.
returnvalueptr A pointer to the value to be returned to the user.
size The maximum number of bytes, including the
terminating null, that is to be written to
nameptr.
uoptblkptr Pointer to a unit options block that specifies the
options to be selected for the unit.
unitspec SCSI ID and logical unit number of target device.
DESCRIPTION
Adapter driver routines are invoked by their SCSI device drivers.
However, in order to keep the device driver code from being fixed to
a particular adapter driver, device drivers do not call adapter
routines directly. Instead they call adapter manager routines with a
parameter identifying the target adapter and the adapter manager
routines route the calls to the correct adapter driver. The adapter
manager consists of a standard set of adapter driver routines with
the generic mnemonic scsiadapter.
This man page describes adapter manager routines that SCSI device
drivers use to interface to their SCSI adapter drivers. It includes
the following routines:
devscsiadapterconfigure Call configuration routine
devscsiadapterdeconfigure Call deconfiguration routine
devscsiadapteropen Call driver's open routine
devscsiadapterclose Call driver's close routine
devscsiadapterdevicetoname Call device-to-name routine
devscsiadapternametodevice Call name-to-device routine
devscsiadapterregisterrequester Call register-requester routine
devscsiadapterderegisterrequester
Call deregister-requester
routine
devscsiadaptersetadapteroptions Call set-adapter-options routine
devscsiadaptersetunitoptions Call set-unit-options routine
devscsiadapterioctl Call adapter-ioctl routine
devscsiadapterissuecommand Call issue-command routine
devscsiadapterissueasynccommand Call issue-async-command routine
devscsiadapterissuecommandphysicalmode
Call driver's issue-command-
physical-mode routine
devscsiadaptergetdeviceinfo Call get-device-info routine
devscsiadapteropendump Call driver's open-dump routine
Constants and Data Structures
Adapter manager routines use the same data structures described for
adapter drivers. For a discussion of these data structures, see the
adapterdriver(3K) man page.
devscsiadapterclose
This routine locates the SCSI adapter driver for the adapter
specified by majornumber and calls that driver's close routine.
devscsiadapterconfigure
This routine locates the SCSI adapter driver for the adapter
specified by nameptr and calls that driver's configuration routine.
devscsiadapterdeconfigure
This routine locates the SCSI adapter driver specified by nameptr
and calls that driver's deconfiguration routine.
devscsiadapterderegisterrequester
This routine locates the SCSI adapter driver for the adapter
specified by majornumber and calls that driver's deregister-
requester routine.
devscsiadapterdevicetoname
This routine locates the SCSI adapter driver for the adapter
specified by devicenumber and calls that driver's device-to-name
routine.
devscsiadaptergetdeviceinfo
This routine locates the SCSI adapter driver for the adapter
specified by nameptr and calls that driver's get-device-info
routine.
devscsiadapterioctl
This routine locates the SCSI adapter driver for the adapter
specified by the majornumber and calls that driver's adapter-ioctl
routine.
You can use the command parameter to transfer information in either
direction between the caller and the device. In particular it may be
a pointer to a buffer supplied by the caller.
devscsiadapterissueasynccommand
This routine locates the SCSI adapter driver for the adapter
specified by majornumber and calls that driver's issue-async-command
routine.
devscsiadapterissuecommand
This routine locates the SCSI adapter driver for the adapter
specified by the majornumber and calls that driver's issue-command
routine.
devscsiadapterissuecommandphysicalmode
This routine locates the SCSI adapter driver for the adapter
specified by majornumber and calls that driver's issue-command-
physical-mode routine.
devscsiadapternametodevice
This routine locates the SCSI adapter driver for the adapter
specified by nameptr and calls that driver's name-to-device routine.
devscsiadapteropen
This routine locates the SCSI adapter driver for the adapter
specified by majornumber and calls that driver's open routine.
devscsiadapteropendump
This routine locates the SCSI adapter driver for the adapter
specified by devicename and calls that driver's open-dump routine.
devscsiadapterregisterrequester
This routine locates the SCSI adapter driver for the adapter
specified by majornumber and calls that driver's register-requester
routine.
devscsiadaptersetadapteroptions
This routine locates the SCSI adapter driver for the adapter
specified by the majornumber and calls that driver's set-adapter-
options routine.
devscsiadaptersetunitoptions
This routine locates the SCSI adapter driver for the adapter
specified by majornumber and calls that driver's set-unit-options
routine.
DIAGNOSTICS
Return Value
For devscsiadapterclose, devscsiadapterioctl, and
devscsiadapteropen:
IOENODEVFUNCTIONNOTSUPPORTED
The target adapter does not support this function.
[others] Values returned by adapter driver's close, ioctl, or
open routine, respectively.
For devscsiadapterconfigure:
OK The configuration completed successfully.
DEVENXIOADAPTERCONFIGFAILED
The configuration operation failed.
[others] Values returned by adapter driver's configuration
routine.
For devscsiadapterdeconfigure:
OK The deconfiguration completed successfully.
[others] Values returned by adapter driver's deconfiguration
routine.
For devscsiadapterderegisterrequester,
devscsiadapterdevicetoname, devscsiadaptergetdeviceinfo,
devscsiadapterissueasynccommand, devscsiadapterissuecommand,
devscsiadapterissuecommandphysicalmode,
devscsiadapternametodevice, and
devscsiadaptersetunitoptions:
[others] Values returned by adapter driver's deregister-
requester, device-to-name, get-device-info issue-
async-command, issue-command, issue-command-
physical-mode, name-to-device, or set-unit-options
routine, respectively.
For devscsiadapteropendump:
IOENXIODEVICENAMENOTRECOGNIZED
This routine returns this value if no SCSI adapters
are found.
[others] Values returned by adapter driver's open-dump
routine.
For devscsiadapterregisterrequester:
DEVENXIOADAPTERCONFIGFAILED
The configuration operation failed.
[others] Values returned by adapter driver's register-
requester routine.
For devscsiadaptersetadapteroptions:
IOENODEVFUNCTIONNOTSUPPORTED
The interface version used with this device does not
support the adapter set-adapter-options call.
[others] Values returned by adapter driver's set-adapter-
options routine.
SEE ALSO
adapterdriver(3K), devicedriver(3K).
Programming in the DG/UX Kernel Environment.
Licensed material--property of copyright holder(s)