2 * FreeBSD platform specific driver option settings, data structures,
3 * function declarations and includes.
5 * Copyright (c) 1994-2001 Justin T. Gibbs.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions, and the following disclaimer,
13 * without modification.
14 * 2. The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
17 * Alternatively, this software may be distributed under the terms of the
18 * GNU Public License ("GPL").
20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
24 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * $Id: //depot/aic7xxx/freebsd/dev/aic7xxx/aic7xxx_osm.h#18 $
34 * $FreeBSD: src/sys/dev/aic7xxx/aic7xxx_osm.h,v 1.30 2005/12/05 11:58:32 ru Exp $
35 * $DragonFly: src/sys/dev/disk/aic7xxx/aic7xxx_osm.h,v 1.15 2008/04/06 19:03:18 pavalos Exp $
38 #ifndef _AIC7XXX_FREEBSD_H_
39 #define _AIC7XXX_FREEBSD_H_
41 #include <opt_aic7xxx.h> /* for config options */
43 #include <sys/param.h>
44 #include <sys/systm.h>
45 #include <sys/bus.h> /* For device_t */
46 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
47 #include <sys/endian.h>
49 #include <sys/eventhandler.h>
50 #include <sys/kernel.h>
51 #include <sys/malloc.h>
52 #include <sys/queue.h>
54 #include <sys/thread2.h>
56 #if defined(__DragonFly__) || __FreeBSD_version < 500000
63 #define AIC_PCI_CONFIG 1
65 #include <machine/endian.h>
66 #include <machine/clock.h>
69 #include <bus/pci/pcireg.h>
70 #include <bus/pci/pcivar.h>
73 #include <bus/cam/cam.h>
74 #include <bus/cam/cam_ccb.h>
75 #include <bus/cam/cam_debug.h>
76 #include <bus/cam/cam_sim.h>
77 #include <bus/cam/cam_xpt_sim.h>
79 #include <bus/cam/scsi/scsi_all.h>
80 #include <bus/cam/scsi/scsi_message.h>
82 /*************************** Attachment Bookkeeping ***************************/
83 extern devclass_t ahc_devclass
;
85 /****************************** Platform Macros *******************************/
86 #define SIM_IS_SCSIBUS_B(ahc, sim) \
87 ((sim) == ahc->platform_data->sim_b)
88 #define SIM_CHANNEL(ahc, sim) \
89 (((sim) == ahc->platform_data->sim_b) ? 'B' : 'A')
90 #define SIM_SCSI_ID(ahc, sim) \
91 (((sim) == ahc->platform_data->sim_b) ? ahc->our_id_b : ahc->our_id)
92 #define SIM_PATH(ahc, sim) \
93 (((sim) == ahc->platform_data->sim_b) ? ahc->platform_data->path_b \
94 : ahc->platform_data->path)
95 #define BUILD_SCSIID(ahc, sim, target_id, our_id) \
96 ((((target_id) << TID_SHIFT) & TID) | (our_id) \
97 | (SIM_IS_SCSIBUS_B(ahc, sim) ? TWIN_CHNLB : 0))
99 #define SCB_GET_SIM(ahc, scb) \
100 (SCB_GET_CHANNEL(ahc, scb) == 'A' ? (ahc)->platform_data->sim \
101 : (ahc)->platform_data->sim_b)
104 #define offsetof(type, member) ((size_t)(&((type *)0)->member))
107 /************************ Tunable Driver Parameters **************************/
109 * The number of dma segments supported. The sequencer can handle any number
110 * of physically contiguous S/G entrys. To reduce the driver's memory
111 * consumption, we limit the number supported to be sufficient to handle
112 * the largest mapping supported by the kernel, MAXPHYS. Assuming the
113 * transfer is as fragmented as possible and unaligned, this turns out to
114 * be the number of paged sized transfers in MAXPHYS plus an extra element
115 * to handle any unaligned residual. The sequencer fetches SG elements
116 * in cacheline sized chucks, so make the number per-transaction an even
117 * multiple of 16 which should align us on even the largest of cacheline
120 #define AHC_NSEG (roundup(btoc(MAXPHYS) + 1, 16))
122 /* This driver supports target mode */
123 #define AHC_TARGET_MODE 1
125 /***************************** Core Includes **********************************/
126 #ifdef AHC_REG_PRETTY_PRINT
127 #define AIC_DEBUG_REGISTERS 1
129 #define AIC_DEBUG_REGISTERS 0
131 #define AIC_CORE_INCLUDE "aic7xxx.h"
132 #define AIC_LIB_PREFIX ahc
133 #define AIC_CONST_PREFIX AHC
134 #include "aic_osm_lib.h"
136 /************************** Softc/SCB Platform Data ***************************/
137 struct ahc_platform_data
{
139 * Hooks into the XPT.
142 struct cam_sim
*sim_b
;
143 struct cam_path
*path
;
144 struct cam_path
*path_b
;
149 struct resource
*regs
;
150 struct resource
*irq
;
153 struct thread
*recovery_thread
;
157 struct scb_platform_data
{
160 /*************************** Device Access ************************************/
161 #define ahc_inb(ahc, port) \
162 bus_space_read_1((ahc)->tag, (ahc)->bsh, port)
164 #define ahc_outb(ahc, port, value) \
165 bus_space_write_1((ahc)->tag, (ahc)->bsh, port, value)
167 #define ahc_outsb(ahc, port, valp, count) \
168 bus_space_write_multi_1((ahc)->tag, (ahc)->bsh, port, valp, count)
170 #define ahc_insb(ahc, port, valp, count) \
171 bus_space_read_multi_1((ahc)->tag, (ahc)->bsh, port, valp, count)
173 static __inline
void ahc_flush_device_writes(struct ahc_softc
*);
176 ahc_flush_device_writes(struct ahc_softc
*ahc
)
178 /* XXX Is this sufficient for all architectures??? */
179 ahc_inb(ahc
, INTSTAT
);
182 /**************************** Locking Primitives ******************************/
183 /* Lock protecting internal data structures */
184 static __inline
void ahc_lockinit(struct ahc_softc
*);
185 static __inline
void ahc_lock(struct ahc_softc
*);
186 static __inline
void ahc_unlock(struct ahc_softc
*);
189 ahc_lockinit(struct ahc_softc
*ahc
)
191 lockinit(&ahc
->platform_data
->lock
, "ahc_lock", 0, LK_CANRECURSE
);
195 ahc_lock(struct ahc_softc
*ahc
)
197 lockmgr(&ahc
->platform_data
->lock
, LK_EXCLUSIVE
);
201 ahc_unlock(struct ahc_softc
*ahc
)
203 lockmgr(&ahc
->platform_data
->lock
, LK_RELEASE
);
206 /************************* Initialization/Teardown ****************************/
207 int ahc_platform_alloc(struct ahc_softc
*ahc
, void *platform_arg
);
208 void ahc_platform_free(struct ahc_softc
*ahc
);
209 int ahc_map_int(struct ahc_softc
*ahc
);
210 int ahc_attach(struct ahc_softc
*);
211 int ahc_softc_comp(struct ahc_softc
*lahc
, struct ahc_softc
*rahc
);
212 int ahc_detach(device_t
);
214 /********************************** PCI ***************************************/
215 #ifdef AIC_PCI_CONFIG
216 int ahc_pci_map_registers(struct ahc_softc
*ahc
);
217 #define ahc_pci_map_int ahc_map_int
218 #endif /*AIC_PCI_CONFIG*/
220 /******************************** VL/EISA *************************************/
221 int aic7770_map_registers(struct ahc_softc
*ahc
, u_int port
);
222 static __inline
int aic7770_map_int(struct ahc_softc
*, int);
225 aic7770_map_int(struct ahc_softc
*ahc
, int irq
)
228 * The IRQ is unused in the FreeBSD
229 * implementation since the EISA and
230 * ISA attachments register the IRQ
231 * with newbus before the core is called.
233 return ahc_map_int(ahc
);
236 /********************************* Debug **************************************/
237 static __inline
void ahc_print_path(struct ahc_softc
*, struct scb
*);
238 static __inline
void ahc_platform_dump_card_state(struct ahc_softc
*ahc
);
241 ahc_print_path(struct ahc_softc
*ahc
, struct scb
*scb
)
243 xpt_print_path(scb
->io_ctx
->ccb_h
.path
);
247 ahc_platform_dump_card_state(struct ahc_softc
*ahc
)
249 /* Nothing to do here for FreeBSD */
251 /**************************** Transfer Settings *******************************/
252 void ahc_notify_xfer_settings_change(struct ahc_softc
*,
253 struct ahc_devinfo
*);
254 void ahc_platform_set_tags(struct ahc_softc
*, struct ahc_devinfo
*,
257 /****************************** Interrupts ************************************/
258 void ahc_platform_intr(void *);
259 static __inline
void ahc_platform_flushwork(struct ahc_softc
*ahc
);
261 ahc_platform_flushwork(struct ahc_softc
*ahc
)
265 /************************ Misc Function Declarations **************************/
266 void ahc_done(struct ahc_softc
*ahc
, struct scb
*scb
);
267 void ahc_send_async(struct ahc_softc
*, char /*channel*/,
268 u_int
/*target*/, u_int
/*lun*/, ac_code
, void *arg
);
269 #endif /* _AIC7XXX_FREEBSD_H_ */