2 * Copyright (c) 2004-07 Applied Micro Circuits Corporation.
3 * Copyright (c) 2004-05 Vinod Kashyap.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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.
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
27 * $FreeBSD: src/sys/dev/twa/tw_osl.h,v 1.9 2010/08/30 19:15:04 delphij Exp $
31 * AMCC'S 3ware driver for 9000 series storage controllers.
33 * Author: Vinod Kashyap
34 * Modifications by: Adam Radford
35 * Modifications by: Manjunath Ranganathaiah
46 * OS Layer internal macros, structures and functions.
50 #define TW_OSLI_DEVICE_NAME "3ware 9000 series Storage Controller"
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
59 #define TW_OSLI_DMA_BOUNDARY (1u << 31)
61 #define TW_OSLI_DMA_BOUNDARY ((bus_size_t)((uint64_t)1 << 32))
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 */
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
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 #define TW_OSLI_REQ_FLAGS_FAILED (1<<7) /* bus_dmamap_load() failed */
84 struct tw_osli_q_stats {
85 TW_UINT32 cur_len; /* current # of items in q */
86 TW_UINT32 max_len; /* max value reached by q_length */
88 #endif /* TW_OSL_DEBUG */
91 /* Queues of OSL internal request context packets. */
92 #define TW_OSLI_FREE_Q 0 /* free q */
93 #define TW_OSLI_BUSY_Q 1 /* q of reqs submitted to CL */
94 #define TW_OSLI_Q_COUNT 2 /* total number of queues */
96 /* Driver's request packet. */
97 struct tw_osli_req_context {
98 struct tw_cl_req_handle req_handle;/* tag to track req b/w OSL & CL */
99 struct lock ioctl_wake_timeout_lock_handle;/* non-spin lock used to detect ioctl timeout */
100 struct lock *ioctl_wake_timeout_lock;/* ptr to above lock */
101 struct twa_softc *ctlr; /* ptr to OSL's controller context */
102 TW_VOID *data; /* ptr to data being passed to CL */
103 TW_UINT32 length; /* length of buf being passed to CL */
104 TW_UINT64 deadline;/* request timeout (in absolute time) */
107 * ptr to, and length of data passed to us from above, in case a buffer
108 * copy was done due to non-compliance to alignment requirements
111 TW_UINT32 real_length;
113 TW_UINT32 state; /* request state */
114 TW_UINT32 flags; /* request flags */
116 /* error encountered before request submission to CL */
117 TW_UINT32 error_code;
119 /* ptr to orig req for use during callback */
122 struct tw_cl_link link; /* to link this request in a list */
123 bus_dmamap_t dma_map;/* DMA map for data */
124 struct tw_cl_req_packet req_pkt;/* req pkt understood by CL */
128 /* Per-controller structure. */
130 struct tw_cl_ctlr_handle ctlr_handle;
131 struct tw_osli_req_context *req_ctx_buf;
133 /* Controller state. */
139 TW_UINT32 sg_size_factor;
141 TW_VOID *non_dma_mem;
143 TW_UINT64 dma_mem_phys;
145 /* Request queues and arrays. */
146 struct tw_cl_link req_q_head[TW_OSLI_Q_COUNT];
148 struct task deferred_intr_callback;/* taskqueue function */
149 struct spinlock io_lock_handle;/* general purpose lock */
150 struct spinlock *io_lock;/* ptr to general purpose lock */
151 struct spinlock q_lock_handle; /* queue manipulation lock */
152 struct spinlock *q_lock;/* ptr to queue manipulation lock */
153 struct lock sim_lock_handle;/* sim lock shared with cam */
154 struct lock *sim_lock;/* ptr to sim lock */
156 struct callout watchdog_callout[2]; /* For command timout */
157 TW_UINT32 watchdog_index;
160 struct tw_osli_q_stats q_stats[TW_OSLI_Q_COUNT];/* queue statistics */
161 #endif /* TW_OSL_DEBUG */
163 device_t bus_dev; /* bus device */
164 struct cdev *ctrl_dev; /* control device */
165 struct resource *reg_res; /* register interface window */
166 TW_INT32 reg_res_id; /* register resource id */
167 bus_space_handle_t bus_handle; /* bus space handle */
168 bus_space_tag_t bus_tag; /* bus space tag */
169 bus_dma_tag_t parent_tag; /* parent DMA tag */
170 bus_dma_tag_t cmd_tag; /* DMA tag for CL's DMA'able mem */
171 bus_dma_tag_t dma_tag; /* data buffer DMA tag */
172 bus_dma_tag_t ioctl_tag; /* ioctl data buffer DMA tag */
173 bus_dmamap_t cmd_map; /* DMA map for CL's DMA'able mem */
174 bus_dmamap_t ioctl_map; /* DMA map for ioctl data buffers */
175 struct resource *irq_res; /* interrupt resource */
176 TW_INT32 irq_res_id; /* register resource id */
177 TW_VOID *intr_handle; /* interrupt handle */
179 struct sysctl_ctx_list sysctl_ctxt; /* sysctl context */
180 struct sysctl_oid *sysctl_tree; /* sysctl oid */
182 struct cam_sim *sim; /* sim for this controller */
183 struct cam_path *path; /* peripheral, path, tgt, lun
184 associated with this controller */
195 #define TW_OSLI_Q_INIT(sc, q_type) do { \
196 (sc)->q_stats[q_type].cur_len = 0; \
197 (sc)->q_stats[q_type].max_len = 0; \
201 #define TW_OSLI_Q_INSERT(sc, q_type) do { \
202 struct tw_osli_q_stats *q_stats = &((sc)->q_stats[q_type]); \
204 if (++(q_stats->cur_len) > q_stats->max_len) \
205 q_stats->max_len = q_stats->cur_len; \
209 #define TW_OSLI_Q_REMOVE(sc, q_type) \
210 (sc)->q_stats[q_type].cur_len--
213 #else /* TW_OSL_DEBUG */
215 #define TW_OSLI_Q_INIT(sc, q_index)
216 #define TW_OSLI_Q_INSERT(sc, q_index)
217 #define TW_OSLI_Q_REMOVE(sc, q_index)
219 #endif /* TW_OSL_DEBUG */
223 /* Initialize a queue of requests. */
224 static __inline TW_VOID
225 tw_osli_req_q_init(struct twa_softc *sc, TW_UINT8 q_type)
227 TW_CL_Q_INIT(&(sc->req_q_head[q_type]));
228 TW_OSLI_Q_INIT(sc, q_type);
233 /* Insert the given request at the head of the given queue (q_type). */
234 static __inline TW_VOID
235 tw_osli_req_q_insert_head(struct tw_osli_req_context *req, TW_UINT8 q_type)
237 spin_lock(req->ctlr->q_lock);
238 TW_CL_Q_INSERT_HEAD(&(req->ctlr->req_q_head[q_type]), &(req->link));
239 TW_OSLI_Q_INSERT(req->ctlr, q_type);
240 spin_unlock(req->ctlr->q_lock);
245 /* Insert the given request at the tail of the given queue (q_type). */
246 static __inline TW_VOID
247 tw_osli_req_q_insert_tail(struct tw_osli_req_context *req, TW_UINT8 q_type)
249 spin_lock(req->ctlr->q_lock);
250 TW_CL_Q_INSERT_TAIL(&(req->ctlr->req_q_head[q_type]), &(req->link));
251 TW_OSLI_Q_INSERT(req->ctlr, q_type);
252 spin_unlock(req->ctlr->q_lock);
257 /* Remove and return the request at the head of the given queue (q_type). */
258 static __inline struct tw_osli_req_context *
259 tw_osli_req_q_remove_head(struct twa_softc *sc, TW_UINT8 q_type)
261 struct tw_osli_req_context *req = NULL;
262 struct tw_cl_link *link;
264 spin_lock(sc->q_lock);
265 if ((link = TW_CL_Q_FIRST_ITEM(&(sc->req_q_head[q_type]))) !=
267 req = TW_CL_STRUCT_HEAD(link,
268 struct tw_osli_req_context, link);
269 TW_CL_Q_REMOVE_ITEM(&(sc->req_q_head[q_type]), &(req->link));
270 TW_OSLI_Q_REMOVE(sc, q_type);
272 spin_unlock(sc->q_lock);
278 /* Remove the given request from the given queue (q_type). */
279 static __inline TW_VOID
280 tw_osli_req_q_remove_item(struct tw_osli_req_context *req, TW_UINT8 q_type)
282 spin_lock(req->ctlr->q_lock);
283 TW_CL_Q_REMOVE_ITEM(&(req->ctlr->req_q_head[q_type]), &(req->link));
284 TW_OSLI_Q_REMOVE(req->ctlr, q_type);
285 spin_unlock(req->ctlr->q_lock);
292 extern TW_INT32 TW_DEBUG_LEVEL_FOR_OSL;
294 #define tw_osli_dbg_dprintf(dbg_level, sc, fmt, args...) \
295 if (dbg_level <= TW_DEBUG_LEVEL_FOR_OSL) \
296 device_printf(sc->bus_dev, "%s: " fmt "\n", \
300 #define tw_osli_dbg_printf(dbg_level, fmt, args...) \
301 if (dbg_level <= TW_DEBUG_LEVEL_FOR_OSL) \
302 kprintf("%s: " fmt "\n", __func__, ##args)
304 #else /* TW_OSL_DEBUG */
306 #define tw_osli_dbg_dprintf(dbg_level, sc, fmt, args...)
307 #define tw_osli_dbg_printf(dbg_level, fmt, args...)
309 #endif /* TW_OSL_DEBUG */
312 /* For regular printing. */
313 #define twa_printf(sc, fmt, args...) \
314 device_printf(((struct twa_softc *)(sc))->bus_dev, fmt, ##args)
316 /* For printing in the "consistent error reporting" format. */
317 #define tw_osli_printf(sc, err_specific_desc, args...) \
318 device_printf((sc)->bus_dev, \
319 "%s: (0x%02X: 0x%04X): %s: " err_specific_desc "\n", ##args)
323 #endif /* TW_OSL_H */