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