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