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