2 * Copyright (c) 2000-03 ICP vortex GmbH
3 * Copyright (c) 2002-03 Intel Corporation
4 * Copyright (c) 2003 Adaptec Inc.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions, and the following disclaimer,
12 * without modification, immediately at the beginning of the file.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. 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
28 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 #ident "$Id: iir_pci.c 1.2 2003/08/26 12:29:55 achim Exp $"
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
37 * iir_pci.c: PCI Bus Attachment for Intel Integrated RAID Controller driver
39 * Written by: Achim Leubner <achim.leubner@intel.com>
40 * Written by: Achim Leubner <achim_leubner@adaptec.com>
41 * Fixes/Additions: Boji Tony Kannanthanam <boji.t.kannanthanam@intel.com>
46 /* #include "opt_iir.h" */
48 #include <sys/param.h>
49 #include <sys/systm.h>
50 #include <sys/endian.h>
51 #include <sys/kernel.h>
53 #include <sys/mutex.h>
54 #include <sys/module.h>
57 #include <machine/bus.h>
58 #include <machine/resource.h>
61 #include <dev/pci/pcireg.h>
62 #include <dev/pci/pcivar.h>
64 #include <cam/scsi/scsi_all.h>
66 #include <dev/iir/iir.h>
68 /* Mapping registers for various areas */
69 #define PCI_DPMEM PCIR_BAR(0)
71 /* Product numbers for Fibre-Channel are greater than or equal to 0x200 */
72 #define GDT_PCI_PRODUCT_FC 0x200
74 /* PCI SRAM structure */
75 #define GDT_MAGIC 0x00 /* u_int32_t, controller ID from BIOS */
76 #define GDT_NEED_DEINIT 0x04 /* u_int16_t, switch between BIOS/driver */
77 #define GDT_SWITCH_SUPPORT 0x06 /* u_int8_t, see GDT_NEED_DEINIT */
78 #define GDT_OS_USED 0x10 /* u_int8_t [16], OS code per service */
79 #define GDT_FW_MAGIC 0x3c /* u_int8_t, controller ID from firmware */
80 #define GDT_SRAM_SZ 0x40
82 /* DPRAM PCI controllers */
83 #define GDT_DPR_IF 0x00 /* interface area */
84 #define GDT_6SR (0xff0 - GDT_SRAM_SZ)
85 #define GDT_SEMA1 0xff1 /* volatile u_int8_t, command semaphore */
86 #define GDT_IRQEN 0xff5 /* u_int8_t, board interrupts enable */
87 #define GDT_EVENT 0xff8 /* u_int8_t, release event */
88 #define GDT_IRQDEL 0xffc /* u_int8_t, acknowledge board interrupt */
89 #define GDT_DPRAM_SZ 0x1000
91 /* PLX register structure (new PCI controllers) */
92 #define GDT_CFG_REG 0x00 /* u_int8_t, DPRAM cfg. (2: < 1MB, 0: any) */
93 #define GDT_SEMA0_REG 0x40 /* volatile u_int8_t, command semaphore */
94 #define GDT_SEMA1_REG 0x41 /* volatile u_int8_t, status semaphore */
95 #define GDT_PLX_STATUS 0x44 /* volatile u_int16_t, command status */
96 #define GDT_PLX_SERVICE 0x46 /* u_int16_t, service */
97 #define GDT_PLX_INFO 0x48 /* u_int32_t [2], additional info */
98 #define GDT_LDOOR_REG 0x60 /* u_int8_t, PCI to local doorbell */
99 #define GDT_EDOOR_REG 0x64 /* volatile u_int8_t, local to PCI doorbell */
100 #define GDT_CONTROL0 0x68 /* u_int8_t, control0 register (unused) */
101 #define GDT_CONTROL1 0x69 /* u_int8_t, board interrupts enable */
102 #define GDT_PLX_SZ 0x80
104 /* DPRAM new PCI controllers */
105 #define GDT_IC 0x00 /* interface */
106 #define GDT_PCINEW_6SR (0x4000 - GDT_SRAM_SZ)
108 #define GDT_PCINEW_SZ 0x4000
110 /* i960 register structure (PCI MPR controllers) */
111 #define GDT_MPR_SEMA0 0x10 /* volatile u_int8_t, command semaphore */
112 #define GDT_MPR_SEMA1 0x12 /* volatile u_int8_t, status semaphore */
113 #define GDT_MPR_STATUS 0x14 /* volatile u_int16_t, command status */
114 #define GDT_MPR_SERVICE 0x16 /* u_int16_t, service */
115 #define GDT_MPR_INFO 0x18 /* u_int32_t [2], additional info */
116 #define GDT_MPR_LDOOR 0x20 /* u_int8_t, PCI to local doorbell */
117 #define GDT_MPR_EDOOR 0x2c /* volatile u_int8_t, locl to PCI doorbell */
118 #define GDT_EDOOR_EN 0x34 /* u_int8_t, board interrupts enable */
119 #define GDT_SEVERITY 0xefc /* u_int8_t, event severity */
120 #define GDT_EVT_BUF 0xf00 /* u_int8_t [256], event buffer */
121 #define GDT_I960_SZ 0x1000
123 /* DPRAM PCI MPR controllers */
124 #define GDT_I960R 0x00 /* 4KB i960 registers */
125 #define GDT_MPR_IC GDT_I960_SZ
126 /* i960 register area */
127 #define GDT_MPR_6SR (GDT_I960_SZ + 0x3000 - GDT_SRAM_SZ)
129 #define GDT_MPR_SZ (0x3000 - GDT_SRAM_SZ)
131 static int iir_pci_probe(device_t dev);
132 static int iir_pci_attach(device_t dev);
134 void gdt_pci_enable_intr(struct gdt_softc *);
136 void gdt_mpr_copy_cmd(struct gdt_softc *, struct gdt_ccb *);
137 u_int8_t gdt_mpr_get_status(struct gdt_softc *);
138 void gdt_mpr_intr(struct gdt_softc *, struct gdt_intr_ctx *);
139 void gdt_mpr_release_event(struct gdt_softc *);
140 void gdt_mpr_set_sema0(struct gdt_softc *);
141 int gdt_mpr_test_busy(struct gdt_softc *);
143 static device_method_t iir_pci_methods[] = {
144 /* Device interface */
145 DEVMETHOD(device_probe, iir_pci_probe),
146 DEVMETHOD(device_attach, iir_pci_attach),
151 static driver_t iir_pci_driver =
155 sizeof(struct gdt_softc)
158 static devclass_t iir_devclass;
160 DRIVER_MODULE(iir, pci, iir_pci_driver, iir_devclass, 0, 0);
161 MODULE_DEPEND(iir, pci, 1, 1, 1);
162 MODULE_DEPEND(iir, cam, 1, 1, 1);
165 iir_pci_probe(device_t dev)
167 if (pci_get_vendor(dev) == INTEL_VENDOR_ID &&
168 pci_get_device(dev) == INTEL_DEVICE_ID_IIR) {
169 device_set_desc(dev, "Intel Integrated RAID Controller");
170 return (BUS_PROBE_DEFAULT);
172 if (pci_get_vendor(dev) == GDT_VENDOR_ID &&
173 ((pci_get_device(dev) >= GDT_DEVICE_ID_MIN &&
174 pci_get_device(dev) <= GDT_DEVICE_ID_MAX) ||
175 pci_get_device(dev) == GDT_DEVICE_ID_NEWRX)) {
176 device_set_desc(dev, "ICP Disk Array Controller");
177 return (BUS_PROBE_DEFAULT);
184 iir_pci_attach(device_t dev)
186 struct gdt_softc *gdt;
187 struct resource *io = NULL, *irq = NULL;
188 int retries, rid, error = 0;
194 io = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE);
196 device_printf(dev, "can't allocate register resources\n");
203 irq = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
204 RF_ACTIVE | RF_SHAREABLE);
206 device_printf(dev, "can't find IRQ value\n");
211 gdt = device_get_softc(dev);
212 gdt->sc_devnode = dev;
213 gdt->sc_init_level = 0;
214 gdt->sc_dpmemt = rman_get_bustag(io);
215 gdt->sc_dpmemh = rman_get_bushandle(io);
216 gdt->sc_dpmembase = rman_get_start(io);
217 gdt->sc_hanum = device_get_unit(dev);
218 gdt->sc_bus = pci_get_bus(dev);
219 gdt->sc_slot = pci_get_slot(dev);
220 gdt->sc_vendor = pci_get_vendor(dev);
221 gdt->sc_device = pci_get_device(dev);
222 gdt->sc_subdevice = pci_get_subdevice(dev);
223 gdt->sc_class = GDT_MPR;
225 if (gdt->sc_device >= GDT_PCI_PRODUCT_FC)
226 gdt->sc_class |= GDT_FC;
229 /* initialize RP controller */
230 /* check and reset interface area */
231 bus_space_write_4(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_IC,
232 htole32(GDT_MPR_MAGIC));
233 if (bus_space_read_4(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_IC) !=
234 htole32(GDT_MPR_MAGIC)) {
235 printf("cannot access DPMEM at 0x%jx (shadowed?)\n",
236 (uintmax_t)gdt->sc_dpmembase);
240 bus_space_set_region_4(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_I960_SZ, htole32(0),
243 /* Disable everything */
244 bus_space_write_1(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_EDOOR_EN,
245 bus_space_read_1(gdt->sc_dpmemt, gdt->sc_dpmemh,
247 bus_space_write_1(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_EDOOR, 0xff);
248 bus_space_write_1(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_IC + GDT_S_STATUS,
250 bus_space_write_1(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_IC + GDT_CMD_INDEX,
253 bus_space_write_4(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_IC + GDT_S_INFO,
254 htole32(gdt->sc_dpmembase));
255 bus_space_write_1(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_IC + GDT_S_CMD_INDX,
257 bus_space_write_1(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_LDOOR, 1);
260 retries = GDT_RETRIES;
261 while (bus_space_read_1(gdt->sc_dpmemt, gdt->sc_dpmemh,
262 GDT_MPR_IC + GDT_S_STATUS) != 0xff) {
263 if (--retries == 0) {
264 printf("DEINIT failed\n");
271 protocol = (uint8_t)le32toh(bus_space_read_4(gdt->sc_dpmemt, gdt->sc_dpmemh,
272 GDT_MPR_IC + GDT_S_INFO));
273 bus_space_write_1(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_IC + GDT_S_STATUS,
275 if (protocol != GDT_PROTOCOL_VERSION) {
276 printf("unsupported protocol %d\n", protocol);
281 /* special commnd to controller BIOS */
282 bus_space_write_4(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_IC + GDT_S_INFO,
284 bus_space_write_4(gdt->sc_dpmemt, gdt->sc_dpmemh,
285 GDT_MPR_IC + GDT_S_INFO + sizeof (u_int32_t), htole32(0));
286 bus_space_write_4(gdt->sc_dpmemt, gdt->sc_dpmemh,
287 GDT_MPR_IC + GDT_S_INFO + 2 * sizeof (u_int32_t),
289 bus_space_write_4(gdt->sc_dpmemt, gdt->sc_dpmemh,
290 GDT_MPR_IC + GDT_S_INFO + 3 * sizeof (u_int32_t),
292 bus_space_write_1(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_IC + GDT_S_CMD_INDX,
294 bus_space_write_1(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_LDOOR, 1);
297 retries = GDT_RETRIES;
298 while (bus_space_read_1(gdt->sc_dpmemt, gdt->sc_dpmemh,
299 GDT_MPR_IC + GDT_S_STATUS) != 0xfe) {
300 if (--retries == 0) {
301 printf("initialization error\n");
308 bus_space_write_1(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_IC + GDT_S_STATUS,
311 gdt->sc_ic_all_size = GDT_MPR_SZ;
313 gdt->sc_copy_cmd = gdt_mpr_copy_cmd;
314 gdt->sc_get_status = gdt_mpr_get_status;
315 gdt->sc_intr = gdt_mpr_intr;
316 gdt->sc_release_event = gdt_mpr_release_event;
317 gdt->sc_set_sema0 = gdt_mpr_set_sema0;
318 gdt->sc_test_busy = gdt_mpr_test_busy;
320 /* Allocate a dmatag representing the capabilities of this attachment */
321 /* XXX Should be a child of the PCI bus dma tag */
322 if (bus_dma_tag_create(/*parent*/NULL, /*alignemnt*/1, /*boundary*/0,
323 /*lowaddr*/BUS_SPACE_MAXADDR_32BIT,
324 /*highaddr*/BUS_SPACE_MAXADDR,
325 /*filter*/NULL, /*filterarg*/NULL,
326 /*maxsize*/BUS_SPACE_MAXSIZE_32BIT,
327 /*nsegments*/GDT_MAXSG,
328 /*maxsegsz*/BUS_SPACE_MAXSIZE_32BIT,
329 /*flags*/0, /*lockfunc*/busdma_lock_mutex,
330 /*lockarg*/&Giant, &gdt->sc_parent_dmat) != 0) {
334 gdt->sc_init_level++;
336 if (iir_init(gdt) != 0) {
342 /* Register with the XPT */
345 /* associate interrupt handler */
346 if (bus_setup_intr( dev, irq, INTR_TYPE_CAM,
347 NULL, iir_intr, gdt, &ih )) {
348 device_printf(dev, "Unable to register interrupt handler\n");
353 gdt_pci_enable_intr(gdt);
358 bus_release_resource( dev, SYS_RES_IRQ, 0, irq );
361 bus_release_resource( dev, SYS_RES_MEMORY, rid, io );
367 /* Enable interrupts */
369 gdt_pci_enable_intr(struct gdt_softc *gdt)
371 GDT_DPRINTF(GDT_D_INTR, ("gdt_pci_enable_intr(%p) ", gdt));
373 switch(GDT_CLASS(gdt)) {
375 bus_space_write_1(gdt->sc_dpmemt, gdt->sc_dpmemh,
376 GDT_MPR_EDOOR, 0xff);
377 bus_space_write_1(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_EDOOR_EN,
378 bus_space_read_1(gdt->sc_dpmemt, gdt->sc_dpmemh,
386 * MPR PCI controller-specific functions
390 gdt_mpr_copy_cmd(struct gdt_softc *gdt, struct gdt_ccb *gccb)
392 u_int16_t cp_count = roundup(gccb->gc_cmd_len, sizeof (u_int32_t));
393 u_int16_t dp_offset = gdt->sc_cmd_off;
394 u_int16_t cmd_no = gdt->sc_cmd_cnt++;
396 GDT_DPRINTF(GDT_D_CMD, ("gdt_mpr_copy_cmd(%p) ", gdt));
398 gdt->sc_cmd_off += cp_count;
400 bus_space_write_region_4(gdt->sc_dpmemt, gdt->sc_dpmemh,
401 GDT_MPR_IC + GDT_DPR_CMD + dp_offset,
402 (u_int32_t *)gccb->gc_cmd, cp_count >> 2);
403 bus_space_write_2(gdt->sc_dpmemt, gdt->sc_dpmemh,
404 GDT_MPR_IC + GDT_COMM_QUEUE + cmd_no * GDT_COMM_Q_SZ + GDT_OFFSET,
405 htole16(GDT_DPMEM_COMMAND_OFFSET + dp_offset));
406 bus_space_write_2(gdt->sc_dpmemt, gdt->sc_dpmemh,
407 GDT_MPR_IC + GDT_COMM_QUEUE + cmd_no * GDT_COMM_Q_SZ + GDT_SERV_ID,
408 htole16(gccb->gc_service));
412 gdt_mpr_get_status(struct gdt_softc *gdt)
414 GDT_DPRINTF(GDT_D_MISC, ("gdt_mpr_get_status(%p) ", gdt));
416 return bus_space_read_1(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_EDOOR);
420 gdt_mpr_intr(struct gdt_softc *gdt, struct gdt_intr_ctx *ctx)
424 GDT_DPRINTF(GDT_D_INTR, ("gdt_mpr_intr(%p) ", gdt));
426 bus_space_write_1(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_EDOOR, 0xff);
428 if (ctx->istatus & 0x80) { /* error flag */
429 ctx->istatus &= ~0x80;
430 ctx->cmd_status = bus_space_read_2(gdt->sc_dpmemt,
431 gdt->sc_dpmemh, GDT_MPR_STATUS);
432 } else /* no error */
433 ctx->cmd_status = GDT_S_OK;
436 bus_space_read_4(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_INFO);
438 bus_space_read_2(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_SERVICE);
440 bus_space_read_4(gdt->sc_dpmemt, gdt->sc_dpmemh,
441 GDT_MPR_INFO + sizeof (u_int32_t));
444 if (ctx->istatus == GDT_ASYNCINDEX) {
445 if (ctx->service != GDT_SCREENSERVICE &&
446 (gdt->sc_fw_vers & 0xff) >= 0x1a) {
447 gdt->sc_dvr.severity =
448 bus_space_read_1(gdt->sc_dpmemt,gdt->sc_dpmemh, GDT_SEVERITY);
449 for (i = 0; i < 256; ++i) {
450 gdt->sc_dvr.event_string[i] =
451 bus_space_read_1(gdt->sc_dpmemt, gdt->sc_dpmemh,
453 if (gdt->sc_dvr.event_string[i] == 0)
458 bus_space_write_1(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_SEMA1, 0);
462 gdt_mpr_release_event(struct gdt_softc *gdt)
464 GDT_DPRINTF(GDT_D_MISC, ("gdt_mpr_release_event(%p) ", gdt));
466 bus_space_write_1(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_LDOOR, 1);
470 gdt_mpr_set_sema0(struct gdt_softc *gdt)
472 GDT_DPRINTF(GDT_D_MISC, ("gdt_mpr_set_sema0(%p) ", gdt));
474 bus_space_write_1(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_SEMA0, 1);
478 gdt_mpr_test_busy(struct gdt_softc *gdt)
480 GDT_DPRINTF(GDT_D_MISC, ("gdt_mpr_test_busy(%p) ", gdt));
482 return (bus_space_read_1(gdt->sc_dpmemt, gdt->sc_dpmemh,