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
33 * Driver for the 3ware Escalade family of IDE RAID controllers.
36 #include <dev/twe/twe_compat.h>
37 #include <dev/twe/twereg.h>
38 #include <dev/twe/tweio.h>
39 #include <dev/twe/twevar.h>
40 #define TWE_DEFINE_TABLES
41 #include <dev/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;
262 dr->td_stripe = ud->stripe_size;
264 /* build synthetic geometry as per controller internal rules */
265 if (dr->td_size > 0x200000) {
272 dr->td_cylinders = dr->td_size / (dr->td_heads * dr->td_sectors);
273 dr->td_twe_unit = unit;
276 error = twe_attach_drive(sc, dr);
280 free(param, M_DEVBUF);
282 free(drives, M_DEVBUF);
287 twe_del_unit(struct twe_softc *sc, int unit)
291 TWE_CONFIG_ASSERT_LOCKED(sc);
292 if (unit < 0 || unit >= TWE_MAX_UNITS)
295 if (sc->twe_drive[unit].td_disk == NULL)
298 error = twe_detach_drive(sc, unit);
302 /********************************************************************************
303 * Locate disk devices and attach children to them.
306 twe_init(struct twe_softc *sc)
314 for (i = 0; i < TWE_MAX_UNITS; i++)
316 TWE_CONFIG_UNLOCK(sc);
319 * Initialise connection with controller.
322 twe_init_connection(sc, TWE_INIT_MESSAGE_CREDITS);
324 #ifdef TWE_SHUTDOWN_NOTIFICATION
326 * Tell the controller we support shutdown notification.
328 twe_set_param_1(sc, TWE_PARAM_FEATURES, TWE_PARAM_FEATURES_DriverShutdown, 1);
332 * Mark controller up and ready to run.
334 sc->twe_state &= ~TWE_STATE_SHUTDOWN;
337 * Finally enable interrupts.
339 twe_enable_interrupts(sc);
343 /********************************************************************************
344 * Stop the controller
347 twe_deinit(struct twe_softc *sc)
350 * Mark the controller as shutting down, and disable any further interrupts.
352 TWE_IO_ASSERT_LOCKED(sc);
353 sc->twe_state |= TWE_STATE_SHUTDOWN;
354 twe_disable_interrupts(sc);
356 #ifdef TWE_SHUTDOWN_NOTIFICATION
358 * Disconnect from the controller
360 twe_init_connection(sc, TWE_SHUTDOWN_MESSAGE_CREDITS);
364 /*******************************************************************************
365 * Take an interrupt, or be poked by other code to look for interrupt-worthy
369 twe_intr(struct twe_softc *sc)
371 u_int32_t status_reg;
376 * Collect current interrupt status.
378 status_reg = TWE_STATUS(sc);
379 twe_check_bits(sc, status_reg);
382 * Dispatch based on interrupt status
384 if (status_reg & TWE_STATUS_HOST_INTERRUPT)
386 if (status_reg & TWE_STATUS_ATTENTION_INTERRUPT)
387 twe_attention_intr(sc);
388 if (status_reg & TWE_STATUS_COMMAND_INTERRUPT)
389 twe_command_intr(sc);
390 if (status_reg & TWE_STATUS_RESPONSE_INTERRUPT)
394 /********************************************************************************
395 * Pull as much work off the softc's work queue as possible and give it to the
399 twe_startio(struct twe_softc *sc)
401 struct twe_request *tr;
408 TWE_IO_ASSERT_LOCKED(sc);
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 ((bp = twe_dequeue_bio(sc)) == NULL) {
427 twe_release_request(tr);
431 /* connect the bio to the command */
432 tr->tr_complete = twe_completeio;
434 tr->tr_data = bp->bio_data;
435 tr->tr_length = bp->bio_bcount;
436 cmd = TWE_FIND_COMMAND(tr);
437 if (bp->bio_cmd == BIO_READ) {
438 tr->tr_flags |= TWE_CMD_DATAIN;
439 cmd->io.opcode = TWE_OP_READ;
441 tr->tr_flags |= TWE_CMD_DATAOUT;
442 cmd->io.opcode = TWE_OP_WRITE;
445 /* build a suitable I/O command (assumes 512-byte rounded transfers) */
447 cmd->io.unit = *(int *)(bp->bio_driver1);
448 cmd->io.block_count = (tr->tr_length + TWE_BLOCK_SIZE - 1) / TWE_BLOCK_SIZE;
449 cmd->io.lba = bp->bio_pblkno;
452 /* did we find something to do? */
456 /* try to map and submit the command to controller */
457 error = twe_map_request(tr);
462 tr->tr_status = TWE_CMD_ERROR;
463 if (tr->tr_private != NULL) {
464 bp = (struct bio *)(tr->tr_private);
465 bp->bio_error = error;
466 bp->bio_flags |= BIO_ERROR;
467 tr->tr_private = NULL;
469 twe_release_request(tr);
470 } else if (tr->tr_flags & TWE_CMD_SLEEPER)
471 wakeup_one(tr); /* wakeup the sleeping owner */
476 /********************************************************************************
477 * Write blocks from memory to disk, for system crash dumps.
480 twe_dump_blocks(struct twe_softc *sc, int unit, u_int32_t lba, void *data, int nblks)
482 struct twe_request *tr;
486 if (twe_get_request(sc, &tr))
490 tr->tr_status = TWE_CMD_SETUP;
491 tr->tr_length = nblks * TWE_BLOCK_SIZE;
492 tr->tr_flags = TWE_CMD_DATAOUT;
494 cmd = TWE_FIND_COMMAND(tr);
495 cmd->io.opcode = TWE_OP_WRITE;
498 cmd->io.block_count = nblks;
501 error = twe_immediate_request(tr, 0);
503 if (twe_report_request(tr))
505 twe_release_request(tr);
509 /********************************************************************************
510 * Handle controller-specific control operations.
513 twe_ioctl(struct twe_softc *sc, u_long ioctlcmd, void *addr)
515 struct twe_usercommand *tu = (struct twe_usercommand *)addr;
516 struct twe_paramcommand *tp = (struct twe_paramcommand *)addr;
517 struct twe_drivecommand *td = (struct twe_drivecommand *)addr;
518 union twe_statrequest *ts = (union twe_statrequest *)addr;
522 u_int16_t *aen_code = (u_int16_t *)addr;
523 struct twe_request *tr;
530 /* handle a command from userspace */
533 * if there's a data buffer, allocate and copy it in.
534 * Must be in multipled of 512 bytes.
536 tr_length = roundup2(tu->tu_size, 512);
538 data = malloc(tr_length, M_DEVBUF, M_WAITOK);
539 error = copyin(tu->tu_data, data, tu->tu_size);
541 free(data, M_DEVBUF);
549 while (twe_get_request(sc, &tr))
550 mtx_sleep(sc, &sc->twe_io_lock, PPAUSE, "twioctl", hz);
553 * Save the command's request ID, copy the user-supplied command in,
554 * restore the request ID.
556 cmd = TWE_FIND_COMMAND(tr);
557 srid = cmd->generic.request_id;
558 bcopy(&tu->tu_command, cmd, sizeof(TWE_Command));
559 cmd->generic.request_id = srid;
561 tr->tr_length = tr_length;
563 if (tr->tr_length > 0) {
564 tr->tr_flags |= TWE_CMD_DATAIN | TWE_CMD_DATAOUT;
567 /* run the command */
568 error = twe_wait_request(tr);
573 /* copy the command out again */
574 bcopy(cmd, &tu->tu_command, sizeof(TWE_Command));
576 /* if there was a data buffer, copy it out */
577 if (tr->tr_length > 0)
578 error = copyout(tr->tr_data, tu->tu_data, tu->tu_size);
582 if (tr->tr_data != NULL)
583 free(tr->tr_data, M_DEVBUF);
585 twe_release_request(tr);
590 /* fetch statistics counter */
592 switch (ts->ts_item) {
593 #ifdef TWE_PERFORMANCE_MONITOR
600 bcopy(&sc->twe_qstat[ts->ts_item], &ts->ts_qstat, sizeof(struct twe_qstat));
610 /* poll for an AEN */
613 *aen_code = twe_dequeue_aen(sc);
617 /* wait for another AEN to show up */
620 while ((*aen_code = twe_dequeue_aen(sc)) == TWE_AEN_QUEUE_EMPTY) {
621 error = mtx_sleep(&sc->twe_aen_queue, &sc->twe_io_lock, PRIBIO | PCATCH,
629 case TWEIO_GET_PARAM:
631 param = twe_get_param(sc, tp->tp_table_id, tp->tp_param_id, tp->tp_size, NULL);
634 twe_printf(sc, "TWEIO_GET_PARAM failed for 0x%x/0x%x/%d\n",
635 tp->tp_table_id, tp->tp_param_id, tp->tp_size);
638 if (param->parameter_size_bytes > tp->tp_size) {
639 twe_printf(sc, "TWEIO_GET_PARAM parameter too large (%d > %d)\n",
640 param->parameter_size_bytes, tp->tp_size);
643 error = copyout(param->data, tp->tp_data, param->parameter_size_bytes);
645 free(param, M_DEVBUF);
649 case TWEIO_SET_PARAM:
650 data = malloc(tp->tp_size, M_DEVBUF, M_WAITOK);
651 error = copyin(tp->tp_data, data, tp->tp_size);
654 error = twe_set_param(sc, tp->tp_table_id, tp->tp_param_id, tp->tp_size, data);
657 free(data, M_DEVBUF);
668 error = twe_add_unit(sc, td->td_unit);
669 TWE_CONFIG_UNLOCK(sc);
674 error = twe_del_unit(sc, td->td_unit);
675 TWE_CONFIG_UNLOCK(sc);
678 /* XXX implement ATA PASSTHROUGH */
680 /* nothing we understand */
688 /********************************************************************************
689 * Enable the useful interrupts from the controller.
692 twe_enable_interrupts(struct twe_softc *sc)
694 sc->twe_state |= TWE_STATE_INTEN;
696 TWE_CONTROL_CLEAR_ATTENTION_INTERRUPT |
697 TWE_CONTROL_UNMASK_RESPONSE_INTERRUPT |
698 TWE_CONTROL_ENABLE_INTERRUPTS);
701 /********************************************************************************
702 * Disable interrupts from the controller.
705 twe_disable_interrupts(struct twe_softc *sc)
707 TWE_CONTROL(sc, TWE_CONTROL_DISABLE_INTERRUPTS);
708 sc->twe_state &= ~TWE_STATE_INTEN;
711 /********************************************************************************
712 ********************************************************************************
714 ********************************************************************************
715 ********************************************************************************/
717 /********************************************************************************
718 * Read integer parameter table entries.
721 twe_get_param_1(struct twe_softc *sc, int table_id, int param_id, u_int8_t *result)
725 if ((param = twe_get_param(sc, table_id, param_id, 1, NULL)) == NULL)
727 *result = *(u_int8_t *)param->data;
728 free(param, M_DEVBUF);
733 twe_get_param_2(struct twe_softc *sc, int table_id, int param_id, u_int16_t *result)
737 if ((param = twe_get_param(sc, table_id, param_id, 2, NULL)) == NULL)
739 *result = *(u_int16_t *)param->data;
740 free(param, M_DEVBUF);
745 twe_get_param_4(struct twe_softc *sc, int table_id, int param_id, u_int32_t *result)
749 if ((param = twe_get_param(sc, table_id, param_id, 4, NULL)) == NULL)
751 *result = *(u_int32_t *)param->data;
752 free(param, M_DEVBUF);
756 /********************************************************************************
757 * Perform a TWE_OP_GET_PARAM command. If a callback function is provided, it
758 * will be called with the command when it's completed. If no callback is
759 * provided, we will wait for the command to complete and then return just the data.
760 * The caller is responsible for freeing the data when done with it.
763 twe_get_param(struct twe_softc *sc, int table_id, int param_id, size_t param_size,
764 void (* func)(struct twe_request *tr))
766 struct twe_request *tr;
773 TWE_IO_ASSERT_LOCKED(sc);
778 if (twe_get_request(sc, &tr))
782 if ((param = (TWE_Param *)malloc(TWE_SECTOR_SIZE, M_DEVBUF, M_NOWAIT)) == NULL)
785 tr->tr_length = TWE_SECTOR_SIZE;
786 tr->tr_flags = TWE_CMD_DATAIN | TWE_CMD_DATAOUT;
788 /* build the command for the controller */
789 cmd = TWE_FIND_COMMAND(tr);
790 cmd->param.opcode = TWE_OP_GET_PARAM;
793 cmd->param.param_count = 1;
795 /* fill in the outbound parameter data */
796 param->table_id = table_id;
797 param->parameter_id = param_id;
798 param->parameter_size_bytes = param_size;
800 /* submit the command and either wait or let the callback handle it */
802 /* XXX could use twe_wait_request here if interrupts were enabled? */
803 error = twe_immediate_request(tr, 1 /* usetmp */);
805 if (twe_report_request(tr))
810 twe_release_request(tr);
813 tr->tr_complete = func;
814 error = twe_map_request(tr);
815 if ((error == 0) || (error == EBUSY))
819 /* something failed */
823 twe_release_request(tr);
825 free(param, M_DEVBUF);
829 /********************************************************************************
830 * Set integer parameter table entries.
832 #ifdef TWE_SHUTDOWN_NOTIFICATION
834 twe_set_param_1(struct twe_softc *sc, int table_id, int param_id, u_int8_t value)
836 return(twe_set_param(sc, table_id, param_id, sizeof(value), &value));
842 twe_set_param_2(struct twe_softc *sc, int table_id, int param_id, u_int16_t value)
844 return(twe_set_param(sc, table_id, param_id, sizeof(value), &value));
848 twe_set_param_4(struct twe_softc *sc, int table_id, int param_id, u_int32_t value)
850 return(twe_set_param(sc, table_id, param_id, sizeof(value), &value));
854 /********************************************************************************
855 * Perform a TWE_OP_SET_PARAM command, returns nonzero on error.
858 twe_set_param(struct twe_softc *sc, int table_id, int param_id, int param_size, void *data)
860 struct twe_request *tr;
867 TWE_IO_ASSERT_LOCKED(sc);
873 if (twe_get_request(sc, &tr))
877 if ((param = (TWE_Param *)malloc(TWE_SECTOR_SIZE, M_DEVBUF, M_NOWAIT)) == NULL)
880 tr->tr_length = TWE_SECTOR_SIZE;
881 tr->tr_flags = TWE_CMD_DATAIN | TWE_CMD_DATAOUT;
883 /* build the command for the controller */
884 cmd = TWE_FIND_COMMAND(tr);
885 cmd->param.opcode = TWE_OP_SET_PARAM;
888 cmd->param.param_count = 1;
890 /* fill in the outbound parameter data */
891 param->table_id = table_id;
892 param->parameter_id = param_id;
893 param->parameter_size_bytes = param_size;
894 bcopy(data, param->data, param_size);
896 /* XXX could use twe_wait_request here if interrupts were enabled? */
897 error = twe_immediate_request(tr, 1 /* usetmp */);
899 if (twe_report_request(tr))
905 twe_release_request(tr);
907 free(param, M_DEVBUF);
911 /********************************************************************************
912 * Perform a TWE_OP_INIT_CONNECTION command, returns nonzero on error.
914 * Typically called with interrupts disabled.
917 twe_init_connection(struct twe_softc *sc, int mode)
919 struct twe_request *tr;
925 TWE_IO_ASSERT_LOCKED(sc);
928 if (twe_get_request(sc, &tr))
931 /* build the command */
932 cmd = TWE_FIND_COMMAND(tr);
933 cmd->initconnection.opcode = TWE_OP_INIT_CONNECTION;
934 cmd->initconnection.size = 3;
935 cmd->initconnection.host_id = 0;
936 cmd->initconnection.message_credits = mode;
937 cmd->initconnection.response_queue_pointer = 0;
939 /* submit the command */
940 error = twe_immediate_request(tr, 0 /* usetmp */);
941 twe_release_request(tr);
943 if (mode == TWE_INIT_MESSAGE_CREDITS)
944 sc->twe_host_id = cmd->initconnection.host_id;
948 /********************************************************************************
949 * Start the command (tr) and sleep waiting for it to complete.
951 * Successfully completed commands are dequeued.
954 twe_wait_request(struct twe_request *tr)
959 TWE_IO_ASSERT_LOCKED(tr->tr_sc);
960 tr->tr_flags |= TWE_CMD_SLEEPER;
961 tr->tr_status = TWE_CMD_BUSY;
962 twe_enqueue_ready(tr);
963 twe_startio(tr->tr_sc);
964 while (tr->tr_status == TWE_CMD_BUSY)
965 mtx_sleep(tr, &tr->tr_sc->twe_io_lock, PRIBIO, "twewait", 0);
967 return(tr->tr_status != TWE_CMD_COMPLETE);
970 /********************************************************************************
971 * Start the command (tr) and busy-wait for it to complete.
972 * This should only be used when interrupts are actually disabled (although it
973 * will work if they are not).
976 twe_immediate_request(struct twe_request *tr, int usetmp)
978 struct twe_softc *sc;
986 if (usetmp && (tr->tr_data != NULL)) {
987 tr->tr_flags |= TWE_CMD_IMMEDIATE;
988 if (tr->tr_length > DFLTPHYS)
990 bcopy(tr->tr_data, sc->twe_immediate, tr->tr_length);
992 tr->tr_status = TWE_CMD_BUSY;
993 if ((error = twe_map_request(tr)) != 0)
997 /* Wait up to 5 seconds for the command to complete */
998 while ((count++ < 5000) && (tr->tr_status == TWE_CMD_BUSY)){
1002 if (usetmp && (tr->tr_data != NULL))
1003 bcopy(sc->twe_immediate, tr->tr_data, tr->tr_length);
1005 return(tr->tr_status != TWE_CMD_COMPLETE);
1008 /********************************************************************************
1009 * Handle completion of an I/O command.
1012 twe_completeio(struct twe_request *tr)
1014 TWE_Command *cmd = TWE_FIND_COMMAND(tr);
1015 struct twe_softc *sc = tr->tr_sc;
1016 struct bio *bp = tr->tr_private;
1020 if (tr->tr_status == TWE_CMD_COMPLETE) {
1022 if (cmd->generic.status)
1023 if (twe_report_request(tr)) {
1024 bp->bio_error = EIO;
1025 bp->bio_flags |= BIO_ERROR;
1029 twe_panic(sc, "twe_completeio on incomplete command");
1031 tr->tr_private = NULL;
1033 twe_release_request(tr);
1036 /********************************************************************************
1037 * Reset the controller and pull all the active commands back onto the ready
1038 * queue. Used to restart a controller that's exhibiting bad behaviour.
1041 twe_reset(struct twe_softc *sc)
1043 struct twe_request *tr;
1047 * Sleep for a short period to allow AENs to be signalled.
1049 mtx_sleep(sc, &sc->twe_io_lock, PRIBIO, "twereset", hz);
1052 * Disable interrupts from the controller, and mask any accidental entry
1053 * into our interrupt handler.
1055 twe_printf(sc, "controller reset in progress...\n");
1056 twe_disable_interrupts(sc);
1059 * Try to soft-reset the controller.
1061 for (i = 0; i < TWE_MAX_RESET_TRIES; i++) {
1064 twe_printf(sc, "reset %d failed, trying again\n", i);
1066 if (!twe_soft_reset(sc))
1067 break; /* reset process complete */
1069 /* did we give up? */
1070 if (i >= TWE_MAX_RESET_TRIES) {
1071 twe_printf(sc, "can't reset controller, giving up\n");
1076 * Move all of the commands that were busy back to the ready queue.
1079 while ((tr = twe_dequeue_busy(sc)) != NULL) {
1080 twe_enqueue_ready(tr);
1085 * Kick the controller to start things going again, then re-enable interrupts.
1088 twe_printf(sc, "controller reset done, %d commands restarted\n", i);
1091 twe_enable_interrupts(sc);
1094 /********************************************************************************
1095 ********************************************************************************
1096 Command I/O to Controller
1097 ********************************************************************************
1098 ********************************************************************************/
1100 /********************************************************************************
1101 * Try to deliver (tr) to the controller.
1103 * Can be called at any interrupt level, with or without interrupts enabled.
1106 twe_start(struct twe_request *tr)
1108 struct twe_softc *sc = tr->tr_sc;
1111 u_int32_t status_reg;
1116 TWE_IO_ASSERT_LOCKED(sc);
1118 /* mark the command as currently being processed */
1119 tr->tr_status = TWE_CMD_BUSY;
1120 cmd = TWE_FIND_COMMAND(tr);
1123 * Spin briefly waiting for the controller to come ready
1125 * XXX it might be more efficient to return EBUSY immediately
1126 * and let the command be rescheduled.
1128 for (i = 100000; (i > 0); i--) {
1130 /* check to see if we can post a command */
1131 status_reg = TWE_STATUS(sc);
1132 twe_check_bits(sc, status_reg);
1134 if (!(status_reg & TWE_STATUS_COMMAND_QUEUE_FULL)) {
1135 twe_enqueue_busy(tr);
1137 TWE_COMMAND_QUEUE(sc, TWE_FIND_COMMANDPHYS(tr));
1139 /* move command to work queue */
1141 if (tr->tr_complete != NULL) {
1142 debug(3, "queued request %d with callback %p", cmd->generic.request_id, tr->tr_complete);
1143 } else if (tr->tr_flags & TWE_CMD_SLEEPER) {
1144 debug(3, "queued request %d with wait channel %p", cmd->generic.request_id, tr);
1146 debug(3, "queued request %d for polling caller", cmd->generic.request_id);
1150 } else if (!(status_reg & TWE_STATUS_RESPONSE_QUEUE_EMPTY) && i > 1)
1155 * We couldn't get the controller to take the command; try submitting it again later.
1156 * This should only happen if something is wrong with the controller, or if we have
1157 * overestimated the number of commands it can accept. (Should we actually reject
1158 * the command at this point?)
1163 /********************************************************************************
1164 * Poll the controller (sc) for completed commands.
1166 * Can be called at any interrupt level, with or without interrupts enabled.
1169 twe_done(struct twe_softc *sc, int startio)
1171 TWE_Response_Queue rq;
1173 struct twe_request *tr;
1175 u_int32_t status_reg;
1179 /* loop collecting completed commands */
1182 status_reg = TWE_STATUS(sc);
1183 twe_check_bits(sc, status_reg); /* XXX should this fail? */
1185 if (!(status_reg & TWE_STATUS_RESPONSE_QUEUE_EMPTY)) {
1187 rq = TWE_RESPONSE_QUEUE(sc);
1188 tr = sc->twe_lookup[rq.u.response_id]; /* find command */
1189 cmd = TWE_FIND_COMMAND(tr);
1190 if (tr->tr_status != TWE_CMD_BUSY)
1191 twe_printf(sc, "completion event for nonbusy command\n");
1192 tr->tr_status = TWE_CMD_COMPLETE;
1193 debug(3, "completed request id %d with status %d",
1194 cmd->generic.request_id, cmd->generic.status);
1195 /* move to completed queue */
1196 twe_remove_busy(tr);
1197 twe_enqueue_complete(tr);
1198 sc->twe_state &= ~TWE_STATE_CTLR_BUSY;
1200 break; /* no response ready */
1204 /* if we've completed any commands, try posting some more */
1205 if (found && startio)
1208 /* handle completion and timeouts */
1209 twe_complete(sc); /* XXX use deferred completion? */
1212 /********************************************************************************
1213 * Perform post-completion processing for commands on (sc).
1215 * This is split from twe_done as it can be safely deferred and run at a lower
1216 * priority level should facilities for such a thing become available.
1219 twe_complete(struct twe_softc *sc)
1221 struct twe_request *tr;
1226 * Pull commands off the completed list, dispatch them appropriately
1228 while ((tr = twe_dequeue_complete(sc)) != NULL) {
1229 /* unmap the command's data buffer */
1230 twe_unmap_request(tr);
1232 /* dispatch to suit command originator */
1233 if (tr->tr_complete != NULL) { /* completion callback */
1234 debug(2, "call completion handler %p", tr->tr_complete);
1235 tr->tr_complete(tr);
1237 } else if (tr->tr_flags & TWE_CMD_SLEEPER) { /* caller is asleep waiting */
1238 debug(2, "wake up command owner on %p", tr);
1241 } else { /* caller is polling command */
1242 debug(2, "command left for owner");
1247 /********************************************************************************
1248 * Wait for (status) to be set in the controller status register for up to
1249 * (timeout) seconds. Returns 0 if found, nonzero if we time out.
1251 * Note: this busy-waits, rather than sleeping, since we may be called with
1252 * eg. clock interrupts masked.
1255 twe_wait_status(struct twe_softc *sc, u_int32_t status, int timeout)
1258 u_int32_t status_reg;
1262 expiry = time_second + timeout;
1265 status_reg = TWE_STATUS(sc);
1266 if (status_reg & status) /* got the required bit(s)? */
1269 } while (time_second <= expiry);
1274 /********************************************************************************
1275 * Drain the response queue, which may contain responses to commands we know
1279 twe_drain_response_queue(struct twe_softc *sc)
1281 TWE_Response_Queue rq;
1282 u_int32_t status_reg;
1286 for (;;) { /* XXX give up eventually? */
1287 status_reg = TWE_STATUS(sc);
1288 if (twe_check_bits(sc, status_reg))
1290 if (status_reg & TWE_STATUS_RESPONSE_QUEUE_EMPTY)
1292 rq = TWE_RESPONSE_QUEUE(sc);
1296 /********************************************************************************
1297 * Soft-reset the controller
1300 twe_soft_reset(struct twe_softc *sc)
1302 u_int32_t status_reg;
1306 TWE_IO_ASSERT_LOCKED(sc);
1309 if (twe_wait_status(sc, TWE_STATUS_ATTENTION_INTERRUPT, 30)) {
1310 twe_printf(sc, "no attention interrupt\n");
1313 TWE_CONTROL(sc, TWE_CONTROL_CLEAR_ATTENTION_INTERRUPT);
1314 if (twe_drain_aen_queue(sc)) {
1315 twe_printf(sc, "can't drain AEN queue\n");
1318 if (twe_find_aen(sc, TWE_AEN_SOFT_RESET)) {
1319 twe_printf(sc, "reset not reported\n");
1322 status_reg = TWE_STATUS(sc);
1323 if (TWE_STATUS_ERRORS(status_reg) || twe_check_bits(sc, status_reg)) {
1324 twe_printf(sc, "controller errors detected\n");
1327 if (twe_drain_response_queue(sc)) {
1328 twe_printf(sc, "can't drain response queue\n");
1334 /********************************************************************************
1335 ********************************************************************************
1337 ********************************************************************************
1338 ********************************************************************************/
1340 /********************************************************************************
1343 * XXX what does this mean?
1346 twe_host_intr(struct twe_softc *sc)
1350 twe_printf(sc, "host interrupt\n");
1351 TWE_CONTROL(sc, TWE_CONTROL_CLEAR_HOST_INTERRUPT);
1354 /********************************************************************************
1355 * Attention interrupt.
1357 * Signalled when the controller has one or more AENs for us.
1360 twe_attention_intr(struct twe_softc *sc)
1364 /* instigate a poll for AENs */
1365 if (twe_fetch_aen(sc)) {
1366 twe_printf(sc, "error polling for signalled AEN\n");
1368 TWE_CONTROL(sc, TWE_CONTROL_CLEAR_ATTENTION_INTERRUPT);
1372 /********************************************************************************
1373 * Command interrupt.
1375 * Signalled when the controller can handle more commands.
1378 twe_command_intr(struct twe_softc *sc)
1383 * We don't use this, rather we try to submit commands when we receive
1384 * them, and when other commands have completed. Mask it so we don't get
1387 TWE_CONTROL(sc, TWE_CONTROL_MASK_COMMAND_INTERRUPT);
1390 /********************************************************************************
1391 ********************************************************************************
1392 Asynchronous Event Handling
1393 ********************************************************************************
1394 ********************************************************************************/
1396 /********************************************************************************
1397 * Request an AEN from the controller.
1400 twe_fetch_aen(struct twe_softc *sc)
1405 if ((twe_get_param(sc, TWE_PARAM_AEN, TWE_PARAM_AEN_UnitCode, 2, twe_handle_aen)) == NULL)
1410 /********************************************************************************
1411 * Handle an AEN returned by the controller.
1414 twe_handle_aen(struct twe_request *tr)
1416 struct twe_softc *sc = tr->tr_sc;
1422 /* XXX check for command success somehow? */
1424 param = (TWE_Param *)tr->tr_data;
1425 aen = *(u_int16_t *)(param->data);
1427 free(tr->tr_data, M_DEVBUF);
1428 twe_release_request(tr);
1429 twe_enqueue_aen(sc, aen);
1431 /* XXX poll for more AENs? */
1434 /********************************************************************************
1435 * Pull AENs out of the controller and park them in the queue, in a context where
1436 * interrupts aren't active. Return nonzero if we encounter any errors in the
1437 * process of obtaining all the available AENs.
1440 twe_drain_aen_queue(struct twe_softc *sc)
1444 TWE_IO_ASSERT_LOCKED(sc);
1446 if (twe_get_param_2(sc, TWE_PARAM_AEN, TWE_PARAM_AEN_UnitCode, &aen))
1448 if (aen == TWE_AEN_QUEUE_EMPTY)
1450 twe_enqueue_aen(sc, aen);
1454 /********************************************************************************
1455 * Push an AEN that we've received onto the queue.
1457 * Note that we have to lock this against reentrance, since it may be called
1458 * from both interrupt and non-interrupt context.
1460 * If someone is waiting for the AEN we have, wake them up.
1463 twe_enqueue_aen(struct twe_softc *sc, u_int16_t aen)
1470 TWE_IO_ASSERT_LOCKED(sc);
1471 if ((msg = twe_format_aen(sc, aen)) != NULL)
1472 twe_printf(sc, "AEN: <%s>\n", msg);
1474 /* enqueue the AEN */
1475 next = ((sc->twe_aen_head + 1) % TWE_Q_LENGTH);
1476 nextnext = ((sc->twe_aen_head + 2) % TWE_Q_LENGTH);
1478 /* check to see if this is the last free slot, and subvert the AEN if it is */
1479 if (nextnext == sc->twe_aen_tail)
1480 aen = TWE_AEN_QUEUE_FULL;
1482 /* look to see if there's room for this AEN */
1483 if (next != sc->twe_aen_tail) {
1484 sc->twe_aen_queue[sc->twe_aen_head] = aen;
1485 sc->twe_aen_head = next;
1488 /* wake up anyone asleep on the queue */
1489 wakeup(&sc->twe_aen_queue);
1491 /* anyone looking for this AEN? */
1492 if (sc->twe_wait_aen == aen) {
1493 sc->twe_wait_aen = -1;
1494 wakeup(&sc->twe_wait_aen);
1498 /********************************************************************************
1499 * Pop an AEN off the queue, or return -1 if there are none left.
1501 * We are more or less interrupt-safe, so don't block interrupts.
1504 twe_dequeue_aen(struct twe_softc *sc)
1510 TWE_IO_ASSERT_LOCKED(sc);
1511 if (sc->twe_aen_tail == sc->twe_aen_head) {
1512 result = TWE_AEN_QUEUE_EMPTY;
1514 result = sc->twe_aen_queue[sc->twe_aen_tail];
1515 sc->twe_aen_tail = ((sc->twe_aen_tail + 1) % TWE_Q_LENGTH);
1520 /********************************************************************************
1521 * Check to see if the requested AEN is in the queue.
1523 * XXX we could probably avoid masking interrupts here
1526 twe_find_aen(struct twe_softc *sc, u_int16_t aen)
1531 for (i = sc->twe_aen_tail; (i != sc->twe_aen_head) && missing; i = (i + 1) % TWE_Q_LENGTH) {
1532 if (sc->twe_aen_queue[i] == aen)
1539 #if 0 /* currently unused */
1540 /********************************************************************************
1541 * Sleep waiting for at least (timeout) seconds until we see (aen) as
1542 * requested. Returns nonzero on timeout or failure.
1544 * XXX: this should not be used in cases where there may be more than one sleeper
1545 * without a mechanism for registering multiple sleepers.
1548 twe_wait_aen(struct twe_softc *sc, int aen, int timeout)
1555 expiry = time_second + timeout;
1558 sc->twe_wait_aen = aen;
1561 mtx_sleep(&sc->twe_wait_aen, &sc->twe_io_lock, PZERO, "twewaen", hz);
1562 if (sc->twe_wait_aen == -1)
1564 } while ((time_second <= expiry) && !found);
1569 /********************************************************************************
1570 ********************************************************************************
1571 Command Buffer Management
1572 ********************************************************************************
1573 ********************************************************************************/
1575 /********************************************************************************
1576 * Get a new command buffer.
1578 * This will return NULL if all command buffers are in use.
1581 twe_get_request(struct twe_softc *sc, struct twe_request **tr)
1587 TWE_IO_ASSERT_LOCKED(sc);
1589 /* try to reuse an old buffer */
1590 *tr = twe_dequeue_free(sc);
1592 /* initialise some fields to their defaults */
1594 cmd = TWE_FIND_COMMAND(*tr);
1595 (*tr)->tr_data = NULL;
1596 (*tr)->tr_private = NULL;
1597 (*tr)->tr_status = TWE_CMD_SETUP; /* command is in setup phase */
1598 (*tr)->tr_flags = 0;
1599 (*tr)->tr_complete = NULL;
1600 cmd->generic.status = 0; /* before submission to controller */
1601 cmd->generic.flags = 0; /* not used */
1603 return(*tr == NULL);
1606 /********************************************************************************
1607 * Release a command buffer for reuse.
1611 twe_release_request(struct twe_request *tr)
1616 TWE_IO_ASSERT_LOCKED(tr->tr_sc);
1617 if (tr->tr_private != NULL)
1618 twe_panic(tr->tr_sc, "tr_private != NULL");
1619 twe_enqueue_free(tr);
1622 /********************************************************************************
1623 ********************************************************************************
1625 ********************************************************************************
1626 ********************************************************************************/
1628 /********************************************************************************
1629 * Print some information about the controller
1632 twe_describe_controller(struct twe_softc *sc)
1643 /* get the port count */
1644 twe_get_param_1(sc, TWE_PARAM_CONTROLLER, TWE_PARAM_CONTROLLER_PortCount, &ports);
1646 /* get version strings */
1647 p[0] = twe_get_param(sc, TWE_PARAM_VERSION, TWE_PARAM_VERSION_FW, 16, NULL);
1648 p[1] = twe_get_param(sc, TWE_PARAM_VERSION, TWE_PARAM_VERSION_BIOS, 16, NULL);
1650 twe_printf(sc, "%d ports, Firmware %.16s, BIOS %.16s\n", ports, p[0]->data, p[1]->data);
1653 p[2] = twe_get_param(sc, TWE_PARAM_VERSION, TWE_PARAM_VERSION_Mon, 16, NULL);
1654 p[3] = twe_get_param(sc, TWE_PARAM_VERSION, TWE_PARAM_VERSION_PCB, 8, NULL);
1655 p[4] = twe_get_param(sc, TWE_PARAM_VERSION, TWE_PARAM_VERSION_ATA, 8, NULL);
1656 p[5] = twe_get_param(sc, TWE_PARAM_VERSION, TWE_PARAM_VERSION_PCI, 8, NULL);
1658 if (p[2] && p[3] && p[4] && p[5])
1659 twe_printf(sc, "Monitor %.16s, PCB %.8s, Achip %.8s, Pchip %.8s\n", p[2]->data, p[3]->data,
1660 p[4]->data, p[5]->data);
1662 free(p[2], M_DEVBUF);
1664 free(p[3], M_DEVBUF);
1666 free(p[4], M_DEVBUF);
1668 free(p[5], M_DEVBUF);
1671 free(p[0], M_DEVBUF);
1673 free(p[1], M_DEVBUF);
1675 /* print attached drives */
1677 p[0] = twe_get_param(sc, TWE_PARAM_DRIVESUMMARY, TWE_PARAM_DRIVESUMMARY_Status, 16, NULL);
1678 for (i = 0; i < ports; i++) {
1679 if (p[0]->data[i] != TWE_PARAM_DRIVESTATUS_Present)
1681 twe_get_param_4(sc, TWE_PARAM_DRIVEINFO + i, TWE_PARAM_DRIVEINFO_Size, &size);
1682 p[1] = twe_get_param(sc, TWE_PARAM_DRIVEINFO + i, TWE_PARAM_DRIVEINFO_Model, 40, NULL);
1684 twe_printf(sc, "port %d: %.40s %dMB\n", i, p[1]->data, size / 2048);
1685 free(p[1], M_DEVBUF);
1687 twe_printf(sc, "port %d, drive status unavailable\n", i);
1691 free(p[0], M_DEVBUF);
1696 /********************************************************************************
1697 * Look up a text description of a numeric code and return a pointer to same.
1700 twe_describe_code(struct twe_code_lookup *table, u_int32_t code)
1704 for (i = 0; table[i].string != NULL; i++)
1705 if (table[i].code == code)
1706 return(table[i].string);
1707 return(table[i+1].string);
1710 /********************************************************************************
1711 * Complain if the status bits aren't what we're expecting.
1713 * Rate-limit the complaints to at most one of each every five seconds, but
1714 * always return the correct status.
1717 twe_check_bits(struct twe_softc *sc, u_int32_t status_reg)
1720 static time_t lastwarn[2] = {0, 0};
1723 * This can be a little problematic, as twe_panic may call twe_reset if
1724 * TWE_DEBUG is not set, which will call us again as part of the soft reset.
1726 if ((status_reg & TWE_STATUS_PANIC_BITS) != 0) {
1727 twe_printf(sc, "FATAL STATUS BIT(S) %b\n", status_reg & TWE_STATUS_PANIC_BITS,
1728 TWE_STATUS_BITS_DESCRIPTION);
1729 twe_panic(sc, "fatal status bits");
1733 if ((status_reg & TWE_STATUS_EXPECTED_BITS) != TWE_STATUS_EXPECTED_BITS) {
1734 if (time_second > (lastwarn[0] + 5)) {
1735 twe_printf(sc, "missing expected status bit(s) %b\n", ~status_reg & TWE_STATUS_EXPECTED_BITS,
1736 TWE_STATUS_BITS_DESCRIPTION);
1737 lastwarn[0] = time_second;
1742 if ((status_reg & TWE_STATUS_UNEXPECTED_BITS) != 0) {
1743 if (time_second > (lastwarn[1] + 5)) {
1744 twe_printf(sc, "unexpected status bit(s) %b\n", status_reg & TWE_STATUS_UNEXPECTED_BITS,
1745 TWE_STATUS_BITS_DESCRIPTION);
1746 lastwarn[1] = time_second;
1749 if (status_reg & TWE_STATUS_PCI_PARITY_ERROR) {
1750 twe_printf(sc, "PCI parity error: Reseat card, move card or buggy device present.\n");
1751 twe_clear_pci_parity_error(sc);
1753 if (status_reg & TWE_STATUS_PCI_ABORT) {
1754 twe_printf(sc, "PCI abort, clearing.\n");
1755 twe_clear_pci_abort(sc);
1762 /********************************************************************************
1763 * Return a string describing (aen).
1765 * The low 8 bits of the aen are the code, the high 8 bits give the unit number
1766 * where an AEN is specific to a unit.
1768 * Note that we could expand this routine to handle eg. up/downgrading the status
1769 * of a drive if we had some idea of what the drive's initial status was.
1773 twe_format_aen(struct twe_softc *sc, u_int16_t aen)
1778 code = twe_describe_code(twe_table_aen, TWE_AEN_CODE(aen));
1790 if ((child = sc->twe_drive[TWE_AEN_UNIT(aen)].td_disk) != NULL) {
1791 snprintf(sc->twe_aen_buf, sizeof(sc->twe_aen_buf), "twed%d: %s",
1792 device_get_unit(child), msg);
1794 snprintf(sc->twe_aen_buf, sizeof(sc->twe_aen_buf),
1795 "twe%d: %s for unknown unit %d", device_get_unit(sc->twe_dev),
1796 msg, TWE_AEN_UNIT(aen));
1798 return(sc->twe_aen_buf);
1801 snprintf(sc->twe_aen_buf, sizeof(sc->twe_aen_buf),
1802 "twe%d: port %d: %s", device_get_unit(sc->twe_dev),
1803 TWE_AEN_UNIT(aen), msg);
1804 return(sc->twe_aen_buf);
1811 snprintf(sc->twe_aen_buf, sizeof(sc->twe_aen_buf), "unknown AEN 0x%x", aen);
1812 return(sc->twe_aen_buf);
1815 /********************************************************************************
1816 * Print a diagnostic if the status of the command warrants it, and return
1817 * either zero (command was ok) or nonzero (command failed).
1820 twe_report_request(struct twe_request *tr)
1822 struct twe_softc *sc = tr->tr_sc;
1823 TWE_Command *cmd = TWE_FIND_COMMAND(tr);
1827 * Check the command status value and handle accordingly.
1829 if (cmd->generic.status == TWE_STATUS_RESET) {
1831 * The status code 0xff requests a controller reset.
1833 twe_printf(sc, "command returned with controller reset request\n");
1836 } else if (cmd->generic.status > TWE_STATUS_FATAL) {
1838 * Fatal errors that don't require controller reset.
1840 * We know a few special flags values.
1842 switch (cmd->generic.flags) {
1844 device_printf(sc->twe_drive[cmd->generic.unit].td_disk,
1848 device_printf(sc->twe_drive[cmd->generic.unit].td_disk,
1849 "unrecoverable drive error");
1852 device_printf(sc->twe_drive[cmd->generic.unit].td_disk,
1853 "controller error - %s (flags = 0x%x)\n",
1854 twe_describe_code(twe_table_status, cmd->generic.status),
1855 cmd->generic.flags);
1858 } else if (cmd->generic.status > TWE_STATUS_WARNING) {
1860 * Warning level status.
1862 device_printf(sc->twe_drive[cmd->generic.unit].td_disk,
1863 "warning - %s (flags = 0x%x)\n",
1864 twe_describe_code(twe_table_status, cmd->generic.status),
1865 cmd->generic.flags);
1866 } else if (cmd->generic.status > 0x40) {
1868 * Info level status.
1870 device_printf(sc->twe_drive[cmd->generic.unit].td_disk,
1871 "attention - %s (flags = 0x%x)\n",
1872 twe_describe_code(twe_table_status, cmd->generic.status),
1873 cmd->generic.flags);
1879 /********************************************************************************
1880 * Print some controller state to aid in debugging error/panic conditions
1883 twe_print_controller(struct twe_softc *sc)
1885 u_int32_t status_reg;
1887 status_reg = TWE_STATUS(sc);
1888 twe_printf(sc, "status %b\n", status_reg, TWE_STATUS_BITS_DESCRIPTION);
1889 twe_printf(sc, " current max min\n");
1890 twe_printf(sc, "free %04d %04d %04d\n",
1891 sc->twe_qstat[TWEQ_FREE].q_length, sc->twe_qstat[TWEQ_FREE].q_max, sc->twe_qstat[TWEQ_FREE].q_min);
1893 twe_printf(sc, "ready %04d %04d %04d\n",
1894 sc->twe_qstat[TWEQ_READY].q_length, sc->twe_qstat[TWEQ_READY].q_max, sc->twe_qstat[TWEQ_READY].q_min);
1896 twe_printf(sc, "busy %04d %04d %04d\n",
1897 sc->twe_qstat[TWEQ_BUSY].q_length, sc->twe_qstat[TWEQ_BUSY].q_max, sc->twe_qstat[TWEQ_BUSY].q_min);
1899 twe_printf(sc, "complete %04d %04d %04d\n",
1900 sc->twe_qstat[TWEQ_COMPLETE].q_length, sc->twe_qstat[TWEQ_COMPLETE].q_max, sc->twe_qstat[TWEQ_COMPLETE].q_min);
1902 twe_printf(sc, "bioq %04d %04d %04d\n",
1903 sc->twe_qstat[TWEQ_BIO].q_length, sc->twe_qstat[TWEQ_BIO].q_max, sc->twe_qstat[TWEQ_BIO].q_min);
1905 twe_printf(sc, "AEN queue head %d tail %d\n", sc->twe_aen_head, sc->twe_aen_tail);
1909 twe_panic(struct twe_softc *sc, char *reason)
1911 twe_print_controller(sc);
1920 /********************************************************************************
1921 * Print a request/command in human-readable format.
1924 twe_print_request(struct twe_request *tr)
1926 struct twe_softc *sc = tr->tr_sc;
1927 TWE_Command *cmd = TWE_FIND_COMMAND(tr);
1930 twe_printf(sc, "CMD: request_id %d opcode <%s> size %d unit %d host_id %d\n",
1931 cmd->generic.request_id, twe_describe_code(twe_table_opcode, cmd->generic.opcode), cmd->generic.size,
1932 cmd->generic.unit, cmd->generic.host_id);
1933 twe_printf(sc, " status %d flags 0x%x count %d sgl_offset %d\n",
1934 cmd->generic.status, cmd->generic.flags, cmd->generic.count, cmd->generic.sgl_offset);
1936 switch(cmd->generic.opcode) { /* XXX add more opcodes? */
1939 twe_printf(sc, " lba %d\n", cmd->io.lba);
1940 for (i = 0; (i < TWE_MAX_SGL_LENGTH) && (cmd->io.sgl[i].length != 0); i++)
1941 twe_printf(sc, " %d: 0x%x/%d\n",
1942 i, cmd->io.sgl[i].address, cmd->io.sgl[i].length);
1945 case TWE_OP_GET_PARAM:
1946 case TWE_OP_SET_PARAM:
1947 for (i = 0; (i < TWE_MAX_SGL_LENGTH) && (cmd->param.sgl[i].length != 0); i++)
1948 twe_printf(sc, " %d: 0x%x/%d\n",
1949 i, cmd->param.sgl[i].address, cmd->param.sgl[i].length);
1952 case TWE_OP_INIT_CONNECTION:
1953 twe_printf(sc, " response queue pointer 0x%x\n",
1954 cmd->initconnection.response_queue_pointer);
1960 twe_printf(sc, " tr_command %p/0x%x tr_data %p/0x%x,%d\n",
1961 tr, TWE_FIND_COMMANDPHYS(tr), tr->tr_data, tr->tr_dataphys, tr->tr_length);
1962 twe_printf(sc, " tr_status %d tr_flags 0x%x tr_complete %p tr_private %p\n",
1963 tr->tr_status, tr->tr_flags, tr->tr_complete, tr->tr_private);