144953a3a87798c81749a775131d688f172f0138
[dragonfly.git] / sys / dev / raid / twa / tw_osl.h
1 /*
2  * Copyright (c) 2004-07 Applied Micro Circuits Corporation.
3  * Copyright (c) 2004-05 Vinod Kashyap.
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
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  *      $FreeBSD: src/sys/dev/twa/tw_osl.h,v 1.8 2010/06/09 21:40:38 delphij Exp $
28  */
29
30 /*
31  * AMCC'S 3ware driver for 9000 series storage controllers.
32  *
33  * Author: Vinod Kashyap
34  * Modifications by: Adam Radford
35  * Modifications by: Manjunath Ranganathaiah
36  */
37
38
39
40 #ifndef TW_OSL_H
41
42 #define TW_OSL_H
43
44
45 /*
46  * OS Layer internal macros, structures and functions.
47  */
48
49
50 #define TW_OSLI_DEVICE_NAME             "3ware 9000 series Storage Controller"
51
52 #define TW_OSLI_MALLOC_CLASS            M_TWA
53 #define TW_OSLI_MAX_NUM_REQUESTS        TW_CL_MAX_SIMULTANEOUS_REQUESTS
54 /* Reserve two command packets.  One for ioctls and one for AENs */
55 #define TW_OSLI_MAX_NUM_IOS             (TW_OSLI_MAX_NUM_REQUESTS - 2)
56 #define TW_OSLI_MAX_NUM_AENS            0x100
57
58 #ifdef PAE
59 #define TW_OSLI_DMA_BOUNDARY            (1u << 31)
60 #else
61 #define TW_OSLI_DMA_BOUNDARY            ((bus_size_t)((uint64_t)1 << 32))
62 #endif
63
64 /* Possible values of req->state. */
65 #define TW_OSLI_REQ_STATE_INIT          0x0     /* being initialized */
66 #define TW_OSLI_REQ_STATE_BUSY          0x1     /* submitted to CL */
67 #define TW_OSLI_REQ_STATE_PENDING       0x2     /* in pending queue */
68 #define TW_OSLI_REQ_STATE_COMPLETE      0x3     /* completed by CL */
69
70 /* Possible values of req->flags. */
71 #define TW_OSLI_REQ_FLAGS_DATA_IN       (1<<0)  /* read request */
72 #define TW_OSLI_REQ_FLAGS_DATA_OUT      (1<<1)  /* write request */
73 #define TW_OSLI_REQ_FLAGS_DATA_COPY_NEEDED (1<<2)/* data in ccb is misaligned,
74                                         have to copy to/from private buffer */
75 #define TW_OSLI_REQ_FLAGS_MAPPED        (1<<3)  /* request has been mapped */
76 #define TW_OSLI_REQ_FLAGS_IN_PROGRESS   (1<<4)  /* bus_dmamap_load returned
77                                                 EINPROGRESS */
78 #define TW_OSLI_REQ_FLAGS_PASSTHRU      (1<<5)  /* pass through request */
79 #define TW_OSLI_REQ_FLAGS_SLEEPING      (1<<6)  /* owner sleeping on this cmd */
80
81
82 #ifdef TW_OSL_DEBUG
83 struct tw_osli_q_stats {
84         TW_UINT32       cur_len;        /* current # of items in q */
85         TW_UINT32       max_len;        /* max value reached by q_length */
86 };
87 #endif /* TW_OSL_DEBUG */
88
89
90 /* Queues of OSL internal request context packets. */
91 #define TW_OSLI_FREE_Q          0       /* free q */
92 #define TW_OSLI_BUSY_Q          1       /* q of reqs submitted to CL */
93 #define TW_OSLI_Q_COUNT         2       /* total number of queues */
94
95 /* Driver's request packet. */
96 struct tw_osli_req_context {
97         struct tw_cl_req_handle req_handle;/* tag to track req b/w OSL & CL */
98         struct lock             ioctl_wake_timeout_lock_handle;/* non-spin lock used to detect ioctl timeout */
99         struct lock             *ioctl_wake_timeout_lock;/* ptr to above lock */
100         struct twa_softc        *ctlr;  /* ptr to OSL's controller context */
101         TW_VOID                 *data;  /* ptr to data being passed to CL */
102         TW_UINT32               length; /* length of buf being passed to CL */
103
104         /*
105          * ptr to, and length of data passed to us from above, in case a buffer
106          * copy was done due to non-compliance to alignment requirements
107          */
108         TW_VOID                 *real_data;
109         TW_UINT32               real_length;
110
111         TW_UINT32               state;  /* request state */
112         TW_UINT32               flags;  /* request flags */
113
114         /* error encountered before request submission to CL */
115         TW_UINT32               error_code;
116
117         /* ptr to orig req for use during callback */
118         TW_VOID                 *orig_req;
119
120         struct tw_cl_link       link;   /* to link this request in a list */
121         bus_dmamap_t            dma_map;/* DMA map for data */
122         struct tw_cl_req_packet req_pkt;/* req pkt understood by CL */
123 };
124
125
126 /* Per-controller structure. */
127 struct twa_softc {
128         struct tw_cl_ctlr_handle        ctlr_handle;
129         struct tw_osli_req_context      *req_ctx_buf;
130
131         /* Controller state. */
132         TW_UINT8                open;
133         TW_UINT32               flags;
134
135         TW_INT32                device_id;
136         TW_UINT32               alignment;
137         TW_UINT32               sg_size_factor;
138
139         TW_VOID                 *non_dma_mem;
140         TW_VOID                 *dma_mem;
141         TW_UINT64               dma_mem_phys;
142
143         /* Request queues and arrays. */
144         struct tw_cl_link       req_q_head[TW_OSLI_Q_COUNT];
145
146         struct task             deferred_intr_callback;/* taskqueue function */
147         struct spinlock         io_lock_handle;/* general purpose lock */
148         struct spinlock         *io_lock;/* ptr to general purpose lock */
149         struct spinlock         q_lock_handle;  /* queue manipulation lock */
150         struct spinlock         *q_lock;/* ptr to queue manipulation lock */
151         struct lock             sim_lock_handle;/* sim lock shared with cam */
152         struct lock             *sim_lock;/* ptr to sim lock */
153
154 #ifdef TW_OSL_DEBUG
155         struct tw_osli_q_stats  q_stats[TW_OSLI_Q_COUNT];/* queue statistics */
156 #endif /* TW_OSL_DEBUG */
157
158         device_t                bus_dev;        /* bus device */
159         struct cdev             *ctrl_dev;      /* control device */
160         struct resource         *reg_res;       /* register interface window */
161         TW_INT32                reg_res_id;     /* register resource id */
162         bus_space_handle_t      bus_handle;     /* bus space handle */
163         bus_space_tag_t         bus_tag;        /* bus space tag */
164         bus_dma_tag_t           parent_tag;     /* parent DMA tag */
165         bus_dma_tag_t           cmd_tag; /* DMA tag for CL's DMA'able mem */
166         bus_dma_tag_t           dma_tag; /* data buffer DMA tag */
167         bus_dma_tag_t           ioctl_tag; /* ioctl data buffer DMA tag */
168         bus_dmamap_t            cmd_map; /* DMA map for CL's DMA'able mem */
169         bus_dmamap_t            ioctl_map; /* DMA map for ioctl data buffers */
170         struct resource         *irq_res;       /* interrupt resource */
171         TW_INT32                irq_res_id;     /* register resource id */
172         TW_VOID                 *intr_handle;   /* interrupt handle */
173
174         struct sysctl_ctx_list  sysctl_ctxt;    /* sysctl context */
175         struct sysctl_oid       *sysctl_tree;   /* sysctl oid */
176
177         struct cam_sim          *sim;   /* sim for this controller */
178         struct cam_path         *path;  /* peripheral, path, tgt, lun
179                                         associated with this controller */
180 };
181
182
183
184 /*
185  * Queue primitives.
186  */
187
188 #ifdef TW_OSL_DEBUG
189
190 #define TW_OSLI_Q_INIT(sc, q_type)      do {                            \
191         (sc)->q_stats[q_type].cur_len = 0;                              \
192         (sc)->q_stats[q_type].max_len = 0;                              \
193 } while(0)
194
195
196 #define TW_OSLI_Q_INSERT(sc, q_type)    do {                            \
197         struct tw_osli_q_stats *q_stats = &((sc)->q_stats[q_type]);     \
198                                                                         \
199         if (++(q_stats->cur_len) > q_stats->max_len)                    \
200                 q_stats->max_len = q_stats->cur_len;                    \
201 } while(0)
202
203
204 #define TW_OSLI_Q_REMOVE(sc, q_type)                                    \
205         (sc)->q_stats[q_type].cur_len--
206
207
208 #else /* TW_OSL_DEBUG */
209
210 #define TW_OSLI_Q_INIT(sc, q_index)
211 #define TW_OSLI_Q_INSERT(sc, q_index)
212 #define TW_OSLI_Q_REMOVE(sc, q_index)
213
214 #endif /* TW_OSL_DEBUG */
215
216
217
218 /* Initialize a queue of requests. */
219 static __inline TW_VOID
220 tw_osli_req_q_init(struct twa_softc *sc, TW_UINT8 q_type)
221 {
222         TW_CL_Q_INIT(&(sc->req_q_head[q_type]));
223         TW_OSLI_Q_INIT(sc, q_type);
224 }
225
226
227
228 /* Insert the given request at the head of the given queue (q_type). */
229 static __inline TW_VOID
230 tw_osli_req_q_insert_head(struct tw_osli_req_context *req, TW_UINT8 q_type)
231 {
232         spin_lock(req->ctlr->q_lock);
233         TW_CL_Q_INSERT_HEAD(&(req->ctlr->req_q_head[q_type]), &(req->link));
234         TW_OSLI_Q_INSERT(req->ctlr, q_type);
235         spin_unlock(req->ctlr->q_lock);
236 }
237
238
239
240 /* Insert the given request at the tail of the given queue (q_type). */
241 static __inline TW_VOID
242 tw_osli_req_q_insert_tail(struct tw_osli_req_context *req, TW_UINT8 q_type)
243 {
244         spin_lock(req->ctlr->q_lock);
245         TW_CL_Q_INSERT_TAIL(&(req->ctlr->req_q_head[q_type]), &(req->link));
246         TW_OSLI_Q_INSERT(req->ctlr, q_type);
247         spin_unlock(req->ctlr->q_lock);
248 }
249
250
251
252 /* Remove and return the request at the head of the given queue (q_type). */
253 static __inline struct tw_osli_req_context *
254 tw_osli_req_q_remove_head(struct twa_softc *sc, TW_UINT8 q_type)
255 {
256         struct tw_osli_req_context      *req = NULL;
257         struct tw_cl_link               *link;
258
259         spin_lock(sc->q_lock);
260         if ((link = TW_CL_Q_FIRST_ITEM(&(sc->req_q_head[q_type]))) !=
261                 TW_CL_NULL) {
262                 req = TW_CL_STRUCT_HEAD(link,
263                         struct tw_osli_req_context, link);
264                 TW_CL_Q_REMOVE_ITEM(&(sc->req_q_head[q_type]), &(req->link));
265                 TW_OSLI_Q_REMOVE(sc, q_type);
266         }
267         spin_unlock(sc->q_lock);
268         return(req);
269 }
270
271
272
273 /* Remove the given request from the given queue (q_type). */
274 static __inline TW_VOID
275 tw_osli_req_q_remove_item(struct tw_osli_req_context *req, TW_UINT8 q_type)
276 {
277         spin_lock(req->ctlr->q_lock);
278         TW_CL_Q_REMOVE_ITEM(&(req->ctlr->req_q_head[q_type]), &(req->link));
279         TW_OSLI_Q_REMOVE(req->ctlr, q_type);
280         spin_unlock(req->ctlr->q_lock);
281 }
282
283
284
285 #ifdef TW_OSL_DEBUG
286
287 extern TW_INT32 TW_DEBUG_LEVEL_FOR_OSL;
288
289 #define tw_osli_dbg_dprintf(dbg_level, sc, fmt, args...)                \
290         if (dbg_level <= TW_DEBUG_LEVEL_FOR_OSL)                        \
291                 device_printf(sc->bus_dev, "%s: " fmt "\n",             \
292                         __func__, ##args)
293
294
295 #define tw_osli_dbg_printf(dbg_level, fmt, args...)                     \
296         if (dbg_level <= TW_DEBUG_LEVEL_FOR_OSL)                        \
297                 kprintf("%s: " fmt "\n", __func__, ##args)
298
299 #else /* TW_OSL_DEBUG */
300
301 #define tw_osli_dbg_dprintf(dbg_level, sc, fmt, args...)
302 #define tw_osli_dbg_printf(dbg_level, fmt, args...)
303
304 #endif /* TW_OSL_DEBUG */
305
306
307 /* For regular printing. */
308 #define twa_printf(sc, fmt, args...)                                    \
309         device_printf(((struct twa_softc *)(sc))->bus_dev, fmt, ##args)
310
311 /* For printing in the "consistent error reporting" format. */
312 #define tw_osli_printf(sc, err_specific_desc, args...)                  \
313         device_printf((sc)->bus_dev,                                    \
314                 "%s: (0x%02X: 0x%04X): %s: " err_specific_desc "\n", ##args)
315
316
317
318 #endif /* TW_OSL_H */