xref: /freebsd/sys/dev/mlx/mlx_disk.c (revision 23f282aa31e9b6fceacd449020e936e98d6f2298)
1 /*-
2  * Copyright (c) 1999 Jonathan Lemon
3  * Copyright (c) 1999 Michael Smith
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  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  *
27  * $FreeBSD$
28  */
29 
30 /*
31  * Disk driver for Mylex DAC960 RAID adapters.
32  */
33 
34 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/kernel.h>
37 
38 #include <sys/buf.h>
39 #include <sys/bus.h>
40 #include <sys/conf.h>
41 #include <sys/devicestat.h>
42 #include <sys/disk.h>
43 
44 #include <machine/bus.h>
45 #include <machine/clock.h>
46 #include <sys/rman.h>
47 
48 #include <dev/mlx/mlxio.h>
49 #include <dev/mlx/mlxvar.h>
50 #include <dev/mlx/mlxreg.h>
51 
52 /* prototypes */
53 static int mlxd_probe(device_t dev);
54 static int mlxd_attach(device_t dev);
55 static int mlxd_detach(device_t dev);
56 
57 static	d_open_t	mlxd_open;
58 static	d_close_t	mlxd_close;
59 static	d_strategy_t	mlxd_strategy;
60 static	d_ioctl_t	mlxd_ioctl;
61 
62 #define MLXD_BDEV_MAJOR	27
63 #define MLXD_CDEV_MAJOR	131
64 
65 static struct cdevsw mlxd_cdevsw = {
66 		/* open */	mlxd_open,
67 		/* close */	mlxd_close,
68 		/* read */	physread,
69 		/* write */	physwrite,
70 		/* ioctl */	mlxd_ioctl,
71 		/* poll */	nopoll,
72 		/* mmap */	nommap,
73 		/* strategy */	mlxd_strategy,
74 		/* name */ 	"mlxd",
75 		/* maj */	MLXD_CDEV_MAJOR,
76 		/* dump */	nodump,
77 		/* psize */ 	nopsize,
78 		/* flags */	D_DISK,
79 		/* bmaj */	MLXD_BDEV_MAJOR
80 };
81 
82 devclass_t		mlxd_devclass;
83 static struct cdevsw	mlxddisk_cdevsw;
84 
85 static device_method_t mlxd_methods[] = {
86     DEVMETHOD(device_probe,	mlxd_probe),
87     DEVMETHOD(device_attach,	mlxd_attach),
88     DEVMETHOD(device_detach,	mlxd_detach),
89     { 0, 0 }
90 };
91 
92 static driver_t mlxd_driver = {
93     "mlxd",
94     mlxd_methods,
95     sizeof(struct mlxd_softc)
96 };
97 
98 DRIVER_MODULE(mlxd, mlx, mlxd_driver, mlxd_devclass, 0, 0);
99 
100 static int
101 mlxd_open(dev_t dev, int flags, int fmt, struct proc *p)
102 {
103     struct mlxd_softc	*sc = (struct mlxd_softc *)dev->si_drv1;
104     struct disklabel	*label;
105 
106     debug_called(1);
107 
108     if (sc == NULL)
109 	return (ENXIO);
110 
111     /* controller not active? */
112     if (sc->mlxd_controller->mlx_state & MLX_STATE_SHUTDOWN)
113 	return(ENXIO);
114 
115     label = &sc->mlxd_disk.d_label;
116     bzero(label, sizeof(*label));
117     label->d_type = DTYPE_SCSI;
118     label->d_secsize    = MLX_BLKSIZE;
119     label->d_nsectors   = sc->mlxd_drive->ms_sectors;
120     label->d_ntracks    = sc->mlxd_drive->ms_heads;
121     label->d_ncylinders = sc->mlxd_drive->ms_cylinders;
122     label->d_secpercyl  = sc->mlxd_drive->ms_sectors * sc->mlxd_drive->ms_heads;
123     label->d_secperunit = sc->mlxd_drive->ms_size;
124 
125     sc->mlxd_flags |= MLXD_OPEN;
126     return (0);
127 }
128 
129 static int
130 mlxd_close(dev_t dev, int flags, int fmt, struct proc *p)
131 {
132     struct mlxd_softc	*sc = (struct mlxd_softc *)dev->si_drv1;
133 
134     debug_called(1);
135 
136     if (sc == NULL)
137 	return (ENXIO);
138     sc->mlxd_flags &= ~MLXD_OPEN;
139     return (0);
140 }
141 
142 static int
143 mlxd_ioctl(dev_t dev, u_long cmd, caddr_t addr, int32_t flag, struct proc *p)
144 {
145     struct mlxd_softc	*sc = (struct mlxd_softc *)dev->si_drv1;
146     int error;
147 
148     debug_called(1);
149 
150     if (sc == NULL)
151 	return (ENXIO);
152 
153     if ((error = mlx_submit_ioctl(sc->mlxd_controller, sc->mlxd_drive, cmd, addr, flag, p)) != ENOIOCTL) {
154 	debug(0, "mlx_submit_ioctl returned %d\n", error);
155 	return(error);
156     }
157     return (ENOTTY);
158 }
159 
160 /*
161  * Read/write routine for a buffer.  Finds the proper unit, range checks
162  * arguments, and schedules the transfer.  Does not wait for the transfer
163  * to complete.  Multi-page transfers are supported.  All I/O requests must
164  * be a multiple of a sector in length.
165  */
166 static void
167 mlxd_strategy(struct bio *bp)
168 {
169     struct mlxd_softc	*sc = (struct mlxd_softc *)bp->bio_dev->si_drv1;
170 
171     debug_called(1);
172 
173     /* bogus disk? */
174     if (sc == NULL) {
175 	bp->bio_error = EINVAL;
176 	goto bad;
177     }
178 
179     /* XXX may only be temporarily offline - sleep? */
180     if (sc->mlxd_drive->ms_state == MLX_SYSD_OFFLINE) {
181 	bp->bio_error = ENXIO;
182 	goto bad;
183     }
184 
185     /* do-nothing operation */
186     if (bp->bio_bcount == 0)
187 	goto done;
188 
189     devstat_start_transaction(&sc->mlxd_stats);
190     mlx_submit_buf(sc->mlxd_controller, bp);
191     return;
192 
193  bad:
194     bp->bio_flags |= BIO_ERROR;
195 
196  done:
197     /*
198      * Correctly set the buf to indicate a completed transfer
199      */
200     bp->bio_resid = bp->bio_bcount;
201     biodone(bp);
202     return;
203 }
204 
205 void
206 mlxd_intr(void *data)
207 {
208     struct bio *bp = (struct bio *)data;
209     struct mlxd_softc	*sc = (struct mlxd_softc *)bp->bio_dev->si_drv1;
210 
211     debug_called(1);
212 
213     if (bp->bio_flags & BIO_ERROR)
214 	bp->bio_error = EIO;
215     else
216 	bp->bio_resid = 0;
217 
218     devstat_end_transaction_bio(&sc->mlxd_stats, bp);
219     biodone(bp);
220 }
221 
222 static int
223 mlxd_probe(device_t dev)
224 {
225 
226     debug_called(1);
227 
228     device_set_desc(dev, "Mylex System Drive");
229     return (0);
230 }
231 
232 static int
233 mlxd_attach(device_t dev)
234 {
235     struct mlxd_softc	*sc = (struct mlxd_softc *)device_get_softc(dev);
236     device_t		parent;
237     char		*state;
238     dev_t		dsk;
239 
240     debug_called(1);
241 
242     parent = device_get_parent(dev);
243     sc->mlxd_controller = (struct mlx_softc *)device_get_softc(parent);
244     sc->mlxd_unit = device_get_unit(dev);
245     sc->mlxd_drive = device_get_ivars(dev);
246     sc->mlxd_dev = dev;
247 
248     switch(sc->mlxd_drive->ms_state) {
249     case MLX_SYSD_ONLINE:
250 	state = "online";
251 	break;
252     case MLX_SYSD_CRITICAL:
253 	state = "critical";
254 	break;
255     case MLX_SYSD_OFFLINE:
256 	state = "offline";
257 	break;
258     default:
259 	state = "unknown state";
260     }
261 
262     device_printf(dev, "%uMB (%u sectors) RAID %d (%s)\n",
263 		  sc->mlxd_drive->ms_size / ((1024 * 1024) / MLX_BLKSIZE),
264 		  sc->mlxd_drive->ms_size, sc->mlxd_drive->ms_raidlevel, state);
265 
266     devstat_add_entry(&sc->mlxd_stats, "mlxd", sc->mlxd_unit, MLX_BLKSIZE,
267 		      DEVSTAT_NO_ORDERED_TAGS,
268 		      DEVSTAT_TYPE_STORARRAY | DEVSTAT_TYPE_IF_OTHER,
269 		      DEVSTAT_PRIORITY_ARRAY);
270 
271     dsk = disk_create(sc->mlxd_unit, &sc->mlxd_disk, 0, &mlxd_cdevsw, &mlxddisk_cdevsw);
272     dsk->si_drv1 = sc;
273     sc->mlxd_dev_t = dsk;
274 
275     /* set maximum I/O size */
276     dsk->si_iosize_max = sc->mlxd_controller->mlx_enq2->me_maxblk * MLX_BLKSIZE;
277 
278     return (0);
279 }
280 
281 static int
282 mlxd_detach(device_t dev)
283 {
284     struct mlxd_softc *sc = (struct mlxd_softc *)device_get_softc(dev);
285 
286     debug_called(1);
287 
288     devstat_remove_entry(&sc->mlxd_stats);
289     disk_destroy(sc->mlxd_dev_t);
290 
291     return(0);
292 }
293 
294