2 * Copyright (c) 2000 Michael Smith
3 * Copyright (c) 2003 Paul Saab
4 * Copyright (c) 2003 Vinod Kashyap
5 * Copyright (c) 2000 BSDi
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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.
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
29 * $FreeBSD: src/sys/dev/twe/twe.c,v 1.34 2012/11/17 01:52:19 svnexp Exp $
33 * Driver for the 3ware Escalade family of IDE RAID controllers.
36 #include <dev/raid/twe/twe_compat.h>
37 #include <dev/raid/twe/twereg.h>
38 #include <dev/raid/twe/tweio.h>
39 #include <dev/raid/twe/twevar.h>
40 #define TWE_DEFINE_TABLES
41 #include <dev/raid/twe/twe_tables.h>
46 static int twe_get_param_1(struct twe_softc *sc, int table_id, int param_id, u_int8_t *result);
47 static int twe_get_param_2(struct twe_softc *sc, int table_id, int param_id, u_int16_t *result);
48 static int twe_get_param_4(struct twe_softc *sc, int table_id, int param_id, u_int32_t *result);
49 static void *twe_get_param(struct twe_softc *sc, int table_id, int parameter_id, size_t size,
50 void (* func)(struct twe_request *tr));
51 #ifdef TWE_SHUTDOWN_NOTIFICATION
52 static int twe_set_param_1(struct twe_softc *sc, int table_id, int param_id, u_int8_t value);
55 static int twe_set_param_2(struct twe_softc *sc, int table_id, int param_id, u_int16_t value);
56 static int twe_set_param_4(struct twe_softc *sc, int table_id, int param_id, u_int32_t value);
58 static int twe_set_param(struct twe_softc *sc, int table_id, int param_id, int param_size,
60 static int twe_init_connection(struct twe_softc *sc, int mode);
61 static int twe_wait_request(struct twe_request *tr);
62 static int twe_immediate_request(struct twe_request *tr, int usetmp);
63 static void twe_completeio(struct twe_request *tr);
64 static void twe_reset(struct twe_softc *sc);
65 static int twe_add_unit(struct twe_softc *sc, int unit);
66 static int twe_del_unit(struct twe_softc *sc, int unit);
69 * Command I/O to controller.
71 static void twe_done(struct twe_softc *sc, int startio);
72 static void twe_complete(struct twe_softc *sc);
73 static int twe_wait_status(struct twe_softc *sc, u_int32_t status, int timeout);
74 static int twe_drain_response_queue(struct twe_softc *sc);
75 static int twe_check_bits(struct twe_softc *sc, u_int32_t status_reg);
76 static int twe_soft_reset(struct twe_softc *sc);
81 static void twe_host_intr(struct twe_softc *sc);
82 static void twe_attention_intr(struct twe_softc *sc);
83 static void twe_command_intr(struct twe_softc *sc);
86 * Asynchronous event handling.
88 static int twe_fetch_aen(struct twe_softc *sc);
89 static void twe_handle_aen(struct twe_request *tr);
90 static void twe_enqueue_aen(struct twe_softc *sc, u_int16_t aen);
91 static u_int16_t twe_dequeue_aen(struct twe_softc *sc);
92 static int twe_drain_aen_queue(struct twe_softc *sc);
93 static int twe_find_aen(struct twe_softc *sc, u_int16_t aen);
96 * Command buffer management.
98 static int twe_get_request(struct twe_softc *sc, struct twe_request **tr);
99 static void twe_release_request(struct twe_request *tr);
104 static char *twe_format_aen(struct twe_softc *sc, u_int16_t aen);
105 static int twe_report_request(struct twe_request *tr);
106 static void twe_panic(struct twe_softc *sc, char *reason);
108 /********************************************************************************
109 ********************************************************************************
111 ********************************************************************************
112 ********************************************************************************/
114 /********************************************************************************
115 * Initialise the controller, set up driver data structures.
118 twe_setup(struct twe_softc *sc)
120 struct twe_request *tr;
122 u_int32_t status_reg;
128 * Initialise request queues.
134 twe_initq_complete(sc);
135 sc->twe_wait_aen = -1;
138 * Allocate request structures up front.
140 for (i = 0; i < TWE_Q_LENGTH; i++) {
141 if ((tr = twe_allocate_request(sc, i)) == NULL)
144 * Set global defaults that won't change.
146 cmd = TWE_FIND_COMMAND(tr);
147 cmd->generic.host_id = sc->twe_host_id; /* controller-assigned host ID */
148 cmd->generic.request_id = i; /* our index number */
149 sc->twe_lookup[i] = tr;
152 * Put command onto the freelist.
155 twe_release_request(tr);
161 * Check status register for errors, clear them.
163 status_reg = TWE_STATUS(sc);
164 twe_check_bits(sc, status_reg);
167 * Wait for the controller to come ready.
169 if (twe_wait_status(sc, TWE_STATUS_MICROCONTROLLER_READY, 60)) {
171 twe_printf(sc, "microcontroller not ready\n");
176 * Disable interrupts from the card.
178 twe_disable_interrupts(sc);
181 * Soft reset the controller, look for the AEN acknowledging the reset,
182 * check for errors, drain the response queue.
184 for (i = 0; i < TWE_MAX_RESET_TRIES; i++) {
187 twe_printf(sc, "reset %d failed, trying again\n", i);
189 if (!twe_soft_reset(sc))
190 break; /* reset process complete */
193 /* did we give up? */
194 if (i >= TWE_MAX_RESET_TRIES) {
195 twe_printf(sc, "can't initialise controller, giving up\n");
203 twe_add_unit(struct twe_softc *sc, int unit)
205 struct twe_drive *dr;
206 int table, error = 0;
208 TWE_Param *drives = NULL, *param = NULL;
209 TWE_Array_Descriptor *ud;
211 TWE_CONFIG_ASSERT_LOCKED(sc);
212 if (unit < 0 || unit > TWE_MAX_UNITS)
216 * The controller is in a safe state, so try to find drives attached to it.
219 if ((drives = twe_get_param(sc, TWE_PARAM_UNITSUMMARY, TWE_PARAM_UNITSUMMARY_Status,
220 TWE_MAX_UNITS, NULL)) == NULL) {
222 twe_printf(sc, "can't detect attached units\n");
226 dr = &sc->twe_drive[unit];
227 /* check that the drive is online */
228 if (!(drives->data[unit] & TWE_PARAM_UNITSTATUS_Online)) {
234 table = TWE_PARAM_UNITINFO + unit;
236 if (twe_get_param_4(sc, table, TWE_PARAM_UNITINFO_Capacity, &dr->td_size)) {
238 twe_printf(sc, "error fetching capacity for unit %d\n", unit);
242 if (twe_get_param_1(sc, table, TWE_PARAM_UNITINFO_Status, &dr->td_state)) {
244 twe_printf(sc, "error fetching state for unit %d\n", unit);
248 if (twe_get_param_2(sc, table, TWE_PARAM_UNITINFO_DescriptorSize, &dsize)) {
250 twe_printf(sc, "error fetching descriptor size for unit %d\n", unit);
254 if ((param = twe_get_param(sc, table, TWE_PARAM_UNITINFO_Descriptor, dsize - 3, NULL)) == NULL) {
256 twe_printf(sc, "error fetching descriptor for unit %d\n", unit);
260 ud = (TWE_Array_Descriptor *)param->data;
261 dr->td_type = ud->configuration;
263 /* build synthetic geometry as per controller internal rules */
264 if (dr->td_size > 0x200000) {
271 dr->td_cylinders = dr->td_size / (dr->td_heads * dr->td_sectors);
272 dr->td_twe_unit = unit;
275 error = twe_attach_drive(sc, dr);
279 kfree(param, M_DEVBUF);
281 kfree(drives, M_DEVBUF);
286 twe_del_unit(struct twe_softc *sc, int unit)
290 TWE_CONFIG_ASSERT_LOCKED(sc);
291 if (unit < 0 || unit >= TWE_MAX_UNITS)
294 if (sc->twe_drive[unit].td_disk == NULL)
297 error = twe_detach_drive(sc, unit);
301 /********************************************************************************
302 * Locate disk devices and attach children to them.
305 twe_init(struct twe_softc *sc)
313 for (i = 0; i < TWE_MAX_UNITS; i++)
315 TWE_CONFIG_UNLOCK(sc);
318 * Initialise connection with controller.
321 twe_init_connection(sc, TWE_INIT_MESSAGE_CREDITS);
323 #ifdef TWE_SHUTDOWN_NOTIFICATION
325 * Tell the controller we support shutdown notification.
327 twe_set_param_1(sc, TWE_PARAM_FEATURES, TWE_PARAM_FEATURES_DriverShutdown, 1);
331 * Mark controller up and ready to run.
333 sc->twe_state &= ~TWE_STATE_SHUTDOWN;
336 * Finally enable interrupts.
338 twe_enable_interrupts(sc);
342 /********************************************************************************
343 * Stop the controller
346 twe_deinit(struct twe_softc *sc)
349 * Mark the controller as shutting down, and disable any further interrupts.
351 twe_lockassert(&sc->twe_io_lock);
352 sc->twe_state |= TWE_STATE_SHUTDOWN;
353 twe_disable_interrupts(sc);
355 #ifdef TWE_SHUTDOWN_NOTIFICATION
357 * Disconnect from the controller
359 twe_init_connection(sc, TWE_SHUTDOWN_MESSAGE_CREDITS);
363 /*******************************************************************************
364 * Take an interrupt, or be poked by other code to look for interrupt-worthy
368 twe_intr(struct twe_softc *sc)
370 u_int32_t status_reg;
375 * Collect current interrupt status.
377 status_reg = TWE_STATUS(sc);
378 twe_check_bits(sc, status_reg);
381 * Dispatch based on interrupt status
383 if (status_reg & TWE_STATUS_HOST_INTERRUPT)
385 if (status_reg & TWE_STATUS_ATTENTION_INTERRUPT)
386 twe_attention_intr(sc);
387 if (status_reg & TWE_STATUS_COMMAND_INTERRUPT)
388 twe_command_intr(sc);
389 if (status_reg & TWE_STATUS_RESPONSE_INTERRUPT)
393 /********************************************************************************
394 * Pull as much work off the softc's work queue as possible and give it to the
398 twe_startio(struct twe_softc *sc)
400 struct twe_request *tr;
408 twe_lockassert(&sc->twe_io_lock);
409 if (sc->twe_state & (TWE_STATE_CTLR_BUSY | TWE_STATE_FRZN))
412 /* spin until something prevents us from doing any work */
415 /* try to get a command that's already ready to go */
416 tr = twe_dequeue_ready(sc);
418 /* build a command from an outstanding bio */
421 /* get a command to handle the bio with */
422 if (twe_get_request(sc, &tr))
425 /* see if there's work to be done */
426 if ((bio = twe_dequeue_bio(sc)) == NULL) {
427 twe_release_request(tr);
432 /* connect the bio to the command */
433 tr->tr_complete = twe_completeio;
434 tr->tr_private = bio;
435 tr->tr_data = bp->b_data;
436 tr->tr_length = bp->b_bcount;
437 cmd = TWE_FIND_COMMAND(tr);
438 if (bp->b_cmd == BUF_CMD_READ) {
439 tr->tr_flags |= TWE_CMD_DATAIN;
440 cmd->io.opcode = TWE_OP_READ;
442 tr->tr_flags |= TWE_CMD_DATAOUT;
443 cmd->io.opcode = TWE_OP_WRITE;
446 /* build a suitable I/O command (assumes 512-byte rounded transfers) */
448 cmd->io.unit = ((struct twed_softc *)bio->bio_driver_info)->twed_drive->td_twe_unit;
449 cmd->io.block_count = (tr->tr_length + TWE_BLOCK_SIZE - 1) / TWE_BLOCK_SIZE;
450 cmd->io.lba = (u_int32_t)(bio->bio_offset / TWE_BLOCK_SIZE);
451 KKASSERT(bio->bio_offset < 0x100000000ULL * TWE_BLOCK_SIZE);
454 /* did we find something to do? */
458 /* try to map and submit the command to controller */
459 error = twe_map_request(tr);
464 tr->tr_status = TWE_CMD_ERROR;
465 if (tr->tr_private != NULL) {
466 bio = (struct bio *)(tr->tr_private);
469 bp->b_flags |= B_ERROR;
470 tr->tr_private = NULL;
472 twe_release_request(tr);
473 } else if (tr->tr_flags & TWE_CMD_SLEEPER)
474 wakeup_one(tr); /* wakeup the sleeping owner */
479 /********************************************************************************
480 * Write blocks from memory to disk, for system crash dumps.
483 twe_dump_blocks(struct twe_softc *sc, int unit, u_int64_t lba, void *data, int nblks)
485 struct twe_request *tr;
489 if (twe_get_request(sc, &tr))
492 KKASSERT(lba < 0x100000000ULL);
495 tr->tr_status = TWE_CMD_SETUP;
496 tr->tr_length = nblks * TWE_BLOCK_SIZE;
497 tr->tr_flags = TWE_CMD_DATAOUT;
499 cmd = TWE_FIND_COMMAND(tr);
500 cmd->io.opcode = TWE_OP_WRITE;
503 cmd->io.block_count = nblks;
506 error = twe_immediate_request(tr, 0);
508 if (twe_report_request(tr))
510 twe_release_request(tr);
514 /********************************************************************************
515 * Handle controller-specific control operations.
518 twe_ioctl(struct twe_softc *sc, u_long ioctlcmd, void *addr)
520 struct twe_usercommand *tu = (struct twe_usercommand *)addr;
521 struct twe_paramcommand *tp = (struct twe_paramcommand *)addr;
522 struct twe_drivecommand *td = (struct twe_drivecommand *)addr;
523 union twe_statrequest *ts = (union twe_statrequest *)addr;
527 u_int16_t *aen_code = (u_int16_t *)addr;
528 struct twe_request *tr;
535 /* handle a command from userspace */
538 * if there's a data buffer, allocate and copy it in.
539 * Must be in multipled of 512 bytes.
541 tr_length = roundup2(tu->tu_size, 512);
543 data = kmalloc(tr_length, M_DEVBUF, M_WAITOK);
544 error = copyin(tu->tu_data, data, tu->tu_size);
546 kfree(data, M_DEVBUF);
554 while (twe_get_request(sc, &tr))
555 lksleep(sc, &sc->twe_io_lock, 0, "twioctl", hz);
558 * Save the command's request ID, copy the user-supplied command in,
559 * restore the request ID.
561 cmd = TWE_FIND_COMMAND(tr);
562 srid = cmd->generic.request_id;
563 bcopy(&tu->tu_command, cmd, sizeof(TWE_Command));
564 cmd->generic.request_id = srid;
567 * if there's a data buffer, allocate and copy it in.
568 * Must be in multipled of 512 bytes.
570 tr->tr_length = tr_length;
572 if (tr->tr_length > 0)
573 tr->tr_flags |= TWE_CMD_DATAIN | TWE_CMD_DATAOUT;
575 /* run the command */
576 error = twe_wait_request(tr);
581 /* copy the command out again */
582 bcopy(cmd, &tu->tu_command, sizeof(TWE_Command));
584 /* if there was a data buffer, copy it out */
585 if (tr->tr_length > 0)
586 error = copyout(tr->tr_data, tu->tu_data, tu->tu_size);
590 if (tr->tr_data != NULL)
591 kfree(tr->tr_data, M_DEVBUF);
593 twe_release_request(tr);
598 /* fetch statistics counter */
600 switch (ts->ts_item) {
601 #ifdef TWE_PERFORMANCE_MONITOR
608 bcopy(&sc->twe_qstat[ts->ts_item], &ts->ts_qstat, sizeof(struct twe_qstat));
618 /* poll for an AEN */
621 *aen_code = twe_dequeue_aen(sc);
625 /* wait for another AEN to show up */
628 while ((*aen_code = twe_dequeue_aen(sc)) == TWE_AEN_QUEUE_EMPTY) {
629 error = lksleep(&sc->twe_aen_queue, &sc->twe_io_lock, PCATCH,
637 case TWEIO_GET_PARAM:
639 param = twe_get_param(sc, tp->tp_table_id, tp->tp_param_id, tp->tp_size, NULL);
642 twe_printf(sc, "TWEIO_GET_PARAM failed for 0x%x/0x%x/%d\n",
643 tp->tp_table_id, tp->tp_param_id, tp->tp_size);
646 if (param->parameter_size_bytes > tp->tp_size) {
647 twe_printf(sc, "TWEIO_GET_PARAM parameter too large (%d > %d)\n",
648 param->parameter_size_bytes, tp->tp_size);
651 error = copyout(param->data, tp->tp_data, param->parameter_size_bytes);
653 kfree(param, M_DEVBUF);
657 case TWEIO_SET_PARAM:
658 data = kmalloc(tp->tp_size, M_DEVBUF, M_WAITOK);
659 error = copyin(tp->tp_data, data, tp->tp_size);
662 error = twe_set_param(sc, tp->tp_table_id, tp->tp_param_id, tp->tp_size, data);
665 kfree(data, M_DEVBUF);
676 error = twe_add_unit(sc, td->td_unit);
677 TWE_CONFIG_UNLOCK(sc);
682 error = twe_del_unit(sc, td->td_unit);
683 TWE_CONFIG_UNLOCK(sc);
686 /* XXX implement ATA PASSTHROUGH */
688 /* nothing we understand */
696 /********************************************************************************
697 * Enable the useful interrupts from the controller.
700 twe_enable_interrupts(struct twe_softc *sc)
702 sc->twe_state |= TWE_STATE_INTEN;
704 TWE_CONTROL_CLEAR_ATTENTION_INTERRUPT |
705 TWE_CONTROL_UNMASK_RESPONSE_INTERRUPT |
706 TWE_CONTROL_ENABLE_INTERRUPTS);
709 /********************************************************************************
710 * Disable interrupts from the controller.
713 twe_disable_interrupts(struct twe_softc *sc)
715 TWE_CONTROL(sc, TWE_CONTROL_DISABLE_INTERRUPTS);
716 sc->twe_state &= ~TWE_STATE_INTEN;
719 /********************************************************************************
720 ********************************************************************************
722 ********************************************************************************
723 ********************************************************************************/
725 /********************************************************************************
726 * Read integer parameter table entries.
729 twe_get_param_1(struct twe_softc *sc, int table_id, int param_id, u_int8_t *result)
733 if ((param = twe_get_param(sc, table_id, param_id, 1, NULL)) == NULL)
735 *result = *(u_int8_t *)param->data;
736 kfree(param, M_DEVBUF);
741 twe_get_param_2(struct twe_softc *sc, int table_id, int param_id, u_int16_t *result)
745 if ((param = twe_get_param(sc, table_id, param_id, 2, NULL)) == NULL)
747 *result = *(u_int16_t *)param->data;
748 kfree(param, M_DEVBUF);
753 twe_get_param_4(struct twe_softc *sc, int table_id, int param_id, u_int32_t *result)
757 if ((param = twe_get_param(sc, table_id, param_id, 4, NULL)) == NULL)
759 *result = *(u_int32_t *)param->data;
760 kfree(param, M_DEVBUF);
764 /********************************************************************************
765 * Perform a TWE_OP_GET_PARAM command. If a callback function is provided, it
766 * will be called with the command when it's completed. If no callback is
767 * provided, we will wait for the command to complete and then return just the data.
768 * The caller is responsible for freeing the data when done with it.
771 twe_get_param(struct twe_softc *sc, int table_id, int param_id, size_t param_size,
772 void (* func)(struct twe_request *tr))
774 struct twe_request *tr;
781 twe_lockassert(&sc->twe_io_lock);
786 if (twe_get_request(sc, &tr))
790 param = (TWE_Param *)kmalloc(TWE_SECTOR_SIZE, M_DEVBUF, M_INTWAIT);
792 tr->tr_length = TWE_SECTOR_SIZE;
793 tr->tr_flags = TWE_CMD_DATAIN | TWE_CMD_DATAOUT;
795 /* build the command for the controller */
796 cmd = TWE_FIND_COMMAND(tr);
797 cmd->param.opcode = TWE_OP_GET_PARAM;
800 cmd->param.param_count = 1;
802 /* fill in the outbound parameter data */
803 param->table_id = table_id;
804 param->parameter_id = param_id;
805 param->parameter_size_bytes = param_size;
807 /* submit the command and either wait or let the callback handle it */
809 /* XXX could use twe_wait_request here if interrupts were enabled? */
810 error = twe_immediate_request(tr, 1 /* usetmp */);
812 if (twe_report_request(tr))
817 twe_release_request(tr);
820 tr->tr_complete = func;
821 error = twe_map_request(tr);
822 if ((error == 0) || (error == EBUSY))
826 /* something failed */
830 twe_release_request(tr);
832 kfree(param, M_DEVBUF);
836 /********************************************************************************
837 * Set integer parameter table entries.
839 #ifdef TWE_SHUTDOWN_NOTIFICATION
841 twe_set_param_1(struct twe_softc *sc, int table_id, int param_id, u_int8_t value)
843 return(twe_set_param(sc, table_id, param_id, sizeof(value), &value));
849 twe_set_param_2(struct twe_softc *sc, int table_id, int param_id, u_int16_t value)
851 return(twe_set_param(sc, table_id, param_id, sizeof(value), &value));
855 twe_set_param_4(struct twe_softc *sc, int table_id, int param_id, u_int32_t value)
857 return(twe_set_param(sc, table_id, param_id, sizeof(value), &value));
861 /********************************************************************************
862 * Perform a TWE_OP_SET_PARAM command, returns nonzero on error.
865 twe_set_param(struct twe_softc *sc, int table_id, int param_id, int param_size, void *data)
867 struct twe_request *tr;
874 twe_lockassert(&sc->twe_io_lock);
880 if (twe_get_request(sc, &tr))
884 param = (TWE_Param *)kmalloc(TWE_SECTOR_SIZE, M_DEVBUF, M_INTWAIT);
886 tr->tr_length = TWE_SECTOR_SIZE;
887 tr->tr_flags = TWE_CMD_DATAIN | TWE_CMD_DATAOUT;
889 /* build the command for the controller */
890 cmd = TWE_FIND_COMMAND(tr);
891 cmd->param.opcode = TWE_OP_SET_PARAM;
894 cmd->param.param_count = 1;
896 /* fill in the outbound parameter data */
897 param->table_id = table_id;
898 param->parameter_id = param_id;
899 param->parameter_size_bytes = param_size;
900 bcopy(data, param->data, param_size);
902 /* XXX could use twe_wait_request here if interrupts were enabled? */
903 error = twe_immediate_request(tr, 1 /* usetmp */);
905 if (twe_report_request(tr))
911 twe_release_request(tr);
913 kfree(param, M_DEVBUF);
917 /********************************************************************************
918 * Perform a TWE_OP_INIT_CONNECTION command, returns nonzero on error.
920 * Typically called with interrupts disabled.
923 twe_init_connection(struct twe_softc *sc, int mode)
925 struct twe_request *tr;
931 twe_lockassert(&sc->twe_io_lock);
934 if (twe_get_request(sc, &tr))
937 /* build the command */
938 cmd = TWE_FIND_COMMAND(tr);
939 cmd->initconnection.opcode = TWE_OP_INIT_CONNECTION;
940 cmd->initconnection.size = 3;
941 cmd->initconnection.host_id = 0;
942 cmd->initconnection.message_credits = mode;
943 cmd->initconnection.response_queue_pointer = 0;
945 /* submit the command */
946 error = twe_immediate_request(tr, 0 /* usetmp */);
947 twe_release_request(tr);
949 if (mode == TWE_INIT_MESSAGE_CREDITS)
950 sc->twe_host_id = cmd->initconnection.host_id;
954 /********************************************************************************
955 * Start the command (tr) and sleep waiting for it to complete.
957 * Successfully completed commands are dequeued.
960 twe_wait_request(struct twe_request *tr)
964 twe_lockassert(&tr->tr_sc->twe_io_lock);
965 tr->tr_flags |= TWE_CMD_SLEEPER;
966 tr->tr_status = TWE_CMD_BUSY;
967 twe_enqueue_ready(tr);
968 twe_startio(tr->tr_sc);
969 while (tr->tr_status == TWE_CMD_BUSY)
970 lksleep(tr, &tr->tr_sc->twe_io_lock, 0, "twewait", 0);
972 return(tr->tr_status != TWE_CMD_COMPLETE);
975 /********************************************************************************
976 * Start the command (tr) and busy-wait for it to complete.
977 * This should only be used when interrupts are actually disabled (although it
978 * will work if they are not).
981 twe_immediate_request(struct twe_request *tr, int usetmp)
983 struct twe_softc *sc;
991 if (usetmp && (tr->tr_data != NULL)) {
992 tr->tr_flags |= TWE_CMD_IMMEDIATE;
993 if (tr->tr_length > MAXBSIZE)
995 bcopy(tr->tr_data, sc->twe_immediate, tr->tr_length);
997 tr->tr_status = TWE_CMD_BUSY;
998 if ((error = twe_map_request(tr)) != 0)
1002 /* Wait up to 5 seconds for the command to complete */
1003 while ((count++ < 5000) && (tr->tr_status == TWE_CMD_BUSY)){
1007 if (usetmp && (tr->tr_data != NULL))
1008 bcopy(sc->twe_immediate, tr->tr_data, tr->tr_length);
1010 return(tr->tr_status != TWE_CMD_COMPLETE);
1013 /********************************************************************************
1014 * Handle completion of an I/O command.
1017 twe_completeio(struct twe_request *tr)
1019 TWE_Command *cmd = TWE_FIND_COMMAND(tr);
1020 struct twe_softc *sc = tr->tr_sc;
1021 struct bio *bio = tr->tr_private;
1022 struct buf *bp = bio->bio_buf;
1026 if (tr->tr_status == TWE_CMD_COMPLETE) {
1028 if (cmd->generic.status)
1029 if (twe_report_request(tr)) {
1031 bp->b_flags |= B_ERROR;
1035 twe_panic(sc, "twe_completeio on incomplete command");
1037 tr->tr_private = NULL;
1039 twe_release_request(tr);
1042 /********************************************************************************
1043 * Reset the controller and pull all the active commands back onto the ready
1044 * queue. Used to restart a controller that's exhibiting bad behaviour.
1047 twe_reset(struct twe_softc *sc)
1049 struct twe_request *tr;
1053 * Sleep for a short period to allow AENs to be signalled.
1055 lksleep(sc, &sc->twe_io_lock, 0, "twereset", hz);
1058 * Disable interrupts from the controller, and mask any accidental entry
1059 * into our interrupt handler.
1061 twe_printf(sc, "controller reset in progress...\n");
1062 twe_disable_interrupts(sc);
1065 * Try to soft-reset the controller.
1067 for (i = 0; i < TWE_MAX_RESET_TRIES; i++) {
1070 twe_printf(sc, "reset %d failed, trying again\n", i);
1072 if (!twe_soft_reset(sc))
1073 break; /* reset process complete */
1075 /* did we give up? */
1076 if (i >= TWE_MAX_RESET_TRIES) {
1077 twe_printf(sc, "can't reset controller, giving up\n");
1082 * Move all of the commands that were busy back to the ready queue.
1085 while ((tr = twe_dequeue_busy(sc)) != NULL) {
1086 twe_enqueue_ready(tr);
1091 * Kick the controller to start things going again, then re-enable interrupts.
1094 twe_printf(sc, "controller reset done, %d commands restarted\n", i);
1097 twe_enable_interrupts(sc);
1100 /********************************************************************************
1101 ********************************************************************************
1102 Command I/O to Controller
1103 ********************************************************************************
1104 ********************************************************************************/
1106 /********************************************************************************
1107 * Try to deliver (tr) to the controller.
1109 * Can be called at any interrupt level, with or without interrupts enabled.
1112 twe_start(struct twe_request *tr)
1114 struct twe_softc *sc = tr->tr_sc;
1117 u_int32_t status_reg;
1121 twe_lockassert(&sc->twe_io_lock);
1123 /* mark the command as currently being processed */
1124 tr->tr_status = TWE_CMD_BUSY;
1125 cmd = TWE_FIND_COMMAND(tr);
1128 * Spin briefly waiting for the controller to come ready
1130 * XXX it might be more efficient to return EBUSY immediately
1131 * and let the command be rescheduled.
1133 for (i = 100000; (i > 0); i--) {
1135 /* check to see if we can post a command */
1136 status_reg = TWE_STATUS(sc);
1137 twe_check_bits(sc, status_reg);
1139 if (!(status_reg & TWE_STATUS_COMMAND_QUEUE_FULL)) {
1140 twe_enqueue_busy(tr);
1142 TWE_COMMAND_QUEUE(sc, TWE_FIND_COMMANDPHYS(tr));
1144 /* move command to work queue */
1146 if (tr->tr_complete != NULL) {
1147 debug(3, "queued request %d with callback %p", cmd->generic.request_id, tr->tr_complete);
1148 } else if (tr->tr_flags & TWE_CMD_SLEEPER) {
1149 debug(3, "queued request %d with wait channel %p", cmd->generic.request_id, tr);
1151 debug(3, "queued request %d for polling caller", cmd->generic.request_id);
1155 } else if (!(status_reg & TWE_STATUS_RESPONSE_QUEUE_EMPTY) && i > 1)
1160 * We couldn't get the controller to take the command; try submitting it again later.
1161 * This should only happen if something is wrong with the controller, or if we have
1162 * overestimated the number of commands it can accept. (Should we actually reject
1163 * the command at this point?)
1168 /********************************************************************************
1169 * Poll the controller (sc) for completed commands.
1171 * Can be called at any interrupt level, with or without interrupts enabled.
1174 twe_done(struct twe_softc *sc, int startio)
1176 TWE_Response_Queue rq;
1178 struct twe_request *tr;
1180 u_int32_t status_reg;
1184 /* loop collecting completed commands */
1187 status_reg = TWE_STATUS(sc);
1188 twe_check_bits(sc, status_reg); /* XXX should this fail? */
1190 if (!(status_reg & TWE_STATUS_RESPONSE_QUEUE_EMPTY)) {
1192 rq.value = TWE_RESPONSE_QUEUE(sc);
1193 tr = sc->twe_lookup[rq.u.response_id]; /* find command */
1194 cmd = TWE_FIND_COMMAND(tr);
1195 if (tr->tr_status != TWE_CMD_BUSY)
1196 twe_printf(sc, "completion event for nonbusy command\n");
1197 tr->tr_status = TWE_CMD_COMPLETE;
1198 debug(3, "completed request id %d with status %d",
1199 cmd->generic.request_id, cmd->generic.status);
1200 /* move to completed queue */
1201 twe_remove_busy(tr);
1202 twe_enqueue_complete(tr);
1203 sc->twe_state &= ~TWE_STATE_CTLR_BUSY;
1205 break; /* no response ready */
1209 /* if we've completed any commands, try posting some more */
1210 if (found && startio)
1213 /* handle completion and timeouts */
1214 twe_complete(sc); /* XXX use deferred completion? */
1217 /********************************************************************************
1218 * Perform post-completion processing for commands on (sc).
1220 * This is split from twe_done as it can be safely deferred and run at a lower
1221 * priority level should facilities for such a thing become available.
1224 twe_complete(struct twe_softc *sc)
1226 struct twe_request *tr;
1231 * Pull commands off the completed list, dispatch them appropriately
1233 while ((tr = twe_dequeue_complete(sc)) != NULL) {
1234 /* unmap the command's data buffer */
1235 twe_unmap_request(tr);
1237 /* dispatch to suit command originator */
1238 if (tr->tr_complete != NULL) { /* completion callback */
1239 debug(2, "call completion handler %p", tr->tr_complete);
1240 tr->tr_complete(tr);
1242 } else if (tr->tr_flags & TWE_CMD_SLEEPER) { /* caller is asleep waiting */
1243 debug(2, "wake up command owner on %p", tr);
1246 } else { /* caller is polling command */
1247 debug(2, "command left for owner");
1252 /********************************************************************************
1253 * Wait for (status) to be set in the controller status register for up to
1254 * (timeout) seconds. Returns 0 if found, nonzero if we time out.
1256 * Note: this busy-waits, rather than sleeping, since we may be called with
1257 * eg. clock interrupts masked.
1260 twe_wait_status(struct twe_softc *sc, u_int32_t status, int timeout)
1263 u_int32_t status_reg;
1267 expiry = time_second + timeout;
1270 status_reg = TWE_STATUS(sc);
1271 if (status_reg & status) /* got the required bit(s)? */
1274 } while (time_second <= expiry);
1279 /********************************************************************************
1280 * Drain the response queue, which may contain responses to commands we know
1284 twe_drain_response_queue(struct twe_softc *sc)
1286 TWE_Response_Queue rq;
1287 u_int32_t status_reg;
1291 for (;;) { /* XXX give up eventually? */
1292 status_reg = TWE_STATUS(sc);
1293 if (twe_check_bits(sc, status_reg))
1295 if (status_reg & TWE_STATUS_RESPONSE_QUEUE_EMPTY)
1297 rq.value = TWE_RESPONSE_QUEUE(sc);
1301 /********************************************************************************
1302 * Soft-reset the controller
1305 twe_soft_reset(struct twe_softc *sc)
1307 u_int32_t status_reg;
1311 twe_lockassert(&sc->twe_io_lock);
1314 if (twe_wait_status(sc, TWE_STATUS_ATTENTION_INTERRUPT, 30)) {
1315 twe_printf(sc, "no attention interrupt\n");
1318 TWE_CONTROL(sc, TWE_CONTROL_CLEAR_ATTENTION_INTERRUPT);
1319 if (twe_drain_aen_queue(sc)) {
1320 twe_printf(sc, "can't drain AEN queue\n");
1323 if (twe_find_aen(sc, TWE_AEN_SOFT_RESET)) {
1324 twe_printf(sc, "reset not reported\n");
1327 status_reg = TWE_STATUS(sc);
1328 if (TWE_STATUS_ERRORS(status_reg) || twe_check_bits(sc, status_reg)) {
1329 twe_printf(sc, "controller errors detected\n");
1332 if (twe_drain_response_queue(sc)) {
1333 twe_printf(sc, "can't drain response queue\n");
1339 /********************************************************************************
1340 ********************************************************************************
1342 ********************************************************************************
1343 ********************************************************************************/
1345 /********************************************************************************
1348 * XXX what does this mean?
1351 twe_host_intr(struct twe_softc *sc)
1355 twe_printf(sc, "host interrupt\n");
1356 TWE_CONTROL(sc, TWE_CONTROL_CLEAR_HOST_INTERRUPT);
1359 /********************************************************************************
1360 * Attention interrupt.
1362 * Signalled when the controller has one or more AENs for us.
1365 twe_attention_intr(struct twe_softc *sc)
1369 /* instigate a poll for AENs */
1370 if (twe_fetch_aen(sc)) {
1371 twe_printf(sc, "error polling for signalled AEN\n");
1373 TWE_CONTROL(sc, TWE_CONTROL_CLEAR_ATTENTION_INTERRUPT);
1377 /********************************************************************************
1378 * Command interrupt.
1380 * Signalled when the controller can handle more commands.
1383 twe_command_intr(struct twe_softc *sc)
1388 * We don't use this, rather we try to submit commands when we receive
1389 * them, and when other commands have completed. Mask it so we don't get
1392 TWE_CONTROL(sc, TWE_CONTROL_MASK_COMMAND_INTERRUPT);
1395 /********************************************************************************
1396 ********************************************************************************
1397 Asynchronous Event Handling
1398 ********************************************************************************
1399 ********************************************************************************/
1401 /********************************************************************************
1402 * Request an AEN from the controller.
1405 twe_fetch_aen(struct twe_softc *sc)
1410 if ((twe_get_param(sc, TWE_PARAM_AEN, TWE_PARAM_AEN_UnitCode, 2, twe_handle_aen)) == NULL)
1415 /********************************************************************************
1416 * Handle an AEN returned by the controller.
1419 twe_handle_aen(struct twe_request *tr)
1421 struct twe_softc *sc = tr->tr_sc;
1427 /* XXX check for command success somehow? */
1429 param = (TWE_Param *)tr->tr_data;
1430 aen = *(u_int16_t *)(param->data);
1432 kfree(tr->tr_data, M_DEVBUF);
1433 twe_release_request(tr);
1434 twe_enqueue_aen(sc, aen);
1436 /* XXX poll for more AENs? */
1439 /********************************************************************************
1440 * Pull AENs out of the controller and park them in the queue, in a context where
1441 * interrupts aren't active. Return nonzero if we encounter any errors in the
1442 * process of obtaining all the available AENs.
1445 twe_drain_aen_queue(struct twe_softc *sc)
1449 twe_lockassert(&sc->twe_io_lock);
1451 if (twe_get_param_2(sc, TWE_PARAM_AEN, TWE_PARAM_AEN_UnitCode, &aen))
1453 if (aen == TWE_AEN_QUEUE_EMPTY)
1455 twe_enqueue_aen(sc, aen);
1459 /********************************************************************************
1460 * Push an AEN that we've received onto the queue.
1462 * Note that we have to lock this against reentrance, since it may be called
1463 * from both interrupt and non-interrupt context.
1465 * If someone is waiting for the AEN we have, wake them up.
1468 twe_enqueue_aen(struct twe_softc *sc, u_int16_t aen)
1475 twe_lockassert(&sc->twe_io_lock);
1476 if ((msg = twe_format_aen(sc, aen)) != NULL)
1477 twe_printf(sc, "AEN: <%s>\n", msg);
1479 /* enqueue the AEN */
1480 next = ((sc->twe_aen_head + 1) % TWE_Q_LENGTH);
1481 nextnext = ((sc->twe_aen_head + 2) % TWE_Q_LENGTH);
1483 /* check to see if this is the last free slot, and subvert the AEN if it is */
1484 if (nextnext == sc->twe_aen_tail)
1485 aen = TWE_AEN_QUEUE_FULL;
1487 /* look to see if there's room for this AEN */
1488 if (next != sc->twe_aen_tail) {
1489 sc->twe_aen_queue[sc->twe_aen_head] = aen;
1490 sc->twe_aen_head = next;
1493 /* wake up anyone asleep on the queue */
1494 wakeup(&sc->twe_aen_queue);
1496 /* anyone looking for this AEN? */
1497 if (sc->twe_wait_aen == aen) {
1498 sc->twe_wait_aen = -1;
1499 wakeup(&sc->twe_wait_aen);
1503 /********************************************************************************
1504 * Pop an AEN off the queue, or return -1 if there are none left.
1506 * We are more or less interrupt-safe, so don't block interrupts.
1509 twe_dequeue_aen(struct twe_softc *sc)
1515 twe_lockassert(&sc->twe_io_lock);
1516 if (sc->twe_aen_tail == sc->twe_aen_head) {
1517 result = TWE_AEN_QUEUE_EMPTY;
1519 result = sc->twe_aen_queue[sc->twe_aen_tail];
1520 sc->twe_aen_tail = ((sc->twe_aen_tail + 1) % TWE_Q_LENGTH);
1525 /********************************************************************************
1526 * Check to see if the requested AEN is in the queue.
1528 * XXX we could probably avoid masking interrupts here
1531 twe_find_aen(struct twe_softc *sc, u_int16_t aen)
1536 for (i = sc->twe_aen_tail; (i != sc->twe_aen_head) && missing; i = (i + 1) % TWE_Q_LENGTH) {
1537 if (sc->twe_aen_queue[i] == aen)
1544 #if 0 /* currently unused */
1545 /********************************************************************************
1546 * Sleep waiting for at least (timeout) seconds until we see (aen) as
1547 * requested. Returns nonzero on timeout or failure.
1549 * XXX: this should not be used in cases where there may be more than one sleeper
1550 * without a mechanism for registering multiple sleepers.
1553 twe_wait_aen(struct twe_softc *sc, int aen, int timeout)
1560 expiry = time_second + timeout;
1563 sc->twe_wait_aen = aen;
1566 lksleep(&sc->twe_wait_aen, &sc->twe_io_lock, 0, "twewaen", hz);
1567 if (sc->twe_wait_aen == -1)
1569 } while ((time_second <= expiry) && !found);
1574 /********************************************************************************
1575 ********************************************************************************
1576 Command Buffer Management
1577 ********************************************************************************
1578 ********************************************************************************/
1580 /********************************************************************************
1581 * Get a new command buffer.
1583 * This will return NULL if all command buffers are in use.
1586 twe_get_request(struct twe_softc *sc, struct twe_request **tr)
1591 twe_lockassert(&sc->twe_io_lock);
1593 /* try to reuse an old buffer */
1594 *tr = twe_dequeue_free(sc);
1596 /* initialise some fields to their defaults */
1598 cmd = TWE_FIND_COMMAND(*tr);
1599 (*tr)->tr_data = NULL;
1600 (*tr)->tr_private = NULL;
1601 (*tr)->tr_status = TWE_CMD_SETUP; /* command is in setup phase */
1602 (*tr)->tr_flags = 0;
1603 (*tr)->tr_complete = NULL;
1604 cmd->generic.status = 0; /* before submission to controller */
1605 cmd->generic.flags = 0; /* not used */
1607 return(*tr == NULL);
1610 /********************************************************************************
1611 * Release a command buffer for reuse.
1615 twe_release_request(struct twe_request *tr)
1619 twe_lockassert(&tr->tr_sc->twe_io_lock);
1620 if (tr->tr_private != NULL)
1621 twe_panic(tr->tr_sc, "tr_private != NULL");
1622 twe_enqueue_free(tr);
1625 /********************************************************************************
1626 ********************************************************************************
1628 ********************************************************************************
1629 ********************************************************************************/
1631 /********************************************************************************
1632 * Print some information about the controller
1635 twe_describe_controller(struct twe_softc *sc)
1646 /* get the port count */
1647 twe_get_param_1(sc, TWE_PARAM_CONTROLLER, TWE_PARAM_CONTROLLER_PortCount, &ports);
1649 /* get version strings */
1650 p[0] = twe_get_param(sc, TWE_PARAM_VERSION, TWE_PARAM_VERSION_FW, 16, NULL);
1651 p[1] = twe_get_param(sc, TWE_PARAM_VERSION, TWE_PARAM_VERSION_BIOS, 16, NULL);
1653 twe_printf(sc, "%d ports, Firmware %.16s, BIOS %.16s\n", ports, p[0]->data, p[1]->data);
1656 p[2] = twe_get_param(sc, TWE_PARAM_VERSION, TWE_PARAM_VERSION_Mon, 16, NULL);
1657 p[3] = twe_get_param(sc, TWE_PARAM_VERSION, TWE_PARAM_VERSION_PCB, 8, NULL);
1658 p[4] = twe_get_param(sc, TWE_PARAM_VERSION, TWE_PARAM_VERSION_ATA, 8, NULL);
1659 p[5] = twe_get_param(sc, TWE_PARAM_VERSION, TWE_PARAM_VERSION_PCI, 8, NULL);
1661 if (p[2] && p[3] && p[4] && p[5])
1662 twe_printf(sc, "Monitor %.16s, PCB %.8s, Achip %.8s, Pchip %.8s\n", p[2]->data, p[3]->data,
1663 p[4]->data, p[5]->data);
1665 kfree(p[2], M_DEVBUF);
1667 kfree(p[3], M_DEVBUF);
1669 kfree(p[4], M_DEVBUF);
1671 kfree(p[5], M_DEVBUF);
1674 kfree(p[0], M_DEVBUF);
1676 kfree(p[1], M_DEVBUF);
1678 /* print attached drives */
1680 p[0] = twe_get_param(sc, TWE_PARAM_DRIVESUMMARY, TWE_PARAM_DRIVESUMMARY_Status, 16, NULL);
1681 for (i = 0; i < ports; i++) {
1682 if (p[0]->data[i] != TWE_PARAM_DRIVESTATUS_Present)
1684 twe_get_param_4(sc, TWE_PARAM_DRIVEINFO + i, TWE_PARAM_DRIVEINFO_Size, &size);
1685 p[1] = twe_get_param(sc, TWE_PARAM_DRIVEINFO + i, TWE_PARAM_DRIVEINFO_Model, 40, NULL);
1687 twe_printf(sc, "port %d: %.40s %dMB\n", i, p[1]->data, size / 2048);
1688 kfree(p[1], M_DEVBUF);
1690 twe_printf(sc, "port %d, drive status unavailable\n", i);
1694 kfree(p[0], M_DEVBUF);
1699 /********************************************************************************
1700 * Look up a text description of a numeric code and return a pointer to same.
1703 twe_describe_code(struct twe_code_lookup *table, u_int32_t code)
1707 for (i = 0; table[i].string != NULL; i++)
1708 if (table[i].code == code)
1709 return(table[i].string);
1710 return(table[i+1].string);
1713 /********************************************************************************
1714 * Complain if the status bits aren't what we're expecting.
1716 * Rate-limit the complaints to at most one of each every five seconds, but
1717 * always return the correct status.
1720 twe_check_bits(struct twe_softc *sc, u_int32_t status_reg)
1723 static time_t lastwarn[2] = {0, 0};
1726 * This can be a little problematic, as twe_panic may call twe_reset if
1727 * TWE_DEBUG is not set, which will call us again as part of the soft reset.
1729 if ((status_reg & TWE_STATUS_PANIC_BITS) != 0) {
1730 twe_printf(sc, "FATAL STATUS BIT(S) %b\n", status_reg & TWE_STATUS_PANIC_BITS,
1731 TWE_STATUS_BITS_DESCRIPTION);
1732 twe_panic(sc, "fatal status bits");
1736 if ((status_reg & TWE_STATUS_EXPECTED_BITS) != TWE_STATUS_EXPECTED_BITS) {
1737 if (time_second > (lastwarn[0] + 5)) {
1738 twe_printf(sc, "missing expected status bit(s) %b\n", ~status_reg & TWE_STATUS_EXPECTED_BITS,
1739 TWE_STATUS_BITS_DESCRIPTION);
1740 lastwarn[0] = time_second;
1745 if ((status_reg & TWE_STATUS_UNEXPECTED_BITS) != 0) {
1746 if (time_second > (lastwarn[1] + 5)) {
1747 twe_printf(sc, "unexpected status bit(s) %b\n", status_reg & TWE_STATUS_UNEXPECTED_BITS,
1748 TWE_STATUS_BITS_DESCRIPTION);
1749 lastwarn[1] = time_second;
1752 if (status_reg & TWE_STATUS_PCI_PARITY_ERROR) {
1753 twe_printf(sc, "PCI parity error: Reseat card, move card or buggy device present.\n");
1754 twe_clear_pci_parity_error(sc);
1756 if (status_reg & TWE_STATUS_PCI_ABORT) {
1757 twe_printf(sc, "PCI abort, clearing.\n");
1758 twe_clear_pci_abort(sc);
1765 /********************************************************************************
1766 * Return a string describing (aen).
1768 * The low 8 bits of the aen are the code, the high 8 bits give the unit number
1769 * where an AEN is specific to a unit.
1771 * Note that we could expand this routine to handle eg. up/downgrading the status
1772 * of a drive if we had some idea of what the drive's initial status was.
1776 twe_format_aen(struct twe_softc *sc, u_int16_t aen)
1781 code = twe_describe_code(twe_table_aen, TWE_AEN_CODE(aen));
1793 if ((child = sc->twe_drive[TWE_AEN_UNIT(aen)].td_disk) != NULL) {
1794 ksnprintf(sc->twe_aen_buf, sizeof(sc->twe_aen_buf), "twed%d: %s",
1795 device_get_unit(child), msg);
1797 ksnprintf(sc->twe_aen_buf, sizeof(sc->twe_aen_buf),
1798 "twe%d: %s for unknown unit %d", device_get_unit(sc->twe_dev),
1799 msg, TWE_AEN_UNIT(aen));
1801 return(sc->twe_aen_buf);
1804 ksnprintf(sc->twe_aen_buf, sizeof(sc->twe_aen_buf),
1805 "twe%d: port %d: %s", device_get_unit(sc->twe_dev),
1806 TWE_AEN_UNIT(aen), msg);
1807 return(sc->twe_aen_buf);
1814 ksnprintf(sc->twe_aen_buf, sizeof(sc->twe_aen_buf), "unknown AEN 0x%x", aen);
1815 return(sc->twe_aen_buf);
1818 /********************************************************************************
1819 * Print a diagnostic if the status of the command warrants it, and return
1820 * either zero (command was ok) or nonzero (command failed).
1823 twe_report_request(struct twe_request *tr)
1825 struct twe_softc *sc = tr->tr_sc;
1826 TWE_Command *cmd = TWE_FIND_COMMAND(tr);
1830 * Check the command status value and handle accordingly.
1832 if (cmd->generic.status == TWE_STATUS_RESET) {
1834 * The status code 0xff requests a controller reset.
1836 twe_printf(sc, "command returned with controller reset request\n");
1839 } else if (cmd->generic.status > TWE_STATUS_FATAL) {
1841 * Fatal errors that don't require controller reset.
1843 * We know a few special flags values.
1845 switch (cmd->generic.flags) {
1847 device_printf(sc->twe_drive[cmd->generic.unit].td_disk,
1851 device_printf(sc->twe_drive[cmd->generic.unit].td_disk,
1852 "unrecoverable drive error\n");
1855 device_printf(sc->twe_drive[cmd->generic.unit].td_disk,
1856 "controller error - %s (flags = 0x%x)\n",
1857 twe_describe_code(twe_table_status, cmd->generic.status),
1858 cmd->generic.flags);
1861 } else if (cmd->generic.status > TWE_STATUS_WARNING) {
1863 * Warning level status.
1865 device_printf(sc->twe_drive[cmd->generic.unit].td_disk,
1866 "warning - %s (flags = 0x%x)\n",
1867 twe_describe_code(twe_table_status, cmd->generic.status),
1868 cmd->generic.flags);
1869 } else if (cmd->generic.status > 0x40) {
1871 * Info level status.
1873 device_printf(sc->twe_drive[cmd->generic.unit].td_disk,
1874 "attention - %s (flags = 0x%x)\n",
1875 twe_describe_code(twe_table_status, cmd->generic.status),
1876 cmd->generic.flags);
1882 /********************************************************************************
1883 * Print some controller state to aid in debugging error/panic conditions
1886 twe_print_controller(struct twe_softc *sc)
1888 u_int32_t status_reg;
1890 status_reg = TWE_STATUS(sc);
1891 twe_printf(sc, "status %b\n", status_reg, TWE_STATUS_BITS_DESCRIPTION);
1892 twe_printf(sc, " current max min\n");
1893 twe_printf(sc, "free %04d %04d %04d\n",
1894 sc->twe_qstat[TWEQ_FREE].q_length, sc->twe_qstat[TWEQ_FREE].q_max, sc->twe_qstat[TWEQ_FREE].q_min);
1896 twe_printf(sc, "ready %04d %04d %04d\n",
1897 sc->twe_qstat[TWEQ_READY].q_length, sc->twe_qstat[TWEQ_READY].q_max, sc->twe_qstat[TWEQ_READY].q_min);
1899 twe_printf(sc, "busy %04d %04d %04d\n",
1900 sc->twe_qstat[TWEQ_BUSY].q_length, sc->twe_qstat[TWEQ_BUSY].q_max, sc->twe_qstat[TWEQ_BUSY].q_min);
1902 twe_printf(sc, "complete %04d %04d %04d\n",
1903 sc->twe_qstat[TWEQ_COMPLETE].q_length, sc->twe_qstat[TWEQ_COMPLETE].q_max, sc->twe_qstat[TWEQ_COMPLETE].q_min);
1905 twe_printf(sc, "bioq %04d %04d %04d\n",
1906 sc->twe_qstat[TWEQ_BIO].q_length, sc->twe_qstat[TWEQ_BIO].q_max, sc->twe_qstat[TWEQ_BIO].q_min);
1908 twe_printf(sc, "AEN queue head %d tail %d\n", sc->twe_aen_head, sc->twe_aen_tail);
1912 twe_panic(struct twe_softc *sc, char *reason)
1914 twe_print_controller(sc);
1923 /********************************************************************************
1924 * Print a request/command in human-readable format.
1927 twe_print_request(struct twe_request *tr)
1929 struct twe_softc *sc = tr->tr_sc;
1930 TWE_Command *cmd = TWE_FIND_COMMAND(tr);
1933 twe_printf(sc, "CMD: request_id %d opcode <%s> size %d unit %d host_id %d\n",
1934 cmd->generic.request_id, twe_describe_code(twe_table_opcode, cmd->generic.opcode), cmd->generic.size,
1935 cmd->generic.unit, cmd->generic.host_id);
1936 twe_printf(sc, " status %d flags 0x%x count %d sgl_offset %d\n",
1937 cmd->generic.status, cmd->generic.flags, cmd->generic.count, cmd->generic.sgl_offset);
1939 switch(cmd->generic.opcode) { /* XXX add more opcodes? */
1942 twe_printf(sc, " lba %d\n", cmd->io.lba);
1943 for (i = 0; (i < TWE_MAX_SGL_LENGTH) && (cmd->io.sgl[i].length != 0); i++)
1944 twe_printf(sc, " %d: 0x%x/%d\n",
1945 i, cmd->io.sgl[i].address, cmd->io.sgl[i].length);
1948 case TWE_OP_GET_PARAM:
1949 case TWE_OP_SET_PARAM:
1950 for (i = 0; (i < TWE_MAX_SGL_LENGTH) && (cmd->param.sgl[i].length != 0); i++)
1951 twe_printf(sc, " %d: 0x%x/%d\n",
1952 i, cmd->param.sgl[i].address, cmd->param.sgl[i].length);
1955 case TWE_OP_INIT_CONNECTION:
1956 twe_printf(sc, " response queue pointer 0x%x\n",
1957 cmd->initconnection.response_queue_pointer);
1963 twe_printf(sc, " tr_command %p/0x%x tr_data %p/0x%x,%d\n",
1964 tr, TWE_FIND_COMMANDPHYS(tr), tr->tr_data, tr->tr_dataphys, tr->tr_length);
1965 twe_printf(sc, " tr_status %d tr_flags 0x%x tr_complete %p tr_private %p\n",
1966 tr->tr_status, tr->tr_flags, tr->tr_complete, tr->tr_private);