f6cb47650130ea2cf0cc35d89d9efab4f3865f25
[dragonfly.git] / sys / dev / disk / aic7xxx / aic_osm_lib.h
1 /*
2  * FreeBSD platform specific, shared driver option settings, data structures,
3  * function declarations and includes.
4  *
5  * Copyright (c) 1994-2001 Justin T. Gibbs.
6  * Copyright (c) 2001-2003 Adaptec Inc.
7  * All rights reserved.
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  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions, and the following disclaimer,
14  *    without modification.
15  * 2. The name of the author may not be used to endorse or promote products
16  *    derived from this software without specific prior written permission.
17  *
18  * Alternatively, this software may be distributed under the terms of the
19  * GNU Public License ("GPL").
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
25  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * $Id: //depot/aic7xxx/freebsd/dev/aic7xxx/aic_osm_lib.h#5 $
34  *
35  * $FreeBSD: src/sys/dev/aic7xxx/aic_osm_lib.h,v 1.2 2004/05/11 20:33:42 gibbs Exp $
36  * $DragonFly: src/sys/dev/disk/aic7xxx/aic_osm_lib.h,v 1.2 2007/07/06 01:42:34 pavalos Exp $
37  */
38
39 /******************************** OS Includes *********************************/
40 #if __FreeBSD_version >= 500000
41 #include <sys/mutex.h>
42 #endif
43
44 /*************************** Library Symbol Mapping ***************************/
45 #define AIC_LIB_ENTRY_CONCAT(x, prefix) prefix ## x
46 #define AIC_LIB_ENTRY_EXPAND(x, prefix) AIC_LIB_ENTRY_CONCAT(x, prefix)
47 #define AIC_LIB_ENTRY(x)                AIC_LIB_ENTRY_EXPAND(x, AIC_LIB_PREFIX)
48 #define AIC_CONST_ENTRY(x)              AIC_LIB_ENTRY_EXPAND(x,AIC_CONST_PREFIX)
49
50 #define aic_softc                       AIC_LIB_ENTRY(_softc)
51 #define aic_tailq                       AIC_LIB_ENTRY(_tailq)
52 #define aic_transinfo                   AIC_LIB_ENTRY(_transinfo)
53 #define aic_platform_data               AIC_LIB_ENTRY(_platform_data)
54 #define aic_devinfo                     AIC_LIB_ENTRY(_devinfo)
55 #define aic_lock                        AIC_LIB_ENTRY(_lock)
56 #define aic_unlock                      AIC_LIB_ENTRY(_unlock)
57 #define aic_callback_t                  AIC_LIB_ENTRY(_callback_t)
58 #define aic_platform_freeze_devq        AIC_LIB_ENTRY(_platform_freeze_devq)
59 #define aic_platform_abort_scbs         AIC_LIB_ENTRY(_platform_abort_scbs)
60 #define aic_platform_timeout            AIC_LIB_ENTRY(_platform_timeout)
61 #define aic_timeout                     AIC_LIB_ENTRY(_timeout)
62 #define aic_set_recoveryscb             AIC_LIB_ENTRY(_set_recoveryscb)
63 #define aic_spawn_recovery_thread       AIC_LIB_ENTRY(_spawn_recovery_thread)
64 #define aic_wakeup_recovery_thread      AIC_LIB_ENTRY(_wakeup_recovery_thread)
65 #define aic_terminate_recovery_thread \
66         AIC_LIB_ENTRY(_terminate_recovery_thread)
67 #define aic_recovery_thread             AIC_LIB_ENTRY(_recovery_thread)
68 #define aic_recover_commands            AIC_LIB_ENTRY(_recover_commands)
69
70 #define AIC_RESOURCE_SHORTAGE           AIC_CONST_ENTRY(_RESOURCE_SHORTAGE)
71 #define AIC_SHUTDOWN_RECOVERY           AIC_CONST_ENTRY(_SHUTDOWN_RECOVERY)
72
73 /********************************* Byte Order *********************************/
74 #if __FreeBSD_version >= 500000
75 #define aic_htobe16(x) htobe16(x)
76 #define aic_htobe32(x) htobe32(x)
77 #define aic_htobe64(x) htobe64(x)
78 #define aic_htole16(x) htole16(x)
79 #define aic_htole32(x) htole32(x)
80 #define aic_htole64(x) htole64(x)
81
82 #define aic_be16toh(x) be16toh(x)
83 #define aic_be32toh(x) be32toh(x)
84 #define aic_be64toh(x) be64toh(x)
85 #define aic_le16toh(x) le16toh(x)
86 #define aic_le32toh(x) le32toh(x)
87 #define aic_le64toh(x) le64toh(x)
88 #else
89 #define aic_htobe16(x) (x)
90 #define aic_htobe32(x) (x)
91 #define aic_htobe64(x) (x)
92 #define aic_htole16(x) (x)
93 #define aic_htole32(x) (x)
94 #define aic_htole64(x) (x)
95
96 #define aic_be16toh(x) (x)
97 #define aic_be32toh(x) (x)
98 #define aic_be64toh(x) (x)
99 #define aic_le16toh(x) (x)
100 #define aic_le32toh(x) (x)
101 #define aic_le64toh(x) (x)
102 #endif
103
104 /************************* Forward Declarations *******************************/
105 typedef device_t aic_dev_softc_t;
106 typedef union ccb *aic_io_ctx_t;
107 struct aic_softc;
108 struct scb;
109
110 /*************************** Timer DataStructures *****************************/
111 typedef struct callout aic_timer_t;
112
113 /****************************** Error Recovery ********************************/
114 void            aic_set_recoveryscb(struct aic_softc *aic, struct scb *scb);
115 timeout_t       aic_platform_timeout;
116 int             aic_spawn_recovery_thread(struct aic_softc *aic);
117 void            aic_terminate_recovery_thread(struct aic_softc *aic);
118
119 static __inline void    aic_wakeup_recovery_thread(struct aic_softc *aic);
120
121 static __inline void
122 aic_wakeup_recovery_thread(struct aic_softc *aic)
123 {
124         wakeup(aic);
125 }
126
127 /****************************** Kernel Threads ********************************/
128 #if __FreeBSD_version > 500005
129 #define aic_kthread_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \
130         kthread_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg)
131 #else
132 #define aic_kthread_create(func, farg, proc_ptr, flags, stackpgs, fmtstr, arg) \
133         kthread_create(func, farg, proc_ptr, fmtstr, arg)
134 #endif
135
136 /******************************* Bus Space/DMA ********************************/
137
138 #if __FreeBSD_version >= 501102
139 #define aic_dma_tag_create(aic, parent_tag, alignment, boundary,        \
140                            lowaddr, highaddr, filter, filterarg,        \
141                            maxsize, nsegments, maxsegsz, flags,         \
142                            dma_tagp)                                    \
143         bus_dma_tag_create(parent_tag, alignment, boundary,             \
144                            lowaddr, highaddr, filter, filterarg,        \
145                            maxsize, nsegments, maxsegsz, flags,         \
146                            busdma_lock_mutex, &Giant,                   \
147                            dma_tagp)
148 #else
149 #define aic_dma_tag_create(aic, parent_tag, alignment, boundary,        \
150                            lowaddr, highaddr, filter, filterarg,        \
151                            maxsize, nsegments, maxsegsz, flags,         \
152                            dma_tagp)                                    \
153         bus_dma_tag_create(parent_tag, alignment, boundary,             \
154                            lowaddr, highaddr, filter, filterarg,        \
155                            maxsize, nsegments, maxsegsz, flags,         \
156                            dma_tagp)
157 #endif
158
159 #define aic_dma_tag_destroy(aic, tag)                                   \
160         bus_dma_tag_destroy(tag)
161
162 #define aic_dmamem_alloc(aic, dmat, vaddr, flags, mapp)                 \
163         bus_dmamem_alloc(dmat, vaddr, flags, mapp)
164
165 #define aic_dmamem_free(aic, dmat, vaddr, map)                          \
166         bus_dmamem_free(dmat, vaddr, map)
167
168 #define aic_dmamap_create(aic, tag, flags, mapp)                        \
169         bus_dmamap_create(tag, flags, mapp)
170
171 #define aic_dmamap_destroy(aic, tag, map)                               \
172         bus_dmamap_destroy(tag, map)
173
174 #define aic_dmamap_load(aic, dmat, map, addr, buflen, callback,         \
175                         callback_arg, flags)                            \
176         bus_dmamap_load(dmat, map, addr, buflen, callback, callback_arg, flags)
177
178 #define aic_dmamap_unload(aic, tag, map)                                \
179         bus_dmamap_unload(tag, map)
180
181 /* XXX Need to update Bus DMA for partial map syncs */
182 #define aic_dmamap_sync(aic, dma_tag, dmamap, offset, len, op)          \
183         bus_dmamap_sync(dma_tag, dmamap, op)
184
185 /***************************** Core Includes **********************************/
186 #include AIC_CORE_INCLUDE
187
188 /***************************** Timer Facilities *******************************/
189 #if __FreeBSD_version >= 500000
190 #define aic_timer_init(timer) callout_init(timer, /*mpsafe*/0)
191 #else
192 #define aic_timer_init callout_init
193 #endif
194 #define aic_timer_stop callout_stop
195
196 static __inline void aic_timer_reset(aic_timer_t *, u_int,
197                                      aic_callback_t *, void *);
198 static __inline u_int aic_get_timeout(struct scb *);
199 static __inline void aic_scb_timer_reset(struct scb *, u_int);
200
201 static __inline void
202 aic_timer_reset(aic_timer_t *timer, u_int usec, aic_callback_t *func, void *arg)
203 {
204         callout_reset(timer, (usec * hz)/1000000, func, arg);
205 }
206
207 static __inline u_int
208 aic_get_timeout(struct scb *scb)
209 {
210         return (scb->io_ctx->ccb_h.timeout * 1000);
211 }
212
213 static __inline void
214 aic_scb_timer_reset(struct scb *scb, u_int usec)
215 {
216         callout_reset(&scb->io_ctx->ccb_h.timeout_ch, (usec * hz)/1000000,
217                 aic_platform_timeout, scb);
218 }
219
220 static __inline void
221 aic_scb_timer_start(struct scb *scb)
222 {
223         
224         if (scb->io_ctx->ccb_h.timeout != CAM_TIME_INFINITY) {
225                 uint64_t time;
226
227                 time = scb->io_ctx->ccb_h.timeout;
228                 time *= hz;
229                 time /= 1000;
230                 callout_reset(&scb->io_ctx->ccb_h.timeout_ch, time,
231                     aic_platform_timeout, scb);
232         }
233 }
234
235 /************************** Transaction Operations ****************************/
236 static __inline void aic_set_transaction_status(struct scb *, uint32_t);
237 static __inline void aic_set_scsi_status(struct scb *, uint32_t);
238 static __inline uint32_t aic_get_transaction_status(struct scb *);
239 static __inline uint32_t aic_get_scsi_status(struct scb *);
240 static __inline void aic_set_transaction_tag(struct scb *, int, u_int);
241 static __inline u_long aic_get_transfer_length(struct scb *);
242 static __inline int aic_get_transfer_dir(struct scb *);
243 static __inline void aic_set_residual(struct scb *, u_long);
244 static __inline void aic_set_sense_residual(struct scb *, u_long);
245 static __inline u_long aic_get_residual(struct scb *);
246 static __inline int aic_perform_autosense(struct scb *);
247 static __inline uint32_t aic_get_sense_bufsize(struct aic_softc*, struct scb*);
248 static __inline void aic_freeze_ccb(union ccb *ccb);
249 static __inline void aic_freeze_scb(struct scb *scb);
250 static __inline void aic_platform_freeze_devq(struct aic_softc *, struct scb *);
251 static __inline int  aic_platform_abort_scbs(struct aic_softc *aic, int target,
252                                              char channel, int lun, u_int tag,
253                                              role_t role, uint32_t status);
254
255 static __inline
256 void aic_set_transaction_status(struct scb *scb, uint32_t status)
257 {
258         scb->io_ctx->ccb_h.status &= ~CAM_STATUS_MASK;
259         scb->io_ctx->ccb_h.status |= status;
260 }
261
262 static __inline
263 void aic_set_scsi_status(struct scb *scb, uint32_t status)
264 {
265         scb->io_ctx->csio.scsi_status = status;
266 }
267
268 static __inline
269 uint32_t aic_get_transaction_status(struct scb *scb)
270 {
271         return (scb->io_ctx->ccb_h.status & CAM_STATUS_MASK);
272 }
273
274 static __inline
275 uint32_t aic_get_scsi_status(struct scb *scb)
276 {
277         return (scb->io_ctx->csio.scsi_status);
278 }
279
280 static __inline
281 void aic_set_transaction_tag(struct scb *scb, int enabled, u_int type)
282 {
283         scb->io_ctx->csio.tag_action = type;
284         if (enabled)
285                 scb->io_ctx->ccb_h.flags |= CAM_TAG_ACTION_VALID;
286         else
287                 scb->io_ctx->ccb_h.flags &= ~CAM_TAG_ACTION_VALID;
288 }
289
290 static __inline
291 u_long aic_get_transfer_length(struct scb *scb)
292 {
293         return (scb->io_ctx->csio.dxfer_len);
294 }
295
296 static __inline
297 int aic_get_transfer_dir(struct scb *scb)
298 {
299         return (scb->io_ctx->ccb_h.flags & CAM_DIR_MASK);
300 }
301
302 static __inline
303 void aic_set_residual(struct scb *scb, u_long resid)
304 {
305         scb->io_ctx->csio.resid = resid;
306 }
307
308 static __inline
309 void aic_set_sense_residual(struct scb *scb, u_long resid)
310 {
311         scb->io_ctx->csio.sense_resid = resid;
312 }
313
314 static __inline
315 u_long aic_get_residual(struct scb *scb)
316 {
317         return (scb->io_ctx->csio.resid);
318 }
319
320 static __inline
321 int aic_perform_autosense(struct scb *scb)
322 {
323         return (!(scb->io_ctx->ccb_h.flags & CAM_DIS_AUTOSENSE));
324 }
325
326 static __inline uint32_t
327 aic_get_sense_bufsize(struct aic_softc *aic, struct scb *scb)
328 {
329         return (sizeof(struct scsi_sense_data));
330 }
331
332 static __inline void
333 aic_freeze_ccb(union ccb *ccb)
334 {
335         if ((ccb->ccb_h.status & CAM_DEV_QFRZN) == 0) {
336                 ccb->ccb_h.status |= CAM_DEV_QFRZN;
337                 xpt_freeze_devq(ccb->ccb_h.path, /*count*/1);
338         }
339 }
340
341 static __inline void
342 aic_freeze_scb(struct scb *scb)
343 {
344         aic_freeze_ccb(scb->io_ctx);
345 }
346
347 static __inline void
348 aic_platform_freeze_devq(struct aic_softc *aic, struct scb *scb)
349 {
350         /* Nothing to do here for FreeBSD */
351 }
352
353 static __inline int
354 aic_platform_abort_scbs(struct aic_softc *aic, int target,
355                         char channel, int lun, u_int tag,
356                         role_t role, uint32_t status)
357 {
358         /* Nothing to do here for FreeBSD */
359         return (0);
360 }
361
362 static __inline void
363 aic_platform_scb_free(struct aic_softc *aic, struct scb *scb)
364 {
365         /* What do we do to generically handle driver resource shortages??? */
366         if ((aic->flags & AIC_RESOURCE_SHORTAGE) != 0
367          && scb->io_ctx != NULL
368          && (scb->io_ctx->ccb_h.status & CAM_RELEASE_SIMQ) == 0) {
369                 scb->io_ctx->ccb_h.status |= CAM_RELEASE_SIMQ;
370                 aic->flags &= ~AIC_RESOURCE_SHORTAGE;
371         }
372         scb->io_ctx = NULL;
373 }
374
375 /****************************** OS Primitives *********************************/
376 #define aic_delay DELAY
377
378 /********************************** PCI ***************************************/
379 #ifdef AIC_PCI_CONFIG
380 static __inline uint32_t aic_pci_read_config(aic_dev_softc_t pci,
381                                              int reg, int width);
382 static __inline void     aic_pci_write_config(aic_dev_softc_t pci,
383                                               int reg, uint32_t value,
384                                               int width);
385 static __inline int      aic_get_pci_function(aic_dev_softc_t);
386 static __inline int      aic_get_pci_slot(aic_dev_softc_t);
387 static __inline int      aic_get_pci_bus(aic_dev_softc_t);
388
389
390 static __inline uint32_t
391 aic_pci_read_config(aic_dev_softc_t pci, int reg, int width)
392 {
393         return (pci_read_config(pci, reg, width));
394 }
395
396 static __inline void
397 aic_pci_write_config(aic_dev_softc_t pci, int reg, uint32_t value, int width)
398 {
399         pci_write_config(pci, reg, value, width);
400 }
401
402 static __inline int
403 aic_get_pci_function(aic_dev_softc_t pci)
404 {
405         return (pci_get_function(pci));
406 }
407
408 static __inline int
409 aic_get_pci_slot(aic_dev_softc_t pci)
410 {
411         return (pci_get_slot(pci));
412 }
413
414 static __inline int
415 aic_get_pci_bus(aic_dev_softc_t pci)
416 {
417         return (pci_get_bus(pci));
418 }
419
420 typedef enum
421 {
422         AIC_POWER_STATE_D0 = PCI_POWERSTATE_D0,
423         AIC_POWER_STATE_D1 = PCI_POWERSTATE_D1,
424         AIC_POWER_STATE_D2 = PCI_POWERSTATE_D2,
425         AIC_POWER_STATE_D3 = PCI_POWERSTATE_D3
426 } aic_power_state;
427
428 static __inline int aic_power_state_change(struct aic_softc *aic,
429                                            aic_power_state new_state);
430
431 static __inline int
432 aic_power_state_change(struct aic_softc *aic, aic_power_state new_state)
433 {
434         return (pci_set_powerstate(aic->dev_softc, new_state));
435 }
436 #endif