2 .\" Copyright (c) 1998 Kenneth D. Merry.
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
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.
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
30 .\" This man page borrows heavily from the old scsi(3) man page, which had
31 .\" the following copyright:
33 .\" Copyright (c) 1994 HD Associates (hd@world.std.com)
34 .\" All rights reserved.
36 .\" Redistribution and use in source and binary forms, with or without
37 .\" modification, are permitted provided that the following conditions
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.
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
69 .Nm csio_build_visit ,
71 .Nm csio_decode_visit ,
73 .Nm buff_decode_visit ,
75 .Nm csio_encode_visit ,
77 .Nd CAM user library SCSI buffer parsing routines
85 .Fa "struct ccb_scsiio *csio"
86 .Fa "uint8_t *data_ptr"
87 .Fa "uint32_t dxfer_len"
91 .Fa "const char *cmd_spec"
96 .Fa "struct ccb_scsiio *csio"
97 .Fa "uint8_t *data_ptr"
98 .Fa "uint32_t dxfer_len"
100 .Fa "int retry_count"
102 .Fa "const char *cmd_spec"
103 .Fa "int (*arg_get)(void *hook, char *field_name)"
108 .Fa "struct ccb_scsiio *csio"
109 .Fa "const char *fmt"
113 .Fo csio_decode_visit
114 .Fa "struct ccb_scsiio *csio"
115 .Fa "const char *fmt"
116 .Fa "void (*arg_put)(void *hook"
127 .Fa "const char *fmt"
131 .Fo buff_decode_visit
134 .Fa "const char *fmt"
135 .Fa "void (*arg_put)(void *, int, void *, int, char *)"
140 .Fa "struct ccb_scsiio *csio"
141 .Fa "const char *fmt"
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)"
152 .Fo buff_encode_visit
155 .Fa "const char *fmt"
156 .Fa "int (*arg_get)(void *hook, char *field_name)"
160 The CAM buffer/CDB encoding and decoding routines provide a relatively easy
161 migration path for userland
163 applications written with the similarly-named
165 functions from the old
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
175 .Fn scsi_start_stop ,
177 .Fn scsi_read_write .
182 structure based on the information provided in
183 the variable argument list.
184 It gracefully handles a NULL
186 argument passed to it.
189 is the length of the data phase; the data transfer direction is
195 is the data buffer used during the
201 command in question, this should be set to NULL.
203 transfer for the command, this buffer must be at least
208 are the flags defined in
211 /* Common CCB header */
214 CAM_CDB_POINTER = 0x00000001,/* The CDB field is a pointer */
215 CAM_QUEUE_ENABLE = 0x00000002,/* SIM queue actions are enabled */
216 CAM_CDB_LINKED = 0x00000004,/* CCB contains a linked CDB */
217 CAM_SCATTER_VALID = 0x00000010,/* Scatter/gather list is valid */
218 CAM_DIS_AUTOSENSE = 0x00000020,/* Disable autosense feature */
219 CAM_DIR_RESV = 0x00000000,/* Data direction (00:reserved) */
220 CAM_DIR_IN = 0x00000040,/* Data direction (01:DATA IN) */
221 CAM_DIR_OUT = 0x00000080,/* Data direction (10:DATA OUT) */
222 CAM_DIR_NONE = 0x000000C0,/* Data direction (11:no data) */
223 CAM_DIR_MASK = 0x000000C0,/* Data direction Mask */
224 CAM_SOFT_RST_OP = 0x00000100,/* Use Soft reset alternative */
225 CAM_ENG_SYNC = 0x00000200,/* Flush resid bytes on complete */
226 CAM_DEV_QFRZDIS = 0x00000400,/* Disable DEV Q freezing */
227 CAM_DEV_QFREEZE = 0x00000800,/* Freeze DEV Q on execution */
228 CAM_HIGH_POWER = 0x00001000,/* Command takes a lot of power */
229 CAM_SENSE_PTR = 0x00002000,/* Sense data is a pointer */
230 CAM_SENSE_PHYS = 0x00004000,/* Sense pointer is physical addr*/
231 CAM_TAG_ACTION_VALID = 0x00008000,/* Use the tag action in this ccb*/
232 CAM_PASS_ERR_RECOVER = 0x00010000,/* Pass driver does err. recovery*/
233 CAM_DIS_DISCONNECT = 0x00020000,/* Disable disconnect */
234 CAM_SG_LIST_PHYS = 0x00040000,/* SG list has physical addrs. */
235 CAM_MSG_BUF_PHYS = 0x00080000,/* Message buffer ptr is physical*/
236 CAM_SNS_BUF_PHYS = 0x00100000,/* Autosense data ptr is physical*/
237 CAM_DATA_PHYS = 0x00200000,/* SG/Buffer data ptrs are phys. */
238 CAM_CDB_PHYS = 0x00400000,/* CDB pointer is physical */
239 CAM_ENG_SGLIST = 0x00800000,/* SG list is for the HBA engine */
241 /* Phase cognizant mode flags */
242 CAM_DIS_AUTOSRP = 0x01000000,/* Disable autosave/restore ptrs */
243 CAM_DIS_AUTODISC = 0x02000000,/* Disable auto disconnect */
244 CAM_TGT_CCB_AVAIL = 0x04000000,/* Target CCB available */
245 CAM_TGT_PHASE_MODE = 0x08000000,/* The SIM runs in phase mode */
246 CAM_MSGB_VALID = 0x20000000,/* Message buffer valid */
247 CAM_STATUS_VALID = 0x40000000,/* Status buffer valid */
248 CAM_DATAB_VALID = 0x80000000,/* Data buffer valid */
250 /* Host target Mode flags */
251 CAM_TERM_IO = 0x20000000,/* Terminate I/O Message sup. */
252 CAM_DISCONNECT = 0x40000000,/* Disconnects are mandatory */
253 CAM_SEND_STATUS = 0x80000000,/* Send status after data phase */
257 Multiple flags should be ORed together.
258 Any of the CCB flags may be used,
259 although it is worth noting several important ones here:
260 .Bl -tag -width CAM_PASS_ERR_RECOVER
262 This indicates that the operation in question is a read operation.
264 data is being read from the
266 device to the user-supplied buffer.
268 This indicates that the operation is a write operation.
270 written from the user-supplied buffer to the device.
272 This indicates that there is no data to be transferred for this command.
273 .It Dv CAM_DEV_QFRZDIS
274 This flag disables device queue freezing as an error recovery mechanism.
275 .It Dv CAM_PASS_ERR_RECOVER
278 driver to enable error recovery.
279 The default is to not perform error
280 recovery, which means that the retry count will not be honored without this
281 flag, among other things.
283 This indicates that the address contained in
285 is a physical address, not a virtual address.
290 tells the kernel how many times to retry the command in question.
292 retry count is ignored unless the
294 driver is told to enable error recovery via the
295 .Dv CAM_PASS_ERR_RECOVER
300 tells the kernel how long to wait for the given command to complete.
302 the timeout expires and the command has not completed, the CCB will be
303 returned from the kernel with an appropriate error status.
306 is a CDB format specifier used to build up the SCSI CDB.
307 This text string is made up of a list of field specifiers.
309 specifiers specify the value for each CDB field (including indicating
310 that the value be taken from the next argument in the
311 variable argument list), the width
312 of the field in bits or bytes, and an optional name.
314 ignored, and the pound sign ('#') introduces a comment that ends at the
315 end of the current line.
317 The optional name is the first part of a field specifier and
319 The text in curly braces in this example are
321 .Dl "{PS} v:b1 {Reserved} 0:b1 {Page Code} v:b6 # Mode select page"
323 This field specifier has two one bit fields and one six bit field.
324 The second one bit field is the constant value 0 and the first
325 one bit field and the six bit field are taken from the variable
327 Multi byte fields are swapped into the SCSI byte order in the
328 CDB and white space is ignored.
330 When the field is a hex value or the letter v, (e.g.,
334 then a single byte value
335 is copied to the next unused byte of the CDB.
338 is used the next integer argument is taken from the variable argument list
341 A constant hex value followed by a field width specifier or the letter
343 followed by a field width specifier (e.g.,
348 specifies a field of a given bit or byte width.
349 Either the constant value or (for the V specifier) the next integer value from
350 the variable argument list is copied to the next unused
351 bits or bytes of the CDB.
353 A decimal number or the letter
355 followed by a decimal number field width indicates a bit field of that width.
356 The bit fields are packed as tightly as possible beginning with the
357 high bit (so that it reads the same as the SCSI spec), and a new byte of
358 the CDB is started whenever a byte fills completely or when an
360 field is encountered.
362 A field width specifier consisting of the letter
365 1, 2, 3 or 4 indicates a 1, 2, 3 or 4 byte integral value that must
366 be swapped into SCSI byte order (MSB first).
370 field specifier the next integer argument is taken from the variable argument
371 list and that value is used swapped into SCSI byte order.
374 operates similarly to
376 except that the values to substitute for variable arguments in
378 are retrieved via the
380 function passed in to
386 function takes two arguments:
387 .Bl -tag -width field_name
391 function at each invocation.
394 function to keep some state in between calls without using global or static
397 is the field name supplied in
403 is used to decode information from the data in phase of the SCSI
406 The decoding is similar to
407 the command specifier processing of
409 except that the data is extracted from the data pointed to by
411 The stdarg list should be pointers to integers instead of integer
413 A seek field type and a suppression modifier are added.
416 suppression modifier (e.g.,
420 suppresses assignment from the field and can be used to skip
421 over bytes or bits in the data, without having to copy
422 them to a dummy variable in the arg list.
426 permits you to skip over data.
427 This seeks to an absolute position
429 or a relative position
431 in the data, based on whether or not the presence of the '+' sign.
432 The seek value can be specified as
434 and the next integer value from the argument list will be
435 used as the seek value.
437 .Fn csio_decode_visit
440 except that instead of placing the decoded contents of the buffer in
441 variadic arguments, the decoded buffer contents are returned to the user
444 function that is passed in.
447 function takes several arguments:
448 .Bl -tag -width letter
450 The "hook" is a mechanism to allow the
452 function to save state in between calls.
454 is the letter describing the format of the argument being passed into the
457 is a void pointer to the value being passed into the function.
459 is the size of the value being passed into the
462 The argument format determines the unit of measure.
464 This is a text description of the field, if one was provided in the
469 decodes an arbitrary data buffer using the method
473 .Fn buff_decode_visit
474 decodes an arbitrary data buffer using the method described above for
475 .Fn csio_decode_visit .
480 portion (not the CDB!) of a
482 structure, using the method described above for
485 .Fn csio_encode_visit
488 portion (not the CDB!) of a
490 structure, using the method described above for
491 .Fn csio_build_visit .
493 .Fn buff_encode_visit
494 encodes an arbitrary data pointer, using the method described
496 .Fn csio_build_visit .
499 .Fn csio_build_visit ,
501 .Fn csio_encode_visit ,
503 .Fn buff_encode_visit
504 return the number of fields processed.
507 .Fn csio_decode_visit ,
510 .Fn buff_decode_visit
511 return the number of assignments performed.
517 The CAM versions of these functions are based upon similar functions
518 implemented for the old
522 The encoding/decoding functions in the old
525 .An Peter Dufault Aq Mt dufault@hda.com .
527 Many systems have comparable interfaces to permit a user to construct a
528 SCSI command in user space.
532 data structure was almost identical to the SGI /dev/scsi data structure.
533 If anyone knows the name of the authors it should go here;
535 first read about it in a 1989 Sun Expert magazine.
537 The new CCB data structures are derived from the CAM-2 and CAM-3
541 implemented a clone of SGI's interface in
547 library and the related kernel ioctl.
548 If anyone needs that for compatibility, contact
549 .Mt dufault@hda.com .
552 .An Kenneth Merry Aq Mt ken@FreeBSD.org
553 implemented the CAM versions of these encoding and decoding functions.
554 This current work is based upon earlier work by
555 .An Peter Dufault Aq Mt dufault@hda.com .
557 There should probably be a function that encodes both the CDB and the data
561 I discovered this while implementing the arbitrary command execution
564 but I have not yet had time to implement such a function.
566 Some of the CCB flag descriptions really do not belong here.
568 belong in a generic CCB man page.
569 Since that man page has not yet been
570 written, the shorter descriptions here will have to suffice.