diff options
Diffstat (limited to 'lib/libcam')
| -rw-r--r-- | lib/libcam/Makefile | 40 | ||||
| -rw-r--r-- | lib/libcam/cam.3 | 416 | ||||
| -rw-r--r-- | lib/libcam/cam_cdbparse.3 | 543 | ||||
| -rw-r--r-- | lib/libcam/camlib.c | 785 | ||||
| -rw-r--r-- | lib/libcam/camlib.h | 178 | ||||
| -rw-r--r-- | lib/libcam/scsi_cmdparse.c | 827 |
6 files changed, 2789 insertions, 0 deletions
diff --git a/lib/libcam/Makefile b/lib/libcam/Makefile new file mode 100644 index 0000000..6f47001 --- /dev/null +++ b/lib/libcam/Makefile @@ -0,0 +1,40 @@ +MAINTAINER=ken@FreeBSD.ORG + +LIB= cam +SRCS= camlib.c scsi_cmdparse.c scsi_all.c scsi_sa.c cam.c + +MAN3= cam.3 cam_cdbparse.3 + + +MLINKS+=cam.3 cam_open_device.3 \ + cam.3 cam_open_spec_device.3 \ + cam.3 cam_open_btl.3 \ + cam.3 cam_open_pass.3 \ + cam.3 cam_close_device.3 \ + cam.3 cam_close_spec_device.3 \ + cam.3 cam_getccb.3 \ + cam.3 cam_send_ccb.3 \ + cam.3 cam_freeccb.3 \ + cam.3 cam_path_string.3 \ + cam.3 cam_device_dup.3 \ + cam.3 cam_device_copy.3 \ + cam.3 cam_get_device.3 \ + cam_cdbparse.3 csio_build.3 \ + cam_cdbparse.3 csio_build_visit.3 \ + cam_cdbparse.3 csio_decode.3 \ + cam_cdbparse.3 csio_decode_visit.3 \ + cam_cdbparse.3 buff_decode.3 \ + cam_cdbparse.3 buff_decode_visit.3 \ + cam_cdbparse.3 csio_encode.3 \ + cam_cdbparse.3 csio_encode_visit.3 \ + cam_cdbparse.3 buff_encode_visit.3 + +beforeinstall: + ${INSTALL} -C -o ${BINOWN} -g ${BINGRP} -m 444 ${.CURDIR}/camlib.h \ + ${DESTDIR}/usr/include + +.PATH: ${.CURDIR}/../../sys/cam/scsi ${.CURDIR}/../../sys/cam + +CFLAGS+=-I${.CURDIR} -I${.CURDIR}/../../sys + +.include <bsd.lib.mk> diff --git a/lib/libcam/cam.3 b/lib/libcam/cam.3 new file mode 100644 index 0000000..8cd898c --- /dev/null +++ b/lib/libcam/cam.3 @@ -0,0 +1,416 @@ +.\" +.\" Copyright (c) 1998 Kenneth D. Merry. +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. The name of the author may not be used to endorse or promote products +.\" derived from this software without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.Dd October 10, 1998 +.Os FreeBSD 3.0 +.Dt CAM 3 +.Sh NAME +.Nm cam_open_device , +.Nm cam_open_spec_device , +.Nm cam_open_btl , +.Nm cam_open_pass , +.Nm cam_close_device , +.Nm cam_close_spec_device , +.Nm cam_getccb , +.Nm cam_send_ccb , +.Nm cam_freeccb , +.Nm cam_path_string , +.Nm cam_device_dup , +.Nm cam_device_copy , +.Nm cam_get_device +.Nd CAM user library +.Sh SYNOPSIS +.Fd #include <stdio.h> +.Fd #include <camlib.h> +.Ft struct cam_device * +.Fo cam_open_device +.Fa "const char *path" +.Fa "int flags" +.Fc +.Ft struct cam_device * +.Fo cam_open_spec_device +.Fa "const char *dev_name" +.Fa "int unit" +.Fa "int flags" +.Fa "struct cam_device *device" +.Fc +.Ft struct cam_device * +.Fo cam_open_btl +.Fa "path_id_t path_id" +.Fa "target_id_t target_id" +.Fa "lun_id_t target_lun" +.Fa "int flags" +.Fa "struct cam_device *device" +.Fc +.Ft struct cam_device * +.Fo cam_open_pass +.Fa "const char *path" +.Fa "int flags" +.Fa "struct cam_device *device" +.Fc +.Ft void +.Fo cam_close_device +.Fa "struct cam_device *dev" +.Fc +.Ft void +.Fo cam_close_spec_device +.Fa "struct cam_device *dev" +.Fc +.Ft union ccb * +.Fo cam_getccb +.Fa "struct cam_device *dev" +.Fc +.Ft int +.Fo cam_send_ccb +.Fa "struct cam_device *device" +.Fa "union ccb *ccb" +.Fc +.Ft void +.Fo cam_freeccb +.Fa "union ccb *ccb" +.Fc +.Ft char * +.Fo cam_path_string +.Fa "struct cam_device *dev" +.Fa "char *str" +.Fa "int len" +.Fc +.Ft struct cam_device * +.Fo cam_device_dup +.Fa "struct cam_device *device" +.Fc +.Ft void +.Fo cam_device_copy +.Fa "struct cam_device *src" +.Fa "struct cam_device *dst" +.Fc +.Ft int +.Fo cam_get_device +.Fa "const char *path" +.Fa "char *dev_name" +.Fa "int devnamelen" +.Fa "int *unit" +.Fc +.Sh DESCRIPTION +The CAM library consists of a number of functions designed to aid in +programming with the CAM subsystem. This man page covers the basic set of +library functions. More functions are documented in the man pages listed +below. +.Pp +Many of the CAM library functions use the +.Va cam_device +structure: +.Bd -literal +struct cam_device { + char device_path[MAXPATHLEN+1];/* + * Pathname of the + * device given by the + * user. This may be + * null if the user + * states the device + * name and unit number + * separately. + */ + char given_dev_name[DEV_IDLEN+1];/* + * Device name given by + * the user. + */ + u_int32_t given_unit_number; /* + * Unit number given by + * the user. + */ + char device_name[DEV_IDLEN+1];/* + * Name of the device, + * e.g. 'pass' + */ + u_int32_t dev_unit_num; /* Unit number of the passthrough + * device associated with this + * particular device. + */ + + char sim_name[SIM_IDLEN+1];/* + * Controller name, e.g.'ahc' + */ + u_int32_t sim_unit_number; /* Controller unit number */ + u_int32_t bus_id; /* Controller bus number */ + lun_id_t target_lun; /* Logical Unit Number */ + target_id_t target_id; /* Target ID */ + path_id_t path_id; /* System SCSI bus number */ + u_int16_t pd_type; /* type of peripheral device */ + struct scsi_inquiry_data inq_data; /* SCSI Inquiry data */ + u_int8_t serial_num[252]; /* device serial number */ + u_int8_t serial_num_len; /* length of the serial number */ + u_int8_t sync_period; /* Negotiated sync period */ + u_int8_t sync_offset; /* Negotiated sync offset */ + u_int8_t bus_width; /* Negotiated bus width */ + int fd; /* file descriptor for device */ +}; +.Ed +.Pp +.Fn cam_open_device +takes as arguments a string describing the device it is to open, and +.Ar flags +suitable for passing to +.Xr open 2 . +The "path" passed in may actually be most any type of string that contains +a device name and unit number to be opened. The string will be parsed by +.Fn cam_get_device +into a device name and unit number. Once the device name and unit number +are determined, a lookup is performed to determine the passthrough device +that corresponds to the given device. +.Fn cam_open_device +is rather simple to use, but it isn't really suitable for general use +because its behavior isn't necessarily deterministic. Programmers writing +new applications should make the extra effort to use one of the other open +routines documented below. +.Pp +.Fn cam_open_spec_device +opens the +.Xr pass 4 +device that corresponds to the device name and unit number passed in. The +.Ar flags +should be flags suitable for passing to +.Xr open 2 . +The +.Ar device +argument is optional. The user may supply pre-allocated space for the +.Va cam_device +structure. If the +.Ar device +argument is +.Va NULL , +.Fn cam_open_spec_device +will allocate space for the +.Va cam_device +structure using +.Xr malloc 3 . +.Pp +.Fn cam_open_btl +is similar to +.Fn cam_open_spec_device , +except that it takes a +.Tn SCSI +bus, target and logical unit instead of a device name and unit number as +arguments. The +.Va path_id +argument is the CAM equivalent of a +.Tn SCSI +bus number. It represents the logical bus number in the system. The +.Ar flags +should be flags suitable for passing to +.Xr open 2 . +As with +.Fn cam_open_spec_device , +the +.Fa device +argument is optional. +.Pp +.Fn cam_open_pass +takes as an argument the +.Fa path +of a +.Xr pass 4 +device to open. No translation or lookup is performed, so the path passed +in must be that of a CAM +.Xr pass 4 +device. The +.Fa flags +should be flags suitable for passing to +.Xr open 2 . +The +.Fa device +argument, as with +.Fn cam_open_spec_device +and +.Fn cam_open_btl , +should be NULL if the user wants the CAM library to allocate space for the +.Va cam_device +structure. +.Fn cam_close_device +frees the +.Va cam_device +structure allocated by one of the above open() calls, and closes the file +descriptor to the passthrough device. This routine should not be called if +the user allocated space for the +.Va cam_device +structure. Instead, the user should call +.Fn cam_close_spec_device . +.Pp +.Fn cam_close_spec_device +merely closes the file descriptor opened in one of the open() routines +described above. This function should be called when the +.Va cam_device +structure was allocated by the caller, rather than the CAM library. +.Pp +.Fn cam_getccb +allocates a CCB +using +.Xr malloc 3 +and sets fields in the CCB header using values from the +.Va cam_device +structure. +.Pp +.Fn cam_send_ccb +sends the given +.Va ccb +to the +.Fa device +described in the +.Va cam_device +structure. +.Pp +.Fn cam_freeccb +frees CCBs allocated by +.Fn cam_getccb . +.Pp +.Fn cam_path_string +takes as arguments a +.Va cam_device +structure, and a string with length +.Fa len . +It creates a colon-terminated printing prefix string similar to the ones +used by the kernel. e.g.: "(cd0:ahc1:0:4:0): ". +.Fn cam_path_string +will place at most +.Fa len Ns \-1 +characters into +.Ar str . +The +.Ar len Ns 'th +character will be the terminating +.Ql \e0 . +.Pp +.Fn cam_device_dup +operates in a fashion similar to +.Xr strdup 3 . +It allocates space for a +.Va cam_device +structure and copies the contents of the passed-in +.Fa device +structure to the newly allocated structure. +.Pp +.Fn cam_device_copy +copies the +.Fa src +structure to +.Fa dst . +.Pp +.Fn cam_get_device +takes a +.Fa path +argument containing a string with a device name followed by a unit number. +It then breaks the string down into a device name and unit number, and +passes them back in +.Fa dev_name +and +.Fa unit , +respectively. +.Fn cam_get_device +can handle strings of the following forms, at least: +.Pp +.Bl -tag -width 1234 -compact +.It /dev/foo0a +.It /dev/rfoo0a +.It /dev/rfoo1s2c +.It foo0 +.It foo0a +.It rfoo0 +.It rfoo0a +.It nrfoo0 +.El +.Pp +.Fn cam_get_device +is provided as a convenience function for applications that need to provide +functionality similar to +.Fn cam_open_device . +Programmers are encouraged to use more deterministic methods of obtaining +device names and unit numbers if possible. +.Sh RETURN VALUES +.Fn cam_open_device , +.Fn cam_open_spec_device , +.Fn cam_open_btl , +and +.Fn cam_open_pass +return a pointer to a +.Va cam_device +structure, or NULL if there was an error. +.Pp +.Fn cam_getccb +returns an allocated and partially initialized CCB, or NULL if allocation +of the CCB failed. +.Pp +.Fn cam_send_ccb +returns a value of -1 if an error occured, and +.Va errno +is set to indicate the error. +.Pp +.Fn cam_path_string +returns a filled printing prefix string as a convenience. This is the same +.Fa str +that is passed into +.Fn cam_path_string . +.Pp +.Fn cam_device_dup +returns a copy of the +.Va device +passed in, or NULL if an error occurred. +.Pp +.Fn cam_get_device +returns 0 for success, and -1 to indicate failure. +.Pp +If an error is returned from one of the base CAM library functions +described here, the reason for the error is generally printed in the global +string +.Va cam_errbuf +which is +.Dv CAM_ERRBUF_SIZE +characters long. +.Sh SEE ALSO +.Xr cam_cdbparse 3 , +.Xr pass 4 , +.Xr camcontrol 8 +.Sh HISTORY +The CAM library first appeared in +.Fx 3.0 . +.Sh AUTHORS +.An Kenneth Merry Aq ken@FreeBSD.org +.Sh BUGS +.Fn cam_open_device +doesn't check to see if the +.Fa path +passed in is a symlink to something. It also doesn't check to see if the +.Fa path +passed in is an actual +.Xr pass 4 +device. The former would be rather easy to implement, but the latter would +require a definitive way to identify a device node as a +.Xr pass 4 +device. +.Pp +Some of the functions are possibly mis-named or poorly named. diff --git a/lib/libcam/cam_cdbparse.3 b/lib/libcam/cam_cdbparse.3 new file mode 100644 index 0000000..42c5dac --- /dev/null +++ b/lib/libcam/cam_cdbparse.3 @@ -0,0 +1,543 @@ +.\" +.\" Copyright (c) 1998 Kenneth D. Merry. +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. The name of the author may not be used to endorse or promote products +.\" derived from this software without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" $FreeBSD$ +.\" +.\" This man page borrows heavily from the old scsi(3) man page, which had +.\" the following copyright: +.\" +.\" Copyright (c) 1994 HD Associates (hd@world.std.com) +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by HD Associates +.\" 4. Neither the name of the HD Associates nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY HD ASSOCIATES``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL HD ASSOCIATES OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" +.Dd October 13, 1998 +.Os FreeBSD 3.0 +.Dt CAM_CDBPARSE 3 +.Sh NAME +.Nm csio_build , +.Nm csio_build_visit , +.Nm csio_decode , +.Nm csio_decode_visit , +.Nm buff_decode , +.Nm buff_decode_visit , +.Nm csio_encode , +.Nm csio_encode_visit , +.Nm buff_encode_visit +.Nd CAM user library SCSI buffer parsing routines +.Sh SYNOPSIS +.Fd #include <stdio.h> +.Fd #include <camlib.h> +.Ft int +.Fo csio_build +.Fa "struct ccb_scsiio *csio" +.Fa "u_int8_t *data_ptr" +.Fa "u_int32_t dxfer_len" +.Fa "u_int32_t flags" +.Fa "int retry_count" +.Fa "int timeout" +.Fa "char *cmd_spec" +.Fa "..." +.Fc +.Ft int +.Fo csio_build_visit +.Fa "struct ccb_scsiio *csio" +.Fa "u_int8_t *data_ptr" +.Fa "u_int32_t dxfer_len" +.Fa "u_int32_t flags" +.Fa "int retry_count" +.Fa "int timeout" +.Fa "char *cmd_spec" +.Fa "int (*arg_get)(void *hook, char *field_name)" +.Fa "void *gethook" +.Fc +.Ft int +.Fo csio_decode +.Fa "struct ccb_scsiio *csio" +.Fa "char *fmt" +.Fa "..." +.Fc +.Ft int +.Fo csio_decode_visit +.Fa "struct ccb_scsiio *csio" +.Fa "char *fmt" +.Fa "void (*arg_put)(void *hook" +.Fa "int letter" +.Fa "void *val" +.Fa "int count" +.Fa "char *name)" +.Fa "void *puthook" +.Fc +.Ft int +.Fo buff_decode +.Fa "u_int8_t *buff" +.Fa "size_t len" +.Fa "char *fmt" +.Fa "..." +.Fc +.Ft int +.Fo buff_decode_visit +.Fa "u_int8_t *buff" +.Fa "size_t len" +.Fa "char *fmt" +.Fa "void (*arg_put)(void *, int, void *, int, char *)" +.Fa "void *puthook" +.Fc +.Ft int +.Fo csio_encode +.Fa "struct ccb_scsiio *csio" +.Fa "char *fmt" +.Fa "..." +.Fc +.Ft int +.Fo csio_encode_visit +.Fa "struct ccb_scsiio *csio" +.Fa "char *fmt" +.Fa "int (*arg_get)(void *hook, char *field_name)" +.Fa "void *gethook" +.Fc +.Ft int +.Fo buff_encode_visit +.Fa "u_int8_t *buff" +.Fa "size_t len" +.Fa "char *fmt" +.Fa "int (*arg_get)(void *hook, char *field_name)" +.Fa "void *gethook" +.Fc +.Sh DESCRIPTION +The CAM buffer/CDB encoding and decoding routines provide a relatively easy +migration path for userland +.Tn SCSI +applications written with the similarly-named +.Va scsireq_ Ns * +functions from the old FreeBSD +.Tn SCSI +layer. +.Pp +These functions may be used in new applications, but users may find it +easier to use the various SCSI CCB building functions included with the +.Xr cam 3 +library. (e.g. +.Fn cam_fill_csio , +.Fn scsi_start_stop , +and +.Fn scsi_read_write ) +.Pp +.Fn csio_build +builds up a +.Va ccb_scsiio +structure based on the information provided in +the variable argument list. +It gracefully handles a NULL +.Fa data_ptr +argument passed to it. +.Pp +.Fa dxfer_len +is the length of the data phase; the data transfer direction is +determined by the +.Fa flags +argument. +.Pp +.Fa data_ptr +is the data buffer used during the +.Tn SCSI +data phase. If no data is to be +transferred for the +.Tn SCSI +command in question, this should be set to NULL. If there is data to +transfer for the command, this buffer must be at least +.Fa dxfer_len +long. +.Pp +.Fa flags +are the flags defined in +.Aq Pa cam/cam_ccb.h : +.Bd -literal +/* Common CCB header */ +/* CAM CCB flags */ +typedef enum { + CAM_CDB_POINTER = 0x00000001,/* The CDB field is a pointer */ + CAM_QUEUE_ENABLE = 0x00000002,/* SIM queue actions are enabled */ + CAM_CDB_LINKED = 0x00000004,/* CCB contains a linked CDB */ + CAM_SCATTER_VALID = 0x00000010,/* Scatter/gather list is valid */ + CAM_DIS_AUTOSENSE = 0x00000020,/* Disable autosense feature */ + CAM_DIR_RESV = 0x00000000,/* Data direction (00:reserved) */ + CAM_DIR_IN = 0x00000040,/* Data direction (01:DATA IN) */ + CAM_DIR_OUT = 0x00000080,/* Data direction (10:DATA OUT) */ + CAM_DIR_NONE = 0x000000C0,/* Data direction (11:no data) */ + CAM_DIR_MASK = 0x000000C0,/* Data direction Mask */ + CAM_SOFT_RST_OP = 0x00000100,/* Use Soft reset alternative */ + CAM_ENG_SYNC = 0x00000200,/* Flush resid bytes on complete */ + CAM_DEV_QFRZDIS = 0x00000400,/* Disable DEV Q freezing */ + CAM_DEV_QFREEZE = 0x00000800,/* Freeze DEV Q on execution */ + CAM_HIGH_POWER = 0x00001000,/* Command takes a lot of power */ + CAM_SENSE_PTR = 0x00002000,/* Sense data is a pointer */ + CAM_SENSE_PHYS = 0x00004000,/* Sense pointer is physical addr*/ + CAM_TAG_ACTION_VALID = 0x00008000,/* Use the tag action in this ccb*/ + CAM_PASS_ERR_RECOVER = 0x00010000,/* Pass driver does err. recovery*/ + CAM_DIS_DISCONNECT = 0x00020000,/* Disable disconnect */ + CAM_SG_LIST_PHYS = 0x00040000,/* SG list has physical addrs. */ + CAM_MSG_BUF_PHYS = 0x00080000,/* Message buffer ptr is physical*/ + CAM_SNS_BUF_PHYS = 0x00100000,/* Autosense data ptr is physical*/ + CAM_DATA_PHYS = 0x00200000,/* SG/Buffer data ptrs are phys. */ + CAM_CDB_PHYS = 0x00400000,/* CDB poiner is physical */ + CAM_ENG_SGLIST = 0x00800000,/* SG list is for the HBA engine */ + +/* Phase cognizant mode flags */ + CAM_DIS_AUTOSRP = 0x01000000,/* Diable autosave/restore ptrs */ + CAM_DIS_AUTODISC = 0x02000000,/* Disable auto disconnect */ + CAM_TGT_CCB_AVAIL = 0x04000000,/* Target CCB available */ + CAM_TGT_PHASE_MODE = 0x08000000,/* The SIM runs in phase mode */ + CAM_MSGB_VALID = 0x20000000,/* Message buffer valid */ + CAM_STATUS_VALID = 0x40000000,/* Status buffer valid */ + CAM_DATAB_VALID = 0x80000000,/* Data buffer valid */ + +/* Host target Mode flags */ + CAM_TERM_IO = 0x20000000,/* Terminate I/O Message sup. */ + CAM_DISCONNECT = 0x40000000,/* Disconnects are mandatory */ + CAM_SEND_STATUS = 0x80000000,/* Send status after data phase */ +} ccb_flags; +.Ed +.Pp +Multiple flags should be ORed together. Any of the CCB flags may be used, +although it is worth noting several important ones here: +.Pp +.Bl -tag -width CAM_PASS_ERR_RECOVER +.It Dv CAM_DIR_IN +This indicates that the operation in question is a read operation. i.e., +data is being read from the +.Tn SCSI +device to the user-supplied buffer. +.It Dv CAM_DIR_OUT +This indicates that the operation is a write operation. i.e. data is being +written from the user-supplied buffer to the device. +.It Dv CAM_DIR_NONE +This indicates that there is no data to be transferred for this command. +.It Dv CAM_DEV_QFRZDIS +This flag disables device queue freezing as an error recovery mechanism. +.It Dv CAM_PASS_ERR_RECOVER +This flag tells the +.Xr pass 4 +driver to enable error recovery. The default is to not perform error +recovery, which means that the retry count won't be honored without this +flag, among other things. +.It Dv CAM_DATA_PHYS +This indicates that the address contained in +.Fa data_ptr +is a physical address, not a virtual address. +.El +.Pp +The +.Fa retry_count +tells the kernel how many times to retry the command in question. The +retry count is ignored unless the +.Xr pass 4 +driver is told to enable error recovery via the +.Dv CAM_PASS_ERR_RECOVER +flag. +.Pp +The +.Fa timeout +tells the kernel how long to wait for the given command to complete. If +the timeout expires and the command hasn't completed, the CCB will be +returned from the kernel with an appropriate error status. +.Pp +.Fa cmd_spec +is a CDB format specifier used to build up the SCSI CDB. +This text string is made up of a list of field specifiers. Field +specifiers specify the value for each CDB field (including indicating +that the value be taken from the next argument in the +variable argument list), the width +of the field in bits or bytes, and an optional name. White space is +ignored, and the pound sign ('#') introduces a comment that ends at the +end of the current line. +.Pp +The optional name is the first part of a field specifier and +is in curly braces. The text in curly braces in this example are +the names: +.Bd -literal -offset indent +.Fa "{PS} v:b1 {Reserved} 0:b1 {Page Code} v:b6 # Mode select page" +.Ed +.Pp +This field specifier has two one bit fields and one six bit field. +The second one bit field is the constant value 0 and the first +one bit field and the six bit field are taken from the variable +argument list. +Multi byte fields are swapped into the SCSI byte order in the +CDB and white space is ignored. +.Pp +When the field is a hex value or the letter v, (e.g., +.Fa "1A" +or +.Fa "v" ) +then a single byte value +is copied to the next unused byte of the CDB. +When the letter +.Fa v +is used the next integer argument is taken from the variable argument list +and that value used. +.Pp +A constant hex value followed by a field width specifier or the letter +.Fa v +followed by a field width specifier (e.g., +.Fa 3:4 , +.Fa 3:b4 , +.Fa 3:i3 , +.FR v:i3 ) +specifies a field of a given bit or byte width. +Either the constant value or (for the V specifier) the next integer value from +the variable argument list is copied to the next unused +bits or bytes of the CDB. +.Pp +A decimal number or the letter +.Fa b +followed by a decimal number field width indicates a bit field of that width. +The bit fields are packed as tightly as possible beginning with the +high bit (so that it reads the same as the SCSI spec), and a new byte of +the CDB is started whenever a byte fills completely or when an +.Fa i +field is encountered. +.Pp +A field width specifier consisting of the letter +.Fa i +followed by either +1, 2, 3 or 4 indicates a 1, 2, 3 or 4 byte integral value that must +be swapped into SCSI byte order (MSB first). +.Pp +For the +.Fa v +field specifier the next integer argument is taken from the variable argument +list and that value is used swapped into SCSI byte order. +.Pp +.Fn csio_build_visit +operates similarly to +.Fn csio_build , +except that the values to substitute for variable arguments in +.Fa cmd_spec +are retrieved via the +.Fn arg_get +function passed in to +.Fn csio_build_visit +instead of via +.Xr stdarg 3 . +The +.Fn arg_get +function takes two arguments: +.Bl -tag -width field_name +.It Fa gethook +is passed into the +.Fn arg_get +function at each invocation. This enables the +.Fn arg_get +function to keep some state in between calls without using global or static +variables. +.It Fa field_name +is the field name supplied in +.Fa fmt , +if any. +.El +.Pp +.Fn csio_decode +is used to decode information from the data in phase of the SCSI +transfer. +.Pp +The decoding is similar to +the command specifier processing of +.Fn csio_build +except that the data is extracted from the data pointed to by +.Fa csio->data_ptr . +The stdarg list should be pointers to integers instead of integer +values. +A seek field type and a suppression modifier are added. +The +.Fa * +suppression modifier (e.g., +.Fa *i3 +or +.Fa *b4 ) +suppresses assignment from the field and can be used to skip +over bytes or bits in the data, without having to copy +them to a dummy variable in the arg list. +.Pp +The seek field type +.Fa s +permits you to skip over data. +This seeks to an absolute position ( +.Fa s3 ) +or a relative position ( +.Fa s+3 ) +in the data, based on whether or not the presence of the '+' sign. +The seek value can be specified as +.Fa v +and the next integer value from the argument list will be +used as the seek value. +.Pp +.Fn csio_decode_visit +operates like +.Fn csio_decode +except that instead of placing the decoded contents of the buffer in +varardic arguments, the decoded buffer contents are returned to the user +via the +.Fn arg_put +function that is passed in. +The +.Fn arg_put +function takes several arguments: +.Bl -tag -width letter +.It Fa hook +The "hook" is a mechanism to allow the +.Fn arg_put +function to save state in between calls. +.It Fa letter +is the letter describing the format of the argument being passed into the +function. +.It Fa val +is a void pointer to the value being passed into the function. +.It Fa count +is the number of arguments being passed into the +.Fn arg_put +function. At present this will only be set to 1. +.It Fa name +This is a text description of the field, if one was provided in the +.Fa fmt . +.El +.Pp +.Fn buff_decode +decodes an arbitrary data buffer using the method +described above for +.Fn csio_decode . +.Pp +.Fn buff_decode_visit +decodes an arbitrary data buffer using the method described above for +.Fn csio_decode_visit . +.Pp +.Fn csio_encode +encodes the +.Fa data_ptr +portion (not the CDB!) of a +.Va ccb_scsiio +structure, using the method described above for +.Fn csio_build . +.Pp +.Fn csio_encode_visit +encodes the +.Fa data_ptr +portion (not the CDB!) of a +.Va ccb_scsiio +structure, using the method described above for +.Fn csio_build_visit . +.Pp +.Fn buff_encode_visit +encodes an arbitrary data pointer, using the method described +above for +.Fn csio_build_visit . +.Sh RETURN VALUES +.Fn csio_build , +.Fn csio_build_visit , +.Fn csio_encode , +.Fn csio_encode_visit , +and +.Fn buff_encode_visit +return the number of fields processed. +.Pp +.Fn csio_decode , +.Fn csio_decode_visit , +.Fn buff_decode , +and +.Fn buff_decode_visit +return the number of assignments performed. +.Sh SEE ALSO +.Xr cam 3 , +.Xr pass 4 , +.Xr camcontrol 8 +.Sh HISTORY +.Pp +The CAM versions of these functions are based upon similar functions +implemented for the old FreeBSD +.Tn SCSI +layer. The encoding/decoding functions in the old +.Tn SCSI +code were written by Peter Dufault. +.Pp +Many systems have comparable interfaces to permit a user to construct a +SCSI command in user space. +.Pp +The old +.Va scsireq +data structure was almost identical to the SGI /dev/scsi data +structure. If anyone knows the name of the authors it should +go here; Peter Dufault first read about it in a 1989 Sun Expert magazine. +.Pp +The new CCB data structures are derived from the CAM-2 and CAM-3 +specifications. +.Pp +Peter Dufault implemented a clone of SGI's interface in 386bsd that +led to the original FreeBSD +.Tn SCSI +library and the related kernel ioctl. +If anyone needs that for compatibility contact dufault@hda.com. +.Sh AUTHORS +Kenneth Merry implemented the CAM versions of these encoding and decoding +functions. This current work is based upon earlier work by Peter Dufault. +.Sh BUGS +There should probably be a function that encodes both the CDB and the data +buffer portions of a +.Tn SCSI +CCB. I discovered this while implementing the arbitrary command execution +code in +.Xr camcontrol 8 , +but I haven't yet had time to implement such a function. +.Pp +Some of the CCB flag descriptions really don't belong here. Rather they +belong in a generic CCB man page. Since that man page hasn't yet been +written, the shorter descriptions here will have to suffice. diff --git a/lib/libcam/camlib.c b/lib/libcam/camlib.c new file mode 100644 index 0000000..648b030 --- /dev/null +++ b/lib/libcam/camlib.c @@ -0,0 +1,785 @@ +/* + * Copyright (c) 1997, 1998, 1999 Kenneth D. Merry. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * $FreeBSD$ + */ + +#include <sys/types.h> +#include <sys/param.h> +#include <stdio.h> +#include <stdlib.h> +#include <string.h> +#include <fcntl.h> +#include <unistd.h> +#include <errno.h> +#include <ctype.h> + +#include <cam/cam.h> +#include <cam/scsi/scsi_all.h> +#include <cam/cam_ccb.h> +#include <cam/scsi/scsi_pass.h> +#include "camlib.h" + +struct cam_devequiv { + char *given_dev; + char *real_dev; +}; + +struct cam_devequiv devmatchtable[] = { + {"sd", "da"}, + {"st", "sa"} +}; + +char cam_errbuf[CAM_ERRBUF_SIZE]; + +static struct cam_device *cam_real_open_device(const char *path, int flags, + struct cam_device *device, + const char *given_path, + const char *given_dev_name, + int given_unit_number); +static struct cam_device *cam_lookup_pass(const char *dev_name, int unit, + int flags, const char *given_path, + struct cam_device *device); + +/* + * Send a ccb to a passthrough device. + */ +int +cam_send_ccb(struct cam_device *device, union ccb *ccb) +{ + return(ioctl(device->fd, CAMIOCOMMAND, ccb)); +} + +/* + * Malloc a CCB, zero out the header and set its path, target and lun ids. + */ +union ccb * +cam_getccb(struct cam_device *dev) +{ + union ccb *ccb; + + ccb = (union ccb *)malloc(sizeof(union ccb)); + if (ccb != NULL) { + bzero(&ccb->ccb_h, sizeof(struct ccb_hdr)); + ccb->ccb_h.path_id = dev->path_id; + ccb->ccb_h.target_id = dev->target_id; + ccb->ccb_h.target_lun = dev->target_lun; + } + + return(ccb); +} + +/* + * Free a CCB. + */ +void +cam_freeccb(union ccb *ccb) +{ + if (ccb != NULL) + free(ccb); +} + +/* + * Take a device name or path passed in by the user, and attempt to figure + * out the device name and unit number. Some possible device name formats are: + * /dev/foo0a + * /dev/rfoo0a + * /dev/rfoos2c + * foo0 + * foo0a + * rfoo0 + * rfoo0a + * nrfoo0 + * + * If the caller passes in an old style device name like 'sd' or 'st', + * it will be converted to the new style device name based upon devmatchtable + * above. + * + * Input parameters: device name/path, length of devname string + * Output: device name, unit number + * Return values: returns 0 for success, -1 for failure + */ +int +cam_get_device(const char *path, char *dev_name, int devnamelen, int *unit) +{ + char *func_name = "cam_get_device"; + char *tmpstr, *tmpstr2; + char *newpath; + int unit_offset; + int i, found = 0; + + + if (path == NULL) { + sprintf(cam_errbuf, "%s: device pathname was NULL", func_name); + return(-1); + } + + /* + * We can be rather destructive to the path string. Make a copy of + * it so we don't hose the user's string. + */ + newpath = (char *)strdup(path); + tmpstr = newpath; + + /* Get rid of any leading white space */ + while (isspace(*tmpstr) && (*tmpstr != '\0')) + tmpstr++; + + /* + * Check to see whether we have an absolute pathname. + */ + if (*tmpstr == '/') { + tmpstr2 = tmpstr; + tmpstr = (char *)rindex(tmpstr2, '/'); + if ((tmpstr != NULL) && (*tmpstr != '\0')) + tmpstr++; + } + + if (*tmpstr == '\0') { + sprintf(cam_errbuf, "%s: no text after slash", func_name); + free(newpath); + return(-1); + } + + /* + * Check to see whether the user has given us a nonrewound tape + * device. + */ + if (*tmpstr == 'n') + tmpstr++; + + if (*tmpstr == '\0') { + sprintf(cam_errbuf, "%s: no text after leading 'n'", func_name); + free(newpath); + return(-1); + } + + /* + * See if the user has given us a character device. + */ + if (*tmpstr == 'r') + tmpstr++; + + if (*tmpstr == '\0') { + sprintf(cam_errbuf, "%s: no text after leading 'r'", func_name); + free(newpath); + return(-1); + } + + /* + * Try to get rid of any trailing white space or partition letters. + */ + tmpstr2 = &tmpstr[strlen(tmpstr) - 1]; + + while ((*tmpstr2 != '\0') && (tmpstr2 > tmpstr) &&(!isdigit(*tmpstr2))){ + *tmpstr2 = '\0'; + tmpstr2--; + } + + /* + * Check to see whether we have been given a partition with a slice + * name. If so, get rid of the slice name/number. + */ + if (strlen(tmpstr) > 3) { + /* + * Basically, we're looking for a string that ends in the + * following general manner: 1s1 -- a number, the letter + * s, and then another number. This indicates that the + * user has given us a slice. We substitute nulls for the + * s and the slice number. + */ + if ((isdigit(tmpstr[strlen(tmpstr) - 1])) + && (tmpstr[strlen(tmpstr) - 2] == 's') + && (isdigit(tmpstr[strlen(tmpstr) - 3]))) { + tmpstr[strlen(tmpstr) - 1] = '\0'; + tmpstr[strlen(tmpstr) - 1] = '\0'; + } + } + + /* + * After we nuke off the slice, we should have just a device name + * and unit number. That means there must be at least 2 + * characters. If we only have 1, we don't have a valid device name. + */ + if (strlen(tmpstr) < 2) { + sprintf(cam_errbuf, + "%s: must have both device name and unit number", + func_name); + free(newpath); + return(-1); + } + + /* + * If the first character of the string is a digit, then the user + * has probably given us all numbers. Point out the error. + */ + if (isdigit(*tmpstr)) { + sprintf(cam_errbuf, + "%s: device name cannot begin with a number", + func_name); + free(newpath); + return(-1); + } + + /* + * At this point, if the last character of the string isn't a + * number, we know the user either didn't give us a device number, + * or he gave us a device name/number format we don't recognize. + */ + if (!isdigit(tmpstr[strlen(tmpstr) - 1])) { + sprintf(cam_errbuf, "%s: unable to find device unit number", + func_name); + free(newpath); + return(-1); + } + + /* + * Attempt to figure out where the device name ends and the unit + * number begins. As long as unit_offset is at least 1 less than + * the length of the string, we can still potentially have a device + * name at the front of the string. When we get to something that + * isn't a digit, we've hit the device name. Because of the check + * above, we know that this cannot happen when unit_offset == 1. + * Therefore it is okay to decrement unit_offset -- it won't cause + * us to go past the end of the character array. + */ + for (unit_offset = 1; + (unit_offset < (strlen(tmpstr))) + && (isdigit(tmpstr[strlen(tmpstr) - unit_offset])); unit_offset++); + + unit_offset--; + + /* + * Grab the unit number. + */ + *unit = atoi(&tmpstr[strlen(tmpstr) - unit_offset]); + + /* + * Put a null in place of the first number of the unit number so + * that all we have left is the device name. + */ + tmpstr[strlen(tmpstr) - unit_offset] = '\0'; + + /* + * Look through our equivalency table and see if the device name + * the user gave us is an old style device name. If so, translate + * it to the new style device name. + */ + for (i = 0;i < (sizeof(devmatchtable)/sizeof(struct cam_devequiv));i++){ + if (strcmp(tmpstr, devmatchtable[i].given_dev) == 0) { + strncpy(dev_name,devmatchtable[i].real_dev, devnamelen); + found = 1; + break; + } + } + if (found == 0) + strncpy(dev_name, tmpstr, devnamelen); + + /* Make sure we pass back a null-terminated string */ + dev_name[devnamelen - 1] = '\0'; + + /* Clean up allocated memory */ + free(newpath); + + return(0); + +} + +/* + * Backwards compatible wrapper for the real open routine. This translates + * a pathname into a device name and unit number for use with the real open + * routine. + */ +struct cam_device * +cam_open_device(const char *path, int flags) +{ + int unit; + char dev_name[DEV_IDLEN + 1]; + + /* + * cam_get_device() has already put an error message in cam_errbuf, + * so we don't need to. + */ + if (cam_get_device(path, dev_name, DEV_IDLEN + 1, &unit) == -1) + return(NULL); + + return(cam_lookup_pass(dev_name, unit, flags, path, NULL)); +} + +/* + * Open the passthrough device for a given bus, target and lun, if the + * passthrough device exists. + */ +struct cam_device * +cam_open_btl(path_id_t path_id, target_id_t target_id, lun_id_t target_lun, + int flags, struct cam_device *device) +{ + union ccb ccb; + struct periph_match_pattern *match_pat; + char *func_name = "cam_open_btl"; + int fd, bufsize; + + if ((fd = open(XPT_DEVICE, O_RDWR)) < 0) { + snprintf(cam_errbuf, CAM_ERRBUF_SIZE, + "%s: couldn't open %s\n%s: %s", func_name, XPT_DEVICE, + func_name, strerror(errno)); + return(NULL); + } + + bzero(&ccb, sizeof(union ccb)); + ccb.ccb_h.func_code = XPT_DEV_MATCH; + + /* Setup the result buffer */ + bufsize = sizeof(struct dev_match_result); + ccb.cdm.match_buf_len = bufsize; + ccb.cdm.matches = (struct dev_match_result *)malloc(bufsize); + if (ccb.cdm.matches == NULL) { + snprintf(cam_errbuf, CAM_ERRBUF_SIZE, + "%s: couldn't malloc match buffer", func_name); + close(fd); + return(NULL); + } + ccb.cdm.num_matches = 0; + + /* Setup the pattern buffer */ + ccb.cdm.num_patterns = 1; + ccb.cdm.pattern_buf_len = sizeof(struct dev_match_pattern); + ccb.cdm.patterns = (struct dev_match_pattern *)malloc( + sizeof(struct dev_match_pattern)); + if (ccb.cdm.patterns == NULL) { + snprintf(cam_errbuf, CAM_ERRBUF_SIZE, + "%s: couldn't malloc pattern buffer", func_name); + free(ccb.cdm.matches); + close(fd); + return(NULL); + } + ccb.cdm.patterns[0].type = DEV_MATCH_PERIPH; + match_pat = &ccb.cdm.patterns[0].pattern.periph_pattern; + + /* + * We're looking for the passthrough device associated with this + * particular bus/target/lun. + */ + sprintf(match_pat->periph_name, "pass"); + match_pat->path_id = path_id; + match_pat->target_id = target_id; + match_pat->target_lun = target_lun; + /* Now set the flags to indicate what we're looking for. */ + match_pat->flags = PERIPH_MATCH_PATH | PERIPH_MATCH_TARGET | + PERIPH_MATCH_LUN | PERIPH_MATCH_NAME; + + if (ioctl(fd, CAMIOCOMMAND, &ccb) == -1) { + sprintf(cam_errbuf, "%s: CAMIOCOMMAND ioctl failed\n" + "%s: %s", func_name, func_name, strerror(errno)); + goto btl_bailout; + } + + /* + * Check for an outright error. + */ + if ((ccb.ccb_h.status != CAM_REQ_CMP) + || ((ccb.cdm.status != CAM_DEV_MATCH_LAST) + && (ccb.cdm.status != CAM_DEV_MATCH_MORE))) { + sprintf(cam_errbuf, "%s: CAM error %#x, CDM error %d " + "returned from XPT_DEV_MATCH ccb", func_name, + ccb.ccb_h.status, ccb.cdm.status); + goto btl_bailout; + } + + if (ccb.cdm.status == CAM_DEV_MATCH_MORE) { + sprintf(cam_errbuf, "%s: CDM reported more than one" + " passthrough device at %d:%d:%d!!\n", + func_name, path_id, target_id, target_lun); + goto btl_bailout; + } + + if (ccb.cdm.num_matches == 0) { + sprintf(cam_errbuf, "%s: no passthrough device found at" + " %d:%d:%d", func_name, path_id, target_id, + target_lun); + goto btl_bailout; + } + + switch(ccb.cdm.matches[0].type) { + case DEV_MATCH_PERIPH: { + int pass_unit; + char dev_path[256]; + struct periph_match_result *periph_result; + + periph_result = &ccb.cdm.matches[0].result.periph_result; + pass_unit = periph_result->unit_number; + free(ccb.cdm.matches); + free(ccb.cdm.patterns); + close(fd); + sprintf(dev_path, "/dev/pass%d", pass_unit); + return(cam_real_open_device(dev_path, flags, device, NULL, + NULL, 0)); + break; /* NOTREACHED */ + } + default: + sprintf(cam_errbuf, "%s: asked for a peripheral match, but" + " got a bus or device match??!!", func_name); + goto btl_bailout; + break; /* NOTREACHED */ + } + +btl_bailout: + free(ccb.cdm.matches); + free(ccb.cdm.patterns); + close(fd); + return(NULL); +} + +struct cam_device * +cam_open_spec_device(const char *dev_name, int unit, int flags, + struct cam_device *device) +{ + return(cam_lookup_pass(dev_name, unit, flags, NULL, device)); +} + +struct cam_device * +cam_open_pass(const char *path, int flags, struct cam_device *device) +{ + return(cam_real_open_device(path, flags, device, path, NULL, 0)); +} + +static struct cam_device * +cam_lookup_pass(const char *dev_name, int unit, int flags, + const char *given_path, struct cam_device *device) +{ + int fd; + union ccb ccb; + char dev_path[256]; + char *func_name = "cam_lookup_pass"; + + /* + * The flags argument above only applies to the actual passthrough + * device open, not our open of the given device to find the + * passthrough device. + */ + if ((fd = open(XPT_DEVICE, O_RDWR)) < 0) { + snprintf(cam_errbuf, CAM_ERRBUF_SIZE, + "%s: couldn't open %s\n%s: %s", func_name, XPT_DEVICE, + func_name, strerror(errno)); + return(NULL); + } + + /* This isn't strictly necessary for the GETPASSTHRU ioctl. */ + ccb.ccb_h.func_code = XPT_GDEVLIST; + + /* These two are necessary for the GETPASSTHRU ioctl to work. */ + strncpy(ccb.cgdl.periph_name, dev_name, DEV_IDLEN - 1); + ccb.cgdl.periph_name[DEV_IDLEN - 1] = '\0'; + ccb.cgdl.unit_number = unit; + + /* + * Attempt to get the passthrough device. This ioctl will fail if + * the device name is null, if the device doesn't exist, or if the + * passthrough driver isn't in the kernel. + */ + if (ioctl(fd, CAMGETPASSTHRU, &ccb) == -1) { + char tmpstr[256]; + + /* + * If we get ENOENT from the transport layer version of + * the CAMGETPASSTHRU ioctl, it means one of two things: + * either the device name/unit number passed in doesn't + * exist, or the passthrough driver isn't in the kernel. + */ + if (errno == ENOENT) { + snprintf(tmpstr, sizeof(tmpstr), + "\n%s: either the pass driver isn't in " + "your kernel\n%s: or %s%d doesn't exist", + func_name, func_name, dev_name, unit); + } + snprintf(cam_errbuf, sizeof(cam_errbuf), + "%s: CAMGETPASSTHRU ioctl failed\n" + "%s: %s%s", func_name, func_name, strerror(errno), + (errno == ENOENT) ? tmpstr : ""); + + return(NULL); + } + + close(fd); + + /* + * If the ioctl returned the right status, but we got an error back + * in the ccb, that means that the kernel found the device the user + * passed in, but was unable to find the passthrough device for + * the device the user gave us. + */ + if (ccb.cgdl.status == CAM_GDEVLIST_ERROR) { + sprintf(cam_errbuf, "%s: device %s%d does not exist", + func_name, dev_name, unit); + return(NULL); + } + + sprintf(dev_path, "/dev/%s%d", ccb.cgdl.periph_name, + ccb.cgdl.unit_number); + + return(cam_real_open_device(dev_path, flags, device, NULL, + dev_name, unit)); +} + +/* + * Open a given device. The path argument isn't strictly necessary, but it + * is copied into the cam_device structure as a convenience to the user. + */ +static struct cam_device * +cam_real_open_device(const char *path, int flags, struct cam_device *device, + const char *given_path, const char *given_dev_name, + int given_unit_number) +{ + char newpath[MAXPATHLEN+1]; + char *func_name = "cam_real_open_device"; + union ccb ccb; + int fd, malloced_device = 0; + + /* + * See if the user wants us to malloc a device for him. + */ + if (device == NULL) { + if ((device = (struct cam_device *)malloc( + sizeof(struct cam_device))) == NULL) { + sprintf(cam_errbuf, "%s: device structure malloc" + " failed\n%s: %s", func_name, func_name, + strerror(errno)); + return(NULL); + } + malloced_device = 1; + } + + /* + * If the user passed in a path, save it for him. + */ + if (given_path != NULL) + strncpy(device->device_path, given_path, MAXPATHLEN + 1); + else + device->device_path[0] = '\0'; + + /* + * If the user passed in a device name and unit number pair, save + * those as well. + */ + if (given_dev_name != NULL) + strncpy(device->given_dev_name, given_dev_name, DEV_IDLEN); + else + device->given_dev_name[0] = '\0'; + device->given_unit_number = given_unit_number; + + if ((fd = open(path, flags)) < 0) { + snprintf(cam_errbuf, CAM_ERRBUF_SIZE, + "%s: couldn't open passthrough device %s\n" + "%s: %s", func_name, path, func_name, + strerror(errno)); + goto crod_bailout; + } + + device->fd = fd; + + bzero(&ccb, sizeof(union ccb)); + + /* + * Unlike the transport layer version of the GETPASSTHRU ioctl, + * we don't have to set any fields. + */ + ccb.ccb_h.func_code = XPT_GDEVLIST; + + /* + * We're only doing this to get some information on the device in + * question. Otherwise, we'd have to pass in yet another + * parameter: the passthrough driver unit number. + */ + if (ioctl(fd, CAMGETPASSTHRU, &ccb) == -1) { + /* + * At this point we know the passthrough device must exist + * because we just opened it above. The only way this + * ioctl can fail is if the ccb size is wrong. + */ + sprintf(cam_errbuf, "%s: CAMGETPASSTHRU ioctl failed\n" + "%s: %s", func_name, func_name, strerror(errno)); + goto crod_bailout; + } + + /* + * If the ioctl returned the right status, but we got an error back + * in the ccb, that means that the kernel found the device the user + * passed in, but was unable to find the passthrough device for + * the device the user gave us. + */ + if (ccb.cgdl.status == CAM_GDEVLIST_ERROR) { + sprintf(cam_errbuf, "%s: passthrough device does not exist??!!", + func_name); + goto crod_bailout; + } + + device->dev_unit_num = ccb.cgdl.unit_number; + strcpy(device->device_name, ccb.cgdl.periph_name); + device->path_id = ccb.ccb_h.path_id; + device->target_id = ccb.ccb_h.target_id; + device->target_lun = ccb.ccb_h.target_lun; + + ccb.ccb_h.func_code = XPT_PATH_INQ; + if (ioctl(fd, CAMIOCOMMAND, &ccb) == -1) { + sprintf(cam_errbuf, "%s: Path Inquiry CCB failed\n" + "%s: %s", func_name, func_name, strerror(errno)); + goto crod_bailout; + } + strncpy(device->sim_name, ccb.cpi.dev_name, SIM_IDLEN); + device->sim_unit_number = ccb.cpi.unit_number; + device->bus_id = ccb.cpi.bus_id; + + /* + * It doesn't really matter what is in the payload for a getdev + * CCB, the kernel doesn't look at it. + */ + ccb.ccb_h.func_code = XPT_GDEV_TYPE; + if (ioctl(fd, CAMIOCOMMAND, &ccb) == -1) { + sprintf(cam_errbuf, "%s: Get Device Type CCB failed\n" + "%s: %s", func_name, func_name, strerror(errno)); + goto crod_bailout; + } + device->pd_type = ccb.cgd.pd_type; + bcopy(&ccb.cgd.inq_data, &device->inq_data, + sizeof(struct scsi_inquiry_data)); + device->serial_num_len = ccb.cgd.serial_num_len; + bcopy(&ccb.cgd.serial_num, &device->serial_num, device->serial_num_len); + + /* + * Zero the payload, the kernel does look at the flags. + */ + bzero(&(&ccb.ccb_h)[1], sizeof(struct ccb_trans_settings)); + + /* + * Get transfer settings for this device. + */ + ccb.ccb_h.func_code = XPT_GET_TRAN_SETTINGS; + + ccb.cts.flags = CCB_TRANS_CURRENT_SETTINGS; + + if (ioctl(fd, CAMIOCOMMAND, &ccb) == -1) { + sprintf(cam_errbuf, "%s: Get Transfer Settings CCB failed\n" + "%s: %s", func_name, func_name, strerror(errno)); + goto crod_bailout; + } + device->sync_period = ccb.cts.sync_period; + device->sync_offset = ccb.cts.sync_offset; + device->bus_width = ccb.cts.bus_width; + + return(device); + +crod_bailout: + + if (malloced_device) + free(device); + + return(NULL); +} + +void +cam_close_device(struct cam_device *dev) +{ + if (dev == NULL) + return; + + cam_close_spec_device(dev); + + if (dev != NULL) + free(dev); +} + +void +cam_close_spec_device(struct cam_device *dev) +{ + if (dev == NULL) + return; + + if (dev->fd >= 0) + close(dev->fd); +} + +char * +cam_path_string(struct cam_device *dev, char *str, int len) +{ + if (dev == NULL) { + snprintf(str, len, "No path"); + return(str); + } + + snprintf(str, len, "(%s%d:%s%d:%d:%d:%d): ", + (dev->device_name[0] != '\0') ? dev->device_name : "pass", + dev->dev_unit_num, + (dev->sim_name[0] != '\0') ? dev->sim_name : "unknown", + dev->sim_unit_number, + dev->bus_id, + dev->target_id, + dev->target_lun); + + return(str); +} + +/* + * Malloc/duplicate a CAM device structure. + */ +struct cam_device * +cam_device_dup(struct cam_device *device) +{ + char *func_name = "cam_device_dup"; + struct cam_device *newdev; + + if (device == NULL) { + sprintf(cam_errbuf, "%s: device is NULL", func_name); + return(NULL); + } + + newdev = malloc(sizeof(struct cam_device)); + + bcopy(device, newdev, sizeof(struct cam_device)); + + return(newdev); +} + +/* + * Copy a CAM device structure. + */ +void +cam_device_copy(struct cam_device *src, struct cam_device *dst) +{ + char *func_name = "cam_device_copy"; + + if (src == NULL) { + sprintf(cam_errbuf, "%s: source device struct was NULL", + func_name); + return; + } + + if (dst == NULL) { + sprintf(cam_errbuf, "%s: destination device struct was NULL", + func_name); + return; + } + + bcopy(src, dst, sizeof(struct cam_device)); + +} diff --git a/lib/libcam/camlib.h b/lib/libcam/camlib.h new file mode 100644 index 0000000..4201294 --- /dev/null +++ b/lib/libcam/camlib.h @@ -0,0 +1,178 @@ +/* + * Copyright (c) 1997, 1998 Kenneth D. Merry. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * + * $FreeBSD$ + */ +/* + * Buffer encoding/decoding routines taken from the original FreeBSD SCSI + * library and slightly modified. The original header file had the following + * copyright: + */ +/* Copyright (c) 1994 HD Associates (hd@world.std.com) + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * This product includes software developed by HD Associates + * 4. Neither the name of the HD Associaates nor the names of its contributors + * may be used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY HD ASSOCIATES``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL HD ASSOCIATES OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + */ + + +#ifndef _CAMLIB_H +#define _CAMLIB_H + +#include <sys/cdefs.h> +#include <sys/param.h> + +#include <cam/cam.h> +#include <cam/cam_ccb.h> + +#define CAM_ERRBUF_SIZE 2048 /* sizeof the CAM libarary error string */ + +/* + * Right now we hard code the transport layer device, but this will change + * if we ever get more than one transport layer. + */ +#define XPT_DEVICE "/dev/xpt0" + + +extern char cam_errbuf[]; + +struct cam_device { + char device_path[MAXPATHLEN+1];/* + * Pathname of the device + * given by the user. This + * may be null if the + * user states the device + * name and unit number + * separately. + */ + char given_dev_name[DEV_IDLEN+1];/* + * Device name given by + * the user. + */ + u_int32_t given_unit_number; /* + * Unit number given by + * the user. + */ + char device_name[DEV_IDLEN+1];/* + * Name of the device, + * e.g. 'pass' + */ + u_int32_t dev_unit_num; /* Unit number of the passthrough + * device associated with this + * particular device. + */ + + char sim_name[SIM_IDLEN+1]; /* Controller name, e.g. 'ahc' */ + u_int32_t sim_unit_number; /* Controller unit number */ + u_int32_t bus_id; /* Controller bus number */ + lun_id_t target_lun; /* Logical Unit Number */ + target_id_t target_id; /* Target ID */ + path_id_t path_id; /* System SCSI bus number */ + u_int16_t pd_type; /* type of peripheral device */ + struct scsi_inquiry_data inq_data; /* SCSI Inquiry data */ + u_int8_t serial_num[252]; /* device serial number */ + u_int8_t serial_num_len; /* length of the serial number */ + u_int8_t sync_period; /* Negotiated sync period */ + u_int8_t sync_offset; /* Negotiated sync offset */ + u_int8_t bus_width; /* Negotiated bus width */ + int fd; /* file descriptor for device */ +}; + +__BEGIN_DECLS +/* Basic utility commands */ +struct cam_device * cam_open_device(const char *path, int flags); +void cam_close_device(struct cam_device *dev); +void cam_close_spec_device(struct cam_device *dev); +struct cam_device * cam_open_spec_device(const char *dev_name, + int unit, int flags, + struct cam_device *device); +struct cam_device * cam_open_btl(path_id_t path_id, target_id_t target_id, + lun_id_t target_lun, int flags, + struct cam_device *device); +struct cam_device * cam_open_pass(const char *path, int flags, + struct cam_device *device); +union ccb * cam_getccb(struct cam_device *dev); +void cam_freeccb(union ccb *ccb); +int cam_send_ccb(struct cam_device *device, union ccb *ccb); +char * cam_path_string(struct cam_device *dev, char *str, + int len); +struct cam_device * cam_device_dup(struct cam_device *device); +void cam_device_copy(struct cam_device *src, + struct cam_device *dst); +int cam_get_device(const char *path, char *dev_name, + int devnamelen, int *unit); + +/* + * Buffer encoding/decoding routines, from the old SCSI library. + */ +int csio_decode(struct ccb_scsiio *csio, char *fmt, ...); +int csio_decode_visit(struct ccb_scsiio *csio, char *fmt, + void (*arg_put)(void *, int, void *, int, char *), + void *puthook); +int buff_decode(u_int8_t *buff, size_t len, char *fmt, ...); +int buff_decode_visit(u_int8_t *buff, size_t len, char *fmt, + void (*arg_put)(void *, int, void *, int, char *), + void *puthook); +int csio_build(struct ccb_scsiio *csio, u_int8_t *data_ptr, + u_int32_t dxfer_len, u_int32_t flags, int retry_count, + int timeout, char *cmd_spec, ...); +int csio_build_visit(struct ccb_scsiio *csio, u_int8_t *data_ptr, + u_int32_t dxfer_len, u_int32_t flags, int retry_count, + int timeout, char *cmd_spec, + int (*arg_get)(void *hook, char *field_name), + void *gethook); +int csio_encode(struct ccb_scsiio *csio, char *fmt, ...); +int buff_encode_visit(u_int8_t *buff, size_t len, char *fmt, + int (*arg_get)(void *hook, char *field_name), + void *gethook); +int csio_encode_visit(struct ccb_scsiio *csio, char *fmt, + int (*arg_get)(void *hook, char *field_name), + void *gethook); +__END_DECLS + +#endif /* _CAMLIB_H */ diff --git a/lib/libcam/scsi_cmdparse.c b/lib/libcam/scsi_cmdparse.c new file mode 100644 index 0000000..ad1cbb0 --- /dev/null +++ b/lib/libcam/scsi_cmdparse.c @@ -0,0 +1,827 @@ +/* + * Taken from the original FreeBSD user SCSI library. + */ +/* Copyright (c) 1994 HD Associates + * (contact: dufault@hda.com) + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * This product includes software developed by HD Associates + * 4. Neither the name of the HD Associaates nor the names of its contributors + * may be used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY HD ASSOCIATES``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL HD ASSOCIATES OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + * From: scsi.c,v 1.8 1997/02/22 15:07:54 peter Exp $ + * $FreeBSD$ + */ +#include <stdlib.h> +#include <stdio.h> +#include <ctype.h> +#include <string.h> +#include <sys/errno.h> +#include <stdarg.h> +#include <fcntl.h> + +#include <cam/cam.h> +#include <cam/cam_ccb.h> +#include <cam/scsi/scsi_message.h> +#include "camlib.h" + +/* + * Decode: Decode the data section of a scsireq. This decodes + * trivial grammar: + * + * fields : field fields + * ; + * + * field : field_specifier + * | control + * ; + * + * control : 's' seek_value + * | 's' '+' seek_value + * ; + * + * seek_value : DECIMAL_NUMBER + * | 'v' // For indirect seek, i.e., value from the arg list + * ; + * + * field_specifier : type_specifier field_width + * | '{' NAME '}' type_specifier field_width + * ; + * + * field_width : DECIMAL_NUMBER + * ; + * + * type_specifier : 'i' // Integral types (i1, i2, i3, i4) + * | 'b' // Bits + * | 't' // Bits + * | 'c' // Character arrays + * | 'z' // Character arrays with zeroed trailing spaces + * ; + * + * Notes: + * 1. Integral types are swapped into host order. + * 2. Bit fields are allocated MSB to LSB to match the SCSI spec documentation. + * 3. 's' permits "seeking" in the string. "s+DECIMAL" seeks relative to + * DECIMAL; "sDECIMAL" seeks absolute to decimal. + * 4. 's' permits an indirect reference. "sv" or "s+v" will get the + * next integer value from the arg array. + * 5. Field names can be anything between the braces + * + * BUGS: + * i and b types are promoted to ints. + * + */ + +static int +do_buff_decode(u_int8_t *databuf, size_t len, + void (*arg_put)(void *, int , void *, int, char *), + void *puthook, char *fmt, va_list ap) +{ + int assigned = 0; + int width; + int suppress; + int plus; + int done = 0; + static u_char mask[] = {0, 0x01, 0x03, 0x07, 0x0f, + 0x1f, 0x3f, 0x7f, 0xff}; + int value; + u_char *base = databuf; + char letter; + char field_name[80]; + +# define ARG_PUT(ARG) \ + do \ + { \ + if (!suppress) \ + { \ + if (arg_put) \ + (*arg_put)(puthook, (letter == 't' ? \ + 'b' : letter), \ + (void *)((long)(ARG)), 1, field_name); \ + else \ + *(va_arg(ap, int *)) = (ARG); \ + assigned++; \ + } \ + field_name[0] = 0; \ + suppress = 0; \ + } while (0) + + u_char bits = 0; /* For bit fields */ + int shift = 0; /* Bits already shifted out */ + suppress = 0; + field_name[0] = 0; + + while (!done) { + switch(letter = *fmt) { + case ' ': /* White space */ + case '\t': + case '\r': + case '\n': + case '\f': + fmt++; + break; + + case '#': /* Comment */ + while (*fmt && (*fmt != '\n')) + fmt++; + if (fmt) + fmt++; /* Skip '\n' */ + break; + + case '*': /* Suppress assignment */ + fmt++; + suppress = 1; + break; + + case '{': /* Field Name */ + { + int i = 0; + fmt++; /* Skip '{' */ + while (*fmt && (*fmt != '}')) { + if (i < sizeof(field_name)) + field_name[i++] = *fmt; + + fmt++; + } + if (fmt) + fmt++; /* Skip '}' */ + field_name[i] = 0; + break; + } + + case 't': /* Bit (field) */ + case 'b': /* Bits */ + fmt++; + width = strtol(fmt, &fmt, 10); + if (width > 8) + done = 1; + else { + if (shift <= 0) { + bits = *databuf++; + shift = 8; + } + value = (bits >> (shift - width)) & + mask[width]; + +#if 0 + printf("shift %2d bits %02x value %02x width %2d mask %02x\n", + shift, bits, value, width, mask[width]); +#endif + + ARG_PUT(value); + + shift -= width; + } + break; + + case 'i': /* Integral values */ + shift = 0; + fmt++; + width = strtol(fmt, &fmt, 10); + switch(width) { + case 1: + ARG_PUT(*databuf); + databuf++; + break; + + case 2: + ARG_PUT((*databuf) << 8 | *(databuf + 1)); + databuf += 2; + break; + + case 3: + ARG_PUT((*databuf) << 16 | + (*(databuf + 1)) << 8 | *(databuf + 2)); + databuf += 3; + break; + + case 4: + ARG_PUT((*databuf) << 24 | + (*(databuf + 1)) << 16 | + (*(databuf + 2)) << 8 | + *(databuf + 3)); + databuf += 4; + break; + + default: + done = 1; + break; + } + + break; + + case 'c': /* Characters (i.e., not swapped) */ + case 'z': /* Characters with zeroed trailing + spaces */ + shift = 0; + fmt++; + width = strtol(fmt, &fmt, 10); + if (!suppress) { + if (arg_put) + (*arg_put)(puthook, + (letter == 't' ? 'b' : letter), + databuf, width, field_name); + else { + char *dest; + dest = va_arg(ap, char *); + bcopy(databuf, dest, width); + if (letter == 'z') { + char *p; + for (p = dest + width - 1; + (p >= (char *)dest) + && (*p == ' '); p--) + *p = 0; + } + } + assigned++; + } + databuf += width; + field_name[0] = 0; + suppress = 0; + break; + + case 's': /* Seek */ + shift = 0; + fmt++; + if (*fmt == '+') { + plus = 1; + fmt++; + } else + plus = 0; + + if (tolower(*fmt) == 'v') { + /* + * You can't suppress a seek value. You also + * can't have a variable seek when you are using + * "arg_put". + */ + width = (arg_put) ? 0 : va_arg(ap, int); + fmt++; + } else + width = strtol(fmt, &fmt, 10); + + if (plus) + databuf += width; /* Relative seek */ + else + databuf = base + width; /* Absolute seek */ + + break; + + case 0: + done = 1; + break; + + default: + fprintf(stderr, "Unknown letter in format: %c\n", + letter); + fmt++; + break; + } + } + + return (assigned); +} + +/* next_field: Return the next field in a command specifier. This + * builds up a SCSI command using this trivial grammar: + * + * fields : field fields + * ; + * + * field : value + * | value ':' field_width + * ; + * + * field_width : digit + * | 'i' digit // i2 = 2 byte integer, i3 = 3 byte integer etc. + * ; + * + * value : HEX_NUMBER + * | 'v' // For indirection. + * ; + * + * Notes: + * Bit fields are specified MSB first to match the SCSI spec. + * + * Examples: + * TUR: "0 0 0 0 0 0" + * WRITE BUFFER: "38 v:3 0:2 0:3 v v:i3 v:i3 0", mode, buffer_id, list_length + * + * The function returns the value: + * 0: For reached end, with error_p set if an error was found + * 1: For valid stuff setup + * 2: For "v" was entered as the value (implies use varargs) + * + */ + +static int +next_field(char **pp, char *fmt, int *width_p, int *value_p, char *name, + int n_name, int *error_p, int *suppress_p) +{ + char *p = *pp; + + int something = 0; + + enum { + BETWEEN_FIELDS, + START_FIELD, + GET_FIELD, + DONE, + } state; + + int value = 0; + int field_size; /* Default to byte field type... */ + int field_width; /* 1 byte wide */ + int is_error = 0; + int suppress = 0; + + field_size = 8; /* Default to byte field type... */ + *fmt = 'i'; + field_width = 1; /* 1 byte wide */ + if (name) + *name = 0; + + state = BETWEEN_FIELDS; + + while (state != DONE) { + switch(state) { + case BETWEEN_FIELDS: + if (*p == 0) + state = DONE; + else if (isspace(*p)) + p++; + else if (*p == '#') { + while (*p && *p != '\n') + p++; + if (p) + p++; + } else if (*p == '{') { + int i = 0; + + p++; + + while (*p && *p != '}') { + if(name && i < n_name) { + name[i] = *p; + i++; + } + p++; + } + + if(name && i < n_name) + name[i] = 0; + + if (*p == '}') + p++; + } else if (*p == '*') { + p++; + suppress = 1; + } else if (isxdigit(*p)) { + something = 1; + value = strtol(p, &p, 16); + state = START_FIELD; + } else if (tolower(*p) == 'v') { + p++; + something = 2; + value = *value_p; + state = START_FIELD; + } else if (tolower(*p) == 'i') { + /* + * Try to work without the "v". + */ + something = 2; + value = *value_p; + p++; + + *fmt = 'i'; + field_size = 8; + field_width = strtol(p, &p, 10); + state = DONE; + + } else if (tolower(*p) == 't') { + /* + * XXX: B can't work: Sees the 'b' as a + * hex digit in "isxdigit". try "t" for + * bit field. + */ + something = 2; + value = *value_p; + p++; + + *fmt = 'b'; + field_size = 1; + field_width = strtol(p, &p, 10); + state = DONE; + } else if (tolower(*p) == 's') { + /* Seek */ + *fmt = 's'; + p++; + if (tolower(*p) == 'v') { + p++; + something = 2; + value = *value_p; + } else { + something = 1; + value = strtol(p, &p, 0); + } + state = DONE; + } else { + fprintf(stderr, "Invalid starting " + "character: %c\n", *p); + is_error = 1; + state = DONE; + } + break; + + case START_FIELD: + if (*p == ':') { + p++; + field_size = 1; /* Default to bits + when specified */ + state = GET_FIELD; + } else + state = DONE; + break; + + case GET_FIELD: + if (isdigit(*p)) { + *fmt = 'b'; + field_size = 1; + field_width = strtol(p, &p, 10); + state = DONE; + } else if (*p == 'i') { + + /* Integral (bytes) */ + p++; + + *fmt = 'i'; + field_size = 8; + field_width = strtol(p, &p, 10); + state = DONE; + } else if (*p == 'b') { + + /* Bits */ + p++; + + *fmt = 'b'; + field_size = 1; + field_width = strtol(p, &p, 10); + state = DONE; + } else { + fprintf(stderr, "Invalid startfield %c " + "(%02x)\n", *p, *p); + is_error = 1; + state = DONE; + } + break; + + case DONE: + break; + } + } + + if (is_error) { + *error_p = 1; + return 0; + } + + *error_p = 0; + *pp = p; + *width_p = field_width * field_size; + *value_p = value; + *suppress_p = suppress; + + return (something); +} + +static int +do_encode(u_char *buff, size_t vec_max, size_t *used, + int (*arg_get)(void *, char *), void *gethook, char *fmt, va_list ap) +{ + int ind; + int shift; + u_char val; + int ret; + int width, value, error, suppress; + char c; + int encoded = 0; + char field_name[80]; + + ind = 0; + shift = 0; + val = 0; + + while ((ret = next_field(&fmt, &c, &width, &value, field_name, + sizeof(field_name), &error, &suppress))) { + encoded++; + + if (ret == 2) { + if (suppress) + value = 0; + else + value = arg_get ? + (*arg_get)(gethook, field_name) : + va_arg(ap, int); + } + +#if 0 + printf( +"do_encode: ret %d fmt %c width %d value %d name \"%s\" error %d suppress %d\n", + ret, c, width, value, field_name, error, suppress); +#endif + /* Absolute seek */ + if (c == 's') { + ind = value; + continue; + } + + /* A width of < 8 is a bit field. */ + if (width < 8) { + + /* This is a bit field. We start with the high bits + * so it reads the same as the SCSI spec. + */ + + shift += width; + + val |= (value << (8 - shift)); + + if (shift == 8) { + if (ind < vec_max) { + buff[ind++] = val; + val = 0; + } + shift = 0; + } + } else { + if (shift) { + if (ind < vec_max) { + buff[ind++] = val; + val = 0; + } + shift = 0; + } + switch(width) { + case 8: /* 1 byte integer */ + if (ind < vec_max) + buff[ind++] = value; + break; + + case 16: /* 2 byte integer */ + if (ind < vec_max - 2 + 1) { + buff[ind++] = value >> 8; + buff[ind++] = value; + } + break; + + case 24: /* 3 byte integer */ + if (ind < vec_max - 3 + 1) { + buff[ind++] = value >> 16; + buff[ind++] = value >> 8; + buff[ind++] = value; + } + break; + + case 32: /* 4 byte integer */ + if (ind < vec_max - 4 + 1) { + buff[ind++] = value >> 24; + buff[ind++] = value >> 16; + buff[ind++] = value >> 8; + buff[ind++] = value; + } + break; + + default: + fprintf(stderr, "do_encode: Illegal width\n"); + break; + } + } + } + + /* Flush out any remaining bits + */ + if (shift && ind < vec_max) { + buff[ind++] = val; + val = 0; + } + + + if (used) + *used = ind; + + if (error) + return -1; + + return encoded; +} + +int +csio_decode(struct ccb_scsiio *csio, char *fmt, ...) +{ + va_list ap; + + va_start(ap, fmt); + + return(do_buff_decode(csio->data_ptr, (size_t)csio->dxfer_len, + 0, 0, fmt, ap)); +} + +int +csio_decode_visit(struct ccb_scsiio *csio, char *fmt, + void (*arg_put)(void *, int, void *, int, char *), + void *puthook) +{ + va_list ap; + + /* + * We need some way to output things; we can't do it without + * the arg_put function. + */ + if (arg_put == NULL) + return(-1); + + bzero(&ap, sizeof(ap)); + + return(do_buff_decode(csio->data_ptr, (size_t)csio->dxfer_len, + arg_put, puthook, fmt, ap)); +} + +int +buff_decode(u_int8_t *buff, size_t len, char *fmt, ...) +{ + va_list ap; + + va_start(ap, fmt); + + return(do_buff_decode(buff, len, 0, 0, fmt, ap)); +} + +int +buff_decode_visit(u_int8_t *buff, size_t len, char *fmt, + void (*arg_put)(void *, int, void *, int, char *), + void *puthook) +{ + va_list ap; + + /* + * We need some way to output things; we can't do it without + * the arg_put function. + */ + if (arg_put == NULL) + return(-1); + + bzero(&ap, sizeof(ap)); + + return(do_buff_decode(buff, len, arg_put, puthook, fmt, ap)); +} + +/* + * Build a SCSI CCB, given the command and data pointers and a format + * string describing the + */ +int +csio_build(struct ccb_scsiio *csio, u_int8_t *data_ptr, u_int32_t dxfer_len, + u_int32_t flags, int retry_count, int timeout, char *cmd_spec, ...) +{ + size_t cmdlen; + int retval; + va_list ap; + + if (csio == NULL) + return(0); + + bzero(csio, sizeof(struct ccb_scsiio)); + + va_start(ap, cmd_spec); + + if ((retval = do_encode(csio->cdb_io.cdb_bytes, SCSI_MAX_CDBLEN, + &cmdlen, NULL, NULL, cmd_spec, ap)) == -1) + return(retval); + + cam_fill_csio(csio, + /* retries */ retry_count, + /* cbfcnp */ NULL, + /* flags */ flags, + /* tag_action */ MSG_SIMPLE_Q_TAG, + /* data_ptr */ data_ptr, + /* dxfer_len */ dxfer_len, + /* sense_len */ SSD_FULL_SIZE, + /* cdb_len */ cmdlen, + /* timeout */ timeout ? timeout : 5000); + + return(retval); +} + +int +csio_build_visit(struct ccb_scsiio *csio, u_int8_t *data_ptr, + u_int32_t dxfer_len, u_int32_t flags, int retry_count, + int timeout, char *cmd_spec, + int (*arg_get)(void *hook, char *field_name), void *gethook) +{ + va_list ap; + size_t cmdlen; + int retval; + + if (csio == NULL) + return(0); + + /* + * We need something to encode, but we can't get it without the + * arg_get function. + */ + if (arg_get == NULL) + return(-1); + + bzero(&ap, sizeof(ap)); + + bzero(csio, sizeof(struct ccb_scsiio)); + + if ((retval = do_encode(csio->cdb_io.cdb_bytes, SCSI_MAX_CDBLEN, + &cmdlen, arg_get, gethook, cmd_spec, ap)) == -1) + return(retval); + + cam_fill_csio(csio, + /* retries */ retry_count, + /* cbfcnp */ NULL, + /* flags */ flags, + /* tag_action */ MSG_SIMPLE_Q_TAG, + /* data_ptr */ data_ptr, + /* dxfer_len */ dxfer_len, + /* sense_len */ SSD_FULL_SIZE, + /* cdb_len */ cmdlen, + /* timeout */ timeout ? timeout : 5000); + + return(retval); +} + +int +csio_encode(struct ccb_scsiio *csio, char *fmt, ...) +{ + va_list ap; + + if (csio == NULL) + return(0); + + va_start(ap, fmt); + + return(do_encode(csio->data_ptr, csio->dxfer_len, 0, 0, 0, fmt, ap)); +} + +int +buff_encode_visit(u_int8_t *buff, size_t len, char *fmt, + int (*arg_get)(void *hook, char *field_name), void *gethook) +{ + va_list ap; + + /* + * We need something to encode, but we can't get it without the + * arg_get function. + */ + if (arg_get == NULL) + return(-1); + + bzero(&ap, sizeof(ap)); + + return(do_encode(buff, len, 0, arg_get, gethook, fmt, ap)); +} + +int +csio_encode_visit(struct ccb_scsiio *csio, char *fmt, + int (*arg_get)(void *hook, char *field_name), void *gethook) +{ + va_list ap; + + /* + * We need something to encode, but we can't get it without the + * arg_get function. + */ + if (arg_get == NULL) + return(-1); + + bzero(&ap, sizeof(ap)); + + return(do_encode(csio->data_ptr, csio->dxfer_len, 0, arg_get, + gethook, fmt, ap)); +} |
