FreeBSD/Linux Kernel Cross Reference
sys/dev/twe/twe.c
1 /*-
2 * Copyright (c) 2000 Michael Smith
3 * Copyright (c) 2003 Paul Saab
4 * Copyright (c) 2003 Vinod Kashyap
5 * Copyright (c) 2000 BSDi
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 *
29 * $FreeBSD: releng/5.3/sys/dev/twe/twe.c 130358 2004-06-11 18:42:44Z vkashyap $
30 */
31
32 /*
33 * Driver for the 3ware Escalade family of IDE RAID controllers.
34 */
35
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>
42
43 /*
44 * Command submission.
45 */
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);
53 #endif
54 #if 0
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);
57 #endif
58 static int twe_set_param(struct twe_softc *sc, int table_id, int param_id, int param_size,
59 void *data);
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);
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);
67
68 /*
69 * Command I/O to controller.
70 */
71 static void twe_done(struct twe_softc *sc);
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);
77
78 /*
79 * Interrupt handling.
80 */
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);
84
85 /*
86 * Asynchronous event handling.
87 */
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);
94
95 /*
96 * Command buffer management.
97 */
98 static int twe_get_request(struct twe_softc *sc, struct twe_request **tr);
99 static void twe_release_request(struct twe_request *tr);
100
101 /*
102 * Debugging.
103 */
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);
107
108 /********************************************************************************
109 ********************************************************************************
110 Public Interfaces
111 ********************************************************************************
112 ********************************************************************************/
113
114 /********************************************************************************
115 * Initialise the controller, set up driver data structures.
116 */
117 int
118 twe_setup(struct twe_softc *sc)
119 {
120 struct twe_request *tr;
121 TWE_Command *cmd;
122 u_int32_t status_reg;
123 int i;
124
125 debug_called(4);
126
127 /*
128 * Initialise request queues.
129 */
130 twe_initq_free(sc);
131 twe_initq_bio(sc);
132 twe_initq_ready(sc);
133 twe_initq_busy(sc);
134 twe_initq_complete(sc);
135 sc->twe_wait_aen = -1;
136
137 /*
138 * Allocate request structures up front.
139 */
140 for (i = 0; i < TWE_Q_LENGTH; i++) {
141 if ((tr = twe_allocate_request(sc, i)) == NULL)
142 return(ENOMEM);
143 /*
144 * Set global defaults that won't change.
145 */
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;
150
151 /*
152 * Put command onto the freelist.
153 */
154 twe_release_request(tr);
155 }
156
157 /*
158 * Check status register for errors, clear them.
159 */
160 status_reg = TWE_STATUS(sc);
161 twe_check_bits(sc, status_reg);
162
163 /*
164 * Wait for the controller to come ready.
165 */
166 if (twe_wait_status(sc, TWE_STATUS_MICROCONTROLLER_READY, 60)) {
167 twe_printf(sc, "microcontroller not ready\n");
168 return(ENXIO);
169 }
170
171 /*
172 * Disable interrupts from the card.
173 */
174 twe_disable_interrupts(sc);
175
176 /*
177 * Soft reset the controller, look for the AEN acknowledging the reset,
178 * check for errors, drain the response queue.
179 */
180 for (i = 0; i < TWE_MAX_RESET_TRIES; i++) {
181
182 if (i > 0)
183 twe_printf(sc, "reset %d failed, trying again\n", i);
184
185 if (!twe_soft_reset(sc))
186 break; /* reset process complete */
187 }
188 /* did we give up? */
189 if (i >= TWE_MAX_RESET_TRIES) {
190 twe_printf(sc, "can't initialise controller, giving up\n");
191 return(ENXIO);
192 }
193
194 return(0);
195 }
196
197 static int
198 twe_add_unit(struct twe_softc *sc, int unit)
199 {
200 struct twe_drive *dr;
201 int table, error = 0;
202 u_int16_t dsize;
203 TWE_Param *drives = NULL, *param = NULL;
204 TWE_Unit_Descriptor *ud;
205
206 if (unit < 0 || unit > TWE_MAX_UNITS)
207 return (EINVAL);
208
209 /*
210 * The controller is in a safe state, so try to find drives attached to it.
211 */
212 if ((drives = twe_get_param(sc, TWE_PARAM_UNITSUMMARY, TWE_PARAM_UNITSUMMARY_Status,
213 TWE_MAX_UNITS, NULL)) == NULL) {
214 twe_printf(sc, "can't detect attached units\n");
215 return (EIO);
216 }
217
218 dr = &sc->twe_drive[unit];
219 /* check that the drive is online */
220 if (!(drives->data[unit] & TWE_PARAM_UNITSTATUS_Online)) {
221 error = ENXIO;
222 goto out;
223 }
224
225 table = TWE_PARAM_UNITINFO + unit;
226
227 if (twe_get_param_4(sc, table, TWE_PARAM_UNITINFO_Capacity, &dr->td_size)) {
228 twe_printf(sc, "error fetching capacity for unit %d\n", unit);
229 error = EIO;
230 goto out;
231 }
232 if (twe_get_param_1(sc, table, TWE_PARAM_UNITINFO_Status, &dr->td_state)) {
233 twe_printf(sc, "error fetching state for unit %d\n", unit);
234 error = EIO;
235 goto out;
236 }
237 if (twe_get_param_2(sc, table, TWE_PARAM_UNITINFO_DescriptorSize, &dsize)) {
238 twe_printf(sc, "error fetching descriptor size for unit %d\n", unit);
239 error = EIO;
240 goto out;
241 }
242 if ((param = twe_get_param(sc, table, TWE_PARAM_UNITINFO_Descriptor, dsize - 3, NULL)) == NULL) {
243 twe_printf(sc, "error fetching descriptor for unit %d\n", unit);
244 error = EIO;
245 goto out;
246 }
247 ud = (TWE_Unit_Descriptor *)param->data;
248 dr->td_type = ud->configuration;
249
250 /* build synthetic geometry as per controller internal rules */
251 if (dr->td_size > 0x200000) {
252 dr->td_heads = 255;
253 dr->td_sectors = 63;
254 } else {
255 dr->td_heads = 64;
256 dr->td_sectors = 32;
257 }
258 dr->td_cylinders = dr->td_size / (dr->td_heads * dr->td_sectors);
259 dr->td_twe_unit = unit;
260
261 error = twe_attach_drive(sc, dr);
262
263 out:
264 if (param != NULL)
265 free(param, M_DEVBUF);
266 if (drives != NULL)
267 free(drives, M_DEVBUF);
268 return (error);
269 }
270
271 static int
272 twe_del_unit(struct twe_softc *sc, int unit)
273 {
274 int error;
275
276 if (unit < 0 || unit >= TWE_MAX_UNITS)
277 return (ENXIO);
278
279 if (sc->twe_drive[unit].td_disk == NULL)
280 return (ENXIO);
281
282 error = twe_detach_drive(sc, unit);
283 return (error);
284 }
285
286 /********************************************************************************
287 * Locate disk devices and attach children to them.
288 */
289 void
290 twe_init(struct twe_softc *sc)
291 {
292 int i;
293
294 /*
295 * Scan for drives
296 */
297 for (i = 0; i < TWE_MAX_UNITS; i++)
298 twe_add_unit(sc, i);
299
300 /*
301 * Initialise connection with controller.
302 */
303 twe_init_connection(sc, TWE_INIT_MESSAGE_CREDITS);
304
305 #ifdef TWE_SHUTDOWN_NOTIFICATION
306 /*
307 * Tell the controller we support shutdown notification.
308 */
309 twe_set_param_1(sc, TWE_PARAM_FEATURES, TWE_PARAM_FEATURES_DriverShutdown, 1);
310 #endif
311
312 /*
313 * Mark controller up and ready to run.
314 */
315 sc->twe_state &= ~TWE_STATE_SHUTDOWN;
316
317 /*
318 * Finally enable interrupts.
319 */
320 twe_enable_interrupts(sc);
321 }
322
323 /********************************************************************************
324 * Stop the controller
325 */
326 void
327 twe_deinit(struct twe_softc *sc)
328 {
329 /*
330 * Mark the controller as shutting down, and disable any further interrupts.
331 */
332 sc->twe_state |= TWE_STATE_SHUTDOWN;
333 twe_disable_interrupts(sc);
334
335 #ifdef TWE_SHUTDOWN_NOTIFICATION
336 /*
337 * Disconnect from the controller
338 */
339 twe_init_connection(sc, TWE_SHUTDOWN_MESSAGE_CREDITS);
340 #endif
341 }
342
343 /*******************************************************************************
344 * Take an interrupt, or be poked by other code to look for interrupt-worthy
345 * status.
346 */
347 void
348 twe_intr(struct twe_softc *sc)
349 {
350 u_int32_t status_reg;
351
352 debug_called(4);
353
354 /*
355 * Collect current interrupt status.
356 */
357 status_reg = TWE_STATUS(sc);
358 twe_check_bits(sc, status_reg);
359
360 /*
361 * Dispatch based on interrupt status
362 */
363 if (status_reg & TWE_STATUS_HOST_INTERRUPT)
364 twe_host_intr(sc);
365 if (status_reg & TWE_STATUS_ATTENTION_INTERRUPT)
366 twe_attention_intr(sc);
367 if (status_reg & TWE_STATUS_COMMAND_INTERRUPT)
368 twe_command_intr(sc);
369 if (status_reg & TWE_STATUS_RESPONSE_INTERRUPT)
370 twe_done(sc);
371 };
372
373 /********************************************************************************
374 * Pull as much work off the softc's work queue as possible and give it to the
375 * controller.
376 */
377 void
378 twe_startio(struct twe_softc *sc)
379 {
380 struct twe_request *tr;
381 TWE_Command *cmd;
382 twe_bio *bp;
383 int error;
384
385 debug_called(4);
386
387 if (sc->twe_state & (TWE_STATE_CTLR_BUSY | TWE_STATE_FRZN))
388 return;
389
390 /* spin until something prevents us from doing any work */
391 for (;;) {
392
393 /* try to get a command that's already ready to go */
394 tr = twe_dequeue_ready(sc);
395
396 /* build a command from an outstanding bio */
397 if (tr == NULL) {
398
399 /* get a command to handle the bio with */
400 if (twe_get_request(sc, &tr))
401 break;
402
403 /* see if there's work to be done */
404 if ((bp = twe_dequeue_bio(sc)) == NULL) {
405 twe_release_request(tr);
406 break;
407 }
408
409 /* connect the bio to the command */
410 tr->tr_complete = twe_completeio;
411 tr->tr_private = bp;
412 tr->tr_data = TWE_BIO_DATA(bp);
413 tr->tr_length = TWE_BIO_LENGTH(bp);
414 cmd = TWE_FIND_COMMAND(tr);
415 if (TWE_BIO_IS_READ(bp)) {
416 tr->tr_flags |= TWE_CMD_DATAIN;
417 cmd->io.opcode = TWE_OP_READ;
418 } else {
419 tr->tr_flags |= TWE_CMD_DATAOUT;
420 cmd->io.opcode = TWE_OP_WRITE;
421 }
422
423 /* build a suitable I/O command (assumes 512-byte rounded transfers) */
424 cmd->io.size = 3;
425 cmd->io.unit = TWE_BIO_UNIT(bp);
426 cmd->io.block_count = (tr->tr_length + TWE_BLOCK_SIZE - 1) / TWE_BLOCK_SIZE;
427 cmd->io.lba = TWE_BIO_LBA(bp);
428 }
429
430 /* did we find something to do? */
431 if (tr == NULL)
432 break;
433
434 /* try to map and submit the command to controller */
435 error = twe_map_request(tr);
436
437 if (error != 0) {
438 if (error == EBUSY)
439 break;
440 tr->tr_status = TWE_CMD_ERROR;
441 if (tr->tr_private != NULL) {
442 bp = (twe_bio *)(tr->tr_private);
443 TWE_BIO_SET_ERROR(bp, error);
444 tr->tr_private = NULL;
445 twed_intr(bp);
446 twe_release_request(tr);
447 } else if (tr->tr_flags & TWE_CMD_SLEEPER)
448 wakeup_one(tr); /* wakeup the sleeping owner */
449 }
450 }
451 }
452
453 /********************************************************************************
454 * Write blocks from memory to disk, for system crash dumps.
455 */
456 int
457 twe_dump_blocks(struct twe_softc *sc, int unit, u_int32_t lba, void *data, int nblks)
458 {
459 struct twe_request *tr;
460 TWE_Command *cmd;
461 int error;
462
463 if (twe_get_request(sc, &tr))
464 return(ENOMEM);
465
466 tr->tr_data = data;
467 tr->tr_status = TWE_CMD_SETUP;
468 tr->tr_length = nblks * TWE_BLOCK_SIZE;
469 tr->tr_flags = TWE_CMD_DATAOUT;
470
471 cmd = TWE_FIND_COMMAND(tr);
472 cmd->io.opcode = TWE_OP_WRITE;
473 cmd->io.size = 3;
474 cmd->io.unit = unit;
475 cmd->io.block_count = nblks;
476 cmd->io.lba = lba;
477
478 error = twe_immediate_request(tr);
479 if (error == 0)
480 if (twe_report_request(tr))
481 error = EIO;
482 twe_release_request(tr);
483 return(error);
484 }
485
486 /********************************************************************************
487 * Handle controller-specific control operations.
488 */
489 int
490 twe_ioctl(struct twe_softc *sc, int ioctlcmd, void *addr)
491 {
492 struct twe_usercommand *tu = (struct twe_usercommand *)addr;
493 struct twe_paramcommand *tp = (struct twe_paramcommand *)addr;
494 struct twe_drivecommand *td = (struct twe_drivecommand *)addr;
495 union twe_statrequest *ts = (union twe_statrequest *)addr;
496 TWE_Param *param;
497 TWE_Command *cmd;
498 void *data;
499 u_int16_t *aen_code = (u_int16_t *)addr;
500 struct twe_request *tr;
501 u_int8_t srid;
502 int s, error;
503
504 error = 0;
505 switch(ioctlcmd) {
506 /* handle a command from userspace */
507 case TWEIO_COMMAND:
508 /* get a request */
509 while (twe_get_request(sc, &tr))
510 tsleep(sc, PPAUSE, "twioctl", hz);
511
512 /*
513 * Save the command's request ID, copy the user-supplied command in,
514 * restore the request ID.
515 */
516 cmd = TWE_FIND_COMMAND(tr);
517 srid = cmd->generic.request_id;
518 bcopy(&tu->tu_command, cmd, sizeof(TWE_Command));
519 cmd->generic.request_id = srid;
520
521 /*
522 * if there's a data buffer, allocate and copy it in.
523 * Must be in multipled of 512 bytes.
524 */
525 tr->tr_length = (tu->tu_size + 511) & ~511;
526 if (tr->tr_length > 0) {
527 if ((tr->tr_data = malloc(tr->tr_length, M_DEVBUF, M_WAITOK)) == NULL) {
528 error = ENOMEM;
529 goto cmd_done;
530 }
531 if ((error = copyin(tu->tu_data, tr->tr_data, tu->tu_size)) != 0)
532 goto cmd_done;
533 tr->tr_flags |= TWE_CMD_DATAIN | TWE_CMD_DATAOUT;
534 }
535
536 /* run the command */
537 error = twe_wait_request(tr);
538 if (error)
539 goto cmd_done;
540
541 /* copy the command out again */
542 bcopy(cmd, &tu->tu_command, sizeof(TWE_Command));
543
544 /* if there was a data buffer, copy it out */
545 if (tr->tr_length > 0)
546 error = copyout(tr->tr_data, tu->tu_data, tu->tu_size);
547
548 cmd_done:
549 /* free resources */
550 if (tr->tr_data != NULL)
551 free(tr->tr_data, M_DEVBUF);
552 if (tr != NULL)
553 twe_release_request(tr);
554
555 break;
556
557 /* fetch statistics counter */
558 case TWEIO_STATS:
559 switch (ts->ts_item) {
560 #ifdef TWE_PERFORMANCE_MONITOR
561 case TWEQ_FREE:
562 case TWEQ_BIO:
563 case TWEQ_READY:
564 case TWEQ_BUSY:
565 case TWEQ_COMPLETE:
566 bcopy(&sc->twe_qstat[ts->ts_item], &ts->ts_qstat, sizeof(struct twe_qstat));
567 break;
568 #endif
569 default:
570 error = ENOENT;
571 break;
572 }
573 break;
574
575 /* poll for an AEN */
576 case TWEIO_AEN_POLL:
577 *aen_code = twe_dequeue_aen(sc);
578 break;
579
580 /* wait for another AEN to show up */
581 case TWEIO_AEN_WAIT:
582 s = splbio();
583 while ((*aen_code = twe_dequeue_aen(sc)) == TWE_AEN_QUEUE_EMPTY) {
584 error = tsleep(&sc->twe_aen_queue, PRIBIO | PCATCH, "tweaen", 0);
585 if (error == EINTR)
586 break;
587 }
588 splx(s);
589 break;
590
591 case TWEIO_GET_PARAM:
592 if ((param = twe_get_param(sc, tp->tp_table_id, tp->tp_param_id, tp->tp_size, NULL)) == NULL) {
593 twe_printf(sc, "TWEIO_GET_PARAM failed for 0x%x/0x%x/%d\n",
594 tp->tp_table_id, tp->tp_param_id, tp->tp_size);
595 error = EINVAL;
596 } else {
597 if (param->parameter_size_bytes > tp->tp_size) {
598 twe_printf(sc, "TWEIO_GET_PARAM parameter too large (%d > %d)\n",
599 param->parameter_size_bytes, tp->tp_size);
600 error = EFAULT;
601 } else {
602 error = copyout(param->data, tp->tp_data, param->parameter_size_bytes);
603 }
604 free(param, M_DEVBUF);
605 }
606 break;
607
608 case TWEIO_SET_PARAM:
609 if ((data = malloc(tp->tp_size, M_DEVBUF, M_WAITOK)) == NULL) {
610 error = ENOMEM;
611 } else {
612 error = copyin(tp->tp_data, data, tp->tp_size);
613 if (error == 0)
614 error = twe_set_param(sc, tp->tp_table_id, tp->tp_param_id, tp->tp_size, data);
615 free(data, M_DEVBUF);
616 }
617 break;
618
619 case TWEIO_RESET:
620 twe_reset(sc);
621 break;
622
623 case TWEIO_ADD_UNIT:
624 error = twe_add_unit(sc, td->td_unit);
625 break;
626
627 case TWEIO_DEL_UNIT:
628 error = twe_del_unit(sc, td->td_unit);
629 break;
630
631 /* XXX implement ATA PASSTHROUGH */
632
633 /* nothing we understand */
634 default:
635 error = ENOTTY;
636 }
637
638 return(error);
639 }
640
641 /********************************************************************************
642 * Enable the useful interrupts from the controller.
643 */
644 void
645 twe_enable_interrupts(struct twe_softc *sc)
646 {
647 sc->twe_state |= TWE_STATE_INTEN;
648 TWE_CONTROL(sc,
649 TWE_CONTROL_CLEAR_ATTENTION_INTERRUPT |
650 TWE_CONTROL_UNMASK_RESPONSE_INTERRUPT |
651 TWE_CONTROL_ENABLE_INTERRUPTS);
652 }
653
654 /********************************************************************************
655 * Disable interrupts from the controller.
656 */
657 void
658 twe_disable_interrupts(struct twe_softc *sc)
659 {
660 TWE_CONTROL(sc, TWE_CONTROL_DISABLE_INTERRUPTS);
661 sc->twe_state &= ~TWE_STATE_INTEN;
662 }
663
664 /********************************************************************************
665 ********************************************************************************
666 Command Submission
667 ********************************************************************************
668 ********************************************************************************/
669
670 /********************************************************************************
671 * Read integer parameter table entries.
672 */
673 static int
674 twe_get_param_1(struct twe_softc *sc, int table_id, int param_id, u_int8_t *result)
675 {
676 TWE_Param *param;
677
678 if ((param = twe_get_param(sc, table_id, param_id, 1, NULL)) == NULL)
679 return(ENOENT);
680 *result = *(u_int8_t *)param->data;
681 free(param, M_DEVBUF);
682 return(0);
683 }
684
685 static int
686 twe_get_param_2(struct twe_softc *sc, int table_id, int param_id, u_int16_t *result)
687 {
688 TWE_Param *param;
689
690 if ((param = twe_get_param(sc, table_id, param_id, 2, NULL)) == NULL)
691 return(ENOENT);
692 *result = *(u_int16_t *)param->data;
693 free(param, M_DEVBUF);
694 return(0);
695 }
696
697 static int
698 twe_get_param_4(struct twe_softc *sc, int table_id, int param_id, u_int32_t *result)
699 {
700 TWE_Param *param;
701
702 if ((param = twe_get_param(sc, table_id, param_id, 4, NULL)) == NULL)
703 return(ENOENT);
704 *result = *(u_int32_t *)param->data;
705 free(param, M_DEVBUF);
706 return(0);
707 }
708
709 /********************************************************************************
710 * Perform a TWE_OP_GET_PARAM command. If a callback function is provided, it
711 * will be called with the command when it's completed. If no callback is
712 * provided, we will wait for the command to complete and then return just the data.
713 * The caller is responsible for freeing the data when done with it.
714 */
715 static void *
716 twe_get_param(struct twe_softc *sc, int table_id, int param_id, size_t param_size,
717 void (* func)(struct twe_request *tr))
718 {
719 struct twe_request *tr;
720 TWE_Command *cmd;
721 TWE_Param *param;
722 int error;
723
724 debug_called(4);
725
726 tr = NULL;
727 param = NULL;
728
729 /* get a command */
730 if (twe_get_request(sc, &tr))
731 goto err;
732
733 /* get a buffer */
734 if ((param = (TWE_Param *)malloc(TWE_SECTOR_SIZE, M_DEVBUF, M_NOWAIT)) == NULL)
735 goto err;
736 tr->tr_data = param;
737 tr->tr_length = TWE_SECTOR_SIZE;
738 tr->tr_flags = TWE_CMD_DATAIN | TWE_CMD_DATAOUT;
739
740 /* build the command for the controller */
741 cmd = TWE_FIND_COMMAND(tr);
742 cmd->param.opcode = TWE_OP_GET_PARAM;
743 cmd->param.size = 2;
744 cmd->param.unit = 0;
745 cmd->param.param_count = 1;
746
747 /* fill in the outbound parameter data */
748 param->table_id = table_id;
749 param->parameter_id = param_id;
750 param->parameter_size_bytes = param_size;
751
752 /* submit the command and either wait or let the callback handle it */
753 if (func == NULL) {
754 /* XXX could use twe_wait_request here if interrupts were enabled? */
755 error = twe_immediate_request(tr);
756 if (error == 0) {
757 if (twe_report_request(tr))
758 goto err;
759 } else {
760 goto err;
761 }
762 twe_release_request(tr);
763 return(param);
764 } else {
765 tr->tr_complete = func;
766 error = twe_map_request(tr);
767 if ((error == 0) || (error == EBUSY))
768 return(func);
769 }
770
771 /* something failed */
772 err:
773 debug(1, "failed");
774 if (tr != NULL)
775 twe_release_request(tr);
776 if (param != NULL)
777 free(param, M_DEVBUF);
778 return(NULL);
779 }
780
781 /********************************************************************************
782 * Set integer parameter table entries.
783 */
784 #ifdef TWE_SHUTDOWN_NOTIFICATION
785 static int
786 twe_set_param_1(struct twe_softc *sc, int table_id, int param_id, u_int8_t value)
787 {
788 return(twe_set_param(sc, table_id, param_id, sizeof(value), &value));
789 }
790 #endif
791
792 #if 0
793 static int
794 twe_set_param_2(struct twe_softc *sc, int table_id, int param_id, u_int16_t value)
795 {
796 return(twe_set_param(sc, table_id, param_id, sizeof(value), &value));
797 }
798
799 static int
800 twe_set_param_4(struct twe_softc *sc, int table_id, int param_id, u_int32_t value)
801 {
802 return(twe_set_param(sc, table_id, param_id, sizeof(value), &value));
803 }
804 #endif
805
806 /********************************************************************************
807 * Perform a TWE_OP_SET_PARAM command, returns nonzero on error.
808 */
809 static int
810 twe_set_param(struct twe_softc *sc, int table_id, int param_id, int param_size, void *data)
811 {
812 struct twe_request *tr;
813 TWE_Command *cmd;
814 TWE_Param *param;
815 int error;
816
817 debug_called(4);
818
819 tr = NULL;
820 param = NULL;
821 error = ENOMEM;
822
823 /* get a command */
824 if (twe_get_request(sc, &tr))
825 goto out;
826
827 /* get a buffer */
828 if ((param = (TWE_Param *)malloc(TWE_SECTOR_SIZE, M_DEVBUF, M_NOWAIT)) == NULL)
829 goto out;
830 tr->tr_data = param;
831 tr->tr_length = TWE_SECTOR_SIZE;
832 tr->tr_flags = TWE_CMD_DATAIN | TWE_CMD_DATAOUT;
833
834 /* build the command for the controller */
835 cmd = TWE_FIND_COMMAND(tr);
836 cmd->param.opcode = TWE_OP_SET_PARAM;
837 cmd->param.size = 2;
838 cmd->param.unit = 0;
839 cmd->param.param_count = 1;
840
841 /* fill in the outbound parameter data */
842 param->table_id = table_id;
843 param->parameter_id = param_id;
844 param->parameter_size_bytes = param_size;
845 bcopy(data, param->data, param_size);
846
847 /* XXX could use twe_wait_request here if interrupts were enabled? */
848 error = twe_immediate_request(tr);
849 if (error == 0) {
850 if (twe_report_request(tr))
851 error = EIO;
852 }
853
854 out:
855 if (tr != NULL)
856 twe_release_request(tr);
857 if (param != NULL)
858 free(param, M_DEVBUF);
859 return(error);
860 }
861
862 /********************************************************************************
863 * Perform a TWE_OP_INIT_CONNECTION command, returns nonzero on error.
864 *
865 * Typically called with interrupts disabled.
866 */
867 static int
868 twe_init_connection(struct twe_softc *sc, int mode)
869 {
870 struct twe_request *tr;
871 TWE_Command *cmd;
872 int error;
873
874 debug_called(4);
875
876 /* get a command */
877 if (twe_get_request(sc, &tr))
878 return(0);
879
880 /* build the command */
881 cmd = TWE_FIND_COMMAND(tr);
882 cmd->initconnection.opcode = TWE_OP_INIT_CONNECTION;
883 cmd->initconnection.size = 3;
884 cmd->initconnection.host_id = 0;
885 cmd->initconnection.message_credits = mode;
886 cmd->initconnection.response_queue_pointer = 0;
887
888 /* submit the command */
889 error = twe_immediate_request(tr);
890 twe_release_request(tr);
891
892 if (mode == TWE_INIT_MESSAGE_CREDITS)
893 sc->twe_host_id = cmd->initconnection.host_id;
894 return(error);
895 }
896
897 /********************************************************************************
898 * Start the command (tr) and sleep waiting for it to complete.
899 *
900 * Successfully completed commands are dequeued.
901 */
902 static int
903 twe_wait_request(struct twe_request *tr)
904 {
905 int s;
906
907 debug_called(4);
908
909 tr->tr_flags |= TWE_CMD_SLEEPER;
910 tr->tr_status = TWE_CMD_BUSY;
911 twe_enqueue_ready(tr);
912 twe_startio(tr->tr_sc);
913 s = splbio();
914 while (tr->tr_status == TWE_CMD_BUSY)
915 tsleep(tr, PRIBIO, "twewait", 0);
916 splx(s);
917
918 return(tr->tr_status != TWE_CMD_COMPLETE);
919 }
920
921 /********************************************************************************
922 * Start the command (tr) and busy-wait for it to complete.
923 * This should only be used when interrupts are actually disabled (although it
924 * will work if they are not).
925 */
926 static int
927 twe_immediate_request(struct twe_request *tr)
928 {
929 int error;
930
931 debug_called(4);
932
933 tr->tr_flags |= TWE_CMD_IMMEDIATE;
934 tr->tr_status = TWE_CMD_BUSY;
935 if ((error = twe_map_request(tr)) != 0)
936 if (error != EBUSY)
937 return(error);
938 while (tr->tr_status == TWE_CMD_BUSY){
939 twe_done(tr->tr_sc);
940 }
941 return(tr->tr_status != TWE_CMD_COMPLETE);
942 }
943
944 /********************************************************************************
945 * Handle completion of an I/O command.
946 */
947 static void
948 twe_completeio(struct twe_request *tr)
949 {
950 TWE_Command *cmd = TWE_FIND_COMMAND(tr);
951 struct twe_softc *sc = tr->tr_sc;
952 twe_bio *bp = (twe_bio *)tr->tr_private;
953
954 debug_called(4);
955
956 if (tr->tr_status == TWE_CMD_COMPLETE) {
957
958 if (cmd->generic.status)
959 if (twe_report_request(tr))
960 TWE_BIO_SET_ERROR(bp, EIO);
961
962 } else {
963 twe_panic(sc, "twe_completeio on incomplete command");
964 }
965 tr->tr_private = NULL;
966 twed_intr(bp);
967 twe_release_request(tr);
968 }
969
970 /********************************************************************************
971 * Reset the controller and pull all the active commands back onto the ready
972 * queue. Used to restart a controller that's exhibiting bad behaviour.
973 */
974 static void
975 twe_reset(struct twe_softc *sc)
976 {
977 struct twe_request *tr;
978 int i, s;
979
980 /*
981 * Sleep for a short period to allow AENs to be signalled.
982 */
983 tsleep(sc, PRIBIO, "twereset", hz);
984
985 /*
986 * Disable interrupts from the controller, and mask any accidental entry
987 * into our interrupt handler.
988 */
989 twe_printf(sc, "controller reset in progress...\n");
990 twe_disable_interrupts(sc);
991 s = splbio();
992
993 /*
994 * Try to soft-reset the controller.
995 */
996 for (i = 0; i < TWE_MAX_RESET_TRIES; i++) {
997
998 if (i > 0)
999 twe_printf(sc, "reset %d failed, trying again\n", i);
1000
1001 if (!twe_soft_reset(sc))
1002 break; /* reset process complete */
1003 }
1004 /* did we give up? */
1005 if (i >= TWE_MAX_RESET_TRIES) {
1006 twe_printf(sc, "can't reset controller, giving up\n");
1007 goto out;
1008 }
1009
1010 /*
1011 * Move all of the commands that were busy back to the ready queue.
1012 */
1013 i = 0;
1014 while ((tr = twe_dequeue_busy(sc)) != NULL) {
1015 twe_enqueue_ready(tr);
1016 i++;
1017 }
1018
1019 /*
1020 * Kick the controller to start things going again, then re-enable interrupts.
1021 */
1022 twe_startio(sc);
1023 twe_enable_interrupts(sc);
1024 twe_printf(sc, "controller reset done, %d commands restarted\n", i);
1025
1026 out:
1027 splx(s);
1028 twe_enable_interrupts(sc);
1029 }
1030
1031 /********************************************************************************
1032 ********************************************************************************
1033 Command I/O to Controller
1034 ********************************************************************************
1035 ********************************************************************************/
1036
1037 /********************************************************************************
1038 * Try to deliver (tr) to the controller.
1039 *
1040 * Can be called at any interrupt level, with or without interrupts enabled.
1041 */
1042 int
1043 twe_start(struct twe_request *tr)
1044 {
1045 struct twe_softc *sc = tr->tr_sc;
1046 TWE_Command *cmd;
1047 int i, s, done;
1048 u_int32_t status_reg;
1049
1050 debug_called(4);
1051
1052 /* mark the command as currently being processed */
1053 tr->tr_status = TWE_CMD_BUSY;
1054 cmd = TWE_FIND_COMMAND(tr);
1055
1056 /*
1057 * Spin briefly waiting for the controller to come ready
1058 *
1059 * XXX it might be more efficient to return EBUSY immediately
1060 * and let the command be rescheduled.
1061 */
1062 for (i = 100000, done = 0; (i > 0) && !done; i--) {
1063 s = splbio();
1064
1065 /* check to see if we can post a command */
1066 status_reg = TWE_STATUS(sc);
1067 twe_check_bits(sc, status_reg);
1068
1069 if (!(status_reg & TWE_STATUS_COMMAND_QUEUE_FULL)) {
1070 twe_enqueue_busy(tr);
1071
1072 TWE_COMMAND_QUEUE(sc, TWE_FIND_COMMANDPHYS(tr));
1073 done = 1;
1074 /* move command to work queue */
1075 #ifdef TWE_DEBUG
1076 if (tr->tr_complete != NULL) {
1077 debug(3, "queued request %d with callback %p", cmd->generic.request_id, tr->tr_complete);
1078 } else if (tr->tr_flags & TWE_CMD_SLEEPER) {
1079 debug(3, "queued request %d with wait channel %p", cmd->generic.request_id, tr);
1080 } else {
1081 debug(3, "queued request %d for polling caller", cmd->generic.request_id);
1082 }
1083 #endif
1084 }
1085 splx(s); /* drop spl to allow completion interrupts */
1086 }
1087
1088 /* command is enqueued */
1089 if (done)
1090 return(0);
1091
1092 /*
1093 * We couldn't get the controller to take the command; try submitting it again later.
1094 * This should only happen if something is wrong with the controller, or if we have
1095 * overestimated the number of commands it can accept. (Should we actually reject
1096 * the command at this point?)
1097 */
1098 return(EBUSY);
1099 }
1100
1101 /********************************************************************************
1102 * Poll the controller (sc) for completed commands.
1103 *
1104 * Can be called at any interrupt level, with or without interrupts enabled.
1105 */
1106 static void
1107 twe_done(struct twe_softc *sc)
1108 {
1109 TWE_Response_Queue rq;
1110 TWE_Command *cmd;
1111 struct twe_request *tr;
1112 int s, found;
1113 u_int32_t status_reg;
1114
1115 debug_called(5);
1116
1117 /* loop collecting completed commands */
1118 found = 0;
1119 s = splbio();
1120 for (;;) {
1121 status_reg = TWE_STATUS(sc);
1122 twe_check_bits(sc, status_reg); /* XXX should this fail? */
1123
1124 if (!(status_reg & TWE_STATUS_RESPONSE_QUEUE_EMPTY)) {
1125 found = 1;
1126 rq = TWE_RESPONSE_QUEUE(sc);
1127 tr = sc->twe_lookup[rq.u.response_id]; /* find command */
1128 cmd = TWE_FIND_COMMAND(tr);
1129 if (tr->tr_status != TWE_CMD_BUSY)
1130 twe_printf(sc, "completion event for nonbusy command\n");
1131 tr->tr_status = TWE_CMD_COMPLETE;
1132 debug(3, "completed request id %d with status %d",
1133 cmd->generic.request_id, cmd->generic.status);
1134 /* move to completed queue */
1135 twe_remove_busy(tr);
1136 twe_enqueue_complete(tr);
1137 sc->twe_state &= ~TWE_STATE_CTLR_BUSY;
1138 } else {
1139 break; /* no response ready */
1140 }
1141 }
1142 splx(s);
1143
1144 /* if we've completed any commands, try posting some more */
1145 if (found)
1146 twe_startio(sc);
1147
1148 /* handle completion and timeouts */
1149 twe_complete(sc); /* XXX use deferred completion? */
1150 }
1151
1152 /********************************************************************************
1153 * Perform post-completion processing for commands on (sc).
1154 *
1155 * This is split from twe_done as it can be safely deferred and run at a lower
1156 * priority level should facilities for such a thing become available.
1157 */
1158 static void
1159 twe_complete(struct twe_softc *sc)
1160 {
1161 struct twe_request *tr;
1162
1163 debug_called(5);
1164
1165 /*
1166 * Pull commands off the completed list, dispatch them appropriately
1167 */
1168 while ((tr = twe_dequeue_complete(sc)) != NULL) {
1169 /* unmap the command's data buffer */
1170 twe_unmap_request(tr);
1171
1172 /* dispatch to suit command originator */
1173 if (tr->tr_complete != NULL) { /* completion callback */
1174 debug(2, "call completion handler %p", tr->tr_complete);
1175 tr->tr_complete(tr);
1176
1177 } else if (tr->tr_flags & TWE_CMD_SLEEPER) { /* caller is asleep waiting */
1178 debug(2, "wake up command owner on %p", tr);
1179 wakeup_one(tr);
1180
1181 } else { /* caller is polling command */
1182 debug(2, "command left for owner");
1183 }
1184 }
1185 }
1186
1187 /********************************************************************************
1188 * Wait for (status) to be set in the controller status register for up to
1189 * (timeout) seconds. Returns 0 if found, nonzero if we time out.
1190 *
1191 * Note: this busy-waits, rather than sleeping, since we may be called with
1192 * eg. clock interrupts masked.
1193 */
1194 static int
1195 twe_wait_status(struct twe_softc *sc, u_int32_t status, int timeout)
1196 {
1197 time_t expiry;
1198 u_int32_t status_reg;
1199
1200 debug_called(4);
1201
1202 expiry = time_second + timeout;
1203
1204 do {
1205 status_reg = TWE_STATUS(sc);
1206 if (status_reg & status) /* got the required bit(s)? */
1207 return(0);
1208 DELAY(100000);
1209 } while (time_second <= expiry);
1210
1211 return(1);
1212 }
1213
1214 /********************************************************************************
1215 * Drain the response queue, which may contain responses to commands we know
1216 * nothing about.
1217 */
1218 static int
1219 twe_drain_response_queue(struct twe_softc *sc)
1220 {
1221 TWE_Response_Queue rq;
1222 u_int32_t status_reg;
1223
1224 debug_called(4);
1225
1226 for (;;) { /* XXX give up eventually? */
1227 status_reg = TWE_STATUS(sc);
1228 if (twe_check_bits(sc, status_reg))
1229 return(1);
1230 if (status_reg & TWE_STATUS_RESPONSE_QUEUE_EMPTY)
1231 return(0);
1232 rq = TWE_RESPONSE_QUEUE(sc);
1233 }
1234 }
1235
1236 /********************************************************************************
1237 * Soft-reset the controller
1238 */
1239 static int
1240 twe_soft_reset(struct twe_softc *sc)
1241 {
1242 u_int32_t status_reg;
1243
1244 debug_called(2);
1245
1246 TWE_SOFT_RESET(sc);
1247
1248 if (twe_wait_status(sc, TWE_STATUS_ATTENTION_INTERRUPT, 30)) {
1249 twe_printf(sc, "no attention interrupt\n");
1250 return(1);
1251 }
1252 TWE_CONTROL(sc, TWE_CONTROL_CLEAR_ATTENTION_INTERRUPT);
1253 if (twe_drain_aen_queue(sc)) {
1254 twe_printf(sc, "can't drain AEN queue\n");
1255 return(1);
1256 }
1257 if (twe_find_aen(sc, TWE_AEN_SOFT_RESET)) {
1258 twe_printf(sc, "reset not reported\n");
1259 return(1);
1260 }
1261 status_reg = TWE_STATUS(sc);
1262 if (TWE_STATUS_ERRORS(status_reg) || twe_check_bits(sc, status_reg)) {
1263 twe_printf(sc, "controller errors detected\n");
1264 return(1);
1265 }
1266 if (twe_drain_response_queue(sc)) {
1267 twe_printf(sc, "can't drain response queue\n");
1268 return(1);
1269 }
1270 return(0);
1271 }
1272
1273 /********************************************************************************
1274 ********************************************************************************
1275 Interrupt Handling
1276 ********************************************************************************
1277 ********************************************************************************/
1278
1279 /********************************************************************************
1280 * Host interrupt.
1281 *
1282 * XXX what does this mean?
1283 */
1284 static void
1285 twe_host_intr(struct twe_softc *sc)
1286 {
1287 debug_called(4);
1288
1289 twe_printf(sc, "host interrupt\n");
1290 TWE_CONTROL(sc, TWE_CONTROL_CLEAR_HOST_INTERRUPT);
1291 }
1292
1293 /********************************************************************************
1294 * Attention interrupt.
1295 *
1296 * Signalled when the controller has one or more AENs for us.
1297 */
1298 static void
1299 twe_attention_intr(struct twe_softc *sc)
1300 {
1301 debug_called(4);
1302
1303 /* instigate a poll for AENs */
1304 if (twe_fetch_aen(sc)) {
1305 twe_printf(sc, "error polling for signalled AEN\n");
1306 } else {
1307 TWE_CONTROL(sc, TWE_CONTROL_CLEAR_ATTENTION_INTERRUPT);
1308 }
1309 }
1310
1311 /********************************************************************************
1312 * Command interrupt.
1313 *
1314 * Signalled when the controller can handle more commands.
1315 */
1316 static void
1317 twe_command_intr(struct twe_softc *sc)
1318 {
1319 debug_called(4);
1320
1321 /*
1322 * We don't use this, rather we try to submit commands when we receive
1323 * them, and when other commands have completed. Mask it so we don't get
1324 * another one.
1325 */
1326 TWE_CONTROL(sc, TWE_CONTROL_MASK_COMMAND_INTERRUPT);
1327 }
1328
1329 /********************************************************************************
1330 ********************************************************************************
1331 Asynchronous Event Handling
1332 ********************************************************************************
1333 ********************************************************************************/
1334
1335 /********************************************************************************
1336 * Request an AEN from the controller.
1337 */
1338 static int
1339 twe_fetch_aen(struct twe_softc *sc)
1340 {
1341
1342 debug_called(4);
1343
1344 if ((twe_get_param(sc, TWE_PARAM_AEN, TWE_PARAM_AEN_UnitCode, 2, twe_handle_aen)) == NULL)
1345 return(EIO);
1346 return(0);
1347 }
1348
1349 /********************************************************************************
1350 * Handle an AEN returned by the controller.
1351 */
1352 static void
1353 twe_handle_aen(struct twe_request *tr)
1354 {
1355 struct twe_softc *sc = tr->tr_sc;
1356 TWE_Param *param;
1357 u_int16_t aen;
1358
1359 debug_called(4);
1360
1361 /* XXX check for command success somehow? */
1362
1363 param = (TWE_Param *)tr->tr_data;
1364 aen = *(u_int16_t *)(param->data);
1365
1366 free(tr->tr_data, M_DEVBUF);
1367 twe_release_request(tr);
1368 twe_enqueue_aen(sc, aen);
1369
1370 /* XXX poll for more AENs? */
1371 }
1372
1373 /********************************************************************************
1374 * Pull AENs out of the controller and park them in the queue, in a context where
1375 * interrupts aren't active. Return nonzero if we encounter any errors in the
1376 * process of obtaining all the available AENs.
1377 */
1378 static int
1379 twe_drain_aen_queue(struct twe_softc *sc)
1380 {
1381 u_int16_t aen;
1382
1383 for (;;) {
1384 if (twe_get_param_2(sc, TWE_PARAM_AEN, TWE_PARAM_AEN_UnitCode, &aen))
1385 return(1);
1386 if (aen == TWE_AEN_QUEUE_EMPTY)
1387 return(0);
1388 twe_enqueue_aen(sc, aen);
1389 }
1390 }
1391
1392 /********************************************************************************
1393 * Push an AEN that we've received onto the queue.
1394 *
1395 * Note that we have to lock this against reentrance, since it may be called
1396 * from both interrupt and non-interrupt context.
1397 *
1398 * If someone is waiting for the AEN we have, wake them up.
1399 */
1400 static void
1401 twe_enqueue_aen(struct twe_softc *sc, u_int16_t aen)
1402 {
1403 char *msg;
1404 int s, next, nextnext;
1405
1406 debug_called(4);
1407
1408 if ((msg = twe_format_aen(sc, aen)) != NULL)
1409 twe_printf(sc, "AEN: <%s>\n", msg);
1410
1411 s = splbio();
1412 /* enqueue the AEN */
1413 next = ((sc->twe_aen_head + 1) % TWE_Q_LENGTH);
1414 nextnext = ((sc->twe_aen_head + 2) % TWE_Q_LENGTH);
1415
1416 /* check to see if this is the last free slot, and subvert the AEN if it is */
1417 if (nextnext == sc->twe_aen_tail)
1418 aen = TWE_AEN_QUEUE_FULL;
1419
1420 /* look to see if there's room for this AEN */
1421 if (next != sc->twe_aen_tail) {
1422 sc->twe_aen_queue[sc->twe_aen_head] = aen;
1423 sc->twe_aen_head = next;
1424 }
1425
1426 /* wake up anyone asleep on the queue */
1427 wakeup(&sc->twe_aen_queue);
1428
1429 /* anyone looking for this AEN? */
1430 if (sc->twe_wait_aen == aen) {
1431 sc->twe_wait_aen = -1;
1432 wakeup(&sc->twe_wait_aen);
1433 }
1434 splx(s);
1435 }
1436
1437 /********************************************************************************
1438 * Pop an AEN off the queue, or return -1 if there are none left.
1439 *
1440 * We are more or less interrupt-safe, so don't block interrupts.
1441 */
1442 static u_int16_t
1443 twe_dequeue_aen(struct twe_softc *sc)
1444 {
1445 u_int16_t result;
1446
1447 debug_called(4);
1448
1449 if (sc->twe_aen_tail == sc->twe_aen_head) {
1450 result = TWE_AEN_QUEUE_EMPTY;
1451 } else {
1452 result = sc->twe_aen_queue[sc->twe_aen_tail];
1453 sc->twe_aen_tail = ((sc->twe_aen_tail + 1) % TWE_Q_LENGTH);
1454 }
1455 return(result);
1456 }
1457
1458 /********************************************************************************
1459 * Check to see if the requested AEN is in the queue.
1460 *
1461 * XXX we could probably avoid masking interrupts here
1462 */
1463 static int
1464 twe_find_aen(struct twe_softc *sc, u_int16_t aen)
1465 {
1466 int i, s, missing;
1467
1468 missing = 1;
1469 s = splbio();
1470 for (i = sc->twe_aen_tail; (i != sc->twe_aen_head) && missing; i = (i + 1) % TWE_Q_LENGTH) {
1471 if (sc->twe_aen_queue[i] == aen)
1472 missing = 0;
1473 }
1474 splx(s);
1475 return(missing);
1476 }
1477
1478
1479 #if 0 /* currently unused */
1480 /********************************************************************************
1481 * Sleep waiting for at least (timeout) seconds until we see (aen) as
1482 * requested. Returns nonzero on timeout or failure.
1483 *
1484 * XXX: this should not be used in cases where there may be more than one sleeper
1485 * without a mechanism for registering multiple sleepers.
1486 */
1487 static int
1488 twe_wait_aen(struct twe_softc *sc, int aen, int timeout)
1489 {
1490 time_t expiry;
1491 int found, s;
1492
1493 debug_called(4);
1494
1495 expiry = time_second + timeout;
1496 found = 0;
1497
1498 s = splbio();
1499 sc->twe_wait_aen = aen;
1500 do {
1501 twe_fetch_aen(sc);
1502 tsleep(&sc->twe_wait_aen, PZERO, "twewaen", hz);
1503 if (sc->twe_wait_aen == -1)
1504 found = 1;
1505 } while ((time_second <= expiry) && !found);
1506 splx(s);
1507 return(!found);
1508 }
1509 #endif
1510
1511 /********************************************************************************
1512 ********************************************************************************
1513 Command Buffer Management
1514 ********************************************************************************
1515 ********************************************************************************/
1516
1517 /********************************************************************************
1518 * Get a new command buffer.
1519 *
1520 * This will return NULL if all command buffers are in use.
1521 */
1522 static int
1523 twe_get_request(struct twe_softc *sc, struct twe_request **tr)
1524 {
1525 TWE_Command *cmd;
1526 debug_called(4);
1527
1528 /* try to reuse an old buffer */
1529 *tr = twe_dequeue_free(sc);
1530
1531 /* initialise some fields to their defaults */
1532 if (*tr != NULL) {
1533 cmd = TWE_FIND_COMMAND(*tr);
1534 (*tr)->tr_data = NULL;
1535 (*tr)->tr_private = NULL;
1536 (*tr)->tr_status = TWE_CMD_SETUP; /* command is in setup phase */
1537 (*tr)->tr_flags = 0;
1538 (*tr)->tr_complete = NULL;
1539 cmd->generic.status = 0; /* before submission to controller */
1540 cmd->generic.flags = 0; /* not used */
1541 }
1542 return(*tr == NULL);
1543 }
1544
1545 /********************************************************************************
1546 * Release a command buffer for reuse.
1547 *
1548 */
1549 static void
1550 twe_release_request(struct twe_request *tr)
1551 {
1552 debug_called(4);
1553
1554 if (tr->tr_private != NULL)
1555 twe_panic(tr->tr_sc, "tr_private != NULL");
1556 twe_enqueue_free(tr);
1557 }
1558
1559 /********************************************************************************
1560 ********************************************************************************
1561 Debugging
1562 ********************************************************************************
1563 ********************************************************************************/
1564
1565 /********************************************************************************
1566 * Print some information about the controller
1567 */
1568 void
1569 twe_describe_controller(struct twe_softc *sc)
1570 {
1571 TWE_Param *p[6];
1572 u_int8_t ports;
1573 u_int32_t size;
1574 int i;
1575
1576 debug_called(2);
1577
1578 /* get the port count */
1579 twe_get_param_1(sc, TWE_PARAM_CONTROLLER, TWE_PARAM_CONTROLLER_PortCount, &ports);
1580
1581 /* get version strings */
1582 p[0] = twe_get_param(sc, TWE_PARAM_VERSION, TWE_PARAM_VERSION_FW, 16, NULL);
1583 p[1] = twe_get_param(sc, TWE_PARAM_VERSION, TWE_PARAM_VERSION_BIOS, 16, NULL);
1584 if (p[0] && p[1])
1585 twe_printf(sc, "%d ports, Firmware %.16s, BIOS %.16s\n", ports, p[0]->data, p[1]->data);
1586
1587 if (bootverbose) {
1588 p[2] = twe_get_param(sc, TWE_PARAM_VERSION, TWE_PARAM_VERSION_Mon, 16, NULL);
1589 p[3] = twe_get_param(sc, TWE_PARAM_VERSION, TWE_PARAM_VERSION_PCB, 8, NULL);
1590 p[4] = twe_get_param(sc, TWE_PARAM_VERSION, TWE_PARAM_VERSION_ATA, 8, NULL);
1591 p[5] = twe_get_param(sc, TWE_PARAM_VERSION, TWE_PARAM_VERSION_PCI, 8, NULL);
1592
1593 if (p[2] && p[3] && p[4] && p[5])
1594 twe_printf(sc, "Monitor %.16s, PCB %.8s, Achip %.8s, Pchip %.8s\n", p[2]->data, p[3]->data,
1595 p[4]->data, p[5]->data);
1596 if (p[2])
1597 free(p[2], M_DEVBUF);
1598 if (p[3])
1599 free(p[3], M_DEVBUF);
1600 if (p[4])
1601 free(p[4], M_DEVBUF);
1602 if (p[5])
1603 free(p[5], M_DEVBUF);
1604 }
1605 if (p[0])
1606 free(p[0], M_DEVBUF);
1607 if (p[1])
1608 free(p[1], M_DEVBUF);
1609
1610 /* print attached drives */
1611 if (bootverbose) {
1612 p[0] = twe_get_param(sc, TWE_PARAM_DRIVESUMMARY, TWE_PARAM_DRIVESUMMARY_Status, 16, NULL);
1613 for (i = 0; i < ports; i++) {
1614 if (p[0]->data[i] != TWE_PARAM_DRIVESTATUS_Present)
1615 continue;
1616 twe_get_param_4(sc, TWE_PARAM_DRIVEINFO + i, TWE_PARAM_DRIVEINFO_Size, &size);
1617 p[1] = twe_get_param(sc, TWE_PARAM_DRIVEINFO + i, TWE_PARAM_DRIVEINFO_Model, 40, NULL);
1618 if (p[1] != NULL) {
1619 twe_printf(sc, "port %d: %.40s %dMB\n", i, p[1]->data, size / 2048);
1620 free(p[1], M_DEVBUF);
1621 } else {
1622 twe_printf(sc, "port %d, drive status unavailable\n", i);
1623 }
1624 }
1625 if (p[0])
1626 free(p[0], M_DEVBUF);
1627 }
1628 }
1629
1630 /********************************************************************************
1631 * Look up a text description of a numeric code and return a pointer to same.
1632 */
1633 char *
1634 twe_describe_code(struct twe_code_lookup *table, u_int32_t code)
1635 {
1636 int i;
1637
1638 for (i = 0; table[i].string != NULL; i++)
1639 if (table[i].code == code)
1640 return(table[i].string);
1641 return(table[i+1].string);
1642 }
1643
1644 /********************************************************************************
1645 * Complain if the status bits aren't what we're expecting.
1646 *
1647 * Rate-limit the complaints to at most one of each every five seconds, but
1648 * always return the correct status.
1649 */
1650 static int
1651 twe_check_bits(struct twe_softc *sc, u_int32_t status_reg)
1652 {
1653 int result;
1654 static time_t lastwarn[2] = {0, 0};
1655
1656 /*
1657 * This can be a little problematic, as twe_panic may call twe_reset if
1658 * TWE_DEBUG is not set, which will call us again as part of the soft reset.
1659 */
1660 if ((status_reg & TWE_STATUS_PANIC_BITS) != 0) {
1661 twe_printf(sc, "FATAL STATUS BIT(S) %b\n", status_reg & TWE_STATUS_PANIC_BITS,
1662 TWE_STATUS_BITS_DESCRIPTION);
1663 twe_panic(sc, "fatal status bits");
1664 }
1665
1666 result = 0;
1667 if ((status_reg & TWE_STATUS_EXPECTED_BITS) != TWE_STATUS_EXPECTED_BITS) {
1668 if (time_second > (lastwarn[0] + 5)) {
1669 twe_printf(sc, "missing expected status bit(s) %b\n", ~status_reg & TWE_STATUS_EXPECTED_BITS,
1670 TWE_STATUS_BITS_DESCRIPTION);
1671 lastwarn[0] = time_second;
1672 }
1673 result = 1;
1674 }
1675
1676 if ((status_reg & TWE_STATUS_UNEXPECTED_BITS) != 0) {
1677 if (time_second > (lastwarn[1] + 5)) {
1678 twe_printf(sc, "unexpected status bit(s) %b\n", status_reg & TWE_STATUS_UNEXPECTED_BITS,
1679 TWE_STATUS_BITS_DESCRIPTION);
1680 lastwarn[1] = time_second;
1681 }
1682 result = 1;
1683 if (status_reg & TWE_STATUS_PCI_PARITY_ERROR) {
1684 twe_printf(sc, "PCI parity error: Reseat card, move card or buggy device present.");
1685 twe_clear_pci_parity_error(sc);
1686 }
1687 if (status_reg & TWE_STATUS_PCI_ABORT) {
1688 twe_printf(sc, "PCI abort, clearing.\n");
1689 twe_clear_pci_abort(sc);
1690 }
1691 }
1692
1693 return(result);
1694 }
1695
1696 /********************************************************************************
1697 * Return a string describing (aen).
1698 *
1699 * The low 8 bits of the aen are the code, the high 8 bits give the unit number
1700 * where an AEN is specific to a unit.
1701 *
1702 * Note that we could expand this routine to handle eg. up/downgrading the status
1703 * of a drive if we had some idea of what the drive's initial status was.
1704 */
1705
1706 static char *
1707 twe_format_aen(struct twe_softc *sc, u_int16_t aen)
1708 {
1709 static char buf[80];
1710 device_t child;
1711 char *code, *msg;
1712
1713 code = twe_describe_code(twe_table_aen, TWE_AEN_CODE(aen));
1714 msg = code + 2;
1715
1716 switch (*code) {
1717 case 'q':
1718 if (!bootverbose)
1719 return(NULL);
1720 /* FALLTHROUGH */
1721 case 'a':
1722 return(msg);
1723
1724 case 'c':
1725 if ((child = sc->twe_drive[TWE_AEN_UNIT(aen)].td_disk) != NULL) {
1726 sprintf(buf, "twed%d: %s", device_get_unit(child), msg);
1727 } else {
1728 sprintf(buf, "twe%d: %s for unknown unit %d", device_get_unit(sc->twe_dev),
1729 msg, TWE_AEN_UNIT(aen));
1730 }
1731 return(buf);
1732
1733 case 'p':
1734 sprintf(buf, "twe%d: port %d: %s", device_get_unit(sc->twe_dev), TWE_AEN_UNIT(aen),
1735 msg);
1736 return(buf);
1737
1738
1739 case 'x':
1740 default:
1741 break;
1742 }
1743 sprintf(buf, "unknown AEN 0x%x", aen);
1744 return(buf);
1745 }
1746
1747 /********************************************************************************
1748 * Print a diagnostic if the status of the command warrants it, and return
1749 * either zero (command was ok) or nonzero (command failed).
1750 */
1751 static int
1752 twe_report_request(struct twe_request *tr)
1753 {
1754 struct twe_softc *sc = tr->tr_sc;
1755 TWE_Command *cmd = TWE_FIND_COMMAND(tr);
1756 int result = 0;
1757
1758 /*
1759 * Check the command status value and handle accordingly.
1760 */
1761 if (cmd->generic.status == TWE_STATUS_RESET) {
1762 /*
1763 * The status code 0xff requests a controller reset.
1764 */
1765 twe_printf(sc, "command returned with controller reset request\n");
1766 twe_reset(sc);
1767 result = 1;
1768 } else if (cmd->generic.status > TWE_STATUS_FATAL) {
1769 /*
1770 * Fatal errors that don't require controller reset.
1771 *
1772 * We know a few special flags values.
1773 */
1774 switch (cmd->generic.flags) {
1775 case 0x1b:
1776 device_printf(sc->twe_drive[cmd->generic.unit].td_disk,
1777 "drive timeout");
1778 break;
1779 case 0x51:
1780 device_printf(sc->twe_drive[cmd->generic.unit].td_disk,
1781 "unrecoverable drive error");
1782 break;
1783 default:
1784 device_printf(sc->twe_drive[cmd->generic.unit].td_disk,
1785 "controller error - %s (flags = 0x%x)\n",
1786 twe_describe_code(twe_table_status, cmd->generic.status),
1787 cmd->generic.flags);
1788 result = 1;
1789 }
1790 } else if (cmd->generic.status > TWE_STATUS_WARNING) {
1791 /*
1792 * Warning level status.
1793 */
1794 device_printf(sc->twe_drive[cmd->generic.unit].td_disk,
1795 "warning - %s (flags = 0x%x)\n",
1796 twe_describe_code(twe_table_status, cmd->generic.status),
1797 cmd->generic.flags);
1798 } else if (cmd->generic.status > 0x40) {
1799 /*
1800 * Info level status.
1801 */
1802 device_printf(sc->twe_drive[cmd->generic.unit].td_disk,
1803 "attention - %s (flags = 0x%x)\n",
1804 twe_describe_code(twe_table_status, cmd->generic.status),
1805 cmd->generic.flags);
1806 }
1807
1808 return(result);
1809 }
1810
1811 /********************************************************************************
1812 * Print some controller state to aid in debugging error/panic conditions
1813 */
1814 void
1815 twe_print_controller(struct twe_softc *sc)
1816 {
1817 u_int32_t status_reg;
1818
1819 status_reg = TWE_STATUS(sc);
1820 twe_printf(sc, "status %b\n", status_reg, TWE_STATUS_BITS_DESCRIPTION);
1821 twe_printf(sc, " current max min\n");
1822 twe_printf(sc, "free %04d %04d %04d\n",
1823 sc->twe_qstat[TWEQ_FREE].q_length, sc->twe_qstat[TWEQ_FREE].q_max, sc->twe_qstat[TWEQ_FREE].q_min);
1824
1825 twe_printf(sc, "ready %04d %04d %04d\n",
1826 sc->twe_qstat[TWEQ_READY].q_length, sc->twe_qstat[TWEQ_READY].q_max, sc->twe_qstat[TWEQ_READY].q_min);
1827
1828 twe_printf(sc, "busy %04d %04d %04d\n",
1829 sc->twe_qstat[TWEQ_BUSY].q_length, sc->twe_qstat[TWEQ_BUSY].q_max, sc->twe_qstat[TWEQ_BUSY].q_min);
1830
1831 twe_printf(sc, "complete %04d %04d %04d\n",
1832 sc->twe_qstat[TWEQ_COMPLETE].q_length, sc->twe_qstat[TWEQ_COMPLETE].q_max, sc->twe_qstat[TWEQ_COMPLETE].q_min);
1833
1834 twe_printf(sc, "bioq %04d %04d %04d\n",
1835 sc->twe_qstat[TWEQ_BIO].q_length, sc->twe_qstat[TWEQ_BIO].q_max, sc->twe_qstat[TWEQ_BIO].q_min);
1836
1837 twe_printf(sc, "AEN queue head %d tail %d\n", sc->twe_aen_head, sc->twe_aen_tail);
1838 }
1839
1840 static void
1841 twe_panic(struct twe_softc *sc, char *reason)
1842 {
1843 twe_print_controller(sc);
1844 #ifdef TWE_DEBUG
1845 panic(reason);
1846 #else
1847 twe_reset(sc);
1848 #endif
1849 }
1850
1851 #if 0
1852 /********************************************************************************
1853 * Print a request/command in human-readable format.
1854 */
1855 static void
1856 twe_print_request(struct twe_request *tr)
1857 {
1858 struct twe_softc *sc = tr->tr_sc;
1859 TWE_Command *cmd = TWE_FIND_COMMAND(tr);
1860 int i;
1861
1862 twe_printf(sc, "CMD: request_id %d opcode <%s> size %d unit %d host_id %d\n",
1863 cmd->generic.request_id, twe_describe_code(twe_table_opcode, cmd->generic.opcode), cmd->generic.size,
1864 cmd->generic.unit, cmd->generic.host_id);
1865 twe_printf(sc, " status %d flags 0x%x count %d sgl_offset %d\n",
1866 cmd->generic.status, cmd->generic.flags, cmd->generic.count, cmd->generic.sgl_offset);
1867
1868 switch(cmd->generic.opcode) { /* XXX add more opcodes? */
1869 case TWE_OP_READ:
1870 case TWE_OP_WRITE:
1871 twe_printf(sc, " lba %d\n", cmd->io.lba);
1872 for (i = 0; (i < TWE_MAX_SGL_LENGTH) && (cmd->io.sgl[i].length != 0); i++)
1873 twe_printf(sc, " %d: 0x%x/%d\n",
1874 i, cmd->io.sgl[i].address, cmd->io.sgl[i].length);
1875 break;
1876
1877 case TWE_OP_GET_PARAM:
1878 case TWE_OP_SET_PARAM:
1879 for (i = 0; (i < TWE_MAX_SGL_LENGTH) && (cmd->param.sgl[i].length != 0); i++)
1880 twe_printf(sc, " %d: 0x%x/%d\n",
1881 i, cmd->param.sgl[i].address, cmd->param.sgl[i].length);
1882 break;
1883
1884 case TWE_OP_INIT_CONNECTION:
1885 twe_printf(sc, " response queue pointer 0x%x\n",
1886 cmd->initconnection.response_queue_pointer);
1887 break;
1888
1889 default:
1890 break;
1891 }
1892 twe_printf(sc, " tr_command %p/0x%x tr_data %p/0x%x,%d\n",
1893 tr, TWE_FIND_COMMANDPHYS(tr), tr->tr_data, tr->tr_dataphys, tr->tr_length);
1894 twe_printf(sc, " tr_status %d tr_flags 0x%x tr_complete %p tr_private %p\n",
1895 tr->tr_status, tr->tr_flags, tr->tr_complete, tr->tr_private);
1896 }
1897
1898 #endif
Cache object: b86f7595a397fd6e1b5d2dfb6e0f9cad
|