iir_pci.c revision 106537
1/* $FreeBSD: head/sys/dev/iir/iir_pci.c 106537 2002-11-06 22:42:45Z jhb $ */
2/*
3 *       Copyright (c) 2000-01 Intel Corporation
4 *       All Rights Reserved
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions, and the following disclaimer,
11 *    without modification, immediately at the beginning of the file.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 * 3. The name of the author may not be used to endorse or promote products
16 *    derived from this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
22 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * SUCH DAMAGE.
29 *
30 */
31
32/*
33 *  iir_pci.c:  PCI Bus Attachment for Intel Integrated RAID Controller driver
34 *
35 *  Written by: Achim Leubner <achim.leubner@intel.com>
36 *  Fixes/Additions: Boji Tony Kannanthanam <boji.t.kannanthanam@intel.com>
37 *
38 *  TODO:
39 */
40
41#ident "$Id: iir_pci.c 1.1 2001/05/22 20:14:12 achim Exp $"
42
43/* #include "opt_iir.h" */
44
45#include <sys/param.h>
46#include <sys/systm.h>
47#include <sys/endian.h>
48#include <sys/kernel.h>
49#include <sys/module.h>
50#include <sys/bus.h>
51
52#include <machine/bus_memio.h>
53#include <machine/bus_pio.h>
54#include <machine/bus.h>
55#include <machine/resource.h>
56#include <machine/clock.h>
57#include <sys/rman.h>
58
59#include <pci/pcireg.h>
60#include <pci/pcivar.h>
61
62#include <cam/scsi/scsi_all.h>
63
64#include <dev/iir/iir.h>
65
66/* Mapping registers for various areas */
67#define PCI_DPMEM       PCIR_MAPS
68
69/* Product numbers for Fibre-Channel are greater than or equal to 0x200 */
70#define GDT_PCI_PRODUCT_FC      0x200
71
72/* PCI SRAM structure */
73#define GDT_MAGIC       0x00    /* u_int32_t, controller ID from BIOS */
74#define GDT_NEED_DEINIT 0x04    /* u_int16_t, switch between BIOS/driver */
75#define GDT_SWITCH_SUPPORT 0x06 /* u_int8_t, see GDT_NEED_DEINIT */
76#define GDT_OS_USED     0x10    /* u_int8_t [16], OS code per service */
77#define GDT_FW_MAGIC    0x3c    /* u_int8_t, controller ID from firmware */
78#define GDT_SRAM_SZ     0x40
79
80/* DPRAM PCI controllers */
81#define GDT_DPR_IF      0x00    /* interface area */
82#define GDT_6SR         (0xff0 - GDT_SRAM_SZ)
83#define GDT_SEMA1       0xff1   /* volatile u_int8_t, command semaphore */
84#define GDT_IRQEN       0xff5   /* u_int8_t, board interrupts enable */
85#define GDT_EVENT       0xff8   /* u_int8_t, release event */
86#define GDT_IRQDEL      0xffc   /* u_int8_t, acknowledge board interrupt */
87#define GDT_DPRAM_SZ    0x1000
88
89/* PLX register structure (new PCI controllers) */
90#define GDT_CFG_REG     0x00    /* u_int8_t, DPRAM cfg. (2: < 1MB, 0: any) */
91#define GDT_SEMA0_REG   0x40    /* volatile u_int8_t, command semaphore */
92#define GDT_SEMA1_REG   0x41    /* volatile u_int8_t, status semaphore */
93#define GDT_PLX_STATUS  0x44    /* volatile u_int16_t, command status */
94#define GDT_PLX_SERVICE 0x46    /* u_int16_t, service */
95#define GDT_PLX_INFO    0x48    /* u_int32_t [2], additional info */
96#define GDT_LDOOR_REG   0x60    /* u_int8_t, PCI to local doorbell */
97#define GDT_EDOOR_REG   0x64    /* volatile u_int8_t, local to PCI doorbell */
98#define GDT_CONTROL0    0x68    /* u_int8_t, control0 register (unused) */
99#define GDT_CONTROL1    0x69    /* u_int8_t, board interrupts enable */
100#define GDT_PLX_SZ      0x80
101
102/* DPRAM new PCI controllers */
103#define GDT_IC          0x00    /* interface */
104#define GDT_PCINEW_6SR  (0x4000 - GDT_SRAM_SZ)
105                                /* SRAM structure */
106#define GDT_PCINEW_SZ   0x4000
107
108/* i960 register structure (PCI MPR controllers) */
109#define GDT_MPR_SEMA0   0x10    /* volatile u_int8_t, command semaphore */
110#define GDT_MPR_SEMA1   0x12    /* volatile u_int8_t, status semaphore */
111#define GDT_MPR_STATUS  0x14    /* volatile u_int16_t, command status */
112#define GDT_MPR_SERVICE 0x16    /* u_int16_t, service */
113#define GDT_MPR_INFO    0x18    /* u_int32_t [2], additional info */
114#define GDT_MPR_LDOOR   0x20    /* u_int8_t, PCI to local doorbell */
115#define GDT_MPR_EDOOR   0x2c    /* volatile u_int8_t, locl to PCI doorbell */
116#define GDT_EDOOR_EN    0x34    /* u_int8_t, board interrupts enable */
117#define GDT_SEVERITY    0xefc   /* u_int8_t, event severity */
118#define GDT_EVT_BUF     0xf00   /* u_int8_t [256], event buffer */
119#define GDT_I960_SZ     0x1000
120
121/* DPRAM PCI MPR controllers */
122#define GDT_I960R       0x00    /* 4KB i960 registers */
123#define GDT_MPR_IC      GDT_I960_SZ
124                                /* i960 register area */
125#define GDT_MPR_6SR     (GDT_I960_SZ + 0x3000 - GDT_SRAM_SZ)
126                                /* DPRAM struct. */
127#define GDT_MPR_SZ      (0x3000 - GDT_SRAM_SZ)
128
129static int      iir_pci_probe(device_t dev);
130static int      iir_pci_attach(device_t dev);
131
132void            gdt_pci_enable_intr(struct gdt_softc *);
133
134void            gdt_mpr_copy_cmd(struct gdt_softc *, struct gdt_ccb *);
135u_int8_t        gdt_mpr_get_status(struct gdt_softc *);
136void            gdt_mpr_intr(struct gdt_softc *, struct gdt_intr_ctx *);
137void            gdt_mpr_release_event(struct gdt_softc *);
138void            gdt_mpr_set_sema0(struct gdt_softc *);
139int             gdt_mpr_test_busy(struct gdt_softc *);
140
141static device_method_t iir_pci_methods[] = {
142        /* Device interface */
143        DEVMETHOD(device_probe,         iir_pci_probe),
144        DEVMETHOD(device_attach,        iir_pci_attach),
145        { 0, 0}
146};
147
148
149static  driver_t iir_pci_driver =
150{
151        "iir",
152        iir_pci_methods,
153        sizeof(struct gdt_softc)
154};
155
156static devclass_t iir_devclass;
157
158DRIVER_MODULE(iir, pci, iir_pci_driver, iir_devclass, 0, 0);
159
160static int
161iir_pci_probe(device_t dev)
162{
163    if (pci_get_vendor(dev) == INTEL_VENDOR_ID &&
164        pci_get_device(dev) == INTEL_DEVICE_ID_IIR) {
165        device_set_desc(dev, "Intel Integrated RAID Controller");
166        return (0);
167    }
168    if (pci_get_vendor(dev) == GDT_VENDOR_ID &&
169        ((pci_get_device(dev) >= GDT_DEVICE_ID_MIN &&
170        pci_get_device(dev) <= GDT_DEVICE_ID_MAX) ||
171        pci_get_device(dev) == GDT_DEVICE_ID_NEWRX)) {
172        device_set_desc(dev, "ICP Disk Array Controller");
173        return (0);
174    }
175    return (ENXIO);
176}
177
178
179static int
180iir_pci_attach(device_t dev)
181{
182    struct gdt_softc    *gdt;
183    struct resource     *io = NULL, *irq = NULL;
184    int                 retries, rid, error = 0;
185    void                *ih;
186    u_int8_t            protocol;
187
188    /* map DPMEM */
189    rid = PCI_DPMEM;
190    io = bus_alloc_resource(dev, SYS_RES_MEMORY, &rid, 0, ~0, 1, RF_ACTIVE);
191    if (io == NULL) {
192        device_printf(dev, "can't allocate register resources\n");
193        error = ENOMEM;
194        goto err;
195    }
196
197    /* get IRQ */
198    rid = 0;
199    irq = bus_alloc_resource(dev, SYS_RES_IRQ, &rid, 0, ~0, 1,
200                             RF_ACTIVE | RF_SHAREABLE);
201    if (io == NULL) {
202        device_printf(dev, "can't find IRQ value\n");
203        error = ENOMEM;
204        goto err;
205    }
206
207    gdt = device_get_softc(dev);
208    bzero(gdt, sizeof(struct gdt_softc));
209    gdt->sc_init_level = 0;
210    gdt->sc_dpmemt = rman_get_bustag(io);
211    gdt->sc_dpmemh = rman_get_bushandle(io);
212    gdt->sc_dpmembase = rman_get_start(io);
213    gdt->sc_hanum = device_get_unit(dev);
214    gdt->sc_bus = pci_get_bus(dev);
215    gdt->sc_slot = pci_get_slot(dev);
216    gdt->sc_device = pci_get_device(dev);
217    gdt->sc_subdevice = pci_get_subdevice(dev);
218    gdt->sc_class = GDT_MPR;
219/* no FC ctr.
220    if (gdt->sc_device >= GDT_PCI_PRODUCT_FC)
221        gdt->sc_class |= GDT_FC;
222*/
223
224    /* initialize RP controller */
225    /* check and reset interface area */
226    bus_space_write_4(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_IC,
227                      htole32(GDT_MPR_MAGIC));
228    if (bus_space_read_4(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_IC) !=
229        htole32(GDT_MPR_MAGIC)) {
230        printf("cannot access DPMEM at 0x%llx (shadowed?)\n",
231               (long long)gdt->sc_dpmembase);
232        error = ENXIO;
233        goto err;
234    }
235    bus_space_set_region_4(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_I960_SZ, htole32(0),
236                           GDT_MPR_SZ >> 2);
237
238    /* Disable everything */
239    bus_space_write_1(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_EDOOR_EN,
240                      bus_space_read_1(gdt->sc_dpmemt, gdt->sc_dpmemh,
241                                       GDT_EDOOR_EN) | 4);
242    bus_space_write_1(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_EDOOR, 0xff);
243    bus_space_write_1(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_IC + GDT_S_STATUS,
244                      0);
245    bus_space_write_1(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_IC + GDT_CMD_INDEX,
246                      0);
247
248    bus_space_write_4(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_IC + GDT_S_INFO,
249                      htole32(gdt->sc_dpmembase));
250    bus_space_write_1(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_IC + GDT_S_CMD_INDX,
251                      0xff);
252    bus_space_write_1(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_LDOOR, 1);
253
254    DELAY(20);
255    retries = GDT_RETRIES;
256    while (bus_space_read_1(gdt->sc_dpmemt, gdt->sc_dpmemh,
257                            GDT_MPR_IC + GDT_S_STATUS) != 0xff) {
258        if (--retries == 0) {
259            printf("DEINIT failed\n");
260            error = ENXIO;
261            goto err;
262        }
263        DELAY(1);
264    }
265
266    protocol = (u_int8_t)letoh32(bus_space_read_4(gdt->sc_dpmemt, gdt->sc_dpmemh,
267                                                  GDT_MPR_IC + GDT_S_INFO));
268    bus_space_write_1(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_IC + GDT_S_STATUS,
269                      0);
270    if (protocol != GDT_PROTOCOL_VERSION) {
271        printf("unsupported protocol %d\n", protocol);
272        error = ENXIO;
273        goto err;
274    }
275
276    /* special commnd to controller BIOS */
277    bus_space_write_4(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_IC + GDT_S_INFO,
278                      htole32(0));
279    bus_space_write_4(gdt->sc_dpmemt, gdt->sc_dpmemh,
280                      GDT_MPR_IC + GDT_S_INFO + sizeof (u_int32_t), htole32(0));
281    bus_space_write_4(gdt->sc_dpmemt, gdt->sc_dpmemh,
282                      GDT_MPR_IC + GDT_S_INFO + 2 * sizeof (u_int32_t),
283                      htole32(1));
284    bus_space_write_4(gdt->sc_dpmemt, gdt->sc_dpmemh,
285                      GDT_MPR_IC + GDT_S_INFO + 3 * sizeof (u_int32_t),
286                      htole32(0));
287    bus_space_write_1(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_IC + GDT_S_CMD_INDX,
288                      0xfe);
289    bus_space_write_1(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_LDOOR, 1);
290
291    DELAY(20);
292    retries = GDT_RETRIES;
293    while (bus_space_read_1(gdt->sc_dpmemt, gdt->sc_dpmemh,
294                            GDT_MPR_IC + GDT_S_STATUS) != 0xfe) {
295        if (--retries == 0) {
296            printf("initialization error\n");
297            error = ENXIO;
298            goto err;
299        }
300        DELAY(1);
301    }
302
303    bus_space_write_1(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_IC + GDT_S_STATUS,
304                      0);
305
306    gdt->sc_ic_all_size = GDT_MPR_SZ;
307
308    gdt->sc_copy_cmd = gdt_mpr_copy_cmd;
309    gdt->sc_get_status = gdt_mpr_get_status;
310    gdt->sc_intr = gdt_mpr_intr;
311    gdt->sc_release_event = gdt_mpr_release_event;
312    gdt->sc_set_sema0 = gdt_mpr_set_sema0;
313    gdt->sc_test_busy = gdt_mpr_test_busy;
314
315    /* Allocate a dmatag representing the capabilities of this attachment */
316    /* XXX Should be a child of the PCI bus dma tag */
317    if (bus_dma_tag_create(/*parent*/NULL, /*alignemnt*/1, /*boundary*/0,
318                           /*lowaddr*/BUS_SPACE_MAXADDR_32BIT,
319                           /*highaddr*/BUS_SPACE_MAXADDR,
320                           /*filter*/NULL, /*filterarg*/NULL,
321                           /*maxsize*/BUS_SPACE_MAXSIZE_32BIT,
322                           /*nsegments*/GDT_MAXSG,
323                           /*maxsegsz*/BUS_SPACE_MAXSIZE_32BIT,
324                           /*flags*/0, &gdt->sc_parent_dmat) != 0) {
325        error = ENXIO;
326        goto err;
327    }
328    gdt->sc_init_level++;
329
330    if (iir_init(gdt) != 0) {
331        iir_free(gdt);
332        error = ENXIO;
333        goto err;
334    }
335
336    /* Register with the XPT */
337    iir_attach(gdt);
338
339    /* associate interrupt handler */
340    if (bus_setup_intr( dev, irq, INTR_TYPE_CAM,
341                        iir_intr, gdt, &ih )) {
342        device_printf(dev, "Unable to register interrupt handler\n");
343        error = ENXIO;
344        goto err;
345    }
346
347    gdt_pci_enable_intr(gdt);
348    return (0);
349
350err:
351    if (irq)
352        bus_release_resource( dev, SYS_RES_IRQ, 0, irq );
353/*
354    if (io)
355        bus_release_resource( dev, SYS_RES_MEMORY, rid, io );
356*/
357    return (error);
358}
359
360
361/* Enable interrupts */
362void
363gdt_pci_enable_intr(struct gdt_softc *gdt)
364{
365    GDT_DPRINTF(GDT_D_INTR, ("gdt_pci_enable_intr(%p) ", gdt));
366
367    switch(GDT_CLASS(gdt)) {
368      case GDT_MPR:
369        bus_space_write_1(gdt->sc_dpmemt, gdt->sc_dpmemh,
370                          GDT_MPR_EDOOR, 0xff);
371        bus_space_write_1(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_EDOOR_EN,
372                          bus_space_read_1(gdt->sc_dpmemt, gdt->sc_dpmemh,
373                                           GDT_EDOOR_EN) & ~4);
374        break;
375    }
376}
377
378
379/*
380 * MPR PCI controller-specific functions
381 */
382
383void
384gdt_mpr_copy_cmd(struct gdt_softc *gdt, struct gdt_ccb *ccb)
385{
386    u_int16_t cp_count = roundup(gdt->sc_cmd_len, sizeof (u_int32_t));
387    u_int16_t dp_offset = gdt->sc_cmd_off;
388    u_int16_t cmd_no = gdt->sc_cmd_cnt++;
389
390    GDT_DPRINTF(GDT_D_CMD, ("gdt_mpr_copy_cmd(%p) ", gdt));
391
392    gdt->sc_cmd_off += cp_count;
393
394    bus_space_write_2(gdt->sc_dpmemt, gdt->sc_dpmemh,
395                      GDT_MPR_IC + GDT_COMM_QUEUE + cmd_no * GDT_COMM_Q_SZ + GDT_OFFSET,
396                      htole16(GDT_DPMEM_COMMAND_OFFSET + dp_offset));
397    bus_space_write_2(gdt->sc_dpmemt, gdt->sc_dpmemh,
398                      GDT_MPR_IC + GDT_COMM_QUEUE + cmd_no * GDT_COMM_Q_SZ + GDT_SERV_ID,
399                      htole16(ccb->gc_service));
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 *)gdt->sc_cmd, cp_count >> 2);
403}
404
405u_int8_t
406gdt_mpr_get_status(struct gdt_softc *gdt)
407{
408    GDT_DPRINTF(GDT_D_MISC, ("gdt_mpr_get_status(%p) ", gdt));
409
410    return bus_space_read_1(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_EDOOR);
411}
412
413void
414gdt_mpr_intr(struct gdt_softc *gdt, struct gdt_intr_ctx *ctx)
415{
416    int i;
417
418    GDT_DPRINTF(GDT_D_INTR, ("gdt_mpr_intr(%p) ", gdt));
419
420    if (ctx->istatus & 0x80) {          /* error flag */
421        ctx->istatus &= ~0x80;
422        ctx->cmd_status = bus_space_read_2(gdt->sc_dpmemt,
423                                           gdt->sc_dpmemh, GDT_MPR_STATUS);
424    } else                                      /* no error */
425        ctx->cmd_status = GDT_S_OK;
426
427    ctx->info =
428        bus_space_read_4(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_INFO);
429    ctx->service =
430        bus_space_read_2(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_SERVICE);
431    ctx->info2 =
432        bus_space_read_4(gdt->sc_dpmemt, gdt->sc_dpmemh,
433                         GDT_MPR_INFO + sizeof (u_int32_t));
434
435    /* event string */
436    if (ctx->istatus == GDT_ASYNCINDEX) {
437        if (ctx->service != GDT_SCREENSERVICE &&
438            (gdt->sc_fw_vers & 0xff) >= 0x1a) {
439            gdt->sc_dvr.severity =
440                bus_space_read_1(gdt->sc_dpmemt,gdt->sc_dpmemh, GDT_SEVERITY);
441            for (i = 0; i < 256; ++i) {
442                gdt->sc_dvr.event_string[i] =
443                    bus_space_read_1(gdt->sc_dpmemt, gdt->sc_dpmemh,
444                                     GDT_EVT_BUF + i);
445                if (gdt->sc_dvr.event_string[i] == 0)
446                    break;
447            }
448        }
449    }
450    bus_space_write_1(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_EDOOR, 0xff);
451    bus_space_write_1(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_SEMA1, 0);
452}
453
454void
455gdt_mpr_release_event(struct gdt_softc *gdt)
456{
457    GDT_DPRINTF(GDT_D_MISC, ("gdt_mpr_release_event(%p) ", gdt));
458
459    bus_space_write_1(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_LDOOR, 1);
460}
461
462void
463gdt_mpr_set_sema0(struct gdt_softc *gdt)
464{
465    GDT_DPRINTF(GDT_D_MISC, ("gdt_mpr_set_sema0(%p) ", gdt));
466
467    bus_space_write_1(gdt->sc_dpmemt, gdt->sc_dpmemh, GDT_MPR_SEMA0, 1);
468}
469
470int
471gdt_mpr_test_busy(struct gdt_softc *gdt)
472{
473    GDT_DPRINTF(GDT_D_MISC, ("gdt_mpr_test_busy(%p) ", gdt));
474
475    return (bus_space_read_1(gdt->sc_dpmemt, gdt->sc_dpmemh,
476                             GDT_MPR_SEMA0) & 1);
477}
478