lib/libcam/cam_cdbparse.3

   1 .\"
   2 .\" Copyright (c) 1998 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: src/lib/libcam/cam_cdbparse.3,v 1.3.2.11 2002/12/29 16:35:35 schweikh Exp $
  29 .\"
  30 .\" This man page borrows heavily from the old scsi(3) man page, which had
  31 .\" the following copyright:
  32 .\"
  33 .\" Copyright (c) 1994 HD Associates (hd@world.std.com)
  34 .\" All rights reserved.
  35 .\"
  36 .\" Redistribution and use in source and binary forms, with or without
  37 .\" modification, are permitted provided that the following conditions
  38 .\" are met:
  39 .\" 1. Redistributions of source code must retain the above copyright
  40 .\"    notice, this list of conditions and the following disclaimer.
  41 .\" 2. Redistributions in binary form must reproduce the above copyright
  42 .\"    notice, this list of conditions and the following disclaimer in the
  43 .\"    documentation and/or other materials provided with the distribution.
  44 .\" 3. All advertising materials mentioning features or use of this software
  45 .\"    must display the following acknowledgement:
  46 .\"     This product includes software developed by HD Associates
  47 .\" 4. Neither the name of the HD Associates nor the names of its contributors
  48 .\"    may be used to endorse or promote products derived from this software
  49 .\"    without specific prior written permission.
  50 .\"
  51 .\" THIS SOFTWARE IS PROVIDED BY HD ASSOCIATES``AS IS'' AND
  52 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  53 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  54 .\" ARE DISCLAIMED.  IN NO EVENT SHALL HD ASSOCIATES OR CONTRIBUTORS BE LIABLE
  55 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  56 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  57 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  58 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  59 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  60 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  61 .\" SUCH DAMAGE.
  62 .\"
  63 .\"
  64 .Dd October 13, 1998
  65 .Os
  66 .Dt CAM_CDBPARSE 3
  67 .Sh NAME
  68 .Nm csio_build ,
  69 .Nm csio_build_visit ,
  70 .Nm csio_decode ,
  71 .Nm csio_decode_visit ,
  72 .Nm buff_decode ,
  73 .Nm buff_decode_visit ,
  74 .Nm csio_encode ,
  75 .Nm csio_encode_visit ,
  76 .Nm buff_encode_visit
  77 .Nd CAM user library SCSI buffer parsing routines
  78 .Sh LIBRARY
  79 .Lb libcam
  80 .Sh SYNOPSIS
  81 .In stdio.h
  82 .In camlib.h
  83 .Ft int
  84 .Fo csio_build
  85 .Fa "struct ccb_scsiio *csio"
  86 .Fa "u_int8_t *data_ptr"
  87 .Fa "u_int32_t dxfer_len"
  88 .Fa "u_int32_t flags"
  89 .Fa "int retry_count"
  90 .Fa "int timeout"
  91 .Fa "char *cmd_spec"
  92 .Fa "..."
  93 .Fc
  94 .Ft int
  95 .Fo csio_build_visit
  96 .Fa "struct ccb_scsiio *csio"
  97 .Fa "u_int8_t *data_ptr"
  98 .Fa "u_int32_t dxfer_len"
  99 .Fa "u_int32_t flags"
 100 .Fa "int retry_count"
 101 .Fa "int timeout"
 102 .Fa "char *cmd_spec"
 103 .Fa "int (*arg_get)(void *hook, char *field_name)"
 104 .Fa "void *gethook"
 105 .Fc
 106 .Ft int
 107 .Fo csio_decode
 108 .Fa "struct ccb_scsiio *csio"
 109 .Fa "char *fmt"
 110 .Fa "..."
 111 .Fc
 112 .Ft int
 113 .Fo csio_decode_visit
 114 .Fa "struct ccb_scsiio *csio"
 115 .Fa "char *fmt"
 116 .Fa "void (*arg_put)(void *hook"
 117 .Fa "int letter"
 118 .Fa "void *val"
 119 .Fa "int count"
 120 .Fa "char *name)"
 121 .Fa "void *puthook"
 122 .Fc
 123 .Ft int
 124 .Fo buff_decode
 125 .Fa "u_int8_t *buff"
 126 .Fa "size_t len"
 127 .Fa "char *fmt"
 128 .Fa "..."
 129 .Fc
 130 .Ft int
 131 .Fo buff_decode_visit
 132 .Fa "u_int8_t *buff"
 133 .Fa "size_t len"
 134 .Fa "char *fmt"
 135 .Fa "void (*arg_put)(void *, int, void *, int, char *)"
 136 .Fa "void *puthook"
 137 .Fc
 138 .Ft int
 139 .Fo csio_encode
 140 .Fa "struct ccb_scsiio *csio"
 141 .Fa "char *fmt"
 142 .Fa "..."
 143 .Fc
 144 .Ft int
 145 .Fo csio_encode_visit
 146 .Fa "struct ccb_scsiio *csio"
 147 .Fa "char *fmt"
 148 .Fa "int (*arg_get)(void *hook, char *field_name)"
 149 .Fa "void *gethook"
 150 .Fc
 151 .Ft int
 152 .Fo buff_encode_visit
 153 .Fa "u_int8_t *buff"
 154 .Fa "size_t len"
 155 .Fa "char *fmt"
 156 .Fa "int (*arg_get)(void *hook, char *field_name)"
 157 .Fa "void *gethook"
 158 .Fc
 159 .Sh DESCRIPTION
 160 The CAM buffer/CDB encoding and decoding routines provide a relatively easy
 161 migration path for userland
 162 .Tn SCSI
 163 applications written with the similarly-named
 164 .Va scsireq_ Ns *
 165 functions from the old
 166 .Fx
 167 .Tn SCSI
 168 layer.
 169 .Pp
 170 These functions may be used in new applications, but users may find it
 171 easier to use the various SCSI CCB building functions included with the
 172 .Xr cam 3
 173 library.  (e.g.\&
 174 .Fn cam_fill_csio ,
 175 .Fn scsi_start_stop ,
 176 and
 177 .Fn scsi_read_write )
 178 .Pp
 179 .Fn csio_build
 180 builds up a
 181 .Va ccb_scsiio
 182 structure based on the information provided in
 183 the variable argument list.
 184 It gracefully handles a NULL
 185 .Fa data_ptr
 186 argument passed to it.
 187 .Pp
 188 .Fa dxfer_len
 189 is the length of the data phase; the data transfer direction is
 190 determined by the
 191 .Fa flags
 192 argument.
 193 .Pp
 194 .Fa data_ptr
 195 is the data buffer used during the
 196 .Tn SCSI
 197 data phase.  If no data is to be
 198 transferred for the
 199 .Tn SCSI
 200 command in question, this should be set to NULL.  If there is data to
 201 transfer for the command, this buffer must be at least
 202 .Fa dxfer_len
 203 long.
 204 .Pp
 205 .Fa flags
 206 are the flags defined in
 207 .Aq Pa cam/cam_ccb.h :
 208 .Bd -literal
 209 /* Common CCB header */
 210 /* CAM CCB flags */
 211 typedef enum {
 212      CAM_CDB_POINTER       = 0x00000001,/* The CDB field is a pointer    */
 213      CAM_QUEUE_ENABLE      = 0x00000002,/* SIM queue actions are enabled */
 214      CAM_CDB_LINKED        = 0x00000004,/* CCB contains a linked CDB     */
 215      CAM_SCATTER_VALID     = 0x00000010,/* Scatter/gather list is valid  */
 216      CAM_DIS_AUTOSENSE     = 0x00000020,/* Disable autosense feature     */
 217      CAM_DIR_RESV          = 0x00000000,/* Data direction (00:reserved)  */
 218      CAM_DIR_IN            = 0x00000040,/* Data direction (01:DATA IN)   */
 219      CAM_DIR_OUT           = 0x00000080,/* Data direction (10:DATA OUT)  */
 220      CAM_DIR_NONE          = 0x000000C0,/* Data direction (11:no data)   */
 221      CAM_DIR_MASK          = 0x000000C0,/* Data direction Mask           */
 222      CAM_SOFT_RST_OP       = 0x00000100,/* Use Soft reset alternative    */
 223      CAM_ENG_SYNC          = 0x00000200,/* Flush resid bytes on complete */
 224      CAM_DEV_QFRZDIS       = 0x00000400,/* Disable DEV Q freezing        */
 225      CAM_DEV_QFREEZE       = 0x00000800,/* Freeze DEV Q on execution     */
 226      CAM_HIGH_POWER        = 0x00001000,/* Command takes a lot of power  */
 227      CAM_SENSE_PTR         = 0x00002000,/* Sense data is a pointer       */
 228      CAM_SENSE_PHYS        = 0x00004000,/* Sense pointer is physical addr*/
 229      CAM_TAG_ACTION_VALID  = 0x00008000,/* Use the tag action in this ccb*/
 230      CAM_PASS_ERR_RECOVER  = 0x00010000,/* Pass driver does err. recovery*/
 231      CAM_DIS_DISCONNECT    = 0x00020000,/* Disable disconnect            */
 232      CAM_SG_LIST_PHYS      = 0x00040000,/* SG list has physical addrs.   */
 233      CAM_MSG_BUF_PHYS      = 0x00080000,/* Message buffer ptr is physical*/
 234      CAM_SNS_BUF_PHYS      = 0x00100000,/* Autosense data ptr is physical*/
 235      CAM_DATA_PHYS         = 0x00200000,/* SG/Buffer data ptrs are phys. */
 236      CAM_CDB_PHYS          = 0x00400000,/* CDB pointer is physical       */
 237      CAM_ENG_SGLIST        = 0x00800000,/* SG list is for the HBA engine */
 238
 239 /* Phase cognizant mode flags */
 240      CAM_DIS_AUTOSRP       = 0x01000000,/* Disable autosave/restore ptrs */
 241      CAM_DIS_AUTODISC      = 0x02000000,/* Disable auto disconnect       */
 242      CAM_TGT_CCB_AVAIL     = 0x04000000,/* Target CCB available          */
 243      CAM_TGT_PHASE_MODE    = 0x08000000,/* The SIM runs in phase mode    */
 244      CAM_MSGB_VALID        = 0x20000000,/* Message buffer valid          */
 245      CAM_STATUS_VALID      = 0x40000000,/* Status buffer valid           */
 246      CAM_DATAB_VALID       = 0x80000000,/* Data buffer valid             */
 247
 248 /* Host target Mode flags */
 249      CAM_TERM_IO           = 0x20000000,/* Terminate I/O Message sup.    */
 250      CAM_DISCONNECT        = 0x40000000,/* Disconnects are mandatory     */
 251      CAM_SEND_STATUS       = 0x80000000,/* Send status after data phase  */
 252 } ccb_flags;
 253 .Ed
 254 .Pp
 255 Multiple flags should be ORed together.  Any of the CCB flags may be used,
 256 although it is worth noting several important ones here:
 257 .Pp
 258 .Bl -tag -width CAM_PASS_ERR_RECOVER
 259 .It Dv CAM_DIR_IN
 260 This indicates that the operation in question is a read operation.  i.e.,
 261 data is being read from the
 262 .Tn SCSI
 263 device to the user-supplied buffer.
 264 .It Dv CAM_DIR_OUT
 265 This indicates that the operation is a write operation.  i.e. data is being
 266 written from the user-supplied buffer to the device.
 267 .It Dv CAM_DIR_NONE
 268 This indicates that there is no data to be transferred for this command.
 269 .It Dv CAM_DEV_QFRZDIS
 270 This flag disables device queue freezing as an error recovery mechanism.
 271 .It Dv CAM_PASS_ERR_RECOVER
 272 This flag tells the
 273 .Xr pass 4
 274 driver to enable error recovery.  The default is to not perform error
 275 recovery, which means that the retry count won't be honored without this
 276 flag, among other things.
 277 .It Dv CAM_DATA_PHYS
 278 This indicates that the address contained in
 279 .Fa data_ptr
 280 is a physical address, not a virtual address.
 281 .El
 282 .Pp
 283 The
 284 .Fa retry_count
 285 tells the kernel how many times to retry the command in question.  The
 286 retry count is ignored unless the
 287 .Xr pass 4
 288 driver is told to enable error recovery via the
 289 .Dv CAM_PASS_ERR_RECOVER
 290 flag.
 291 .Pp
 292 The
 293 .Fa timeout
 294 tells the kernel how long to wait for the given command to complete.  If
 295 the timeout expires and the command hasn't completed, the CCB will be
 296 returned from the kernel with an appropriate error status.
 297 .Pp
 298 .Fa cmd_spec
 299 is a CDB format specifier used to build up the SCSI CDB.
 300 This text string is made up of a list of field specifiers.  Field
 301 specifiers specify the value for each CDB field (including indicating
 302 that the value be taken from the next argument in the
 303 variable argument list), the width
 304 of the field in bits or bytes, and an optional name.  White space is
 305 ignored, and the pound sign ('#') introduces a comment that ends at the
 306 end of the current line.
 307 .Pp
 308 The optional name is the first part of a field specifier and
 309 is in curly braces.  The text in curly braces in this example are
 310 the names:
 311 .Dl "{PS} v:b1 {Reserved} 0:b1 {Page Code} v:b6 # Mode select page"
 312 .Pp
 313 This field specifier has two one bit fields and one six bit field.
 314 The second one bit field is the constant value 0 and the first
 315 one bit field and the six bit field are taken from the variable
 316 argument list.
 317 Multi byte fields are swapped into the SCSI byte order in the
 318 CDB and white space is ignored.
 319 .Pp
 320 When the field is a hex value or the letter v, (e.g.,
 321 .Fa "1A"
 322 or
 323 .Fa "v" )
 324 then a single byte value
 325 is copied to the next unused byte of the CDB.
 326 When the letter
 327 .Fa v
 328 is used the next integer argument is taken from the variable argument list
 329 and that value used.
 330 .Pp
 331 A constant hex value followed by a field width specifier or the letter
 332 .Fa v
 333 followed by a field width specifier (e.g.,
 334 .Fa 3:4 ,
 335 .Fa 3:b4 ,
 336 .Fa 3:i3 ,
 337 .Fa v:i3 )
 338 specifies a field of a given bit or byte width.
 339 Either the constant value or (for the V specifier) the next integer value from
 340 the variable argument list is copied to the next unused
 341 bits or bytes of the CDB.
 342 .Pp
 343 A decimal number or the letter
 344 .Fa b
 345 followed by a decimal number field width indicates a bit field of that width.
 346 The bit fields are packed as tightly as possible beginning with the
 347 high bit (so that it reads the same as the SCSI spec), and a new byte of
 348 the CDB is started whenever a byte fills completely or when an
 349 .Fa i
 350 field is encountered.
 351 .Pp
 352 A field width specifier consisting of the letter
 353 .Fa i
 354 followed by either
 355 1, 2, 3 or 4 indicates a 1, 2, 3 or 4 byte integral value that must
 356 be swapped into SCSI byte order (MSB first).
 357 .Pp
 358 For the
 359 .Fa v
 360 field specifier the next integer argument is taken from the variable argument
 361 list and that value is used swapped into SCSI byte order.
 362 .Pp
 363 .Fn csio_build_visit
 364 operates similarly to
 365 .Fn csio_build ,
 366 except that the values to substitute for variable arguments in
 367 .Fa cmd_spec
 368 are retrieved via the
 369 .Fn arg_get
 370 function passed in to
 371 .Fn csio_build_visit
 372 instead of via
 373 .Xr stdarg 3 .
 374 The
 375 .Fn arg_get
 376 function takes two arguments:
 377 .Bl -tag -width field_name
 378 .It Fa gethook
 379 is passed into the
 380 .Fn arg_get
 381 function at each invocation.  This enables the
 382 .Fn arg_get
 383 function to keep some state in between calls without using global or static
 384 variables.
 385 .It Fa field_name
 386 is the field name supplied in
 387 .Fa fmt ,
 388 if any.
 389 .El
 390 .Pp
 391 .Fn csio_decode
 392 is used to decode information from the data in phase of the SCSI
 393 transfer.
 394 .Pp
 395 The decoding is similar to
 396 the command specifier processing of
 397 .Fn csio_build
 398 except that the data is extracted from the data pointed to by
 399 .Fa csio->data_ptr .
 400 The stdarg list should be pointers to integers instead of integer
 401 values.
 402 A seek field type and a suppression modifier are added.
 403 The
 404 .Fa *
 405 suppression modifier (e.g.,
 406 .Fa *i3
 407 or
 408 .Fa *b4 )
 409 suppresses assignment from the field and can be used to skip
 410 over bytes or bits in the data, without having to copy
 411 them to a dummy variable in the arg list.
 412 .Pp
 413 The seek field type
 414 .Fa s
 415 permits you to skip over data.
 416 This seeks to an absolute position
 417 .Pq Fa s3
 418 or a relative position
 419 .Pq Fa s+3
 420 in the data, based on whether or not the presence of the '+' sign.
 421 The seek value can be specified as
 422 .Fa v
 423 and the next integer value from the argument list will be
 424 used as the seek value.
 425 .Pp
 426 .Fn csio_decode_visit
 427 operates like
 428 .Fn csio_decode
 429 except that instead of placing the decoded contents of the buffer in
 430 variadic arguments, the decoded buffer contents are returned to the user
 431 via the
 432 .Fn arg_put
 433 function that is passed in.
 434 The
 435 .Fn arg_put
 436 function takes several arguments:
 437 .Bl -tag -width letter
 438 .It Fa hook
 439 The "hook" is a mechanism to allow the
 440 .Fn arg_put
 441 function to save state in between calls.
 442 .It Fa letter
 443 is the letter describing the format of the argument being passed into the
 444 function.
 445 .It Fa val
 446 is a void pointer to the value being passed into the function.
 447 .It Fa count
 448 is the size of the value being passed into the
 449 .Fn arg_put
 450 function.  The argument format determines the unit of measure.
 451 .It Fa name
 452 This is a text description of the field, if one was provided in the
 453 .Fa fmt .
 454 .El
 455 .Pp
 456 .Fn buff_decode
 457 decodes an arbitrary data buffer using the method
 458 described above for
 459 .Fn csio_decode .
 460 .Pp
 461 .Fn buff_decode_visit
 462 decodes an arbitrary data buffer using the method described above for
 463 .Fn csio_decode_visit .
 464 .Pp
 465 .Fn csio_encode
 466 encodes the
 467 .Fa data_ptr
 468 portion (not the CDB!) of a
 469 .Va ccb_scsiio
 470 structure, using the method described above for
 471 .Fn csio_build .
 472 .Pp
 473 .Fn csio_encode_visit
 474 encodes the
 475 .Fa data_ptr
 476 portion (not the CDB!) of a
 477 .Va ccb_scsiio
 478 structure, using the method described above for
 479 .Fn csio_build_visit .
 480 .Pp
 481 .Fn buff_encode_visit
 482 encodes an arbitrary data pointer, using the method described
 483 above for
 484 .Fn csio_build_visit .
 485 .Sh RETURN VALUES
 486 .Fn csio_build ,
 487 .Fn csio_build_visit ,
 488 .Fn csio_encode ,
 489 .Fn csio_encode_visit ,
 490 and
 491 .Fn buff_encode_visit
 492 return the number of fields processed.
 493 .Pp
 494 .Fn csio_decode ,
 495 .Fn csio_decode_visit ,
 496 .Fn buff_decode ,
 497 and
 498 .Fn buff_decode_visit
 499 return the number of assignments performed.
 500 .Sh SEE ALSO
 501 .Xr cam 3 ,
 502 .Xr pass 4 ,
 503 .Xr camcontrol 8
 504 .Sh HISTORY
 505 The CAM versions of these functions are based upon similar functions
 506 implemented for the old
 507 .Fx
 508 .Tn SCSI
 509 layer.  The encoding/decoding functions in the old
 510 .Tn SCSI
 511 code were written by Peter Dufault.
 512 .Pp
 513 Many systems have comparable interfaces to permit a user to construct a
 514 SCSI command in user space.
 515 .Pp
 516 The old
 517 .Va scsireq
 518 data structure was almost identical to the SGI /dev/scsi data
 519 structure.  If anyone knows the name of the authors it should
 520 go here; Peter Dufault first read about it in a 1989 Sun Expert magazine.
 521 .Pp
 522 The new CCB data structures are derived from the CAM-2 and CAM-3
 523 specifications.
 524 .Pp
 525 .An Peter Dufault
 526 implemented a clone of SGI's interface in
 527 .Bx 386
 528 that
 529 led to the original
 530 .Fx
 531 .Tn SCSI
 532 library and the related kernel ioctl.
 533 If anyone needs that for compatibility contact dufault@hda.com.
 534 .Sh AUTHORS
 535 Kenneth Merry implemented the CAM versions of these encoding and decoding
 536 functions.  This current work is based upon earlier work by Peter Dufault.
 537 .Sh BUGS
 538 There should probably be a function that encodes both the CDB and the data
 539 buffer portions of a
 540 .Tn SCSI
 541 CCB.  I discovered this while implementing the arbitrary command execution
 542 code in
 543 .Xr camcontrol 8 ,
 544 but I haven't yet had time to implement such a function.
 545 .Pp
 546 Some of the CCB flag descriptions really don't belong here.  Rather they
 547 belong in a generic CCB man page.  Since that man page hasn't yet been
 548 written, the shorter descriptions here will have to suffice.