2 * Taken from the original FreeBSD user SCSI library.
4 /* Copyright (c) 1994 HD Associates
5 * (contact: dufault@hda.com)
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. All advertising materials mentioning features or use of this software
17 * must display the following acknowledgement:
18 * This product includes software developed by HD Associates
19 * 4. Neither the name of the HD Associaates nor the names of its contributors
20 * may be used to endorse or promote products derived from this software
21 * without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY HD ASSOCIATES``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL HD ASSOCIATES OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * From: scsi.c,v 1.8 1997/02/22 15:07:54 peter Exp $
37 #include <sys/cdefs.h>
38 __FBSDID("$FreeBSD$");
40 #include <sys/types.h>
46 #include <sys/errno.h>
51 #include <cam/cam_ccb.h>
52 #include <cam/scsi/scsi_message.h>
56 * Decode: Decode the data section of a scsireq. This decodes
59 * fields : field fields
62 * field : field_specifier
66 * control : 's' seek_value
67 * | 's' '+' seek_value
70 * seek_value : DECIMAL_NUMBER
71 * | 'v' // For indirect seek, i.e., value from the arg list
74 * field_specifier : type_specifier field_width
75 * | '{' NAME '}' type_specifier field_width
78 * field_width : DECIMAL_NUMBER
81 * type_specifier : 'i' // Integral types (i1, i2, i3, i4)
84 * | 'c' // Character arrays
85 * | 'z' // Character arrays with zeroed trailing spaces
89 * 1. Integral types are swapped into host order.
90 * 2. Bit fields are allocated MSB to LSB to match the SCSI spec documentation.
91 * 3. 's' permits "seeking" in the string. "s+DECIMAL" seeks relative to
92 * DECIMAL; "sDECIMAL" seeks absolute to decimal.
93 * 4. 's' permits an indirect reference. "sv" or "s+v" will get the
94 * next integer value from the arg array.
95 * 5. Field names can be anything between the braces
98 * i and b types are promoted to ints.
103 do_buff_decode(u_int8_t *databuf, size_t len,
104 void (*arg_put)(void *, int , void *, int, char *),
105 void *puthook, const char *fmt, va_list ap)
112 static u_char mask[] = {0, 0x01, 0x03, 0x07, 0x0f,
113 0x1f, 0x3f, 0x7f, 0xff};
115 u_char *base = databuf;
120 # define ARG_PUT(ARG) \
126 (*arg_put)(puthook, (letter == 't' ? \
128 (void *)((long)(ARG)), width, \
131 *(va_arg(ap, int *)) = (ARG); \
138 u_char bits = 0; /* For bit fields */
139 int shift = 0; /* Bits already shifted out */
144 switch(letter = *fmt) {
145 case ' ': /* White space */
153 case '#': /* Comment */
154 while (*fmt && (*fmt != '\n'))
157 fmt++; /* Skip '\n' */
160 case '*': /* Suppress assignment */
165 case '{': /* Field Name */
168 fmt++; /* Skip '{' */
169 while (*fmt && (*fmt != '}')) {
170 if (i < sizeof(field_name))
171 field_name[i++] = *fmt;
176 fmt++; /* Skip '}' */
181 case 't': /* Bit (field) */
184 width = strtol(fmt, &intendp, 10);
193 value = (bits >> (shift - width)) &
197 printf("shift %2d bits %02x value %02x width %2d mask %02x\n",
198 shift, bits, value, width, mask[width]);
207 case 'i': /* Integral values */
210 width = strtol(fmt, &intendp, 10);
219 ARG_PUT((*databuf) << 8 | *(databuf + 1));
224 ARG_PUT((*databuf) << 16 |
225 (*(databuf + 1)) << 8 | *(databuf + 2));
230 ARG_PUT((*databuf) << 24 |
231 (*(databuf + 1)) << 16 |
232 (*(databuf + 2)) << 8 |
244 case 'c': /* Characters (i.e., not swapped) */
245 case 'z': /* Characters with zeroed trailing
249 width = strtol(fmt, &intendp, 10);
254 (letter == 't' ? 'b' : letter),
255 databuf, width, field_name);
258 dest = va_arg(ap, char *);
259 bcopy(databuf, dest, width);
262 for (p = dest + width - 1;
284 if (tolower(*fmt) == 'v') {
286 * You can't suppress a seek value. You also
287 * can't have a variable seek when you are using
290 width = (arg_put) ? 0 : va_arg(ap, int);
293 width = strtol(fmt, &intendp, 10);
298 databuf += width; /* Relative seek */
300 databuf = base + width; /* Absolute seek */
309 fprintf(stderr, "Unknown letter in format: %c\n",
319 /* next_field: Return the next field in a command specifier. This
320 * builds up a SCSI command using this trivial grammar:
322 * fields : field fields
326 * | value ':' field_width
329 * field_width : digit
330 * | 'i' digit // i2 = 2 byte integer, i3 = 3 byte integer etc.
334 * | 'v' // For indirection.
338 * Bit fields are specified MSB first to match the SCSI spec.
342 * WRITE BUFFER: "38 v:3 0:2 0:3 v v:i3 v:i3 0", mode, buffer_id, list_length
344 * The function returns the value:
345 * 0: For reached end, with error_p set if an error was found
346 * 1: For valid stuff setup
347 * 2: For "v" was entered as the value (implies use varargs)
352 next_field(const char **pp, char *fmt, int *width_p, int *value_p, char *name,
353 int n_name, int *error_p, int *suppress_p)
368 int field_size; /* Default to byte field type... */
369 int field_width; /* 1 byte wide */
373 field_size = 8; /* Default to byte field type... */
375 field_width = 1; /* 1 byte wide */
379 state = BETWEEN_FIELDS;
381 while (state != DONE) {
386 else if (isspace(*p))
388 else if (*p == '#') {
389 while (*p && *p != '\n')
393 } else if (*p == '{') {
398 while (*p && *p != '}') {
399 if(name && i < n_name) {
406 if(name && i < n_name)
411 } else if (*p == '*') {
414 } else if (isxdigit(*p)) {
416 value = strtol(p, &intendp, 16);
419 } else if (tolower(*p) == 'v') {
424 } else if (tolower(*p) == 'i') {
426 * Try to work without the "v".
434 field_width = strtol(p, &intendp, 10);
438 } else if (tolower(*p) == 't') {
440 * XXX: B can't work: Sees the 'b' as a
441 * hex digit in "isxdigit". try "t" for
450 field_width = strtol(p, &intendp, 10);
453 } else if (tolower(*p) == 's') {
457 if (tolower(*p) == 'v') {
463 value = strtol(p, &intendp, 0);
468 fprintf(stderr, "Invalid starting "
469 "character: %c\n", *p);
478 field_size = 1; /* Default to bits
489 field_width = strtol(p, &intendp, 10);
492 } else if (*p == 'i') {
494 /* Integral (bytes) */
499 field_width = strtol(p, &intendp, 10);
502 } else if (*p == 'b') {
509 field_width = strtol(p, &intendp, 10);
513 fprintf(stderr, "Invalid startfield %c "
532 *width_p = field_width * field_size;
534 *suppress_p = suppress;
540 do_encode(u_char *buff, size_t vec_max, size_t *used,
541 int (*arg_get)(void *, char *), void *gethook, const char *fmt,
548 int width, value, error, suppress;
557 while ((ret = next_field(&fmt, &c, &width, &value, field_name,
558 sizeof(field_name), &error, &suppress))) {
566 (*arg_get)(gethook, field_name) :
572 "do_encode: ret %d fmt %c width %d value %d name \"%s\" error %d suppress %d\n",
573 ret, c, width, value, field_name, error, suppress);
581 /* A width of < 8 is a bit field. */
584 /* This is a bit field. We start with the high bits
585 * so it reads the same as the SCSI spec.
590 val |= (value << (8 - shift));
608 case 8: /* 1 byte integer */
613 case 16: /* 2 byte integer */
614 if (ind < vec_max - 2 + 1) {
615 buff[ind++] = value >> 8;
620 case 24: /* 3 byte integer */
621 if (ind < vec_max - 3 + 1) {
622 buff[ind++] = value >> 16;
623 buff[ind++] = value >> 8;
628 case 32: /* 4 byte integer */
629 if (ind < vec_max - 4 + 1) {
630 buff[ind++] = value >> 24;
631 buff[ind++] = value >> 16;
632 buff[ind++] = value >> 8;
638 fprintf(stderr, "do_encode: Illegal width\n");
644 /* Flush out any remaining bits
646 if (shift && ind < vec_max) {
662 csio_decode(struct ccb_scsiio *csio, const char *fmt, ...)
668 return(do_buff_decode(csio->data_ptr, (size_t)csio->dxfer_len,
673 csio_decode_visit(struct ccb_scsiio *csio, const char *fmt,
674 void (*arg_put)(void *, int, void *, int, char *),
680 * We need some way to output things; we can't do it without
681 * the arg_put function.
686 bzero(&ap, sizeof(ap));
688 return(do_buff_decode(csio->data_ptr, (size_t)csio->dxfer_len,
689 arg_put, puthook, fmt, ap));
693 buff_decode(u_int8_t *buff, size_t len, const char *fmt, ...)
699 return(do_buff_decode(buff, len, 0, 0, fmt, ap));
703 buff_decode_visit(u_int8_t *buff, size_t len, const char *fmt,
704 void (*arg_put)(void *, int, void *, int, char *),
710 * We need some way to output things; we can't do it without
711 * the arg_put function.
716 bzero(&ap, sizeof(ap));
718 return(do_buff_decode(buff, len, arg_put, puthook, fmt, ap));
722 * Build a SCSI CCB, given the command and data pointers and a format
723 * string describing the
726 csio_build(struct ccb_scsiio *csio, u_int8_t *data_ptr, u_int32_t dxfer_len,
727 u_int32_t flags, int retry_count, int timeout, const char *cmd_spec,
737 bzero(csio, sizeof(struct ccb_scsiio));
739 va_start(ap, cmd_spec);
741 if ((retval = do_encode(csio->cdb_io.cdb_bytes, SCSI_MAX_CDBLEN,
742 &cmdlen, NULL, NULL, cmd_spec, ap)) == -1)
746 /* retries */ retry_count,
749 /* tag_action */ MSG_SIMPLE_Q_TAG,
750 /* data_ptr */ data_ptr,
751 /* dxfer_len */ dxfer_len,
752 /* sense_len */ SSD_FULL_SIZE,
753 /* cdb_len */ cmdlen,
754 /* timeout */ timeout ? timeout : 5000);
760 csio_build_visit(struct ccb_scsiio *csio, u_int8_t *data_ptr,
761 u_int32_t dxfer_len, u_int32_t flags, int retry_count,
762 int timeout, const char *cmd_spec,
763 int (*arg_get)(void *hook, char *field_name), void *gethook)
773 * We need something to encode, but we can't get it without the
779 bzero(&ap, sizeof(ap));
781 bzero(csio, sizeof(struct ccb_scsiio));
783 if ((retval = do_encode(csio->cdb_io.cdb_bytes, SCSI_MAX_CDBLEN,
784 &cmdlen, arg_get, gethook, cmd_spec, ap)) == -1)
788 /* retries */ retry_count,
791 /* tag_action */ MSG_SIMPLE_Q_TAG,
792 /* data_ptr */ data_ptr,
793 /* dxfer_len */ dxfer_len,
794 /* sense_len */ SSD_FULL_SIZE,
795 /* cdb_len */ cmdlen,
796 /* timeout */ timeout ? timeout : 5000);
802 csio_encode(struct ccb_scsiio *csio, const char *fmt, ...)
811 return(do_encode(csio->data_ptr, csio->dxfer_len, 0, 0, 0, fmt, ap));
815 buff_encode_visit(u_int8_t *buff, size_t len, const char *fmt,
816 int (*arg_get)(void *hook, char *field_name), void *gethook)
821 * We need something to encode, but we can't get it without the
827 bzero(&ap, sizeof(ap));
829 return(do_encode(buff, len, 0, arg_get, gethook, fmt, ap));
833 csio_encode_visit(struct ccb_scsiio *csio, const char *fmt,
834 int (*arg_get)(void *hook, char *field_name), void *gethook)
839 * We need something to encode, but we can't get it without the
845 bzero(&ap, sizeof(ap));
847 return(do_encode(csio->data_ptr, csio->dxfer_len, 0, arg_get,