2 * FreeBSD platform specific driver option settings, data structures,
3 * function declarations and includes.
5 * Copyright (c) 1994-2001 Justin T. Gibbs.
6 * Copyright (c) 2001-2002 Adaptec Inc.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
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.
18 * Alternatively, this software may be distributed under the terms of the
19 * GNU Public License ("GPL").
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
33 * $Id: //depot/aic7xxx/freebsd/dev/aic7xxx/aic79xx_osm.h#23 $
35 * $FreeBSD: src/sys/dev/aic7xxx/aic79xx_osm.h,v 1.18 2005/12/06 11:19:36 ru Exp $
36 * $DragonFly: src/sys/dev/disk/aic7xxx/aic79xx_osm.h,v 1.13 2008/02/10 00:01:02 pavalos Exp $
39 #ifndef _AIC79XX_FREEBSD_H_
40 #define _AIC79XX_FREEBSD_H_
42 #include <opt_aic79xx.h> /* for config options */
44 #include <sys/param.h>
45 #include <sys/systm.h>
46 #include <sys/bus.h> /* For device_t */
47 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
48 #include <sys/endian.h>
50 #include <sys/eventhandler.h>
51 #include <sys/kernel.h>
52 #include <sys/malloc.h>
53 #include <sys/queue.h>
54 #include <sys/thread2.h>
56 #define AIC_PCI_CONFIG 1
57 #include <machine/endian.h>
58 #include <machine/clock.h>
62 #include <bus/pci/pcireg.h>
63 #include <bus/pci/pcivar.h>
65 #include <bus/cam/cam.h>
66 #include <bus/cam/cam_ccb.h>
67 #include <bus/cam/cam_debug.h>
68 #include <bus/cam/cam_sim.h>
69 #include <bus/cam/cam_xpt_sim.h>
71 #include <bus/cam/scsi/scsi_all.h>
72 #include <bus/cam/scsi/scsi_message.h>
73 #include <bus/cam/scsi/scsi_iu.h>
75 /****************************** Platform Macros *******************************/
76 #define SIM_IS_SCSIBUS_B(ahd, sim) \
78 #define SIM_CHANNEL(ahd, sim) \
80 #define SIM_SCSI_ID(ahd, sim) \
82 #define SIM_PATH(ahd, sim) \
83 (ahd->platform_data->path)
84 #define BUILD_SCSIID(ahd, sim, target_id, our_id) \
85 ((((target_id) << TID_SHIFT) & TID) | (our_id))
88 #define SCB_GET_SIM(ahd, scb) \
89 ((ahd)->platform_data->sim)
92 #define offsetof(type, member) ((size_t)(&((type *)0)->member))
95 /************************ Tunable Driver Parameters **************************/
97 * The number of dma segments supported. The sequencer can handle any number
98 * of physically contiguous S/G entrys. To reduce the driver's memory
99 * consumption, we limit the number supported to be sufficient to handle
100 * the largest mapping supported by the kernel, MAXPHYS. Assuming the
101 * transfer is as fragmented as possible and unaligned, this turns out to
102 * be the number of paged sized transfers in MAXPHYS plus an extra element
103 * to handle any unaligned residual. The sequencer fetches SG elements
104 * in cacheline sized chucks, so make the number per-transaction an even
105 * multiple of 16 which should align us on even the largest of cacheline
108 #define AHD_NSEG (roundup(btoc(MAXPHYS) + 1, 16))
110 /* This driver supports target mode */
112 #define AHD_TARGET_MODE 1
115 /***************************** Core Includes **********************************/
116 #ifdef AHD_REG_PRETTY_PRINT
117 #define AIC_DEBUG_REGISTERS 1
119 #define AIC_DEBUG_REGISTERS 0
121 #define AIC_CORE_INCLUDE "aic79xx.h"
122 #define AIC_LIB_PREFIX ahd
123 #define AIC_CONST_PREFIX AHD
124 #include "aic_osm_lib.h"
126 /************************** Softc/SCB Platform Data ***************************/
127 struct ahd_platform_data
{
129 * Hooks into the XPT.
132 struct cam_path
*path
;
134 int regs_res_type
[2];
137 struct resource
*regs
[2];
138 struct resource
*irq
;
141 struct thread
*recovery_thread
;
145 struct scb_platform_data
{
148 /*************************** Device Access ************************************/
149 #define ahd_inb(ahd, port) \
150 bus_space_read_1((ahd)->tags[(port) >> 8], \
151 (ahd)->bshs[(port) >> 8], (port) & 0xFF)
153 #define ahd_outb(ahd, port, value) \
154 bus_space_write_1((ahd)->tags[(port) >> 8], \
155 (ahd)->bshs[(port) >> 8], (port) & 0xFF, value)
157 #define ahd_inw_atomic(ahd, port) \
158 aic_le16toh(bus_space_read_2((ahd)->tags[(port) >> 8], \
159 (ahd)->bshs[(port) >> 8], (port) & 0xFF))
161 #define ahd_outw_atomic(ahd, port, value) \
162 bus_space_write_2((ahd)->tags[(port) >> 8], \
163 (ahd)->bshs[(port) >> 8], \
164 (port & 0xFF), aic_htole16(value))
166 #define ahd_outsb(ahd, port, valp, count) \
167 bus_space_write_multi_1((ahd)->tags[(port) >> 8], \
168 (ahd)->bshs[(port) >> 8], \
169 (port & 0xFF), valp, count)
171 #define ahd_insb(ahd, port, valp, count) \
172 bus_space_read_multi_1((ahd)->tags[(port) >> 8], \
173 (ahd)->bshs[(port) >> 8], \
174 (port & 0xFF), valp, count)
176 static __inline
void ahd_flush_device_writes(struct ahd_softc
*);
179 ahd_flush_device_writes(struct ahd_softc
*ahd
)
181 /* XXX Is this sufficient for all architectures??? */
182 ahd_inb(ahd
, INTSTAT
);
185 /**************************** Locking Primitives ******************************/
186 /* Lock protecting internal data structures */
187 static __inline
void ahd_lockinit(struct ahd_softc
*);
188 static __inline
void ahd_lock(struct ahd_softc
*);
189 static __inline
void ahd_unlock(struct ahd_softc
*);
192 ahd_lockinit(struct ahd_softc
*ahd
)
194 lockinit(&ahd
->platform_data
->lock
, "ahd_lock", 0, LK_EXCLUSIVE
|LK_CANRECURSE
);
198 ahd_lock(struct ahd_softc
*ahd
)
200 lockmgr(&ahd
->platform_data
->lock
, LK_EXCLUSIVE
);
204 ahd_unlock(struct ahd_softc
*ahd
)
206 lockmgr(&ahd
->platform_data
->lock
, LK_RELEASE
);
209 /********************************** PCI ***************************************/
210 int ahd_pci_map_registers(struct ahd_softc
*ahd
);
211 int ahd_pci_map_int(struct ahd_softc
*ahd
);
213 /************************** Transaction Operations ****************************/
214 static __inline
void aic_freeze_simq(struct aic_softc
*);
215 static __inline
void aic_release_simq(struct aic_softc
*);
218 aic_freeze_simq(struct aic_softc
*aic
)
220 xpt_freeze_simq(aic
->platform_data
->sim
, /*count*/1);
224 aic_release_simq(struct aic_softc
*aic
)
226 xpt_release_simq(aic
->platform_data
->sim
, /*run queue*/TRUE
);
229 /********************************* Debug **************************************/
230 static __inline
void ahd_print_path(struct ahd_softc
*, struct scb
*);
231 static __inline
void ahd_platform_dump_card_state(struct ahd_softc
*ahd
);
234 ahd_print_path(struct ahd_softc
*ahd
, struct scb
*scb
)
236 xpt_print_path(scb
->io_ctx
->ccb_h
.path
);
240 ahd_platform_dump_card_state(struct ahd_softc
*ahd
)
242 /* Nothing to do here for FreeBSD */
244 /**************************** Transfer Settings *******************************/
245 void ahd_notify_xfer_settings_change(struct ahd_softc
*,
246 struct ahd_devinfo
*);
247 void ahd_platform_set_tags(struct ahd_softc
*, struct ahd_devinfo
*,
250 /************************* Initialization/Teardown ****************************/
251 int ahd_platform_alloc(struct ahd_softc
*ahd
, void *platform_arg
);
252 void ahd_platform_free(struct ahd_softc
*ahd
);
253 int ahd_map_int(struct ahd_softc
*ahd
);
254 int ahd_attach(struct ahd_softc
*);
255 int ahd_softc_comp(struct ahd_softc
*lahd
, struct ahd_softc
*rahd
);
256 int ahd_detach(device_t
);
257 #define ahd_platform_init(arg)
260 /****************************** Interrupts ************************************/
261 void ahd_platform_intr(void *);
262 static __inline
void ahd_platform_flushwork(struct ahd_softc
*ahd
);
264 ahd_platform_flushwork(struct ahd_softc
*ahd
)
268 /************************ Misc Function Declarations **************************/
269 void ahd_done(struct ahd_softc
*ahd
, struct scb
*scb
);
270 void ahd_send_async(struct ahd_softc
*, char /*channel*/,
271 u_int
/*target*/, u_int
/*lun*/, ac_code
, void *arg
);
272 #endif /* _AIC79XX_FREEBSD_H_ */