tws.h revision 330897 
1/*-
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (c) 2010, LSI Corp.
5 * All rights reserved.
6 * Author : Manjunath Ranganathaiah
7 * Support: freebsdraid@lsi.com
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 *
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
18 *    distribution.
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.
22 *
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.
35 *
36 * $FreeBSD: stable/11/sys/dev/tws/tws.h 330897 2018-03-14 03:19:51Z eadler $
37 */
38
39#include <sys/param.h>        /* defines used in kernel.h */
40#include <sys/module.h>
41#include <sys/systm.h>
42#include <sys/proc.h>
43#include <sys/errno.h>
44#include <sys/kernel.h>       /* types used in module initialization */
45#include <sys/conf.h>         /* cdevsw struct */
46#include <sys/uio.h>          /* uio struct */
47#include <sys/malloc.h>
48#include <sys/bus.h>          /* structs, prototypes for pci bus stuff */
49
50
51#include <machine/bus.h>
52#include <sys/rman.h>
53#include <machine/resource.h>
54
55#include <dev/pci/pcivar.h>   /* For pci_get macros! */
56#include <dev/pci/pcireg.h>
57
58#include <sys/types.h>
59#include <sys/sysctl.h>
60#include <sys/stat.h>
61
62
63#define TWS_PULL_MODE_ENABLE 1
64
65MALLOC_DECLARE(M_TWS);
66/* externs */
67extern int tws_queue_depth;
68
69
70#define TWS_DRIVER_VERSION_STRING "10.80.00.005"
71#define TWS_MAX_NUM_UNITS             65
72#define TWS_MAX_NUM_LUNS              32
73#define TWS_MAX_IRQS                  2
74#define TWS_SCSI_INITIATOR_ID         66
75#define TWS_MAX_IO_SIZE               0x20000 /* 128kB */
76#define TWS_SECTOR_SIZE               0x200
77#define TWS_POLL_TIMEOUT              60
78#define TWS_IO_TIMEOUT                60
79#define TWS_IOCTL_TIMEOUT             60
80#define TWS_RESET_TIMEOUT             60
81
82#define TWS_PCI_BAR0                  0x10
83#define TWS_PCI_BAR1                  0x14
84#define TWS_PCI_BAR2                  0x1C
85
86#define TWS_VENDOR_ID                 0x13C1
87#define TWS_DEVICE_ID                 0x1010
88
89#define TWS_INVALID_REQID             0xFFFF
90
91/* bus tag related */
92#define TWS_ALIGNMENT                 4
93#define TWS_IN_MF_ALIGNMENT           16
94#define TWS_OUT_MF_ALIGNMENT          4
95
96#define TWS_MAX_32BIT_SG_ELEMENTS     93     /* max 32-bit sg elements */
97#define TWS_MAX_64BIT_SG_ELEMENTS     46     /* max 64-bit sg elements */
98
99#define TWS_MAX_QS                    4
100#define TWS_MAX_REQS                  256
101#define TWS_RESERVED_REQS             4
102
103/* Request states */
104#define TWS_REQ_STATE_FREE            0
105#define TWS_REQ_STATE_BUSY            1
106#define TWS_REQ_STATE_TRAN            2
107#define TWS_REQ_STATE_COMPLETE        3
108
109/* Request types */
110#define TWS_REQ_TYPE_INTERNAL_CMD     0x0
111#define TWS_REQ_TYPE_AEN_FETCH        0x1
112#define TWS_REQ_TYPE_PASSTHRU         0x2
113#define TWS_REQ_TYPE_GETSET_PARAM     0x3
114#define TWS_REQ_TYPE_SCSI_IO          0x4
115
116/* Driver states */
117
118enum tws_states {
119    TWS_INIT=50,
120    TWS_UNINIT,
121    TWS_OFFLINE,
122    TWS_ONLINE,
123    TWS_RESET,
124};
125
126/* events */
127
128enum tws_events {
129    TWS_INIT_START=100,
130    TWS_INIT_COMPLETE,
131    TWS_UNINIT_START,
132    TWS_RESET_START,
133    TWS_RESET_COMPLETE,
134    TWS_SCAN_FAILURE,
135};
136
137enum tws_req_flags {
138    TWS_DIR_UNKNOWN = 0x1,
139    TWS_DIR_IN = 0x2,
140    TWS_DIR_OUT = 0x4,
141    TWS_DIR_NONE = 0x8,
142    TWS_DATA_CCB = 0x10,
143};
144
145enum tws_intrs {
146     TWS_INTx,
147     TWS_MSI,
148     TWS_MSIX,
149};
150
151struct tws_msix_info {
152    int tbl_res_id;
153    bus_space_tag_t tbl_tag;
154    bus_space_handle_t tbl_handle;
155    struct resource *tbl_res;
156};
157
158struct tws_ioctl_lock {
159    u_int32_t       lock;
160    time_t          timeout;
161};
162
163
164#define TWS_TRACE_FNAME_LEN  10
165#define TWS_TRACE_FUNC_LEN   15
166#define TWS_TRACE_DESC_LEN   10
167struct tws_trace_rec {
168    struct timespec ts;
169    char fname[TWS_TRACE_FNAME_LEN];
170    char func[TWS_TRACE_FUNC_LEN];
171    int linenum;
172    char desc[TWS_TRACE_DESC_LEN];
173    u_int64_t val1;
174    u_int64_t val2;
175};
176
177struct tws_circular_q {
178    volatile int16_t head;
179    volatile int16_t tail;
180    u_int16_t depth;
181    u_int8_t  overflow;
182    void *    q;
183};
184
185
186
187struct tws_stats {
188    u_int64_t reqs_in;
189    u_int64_t reqs_out;
190    u_int64_t reqs_errored;
191    u_int64_t spurios_intrs;
192    u_int64_t num_intrs;
193    u_int64_t num_aens;
194    u_int64_t ioctls;
195    u_int64_t scsi_ios;
196};
197
198struct tws_init_connect_info {
199    u_int16_t     working_srl;
200    u_int16_t     working_branch;
201    u_int16_t     working_build;
202    u_int16_t     fw_on_ctlr_srl;
203    u_int16_t     fw_on_ctlr_branch;
204    u_int16_t     fw_on_ctlr_build;
205
206};
207
208
209/* ------------ boolean types ------------------- */
210
211#ifndef __bool_true_false_are_defined
212typedef enum _boolean { false, true } boolean;
213#else
214#define	boolean		bool
215#endif
216enum err { SUCCESS, FAILURE };
217
218/* ----------- per instance data ---------------- */
219
220/* The softc holds our per-instance data. */
221struct tws_softc {
222    device_t    tws_dev;                  /* bus device */
223    struct cdev *tws_cdev;                /* controller device */
224    u_int32_t   device_id;                /* device id */
225    u_int32_t   subvendor_id;             /* device id */
226    u_int32_t   subdevice_id;             /* device id */
227    u_int8_t    tws_state;                /* driver state */
228    u_int8_t    tws_prev_state;           /* driver prev state */
229    struct sysctl_ctx_list tws_clist;     /* sysctl context */
230    struct sysctl_oid *tws_oidp;          /* sysctl context */
231    struct resource *reg_res;             /* register interface window */
232    struct resource *mfa_res;             /* mfa interface window */
233    int reg_res_id;                       /* register resource id */
234    int mfa_res_id;                       /* register resource id */
235    bus_space_handle_t bus_handle;        /* bus space handle */
236    bus_space_handle_t bus_mfa_handle;     /* bus space handle */
237    bus_space_tag_t bus_tag;              /* bus space tag */
238    bus_space_tag_t bus_mfa_tag;          /* bus space tag for mfa's */
239    u_int64_t mfa_base;                   /* mfa base address */
240    struct resource *irq_res[TWS_MAX_IRQS];/* interrupt resource */
241    int irq_res_id[TWS_MAX_IRQS];         /* intr resource id */
242    void *intr_handle[TWS_MAX_IRQS];      /* interrupt handle */
243    int irqs;                             /* intrs used */
244    struct tws_msix_info msix;            /* msix info */
245    struct cam_sim *sim;                  /* sim for this controller */
246    struct cam_path *path;                /* Ctlr path to CAM */
247    struct mtx q_lock;                    /* queue lock */
248    struct mtx sim_lock;                  /* sim lock */
249    struct mtx gen_lock;                  /* general driver  lock */
250    struct mtx io_lock;                   /* IO  lock */
251    struct tws_ioctl_lock ioctl_lock;     /* ioctl lock */
252    u_int32_t seq_id;                     /* Sequence id */
253    struct tws_circular_q aen_q;          /* aen q */
254    struct tws_circular_q trace_q;        /* trace q */
255    struct tws_stats stats;               /* I/O stats */
256    struct tws_init_connect_info cinfo;   /* compatibility info */
257    boolean is64bit;                      /* True - 64bit else 32bit */
258    u_int8_t intr_type;                   /* Interrupt type used */
259    bus_dma_tag_t parent_tag;             /* parent DMA tag */
260    bus_dma_tag_t cmd_tag;                /* command DMA tag */
261    bus_dmamap_t cmd_map;                 /* command map */
262    void *dma_mem;                        /* pointer to dmable memory */
263    u_int64_t dma_mem_phys;               /* phy addr */
264    bus_dma_tag_t data_tag;               /* data DMA tag */
265    void *ioctl_data_mem;                 /* ioctl dmable memory */
266    bus_dmamap_t ioctl_data_map;          /* ioctl data map */
267    struct tws_request *reqs;             /* pointer to requests */
268    struct tws_sense *sense_bufs;         /* pointer to sense buffers */
269    boolean obfl_q_overrun;               /* OBFL overrun flag  */
270    union ccb *scan_ccb;                  /* pointer to a ccb */
271    struct tws_request *q_head[TWS_MAX_QS]; /* head pointers to q's */
272    struct tws_request *q_tail[TWS_MAX_QS]; /* tail pointers to q's */
273    struct callout stats_timer;
274};
275