270ac471b6a1db8c8a816292eec6b5102ac172ff
[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.3 2004/08/17 00:14:31 gibbs Exp $
36  * $DragonFly: src/sys/dev/disk/aic7xxx/aic_osm_lib.h,v 1.3 2007/07/06 04:56:22 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 (AIC_SCB_DATA(scb->aic_softc)->recovery_scbs == 0
225          && scb->io_ctx->ccb_h.timeout != CAM_TIME_INFINITY) {
226                 uint64_t time;
227
228                 time = scb->io_ctx->ccb_h.timeout;
229                 time *= hz;
230                 time /= 1000;
231                 callout_reset(&scb->io_ctx->ccb_h.timeout_ch, time,
232                     aic_platform_timeout, scb);
233         }
234 }
235
236 /************************** Transaction Operations ****************************/
237 static __inline void aic_set_transaction_status(struct scb *, uint32_t);
238 static __inline void aic_set_scsi_status(struct scb *, uint32_t);
239 static __inline uint32_t aic_get_transaction_status(struct scb *);
240 static __inline uint32_t aic_get_scsi_status(struct scb *);
241 static __inline void aic_set_transaction_tag(struct scb *, int, u_int);
242 static __inline u_long aic_get_transfer_length(struct scb *);
243 static __inline int aic_get_transfer_dir(struct scb *);
244 static __inline void aic_set_residual(struct scb *, u_long);
245 static __inline void aic_set_sense_residual(struct scb *, u_long);
246 static __inline u_long aic_get_residual(struct scb *);
247 static __inline int aic_perform_autosense(struct scb *);
248 static __inline uint32_t aic_get_sense_bufsize(struct aic_softc*, struct scb*);
249 static __inline void aic_freeze_ccb(union ccb *ccb);
250 static __inline void aic_freeze_scb(struct scb *scb);
251 static __inline void aic_platform_freeze_devq(struct aic_softc *, struct scb *);
252 static __inline int  aic_platform_abort_scbs(struct aic_softc *aic, int target,
253                                              char channel, int lun, u_int tag,
254                                              role_t role, uint32_t status);
255
256 static __inline
257 void aic_set_transaction_status(struct scb *scb, uint32_t status)
258 {
259         scb->io_ctx->ccb_h.status &= ~CAM_STATUS_MASK;
260         scb->io_ctx->ccb_h.status |= status;
261 }
262
263 static __inline
264 void aic_set_scsi_status(struct scb *scb, uint32_t status)
265 {
266         scb->io_ctx->csio.scsi_status = status;
267 }
268
269 static __inline
270 uint32_t aic_get_transaction_status(struct scb *scb)
271 {
272         return (scb->io_ctx->ccb_h.status & CAM_STATUS_MASK);
273 }
274
275 static __inline
276 uint32_t aic_get_scsi_status(struct scb *scb)
277 {
278         return (scb->io_ctx->csio.scsi_status);
279 }
280
281 static __inline
282 void aic_set_transaction_tag(struct scb *scb, int enabled, u_int type)
283 {
284         scb->io_ctx->csio.tag_action = type;
285         if (enabled)
286                 scb->io_ctx->ccb_h.flags |= CAM_TAG_ACTION_VALID;
287         else
288                 scb->io_ctx->ccb_h.flags &= ~CAM_TAG_ACTION_VALID;
289 }
290
291 static __inline
292 u_long aic_get_transfer_length(struct scb *scb)
293 {
294         return (scb->io_ctx->csio.dxfer_len);
295 }
296
297 static __inline
298 int aic_get_transfer_dir(struct scb *scb)
299 {
300         return (scb->io_ctx->ccb_h.flags & CAM_DIR_MASK);
301 }
302
303 static __inline
304 void aic_set_residual(struct scb *scb, u_long resid)
305 {
306         scb->io_ctx->csio.resid = resid;
307 }
308
309 static __inline
310 void aic_set_sense_residual(struct scb *scb, u_long resid)
311 {
312         scb->io_ctx->csio.sense_resid = resid;
313 }
314
315 static __inline
316 u_long aic_get_residual(struct scb *scb)
317 {
318         return (scb->io_ctx->csio.resid);
319 }
320
321 static __inline
322 int aic_perform_autosense(struct scb *scb)
323 {
324         return (!(scb->io_ctx->ccb_h.flags & CAM_DIS_AUTOSENSE));
325 }
326
327 static __inline uint32_t
328 aic_get_sense_bufsize(struct aic_softc *aic, struct scb *scb)
329 {
330         return (sizeof(struct scsi_sense_data));
331 }
332
333 static __inline void
334 aic_freeze_ccb(union ccb *ccb)
335 {
336         if ((ccb->ccb_h.status & CAM_DEV_QFRZN) == 0) {
337                 ccb->ccb_h.status |= CAM_DEV_QFRZN;
338                 xpt_freeze_devq(ccb->ccb_h.path, /*count*/1);
339         }
340 }
341
342 static __inline void
343 aic_freeze_scb(struct scb *scb)
344 {
345         aic_freeze_ccb(scb->io_ctx);
346 }
347
348 static __inline void
349 aic_platform_freeze_devq(struct aic_softc *aic, struct scb *scb)
350 {
351         /* Nothing to do here for FreeBSD */
352 }
353
354 static __inline int
355 aic_platform_abort_scbs(struct aic_softc *aic, int target,
356                         char channel, int lun, u_int tag,
357                         role_t role, uint32_t status)
358 {
359         /* Nothing to do here for FreeBSD */
360         return (0);
361 }
362
363 static __inline void
364 aic_platform_scb_free(struct aic_softc *aic, struct scb *scb)
365 {
366         /* What do we do to generically handle driver resource shortages??? */
367         if ((aic->flags & AIC_RESOURCE_SHORTAGE) != 0
368          && scb->io_ctx != NULL
369          && (scb->io_ctx->ccb_h.status & CAM_RELEASE_SIMQ) == 0) {
370                 scb->io_ctx->ccb_h.status |= CAM_RELEASE_SIMQ;
371                 aic->flags &= ~AIC_RESOURCE_SHORTAGE;
372         }
373         scb->io_ctx = NULL;
374 }
375
376 /****************************** OS Primitives *********************************/
377 #define aic_delay DELAY
378
379 /********************************** PCI ***************************************/
380 #ifdef AIC_PCI_CONFIG
381 static __inline uint32_t aic_pci_read_config(aic_dev_softc_t pci,
382                                              int reg, int width);
383 static __inline void     aic_pci_write_config(aic_dev_softc_t pci,
384                                               int reg, uint32_t value,
385                                               int width);
386 static __inline int      aic_get_pci_function(aic_dev_softc_t);
387 static __inline int      aic_get_pci_slot(aic_dev_softc_t);
388 static __inline int      aic_get_pci_bus(aic_dev_softc_t);
389
390
391 static __inline uint32_t
392 aic_pci_read_config(aic_dev_softc_t pci, int reg, int width)
393 {
394         return (pci_read_config(pci, reg, width));
395 }
396
397 static __inline void
398 aic_pci_write_config(aic_dev_softc_t pci, int reg, uint32_t value, int width)
399 {
400         pci_write_config(pci, reg, value, width);
401 }
402
403 static __inline int
404 aic_get_pci_function(aic_dev_softc_t pci)
405 {
406         return (pci_get_function(pci));
407 }
408
409 static __inline int
410 aic_get_pci_slot(aic_dev_softc_t pci)
411 {
412         return (pci_get_slot(pci));
413 }
414
415 static __inline int
416 aic_get_pci_bus(aic_dev_softc_t pci)
417 {
418         return (pci_get_bus(pci));
419 }
420
421 typedef enum
422 {
423         AIC_POWER_STATE_D0 = PCI_POWERSTATE_D0,
424         AIC_POWER_STATE_D1 = PCI_POWERSTATE_D1,
425         AIC_POWER_STATE_D2 = PCI_POWERSTATE_D2,
426         AIC_POWER_STATE_D3 = PCI_POWERSTATE_D3
427 } aic_power_state;
428
429 static __inline int aic_power_state_change(struct aic_softc *aic,
430                                            aic_power_state new_state);
431
432 static __inline int
433 aic_power_state_change(struct aic_softc *aic, aic_power_state new_state)
434 {
435         return (pci_set_powerstate(aic->dev_softc, new_state));
436 }
437 #endif