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
30#include <sys/cdefs.h>
31__FBSDID("$FreeBSD$");
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
40#include <sys/bus.h>
41#include <sys/conf.h>
42#include <sys/disk.h>
43
44#include <vm/vm.h>
45#include <vm/pmap.h>
46
47#include <machine/md_var.h>
48#include <machine/bus.h>
49#include <sys/rman.h>
50
51#include <dev/aac/aacreg.h>
52#include <sys/aac_ioctl.h>
53#include <dev/aac/aacvar.h>
54
55/*
56 * Interface to parent.
57 */
58static int aac_disk_probe(device_t dev);
59static int aac_disk_attach(device_t dev);
60static int aac_disk_detach(device_t dev);
61
62/*
63 * Interface to the device switch.
64 */
65static	disk_open_t	aac_disk_open;
66static	disk_close_t	aac_disk_close;
67static	disk_strategy_t	aac_disk_strategy;
68static	dumper_t	aac_disk_dump;
69
70static devclass_t	aac_disk_devclass;
71
72static device_method_t aac_disk_methods[] = {
73	DEVMETHOD(device_probe,	aac_disk_probe),
74	DEVMETHOD(device_attach,	aac_disk_attach),
75	DEVMETHOD(device_detach,	aac_disk_detach),
76	DEVMETHOD_END
77};
78
79static driver_t aac_disk_driver = {
80	"aacd",
81	aac_disk_methods,
82	sizeof(struct aac_disk)
83};
84
85DRIVER_MODULE(aacd, aac, aac_disk_driver, aac_disk_devclass, NULL, NULL);
86
87/*
88 * Handle open from generic layer.
89 *
90 * This is called by the diskslice code on first open in order to get the
91 * basic device geometry paramters.
92 */
93static int
94aac_disk_open(struct disk *dp)
95{
96	struct aac_disk	*sc;
97
98	fwprintf(NULL, HBA_FLAGS_DBG_FUNCTION_ENTRY_B, "");
99
100	sc = (struct aac_disk *)dp->d_drv1;
101
102	if (sc == NULL) {
103		printf("aac_disk_open: No Softc\n");
104		return (ENXIO);
105	}
106
107	/* check that the controller is up and running */
108	if (sc->ad_controller->aac_state & AAC_STATE_SUSPEND) {
109		device_printf(sc->ad_controller->aac_dev,
110		    "Controller Suspended controller state = 0x%x\n",
111		    sc->ad_controller->aac_state);
112		return(ENXIO);
113	}
114
115	sc->ad_flags |= AAC_DISK_OPEN;
116	return (0);
117}
118
119/*
120 * Handle last close of the disk device.
121 */
122static int
123aac_disk_close(struct disk *dp)
124{
125	struct aac_disk	*sc;
126
127	fwprintf(NULL, HBA_FLAGS_DBG_FUNCTION_ENTRY_B, "");
128
129	sc = (struct aac_disk *)dp->d_drv1;
130
131	if (sc == NULL)
132		return (ENXIO);
133
134	sc->ad_flags &= ~AAC_DISK_OPEN;
135	return (0);
136}
137
138/*
139 * Handle an I/O request.
140 */
141static void
142aac_disk_strategy(struct bio *bp)
143{
144	struct aac_disk	*sc;
145
146	sc = (struct aac_disk *)bp->bio_disk->d_drv1;
147	fwprintf(NULL, HBA_FLAGS_DBG_FUNCTION_ENTRY_B, "");
148
149	/* bogus disk? */
150	if (sc == NULL) {
151		bp->bio_flags |= BIO_ERROR;
152		bp->bio_error = EINVAL;
153		biodone(bp);
154		return;
155	}
156
157	/* do-nothing operation? */
158	if (bp->bio_bcount == 0) {
159		bp->bio_resid = bp->bio_bcount;
160		biodone(bp);
161		return;
162	}
163
164	/* perform accounting */
165
166	/* pass the bio to the controller - it can work out who we are */
167	mtx_lock(&sc->ad_controller->aac_io_lock);
168	aac_submit_bio(bp);
169	mtx_unlock(&sc->ad_controller->aac_io_lock);
170}
171
172/*
173 * Map the S/G elements for doing a dump.
174 */
175static void
176aac_dump_map_sg(void *arg, bus_dma_segment_t *segs, int nsegs, int error)
177{
178	struct aac_fib *fib;
179	struct aac_blockwrite *bw;
180	struct aac_sg_table *sg;
181	int i;
182
183	fib = (struct aac_fib *)arg;
184	bw = (struct aac_blockwrite *)&fib->data[0];
185	sg = &bw->SgMap;
186
187	if (sg != NULL) {
188		sg->SgCount = nsegs;
189		for (i = 0; i < nsegs; i++) {
190			if (segs[i].ds_addr >= BUS_SPACE_MAXADDR_32BIT)
191				return;
192			sg->SgEntry[i].SgAddress = segs[i].ds_addr;
193			sg->SgEntry[i].SgByteCount = segs[i].ds_len;
194		}
195		fib->Header.Size = nsegs * sizeof(struct aac_sg_entry);
196	}
197}
198
199/*
200 * Map the S/G elements for doing a dump on 64-bit capable devices.
201 */
202static void
203aac_dump_map_sg64(void *arg, bus_dma_segment_t *segs, int nsegs, int error)
204{
205	struct aac_fib *fib;
206	struct aac_blockwrite64 *bw;
207	struct aac_sg_table64 *sg;
208	int i;
209
210	fib = (struct aac_fib *)arg;
211	bw = (struct aac_blockwrite64 *)&fib->data[0];
212	sg = &bw->SgMap64;
213
214	if (sg != NULL) {
215		sg->SgCount = nsegs;
216		for (i = 0; i < nsegs; i++) {
217			sg->SgEntry64[i].SgAddress = segs[i].ds_addr;
218			sg->SgEntry64[i].SgByteCount = segs[i].ds_len;
219		}
220		fib->Header.Size = nsegs * sizeof(struct aac_sg_entry64);
221	}
222}
223
224/*
225 * Dump memory out to an array
226 *
227 * Send out one command at a time with up to maxio of data.
228 */
229static int
230aac_disk_dump(void *arg, void *virtual, vm_offset_t physical, off_t offset, size_t length)
231{
232	struct aac_disk *ad;
233	struct aac_softc *sc;
234	struct aac_fib *fib;
235	size_t len, maxio;
236	int size;
237	static bus_dmamap_t dump_datamap;
238	static int first = 0;
239	struct disk *dp;
240	bus_dmamap_callback_t *callback;
241	u_int32_t command;
242
243	dp = arg;
244	ad = dp->d_drv1;
245
246	if (ad == NULL)
247		return (EINVAL);
248
249	sc= ad->ad_controller;
250
251	if (!first) {
252		first = 1;
253		if (bus_dmamap_create(sc->aac_buffer_dmat, 0, &dump_datamap)) {
254			device_printf(sc->aac_dev,
255			    "bus_dmamap_create failed\n");
256			return (ENOMEM);
257		}
258	}
259
260	/* Skip aac_alloc_sync_fib().  We don't want to mess with sleep locks */
261	fib = &sc->aac_common->ac_sync_fib;
262
263	while (length > 0) {
264		maxio = sc->aac_max_sectors << 9;
265		len = (length > maxio) ? maxio : length;
266		if ((sc->flags & AAC_FLAGS_SG_64BIT) == 0) {
267			struct aac_blockwrite *bw;
268			bw = (struct aac_blockwrite *)&fib->data[0];
269			bw->Command = VM_CtBlockWrite;
270			bw->ContainerId = ad->ad_container->co_mntobj.ObjectId;
271			bw->BlockNumber = offset / AAC_BLOCK_SIZE;
272			bw->ByteCount = len;
273			bw->Stable = CUNSTABLE;
274			command = ContainerCommand;
275			callback = aac_dump_map_sg;
276			size = sizeof(struct aac_blockwrite);
277		} else {
278			struct aac_blockwrite64 *bw;
279			bw = (struct aac_blockwrite64 *)&fib->data[0];
280			bw->Command = VM_CtHostWrite64;
281			bw->ContainerId = ad->ad_container->co_mntobj.ObjectId;
282			bw->BlockNumber = offset / AAC_BLOCK_SIZE;
283			bw->SectorCount = len / AAC_BLOCK_SIZE;
284			bw->Pad = 0;
285			bw->Flags = 0;
286			command = ContainerCommand64;
287			callback = aac_dump_map_sg64;
288			size = sizeof(struct aac_blockwrite64);
289		}
290
291		/*
292		 * There really isn't any way to recover from errors or
293		 * resource shortages here.  Oh well.  Because of that, don't
294		 * bother trying to send the command from the callback; there
295		 * is too much required context.
296		 */
297		if (bus_dmamap_load(sc->aac_buffer_dmat, dump_datamap, virtual,
298		    len, callback, fib, BUS_DMA_NOWAIT) != 0)
299			return (ENOMEM);
300
301		bus_dmamap_sync(sc->aac_buffer_dmat, dump_datamap,
302		    BUS_DMASYNC_PREWRITE);
303
304		/* fib->Header.Size is set in aac_dump_map_sg */
305		size += fib->Header.Size;
306
307		if (aac_sync_fib(sc, command, 0, fib, size)) {
308			device_printf(sc->aac_dev,
309			     "Error dumping block 0x%jx\n",
310			     (uintmax_t)physical);
311			return (EIO);
312		}
313
314		bus_dmamap_sync(sc->aac_buffer_dmat, dump_datamap,
315		    BUS_DMASYNC_POSTWRITE);
316
317		bus_dmamap_unload(sc->aac_buffer_dmat, dump_datamap);
318
319		length -= len;
320		offset += len;
321		virtual = (uint8_t *)virtual + len;
322	}
323
324	return (0);
325}
326
327/*
328 * Handle completion of an I/O request.
329 */
330void
331aac_biodone(struct bio *bp)
332{
333	fwprintf(NULL, HBA_FLAGS_DBG_FUNCTION_ENTRY_B, "");
334
335	if (bp->bio_flags & BIO_ERROR) {
336		bp->bio_resid = bp->bio_bcount;
337		disk_err(bp, "hard error", -1, 1);
338	}
339
340	biodone(bp);
341}
342
343/*
344 * Stub only.
345 */
346static int
347aac_disk_probe(device_t dev)
348{
349
350	fwprintf(NULL, HBA_FLAGS_DBG_FUNCTION_ENTRY_B, "");
351
352	return (0);
353}
354
355/*
356 * Attach a unit to the controller.
357 */
358static int
359aac_disk_attach(device_t dev)
360{
361	struct aac_disk	*sc;
362
363	sc = (struct aac_disk *)device_get_softc(dev);
364	fwprintf(NULL, HBA_FLAGS_DBG_FUNCTION_ENTRY_B, "");
365
366	/* initialise our softc */
367	sc->ad_controller =
368	    (struct aac_softc *)device_get_softc(device_get_parent(dev));
369	sc->ad_container = device_get_ivars(dev);
370	sc->ad_dev = dev;
371
372	/*
373	 * require that extended translation be enabled - other drivers read the
374	 * disk!
375	 */
376	sc->ad_size = sc->ad_container->co_mntobj.Capacity;
377	if (sc->ad_controller->flags & AAC_FLAGS_LBA_64BIT)
378		sc->ad_size += (u_int64_t)
379			sc->ad_container->co_mntobj.CapacityHigh << 32;
380	if (sc->ad_size >= (2 * 1024 * 1024)) {		/* 2GB */
381		sc->ad_heads = 255;
382		sc->ad_sectors = 63;
383	} else if (sc->ad_size >= (1 * 1024 * 1024)) {	/* 1GB */
384		sc->ad_heads = 128;
385		sc->ad_sectors = 32;
386	} else {
387		sc->ad_heads = 64;
388		sc->ad_sectors = 32;
389	}
390	sc->ad_cylinders = (sc->ad_size / (sc->ad_heads * sc->ad_sectors));
391
392	device_printf(dev, "%juMB (%ju sectors)\n",
393		      (intmax_t)sc->ad_size / ((1024 * 1024) / AAC_BLOCK_SIZE),
394		      (intmax_t)sc->ad_size);
395
396	/* attach a generic disk device to ourselves */
397	sc->unit = device_get_unit(dev);
398	sc->ad_disk = disk_alloc();
399	sc->ad_disk->d_drv1 = sc;
400	sc->ad_disk->d_flags = DISKFLAG_UNMAPPED_BIO;
401	sc->ad_disk->d_name = "aacd";
402	sc->ad_disk->d_maxsize = sc->ad_controller->aac_max_sectors << 9;
403	sc->ad_disk->d_open = aac_disk_open;
404	sc->ad_disk->d_close = aac_disk_close;
405	sc->ad_disk->d_strategy = aac_disk_strategy;
406	sc->ad_disk->d_dump = aac_disk_dump;
407	sc->ad_disk->d_sectorsize = AAC_BLOCK_SIZE;
408	sc->ad_disk->d_mediasize = (off_t)sc->ad_size * AAC_BLOCK_SIZE;
409	sc->ad_disk->d_fwsectors = sc->ad_sectors;
410	sc->ad_disk->d_fwheads = sc->ad_heads;
411	sc->ad_disk->d_unit = sc->unit;
412	disk_create(sc->ad_disk, DISK_VERSION);
413
414	return (0);
415}
416
417/*
418 * Disconnect ourselves from the system.
419 */
420static int
421aac_disk_detach(device_t dev)
422{
423	struct aac_disk *sc;
424
425	sc = (struct aac_disk *)device_get_softc(dev);
426	fwprintf(NULL, HBA_FLAGS_DBG_FUNCTION_ENTRY_B, "");
427
428	if (sc->ad_flags & AAC_DISK_OPEN)
429		return(EBUSY);
430
431	disk_destroy(sc->ad_disk);
432
433	return(0);
434}
435