xref: /freebsd/sys/dev/mlx/mlx_disk.c (revision 17d6c636720d00f77e5d098daf4c278f89d84f7b)
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/bus.h>
39 #include <sys/conf.h>
40 #include <sys/devicestat.h>
41 #include <sys/disk.h>
42 
43 #include <machine/bus.h>
44 #include <sys/rman.h>
45 
46 #include <dev/mlx/mlx_compat.h>
47 #include <dev/mlx/mlxio.h>
48 #include <dev/mlx/mlxvar.h>
49 #include <dev/mlx/mlxreg.h>
50 
51 /* prototypes */
52 static int mlxd_probe(device_t dev);
53 static int mlxd_attach(device_t dev);
54 static int mlxd_detach(device_t dev);
55 
56 static	d_open_t	mlxd_open;
57 static	d_close_t	mlxd_close;
58 static	d_strategy_t	mlxd_strategy;
59 static	d_ioctl_t	mlxd_ioctl;
60 
61 #define MLXD_CDEV_MAJOR	131
62 
63 static struct cdevsw mlxd_cdevsw = {
64 		/* open */	mlxd_open,
65 		/* close */	mlxd_close,
66 		/* read */	physread,
67 		/* write */	physwrite,
68 		/* ioctl */	mlxd_ioctl,
69 		/* poll */	nopoll,
70 		/* mmap */	nommap,
71 		/* strategy */	mlxd_strategy,
72 		/* name */ 	"mlxd",
73 		/* maj */	MLXD_CDEV_MAJOR,
74 		/* dump */	nodump,
75 		/* psize */ 	nopsize,
76 		/* flags */	D_DISK,
77 };
78 
79 devclass_t		mlxd_devclass;
80 static struct cdevsw	mlxddisk_cdevsw;
81 
82 static device_method_t mlxd_methods[] = {
83     DEVMETHOD(device_probe,	mlxd_probe),
84     DEVMETHOD(device_attach,	mlxd_attach),
85     DEVMETHOD(device_detach,	mlxd_detach),
86     { 0, 0 }
87 };
88 
89 static driver_t mlxd_driver = {
90     "mlxd",
91     mlxd_methods,
92     sizeof(struct mlxd_softc)
93 };
94 
95 DRIVER_MODULE(mlxd, mlx, mlxd_driver, mlxd_devclass, 0, 0);
96 
97 static int
98 mlxd_open(dev_t dev, int flags, int fmt, struct thread *td)
99 {
100     struct mlxd_softc	*sc = (struct mlxd_softc *)dev->si_drv1;
101     struct disklabel	*label;
102 
103     debug_called(1);
104 
105     if (sc == NULL)
106 	return (ENXIO);
107 
108     /* controller not active? */
109     if (sc->mlxd_controller->mlx_state & MLX_STATE_SHUTDOWN)
110 	return(ENXIO);
111 
112     label = &sc->mlxd_disk.d_label;
113     bzero(label, sizeof(*label));
114     label->d_type = DTYPE_SCSI;
115     label->d_secsize    = MLX_BLKSIZE;
116     label->d_nsectors   = sc->mlxd_drive->ms_sectors;
117     label->d_ntracks    = sc->mlxd_drive->ms_heads;
118     label->d_ncylinders = sc->mlxd_drive->ms_cylinders;
119     label->d_secpercyl  = sc->mlxd_drive->ms_sectors * sc->mlxd_drive->ms_heads;
120     label->d_secperunit = sc->mlxd_drive->ms_size;
121 
122     sc->mlxd_flags |= MLXD_OPEN;
123     return (0);
124 }
125 
126 static int
127 mlxd_close(dev_t dev, int flags, int fmt, struct thread *td)
128 {
129     struct mlxd_softc	*sc = (struct mlxd_softc *)dev->si_drv1;
130 
131     debug_called(1);
132 
133     if (sc == NULL)
134 	return (ENXIO);
135     sc->mlxd_flags &= ~MLXD_OPEN;
136     return (0);
137 }
138 
139 static int
140 mlxd_ioctl(dev_t dev, u_long cmd, caddr_t addr, int32_t flag, struct thread *td)
141 {
142     struct mlxd_softc	*sc = (struct mlxd_softc *)dev->si_drv1;
143     int error;
144 
145     debug_called(1);
146 
147     if (sc == NULL)
148 	return (ENXIO);
149 
150     if ((error = mlx_submit_ioctl(sc->mlxd_controller, sc->mlxd_drive, cmd, addr, flag, td)) != ENOIOCTL) {
151 	debug(0, "mlx_submit_ioctl returned %d\n", error);
152 	return(error);
153     }
154     return (ENOTTY);
155 }
156 
157 /*
158  * Read/write routine for a buffer.  Finds the proper unit, range checks
159  * arguments, and schedules the transfer.  Does not wait for the transfer
160  * to complete.  Multi-page transfers are supported.  All I/O requests must
161  * be a multiple of a sector in length.
162  */
163 static void
164 mlxd_strategy(mlx_bio *bp)
165 {
166     struct mlxd_softc	*sc = (struct mlxd_softc *)MLX_BIO_SOFTC(bp);
167 
168     debug_called(1);
169 
170     /* bogus disk? */
171     if (sc == NULL) {
172 	MLX_BIO_SET_ERROR(bp, EINVAL);
173 	goto bad;
174     }
175 
176     /* XXX may only be temporarily offline - sleep? */
177     if (sc->mlxd_drive->ms_state == MLX_SYSD_OFFLINE) {
178 	MLX_BIO_SET_ERROR(bp, ENXIO);
179 	goto bad;
180     }
181 
182     MLX_BIO_STATS_START(bp);
183     mlx_submit_buf(sc->mlxd_controller, bp);
184     return;
185 
186  bad:
187     /*
188      * Correctly set the bio to indicate a failed tranfer.
189      */
190     MLX_BIO_RESID(bp) = MLX_BIO_LENGTH(bp);
191     MLX_BIO_DONE(bp);
192     return;
193 }
194 
195 void
196 mlxd_intr(void *data)
197 {
198     mlx_bio 		*bp = (mlx_bio *)data;
199 
200     debug_called(1);
201 
202     if (MLX_BIO_HAS_ERROR(bp))
203 	MLX_BIO_SET_ERROR(bp, EIO);
204     else
205 	MLX_BIO_RESID(bp) = 0;
206 
207     MLX_BIO_STATS_END(bp);
208     MLX_BIO_DONE(bp);
209 }
210 
211 static int
212 mlxd_probe(device_t dev)
213 {
214 
215     debug_called(1);
216 
217     device_set_desc(dev, "Mylex System Drive");
218     return (0);
219 }
220 
221 static int
222 mlxd_attach(device_t dev)
223 {
224     struct mlxd_softc	*sc = (struct mlxd_softc *)device_get_softc(dev);
225     device_t		parent;
226     char		*state;
227     dev_t		dsk;
228     int			s1, s2;
229 
230     debug_called(1);
231 
232     parent = device_get_parent(dev);
233     sc->mlxd_controller = (struct mlx_softc *)device_get_softc(parent);
234     sc->mlxd_unit = device_get_unit(dev);
235     sc->mlxd_drive = device_get_ivars(dev);
236     sc->mlxd_dev = dev;
237 
238     switch(sc->mlxd_drive->ms_state) {
239     case MLX_SYSD_ONLINE:
240 	state = "online";
241 	break;
242     case MLX_SYSD_CRITICAL:
243 	state = "critical";
244 	break;
245     case MLX_SYSD_OFFLINE:
246 	state = "offline";
247 	break;
248     default:
249 	state = "unknown state";
250     }
251 
252     device_printf(dev, "%uMB (%u sectors) RAID %d (%s)\n",
253 		  sc->mlxd_drive->ms_size / ((1024 * 1024) / MLX_BLKSIZE),
254 		  sc->mlxd_drive->ms_size, sc->mlxd_drive->ms_raidlevel, state);
255 
256     devstat_add_entry(&sc->mlxd_stats, "mlxd", sc->mlxd_unit, MLX_BLKSIZE,
257 		      DEVSTAT_NO_ORDERED_TAGS,
258 		      DEVSTAT_TYPE_STORARRAY | DEVSTAT_TYPE_IF_OTHER,
259 		      DEVSTAT_PRIORITY_ARRAY);
260 
261     dsk = disk_create(sc->mlxd_unit, &sc->mlxd_disk, 0, &mlxd_cdevsw, &mlxddisk_cdevsw);
262     dsk->si_drv1 = sc;
263     sc->mlxd_dev_t = dsk;
264 
265     /*
266      * Set maximum I/O size to the lesser of the recommended maximum and the practical
267      * maximum.
268      */
269     s1 = sc->mlxd_controller->mlx_enq2->me_maxblk * MLX_BLKSIZE;
270     s2 = (sc->mlxd_controller->mlx_enq2->me_max_sg - 1) * PAGE_SIZE;
271     dsk->si_iosize_max = imin(s1, s2);
272 
273     return (0);
274 }
275 
276 static int
277 mlxd_detach(device_t dev)
278 {
279     struct mlxd_softc *sc = (struct mlxd_softc *)device_get_softc(dev);
280 
281     debug_called(1);
282 
283     devstat_remove_entry(&sc->mlxd_stats);
284     disk_destroy(sc->mlxd_dev_t);
285 
286     return(0);
287 }
288 
289