ciss.c revision 126076
1/*-
2 * Copyright (c) 2001 Michael Smith
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 *
26 *	$FreeBSD: head/sys/dev/ciss/ciss.c 126076 2004-02-21 19:42:58Z phk $
27 */
28
29/*
30 * Common Interface for SCSI-3 Support driver.
31 *
32 * CISS claims to provide a common interface between a generic SCSI
33 * transport and an intelligent host adapter.
34 *
35 * This driver supports CISS as defined in the document "CISS Command
36 * Interface for SCSI-3 Support Open Specification", Version 1.04,
37 * Valence Number 1, dated 20001127, produced by Compaq Computer
38 * Corporation.  This document appears to be a hastily and somewhat
39 * arbitrarlily cut-down version of a larger (and probably even more
40 * chaotic and inconsistent) Compaq internal document.  Various
41 * details were also gleaned from Compaq's "cciss" driver for Linux.
42 *
43 * We provide a shim layer between the CISS interface and CAM,
44 * offloading most of the queueing and being-a-disk chores onto CAM.
45 * Entry to the driver is via the PCI bus attachment (ciss_probe,
46 * ciss_attach, etc) and via the CAM interface (ciss_cam_action,
47 * ciss_cam_poll).  The Compaq CISS adapters are, however, poor SCSI
48 * citizens and we have to fake up some responses to get reasonable
49 * behaviour out of them.  In addition, the CISS command set is by no
50 * means adequate to support the functionality of a RAID controller,
51 * and thus the supported Compaq adapters utilise portions of the
52 * control protocol from earlier Compaq adapter families.
53 *
54 * Note that we only support the "simple" transport layer over PCI.
55 * This interface (ab)uses the I2O register set (specifically the post
56 * queues) to exchange commands with the adapter.  Other interfaces
57 * are available, but we aren't supposed to know about them, and it is
58 * dubious whether they would provide major performance improvements
59 * except under extreme load.
60 *
61 * Currently the only supported CISS adapters are the Compaq Smart
62 * Array 5* series (5300, 5i, 532).  Even with only three adapters,
63 * Compaq still manage to have interface variations.
64 *
65 *
66 * Thanks must go to Fred Harris and Darryl DeVinney at Compaq, as
67 * well as Paul Saab at Yahoo! for their assistance in making this
68 * driver happen.
69 */
70
71#include <sys/param.h>
72#include <sys/systm.h>
73#include <sys/malloc.h>
74#include <sys/kernel.h>
75#include <sys/bus.h>
76#include <sys/conf.h>
77#include <sys/stat.h>
78
79#include <cam/cam.h>
80#include <cam/cam_ccb.h>
81#include <cam/cam_periph.h>
82#include <cam/cam_sim.h>
83#include <cam/cam_xpt_sim.h>
84#include <cam/scsi/scsi_all.h>
85#include <cam/scsi/scsi_message.h>
86
87#include <machine/clock.h>
88#include <machine/bus_memio.h>
89#include <machine/bus.h>
90#include <machine/endian.h>
91#include <machine/resource.h>
92#include <sys/rman.h>
93
94#include <dev/pci/pcireg.h>
95#include <dev/pci/pcivar.h>
96
97#include <dev/ciss/cissreg.h>
98#include <dev/ciss/cissvar.h>
99#include <dev/ciss/cissio.h>
100
101MALLOC_DEFINE(CISS_MALLOC_CLASS, "ciss_data", "ciss internal data buffers");
102
103/* pci interface */
104static int	ciss_lookup(device_t dev);
105static int	ciss_probe(device_t dev);
106static int	ciss_attach(device_t dev);
107static int	ciss_detach(device_t dev);
108static int	ciss_shutdown(device_t dev);
109
110/* (de)initialisation functions, control wrappers */
111static int	ciss_init_pci(struct ciss_softc *sc);
112static int	ciss_wait_adapter(struct ciss_softc *sc);
113static int	ciss_flush_adapter(struct ciss_softc *sc);
114static int	ciss_init_requests(struct ciss_softc *sc);
115static void	ciss_command_map_helper(void *arg, bus_dma_segment_t *segs,
116					int nseg, int error);
117static int	ciss_identify_adapter(struct ciss_softc *sc);
118static int	ciss_init_logical(struct ciss_softc *sc);
119static int	ciss_identify_logical(struct ciss_softc *sc, struct ciss_ldrive *ld);
120static int	ciss_get_ldrive_status(struct ciss_softc *sc,  struct ciss_ldrive *ld);
121static int	ciss_update_config(struct ciss_softc *sc);
122static int	ciss_accept_media(struct ciss_softc *sc, int ldrive, int async);
123static void	ciss_accept_media_complete(struct ciss_request *cr);
124static void	ciss_free(struct ciss_softc *sc);
125
126/* request submission/completion */
127static int	ciss_start(struct ciss_request *cr);
128static void	ciss_done(struct ciss_softc *sc);
129static void	ciss_intr(void *arg);
130static void	ciss_complete(struct ciss_softc *sc);
131static int	ciss_report_request(struct ciss_request *cr, int *command_status,
132				    int *scsi_status);
133static int	ciss_synch_request(struct ciss_request *cr, int timeout);
134static int	ciss_poll_request(struct ciss_request *cr, int timeout);
135static int	ciss_wait_request(struct ciss_request *cr, int timeout);
136#if 0
137static int	ciss_abort_request(struct ciss_request *cr);
138#endif
139
140/* request queueing */
141static int	ciss_get_request(struct ciss_softc *sc, struct ciss_request **crp);
142static void	ciss_preen_command(struct ciss_request *cr);
143static void 	ciss_release_request(struct ciss_request *cr);
144
145/* request helpers */
146static int	ciss_get_bmic_request(struct ciss_softc *sc, struct ciss_request **crp,
147				      int opcode, void **bufp, size_t bufsize);
148static int	ciss_user_command(struct ciss_softc *sc, IOCTL_Command_struct *ioc);
149
150/* DMA map/unmap */
151static int	ciss_map_request(struct ciss_request *cr);
152static void	ciss_request_map_helper(void *arg, bus_dma_segment_t *segs,
153					int nseg, int error);
154static void	ciss_unmap_request(struct ciss_request *cr);
155
156/* CAM interface */
157static int	ciss_cam_init(struct ciss_softc *sc);
158static void	ciss_cam_rescan_target(struct ciss_softc *sc, int target);
159static void	ciss_cam_rescan_all(struct ciss_softc *sc);
160static void	ciss_cam_rescan_callback(struct cam_periph *periph, union ccb *ccb);
161static void	ciss_cam_action(struct cam_sim *sim, union ccb *ccb);
162static int	ciss_cam_action_io(struct cam_sim *sim, struct ccb_scsiio *csio);
163static int	ciss_cam_emulate(struct ciss_softc *sc, struct ccb_scsiio *csio);
164static void	ciss_cam_poll(struct cam_sim *sim);
165static void	ciss_cam_complete(struct ciss_request *cr);
166static void	ciss_cam_complete_fixup(struct ciss_softc *sc, struct ccb_scsiio *csio);
167static struct cam_periph *ciss_find_periph(struct ciss_softc *sc, int target);
168static int	ciss_name_device(struct ciss_softc *sc, int target);
169
170/* periodic status monitoring */
171static void	ciss_periodic(void *arg);
172static void	ciss_notify_event(struct ciss_softc *sc);
173static void	ciss_notify_complete(struct ciss_request *cr);
174static int	ciss_notify_abort(struct ciss_softc *sc);
175static int	ciss_notify_abort_bmic(struct ciss_softc *sc);
176static void	ciss_notify_logical(struct ciss_softc *sc, struct ciss_notify *cn);
177static void	ciss_notify_physical(struct ciss_softc *sc, struct ciss_notify *cn);
178
179/* debugging output */
180static void	ciss_print_request(struct ciss_request *cr);
181static void	ciss_print_ldrive(struct ciss_softc *sc, struct ciss_ldrive *ld);
182static const char *ciss_name_ldrive_status(int status);
183static int	ciss_decode_ldrive_status(int status);
184static const char *ciss_name_ldrive_org(int org);
185static const char *ciss_name_command_status(int status);
186
187/*
188 * PCI bus interface.
189 */
190static device_method_t ciss_methods[] = {
191    /* Device interface */
192    DEVMETHOD(device_probe,	ciss_probe),
193    DEVMETHOD(device_attach,	ciss_attach),
194    DEVMETHOD(device_detach,	ciss_detach),
195    DEVMETHOD(device_shutdown,	ciss_shutdown),
196    { 0, 0 }
197};
198
199static driver_t ciss_pci_driver = {
200    "ciss",
201    ciss_methods,
202    sizeof(struct ciss_softc)
203};
204
205static devclass_t	ciss_devclass;
206DRIVER_MODULE(ciss, pci, ciss_pci_driver, ciss_devclass, 0, 0);
207
208/*
209 * Control device interface.
210 */
211static d_open_t		ciss_open;
212static d_close_t	ciss_close;
213static d_ioctl_t	ciss_ioctl;
214
215
216static struct cdevsw ciss_cdevsw = {
217	.d_open =	ciss_open,
218	.d_close =	ciss_close,
219	.d_ioctl =	ciss_ioctl,
220	.d_name =	"ciss",
221};
222
223/************************************************************************
224 * CISS adapters amazingly don't have a defined programming interface
225 * value.  (One could say some very despairing things about PCI and
226 * people just not getting the general idea.)  So we are forced to
227 * stick with matching against subvendor/subdevice, and thus have to
228 * be updated for every new CISS adapter that appears.
229 */
230#define CISS_BOARD_SA5	(1<<0)
231#define CISS_BOARD_SA5B	(1<<1)
232
233static struct
234{
235    u_int16_t	subvendor;
236    u_int16_t	subdevice;
237    int		flags;
238    char	*desc;
239} ciss_vendor_data[] = {
240    { 0x0e11, 0x4070, CISS_BOARD_SA5,	"Compaq Smart Array 5300" },
241    { 0x0e11, 0x4080, CISS_BOARD_SA5B,	"Compaq Smart Array 5i" },
242    { 0x0e11, 0x4082, CISS_BOARD_SA5B,	"Compaq Smart Array 532" },
243    { 0x0e11, 0x4083, CISS_BOARD_SA5B,	"HP Smart Array 5312" },
244    { 0x0e11, 0x4091, CISS_BOARD_SA5,	"HP Smart Array 6i" },
245    { 0x0e11, 0x409A, CISS_BOARD_SA5,	"HP Smart Array 641" },
246    { 0x0e11, 0x409B, CISS_BOARD_SA5,	"HP Smart Array 642" },
247    { 0x0e11, 0x409C, CISS_BOARD_SA5,	"HP Smart Array 6400" },
248    { 0x0e11, 0x409D, CISS_BOARD_SA5,	"HP Smart Array 6400 EM" },
249    { 0, 0, 0, NULL }
250};
251
252/************************************************************************
253 * Find a match for the device in our list of known adapters.
254 */
255static int
256ciss_lookup(device_t dev)
257{
258    int 	i;
259
260    for (i = 0; ciss_vendor_data[i].desc != NULL; i++)
261	if ((pci_get_subvendor(dev) == ciss_vendor_data[i].subvendor) &&
262	    (pci_get_subdevice(dev) == ciss_vendor_data[i].subdevice)) {
263	    return(i);
264	}
265    return(-1);
266}
267
268/************************************************************************
269 * Match a known CISS adapter.
270 */
271static int
272ciss_probe(device_t dev)
273{
274    int		i;
275
276    i = ciss_lookup(dev);
277    if (i != -1) {
278	device_set_desc(dev, ciss_vendor_data[i].desc);
279	return(-10);
280    }
281    return(ENOENT);
282}
283
284/************************************************************************
285 * Attach the driver to this adapter.
286 */
287static int
288ciss_attach(device_t dev)
289{
290    struct ciss_softc	*sc;
291    int			i, error;
292
293    debug_called(1);
294
295#ifdef CISS_DEBUG
296    /* print structure/union sizes */
297    debug_struct(ciss_command);
298    debug_struct(ciss_header);
299    debug_union(ciss_device_address);
300    debug_struct(ciss_cdb);
301    debug_struct(ciss_report_cdb);
302    debug_struct(ciss_notify_cdb);
303    debug_struct(ciss_notify);
304    debug_struct(ciss_message_cdb);
305    debug_struct(ciss_error_info_pointer);
306    debug_struct(ciss_error_info);
307    debug_struct(ciss_sg_entry);
308    debug_struct(ciss_config_table);
309    debug_struct(ciss_bmic_cdb);
310    debug_struct(ciss_bmic_id_ldrive);
311    debug_struct(ciss_bmic_id_lstatus);
312    debug_struct(ciss_bmic_id_table);
313    debug_struct(ciss_bmic_id_pdrive);
314    debug_struct(ciss_bmic_blink_pdrive);
315    debug_struct(ciss_bmic_flush_cache);
316    debug_const(CISS_MAX_REQUESTS);
317    debug_const(CISS_MAX_LOGICAL);
318    debug_const(CISS_INTERRUPT_COALESCE_DELAY);
319    debug_const(CISS_INTERRUPT_COALESCE_COUNT);
320    debug_const(CISS_COMMAND_ALLOC_SIZE);
321    debug_const(CISS_COMMAND_SG_LENGTH);
322
323    debug_type(cciss_pci_info_struct);
324    debug_type(cciss_coalint_struct);
325    debug_type(cciss_coalint_struct);
326    debug_type(NodeName_type);
327    debug_type(NodeName_type);
328    debug_type(Heartbeat_type);
329    debug_type(BusTypes_type);
330    debug_type(FirmwareVer_type);
331    debug_type(DriverVer_type);
332    debug_type(IOCTL_Command_struct);
333#endif
334
335    sc = device_get_softc(dev);
336    sc->ciss_dev = dev;
337
338    /*
339     * Work out adapter type.
340     */
341    i = ciss_lookup(dev);
342    if (ciss_vendor_data[i].flags & CISS_BOARD_SA5) {
343	sc->ciss_interrupt_mask = CISS_TL_SIMPLE_INTR_OPQ_SA5;
344    } else if (ciss_vendor_data[i].flags & CISS_BOARD_SA5B) {
345	sc->ciss_interrupt_mask = CISS_TL_SIMPLE_INTR_OPQ_SA5B;
346    } else {
347	/* really an error on our part */
348	ciss_printf(sc, "unable to determine hardware type\n");
349	error = ENXIO;
350	goto out;
351    }
352
353    /*
354     * Do PCI-specific init.
355     */
356    if ((error = ciss_init_pci(sc)) != 0)
357	goto out;
358
359    /*
360     * Initialise driver queues.
361     */
362    ciss_initq_free(sc);
363    ciss_initq_busy(sc);
364    ciss_initq_complete(sc);
365
366    /*
367     * Initialise command/request pool.
368     */
369    if ((error = ciss_init_requests(sc)) != 0)
370	goto out;
371
372    /*
373     * Get adapter information.
374     */
375    if ((error = ciss_identify_adapter(sc)) != 0)
376	goto out;
377
378    /*
379     * Build our private table of logical devices.
380     */
381    if ((error = ciss_init_logical(sc)) != 0)
382	goto out;
383
384    /*
385     * Enable interrupts so that the CAM scan can complete.
386     */
387    CISS_TL_SIMPLE_ENABLE_INTERRUPTS(sc);
388
389    /*
390     * Initialise the CAM interface.
391     */
392    if ((error = ciss_cam_init(sc)) != 0)
393	goto out;
394
395    /*
396     * Start the heartbeat routine and event chain.
397     */
398    ciss_periodic(sc);
399
400   /*
401     * Create the control device.
402     */
403    sc->ciss_dev_t = make_dev(&ciss_cdevsw, device_get_unit(sc->ciss_dev),
404			      UID_ROOT, GID_OPERATOR, S_IRUSR | S_IWUSR,
405			      "ciss%d", device_get_unit(sc->ciss_dev));
406    sc->ciss_dev_t->si_drv1 = sc;
407
408    /*
409     * The adapter is running; synchronous commands can now sleep
410     * waiting for an interrupt to signal completion.
411     */
412    sc->ciss_flags |= CISS_FLAG_RUNNING;
413
414    error = 0;
415 out:
416    if (error != 0)
417	ciss_free(sc);
418    return(error);
419}
420
421/************************************************************************
422 * Detach the driver from this adapter.
423 */
424static int
425ciss_detach(device_t dev)
426{
427    struct ciss_softc	*sc = device_get_softc(dev);
428
429    debug_called(1);
430
431    /* flush adapter cache */
432    ciss_flush_adapter(sc);
433
434    destroy_dev(sc->ciss_dev_t);
435
436    /* release all resources */
437    ciss_free(sc);
438
439    return(0);
440
441}
442
443/************************************************************************
444 * Prepare adapter for system shutdown.
445 */
446static int
447ciss_shutdown(device_t dev)
448{
449    struct ciss_softc	*sc = device_get_softc(dev);
450
451    debug_called(1);
452
453    /* flush adapter cache */
454    ciss_flush_adapter(sc);
455
456    return(0);
457}
458
459/************************************************************************
460 * Perform PCI-specific attachment actions.
461 */
462static int
463ciss_init_pci(struct ciss_softc *sc)
464{
465    uintptr_t		cbase, csize, cofs;
466    int			error;
467
468    debug_called(1);
469
470    /*
471     * Allocate register window first (we need this to find the config
472     * struct).
473     */
474    error = ENXIO;
475    sc->ciss_regs_rid = CISS_TL_SIMPLE_BAR_REGS;
476    if ((sc->ciss_regs_resource =
477	 bus_alloc_resource(sc->ciss_dev, SYS_RES_MEMORY, &sc->ciss_regs_rid,
478			    0, ~0, 1, RF_ACTIVE)) == NULL) {
479	ciss_printf(sc, "can't allocate register window\n");
480	return(ENXIO);
481    }
482    sc->ciss_regs_bhandle = rman_get_bushandle(sc->ciss_regs_resource);
483    sc->ciss_regs_btag = rman_get_bustag(sc->ciss_regs_resource);
484
485    /*
486     * Find the BAR holding the config structure.  If it's not the one
487     * we already mapped for registers, map it too.
488     */
489    sc->ciss_cfg_rid = CISS_TL_SIMPLE_READ(sc, CISS_TL_SIMPLE_CFG_BAR) & 0xffff;
490    if (sc->ciss_cfg_rid != sc->ciss_regs_rid) {
491	if ((sc->ciss_cfg_resource =
492	     bus_alloc_resource(sc->ciss_dev, SYS_RES_MEMORY, &sc->ciss_cfg_rid,
493				0, ~0, 1, RF_ACTIVE)) == NULL) {
494	    ciss_printf(sc, "can't allocate config window\n");
495	    return(ENXIO);
496	}
497	cbase = (uintptr_t)rman_get_virtual(sc->ciss_cfg_resource);
498	csize = rman_get_end(sc->ciss_cfg_resource) -
499	    rman_get_start(sc->ciss_cfg_resource) + 1;
500    } else {
501	cbase = (uintptr_t)rman_get_virtual(sc->ciss_regs_resource);
502	csize = rman_get_end(sc->ciss_regs_resource) -
503	    rman_get_start(sc->ciss_regs_resource) + 1;
504    }
505    cofs = CISS_TL_SIMPLE_READ(sc, CISS_TL_SIMPLE_CFG_OFF);
506
507    /*
508     * Use the base/size/offset values we just calculated to
509     * sanity-check the config structure.  If it's OK, point to it.
510     */
511    if ((cofs + sizeof(struct ciss_config_table)) > csize) {
512	ciss_printf(sc, "config table outside window\n");
513	return(ENXIO);
514    }
515    sc->ciss_cfg = (struct ciss_config_table *)(cbase + cofs);
516    debug(1, "config struct at %p", sc->ciss_cfg);
517
518    /*
519     * Validate the config structure.  If we supported other transport
520     * methods, we could select amongst them at this point in time.
521     */
522    if (strncmp(sc->ciss_cfg->signature, "CISS", 4)) {
523	ciss_printf(sc, "config signature mismatch (got '%c%c%c%c')\n",
524		    sc->ciss_cfg->signature[0], sc->ciss_cfg->signature[1],
525		    sc->ciss_cfg->signature[2], sc->ciss_cfg->signature[3]);
526	return(ENXIO);
527    }
528    if ((sc->ciss_cfg->valence < CISS_MIN_VALENCE) ||
529	(sc->ciss_cfg->valence > CISS_MAX_VALENCE)) {
530	ciss_printf(sc, "adapter interface specification (%d) unsupported\n",
531		    sc->ciss_cfg->valence);
532	return(ENXIO);
533    }
534
535    /*
536     * Put the board into simple mode, and tell it we're using the low
537     * 4GB of RAM.  Set the default interrupt coalescing options.
538     */
539    if (!(sc->ciss_cfg->supported_methods & CISS_TRANSPORT_METHOD_SIMPLE)) {
540	ciss_printf(sc, "adapter does not support 'simple' transport layer\n");
541	return(ENXIO);
542    }
543    sc->ciss_cfg->requested_method = CISS_TRANSPORT_METHOD_SIMPLE;
544    sc->ciss_cfg->command_physlimit = 0;
545    sc->ciss_cfg->interrupt_coalesce_delay = CISS_INTERRUPT_COALESCE_DELAY;
546    sc->ciss_cfg->interrupt_coalesce_count = CISS_INTERRUPT_COALESCE_COUNT;
547
548    if (ciss_update_config(sc)) {
549	ciss_printf(sc, "adapter refuses to accept config update (IDBR 0x%x)\n",
550		    CISS_TL_SIMPLE_READ(sc, CISS_TL_SIMPLE_IDBR));
551	return(ENXIO);
552    }
553    if (!(sc->ciss_cfg->active_method != CISS_TRANSPORT_METHOD_SIMPLE)) {
554	ciss_printf(sc,
555		    "adapter refuses to go into 'simple' transport mode (0x%x, 0x%x)\n",
556		    sc->ciss_cfg->supported_methods, sc->ciss_cfg->active_method);
557	return(ENXIO);
558    }
559
560    /*
561     * Wait for the adapter to come ready.
562     */
563    if ((error = ciss_wait_adapter(sc)) != 0)
564	return(error);
565
566    /*
567     * Turn off interrupts before we go routing anything.
568     */
569    CISS_TL_SIMPLE_DISABLE_INTERRUPTS(sc);
570
571    /*
572     * Allocate and set up our interrupt.
573     */
574    sc->ciss_irq_rid = 0;
575    if ((sc->ciss_irq_resource =
576	 bus_alloc_resource(sc->ciss_dev, SYS_RES_IRQ, &sc->ciss_irq_rid, 0, ~0, 1,
577			    RF_ACTIVE | RF_SHAREABLE)) == NULL) {
578	ciss_printf(sc, "can't allocate interrupt\n");
579	return(ENXIO);
580    }
581    if (bus_setup_intr(sc->ciss_dev, sc->ciss_irq_resource, INTR_TYPE_CAM, ciss_intr, sc,
582		       &sc->ciss_intr)) {
583	ciss_printf(sc, "can't set up interrupt\n");
584	return(ENXIO);
585    }
586
587    /*
588     * Allocate the parent bus DMA tag appropriate for our PCI
589     * interface.
590     *
591     * Note that "simple" adapters can only address within a 32-bit
592     * span.
593     */
594    if (bus_dma_tag_create(NULL, 			/* parent */
595			   1, 0, 			/* alignment, boundary */
596			   BUS_SPACE_MAXADDR,		/* lowaddr */
597			   BUS_SPACE_MAXADDR, 		/* highaddr */
598			   NULL, NULL, 			/* filter, filterarg */
599			   BUS_SPACE_MAXSIZE_32BIT,	/* maxsize */
600			   CISS_COMMAND_SG_LENGTH,	/* nsegments */
601			   BUS_SPACE_MAXSIZE_32BIT,	/* maxsegsize */
602			   BUS_DMA_ALLOCNOW,		/* flags */
603			   NULL, NULL,			/* lockfunc, lockarg */
604			   &sc->ciss_parent_dmat)) {
605	ciss_printf(sc, "can't allocate parent DMA tag\n");
606	return(ENOMEM);
607    }
608
609    /*
610     * Create DMA tag for mapping buffers into adapter-addressable
611     * space.
612     */
613    if (bus_dma_tag_create(sc->ciss_parent_dmat, 	/* parent */
614			   1, 0, 			/* alignment, boundary */
615			   BUS_SPACE_MAXADDR,		/* lowaddr */
616			   BUS_SPACE_MAXADDR, 		/* highaddr */
617			   NULL, NULL, 			/* filter, filterarg */
618			   MAXBSIZE, CISS_COMMAND_SG_LENGTH,	/* maxsize, nsegments */
619			   BUS_SPACE_MAXSIZE_32BIT,	/* maxsegsize */
620			   0,				/* flags */
621			   busdma_lock_mutex, &Giant,	/* lockfunc, lockarg */
622			   &sc->ciss_buffer_dmat)) {
623	ciss_printf(sc, "can't allocate buffer DMA tag\n");
624	return(ENOMEM);
625    }
626    return(0);
627}
628
629/************************************************************************
630 * Wait for the adapter to come ready.
631 */
632static int
633ciss_wait_adapter(struct ciss_softc *sc)
634{
635    int		i;
636
637    debug_called(1);
638
639    /*
640     * Wait for the adapter to come ready.
641     */
642    if (!(sc->ciss_cfg->active_method & CISS_TRANSPORT_METHOD_READY)) {
643	ciss_printf(sc, "waiting for adapter to come ready...\n");
644	for (i = 0; !(sc->ciss_cfg->active_method & CISS_TRANSPORT_METHOD_READY); i++) {
645	    DELAY(1000000);	/* one second */
646	    if (i > 30) {
647		ciss_printf(sc, "timed out waiting for adapter to come ready\n");
648		return(EIO);
649	    }
650	}
651    }
652    return(0);
653}
654
655/************************************************************************
656 * Flush the adapter cache.
657 */
658static int
659ciss_flush_adapter(struct ciss_softc *sc)
660{
661    struct ciss_request			*cr;
662    struct ciss_bmic_flush_cache	*cbfc;
663    int					error, command_status;
664
665    debug_called(1);
666
667    cr = NULL;
668    cbfc = NULL;
669
670    /*
671     * Build a BMIC request to flush the cache.  We don't disable
672     * it, as we may be going to do more I/O (eg. we are emulating
673     * the Synchronise Cache command).
674     */
675    if ((cbfc = malloc(sizeof(*cbfc), CISS_MALLOC_CLASS, M_NOWAIT | M_ZERO)) == NULL) {
676	error = ENOMEM;
677	goto out;
678    }
679    if ((error = ciss_get_bmic_request(sc, &cr, CISS_BMIC_FLUSH_CACHE,
680				       (void **)&cbfc, sizeof(*cbfc))) != 0)
681	goto out;
682
683    /*
684     * Submit the request and wait for it to complete.
685     */
686    if ((error = ciss_synch_request(cr, 60 * 1000)) != 0) {
687	ciss_printf(sc, "error sending BMIC FLUSH_CACHE command (%d)\n", error);
688	goto out;
689    }
690
691    /*
692     * Check response.
693     */
694    ciss_report_request(cr, &command_status, NULL);
695    switch(command_status) {
696    case CISS_CMD_STATUS_SUCCESS:
697	break;
698    default:
699	ciss_printf(sc, "error flushing cache (%s)\n",
700		    ciss_name_command_status(command_status));
701	error = EIO;
702	goto out;
703    }
704
705out:
706    if (cbfc != NULL)
707	free(cbfc, CISS_MALLOC_CLASS);
708    if (cr != NULL)
709	ciss_release_request(cr);
710    return(error);
711}
712
713/************************************************************************
714 * Allocate memory for the adapter command structures, initialise
715 * the request structures.
716 *
717 * Note that the entire set of commands are allocated in a single
718 * contiguous slab.
719 */
720static int
721ciss_init_requests(struct ciss_softc *sc)
722{
723    struct ciss_request	*cr;
724    int			i;
725
726    debug_called(1);
727
728    /*
729     * Calculate the number of request structures/commands we are
730     * going to provide for this adapter.
731     */
732    sc->ciss_max_requests = min(CISS_MAX_REQUESTS, sc->ciss_cfg->max_outstanding_commands);
733
734    if (bootverbose)
735	ciss_printf(sc, "using %d of %d available commands\n",
736		    sc->ciss_max_requests, sc->ciss_cfg->max_outstanding_commands);
737
738    /*
739     * Create the DMA tag for commands.
740     */
741    if (bus_dma_tag_create(sc->ciss_parent_dmat,	/* parent */
742			   1, 0, 			/* alignment, boundary */
743			   BUS_SPACE_MAXADDR_32BIT,	/* lowaddr */
744			   BUS_SPACE_MAXADDR, 		/* highaddr */
745			   NULL, NULL, 			/* filter, filterarg */
746			   CISS_COMMAND_ALLOC_SIZE *
747			   sc->ciss_max_requests, 1,	/* maxsize, nsegments */
748			   BUS_SPACE_MAXSIZE_32BIT,	/* maxsegsize */
749			   BUS_DMA_ALLOCNOW,		/* flags */
750			   NULL, NULL,			/* lockfunc, lockarg */
751			   &sc->ciss_command_dmat)) {
752	ciss_printf(sc, "can't allocate command DMA tag\n");
753	return(ENOMEM);
754    }
755    /*
756     * Allocate memory and make it available for DMA.
757     */
758    if (bus_dmamem_alloc(sc->ciss_command_dmat, (void **)&sc->ciss_command,
759			 BUS_DMA_NOWAIT, &sc->ciss_command_map)) {
760	ciss_printf(sc, "can't allocate command memory\n");
761	return(ENOMEM);
762    }
763    bus_dmamap_load(sc->ciss_command_dmat, sc->ciss_command_map, sc->ciss_command,
764		    CISS_COMMAND_ALLOC_SIZE * sc->ciss_max_requests,
765		    ciss_command_map_helper, sc, 0);
766    bzero(sc->ciss_command, CISS_COMMAND_ALLOC_SIZE * sc->ciss_max_requests);
767
768    /*
769     * Set up the request and command structures, push requests onto
770     * the free queue.
771     */
772    for (i = 1; i < sc->ciss_max_requests; i++) {
773	cr = &sc->ciss_request[i];
774	cr->cr_sc = sc;
775	cr->cr_tag = i;
776	bus_dmamap_create(sc->ciss_buffer_dmat, 0, &cr->cr_datamap);
777	ciss_enqueue_free(cr);
778    }
779    return(0);
780}
781
782static void
783ciss_command_map_helper(void *arg, bus_dma_segment_t *segs, int nseg, int error)
784{
785    struct ciss_softc	*sc = (struct ciss_softc *)arg;
786
787    sc->ciss_command_phys = segs->ds_addr;
788}
789
790/************************************************************************
791 * Identify the adapter, print some information about it.
792 */
793static int
794ciss_identify_adapter(struct ciss_softc *sc)
795{
796    struct ciss_request	*cr;
797    int			error, command_status;
798
799    debug_called(1);
800
801    cr = NULL;
802
803    /*
804     * Get a request, allocate storage for the adapter data.
805     */
806    if ((error = ciss_get_bmic_request(sc, &cr, CISS_BMIC_ID_CTLR,
807				       (void **)&sc->ciss_id,
808				       sizeof(*sc->ciss_id))) != 0)
809	goto out;
810
811    /*
812     * Submit the request and wait for it to complete.
813     */
814    if ((error = ciss_synch_request(cr, 60 * 1000)) != 0) {
815	ciss_printf(sc, "error sending BMIC ID_CTLR command (%d)\n", error);
816	goto out;
817    }
818
819    /*
820     * Check response.
821     */
822    ciss_report_request(cr, &command_status, NULL);
823    switch(command_status) {
824    case CISS_CMD_STATUS_SUCCESS:		/* buffer right size */
825	break;
826    case CISS_CMD_STATUS_DATA_UNDERRUN:
827    case CISS_CMD_STATUS_DATA_OVERRUN:
828	ciss_printf(sc, "data over/underrun reading adapter information\n");
829    default:
830	ciss_printf(sc, "error reading adapter information (%s)\n",
831		    ciss_name_command_status(command_status));
832	error = EIO;
833	goto out;
834    }
835
836    /* sanity-check reply */
837    if (!sc->ciss_id->big_map_supported) {
838	ciss_printf(sc, "adapter does not support BIG_MAP\n");
839	error = ENXIO;
840	goto out;
841    }
842
843#if 0
844    /* XXX later revisions may not need this */
845    sc->ciss_flags |= CISS_FLAG_FAKE_SYNCH;
846#endif
847
848    /* XXX only really required for old 5300 adapters? */
849    sc->ciss_flags |= CISS_FLAG_BMIC_ABORT;
850
851    /* print information */
852    if (bootverbose) {
853	ciss_printf(sc, "  %d logical drive%s configured\n",
854		    sc->ciss_id->configured_logical_drives,
855		    (sc->ciss_id->configured_logical_drives == 1) ? "" : "s");
856	ciss_printf(sc, "  firmware %4.4s\n", sc->ciss_id->running_firmware_revision);
857	ciss_printf(sc, "  %d SCSI channels\n", sc->ciss_id->scsi_bus_count);
858
859	ciss_printf(sc, "  signature '%.4s'\n", sc->ciss_cfg->signature);
860	ciss_printf(sc, "  valence %d\n", sc->ciss_cfg->valence);
861	ciss_printf(sc, "  supported I/O methods 0x%b\n",
862		    sc->ciss_cfg->supported_methods,
863		    "\20\1READY\2simple\3performant\4MEMQ\n");
864	ciss_printf(sc, "  active I/O method 0x%b\n",
865		    sc->ciss_cfg->active_method, "\20\2simple\3performant\4MEMQ\n");
866	ciss_printf(sc, "  4G page base 0x%08x\n",
867		    sc->ciss_cfg->command_physlimit);
868	ciss_printf(sc, "  interrupt coalesce delay %dus\n",
869		    sc->ciss_cfg->interrupt_coalesce_delay);
870	ciss_printf(sc, "  interrupt coalesce count %d\n",
871		    sc->ciss_cfg->interrupt_coalesce_count);
872	ciss_printf(sc, "  max outstanding commands %d\n",
873		    sc->ciss_cfg->max_outstanding_commands);
874	ciss_printf(sc, "  bus types 0x%b\n", sc->ciss_cfg->bus_types,
875		    "\20\1ultra2\2ultra3\10fibre1\11fibre2\n");
876	ciss_printf(sc, "  server name '%.16s'\n", sc->ciss_cfg->server_name);
877	ciss_printf(sc, "  heartbeat 0x%x\n", sc->ciss_cfg->heartbeat);
878    }
879
880out:
881    if (error) {
882	if (sc->ciss_id != NULL) {
883	    free(sc->ciss_id, CISS_MALLOC_CLASS);
884	    sc->ciss_id = NULL;
885	}
886    }
887    if (cr != NULL)
888	ciss_release_request(cr);
889    return(error);
890}
891
892/************************************************************************
893 * Find logical drives on the adapter.
894 */
895static int
896ciss_init_logical(struct ciss_softc *sc)
897{
898    struct ciss_request		*cr;
899    struct ciss_command		*cc;
900    struct ciss_report_cdb	*crc;
901    struct ciss_lun_report	*cll;
902    int				error, i;
903    size_t			report_size;
904    int				ndrives;
905    int				command_status;
906
907    debug_called(1);
908
909    cr = NULL;
910    cll = NULL;
911
912    /*
913     * Get a request, allocate storage for the address list.
914     */
915    if ((error = ciss_get_request(sc, &cr)) != 0)
916	goto out;
917    report_size = sizeof(*cll) + CISS_MAX_LOGICAL * sizeof(union ciss_device_address);
918    if ((cll = malloc(report_size, CISS_MALLOC_CLASS, M_NOWAIT | M_ZERO)) == NULL) {
919	ciss_printf(sc, "can't allocate memory for logical drive list\n");
920	error = ENOMEM;
921	goto out;
922    }
923
924    /*
925     * Build the Report Logical LUNs command.
926     */
927    cc = CISS_FIND_COMMAND(cr);
928    cr->cr_data = cll;
929    cr->cr_length = report_size;
930    cr->cr_flags = CISS_REQ_DATAIN;
931
932    cc->header.address.physical.mode = CISS_HDR_ADDRESS_MODE_PERIPHERAL;
933    cc->header.address.physical.bus = 0;
934    cc->header.address.physical.target = 0;
935    cc->cdb.cdb_length = sizeof(*crc);
936    cc->cdb.type = CISS_CDB_TYPE_COMMAND;
937    cc->cdb.attribute = CISS_CDB_ATTRIBUTE_SIMPLE;
938    cc->cdb.direction = CISS_CDB_DIRECTION_READ;
939    cc->cdb.timeout = 30;	/* XXX better suggestions? */
940
941    crc = (struct ciss_report_cdb *)&(cc->cdb.cdb[0]);
942    bzero(crc, sizeof(*crc));
943    crc->opcode = CISS_OPCODE_REPORT_LOGICAL_LUNS;
944    crc->length = htonl(report_size);			/* big-endian field */
945    cll->list_size = htonl(report_size - sizeof(*cll));	/* big-endian field */
946
947    /*
948     * Submit the request and wait for it to complete.  (timeout
949     * here should be much greater than above)
950     */
951    if ((error = ciss_synch_request(cr, 60 * 1000)) != 0) {
952	ciss_printf(sc, "error sending Report Logical LUNs command (%d)\n", error);
953	goto out;
954    }
955
956    /*
957     * Check response.  Note that data over/underrun is OK.
958     */
959    ciss_report_request(cr, &command_status, NULL);
960    switch(command_status) {
961    case CISS_CMD_STATUS_SUCCESS:	/* buffer right size */
962    case CISS_CMD_STATUS_DATA_UNDERRUN:	/* buffer too large, not bad */
963	break;
964    case CISS_CMD_STATUS_DATA_OVERRUN:
965	ciss_printf(sc, "WARNING: more logical drives than driver limit (%d), adjust CISS_MAX_LOGICAL\n",
966		    CISS_MAX_LOGICAL);
967	break;
968    default:
969	ciss_printf(sc, "error detecting logical drive configuration (%s)\n",
970		    ciss_name_command_status(command_status));
971	error = EIO;
972	goto out;
973    }
974    ciss_release_request(cr);
975    cr = NULL;
976
977    /* sanity-check reply */
978    ndrives = (ntohl(cll->list_size) / sizeof(union ciss_device_address));
979    if ((ndrives < 0) || (ndrives >= CISS_MAX_LOGICAL)) {
980	ciss_printf(sc, "adapter claims to report absurd number of logical drives (%d > %d)\n",
981		    ndrives, CISS_MAX_LOGICAL);
982	return(ENXIO);
983    }
984
985    /*
986     * Save logical drive information.
987     */
988    if (bootverbose)
989	ciss_printf(sc, "%d logical drive%s\n", ndrives, (ndrives > 1) ? "s" : "");
990    if (ndrives != sc->ciss_id->configured_logical_drives)
991	ciss_printf(sc, "logical drive map claims %d drives, but adapter claims %d\n",
992		    ndrives, sc->ciss_id->configured_logical_drives);
993    for (i = 0; i < CISS_MAX_LOGICAL; i++) {
994	if (i < ndrives) {
995	    sc->ciss_logical[i].cl_address = cll->lun[i];	/* XXX endianness? */
996	    if (ciss_identify_logical(sc, &sc->ciss_logical[i]) != 0)
997		continue;
998	    /*
999	     * If the drive has had media exchanged, we should bring it online.
1000	     */
1001	    if (sc->ciss_logical[i].cl_lstatus->media_exchanged)
1002		ciss_accept_media(sc, i, 0);
1003
1004	} else {
1005	    sc->ciss_logical[i].cl_status = CISS_LD_NONEXISTENT;
1006	}
1007    }
1008    error = 0;
1009
1010 out:
1011    /*
1012     * Note that if the error is a timeout, we are taking a slight
1013     * risk here and assuming that the adapter will not respond at a
1014     * later time, scribbling over host memory.
1015     */
1016    if (cr != NULL)
1017	ciss_release_request(cr);
1018    if (cll != NULL)
1019	free(cll, CISS_MALLOC_CLASS);
1020    return(error);
1021}
1022
1023static int
1024ciss_inquiry_logical(struct ciss_softc *sc, struct ciss_ldrive *ld)
1025{
1026    struct ciss_request			*cr;
1027    struct ciss_command			*cc;
1028    struct scsi_inquiry			*inq;
1029    int					error;
1030    int					command_status;
1031    int					lun;
1032
1033    cr = NULL;
1034    lun = ld->cl_address.logical.lun;
1035
1036    bzero(&ld->cl_geometry, sizeof(ld->cl_geometry));
1037
1038    if ((error = ciss_get_request(sc, &cr)) != 0)
1039	goto out;
1040
1041    cc = CISS_FIND_COMMAND(cr);
1042    cr->cr_data = &ld->cl_geometry;
1043    cr->cr_length = sizeof(ld->cl_geometry);
1044    cr->cr_flags = CISS_REQ_DATAIN;
1045
1046    cc->header.address.logical.mode = CISS_HDR_ADDRESS_MODE_LOGICAL;
1047    cc->header.address.logical.lun  = lun;
1048    cc->cdb.cdb_length = 6;
1049    cc->cdb.type = CISS_CDB_TYPE_COMMAND;
1050    cc->cdb.attribute = CISS_CDB_ATTRIBUTE_SIMPLE;
1051    cc->cdb.direction = CISS_CDB_DIRECTION_READ;
1052    cc->cdb.timeout = 30;
1053
1054    inq = (struct scsi_inquiry *)&(cc->cdb.cdb[0]);
1055    inq->opcode = INQUIRY;
1056    inq->byte2 = SI_EVPD;
1057    inq->page_code = CISS_VPD_LOGICAL_DRIVE_GEOMETRY;
1058    inq->length = sizeof(ld->cl_geometry);
1059
1060    if ((error = ciss_synch_request(cr, 60 * 1000)) != 0) {
1061	ciss_printf(sc, "error getting geometry (%d)\n", error);
1062	goto out;
1063    }
1064
1065    ciss_report_request(cr, &command_status, NULL);
1066    switch(command_status) {
1067    case CISS_CMD_STATUS_SUCCESS:
1068    case CISS_CMD_STATUS_DATA_UNDERRUN:
1069	break;
1070    case CISS_CMD_STATUS_DATA_OVERRUN:
1071	ciss_printf(sc, "WARNING: Data overrun\n");
1072	break;
1073    default:
1074	ciss_printf(sc, "Error detecting logical drive geometry (%s)\n",
1075		    ciss_name_command_status(command_status));
1076	break;
1077    }
1078
1079out:
1080    if (cr != NULL)
1081	ciss_release_request(cr);
1082    return(error);
1083}
1084/************************************************************************
1085 * Identify a logical drive, initialise state related to it.
1086 */
1087static int
1088ciss_identify_logical(struct ciss_softc *sc, struct ciss_ldrive *ld)
1089{
1090    struct ciss_request		*cr;
1091    struct ciss_command		*cc;
1092    struct ciss_bmic_cdb	*cbc;
1093    int				error, command_status;
1094
1095    debug_called(1);
1096
1097    cr = NULL;
1098
1099    /*
1100     * Build a BMIC request to fetch the drive ID.
1101     */
1102    if ((error = ciss_get_bmic_request(sc, &cr, CISS_BMIC_ID_LDRIVE,
1103				       (void **)&ld->cl_ldrive,
1104				       sizeof(*ld->cl_ldrive))) != 0)
1105	goto out;
1106    cc = CISS_FIND_COMMAND(cr);
1107    cbc = (struct ciss_bmic_cdb *)&(cc->cdb.cdb[0]);
1108    cbc->log_drive = ld->cl_address.logical.lun;
1109
1110    /*
1111     * Submit the request and wait for it to complete.
1112     */
1113    if ((error = ciss_synch_request(cr, 60 * 1000)) != 0) {
1114	ciss_printf(sc, "error sending BMIC LDRIVE command (%d)\n", error);
1115	goto out;
1116    }
1117
1118    /*
1119     * Check response.
1120     */
1121    ciss_report_request(cr, &command_status, NULL);
1122    switch(command_status) {
1123    case CISS_CMD_STATUS_SUCCESS:		/* buffer right size */
1124	break;
1125    case CISS_CMD_STATUS_DATA_UNDERRUN:
1126    case CISS_CMD_STATUS_DATA_OVERRUN:
1127	ciss_printf(sc, "data over/underrun reading logical drive ID\n");
1128    default:
1129	ciss_printf(sc, "error reading logical drive ID (%s)\n",
1130		    ciss_name_command_status(command_status));
1131	error = EIO;
1132	goto out;
1133    }
1134    ciss_release_request(cr);
1135    cr = NULL;
1136
1137    /*
1138     * Build a CISS BMIC command to get the logical drive status.
1139     */
1140    if ((error = ciss_get_ldrive_status(sc, ld)) != 0)
1141	goto out;
1142
1143    /*
1144     * Get the logical drive geometry.
1145     */
1146    if ((error = ciss_inquiry_logical(sc, ld)) != 0)
1147	goto out;
1148
1149    /*
1150     * Print the drive's basic characteristics.
1151     */
1152    if (bootverbose) {
1153	ciss_printf(sc, "logical drive %d: %s, %dMB ",
1154		    ld->cl_address.logical.lun,
1155		    ciss_name_ldrive_org(ld->cl_ldrive->fault_tolerance),
1156		    ((ld->cl_ldrive->blocks_available / (1024 * 1024)) *
1157		     ld->cl_ldrive->block_size));
1158
1159	ciss_print_ldrive(sc, ld);
1160    }
1161out:
1162    if (error != 0) {
1163	/* make the drive not-exist */
1164	ld->cl_status = CISS_LD_NONEXISTENT;
1165	if (ld->cl_ldrive != NULL) {
1166	    free(ld->cl_ldrive, CISS_MALLOC_CLASS);
1167	    ld->cl_ldrive = NULL;
1168	}
1169	if (ld->cl_lstatus != NULL) {
1170	    free(ld->cl_lstatus, CISS_MALLOC_CLASS);
1171	    ld->cl_lstatus = NULL;
1172	}
1173    }
1174    if (cr != NULL)
1175	ciss_release_request(cr);
1176
1177    return(error);
1178}
1179
1180/************************************************************************
1181 * Get status for a logical drive.
1182 *
1183 * XXX should we also do this in response to Test Unit Ready?
1184 */
1185static int
1186ciss_get_ldrive_status(struct ciss_softc *sc,  struct ciss_ldrive *ld)
1187{
1188    struct ciss_request		*cr;
1189    struct ciss_command		*cc;
1190    struct ciss_bmic_cdb	*cbc;
1191    int				error, command_status;
1192
1193    /*
1194     * Build a CISS BMIC command to get the logical drive status.
1195     */
1196    if ((error = ciss_get_bmic_request(sc, &cr, CISS_BMIC_ID_LSTATUS,
1197				       (void **)&ld->cl_lstatus,
1198				       sizeof(*ld->cl_lstatus))) != 0)
1199	goto out;
1200    cc = CISS_FIND_COMMAND(cr);
1201    cbc = (struct ciss_bmic_cdb *)&(cc->cdb.cdb[0]);
1202    cbc->log_drive = ld->cl_address.logical.lun;
1203
1204    /*
1205     * Submit the request and wait for it to complete.
1206     */
1207    if ((error = ciss_synch_request(cr, 60 * 1000)) != 0) {
1208	ciss_printf(sc, "error sending BMIC LSTATUS command (%d)\n", error);
1209	goto out;
1210    }
1211
1212    /*
1213     * Check response.
1214     */
1215    ciss_report_request(cr, &command_status, NULL);
1216    switch(command_status) {
1217    case CISS_CMD_STATUS_SUCCESS:		/* buffer right size */
1218	break;
1219    case CISS_CMD_STATUS_DATA_UNDERRUN:
1220    case CISS_CMD_STATUS_DATA_OVERRUN:
1221	ciss_printf(sc, "data over/underrun reading logical drive status\n");
1222    default:
1223	ciss_printf(sc, "error reading logical drive status (%s)\n",
1224		    ciss_name_command_status(command_status));
1225	error = EIO;
1226	goto out;
1227    }
1228
1229    /*
1230     * Set the drive's summary status based on the returned status.
1231     *
1232     * XXX testing shows that a failed JBOD drive comes back at next
1233     * boot in "queued for expansion" mode.  WTF?
1234     */
1235    ld->cl_status = ciss_decode_ldrive_status(ld->cl_lstatus->status);
1236
1237out:
1238    if (cr != NULL)
1239	ciss_release_request(cr);
1240    return(error);
1241}
1242
1243/************************************************************************
1244 * Notify the adapter of a config update.
1245 */
1246static int
1247ciss_update_config(struct ciss_softc *sc)
1248{
1249    int		i;
1250
1251    debug_called(1);
1252
1253    CISS_TL_SIMPLE_WRITE(sc, CISS_TL_SIMPLE_IDBR, CISS_TL_SIMPLE_IDBR_CFG_TABLE);
1254    for (i = 0; i < 1000; i++) {
1255	if (!(CISS_TL_SIMPLE_READ(sc, CISS_TL_SIMPLE_IDBR) &
1256	      CISS_TL_SIMPLE_IDBR_CFG_TABLE)) {
1257	    return(0);
1258	}
1259	DELAY(1000);
1260    }
1261    return(1);
1262}
1263
1264/************************************************************************
1265 * Accept new media into a logical drive.
1266 *
1267 * XXX The drive has previously been offline; it would be good if we
1268 *     could make sure it's not open right now.
1269 */
1270static int
1271ciss_accept_media(struct ciss_softc *sc, int ldrive, int async)
1272{
1273    struct ciss_request		*cr;
1274    struct ciss_command		*cc;
1275    struct ciss_bmic_cdb	*cbc;
1276    int				error;
1277
1278    debug(0, "bringing logical drive %d back online %ssynchronously",
1279	  ldrive, async ? "a" : "");
1280
1281    /*
1282     * Build a CISS BMIC command to bring the drive back online.
1283     */
1284    if ((error = ciss_get_bmic_request(sc, &cr, CISS_BMIC_ACCEPT_MEDIA,
1285				       NULL, 0)) != 0)
1286	goto out;
1287    cc = CISS_FIND_COMMAND(cr);
1288    cbc = (struct ciss_bmic_cdb *)&(cc->cdb.cdb[0]);
1289    cbc->log_drive = ldrive;
1290
1291    /*
1292     * Dispatch the request asynchronously if we can't sleep waiting
1293     * for it to complete.
1294     */
1295    if (async) {
1296	cr->cr_complete = ciss_accept_media_complete;
1297	if ((error = ciss_start(cr)) != 0)
1298	    goto out;
1299	return(0);
1300    } else {
1301	/*
1302	 * Submit the request and wait for it to complete.
1303	 */
1304	if ((error = ciss_synch_request(cr, 60 * 1000)) != 0) {
1305	    ciss_printf(sc, "error sending BMIC LSTATUS command (%d)\n", error);
1306	    goto out;
1307	}
1308    }
1309
1310    /*
1311     * Call the completion callback manually.
1312     */
1313    ciss_accept_media_complete(cr);
1314    return(0);
1315
1316out:
1317    if (cr != NULL)
1318	ciss_release_request(cr);
1319    return(error);
1320}
1321
1322static void
1323ciss_accept_media_complete(struct ciss_request *cr)
1324{
1325    int				command_status;
1326
1327    /*
1328     * Check response.
1329     */
1330    ciss_report_request(cr, &command_status, NULL);
1331    switch(command_status) {
1332    case CISS_CMD_STATUS_SUCCESS:		/* all OK */
1333	/* we should get a logical drive status changed event here */
1334	break;
1335    default:
1336	ciss_printf(cr->cr_sc, "error accepting media into failed logical drive (%s)\n",
1337		    ciss_name_command_status(command_status));
1338	break;
1339    }
1340    ciss_release_request(cr);
1341}
1342
1343/************************************************************************
1344 * Release adapter resources.
1345 */
1346static void
1347ciss_free(struct ciss_softc *sc)
1348{
1349    struct ciss_request *cr;
1350
1351    debug_called(1);
1352
1353    /* we're going away */
1354    sc->ciss_flags |= CISS_FLAG_ABORTING;
1355
1356    /* terminate the periodic heartbeat routine */
1357    untimeout(ciss_periodic, sc, sc->ciss_periodic);
1358
1359    /* cancel the Event Notify chain */
1360    ciss_notify_abort(sc);
1361
1362    /* free the controller data */
1363    if (sc->ciss_id != NULL)
1364	free(sc->ciss_id, CISS_MALLOC_CLASS);
1365
1366    /* release I/O resources */
1367    if (sc->ciss_regs_resource != NULL)
1368	bus_release_resource(sc->ciss_dev, SYS_RES_MEMORY,
1369			     sc->ciss_regs_rid, sc->ciss_regs_resource);
1370    if (sc->ciss_cfg_resource != NULL)
1371	bus_release_resource(sc->ciss_dev, SYS_RES_MEMORY,
1372			     sc->ciss_cfg_rid, sc->ciss_cfg_resource);
1373    if (sc->ciss_intr != NULL)
1374	bus_teardown_intr(sc->ciss_dev, sc->ciss_irq_resource, sc->ciss_intr);
1375    if (sc->ciss_irq_resource != NULL)
1376	bus_release_resource(sc->ciss_dev, SYS_RES_IRQ,
1377			     sc->ciss_irq_rid, sc->ciss_irq_resource);
1378
1379    /* destroy DMA tags */
1380    if (sc->ciss_parent_dmat)
1381	bus_dma_tag_destroy(sc->ciss_parent_dmat);
1382
1383    while ((cr = ciss_dequeue_free(sc)) != NULL)
1384	bus_dmamap_destroy(sc->ciss_buffer_dmat, cr->cr_datamap);
1385    if (sc->ciss_buffer_dmat)
1386	bus_dma_tag_destroy(sc->ciss_buffer_dmat);
1387
1388    /* destroy command memory and DMA tag */
1389    if (sc->ciss_command != NULL) {
1390	bus_dmamap_unload(sc->ciss_command_dmat, sc->ciss_command_map);
1391	bus_dmamem_free(sc->ciss_command_dmat, sc->ciss_command, sc->ciss_command_map);
1392    }
1393    if (sc->ciss_command_dmat)
1394	bus_dma_tag_destroy(sc->ciss_command_dmat);
1395
1396    /* disconnect from CAM */
1397    if (sc->ciss_cam_sim) {
1398	xpt_bus_deregister(cam_sim_path(sc->ciss_cam_sim));
1399	cam_sim_free(sc->ciss_cam_sim, 0);
1400    }
1401    if (sc->ciss_cam_devq)
1402	cam_simq_free(sc->ciss_cam_devq);
1403    /* XXX what about ciss_cam_path? */
1404}
1405
1406/************************************************************************
1407 * Give a command to the adapter.
1408 *
1409 * Note that this uses the simple transport layer directly.  If we
1410 * want to add support for other layers, we'll need a switch of some
1411 * sort.
1412 *
1413 * Note that the simple transport layer has no way of refusing a
1414 * command; we only have as many request structures as the adapter
1415 * supports commands, so we don't have to check (this presumes that
1416 * the adapter can handle commands as fast as we throw them at it).
1417 */
1418static int
1419ciss_start(struct ciss_request *cr)
1420{
1421    struct ciss_command	*cc;	/* XXX debugging only */
1422    int			error;
1423
1424    cc = CISS_FIND_COMMAND(cr);
1425    debug(2, "post command %d tag %d ", cr->cr_tag, cc->header.host_tag);
1426
1427    /*
1428     * Map the request's data.
1429     */
1430    if ((error = ciss_map_request(cr)))
1431	return(error);
1432
1433#if 0
1434    ciss_print_request(cr);
1435#endif
1436
1437    return(0);
1438}
1439
1440/************************************************************************
1441 * Fetch completed request(s) from the adapter, queue them for
1442 * completion handling.
1443 *
1444 * Note that this uses the simple transport layer directly.  If we
1445 * want to add support for other layers, we'll need a switch of some
1446 * sort.
1447 *
1448 * Note that the simple transport mechanism does not require any
1449 * reentrancy protection; the OPQ read is atomic.  If there is a
1450 * chance of a race with something else that might move the request
1451 * off the busy list, then we will have to lock against that
1452 * (eg. timeouts, etc.)
1453 */
1454static void
1455ciss_done(struct ciss_softc *sc)
1456{
1457    struct ciss_request	*cr;
1458    struct ciss_command	*cc;
1459    u_int32_t		tag, index;
1460    int			complete;
1461
1462    debug_called(3);
1463
1464    /*
1465     * Loop quickly taking requests from the adapter and moving them
1466     * from the busy queue to the completed queue.
1467     */
1468    complete = 0;
1469    for (;;) {
1470
1471	/* see if the OPQ contains anything */
1472	if (!CISS_TL_SIMPLE_OPQ_INTERRUPT(sc))
1473	    break;
1474
1475	tag = CISS_TL_SIMPLE_FETCH_CMD(sc);
1476	if (tag == CISS_TL_SIMPLE_OPQ_EMPTY)
1477	    break;
1478	index = tag >> 2;
1479	debug(2, "completed command %d%s", index,
1480	      (tag & CISS_HDR_HOST_TAG_ERROR) ? " with error" : "");
1481	if (index >= sc->ciss_max_requests) {
1482	    ciss_printf(sc, "completed invalid request %d (0x%x)\n", index, tag);
1483	    continue;
1484	}
1485	cr = &(sc->ciss_request[index]);
1486	cc = CISS_FIND_COMMAND(cr);
1487	cc->header.host_tag = tag;	/* not updated by adapter */
1488	if (ciss_remove_busy(cr)) {
1489	    /* assume this is garbage out of the adapter */
1490	    ciss_printf(sc, "completed nonbusy request %d\n", index);
1491	} else {
1492	    ciss_enqueue_complete(cr);
1493	}
1494	complete = 1;
1495    }
1496
1497    /*
1498     * Invoke completion processing.  If we can defer this out of
1499     * interrupt context, that'd be good.
1500     */
1501    if (complete)
1502	ciss_complete(sc);
1503}
1504
1505/************************************************************************
1506 * Take an interrupt from the adapter.
1507 */
1508static void
1509ciss_intr(void *arg)
1510{
1511    struct ciss_softc	*sc = (struct ciss_softc *)arg;
1512
1513    /*
1514     * The only interrupt we recognise indicates that there are
1515     * entries in the outbound post queue.
1516     */
1517    ciss_done(sc);
1518}
1519
1520/************************************************************************
1521 * Process completed requests.
1522 *
1523 * Requests can be completed in three fashions:
1524 *
1525 * - by invoking a callback function (cr_complete is non-null)
1526 * - by waking up a sleeper (cr_flags has CISS_REQ_SLEEP set)
1527 * - by clearing the CISS_REQ_POLL flag in interrupt/timeout context
1528 */
1529static void
1530ciss_complete(struct ciss_softc *sc)
1531{
1532    struct ciss_request	*cr;
1533
1534    debug_called(2);
1535
1536    /*
1537     * Loop taking requests off the completed queue and performing
1538     * completion processing on them.
1539     */
1540    for (;;) {
1541	if ((cr = ciss_dequeue_complete(sc)) == NULL)
1542	    break;
1543	ciss_unmap_request(cr);
1544
1545	/*
1546	 * If the request has a callback, invoke it.
1547	 */
1548	if (cr->cr_complete != NULL) {
1549	    cr->cr_complete(cr);
1550	    continue;
1551	}
1552
1553	/*
1554	 * If someone is sleeping on this request, wake them up.
1555	 */
1556	if (cr->cr_flags & CISS_REQ_SLEEP) {
1557	    cr->cr_flags &= ~CISS_REQ_SLEEP;
1558	    wakeup(cr);
1559	    continue;
1560	}
1561
1562	/*
1563	 * If someone is polling this request for completion, signal.
1564	 */
1565	if (cr->cr_flags & CISS_REQ_POLL) {
1566	    cr->cr_flags &= ~CISS_REQ_POLL;
1567	    continue;
1568	}
1569
1570	/*
1571	 * Give up and throw the request back on the free queue.  This
1572	 * should never happen; resources will probably be lost.
1573	 */
1574	ciss_printf(sc, "WARNING: completed command with no submitter\n");
1575	ciss_enqueue_free(cr);
1576    }
1577}
1578
1579/************************************************************************
1580 * Report on the completion status of a request, and pass back SCSI
1581 * and command status values.
1582 */
1583static int
1584ciss_report_request(struct ciss_request *cr, int *command_status, int *scsi_status)
1585{
1586    struct ciss_command		*cc;
1587    struct ciss_error_info	*ce;
1588
1589    debug_called(2);
1590
1591    cc = CISS_FIND_COMMAND(cr);
1592    ce = (struct ciss_error_info *)&(cc->sg[0]);
1593
1594    /*
1595     * We don't consider data under/overrun an error for the Report
1596     * Logical/Physical LUNs commands.
1597     */
1598    if ((cc->header.host_tag & CISS_HDR_HOST_TAG_ERROR) &&
1599	((cc->cdb.cdb[0] == CISS_OPCODE_REPORT_LOGICAL_LUNS) ||
1600	 (cc->cdb.cdb[0] == CISS_OPCODE_REPORT_PHYSICAL_LUNS))) {
1601	cc->header.host_tag &= ~CISS_HDR_HOST_TAG_ERROR;
1602	debug(2, "ignoring irrelevant under/overrun error");
1603    }
1604
1605    /*
1606     * Check the command's error bit, if clear, there's no status and
1607     * everything is OK.
1608     */
1609    if (!(cc->header.host_tag & CISS_HDR_HOST_TAG_ERROR)) {
1610	if (scsi_status != NULL)
1611	    *scsi_status = SCSI_STATUS_OK;
1612	if (command_status != NULL)
1613	    *command_status = CISS_CMD_STATUS_SUCCESS;
1614	return(0);
1615    } else {
1616	if (command_status != NULL)
1617	    *command_status = ce->command_status;
1618	if (scsi_status != NULL) {
1619	    if (ce->command_status == CISS_CMD_STATUS_TARGET_STATUS) {
1620		*scsi_status = ce->scsi_status;
1621	    } else {
1622		*scsi_status = -1;
1623	    }
1624	}
1625	if (bootverbose)
1626	    ciss_printf(cr->cr_sc, "command status 0x%x (%s) scsi status 0x%x\n",
1627			ce->command_status, ciss_name_command_status(ce->command_status),
1628			ce->scsi_status);
1629	if (ce->command_status == CISS_CMD_STATUS_INVALID_COMMAND) {
1630	    ciss_printf(cr->cr_sc, "invalid command, offense size %d at %d, value 0x%x\n",
1631			ce->additional_error_info.invalid_command.offense_size,
1632			ce->additional_error_info.invalid_command.offense_offset,
1633			ce->additional_error_info.invalid_command.offense_value);
1634	}
1635    }
1636    return(1);
1637}
1638
1639/************************************************************************
1640 * Issue a request and don't return until it's completed.
1641 *
1642 * Depending on adapter status, we may poll or sleep waiting for
1643 * completion.
1644 */
1645static int
1646ciss_synch_request(struct ciss_request *cr, int timeout)
1647{
1648    if (cr->cr_sc->ciss_flags & CISS_FLAG_RUNNING) {
1649	return(ciss_wait_request(cr, timeout));
1650    } else {
1651	return(ciss_poll_request(cr, timeout));
1652    }
1653}
1654
1655/************************************************************************
1656 * Issue a request and poll for completion.
1657 *
1658 * Timeout in milliseconds.
1659 */
1660static int
1661ciss_poll_request(struct ciss_request *cr, int timeout)
1662{
1663    int		error;
1664
1665    debug_called(2);
1666
1667    cr->cr_flags |= CISS_REQ_POLL;
1668    if ((error = ciss_start(cr)) != 0)
1669	return(error);
1670
1671    do {
1672	ciss_done(cr->cr_sc);
1673	if (!(cr->cr_flags & CISS_REQ_POLL))
1674	    return(0);
1675	DELAY(1000);
1676    } while (timeout-- >= 0);
1677    return(EWOULDBLOCK);
1678}
1679
1680/************************************************************************
1681 * Issue a request and sleep waiting for completion.
1682 *
1683 * Timeout in milliseconds.  Note that a spurious wakeup will reset
1684 * the timeout.
1685 */
1686static int
1687ciss_wait_request(struct ciss_request *cr, int timeout)
1688{
1689    int		s, error;
1690
1691    debug_called(2);
1692
1693    cr->cr_flags |= CISS_REQ_SLEEP;
1694    if ((error = ciss_start(cr)) != 0)
1695	return(error);
1696
1697    s = splcam();
1698    while (cr->cr_flags & CISS_REQ_SLEEP) {
1699	error = tsleep(cr, PCATCH, "cissREQ", (timeout * hz) / 1000);
1700	/*
1701	 * On wakeup or interruption due to restartable activity, go
1702	 * back and check to see if we're done.
1703	 */
1704	if ((error == 0) || (error == ERESTART)) {
1705	    error = 0;
1706	    continue;
1707	}
1708	/*
1709	 * Timeout, interrupted system call, etc.
1710	 */
1711	break;
1712    }
1713    splx(s);
1714    return(error);
1715}
1716
1717#if 0
1718/************************************************************************
1719 * Abort a request.  Note that a potential exists here to race the
1720 * request being completed; the caller must deal with this.
1721 */
1722static int
1723ciss_abort_request(struct ciss_request *ar)
1724{
1725    struct ciss_request		*cr;
1726    struct ciss_command		*cc;
1727    struct ciss_message_cdb	*cmc;
1728    int				error;
1729
1730    debug_called(1);
1731
1732    /* get a request */
1733    if ((error = ciss_get_request(ar->cr_sc, &cr)) != 0)
1734	return(error);
1735
1736    /* build the abort command */
1737    cc = CISS_FIND_COMMAND(cr);
1738    cc->header.address.mode.mode = CISS_HDR_ADDRESS_MODE_PERIPHERAL;	/* addressing? */
1739    cc->header.address.physical.target = 0;
1740    cc->header.address.physical.bus = 0;
1741    cc->cdb.cdb_length = sizeof(*cmc);
1742    cc->cdb.type = CISS_CDB_TYPE_MESSAGE;
1743    cc->cdb.attribute = CISS_CDB_ATTRIBUTE_SIMPLE;
1744    cc->cdb.direction = CISS_CDB_DIRECTION_NONE;
1745    cc->cdb.timeout = 30;
1746
1747    cmc = (struct ciss_message_cdb *)&(cc->cdb.cdb[0]);
1748    cmc->opcode = CISS_OPCODE_MESSAGE_ABORT;
1749    cmc->type = CISS_MESSAGE_ABORT_TASK;
1750    cmc->abort_tag = ar->cr_tag;	/* endianness?? */
1751
1752    /*
1753     * Send the request and wait for a response.  If we believe we
1754     * aborted the request OK, clear the flag that indicates it's
1755     * running.
1756     */
1757    error = ciss_synch_request(cr, 35 * 1000);
1758    if (!error)
1759	error = ciss_report_request(cr, NULL, NULL);
1760    ciss_release_request(cr);
1761
1762    return(error);
1763}
1764#endif
1765
1766
1767/************************************************************************
1768 * Fetch and initialise a request
1769 */
1770static int
1771ciss_get_request(struct ciss_softc *sc, struct ciss_request **crp)
1772{
1773    struct ciss_request *cr;
1774
1775    debug_called(2);
1776
1777    /*
1778     * Get a request and clean it up.
1779     */
1780    if ((cr = ciss_dequeue_free(sc)) == NULL)
1781	return(ENOMEM);
1782
1783    cr->cr_data = NULL;
1784    cr->cr_flags = 0;
1785    cr->cr_complete = NULL;
1786    cr->cr_private = NULL;
1787
1788    ciss_preen_command(cr);
1789    *crp = cr;
1790    return(0);
1791}
1792
1793static void
1794ciss_preen_command(struct ciss_request *cr)
1795{
1796    struct ciss_command	*cc;
1797    u_int32_t		cmdphys;
1798
1799    /*
1800     * Clean up the command structure.
1801     *
1802     * Note that we set up the error_info structure here, since the
1803     * length can be overwritten by any command.
1804     */
1805    cc = CISS_FIND_COMMAND(cr);
1806    cc->header.sg_in_list = 0;		/* kinda inefficient this way */
1807    cc->header.sg_total = 0;
1808    cc->header.host_tag = cr->cr_tag << 2;
1809    cc->header.host_tag_zeroes = 0;
1810    cmdphys = CISS_FIND_COMMANDPHYS(cr);
1811    cc->error_info.error_info_address = cmdphys + sizeof(struct ciss_command);
1812    cc->error_info.error_info_length = CISS_COMMAND_ALLOC_SIZE - sizeof(struct ciss_command);
1813
1814}
1815
1816/************************************************************************
1817 * Release a request to the free list.
1818 */
1819static void
1820ciss_release_request(struct ciss_request *cr)
1821{
1822    struct ciss_softc	*sc;
1823
1824    debug_called(2);
1825
1826    sc = cr->cr_sc;
1827
1828    /* release the request to the free queue */
1829    ciss_requeue_free(cr);
1830}
1831
1832/************************************************************************
1833 * Allocate a request that will be used to send a BMIC command.  Do some
1834 * of the common setup here to avoid duplicating it everywhere else.
1835 */
1836static int
1837ciss_get_bmic_request(struct ciss_softc *sc, struct ciss_request **crp,
1838		      int opcode, void **bufp, size_t bufsize)
1839{
1840    struct ciss_request		*cr;
1841    struct ciss_command		*cc;
1842    struct ciss_bmic_cdb	*cbc;
1843    void			*buf;
1844    int				error;
1845    int				dataout;
1846
1847    debug_called(2);
1848
1849    cr = NULL;
1850    buf = NULL;
1851
1852    /*
1853     * Get a request.
1854     */
1855    if ((error = ciss_get_request(sc, &cr)) != 0)
1856	goto out;
1857
1858    /*
1859     * Allocate data storage if requested, determine the data direction.
1860     */
1861    dataout = 0;
1862    if ((bufsize > 0) && (bufp != NULL)) {
1863	if (*bufp == NULL) {
1864	    if ((buf = malloc(bufsize, CISS_MALLOC_CLASS, M_NOWAIT | M_ZERO)) == NULL) {
1865		error = ENOMEM;
1866		goto out;
1867	    }
1868	} else {
1869	    buf = *bufp;
1870	    dataout = 1;	/* we are given a buffer, so we are writing */
1871	}
1872    }
1873
1874    /*
1875     * Build a CISS BMIC command to get the logical drive ID.
1876     */
1877    cr->cr_data = buf;
1878    cr->cr_length = bufsize;
1879    if (!dataout)
1880	cr->cr_flags = CISS_REQ_DATAIN;
1881
1882    cc = CISS_FIND_COMMAND(cr);
1883    cc->header.address.physical.mode = CISS_HDR_ADDRESS_MODE_PERIPHERAL;
1884    cc->header.address.physical.bus = 0;
1885    cc->header.address.physical.target = 0;
1886    cc->cdb.cdb_length = sizeof(*cbc);
1887    cc->cdb.type = CISS_CDB_TYPE_COMMAND;
1888    cc->cdb.attribute = CISS_CDB_ATTRIBUTE_SIMPLE;
1889    cc->cdb.direction = dataout ? CISS_CDB_DIRECTION_WRITE : CISS_CDB_DIRECTION_READ;
1890    cc->cdb.timeout = 0;
1891
1892    cbc = (struct ciss_bmic_cdb *)&(cc->cdb.cdb[0]);
1893    bzero(cbc, sizeof(*cbc));
1894    cbc->opcode = dataout ? CISS_ARRAY_CONTROLLER_WRITE : CISS_ARRAY_CONTROLLER_READ;
1895    cbc->bmic_opcode = opcode;
1896    cbc->size = htons((u_int16_t)bufsize);
1897
1898out:
1899    if (error) {
1900	if (cr != NULL)
1901	    ciss_release_request(cr);
1902	if ((bufp != NULL) && (*bufp == NULL) && (buf != NULL))
1903	    free(buf, CISS_MALLOC_CLASS);
1904    } else {
1905	*crp = cr;
1906	if ((bufp != NULL) && (*bufp == NULL) && (buf != NULL))
1907	    *bufp = buf;
1908    }
1909    return(error);
1910}
1911
1912/************************************************************************
1913 * Handle a command passed in from userspace.
1914 */
1915static int
1916ciss_user_command(struct ciss_softc *sc, IOCTL_Command_struct *ioc)
1917{
1918    struct ciss_request		*cr;
1919    struct ciss_command		*cc;
1920    struct ciss_error_info	*ce;
1921    int				error = 0;
1922
1923    debug_called(1);
1924
1925    cr = NULL;
1926
1927    /*
1928     * Get a request.
1929     */
1930    if ((error = ciss_get_request(sc, &cr)) != 0)
1931	goto out;
1932    cc = CISS_FIND_COMMAND(cr);
1933
1934    /*
1935     * Allocate an in-kernel databuffer if required, copy in user data.
1936     */
1937    cr->cr_length = ioc->buf_size;
1938    if (ioc->buf_size > 0) {
1939	if ((cr->cr_data = malloc(ioc->buf_size, CISS_MALLOC_CLASS, M_WAITOK)) == NULL) {
1940	    error = ENOMEM;
1941	    goto out;
1942	}
1943	if ((error = copyin(ioc->buf, cr->cr_data, ioc->buf_size))) {
1944	    debug(0, "copyin: bad data buffer %p/%d", ioc->buf, ioc->buf_size);
1945	    goto out;
1946	}
1947    }
1948
1949    /*
1950     * Build the request based on the user command.
1951     */
1952    bcopy(&ioc->LUN_info, &cc->header.address, sizeof(cc->header.address));
1953    bcopy(&ioc->Request, &cc->cdb, sizeof(cc->cdb));
1954
1955    /* XXX anything else to populate here? */
1956
1957    /*
1958     * Run the command.
1959     */
1960    if ((error = ciss_synch_request(cr, 60 * 1000))) {
1961	debug(0, "request failed - %d", error);
1962	goto out;
1963    }
1964
1965    /*
1966     * Check to see if the command succeeded.
1967     */
1968    ce = (struct ciss_error_info *)&(cc->sg[0]);
1969    if (ciss_report_request(cr, NULL, NULL) == 0)
1970	bzero(ce, sizeof(*ce));
1971    else
1972	error = EIO;
1973
1974    /*
1975     * Copy the results back to the user.
1976     */
1977    bcopy(ce, &ioc->error_info, sizeof(*ce));
1978    if ((ioc->buf_size > 0) &&
1979	(error = copyout(cr->cr_data, ioc->buf, ioc->buf_size))) {
1980	debug(0, "copyout: bad data buffer %p/%d", ioc->buf, ioc->buf_size);
1981	goto out;
1982    }
1983
1984    /* done OK */
1985    error = 0;
1986
1987out:
1988    if ((cr != NULL) && (cr->cr_data != NULL))
1989	free(cr->cr_data, CISS_MALLOC_CLASS);
1990    if (cr != NULL)
1991	ciss_release_request(cr);
1992    return(error);
1993}
1994
1995/************************************************************************
1996 * Map a request into bus-visible space, initialise the scatter/gather
1997 * list.
1998 */
1999static int
2000ciss_map_request(struct ciss_request *cr)
2001{
2002    struct ciss_softc	*sc;
2003    int			error = 0;
2004
2005    debug_called(2);
2006
2007    sc = cr->cr_sc;
2008
2009    /* check that mapping is necessary */
2010    if (cr->cr_flags & CISS_REQ_MAPPED)
2011	return(0);
2012
2013    cr->cr_flags |= CISS_REQ_MAPPED;
2014
2015    bus_dmamap_sync(sc->ciss_command_dmat, sc->ciss_command_map,
2016		    BUS_DMASYNC_PREWRITE);
2017
2018    if (cr->cr_data != NULL) {
2019	error = bus_dmamap_load(sc->ciss_buffer_dmat, cr->cr_datamap,
2020				cr->cr_data, cr->cr_length,
2021				ciss_request_map_helper, cr, 0);
2022	if (error != 0)
2023	    return (error);
2024    } else {
2025	/*
2026	 * Post the command to the adapter.
2027	 */
2028	ciss_enqueue_busy(cr);
2029	CISS_TL_SIMPLE_POST_CMD(cr->cr_sc, CISS_FIND_COMMANDPHYS(cr));
2030    }
2031
2032    return(0);
2033}
2034
2035static void
2036ciss_request_map_helper(void *arg, bus_dma_segment_t *segs, int nseg, int error)
2037{
2038    struct ciss_command	*cc;
2039    struct ciss_request *cr;
2040    struct ciss_softc	*sc;
2041    int			i;
2042
2043    debug_called(2);
2044
2045    cr = (struct ciss_request *)arg;
2046    sc = cr->cr_sc;
2047    cc = CISS_FIND_COMMAND(cr);
2048
2049    for (i = 0; i < nseg; i++) {
2050	cc->sg[i].address = segs[i].ds_addr;
2051	cc->sg[i].length = segs[i].ds_len;
2052	cc->sg[i].extension = 0;
2053    }
2054    /* we leave the s/g table entirely within the command */
2055    cc->header.sg_in_list = nseg;
2056    cc->header.sg_total = nseg;
2057
2058    if (cr->cr_flags & CISS_REQ_DATAIN)
2059	bus_dmamap_sync(sc->ciss_buffer_dmat, cr->cr_datamap, BUS_DMASYNC_PREREAD);
2060    if (cr->cr_flags & CISS_REQ_DATAOUT)
2061	bus_dmamap_sync(sc->ciss_buffer_dmat, cr->cr_datamap, BUS_DMASYNC_PREWRITE);
2062
2063    /*
2064     * Post the command to the adapter.
2065     */
2066    ciss_enqueue_busy(cr);
2067    CISS_TL_SIMPLE_POST_CMD(cr->cr_sc, CISS_FIND_COMMANDPHYS(cr));
2068}
2069
2070/************************************************************************
2071 * Unmap a request from bus-visible space.
2072 */
2073static void
2074ciss_unmap_request(struct ciss_request *cr)
2075{
2076    struct ciss_softc	*sc;
2077
2078    debug_called(2);
2079
2080    sc = cr->cr_sc;
2081
2082    /* check that unmapping is necessary */
2083    if ((cr->cr_flags & CISS_REQ_MAPPED) == 0)
2084	return;
2085
2086    bus_dmamap_sync(sc->ciss_command_dmat, sc->ciss_command_map,
2087		    BUS_DMASYNC_POSTWRITE);
2088
2089    if (cr->cr_data == NULL)
2090	goto out;
2091
2092    if (cr->cr_flags & CISS_REQ_DATAIN)
2093	bus_dmamap_sync(sc->ciss_buffer_dmat, cr->cr_datamap, BUS_DMASYNC_POSTREAD);
2094    if (cr->cr_flags & CISS_REQ_DATAOUT)
2095	bus_dmamap_sync(sc->ciss_buffer_dmat, cr->cr_datamap, BUS_DMASYNC_POSTWRITE);
2096
2097    bus_dmamap_unload(sc->ciss_buffer_dmat, cr->cr_datamap);
2098out:
2099    cr->cr_flags &= ~CISS_REQ_MAPPED;
2100}
2101
2102/************************************************************************
2103 * Attach the driver to CAM.
2104 *
2105 * We put all the logical drives on a single SCSI bus.
2106 */
2107static int
2108ciss_cam_init(struct ciss_softc *sc)
2109{
2110
2111    debug_called(1);
2112
2113    /*
2114     * Allocate a devq.  We can reuse this for the masked physical
2115     * devices if we decide to export these as well.
2116     */
2117    if ((sc->ciss_cam_devq = cam_simq_alloc(sc->ciss_max_requests)) == NULL) {
2118	ciss_printf(sc, "can't allocate CAM SIM queue\n");
2119	return(ENOMEM);
2120    }
2121
2122    /*
2123     * Create a SIM.
2124     */
2125    if ((sc->ciss_cam_sim = cam_sim_alloc(ciss_cam_action, ciss_cam_poll, "ciss", sc,
2126					  device_get_unit(sc->ciss_dev),
2127					  sc->ciss_max_requests - 2,
2128					  1,
2129					  sc->ciss_cam_devq)) == NULL) {
2130	ciss_printf(sc, "can't allocate CAM SIM\n");
2131	return(ENOMEM);
2132    }
2133
2134    /*
2135     * Register bus 0 (the 'logical drives' bus) with this SIM.
2136     */
2137    if (xpt_bus_register(sc->ciss_cam_sim, 0) != 0) {
2138	ciss_printf(sc, "can't register SCSI bus 0\n");
2139	return(ENXIO);
2140    }
2141
2142    /*
2143     * Initiate a rescan of the bus.
2144     */
2145    ciss_cam_rescan_all(sc);
2146
2147    return(0);
2148}
2149
2150/************************************************************************
2151 * Initiate a rescan of the 'logical devices' SIM
2152 */
2153static void
2154ciss_cam_rescan_target(struct ciss_softc *sc, int target)
2155{
2156    union ccb	*ccb;
2157
2158    debug_called(1);
2159
2160    if ((ccb = malloc(sizeof(union ccb), M_TEMP, M_WAITOK | M_ZERO)) == NULL) {
2161	ciss_printf(sc, "rescan failed (can't allocate CCB)\n");
2162	return;
2163    }
2164
2165    if (xpt_create_path(&sc->ciss_cam_path, xpt_periph, cam_sim_path(sc->ciss_cam_sim), target, 0)
2166	!= CAM_REQ_CMP) {
2167	ciss_printf(sc, "rescan failed (can't create path)\n");
2168	free(ccb, M_TEMP);
2169	return;
2170    }
2171
2172    xpt_setup_ccb(&ccb->ccb_h, sc->ciss_cam_path, 5/*priority (low)*/);
2173    ccb->ccb_h.func_code = XPT_SCAN_BUS;
2174    ccb->ccb_h.cbfcnp = ciss_cam_rescan_callback;
2175    ccb->crcn.flags = CAM_FLAG_NONE;
2176    xpt_action(ccb);
2177
2178    /* scan is now in progress */
2179}
2180
2181static void
2182ciss_cam_rescan_all(struct ciss_softc *sc)
2183{
2184    ciss_cam_rescan_target(sc, 0);
2185}
2186
2187static void
2188ciss_cam_rescan_callback(struct cam_periph *periph, union ccb *ccb)
2189{
2190    xpt_free_path(ccb->ccb_h.path);
2191    free(ccb, M_TEMP);
2192}
2193
2194/************************************************************************
2195 * Handle requests coming from CAM
2196 */
2197static void
2198ciss_cam_action(struct cam_sim *sim, union ccb *ccb)
2199{
2200    struct ciss_softc	*sc;
2201    struct ccb_scsiio	*csio;
2202    int			target;
2203
2204    sc = cam_sim_softc(sim);
2205    csio = (struct ccb_scsiio *)&ccb->csio;
2206    target = csio->ccb_h.target_id;
2207
2208    switch (ccb->ccb_h.func_code) {
2209
2210	/* perform SCSI I/O */
2211    case XPT_SCSI_IO:
2212	if (!ciss_cam_action_io(sim, csio))
2213	    return;
2214	break;
2215
2216	/* perform geometry calculations */
2217    case XPT_CALC_GEOMETRY:
2218    {
2219	struct ccb_calc_geometry	*ccg = &ccb->ccg;
2220	struct ciss_ldrive		*ld = &sc->ciss_logical[target];
2221
2222	debug(1, "XPT_CALC_GEOMETRY %d:%d:%d", cam_sim_bus(sim), ccb->ccb_h.target_id, ccb->ccb_h.target_lun);
2223
2224	/*
2225	 * Use the cached geometry settings unless the fault tolerance
2226	 * is invalid.
2227	 */
2228	if (ld->cl_geometry.fault_tolerance == 0xFF) {
2229	    u_int32_t			secs_per_cylinder;
2230
2231	    ccg->heads = 255;
2232	    ccg->secs_per_track = 32;
2233	    secs_per_cylinder = ccg->heads * ccg->secs_per_track;
2234	    ccg->cylinders = ccg->volume_size / secs_per_cylinder;
2235	} else {
2236	    ccg->heads = ld->cl_geometry.heads;
2237	    ccg->secs_per_track = ld->cl_geometry.sectors;
2238	    ccg->cylinders = ntohs(ld->cl_geometry.cylinders);
2239	}
2240	ccb->ccb_h.status = CAM_REQ_CMP;
2241        break;
2242    }
2243
2244	/* handle path attribute inquiry */
2245    case XPT_PATH_INQ:
2246    {
2247	struct ccb_pathinq	*cpi = &ccb->cpi;
2248
2249	debug(1, "XPT_PATH_INQ %d:%d:%d", cam_sim_bus(sim), ccb->ccb_h.target_id, ccb->ccb_h.target_lun);
2250
2251	cpi->version_num = 1;
2252	cpi->hba_inquiry = PI_TAG_ABLE;	/* XXX is this correct? */
2253	cpi->target_sprt = 0;
2254	cpi->hba_misc = 0;
2255	cpi->max_target = CISS_MAX_LOGICAL;
2256	cpi->max_lun = 0;		/* 'logical drive' channel only */
2257	cpi->initiator_id = CISS_MAX_LOGICAL;
2258	strncpy(cpi->sim_vid, "FreeBSD", SIM_IDLEN);
2259        strncpy(cpi->hba_vid, "msmith@freebsd.org", HBA_IDLEN);
2260        strncpy(cpi->dev_name, cam_sim_name(sim), DEV_IDLEN);
2261        cpi->unit_number = cam_sim_unit(sim);
2262        cpi->bus_id = cam_sim_bus(sim);
2263	cpi->base_transfer_speed = 132 * 1024;	/* XXX what to set this to? */
2264	ccb->ccb_h.status = CAM_REQ_CMP;
2265	break;
2266    }
2267
2268    case XPT_GET_TRAN_SETTINGS:
2269    {
2270	struct ccb_trans_settings	*cts = &ccb->cts;
2271	int				bus, target;
2272
2273	bus = cam_sim_bus(sim);
2274	target = cts->ccb_h.target_id;
2275
2276	debug(1, "XPT_GET_TRAN_SETTINGS %d:%d", bus, target);
2277	cts->valid = 0;
2278
2279	/* disconnect always OK */
2280	cts->flags |= CCB_TRANS_DISC_ENB;
2281	cts->valid |= CCB_TRANS_DISC_VALID;
2282
2283	cts->ccb_h.status = CAM_REQ_CMP;
2284	break;
2285    }
2286
2287    default:		/* we can't do this */
2288	debug(1, "unspported func_code = 0x%x", ccb->ccb_h.func_code);
2289	ccb->ccb_h.status = CAM_REQ_INVALID;
2290	break;
2291    }
2292
2293    xpt_done(ccb);
2294}
2295
2296/************************************************************************
2297 * Handle a CAM SCSI I/O request.
2298 */
2299static int
2300ciss_cam_action_io(struct cam_sim *sim, struct ccb_scsiio *csio)
2301{
2302    struct ciss_softc	*sc;
2303    int			bus, target;
2304    struct ciss_request	*cr;
2305    struct ciss_command	*cc;
2306    int			error;
2307
2308    sc = cam_sim_softc(sim);
2309    bus = cam_sim_bus(sim);
2310    target = csio->ccb_h.target_id;
2311
2312    debug(2, "XPT_SCSI_IO %d:%d:%d", bus, target, csio->ccb_h.target_lun);
2313
2314    /* check for I/O attempt to nonexistent device */
2315    if ((bus != 0) ||
2316	(target >= CISS_MAX_LOGICAL)) {
2317	debug(3, "  device does not exist");
2318	csio->ccb_h.status = CAM_REQ_CMP_ERR;
2319    }
2320
2321    /* firmware does not support commands > 10 bytes */
2322    if (csio->cdb_len > 12/*CISS_CDB_BUFFER_SIZE*/) {
2323	debug(3, "  command too large (%d > %d)", csio->cdb_len, CISS_CDB_BUFFER_SIZE);
2324	csio->ccb_h.status = CAM_REQ_CMP_ERR;
2325    }
2326
2327    /* check that the CDB pointer is not to a physical address */
2328    if ((csio->ccb_h.flags & CAM_CDB_POINTER) && (csio->ccb_h.flags & CAM_CDB_PHYS)) {
2329	debug(3, "  CDB pointer is to physical address");
2330	csio->ccb_h.status = CAM_REQ_CMP_ERR;
2331    }
2332
2333    /* if there is data transfer, it must be to/from a virtual address */
2334    if ((csio->ccb_h.flags & CAM_DIR_MASK) != CAM_DIR_NONE) {
2335	if (csio->ccb_h.flags & CAM_DATA_PHYS) {		/* we can't map it */
2336	    debug(3, "  data pointer is to physical address");
2337	    csio->ccb_h.status = CAM_REQ_CMP_ERR;
2338	}
2339	if (csio->ccb_h.flags & CAM_SCATTER_VALID) {	/* we want to do the s/g setup */
2340	    debug(3, "  data has premature s/g setup");
2341	    csio->ccb_h.status = CAM_REQ_CMP_ERR;
2342	}
2343    }
2344
2345    /* abandon aborted ccbs or those that have failed validation */
2346    if ((csio->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_INPROG) {
2347	debug(3, "abandoning CCB due to abort/validation failure");
2348	return(EINVAL);
2349    }
2350
2351    /* handle emulation of some SCSI commands ourself */
2352    if (ciss_cam_emulate(sc, csio))
2353	return(0);
2354
2355    /*
2356     * Get a request to manage this command.  If we can't, return the
2357     * ccb, freeze the queue and flag so that we unfreeze it when a
2358     * request completes.
2359     */
2360    if ((error = ciss_get_request(sc, &cr)) != 0) {
2361	xpt_freeze_simq(sc->ciss_cam_sim, 1);
2362	csio->ccb_h.status |= CAM_REQUEUE_REQ;
2363	return(error);
2364    }
2365
2366    /*
2367     * Build the command.
2368     */
2369    cc = CISS_FIND_COMMAND(cr);
2370    cr->cr_data = csio->data_ptr;
2371    cr->cr_length = csio->dxfer_len;
2372    cr->cr_complete = ciss_cam_complete;
2373    cr->cr_private = csio;
2374
2375    cc->header.address.logical.mode = CISS_HDR_ADDRESS_MODE_LOGICAL;
2376    cc->header.address.logical.lun = target;
2377    cc->cdb.cdb_length = csio->cdb_len;
2378    cc->cdb.type = CISS_CDB_TYPE_COMMAND;
2379    cc->cdb.attribute = CISS_CDB_ATTRIBUTE_SIMPLE;	/* XXX ordered tags? */
2380    if ((csio->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_OUT) {
2381	cr->cr_flags = CISS_REQ_DATAOUT;
2382	cc->cdb.direction = CISS_CDB_DIRECTION_WRITE;
2383    } else if ((csio->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_IN) {
2384	cr->cr_flags = CISS_REQ_DATAIN;
2385	cc->cdb.direction = CISS_CDB_DIRECTION_READ;
2386    } else {
2387	cr->cr_flags = 0;
2388	cc->cdb.direction = CISS_CDB_DIRECTION_NONE;
2389    }
2390    cc->cdb.timeout = (csio->ccb_h.timeout / 1000) + 1;
2391    if (csio->ccb_h.flags & CAM_CDB_POINTER) {
2392	bcopy(csio->cdb_io.cdb_ptr, &cc->cdb.cdb[0], csio->cdb_len);
2393    } else {
2394	bcopy(csio->cdb_io.cdb_bytes, &cc->cdb.cdb[0], csio->cdb_len);
2395    }
2396
2397    /*
2398     * Submit the request to the adapter.
2399     *
2400     * Note that this may fail if we're unable to map the request (and
2401     * if we ever learn a transport layer other than simple, may fail
2402     * if the adapter rejects the command).
2403     */
2404    if ((error = ciss_start(cr)) != 0) {
2405	xpt_freeze_simq(sc->ciss_cam_sim, 1);
2406	if (error == EINPROGRESS) {
2407	    csio->ccb_h.status |= CAM_RELEASE_SIMQ;
2408	    error = 0;
2409	} else {
2410	    csio->ccb_h.status |= CAM_REQUEUE_REQ;
2411	    ciss_release_request(cr);
2412	}
2413	return(error);
2414    }
2415
2416    return(0);
2417}
2418
2419/************************************************************************
2420 * Emulate SCSI commands the adapter doesn't handle as we might like.
2421 */
2422static int
2423ciss_cam_emulate(struct ciss_softc *sc, struct ccb_scsiio *csio)
2424{
2425    int		target;
2426    u_int8_t	opcode;
2427
2428    target = csio->ccb_h.target_id;
2429    opcode = (csio->ccb_h.flags & CAM_CDB_POINTER) ?
2430	*(u_int8_t *)csio->cdb_io.cdb_ptr : csio->cdb_io.cdb_bytes[0];
2431
2432    /*
2433     * Handle requests for volumes that don't exist.  A selection timeout
2434     * is slightly better than an illegal request.  Other errors might be
2435     * better.
2436     */
2437    if (sc->ciss_logical[target].cl_status == CISS_LD_NONEXISTENT) {
2438	csio->ccb_h.status = CAM_SEL_TIMEOUT;
2439	xpt_done((union ccb *)csio);
2440	return(1);
2441    }
2442
2443    /*
2444     * Handle requests for volumes that exist but are offline.
2445     *
2446     * I/O operations should fail, everything else should work.
2447     */
2448    if (sc->ciss_logical[target].cl_status == CISS_LD_OFFLINE) {
2449	switch(opcode) {
2450	case READ_6:
2451	case READ_10:
2452	case READ_12:
2453	case WRITE_6:
2454	case WRITE_10:
2455	case WRITE_12:
2456	    csio->ccb_h.status = CAM_SEL_TIMEOUT;
2457	    xpt_done((union ccb *)csio);
2458	    return(1);
2459	}
2460    }
2461
2462    /* if we have to fake Synchronise Cache */
2463    if (sc->ciss_flags & CISS_FLAG_FAKE_SYNCH) {
2464	/*
2465	 * If this is a Synchronise Cache command, typically issued when
2466	 * a device is closed, flush the adapter and complete now.
2467	 */
2468	if (((csio->ccb_h.flags & CAM_CDB_POINTER) ?
2469	     *(u_int8_t *)csio->cdb_io.cdb_ptr : csio->cdb_io.cdb_bytes[0]) == SYNCHRONIZE_CACHE) {
2470	    ciss_flush_adapter(sc);
2471	    csio->ccb_h.status = CAM_REQ_CMP;
2472	    xpt_done((union ccb *)csio);
2473	    return(1);
2474	}
2475    }
2476
2477    return(0);
2478}
2479
2480/************************************************************************
2481 * Check for possibly-completed commands.
2482 */
2483static void
2484ciss_cam_poll(struct cam_sim *sim)
2485{
2486    struct ciss_softc	*sc = cam_sim_softc(sim);
2487
2488    debug_called(2);
2489
2490    ciss_done(sc);
2491}
2492
2493/************************************************************************
2494 * Handle completion of a command - pass results back through the CCB
2495 */
2496static void
2497ciss_cam_complete(struct ciss_request *cr)
2498{
2499    struct ciss_softc		*sc;
2500    struct ciss_command		*cc;
2501    struct ciss_error_info	*ce;
2502    struct ccb_scsiio		*csio;
2503    int				scsi_status;
2504    int				command_status;
2505
2506    debug_called(2);
2507
2508    sc = cr->cr_sc;
2509    cc = CISS_FIND_COMMAND(cr);
2510    ce = (struct ciss_error_info *)&(cc->sg[0]);
2511    csio = (struct ccb_scsiio *)cr->cr_private;
2512
2513    /*
2514     * Extract status values from request.
2515     */
2516    ciss_report_request(cr, &command_status, &scsi_status);
2517    csio->scsi_status = scsi_status;
2518
2519    /*
2520     * Handle specific SCSI status values.
2521     */
2522    switch(scsi_status) {
2523	/* no status due to adapter error */
2524    case -1:
2525	debug(0, "adapter error");
2526	csio->ccb_h.status = CAM_REQ_CMP_ERR;
2527	break;
2528
2529	/* no status due to command completed OK */
2530    case SCSI_STATUS_OK:		/* CISS_SCSI_STATUS_GOOD */
2531	debug(2, "SCSI_STATUS_OK");
2532	csio->ccb_h.status = CAM_REQ_CMP;
2533	break;
2534
2535	/* check condition, sense data included */
2536    case SCSI_STATUS_CHECK_COND:	/* CISS_SCSI_STATUS_CHECK_CONDITION */
2537	debug(0, "SCSI_STATUS_CHECK_COND  sense size %d  resid %d",
2538	      ce->sense_length, ce->residual_count);
2539	bzero(&csio->sense_data, SSD_FULL_SIZE);
2540	bcopy(&ce->sense_info[0], &csio->sense_data, ce->sense_length);
2541	csio->sense_len = ce->sense_length;
2542	csio->resid = ce->residual_count;
2543	csio->ccb_h.status = CAM_SCSI_STATUS_ERROR | CAM_AUTOSNS_VALID;
2544#ifdef CISS_DEBUG
2545	{
2546	    struct scsi_sense_data	*sns = (struct scsi_sense_data *)&ce->sense_info[0];
2547	    debug(0, "sense key %x", sns->flags & SSD_KEY);
2548	}
2549#endif
2550	break;
2551
2552    case SCSI_STATUS_BUSY:		/* CISS_SCSI_STATUS_BUSY */
2553	debug(0, "SCSI_STATUS_BUSY");
2554	csio->ccb_h.status = CAM_SCSI_BUSY;
2555	break;
2556
2557    default:
2558	debug(0, "unknown status 0x%x", csio->scsi_status);
2559	csio->ccb_h.status = CAM_REQ_CMP_ERR;
2560	break;
2561    }
2562
2563    /* handle post-command fixup */
2564    ciss_cam_complete_fixup(sc, csio);
2565
2566    /* tell CAM we're ready for more commands */
2567    csio->ccb_h.status |= CAM_RELEASE_SIMQ;
2568
2569    xpt_done((union ccb *)csio);
2570    ciss_release_request(cr);
2571}
2572
2573/********************************************************************************
2574 * Fix up the result of some commands here.
2575 */
2576static void
2577ciss_cam_complete_fixup(struct ciss_softc *sc, struct ccb_scsiio *csio)
2578{
2579    struct scsi_inquiry_data	*inq;
2580    struct ciss_ldrive		*cl;
2581    int				target;
2582
2583    if (((csio->ccb_h.flags & CAM_CDB_POINTER) ?
2584	 *(u_int8_t *)csio->cdb_io.cdb_ptr : csio->cdb_io.cdb_bytes[0]) == INQUIRY) {
2585
2586	inq = (struct scsi_inquiry_data *)csio->data_ptr;
2587	target = csio->ccb_h.target_id;
2588	cl = &sc->ciss_logical[target];
2589
2590	padstr(inq->vendor, "COMPAQ", 8);
2591	padstr(inq->product, ciss_name_ldrive_org(cl->cl_ldrive->fault_tolerance), 8);
2592	padstr(inq->revision, ciss_name_ldrive_status(cl->cl_lstatus->status), 16);
2593    }
2594}
2595
2596
2597/********************************************************************************
2598 * Find a peripheral attached at (target)
2599 */
2600static struct cam_periph *
2601ciss_find_periph(struct ciss_softc *sc, int target)
2602{
2603    struct cam_periph	*periph;
2604    struct cam_path	*path;
2605    int			status;
2606
2607    status = xpt_create_path(&path, NULL, cam_sim_path(sc->ciss_cam_sim), target, 0);
2608    if (status == CAM_REQ_CMP) {
2609	periph = cam_periph_find(path, NULL);
2610	xpt_free_path(path);
2611    } else {
2612	periph = NULL;
2613    }
2614    return(periph);
2615}
2616
2617/********************************************************************************
2618 * Name the device at (target)
2619 *
2620 * XXX is this strictly correct?
2621 */
2622static int
2623ciss_name_device(struct ciss_softc *sc, int target)
2624{
2625    struct cam_periph	*periph;
2626
2627    if ((periph = ciss_find_periph(sc, target)) != NULL) {
2628	sprintf(sc->ciss_logical[target].cl_name, "%s%d", periph->periph_name, periph->unit_number);
2629	return(0);
2630    }
2631    sc->ciss_logical[target].cl_name[0] = 0;
2632    return(ENOENT);
2633}
2634
2635/************************************************************************
2636 * Periodic status monitoring.
2637 */
2638static void
2639ciss_periodic(void *arg)
2640{
2641    struct ciss_softc	*sc;
2642
2643    debug_called(1);
2644
2645    sc = (struct ciss_softc *)arg;
2646
2647    /*
2648     * Check the adapter heartbeat.
2649     */
2650    if (sc->ciss_cfg->heartbeat == sc->ciss_heartbeat) {
2651	sc->ciss_heart_attack++;
2652	debug(0, "adapter heart attack in progress 0x%x/%d",
2653	      sc->ciss_heartbeat, sc->ciss_heart_attack);
2654	if (sc->ciss_heart_attack == 3) {
2655	    ciss_printf(sc, "ADAPTER HEARTBEAT FAILED\n");
2656	    /* XXX should reset adapter here */
2657	}
2658    } else {
2659	sc->ciss_heartbeat = sc->ciss_cfg->heartbeat;
2660	sc->ciss_heart_attack = 0;
2661	debug(3, "new heartbeat 0x%x", sc->ciss_heartbeat);
2662    }
2663
2664    /*
2665     * If the notify event request has died for some reason, or has
2666     * not started yet, restart it.
2667     */
2668    if (!(sc->ciss_flags & CISS_FLAG_NOTIFY_OK)) {
2669	debug(0, "(re)starting Event Notify chain");
2670	ciss_notify_event(sc);
2671    }
2672
2673    /*
2674     * Reschedule.
2675     */
2676    if (!(sc->ciss_flags & CISS_FLAG_ABORTING))
2677	sc->ciss_periodic = timeout(ciss_periodic, sc, CISS_HEARTBEAT_RATE * hz);
2678}
2679
2680/************************************************************************
2681 * Request a notification response from the adapter.
2682 *
2683 * If (cr) is NULL, this is the first request of the adapter, so
2684 * reset the adapter's message pointer and start with the oldest
2685 * message available.
2686 */
2687static void
2688ciss_notify_event(struct ciss_softc *sc)
2689{
2690    struct ciss_request		*cr;
2691    struct ciss_command		*cc;
2692    struct ciss_notify_cdb	*cnc;
2693    int				error;
2694
2695    debug_called(1);
2696
2697    cr = sc->ciss_periodic_notify;
2698
2699    /* get a request if we don't already have one */
2700    if (cr == NULL) {
2701	if ((error = ciss_get_request(sc, &cr)) != 0) {
2702	    debug(0, "can't get notify event request");
2703	    goto out;
2704	}
2705	sc->ciss_periodic_notify = cr;
2706	cr->cr_complete = ciss_notify_complete;
2707	debug(1, "acquired request %d", cr->cr_tag);
2708    }
2709
2710    /*
2711     * Get a databuffer if we don't already have one, note that the
2712     * adapter command wants a larger buffer than the actual
2713     * structure.
2714     */
2715    if (cr->cr_data == NULL) {
2716	if ((cr->cr_data = malloc(CISS_NOTIFY_DATA_SIZE, CISS_MALLOC_CLASS, M_NOWAIT)) == NULL) {
2717	    debug(0, "can't get notify event request buffer");
2718	    error = ENOMEM;
2719	    goto out;
2720	}
2721	cr->cr_length = CISS_NOTIFY_DATA_SIZE;
2722    }
2723
2724    /* re-setup the request's command (since we never release it) XXX overkill*/
2725    ciss_preen_command(cr);
2726
2727    /* (re)build the notify event command */
2728    cc = CISS_FIND_COMMAND(cr);
2729    cc->header.address.physical.mode = CISS_HDR_ADDRESS_MODE_PERIPHERAL;
2730    cc->header.address.physical.bus = 0;
2731    cc->header.address.physical.target = 0;
2732
2733    cc->cdb.cdb_length = sizeof(*cnc);
2734    cc->cdb.type = CISS_CDB_TYPE_COMMAND;
2735    cc->cdb.attribute = CISS_CDB_ATTRIBUTE_SIMPLE;
2736    cc->cdb.direction = CISS_CDB_DIRECTION_READ;
2737    cc->cdb.timeout = 0;	/* no timeout, we hope */
2738
2739    cnc = (struct ciss_notify_cdb *)&(cc->cdb.cdb[0]);
2740    bzero(cr->cr_data, CISS_NOTIFY_DATA_SIZE);
2741    cnc->opcode = CISS_OPCODE_READ;
2742    cnc->command = CISS_COMMAND_NOTIFY_ON_EVENT;
2743    cnc->timeout = 0;		/* no timeout, we hope */
2744    cnc->synchronous = 0;
2745    cnc->ordered = 0;
2746    cnc->seek_to_oldest = 0;
2747    cnc->new_only = 0;
2748    cnc->length = htonl(CISS_NOTIFY_DATA_SIZE);
2749
2750    /* submit the request */
2751    error = ciss_start(cr);
2752
2753 out:
2754    if (error) {
2755	if (cr != NULL) {
2756	    if (cr->cr_data != NULL)
2757		free(cr->cr_data, CISS_MALLOC_CLASS);
2758	    ciss_release_request(cr);
2759	}
2760	sc->ciss_periodic_notify = NULL;
2761	debug(0, "can't submit notify event request");
2762	sc->ciss_flags &= ~CISS_FLAG_NOTIFY_OK;
2763    } else {
2764	debug(1, "notify event submitted");
2765	sc->ciss_flags |= CISS_FLAG_NOTIFY_OK;
2766    }
2767}
2768
2769static void
2770ciss_notify_complete(struct ciss_request *cr)
2771{
2772    struct ciss_command	*cc;
2773    struct ciss_notify	*cn;
2774    struct ciss_softc	*sc;
2775    int			scsi_status;
2776    int			command_status;
2777
2778    debug_called(1);
2779
2780    cc = CISS_FIND_COMMAND(cr);
2781    cn = (struct ciss_notify *)cr->cr_data;
2782    sc = cr->cr_sc;
2783
2784    /*
2785     * Report request results, decode status.
2786     */
2787    ciss_report_request(cr, &command_status, &scsi_status);
2788
2789    /*
2790     * Abort the chain on a fatal error.
2791     *
2792     * XXX which of these are actually errors?
2793     */
2794    if ((command_status != CISS_CMD_STATUS_SUCCESS) &&
2795	(command_status != CISS_CMD_STATUS_TARGET_STATUS) &&
2796	(command_status != CISS_CMD_STATUS_TIMEOUT)) {	/* XXX timeout? */
2797	ciss_printf(sc, "fatal error in Notify Event request (%s)\n",
2798		    ciss_name_command_status(command_status));
2799	ciss_release_request(cr);
2800	sc->ciss_flags &= ~CISS_FLAG_NOTIFY_OK;
2801	return;
2802    }
2803
2804    /*
2805     * If the adapter gave us a text message, print it.
2806     */
2807    if (cn->message[0] != 0)
2808	ciss_printf(sc, "*** %.80s\n", cn->message);
2809
2810    debug(0, "notify event class %d subclass %d detail %d",
2811		cn->class, cn->subclass, cn->detail);
2812
2813    /*
2814     * If there's room, save the event for a user-level tool.
2815     */
2816    if (((sc->ciss_notify_head + 1) % CISS_MAX_EVENTS) != sc->ciss_notify_tail) {
2817	sc->ciss_notify[sc->ciss_notify_head] = *cn;
2818	sc->ciss_notify_head = (sc->ciss_notify_head + 1) % CISS_MAX_EVENTS;
2819    }
2820
2821    /*
2822     * Some events are directly of interest to us.
2823     */
2824    switch (cn->class) {
2825    case CISS_NOTIFY_LOGICAL:
2826	ciss_notify_logical(sc, cn);
2827	break;
2828    case CISS_NOTIFY_PHYSICAL:
2829	ciss_notify_physical(sc, cn);
2830	break;
2831    }
2832
2833    /*
2834     * If the response indicates that the notifier has been aborted,
2835     * release the notifier command.
2836     */
2837    if ((cn->class == CISS_NOTIFY_NOTIFIER) &&
2838	(cn->subclass == CISS_NOTIFY_NOTIFIER_STATUS) &&
2839	(cn->detail == 1)) {
2840	debug(0, "notifier exiting");
2841	sc->ciss_flags &= ~CISS_FLAG_NOTIFY_OK;
2842	ciss_release_request(cr);
2843	sc->ciss_periodic_notify = NULL;
2844	wakeup(&sc->ciss_periodic_notify);
2845    }
2846
2847    /*
2848     * Send a new notify event command, if we're not aborting.
2849     */
2850    if (!(sc->ciss_flags & CISS_FLAG_ABORTING)) {
2851	ciss_notify_event(sc);
2852    }
2853}
2854
2855/************************************************************************
2856 * Abort the Notify Event chain.
2857 *
2858 * Note that we can't just abort the command in progress; we have to
2859 * explicitly issue an Abort Notify Event command in order for the
2860 * adapter to clean up correctly.
2861 *
2862 * If we are called with CISS_FLAG_ABORTING set in the adapter softc,
2863 * the chain will not restart itself.
2864 */
2865static int
2866ciss_notify_abort(struct ciss_softc *sc)
2867{
2868    struct ciss_request		*cr;
2869    struct ciss_command		*cc;
2870    struct ciss_notify_cdb	*cnc;
2871    int				error, s, command_status, scsi_status;
2872
2873    debug_called(1);
2874
2875    cr = NULL;
2876    error = 0;
2877
2878    /* verify that there's an outstanding command */
2879    if (!(sc->ciss_flags & CISS_FLAG_NOTIFY_OK))
2880	goto out;
2881
2882    /* get a command to issue the abort with */
2883    if ((error = ciss_get_request(sc, &cr)))
2884	goto out;
2885
2886    /* get a buffer for the result */
2887    if ((cr->cr_data = malloc(CISS_NOTIFY_DATA_SIZE, CISS_MALLOC_CLASS, M_NOWAIT)) == NULL) {
2888	debug(0, "can't get notify event request buffer");
2889	error = ENOMEM;
2890	goto out;
2891    }
2892    cr->cr_length = CISS_NOTIFY_DATA_SIZE;
2893
2894    /* build the CDB */
2895    cc = CISS_FIND_COMMAND(cr);
2896    cc->header.address.physical.mode = CISS_HDR_ADDRESS_MODE_PERIPHERAL;
2897    cc->header.address.physical.bus = 0;
2898    cc->header.address.physical.target = 0;
2899    cc->cdb.cdb_length = sizeof(*cnc);
2900    cc->cdb.type = CISS_CDB_TYPE_COMMAND;
2901    cc->cdb.attribute = CISS_CDB_ATTRIBUTE_SIMPLE;
2902    cc->cdb.direction = CISS_CDB_DIRECTION_READ;
2903    cc->cdb.timeout = 0;	/* no timeout, we hope */
2904
2905    cnc = (struct ciss_notify_cdb *)&(cc->cdb.cdb[0]);
2906    bzero(cnc, sizeof(*cnc));
2907    cnc->opcode = CISS_OPCODE_WRITE;
2908    cnc->command = CISS_COMMAND_ABORT_NOTIFY;
2909    cnc->length = htonl(CISS_NOTIFY_DATA_SIZE);
2910
2911    ciss_print_request(cr);
2912
2913    /*
2914     * Submit the request and wait for it to complete.
2915     */
2916    if ((error = ciss_synch_request(cr, 60 * 1000)) != 0) {
2917	ciss_printf(sc, "Abort Notify Event command failed (%d)\n", error);
2918	goto out;
2919    }
2920
2921    /*
2922     * Check response.
2923     */
2924    ciss_report_request(cr, &command_status, &scsi_status);
2925    switch(command_status) {
2926    case CISS_CMD_STATUS_SUCCESS:
2927	break;
2928    case CISS_CMD_STATUS_INVALID_COMMAND:
2929	/*
2930	 * Some older adapters don't support the CISS version of this
2931	 * command.  Fall back to using the BMIC version.
2932	 */
2933	error = ciss_notify_abort_bmic(sc);
2934	if (error != 0)
2935	    goto out;
2936	break;
2937
2938    case CISS_CMD_STATUS_TARGET_STATUS:
2939	/*
2940	 * This can happen if the adapter thinks there wasn't an outstanding
2941	 * Notify Event command but we did.  We clean up here.
2942	 */
2943	if (scsi_status == CISS_SCSI_STATUS_CHECK_CONDITION) {
2944	    if (sc->ciss_periodic_notify != NULL)
2945		ciss_release_request(sc->ciss_periodic_notify);
2946	    error = 0;
2947	    goto out;
2948	}
2949	/* FALLTHROUGH */
2950
2951    default:
2952	ciss_printf(sc, "Abort Notify Event command failed (%s)\n",
2953		    ciss_name_command_status(command_status));
2954	error = EIO;
2955	goto out;
2956    }
2957
2958    /*
2959     * Sleep waiting for the notifier command to complete.  Note
2960     * that if it doesn't, we may end up in a bad situation, since
2961     * the adapter may deliver it later.  Also note that the adapter
2962     * requires the Notify Event command to be cancelled in order to
2963     * maintain internal bookkeeping.
2964     */
2965    s = splcam();
2966    while (sc->ciss_periodic_notify != NULL) {
2967	error = tsleep(&sc->ciss_periodic_notify, 0, "cissNEA", hz * 5);
2968	if (error == EWOULDBLOCK) {
2969	    ciss_printf(sc, "Notify Event command failed to abort, adapter may wedge.\n");
2970	    break;
2971	}
2972    }
2973    splx(s);
2974
2975 out:
2976    /* release the cancel request */
2977    if (cr != NULL) {
2978	if (cr->cr_data != NULL)
2979	    free(cr->cr_data, CISS_MALLOC_CLASS);
2980	ciss_release_request(cr);
2981    }
2982    if (error == 0)
2983	sc->ciss_flags &= ~CISS_FLAG_NOTIFY_OK;
2984    return(error);
2985}
2986
2987/************************************************************************
2988 * Abort the Notify Event chain using a BMIC command.
2989 */
2990static int
2991ciss_notify_abort_bmic(struct ciss_softc *sc)
2992{
2993    struct ciss_request			*cr;
2994    int					error, command_status;
2995
2996    debug_called(1);
2997
2998    cr = NULL;
2999    error = 0;
3000
3001    /* verify that there's an outstanding command */
3002    if (!(sc->ciss_flags & CISS_FLAG_NOTIFY_OK))
3003	goto out;
3004
3005    /*
3006     * Build a BMIC command to cancel the Notify on Event command.
3007     *
3008     * Note that we are sending a CISS opcode here.  Odd.
3009     */
3010    if ((error = ciss_get_bmic_request(sc, &cr, CISS_COMMAND_ABORT_NOTIFY,
3011				       NULL, 0)) != 0)
3012	goto out;
3013
3014    /*
3015     * Submit the request and wait for it to complete.
3016     */
3017    if ((error = ciss_synch_request(cr, 60 * 1000)) != 0) {
3018	ciss_printf(sc, "error sending BMIC Cancel Notify on Event command (%d)\n", error);
3019	goto out;
3020    }
3021
3022    /*
3023     * Check response.
3024     */
3025    ciss_report_request(cr, &command_status, NULL);
3026    switch(command_status) {
3027    case CISS_CMD_STATUS_SUCCESS:
3028	break;
3029    default:
3030	ciss_printf(sc, "error cancelling Notify on Event (%s)\n",
3031		    ciss_name_command_status(command_status));
3032	error = EIO;
3033	goto out;
3034    }
3035
3036out:
3037    if (cr != NULL)
3038	ciss_release_request(cr);
3039    return(error);
3040}
3041
3042/************************************************************************
3043 * Handle a notify event relating to the status of a logical drive.
3044 *
3045 * XXX need to be able to defer some of these to properly handle
3046 *     calling the "ID Physical drive" command, unless the 'extended'
3047 *     drive IDs are always in BIG_MAP format.
3048 */
3049static void
3050ciss_notify_logical(struct ciss_softc *sc, struct ciss_notify *cn)
3051{
3052    struct ciss_ldrive	*ld;
3053    int			ostatus;
3054
3055    debug_called(2);
3056
3057    ld = &sc->ciss_logical[cn->data.logical_status.logical_drive];
3058
3059    switch (cn->subclass) {
3060    case CISS_NOTIFY_LOGICAL_STATUS:
3061	switch (cn->detail) {
3062	case 0:
3063	    ciss_name_device(sc, cn->data.logical_status.logical_drive);
3064	    ciss_printf(sc, "logical drive %d (%s) changed status %s->%s, spare status 0x%b\n",
3065			cn->data.logical_status.logical_drive, ld->cl_name,
3066			ciss_name_ldrive_status(cn->data.logical_status.previous_state),
3067			ciss_name_ldrive_status(cn->data.logical_status.new_state),
3068			cn->data.logical_status.spare_state,
3069			"\20\1configured\2rebuilding\3failed\4in use\5available\n");
3070
3071	    /*
3072	     * Update our idea of the drive's status.
3073	     */
3074	    ostatus = ciss_decode_ldrive_status(cn->data.logical_status.previous_state);
3075	    ld->cl_status = ciss_decode_ldrive_status(cn->data.logical_status.new_state);
3076	    if (ld->cl_lstatus != NULL)
3077		ld->cl_lstatus->status = cn->data.logical_status.new_state;
3078
3079#if 0
3080	    /*
3081	     * Have CAM rescan the drive if its status has changed.
3082	     */
3083	    if (ostatus != ld->cl_status)
3084		ciss_cam_rescan_target(sc, cn->data.logical_status.logical_drive);
3085#endif
3086
3087	    break;
3088
3089	case 1:	/* logical drive has recognised new media, needs Accept Media Exchange */
3090	    ciss_name_device(sc, cn->data.logical_status.logical_drive);
3091	    ciss_printf(sc, "logical drive %d (%s) media exchanged, ready to go online\n",
3092			cn->data.logical_status.logical_drive, ld->cl_name);
3093	    ciss_accept_media(sc, cn->data.logical_status.logical_drive, 1);
3094	    break;
3095
3096	case 2:
3097	case 3:
3098	    ciss_printf(sc, "rebuild of logical drive %d (%s) failed due to %s error\n",
3099			cn->data.rebuild_aborted.logical_drive,
3100			sc->ciss_logical[cn->data.rebuild_aborted.logical_drive].cl_name,
3101			(cn->detail == 2) ? "read" : "write");
3102	    break;
3103	}
3104	break;
3105
3106    case CISS_NOTIFY_LOGICAL_ERROR:
3107	if (cn->detail == 0) {
3108	    ciss_printf(sc, "FATAL I/O ERROR on logical drive %d (%s), SCSI port %d ID %d\n",
3109			cn->data.io_error.logical_drive,
3110			sc->ciss_logical[cn->data.io_error.logical_drive].cl_name,
3111			cn->data.io_error.failure_bus,
3112			cn->data.io_error.failure_drive);
3113	    /* XXX should we take the drive down at this point, or will we be told? */
3114	}
3115	break;
3116
3117    case CISS_NOTIFY_LOGICAL_SURFACE:
3118	if (cn->detail == 0)
3119	    ciss_printf(sc, "logical drive %d (%s) completed consistency initialisation\n",
3120			cn->data.consistency_completed.logical_drive,
3121			sc->ciss_logical[cn->data.consistency_completed.logical_drive].cl_name);
3122	break;
3123    }
3124}
3125
3126/************************************************************************
3127 * Handle a notify event relating to the status of a physical drive.
3128 */
3129static void
3130ciss_notify_physical(struct ciss_softc *sc, struct ciss_notify *cn)
3131{
3132
3133}
3134
3135/************************************************************************
3136 * Print a request.
3137 */
3138static void
3139ciss_print_request(struct ciss_request *cr)
3140{
3141    struct ciss_softc	*sc;
3142    struct ciss_command	*cc;
3143    int			i;
3144
3145    sc = cr->cr_sc;
3146    cc = CISS_FIND_COMMAND(cr);
3147
3148    ciss_printf(sc, "REQUEST @ %p\n", cr);
3149    ciss_printf(sc, "  data %p/%d  tag %d  flags %b\n",
3150	      cr->cr_data, cr->cr_length, cr->cr_tag, cr->cr_flags,
3151	      "\20\1mapped\2sleep\3poll\4dataout\5datain\n");
3152    ciss_printf(sc, "  sg list/total %d/%d  host tag 0x%x\n",
3153		cc->header.sg_in_list, cc->header.sg_total, cc->header.host_tag);
3154    switch(cc->header.address.mode.mode) {
3155    case CISS_HDR_ADDRESS_MODE_PERIPHERAL:
3156    case CISS_HDR_ADDRESS_MODE_MASK_PERIPHERAL:
3157	ciss_printf(sc, "  physical bus %d target %d\n",
3158		    cc->header.address.physical.bus, cc->header.address.physical.target);
3159	break;
3160    case CISS_HDR_ADDRESS_MODE_LOGICAL:
3161	ciss_printf(sc, "  logical unit %d\n", cc->header.address.logical.lun);
3162	break;
3163    }
3164    ciss_printf(sc, "  %s cdb length %d type %s attribute %s\n",
3165		(cc->cdb.direction == CISS_CDB_DIRECTION_NONE) ? "no-I/O" :
3166		(cc->cdb.direction == CISS_CDB_DIRECTION_READ) ? "READ" :
3167		(cc->cdb.direction == CISS_CDB_DIRECTION_WRITE) ? "WRITE" : "??",
3168		cc->cdb.cdb_length,
3169		(cc->cdb.type == CISS_CDB_TYPE_COMMAND) ? "command" :
3170		(cc->cdb.type == CISS_CDB_TYPE_MESSAGE) ? "message" : "??",
3171		(cc->cdb.attribute == CISS_CDB_ATTRIBUTE_UNTAGGED) ? "untagged" :
3172		(cc->cdb.attribute == CISS_CDB_ATTRIBUTE_SIMPLE) ? "simple" :
3173		(cc->cdb.attribute == CISS_CDB_ATTRIBUTE_HEAD_OF_QUEUE) ? "head-of-queue" :
3174		(cc->cdb.attribute == CISS_CDB_ATTRIBUTE_ORDERED) ? "ordered" :
3175		(cc->cdb.attribute == CISS_CDB_ATTRIBUTE_AUTO_CONTINGENT) ? "auto-contingent" : "??");
3176    ciss_printf(sc, "  %*D\n", cc->cdb.cdb_length, &cc->cdb.cdb[0], " ");
3177
3178    if (cc->header.host_tag & CISS_HDR_HOST_TAG_ERROR) {
3179	/* XXX print error info */
3180    } else {
3181	/* since we don't use chained s/g, don't support it here */
3182	for (i = 0; i < cc->header.sg_in_list; i++) {
3183	    if ((i % 4) == 0)
3184		ciss_printf(sc, "   ");
3185	    printf("0x%08x/%d ", (u_int32_t)cc->sg[i].address, cc->sg[i].length);
3186	    if ((((i + 1) % 4) == 0) || (i == (cc->header.sg_in_list - 1)))
3187		printf("\n");
3188	}
3189    }
3190}
3191
3192/************************************************************************
3193 * Print information about the status of a logical drive.
3194 */
3195static void
3196ciss_print_ldrive(struct ciss_softc *sc, struct ciss_ldrive *ld)
3197{
3198    int		bus, target, i;
3199
3200    if (ld->cl_lstatus == NULL) {
3201	printf("does not exist\n");
3202	return;
3203    }
3204
3205    /* print drive status */
3206    switch(ld->cl_lstatus->status) {
3207    case CISS_LSTATUS_OK:
3208	printf("online\n");
3209	break;
3210    case CISS_LSTATUS_INTERIM_RECOVERY:
3211	printf("in interim recovery mode\n");
3212	break;
3213    case CISS_LSTATUS_READY_RECOVERY:
3214	printf("ready to begin recovery\n");
3215	break;
3216    case CISS_LSTATUS_RECOVERING:
3217	bus = CISS_BIG_MAP_BUS(sc, ld->cl_lstatus->drive_rebuilding);
3218	target = CISS_BIG_MAP_BUS(sc, ld->cl_lstatus->drive_rebuilding);
3219	printf("being recovered, working on physical drive %d.%d, %u blocks remaining\n",
3220	       bus, target, ld->cl_lstatus->blocks_to_recover);
3221	break;
3222    case CISS_LSTATUS_EXPANDING:
3223	printf("being expanded, %u blocks remaining\n",
3224	       ld->cl_lstatus->blocks_to_recover);
3225	break;
3226    case CISS_LSTATUS_QUEUED_FOR_EXPANSION:
3227	printf("queued for expansion\n");
3228	break;
3229    case CISS_LSTATUS_FAILED:
3230	printf("queued for expansion\n");
3231	break;
3232    case CISS_LSTATUS_WRONG_PDRIVE:
3233	printf("wrong physical drive inserted\n");
3234	break;
3235    case CISS_LSTATUS_MISSING_PDRIVE:
3236	printf("missing a needed physical drive\n");
3237	break;
3238    case CISS_LSTATUS_BECOMING_READY:
3239	printf("becoming ready\n");
3240	break;
3241    }
3242
3243    /* print failed physical drives */
3244    for (i = 0; i < CISS_BIG_MAP_ENTRIES / 8; i++) {
3245	bus = CISS_BIG_MAP_BUS(sc, ld->cl_lstatus->drive_failure_map[i]);
3246	target = CISS_BIG_MAP_TARGET(sc, ld->cl_lstatus->drive_failure_map[i]);
3247	if (bus == -1)
3248	    continue;
3249	ciss_printf(sc, "physical drive %d:%d (%x) failed\n", bus, target,
3250		    ld->cl_lstatus->drive_failure_map[i]);
3251    }
3252}
3253
3254#ifdef CISS_DEBUG
3255/************************************************************************
3256 * Print information about the controller/driver.
3257 */
3258static void
3259ciss_print_adapter(struct ciss_softc *sc)
3260{
3261    int		i;
3262
3263    ciss_printf(sc, "ADAPTER:\n");
3264    for (i = 0; i < CISSQ_COUNT; i++) {
3265	ciss_printf(sc, "%s     %d/%d\n",
3266	    i == 0 ? "free" :
3267	    i == 1 ? "busy" : "complete",
3268	    sc->ciss_qstat[i].q_length,
3269	    sc->ciss_qstat[i].q_max);
3270    }
3271    ciss_printf(sc, "max_requests %d\n", sc->ciss_max_requests);
3272    ciss_printf(sc, "notify_head/tail %d/%d\n",
3273	sc->ciss_notify_head, sc->ciss_notify_tail);
3274    ciss_printf(sc, "flags %b\n", sc->ciss_flags,
3275	"\20\1notify_ok\2control_open\3aborting\4running\21fake_synch\22bmic_abort\n");
3276
3277    for (i = 0; i < CISS_MAX_LOGICAL; i++) {
3278	ciss_printf(sc, "LOGICAL DRIVE %d:  ", i);
3279	ciss_print_ldrive(sc, sc->ciss_logical + i);
3280    }
3281
3282    for (i = 1; i < sc->ciss_max_requests; i++)
3283	ciss_print_request(sc->ciss_request + i);
3284}
3285
3286/* DDB hook */
3287static void
3288ciss_print0(void)
3289{
3290    struct ciss_softc	*sc;
3291
3292    sc = devclass_get_softc(devclass_find("ciss"), 0);
3293    if (sc == NULL) {
3294	printf("no ciss controllers\n");
3295    } else {
3296	ciss_print_adapter(sc);
3297    }
3298}
3299#endif
3300
3301/************************************************************************
3302 * Return a name for a logical drive status value.
3303 */
3304static const char *
3305ciss_name_ldrive_status(int status)
3306{
3307    switch (status) {
3308    case CISS_LSTATUS_OK:
3309	return("OK");
3310    case CISS_LSTATUS_FAILED:
3311	return("failed");
3312    case CISS_LSTATUS_NOT_CONFIGURED:
3313	return("not configured");
3314    case CISS_LSTATUS_INTERIM_RECOVERY:
3315	return("interim recovery");
3316    case CISS_LSTATUS_READY_RECOVERY:
3317	return("ready for recovery");
3318    case CISS_LSTATUS_RECOVERING:
3319	return("recovering");
3320    case CISS_LSTATUS_WRONG_PDRIVE:
3321	return("wrong physical drive inserted");
3322    case CISS_LSTATUS_MISSING_PDRIVE:
3323	return("missing physical drive");
3324    case CISS_LSTATUS_EXPANDING:
3325	return("expanding");
3326    case CISS_LSTATUS_BECOMING_READY:
3327	return("becoming ready");
3328    case CISS_LSTATUS_QUEUED_FOR_EXPANSION:
3329	return("queued for expansion");
3330    }
3331    return("unknown status");
3332}
3333
3334/************************************************************************
3335 * Return an online/offline/nonexistent value for a logical drive
3336 * status value.
3337 */
3338static int
3339ciss_decode_ldrive_status(int status)
3340{
3341    switch(status) {
3342    case CISS_LSTATUS_NOT_CONFIGURED:
3343	return(CISS_LD_NONEXISTENT);
3344
3345    case CISS_LSTATUS_OK:
3346    case CISS_LSTATUS_INTERIM_RECOVERY:
3347    case CISS_LSTATUS_READY_RECOVERY:
3348    case CISS_LSTATUS_RECOVERING:
3349    case CISS_LSTATUS_EXPANDING:
3350    case CISS_LSTATUS_QUEUED_FOR_EXPANSION:
3351	return(CISS_LD_ONLINE);
3352
3353    case CISS_LSTATUS_FAILED:
3354    case CISS_LSTATUS_WRONG_PDRIVE:
3355    case CISS_LSTATUS_MISSING_PDRIVE:
3356    case CISS_LSTATUS_BECOMING_READY:
3357    default:
3358	return(CISS_LD_OFFLINE);
3359    }
3360}
3361
3362
3363/************************************************************************
3364 * Return a name for a logical drive's organisation.
3365 */
3366static const char *
3367ciss_name_ldrive_org(int org)
3368{
3369    switch(org) {
3370    case CISS_LDRIVE_RAID0:
3371	return("RAID 0");
3372    case CISS_LDRIVE_RAID1:
3373	return("RAID 1");
3374    case CISS_LDRIVE_RAID4:
3375	return("RAID 4");
3376    case CISS_LDRIVE_RAID5:
3377	return("RAID 5");
3378    case CISS_LDRIVE_RAID51:
3379	return("RAID 5+1");
3380    case CISS_LDRIVE_RAIDADG:
3381	return("RAID ADG");
3382    }
3383    return("unkown");
3384}
3385
3386/************************************************************************
3387 * Return a name for a command status value.
3388 */
3389static const char *
3390ciss_name_command_status(int status)
3391{
3392    switch(status) {
3393    case CISS_CMD_STATUS_SUCCESS:
3394	return("success");
3395    case CISS_CMD_STATUS_TARGET_STATUS:
3396	return("target status");
3397    case CISS_CMD_STATUS_DATA_UNDERRUN:
3398	return("data underrun");
3399    case CISS_CMD_STATUS_DATA_OVERRUN:
3400	return("data overrun");
3401    case CISS_CMD_STATUS_INVALID_COMMAND:
3402	return("invalid command");
3403    case CISS_CMD_STATUS_PROTOCOL_ERROR:
3404	return("protocol error");
3405    case CISS_CMD_STATUS_HARDWARE_ERROR:
3406	return("hardware error");
3407    case CISS_CMD_STATUS_CONNECTION_LOST:
3408	return("connection lost");
3409    case CISS_CMD_STATUS_ABORTED:
3410	return("aborted");
3411    case CISS_CMD_STATUS_ABORT_FAILED:
3412	return("abort failed");
3413    case CISS_CMD_STATUS_UNSOLICITED_ABORT:
3414	return("unsolicited abort");
3415    case CISS_CMD_STATUS_TIMEOUT:
3416	return("timeout");
3417    case CISS_CMD_STATUS_UNABORTABLE:
3418	return("unabortable");
3419    }
3420    return("unknown status");
3421}
3422
3423/************************************************************************
3424 * Handle an open on the control device.
3425 */
3426static int
3427ciss_open(dev_t dev, int flags, int fmt, d_thread_t *p)
3428{
3429    struct ciss_softc	*sc;
3430
3431    debug_called(1);
3432
3433    sc = (struct ciss_softc *)dev->si_drv1;
3434
3435    /* we might want to veto if someone already has us open */
3436
3437    sc->ciss_flags |= CISS_FLAG_CONTROL_OPEN;
3438    return(0);
3439}
3440
3441/************************************************************************
3442 * Handle the last close on the control device.
3443 */
3444static int
3445ciss_close(dev_t dev, int flags, int fmt, d_thread_t *p)
3446{
3447    struct ciss_softc	*sc;
3448
3449    debug_called(1);
3450
3451    sc = (struct ciss_softc *)dev->si_drv1;
3452
3453    sc->ciss_flags &= ~CISS_FLAG_CONTROL_OPEN;
3454    return (0);
3455}
3456
3457/********************************************************************************
3458 * Handle adapter-specific control operations.
3459 *
3460 * Note that the API here is compatible with the Linux driver, in order to
3461 * simplify the porting of Compaq's userland tools.
3462 */
3463static int
3464ciss_ioctl(dev_t dev, u_long cmd, caddr_t addr, int32_t flag, d_thread_t *p)
3465{
3466    struct ciss_softc		*sc;
3467    int				error;
3468
3469    debug_called(1);
3470
3471    sc = (struct ciss_softc *)dev->si_drv1;
3472    error = 0;
3473
3474    switch(cmd) {
3475    case CCISS_GETPCIINFO:
3476    {
3477	cciss_pci_info_struct	*pis = (cciss_pci_info_struct *)addr;
3478
3479	pis->bus = pci_get_bus(sc->ciss_dev);
3480	pis->dev_fn = pci_get_slot(sc->ciss_dev);
3481	pis->board_id = pci_get_devid(sc->ciss_dev);
3482
3483	break;
3484    }
3485
3486    case CCISS_GETINTINFO:
3487    {
3488	cciss_coalint_struct	*cis = (cciss_coalint_struct *)addr;
3489
3490	cis->delay = sc->ciss_cfg->interrupt_coalesce_delay;
3491	cis->count = sc->ciss_cfg->interrupt_coalesce_count;
3492
3493	break;
3494    }
3495
3496    case CCISS_SETINTINFO:
3497    {
3498	cciss_coalint_struct	*cis = (cciss_coalint_struct *)addr;
3499
3500	if ((cis->delay == 0) && (cis->count == 0)) {
3501	    error = EINVAL;
3502	    break;
3503	}
3504
3505	/*
3506	 * XXX apparently this is only safe if the controller is idle,
3507	 *     we should suspend it before doing this.
3508	 */
3509	sc->ciss_cfg->interrupt_coalesce_delay = cis->delay;
3510	sc->ciss_cfg->interrupt_coalesce_count = cis->count;
3511
3512	if (ciss_update_config(sc))
3513	    error = EIO;
3514
3515	/* XXX resume the controller here */
3516	break;
3517    }
3518
3519    case CCISS_GETNODENAME:
3520	bcopy(sc->ciss_cfg->server_name, (NodeName_type *)addr,
3521	      sizeof(NodeName_type));
3522	break;
3523
3524    case CCISS_SETNODENAME:
3525	bcopy((NodeName_type *)addr, sc->ciss_cfg->server_name,
3526	      sizeof(NodeName_type));
3527	if (ciss_update_config(sc))
3528	    error = EIO;
3529	break;
3530
3531    case CCISS_GETHEARTBEAT:
3532	*(Heartbeat_type *)addr = sc->ciss_cfg->heartbeat;
3533	break;
3534
3535    case CCISS_GETBUSTYPES:
3536	*(BusTypes_type *)addr = sc->ciss_cfg->bus_types;
3537	break;
3538
3539    case CCISS_GETFIRMVER:
3540	bcopy(sc->ciss_id->running_firmware_revision, (FirmwareVer_type *)addr,
3541	      sizeof(FirmwareVer_type));
3542	break;
3543
3544    case CCISS_GETDRIVERVER:
3545	*(DriverVer_type *)addr = CISS_DRIVER_VERSION;
3546	break;
3547
3548    case CCISS_REVALIDVOLS:
3549	/*
3550	 * This is a bit ugly; to do it "right" we really need
3551	 * to find any disks that have changed, kick CAM off them,
3552	 * then rescan only these disks.  It'd be nice if they
3553	 * a) told us which disk(s) they were going to play with,
3554	 * and b) which ones had arrived. 8(
3555	 */
3556	break;
3557
3558    case CCISS_PASSTHRU:
3559	error = ciss_user_command(sc, (IOCTL_Command_struct *)addr);
3560	break;
3561
3562    default:
3563	debug(0, "unknown ioctl 0x%lx", cmd);
3564
3565	debug(1, "CCISS_GETPCIINFO:   0x%lx", CCISS_GETPCIINFO);
3566	debug(1, "CCISS_GETINTINFO:   0x%lx", CCISS_GETINTINFO);
3567	debug(1, "CCISS_SETINTINFO:   0x%lx", CCISS_SETINTINFO);
3568	debug(1, "CCISS_GETNODENAME:  0x%lx", CCISS_GETNODENAME);
3569	debug(1, "CCISS_SETNODENAME:  0x%lx", CCISS_SETNODENAME);
3570	debug(1, "CCISS_GETHEARTBEAT: 0x%lx", CCISS_GETHEARTBEAT);
3571	debug(1, "CCISS_GETBUSTYPES:  0x%lx", CCISS_GETBUSTYPES);
3572	debug(1, "CCISS_GETFIRMVER:   0x%lx", CCISS_GETFIRMVER);
3573	debug(1, "CCISS_GETDRIVERVER: 0x%lx", CCISS_GETDRIVERVER);
3574	debug(1, "CCISS_REVALIDVOLS:  0x%lx", CCISS_REVALIDVOLS);
3575	debug(1, "CCISS_PASSTHRU:     0x%lx", CCISS_PASSTHRU);
3576
3577	error = ENOIOCTL;
3578	break;
3579    }
3580
3581    return(error);
3582}
3583