lib/libcam/camlib.h

   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$
  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 _CAMLIB_H
  65 #define _CAMLIB_H
  66
  67 #include <sys/cdefs.h>
  68 #include <sys/param.h>
  69
  70 #include <cam/cam.h>
  71 #include <cam/cam_ccb.h>
  72
  73 #define CAM_ERRBUF_SIZE 2048    /* sizeof the CAM libarary error string  */
  74
  75 /*
  76  * Right now we hard code the transport layer device, but this will change
  77  * if we ever get more than one transport layer.
  78  */
  79 #define XPT_DEVICE      "/dev/xpt0"
  80
  81
  82 extern char cam_errbuf[];
  83
  84 struct cam_device {
  85         char            device_path[MAXPATHLEN];/*
  86                                                    * Pathname of the device
  87                                                    * given by the user. This
  88                                                    * may be null if the
  89                                                    * user states the device
  90                                                    * name and unit number
  91                                                    * separately.
  92                                                    */
  93         char            given_dev_name[DEV_IDLEN+1];/*
  94                                                      * Device name given by
  95                                                      * the user.
  96                                                      */
  97         u_int32_t       given_unit_number;          /*
  98                                                      * Unit number given by
  99                                                      * the user.
 100                                                      */
 101         char            device_name[DEV_IDLEN+1];/*
 102                                                   * Name of the device,
 103                                                   * e.g. 'pass'
 104                                                   */
 105         u_int32_t       dev_unit_num;   /* Unit number of the passthrough
 106                                          * device associated with this
 107                                          * particular device.
 108                                          */
 109
 110         char            sim_name[SIM_IDLEN+1]; /* Controller name, e.g. 'ahc' */
 111         u_int32_t       sim_unit_number; /* Controller unit number */
 112         u_int32_t       bus_id;          /* Controller bus number */
 113         lun_id_t        target_lun;      /* Logical Unit Number */
 114         target_id_t     target_id;       /* Target ID */
 115         path_id_t       path_id;         /* System SCSI bus number */
 116         u_int16_t       pd_type;         /* type of peripheral device */
 117         struct scsi_inquiry_data inq_data;  /* SCSI Inquiry data */
 118         u_int8_t        serial_num[252]; /* device serial number */
 119         u_int8_t        serial_num_len;  /* length of the serial number */
 120         u_int8_t        sync_period;     /* Negotiated sync period */
 121         u_int8_t        sync_offset;     /* Negotiated sync offset */
 122         u_int8_t        bus_width;       /* Negotiated bus width */
 123         int             fd;              /* file descriptor for device */
 124 };
 125
 126 __BEGIN_DECLS
 127 /* Basic utility commands */
 128 struct cam_device *     cam_open_device(const char *path, int flags);
 129 void                    cam_close_device(struct cam_device *dev);
 130 void                    cam_close_spec_device(struct cam_device *dev);
 131 struct cam_device *     cam_open_spec_device(const char *dev_name,
 132                                              int unit, int flags,
 133                                              struct cam_device *device);
 134 struct cam_device *     cam_open_btl(path_id_t path_id, target_id_t target_id,
 135                                      lun_id_t target_lun, int flags,
 136                                      struct cam_device *device);
 137 struct cam_device *     cam_open_pass(const char *path, int flags,
 138                                       struct cam_device *device);
 139 union ccb *             cam_getccb(struct cam_device *dev);
 140 void                    cam_freeccb(union ccb *ccb);
 141 int                     cam_send_ccb(struct cam_device *device, union ccb *ccb);
 142 char *                  cam_path_string(struct cam_device *dev, char *str,
 143                                         int len);
 144 struct cam_device *     cam_device_dup(struct cam_device *device);
 145 void                    cam_device_copy(struct cam_device *src,
 146                                         struct cam_device *dst);
 147 int                     cam_get_device(const char *path, char *dev_name,
 148                                        int devnamelen, int *unit);
 149
 150 /*
 151  * Buffer encoding/decoding routines, from the old SCSI library.
 152  */
 153 int csio_decode(struct ccb_scsiio *csio, const char *fmt, ...)
 154                 __printflike(2, 3);
 155 int csio_decode_visit(struct ccb_scsiio *csio, const char *fmt,
 156                       void (*arg_put)(void *, int, void *, int, char *),
 157                       void *puthook);
 158 int buff_decode(u_int8_t *buff, size_t len, const char *fmt, ...)
 159                 __printflike(3, 4);
 160 int buff_decode_visit(u_int8_t *buff, size_t len, const char *fmt,
 161                       void (*arg_put)(void *, int, void *, int, char *),
 162                       void *puthook);
 163 int csio_build(struct ccb_scsiio *csio, u_int8_t *data_ptr,
 164                u_int32_t dxfer_len, u_int32_t flags, int retry_count,
 165                int timeout, const char *cmd_spec, ...);
 166 int csio_build_visit(struct ccb_scsiio *csio, u_int8_t *data_ptr,
 167                      u_int32_t dxfer_len, u_int32_t flags, int retry_count,
 168                      int timeout, const char *cmd_spec,
 169                      int (*arg_get)(void *hook, char *field_name),
 170                      void *gethook);
 171 int csio_encode(struct ccb_scsiio *csio, const char *fmt, ...)
 172                 __printflike(2, 3);
 173 int buff_encode_visit(u_int8_t *buff, size_t len, const char *fmt,
 174                       int (*arg_get)(void *hook, char *field_name),
 175                       void *gethook);
 176 int csio_encode_visit(struct ccb_scsiio *csio, const char *fmt,
 177                       int (*arg_get)(void *hook, char *field_name),
 178                       void *gethook);
 179 __END_DECLS
 180
 181 #endif /* _CAMLIB_H */