xref: /freebsd/sys/dev/mlx/mlx_disk.c (revision 0b57cec536236d46e3dba9bd041533462f33dbb7)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 1999 Jonathan Lemon
5  * Copyright (c) 1999 Michael Smith
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
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  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  */
30 
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
33 
34 /*
35  * Disk driver for Mylex DAC960 RAID adapters.
36  */
37 
38 #include <sys/param.h>
39 #include <sys/systm.h>
40 #include <sys/bio.h>
41 #include <sys/kernel.h>
42 #include <sys/lock.h>
43 #include <sys/module.h>
44 #include <sys/sx.h>
45 
46 #include <sys/bus.h>
47 #include <sys/conf.h>
48 
49 #include <machine/bus.h>
50 #include <sys/rman.h>
51 
52 #include <geom/geom_disk.h>
53 
54 #include <dev/mlx/mlxio.h>
55 #include <dev/mlx/mlxvar.h>
56 #include <dev/mlx/mlxreg.h>
57 
58 /* prototypes */
59 static int mlxd_probe(device_t dev);
60 static int mlxd_attach(device_t dev);
61 static int mlxd_detach(device_t dev);
62 
63 devclass_t		mlxd_devclass;
64 
65 static device_method_t mlxd_methods[] = {
66     DEVMETHOD(device_probe,	mlxd_probe),
67     DEVMETHOD(device_attach,	mlxd_attach),
68     DEVMETHOD(device_detach,	mlxd_detach),
69     { 0, 0 }
70 };
71 
72 static driver_t mlxd_driver = {
73     "mlxd",
74     mlxd_methods,
75     sizeof(struct mlxd_softc)
76 };
77 
78 DRIVER_MODULE(mlxd, mlx, mlxd_driver, mlxd_devclass, 0, 0);
79 
80 static int
81 mlxd_open(struct disk *dp)
82 {
83     struct mlxd_softc	*sc = (struct mlxd_softc *)dp->d_drv1;
84 
85     debug_called(1);
86 
87     if (sc == NULL)
88 	return (ENXIO);
89 
90     /* controller not active? */
91     MLX_CONFIG_LOCK(sc->mlxd_controller);
92     MLX_IO_LOCK(sc->mlxd_controller);
93     if (sc->mlxd_controller->mlx_state & MLX_STATE_SHUTDOWN) {
94 	MLX_IO_UNLOCK(sc->mlxd_controller);
95 	MLX_CONFIG_UNLOCK(sc->mlxd_controller);
96 	return(ENXIO);
97     }
98 
99     sc->mlxd_flags |= MLXD_OPEN;
100     MLX_IO_UNLOCK(sc->mlxd_controller);
101     MLX_CONFIG_UNLOCK(sc->mlxd_controller);
102     return (0);
103 }
104 
105 static int
106 mlxd_close(struct disk *dp)
107 {
108     struct mlxd_softc	*sc = (struct mlxd_softc *)dp->d_drv1;
109 
110     debug_called(1);
111 
112     if (sc == NULL)
113 	return (ENXIO);
114     MLX_CONFIG_LOCK(sc->mlxd_controller);
115     MLX_IO_LOCK(sc->mlxd_controller);
116     sc->mlxd_flags &= ~MLXD_OPEN;
117     MLX_IO_UNLOCK(sc->mlxd_controller);
118     MLX_CONFIG_UNLOCK(sc->mlxd_controller);
119     return (0);
120 }
121 
122 static int
123 mlxd_ioctl(struct disk *dp, u_long cmd, void *addr, int flag, struct thread *td)
124 {
125     struct mlxd_softc	*sc = (struct mlxd_softc *)dp->d_drv1;
126     int error;
127 
128     debug_called(1);
129 
130     if (sc == NULL)
131 	return (ENXIO);
132 
133     if ((error = mlx_submit_ioctl(sc->mlxd_controller, sc->mlxd_drive, cmd, addr, flag, td)) != ENOIOCTL) {
134 	debug(0, "mlx_submit_ioctl returned %d\n", error);
135 	return(error);
136     }
137     return (ENOTTY);
138 }
139 
140 /*
141  * Read/write routine for a buffer.  Finds the proper unit, range checks
142  * arguments, and schedules the transfer.  Does not wait for the transfer
143  * to complete.  Multi-page transfers are supported.  All I/O requests must
144  * be a multiple of a sector in length.
145  */
146 static void
147 mlxd_strategy(struct bio *bp)
148 {
149     struct mlxd_softc	*sc = bp->bio_disk->d_drv1;
150 
151     debug_called(1);
152 
153     /* bogus disk? */
154     if (sc == NULL) {
155 	bp->bio_error = EINVAL;
156 	bp->bio_flags |= BIO_ERROR;
157 	goto bad;
158     }
159 
160     /* XXX may only be temporarily offline - sleep? */
161     MLX_IO_LOCK(sc->mlxd_controller);
162     if (sc->mlxd_drive->ms_state == MLX_SYSD_OFFLINE) {
163 	MLX_IO_UNLOCK(sc->mlxd_controller);
164 	bp->bio_error = ENXIO;
165 	bp->bio_flags |= BIO_ERROR;
166 	goto bad;
167     }
168 
169     mlx_submit_buf(sc->mlxd_controller, bp);
170     MLX_IO_UNLOCK(sc->mlxd_controller);
171     return;
172 
173  bad:
174     /*
175      * Correctly set the bio to indicate a failed transfer.
176      */
177     bp->bio_resid = bp->bio_bcount;
178     biodone(bp);
179     return;
180 }
181 
182 void
183 mlxd_intr(struct bio *bp)
184 {
185 
186     debug_called(1);
187 
188     if (bp->bio_flags & BIO_ERROR)
189 	bp->bio_error = EIO;
190     else
191 	bp->bio_resid = 0;
192 
193     biodone(bp);
194 }
195 
196 static int
197 mlxd_probe(device_t dev)
198 {
199 
200     debug_called(1);
201 
202     device_set_desc(dev, "Mylex System Drive");
203     return (0);
204 }
205 
206 static int
207 mlxd_attach(device_t dev)
208 {
209     struct mlxd_softc	*sc = (struct mlxd_softc *)device_get_softc(dev);
210     device_t		parent;
211     char		*state;
212     int			s1, s2;
213 
214     debug_called(1);
215 
216     parent = device_get_parent(dev);
217     sc->mlxd_controller = (struct mlx_softc *)device_get_softc(parent);
218     sc->mlxd_unit = device_get_unit(dev);
219     sc->mlxd_drive = device_get_ivars(dev);
220     sc->mlxd_dev = dev;
221 
222     switch(sc->mlxd_drive->ms_state) {
223     case MLX_SYSD_ONLINE:
224 	state = "online";
225 	break;
226     case MLX_SYSD_CRITICAL:
227 	state = "critical";
228 	break;
229     case MLX_SYSD_OFFLINE:
230 	state = "offline";
231 	break;
232     default:
233 	state = "unknown state";
234     }
235 
236     device_printf(dev, "%uMB (%u sectors) RAID %d (%s)\n",
237 		  sc->mlxd_drive->ms_size / ((1024 * 1024) / MLX_BLKSIZE),
238 		  sc->mlxd_drive->ms_size, sc->mlxd_drive->ms_raidlevel, state);
239 
240     sc->mlxd_disk = disk_alloc();
241     sc->mlxd_disk->d_open = mlxd_open;
242     sc->mlxd_disk->d_close = mlxd_close;
243     sc->mlxd_disk->d_ioctl = mlxd_ioctl;
244     sc->mlxd_disk->d_strategy = mlxd_strategy;
245     sc->mlxd_disk->d_name = "mlxd";
246     sc->mlxd_disk->d_unit = sc->mlxd_unit;
247     sc->mlxd_disk->d_drv1 = sc;
248     sc->mlxd_disk->d_sectorsize = MLX_BLKSIZE;
249     sc->mlxd_disk->d_mediasize = MLX_BLKSIZE * (off_t)sc->mlxd_drive->ms_size;
250     sc->mlxd_disk->d_fwsectors = sc->mlxd_drive->ms_sectors;
251     sc->mlxd_disk->d_fwheads = sc->mlxd_drive->ms_heads;
252 
253     /*
254      * Set maximum I/O size to the lesser of the recommended maximum and the practical
255      * maximum except on v2 cards where the maximum is set to 8 pages.
256      */
257     if (sc->mlxd_controller->mlx_iftype == MLX_IFTYPE_2)
258 	sc->mlxd_disk->d_maxsize = 8 * MLX_PAGE_SIZE;
259     else {
260 	s1 = sc->mlxd_controller->mlx_enq2->me_maxblk * MLX_BLKSIZE;
261 	s2 = (sc->mlxd_controller->mlx_enq2->me_max_sg - 1) * MLX_PAGE_SIZE;
262 	sc->mlxd_disk->d_maxsize = imin(s1, s2);
263     }
264 
265     disk_create(sc->mlxd_disk, DISK_VERSION);
266 
267     return (0);
268 }
269 
270 static int
271 mlxd_detach(device_t dev)
272 {
273     struct mlxd_softc *sc = (struct mlxd_softc *)device_get_softc(dev);
274 
275     debug_called(1);
276 
277     disk_destroy(sc->mlxd_disk);
278 
279     return(0);
280 }
281 
282