kernel: Add D_MPSAFE to the ops of mfi(4), mrsas(4) and twa(4).
[dragonfly.git] / sys / dev / raid / ida / idavar.h
1 /*-
2  * Copyright (c) 1999,2000 Jonathan Lemon
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD: src/sys/dev/ida/idavar.h,v 1.3.2.4 2001/07/30 20:29:58 jlemon Exp $
27  */
28
29 /*
30  * software structures for the Compaq RAID controller
31  */
32
33 #ifndef _IDAVAR_H
34 #define _IDAVAR_H
35
36 #define ida_inb(ida, port) \
37         bus_space_read_1((ida)->tag, (ida)->bsh, port)
38 #define ida_inw(ida, port) \
39         bus_space_read_2((ida)->tag, (ida)->bsh, port)
40 #define ida_inl(ida, port) \
41         bus_space_read_4((ida)->tag, (ida)->bsh, port)
42
43 #define ida_outb(ida, port, val) \
44         bus_space_write_1((ida)->tag, (ida)->bsh, port, val)
45 #define ida_outw(ida, port, val) \
46         bus_space_write_2((ida)->tag, (ida)->bsh, port, val)
47 #define ida_outl(ida, port, val) \
48         bus_space_write_4((ida)->tag, (ida)->bsh, port, val)
49
50 struct ida_hdr {
51         u_int8_t        drive;          /* logical drive */
52         u_int8_t        priority;       /* block priority */
53         u_int16_t       size;           /* size of request, in words */
54 };
55
56 struct ida_req {
57         u_int16_t       next;           /* offset of next request */
58         u_int8_t        command;        /* command */
59         u_int8_t        error;          /* return error code */
60         u_int32_t       blkno;          /* block number */
61         u_int16_t       bcount;         /* block count */
62         u_int8_t        sgcount;        /* number of scatter/gather entries */
63         u_int8_t        spare;          /* reserved */
64 };
65
66 struct ida_sgb {
67         u_int32_t       length;         /* length of S/G segment */
68         u_int32_t       addr;           /* physical address of block */
69 };
70
71 #define IDA_NSEG        32              /* maximum number of segments */
72
73 /*
74  * right now, this structure totals 276 bytes.
75  */
76 struct ida_hardware_qcb {
77         struct  ida_hdr hdr;                    /*   4 */
78         struct  ida_req req;                    /*  12 */
79         struct  ida_sgb seg[IDA_NSEG];          /* 256 */
80         struct  ida_qcb *qcb;                   /*   4 - qcb backpointer */ 
81 };
82
83 typedef enum {
84         QCB_FREE                = 0x0000,
85         QCB_ACTIVE              = 0x0001,       /* waiting for completion */
86 } qcb_state;
87
88 #define DMA_DATA_IN     0x0001
89 #define DMA_DATA_OUT    0x0002
90 #define IDA_COMMAND     0x0004
91 #define DMA_DATA_TRANSFER       (DMA_DATA_IN | DMA_DATA_OUT)
92
93 #define IDA_QCB_MAX     256
94 #define IDA_CONTROLLER  0               /* drive "number" for controller */
95
96 struct ida_qcb {
97         struct          ida_hardware_qcb *hwqcb;
98         qcb_state       state;
99         short           flags;
100         union {
101                 STAILQ_ENTRY(ida_qcb) stqe;
102                 SLIST_ENTRY(ida_qcb) sle;
103         } link;
104         bus_dmamap_t    dmamap;
105         bus_addr_t      hwqcb_busaddr;
106         struct          bio *bio;               /* bio associated with qcb */
107 };
108
109 struct ida_softc;
110
111 struct ida_access {
112         int             (*fifo_full)(struct ida_softc *);
113         void            (*submit)(struct ida_softc *, struct ida_qcb *);
114         bus_addr_t      (*done)(struct ida_softc *);
115         int             (*int_pending)(struct ida_softc *);
116         void            (*int_enable)(struct ida_softc *, int);
117 };
118
119 /*
120  * flags for the controller 
121  */
122 #define IDA_ATTACHED    0x01            /* attached */
123 #define IDA_FIRMWARE    0x02            /* firmware must be started */
124 #define IDA_INTERRUPTS  0x04            /* interrupts enabled */
125
126 struct ida_softc {
127         device_t        dev;
128         int             unit;
129
130         int             regs_res_type;
131         int             regs_res_id;
132         struct          resource *regs;
133
134         int             irq_res_type;
135         struct          resource *irq;
136         void            *ih;
137
138         bus_space_tag_t         tag;
139         bus_space_handle_t      bsh;
140
141         /* various DMA tags */
142         bus_dma_tag_t   parent_dmat;
143         bus_dma_tag_t   buffer_dmat;
144
145         bus_dma_tag_t   hwqcb_dmat;
146         bus_dmamap_t    hwqcb_dmamap;
147         bus_addr_t      hwqcb_busaddr;
148
149         bus_dma_tag_t   sg_dmat;
150
151         int             num_drives;
152         int             num_qcbs;
153         int             flags;
154
155         struct          ida_hardware_qcb *hwqcbs;       /* HW QCB array */
156         struct          ida_qcb *qcbs;                  /* kernel QCB array */
157         SLIST_HEAD(, ida_qcb)   free_qcbs;      
158         STAILQ_HEAD(, ida_qcb)  qcb_queue;
159         struct          bio_queue_head bio_queue;
160
161         struct          ida_access cmd;
162 };
163
164 /*
165  * drive flags
166  */
167 #define DRV_WRITEPROT           0x0001
168
169 struct idad_softc {
170         device_t        dev;
171         struct          ida_softc *controller;
172         struct          disk disk;
173         struct          devstat stats;
174         int             drive;                  /* per controller */
175         int             unit;                   /* global */
176         int             cylinders;
177         int             heads;
178         int             sectors;
179         int             secsize;
180         int             secperunit;
181         int             flags;
182 };
183
184 struct ida_board {
185         u_int32_t       board;
186         char            *desc;
187         struct          ida_access *accessor;
188         int             flags;
189 };
190
191 extern int ida_detach(device_t dev);
192 extern void ida_free(struct ida_softc *ida);
193 extern int ida_init(struct ida_softc *ida);
194 extern void ida_attach(struct ida_softc *ida); 
195 extern int ida_command(struct ida_softc *ida, int command, void *data,
196         int datasize, int drive, u_int64_t pblkno, int flags);
197 extern void ida_submit_buf(struct ida_softc *ida, struct bio *bio);
198 extern void ida_intr(void *data);
199
200 extern void idad_intr(struct bio *bio);
201
202 #endif /* _IDAVAR_H */