1 /* 2 * Copyright (c) 1997, 1998 Kenneth D. Merry. 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. The name of the author may not be used to endorse or promote products 11 * derived from this software without specific prior written permission. 12 * 13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23 * SUCH DAMAGE. 24 * 25 * $FreeBSD: src/lib/libcam/camlib.h,v 1.2 1999/08/28 00:04:06 peter Exp $ 26 * $DragonFly: src/sys/sys/camlib.h,v 1.6 2007/11/24 03:13:03 pavalos Exp $ 27 */ 28 /* 29 * Buffer encoding/decoding routines taken from the original FreeBSD SCSI 30 * library and slightly modified. The original header file had the following 31 * copyright: 32 */ 33 /* Copyright (c) 1994 HD Associates (hd@world.std.com) 34 * All rights reserved. 35 * 36 * Redistribution and use in source and binary forms, with or without 37 * modification, are permitted provided that the following conditions 38 * are met: 39 * 1. Redistributions of source code must retain the above copyright 40 * notice, this list of conditions and the following disclaimer. 41 * 2. Redistributions in binary form must reproduce the above copyright 42 * notice, this list of conditions and the following disclaimer in the 43 * documentation and/or other materials provided with the distribution. 44 * 3. All advertising materials mentioning features or use of this software 45 * must display the following acknowledgement: 46 * This product includes software developed by HD Associates 47 * 4. Neither the name of the HD Associaates nor the names of its contributors 48 * may be used to endorse or promote products derived from this software 49 * without specific prior written permission. 50 * 51 * THIS SOFTWARE IS PROVIDED BY HD ASSOCIATES``AS IS'' AND 52 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 53 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 54 * ARE DISCLAIMED. IN NO EVENT SHALL HD ASSOCIATES OR CONTRIBUTORS BE LIABLE 55 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 56 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 57 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 58 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 59 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 60 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 61 * SUCH DAMAGE. 62 */ 63 64 65 #ifndef _SYS_CAMLIB_H_ 66 #define _SYS_CAMLIB_H_ 67 68 #ifndef _SYS_CDEFS_H_ 69 #include <sys/cdefs.h> 70 #endif 71 #ifndef _SYS_PARAM_H_ 72 #include <sys/param.h> 73 #endif 74 #ifndef _BUS_CAM_CAM_H_ 75 #include <bus/cam/cam.h> 76 #endif 77 #ifndef _BUS_CAM_CAM_CCB_H_ 78 #include <bus/cam/cam_ccb.h> 79 #endif 80 81 #define CAM_ERRBUF_SIZE 2048 /* sizeof the CAM libarary error string */ 82 83 /* 84 * Right now we hard code the transport layer device, but this will change 85 * if we ever get more than one transport layer. 86 */ 87 #define XPT_DEVICE "/dev/xpt0" 88 89 90 extern char cam_errbuf[]; 91 92 struct cam_device { 93 char device_path[MAXPATHLEN]; /* 94 * Pathname of the device 95 * given by the user. This 96 * may be null if the 97 * user states the device 98 * name and unit number 99 * separately. 100 */ 101 char given_dev_name[DEV_IDLEN+1];/* 102 * Device name given by 103 * the user. 104 */ 105 u_int32_t given_unit_number; /* 106 * Unit number given by 107 * the user. 108 */ 109 char device_name[DEV_IDLEN+1];/* 110 * Name of the device, 111 * e.g. 'pass' 112 */ 113 u_int32_t dev_unit_num; /* Unit number of the passthrough 114 * device associated with this 115 * particular device. 116 */ 117 118 char sim_name[SIM_IDLEN+1]; /* Controller name, e.g. 'ahc' */ 119 u_int32_t sim_unit_number; /* Controller unit number */ 120 u_int32_t bus_id; /* Controller bus number */ 121 lun_id_t target_lun; /* Logical Unit Number */ 122 target_id_t target_id; /* Target ID */ 123 path_id_t path_id; /* System SCSI bus number */ 124 u_int16_t pd_type; /* type of peripheral device */ 125 struct scsi_inquiry_data inq_data; /* SCSI Inquiry data */ 126 u_int8_t serial_num[252]; /* device serial number */ 127 u_int8_t serial_num_len; /* length of the serial number */ 128 u_int8_t sync_period; /* Negotiated sync period */ 129 u_int8_t sync_offset; /* Negotiated sync offset */ 130 u_int8_t bus_width; /* Negotiated bus width */ 131 int fd; /* file descriptor for device */ 132 }; 133 134 __BEGIN_DECLS 135 /* Basic utility commands */ 136 struct cam_device * cam_open_device(const char *path, int flags); 137 void cam_close_device(struct cam_device *dev); 138 void cam_close_spec_device(struct cam_device *dev); 139 struct cam_device * cam_open_spec_device(const char *dev_name, 140 int unit, int flags, 141 struct cam_device *device); 142 struct cam_device * cam_open_btl(path_id_t path_id, target_id_t target_id, 143 lun_id_t target_lun, int flags, 144 struct cam_device *device); 145 struct cam_device * cam_open_pass(const char *path, int flags, 146 struct cam_device *device); 147 union ccb * cam_getccb(struct cam_device *dev); 148 void cam_freeccb(union ccb *ccb); 149 int cam_send_ccb(struct cam_device *device, union ccb *ccb); 150 char * cam_path_string(struct cam_device *dev, char *str, 151 int len); 152 struct cam_device * cam_device_dup(struct cam_device *device); 153 void cam_device_copy(struct cam_device *src, 154 struct cam_device *dst); 155 int cam_get_device(const char *path, char *dev_name, 156 int devnamelen, int *unit); 157 158 /* 159 * Buffer encoding/decoding routines, from the old SCSI library. 160 */ 161 int csio_decode(struct ccb_scsiio *csio, const char *fmt, ...) 162 __printflike(2, 3); 163 int csio_decode_visit(struct ccb_scsiio *csio, const char *fmt, 164 void (*arg_put)(void *, int, void *, int, char *), 165 void *puthook); 166 int buff_decode(u_int8_t *buff, size_t len, const char *fmt, ...) 167 __printflike(3, 4); 168 int buff_decode_visit(u_int8_t *buff, size_t len, const char *fmt, 169 void (*arg_put)(void *, int, void *, int, char *), 170 void *puthook); 171 int csio_build(struct ccb_scsiio *csio, u_int8_t *data_ptr, 172 u_int32_t dxfer_len, u_int32_t flags, int retry_count, 173 int timeout, const char *cmd_spec, ...); 174 int csio_build_visit(struct ccb_scsiio *csio, u_int8_t *data_ptr, 175 u_int32_t dxfer_len, u_int32_t flags, int retry_count, 176 int timeout, const char *cmd_spec, 177 int (*arg_get)(void *hook, char *field_name), 178 void *gethook); 179 int csio_encode(struct ccb_scsiio *csio, const char *fmt, ...) 180 __printflike(2, 3); 181 int buff_encode_visit(u_int8_t *buff, size_t len, const char *fmt, 182 int (*arg_get)(void *hook, char *field_name), 183 void *gethook); 184 int csio_encode_visit(struct ccb_scsiio *csio, const char *fmt, 185 int (*arg_get)(void *hook, char *field_name), 186 void *gethook); 187 __END_DECLS 188 189 #endif /* _SYS_CAMLIB_H_ */ 190