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.10 2006/10/25 20:55:53 dillon Exp $ */
4 * LSI MPT Host Adapter FreeBSD Wrapper Definitions (CAM version)
6 * Copyright (c) 2000, 2001 by Greg Ansley, Adam Prewett
8 * Partially derived from Matty Jacobs ISP driver.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
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.
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
30 * Additional Copyright (c) 2002 by Matthew Jacob under same license.
33 #ifndef _MPT_FREEBSD_H_
34 #define _MPT_FREEBSD_H_
38 #include <sys/param.h>
39 #include <sys/systm.h>
41 #include <sys/kernel.h>
42 #include <sys/queue.h>
43 #include <sys/malloc.h>
45 #include <sys/endian.h>
47 #include <sys/malloc.h>
48 #include <sys/mutex.h>
49 #include <sys/condvar.h>
53 #include <sys/thread2.h>
55 #include <machine/clock.h>
56 #include <machine/cpu.h>
58 #include <bus/cam/cam.h>
59 #include <bus/cam/cam_debug.h>
60 #include <bus/cam/cam_ccb.h>
61 #include <bus/cam/cam_sim.h>
62 #include <bus/cam/cam_xpt.h>
63 #include <bus/cam/cam_xpt_sim.h>
64 #include <bus/cam/cam_debug.h>
65 #include <bus/cam/scsi/scsi_all.h>
66 #include <bus/cam/scsi/scsi_message.h>
70 #include "mpilib/mpi_type.h"
71 #include "mpilib/mpi.h"
72 #include "mpilib/mpi_cnfg.h"
73 #include "mpilib/mpi_fc.h"
74 #include "mpilib/mpi_init.h"
75 #include "mpilib/mpi_ioc.h"
76 #include "mpilib/mpi_lan.h"
77 #include "mpilib/mpi_targ.h"
80 #define INLINE __inline
84 #define MPT_LOCK(mpt) crit_enter()
85 #define MPT_UNLOCK(mpt) crit_exit()
86 #define MPT_LOCK_SETUP(mpt)
87 #define MPT_LOCK_DESTROY(mpt)
89 #if LOCKING_WORKED_AS_IT_SHOULD
90 #define MPT_IFLAGS INTR_MPSAFE
91 #define MPT_LOCK_SETUP(mpt) \
92 mtx_init(&mpt->mpt_lock, "mpt", NULL, MTX_DEF); \
93 mpt->mpt_locksetup = 1
94 #define MPT_LOCK_DESTROY(mpt) \
95 if (mpt->mpt_locksetup) { \
96 mtx_destroy(&mpt->mpt_lock); \
97 mpt->mpt_locksetup = 0; \
100 #define MPT_LOCK(mpt) mtx_lock(&(mpt)->mpt_lock)
101 #define MPT_UNLOCK(mpt) mtx_unlock(&(mpt)->mpt_lock)
104 #define MPT_LOCK_SETUP(mpt) do { } while (0)
105 #define MPT_LOCK_DESTROY(mpt) do { } while (0)
106 #define MPT_LOCK(mpt) do { } while (0)
107 #define MPT_UNLOCK(mpt) do { } while (0)
113 /* Max MPT Reply we are willing to accept (must be power of 2) */
114 #define MPT_REPLY_SIZE 128
116 #define MPT_MAX_REQUESTS(mpt) ((mpt)->is_fc? 1024 : 256)
117 #define MPT_REQUEST_AREA 512
118 #define MPT_SENSE_SIZE 32 /* included in MPT_REQUEST_SIZE */
119 #define MPT_REQ_MEM_SIZE(mpt) (MPT_MAX_REQUESTS(mpt) * MPT_REQUEST_AREA)
122 * We cannot tell prior to getting IOC facts how big the IOC's request
123 * area is. Because of this we cannot tell at compile time how many
124 * simple SG elements we can fit within an IOC request prior to having
125 * to put in a chain element.
127 * Experimentally we know that the Ultra4 parts have a 96 byte request
128 * element size and the Fibre Channel units have a 144 byte request
129 * element size. Therefore, if we have 512-32 (== 480) bytes of request
130 * area to play with, we have room for between 3 and 5 request sized
131 * regions- the first of which is the command plus a simple SG list,
132 * the rest of which are chained continuation SG lists. Given that the
133 * normal request we use is 48 bytes w/o the first SG element, we can
134 * assume we have 480-48 == 432 bytes to have simple SG elements and/or
135 * chain elements. If we assume 32 bit addressing, this works out to
136 * 54 SG or chain elements. If we assume 5 chain elements, then we have
137 * a maximum of 49 separate actual SG segments.
140 #define MPT_SGL_MAX 49
142 #define MPT_RQSL(mpt) (mpt->request_frame_size << 2)
143 #define MPT_NSGL(mpt) (MPT_RQSL(mpt) / sizeof (SGE_SIMPLE32))
145 #define MPT_NSGL_FIRST(mpt) \
146 (((mpt->request_frame_size << 2) - \
147 sizeof (MSG_SCSI_IO_REQUEST) - \
148 sizeof (SGE_IO_UNION)) / sizeof (SGE_SIMPLE32))
151 * Convert a physical address returned from IOC to kvm address
152 * needed to access the data.
154 #define MPT_REPLY_PTOV(m, x) \
155 ((void *)(&m->reply[((x << 1) - m->reply_phys)]))
157 #define ccb_mpt_ptr sim_priv.entries[0].ptr
158 #define ccb_req_ptr sim_priv.entries[1].ptr
161 REQ_FREE, REQ_IN_PROGRESS, REQ_TIMEOUT, REQ_ON_CHIP, REQ_DONE
163 typedef struct req_entry {
164 u_int16_t index; /* Index of this entry */
165 union ccb * ccb; /* CAM request */
166 void * req_vbuf; /* Virtual Address of Entry */
167 void * sense_vbuf; /* Virtual Address of sense data */
168 bus_addr_t req_pbuf; /* Physical Address of Entry */
169 bus_addr_t sense_pbuf; /* Physical Address of sense data */
170 bus_dmamap_t dmap; /* DMA map for data buffer */
171 SLIST_ENTRY(req_entry) link; /* Pointer to next in list */
172 enum mpt_req_state debug; /* Debugging */
173 u_int32_t sequence; /* Sequence Number */
174 struct callout timeout;
178 /* Structure for saving proper values for modifyable PCI configuration registers */
181 u_int16_t LatencyTimer_LineSize;
183 u_int32_t Mem0_BAR[2];
184 u_int32_t Mem1_BAR[2];
190 typedef struct mpt_softc {
199 bus : 1; /* FC929/1030 have two busses */
204 u_int16_t mpt_global_credits;
205 u_int16_t request_frame_size;
206 u_int8_t mpt_max_devices;
207 u_int8_t mpt_max_buses;
212 u_int16_t mpt_ini_id;
216 * Device Configuration Information
220 fCONFIG_PAGE_SCSI_PORT_0 _port_page0;
221 fCONFIG_PAGE_SCSI_PORT_1 _port_page1;
222 fCONFIG_PAGE_SCSI_PORT_2 _port_page2;
223 fCONFIG_PAGE_SCSI_DEVICE_0 _dev_page0[16];
224 fCONFIG_PAGE_SCSI_DEVICE_1 _dev_page1[16];
225 uint16_t _tag_enable;
226 uint16_t _disc_enable;
227 uint16_t _update_params0;
228 uint16_t _update_params1;
230 #define mpt_port_page0 cfg.spi._port_page0
231 #define mpt_port_page1 cfg.spi._port_page1
232 #define mpt_port_page2 cfg.spi._port_page2
233 #define mpt_dev_page0 cfg.spi._dev_page0
234 #define mpt_dev_page1 cfg.spi._dev_page1
235 #define mpt_tag_enable cfg.spi._tag_enable
236 #define mpt_disc_enable cfg.spi._disc_enable
237 #define mpt_update_params0 cfg.spi._update_params0
238 #define mpt_update_params1 cfg.spi._update_params1
247 struct resource * pci_irq; /* Interrupt map for chip */
248 void * ih; /* Interupt handle */
249 struct mpt_pci_cfg pci_cfg; /* saved PCI conf registers */
255 struct resource * pci_reg; /* Register map for chip */
256 int pci_reg_id; /* Resource ID */
257 bus_space_tag_t pci_st; /* Bus tag for registers */
258 bus_space_handle_t pci_sh; /* Bus handle for registers */
259 vm_offset_t pci_pa; /* Physical Address */
261 bus_dma_tag_t parent_dmat; /* DMA tag for parent PCI bus */
262 bus_dma_tag_t reply_dmat; /* DMA tag for reply memory */
263 bus_dmamap_t reply_dmap; /* DMA map for reply memory */
264 char * reply; /* KVA of reply memory */
265 bus_addr_t reply_phys; /* BusAddr of reply memory */
268 bus_dma_tag_t buffer_dmat; /* DMA tag for buffers */
269 bus_dma_tag_t request_dmat; /* DMA tag for request memroy */
270 bus_dmamap_t request_dmap; /* DMA map for request memroy */
271 char * request; /* KVA of Request memory */
272 bus_addr_t request_phys; /* BusADdr of request memory */
275 * CAM && Software Management
278 request_t * request_pool;
279 SLIST_HEAD(req_queue, req_entry) request_free_list;
281 struct cam_sim * sim;
282 struct cam_path * path;
284 u_int32_t sequence; /* Sequence Number */
285 u_int32_t timeouts; /* timeout count */
286 u_int32_t success; /* successes afer timeout */
288 /* Opposing port in a 929 or 1030, or NULL */
289 struct mpt_softc * mpt2;
296 static INLINE void mpt_write(mpt_softc_t *, size_t, u_int32_t);
297 static INLINE u_int32_t mpt_read(mpt_softc_t *, int);
300 mpt_write(mpt_softc_t *mpt, size_t offset, u_int32_t val)
302 bus_space_write_4(mpt->pci_st, mpt->pci_sh, offset, val);
305 static INLINE u_int32_t
306 mpt_read(mpt_softc_t *mpt, int offset)
308 return (bus_space_read_4(mpt->pci_st, mpt->pci_sh, offset));
311 void mpt_cam_attach(mpt_softc_t *);
312 void mpt_cam_detach(mpt_softc_t *);
313 void mpt_done(mpt_softc_t *, u_int32_t);
314 void mpt_set_config_regs(mpt_softc_t *);
316 #endif /* _MPT_FREEBSD_H */