convert spl* to critical sections
[dragonfly.git] / sys / dev / disk / mpt / mpt_freebsd.h
1 /* $FreeBSD: src/sys/dev/mpt/mpt_freebsd.h,v 1.3.2.3 2002/09/24 21:37:25 mjacob Exp $ */
2 /* $DragonFly: src/sys/dev/disk/mpt/mpt_freebsd.h,v 1.6 2005/06/06 22:51:54 corecode Exp $ */
3 /*
4  * LSI MPT Host Adapter FreeBSD Wrapper Definitions (CAM version)
5  *
6  * Copyright (c) 2000, 2001 by Greg Ansley, Adam Prewett
7  *
8  * Partially derived from Matty Jacobs ISP driver.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice immediately at the beginning of the file, without modification,
15  *    this list of conditions, and the following disclaimer.
16  * 2. The name of the author may not be used to endorse or promote products
17  *    derived from this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
23  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  */
29 /*
30  * Additional Copyright (c) 2002 by Matthew Jacob under same license.
31  */
32
33 #ifndef  _MPT_FREEBSD_H_
34 #define  _MPT_FREEBSD_H_
35
36 #define RELENG_4        1
37
38 #include <sys/param.h>
39 #include <sys/systm.h>
40 #ifdef  RELENG_4
41 #include <sys/kernel.h>
42 #include <sys/queue.h>
43 #include <sys/malloc.h>
44 #else
45 #include <sys/endian.h>
46 #include <sys/lock.h>
47 #include <sys/malloc.h>
48 #include <sys/mutex.h>
49 #include <sys/condvar.h>
50 #endif
51 #include <sys/proc.h>
52 #include <sys/bus.h>
53 #include <sys/thread2.h>
54
55 #include <machine/bus_memio.h>
56 #include <machine/bus_pio.h>
57 #include <machine/bus.h>
58 #include <machine/clock.h>
59 #include <machine/cpu.h>
60
61 #include <bus/cam/cam.h>
62 #include <bus/cam/cam_debug.h>
63 #include <bus/cam/cam_ccb.h>
64 #include <bus/cam/cam_sim.h>
65 #include <bus/cam/cam_xpt.h>
66 #include <bus/cam/cam_xpt_sim.h>
67 #include <bus/cam/cam_debug.h>
68 #include <bus/cam/scsi/scsi_all.h>
69 #include <bus/cam/scsi/scsi_message.h>
70
71 #include "opt_ddb.h"
72
73 #include "mpilib/mpi_type.h"
74 #include "mpilib/mpi.h"
75 #include "mpilib/mpi_cnfg.h"
76 #include "mpilib/mpi_fc.h"
77 #include "mpilib/mpi_init.h"
78 #include "mpilib/mpi_ioc.h"
79 #include "mpilib/mpi_lan.h"
80 #include "mpilib/mpi_targ.h"
81
82
83 #define INLINE __inline
84
85 #ifdef  RELENG_4
86 #define MPT_IFLAGS              INTR_TYPE_CAM
87 #define MPT_LOCK(mpt)           crit_enter()
88 #define MPT_UNLOCK(mpt)         crit_exit()
89 #define MPTLOCK_2_CAMLOCK       MPT_UNLOCK
90 #define CAMLOCK_2_MPTLOCK       MPT_LOCK
91 #define MPT_LOCK_SETUP(mpt)
92 #define MPT_LOCK_DESTROY(mpt)
93 #else
94 #if     LOCKING_WORKED_AS_IT_SHOULD
95 #define MPT_IFLAGS              INTR_TYPE_CAM | INTR_ENTROPY | INTR_MPSAFE
96 #define MPT_LOCK_SETUP(mpt)                                             \
97                 mtx_init(&mpt->mpt_lock, "mpt", NULL, MTX_DEF);         \
98                 mpt->mpt_locksetup = 1
99 #define MPT_LOCK_DESTROY(mpt)                                           \
100         if (mpt->mpt_locksetup) {                                       \
101                 mtx_destroy(&mpt->mpt_lock);                            \
102                 mpt->mpt_locksetup = 0;                                 \
103         }
104
105 #define MPT_LOCK(mpt)           mtx_lock(&(mpt)->mpt_lock)
106 #define MPT_UNLOCK(mpt)         mtx_unlock(&(mpt)->mpt_lock)
107 #define MPTLOCK_2_CAMLOCK(mpt)  \
108         mtx_unlock(&(mpt)->mpt_lock); mtx_lock(&Giant)
109 #define CAMLOCK_2_MPTLOCK(mpt)  \
110         mtx_unlock(&Giant); mtx_lock(&(mpt)->mpt_lock)
111 #else
112 #define MPT_IFLAGS              INTR_TYPE_CAM | INTR_ENTROPY
113 #define MPT_LOCK_SETUP(mpt)     do { } while (0)
114 #define MPT_LOCK_DESTROY(mpt)   do { } while (0)
115 #define MPT_LOCK(mpt)           do { } while (0)
116 #define MPT_UNLOCK(mpt)         do { } while (0)
117 #define MPTLOCK_2_CAMLOCK(mpt)  do { } while (0)
118 #define CAMLOCK_2_MPTLOCK(mpt)  do { } while (0)
119 #endif
120 #endif
121         
122
123
124 /* Max MPT Reply we are willing to accept (must be power of 2) */
125 #define MPT_REPLY_SIZE          128
126
127 #define MPT_MAX_REQUESTS(mpt)   ((mpt)->is_fc? 1024 : 256)
128 #define MPT_REQUEST_AREA 512
129 #define MPT_SENSE_SIZE    32    /* included in MPT_REQUEST_SIZE */
130 #define MPT_REQ_MEM_SIZE(mpt)   (MPT_MAX_REQUESTS(mpt) * MPT_REQUEST_AREA)
131
132 /*
133  * We cannot tell prior to getting IOC facts how big the IOC's request
134  * area is. Because of this we cannot tell at compile time how many
135  * simple SG elements we can fit within an IOC request prior to having
136  * to put in a chain element.
137  * 
138  * Experimentally we know that the Ultra4 parts have a 96 byte request
139  * element size and the Fibre Channel units have a 144 byte request
140  * element size. Therefore, if we have 512-32 (== 480) bytes of request
141  * area to play with, we have room for between 3 and 5 request sized
142  * regions- the first of which is the command  plus a simple SG list,
143  * the rest of which are chained continuation SG lists. Given that the
144  * normal request we use is 48 bytes w/o the first SG element, we can
145  * assume we have 480-48 == 432 bytes to have simple SG elements and/or
146  * chain elements. If we assume 32 bit addressing, this works out to
147  * 54 SG or chain elements. If we assume 5 chain elements, then we have
148  * a maximum of 49 separate actual SG segments.
149  */
150
151 #define MPT_SGL_MAX             49
152
153 #define MPT_RQSL(mpt)           (mpt->request_frame_size << 2)
154 #define MPT_NSGL(mpt)           (MPT_RQSL(mpt) / sizeof (SGE_SIMPLE32))
155
156 #define MPT_NSGL_FIRST(mpt)                             \
157         (((mpt->request_frame_size << 2) -              \
158         sizeof (MSG_SCSI_IO_REQUEST) -                  \
159         sizeof (SGE_IO_UNION)) / sizeof (SGE_SIMPLE32))
160
161 /*
162  * Convert a physical address returned from IOC to kvm address
163  * needed to access the data.
164  */
165 #define MPT_REPLY_PTOV(m, x)            \
166         ((void *)(&m->reply[((x << 1) - m->reply_phys)]))
167
168 #define ccb_mpt_ptr sim_priv.entries[0].ptr
169 #define ccb_req_ptr sim_priv.entries[1].ptr
170
171 enum mpt_req_state {
172     REQ_FREE, REQ_IN_PROGRESS, REQ_TIMEOUT, REQ_ON_CHIP, REQ_DONE
173 };
174 typedef struct req_entry {
175         u_int16_t       index;          /* Index of this entry */
176         union ccb *     ccb;            /* CAM request */
177         void *          req_vbuf;       /* Virtual Address of Entry */
178         void *          sense_vbuf;     /* Virtual Address of sense data */
179         bus_addr_t      req_pbuf;       /* Physical Address of Entry */
180         bus_addr_t      sense_pbuf;     /* Physical Address of sense data */
181         bus_dmamap_t    dmap;           /* DMA map for data buffer */
182         SLIST_ENTRY(req_entry) link;    /* Pointer to next in list */
183         enum mpt_req_state debug;       /* Debugging */
184         u_int32_t       sequence;       /* Sequence Number */
185         struct callout  timeout;
186 } request_t;
187
188
189 /* Structure for saving proper values for modifyable PCI configuration registers */
190 struct mpt_pci_cfg {
191         u_int16_t Command;
192         u_int16_t LatencyTimer_LineSize;
193         u_int32_t IO_BAR;
194         u_int32_t Mem0_BAR[2];
195         u_int32_t Mem1_BAR[2];
196         u_int32_t ROM_BAR;
197         u_int8_t  IntLine;
198         u_int32_t PMCSR;
199 };
200
201 typedef struct mpt_softc {
202         device_t                dev;
203         u_int32_t               : 16,
204                 unit            : 8,
205                 verbose         : 3,
206                 outofbeer       : 1,
207                 mpt_locksetup   : 1,
208                 disabled        : 1,
209                 is_fc           : 1,
210                 bus             : 1;    /* FC929/1030 have two busses */
211
212         /*
213          * IOC Facts
214          */
215         u_int16_t               mpt_global_credits;
216         u_int16_t               request_frame_size;
217         u_int8_t                mpt_max_devices;
218         u_int8_t                mpt_max_buses;
219
220         /*
221          * Port Facts
222          */
223         u_int16_t               mpt_ini_id;
224
225
226         /*
227          * Device Configuration Information
228          */
229         union {
230                 struct mpt_spi_cfg {
231                         fCONFIG_PAGE_SCSI_PORT_0        _port_page0;
232                         fCONFIG_PAGE_SCSI_PORT_1        _port_page1;
233                         fCONFIG_PAGE_SCSI_PORT_2        _port_page2;
234                         fCONFIG_PAGE_SCSI_DEVICE_0      _dev_page0[16];
235                         fCONFIG_PAGE_SCSI_DEVICE_1      _dev_page1[16];
236                         uint16_t                        _tag_enable;
237                         uint16_t                        _disc_enable;
238                         uint16_t                        _update_params0;
239                         uint16_t                        _update_params1;
240                 } spi;
241 #define mpt_port_page0          cfg.spi._port_page0
242 #define mpt_port_page1          cfg.spi._port_page1
243 #define mpt_port_page2          cfg.spi._port_page2
244 #define mpt_dev_page0           cfg.spi._dev_page0
245 #define mpt_dev_page1           cfg.spi._dev_page1
246 #define mpt_tag_enable          cfg.spi._tag_enable
247 #define mpt_disc_enable         cfg.spi._disc_enable
248 #define mpt_update_params0      cfg.spi._update_params0
249 #define mpt_update_params1      cfg.spi._update_params1
250                 struct mpi_fc_cfg {
251                         u_int8_t        nada;
252                 } fc;
253         } cfg;
254
255         /*
256          * PCI Hardware info
257          */
258         struct resource *       pci_irq;        /* Interrupt map for chip */
259         void *                  ih;             /* Interupt handle */
260         struct mpt_pci_cfg      pci_cfg;        /* saved PCI conf registers */
261
262         /*
263          * DMA Mapping Stuff
264          */
265
266         struct resource *       pci_reg;        /* Register map for chip */
267         int                     pci_reg_id;     /* Resource ID */
268         bus_space_tag_t         pci_st;         /* Bus tag for registers */
269         bus_space_handle_t      pci_sh;         /* Bus handle for registers */
270         vm_offset_t             pci_pa;         /* Physical Address */
271
272         bus_dma_tag_t           parent_dmat;    /* DMA tag for parent PCI bus */
273         bus_dma_tag_t           reply_dmat;     /* DMA tag for reply memory */
274         bus_dmamap_t            reply_dmap;     /* DMA map for reply memory */
275         char *                  reply;          /* KVA of reply memory */
276         bus_addr_t              reply_phys;     /* BusAddr of reply memory */
277
278
279         bus_dma_tag_t           buffer_dmat;    /* DMA tag for buffers */
280         bus_dma_tag_t           request_dmat;   /* DMA tag for request memroy */
281         bus_dmamap_t            request_dmap;   /* DMA map for request memroy */
282         char *                  request;        /* KVA of Request memory */
283         bus_addr_t              request_phys;   /* BusADdr of request memory */
284
285         /*
286          * CAM && Software Management
287          */
288
289         request_t *             request_pool;
290         SLIST_HEAD(req_queue, req_entry) request_free_list;
291
292         struct cam_sim *        sim;
293         struct cam_path *       path;
294
295         u_int32_t               sequence;       /* Sequence Number */
296         u_int32_t               timeouts;       /* timeout count */
297         u_int32_t               success;        /* successes afer timeout */
298
299         /* Opposing port in a 929 or 1030, or NULL */
300         struct mpt_softc *      mpt2;
301
302 } mpt_softc_t;
303
304 #include "mpt.h"
305
306
307 static INLINE void mpt_write(mpt_softc_t *, size_t, u_int32_t);
308 static INLINE u_int32_t mpt_read(mpt_softc_t *, int);
309
310 static INLINE void
311 mpt_write(mpt_softc_t *mpt, size_t offset, u_int32_t val)
312 {
313         bus_space_write_4(mpt->pci_st, mpt->pci_sh, offset, val);
314 }
315
316 static INLINE u_int32_t
317 mpt_read(mpt_softc_t *mpt, int offset)
318 {
319         return (bus_space_read_4(mpt->pci_st, mpt->pci_sh, offset));
320 }
321
322 void mpt_cam_attach(mpt_softc_t *);
323 void mpt_cam_detach(mpt_softc_t *);
324 void mpt_done(mpt_softc_t *, u_int32_t);
325 void mpt_set_config_regs(mpt_softc_t *);
326
327 #endif  /* _MPT_FREEBSD_H */