xref: /dragonfly/sys/dev/raid/aac/aac_disk.c (revision 8a7bdfea)
1 /*-
2  * Copyright (c) 2000 Michael Smith
3  * Copyright (c) 2001 Scott Long
4  * Copyright (c) 2000 BSDi
5  * Copyright (c) 2001 Adaptec, Inc.
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  *	$FreeBSD: src/sys/dev/aac/aac_disk.c,v 1.3.2.8 2003/01/11 18:39:39 scottl Exp $
30  *	$DragonFly: src/sys/dev/raid/aac/aac_disk.c,v 1.20 2008/01/20 03:40:35 pavalos Exp $
31  */
32 
33 #include "opt_aac.h"
34 
35 #include <sys/param.h>
36 #include <sys/systm.h>
37 #include <sys/kernel.h>
38 #include <sys/module.h>
39 #include <sys/sysctl.h>
40 
41 #include <sys/bus.h>
42 #include <sys/conf.h>
43 #include <sys/devicestat.h>
44 #include <sys/disk.h>
45 #include <sys/dtype.h>
46 #include <sys/rman.h>
47 
48 #include <vm/vm.h>
49 #include <vm/pmap.h>
50 
51 #include <machine/md_var.h>
52 
53 #include "aacreg.h"
54 #include "aac_ioctl.h"
55 #include "aacvar.h"
56 
57 /*
58  * Interface to parent.
59  */
60 static int aac_disk_probe(device_t dev);
61 static int aac_disk_attach(device_t dev);
62 static int aac_disk_detach(device_t dev);
63 
64 /*
65  * Interface to the device switch.
66  */
67 static	d_open_t	aac_disk_open;
68 static	d_close_t	aac_disk_close;
69 static	d_strategy_t	aac_disk_strategy;
70 static	d_dump_t	aac_disk_dump;
71 
72 #define AAC_DISK_CDEV_MAJOR	151
73 
74 static struct dev_ops aac_disk_ops = {
75 	{ "aacd", AAC_DISK_CDEV_MAJOR, D_DISK },
76 	.d_open =		aac_disk_open,
77 	.d_close =		aac_disk_close,
78 	.d_read =		physread,
79 	.d_write =		physwrite,
80 	.d_strategy =		aac_disk_strategy,
81 	.d_dump =		aac_disk_dump,
82 };
83 
84 static devclass_t	aac_disk_devclass;
85 
86 static device_method_t aac_disk_methods[] = {
87 	DEVMETHOD(device_probe,	aac_disk_probe),
88 	DEVMETHOD(device_attach,	aac_disk_attach),
89 	DEVMETHOD(device_detach,	aac_disk_detach),
90 	{ 0, 0 }
91 };
92 
93 static driver_t aac_disk_driver = {
94 	"aacd",
95 	aac_disk_methods,
96 	sizeof(struct aac_disk)
97 };
98 
99 #define AAC_MAXIO	65536
100 
101 DRIVER_MODULE(aacd, aac, aac_disk_driver, aac_disk_devclass, 0, 0);
102 
103 /* sysctl tunables */
104 static unsigned int aac_iosize_max = AAC_MAXIO;	/* due to limits of the card */
105 TUNABLE_INT("hw.aac.iosize_max", &aac_iosize_max);
106 
107 SYSCTL_DECL(_hw_aac);
108 SYSCTL_UINT(_hw_aac, OID_AUTO, iosize_max, CTLFLAG_RD, &aac_iosize_max, 0,
109 	    "Max I/O size per transfer to an array");
110 
111 /*
112  * Handle open from generic layer.
113  *
114  * This is called by the diskslice code on first open in order to get the
115  * basic device geometry paramters.
116  */
117 static int
118 aac_disk_open(struct dev_open_args *ap)
119 {
120 	cdev_t dev = ap->a_head.a_dev;
121 	struct aac_disk	*sc;
122 	struct disk_info info;
123 
124 	debug_called(0);
125 
126 	sc = (struct aac_disk *)dev->si_drv1;
127 
128 	if (sc == NULL) {
129 		kprintf("aac_disk_open: No Softc\n");
130 		return (ENXIO);
131 	}
132 
133 	/* check that the controller is up and running */
134 	if (sc->ad_controller->aac_state & AAC_STATE_SUSPEND) {
135 		kprintf("Controller Suspended controller state = 0x%x\n",
136 		       sc->ad_controller->aac_state);
137 		return(ENXIO);
138 	}
139 
140 	/* build synthetic label */
141 	bzero(&info, sizeof(info));
142 	info.d_media_blksize= AAC_BLOCK_SIZE;		/* mandatory */
143 	info.d_media_blocks = sc->ad_size;
144 
145 	info.d_type = DTYPE_ESDI;			/* optional */
146 	info.d_secpertrack   = sc->ad_sectors;
147 	info.d_nheads	= sc->ad_heads;
148 	info.d_ncylinders = sc->ad_cylinders;
149 	info.d_secpercyl  = sc->ad_sectors * sc->ad_heads;
150 
151 	disk_setdiskinfo(&sc->ad_disk, &info);
152 	sc->ad_flags |= AAC_DISK_OPEN;
153 	return (0);
154 }
155 
156 /*
157  * Handle last close of the disk device.
158  */
159 static int
160 aac_disk_close(struct dev_close_args *ap)
161 {
162 	cdev_t dev = ap->a_head.a_dev;
163 	struct aac_disk	*sc;
164 
165 	debug_called(0);
166 
167 	sc = (struct aac_disk *)dev->si_drv1;
168 
169 	if (sc == NULL)
170 		return (ENXIO);
171 
172 	sc->ad_flags &= ~AAC_DISK_OPEN;
173 	return (0);
174 }
175 
176 /*
177  * Handle an I/O request.
178  */
179 static int
180 aac_disk_strategy(struct dev_strategy_args *ap)
181 {
182 	cdev_t dev = ap->a_head.a_dev;
183 	struct bio *bio = ap->a_bio;
184 	struct buf *bp = bio->bio_buf;
185 	struct aac_disk	*sc;
186 
187 	debug_called(4);
188 
189 	sc = (struct aac_disk *)dev->si_drv1;
190 
191 	/* bogus disk? */
192 	if (sc == NULL) {
193 		bp->b_flags |= B_ERROR;
194 		bp->b_error = EINVAL;
195 		biodone(bio);
196 		return(0);
197 	}
198 
199 	/* do-nothing operation? */
200 	if (bp->b_bcount == 0) {
201 		bp->b_resid = bp->b_bcount;
202 		biodone(bio);
203 		return(0);
204 	}
205 
206 	/* perform accounting */
207 
208 	/* pass the bio to the controller - it can work out who we are */
209 	AAC_LOCK_ACQUIRE(&sc->ad_controller->aac_io_lock);
210 	devstat_start_transaction(&sc->ad_stats);
211 	aac_submit_bio(sc, bio);
212 	AAC_LOCK_RELEASE(&sc->ad_controller->aac_io_lock);
213 
214 	return(0);
215 }
216 
217 /*
218  * Dump memory out to an array
219  *
220  * This queues blocks of memory of size AAC_MAXIO to the controller and waits
221  * for the controller to complete the requests.
222  */
223 static int
224 aac_disk_dump(struct dev_dump_args *ap)
225 {
226 	cdev_t dev = ap->a_head.a_dev;
227 	struct aac_disk *ad;
228 	struct aac_softc *sc;
229 	vm_offset_t addr;
230 	long blkcnt;
231 	int dumppages;
232 	int i, error;
233 
234 	ad = dev->si_drv1;
235 	addr = 0;
236 	dumppages = AAC_MAXIO / PAGE_SIZE;
237 
238 	if (ad == NULL)
239 		return (ENXIO);
240 
241 	sc= ad->ad_controller;
242 
243 	blkcnt = howmany(PAGE_SIZE, ap->a_secsize);
244 
245 	while (ap->a_count > 0) {
246 		caddr_t va = NULL;
247 
248 		if ((ap->a_count / blkcnt) < dumppages)
249 			dumppages = ap->a_count / blkcnt;
250 
251 		for (i = 0; i < dumppages; ++i) {
252 			vm_offset_t a = addr + (i * PAGE_SIZE);
253 			if (is_physical_memory(a)) {
254 				va = pmap_kenter_temporary(trunc_page(a), i);
255 			} else {
256 				va = pmap_kenter_temporary(trunc_page(0), i);
257 			}
258 		}
259 
260 retry:
261 		/*
262 		 * Queue the block to the controller.  If the queue is full,
263 		 * EBUSY will be returned.
264 		 */
265 		error = aac_dump_enqueue(ad, ap->a_blkno, va, dumppages);
266 		if (error && (error != EBUSY))
267 			return (error);
268 
269 		if (!error) {
270 			if (dumpstatus(addr, (off_t)(ap->a_count * DEV_BSIZE)) < 0)
271 			return (EINTR);
272 
273 			ap->a_blkno += blkcnt * dumppages;
274 			ap->a_count -= blkcnt * dumppages;
275 			addr += PAGE_SIZE * dumppages;
276 			if (ap->a_count > 0)
277 			continue;
278 		}
279 
280 		/*
281 		 * Either the queue was full on the last attemp, or we have no
282 		 * more data to dump.  Let the queue drain out and retry the
283 		 * block if the queue was full.
284 		 */
285 		aac_dump_complete(sc);
286 
287 		if (error == EBUSY)
288 			goto retry;
289 	}
290 
291 	return (0);
292 }
293 
294 /*
295  * Handle completion of an I/O request.
296  */
297 void
298 aac_biodone(struct bio *bio, const char *code)
299 {
300 	struct buf *bp = bio->bio_buf;
301 	struct aac_disk	*sc;
302 
303 	debug_called(4);
304 
305 	sc = (struct aac_disk *)bio->bio_driver_info;
306 
307 	devstat_end_transaction_buf(&sc->ad_stats, bp);
308 	if (bp->b_flags & B_ERROR) {
309 		diskerr(bio, sc->ad_dev_t,
310 			code, 0, 0);
311 	}
312 	biodone(bio);
313 }
314 
315 /*
316  * Stub only.
317  */
318 static int
319 aac_disk_probe(device_t dev)
320 {
321 
322 	debug_called(2);
323 
324 	return (0);
325 }
326 
327 /*
328  * Attach a unit to the controller.
329  */
330 static int
331 aac_disk_attach(device_t dev)
332 {
333 	struct aac_disk	*sc;
334 
335 	debug_called(0);
336 
337 	sc = (struct aac_disk *)device_get_softc(dev);
338 
339 	/* initialise our softc */
340 	sc->ad_controller =
341 	    (struct aac_softc *)device_get_softc(device_get_parent(dev));
342 	sc->ad_container = device_get_ivars(dev);
343 	sc->ad_dev = dev;
344 
345 	/*
346 	 * require that extended translation be enabled - other drivers read the
347 	 * disk!
348 	 */
349 	sc->ad_size = sc->ad_container->co_mntobj.Capacity;
350 	if (sc->ad_size >= (2 * 1024 * 1024)) {		/* 2GB */
351 		sc->ad_heads = 255;
352 		sc->ad_sectors = 63;
353 	} else if (sc->ad_size >= (1 * 1024 * 1024)) {	/* 1GB */
354 		sc->ad_heads = 128;
355 		sc->ad_sectors = 32;
356 	} else {
357 		sc->ad_heads = 64;
358 		sc->ad_sectors = 32;
359 	}
360 	sc->ad_cylinders = (sc->ad_size / (sc->ad_heads * sc->ad_sectors));
361 
362 	device_printf(dev, "%uMB (%u sectors)\n",
363 		      sc->ad_size / ((1024 * 1024) / AAC_BLOCK_SIZE),
364 		      sc->ad_size);
365 
366 	devstat_add_entry(&sc->ad_stats, "aacd", device_get_unit(dev),
367 			  AAC_BLOCK_SIZE, DEVSTAT_NO_ORDERED_TAGS,
368 			  DEVSTAT_TYPE_STORARRAY | DEVSTAT_TYPE_IF_OTHER,
369 			  DEVSTAT_PRIORITY_ARRAY);
370 
371 	/* attach a generic disk device to ourselves */
372 	sc->ad_dev_t = disk_create(device_get_unit(dev), &sc->ad_disk,
373 				   &aac_disk_ops);
374 	sc->ad_dev_t->si_drv1 = sc;
375 
376 	sc->ad_dev_t->si_iosize_max = aac_iosize_max;
377 	sc->unit = device_get_unit(dev);
378 
379 	return (0);
380 }
381 
382 /*
383  * Disconnect ourselves from the system.
384  */
385 static int
386 aac_disk_detach(device_t dev)
387 {
388 	struct aac_disk *sc;
389 
390 	debug_called(2);
391 
392 	sc = (struct aac_disk *)device_get_softc(dev);
393 
394 	if (sc->ad_flags & AAC_DISK_OPEN)
395 		return(EBUSY);
396 
397 	devstat_remove_entry(&sc->ad_stats);
398 	disk_destroy(&sc->ad_disk);
399 	return(0);
400 }
401