share/man/man4/ssc.4

   1 .\" $FreeBSD$
   2 .\"
   3 .\" Copyright (c) 1997 Brian Somers <brian@Awfulhak.org>
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\"
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .Dd December 29, 1997
  29 .Dt SSC 4
  30 .Os FreeBSD
  31 .Sh NAME
  32 .Nm ssc
  33 .Nd The `super scsi' driver
  34 .Sh SYNOPSIS
  35 .Cd "pseudo-device ssc"
  36 .Sh DESCRIPTION
  37 The
  38 .Nm
  39 driver provides an access point into the SCSI driver code that can
  40 be used when no SCSI devices have previously been detected.  This
  41 is useful for systems that contain only external SCSI devices that
  42 may be powered off at boot time.
  43 .Pp
  44 The
  45 .Sq scsi user ,
  46 or
  47 .Xr su 4
  48 pseudo-device is used by
  49 .Nm ssc ,
  50 and therefore must also be configured.
  51 .Sh KERNEL CONFIGURATION
  52 There are no configuration parameters for the ssc pseudo-device.
  53 .Pp
  54 .Sh IOCTLS
  55 The
  56 .Nm
  57 driver has a single
  58 .Dv SCIOCADDR
  59 ioctl of it's own.  This ioctl must be used after opening
  60 .Pa /dev/ssc
  61 and before issuing any other ioctl calls:
  62 .Bd -literal -offset indent
  63 .Fd #include <sys/scsiio.h>
  64
  65 .Ft int
  66 .Fn ioctl "int fd" "SCIOCADDR" "struct scsi_addr *data"
  67 .Ed
  68 .Pp
  69 .Ar Fd
  70 refers to the descriptor returned by
  71 .Xr open 2 ,
  72 and
  73 .Ar data
  74 must have the
  75 .Ar scbus ,
  76 .Ar target
  77 and
  78 .Ar lun
  79 fields set as required.  This ioctl may be used at will to change the
  80 device to which subsequent ioctls affect.
  81 .Pp
  82 All other ioctls are passed directly to the
  83 .Xr su 4
  84 pseudo-device driver, using the Bus, Target and Lun that were set
  85 with the last
  86 .Dv SCIOCADDR
  87 ioctl call.
  88 .Sh FILES
  89 .Bl -tag -width /dev/ssc -compact
  90 .It Pa /dev/ssc
  91 The device file used to access the
  92 .Sq super scsi
  93 driver.
  94 .El
  95 .Sh DIAGNOSTICS
  96 If any ioctl is attempted before issuing a
  97 .Dv SCIOCADDR
  98 ioctl,
  99 .Dv ENXIO
 100 is returned.  Otherwise, the ioctl is passed directly to the
 101 .Xr su 4
 102 driver.
 103 .Sh SEE ALSO
 104 .Xr open 2 ,
 105 .Xr su 4 ,
 106 .Xr scsi 8
 107 .Sh HISTORY
 108 The
 109 .Nm
 110 driver originally appeared in FreeBSD 2.0.5.