lib/libcam/camlib.h

   1 /*-
   2  * SPDX-License-Identifier: (BSD-2-Clause AND BSD-4-Clause)
   3  *
   4  * Copyright (c) 1997, 1998 Kenneth D. Merry.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. The name of the author may not be used to endorse or promote products
  13  *    derived from this software without specific prior written permission.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  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/param.h>
  68
  69 #include <cam/cam.h>
  70 #include <cam/cam_ccb.h>
  71
  72 #define CAM_ERRBUF_SIZE 2048    /* CAM library error string size */
  73
  74 /*
  75  * Right now we hard code the transport layer device, but this will change
  76  * if we ever get more than one transport layer.
  77  */
  78 #define XPT_DEVICE      "/dev/xpt0"
  79
  80
  81 extern char cam_errbuf[];
  82
  83 struct cam_device {
  84         char            device_path[MAXPATHLEN];/*
  85                                                    * Pathname of the device
  86                                                    * given by the user. This
  87                                                    * may be null if the
  88                                                    * user states the device
  89                                                    * name and unit number
  90                                                    * separately.
  91                                                    */
  92         char            given_dev_name[DEV_IDLEN+1];/*
  93                                                      * Device name given by
  94                                                      * the user.
  95                                                      */
  96         uint32_t        given_unit_number;          /*
  97                                                      * Unit number given by
  98                                                      * the user.
  99                                                      */
 100         char            device_name[DEV_IDLEN+1];/*
 101                                                   * Name of the device,
 102                                                   * e.g. 'pass'
 103                                                   */
 104         uint32_t        dev_unit_num;   /* Unit number of the passthrough
 105                                          * device associated with this
 106                                          * particular device.
 107                                          */
 108
 109         char            sim_name[SIM_IDLEN+1]; /* Controller name, e.g. 'ahc' */
 110         uint32_t        sim_unit_number; /* Controller unit number */
 111         uint32_t        bus_id;          /* Controller bus number */
 112         lun_id_t        target_lun;      /* Logical Unit Number */
 113         target_id_t     target_id;       /* Target ID */
 114         path_id_t       path_id;         /* System SCSI bus number */
 115         uint16_t        pd_type;         /* type of peripheral device */
 116         struct scsi_inquiry_data inq_data;  /* SCSI Inquiry data */
 117         uint8_t serial_num[252]; /* device serial number */
 118         uint8_t serial_num_len;  /* length of the serial number */
 119         uint8_t sync_period;     /* Negotiated sync period */
 120         uint8_t sync_offset;     /* Negotiated sync offset */
 121         uint8_t bus_width;       /* Negotiated bus width */
 122         int             fd;              /* file descriptor for device */
 123 };
 124
 125 __BEGIN_DECLS
 126 /* Basic utility commands */
 127 struct cam_device *     cam_open_device(const char *path, int flags);
 128 void                    cam_close_device(struct cam_device *dev);
 129 void                    cam_close_spec_device(struct cam_device *dev);
 130 struct cam_device *     cam_open_spec_device(const char *dev_name,
 131                                              int unit, int flags,
 132                                              struct cam_device *device);
 133 struct cam_device *     cam_open_btl(path_id_t path_id, target_id_t target_id,
 134                                      lun_id_t target_lun, int flags,
 135                                      struct cam_device *device);
 136 struct cam_device *     cam_open_pass(const char *path, int flags,
 137                                       struct cam_device *device);
 138 union ccb *             cam_getccb(struct cam_device *dev);
 139 void                    cam_freeccb(union ccb *ccb);
 140 int                     cam_send_ccb(struct cam_device *device, union ccb *ccb);
 141 char *                  cam_path_string(struct cam_device *dev, char *str,
 142                                         int len);
 143 struct cam_device *     cam_device_dup(struct cam_device *device);
 144 void                    cam_device_copy(struct cam_device *src,
 145                                         struct cam_device *dst);
 146 int                     cam_get_device(const char *path, char *dev_name,
 147                                        int devnamelen, int *unit);
 148
 149 /*
 150  * Buffer encoding/decoding routines, from the old SCSI library.
 151  */
 152 int csio_decode(struct ccb_scsiio *csio, const char *fmt, ...)
 153                 __printflike(2, 3);
 154 int csio_decode_visit(struct ccb_scsiio *csio, const char *fmt,
 155                       void (*arg_put)(void *, int, void *, int, char *),
 156                       void *puthook);
 157 int buff_decode(uint8_t *buff, size_t len, const char *fmt, ...)
 158                 __printflike(3, 4);
 159 int buff_decode_visit(uint8_t *buff, size_t len, const char *fmt,
 160                       void (*arg_put)(void *, int, void *, int, char *),
 161                       void *puthook);
 162 int csio_build(struct ccb_scsiio *csio, uint8_t *data_ptr,
 163                uint32_t dxfer_len, uint32_t flags, int retry_count,
 164                int timeout, const char *cmd_spec, ...);
 165 int csio_build_visit(struct ccb_scsiio *csio, uint8_t *data_ptr,
 166                      uint32_t dxfer_len, uint32_t flags, int retry_count,
 167                      int timeout, const char *cmd_spec,
 168                      int (*arg_get)(void *hook, char *field_name),
 169                      void *gethook);
 170 int csio_encode(struct ccb_scsiio *csio, const char *fmt, ...)
 171                 __printflike(2, 3);
 172 int buff_encode_visit(uint8_t *buff, size_t len, const char *fmt,
 173                       int (*arg_get)(void *hook, char *field_name),
 174                       void *gethook);
 175 int csio_encode_visit(struct ccb_scsiio *csio, const char *fmt,
 176                       int (*arg_get)(void *hook, char *field_name),
 177                       void *gethook);
 178 __END_DECLS
 179
 180 #endif /* _CAMLIB_H */