share/man/man4/pass.4

   1 .\"
   2 .\" Copyright (c) 1998, 1999 Kenneth D. Merry.
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\" 3. The name of the author may not be used to endorse or promote products
  14 .\"    derived from this software without specific prior written permission.
  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 .\" $FreeBSD$
  29 .\"
  30 .Dd March 17, 2015
  31 .Dt PASS 4
  32 .Os
  33 .Sh NAME
  34 .Nm pass
  35 .Nd CAM application passthrough driver
  36 .Sh SYNOPSIS
  37 .Cd device pass
  38 .Sh DESCRIPTION
  39 The
  40 .Nm
  41 driver provides a way for userland applications to issue CAM CCBs to the
  42 kernel.
  43 .Pp
  44 Since the
  45 .Nm
  46 driver allows direct access to the CAM subsystem, system administrators
  47 should exercise caution when granting access to this driver.
  48 If used
  49 improperly, this driver can allow userland applications to crash a machine
  50 or cause data loss.
  51 .Pp
  52 The
  53 .Nm
  54 driver attaches to every
  55 .Tn SCSI
  56 and
  57 .Tn ATA
  58 device found in the system.
  59 Since it attaches to every device, it provides a generic means of accessing
  60 .Tn SCSI
  61 and
  62 .Tn ATA
  63 devices, and allows the user to access devices which have no
  64 "standard" peripheral driver associated with them.
  65 .Sh KERNEL CONFIGURATION
  66 It is only necessary to configure one
  67 .Nm
  68 device in the kernel;
  69 .Nm
  70 devices are automatically allocated as
  71 .Tn SCSI
  72 and
  73 .Tn ATA
  74 devices are found.
  75 .Sh IOCTLS
  76 .Bl -tag -width 5n
  77 .It CAMIOCOMMAND union ccb *
  78 This ioctl takes most kinds of CAM CCBs and passes them through to the CAM
  79 transport layer for action.
  80 Note that some CCB types are not allowed
  81 through the passthrough device, and must be sent through the
  82 .Xr xpt 4
  83 device instead.
  84 Some examples of xpt-only CCBs are XPT_SCAN_BUS,
  85 XPT_DEV_MATCH, XPT_RESET_BUS, XPT_SCAN_LUN, XPT_ENG_INQ, and XPT_ENG_EXEC.
  86 These CCB types have various attributes that make it illogical or
  87 impossible to service them through the passthrough interface.
  88 .It CAMGETPASSTHRU union ccb *
  89 This ioctl takes an XPT_GDEVLIST CCB, and returns the passthrough device
  90 corresponding to the device in question.
  91 Although this ioctl is available through the
  92 .Nm
  93 driver, it is of limited use, since the caller must already know that
  94 the device in question is a passthrough device if they are issuing this
  95 ioctl.
  96 It is probably more useful to issue this ioctl through the
  97 .Xr xpt 4
  98 device.
  99 .It CAMIOQUEUE union ccb *
 100 Queue a CCB to the
 101 .Xr pass 4
 102 driver to be executed asynchronously.
 103 The caller may use
 104 .Xr select 2 ,
 105 .Xr poll 2
 106 or
 107 .Xr kevent 2
 108 to receive notification when the CCB has completed.
 109 .Pp
 110 This ioctl takes most CAM CCBs, but some CCB types are not allowed through
 111 the pass device, and must be sent through the
 112 .Xr xpt 4
 113 device instead.
 114 Some examples of xpt-only CCBs are XPT_SCAN_BUS,
 115 XPT_DEV_MATCH, XPT_RESET_BUS, XPT_SCAN_LUN, XPT_ENG_INQ, and XPT_ENG_EXEC.
 116 These CCB types have various attributes that make it illogical or
 117 impossible to service them through the passthrough interface.
 118 .Pp
 119 Although the
 120 .Dv CAMIOQUEUE
 121 ioctl is not defined to take an argument, it does require a
 122 pointer to a union ccb.
 123 It is not defined to take an argument to avoid an extra malloc and copy
 124 inside the generic
 125 .Xr ioctl 2
 126 handler.
 127 .pp
 128 The completed CCB will be returned via the
 129 .Dv CAMIOGET
 130 ioctl.
 131 An error will only be returned from the
 132 .Dv CAMIOQUEUE
 133 ioctl if there is an error allocating memory for the request or copying
 134 memory from userland.
 135 All other errors will be reported as standard CAM CCB status errors.
 136 Since the CCB is not copied back to the user process from the pass driver
 137 in the
 138 .Dv CAMIOQUEUE
 139 ioctl, the user's passed-in CCB will not be modfied.
 140 This is the case even with immediate CCBs.
 141 Instead, the completed CCB must be retrieved via the
 142 .Dv CAMIOGET
 143 ioctl and the status examined.
 144 .Pp
 145 Multiple CCBs may be queued via the
 146 .Dv CAMIOQUEUE
 147 ioctl at any given time, and they may complete in a different order than
 148 the order that they were submitted.
 149 The caller must take steps to identify CCBs that are queued and completed.
 150 The
 151 .Dv periph_priv
 152 structure inside struct ccb_hdr is available for userland use with the
 153 .Dv CAMIOQUEUE
 154 and
 155 .Dv CAMIOGET
 156 ioctls, and will be preserved across calls.
 157 Also, the periph_links linked list pointers inside struct ccb_hdr are
 158 available for userland use with the
 159 .Dv CAMIOQUEUE
 160 and
 161 .Dv CAMIOGET
 162 ioctls and will be preserved across calls.
 163 .It CAMIOGET union ccb *
 164 Retrieve completed CAM CCBs queued via the
 165 .Dv CAMIOQUEUE
 166 ioctl.
 167 An error will only be returned from the
 168 .Dv CAMIOGET
 169 ioctl if the
 170 .Xr pass 4
 171 driver fails to copy data to the user process or if there are no completed
 172 CCBs available to retrieve.
 173 If no CCBs are available to retrieve,
 174 errno will be set to
 175 .Dv ENOENT .
 176 .Pp
 177 All other errors will be reported as standard CAM CCB status errors.
 178 .Pp
 179 Although the
 180 .Dv CAMIOGET
 181 ioctl is not defined to take an argument, it does require a
 182 pointer to a union ccb.
 183 It is not defined to take an argument to avoid an extra malloc and copy
 184 inside the generic
 185 .Xr ioctl 2
 186 handler.
 187 .Pp
 188 The pass driver will report via
 189 .Xr select 2 ,
 190 .Xr poll 2
 191 or
 192 .Xr kevent 2
 193 when a CCB has completed.
 194 One CCB may be retrieved per
 195 .Dv CAMIOGET
 196 call.
 197 CCBs may be returned in an order different than the order they were
 198 submitted.
 199 So the caller should use the
 200 .Dv periph_priv
 201 area inside the CCB header to store pointers to identifying information.
 202 .El
 203 .Sh FILES
 204 .Bl -tag -width /dev/passn -compact
 205 .It Pa /dev/pass Ns Ar n
 206 Character device nodes for the
 207 .Nm
 208 driver.
 209 There should be one of these for each device accessed through the
 210 CAM subsystem.
 211 .El
 212 .Sh DIAGNOSTICS
 213 None.
 214 .Sh SEE ALSO
 215 .Xr kqueue 2 ,
 216 .Xr poll 2 ,
 217 .Xr select 2 ,
 218 .Xr cam 3 ,
 219 .Xr cam 4 ,
 220 .Xr cam_cdbparse 3 ,
 221 .Xr cd 4 ,
 222 .Xr ctl 4 ,
 223 .Xr da 4 ,
 224 .Xr sa 4 ,
 225 .Xr xpt 4 ,
 226 .Xr camcontrol 8 ,
 227 .Xr camdd 8
 228 .Sh HISTORY
 229 The CAM passthrough driver first appeared in
 230 .Fx 3.0 .
 231 .Sh AUTHORS
 232 .An Kenneth Merry Aq ken@FreeBSD.org