1/*-
2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3 *
4 * Copyright (c) 2001 Michael Smith
5 * Copyright (c) 2004 Paul Saab
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in the
15 *    documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 *	$FreeBSD$
30 */
31
32/*
33 * Common Interface for SCSI-3 Support driver.
34 *
35 * CISS claims to provide a common interface between a generic SCSI
36 * transport and an intelligent host adapter.
37 *
38 * This driver supports CISS as defined in the document "CISS Command
39 * Interface for SCSI-3 Support Open Specification", Version 1.04,
40 * Valence Number 1, dated 20001127, produced by Compaq Computer
41 * Corporation.  This document appears to be a hastily and somewhat
42 * arbitrarlily cut-down version of a larger (and probably even more
43 * chaotic and inconsistent) Compaq internal document.  Various
44 * details were also gleaned from Compaq's "cciss" driver for Linux.
45 *
46 * We provide a shim layer between the CISS interface and CAM,
47 * offloading most of the queueing and being-a-disk chores onto CAM.
48 * Entry to the driver is via the PCI bus attachment (ciss_probe,
49 * ciss_attach, etc) and via the CAM interface (ciss_cam_action,
50 * ciss_cam_poll).  The Compaq CISS adapters are, however, poor SCSI
51 * citizens and we have to fake up some responses to get reasonable
52 * behaviour out of them.  In addition, the CISS command set is by no
53 * means adequate to support the functionality of a RAID controller,
54 * and thus the supported Compaq adapters utilise portions of the
55 * control protocol from earlier Compaq adapter families.
56 *
57 * Note that we only support the "simple" transport layer over PCI.
58 * This interface (ab)uses the I2O register set (specifically the post
59 * queues) to exchange commands with the adapter.  Other interfaces
60 * are available, but we aren't supposed to know about them, and it is
61 * dubious whether they would provide major performance improvements
62 * except under extreme load.
63 *
64 * Currently the only supported CISS adapters are the Compaq Smart
65 * Array 5* series (5300, 5i, 532).  Even with only three adapters,
66 * Compaq still manage to have interface variations.
67 *
68 *
69 * Thanks must go to Fred Harris and Darryl DeVinney at Compaq, as
70 * well as Paul Saab at Yahoo! for their assistance in making this
71 * driver happen.
72 *
73 * More thanks must go to John Cagle at HP for the countless hours
74 * spent making this driver "work" with the MSA* series storage
75 * enclosures.  Without his help (and nagging), this driver could not
76 * be used with these enclosures.
77 */
78
79#include <sys/param.h>
80#include <sys/systm.h>
81#include <sys/malloc.h>
82#include <sys/kernel.h>
83#include <sys/bus.h>
84#include <sys/conf.h>
85#include <sys/stat.h>
86#include <sys/kthread.h>
87#include <sys/queue.h>
88#include <sys/sysctl.h>
89
90#include <cam/cam.h>
91#include <cam/cam_ccb.h>
92#include <cam/cam_periph.h>
93#include <cam/cam_sim.h>
94#include <cam/cam_xpt_sim.h>
95#include <cam/scsi/scsi_all.h>
96#include <cam/scsi/scsi_message.h>
97
98#include <machine/bus.h>
99#include <machine/endian.h>
100#include <machine/resource.h>
101#include <sys/rman.h>
102
103#include <dev/pci/pcireg.h>
104#include <dev/pci/pcivar.h>
105
106#include <dev/ciss/cissreg.h>
107#include <dev/ciss/cissio.h>
108#include <dev/ciss/cissvar.h>
109
110#ifdef CISS_DEBUG
111#include "opt_ddb.h"
112#endif
113
114static MALLOC_DEFINE(CISS_MALLOC_CLASS, "ciss_data",
115    "ciss internal data buffers");
116
117/* pci interface */
118static int	ciss_lookup(device_t dev);
119static int	ciss_probe(device_t dev);
120static int	ciss_attach(device_t dev);
121static int	ciss_detach(device_t dev);
122static int	ciss_shutdown(device_t dev);
123
124/* (de)initialisation functions, control wrappers */
125static int	ciss_init_pci(struct ciss_softc *sc);
126static int	ciss_setup_msix(struct ciss_softc *sc);
127static int	ciss_init_perf(struct ciss_softc *sc);
128static int	ciss_wait_adapter(struct ciss_softc *sc);
129static int	ciss_flush_adapter(struct ciss_softc *sc);
130static int	ciss_init_requests(struct ciss_softc *sc);
131static void	ciss_command_map_helper(void *arg, bus_dma_segment_t *segs,
132					int nseg, int error);
133static int	ciss_identify_adapter(struct ciss_softc *sc);
134static int	ciss_init_logical(struct ciss_softc *sc);
135static int	ciss_init_physical(struct ciss_softc *sc);
136static int	ciss_filter_physical(struct ciss_softc *sc, struct ciss_lun_report *cll);
137static int	ciss_identify_logical(struct ciss_softc *sc, struct ciss_ldrive *ld);
138static int	ciss_get_ldrive_status(struct ciss_softc *sc,  struct ciss_ldrive *ld);
139static int	ciss_update_config(struct ciss_softc *sc);
140static int	ciss_accept_media(struct ciss_softc *sc, struct ciss_ldrive *ld);
141static void	ciss_init_sysctl(struct ciss_softc *sc);
142static void	ciss_soft_reset(struct ciss_softc *sc);
143static void	ciss_free(struct ciss_softc *sc);
144static void	ciss_spawn_notify_thread(struct ciss_softc *sc);
145static void	ciss_kill_notify_thread(struct ciss_softc *sc);
146
147/* request submission/completion */
148static int	ciss_start(struct ciss_request *cr);
149static void	ciss_done(struct ciss_softc *sc, cr_qhead_t *qh);
150static void	ciss_perf_done(struct ciss_softc *sc, cr_qhead_t *qh);
151static void	ciss_intr(void *arg);
152static void	ciss_perf_intr(void *arg);
153static void	ciss_perf_msi_intr(void *arg);
154static void	ciss_complete(struct ciss_softc *sc, cr_qhead_t *qh);
155static int	_ciss_report_request(struct ciss_request *cr, int *command_status, int *scsi_status, const char *func);
156static int	ciss_synch_request(struct ciss_request *cr, int timeout);
157static int	ciss_poll_request(struct ciss_request *cr, int timeout);
158static int	ciss_wait_request(struct ciss_request *cr, int timeout);
159#if 0
160static int	ciss_abort_request(struct ciss_request *cr);
161#endif
162
163/* request queueing */
164static int	ciss_get_request(struct ciss_softc *sc, struct ciss_request **crp);
165static void	ciss_preen_command(struct ciss_request *cr);
166static void 	ciss_release_request(struct ciss_request *cr);
167
168/* request helpers */
169static int	ciss_get_bmic_request(struct ciss_softc *sc, struct ciss_request **crp,
170				      int opcode, void **bufp, size_t bufsize);
171static int	ciss_user_command(struct ciss_softc *sc, IOCTL_Command_struct *ioc);
172
173/* DMA map/unmap */
174static int	ciss_map_request(struct ciss_request *cr);
175static void	ciss_request_map_helper(void *arg, bus_dma_segment_t *segs,
176					int nseg, int error);
177static void	ciss_unmap_request(struct ciss_request *cr);
178
179/* CAM interface */
180static int	ciss_cam_init(struct ciss_softc *sc);
181static void	ciss_cam_rescan_target(struct ciss_softc *sc,
182				       int bus, int target);
183static void	ciss_cam_action(struct cam_sim *sim, union ccb *ccb);
184static int	ciss_cam_action_io(struct cam_sim *sim, struct ccb_scsiio *csio);
185static int	ciss_cam_emulate(struct ciss_softc *sc, struct ccb_scsiio *csio);
186static void	ciss_cam_poll(struct cam_sim *sim);
187static void	ciss_cam_complete(struct ciss_request *cr);
188static void	ciss_cam_complete_fixup(struct ciss_softc *sc, struct ccb_scsiio *csio);
189static int	ciss_name_device(struct ciss_softc *sc, int bus, int target);
190
191/* periodic status monitoring */
192static void	ciss_periodic(void *arg);
193static void	ciss_nop_complete(struct ciss_request *cr);
194static void	ciss_disable_adapter(struct ciss_softc *sc);
195static void	ciss_notify_event(struct ciss_softc *sc);
196static void	ciss_notify_complete(struct ciss_request *cr);
197static int	ciss_notify_abort(struct ciss_softc *sc);
198static int	ciss_notify_abort_bmic(struct ciss_softc *sc);
199static void	ciss_notify_hotplug(struct ciss_softc *sc, struct ciss_notify *cn);
200static void	ciss_notify_logical(struct ciss_softc *sc, struct ciss_notify *cn);
201static void	ciss_notify_physical(struct ciss_softc *sc, struct ciss_notify *cn);
202
203/* debugging output */
204#ifdef DDB
205static void	ciss_print_request(struct ciss_request *cr);
206#endif
207static void	ciss_print_ldrive(struct ciss_softc *sc, struct ciss_ldrive *ld);
208static const char *ciss_name_ldrive_status(int status);
209static int	ciss_decode_ldrive_status(int status);
210static const char *ciss_name_ldrive_org(int org);
211static const char *ciss_name_command_status(int status);
212
213/*
214 * PCI bus interface.
215 */
216static device_method_t ciss_methods[] = {
217    /* Device interface */
218    DEVMETHOD(device_probe,	ciss_probe),
219    DEVMETHOD(device_attach,	ciss_attach),
220    DEVMETHOD(device_detach,	ciss_detach),
221    DEVMETHOD(device_shutdown,	ciss_shutdown),
222    { 0, 0 }
223};
224
225static driver_t ciss_pci_driver = {
226    "ciss",
227    ciss_methods,
228    sizeof(struct ciss_softc)
229};
230
231/*
232 * Control device interface.
233 */
234static d_open_t		ciss_open;
235static d_close_t	ciss_close;
236static d_ioctl_t	ciss_ioctl;
237
238static struct cdevsw ciss_cdevsw = {
239	.d_version =	D_VERSION,
240	.d_flags =	0,
241	.d_open =	ciss_open,
242	.d_close =	ciss_close,
243	.d_ioctl =	ciss_ioctl,
244	.d_name =	"ciss",
245};
246
247/*
248 * This tunable can be set at boot time and controls whether physical devices
249 * that are marked hidden by the firmware should be exposed anyways.
250 */
251static unsigned int ciss_expose_hidden_physical = 0;
252TUNABLE_INT("hw.ciss.expose_hidden_physical", &ciss_expose_hidden_physical);
253
254static unsigned int ciss_nop_message_heartbeat = 0;
255TUNABLE_INT("hw.ciss.nop_message_heartbeat", &ciss_nop_message_heartbeat);
256
257/*
258 * This tunable can force a particular transport to be used:
259 * <= 0 : use default
260 *    1 : force simple
261 *    2 : force performant
262 */
263static int ciss_force_transport = 0;
264TUNABLE_INT("hw.ciss.force_transport", &ciss_force_transport);
265
266/*
267 * This tunable can force a particular interrupt delivery method to be used:
268 * <= 0 : use default
269 *    1 : force INTx
270 *    2 : force MSIX
271 */
272static int ciss_force_interrupt = 0;
273TUNABLE_INT("hw.ciss.force_interrupt", &ciss_force_interrupt);
274
275/************************************************************************
276 * CISS adapters amazingly don't have a defined programming interface
277 * value.  (One could say some very despairing things about PCI and
278 * people just not getting the general idea.)  So we are forced to
279 * stick with matching against subvendor/subdevice, and thus have to
280 * be updated for every new CISS adapter that appears.
281 */
282#define CISS_BOARD_UNKNWON	0
283#define CISS_BOARD_SA5		1
284#define CISS_BOARD_SA5B		2
285#define CISS_BOARD_NOMSI	(1<<4)
286#define CISS_BOARD_SIMPLE       (1<<5)
287
288static struct
289{
290    u_int16_t	subvendor;
291    u_int16_t	subdevice;
292    int		flags;
293    char	*desc;
294} ciss_vendor_data[] = {
295    { 0x0e11, 0x4070, CISS_BOARD_SA5|CISS_BOARD_NOMSI|CISS_BOARD_SIMPLE,
296                                                        "Compaq Smart Array 5300" },
297    { 0x0e11, 0x4080, CISS_BOARD_SA5B|CISS_BOARD_NOMSI,	"Compaq Smart Array 5i" },
298    { 0x0e11, 0x4082, CISS_BOARD_SA5B|CISS_BOARD_NOMSI,	"Compaq Smart Array 532" },
299    { 0x0e11, 0x4083, CISS_BOARD_SA5B|CISS_BOARD_NOMSI,	"HP Smart Array 5312" },
300    { 0x0e11, 0x4091, CISS_BOARD_SA5,	"HP Smart Array 6i" },
301    { 0x0e11, 0x409A, CISS_BOARD_SA5,	"HP Smart Array 641" },
302    { 0x0e11, 0x409B, CISS_BOARD_SA5,	"HP Smart Array 642" },
303    { 0x0e11, 0x409C, CISS_BOARD_SA5,	"HP Smart Array 6400" },
304    { 0x0e11, 0x409D, CISS_BOARD_SA5,	"HP Smart Array 6400 EM" },
305    { 0x103C, 0x3211, CISS_BOARD_SA5,	"HP Smart Array E200i" },
306    { 0x103C, 0x3212, CISS_BOARD_SA5,	"HP Smart Array E200" },
307    { 0x103C, 0x3213, CISS_BOARD_SA5,	"HP Smart Array E200i" },
308    { 0x103C, 0x3214, CISS_BOARD_SA5,	"HP Smart Array E200i" },
309    { 0x103C, 0x3215, CISS_BOARD_SA5,	"HP Smart Array E200i" },
310    { 0x103C, 0x3220, CISS_BOARD_SA5,	"HP Smart Array" },
311    { 0x103C, 0x3222, CISS_BOARD_SA5,	"HP Smart Array" },
312    { 0x103C, 0x3223, CISS_BOARD_SA5,	"HP Smart Array P800" },
313    { 0x103C, 0x3225, CISS_BOARD_SA5,	"HP Smart Array P600" },
314    { 0x103C, 0x3230, CISS_BOARD_SA5,	"HP Smart Array" },
315    { 0x103C, 0x3231, CISS_BOARD_SA5,	"HP Smart Array" },
316    { 0x103C, 0x3232, CISS_BOARD_SA5,	"HP Smart Array" },
317    { 0x103C, 0x3233, CISS_BOARD_SA5,	"HP Smart Array" },
318    { 0x103C, 0x3234, CISS_BOARD_SA5,	"HP Smart Array P400" },
319    { 0x103C, 0x3235, CISS_BOARD_SA5,	"HP Smart Array P400i" },
320    { 0x103C, 0x3236, CISS_BOARD_SA5,	"HP Smart Array" },
321    { 0x103C, 0x3237, CISS_BOARD_SA5,	"HP Smart Array E500" },
322    { 0x103C, 0x3238, CISS_BOARD_SA5,	"HP Smart Array" },
323    { 0x103C, 0x3239, CISS_BOARD_SA5,	"HP Smart Array" },
324    { 0x103C, 0x323A, CISS_BOARD_SA5,	"HP Smart Array" },
325    { 0x103C, 0x323B, CISS_BOARD_SA5,	"HP Smart Array" },
326    { 0x103C, 0x323C, CISS_BOARD_SA5,	"HP Smart Array" },
327    { 0x103C, 0x323D, CISS_BOARD_SA5,	"HP Smart Array P700m" },
328    { 0x103C, 0x3241, CISS_BOARD_SA5,	"HP Smart Array P212" },
329    { 0x103C, 0x3243, CISS_BOARD_SA5,	"HP Smart Array P410" },
330    { 0x103C, 0x3245, CISS_BOARD_SA5,	"HP Smart Array P410i" },
331    { 0x103C, 0x3247, CISS_BOARD_SA5,	"HP Smart Array P411" },
332    { 0x103C, 0x3249, CISS_BOARD_SA5,	"HP Smart Array P812" },
333    { 0x103C, 0x324A, CISS_BOARD_SA5,	"HP Smart Array P712m" },
334    { 0x103C, 0x324B, CISS_BOARD_SA5,	"HP Smart Array" },
335    { 0x103C, 0x3350, CISS_BOARD_SA5,   "HP Smart Array P222" },
336    { 0x103C, 0x3351, CISS_BOARD_SA5,   "HP Smart Array P420" },
337    { 0x103C, 0x3352, CISS_BOARD_SA5,   "HP Smart Array P421" },
338    { 0x103C, 0x3353, CISS_BOARD_SA5,   "HP Smart Array P822" },
339    { 0x103C, 0x3354, CISS_BOARD_SA5,   "HP Smart Array P420i" },
340    { 0x103C, 0x3355, CISS_BOARD_SA5,   "HP Smart Array P220i" },
341    { 0x103C, 0x3356, CISS_BOARD_SA5,   "HP Smart Array P721m" },
342    { 0x103C, 0x1920, CISS_BOARD_SA5,   "HP Smart Array P430i" },
343    { 0x103C, 0x1921, CISS_BOARD_SA5,   "HP Smart Array P830i" },
344    { 0x103C, 0x1922, CISS_BOARD_SA5,   "HP Smart Array P430" },
345    { 0x103C, 0x1923, CISS_BOARD_SA5,   "HP Smart Array P431" },
346    { 0x103C, 0x1924, CISS_BOARD_SA5,   "HP Smart Array P830" },
347    { 0x103C, 0x1926, CISS_BOARD_SA5,   "HP Smart Array P731m" },
348    { 0x103C, 0x1928, CISS_BOARD_SA5,   "HP Smart Array P230i" },
349    { 0x103C, 0x1929, CISS_BOARD_SA5,   "HP Smart Array P530" },
350    { 0x103C, 0x192A, CISS_BOARD_SA5,   "HP Smart Array P531" },
351    { 0x103C, 0x21BD, CISS_BOARD_SA5,   "HP Smart Array P244br" },
352    { 0x103C, 0x21BE, CISS_BOARD_SA5,   "HP Smart Array P741m" },
353    { 0x103C, 0x21BF, CISS_BOARD_SA5,   "HP Smart Array H240ar" },
354    { 0x103C, 0x21C0, CISS_BOARD_SA5,   "HP Smart Array P440ar" },
355    { 0x103C, 0x21C1, CISS_BOARD_SA5,   "HP Smart Array P840ar" },
356    { 0x103C, 0x21C2, CISS_BOARD_SA5,   "HP Smart Array P440" },
357    { 0x103C, 0x21C3, CISS_BOARD_SA5,   "HP Smart Array P441" },
358    { 0x103C, 0x21C5, CISS_BOARD_SA5,   "HP Smart Array P841" },
359    { 0x103C, 0x21C6, CISS_BOARD_SA5,   "HP Smart Array H244br" },
360    { 0x103C, 0x21C7, CISS_BOARD_SA5,   "HP Smart Array H240" },
361    { 0x103C, 0x21C8, CISS_BOARD_SA5,   "HP Smart Array H241" },
362    { 0x103C, 0x21CA, CISS_BOARD_SA5,   "HP Smart Array P246br" },
363    { 0x103C, 0x21CB, CISS_BOARD_SA5,   "HP Smart Array P840" },
364    { 0x103C, 0x21CC, CISS_BOARD_SA5,   "HP Smart Array P542d" },
365    { 0x103C, 0x21CD, CISS_BOARD_SA5,   "HP Smart Array P240nr" },
366    { 0x103C, 0x21CE, CISS_BOARD_SA5,   "HP Smart Array H240nr" },
367    { 0, 0, 0, NULL }
368};
369
370static devclass_t	ciss_devclass;
371DRIVER_MODULE(ciss, pci, ciss_pci_driver, ciss_devclass, 0, 0);
372MODULE_PNP_INFO("U16:vendor;U16:device;", pci, ciss, ciss_vendor_data,
373    nitems(ciss_vendor_data) - 1);
374MODULE_DEPEND(ciss, cam, 1, 1, 1);
375MODULE_DEPEND(ciss, pci, 1, 1, 1);
376
377/************************************************************************
378 * Find a match for the device in our list of known adapters.
379 */
380static int
381ciss_lookup(device_t dev)
382{
383    int 	i;
384
385    for (i = 0; ciss_vendor_data[i].desc != NULL; i++)
386	if ((pci_get_subvendor(dev) == ciss_vendor_data[i].subvendor) &&
387	    (pci_get_subdevice(dev) == ciss_vendor_data[i].subdevice)) {
388	    return(i);
389	}
390    return(-1);
391}
392
393/************************************************************************
394 * Match a known CISS adapter.
395 */
396static int
397ciss_probe(device_t dev)
398{
399    int		i;
400
401    i = ciss_lookup(dev);
402    if (i != -1) {
403	device_set_desc(dev, ciss_vendor_data[i].desc);
404	return(BUS_PROBE_DEFAULT);
405    }
406    return(ENOENT);
407}
408
409/************************************************************************
410 * Attach the driver to this adapter.
411 */
412static int
413ciss_attach(device_t dev)
414{
415    struct ciss_softc	*sc;
416    int			error;
417
418    debug_called(1);
419
420#ifdef CISS_DEBUG
421    /* print structure/union sizes */
422    debug_struct(ciss_command);
423    debug_struct(ciss_header);
424    debug_union(ciss_device_address);
425    debug_struct(ciss_cdb);
426    debug_struct(ciss_report_cdb);
427    debug_struct(ciss_notify_cdb);
428    debug_struct(ciss_notify);
429    debug_struct(ciss_message_cdb);
430    debug_struct(ciss_error_info_pointer);
431    debug_struct(ciss_error_info);
432    debug_struct(ciss_sg_entry);
433    debug_struct(ciss_config_table);
434    debug_struct(ciss_bmic_cdb);
435    debug_struct(ciss_bmic_id_ldrive);
436    debug_struct(ciss_bmic_id_lstatus);
437    debug_struct(ciss_bmic_id_table);
438    debug_struct(ciss_bmic_id_pdrive);
439    debug_struct(ciss_bmic_blink_pdrive);
440    debug_struct(ciss_bmic_flush_cache);
441    debug_const(CISS_MAX_REQUESTS);
442    debug_const(CISS_MAX_LOGICAL);
443    debug_const(CISS_INTERRUPT_COALESCE_DELAY);
444    debug_const(CISS_INTERRUPT_COALESCE_COUNT);
445    debug_const(CISS_COMMAND_ALLOC_SIZE);
446    debug_const(CISS_COMMAND_SG_LENGTH);
447
448    debug_type(cciss_pci_info_struct);
449    debug_type(cciss_coalint_struct);
450    debug_type(cciss_coalint_struct);
451    debug_type(NodeName_type);
452    debug_type(NodeName_type);
453    debug_type(Heartbeat_type);
454    debug_type(BusTypes_type);
455    debug_type(FirmwareVer_type);
456    debug_type(DriverVer_type);
457    debug_type(IOCTL_Command_struct);
458#endif
459
460    sc = device_get_softc(dev);
461    sc->ciss_dev = dev;
462    mtx_init(&sc->ciss_mtx, "cissmtx", NULL, MTX_DEF);
463    callout_init_mtx(&sc->ciss_periodic, &sc->ciss_mtx, 0);
464
465    /*
466     * Do PCI-specific init.
467     */
468    if ((error = ciss_init_pci(sc)) != 0)
469	goto out;
470
471    /*
472     * Initialise driver queues.
473     */
474    ciss_initq_free(sc);
475    ciss_initq_notify(sc);
476
477    /*
478     * Initialize device sysctls.
479     */
480    ciss_init_sysctl(sc);
481
482    /*
483     * Initialise command/request pool.
484     */
485    if ((error = ciss_init_requests(sc)) != 0)
486	goto out;
487
488    /*
489     * Get adapter information.
490     */
491    if ((error = ciss_identify_adapter(sc)) != 0)
492	goto out;
493
494    /*
495     * Find all the physical devices.
496     */
497    if ((error = ciss_init_physical(sc)) != 0)
498	goto out;
499
500    /*
501     * Build our private table of logical devices.
502     */
503    if ((error = ciss_init_logical(sc)) != 0)
504	goto out;
505
506    /*
507     * Enable interrupts so that the CAM scan can complete.
508     */
509    CISS_TL_SIMPLE_ENABLE_INTERRUPTS(sc);
510
511    /*
512     * Initialise the CAM interface.
513     */
514    if ((error = ciss_cam_init(sc)) != 0)
515	goto out;
516
517    /*
518     * Start the heartbeat routine and event chain.
519     */
520    ciss_periodic(sc);
521
522   /*
523     * Create the control device.
524     */
525    sc->ciss_dev_t = make_dev(&ciss_cdevsw, device_get_unit(sc->ciss_dev),
526			      UID_ROOT, GID_OPERATOR, S_IRUSR | S_IWUSR,
527			      "ciss%d", device_get_unit(sc->ciss_dev));
528    sc->ciss_dev_t->si_drv1 = sc;
529
530    /*
531     * The adapter is running; synchronous commands can now sleep
532     * waiting for an interrupt to signal completion.
533     */
534    sc->ciss_flags |= CISS_FLAG_RUNNING;
535
536    ciss_spawn_notify_thread(sc);
537
538    error = 0;
539 out:
540    if (error != 0) {
541	/* ciss_free() expects the mutex to be held */
542	mtx_lock(&sc->ciss_mtx);
543	ciss_free(sc);
544    }
545    return(error);
546}
547
548/************************************************************************
549 * Detach the driver from this adapter.
550 */
551static int
552ciss_detach(device_t dev)
553{
554    struct ciss_softc	*sc = device_get_softc(dev);
555
556    debug_called(1);
557
558    mtx_lock(&sc->ciss_mtx);
559    if (sc->ciss_flags & CISS_FLAG_CONTROL_OPEN) {
560	mtx_unlock(&sc->ciss_mtx);
561	return (EBUSY);
562    }
563
564    /* flush adapter cache */
565    ciss_flush_adapter(sc);
566
567    /* release all resources.  The mutex is released and freed here too. */
568    ciss_free(sc);
569
570    return(0);
571}
572
573/************************************************************************
574 * Prepare adapter for system shutdown.
575 */
576static int
577ciss_shutdown(device_t dev)
578{
579    struct ciss_softc	*sc = device_get_softc(dev);
580
581    debug_called(1);
582
583    mtx_lock(&sc->ciss_mtx);
584    /* flush adapter cache */
585    ciss_flush_adapter(sc);
586
587    if (sc->ciss_soft_reset)
588	ciss_soft_reset(sc);
589    mtx_unlock(&sc->ciss_mtx);
590
591    return(0);
592}
593
594static void
595ciss_init_sysctl(struct ciss_softc *sc)
596{
597
598    SYSCTL_ADD_INT(device_get_sysctl_ctx(sc->ciss_dev),
599	SYSCTL_CHILDREN(device_get_sysctl_tree(sc->ciss_dev)),
600	OID_AUTO, "soft_reset", CTLFLAG_RW, &sc->ciss_soft_reset, 0, "");
601}
602
603/************************************************************************
604 * Perform PCI-specific attachment actions.
605 */
606static int
607ciss_init_pci(struct ciss_softc *sc)
608{
609    uintptr_t		cbase, csize, cofs;
610    uint32_t		method, supported_methods;
611    int			error, sqmask, i;
612    void		*intr;
613
614    debug_called(1);
615
616    /*
617     * Work out adapter type.
618     */
619    i = ciss_lookup(sc->ciss_dev);
620    if (i < 0) {
621	ciss_printf(sc, "unknown adapter type\n");
622	return (ENXIO);
623    }
624
625    if (ciss_vendor_data[i].flags & CISS_BOARD_SA5) {
626	sqmask = CISS_TL_SIMPLE_INTR_OPQ_SA5;
627    } else if (ciss_vendor_data[i].flags & CISS_BOARD_SA5B) {
628	sqmask = CISS_TL_SIMPLE_INTR_OPQ_SA5B;
629    } else {
630	/*
631	 * XXX Big hammer, masks/unmasks all possible interrupts.  This should
632	 * work on all hardware variants.  Need to add code to handle the
633	 * "controller crashed" interrupt bit that this unmasks.
634	 */
635	sqmask = ~0;
636    }
637
638    /*
639     * Allocate register window first (we need this to find the config
640     * struct).
641     */
642    error = ENXIO;
643    sc->ciss_regs_rid = CISS_TL_SIMPLE_BAR_REGS;
644    if ((sc->ciss_regs_resource =
645	 bus_alloc_resource_any(sc->ciss_dev, SYS_RES_MEMORY,
646				&sc->ciss_regs_rid, RF_ACTIVE)) == NULL) {
647	ciss_printf(sc, "can't allocate register window\n");
648	return(ENXIO);
649    }
650    sc->ciss_regs_bhandle = rman_get_bushandle(sc->ciss_regs_resource);
651    sc->ciss_regs_btag = rman_get_bustag(sc->ciss_regs_resource);
652
653    /*
654     * Find the BAR holding the config structure.  If it's not the one
655     * we already mapped for registers, map it too.
656     */
657    sc->ciss_cfg_rid = CISS_TL_SIMPLE_READ(sc, CISS_TL_SIMPLE_CFG_BAR) & 0xffff;
658    if (sc->ciss_cfg_rid != sc->ciss_regs_rid) {
659	if ((sc->ciss_cfg_resource =
660	     bus_alloc_resource_any(sc->ciss_dev, SYS_RES_MEMORY,
661				    &sc->ciss_cfg_rid, RF_ACTIVE)) == NULL) {
662	    ciss_printf(sc, "can't allocate config window\n");
663	    return(ENXIO);
664	}
665	cbase = (uintptr_t)rman_get_virtual(sc->ciss_cfg_resource);
666	csize = rman_get_end(sc->ciss_cfg_resource) -
667	    rman_get_start(sc->ciss_cfg_resource) + 1;
668    } else {
669	cbase = (uintptr_t)rman_get_virtual(sc->ciss_regs_resource);
670	csize = rman_get_end(sc->ciss_regs_resource) -
671	    rman_get_start(sc->ciss_regs_resource) + 1;
672    }
673    cofs = CISS_TL_SIMPLE_READ(sc, CISS_TL_SIMPLE_CFG_OFF);
674
675    /*
676     * Use the base/size/offset values we just calculated to
677     * sanity-check the config structure.  If it's OK, point to it.
678     */
679    if ((cofs + sizeof(struct ciss_config_table)) > csize) {
680	ciss_printf(sc, "config table outside window\n");
681	return(ENXIO);
682    }
683    sc->ciss_cfg = (struct ciss_config_table *)(cbase + cofs);
684    debug(1, "config struct at %p", sc->ciss_cfg);
685
686    /*
687     * Calculate the number of request structures/commands we are
688     * going to provide for this adapter.
689     */
690    sc->ciss_max_requests = min(CISS_MAX_REQUESTS, sc->ciss_cfg->max_outstanding_commands);
691
692    /*
693     * Validate the config structure.  If we supported other transport
694     * methods, we could select amongst them at this point in time.
695     */
696    if (strncmp(sc->ciss_cfg->signature, "CISS", 4)) {
697	ciss_printf(sc, "config signature mismatch (got '%c%c%c%c')\n",
698		    sc->ciss_cfg->signature[0], sc->ciss_cfg->signature[1],
699		    sc->ciss_cfg->signature[2], sc->ciss_cfg->signature[3]);
700	return(ENXIO);
701    }
702
703    /*
704     * Select the mode of operation, prefer Performant.
705     */
706    if (!(sc->ciss_cfg->supported_methods &
707	(CISS_TRANSPORT_METHOD_SIMPLE | CISS_TRANSPORT_METHOD_PERF))) {
708	ciss_printf(sc, "No supported transport layers: 0x%x\n",
709	    sc->ciss_cfg->supported_methods);
710    }
711
712    switch (ciss_force_transport) {
713    case 1:
714	supported_methods = CISS_TRANSPORT_METHOD_SIMPLE;
715	break;
716    case 2:
717	supported_methods = CISS_TRANSPORT_METHOD_PERF;
718	break;
719    default:
720        /*
721         * Override the capabilities of the BOARD and specify SIMPLE
722         * MODE
723         */
724        if (ciss_vendor_data[i].flags & CISS_BOARD_SIMPLE)
725                supported_methods = CISS_TRANSPORT_METHOD_SIMPLE;
726        else
727                supported_methods = sc->ciss_cfg->supported_methods;
728        break;
729    }
730
731setup:
732    if ((supported_methods & CISS_TRANSPORT_METHOD_PERF) != 0) {
733	method = CISS_TRANSPORT_METHOD_PERF;
734	sc->ciss_perf = (struct ciss_perf_config *)(cbase + cofs +
735	    sc->ciss_cfg->transport_offset);
736	if (ciss_init_perf(sc)) {
737	    supported_methods &= ~method;
738	    goto setup;
739	}
740    } else if (supported_methods & CISS_TRANSPORT_METHOD_SIMPLE) {
741	method = CISS_TRANSPORT_METHOD_SIMPLE;
742    } else {
743	ciss_printf(sc, "No supported transport methods: 0x%x\n",
744	    sc->ciss_cfg->supported_methods);
745	return(ENXIO);
746    }
747
748    /*
749     * Tell it we're using the low 4GB of RAM.  Set the default interrupt
750     * coalescing options.
751     */
752    sc->ciss_cfg->requested_method = method;
753    sc->ciss_cfg->command_physlimit = 0;
754    sc->ciss_cfg->interrupt_coalesce_delay = CISS_INTERRUPT_COALESCE_DELAY;
755    sc->ciss_cfg->interrupt_coalesce_count = CISS_INTERRUPT_COALESCE_COUNT;
756
757#ifdef __i386__
758    sc->ciss_cfg->host_driver |= CISS_DRIVER_SCSI_PREFETCH;
759#endif
760
761    if (ciss_update_config(sc)) {
762	ciss_printf(sc, "adapter refuses to accept config update (IDBR 0x%x)\n",
763		    CISS_TL_SIMPLE_READ(sc, CISS_TL_SIMPLE_IDBR));
764	return(ENXIO);
765    }
766    if ((sc->ciss_cfg->active_method & method) == 0) {
767	supported_methods &= ~method;
768	if (supported_methods == 0) {
769	    ciss_printf(sc, "adapter refuses to go into available transports "
770		"mode (0x%x, 0x%x)\n", supported_methods,
771		sc->ciss_cfg->active_method);
772	    return(ENXIO);
773	} else
774	    goto setup;
775    }
776
777    /*
778     * Wait for the adapter to come ready.
779     */
780    if ((error = ciss_wait_adapter(sc)) != 0)
781	return(error);
782
783    /* Prepare to possibly use MSIX and/or PERFORMANT interrupts.  Normal
784     * interrupts have a rid of 0, this will be overridden if MSIX is used.
785     */
786    sc->ciss_irq_rid[0] = 0;
787    if (method == CISS_TRANSPORT_METHOD_PERF) {
788	ciss_printf(sc, "PERFORMANT Transport\n");
789	if ((ciss_force_interrupt != 1) && (ciss_setup_msix(sc) == 0)) {
790	    intr = ciss_perf_msi_intr;
791	} else {
792	    intr = ciss_perf_intr;
793	}
794	/* XXX The docs say that the 0x01 bit is only for SAS controllers.
795	 * Unfortunately, there is no good way to know if this is a SAS
796	 * controller.  Hopefully enabling this bit universally will work OK.
797	 * It seems to work fine for SA6i controllers.
798	 */
799	sc->ciss_interrupt_mask = CISS_TL_PERF_INTR_OPQ | CISS_TL_PERF_INTR_MSI;
800
801    } else {
802	ciss_printf(sc, "SIMPLE Transport\n");
803	/* MSIX doesn't seem to work in SIMPLE mode, only enable if it forced */
804	if (ciss_force_interrupt == 2)
805	    /* If this fails, we automatically revert to INTx */
806	    ciss_setup_msix(sc);
807	sc->ciss_perf = NULL;
808	intr = ciss_intr;
809	sc->ciss_interrupt_mask = sqmask;
810    }
811
812    /*
813     * Turn off interrupts before we go routing anything.
814     */
815    CISS_TL_SIMPLE_DISABLE_INTERRUPTS(sc);
816
817    /*
818     * Allocate and set up our interrupt.
819     */
820    if ((sc->ciss_irq_resource =
821	 bus_alloc_resource_any(sc->ciss_dev, SYS_RES_IRQ, &sc->ciss_irq_rid[0],
822				RF_ACTIVE | RF_SHAREABLE)) == NULL) {
823	ciss_printf(sc, "can't allocate interrupt\n");
824	return(ENXIO);
825    }
826
827    if (bus_setup_intr(sc->ciss_dev, sc->ciss_irq_resource,
828		       INTR_TYPE_CAM|INTR_MPSAFE, NULL, intr, sc,
829		       &sc->ciss_intr)) {
830	ciss_printf(sc, "can't set up interrupt\n");
831	return(ENXIO);
832    }
833
834    /*
835     * Allocate the parent bus DMA tag appropriate for our PCI
836     * interface.
837     *
838     * Note that "simple" adapters can only address within a 32-bit
839     * span.
840     */
841    if (bus_dma_tag_create(bus_get_dma_tag(sc->ciss_dev),/* PCI parent */
842			   1, 0, 			/* alignment, boundary */
843			   BUS_SPACE_MAXADDR,		/* lowaddr */
844			   BUS_SPACE_MAXADDR, 		/* highaddr */
845			   NULL, NULL, 			/* filter, filterarg */
846			   BUS_SPACE_MAXSIZE_32BIT,	/* maxsize */
847			   BUS_SPACE_UNRESTRICTED,	/* nsegments */
848			   BUS_SPACE_MAXSIZE_32BIT,	/* maxsegsize */
849			   0,				/* flags */
850			   NULL, NULL,			/* lockfunc, lockarg */
851			   &sc->ciss_parent_dmat)) {
852	ciss_printf(sc, "can't allocate parent DMA tag\n");
853	return(ENOMEM);
854    }
855
856    /*
857     * Create DMA tag for mapping buffers into adapter-addressable
858     * space.
859     */
860    if (bus_dma_tag_create(sc->ciss_parent_dmat, 	/* parent */
861			   1, 0, 			/* alignment, boundary */
862			   BUS_SPACE_MAXADDR,		/* lowaddr */
863			   BUS_SPACE_MAXADDR, 		/* highaddr */
864			   NULL, NULL, 			/* filter, filterarg */
865			   (CISS_MAX_SG_ELEMENTS - 1) * PAGE_SIZE, /* maxsize */
866			   CISS_MAX_SG_ELEMENTS,	/* nsegments */
867			   BUS_SPACE_MAXSIZE_32BIT,	/* maxsegsize */
868			   BUS_DMA_ALLOCNOW,		/* flags */
869			   busdma_lock_mutex, &sc->ciss_mtx,	/* lockfunc, lockarg */
870			   &sc->ciss_buffer_dmat)) {
871	ciss_printf(sc, "can't allocate buffer DMA tag\n");
872	return(ENOMEM);
873    }
874    return(0);
875}
876
877/************************************************************************
878 * Setup MSI/MSIX operation (Performant only)
879 * Four interrupts are available, but we only use 1 right now.  If MSI-X
880 * isn't avaialble, try using MSI instead.
881 */
882static int
883ciss_setup_msix(struct ciss_softc *sc)
884{
885    int val, i;
886
887    /* Weed out devices that don't actually support MSI */
888    i = ciss_lookup(sc->ciss_dev);
889    if (ciss_vendor_data[i].flags & CISS_BOARD_NOMSI)
890	return (EINVAL);
891
892    /*
893     * Only need to use the minimum number of MSI vectors, as the driver
894     * doesn't support directed MSIX interrupts.
895     */
896    val = pci_msix_count(sc->ciss_dev);
897    if (val < CISS_MSI_COUNT) {
898	val = pci_msi_count(sc->ciss_dev);
899	device_printf(sc->ciss_dev, "got %d MSI messages]\n", val);
900	if (val < CISS_MSI_COUNT)
901	    return (EINVAL);
902    }
903    val = MIN(val, CISS_MSI_COUNT);
904    if (pci_alloc_msix(sc->ciss_dev, &val) != 0) {
905	if (pci_alloc_msi(sc->ciss_dev, &val) != 0)
906	    return (EINVAL);
907    }
908
909    sc->ciss_msi = val;
910    if (bootverbose)
911	ciss_printf(sc, "Using %d MSIX interrupt%s\n", val,
912	    (val != 1) ? "s" : "");
913
914    for (i = 0; i < val; i++)
915	sc->ciss_irq_rid[i] = i + 1;
916
917    return (0);
918
919}
920
921/************************************************************************
922 * Setup the Performant structures.
923 */
924static int
925ciss_init_perf(struct ciss_softc *sc)
926{
927    struct ciss_perf_config *pc = sc->ciss_perf;
928    int reply_size;
929
930    /*
931     * Create the DMA tag for the reply queue.
932     */
933    reply_size = sizeof(uint64_t) * sc->ciss_max_requests;
934    if (bus_dma_tag_create(sc->ciss_parent_dmat,	/* parent */
935			   1, 0, 			/* alignment, boundary */
936			   BUS_SPACE_MAXADDR_32BIT,	/* lowaddr */
937			   BUS_SPACE_MAXADDR, 		/* highaddr */
938			   NULL, NULL, 			/* filter, filterarg */
939			   reply_size, 1,		/* maxsize, nsegments */
940			   BUS_SPACE_MAXSIZE_32BIT,	/* maxsegsize */
941			   0,				/* flags */
942			   NULL, NULL,			/* lockfunc, lockarg */
943			   &sc->ciss_reply_dmat)) {
944	ciss_printf(sc, "can't allocate reply DMA tag\n");
945	return(ENOMEM);
946    }
947    /*
948     * Allocate memory and make it available for DMA.
949     */
950    if (bus_dmamem_alloc(sc->ciss_reply_dmat, (void **)&sc->ciss_reply,
951			 BUS_DMA_NOWAIT, &sc->ciss_reply_map)) {
952	ciss_printf(sc, "can't allocate reply memory\n");
953	return(ENOMEM);
954    }
955    bus_dmamap_load(sc->ciss_reply_dmat, sc->ciss_reply_map, sc->ciss_reply,
956		    reply_size, ciss_command_map_helper, &sc->ciss_reply_phys, 0);
957    bzero(sc->ciss_reply, reply_size);
958
959    sc->ciss_cycle = 0x1;
960    sc->ciss_rqidx = 0;
961
962    /*
963     * Preload the fetch table with common command sizes.  This allows the
964     * hardware to not waste bus cycles for typical i/o commands, but also not
965     * tax the driver to be too exact in choosing sizes.  The table is optimized
966     * for page-aligned i/o's, but since most i/o comes from the various pagers,
967     * it's a reasonable assumption to make.
968     */
969    pc->fetch_count[CISS_SG_FETCH_NONE] = (sizeof(struct ciss_command) + 15) / 16;
970    pc->fetch_count[CISS_SG_FETCH_1] =
971	(sizeof(struct ciss_command) + sizeof(struct ciss_sg_entry) * 1 + 15) / 16;
972    pc->fetch_count[CISS_SG_FETCH_2] =
973	(sizeof(struct ciss_command) + sizeof(struct ciss_sg_entry) * 2 + 15) / 16;
974    pc->fetch_count[CISS_SG_FETCH_4] =
975	(sizeof(struct ciss_command) + sizeof(struct ciss_sg_entry) * 4 + 15) / 16;
976    pc->fetch_count[CISS_SG_FETCH_8] =
977	(sizeof(struct ciss_command) + sizeof(struct ciss_sg_entry) * 8 + 15) / 16;
978    pc->fetch_count[CISS_SG_FETCH_16] =
979	(sizeof(struct ciss_command) + sizeof(struct ciss_sg_entry) * 16 + 15) / 16;
980    pc->fetch_count[CISS_SG_FETCH_32] =
981	(sizeof(struct ciss_command) + sizeof(struct ciss_sg_entry) * 32 + 15) / 16;
982    pc->fetch_count[CISS_SG_FETCH_MAX] = (CISS_COMMAND_ALLOC_SIZE + 15) / 16;
983
984    pc->rq_size = sc->ciss_max_requests; /* XXX less than the card supports? */
985    pc->rq_count = 1;	/* XXX Hardcode for a single queue */
986    pc->rq_bank_hi = 0;
987    pc->rq_bank_lo = 0;
988    pc->rq[0].rq_addr_hi = 0x0;
989    pc->rq[0].rq_addr_lo = sc->ciss_reply_phys;
990
991    return(0);
992}
993
994/************************************************************************
995 * Wait for the adapter to come ready.
996 */
997static int
998ciss_wait_adapter(struct ciss_softc *sc)
999{
1000    int		i;
1001
1002    debug_called(1);
1003
1004    /*
1005     * Wait for the adapter to come ready.
1006     */
1007    if (!(sc->ciss_cfg->active_method & CISS_TRANSPORT_METHOD_READY)) {
1008	ciss_printf(sc, "waiting for adapter to come ready...\n");
1009	for (i = 0; !(sc->ciss_cfg->active_method & CISS_TRANSPORT_METHOD_READY); i++) {
1010	    DELAY(1000000);	/* one second */
1011	    if (i > 30) {
1012		ciss_printf(sc, "timed out waiting for adapter to come ready\n");
1013		return(EIO);
1014	    }
1015	}
1016    }
1017    return(0);
1018}
1019
1020/************************************************************************
1021 * Flush the adapter cache.
1022 */
1023static int
1024ciss_flush_adapter(struct ciss_softc *sc)
1025{
1026    struct ciss_request			*cr;
1027    struct ciss_bmic_flush_cache	*cbfc;
1028    int					error, command_status;
1029
1030    debug_called(1);
1031
1032    cr = NULL;
1033    cbfc = NULL;
1034
1035    /*
1036     * Build a BMIC request to flush the cache.  We don't disable
1037     * it, as we may be going to do more I/O (eg. we are emulating
1038     * the Synchronise Cache command).
1039     */
1040    if ((cbfc = malloc(sizeof(*cbfc), CISS_MALLOC_CLASS, M_NOWAIT | M_ZERO)) == NULL) {
1041	error = ENOMEM;
1042	goto out;
1043    }
1044    if ((error = ciss_get_bmic_request(sc, &cr, CISS_BMIC_FLUSH_CACHE,
1045				       (void **)&cbfc, sizeof(*cbfc))) != 0)
1046	goto out;
1047
1048    /*
1049     * Submit the request and wait for it to complete.
1050     */
1051    if ((error = ciss_synch_request(cr, 60 * 1000)) != 0) {
1052	ciss_printf(sc, "error sending BMIC FLUSH_CACHE command (%d)\n", error);
1053	goto out;
1054    }
1055
1056    /*
1057     * Check response.
1058     */
1059    ciss_report_request(cr, &command_status, NULL);
1060    switch(command_status) {
1061    case CISS_CMD_STATUS_SUCCESS:
1062	break;
1063    default:
1064	ciss_printf(sc, "error flushing cache (%s)\n",
1065		    ciss_name_command_status(command_status));
1066	error = EIO;
1067	goto out;
1068    }
1069
1070out:
1071    if (cbfc != NULL)
1072	free(cbfc, CISS_MALLOC_CLASS);
1073    if (cr != NULL)
1074	ciss_release_request(cr);
1075    return(error);
1076}
1077
1078static void
1079ciss_soft_reset(struct ciss_softc *sc)
1080{
1081    struct ciss_request		*cr = NULL;
1082    struct ciss_command		*cc;
1083    int				i, error = 0;
1084
1085    for (i = 0; i < sc->ciss_max_logical_bus; i++) {
1086	/* only reset proxy controllers */
1087	if (sc->ciss_controllers[i].physical.bus == 0)
1088	    continue;
1089
1090	if ((error = ciss_get_request(sc, &cr)) != 0)
1091	    break;
1092
1093	if ((error = ciss_get_bmic_request(sc, &cr, CISS_BMIC_SOFT_RESET,
1094					   NULL, 0)) != 0)
1095	    break;
1096
1097	cc = cr->cr_cc;
1098	cc->header.address = sc->ciss_controllers[i];
1099
1100	if ((error = ciss_synch_request(cr, 60 * 1000)) != 0)
1101	    break;
1102
1103	ciss_release_request(cr);
1104    }
1105
1106    if (error)
1107	ciss_printf(sc, "error resetting controller (%d)\n", error);
1108
1109    if (cr != NULL)
1110	ciss_release_request(cr);
1111}
1112
1113/************************************************************************
1114 * Allocate memory for the adapter command structures, initialise
1115 * the request structures.
1116 *
1117 * Note that the entire set of commands are allocated in a single
1118 * contiguous slab.
1119 */
1120static int
1121ciss_init_requests(struct ciss_softc *sc)
1122{
1123    struct ciss_request	*cr;
1124    int			i;
1125
1126    debug_called(1);
1127
1128    if (bootverbose)
1129	ciss_printf(sc, "using %d of %d available commands\n",
1130		    sc->ciss_max_requests, sc->ciss_cfg->max_outstanding_commands);
1131
1132    /*
1133     * Create the DMA tag for commands.
1134     */
1135    if (bus_dma_tag_create(sc->ciss_parent_dmat,	/* parent */
1136			   32, 0, 			/* alignment, boundary */
1137			   BUS_SPACE_MAXADDR_32BIT,	/* lowaddr */
1138			   BUS_SPACE_MAXADDR, 		/* highaddr */
1139			   NULL, NULL, 			/* filter, filterarg */
1140			   CISS_COMMAND_ALLOC_SIZE *
1141			   sc->ciss_max_requests, 1,	/* maxsize, nsegments */
1142			   BUS_SPACE_MAXSIZE_32BIT,	/* maxsegsize */
1143			   0,				/* flags */
1144			   NULL, NULL,			/* lockfunc, lockarg */
1145			   &sc->ciss_command_dmat)) {
1146	ciss_printf(sc, "can't allocate command DMA tag\n");
1147	return(ENOMEM);
1148    }
1149    /*
1150     * Allocate memory and make it available for DMA.
1151     */
1152    if (bus_dmamem_alloc(sc->ciss_command_dmat, (void **)&sc->ciss_command,
1153			 BUS_DMA_NOWAIT, &sc->ciss_command_map)) {
1154	ciss_printf(sc, "can't allocate command memory\n");
1155	return(ENOMEM);
1156    }
1157    bus_dmamap_load(sc->ciss_command_dmat, sc->ciss_command_map,sc->ciss_command,
1158		    CISS_COMMAND_ALLOC_SIZE * sc->ciss_max_requests,
1159		    ciss_command_map_helper, &sc->ciss_command_phys, 0);
1160    bzero(sc->ciss_command, CISS_COMMAND_ALLOC_SIZE * sc->ciss_max_requests);
1161
1162    /*
1163     * Set up the request and command structures, push requests onto
1164     * the free queue.
1165     */
1166    for (i = 1; i < sc->ciss_max_requests; i++) {
1167	cr = &sc->ciss_request[i];
1168	cr->cr_sc = sc;
1169	cr->cr_tag = i;
1170	cr->cr_cc = (struct ciss_command *)((uintptr_t)sc->ciss_command +
1171	    CISS_COMMAND_ALLOC_SIZE * i);
1172	cr->cr_ccphys = sc->ciss_command_phys + CISS_COMMAND_ALLOC_SIZE * i;
1173	bus_dmamap_create(sc->ciss_buffer_dmat, 0, &cr->cr_datamap);
1174	ciss_enqueue_free(cr);
1175    }
1176    return(0);
1177}
1178
1179static void
1180ciss_command_map_helper(void *arg, bus_dma_segment_t *segs, int nseg, int error)
1181{
1182    uint32_t *addr;
1183
1184    addr = arg;
1185    *addr = segs[0].ds_addr;
1186}
1187
1188/************************************************************************
1189 * Identify the adapter, print some information about it.
1190 */
1191static int
1192ciss_identify_adapter(struct ciss_softc *sc)
1193{
1194    struct ciss_request	*cr;
1195    int			error, command_status;
1196
1197    debug_called(1);
1198
1199    cr = NULL;
1200
1201    /*
1202     * Get a request, allocate storage for the adapter data.
1203     */
1204    if ((error = ciss_get_bmic_request(sc, &cr, CISS_BMIC_ID_CTLR,
1205				       (void **)&sc->ciss_id,
1206				       sizeof(*sc->ciss_id))) != 0)
1207	goto out;
1208
1209    /*
1210     * Submit the request and wait for it to complete.
1211     */
1212    if ((error = ciss_synch_request(cr, 60 * 1000)) != 0) {
1213	ciss_printf(sc, "error sending BMIC ID_CTLR command (%d)\n", error);
1214	goto out;
1215    }
1216
1217    /*
1218     * Check response.
1219     */
1220    ciss_report_request(cr, &command_status, NULL);
1221    switch(command_status) {
1222    case CISS_CMD_STATUS_SUCCESS:		/* buffer right size */
1223	break;
1224    case CISS_CMD_STATUS_DATA_UNDERRUN:
1225    case CISS_CMD_STATUS_DATA_OVERRUN:
1226	ciss_printf(sc, "data over/underrun reading adapter information\n");
1227    default:
1228	ciss_printf(sc, "error reading adapter information (%s)\n",
1229		    ciss_name_command_status(command_status));
1230	error = EIO;
1231	goto out;
1232    }
1233
1234    /* sanity-check reply */
1235    if (!(sc->ciss_id->controller_flags & CONTROLLER_FLAGS_BIG_MAP_SUPPORT)) {
1236	ciss_printf(sc, "adapter does not support BIG_MAP\n");
1237	error = ENXIO;
1238	goto out;
1239    }
1240
1241#if 0
1242    /* XXX later revisions may not need this */
1243    sc->ciss_flags |= CISS_FLAG_FAKE_SYNCH;
1244#endif
1245
1246    /* XXX only really required for old 5300 adapters? */
1247    sc->ciss_flags |= CISS_FLAG_BMIC_ABORT;
1248
1249    /*
1250     * Earlier controller specs do not contain these config
1251     * entries, so assume that a 0 means its old and assign
1252     * these values to the defaults that were established
1253     * when this driver was developed for them
1254     */
1255    if (sc->ciss_cfg->max_logical_supported == 0)
1256        sc->ciss_cfg->max_logical_supported = CISS_MAX_LOGICAL;
1257    if (sc->ciss_cfg->max_physical_supported == 0)
1258	sc->ciss_cfg->max_physical_supported = CISS_MAX_PHYSICAL;
1259    /* print information */
1260    if (bootverbose) {
1261	ciss_printf(sc, "  %d logical drive%s configured\n",
1262		    sc->ciss_id->configured_logical_drives,
1263		    (sc->ciss_id->configured_logical_drives == 1) ? "" : "s");
1264	ciss_printf(sc, "  firmware %4.4s\n", sc->ciss_id->running_firmware_revision);
1265	ciss_printf(sc, "  %d SCSI channels\n", sc->ciss_id->scsi_chip_count);
1266
1267	ciss_printf(sc, "  signature '%.4s'\n", sc->ciss_cfg->signature);
1268	ciss_printf(sc, "  valence %d\n", sc->ciss_cfg->valence);
1269	ciss_printf(sc, "  supported I/O methods 0x%b\n",
1270		    sc->ciss_cfg->supported_methods,
1271		    "\20\1READY\2simple\3performant\4MEMQ\n");
1272	ciss_printf(sc, "  active I/O method 0x%b\n",
1273		    sc->ciss_cfg->active_method, "\20\2simple\3performant\4MEMQ\n");
1274	ciss_printf(sc, "  4G page base 0x%08x\n",
1275		    sc->ciss_cfg->command_physlimit);
1276	ciss_printf(sc, "  interrupt coalesce delay %dus\n",
1277		    sc->ciss_cfg->interrupt_coalesce_delay);
1278	ciss_printf(sc, "  interrupt coalesce count %d\n",
1279		    sc->ciss_cfg->interrupt_coalesce_count);
1280	ciss_printf(sc, "  max outstanding commands %d\n",
1281		    sc->ciss_cfg->max_outstanding_commands);
1282	ciss_printf(sc, "  bus types 0x%b\n", sc->ciss_cfg->bus_types,
1283		    "\20\1ultra2\2ultra3\10fibre1\11fibre2\n");
1284	ciss_printf(sc, "  server name '%.16s'\n", sc->ciss_cfg->server_name);
1285	ciss_printf(sc, "  heartbeat 0x%x\n", sc->ciss_cfg->heartbeat);
1286    	ciss_printf(sc, "  max logical logical volumes: %d\n", sc->ciss_cfg->max_logical_supported);
1287    	ciss_printf(sc, "  max physical disks supported: %d\n", sc->ciss_cfg->max_physical_supported);
1288    	ciss_printf(sc, "  max physical disks per logical volume: %d\n", sc->ciss_cfg->max_physical_per_logical);
1289	ciss_printf(sc, "  JBOD Support is %s\n", (sc->ciss_id->uiYetMoreControllerFlags & YMORE_CONTROLLER_FLAGS_JBOD_SUPPORTED) ?
1290			"Available" : "Unavailable");
1291	ciss_printf(sc, "  JBOD Mode is %s\n", (sc->ciss_id->PowerUPNvramFlags & PWR_UP_FLAG_JBOD_ENABLED) ?
1292			"Enabled" : "Disabled");
1293    }
1294
1295out:
1296    if (error) {
1297	if (sc->ciss_id != NULL) {
1298	    free(sc->ciss_id, CISS_MALLOC_CLASS);
1299	    sc->ciss_id = NULL;
1300	}
1301    }
1302    if (cr != NULL)
1303	ciss_release_request(cr);
1304    return(error);
1305}
1306
1307/************************************************************************
1308 * Helper routine for generating a list of logical and physical luns.
1309 */
1310static struct ciss_lun_report *
1311ciss_report_luns(struct ciss_softc *sc, int opcode, int nunits)
1312{
1313    struct ciss_request		*cr;
1314    struct ciss_command		*cc;
1315    struct ciss_report_cdb	*crc;
1316    struct ciss_lun_report	*cll;
1317    int				command_status;
1318    int				report_size;
1319    int				error = 0;
1320
1321    debug_called(1);
1322
1323    cr = NULL;
1324    cll = NULL;
1325
1326    /*
1327     * Get a request, allocate storage for the address list.
1328     */
1329    if ((error = ciss_get_request(sc, &cr)) != 0)
1330	goto out;
1331    report_size = sizeof(*cll) + nunits * sizeof(union ciss_device_address);
1332    if ((cll = malloc(report_size, CISS_MALLOC_CLASS, M_NOWAIT | M_ZERO)) == NULL) {
1333	ciss_printf(sc, "can't allocate memory for lun report\n");
1334	error = ENOMEM;
1335	goto out;
1336    }
1337
1338    /*
1339     * Build the Report Logical/Physical LUNs command.
1340     */
1341    cc = cr->cr_cc;
1342    cr->cr_data = cll;
1343    cr->cr_length = report_size;
1344    cr->cr_flags = CISS_REQ_DATAIN;
1345
1346    cc->header.address.physical.mode = CISS_HDR_ADDRESS_MODE_PERIPHERAL;
1347    cc->header.address.physical.bus = 0;
1348    cc->header.address.physical.target = 0;
1349    cc->cdb.cdb_length = sizeof(*crc);
1350    cc->cdb.type = CISS_CDB_TYPE_COMMAND;
1351    cc->cdb.attribute = CISS_CDB_ATTRIBUTE_SIMPLE;
1352    cc->cdb.direction = CISS_CDB_DIRECTION_READ;
1353    cc->cdb.timeout = 30;	/* XXX better suggestions? */
1354
1355    crc = (struct ciss_report_cdb *)&(cc->cdb.cdb[0]);
1356    bzero(crc, sizeof(*crc));
1357    crc->opcode = opcode;
1358    crc->length = htonl(report_size);			/* big-endian field */
1359    cll->list_size = htonl(report_size - sizeof(*cll));	/* big-endian field */
1360
1361    /*
1362     * Submit the request and wait for it to complete.  (timeout
1363     * here should be much greater than above)
1364     */
1365    if ((error = ciss_synch_request(cr, 60 * 1000)) != 0) {
1366	ciss_printf(sc, "error sending %d LUN command (%d)\n", opcode, error);
1367	goto out;
1368    }
1369
1370    /*
1371     * Check response.  Note that data over/underrun is OK.
1372     */
1373    ciss_report_request(cr, &command_status, NULL);
1374    switch(command_status) {
1375    case CISS_CMD_STATUS_SUCCESS:	/* buffer right size */
1376    case CISS_CMD_STATUS_DATA_UNDERRUN:	/* buffer too large, not bad */
1377	break;
1378    case CISS_CMD_STATUS_DATA_OVERRUN:
1379	ciss_printf(sc, "WARNING: more units than driver limit (%d)\n",
1380		    sc->ciss_cfg->max_logical_supported);
1381	break;
1382    default:
1383	ciss_printf(sc, "error detecting logical drive configuration (%s)\n",
1384		    ciss_name_command_status(command_status));
1385	error = EIO;
1386	goto out;
1387    }
1388    ciss_release_request(cr);
1389    cr = NULL;
1390
1391out:
1392    if (cr != NULL)
1393	ciss_release_request(cr);
1394    if (error && cll != NULL) {
1395	free(cll, CISS_MALLOC_CLASS);
1396	cll = NULL;
1397    }
1398    return(cll);
1399}
1400
1401/************************************************************************
1402 * Find logical drives on the adapter.
1403 */
1404static int
1405ciss_init_logical(struct ciss_softc *sc)
1406{
1407    struct ciss_lun_report	*cll;
1408    int				error = 0, i, j;
1409    int				ndrives;
1410
1411    debug_called(1);
1412
1413    cll = ciss_report_luns(sc, CISS_OPCODE_REPORT_LOGICAL_LUNS,
1414			   sc->ciss_cfg->max_logical_supported);
1415    if (cll == NULL) {
1416	error = ENXIO;
1417	goto out;
1418    }
1419
1420    /* sanity-check reply */
1421    ndrives = (ntohl(cll->list_size) / sizeof(union ciss_device_address));
1422    if ((ndrives < 0) || (ndrives > sc->ciss_cfg->max_logical_supported)) {
1423	ciss_printf(sc, "adapter claims to report absurd number of logical drives (%d > %d)\n",
1424	    	ndrives, sc->ciss_cfg->max_logical_supported);
1425	error = ENXIO;
1426	goto out;
1427    }
1428
1429    /*
1430     * Save logical drive information.
1431     */
1432    if (bootverbose) {
1433	ciss_printf(sc, "%d logical drive%s\n",
1434	    ndrives, (ndrives > 1 || ndrives == 0) ? "s" : "");
1435    }
1436
1437    sc->ciss_logical =
1438	malloc(sc->ciss_max_logical_bus * sizeof(struct ciss_ldrive *),
1439	       CISS_MALLOC_CLASS, M_NOWAIT | M_ZERO);
1440    if (sc->ciss_logical == NULL) {
1441	error = ENXIO;
1442	goto out;
1443    }
1444
1445    for (i = 0; i < sc->ciss_max_logical_bus; i++) {
1446	sc->ciss_logical[i] =
1447	    malloc(sc->ciss_cfg->max_logical_supported *
1448		   sizeof(struct ciss_ldrive),
1449		   CISS_MALLOC_CLASS, M_NOWAIT | M_ZERO);
1450	if (sc->ciss_logical[i] == NULL) {
1451	    error = ENXIO;
1452	    goto out;
1453	}
1454
1455	for (j = 0; j < sc->ciss_cfg->max_logical_supported; j++)
1456	    sc->ciss_logical[i][j].cl_status = CISS_LD_NONEXISTENT;
1457    }
1458
1459    for (i = 0; i < sc->ciss_cfg->max_logical_supported; i++) {
1460	if (i < ndrives) {
1461	    struct ciss_ldrive	*ld;
1462	    int			bus, target;
1463
1464	    bus		= CISS_LUN_TO_BUS(cll->lun[i].logical.lun);
1465	    target	= CISS_LUN_TO_TARGET(cll->lun[i].logical.lun);
1466	    ld		= &sc->ciss_logical[bus][target];
1467
1468	    ld->cl_address	= cll->lun[i];
1469	    ld->cl_controller	= &sc->ciss_controllers[bus];
1470	    if (ciss_identify_logical(sc, ld) != 0)
1471		continue;
1472	    /*
1473	     * If the drive has had media exchanged, we should bring it online.
1474	     */
1475	    if (ld->cl_lstatus->media_exchanged)
1476		ciss_accept_media(sc, ld);
1477	}
1478    }
1479
1480 out:
1481    if (cll != NULL)
1482	free(cll, CISS_MALLOC_CLASS);
1483    return(error);
1484}
1485
1486static int
1487ciss_init_physical(struct ciss_softc *sc)
1488{
1489    struct ciss_lun_report	*cll;
1490    int				error = 0, i;
1491    int				nphys;
1492    int				bus, target;
1493
1494    debug_called(1);
1495
1496    bus = 0;
1497    target = 0;
1498
1499    cll = ciss_report_luns(sc, CISS_OPCODE_REPORT_PHYSICAL_LUNS,
1500			   sc->ciss_cfg->max_physical_supported);
1501    if (cll == NULL) {
1502	error = ENXIO;
1503	goto out;
1504    }
1505
1506    nphys = (ntohl(cll->list_size) / sizeof(union ciss_device_address));
1507
1508    if (bootverbose) {
1509	ciss_printf(sc, "%d physical device%s\n",
1510	    nphys, (nphys > 1 || nphys == 0) ? "s" : "");
1511    }
1512
1513    /*
1514     * Figure out the bus mapping.
1515     * Logical buses include both the local logical bus for local arrays and
1516     * proxy buses for remote arrays.  Physical buses are numbered by the
1517     * controller and represent physical buses that hold physical devices.
1518     * We shift these bus numbers so that everything fits into a single flat
1519     * numbering space for CAM.  Logical buses occupy the first 32 CAM bus
1520     * numbers, and the physical bus numbers are shifted to be above that.
1521     * This results in the various driver arrays being indexed as follows:
1522     *
1523     * ciss_controllers[] - indexed by logical bus
1524     * ciss_cam_sim[]     - indexed by both logical and physical, with physical
1525     *                      being shifted by 32.
1526     * ciss_logical[][]   - indexed by logical bus
1527     * ciss_physical[][]  - indexed by physical bus
1528     *
1529     * XXX This is getting more and more hackish.  CISS really doesn't play
1530     *     well with a standard SCSI model; devices are addressed via magic
1531     *     cookies, not via b/t/l addresses.  Since there is no way to store
1532     *     the cookie in the CAM device object, we have to keep these lookup
1533     *     tables handy so that the devices can be found quickly at the cost
1534     *     of wasting memory and having a convoluted lookup scheme.  This
1535     *     driver should probably be converted to block interface.
1536     */
1537    /*
1538     * If the L2 and L3 SCSI addresses are 0, this signifies a proxy
1539     * controller. A proxy controller is another physical controller
1540     * behind the primary PCI controller. We need to know about this
1541     * so that BMIC commands can be properly targeted.  There can be
1542     * proxy controllers attached to a single PCI controller, so
1543     * find the highest numbered one so the array can be properly
1544     * sized.
1545     */
1546    sc->ciss_max_logical_bus = 1;
1547    for (i = 0; i < nphys; i++) {
1548	if (cll->lun[i].physical.extra_address == 0) {
1549	    bus = cll->lun[i].physical.bus;
1550	    sc->ciss_max_logical_bus = max(sc->ciss_max_logical_bus, bus) + 1;
1551	} else {
1552	    bus = CISS_EXTRA_BUS2(cll->lun[i].physical.extra_address);
1553	    sc->ciss_max_physical_bus = max(sc->ciss_max_physical_bus, bus);
1554	}
1555    }
1556
1557    sc->ciss_controllers =
1558	malloc(sc->ciss_max_logical_bus * sizeof (union ciss_device_address),
1559	       CISS_MALLOC_CLASS, M_NOWAIT | M_ZERO);
1560
1561    if (sc->ciss_controllers == NULL) {
1562	ciss_printf(sc, "Could not allocate memory for controller map\n");
1563	error = ENOMEM;
1564	goto out;
1565    }
1566
1567    /* setup a map of controller addresses */
1568    for (i = 0; i < nphys; i++) {
1569	if (cll->lun[i].physical.extra_address == 0) {
1570	    sc->ciss_controllers[cll->lun[i].physical.bus] = cll->lun[i];
1571	}
1572    }
1573
1574    sc->ciss_physical =
1575	malloc(sc->ciss_max_physical_bus * sizeof(struct ciss_pdrive *),
1576	       CISS_MALLOC_CLASS, M_NOWAIT | M_ZERO);
1577    if (sc->ciss_physical == NULL) {
1578	ciss_printf(sc, "Could not allocate memory for physical device map\n");
1579	error = ENOMEM;
1580	goto out;
1581    }
1582
1583    for (i = 0; i < sc->ciss_max_physical_bus; i++) {
1584	sc->ciss_physical[i] =
1585	    malloc(sizeof(struct ciss_pdrive) * CISS_MAX_PHYSTGT,
1586		   CISS_MALLOC_CLASS, M_NOWAIT | M_ZERO);
1587	if (sc->ciss_physical[i] == NULL) {
1588	    ciss_printf(sc, "Could not allocate memory for target map\n");
1589	    error = ENOMEM;
1590	    goto out;
1591	}
1592    }
1593
1594    ciss_filter_physical(sc, cll);
1595
1596out:
1597    if (cll != NULL)
1598	free(cll, CISS_MALLOC_CLASS);
1599
1600    return(error);
1601}
1602
1603static int
1604ciss_filter_physical(struct ciss_softc *sc, struct ciss_lun_report *cll)
1605{
1606    u_int32_t ea;
1607    int i, nphys;
1608    int	bus, target;
1609
1610    nphys = (ntohl(cll->list_size) / sizeof(union ciss_device_address));
1611    for (i = 0; i < nphys; i++) {
1612	if (cll->lun[i].physical.extra_address == 0)
1613	    continue;
1614
1615	/*
1616	 * Filter out devices that we don't want.  Level 3 LUNs could
1617	 * probably be supported, but the docs don't give enough of a
1618	 * hint to know how.
1619	 *
1620	 * The mode field of the physical address is likely set to have
1621	 * hard disks masked out.  Honor it unless the user has overridden
1622	 * us with the tunable.  We also munge the inquiry data for these
1623	 * disks so that they only show up as passthrough devices.  Keeping
1624	 * them visible in this fashion is useful for doing things like
1625	 * flashing firmware.
1626	 */
1627	ea = cll->lun[i].physical.extra_address;
1628	if ((CISS_EXTRA_BUS3(ea) != 0) || (CISS_EXTRA_TARGET3(ea) != 0) ||
1629	    (CISS_EXTRA_MODE2(ea) == 0x3))
1630	    continue;
1631	if ((ciss_expose_hidden_physical == 0) &&
1632	   (cll->lun[i].physical.mode == CISS_HDR_ADDRESS_MODE_MASK_PERIPHERAL))
1633	    continue;
1634
1635	/*
1636	 * Note: CISS firmware numbers physical busses starting at '1', not
1637	 *       '0'.  This numbering is internal to the firmware and is only
1638	 *       used as a hint here.
1639	 */
1640	bus = CISS_EXTRA_BUS2(ea) - 1;
1641	target = CISS_EXTRA_TARGET2(ea);
1642	sc->ciss_physical[bus][target].cp_address = cll->lun[i];
1643	sc->ciss_physical[bus][target].cp_online = 1;
1644    }
1645
1646    return (0);
1647}
1648
1649static int
1650ciss_inquiry_logical(struct ciss_softc *sc, struct ciss_ldrive *ld)
1651{
1652    struct ciss_request			*cr;
1653    struct ciss_command			*cc;
1654    struct scsi_inquiry			*inq;
1655    int					error;
1656    int					command_status;
1657
1658    cr = NULL;
1659
1660    bzero(&ld->cl_geometry, sizeof(ld->cl_geometry));
1661
1662    if ((error = ciss_get_request(sc, &cr)) != 0)
1663	goto out;
1664
1665    cc = cr->cr_cc;
1666    cr->cr_data = &ld->cl_geometry;
1667    cr->cr_length = sizeof(ld->cl_geometry);
1668    cr->cr_flags = CISS_REQ_DATAIN;
1669
1670    cc->header.address = ld->cl_address;
1671    cc->cdb.cdb_length = 6;
1672    cc->cdb.type = CISS_CDB_TYPE_COMMAND;
1673    cc->cdb.attribute = CISS_CDB_ATTRIBUTE_SIMPLE;
1674    cc->cdb.direction = CISS_CDB_DIRECTION_READ;
1675    cc->cdb.timeout = 30;
1676
1677    inq = (struct scsi_inquiry *)&(cc->cdb.cdb[0]);
1678    inq->opcode = INQUIRY;
1679    inq->byte2 = SI_EVPD;
1680    inq->page_code = CISS_VPD_LOGICAL_DRIVE_GEOMETRY;
1681    scsi_ulto2b(sizeof(ld->cl_geometry), inq->length);
1682
1683    if ((error = ciss_synch_request(cr, 60 * 1000)) != 0) {
1684	ciss_printf(sc, "error getting geometry (%d)\n", error);
1685	goto out;
1686    }
1687
1688    ciss_report_request(cr, &command_status, NULL);
1689    switch(command_status) {
1690    case CISS_CMD_STATUS_SUCCESS:
1691    case CISS_CMD_STATUS_DATA_UNDERRUN:
1692	break;
1693    case CISS_CMD_STATUS_DATA_OVERRUN:
1694	ciss_printf(sc, "WARNING: Data overrun\n");
1695	break;
1696    default:
1697	ciss_printf(sc, "Error detecting logical drive geometry (%s)\n",
1698		    ciss_name_command_status(command_status));
1699	break;
1700    }
1701
1702out:
1703    if (cr != NULL)
1704	ciss_release_request(cr);
1705    return(error);
1706}
1707/************************************************************************
1708 * Identify a logical drive, initialise state related to it.
1709 */
1710static int
1711ciss_identify_logical(struct ciss_softc *sc, struct ciss_ldrive *ld)
1712{
1713    struct ciss_request		*cr;
1714    struct ciss_command		*cc;
1715    struct ciss_bmic_cdb	*cbc;
1716    int				error, command_status;
1717
1718    debug_called(1);
1719
1720    cr = NULL;
1721
1722    /*
1723     * Build a BMIC request to fetch the drive ID.
1724     */
1725    if ((error = ciss_get_bmic_request(sc, &cr, CISS_BMIC_ID_LDRIVE,
1726				       (void **)&ld->cl_ldrive,
1727				       sizeof(*ld->cl_ldrive))) != 0)
1728	goto out;
1729    cc = cr->cr_cc;
1730    cc->header.address = *ld->cl_controller;	/* target controller */
1731    cbc = (struct ciss_bmic_cdb *)&(cc->cdb.cdb[0]);
1732    cbc->log_drive = CISS_LUN_TO_TARGET(ld->cl_address.logical.lun);
1733
1734    /*
1735     * Submit the request and wait for it to complete.
1736     */
1737    if ((error = ciss_synch_request(cr, 60 * 1000)) != 0) {
1738	ciss_printf(sc, "error sending BMIC LDRIVE command (%d)\n", error);
1739	goto out;
1740    }
1741
1742    /*
1743     * Check response.
1744     */
1745    ciss_report_request(cr, &command_status, NULL);
1746    switch(command_status) {
1747    case CISS_CMD_STATUS_SUCCESS:		/* buffer right size */
1748	break;
1749    case CISS_CMD_STATUS_DATA_UNDERRUN:
1750    case CISS_CMD_STATUS_DATA_OVERRUN:
1751	ciss_printf(sc, "data over/underrun reading logical drive ID\n");
1752    default:
1753	ciss_printf(sc, "error reading logical drive ID (%s)\n",
1754		    ciss_name_command_status(command_status));
1755	error = EIO;
1756	goto out;
1757    }
1758    ciss_release_request(cr);
1759    cr = NULL;
1760
1761    /*
1762     * Build a CISS BMIC command to get the logical drive status.
1763     */
1764    if ((error = ciss_get_ldrive_status(sc, ld)) != 0)
1765	goto out;
1766
1767    /*
1768     * Get the logical drive geometry.
1769     */
1770    if ((error = ciss_inquiry_logical(sc, ld)) != 0)
1771	goto out;
1772
1773    /*
1774     * Print the drive's basic characteristics.
1775     */
1776    if (bootverbose) {
1777	ciss_printf(sc, "logical drive (b%dt%d): %s, %dMB ",
1778		    CISS_LUN_TO_BUS(ld->cl_address.logical.lun),
1779		    CISS_LUN_TO_TARGET(ld->cl_address.logical.lun),
1780		    ciss_name_ldrive_org(ld->cl_ldrive->fault_tolerance),
1781		    ((ld->cl_ldrive->blocks_available / (1024 * 1024)) *
1782		     ld->cl_ldrive->block_size));
1783
1784	ciss_print_ldrive(sc, ld);
1785    }
1786out:
1787    if (error != 0) {
1788	/* make the drive not-exist */
1789	ld->cl_status = CISS_LD_NONEXISTENT;
1790	if (ld->cl_ldrive != NULL) {
1791	    free(ld->cl_ldrive, CISS_MALLOC_CLASS);
1792	    ld->cl_ldrive = NULL;
1793	}
1794	if (ld->cl_lstatus != NULL) {
1795	    free(ld->cl_lstatus, CISS_MALLOC_CLASS);
1796	    ld->cl_lstatus = NULL;
1797	}
1798    }
1799    if (cr != NULL)
1800	ciss_release_request(cr);
1801
1802    return(error);
1803}
1804
1805/************************************************************************
1806 * Get status for a logical drive.
1807 *
1808 * XXX should we also do this in response to Test Unit Ready?
1809 */
1810static int
1811ciss_get_ldrive_status(struct ciss_softc *sc,  struct ciss_ldrive *ld)
1812{
1813    struct ciss_request		*cr;
1814    struct ciss_command		*cc;
1815    struct ciss_bmic_cdb	*cbc;
1816    int				error, command_status;
1817
1818    /*
1819     * Build a CISS BMIC command to get the logical drive status.
1820     */
1821    if ((error = ciss_get_bmic_request(sc, &cr, CISS_BMIC_ID_LSTATUS,
1822				       (void **)&ld->cl_lstatus,
1823				       sizeof(*ld->cl_lstatus))) != 0)
1824	goto out;
1825    cc = cr->cr_cc;
1826    cc->header.address = *ld->cl_controller;	/* target controller */
1827    cbc = (struct ciss_bmic_cdb *)&(cc->cdb.cdb[0]);
1828    cbc->log_drive = CISS_LUN_TO_TARGET(ld->cl_address.logical.lun);
1829
1830    /*
1831     * Submit the request and wait for it to complete.
1832     */
1833    if ((error = ciss_synch_request(cr, 60 * 1000)) != 0) {
1834	ciss_printf(sc, "error sending BMIC LSTATUS command (%d)\n", error);
1835	goto out;
1836    }
1837
1838    /*
1839     * Check response.
1840     */
1841    ciss_report_request(cr, &command_status, NULL);
1842    switch(command_status) {
1843    case CISS_CMD_STATUS_SUCCESS:		/* buffer right size */
1844	break;
1845    case CISS_CMD_STATUS_DATA_UNDERRUN:
1846    case CISS_CMD_STATUS_DATA_OVERRUN:
1847	ciss_printf(sc, "data over/underrun reading logical drive status\n");
1848    default:
1849	ciss_printf(sc, "error reading logical drive status (%s)\n",
1850		    ciss_name_command_status(command_status));
1851	error = EIO;
1852	goto out;
1853    }
1854
1855    /*
1856     * Set the drive's summary status based on the returned status.
1857     *
1858     * XXX testing shows that a failed JBOD drive comes back at next
1859     * boot in "queued for expansion" mode.  WTF?
1860     */
1861    ld->cl_status = ciss_decode_ldrive_status(ld->cl_lstatus->status);
1862
1863out:
1864    if (cr != NULL)
1865	ciss_release_request(cr);
1866    return(error);
1867}
1868
1869/************************************************************************
1870 * Notify the adapter of a config update.
1871 */
1872static int
1873ciss_update_config(struct ciss_softc *sc)
1874{
1875    int		i;
1876
1877    debug_called(1);
1878
1879    CISS_TL_SIMPLE_WRITE(sc, CISS_TL_SIMPLE_IDBR, CISS_TL_SIMPLE_IDBR_CFG_TABLE);
1880    for (i = 0; i < 1000; i++) {
1881	if (!(CISS_TL_SIMPLE_READ(sc, CISS_TL_SIMPLE_IDBR) &
1882	      CISS_TL_SIMPLE_IDBR_CFG_TABLE)) {
1883	    return(0);
1884	}
1885	DELAY(1000);
1886    }
1887    return(1);
1888}
1889
1890/************************************************************************
1891 * Accept new media into a logical drive.
1892 *
1893 * XXX The drive has previously been offline; it would be good if we
1894 *     could make sure it's not open right now.
1895 */
1896static int
1897ciss_accept_media(struct ciss_softc *sc, struct ciss_ldrive *ld)
1898{
1899    struct ciss_request		*cr;
1900    struct ciss_command		*cc;
1901    struct ciss_bmic_cdb	*cbc;
1902    int				command_status;
1903    int				error = 0, ldrive;
1904
1905    ldrive = CISS_LUN_TO_TARGET(ld->cl_address.logical.lun);
1906
1907    debug(0, "bringing logical drive %d back online", ldrive);
1908
1909    /*
1910     * Build a CISS BMIC command to bring the drive back online.
1911     */
1912    if ((error = ciss_get_bmic_request(sc, &cr, CISS_BMIC_ACCEPT_MEDIA,
1913				       NULL, 0)) != 0)
1914	goto out;
1915    cc = cr->cr_cc;
1916    cc->header.address = *ld->cl_controller;	/* target controller */
1917    cbc = (struct ciss_bmic_cdb *)&(cc->cdb.cdb[0]);
1918    cbc->log_drive = ldrive;
1919
1920    /*
1921     * Submit the request and wait for it to complete.
1922     */
1923    if ((error = ciss_synch_request(cr, 60 * 1000)) != 0) {
1924	ciss_printf(sc, "error sending BMIC ACCEPT MEDIA command (%d)\n", error);
1925	goto out;
1926    }
1927
1928    /*
1929     * Check response.
1930     */
1931    ciss_report_request(cr, &command_status, NULL);
1932    switch(command_status) {
1933    case CISS_CMD_STATUS_SUCCESS:		/* all OK */
1934	/* we should get a logical drive status changed event here */
1935	break;
1936    default:
1937	ciss_printf(cr->cr_sc, "error accepting media into failed logical drive (%s)\n",
1938		    ciss_name_command_status(command_status));
1939	break;
1940    }
1941
1942out:
1943    if (cr != NULL)
1944	ciss_release_request(cr);
1945    return(error);
1946}
1947
1948/************************************************************************
1949 * Release adapter resources.
1950 */
1951static void
1952ciss_free(struct ciss_softc *sc)
1953{
1954    struct ciss_request *cr;
1955    int			i, j;
1956
1957    debug_called(1);
1958
1959    /* we're going away */
1960    sc->ciss_flags |= CISS_FLAG_ABORTING;
1961
1962    /* terminate the periodic heartbeat routine */
1963    callout_stop(&sc->ciss_periodic);
1964
1965    /* cancel the Event Notify chain */
1966    ciss_notify_abort(sc);
1967
1968    ciss_kill_notify_thread(sc);
1969
1970    /* disconnect from CAM */
1971    if (sc->ciss_cam_sim) {
1972	for (i = 0; i < sc->ciss_max_logical_bus; i++) {
1973	    if (sc->ciss_cam_sim[i]) {
1974		xpt_bus_deregister(cam_sim_path(sc->ciss_cam_sim[i]));
1975		cam_sim_free(sc->ciss_cam_sim[i], 0);
1976	    }
1977	}
1978	for (i = CISS_PHYSICAL_BASE; i < sc->ciss_max_physical_bus +
1979	     CISS_PHYSICAL_BASE; i++) {
1980	    if (sc->ciss_cam_sim[i]) {
1981		xpt_bus_deregister(cam_sim_path(sc->ciss_cam_sim[i]));
1982		cam_sim_free(sc->ciss_cam_sim[i], 0);
1983	    }
1984	}
1985	free(sc->ciss_cam_sim, CISS_MALLOC_CLASS);
1986    }
1987    if (sc->ciss_cam_devq)
1988	cam_simq_free(sc->ciss_cam_devq);
1989
1990    /* remove the control device */
1991    mtx_unlock(&sc->ciss_mtx);
1992    if (sc->ciss_dev_t != NULL)
1993	destroy_dev(sc->ciss_dev_t);
1994
1995    /* Final cleanup of the callout. */
1996    callout_drain(&sc->ciss_periodic);
1997    mtx_destroy(&sc->ciss_mtx);
1998
1999    /* free the controller data */
2000    if (sc->ciss_id != NULL)
2001	free(sc->ciss_id, CISS_MALLOC_CLASS);
2002
2003    /* release I/O resources */
2004    if (sc->ciss_regs_resource != NULL)
2005	bus_release_resource(sc->ciss_dev, SYS_RES_MEMORY,
2006			     sc->ciss_regs_rid, sc->ciss_regs_resource);
2007    if (sc->ciss_cfg_resource != NULL)
2008	bus_release_resource(sc->ciss_dev, SYS_RES_MEMORY,
2009			     sc->ciss_cfg_rid, sc->ciss_cfg_resource);
2010    if (sc->ciss_intr != NULL)
2011	bus_teardown_intr(sc->ciss_dev, sc->ciss_irq_resource, sc->ciss_intr);
2012    if (sc->ciss_irq_resource != NULL)
2013	bus_release_resource(sc->ciss_dev, SYS_RES_IRQ,
2014			     sc->ciss_irq_rid[0], sc->ciss_irq_resource);
2015    if (sc->ciss_msi)
2016	pci_release_msi(sc->ciss_dev);
2017
2018    while ((cr = ciss_dequeue_free(sc)) != NULL)
2019	bus_dmamap_destroy(sc->ciss_buffer_dmat, cr->cr_datamap);
2020    if (sc->ciss_buffer_dmat)
2021	bus_dma_tag_destroy(sc->ciss_buffer_dmat);
2022
2023    /* destroy command memory and DMA tag */
2024    if (sc->ciss_command != NULL) {
2025	bus_dmamap_unload(sc->ciss_command_dmat, sc->ciss_command_map);
2026	bus_dmamem_free(sc->ciss_command_dmat, sc->ciss_command, sc->ciss_command_map);
2027    }
2028    if (sc->ciss_command_dmat)
2029	bus_dma_tag_destroy(sc->ciss_command_dmat);
2030
2031    if (sc->ciss_reply) {
2032	bus_dmamap_unload(sc->ciss_reply_dmat, sc->ciss_reply_map);
2033	bus_dmamem_free(sc->ciss_reply_dmat, sc->ciss_reply, sc->ciss_reply_map);
2034    }
2035    if (sc->ciss_reply_dmat)
2036	bus_dma_tag_destroy(sc->ciss_reply_dmat);
2037
2038    /* destroy DMA tags */
2039    if (sc->ciss_parent_dmat)
2040	bus_dma_tag_destroy(sc->ciss_parent_dmat);
2041    if (sc->ciss_logical) {
2042	for (i = 0; i < sc->ciss_max_logical_bus; i++) {
2043	    for (j = 0; j < sc->ciss_cfg->max_logical_supported; j++) {
2044		if (sc->ciss_logical[i][j].cl_ldrive)
2045		    free(sc->ciss_logical[i][j].cl_ldrive, CISS_MALLOC_CLASS);
2046		if (sc->ciss_logical[i][j].cl_lstatus)
2047		    free(sc->ciss_logical[i][j].cl_lstatus, CISS_MALLOC_CLASS);
2048	    }
2049	    free(sc->ciss_logical[i], CISS_MALLOC_CLASS);
2050	}
2051	free(sc->ciss_logical, CISS_MALLOC_CLASS);
2052    }
2053
2054    if (sc->ciss_physical) {
2055	for (i = 0; i < sc->ciss_max_physical_bus; i++)
2056	    free(sc->ciss_physical[i], CISS_MALLOC_CLASS);
2057	free(sc->ciss_physical, CISS_MALLOC_CLASS);
2058    }
2059
2060    if (sc->ciss_controllers)
2061	free(sc->ciss_controllers, CISS_MALLOC_CLASS);
2062
2063}
2064
2065/************************************************************************
2066 * Give a command to the adapter.
2067 *
2068 * Note that this uses the simple transport layer directly.  If we
2069 * want to add support for other layers, we'll need a switch of some
2070 * sort.
2071 *
2072 * Note that the simple transport layer has no way of refusing a
2073 * command; we only have as many request structures as the adapter
2074 * supports commands, so we don't have to check (this presumes that
2075 * the adapter can handle commands as fast as we throw them at it).
2076 */
2077static int
2078ciss_start(struct ciss_request *cr)
2079{
2080    struct ciss_command	*cc;	/* XXX debugging only */
2081    int			error;
2082
2083    cc = cr->cr_cc;
2084    debug(2, "post command %d tag %d ", cr->cr_tag, cc->header.host_tag);
2085
2086    /*
2087     * Map the request's data.
2088     */
2089    if ((error = ciss_map_request(cr)))
2090	return(error);
2091
2092#if 0
2093    ciss_print_request(cr);
2094#endif
2095
2096    return(0);
2097}
2098
2099/************************************************************************
2100 * Fetch completed request(s) from the adapter, queue them for
2101 * completion handling.
2102 *
2103 * Note that this uses the simple transport layer directly.  If we
2104 * want to add support for other layers, we'll need a switch of some
2105 * sort.
2106 *
2107 * Note that the simple transport mechanism does not require any
2108 * reentrancy protection; the OPQ read is atomic.  If there is a
2109 * chance of a race with something else that might move the request
2110 * off the busy list, then we will have to lock against that
2111 * (eg. timeouts, etc.)
2112 */
2113static void
2114ciss_done(struct ciss_softc *sc, cr_qhead_t *qh)
2115{
2116    struct ciss_request	*cr;
2117    struct ciss_command	*cc;
2118    u_int32_t		tag, index;
2119
2120    debug_called(3);
2121
2122    /*
2123     * Loop quickly taking requests from the adapter and moving them
2124     * to the completed queue.
2125     */
2126    for (;;) {
2127	tag = CISS_TL_SIMPLE_FETCH_CMD(sc);
2128	if (tag == CISS_TL_SIMPLE_OPQ_EMPTY)
2129	    break;
2130	index = tag >> 2;
2131	debug(2, "completed command %d%s", index,
2132	      (tag & CISS_HDR_HOST_TAG_ERROR) ? " with error" : "");
2133	if (index >= sc->ciss_max_requests) {
2134	    ciss_printf(sc, "completed invalid request %d (0x%x)\n", index, tag);
2135	    continue;
2136	}
2137	cr = &(sc->ciss_request[index]);
2138	cc = cr->cr_cc;
2139	cc->header.host_tag = tag;	/* not updated by adapter */
2140	ciss_enqueue_complete(cr, qh);
2141    }
2142
2143}
2144
2145static void
2146ciss_perf_done(struct ciss_softc *sc, cr_qhead_t *qh)
2147{
2148    struct ciss_request	*cr;
2149    struct ciss_command	*cc;
2150    u_int32_t		tag, index;
2151
2152    debug_called(3);
2153
2154    /*
2155     * Loop quickly taking requests from the adapter and moving them
2156     * to the completed queue.
2157     */
2158    for (;;) {
2159	tag = sc->ciss_reply[sc->ciss_rqidx];
2160	if ((tag & CISS_CYCLE_MASK) != sc->ciss_cycle)
2161	    break;
2162	index = tag >> 2;
2163	debug(2, "completed command %d%s\n", index,
2164	      (tag & CISS_HDR_HOST_TAG_ERROR) ? " with error" : "");
2165	if (index < sc->ciss_max_requests) {
2166	    cr = &(sc->ciss_request[index]);
2167	    cc = cr->cr_cc;
2168	    cc->header.host_tag = tag;	/* not updated by adapter */
2169	    ciss_enqueue_complete(cr, qh);
2170	} else {
2171	    ciss_printf(sc, "completed invalid request %d (0x%x)\n", index, tag);
2172	}
2173	if (++sc->ciss_rqidx == sc->ciss_max_requests) {
2174	    sc->ciss_rqidx = 0;
2175	    sc->ciss_cycle ^= 1;
2176	}
2177    }
2178
2179}
2180
2181/************************************************************************
2182 * Take an interrupt from the adapter.
2183 */
2184static void
2185ciss_intr(void *arg)
2186{
2187    cr_qhead_t qh;
2188    struct ciss_softc	*sc = (struct ciss_softc *)arg;
2189
2190    /*
2191     * The only interrupt we recognise indicates that there are
2192     * entries in the outbound post queue.
2193     */
2194    STAILQ_INIT(&qh);
2195    ciss_done(sc, &qh);
2196    mtx_lock(&sc->ciss_mtx);
2197    ciss_complete(sc, &qh);
2198    mtx_unlock(&sc->ciss_mtx);
2199}
2200
2201static void
2202ciss_perf_intr(void *arg)
2203{
2204    struct ciss_softc	*sc = (struct ciss_softc *)arg;
2205
2206    /* Clear the interrupt and flush the bridges.  Docs say that the flush
2207     * needs to be done twice, which doesn't seem right.
2208     */
2209    CISS_TL_PERF_CLEAR_INT(sc);
2210    CISS_TL_PERF_FLUSH_INT(sc);
2211
2212    ciss_perf_msi_intr(sc);
2213}
2214
2215static void
2216ciss_perf_msi_intr(void *arg)
2217{
2218    cr_qhead_t qh;
2219    struct ciss_softc	*sc = (struct ciss_softc *)arg;
2220
2221    STAILQ_INIT(&qh);
2222    ciss_perf_done(sc, &qh);
2223    mtx_lock(&sc->ciss_mtx);
2224    ciss_complete(sc, &qh);
2225    mtx_unlock(&sc->ciss_mtx);
2226}
2227
2228/************************************************************************
2229 * Process completed requests.
2230 *
2231 * Requests can be completed in three fashions:
2232 *
2233 * - by invoking a callback function (cr_complete is non-null)
2234 * - by waking up a sleeper (cr_flags has CISS_REQ_SLEEP set)
2235 * - by clearing the CISS_REQ_POLL flag in interrupt/timeout context
2236 */
2237static void
2238ciss_complete(struct ciss_softc *sc, cr_qhead_t *qh)
2239{
2240    struct ciss_request	*cr;
2241
2242    debug_called(2);
2243
2244    /*
2245     * Loop taking requests off the completed queue and performing
2246     * completion processing on them.
2247     */
2248    for (;;) {
2249	if ((cr = ciss_dequeue_complete(sc, qh)) == NULL)
2250	    break;
2251	ciss_unmap_request(cr);
2252
2253	if ((cr->cr_flags & CISS_REQ_BUSY) == 0)
2254	    ciss_printf(sc, "WARNING: completing non-busy request\n");
2255	cr->cr_flags &= ~CISS_REQ_BUSY;
2256
2257	/*
2258	 * If the request has a callback, invoke it.
2259	 */
2260	if (cr->cr_complete != NULL) {
2261	    cr->cr_complete(cr);
2262	    continue;
2263	}
2264
2265	/*
2266	 * If someone is sleeping on this request, wake them up.
2267	 */
2268	if (cr->cr_flags & CISS_REQ_SLEEP) {
2269	    cr->cr_flags &= ~CISS_REQ_SLEEP;
2270	    wakeup(cr);
2271	    continue;
2272	}
2273
2274	/*
2275	 * If someone is polling this request for completion, signal.
2276	 */
2277	if (cr->cr_flags & CISS_REQ_POLL) {
2278	    cr->cr_flags &= ~CISS_REQ_POLL;
2279	    continue;
2280	}
2281
2282	/*
2283	 * Give up and throw the request back on the free queue.  This
2284	 * should never happen; resources will probably be lost.
2285	 */
2286	ciss_printf(sc, "WARNING: completed command with no submitter\n");
2287	ciss_enqueue_free(cr);
2288    }
2289}
2290
2291/************************************************************************
2292 * Report on the completion status of a request, and pass back SCSI
2293 * and command status values.
2294 */
2295static int
2296_ciss_report_request(struct ciss_request *cr, int *command_status, int *scsi_status, const char *func)
2297{
2298    struct ciss_command		*cc;
2299    struct ciss_error_info	*ce;
2300
2301    debug_called(2);
2302
2303    cc = cr->cr_cc;
2304    ce = (struct ciss_error_info *)&(cc->sg[0]);
2305
2306    /*
2307     * We don't consider data under/overrun an error for the Report
2308     * Logical/Physical LUNs commands.
2309     */
2310    if ((cc->header.host_tag & CISS_HDR_HOST_TAG_ERROR) &&
2311	((ce->command_status == CISS_CMD_STATUS_DATA_OVERRUN) ||
2312	 (ce->command_status == CISS_CMD_STATUS_DATA_UNDERRUN)) &&
2313	((cc->cdb.cdb[0] == CISS_OPCODE_REPORT_LOGICAL_LUNS) ||
2314	 (cc->cdb.cdb[0] == CISS_OPCODE_REPORT_PHYSICAL_LUNS) ||
2315	 (cc->cdb.cdb[0] == INQUIRY))) {
2316	cc->header.host_tag &= ~CISS_HDR_HOST_TAG_ERROR;
2317	debug(2, "ignoring irrelevant under/overrun error");
2318    }
2319
2320    /*
2321     * Check the command's error bit, if clear, there's no status and
2322     * everything is OK.
2323     */
2324    if (!(cc->header.host_tag & CISS_HDR_HOST_TAG_ERROR)) {
2325	if (scsi_status != NULL)
2326	    *scsi_status = SCSI_STATUS_OK;
2327	if (command_status != NULL)
2328	    *command_status = CISS_CMD_STATUS_SUCCESS;
2329	return(0);
2330    } else {
2331	if (command_status != NULL)
2332	    *command_status = ce->command_status;
2333	if (scsi_status != NULL) {
2334	    if (ce->command_status == CISS_CMD_STATUS_TARGET_STATUS) {
2335		*scsi_status = ce->scsi_status;
2336	    } else {
2337		*scsi_status = -1;
2338	    }
2339	}
2340	if (bootverbose)
2341	    ciss_printf(cr->cr_sc, "command status 0x%x (%s) scsi status 0x%x\n",
2342			ce->command_status, ciss_name_command_status(ce->command_status),
2343			ce->scsi_status);
2344	if (ce->command_status == CISS_CMD_STATUS_INVALID_COMMAND) {
2345	    ciss_printf(cr->cr_sc, "invalid command, offense size %d at %d, value 0x%x, function %s\n",
2346			ce->additional_error_info.invalid_command.offense_size,
2347			ce->additional_error_info.invalid_command.offense_offset,
2348			ce->additional_error_info.invalid_command.offense_value,
2349			func);
2350	}
2351    }
2352#if 0
2353    ciss_print_request(cr);
2354#endif
2355    return(1);
2356}
2357
2358/************************************************************************
2359 * Issue a request and don't return until it's completed.
2360 *
2361 * Depending on adapter status, we may poll or sleep waiting for
2362 * completion.
2363 */
2364static int
2365ciss_synch_request(struct ciss_request *cr, int timeout)
2366{
2367    if (cr->cr_sc->ciss_flags & CISS_FLAG_RUNNING) {
2368	return(ciss_wait_request(cr, timeout));
2369    } else {
2370	return(ciss_poll_request(cr, timeout));
2371    }
2372}
2373
2374/************************************************************************
2375 * Issue a request and poll for completion.
2376 *
2377 * Timeout in milliseconds.
2378 */
2379static int
2380ciss_poll_request(struct ciss_request *cr, int timeout)
2381{
2382    cr_qhead_t qh;
2383    struct ciss_softc *sc;
2384    int		error;
2385
2386    debug_called(2);
2387
2388    STAILQ_INIT(&qh);
2389    sc = cr->cr_sc;
2390    cr->cr_flags |= CISS_REQ_POLL;
2391    if ((error = ciss_start(cr)) != 0)
2392	return(error);
2393
2394    do {
2395	if (sc->ciss_perf)
2396	    ciss_perf_done(sc, &qh);
2397	else
2398	    ciss_done(sc, &qh);
2399	ciss_complete(sc, &qh);
2400	if (!(cr->cr_flags & CISS_REQ_POLL))
2401	    return(0);
2402	DELAY(1000);
2403    } while (timeout-- >= 0);
2404    return(EWOULDBLOCK);
2405}
2406
2407/************************************************************************
2408 * Issue a request and sleep waiting for completion.
2409 *
2410 * Timeout in milliseconds.  Note that a spurious wakeup will reset
2411 * the timeout.
2412 */
2413static int
2414ciss_wait_request(struct ciss_request *cr, int timeout)
2415{
2416    int		error;
2417
2418    debug_called(2);
2419
2420    cr->cr_flags |= CISS_REQ_SLEEP;
2421    if ((error = ciss_start(cr)) != 0)
2422	return(error);
2423
2424    while ((cr->cr_flags & CISS_REQ_SLEEP) && (error != EWOULDBLOCK)) {
2425	error = msleep_sbt(cr, &cr->cr_sc->ciss_mtx, PRIBIO, "cissREQ",
2426	    SBT_1MS * timeout, 0, 0);
2427    }
2428    return(error);
2429}
2430
2431#if 0
2432/************************************************************************
2433 * Abort a request.  Note that a potential exists here to race the
2434 * request being completed; the caller must deal with this.
2435 */
2436static int
2437ciss_abort_request(struct ciss_request *ar)
2438{
2439    struct ciss_request		*cr;
2440    struct ciss_command		*cc;
2441    struct ciss_message_cdb	*cmc;
2442    int				error;
2443
2444    debug_called(1);
2445
2446    /* get a request */
2447    if ((error = ciss_get_request(ar->cr_sc, &cr)) != 0)
2448	return(error);
2449
2450    /* build the abort command */
2451    cc = cr->cr_cc;
2452    cc->header.address.mode.mode = CISS_HDR_ADDRESS_MODE_PERIPHERAL;	/* addressing? */
2453    cc->header.address.physical.target = 0;
2454    cc->header.address.physical.bus = 0;
2455    cc->cdb.cdb_length = sizeof(*cmc);
2456    cc->cdb.type = CISS_CDB_TYPE_MESSAGE;
2457    cc->cdb.attribute = CISS_CDB_ATTRIBUTE_SIMPLE;
2458    cc->cdb.direction = CISS_CDB_DIRECTION_NONE;
2459    cc->cdb.timeout = 30;
2460
2461    cmc = (struct ciss_message_cdb *)&(cc->cdb.cdb[0]);
2462    cmc->opcode = CISS_OPCODE_MESSAGE_ABORT;
2463    cmc->type = CISS_MESSAGE_ABORT_TASK;
2464    cmc->abort_tag = ar->cr_tag;	/* endianness?? */
2465
2466    /*
2467     * Send the request and wait for a response.  If we believe we
2468     * aborted the request OK, clear the flag that indicates it's
2469     * running.
2470     */
2471    error = ciss_synch_request(cr, 35 * 1000);
2472    if (!error)
2473	error = ciss_report_request(cr, NULL, NULL);
2474    ciss_release_request(cr);
2475
2476    return(error);
2477}
2478#endif
2479
2480/************************************************************************
2481 * Fetch and initialise a request
2482 */
2483static int
2484ciss_get_request(struct ciss_softc *sc, struct ciss_request **crp)
2485{
2486    struct ciss_request *cr;
2487
2488    debug_called(2);
2489
2490    /*
2491     * Get a request and clean it up.
2492     */
2493    if ((cr = ciss_dequeue_free(sc)) == NULL)
2494	return(ENOMEM);
2495
2496    cr->cr_data = NULL;
2497    cr->cr_flags = 0;
2498    cr->cr_complete = NULL;
2499    cr->cr_private = NULL;
2500    cr->cr_sg_tag = CISS_SG_MAX;	/* Backstop to prevent accidents */
2501
2502    ciss_preen_command(cr);
2503    *crp = cr;
2504    return(0);
2505}
2506
2507static void
2508ciss_preen_command(struct ciss_request *cr)
2509{
2510    struct ciss_command	*cc;
2511    u_int32_t		cmdphys;
2512
2513    /*
2514     * Clean up the command structure.
2515     *
2516     * Note that we set up the error_info structure here, since the
2517     * length can be overwritten by any command.
2518     */
2519    cc = cr->cr_cc;
2520    cc->header.sg_in_list = 0;		/* kinda inefficient this way */
2521    cc->header.sg_total = 0;
2522    cc->header.host_tag = cr->cr_tag << 2;
2523    cc->header.host_tag_zeroes = 0;
2524    bzero(&(cc->sg[0]), CISS_COMMAND_ALLOC_SIZE - sizeof(struct ciss_command));
2525    cmdphys = cr->cr_ccphys;
2526    cc->error_info.error_info_address = cmdphys + sizeof(struct ciss_command);
2527    cc->error_info.error_info_length = CISS_COMMAND_ALLOC_SIZE - sizeof(struct ciss_command);
2528}
2529
2530/************************************************************************
2531 * Release a request to the free list.
2532 */
2533static void
2534ciss_release_request(struct ciss_request *cr)
2535{
2536    struct ciss_softc	*sc;
2537
2538    debug_called(2);
2539
2540    sc = cr->cr_sc;
2541
2542    /* release the request to the free queue */
2543    ciss_requeue_free(cr);
2544}
2545
2546/************************************************************************
2547 * Allocate a request that will be used to send a BMIC command.  Do some
2548 * of the common setup here to avoid duplicating it everywhere else.
2549 */
2550static int
2551ciss_get_bmic_request(struct ciss_softc *sc, struct ciss_request **crp,
2552		      int opcode, void **bufp, size_t bufsize)
2553{
2554    struct ciss_request		*cr;
2555    struct ciss_command		*cc;
2556    struct ciss_bmic_cdb	*cbc;
2557    void			*buf;
2558    int				error;
2559    int				dataout;
2560
2561    debug_called(2);
2562
2563    cr = NULL;
2564    buf = NULL;
2565
2566    /*
2567     * Get a request.
2568     */
2569    if ((error = ciss_get_request(sc, &cr)) != 0)
2570	goto out;
2571
2572    /*
2573     * Allocate data storage if requested, determine the data direction.
2574     */
2575    dataout = 0;
2576    if ((bufsize > 0) && (bufp != NULL)) {
2577	if (*bufp == NULL) {
2578	    if ((buf = malloc(bufsize, CISS_MALLOC_CLASS, M_NOWAIT | M_ZERO)) == NULL) {
2579		error = ENOMEM;
2580		goto out;
2581	    }
2582	} else {
2583	    buf = *bufp;
2584	    dataout = 1;	/* we are given a buffer, so we are writing */
2585	}
2586    }
2587
2588    /*
2589     * Build a CISS BMIC command to get the logical drive ID.
2590     */
2591    cr->cr_data = buf;
2592    cr->cr_length = bufsize;
2593    if (!dataout)
2594	cr->cr_flags = CISS_REQ_DATAIN;
2595
2596    cc = cr->cr_cc;
2597    cc->header.address.physical.mode = CISS_HDR_ADDRESS_MODE_PERIPHERAL;
2598    cc->header.address.physical.bus = 0;
2599    cc->header.address.physical.target = 0;
2600    cc->cdb.cdb_length = sizeof(*cbc);
2601    cc->cdb.type = CISS_CDB_TYPE_COMMAND;
2602    cc->cdb.attribute = CISS_CDB_ATTRIBUTE_SIMPLE;
2603    cc->cdb.direction = dataout ? CISS_CDB_DIRECTION_WRITE : CISS_CDB_DIRECTION_READ;
2604    cc->cdb.timeout = 0;
2605
2606    cbc = (struct ciss_bmic_cdb *)&(cc->cdb.cdb[0]);
2607    bzero(cbc, sizeof(*cbc));
2608    cbc->opcode = dataout ? CISS_ARRAY_CONTROLLER_WRITE : CISS_ARRAY_CONTROLLER_READ;
2609    cbc->bmic_opcode = opcode;
2610    cbc->size = htons((u_int16_t)bufsize);
2611
2612out:
2613    if (error) {
2614	if (cr != NULL)
2615	    ciss_release_request(cr);
2616    } else {
2617	*crp = cr;
2618	if ((bufp != NULL) && (*bufp == NULL) && (buf != NULL))
2619	    *bufp = buf;
2620    }
2621    return(error);
2622}
2623
2624/************************************************************************
2625 * Handle a command passed in from userspace.
2626 */
2627static int
2628ciss_user_command(struct ciss_softc *sc, IOCTL_Command_struct *ioc)
2629{
2630    struct ciss_request		*cr;
2631    struct ciss_command		*cc;
2632    struct ciss_error_info	*ce;
2633    int				error = 0;
2634
2635    debug_called(1);
2636
2637    cr = NULL;
2638
2639    /*
2640     * Get a request.
2641     */
2642    while (ciss_get_request(sc, &cr) != 0)
2643	msleep(sc, &sc->ciss_mtx, PPAUSE, "cissREQ", hz);
2644    cc = cr->cr_cc;
2645
2646    /*
2647     * Allocate an in-kernel databuffer if required, copy in user data.
2648     */
2649    mtx_unlock(&sc->ciss_mtx);
2650    cr->cr_length = ioc->buf_size;
2651    if (ioc->buf_size > 0) {
2652	if ((cr->cr_data = malloc(ioc->buf_size, CISS_MALLOC_CLASS, M_NOWAIT)) == NULL) {
2653	    error = ENOMEM;
2654	    goto out_unlocked;
2655	}
2656	if ((error = copyin(ioc->buf, cr->cr_data, ioc->buf_size))) {
2657	    debug(0, "copyin: bad data buffer %p/%d", ioc->buf, ioc->buf_size);
2658	    goto out_unlocked;
2659	}
2660    }
2661
2662    /*
2663     * Build the request based on the user command.
2664     */
2665    bcopy(&ioc->LUN_info, &cc->header.address, sizeof(cc->header.address));
2666    bcopy(&ioc->Request, &cc->cdb, sizeof(cc->cdb));
2667
2668    /* XXX anything else to populate here? */
2669    mtx_lock(&sc->ciss_mtx);
2670
2671    /*
2672     * Run the command.
2673     */
2674    if ((error = ciss_synch_request(cr, 60 * 1000))) {
2675	debug(0, "request failed - %d", error);
2676	goto out;
2677    }
2678
2679    /*
2680     * Check to see if the command succeeded.
2681     */
2682    ce = (struct ciss_error_info *)&(cc->sg[0]);
2683    if ((cc->header.host_tag & CISS_HDR_HOST_TAG_ERROR) == 0)
2684	bzero(ce, sizeof(*ce));
2685
2686    /*
2687     * Copy the results back to the user.
2688     */
2689    bcopy(ce, &ioc->error_info, sizeof(*ce));
2690    mtx_unlock(&sc->ciss_mtx);
2691    if ((ioc->buf_size > 0) &&
2692	(error = copyout(cr->cr_data, ioc->buf, ioc->buf_size))) {
2693	debug(0, "copyout: bad data buffer %p/%d", ioc->buf, ioc->buf_size);
2694	goto out_unlocked;
2695    }
2696
2697    /* done OK */
2698    error = 0;
2699
2700out_unlocked:
2701    mtx_lock(&sc->ciss_mtx);
2702
2703out:
2704    if ((cr != NULL) && (cr->cr_data != NULL))
2705	free(cr->cr_data, CISS_MALLOC_CLASS);
2706    if (cr != NULL)
2707	ciss_release_request(cr);
2708    return(error);
2709}
2710
2711/************************************************************************
2712 * Map a request into bus-visible space, initialise the scatter/gather
2713 * list.
2714 */
2715static int
2716ciss_map_request(struct ciss_request *cr)
2717{
2718    struct ciss_softc	*sc;
2719    int			error = 0;
2720
2721    debug_called(2);
2722
2723    sc = cr->cr_sc;
2724
2725    /* check that mapping is necessary */
2726    if (cr->cr_flags & CISS_REQ_MAPPED)
2727	return(0);
2728
2729    cr->cr_flags |= CISS_REQ_MAPPED;
2730
2731    bus_dmamap_sync(sc->ciss_command_dmat, sc->ciss_command_map,
2732		    BUS_DMASYNC_PREWRITE);
2733
2734    if (cr->cr_data != NULL) {
2735	if (cr->cr_flags & CISS_REQ_CCB)
2736		error = bus_dmamap_load_ccb(sc->ciss_buffer_dmat,
2737					cr->cr_datamap, cr->cr_data,
2738					ciss_request_map_helper, cr, 0);
2739	else
2740		error = bus_dmamap_load(sc->ciss_buffer_dmat, cr->cr_datamap,
2741					cr->cr_data, cr->cr_length,
2742					ciss_request_map_helper, cr, 0);
2743	if (error != 0)
2744	    return (error);
2745    } else {
2746	/*
2747	 * Post the command to the adapter.
2748	 */
2749	cr->cr_sg_tag = CISS_SG_NONE;
2750	cr->cr_flags |= CISS_REQ_BUSY;
2751	if (sc->ciss_perf)
2752	    CISS_TL_PERF_POST_CMD(sc, cr);
2753	else
2754	    CISS_TL_SIMPLE_POST_CMD(sc, cr->cr_ccphys);
2755    }
2756
2757    return(0);
2758}
2759
2760static void
2761ciss_request_map_helper(void *arg, bus_dma_segment_t *segs, int nseg, int error)
2762{
2763    struct ciss_command	*cc;
2764    struct ciss_request *cr;
2765    struct ciss_softc	*sc;
2766    int			i;
2767
2768    debug_called(2);
2769
2770    cr = (struct ciss_request *)arg;
2771    sc = cr->cr_sc;
2772    cc = cr->cr_cc;
2773
2774    for (i = 0; i < nseg; i++) {
2775	cc->sg[i].address = segs[i].ds_addr;
2776	cc->sg[i].length = segs[i].ds_len;
2777	cc->sg[i].extension = 0;
2778    }
2779    /* we leave the s/g table entirely within the command */
2780    cc->header.sg_in_list = nseg;
2781    cc->header.sg_total = nseg;
2782
2783    if (cr->cr_flags & CISS_REQ_DATAIN)
2784	bus_dmamap_sync(sc->ciss_buffer_dmat, cr->cr_datamap, BUS_DMASYNC_PREREAD);
2785    if (cr->cr_flags & CISS_REQ_DATAOUT)
2786	bus_dmamap_sync(sc->ciss_buffer_dmat, cr->cr_datamap, BUS_DMASYNC_PREWRITE);
2787
2788    if (nseg == 0)
2789	cr->cr_sg_tag = CISS_SG_NONE;
2790    else if (nseg == 1)
2791	cr->cr_sg_tag = CISS_SG_1;
2792    else if (nseg == 2)
2793	cr->cr_sg_tag = CISS_SG_2;
2794    else if (nseg <= 4)
2795	cr->cr_sg_tag = CISS_SG_4;
2796    else if (nseg <= 8)
2797	cr->cr_sg_tag = CISS_SG_8;
2798    else if (nseg <= 16)
2799	cr->cr_sg_tag = CISS_SG_16;
2800    else if (nseg <= 32)
2801	cr->cr_sg_tag = CISS_SG_32;
2802    else
2803	cr->cr_sg_tag = CISS_SG_MAX;
2804
2805    /*
2806     * Post the command to the adapter.
2807     */
2808    cr->cr_flags |= CISS_REQ_BUSY;
2809    if (sc->ciss_perf)
2810	CISS_TL_PERF_POST_CMD(sc, cr);
2811    else
2812	CISS_TL_SIMPLE_POST_CMD(sc, cr->cr_ccphys);
2813}
2814
2815/************************************************************************
2816 * Unmap a request from bus-visible space.
2817 */
2818static void
2819ciss_unmap_request(struct ciss_request *cr)
2820{
2821    struct ciss_softc	*sc;
2822
2823    debug_called(2);
2824
2825    sc = cr->cr_sc;
2826
2827    /* check that unmapping is necessary */
2828    if ((cr->cr_flags & CISS_REQ_MAPPED) == 0)
2829	return;
2830
2831    bus_dmamap_sync(sc->ciss_command_dmat, sc->ciss_command_map,
2832		    BUS_DMASYNC_POSTWRITE);
2833
2834    if (cr->cr_data == NULL)
2835	goto out;
2836
2837    if (cr->cr_flags & CISS_REQ_DATAIN)
2838	bus_dmamap_sync(sc->ciss_buffer_dmat, cr->cr_datamap, BUS_DMASYNC_POSTREAD);
2839    if (cr->cr_flags & CISS_REQ_DATAOUT)
2840	bus_dmamap_sync(sc->ciss_buffer_dmat, cr->cr_datamap, BUS_DMASYNC_POSTWRITE);
2841
2842    bus_dmamap_unload(sc->ciss_buffer_dmat, cr->cr_datamap);
2843out:
2844    cr->cr_flags &= ~CISS_REQ_MAPPED;
2845}
2846
2847/************************************************************************
2848 * Attach the driver to CAM.
2849 *
2850 * We put all the logical drives on a single SCSI bus.
2851 */
2852static int
2853ciss_cam_init(struct ciss_softc *sc)
2854{
2855    int			i, maxbus;
2856
2857    debug_called(1);
2858
2859    /*
2860     * Allocate a devq.  We can reuse this for the masked physical
2861     * devices if we decide to export these as well.
2862     */
2863    if ((sc->ciss_cam_devq = cam_simq_alloc(sc->ciss_max_requests - 2)) == NULL) {
2864	ciss_printf(sc, "can't allocate CAM SIM queue\n");
2865	return(ENOMEM);
2866    }
2867
2868    /*
2869     * Create a SIM.
2870     *
2871     * This naturally wastes a bit of memory.  The alternative is to allocate
2872     * and register each bus as it is found, and then track them on a linked
2873     * list.  Unfortunately, the driver has a few places where it needs to
2874     * look up the SIM based solely on bus number, and it's unclear whether
2875     * a list traversal would work for these situations.
2876     */
2877    maxbus = max(sc->ciss_max_logical_bus, sc->ciss_max_physical_bus +
2878		 CISS_PHYSICAL_BASE);
2879    sc->ciss_cam_sim = malloc(maxbus * sizeof(struct cam_sim*),
2880			      CISS_MALLOC_CLASS, M_NOWAIT | M_ZERO);
2881    if (sc->ciss_cam_sim == NULL) {
2882	ciss_printf(sc, "can't allocate memory for controller SIM\n");
2883	return(ENOMEM);
2884    }
2885
2886    for (i = 0; i < sc->ciss_max_logical_bus; i++) {
2887	if ((sc->ciss_cam_sim[i] = cam_sim_alloc(ciss_cam_action, ciss_cam_poll,
2888						 "ciss", sc,
2889						 device_get_unit(sc->ciss_dev),
2890						 &sc->ciss_mtx,
2891						 2,
2892						 sc->ciss_max_requests - 2,
2893						 sc->ciss_cam_devq)) == NULL) {
2894	    ciss_printf(sc, "can't allocate CAM SIM for controller %d\n", i);
2895	    return(ENOMEM);
2896	}
2897
2898	/*
2899	 * Register bus with this SIM.
2900	 */
2901	mtx_lock(&sc->ciss_mtx);
2902	if (i == 0 || sc->ciss_controllers[i].physical.bus != 0) {
2903	    if (xpt_bus_register(sc->ciss_cam_sim[i], sc->ciss_dev, i) != 0) {
2904		ciss_printf(sc, "can't register SCSI bus %d\n", i);
2905		mtx_unlock(&sc->ciss_mtx);
2906		return (ENXIO);
2907	    }
2908	}
2909	mtx_unlock(&sc->ciss_mtx);
2910    }
2911
2912    for (i = CISS_PHYSICAL_BASE; i < sc->ciss_max_physical_bus +
2913	 CISS_PHYSICAL_BASE; i++) {
2914	if ((sc->ciss_cam_sim[i] = cam_sim_alloc(ciss_cam_action, ciss_cam_poll,
2915						 "ciss", sc,
2916						 device_get_unit(sc->ciss_dev),
2917						 &sc->ciss_mtx, 1,
2918						 sc->ciss_max_requests - 2,
2919						 sc->ciss_cam_devq)) == NULL) {
2920	    ciss_printf(sc, "can't allocate CAM SIM for controller %d\n", i);
2921	    return (ENOMEM);
2922	}
2923
2924	mtx_lock(&sc->ciss_mtx);
2925	if (xpt_bus_register(sc->ciss_cam_sim[i], sc->ciss_dev, i) != 0) {
2926	    ciss_printf(sc, "can't register SCSI bus %d\n", i);
2927	    mtx_unlock(&sc->ciss_mtx);
2928	    return (ENXIO);
2929	}
2930	mtx_unlock(&sc->ciss_mtx);
2931    }
2932
2933    return(0);
2934}
2935
2936/************************************************************************
2937 * Initiate a rescan of the 'logical devices' SIM
2938 */
2939static void
2940ciss_cam_rescan_target(struct ciss_softc *sc, int bus, int target)
2941{
2942    union ccb		*ccb;
2943
2944    debug_called(1);
2945
2946    if ((ccb = xpt_alloc_ccb_nowait()) == NULL) {
2947	ciss_printf(sc, "rescan failed (can't allocate CCB)\n");
2948	return;
2949    }
2950
2951    if (xpt_create_path(&ccb->ccb_h.path, NULL,
2952	    cam_sim_path(sc->ciss_cam_sim[bus]),
2953	    target, CAM_LUN_WILDCARD) != CAM_REQ_CMP) {
2954	ciss_printf(sc, "rescan failed (can't create path)\n");
2955	xpt_free_ccb(ccb);
2956	return;
2957    }
2958    xpt_rescan(ccb);
2959    /* scan is now in progress */
2960}
2961
2962/************************************************************************
2963 * Handle requests coming from CAM
2964 */
2965static void
2966ciss_cam_action(struct cam_sim *sim, union ccb *ccb)
2967{
2968    struct ciss_softc	*sc;
2969    struct ccb_scsiio	*csio;
2970    int			bus, target;
2971    int			physical;
2972
2973    sc = cam_sim_softc(sim);
2974    bus = cam_sim_bus(sim);
2975    csio = (struct ccb_scsiio *)&ccb->csio;
2976    target = csio->ccb_h.target_id;
2977    physical = CISS_IS_PHYSICAL(bus);
2978
2979    switch (ccb->ccb_h.func_code) {
2980	/* perform SCSI I/O */
2981    case XPT_SCSI_IO:
2982	if (!ciss_cam_action_io(sim, csio))
2983	    return;
2984	break;
2985
2986	/* perform geometry calculations */
2987    case XPT_CALC_GEOMETRY:
2988    {
2989	struct ccb_calc_geometry	*ccg = &ccb->ccg;
2990	struct ciss_ldrive		*ld;
2991
2992	debug(1, "XPT_CALC_GEOMETRY %d:%d:%d", cam_sim_bus(sim), ccb->ccb_h.target_id, ccb->ccb_h.target_lun);
2993
2994	ld = NULL;
2995	if (!physical)
2996	    ld = &sc->ciss_logical[bus][target];
2997
2998	/*
2999	 * Use the cached geometry settings unless the fault tolerance
3000	 * is invalid.
3001	 */
3002	if (physical || ld->cl_geometry.fault_tolerance == 0xFF) {
3003	    u_int32_t			secs_per_cylinder;
3004
3005	    ccg->heads = 255;
3006	    ccg->secs_per_track = 32;
3007	    secs_per_cylinder = ccg->heads * ccg->secs_per_track;
3008	    ccg->cylinders = ccg->volume_size / secs_per_cylinder;
3009	} else {
3010	    ccg->heads = ld->cl_geometry.heads;
3011	    ccg->secs_per_track = ld->cl_geometry.sectors;
3012	    ccg->cylinders = ntohs(ld->cl_geometry.cylinders);
3013	}
3014	ccb->ccb_h.status = CAM_REQ_CMP;
3015        break;
3016    }
3017
3018	/* handle path attribute inquiry */
3019    case XPT_PATH_INQ:
3020    {
3021	struct ccb_pathinq	*cpi = &ccb->cpi;
3022	int			sg_length;
3023
3024	debug(1, "XPT_PATH_INQ %d:%d:%d", cam_sim_bus(sim), ccb->ccb_h.target_id, ccb->ccb_h.target_lun);
3025
3026	cpi->version_num = 1;
3027	cpi->hba_inquiry = PI_TAG_ABLE;	/* XXX is this correct? */
3028	cpi->target_sprt = 0;
3029	cpi->hba_misc = 0;
3030	cpi->max_target = sc->ciss_cfg->max_logical_supported;
3031	cpi->max_lun = 0;		/* 'logical drive' channel only */
3032	cpi->initiator_id = sc->ciss_cfg->max_logical_supported;
3033	strlcpy(cpi->sim_vid, "FreeBSD", SIM_IDLEN);
3034	strlcpy(cpi->hba_vid, "CISS", HBA_IDLEN);
3035	strlcpy(cpi->dev_name, cam_sim_name(sim), DEV_IDLEN);
3036	cpi->unit_number = cam_sim_unit(sim);
3037	cpi->bus_id = cam_sim_bus(sim);
3038	cpi->base_transfer_speed = 132 * 1024;	/* XXX what to set this to? */
3039	cpi->transport = XPORT_SPI;
3040	cpi->transport_version = 2;
3041	cpi->protocol = PROTO_SCSI;
3042	cpi->protocol_version = SCSI_REV_2;
3043	if (sc->ciss_cfg->max_sg_length == 0) {
3044		sg_length = 17;
3045	} else {
3046	/* XXX Fix for ZMR cards that advertise max_sg_length == 32
3047	 * Confusing bit here. max_sg_length is usually a power of 2. We always
3048	 * need to subtract 1 to account for partial pages. Then we need to
3049	 * align on a valid PAGE_SIZE so we round down to the nearest power of 2.
3050	 * Add 1 so we can then subtract it out in the assignment to maxio.
3051	 * The reason for all these shenanigans is to create a maxio value that
3052	 * creates IO operations to volumes that yield consistent operations
3053	 * with good performance.
3054	 */
3055		sg_length = sc->ciss_cfg->max_sg_length - 1;
3056		sg_length = (1 << (fls(sg_length) - 1)) + 1;
3057	}
3058	cpi->maxio = (min(CISS_MAX_SG_ELEMENTS, sg_length) - 1) * PAGE_SIZE;
3059	ccb->ccb_h.status = CAM_REQ_CMP;
3060	break;
3061    }
3062
3063    case XPT_GET_TRAN_SETTINGS:
3064    {
3065	struct ccb_trans_settings	*cts = &ccb->cts;
3066	int				bus, target;
3067	struct ccb_trans_settings_spi *spi = &cts->xport_specific.spi;
3068	struct ccb_trans_settings_scsi *scsi = &cts->proto_specific.scsi;
3069
3070	bus = cam_sim_bus(sim);
3071	target = cts->ccb_h.target_id;
3072
3073	debug(1, "XPT_GET_TRAN_SETTINGS %d:%d", bus, target);
3074	/* disconnect always OK */
3075	cts->protocol = PROTO_SCSI;
3076	cts->protocol_version = SCSI_REV_2;
3077	cts->transport = XPORT_SPI;
3078	cts->transport_version = 2;
3079
3080	spi->valid = CTS_SPI_VALID_DISC;
3081	spi->flags = CTS_SPI_FLAGS_DISC_ENB;
3082
3083	scsi->valid = CTS_SCSI_VALID_TQ;
3084	scsi->flags = CTS_SCSI_FLAGS_TAG_ENB;
3085
3086	cts->ccb_h.status = CAM_REQ_CMP;
3087	break;
3088    }
3089
3090    default:		/* we can't do this */
3091	debug(1, "unspported func_code = 0x%x", ccb->ccb_h.func_code);
3092	ccb->ccb_h.status = CAM_REQ_INVALID;
3093	break;
3094    }
3095
3096    xpt_done(ccb);
3097}
3098
3099/************************************************************************
3100 * Handle a CAM SCSI I/O request.
3101 */
3102static int
3103ciss_cam_action_io(struct cam_sim *sim, struct ccb_scsiio *csio)
3104{
3105    struct ciss_softc	*sc;
3106    int			bus, target;
3107    struct ciss_request	*cr;
3108    struct ciss_command	*cc;
3109    int			error;
3110
3111    sc = cam_sim_softc(sim);
3112    bus = cam_sim_bus(sim);
3113    target = csio->ccb_h.target_id;
3114
3115    debug(2, "XPT_SCSI_IO %d:%d:%d", bus, target, csio->ccb_h.target_lun);
3116
3117    /* check that the CDB pointer is not to a physical address */
3118    if ((csio->ccb_h.flags & CAM_CDB_POINTER) && (csio->ccb_h.flags & CAM_CDB_PHYS)) {
3119	debug(3, "  CDB pointer is to physical address");
3120	csio->ccb_h.status = CAM_REQ_CMP_ERR;
3121    }
3122
3123    /* abandon aborted ccbs or those that have failed validation */
3124    if ((csio->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_INPROG) {
3125	debug(3, "abandoning CCB due to abort/validation failure");
3126	return(EINVAL);
3127    }
3128
3129    /* handle emulation of some SCSI commands ourself */
3130    if (ciss_cam_emulate(sc, csio))
3131	return(0);
3132
3133    /*
3134     * Get a request to manage this command.  If we can't, return the
3135     * ccb, freeze the queue and flag so that we unfreeze it when a
3136     * request completes.
3137     */
3138    if ((error = ciss_get_request(sc, &cr)) != 0) {
3139	xpt_freeze_simq(sim, 1);
3140	sc->ciss_flags |= CISS_FLAG_BUSY;
3141	csio->ccb_h.status |= CAM_REQUEUE_REQ;
3142	return(error);
3143    }
3144
3145    /*
3146     * Build the command.
3147     */
3148    cc = cr->cr_cc;
3149    cr->cr_data = csio;
3150    cr->cr_length = csio->dxfer_len;
3151    cr->cr_complete = ciss_cam_complete;
3152    cr->cr_private = csio;
3153
3154    /*
3155     * Target the right logical volume.
3156     */
3157    if (CISS_IS_PHYSICAL(bus))
3158	cc->header.address =
3159	    sc->ciss_physical[CISS_CAM_TO_PBUS(bus)][target].cp_address;
3160    else
3161	cc->header.address =
3162	    sc->ciss_logical[bus][target].cl_address;
3163    cc->cdb.cdb_length = csio->cdb_len;
3164    cc->cdb.type = CISS_CDB_TYPE_COMMAND;
3165    cc->cdb.attribute = CISS_CDB_ATTRIBUTE_SIMPLE;	/* XXX ordered tags? */
3166    if ((csio->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_OUT) {
3167	cr->cr_flags = CISS_REQ_DATAOUT | CISS_REQ_CCB;
3168	cc->cdb.direction = CISS_CDB_DIRECTION_WRITE;
3169    } else if ((csio->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_IN) {
3170	cr->cr_flags = CISS_REQ_DATAIN | CISS_REQ_CCB;
3171	cc->cdb.direction = CISS_CDB_DIRECTION_READ;
3172    } else {
3173	cr->cr_data = NULL;
3174	cr->cr_flags = 0;
3175	cc->cdb.direction = CISS_CDB_DIRECTION_NONE;
3176    }
3177    cc->cdb.timeout = (csio->ccb_h.timeout / 1000) + 1;
3178    if (csio->ccb_h.flags & CAM_CDB_POINTER) {
3179	bcopy(csio->cdb_io.cdb_ptr, &cc->cdb.cdb[0], csio->cdb_len);
3180    } else {
3181	bcopy(csio->cdb_io.cdb_bytes, &cc->cdb.cdb[0], csio->cdb_len);
3182    }
3183
3184    /*
3185     * Submit the request to the adapter.
3186     *
3187     * Note that this may fail if we're unable to map the request (and
3188     * if we ever learn a transport layer other than simple, may fail
3189     * if the adapter rejects the command).
3190     */
3191    if ((error = ciss_start(cr)) != 0) {
3192	xpt_freeze_simq(sim, 1);
3193	csio->ccb_h.status |= CAM_RELEASE_SIMQ;
3194	if (error == EINPROGRESS) {
3195	    error = 0;
3196	} else {
3197	    csio->ccb_h.status |= CAM_REQUEUE_REQ;
3198	    ciss_release_request(cr);
3199	}
3200	return(error);
3201    }
3202
3203    return(0);
3204}
3205
3206/************************************************************************
3207 * Emulate SCSI commands the adapter doesn't handle as we might like.
3208 */
3209static int
3210ciss_cam_emulate(struct ciss_softc *sc, struct ccb_scsiio *csio)
3211{
3212    int		bus, target;
3213    u_int8_t	opcode;
3214
3215    target = csio->ccb_h.target_id;
3216    bus = cam_sim_bus(xpt_path_sim(csio->ccb_h.path));
3217    opcode = (csio->ccb_h.flags & CAM_CDB_POINTER) ?
3218	*(u_int8_t *)csio->cdb_io.cdb_ptr : csio->cdb_io.cdb_bytes[0];
3219
3220    if (CISS_IS_PHYSICAL(bus)) {
3221	if (sc->ciss_physical[CISS_CAM_TO_PBUS(bus)][target].cp_online != 1) {
3222	    csio->ccb_h.status |= CAM_SEL_TIMEOUT;
3223	    xpt_done((union ccb *)csio);
3224	    return(1);
3225	} else
3226	    return(0);
3227    }
3228
3229    /*
3230     * Handle requests for volumes that don't exist or are not online.
3231     * A selection timeout is slightly better than an illegal request.
3232     * Other errors might be better.
3233     */
3234    if (sc->ciss_logical[bus][target].cl_status != CISS_LD_ONLINE) {
3235	csio->ccb_h.status |= CAM_SEL_TIMEOUT;
3236	xpt_done((union ccb *)csio);
3237	return(1);
3238    }
3239
3240    /* if we have to fake Synchronise Cache */
3241    if (sc->ciss_flags & CISS_FLAG_FAKE_SYNCH) {
3242	/*
3243	 * If this is a Synchronise Cache command, typically issued when
3244	 * a device is closed, flush the adapter and complete now.
3245	 */
3246	if (((csio->ccb_h.flags & CAM_CDB_POINTER) ?
3247	     *(u_int8_t *)csio->cdb_io.cdb_ptr : csio->cdb_io.cdb_bytes[0]) == SYNCHRONIZE_CACHE) {
3248	    ciss_flush_adapter(sc);
3249	    csio->ccb_h.status |= CAM_REQ_CMP;
3250	    xpt_done((union ccb *)csio);
3251	    return(1);
3252	}
3253    }
3254
3255    /*
3256     * A CISS target can only ever have one lun per target. REPORT_LUNS requires
3257     * at least one LUN field to be pre created for us, so snag it and fill in
3258     * the least significant byte indicating 1 LUN here.  Emulate the command
3259     * return to shut up warning on console of a CDB error.  swb
3260     */
3261    if (opcode == REPORT_LUNS && csio->dxfer_len > 0) {
3262       csio->data_ptr[3] = 8;
3263       csio->ccb_h.status |= CAM_REQ_CMP;
3264       xpt_done((union ccb *)csio);
3265       return(1);
3266    }
3267
3268    return(0);
3269}
3270
3271/************************************************************************
3272 * Check for possibly-completed commands.
3273 */
3274static void
3275ciss_cam_poll(struct cam_sim *sim)
3276{
3277    cr_qhead_t qh;
3278    struct ciss_softc	*sc = cam_sim_softc(sim);
3279
3280    debug_called(2);
3281
3282    STAILQ_INIT(&qh);
3283    if (sc->ciss_perf)
3284	ciss_perf_done(sc, &qh);
3285    else
3286	ciss_done(sc, &qh);
3287    ciss_complete(sc, &qh);
3288}
3289
3290/************************************************************************
3291 * Handle completion of a command - pass results back through the CCB
3292 */
3293static void
3294ciss_cam_complete(struct ciss_request *cr)
3295{
3296    struct ciss_softc		*sc;
3297    struct ciss_command		*cc;
3298    struct ciss_error_info	*ce;
3299    struct ccb_scsiio		*csio;
3300    int				scsi_status;
3301    int				command_status;
3302
3303    debug_called(2);
3304
3305    sc = cr->cr_sc;
3306    cc = cr->cr_cc;
3307    ce = (struct ciss_error_info *)&(cc->sg[0]);
3308    csio = (struct ccb_scsiio *)cr->cr_private;
3309
3310    /*
3311     * Extract status values from request.
3312     */
3313    ciss_report_request(cr, &command_status, &scsi_status);
3314    csio->scsi_status = scsi_status;
3315
3316    /*
3317     * Handle specific SCSI status values.
3318     */
3319    switch(scsi_status) {
3320	/* no status due to adapter error */
3321    case -1:
3322	debug(0, "adapter error");
3323	csio->ccb_h.status |= CAM_REQ_CMP_ERR;
3324	break;
3325
3326	/* no status due to command completed OK */
3327    case SCSI_STATUS_OK:		/* CISS_SCSI_STATUS_GOOD */
3328	debug(2, "SCSI_STATUS_OK");
3329	csio->ccb_h.status |= CAM_REQ_CMP;
3330	break;
3331
3332	/* check condition, sense data included */
3333    case SCSI_STATUS_CHECK_COND:	/* CISS_SCSI_STATUS_CHECK_CONDITION */
3334	debug(0, "SCSI_STATUS_CHECK_COND  sense size %d  resid %d\n",
3335	      ce->sense_length, ce->residual_count);
3336	bzero(&csio->sense_data, SSD_FULL_SIZE);
3337	bcopy(&ce->sense_info[0], &csio->sense_data, ce->sense_length);
3338	if (csio->sense_len > ce->sense_length)
3339		csio->sense_resid = csio->sense_len - ce->sense_length;
3340	else
3341		csio->sense_resid = 0;
3342	csio->resid = ce->residual_count;
3343	csio->ccb_h.status |= CAM_SCSI_STATUS_ERROR | CAM_AUTOSNS_VALID;
3344#ifdef CISS_DEBUG
3345	{
3346	    struct scsi_sense_data	*sns = (struct scsi_sense_data *)&ce->sense_info[0];
3347	    debug(0, "sense key %x", scsi_get_sense_key(sns, csio->sense_len -
3348		  csio->sense_resid, /*show_errors*/ 1));
3349	}
3350#endif
3351	break;
3352
3353    case SCSI_STATUS_BUSY:		/* CISS_SCSI_STATUS_BUSY */
3354	debug(0, "SCSI_STATUS_BUSY");
3355	csio->ccb_h.status |= CAM_SCSI_BUSY;
3356	break;
3357
3358    default:
3359	debug(0, "unknown status 0x%x", csio->scsi_status);
3360	csio->ccb_h.status |= CAM_REQ_CMP_ERR;
3361	break;
3362    }
3363
3364    /* handle post-command fixup */
3365    ciss_cam_complete_fixup(sc, csio);
3366
3367    ciss_release_request(cr);
3368    if (sc->ciss_flags & CISS_FLAG_BUSY) {
3369	sc->ciss_flags &= ~CISS_FLAG_BUSY;
3370	if (csio->ccb_h.status & CAM_RELEASE_SIMQ)
3371	    xpt_release_simq(xpt_path_sim(csio->ccb_h.path), 0);
3372	else
3373	    csio->ccb_h.status |= CAM_RELEASE_SIMQ;
3374    }
3375    xpt_done((union ccb *)csio);
3376}
3377
3378/********************************************************************************
3379 * Fix up the result of some commands here.
3380 */
3381static void
3382ciss_cam_complete_fixup(struct ciss_softc *sc, struct ccb_scsiio *csio)
3383{
3384    struct scsi_inquiry_data	*inq;
3385    struct ciss_ldrive		*cl;
3386    uint8_t			*cdb;
3387    int				bus, target;
3388
3389    cdb = (csio->ccb_h.flags & CAM_CDB_POINTER) ?
3390	 (uint8_t *)csio->cdb_io.cdb_ptr : csio->cdb_io.cdb_bytes;
3391    if (cdb[0] == INQUIRY &&
3392	(cdb[1] & SI_EVPD) == 0 &&
3393	(csio->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_IN &&
3394	csio->dxfer_len >= SHORT_INQUIRY_LENGTH) {
3395	inq = (struct scsi_inquiry_data *)csio->data_ptr;
3396	target = csio->ccb_h.target_id;
3397	bus = cam_sim_bus(xpt_path_sim(csio->ccb_h.path));
3398
3399	/*
3400	 * If the controller is in JBOD mode, there are no logical volumes.
3401	 * Let the disks be probed and dealt with via CAM.  Else, mask off
3402	 * the physical disks and setup the parts of the inq structure for
3403	 * the logical volume.  swb
3404	 */
3405	if( !(sc->ciss_id->PowerUPNvramFlags & PWR_UP_FLAG_JBOD_ENABLED)){
3406		if (CISS_IS_PHYSICAL(bus)) {
3407	    		if (SID_TYPE(inq) == T_DIRECT)
3408				inq->device = (inq->device & 0xe0) | T_NODEVICE;
3409	    		return;
3410		}
3411		cl = &sc->ciss_logical[bus][target];
3412
3413		padstr(inq->vendor, "HP",
3414	       		SID_VENDOR_SIZE);
3415		padstr(inq->product,
3416	       		ciss_name_ldrive_org(cl->cl_ldrive->fault_tolerance),
3417	       		SID_PRODUCT_SIZE);
3418		padstr(inq->revision,
3419	       		ciss_name_ldrive_status(cl->cl_lstatus->status),
3420	       		SID_REVISION_SIZE);
3421	}
3422    }
3423}
3424
3425/********************************************************************************
3426 * Name the device at (target)
3427 *
3428 * XXX is this strictly correct?
3429 */
3430static int
3431ciss_name_device(struct ciss_softc *sc, int bus, int target)
3432{
3433    struct cam_periph	*periph;
3434    struct cam_path	*path;
3435    int			status;
3436
3437    if (CISS_IS_PHYSICAL(bus))
3438	return (0);
3439
3440    status = xpt_create_path(&path, NULL, cam_sim_path(sc->ciss_cam_sim[bus]),
3441			     target, 0);
3442
3443    if (status == CAM_REQ_CMP) {
3444	xpt_path_lock(path);
3445	periph = cam_periph_find(path, NULL);
3446	xpt_path_unlock(path);
3447	xpt_free_path(path);
3448	if (periph != NULL) {
3449		sprintf(sc->ciss_logical[bus][target].cl_name, "%s%d",
3450			periph->periph_name, periph->unit_number);
3451		return(0);
3452	}
3453    }
3454    sc->ciss_logical[bus][target].cl_name[0] = 0;
3455    return(ENOENT);
3456}
3457
3458/************************************************************************
3459 * Periodic status monitoring.
3460 */
3461static void
3462ciss_periodic(void *arg)
3463{
3464    struct ciss_softc	*sc;
3465    struct ciss_request	*cr = NULL;
3466    struct ciss_command	*cc = NULL;
3467    int			error = 0;
3468
3469    debug_called(1);
3470
3471    sc = (struct ciss_softc *)arg;
3472
3473    /*
3474     * Check the adapter heartbeat.
3475     */
3476    if (sc->ciss_cfg->heartbeat == sc->ciss_heartbeat) {
3477	sc->ciss_heart_attack++;
3478	debug(0, "adapter heart attack in progress 0x%x/%d",
3479	      sc->ciss_heartbeat, sc->ciss_heart_attack);
3480	if (sc->ciss_heart_attack == 3) {
3481	    ciss_printf(sc, "ADAPTER HEARTBEAT FAILED\n");
3482	    ciss_disable_adapter(sc);
3483	    return;
3484	}
3485    } else {
3486	sc->ciss_heartbeat = sc->ciss_cfg->heartbeat;
3487	sc->ciss_heart_attack = 0;
3488	debug(3, "new heartbeat 0x%x", sc->ciss_heartbeat);
3489    }
3490
3491    /*
3492     * Send the NOP message and wait for a response.
3493     */
3494    if (ciss_nop_message_heartbeat != 0 && (error = ciss_get_request(sc, &cr)) == 0) {
3495	cc = cr->cr_cc;
3496	cr->cr_complete = ciss_nop_complete;
3497	cc->cdb.cdb_length = 1;
3498	cc->cdb.type = CISS_CDB_TYPE_MESSAGE;
3499	cc->cdb.attribute = CISS_CDB_ATTRIBUTE_SIMPLE;
3500	cc->cdb.direction = CISS_CDB_DIRECTION_WRITE;
3501	cc->cdb.timeout = 0;
3502	cc->cdb.cdb[0] = CISS_OPCODE_MESSAGE_NOP;
3503
3504	if ((error = ciss_start(cr)) != 0) {
3505	    ciss_printf(sc, "SENDING NOP MESSAGE FAILED\n");
3506	}
3507    }
3508
3509    /*
3510     * If the notify event request has died for some reason, or has
3511     * not started yet, restart it.
3512     */
3513    if (!(sc->ciss_flags & CISS_FLAG_NOTIFY_OK)) {
3514	debug(0, "(re)starting Event Notify chain");
3515	ciss_notify_event(sc);
3516    }
3517
3518    /*
3519     * Reschedule.
3520     */
3521    callout_reset(&sc->ciss_periodic, CISS_HEARTBEAT_RATE * hz, ciss_periodic, sc);
3522}
3523
3524static void
3525ciss_nop_complete(struct ciss_request *cr)
3526{
3527    struct ciss_softc		*sc;
3528    static int			first_time = 1;
3529
3530    sc = cr->cr_sc;
3531    if (ciss_report_request(cr, NULL, NULL) != 0) {
3532	if (first_time == 1) {
3533	    first_time = 0;
3534	    ciss_printf(sc, "SENDING NOP MESSAGE FAILED (not logging anymore)\n");
3535	}
3536    }
3537
3538    ciss_release_request(cr);
3539}
3540
3541/************************************************************************
3542 * Disable the adapter.
3543 *
3544 * The all requests in completed queue is failed with hardware error.
3545 * This will cause failover in a multipath configuration.
3546 */
3547static void
3548ciss_disable_adapter(struct ciss_softc *sc)
3549{
3550    cr_qhead_t			qh;
3551    struct ciss_request		*cr;
3552    struct ciss_command		*cc;
3553    struct ciss_error_info	*ce;
3554    int				i;
3555
3556    CISS_TL_SIMPLE_DISABLE_INTERRUPTS(sc);
3557    pci_disable_busmaster(sc->ciss_dev);
3558    sc->ciss_flags &= ~CISS_FLAG_RUNNING;
3559
3560    STAILQ_INIT(&qh);
3561    for (i = 1; i < sc->ciss_max_requests; i++) {
3562	cr = &sc->ciss_request[i];
3563	if ((cr->cr_flags & CISS_REQ_BUSY) == 0)
3564	    continue;
3565
3566	cc = cr->cr_cc;
3567	ce = (struct ciss_error_info *)&(cc->sg[0]);
3568	ce->command_status = CISS_CMD_STATUS_HARDWARE_ERROR;
3569	ciss_enqueue_complete(cr, &qh);
3570    }
3571
3572    for (;;) {
3573	if ((cr = ciss_dequeue_complete(sc, &qh)) == NULL)
3574	    break;
3575
3576	/*
3577	 * If the request has a callback, invoke it.
3578	 */
3579	if (cr->cr_complete != NULL) {
3580	    cr->cr_complete(cr);
3581	    continue;
3582	}
3583
3584	/*
3585	 * If someone is sleeping on this request, wake them up.
3586	 */
3587	if (cr->cr_flags & CISS_REQ_SLEEP) {
3588	    cr->cr_flags &= ~CISS_REQ_SLEEP;
3589	    wakeup(cr);
3590	    continue;
3591	}
3592    }
3593}
3594
3595/************************************************************************
3596 * Request a notification response from the adapter.
3597 *
3598 * If (cr) is NULL, this is the first request of the adapter, so
3599 * reset the adapter's message pointer and start with the oldest
3600 * message available.
3601 */
3602static void
3603ciss_notify_event(struct ciss_softc *sc)
3604{
3605    struct ciss_request		*cr;
3606    struct ciss_command		*cc;
3607    struct ciss_notify_cdb	*cnc;
3608    int				error;
3609
3610    debug_called(1);
3611
3612    cr = sc->ciss_periodic_notify;
3613
3614    /* get a request if we don't already have one */
3615    if (cr == NULL) {
3616	if ((error = ciss_get_request(sc, &cr)) != 0) {
3617	    debug(0, "can't get notify event request");
3618	    goto out;
3619	}
3620	sc->ciss_periodic_notify = cr;
3621	cr->cr_complete = ciss_notify_complete;
3622	debug(1, "acquired request %d", cr->cr_tag);
3623    }
3624
3625    /*
3626     * Get a databuffer if we don't already have one, note that the
3627     * adapter command wants a larger buffer than the actual
3628     * structure.
3629     */
3630    if (cr->cr_data == NULL) {
3631	if ((cr->cr_data = malloc(CISS_NOTIFY_DATA_SIZE, CISS_MALLOC_CLASS, M_NOWAIT)) == NULL) {
3632	    debug(0, "can't get notify event request buffer");
3633	    error = ENOMEM;
3634	    goto out;
3635	}
3636	cr->cr_length = CISS_NOTIFY_DATA_SIZE;
3637    }
3638
3639    /* re-setup the request's command (since we never release it) XXX overkill*/
3640    ciss_preen_command(cr);
3641
3642    /* (re)build the notify event command */
3643    cc = cr->cr_cc;
3644    cc->header.address.physical.mode = CISS_HDR_ADDRESS_MODE_PERIPHERAL;
3645    cc->header.address.physical.bus = 0;
3646    cc->header.address.physical.target = 0;
3647
3648    cc->cdb.cdb_length = sizeof(*cnc);
3649    cc->cdb.type = CISS_CDB_TYPE_COMMAND;
3650    cc->cdb.attribute = CISS_CDB_ATTRIBUTE_SIMPLE;
3651    cc->cdb.direction = CISS_CDB_DIRECTION_READ;
3652    cc->cdb.timeout = 0;	/* no timeout, we hope */
3653
3654    cnc = (struct ciss_notify_cdb *)&(cc->cdb.cdb[0]);
3655    bzero(cr->cr_data, CISS_NOTIFY_DATA_SIZE);
3656    cnc->opcode = CISS_OPCODE_READ;
3657    cnc->command = CISS_COMMAND_NOTIFY_ON_EVENT;
3658    cnc->timeout = 0;		/* no timeout, we hope */
3659    cnc->synchronous = 0;
3660    cnc->ordered = 0;
3661    cnc->seek_to_oldest = 0;
3662    if ((sc->ciss_flags & CISS_FLAG_RUNNING) == 0)
3663	cnc->new_only = 1;
3664    else
3665	cnc->new_only = 0;
3666    cnc->length = htonl(CISS_NOTIFY_DATA_SIZE);
3667
3668    /* submit the request */
3669    error = ciss_start(cr);
3670
3671 out:
3672    if (error) {
3673	if (cr != NULL) {
3674	    if (cr->cr_data != NULL)
3675		free(cr->cr_data, CISS_MALLOC_CLASS);
3676	    ciss_release_request(cr);
3677	}
3678	sc->ciss_periodic_notify = NULL;
3679	debug(0, "can't submit notify event request");
3680	sc->ciss_flags &= ~CISS_FLAG_NOTIFY_OK;
3681    } else {
3682	debug(1, "notify event submitted");
3683	sc->ciss_flags |= CISS_FLAG_NOTIFY_OK;
3684    }
3685}
3686
3687static void
3688ciss_notify_complete(struct ciss_request *cr)
3689{
3690    struct ciss_command	*cc;
3691    struct ciss_notify	*cn;
3692    struct ciss_softc	*sc;
3693    int			scsi_status;
3694    int			command_status;
3695    debug_called(1);
3696
3697    cc = cr->cr_cc;
3698    cn = (struct ciss_notify *)cr->cr_data;
3699    sc = cr->cr_sc;
3700
3701    /*
3702     * Report request results, decode status.
3703     */
3704    ciss_report_request(cr, &command_status, &scsi_status);
3705
3706    /*
3707     * Abort the chain on a fatal error.
3708     *
3709     * XXX which of these are actually errors?
3710     */
3711    if ((command_status != CISS_CMD_STATUS_SUCCESS) &&
3712	(command_status != CISS_CMD_STATUS_TARGET_STATUS) &&
3713	(command_status != CISS_CMD_STATUS_TIMEOUT)) {	/* XXX timeout? */
3714	ciss_printf(sc, "fatal error in Notify Event request (%s)\n",
3715		    ciss_name_command_status(command_status));
3716	ciss_release_request(cr);
3717	sc->ciss_flags &= ~CISS_FLAG_NOTIFY_OK;
3718	return;
3719    }
3720
3721    /*
3722     * If the adapter gave us a text message, print it.
3723     */
3724    if (cn->message[0] != 0)
3725	ciss_printf(sc, "*** %.80s\n", cn->message);
3726
3727    debug(0, "notify event class %d subclass %d detail %d",
3728		cn->class, cn->subclass, cn->detail);
3729
3730    /*
3731     * If the response indicates that the notifier has been aborted,
3732     * release the notifier command.
3733     */
3734    if ((cn->class == CISS_NOTIFY_NOTIFIER) &&
3735	(cn->subclass == CISS_NOTIFY_NOTIFIER_STATUS) &&
3736	(cn->detail == 1)) {
3737	debug(0, "notifier exiting");
3738	sc->ciss_flags &= ~CISS_FLAG_NOTIFY_OK;
3739	ciss_release_request(cr);
3740	sc->ciss_periodic_notify = NULL;
3741	wakeup(&sc->ciss_periodic_notify);
3742    } else {
3743	/* Handle notify events in a kernel thread */
3744	ciss_enqueue_notify(cr);
3745	sc->ciss_periodic_notify = NULL;
3746	wakeup(&sc->ciss_periodic_notify);
3747	wakeup(&sc->ciss_notify);
3748    }
3749    /*
3750     * Send a new notify event command, if we're not aborting.
3751     */
3752    if (!(sc->ciss_flags & CISS_FLAG_ABORTING)) {
3753	ciss_notify_event(sc);
3754    }
3755}
3756
3757/************************************************************************
3758 * Abort the Notify Event chain.
3759 *
3760 * Note that we can't just abort the command in progress; we have to
3761 * explicitly issue an Abort Notify Event command in order for the
3762 * adapter to clean up correctly.
3763 *
3764 * If we are called with CISS_FLAG_ABORTING set in the adapter softc,
3765 * the chain will not restart itself.
3766 */
3767static int
3768ciss_notify_abort(struct ciss_softc *sc)
3769{
3770    struct ciss_request		*cr;
3771    struct ciss_command		*cc;
3772    struct ciss_notify_cdb	*cnc;
3773    int				error, command_status, scsi_status;
3774
3775    debug_called(1);
3776
3777    cr = NULL;
3778    error = 0;
3779
3780    /* verify that there's an outstanding command */
3781    if (!(sc->ciss_flags & CISS_FLAG_NOTIFY_OK))
3782	goto out;
3783
3784    /* get a command to issue the abort with */
3785    if ((error = ciss_get_request(sc, &cr)))
3786	goto out;
3787
3788    /* get a buffer for the result */
3789    if ((cr->cr_data = malloc(CISS_NOTIFY_DATA_SIZE, CISS_MALLOC_CLASS, M_NOWAIT)) == NULL) {
3790	debug(0, "can't get notify event request buffer");
3791	error = ENOMEM;
3792	goto out;
3793    }
3794    cr->cr_length = CISS_NOTIFY_DATA_SIZE;
3795
3796    /* build the CDB */
3797    cc = cr->cr_cc;
3798    cc->header.address.physical.mode = CISS_HDR_ADDRESS_MODE_PERIPHERAL;
3799    cc->header.address.physical.bus = 0;
3800    cc->header.address.physical.target = 0;
3801    cc->cdb.cdb_length = sizeof(*cnc);
3802    cc->cdb.type = CISS_CDB_TYPE_COMMAND;
3803    cc->cdb.attribute = CISS_CDB_ATTRIBUTE_SIMPLE;
3804    cc->cdb.direction = CISS_CDB_DIRECTION_READ;
3805    cc->cdb.timeout = 0;	/* no timeout, we hope */
3806
3807    cnc = (struct ciss_notify_cdb *)&(cc->cdb.cdb[0]);
3808    bzero(cnc, sizeof(*cnc));
3809    cnc->opcode = CISS_OPCODE_WRITE;
3810    cnc->command = CISS_COMMAND_ABORT_NOTIFY;
3811    cnc->length = htonl(CISS_NOTIFY_DATA_SIZE);
3812#if 0
3813    ciss_print_request(cr);
3814#endif
3815
3816    /*
3817     * Submit the request and wait for it to complete.
3818     */
3819    if ((error = ciss_synch_request(cr, 60 * 1000)) != 0) {
3820	ciss_printf(sc, "Abort Notify Event command failed (%d)\n", error);
3821	goto out;
3822    }
3823
3824    /*
3825     * Check response.
3826     */
3827    ciss_report_request(cr, &command_status, &scsi_status);
3828    switch(command_status) {
3829    case CISS_CMD_STATUS_SUCCESS:
3830	break;
3831    case CISS_CMD_STATUS_INVALID_COMMAND:
3832	/*
3833	 * Some older adapters don't support the CISS version of this
3834	 * command.  Fall back to using the BMIC version.
3835	 */
3836	error = ciss_notify_abort_bmic(sc);
3837	if (error != 0)
3838	    goto out;
3839	break;
3840
3841    case CISS_CMD_STATUS_TARGET_STATUS:
3842	/*
3843	 * This can happen if the adapter thinks there wasn't an outstanding
3844	 * Notify Event command but we did.  We clean up here.
3845	 */
3846	if (scsi_status == CISS_SCSI_STATUS_CHECK_CONDITION) {
3847	    if (sc->ciss_periodic_notify != NULL)
3848		ciss_release_request(sc->ciss_periodic_notify);
3849	    error = 0;
3850	    goto out;
3851	}
3852	/* FALLTHROUGH */
3853
3854    default:
3855	ciss_printf(sc, "Abort Notify Event command failed (%s)\n",
3856		    ciss_name_command_status(command_status));
3857	error = EIO;
3858	goto out;
3859    }
3860
3861    /*
3862     * Sleep waiting for the notifier command to complete.  Note
3863     * that if it doesn't, we may end up in a bad situation, since
3864     * the adapter may deliver it later.  Also note that the adapter
3865     * requires the Notify Event command to be cancelled in order to
3866     * maintain internal bookkeeping.
3867     */
3868    while (sc->ciss_periodic_notify != NULL) {
3869	error = msleep(&sc->ciss_periodic_notify, &sc->ciss_mtx, PRIBIO, "cissNEA", hz * 5);
3870	if (error == EWOULDBLOCK) {
3871	    ciss_printf(sc, "Notify Event command failed to abort, adapter may wedge.\n");
3872	    break;
3873	}
3874    }
3875
3876 out:
3877    /* release the cancel request */
3878    if (cr != NULL) {
3879	if (cr->cr_data != NULL)
3880	    free(cr->cr_data, CISS_MALLOC_CLASS);
3881	ciss_release_request(cr);
3882    }
3883    if (error == 0)
3884	sc->ciss_flags &= ~CISS_FLAG_NOTIFY_OK;
3885    return(error);
3886}
3887
3888/************************************************************************
3889 * Abort the Notify Event chain using a BMIC command.
3890 */
3891static int
3892ciss_notify_abort_bmic(struct ciss_softc *sc)
3893{
3894    struct ciss_request			*cr;
3895    int					error, command_status;
3896
3897    debug_called(1);
3898
3899    cr = NULL;
3900    error = 0;
3901
3902    /* verify that there's an outstanding command */
3903    if (!(sc->ciss_flags & CISS_FLAG_NOTIFY_OK))
3904	goto out;
3905
3906    /*
3907     * Build a BMIC command to cancel the Notify on Event command.
3908     *
3909     * Note that we are sending a CISS opcode here.  Odd.
3910     */
3911    if ((error = ciss_get_bmic_request(sc, &cr, CISS_COMMAND_ABORT_NOTIFY,
3912				       NULL, 0)) != 0)
3913	goto out;
3914
3915    /*
3916     * Submit the request and wait for it to complete.
3917     */
3918    if ((error = ciss_synch_request(cr, 60 * 1000)) != 0) {
3919	ciss_printf(sc, "error sending BMIC Cancel Notify on Event command (%d)\n", error);
3920	goto out;
3921    }
3922
3923    /*
3924     * Check response.
3925     */
3926    ciss_report_request(cr, &command_status, NULL);
3927    switch(command_status) {
3928    case CISS_CMD_STATUS_SUCCESS:
3929	break;
3930    default:
3931	ciss_printf(sc, "error cancelling Notify on Event (%s)\n",
3932		    ciss_name_command_status(command_status));
3933	error = EIO;
3934	goto out;
3935    }
3936
3937out:
3938    if (cr != NULL)
3939	ciss_release_request(cr);
3940    return(error);
3941}
3942
3943/************************************************************************
3944 * Handle rescanning all the logical volumes when a notify event
3945 * causes the drives to come online or offline.
3946 */
3947static void
3948ciss_notify_rescan_logical(struct ciss_softc *sc)
3949{
3950    struct ciss_lun_report      *cll;
3951    struct ciss_ldrive		*ld;
3952    int                         i, j, ndrives;
3953
3954    /*
3955     * We must rescan all logical volumes to get the right logical
3956     * drive address.
3957     */
3958    cll = ciss_report_luns(sc, CISS_OPCODE_REPORT_LOGICAL_LUNS,
3959                           sc->ciss_cfg->max_logical_supported);
3960    if (cll == NULL)
3961        return;
3962
3963    ndrives = (ntohl(cll->list_size) / sizeof(union ciss_device_address));
3964
3965    /*
3966     * Delete any of the drives which were destroyed by the
3967     * firmware.
3968     */
3969    for (i = 0; i < sc->ciss_max_logical_bus; i++) {
3970	for (j = 0; j < sc->ciss_cfg->max_logical_supported; j++) {
3971	    ld = &sc->ciss_logical[i][j];
3972
3973	    if (ld->cl_update == 0)
3974		continue;
3975
3976	    if (ld->cl_status != CISS_LD_ONLINE) {
3977		ciss_cam_rescan_target(sc, i, j);
3978		ld->cl_update = 0;
3979		if (ld->cl_ldrive)
3980		    free(ld->cl_ldrive, CISS_MALLOC_CLASS);
3981		if (ld->cl_lstatus)
3982		    free(ld->cl_lstatus, CISS_MALLOC_CLASS);
3983
3984		ld->cl_ldrive = NULL;
3985		ld->cl_lstatus = NULL;
3986	    }
3987	}
3988    }
3989
3990    /*
3991     * Scan for new drives.
3992     */
3993    for (i = 0; i < ndrives; i++) {
3994	int	bus, target;
3995
3996	bus 	= CISS_LUN_TO_BUS(cll->lun[i].logical.lun);
3997	target	= CISS_LUN_TO_TARGET(cll->lun[i].logical.lun);
3998	ld	= &sc->ciss_logical[bus][target];
3999
4000	if (ld->cl_update == 0)
4001		continue;
4002
4003	ld->cl_update		= 0;
4004	ld->cl_address		= cll->lun[i];
4005	ld->cl_controller	= &sc->ciss_controllers[bus];
4006	if (ciss_identify_logical(sc, ld) == 0) {
4007	    ciss_cam_rescan_target(sc, bus, target);
4008	}
4009    }
4010    free(cll, CISS_MALLOC_CLASS);
4011}
4012
4013/************************************************************************
4014 * Handle a notify event relating to the status of a logical drive.
4015 *
4016 * XXX need to be able to defer some of these to properly handle
4017 *     calling the "ID Physical drive" command, unless the 'extended'
4018 *     drive IDs are always in BIG_MAP format.
4019 */
4020static void
4021ciss_notify_logical(struct ciss_softc *sc, struct ciss_notify *cn)
4022{
4023    struct ciss_ldrive	*ld;
4024    int			ostatus, bus, target;
4025
4026    debug_called(2);
4027
4028    bus		= cn->device.physical.bus;
4029    target	= cn->data.logical_status.logical_drive;
4030    ld		= &sc->ciss_logical[bus][target];
4031
4032    switch (cn->subclass) {
4033    case CISS_NOTIFY_LOGICAL_STATUS:
4034	switch (cn->detail) {
4035	case 0:
4036	    ciss_name_device(sc, bus, target);
4037	    ciss_printf(sc, "logical drive %d (%s) changed status %s->%s, spare status 0x%b\n",
4038			cn->data.logical_status.logical_drive, ld->cl_name,
4039			ciss_name_ldrive_status(cn->data.logical_status.previous_state),
4040			ciss_name_ldrive_status(cn->data.logical_status.new_state),
4041			cn->data.logical_status.spare_state,
4042			"\20\1configured\2rebuilding\3failed\4in use\5available\n");
4043
4044	    /*
4045	     * Update our idea of the drive's status.
4046	     */
4047	    ostatus = ciss_decode_ldrive_status(cn->data.logical_status.previous_state);
4048	    ld->cl_status = ciss_decode_ldrive_status(cn->data.logical_status.new_state);
4049	    if (ld->cl_lstatus != NULL)
4050		ld->cl_lstatus->status = cn->data.logical_status.new_state;
4051
4052	    /*
4053	     * Have CAM rescan the drive if its status has changed.
4054	     */
4055	    if (ostatus != ld->cl_status) {
4056		ld->cl_update = 1;
4057		ciss_notify_rescan_logical(sc);
4058	    }
4059
4060	    break;
4061
4062	case 1:	/* logical drive has recognised new media, needs Accept Media Exchange */
4063	    ciss_name_device(sc, bus, target);
4064	    ciss_printf(sc, "logical drive %d (%s) media exchanged, ready to go online\n",
4065			cn->data.logical_status.logical_drive, ld->cl_name);
4066	    ciss_accept_media(sc, ld);
4067
4068	    ld->cl_update = 1;
4069	    ld->cl_status = ciss_decode_ldrive_status(cn->data.logical_status.new_state);
4070	    ciss_notify_rescan_logical(sc);
4071	    break;
4072
4073	case 2:
4074	case 3:
4075	    ciss_printf(sc, "rebuild of logical drive %d (%s) failed due to %s error\n",
4076			cn->data.rebuild_aborted.logical_drive,
4077			ld->cl_name,
4078			(cn->detail == 2) ? "read" : "write");
4079	    break;
4080	}
4081	break;
4082
4083    case CISS_NOTIFY_LOGICAL_ERROR:
4084	if (cn->detail == 0) {
4085	    ciss_printf(sc, "FATAL I/O ERROR on logical drive %d (%s), SCSI port %d ID %d\n",
4086			cn->data.io_error.logical_drive,
4087			ld->cl_name,
4088			cn->data.io_error.failure_bus,
4089			cn->data.io_error.failure_drive);
4090	    /* XXX should we take the drive down at this point, or will we be told? */
4091	}
4092	break;
4093
4094    case CISS_NOTIFY_LOGICAL_SURFACE:
4095	if (cn->detail == 0)
4096	    ciss_printf(sc, "logical drive %d (%s) completed consistency initialisation\n",
4097			cn->data.consistency_completed.logical_drive,
4098			ld->cl_name);
4099	break;
4100    }
4101}
4102
4103/************************************************************************
4104 * Handle a notify event relating to the status of a physical drive.
4105 */
4106static void
4107ciss_notify_physical(struct ciss_softc *sc, struct ciss_notify *cn)
4108{
4109}
4110
4111/************************************************************************
4112 * Handle a notify event relating to the status of a physical drive.
4113 */
4114static void
4115ciss_notify_hotplug(struct ciss_softc *sc, struct ciss_notify *cn)
4116{
4117    struct ciss_lun_report *cll = NULL;
4118    int bus, target;
4119
4120    switch (cn->subclass) {
4121    case CISS_NOTIFY_HOTPLUG_PHYSICAL:
4122    case CISS_NOTIFY_HOTPLUG_NONDISK:
4123	bus = CISS_BIG_MAP_BUS(sc, cn->data.drive.big_physical_drive_number);
4124	target =
4125	    CISS_BIG_MAP_TARGET(sc, cn->data.drive.big_physical_drive_number);
4126
4127	if (cn->detail == 0) {
4128	    /*
4129	     * Mark the device offline so that it'll start producing selection
4130	     * timeouts to the upper layer.
4131	     */
4132	    if ((bus >= 0) && (target >= 0))
4133		sc->ciss_physical[bus][target].cp_online = 0;
4134	} else {
4135	    /*
4136	     * Rescan the physical lun list for new items
4137	     */
4138	    cll = ciss_report_luns(sc, CISS_OPCODE_REPORT_PHYSICAL_LUNS,
4139				   sc->ciss_cfg->max_physical_supported);
4140	    if (cll == NULL) {
4141		ciss_printf(sc, "Warning, cannot get physical lun list\n");
4142		break;
4143	    }
4144	    ciss_filter_physical(sc, cll);
4145	}
4146	break;
4147
4148    default:
4149	ciss_printf(sc, "Unknown hotplug event %d\n", cn->subclass);
4150	return;
4151    }
4152
4153    if (cll != NULL)
4154	free(cll, CISS_MALLOC_CLASS);
4155}
4156
4157/************************************************************************
4158 * Handle deferred processing of notify events.  Notify events may need
4159 * sleep which is unsafe during an interrupt.
4160 */
4161static void
4162ciss_notify_thread(void *arg)
4163{
4164    struct ciss_softc		*sc;
4165    struct ciss_request		*cr;
4166    struct ciss_notify		*cn;
4167
4168    sc = (struct ciss_softc *)arg;
4169    mtx_lock(&sc->ciss_mtx);
4170
4171    for (;;) {
4172	if (STAILQ_EMPTY(&sc->ciss_notify) != 0 &&
4173	    (sc->ciss_flags & CISS_FLAG_THREAD_SHUT) == 0) {
4174	    msleep(&sc->ciss_notify, &sc->ciss_mtx, PUSER, "idle", 0);
4175	}
4176
4177	if (sc->ciss_flags & CISS_FLAG_THREAD_SHUT)
4178	    break;
4179
4180	cr = ciss_dequeue_notify(sc);
4181
4182	if (cr == NULL)
4183		panic("cr null");
4184	cn = (struct ciss_notify *)cr->cr_data;
4185
4186	switch (cn->class) {
4187	case CISS_NOTIFY_HOTPLUG:
4188	    ciss_notify_hotplug(sc, cn);
4189	    break;
4190	case CISS_NOTIFY_LOGICAL:
4191	    ciss_notify_logical(sc, cn);
4192	    break;
4193	case CISS_NOTIFY_PHYSICAL:
4194	    ciss_notify_physical(sc, cn);
4195	    break;
4196	}
4197
4198	ciss_release_request(cr);
4199    }
4200    sc->ciss_notify_thread = NULL;
4201    wakeup(&sc->ciss_notify_thread);
4202
4203    mtx_unlock(&sc->ciss_mtx);
4204    kproc_exit(0);
4205}
4206
4207/************************************************************************
4208 * Start the notification kernel thread.
4209 */
4210static void
4211ciss_spawn_notify_thread(struct ciss_softc *sc)
4212{
4213
4214    if (kproc_create((void(*)(void *))ciss_notify_thread, sc,
4215		       &sc->ciss_notify_thread, 0, 0, "ciss_notify%d",
4216		       device_get_unit(sc->ciss_dev)))
4217	panic("Could not create notify thread\n");
4218}
4219
4220/************************************************************************
4221 * Kill the notification kernel thread.
4222 */
4223static void
4224ciss_kill_notify_thread(struct ciss_softc *sc)
4225{
4226
4227    if (sc->ciss_notify_thread == NULL)
4228	return;
4229
4230    sc->ciss_flags |= CISS_FLAG_THREAD_SHUT;
4231    wakeup(&sc->ciss_notify);
4232    msleep(&sc->ciss_notify_thread, &sc->ciss_mtx, PUSER, "thtrm", 0);
4233}
4234
4235/************************************************************************
4236 * Print a request.
4237 */
4238#ifdef DDB
4239static void
4240ciss_print_request(struct ciss_request *cr)
4241{
4242    struct ciss_softc	*sc;
4243    struct ciss_command	*cc;
4244    int			i;
4245
4246    sc = cr->cr_sc;
4247    cc = cr->cr_cc;
4248
4249    ciss_printf(sc, "REQUEST @ %p\n", cr);
4250    ciss_printf(sc, "  data %p/%d  tag %d  flags %b\n",
4251	      cr->cr_data, cr->cr_length, cr->cr_tag, cr->cr_flags,
4252	      "\20\1mapped\2sleep\3poll\4dataout\5datain\n");
4253    ciss_printf(sc, "  sg list/total %d/%d  host tag 0x%x\n",
4254		cc->header.sg_in_list, cc->header.sg_total, cc->header.host_tag);
4255    switch(cc->header.address.mode.mode) {
4256    case CISS_HDR_ADDRESS_MODE_PERIPHERAL:
4257    case CISS_HDR_ADDRESS_MODE_MASK_PERIPHERAL:
4258	ciss_printf(sc, "  physical bus %d target %d\n",
4259		    cc->header.address.physical.bus, cc->header.address.physical.target);
4260	break;
4261    case CISS_HDR_ADDRESS_MODE_LOGICAL:
4262	ciss_printf(sc, "  logical unit %d\n", cc->header.address.logical.lun);
4263	break;
4264    }
4265    ciss_printf(sc, "  %s cdb length %d type %s attribute %s\n",
4266		(cc->cdb.direction == CISS_CDB_DIRECTION_NONE) ? "no-I/O" :
4267		(cc->cdb.direction == CISS_CDB_DIRECTION_READ) ? "READ" :
4268		(cc->cdb.direction == CISS_CDB_DIRECTION_WRITE) ? "WRITE" : "??",
4269		cc->cdb.cdb_length,
4270		(cc->cdb.type == CISS_CDB_TYPE_COMMAND) ? "command" :
4271		(cc->cdb.type == CISS_CDB_TYPE_MESSAGE) ? "message" : "??",
4272		(cc->cdb.attribute == CISS_CDB_ATTRIBUTE_UNTAGGED) ? "untagged" :
4273		(cc->cdb.attribute == CISS_CDB_ATTRIBUTE_SIMPLE) ? "simple" :
4274		(cc->cdb.attribute == CISS_CDB_ATTRIBUTE_HEAD_OF_QUEUE) ? "head-of-queue" :
4275		(cc->cdb.attribute == CISS_CDB_ATTRIBUTE_ORDERED) ? "ordered" :
4276		(cc->cdb.attribute == CISS_CDB_ATTRIBUTE_AUTO_CONTINGENT) ? "auto-contingent" : "??");
4277    ciss_printf(sc, "  %*D\n", cc->cdb.cdb_length, &cc->cdb.cdb[0], " ");
4278
4279    if (cc->header.host_tag & CISS_HDR_HOST_TAG_ERROR) {
4280	/* XXX print error info */
4281    } else {
4282	/* since we don't use chained s/g, don't support it here */
4283	for (i = 0; i < cc->header.sg_in_list; i++) {
4284	    if ((i % 4) == 0)
4285		ciss_printf(sc, "   ");
4286	    printf("0x%08x/%d ", (u_int32_t)cc->sg[i].address, cc->sg[i].length);
4287	    if ((((i + 1) % 4) == 0) || (i == (cc->header.sg_in_list - 1)))
4288		printf("\n");
4289	}
4290    }
4291}
4292#endif
4293
4294/************************************************************************
4295 * Print information about the status of a logical drive.
4296 */
4297static void
4298ciss_print_ldrive(struct ciss_softc *sc, struct ciss_ldrive *ld)
4299{
4300    int		bus, target, i;
4301
4302    if (ld->cl_lstatus == NULL) {
4303	printf("does not exist\n");
4304	return;
4305    }
4306
4307    /* print drive status */
4308    switch(ld->cl_lstatus->status) {
4309    case CISS_LSTATUS_OK:
4310	printf("online\n");
4311	break;
4312    case CISS_LSTATUS_INTERIM_RECOVERY:
4313	printf("in interim recovery mode\n");
4314	break;
4315    case CISS_LSTATUS_READY_RECOVERY:
4316	printf("ready to begin recovery\n");
4317	break;
4318    case CISS_LSTATUS_RECOVERING:
4319	bus = CISS_BIG_MAP_BUS(sc, ld->cl_lstatus->drive_rebuilding);
4320	target = CISS_BIG_MAP_BUS(sc, ld->cl_lstatus->drive_rebuilding);
4321	printf("being recovered, working on physical drive %d.%d, %u blocks remaining\n",
4322	       bus, target, ld->cl_lstatus->blocks_to_recover);
4323	break;
4324    case CISS_LSTATUS_EXPANDING:
4325	printf("being expanded, %u blocks remaining\n",
4326	       ld->cl_lstatus->blocks_to_recover);
4327	break;
4328    case CISS_LSTATUS_QUEUED_FOR_EXPANSION:
4329	printf("queued for expansion\n");
4330	break;
4331    case CISS_LSTATUS_FAILED:
4332	printf("queued for expansion\n");
4333	break;
4334    case CISS_LSTATUS_WRONG_PDRIVE:
4335	printf("wrong physical drive inserted\n");
4336	break;
4337    case CISS_LSTATUS_MISSING_PDRIVE:
4338	printf("missing a needed physical drive\n");
4339	break;
4340    case CISS_LSTATUS_BECOMING_READY:
4341	printf("becoming ready\n");
4342	break;
4343    }
4344
4345    /* print failed physical drives */
4346    for (i = 0; i < CISS_BIG_MAP_ENTRIES / 8; i++) {
4347	bus = CISS_BIG_MAP_BUS(sc, ld->cl_lstatus->drive_failure_map[i]);
4348	target = CISS_BIG_MAP_TARGET(sc, ld->cl_lstatus->drive_failure_map[i]);
4349	if (bus == -1)
4350	    continue;
4351	ciss_printf(sc, "physical drive %d:%d (%x) failed\n", bus, target,
4352		    ld->cl_lstatus->drive_failure_map[i]);
4353    }
4354}
4355
4356#ifdef DDB
4357#include <ddb/ddb.h>
4358/************************************************************************
4359 * Print information about the controller/driver.
4360 */
4361static void
4362ciss_print_adapter(struct ciss_softc *sc)
4363{
4364    int		i, j;
4365
4366    ciss_printf(sc, "ADAPTER:\n");
4367    for (i = 0; i < CISSQ_COUNT; i++) {
4368	ciss_printf(sc, "%s     %d/%d\n",
4369	    i == 0 ? "free" :
4370	    i == 1 ? "busy" : "complete",
4371	    sc->ciss_qstat[i].q_length,
4372	    sc->ciss_qstat[i].q_max);
4373    }
4374    ciss_printf(sc, "max_requests %d\n", sc->ciss_max_requests);
4375    ciss_printf(sc, "flags %b\n", sc->ciss_flags,
4376	"\20\1notify_ok\2control_open\3aborting\4running\21fake_synch\22bmic_abort\n");
4377
4378    for (i = 0; i < sc->ciss_max_logical_bus; i++) {
4379	for (j = 0; j < sc->ciss_cfg->max_logical_supported; j++) {
4380	    ciss_printf(sc, "LOGICAL DRIVE %d:  ", i);
4381	    ciss_print_ldrive(sc, &sc->ciss_logical[i][j]);
4382	}
4383    }
4384
4385    /* XXX Should physical drives be printed out here? */
4386
4387    for (i = 1; i < sc->ciss_max_requests; i++)
4388	ciss_print_request(sc->ciss_request + i);
4389}
4390
4391/* DDB hook */
4392DB_COMMAND(ciss_prt, db_ciss_prt)
4393{
4394    struct ciss_softc	*sc;
4395    devclass_t dc;
4396    int maxciss, i;
4397
4398    dc = devclass_find("ciss");
4399    if ( dc == NULL ) {
4400        printf("%s: can't find devclass!\n", __func__);
4401        return;
4402    }
4403    maxciss = devclass_get_maxunit(dc);
4404    for (i = 0; i < maxciss; i++) {
4405        sc = devclass_get_softc(dc, i);
4406	ciss_print_adapter(sc);
4407    }
4408}
4409#endif
4410
4411/************************************************************************
4412 * Return a name for a logical drive status value.
4413 */
4414static const char *
4415ciss_name_ldrive_status(int status)
4416{
4417    switch (status) {
4418    case CISS_LSTATUS_OK:
4419	return("OK");
4420    case CISS_LSTATUS_FAILED:
4421	return("failed");
4422    case CISS_LSTATUS_NOT_CONFIGURED:
4423	return("not configured");
4424    case CISS_LSTATUS_INTERIM_RECOVERY:
4425	return("interim recovery");
4426    case CISS_LSTATUS_READY_RECOVERY:
4427	return("ready for recovery");
4428    case CISS_LSTATUS_RECOVERING:
4429	return("recovering");
4430    case CISS_LSTATUS_WRONG_PDRIVE:
4431	return("wrong physical drive inserted");
4432    case CISS_LSTATUS_MISSING_PDRIVE:
4433	return("missing physical drive");
4434    case CISS_LSTATUS_EXPANDING:
4435	return("expanding");
4436    case CISS_LSTATUS_BECOMING_READY:
4437	return("becoming ready");
4438    case CISS_LSTATUS_QUEUED_FOR_EXPANSION:
4439	return("queued for expansion");
4440    }
4441    return("unknown status");
4442}
4443
4444/************************************************************************
4445 * Return an online/offline/nonexistent value for a logical drive
4446 * status value.
4447 */
4448static int
4449ciss_decode_ldrive_status(int status)
4450{
4451    switch(status) {
4452    case CISS_LSTATUS_NOT_CONFIGURED:
4453	return(CISS_LD_NONEXISTENT);
4454
4455    case CISS_LSTATUS_OK:
4456    case CISS_LSTATUS_INTERIM_RECOVERY:
4457    case CISS_LSTATUS_READY_RECOVERY:
4458    case CISS_LSTATUS_RECOVERING:
4459    case CISS_LSTATUS_EXPANDING:
4460    case CISS_LSTATUS_QUEUED_FOR_EXPANSION:
4461	return(CISS_LD_ONLINE);
4462
4463    case CISS_LSTATUS_FAILED:
4464    case CISS_LSTATUS_WRONG_PDRIVE:
4465    case CISS_LSTATUS_MISSING_PDRIVE:
4466    case CISS_LSTATUS_BECOMING_READY:
4467    default:
4468	return(CISS_LD_OFFLINE);
4469    }
4470}
4471
4472/************************************************************************
4473 * Return a name for a logical drive's organisation.
4474 */
4475static const char *
4476ciss_name_ldrive_org(int org)
4477{
4478    switch(org) {
4479    case CISS_LDRIVE_RAID0:
4480	return("RAID 0");
4481    case CISS_LDRIVE_RAID1:
4482	return("RAID 1(1+0)");
4483    case CISS_LDRIVE_RAID4:
4484	return("RAID 4");
4485    case CISS_LDRIVE_RAID5:
4486	return("RAID 5");
4487    case CISS_LDRIVE_RAID51:
4488	return("RAID 5+1");
4489    case CISS_LDRIVE_RAIDADG:
4490	return("RAID ADG");
4491    }
4492    return("unknown");
4493}
4494
4495/************************************************************************
4496 * Return a name for a command status value.
4497 */
4498static const char *
4499ciss_name_command_status(int status)
4500{
4501    switch(status) {
4502    case CISS_CMD_STATUS_SUCCESS:
4503	return("success");
4504    case CISS_CMD_STATUS_TARGET_STATUS:
4505	return("target status");
4506    case CISS_CMD_STATUS_DATA_UNDERRUN:
4507	return("data underrun");
4508    case CISS_CMD_STATUS_DATA_OVERRUN:
4509	return("data overrun");
4510    case CISS_CMD_STATUS_INVALID_COMMAND:
4511	return("invalid command");
4512    case CISS_CMD_STATUS_PROTOCOL_ERROR:
4513	return("protocol error");
4514    case CISS_CMD_STATUS_HARDWARE_ERROR:
4515	return("hardware error");
4516    case CISS_CMD_STATUS_CONNECTION_LOST:
4517	return("connection lost");
4518    case CISS_CMD_STATUS_ABORTED:
4519	return("aborted");
4520    case CISS_CMD_STATUS_ABORT_FAILED:
4521	return("abort failed");
4522    case CISS_CMD_STATUS_UNSOLICITED_ABORT:
4523	return("unsolicited abort");
4524    case CISS_CMD_STATUS_TIMEOUT:
4525	return("timeout");
4526    case CISS_CMD_STATUS_UNABORTABLE:
4527	return("unabortable");
4528    }
4529    return("unknown status");
4530}
4531
4532/************************************************************************
4533 * Handle an open on the control device.
4534 */
4535static int
4536ciss_open(struct cdev *dev, int flags, int fmt, struct thread *p)
4537{
4538    struct ciss_softc	*sc;
4539
4540    debug_called(1);
4541
4542    sc = (struct ciss_softc *)dev->si_drv1;
4543
4544    /* we might want to veto if someone already has us open */
4545
4546    mtx_lock(&sc->ciss_mtx);
4547    sc->ciss_flags |= CISS_FLAG_CONTROL_OPEN;
4548    mtx_unlock(&sc->ciss_mtx);
4549    return(0);
4550}
4551
4552/************************************************************************
4553 * Handle the last close on the control device.
4554 */
4555static int
4556ciss_close(struct cdev *dev, int flags, int fmt, struct thread *p)
4557{
4558    struct ciss_softc	*sc;
4559
4560    debug_called(1);
4561
4562    sc = (struct ciss_softc *)dev->si_drv1;
4563
4564    mtx_lock(&sc->ciss_mtx);
4565    sc->ciss_flags &= ~CISS_FLAG_CONTROL_OPEN;
4566    mtx_unlock(&sc->ciss_mtx);
4567    return (0);
4568}
4569
4570/********************************************************************************
4571 * Handle adapter-specific control operations.
4572 *
4573 * Note that the API here is compatible with the Linux driver, in order to
4574 * simplify the porting of Compaq's userland tools.
4575 */
4576static int
4577ciss_ioctl(struct cdev *dev, u_long cmd, caddr_t addr, int32_t flag, struct thread *p)
4578{
4579    struct ciss_softc		*sc;
4580    IOCTL_Command_struct	*ioc	= (IOCTL_Command_struct *)addr;
4581#ifdef __amd64__
4582    IOCTL_Command_struct32	*ioc32	= (IOCTL_Command_struct32 *)addr;
4583    IOCTL_Command_struct	ioc_swab;
4584#endif
4585    int				error;
4586
4587    debug_called(1);
4588
4589    sc = (struct ciss_softc *)dev->si_drv1;
4590    error = 0;
4591    mtx_lock(&sc->ciss_mtx);
4592
4593    switch(cmd) {
4594    case CCISS_GETQSTATS:
4595    {
4596	union ciss_statrequest *cr = (union ciss_statrequest *)addr;
4597
4598	switch (cr->cs_item) {
4599	case CISSQ_FREE:
4600	case CISSQ_NOTIFY:
4601	    bcopy(&sc->ciss_qstat[cr->cs_item], &cr->cs_qstat,
4602		sizeof(struct ciss_qstat));
4603	    break;
4604	default:
4605	    error = ENOIOCTL;
4606	    break;
4607	}
4608
4609	break;
4610    }
4611
4612    case CCISS_GETPCIINFO:
4613    {
4614	cciss_pci_info_struct	*pis = (cciss_pci_info_struct *)addr;
4615
4616	pis->bus = pci_get_bus(sc->ciss_dev);
4617	pis->dev_fn = pci_get_slot(sc->ciss_dev);
4618        pis->board_id = (pci_get_subvendor(sc->ciss_dev) << 16) |
4619                pci_get_subdevice(sc->ciss_dev);
4620
4621	break;
4622    }
4623
4624    case CCISS_GETINTINFO:
4625    {
4626	cciss_coalint_struct	*cis = (cciss_coalint_struct *)addr;
4627
4628	cis->delay = sc->ciss_cfg->interrupt_coalesce_delay;
4629	cis->count = sc->ciss_cfg->interrupt_coalesce_count;
4630
4631	break;
4632    }
4633
4634    case CCISS_SETINTINFO:
4635    {
4636	cciss_coalint_struct	*cis = (cciss_coalint_struct *)addr;
4637
4638	if ((cis->delay == 0) && (cis->count == 0)) {
4639	    error = EINVAL;
4640	    break;
4641	}
4642
4643	/*
4644	 * XXX apparently this is only safe if the controller is idle,
4645	 *     we should suspend it before doing this.
4646	 */
4647	sc->ciss_cfg->interrupt_coalesce_delay = cis->delay;
4648	sc->ciss_cfg->interrupt_coalesce_count = cis->count;
4649
4650	if (ciss_update_config(sc))
4651	    error = EIO;
4652
4653	/* XXX resume the controller here */
4654	break;
4655    }
4656
4657    case CCISS_GETNODENAME:
4658	bcopy(sc->ciss_cfg->server_name, (NodeName_type *)addr,
4659	      sizeof(NodeName_type));
4660	break;
4661
4662    case CCISS_SETNODENAME:
4663	bcopy((NodeName_type *)addr, sc->ciss_cfg->server_name,
4664	      sizeof(NodeName_type));
4665	if (ciss_update_config(sc))
4666	    error = EIO;
4667	break;
4668
4669    case CCISS_GETHEARTBEAT:
4670	*(Heartbeat_type *)addr = sc->ciss_cfg->heartbeat;
4671	break;
4672
4673    case CCISS_GETBUSTYPES:
4674	*(BusTypes_type *)addr = sc->ciss_cfg->bus_types;
4675	break;
4676
4677    case CCISS_GETFIRMVER:
4678	bcopy(sc->ciss_id->running_firmware_revision, (FirmwareVer_type *)addr,
4679	      sizeof(FirmwareVer_type));
4680	break;
4681
4682    case CCISS_GETDRIVERVER:
4683	*(DriverVer_type *)addr = CISS_DRIVER_VERSION;
4684	break;
4685
4686    case CCISS_REVALIDVOLS:
4687	/*
4688	 * This is a bit ugly; to do it "right" we really need
4689	 * to find any disks that have changed, kick CAM off them,
4690	 * then rescan only these disks.  It'd be nice if they
4691	 * a) told us which disk(s) they were going to play with,
4692	 * and b) which ones had arrived. 8(
4693	 */
4694	break;
4695
4696#ifdef __amd64__
4697    case CCISS_PASSTHRU32:
4698	ioc_swab.LUN_info	= ioc32->LUN_info;
4699	ioc_swab.Request	= ioc32->Request;
4700	ioc_swab.error_info	= ioc32->error_info;
4701	ioc_swab.buf_size	= ioc32->buf_size;
4702	ioc_swab.buf		= (u_int8_t *)(uintptr_t)ioc32->buf;
4703	ioc			= &ioc_swab;
4704	/* FALLTHROUGH */
4705#endif
4706
4707    case CCISS_PASSTHRU:
4708	error = ciss_user_command(sc, ioc);
4709	break;
4710
4711    default:
4712	debug(0, "unknown ioctl 0x%lx", cmd);
4713
4714	debug(1, "CCISS_GETPCIINFO:   0x%lx", CCISS_GETPCIINFO);
4715	debug(1, "CCISS_GETINTINFO:   0x%lx", CCISS_GETINTINFO);
4716	debug(1, "CCISS_SETINTINFO:   0x%lx", CCISS_SETINTINFO);
4717	debug(1, "CCISS_GETNODENAME:  0x%lx", CCISS_GETNODENAME);
4718	debug(1, "CCISS_SETNODENAME:  0x%lx", CCISS_SETNODENAME);
4719	debug(1, "CCISS_GETHEARTBEAT: 0x%lx", CCISS_GETHEARTBEAT);
4720	debug(1, "CCISS_GETBUSTYPES:  0x%lx", CCISS_GETBUSTYPES);
4721	debug(1, "CCISS_GETFIRMVER:   0x%lx", CCISS_GETFIRMVER);
4722	debug(1, "CCISS_GETDRIVERVER: 0x%lx", CCISS_GETDRIVERVER);
4723	debug(1, "CCISS_REVALIDVOLS:  0x%lx", CCISS_REVALIDVOLS);
4724	debug(1, "CCISS_PASSTHRU:     0x%lx", CCISS_PASSTHRU);
4725
4726	error = ENOIOCTL;
4727	break;
4728    }
4729
4730    mtx_unlock(&sc->ciss_mtx);
4731    return(error);
4732}
4733