2 * SPDX-License-Identifier: BSD-3-Clause
4 * Copyright (c) 2010, LSI Corp.
6 * Author : Manjunath Ranganathaiah
7 * Support: freebsdraid@lsi.com
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
19 * 3. Neither the name of the <ORGANIZATION> nor the names of its
20 * contributors may be used to endorse or promote products derived
21 * from this software without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
26 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
27 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
28 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
29 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
33 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34 * POSSIBILITY OF SUCH DAMAGE.
37 #include <sys/param.h> /* defines used in kernel.h */
38 #include <sys/bus.h> /* structs, prototypes for pci bus stuff */
39 #include <sys/conf.h> /* cdevsw struct */
40 #include <sys/errno.h>
41 #include <sys/kernel.h> /* types used in module initialization */
43 #include <sys/malloc.h>
44 #include <sys/module.h>
45 #include <sys/mutex.h>
47 #include <sys/systm.h>
48 #include <sys/uio.h> /* uio struct */
50 #include <machine/bus.h>
52 #include <machine/resource.h>
54 #include <dev/pci/pcivar.h> /* For pci_get macros! */
55 #include <dev/pci/pcireg.h>
57 #include <sys/types.h>
58 #include <sys/sysctl.h>
61 #define TWS_PULL_MODE_ENABLE 1
63 MALLOC_DECLARE(M_TWS);
65 extern int tws_queue_depth;
67 #define TWS_DRIVER_VERSION_STRING "10.80.00.005"
68 #define TWS_MAX_NUM_UNITS 65
69 #define TWS_MAX_NUM_LUNS 32
70 #define TWS_MAX_IRQS 2
71 #define TWS_SCSI_INITIATOR_ID 66
72 #define TWS_MAX_IO_SIZE 0x20000 /* 128kB */
73 #define TWS_SECTOR_SIZE 0x200
74 #define TWS_POLL_TIMEOUT 60
75 #define TWS_IO_TIMEOUT 60
76 #define TWS_IOCTL_TIMEOUT 60
77 #define TWS_RESET_TIMEOUT 60
79 #define TWS_PCI_BAR0 0x10
80 #define TWS_PCI_BAR1 0x14
81 #define TWS_PCI_BAR2 0x1C
83 #define TWS_VENDOR_ID 0x13C1
84 #define TWS_DEVICE_ID 0x1010
86 #define TWS_INVALID_REQID 0xFFFF
89 #define TWS_ALIGNMENT 4
90 #define TWS_IN_MF_ALIGNMENT 16
91 #define TWS_OUT_MF_ALIGNMENT 4
93 #define TWS_MAX_32BIT_SG_ELEMENTS 93 /* max 32-bit sg elements */
94 #define TWS_MAX_64BIT_SG_ELEMENTS 46 /* max 64-bit sg elements */
97 #define TWS_MAX_REQS 256
98 #define TWS_RESERVED_REQS 4
101 #define TWS_REQ_STATE_FREE 0
102 #define TWS_REQ_STATE_BUSY 1
103 #define TWS_REQ_STATE_TRAN 2
104 #define TWS_REQ_STATE_COMPLETE 3
107 #define TWS_REQ_TYPE_INTERNAL_CMD 0x0
108 #define TWS_REQ_TYPE_AEN_FETCH 0x1
109 #define TWS_REQ_TYPE_PASSTHRU 0x2
110 #define TWS_REQ_TYPE_GETSET_PARAM 0x3
111 #define TWS_REQ_TYPE_SCSI_IO 0x4
135 TWS_DIR_UNKNOWN = 0x1,
148 struct tws_msix_info {
150 bus_space_tag_t tbl_tag;
151 bus_space_handle_t tbl_handle;
152 struct resource *tbl_res;
155 struct tws_ioctl_lock {
160 #define TWS_TRACE_FNAME_LEN 10
161 #define TWS_TRACE_FUNC_LEN 15
162 #define TWS_TRACE_DESC_LEN 10
163 struct tws_trace_rec {
165 char fname[TWS_TRACE_FNAME_LEN];
166 char func[TWS_TRACE_FUNC_LEN];
168 char desc[TWS_TRACE_DESC_LEN];
173 struct tws_circular_q {
174 volatile int16_t head;
175 volatile int16_t tail;
184 u_int64_t reqs_errored;
185 u_int64_t spurios_intrs;
192 struct tws_init_connect_info {
193 u_int16_t working_srl;
194 u_int16_t working_branch;
195 u_int16_t working_build;
196 u_int16_t fw_on_ctlr_srl;
197 u_int16_t fw_on_ctlr_branch;
198 u_int16_t fw_on_ctlr_build;
202 /* ------------ boolean types ------------------- */
204 #ifndef __bool_true_false_are_defined
205 typedef enum _boolean { false, true } boolean;
209 enum err { SUCCESS, FAILURE };
211 /* ----------- per instance data ---------------- */
213 /* The softc holds our per-instance data. */
215 device_t tws_dev; /* bus device */
216 struct cdev *tws_cdev; /* controller device */
217 u_int32_t device_id; /* device id */
218 u_int32_t subvendor_id; /* device id */
219 u_int32_t subdevice_id; /* device id */
220 u_int8_t tws_state; /* driver state */
221 u_int8_t tws_prev_state; /* driver prev state */
222 struct sysctl_ctx_list tws_clist; /* sysctl context */
223 struct sysctl_oid *tws_oidp; /* sysctl context */
224 struct resource *reg_res; /* register interface window */
225 struct resource *mfa_res; /* mfa interface window */
226 int reg_res_id; /* register resource id */
227 int mfa_res_id; /* register resource id */
228 bus_space_handle_t bus_handle; /* bus space handle */
229 bus_space_handle_t bus_mfa_handle; /* bus space handle */
230 bus_space_tag_t bus_tag; /* bus space tag */
231 bus_space_tag_t bus_mfa_tag; /* bus space tag for mfa's */
232 u_int64_t mfa_base; /* mfa base address */
233 struct resource *irq_res[TWS_MAX_IRQS];/* interrupt resource */
234 int irq_res_id[TWS_MAX_IRQS]; /* intr resource id */
235 void *intr_handle[TWS_MAX_IRQS]; /* interrupt handle */
236 int irqs; /* intrs used */
237 struct tws_msix_info msix; /* msix info */
238 struct cam_sim *sim; /* sim for this controller */
239 struct cam_path *path; /* Ctlr path to CAM */
240 struct mtx q_lock; /* queue lock */
241 struct mtx sim_lock; /* sim lock */
242 struct mtx gen_lock; /* general driver lock */
243 struct mtx io_lock; /* IO lock */
244 struct tws_ioctl_lock ioctl_lock; /* ioctl lock */
245 u_int32_t seq_id; /* Sequence id */
246 struct tws_circular_q aen_q; /* aen q */
247 struct tws_circular_q trace_q; /* trace q */
248 struct tws_stats stats; /* I/O stats */
249 struct tws_init_connect_info cinfo; /* compatibility info */
250 boolean is64bit; /* True - 64bit else 32bit */
251 u_int8_t intr_type; /* Interrupt type used */
252 bus_dma_tag_t parent_tag; /* parent DMA tag */
253 bus_dma_tag_t cmd_tag; /* command DMA tag */
254 bus_dmamap_t cmd_map; /* command map */
255 void *dma_mem; /* pointer to dmable memory */
256 u_int64_t dma_mem_phys; /* phy addr */
257 bus_dma_tag_t data_tag; /* data DMA tag */
258 void *ioctl_data_mem; /* ioctl dmable memory */
259 bus_dmamap_t ioctl_data_map; /* ioctl data map */
260 struct tws_request *reqs; /* pointer to requests */
261 struct tws_sense *sense_bufs; /* pointer to sense buffers */
262 boolean obfl_q_overrun; /* OBFL overrun flag */
263 union ccb *scan_ccb; /* pointer to a ccb */
264 struct tws_request *q_head[TWS_MAX_QS]; /* head pointers to q's */
265 struct tws_request *q_tail[TWS_MAX_QS]; /* tail pointers to q's */
266 struct callout stats_timer;