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