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