1 /*-
2 * FreeBSD platform specific driver option settings, data structures,
3 * function declarations and includes.
4 *
5 * Copyright (c) 1994-2001 Justin T. Gibbs.
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
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.
16 *
17 * Alternatively, this software may be distributed under the terms of the
18 * GNU Public License ("GPL").
19 *
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
30 * SUCH DAMAGE.
31 *
32 * $Id: //depot/aic7xxx/freebsd/dev/aic7xxx/aic7xxx_osm.h#18 $
33 */
34
35 #ifndef _AIC7XXX_FREEBSD_H_
36 #define _AIC7XXX_FREEBSD_H_
37
38 #include "opt_aic7xxx.h" /* for config options */
39
40 #include <sys/param.h>
41 #include <sys/systm.h>
42 #include <sys/bus.h> /* For device_t */
43 #include <sys/endian.h>
44 #include <sys/eventhandler.h>
45 #include <sys/kernel.h>
46 #include <sys/malloc.h>
47 #include <sys/module.h>
48 #include <sys/queue.h>
49
50 #define AIC_PCI_CONFIG 1
51 #include <machine/bus.h>
52 #include <machine/endian.h>
53 #include <machine/resource.h>
54
55 #include <sys/rman.h>
56
57 #include <dev/pci/pcireg.h>
58 #include <dev/pci/pcivar.h>
59
60 #include <cam/cam.h>
61 #include <cam/cam_ccb.h>
62 #include <cam/cam_debug.h>
63 #include <cam/cam_sim.h>
64 #include <cam/cam_xpt_sim.h>
65
66 #include <cam/scsi/scsi_all.h>
67 #include <cam/scsi/scsi_message.h>
68
69 /*************************** Attachment Bookkeeping ***************************/
70 extern devclass_t ahc_devclass;
71
72 /****************************** Platform Macros *******************************/
73 #define SIM_IS_SCSIBUS_B(ahc, sim) \
74 ((sim) == ahc->platform_data->sim_b)
75 #define SIM_CHANNEL(ahc, sim) \
76 (((sim) == ahc->platform_data->sim_b) ? 'B' : 'A')
77 #define SIM_SCSI_ID(ahc, sim) \
78 (((sim) == ahc->platform_data->sim_b) ? ahc->our_id_b : ahc->our_id)
79 #define SIM_PATH(ahc, sim) \
80 (((sim) == ahc->platform_data->sim_b) ? ahc->platform_data->path_b \
81 : ahc->platform_data->path)
82 #define BUILD_SCSIID(ahc, sim, target_id, our_id) \
83 ((((target_id) << TID_SHIFT) & TID) | (our_id) \
84 | (SIM_IS_SCSIBUS_B(ahc, sim) ? TWIN_CHNLB : 0))
85
86 #define SCB_GET_SIM(ahc, scb) \
87 (SCB_GET_CHANNEL(ahc, scb) == 'A' ? (ahc)->platform_data->sim \
88 : (ahc)->platform_data->sim_b)
89
90 #ifndef offsetof
91 #define offsetof(type, member) ((size_t)(&((type *)0)->member))
92 #endif
93
94 /************************ Tunable Driver Parameters **************************/
95 /*
96 * The number of dma segments supported. The sequencer can handle any number
97 * of physically contiguous S/G entrys. To reduce the driver's memory
98 * consumption, we limit the number supported to be sufficient to handle
99 * the largest mapping supported by the legacy kernel MAXPHYS setting of
100 * 128K. This can be increased once some testing is done. Assuming the
101 * be the number of paged sized transfers in MAXPHYS plus an extra element
102 * to handle any unaligned residual. The sequencer fetches SG elements
103 * in cacheline sized chucks, so make the number per-transaction an even
104 * multiple of 16 which should align us on even the largest of cacheline
105 * boundaries.
106 */
107 #define AHC_MAXPHYS (128 * 1024)
108 #define AHC_NSEG (roundup(btoc(AHC_MAXPHYS) + 1, 16))
109
110 /* This driver supports target mode */
111 #define AHC_TARGET_MODE 1
112
113 /************************** Softc/SCB Platform Data ***************************/
114 struct ahc_platform_data {
115 /*
116 * Hooks into the XPT.
117 */
118 struct cam_sim *sim;
119 struct cam_sim *sim_b;
120 struct cam_path *path;
121 struct cam_path *path_b;
122
123 int regs_res_type;
124 int regs_res_id;
125 int irq_res_type;
126 struct resource *regs;
127 struct resource *irq;
128 void *ih;
129 eventhandler_tag eh;
130 struct proc *recovery_thread;
131 struct mtx mtx;
132 };
133
134 struct scb_platform_data {
135 };
136
137 /***************************** Core Includes **********************************/
138 #ifdef AHC_REG_PRETTY_PRINT
139 #define AIC_DEBUG_REGISTERS 1
140 #else
141 #define AIC_DEBUG_REGISTERS 0
142 #endif
143 #define AIC_CORE_INCLUDE <dev/aic7xxx/aic7xxx.h>
144 #define AIC_LIB_PREFIX ahc
145 #define AIC_CONST_PREFIX AHC
146 #include <dev/aic7xxx/aic_osm_lib.h>
147
148 /*************************** Device Access ************************************/
149 #define ahc_inb(ahc, port) \
150 bus_space_read_1((ahc)->tag, (ahc)->bsh, port)
151
152 #define ahc_outb(ahc, port, value) \
153 bus_space_write_1((ahc)->tag, (ahc)->bsh, port, value)
154
155 #define ahc_outsb(ahc, port, valp, count) \
156 bus_space_write_multi_1((ahc)->tag, (ahc)->bsh, port, valp, count)
157
158 #define ahc_insb(ahc, port, valp, count) \
159 bus_space_read_multi_1((ahc)->tag, (ahc)->bsh, port, valp, count)
160
161 static __inline void ahc_flush_device_writes(struct ahc_softc *);
162
163 static __inline void
ahc_flush_device_writes(struct ahc_softc * ahc)164 ahc_flush_device_writes(struct ahc_softc *ahc)
165 {
166 /* XXX Is this sufficient for all architectures??? */
167 ahc_inb(ahc, INTSTAT);
168 }
169
170 /**************************** Locking Primitives ******************************/
171 /* Lock protecting internal data structures */
172 static __inline void ahc_lockinit(struct ahc_softc *);
173 static __inline void ahc_lock(struct ahc_softc *);
174 static __inline void ahc_unlock(struct ahc_softc *);
175
176 static __inline void
ahc_lockinit(struct ahc_softc * ahc)177 ahc_lockinit(struct ahc_softc *ahc)
178 {
179 mtx_init(&ahc->platform_data->mtx, "ahc_lock", NULL, MTX_DEF);
180 }
181
182 static __inline void
ahc_lock(struct ahc_softc * ahc)183 ahc_lock(struct ahc_softc *ahc)
184 {
185 mtx_lock(&ahc->platform_data->mtx);
186 }
187
188 static __inline void
ahc_unlock(struct ahc_softc * ahc)189 ahc_unlock(struct ahc_softc *ahc)
190 {
191 mtx_unlock(&ahc->platform_data->mtx);
192 }
193
194 /************************* Initialization/Teardown ****************************/
195 int ahc_platform_alloc(struct ahc_softc *ahc, void *platform_arg);
196 void ahc_platform_free(struct ahc_softc *ahc);
197 int ahc_map_int(struct ahc_softc *ahc);
198 int ahc_attach(struct ahc_softc *);
199 int ahc_softc_comp(struct ahc_softc *lahc, struct ahc_softc *rahc);
200 int ahc_detach(device_t);
201
202 /********************************** PCI ***************************************/
203 #ifdef AIC_PCI_CONFIG
204 int ahc_pci_map_registers(struct ahc_softc *ahc);
205 #define ahc_pci_map_int ahc_map_int
206 #endif /*AIC_PCI_CONFIG*/
207
208 /******************************** VL/EISA/ISA *********************************/
209 int aic7770_map_registers(struct ahc_softc *ahc, u_int port);
210 static __inline int aic7770_map_int(struct ahc_softc *, int);
211
212 static __inline int
aic7770_map_int(struct ahc_softc * ahc,int irq)213 aic7770_map_int(struct ahc_softc *ahc, int irq)
214 {
215 /*
216 * The IRQ is unused in the FreeBSD
217 * implementation since the ISA attachment
218 * registers the IRQ with newbus before
219 * the core is called.
220 */
221 return ahc_map_int(ahc);
222 }
223
224 /********************************* Debug **************************************/
225 static __inline void ahc_print_path(struct ahc_softc *, struct scb *);
226 static __inline void ahc_platform_dump_card_state(struct ahc_softc *ahc);
227
228 static __inline void
ahc_print_path(struct ahc_softc * ahc,struct scb * scb)229 ahc_print_path(struct ahc_softc *ahc, struct scb *scb)
230 {
231 xpt_print_path(scb->io_ctx->ccb_h.path);
232 }
233
234 static __inline void
ahc_platform_dump_card_state(struct ahc_softc * ahc)235 ahc_platform_dump_card_state(struct ahc_softc *ahc)
236 {
237 /* Nothing to do here for FreeBSD */
238 }
239 /**************************** Transfer Settings *******************************/
240 void ahc_notify_xfer_settings_change(struct ahc_softc *,
241 struct ahc_devinfo *);
242 void ahc_platform_set_tags(struct ahc_softc *, struct ahc_devinfo *,
243 int /*enable*/);
244
245 /****************************** Interrupts ************************************/
246 void ahc_platform_intr(void *);
247 static __inline void ahc_platform_flushwork(struct ahc_softc *ahc);
248 static __inline void
ahc_platform_flushwork(struct ahc_softc * ahc)249 ahc_platform_flushwork(struct ahc_softc *ahc)
250 {
251 }
252
253 /************************ Misc Function Declarations **************************/
254 void ahc_done(struct ahc_softc *ahc, struct scb *scb);
255 void ahc_send_async(struct ahc_softc *, char /*channel*/,
256 u_int /*target*/, u_int /*lun*/, ac_code, void *arg);
257 #endif /* _AIC7XXX_FREEBSD_H_ */
258