kernel - callout_init() -> callout_init_mp() in selected cases
[dragonfly.git] / sys / dev / disk / ahci / ahci.c
1 /*
2  * (MPSAFE)
3  *
4  * Copyright (c) 2006 David Gwynne <dlg@openbsd.org>
5  *
6  * Permission to use, copy, modify, and distribute this software for any
7  * purpose with or without fee is hereby granted, provided that the above
8  * copyright notice and this permission notice appear in all copies.
9  *
10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17  *
18  *
19  * Copyright (c) 2009 The DragonFly Project.  All rights reserved.
20  *
21  * This code is derived from software contributed to The DragonFly Project
22  * by Matthew Dillon <dillon@backplane.com>
23  *
24  * Redistribution and use in source and binary forms, with or without
25  * modification, are permitted provided that the following conditions
26  * are met:
27  *
28  * 1. Redistributions of source code must retain the above copyright
29  *    notice, this list of conditions and the following disclaimer.
30  * 2. Redistributions in binary form must reproduce the above copyright
31  *    notice, this list of conditions and the following disclaimer in
32  *    the documentation and/or other materials provided with the
33  *    distribution.
34  * 3. Neither the name of The DragonFly Project nor the names of its
35  *    contributors may be used to endorse or promote products derived
36  *    from this software without specific, prior written permission.
37  *
38  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
39  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
40  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
41  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
42  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
43  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
44  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
45  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
46  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
47  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
48  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
49  * SUCH DAMAGE.
50  *
51  * $OpenBSD: ahci.c,v 1.147 2009/02/16 21:19:07 miod Exp $
52  */
53
54 #include "ahci.h"
55
56 void    ahci_port_interrupt_enable(struct ahci_port *ap);
57
58 int     ahci_load_prdt(struct ahci_ccb *);
59 void    ahci_unload_prdt(struct ahci_ccb *);
60 static void ahci_load_prdt_callback(void *info, bus_dma_segment_t *segs,
61                                     int nsegs, int error);
62 void    ahci_start(struct ahci_ccb *);
63 int     ahci_port_softreset(struct ahci_port *ap);
64 int     ahci_port_hardreset(struct ahci_port *ap, int hard);
65 void    ahci_port_hardstop(struct ahci_port *ap);
66
67 static void ahci_ata_cmd_timeout_unserialized(void *);
68 void    ahci_check_active_timeouts(struct ahci_port *ap);
69
70 void    ahci_beg_exclusive_access(struct ahci_port *ap, struct ata_port *at);
71 void    ahci_end_exclusive_access(struct ahci_port *ap, struct ata_port *at);
72 void    ahci_issue_pending_commands(struct ahci_port *ap, struct ahci_ccb *ccb);
73 void    ahci_issue_saved_commands(struct ahci_port *ap, u_int32_t mask);
74
75 int     ahci_port_read_ncq_error(struct ahci_port *, int);
76
77 struct ahci_dmamem *ahci_dmamem_alloc(struct ahci_softc *, bus_dma_tag_t tag);
78 void    ahci_dmamem_free(struct ahci_softc *, struct ahci_dmamem *);
79 static void ahci_dmamem_saveseg(void *info, bus_dma_segment_t *segs, int nsegs, int error);
80
81 static void ahci_dummy_done(struct ata_xfer *xa);
82 static void ahci_empty_done(struct ahci_ccb *ccb);
83 static void ahci_ata_cmd_done(struct ahci_ccb *ccb);
84 static u_int32_t ahci_pactive(struct ahci_port *ap);
85
86 /*
87  * Initialize the global AHCI hardware.  This code does not set up any of
88  * its ports.
89  */
90 int
91 ahci_init(struct ahci_softc *sc)
92 {
93         u_int32_t       cap, pi, pleft;
94         int             i;
95         struct ahci_port *ap;
96
97         DPRINTF(AHCI_D_VERBOSE, " GHC 0x%b",
98                 ahci_read(sc, AHCI_REG_GHC), AHCI_FMT_GHC);
99
100         /*
101          * save BIOS initialised parameters, enable staggered spin up
102          */
103         cap = ahci_read(sc, AHCI_REG_CAP);
104         cap &= AHCI_REG_CAP_SMPS;
105         cap |= AHCI_REG_CAP_SSS;
106         pi = ahci_read(sc, AHCI_REG_PI);
107
108         /*
109          * Unconditionally reset the controller, do not conditionalize on
110          * trying to figure it if it was previously active or not.
111          *
112          * NOTE: On AE before HR.  The AHCI-1.1 spec has a note in section
113          *       5.2.2.1 regarding this.  HR should be set to 1 only after
114          *       AE is set to 1.  The reset sequence will clear HR when
115          *       it completes, and will also clear AE if SAM is 0.  AE must
116          *       then be set again.  When SAM is 1 the AE bit typically reads
117          *       as 1 (and is read-only).
118          *
119          * NOTE: Avoid PCI[e] transaction burst by issuing dummy reads,
120          *       otherwise the writes will only be separated by a few
121          *       nanoseconds.
122          *
123          * NOTE BRICKS (1)
124          *
125          *      If you have a port multiplier and it does not have a device
126          *      in target 0, and it probes normally, but a later operation
127          *      mis-probes a target behind that PM, it is possible for the
128          *      port to brick such that only (a) a power cycle of the host
129          *      or (b) placing a device in target 0 will fix the problem.
130          *      Power cycling the PM has no effect (it works fine on another
131          *      host port).  This issue is unrelated to CLO.
132          */
133         /*
134          * Wait for any prior reset sequence to complete
135          */
136         if (ahci_wait_ne(sc, AHCI_REG_GHC,
137                          AHCI_REG_GHC_HR, AHCI_REG_GHC_HR) != 0) {
138                 device_printf(sc->sc_dev, "Controller is stuck in reset\n");
139                 return (1);
140         }
141         ahci_write(sc, AHCI_REG_GHC, AHCI_REG_GHC_AE);
142         ahci_os_sleep(500);
143         ahci_read(sc, AHCI_REG_GHC);            /* flush */
144         ahci_write(sc, AHCI_REG_GHC, AHCI_REG_GHC_AE | AHCI_REG_GHC_HR);
145         ahci_os_sleep(500);
146         ahci_read(sc, AHCI_REG_GHC);            /* flush */
147         if (ahci_wait_ne(sc, AHCI_REG_GHC,
148                          AHCI_REG_GHC_HR, AHCI_REG_GHC_HR) != 0) {
149                 device_printf(sc->sc_dev, "unable to reset controller\n");
150                 return (1);
151         }
152         if (ahci_read(sc, AHCI_REG_GHC) & AHCI_REG_GHC_AE) {
153                 device_printf(sc->sc_dev, "AE did not auto-clear!\n");
154                 ahci_write(sc, AHCI_REG_GHC, 0);
155                 ahci_os_sleep(500);
156         }
157
158         /*
159          * Enable ahci (global interrupts disabled)
160          *
161          * Restore saved parameters.  Avoid pci transaction burst write
162          * by issuing dummy reads.
163          */
164         ahci_os_sleep(500);
165         ahci_write(sc, AHCI_REG_GHC, AHCI_REG_GHC_AE);
166         ahci_os_sleep(500);
167
168         ahci_read(sc, AHCI_REG_GHC);            /* flush */
169         ahci_write(sc, AHCI_REG_CAP, cap);
170         ahci_write(sc, AHCI_REG_PI, pi);
171         ahci_read(sc, AHCI_REG_GHC);            /* flush */
172
173         /*
174          * Intel hocus pocus in case the BIOS has not set the chip up
175          * properly for AHCI operation.
176          */
177         if (pci_get_vendor(sc->sc_dev) == PCI_VENDOR_INTEL) {
178                 if ((pci_read_config(sc->sc_dev, 0x92, 2) & 0x0F) != 0x0F)
179                         device_printf(sc->sc_dev, "Intel hocus pocus\n");
180                 pci_write_config(sc->sc_dev, 0x92,
181                              pci_read_config(sc->sc_dev, 0x92, 2) | 0x0F, 2);
182         }
183
184         /*
185          * This is a hack that currently does not appear to have
186          * a significant effect, but I noticed the port registers
187          * do not appear to be completely cleared after the host
188          * controller is reset.
189          *
190          * Use a temporary ap structure so we can call ahci_pwrite().
191          *
192          * We must be sure to stop the port
193          */
194         ap = kmalloc(sizeof(*ap), M_DEVBUF, M_WAITOK | M_ZERO);
195         ap->ap_sc = sc;
196         pleft = pi;
197         for (i = 0; i < AHCI_MAX_PORTS; ++i) {
198                 if (pleft == 0)
199                         break;
200                 if ((pi & (1 << i)) == 0)
201                         continue;
202                 if (bus_space_subregion(sc->sc_iot, sc->sc_ioh,
203                     AHCI_PORT_REGION(i), AHCI_PORT_SIZE, &ap->ap_ioh) != 0) {
204                         device_printf(sc->sc_dev, "can't map port\n");
205                         return (1);
206                 }
207                 /*
208                  * NOTE!  Setting AHCI_PREG_SCTL_DET_DISABLE on AHCI1.0 or
209                  *        AHCI1.1 can brick the chipset.  Not only brick it,
210                  *        but also crash the PC.  The bit seems unreliable
211                  *        on AHCI1.2 as well.
212                  */
213                 ahci_port_stop(ap, 1);
214                 ahci_pwrite(ap, AHCI_PREG_SCTL, AHCI_PREG_SCTL_IPM_DISABLED);
215                 ahci_pwrite(ap, AHCI_PREG_SERR, -1);
216                 ahci_pwrite(ap, AHCI_PREG_IE, 0);
217                 ahci_write(ap->ap_sc, AHCI_REG_IS, 1 << i);
218                 ahci_pwrite(ap, AHCI_PREG_CMD, 0);
219                 ahci_pwrite(ap, AHCI_PREG_IS, -1);
220                 sc->sc_portmask |= (1 << i);
221                 pleft &= ~(1 << i);
222         }
223         sc->sc_numports = i;
224         kfree(ap, M_DEVBUF);
225
226         return (0);
227 }
228
229 /*
230  * Allocate and initialize an AHCI port.
231  */
232 int
233 ahci_port_alloc(struct ahci_softc *sc, u_int port)
234 {
235         struct ahci_port        *ap;
236         struct ata_port         *at;
237         struct ahci_ccb         *ccb;
238         u_int64_t               dva;
239         u_int32_t               cmd;
240         u_int32_t               data;
241         struct ahci_cmd_hdr     *hdr;
242         struct ahci_cmd_table   *table;
243         int     rc = ENOMEM;
244         int     error;
245         int     i;
246
247         ap = kmalloc(sizeof(*ap), M_DEVBUF, M_WAITOK | M_ZERO);
248         ap->ap_err_scratch = kmalloc(512, M_DEVBUF, M_WAITOK | M_ZERO);
249
250         ksnprintf(ap->ap_name, sizeof(ap->ap_name), "%s%d.%d",
251                   device_get_name(sc->sc_dev),
252                   device_get_unit(sc->sc_dev),
253                   port);
254         sc->sc_ports[port] = ap;
255
256         /*
257          * Allocate enough so we never have to reallocate, it makes
258          * it easier.
259          *
260          * ap_pmcount will be reduced by the scan if we encounter the
261          * port multiplier port prior to target 15.
262          *
263          * kmalloc power-of-2 allocations are guaranteed not to cross
264          * a page boundary.  Make sure the identify sub-structure in the
265          * at structure does not cross a page boundary, just in case the
266          * part is AHCI-1.1 and can't handle multiple DRQ blocks.
267          */
268         if (ap->ap_ata[0] == NULL) {
269                 int pw2;
270
271                 for (pw2 = 1; pw2 < sizeof(*at); pw2 <<= 1)
272                         ;
273                 for (i = 0; i < AHCI_MAX_PMPORTS; ++i) {
274                         at = kmalloc(pw2, M_DEVBUF, M_INTWAIT | M_ZERO);
275                         ap->ap_ata[i] = at;
276                         at->at_ahci_port = ap;
277                         at->at_target = i;
278                         at->at_probe = ATA_PROBE_NEED_INIT;
279                         at->at_features |= ATA_PORT_F_RESCAN;
280                         ksnprintf(at->at_name, sizeof(at->at_name),
281                                   "%s.%d", ap->ap_name, i);
282                 }
283         }
284         if (bus_space_subregion(sc->sc_iot, sc->sc_ioh,
285             AHCI_PORT_REGION(port), AHCI_PORT_SIZE, &ap->ap_ioh) != 0) {
286                 device_printf(sc->sc_dev,
287                               "unable to create register window for port %d\n",
288                               port);
289                 goto freeport;
290         }
291
292         ap->ap_sc = sc;
293         ap->ap_num = port;
294         ap->ap_probe = ATA_PROBE_NEED_INIT;
295         ap->link_pwr_mgmt = AHCI_LINK_PWR_MGMT_NONE;
296         ap->sysctl_tree = NULL;
297         TAILQ_INIT(&ap->ap_ccb_free);
298         TAILQ_INIT(&ap->ap_ccb_pending);
299         lockinit(&ap->ap_ccb_lock, "ahcipo", 0, 0);
300
301         /* Disable port interrupts */
302         ahci_pwrite(ap, AHCI_PREG_IE, 0);
303         ahci_pwrite(ap, AHCI_PREG_SERR, -1);
304
305         /*
306          * Sec 10.1.2 - deinitialise port if it is already running
307          */
308         cmd = ahci_pread(ap, AHCI_PREG_CMD);
309         kprintf("%s: Caps %b\n", PORTNAME(ap), cmd, AHCI_PFMT_CMD);
310
311         if ((cmd & (AHCI_PREG_CMD_ST | AHCI_PREG_CMD_CR |
312                     AHCI_PREG_CMD_FRE | AHCI_PREG_CMD_FR)) ||
313             (ahci_pread(ap, AHCI_PREG_SCTL) & AHCI_PREG_SCTL_DET)) {
314                 int r;
315
316                 r = ahci_port_stop(ap, 1);
317                 if (r) {
318                         device_printf(sc->sc_dev,
319                                   "unable to disable %s, ignoring port %d\n",
320                                   ((r == 2) ? "CR" : "FR"), port);
321                         rc = ENXIO;
322                         goto freeport;
323                 }
324
325                 /* Write DET to zero */
326                 ahci_pwrite(ap, AHCI_PREG_SCTL, AHCI_PREG_SCTL_IPM_DISABLED);
327         }
328
329         /* Allocate RFIS */
330         ap->ap_dmamem_rfis = ahci_dmamem_alloc(sc, sc->sc_tag_rfis);
331         if (ap->ap_dmamem_rfis == NULL) {
332                 kprintf("%s: NORFIS\n", PORTNAME(ap));
333                 goto nomem;
334         }
335
336         /* Setup RFIS base address */
337         ap->ap_rfis = (struct ahci_rfis *) AHCI_DMA_KVA(ap->ap_dmamem_rfis);
338         dva = AHCI_DMA_DVA(ap->ap_dmamem_rfis);
339         ahci_pwrite(ap, AHCI_PREG_FBU, (u_int32_t)(dva >> 32));
340         ahci_pwrite(ap, AHCI_PREG_FB, (u_int32_t)dva);
341
342         /* Clear SERR before starting FIS reception or ST or anything */
343         ahci_flush_tfd(ap);
344         ahci_pwrite(ap, AHCI_PREG_SERR, -1);
345
346         /* Enable FIS reception and activate port. */
347         cmd = ahci_pread(ap, AHCI_PREG_CMD) & ~AHCI_PREG_CMD_ICC;
348         cmd &= ~(AHCI_PREG_CMD_CLO | AHCI_PREG_CMD_PMA);
349         cmd |= AHCI_PREG_CMD_FRE | AHCI_PREG_CMD_POD | AHCI_PREG_CMD_SUD;
350         ahci_pwrite(ap, AHCI_PREG_CMD, cmd | AHCI_PREG_CMD_ICC_ACTIVE);
351
352         /* Check whether port activated.  Skip it if not. */
353         cmd = ahci_pread(ap, AHCI_PREG_CMD) & ~AHCI_PREG_CMD_ICC;
354         if ((cmd & AHCI_PREG_CMD_FRE) == 0) {
355                 kprintf("%s: NOT-ACTIVATED\n", PORTNAME(ap));
356                 rc = ENXIO;
357                 goto freeport;
358         }
359
360         /* Allocate a CCB for each command slot */
361         ap->ap_ccbs = kmalloc(sizeof(struct ahci_ccb) * sc->sc_ncmds, M_DEVBUF,
362                               M_WAITOK | M_ZERO);
363         if (ap->ap_ccbs == NULL) {
364                 device_printf(sc->sc_dev,
365                               "unable to allocate command list for port %d\n",
366                               port);
367                 goto freeport;
368         }
369
370         /* Command List Structures and Command Tables */
371         ap->ap_dmamem_cmd_list = ahci_dmamem_alloc(sc, sc->sc_tag_cmdh);
372         ap->ap_dmamem_cmd_table = ahci_dmamem_alloc(sc, sc->sc_tag_cmdt);
373         if (ap->ap_dmamem_cmd_table == NULL ||
374             ap->ap_dmamem_cmd_list == NULL) {
375 nomem:
376                 device_printf(sc->sc_dev,
377                               "unable to allocate DMA memory for port %d\n",
378                               port);
379                 goto freeport;
380         }
381
382         /* Setup command list base address */
383         dva = AHCI_DMA_DVA(ap->ap_dmamem_cmd_list);
384         ahci_pwrite(ap, AHCI_PREG_CLBU, (u_int32_t)(dva >> 32));
385         ahci_pwrite(ap, AHCI_PREG_CLB, (u_int32_t)dva);
386
387         /* Split CCB allocation into CCBs and assign to command header/table */
388         hdr = AHCI_DMA_KVA(ap->ap_dmamem_cmd_list);
389         table = AHCI_DMA_KVA(ap->ap_dmamem_cmd_table);
390         for (i = 0; i < sc->sc_ncmds; i++) {
391                 ccb = &ap->ap_ccbs[i];
392
393                 error = bus_dmamap_create(sc->sc_tag_data, BUS_DMA_ALLOCNOW,
394                                           &ccb->ccb_dmamap);
395                 if (error) {
396                         device_printf(sc->sc_dev,
397                                       "unable to create dmamap for port %d "
398                                       "ccb %d\n", port, i);
399                         goto freeport;
400                 }
401
402                 callout_init_mp(&ccb->ccb_timeout);
403                 ccb->ccb_slot = i;
404                 ccb->ccb_port = ap;
405                 ccb->ccb_cmd_hdr = &hdr[i];
406                 ccb->ccb_cmd_table = &table[i];
407                 dva = AHCI_DMA_DVA(ap->ap_dmamem_cmd_table) +
408                     ccb->ccb_slot * sizeof(struct ahci_cmd_table);
409                 ccb->ccb_cmd_hdr->ctba_hi = htole32((u_int32_t)(dva >> 32));
410                 ccb->ccb_cmd_hdr->ctba_lo = htole32((u_int32_t)dva);
411
412                 ccb->ccb_xa.fis =
413                     (struct ata_fis_h2d *)ccb->ccb_cmd_table->cfis;
414                 ccb->ccb_xa.packetcmd = ccb->ccb_cmd_table->acmd;
415                 ccb->ccb_xa.tag = i;
416
417                 ccb->ccb_xa.state = ATA_S_COMPLETE;
418
419                 /*
420                  * CCB[1] is the error CCB and is not get or put.  It is
421                  * also used for probing.  Numerous HBAs only load the
422                  * signature from CCB[1] so it MUST be used for the second
423                  * FIS.
424                  */
425                 if (i == 1)
426                         ap->ap_err_ccb = ccb;
427                 else
428                         ahci_put_ccb(ccb);
429         }
430
431         /*
432          * Wait for ICC change to complete
433          */
434         ahci_pwait_clr(ap, AHCI_PREG_CMD, AHCI_PREG_CMD_ICC);
435
436         /*
437          * Calculate the interrupt mask
438          */
439         data = AHCI_PREG_IE_TFEE | AHCI_PREG_IE_HBFE |
440                AHCI_PREG_IE_IFE | AHCI_PREG_IE_OFE |
441                AHCI_PREG_IE_DPE | AHCI_PREG_IE_UFE |
442                AHCI_PREG_IE_PCE | AHCI_PREG_IE_PRCE |
443                AHCI_PREG_IE_DHRE | AHCI_PREG_IE_SDBE;
444         if (ap->ap_sc->sc_cap & AHCI_REG_CAP_SSNTF)
445                 data |= AHCI_PREG_IE_IPME;
446 #ifdef AHCI_COALESCE
447         if (sc->sc_ccc_ports & (1 << port)
448                 data &= ~(AHCI_PREG_IE_SDBE | AHCI_PREG_IE_DHRE);
449 #endif
450         ap->ap_intmask = data;
451
452         /*
453          * Start the port helper thread.  The helper thread will call
454          * ahci_port_init() so the ports can all be started in parallel.
455          * A failure by ahci_port_init() does not deallocate the port
456          * since we still want hot-plug events.
457          */
458         ahci_os_start_port(ap);
459         return(0);
460 freeport:
461         ahci_port_free(sc, port);
462         return (rc);
463 }
464
465 /*
466  * [re]initialize an idle port.  No CCBs should be active.  (from port thread)
467  *
468  * This function is called during the initial port allocation sequence
469  * and is also called on hot-plug insertion.  We take no chances and
470  * use a portreset instead of a softreset.
471  *
472  * This function is the only way to move a failed port back to active
473  * status.
474  *
475  * Returns 0 if a device is successfully detected.
476  */
477 int
478 ahci_port_init(struct ahci_port *ap)
479 {
480         u_int32_t cmd;
481
482         /*
483          * Register [re]initialization
484          *
485          * Flush the TFD and SERR and make sure the port is stopped before
486          * enabling its interrupt.  We no longer cycle the port start as
487          * the port should not be started unless a device is present.
488          *
489          * XXX should we enable FIS reception? (FRE)?
490          */
491         ahci_pwrite(ap, AHCI_PREG_IE, 0);
492         ahci_port_stop(ap, 0);
493         if (ap->ap_sc->sc_cap & AHCI_REG_CAP_SSNTF)
494                 ahci_pwrite(ap, AHCI_PREG_SNTF, -1);
495         ahci_flush_tfd(ap);
496         ahci_pwrite(ap, AHCI_PREG_SERR, -1);
497
498         /*
499          * If we are being harsh try to kill the port completely.  Normally
500          * we would want to hold on to some of the state the BIOS may have
501          * set, such as SUD (spin up device).
502          *
503          * AP_F_HARSH_REINIT is cleared in the hard reset state
504          */
505         if (ap->ap_flags & AP_F_HARSH_REINIT) {
506                 ahci_pwrite(ap, AHCI_PREG_SCTL, AHCI_PREG_SCTL_IPM_DISABLED);
507                 ahci_pwrite(ap, AHCI_PREG_CMD, 0);
508
509                 ahci_os_sleep(1000);
510
511                 cmd = ahci_pread(ap, AHCI_PREG_CMD) & ~AHCI_PREG_CMD_ICC;
512                 cmd &= ~(AHCI_PREG_CMD_CLO | AHCI_PREG_CMD_PMA);
513                 cmd |= AHCI_PREG_CMD_FRE | AHCI_PREG_CMD_POD |
514                        AHCI_PREG_CMD_SUD;
515                 ahci_pwrite(ap, AHCI_PREG_CMD, cmd | AHCI_PREG_CMD_ICC_ACTIVE);
516                 cmd = ahci_pread(ap, AHCI_PREG_CMD) & ~AHCI_PREG_CMD_ICC;
517                 if ((cmd & AHCI_PREG_CMD_FRE) == 0) {
518                         kprintf("%s: Warning: FRE did not come up during "
519                                 "harsh reinitialization\n",
520                                 PORTNAME(ap));
521                 }
522                 ahci_os_sleep(1000);
523         }
524
525         /*
526          * Clear any pending garbage and re-enable the interrupt before
527          * going to the next stage.
528          */
529         ap->ap_probe = ATA_PROBE_NEED_HARD_RESET;
530         ap->ap_pmcount = 0;
531
532         if (ap->ap_sc->sc_cap & AHCI_REG_CAP_SSNTF)
533                 ahci_pwrite(ap, AHCI_PREG_SNTF, -1);
534         ahci_flush_tfd(ap);
535         ahci_pwrite(ap, AHCI_PREG_SERR, -1);
536         ahci_pwrite(ap, AHCI_PREG_IS, -1);
537
538         ahci_port_interrupt_enable(ap);
539
540         return (0);
541 }
542
543 /*
544  * Enable or re-enable interrupts on a port.
545  *
546  * This routine is called from the port initialization code or from the
547  * helper thread as the real interrupt may be forced to turn off certain
548  * interrupt sources.
549  */
550 void
551 ahci_port_interrupt_enable(struct ahci_port *ap)
552 {
553         ahci_pwrite(ap, AHCI_PREG_IE, ap->ap_intmask);
554 }
555
556 /*
557  * Manage the agressive link power management capability.
558  */
559 void
560 ahci_port_link_pwr_mgmt(struct ahci_port *ap, int link_pwr_mgmt)
561 {
562         u_int32_t cmd, sctl;
563
564         if (link_pwr_mgmt == ap->link_pwr_mgmt)
565                 return;
566
567         if ((ap->ap_sc->sc_cap & AHCI_REG_CAP_SALP) == 0) {
568                 kprintf("%s: link power management not supported.\n",
569                         PORTNAME(ap));
570                 return;
571         }
572
573         ahci_os_lock_port(ap);
574
575         if (link_pwr_mgmt == AHCI_LINK_PWR_MGMT_AGGR &&
576             (ap->ap_sc->sc_cap & AHCI_REG_CAP_SSC)) {
577                 kprintf("%s: enabling aggressive link power management.\n",
578                         PORTNAME(ap));
579
580                 ap->link_pwr_mgmt = link_pwr_mgmt;
581
582                 ap->ap_intmask &= ~AHCI_PREG_IE_PRCE;
583                 ahci_port_interrupt_enable(ap);
584
585                 sctl = ahci_pread(ap, AHCI_PREG_SCTL);
586                 sctl &= ~(AHCI_PREG_SCTL_IPM_DISABLED);
587                 ahci_pwrite(ap, AHCI_PREG_SCTL, sctl);
588
589                 /*
590                  * Enable device initiated link power management for
591                  * directly attached devices that support it.
592                  */
593                 if (ap->ap_type != ATA_PORT_T_PM &&
594                     ap->ap_ata[0]->at_identify.satafsup & (1 << 3)) {
595                         if (ahci_set_feature(ap, NULL, ATA_SATAFT_DEVIPS, 1))
596                                 kprintf("%s: Could not enable device initiated "
597                                     "link power management.\n",
598                                     PORTNAME(ap));
599                 }
600
601                 cmd = ahci_pread(ap, AHCI_PREG_CMD);
602                 cmd |= AHCI_PREG_CMD_ASP;
603                 cmd |= AHCI_PREG_CMD_ALPE;
604                 ahci_pwrite(ap, AHCI_PREG_CMD, cmd);
605
606         } else if (link_pwr_mgmt == AHCI_LINK_PWR_MGMT_MEDIUM &&
607                    (ap->ap_sc->sc_cap & AHCI_REG_CAP_PSC)) {
608                 kprintf("%s: enabling medium link power management.\n",
609                         PORTNAME(ap));
610
611                 ap->link_pwr_mgmt = link_pwr_mgmt;
612
613                 ap->ap_intmask &= ~AHCI_PREG_IE_PRCE;
614                 ahci_port_interrupt_enable(ap);
615
616                 sctl = ahci_pread(ap, AHCI_PREG_SCTL);
617                 sctl |= AHCI_PREG_SCTL_IPM_DISABLED;
618                 sctl &= ~AHCI_PREG_SCTL_IPM_NOPARTIAL;
619                 ahci_pwrite(ap, AHCI_PREG_SCTL, sctl);
620
621                 cmd = ahci_pread(ap, AHCI_PREG_CMD);
622                 cmd &= ~AHCI_PREG_CMD_ASP;
623                 cmd |= AHCI_PREG_CMD_ALPE;
624                 ahci_pwrite(ap, AHCI_PREG_CMD, cmd);
625
626         } else if (link_pwr_mgmt == AHCI_LINK_PWR_MGMT_NONE) {
627                 kprintf("%s: disabling link power management.\n",
628                         PORTNAME(ap));
629
630                 /* Disable device initiated link power management */
631                 if (ap->ap_type != ATA_PORT_T_PM &&
632                     ap->ap_ata[0]->at_identify.satafsup & (1 << 3))
633                         ahci_set_feature(ap, NULL, ATA_SATAFT_DEVIPS, 0);
634
635                 cmd = ahci_pread(ap, AHCI_PREG_CMD);
636                 cmd &= ~(AHCI_PREG_CMD_ALPE | AHCI_PREG_CMD_ASP);
637                 ahci_pwrite(ap, AHCI_PREG_CMD, cmd);
638
639                 sctl = ahci_pread(ap, AHCI_PREG_SCTL);
640                 sctl |= AHCI_PREG_SCTL_IPM_DISABLED;
641                 ahci_pwrite(ap, AHCI_PREG_SCTL, sctl);
642
643                 /* let the drive come back to avoid PRCS interrupts later */
644                 ahci_os_unlock_port(ap);
645                 ahci_os_sleep(1000);
646                 ahci_os_lock_port(ap);
647
648                 ahci_pwrite(ap, AHCI_PREG_SERR,
649                             AHCI_PREG_SERR_DIAG_N | AHCI_PREG_SERR_DIAG_W);
650                 ahci_pwrite(ap, AHCI_PREG_IS, AHCI_PREG_IS_PRCS);
651
652                 ap->ap_intmask |= AHCI_PREG_IE_PRCE;
653                 ahci_port_interrupt_enable(ap);
654
655                 ap->link_pwr_mgmt = link_pwr_mgmt;
656         } else {
657                 kprintf("%s: unsupported link power management state %d.\n",
658                         PORTNAME(ap), link_pwr_mgmt);
659         }
660
661         ahci_os_unlock_port(ap);
662 }
663
664 /*
665  * Return current link power state.
666  */
667 int
668 ahci_port_link_pwr_state(struct ahci_port *ap)
669 {
670         uint32_t r;
671
672         r = ahci_pread(ap, AHCI_PREG_SSTS);
673         switch (r & SATA_PM_SSTS_IPM) {
674         case SATA_PM_SSTS_IPM_ACTIVE:
675                 return 1;
676         case SATA_PM_SSTS_IPM_PARTIAL:
677                 return 2;
678         case SATA_PM_SSTS_IPM_SLUMBER:
679                 return 3;
680         default:
681                 return 0;
682         }
683 }
684
685 /*
686  * Run the port / target state machine from a main context.
687  *
688  * The state machine for the port is always run.
689  *
690  * If atx is non-NULL run the state machine for a particular target.
691  * If atx is NULL run the state machine for all targets.
692  */
693 void
694 ahci_port_state_machine(struct ahci_port *ap, int initial)
695 {
696         struct ata_port *at;
697         u_int32_t data;
698         int target;
699         int didsleep;
700         int loop;
701
702         /*
703          * State machine for port.  Note that CAM is not yet associated
704          * during the initial parallel probe and the port's probe state
705          * will not get past ATA_PROBE_NEED_IDENT.
706          */
707         {
708                 if (initial == 0 && ap->ap_probe <= ATA_PROBE_NEED_HARD_RESET) {
709                         kprintf("%s: Waiting 10 seconds on insertion\n",
710                                 PORTNAME(ap));
711                         ahci_os_sleep(10000);
712                         initial = 1;
713                 }
714                 if (ap->ap_probe == ATA_PROBE_NEED_INIT)
715                         ahci_port_init(ap);
716                 if (ap->ap_probe == ATA_PROBE_NEED_HARD_RESET)
717                         ahci_port_reset(ap, NULL, 1);
718                 if (ap->ap_probe == ATA_PROBE_NEED_SOFT_RESET)
719                         ahci_port_reset(ap, NULL, 0);
720                 if (ap->ap_probe == ATA_PROBE_NEED_IDENT)
721                         ahci_cam_probe(ap, NULL);
722         }
723         if (ap->ap_type != ATA_PORT_T_PM) {
724                 if (ap->ap_probe == ATA_PROBE_FAILED) {
725                         ahci_cam_changed(ap, NULL, 0);
726                 } else if (ap->ap_probe >= ATA_PROBE_NEED_IDENT) {
727                         ahci_cam_changed(ap, NULL, 1);
728                 }
729                 return;
730         }
731
732         /*
733          * Port Multiplier state machine.
734          *
735          * Get a mask of changed targets and combine with any runnable
736          * states already present.
737          */
738         for (loop = 0; ;++loop) {
739                 if (ahci_pm_read(ap, 15, SATA_PMREG_EINFO, &data)) {
740                         kprintf("%s: PM unable to read hot-plug bitmap\n",
741                                 PORTNAME(ap));
742                         break;
743                 }
744
745                 /*
746                  * Do at least one loop, then stop if no more state changes
747                  * have occured.  The PM might not generate a new
748                  * notification until we clear the entire bitmap.
749                  */
750                 if (loop && data == 0)
751                         break;
752
753                 /*
754                  * New devices showing up in the bitmap require some spin-up
755                  * time before we start probing them.  Reset didsleep.  The
756                  * first new device we detect will sleep before probing.
757                  *
758                  * This only applies to devices whos change bit is set in
759                  * the data, and does not apply to the initial boot-time
760                  * probe.
761                  */
762                 didsleep = 0;
763
764                 for (target = 0; target < ap->ap_pmcount; ++target) {
765                         at = ap->ap_ata[target];
766
767                         /*
768                          * Check the target state for targets behind the PM
769                          * which have changed state.  This will adjust
770                          * at_probe and set ATA_PORT_F_RESCAN
771                          *
772                          * We want to wait at least 10 seconds before probing
773                          * a newly inserted device.  If the check status
774                          * indicates a device is present and in need of a
775                          * hard reset, we make sure we have slept before
776                          * continuing.
777                          *
778                          * We also need to wait at least 1 second for the
779                          * PHY state to change after insertion, if we
780                          * haven't already waited the 10 seconds.
781                          *
782                          * NOTE: When pm_check_good finds a good port it
783                          *       typically starts us in probe state
784                          *       NEED_HARD_RESET rather than INIT.
785                          */
786                         if (data & (1 << target)) {
787                                 if (initial == 0 && didsleep == 0)
788                                         ahci_os_sleep(1000);
789                                 ahci_pm_check_good(ap, target);
790                                 if (initial == 0 && didsleep == 0 &&
791                                     at->at_probe <= ATA_PROBE_NEED_HARD_RESET
792                                 ) {
793                                         didsleep = 1;
794                                         kprintf("%s: Waiting 10 seconds on insertion\n", PORTNAME(ap));
795                                         ahci_os_sleep(10000);
796                                 }
797                         }
798
799                         /*
800                          * Report hot-plug events before the probe state
801                          * really gets hot.  Only actual events are reported
802                          * here to reduce spew.
803                          */
804                         if (data & (1 << target)) {
805                                 kprintf("%s: HOTPLUG (PM) - ", ATANAME(ap, at));
806                                 switch(at->at_probe) {
807                                 case ATA_PROBE_NEED_INIT:
808                                 case ATA_PROBE_NEED_HARD_RESET:
809                                         kprintf("Device inserted\n");
810                                         break;
811                                 case ATA_PROBE_FAILED:
812                                         kprintf("Device removed\n");
813                                         break;
814                                 default:
815                                         kprintf("Device probe in progress\n");
816                                         break;
817                                 }
818                         }
819
820                         /*
821                          * Run through the state machine as necessary if
822                          * the port is not marked failed.
823                          *
824                          * The state machine may stop at NEED_IDENT if
825                          * CAM is not yet attached.
826                          *
827                          * Acquire exclusive access to the port while we
828                          * are doing this.  This prevents command-completion
829                          * from queueing commands for non-polled targets
830                          * inbetween our probe steps.  We need to do this
831                          * because the reset probes can generate severe PHY
832                          * and protocol errors and soft-brick the port.
833                          */
834                         if (at->at_probe != ATA_PROBE_FAILED &&
835                             at->at_probe != ATA_PROBE_GOOD) {
836                                 ahci_beg_exclusive_access(ap, at);
837                                 if (at->at_probe == ATA_PROBE_NEED_INIT)
838                                         ahci_pm_port_init(ap, at);
839                                 if (at->at_probe == ATA_PROBE_NEED_HARD_RESET)
840                                         ahci_port_reset(ap, at, 1);
841                                 if (at->at_probe == ATA_PROBE_NEED_SOFT_RESET)
842                                         ahci_port_reset(ap, at, 0);
843                                 if (at->at_probe == ATA_PROBE_NEED_IDENT)
844                                         ahci_cam_probe(ap, at);
845                                 ahci_end_exclusive_access(ap, at);
846                         }
847
848                         /*
849                          * Add or remove from CAM
850                          */
851                         if (at->at_features & ATA_PORT_F_RESCAN) {
852                                 at->at_features &= ~ATA_PORT_F_RESCAN;
853                                 if (at->at_probe == ATA_PROBE_FAILED) {
854                                         ahci_cam_changed(ap, at, 0);
855                                 } else if (at->at_probe >= ATA_PROBE_NEED_IDENT) {
856                                         ahci_cam_changed(ap, at, 1);
857                                 }
858                         }
859                         data &= ~(1 << target);
860                 }
861                 if (data) {
862                         kprintf("%s: WARNING (PM): extra bits set in "
863                                 "EINFO: %08x\n", PORTNAME(ap), data);
864                         while (target < AHCI_MAX_PMPORTS) {
865                                 ahci_pm_check_good(ap, target);
866                                 ++target;
867                         }
868                 }
869         }
870 }
871
872
873 /*
874  * De-initialize and detach a port.
875  */
876 void
877 ahci_port_free(struct ahci_softc *sc, u_int port)
878 {
879         struct ahci_port        *ap = sc->sc_ports[port];
880         struct ahci_ccb         *ccb;
881         int i;
882
883         /*
884          * Ensure port is disabled and its interrupts are all flushed.
885          */
886         if (ap->ap_sc) {
887                 ahci_port_stop(ap, 1);
888                 ahci_os_stop_port(ap);
889                 ahci_pwrite(ap, AHCI_PREG_CMD, 0);
890                 ahci_pwrite(ap, AHCI_PREG_IE, 0);
891                 ahci_pwrite(ap, AHCI_PREG_IS, ahci_pread(ap, AHCI_PREG_IS));
892                 ahci_write(sc, AHCI_REG_IS, 1 << port);
893         }
894
895         if (ap->ap_ccbs) {
896                 while ((ccb = ahci_get_ccb(ap)) != NULL) {
897                         if (ccb->ccb_dmamap) {
898                                 bus_dmamap_destroy(sc->sc_tag_data,
899                                                    ccb->ccb_dmamap);
900                                 ccb->ccb_dmamap = NULL;
901                         }
902                 }
903                 if ((ccb = ap->ap_err_ccb) != NULL) {
904                         if (ccb->ccb_dmamap) {
905                                 bus_dmamap_destroy(sc->sc_tag_data,
906                                                    ccb->ccb_dmamap);
907                                 ccb->ccb_dmamap = NULL;
908                         }
909                         ap->ap_err_ccb = NULL;
910                 }
911                 kfree(ap->ap_ccbs, M_DEVBUF);
912                 ap->ap_ccbs = NULL;
913         }
914
915         if (ap->ap_dmamem_cmd_list) {
916                 ahci_dmamem_free(sc, ap->ap_dmamem_cmd_list);
917                 ap->ap_dmamem_cmd_list = NULL;
918         }
919         if (ap->ap_dmamem_rfis) {
920                 ahci_dmamem_free(sc, ap->ap_dmamem_rfis);
921                 ap->ap_dmamem_rfis = NULL;
922         }
923         if (ap->ap_dmamem_cmd_table) {
924                 ahci_dmamem_free(sc, ap->ap_dmamem_cmd_table);
925                 ap->ap_dmamem_cmd_table = NULL;
926         }
927         if (ap->ap_ata) {
928                 for (i = 0; i < AHCI_MAX_PMPORTS; ++i) {
929                         if (ap->ap_ata[i]) {
930                                 kfree(ap->ap_ata[i], M_DEVBUF);
931                                 ap->ap_ata[i] = NULL;
932                         }
933                 }
934         }
935         if (ap->ap_err_scratch) {
936                 kfree(ap->ap_err_scratch, M_DEVBUF);
937                 ap->ap_err_scratch = NULL;
938         }
939
940         /* bus_space(9) says we dont free the subregions handle */
941
942         kfree(ap, M_DEVBUF);
943         sc->sc_ports[port] = NULL;
944 }
945
946 static
947 u_int32_t
948 ahci_pactive(struct ahci_port *ap)
949 {
950         u_int32_t mask;
951
952         mask = ahci_pread(ap, AHCI_PREG_CI);
953         if (ap->ap_sc->sc_cap & AHCI_REG_CAP_SNCQ)
954                 mask |= ahci_pread(ap, AHCI_PREG_SACT);
955         return(mask);
956 }
957
958 /*
959  * Start high-level command processing on the port
960  */
961 int
962 ahci_port_start(struct ahci_port *ap)
963 {
964         u_int32_t       r, s, is, tfd;
965
966         /*
967          * FRE must be turned on before ST.  Wait for FR to go active
968          * before turning on ST.  The spec doesn't seem to think this
969          * is necessary but waiting here avoids an on-off race in the
970          * ahci_port_stop() code.
971          */
972         r = ahci_pread(ap, AHCI_PREG_CMD);
973         if ((r & AHCI_PREG_CMD_FRE) == 0) {
974                 r |= AHCI_PREG_CMD_FRE;
975                 ahci_pwrite(ap, AHCI_PREG_CMD, r);
976         }
977         if ((ap->ap_sc->sc_flags & AHCI_F_IGN_FR) == 0) {
978                 if (ahci_pwait_set(ap, AHCI_PREG_CMD, AHCI_PREG_CMD_FR)) {
979                         kprintf("%s: Cannot start FIS reception\n",
980                                 PORTNAME(ap));
981                         return (2);
982                 }
983         } else {
984                 ahci_os_sleep(10);
985         }
986
987         /*
988          * Turn on ST, wait for CR to come up.
989          */
990         r |= AHCI_PREG_CMD_ST;
991         ahci_pwrite(ap, AHCI_PREG_CMD, r);
992         if (ahci_pwait_set_to(ap, 2000, AHCI_PREG_CMD, AHCI_PREG_CMD_CR)) {
993                 s = ahci_pread(ap, AHCI_PREG_SERR);
994                 is = ahci_pread(ap, AHCI_PREG_IS);
995                 tfd = ahci_pread(ap, AHCI_PREG_TFD);
996                 kprintf("%s: Cannot start command DMA\n"
997                         "NCMP=%b NSERR=%b\n"
998                         "NEWIS=%b\n"
999                         "NEWTFD=%b\n",
1000                         PORTNAME(ap),
1001                         r, AHCI_PFMT_CMD, s, AHCI_PFMT_SERR,
1002                         is, AHCI_PFMT_IS,
1003                         tfd, AHCI_PFMT_TFD_STS);
1004                 return (1);
1005         }
1006
1007 #ifdef AHCI_COALESCE
1008         /*
1009          * (Re-)enable coalescing on the port.
1010          */
1011         if (ap->ap_sc->sc_ccc_ports & (1 << ap->ap_num)) {
1012                 ap->ap_sc->sc_ccc_ports_cur |= (1 << ap->ap_num);
1013                 ahci_write(ap->ap_sc, AHCI_REG_CCC_PORTS,
1014                     ap->ap_sc->sc_ccc_ports_cur);
1015         }
1016 #endif
1017
1018         return (0);
1019 }
1020
1021 /*
1022  * Stop high-level command processing on a port
1023  *
1024  * WARNING!  If the port is stopped while CR is still active our saved
1025  *           CI/SACT will race any commands completed by the command
1026  *           processor prior to being able to stop.  Thus we never call
1027  *           this function unless we intend to dispose of any remaining
1028  *           active commands.  In particular, this complicates the timeout
1029  *           code.
1030  */
1031 int
1032 ahci_port_stop(struct ahci_port *ap, int stop_fis_rx)
1033 {
1034         u_int32_t       r;
1035
1036 #ifdef AHCI_COALESCE
1037         /*
1038          * Disable coalescing on the port while it is stopped.
1039          */
1040         if (ap->ap_sc->sc_ccc_ports & (1 << ap->ap_num)) {
1041                 ap->ap_sc->sc_ccc_ports_cur &= ~(1 << ap->ap_num);
1042                 ahci_write(ap->ap_sc, AHCI_REG_CCC_PORTS,
1043                     ap->ap_sc->sc_ccc_ports_cur);
1044         }
1045 #endif
1046
1047         /*
1048          * Turn off ST, then wait for CR to go off.
1049          */
1050         r = ahci_pread(ap, AHCI_PREG_CMD) & ~AHCI_PREG_CMD_ICC;
1051         r &= ~AHCI_PREG_CMD_ST;
1052         ahci_pwrite(ap, AHCI_PREG_CMD, r);
1053
1054         if (ahci_pwait_clr(ap, AHCI_PREG_CMD, AHCI_PREG_CMD_CR)) {
1055                 kprintf("%s: Port bricked, unable to stop (ST)\n",
1056                         PORTNAME(ap));
1057                 return (1);
1058         }
1059
1060 #if 0
1061         /*
1062          * Turn off FRE, then wait for FR to go off.  FRE cannot
1063          * be turned off until CR transitions to 0.
1064          */
1065         if ((r & AHCI_PREG_CMD_FR) == 0) {
1066                 kprintf("%s: FR stopped, clear FRE for next start\n",
1067                         PORTNAME(ap));
1068                 stop_fis_rx = 2;
1069         }
1070 #endif
1071         if (stop_fis_rx) {
1072                 r &= ~AHCI_PREG_CMD_FRE;
1073                 ahci_pwrite(ap, AHCI_PREG_CMD, r);
1074                 if (ahci_pwait_clr(ap, AHCI_PREG_CMD, AHCI_PREG_CMD_FR)) {
1075                         kprintf("%s: Port bricked, unable to stop (FRE)\n",
1076                                 PORTNAME(ap));
1077                         return (2);
1078                 }
1079         }
1080
1081         return (0);
1082 }
1083
1084 /*
1085  * AHCI command list override -> forcibly clear TFD.STS.{BSY,DRQ}
1086  */
1087 int
1088 ahci_port_clo(struct ahci_port *ap)
1089 {
1090         struct ahci_softc               *sc = ap->ap_sc;
1091         u_int32_t                       cmd;
1092
1093         /* Only attempt CLO if supported by controller */
1094         if ((ahci_read(sc, AHCI_REG_CAP) & AHCI_REG_CAP_SCLO) == 0)
1095                 return (1);
1096
1097         /* Issue CLO */
1098         cmd = ahci_pread(ap, AHCI_PREG_CMD) & ~AHCI_PREG_CMD_ICC;
1099         ahci_pwrite(ap, AHCI_PREG_CMD, cmd | AHCI_PREG_CMD_CLO);
1100
1101         /* Wait for completion */
1102         if (ahci_pwait_clr(ap, AHCI_PREG_CMD, AHCI_PREG_CMD_CLO)) {
1103                 kprintf("%s: CLO did not complete\n", PORTNAME(ap));
1104                 return (1);
1105         }
1106
1107         return (0);
1108 }
1109
1110 /*
1111  * Reset a port.
1112  *
1113  * If hard is 0 perform a softreset of the port.
1114  * If hard is 1 perform a hard reset of the port.
1115  *
1116  * If at is non-NULL an indirect port via a port-multiplier is being
1117  * reset, otherwise a direct port is being reset.
1118  *
1119  * NOTE: Indirect ports can only be soft-reset.
1120  */
1121 int
1122 ahci_port_reset(struct ahci_port *ap, struct ata_port *at, int hard)
1123 {
1124         int rc;
1125
1126         if (hard) {
1127                 if (at)
1128                         rc = ahci_pm_hardreset(ap, at->at_target, hard);
1129                 else
1130                         rc = ahci_port_hardreset(ap, hard);
1131         } else {
1132                 if (at)
1133                         rc = ahci_pm_softreset(ap, at->at_target);
1134                 else
1135                         rc = ahci_port_softreset(ap);
1136         }
1137         return(rc);
1138 }
1139
1140 /*
1141  * AHCI soft reset, Section 10.4.1
1142  *
1143  * (at) will be NULL when soft-resetting a directly-attached device, and
1144  * non-NULL when soft-resetting a device through a port multiplier.
1145  *
1146  * This function keeps port communications intact and attempts to generate
1147  * a reset to the connected device using device commands.
1148  */
1149 int
1150 ahci_port_softreset(struct ahci_port *ap)
1151 {
1152         struct ahci_ccb         *ccb = NULL;
1153         struct ahci_cmd_hdr     *cmd_slot;
1154         u_int8_t                *fis;
1155         int                     error;
1156
1157         error = EIO;
1158
1159         if (bootverbose) {
1160                 kprintf("%s: START SOFTRESET %b\n", PORTNAME(ap),
1161                         ahci_pread(ap, AHCI_PREG_CMD), AHCI_PFMT_CMD);
1162         }
1163
1164         DPRINTF(AHCI_D_VERBOSE, "%s: soft reset\n", PORTNAME(ap));
1165
1166         crit_enter();
1167         ap->ap_flags |= AP_F_IN_RESET;
1168         ap->ap_state = AP_S_NORMAL;
1169
1170         /*
1171          * Remember port state in cmd (main to restore start/stop)
1172          *
1173          * Idle port.
1174          */
1175         if (ahci_port_stop(ap, 0)) {
1176                 kprintf("%s: failed to stop port, cannot softreset\n",
1177                         PORTNAME(ap));
1178                 goto err;
1179         }
1180
1181         /*
1182          * Request CLO if device appears hung.
1183          */
1184         if (ahci_pread(ap, AHCI_PREG_TFD) &
1185                    (AHCI_PREG_TFD_STS_BSY | AHCI_PREG_TFD_STS_DRQ)) {
1186                 ahci_port_clo(ap);
1187         }
1188
1189         /*
1190          * This is an attempt to clear errors so a new signature will
1191          * be latched.  It isn't working properly.  XXX
1192          */
1193         ahci_flush_tfd(ap);
1194         ahci_pwrite(ap, AHCI_PREG_SERR, -1);
1195
1196         /* Restart port */
1197         if (ahci_port_start(ap)) {
1198                 kprintf("%s: failed to start port, cannot softreset\n",
1199                         PORTNAME(ap));
1200                 goto err;
1201         }
1202
1203         /* Check whether CLO worked */
1204         if (ahci_pwait_clr(ap, AHCI_PREG_TFD,
1205                                AHCI_PREG_TFD_STS_BSY | AHCI_PREG_TFD_STS_DRQ)) {
1206                 kprintf("%s: CLO %s, need port reset\n",
1207                         PORTNAME(ap),
1208                         (ahci_read(ap->ap_sc, AHCI_REG_CAP) & AHCI_REG_CAP_SCLO)
1209                         ? "failed" : "unsupported");
1210                 error = EBUSY;
1211                 goto err;
1212         }
1213
1214         /*
1215          * Prep first D2H command with SRST feature & clear busy/reset flags
1216          *
1217          * It is unclear which other fields in the FIS are used.  Just zero
1218          * everything.
1219          *
1220          * NOTE!  This CCB is used for both the first and second commands.
1221          *        The second command must use CCB slot 1 to properly load
1222          *        the signature.
1223          */
1224         ccb = ahci_get_err_ccb(ap);
1225         ccb->ccb_xa.complete = ahci_dummy_done;
1226         ccb->ccb_xa.flags = ATA_F_POLL | ATA_F_EXCLUSIVE;
1227         KKASSERT(ccb->ccb_slot == 1);
1228         ccb->ccb_xa.at = NULL;
1229         cmd_slot = ccb->ccb_cmd_hdr;
1230
1231         fis = ccb->ccb_cmd_table->cfis;
1232         bzero(fis, sizeof(ccb->ccb_cmd_table->cfis));
1233         fis[0] = ATA_FIS_TYPE_H2D;
1234         fis[15] = ATA_FIS_CONTROL_SRST|ATA_FIS_CONTROL_4BIT;
1235
1236         cmd_slot->prdtl = 0;
1237         cmd_slot->flags = htole16(5);   /* FIS length: 5 DWORDS */
1238         cmd_slot->flags |= htole16(AHCI_CMD_LIST_FLAG_C); /* Clear busy on OK */
1239         cmd_slot->flags |= htole16(AHCI_CMD_LIST_FLAG_R); /* Reset */
1240
1241         ccb->ccb_xa.state = ATA_S_PENDING;
1242
1243         if (ahci_poll(ccb, 1000, ahci_quick_timeout) != ATA_S_COMPLETE) {
1244                 kprintf("%s: First FIS failed\n", PORTNAME(ap));
1245                 goto err;
1246         }
1247
1248         /*
1249          * WARNING!     TIME SENSITIVE SPACE!   WARNING!
1250          *
1251          * The two FISes are supposed to be back to back.  Don't issue other
1252          * commands or even delay if we can help it.
1253          */
1254
1255         /*
1256          * Prep second D2H command to read status and complete reset sequence
1257          * AHCI 10.4.1 and "Serial ATA Revision 2.6".  I can't find the ATA
1258          * Rev 2.6 and it is unclear how the second FIS should be set up
1259          * from the AHCI document.
1260          *
1261          * It is unclear which other fields in the FIS are used.  Just zero
1262          * everything.
1263          */
1264         ccb->ccb_xa.flags = ATA_F_POLL | ATA_F_AUTOSENSE | ATA_F_EXCLUSIVE;
1265
1266         bzero(fis, sizeof(ccb->ccb_cmd_table->cfis));
1267         fis[0] = ATA_FIS_TYPE_H2D;
1268         fis[15] = ATA_FIS_CONTROL_4BIT;
1269
1270         cmd_slot->prdtl = 0;
1271         cmd_slot->flags = htole16(5);   /* FIS length: 5 DWORDS */
1272
1273         ccb->ccb_xa.state = ATA_S_PENDING;
1274         if (ahci_poll(ccb, 1000, ahci_quick_timeout) != ATA_S_COMPLETE) {
1275                 kprintf("%s: Second FIS failed\n", PORTNAME(ap));
1276                 goto err;
1277         }
1278
1279         if (ahci_pwait_clr(ap, AHCI_PREG_TFD,
1280                             AHCI_PREG_TFD_STS_BSY | AHCI_PREG_TFD_STS_DRQ)) {
1281                 kprintf("%s: device didn't come ready after reset, TFD: 0x%b\n",
1282                         PORTNAME(ap),
1283                         ahci_pread(ap, AHCI_PREG_TFD), AHCI_PFMT_TFD_STS);
1284                 error = EBUSY;
1285                 goto err;
1286         }
1287
1288         /*
1289          * If the softreset is trying to clear a BSY condition after a
1290          * normal portreset we assign the port type.
1291          *
1292          * If the softreset is being run first as part of the ccb error
1293          * processing code then report if the device signature changed
1294          * unexpectedly.
1295          */
1296         ahci_os_sleep(100);
1297         if (ap->ap_type == ATA_PORT_T_NONE) {
1298                 ap->ap_type = ahci_port_signature_detect(ap, NULL);
1299         } else {
1300                 if (ahci_port_signature_detect(ap, NULL) != ap->ap_type) {
1301                         kprintf("%s: device signature unexpectedly "
1302                                 "changed\n", PORTNAME(ap));
1303                         error = EBUSY; /* XXX */
1304                 }
1305         }
1306         error = 0;
1307
1308         ahci_os_sleep(3);
1309 err:
1310         if (ccb != NULL) {
1311                 ahci_put_err_ccb(ccb);
1312
1313                 /*
1314                  * If the target is busy use CLO to clear the busy
1315                  * condition.  The BSY should be cleared on the next
1316                  * start.
1317                  */
1318                 if (ahci_pread(ap, AHCI_PREG_TFD) &
1319                     (AHCI_PREG_TFD_STS_BSY | AHCI_PREG_TFD_STS_DRQ)) {
1320                         ahci_port_clo(ap);
1321                 }
1322         }
1323
1324         /*
1325          * If we failed to softreset make the port quiescent, otherwise
1326          * make sure the port's start/stop state matches what it was on
1327          * entry.
1328          *
1329          * Don't kill the port if the softreset is on a port multiplier
1330          * target, that would kill all the targets!
1331          */
1332         if (error) {
1333                 ahci_port_hardstop(ap);
1334                 /* ap_probe set to failed */
1335         } else {
1336                 ap->ap_probe = ATA_PROBE_NEED_IDENT;
1337                 ap->ap_pmcount = 1;
1338                 ahci_port_start(ap);
1339         }
1340         ap->ap_flags &= ~AP_F_IN_RESET;
1341         crit_exit();
1342
1343         if (bootverbose)
1344                 kprintf("%s: END SOFTRESET\n", PORTNAME(ap));
1345
1346         return (error);
1347 }
1348
1349 /*
1350  * Issue just do the core COMRESET and basic device detection on a port.
1351  *
1352  * NOTE: Only called by ahci_port_hardreset().
1353  */
1354 static int
1355 ahci_comreset(struct ahci_port *ap, int *pmdetectp)
1356 {
1357         u_int32_t cmd;
1358         u_int32_t r;
1359         int error;
1360         int loop;
1361         int retries = 0;
1362
1363         /*
1364          * Idle the port,
1365          */
1366         *pmdetectp = 0;
1367         ahci_port_stop(ap, 0);
1368         ap->ap_state = AP_S_NORMAL;
1369         ahci_os_sleep(10);
1370
1371         /*
1372          * The port may have been quiescent with its SUD bit cleared, so
1373          * set the SUD (spin up device).
1374          *
1375          * NOTE: I do not know if SUD is a hardware pin/low-level signal
1376          *       or if it is messaged.
1377          */
1378         cmd = ahci_pread(ap, AHCI_PREG_CMD) & ~AHCI_PREG_CMD_ICC;
1379
1380         cmd |= AHCI_PREG_CMD_SUD | AHCI_PREG_CMD_POD;
1381         ahci_pwrite(ap, AHCI_PREG_CMD, cmd);
1382         ahci_os_sleep(10);
1383
1384         /*
1385          * Make sure that all power management is disabled.
1386          *
1387          * NOTE!  AHCI_PREG_SCTL_DET_DISABLE seems to be highly unreliable
1388          *        on multiple chipsets and can brick the chipset or even
1389          *        the whole PC.  Never use it.
1390          */
1391         ap->ap_type = ATA_PORT_T_NONE;
1392
1393         r = AHCI_PREG_SCTL_IPM_DISABLED |
1394             AHCI_PREG_SCTL_SPM_DISABLED;
1395         ahci_pwrite(ap, AHCI_PREG_SCTL, r);
1396
1397 retry:
1398         /*
1399          * Give the new power management state time to settle, then clear
1400          * pending status.
1401          */
1402         ahci_os_sleep(1000);
1403         ahci_flush_tfd(ap);
1404         ahci_pwrite(ap, AHCI_PREG_SERR, -1);
1405
1406         /*
1407          * Start transmitting COMRESET.  The spec says that COMRESET must
1408          * be sent for at least 1ms but in actual fact numerous devices
1409          * appear to take much longer.  Delay a whole second here.
1410          *
1411          * In addition, SATA-3 ports can take longer to train, so even
1412          * SATA-2 devices which would normally detect very quickly may
1413          * take longer when plugged into a SATA-3 port.
1414          */
1415         r |= AHCI_PREG_SCTL_DET_INIT;
1416         switch(AhciForceGen) {
1417         case 0:
1418                 r |= AHCI_PREG_SCTL_SPD_ANY;
1419                 break;
1420         case 1:
1421                 r |= AHCI_PREG_SCTL_SPD_GEN1;
1422                 break;
1423         case 2:
1424                 r |= AHCI_PREG_SCTL_SPD_GEN2;
1425                 break;
1426         case 3:
1427                 r |= AHCI_PREG_SCTL_SPD_GEN3;
1428                 break;
1429         default:
1430                 r |= AHCI_PREG_SCTL_SPD_GEN3;
1431                 break;
1432         }
1433         ahci_pwrite(ap, AHCI_PREG_SCTL, r);
1434         ahci_os_sleep(1000);
1435
1436         ap->ap_flags &= ~AP_F_HARSH_REINIT;
1437
1438         /*
1439          * Only SERR_DIAG_X needs to be cleared for TFD updates, but
1440          * since we are hard-resetting the port we might as well clear
1441          * the whole enchillada.  Also be sure to clear any spurious BSY
1442          * prior to clearing INIT.
1443          *
1444          * Wait 1 whole second after clearing INIT before checking
1445          * the device detection bits in an attempt to work around chipsets
1446          * which do not properly mask PCS/PRCS during low level init.
1447          */
1448         ahci_flush_tfd(ap);
1449         ahci_pwrite(ap, AHCI_PREG_SERR, -1);
1450 /*      ahci_port_clo(ap);*/
1451         ahci_os_sleep(10);
1452
1453         r &= ~AHCI_PREG_SCTL_SPD;
1454         r &= ~AHCI_PREG_SCTL_DET_INIT;
1455         r |= AHCI_PREG_SCTL_DET_NONE;
1456         ahci_pwrite(ap, AHCI_PREG_SCTL, r);
1457         ahci_os_sleep(1000);
1458
1459         /*
1460          * Try to determine if there is a device on the port.
1461          *
1462          * Give the device 3/10 second to at least be detected.
1463          * If we fail clear PRCS (phy detect) since we may cycled
1464          * the phy and probably caused another PRCS interrupt.
1465          */
1466         loop = 300;
1467         while (loop > 0) {
1468                 r = ahci_pread(ap, AHCI_PREG_SSTS);
1469                 if (r & AHCI_PREG_SSTS_DET)
1470                         break;
1471                 loop -= ahci_os_softsleep();
1472         }
1473         if (loop == 0) {
1474                 ahci_pwrite(ap, AHCI_PREG_IS, AHCI_PREG_IS_PRCS);
1475                 if (bootverbose) {
1476                         kprintf("%s: Port appears to be unplugged\n",
1477                                 PORTNAME(ap));
1478                 }
1479                 error = ENODEV;
1480                 goto done;
1481         }
1482
1483         /*
1484          * There is something on the port.  Regardless of what happens
1485          * after this tell the caller to try to detect a port multiplier.
1486          *
1487          * Give the device 3 seconds to fully negotiate.
1488          */
1489         *pmdetectp = 1;
1490
1491         if (ahci_pwait_eq(ap, 3000, AHCI_PREG_SSTS,
1492                           AHCI_PREG_SSTS_DET, AHCI_PREG_SSTS_DET_DEV)) {
1493                 if (bootverbose) {
1494                         kprintf("%s: Device may be powered down\n",
1495                                 PORTNAME(ap));
1496                 }
1497                 error = ENODEV;
1498                 goto done;
1499         }
1500
1501         /*
1502          * We got something that definitely looks like a device.  Give
1503          * the device time to send us its first D2H FIS.  Waiting for
1504          * BSY to clear accomplishes this.
1505          *
1506          * NOTE: A port multiplier may or may not clear BSY here,
1507          *       depending on what is sitting in target 0 behind it.
1508          *
1509          * NOTE: Intel SSDs seem to have compatibility problems with Intel
1510          *       mobo's on cold boots and may leave BSY set.  A single
1511          *       retry works around the problem.  This is definitely a bug
1512          *       with the mobo and/or the SSD and does not appear to occur
1513          *       with other devices connected to the same port.
1514          */
1515         ahci_flush_tfd(ap);
1516         if (ahci_pwait_clr_to(ap, 8000, AHCI_PREG_TFD,
1517                             AHCI_PREG_TFD_STS_BSY | AHCI_PREG_TFD_STS_DRQ)) {
1518                 kprintf("%s: Device BUSY: %b\n",
1519                         PORTNAME(ap),
1520                         ahci_pread(ap, AHCI_PREG_TFD),
1521                                 AHCI_PFMT_TFD_STS);
1522                 if (retries == 0) {
1523                         kprintf("%s: Retrying\n", PORTNAME(ap));
1524                         retries = 1;
1525                         goto retry;
1526                 }
1527                 error = EBUSY;
1528         } else {
1529                 error = 0;
1530         }
1531
1532 done:
1533         ahci_flush_tfd(ap);
1534         return error;
1535 }
1536
1537
1538 /*
1539  * AHCI port reset, Section 10.4.2
1540  *
1541  * This function does a hard reset of the port.  Note that the device
1542  * connected to the port could still end-up hung.
1543  */
1544 int
1545 ahci_port_hardreset(struct ahci_port *ap, int hard)
1546 {
1547         u_int32_t data;
1548         int     error;
1549         int     pmdetect;
1550
1551         if (bootverbose)
1552                 kprintf("%s: START HARDRESET\n", PORTNAME(ap));
1553         ap->ap_flags |= AP_F_IN_RESET;
1554
1555         error = ahci_comreset(ap, &pmdetect);
1556
1557         /*
1558          * We may be asked to perform a port multiplier check even if the
1559          * comreset failed.  This typically occurs when the PM has nothing
1560          * in slot 0, which can cause BSY to remain set.
1561          *
1562          * If the PM detection is successful it will override (error),
1563          * otherwise (error) is retained.  If an error does occur it
1564          * is possible that a normal device has blown up on us DUE to
1565          * the PM detection code, so re-run the comreset and assume
1566          * a normal device.
1567          */
1568         if (pmdetect) {
1569                 if (ap->ap_sc->sc_cap & AHCI_REG_CAP_SPM) {
1570                         error = ahci_pm_port_probe(ap, error);
1571                         if (error) {
1572                                 error = ahci_comreset(ap, &pmdetect);
1573                         }
1574                 }
1575         }
1576
1577         /*
1578          * Finish up.
1579          */
1580         ahci_os_sleep(500);
1581
1582         switch(error) {
1583         case 0:
1584                 /*
1585                  * All good, make sure the port is running and set the
1586                  * probe state.  Ignore the signature junk (it's unreliable)
1587                  * until we get to the softreset code.
1588                  */
1589                 if (ahci_port_start(ap)) {
1590                         kprintf("%s: failed to start command DMA on port, "
1591                                 "disabling\n", PORTNAME(ap));
1592                         error = EBUSY;
1593                         break;
1594                 }
1595                 if (ap->ap_type == ATA_PORT_T_PM)
1596                         ap->ap_probe = ATA_PROBE_GOOD;
1597                 else
1598                         ap->ap_probe = ATA_PROBE_NEED_SOFT_RESET;
1599                 break;
1600         case ENODEV:
1601                 /*
1602                  * Normal device probe failure
1603                  */
1604                 data = ahci_pread(ap, AHCI_PREG_SSTS);
1605
1606                 switch(data & AHCI_PREG_SSTS_DET) {
1607                 case AHCI_PREG_SSTS_DET_DEV_NE:
1608                         kprintf("%s: Device not communicating\n",
1609                                 PORTNAME(ap));
1610                         break;
1611                 case AHCI_PREG_SSTS_DET_PHYOFFLINE:
1612                         kprintf("%s: PHY offline\n",
1613                                 PORTNAME(ap));
1614                         break;
1615                 default:
1616                         kprintf("%s: No device detected\n",
1617                                 PORTNAME(ap));
1618                         break;
1619                 }
1620                 ahci_port_hardstop(ap);
1621                 break;
1622         default:
1623                 /*
1624                  * Abnormal probe (EBUSY)
1625                  */
1626                 kprintf("%s: Device on port is bricked\n",
1627                         PORTNAME(ap));
1628                 ahci_port_hardstop(ap);
1629 #if 0
1630                 rc = ahci_port_reset(ap, atx, 0);
1631                 if (rc) {
1632                         kprintf("%s: Unable unbrick device\n",
1633                                 PORTNAME(ap));
1634                 } else {
1635                         kprintf("%s: Successfully unbricked\n",
1636                                 PORTNAME(ap));
1637                 }
1638 #endif
1639                 break;
1640         }
1641
1642         /*
1643          * Clean up
1644          */
1645         ahci_pwrite(ap, AHCI_PREG_SERR, -1);
1646         ahci_pwrite(ap, AHCI_PREG_IS, AHCI_PREG_IS_PCS | AHCI_PREG_IS_PRCS);
1647
1648         ap->ap_flags &= ~AP_F_IN_RESET;
1649
1650         if (bootverbose)
1651                 kprintf("%s: END HARDRESET %d\n", PORTNAME(ap), error);
1652         return (error);
1653 }
1654
1655 /*
1656  * Hard-stop on hot-swap device removal.  See 10.10.1
1657  *
1658  * Place the port in a mode that will allow it to detect hot-swap insertions.
1659  * This is a bit imprecise because just setting-up SCTL to DET_INIT doesn't
1660  * seem to do the job.
1661  *
1662  * FIS reception is left enabled but command processing is disabled.
1663  * Cycling FIS reception (FRE) can brick ports.
1664  */
1665 void
1666 ahci_port_hardstop(struct ahci_port *ap)
1667 {
1668         struct ahci_ccb *ccb;
1669         struct ata_port *at;
1670         u_int32_t r;
1671         u_int32_t cmd;
1672         int slot;
1673         int i;
1674
1675         /*
1676          * Stop the port.  We can't modify things like SUD if the port
1677          * is running.
1678          */
1679         ap->ap_state = AP_S_FATAL_ERROR;
1680         ap->ap_probe = ATA_PROBE_FAILED;
1681         ap->ap_type = ATA_PORT_T_NONE;
1682         ahci_port_stop(ap, 0);
1683         cmd = ahci_pread(ap, AHCI_PREG_CMD);
1684         cmd &= ~(AHCI_PREG_CMD_CLO | AHCI_PREG_CMD_PMA | AHCI_PREG_CMD_ICC);
1685         ahci_pwrite(ap, AHCI_PREG_CMD, cmd);
1686
1687         /*
1688          * Clean up AT sub-ports on SATA port.
1689          */
1690         for (i = 0; ap->ap_ata && i < AHCI_MAX_PMPORTS; ++i) {
1691                 at = ap->ap_ata[i];
1692                 at->at_type = ATA_PORT_T_NONE;
1693                 at->at_probe = ATA_PROBE_FAILED;
1694         }
1695
1696         /*
1697          * Make sure FRE is active.  There isn't anything we can do if it
1698          * fails so just ignore errors.
1699          */
1700         if ((cmd & AHCI_PREG_CMD_FRE) == 0) {
1701                 cmd |= AHCI_PREG_CMD_FRE;
1702                 ahci_pwrite(ap, AHCI_PREG_CMD, cmd);
1703                 if ((ap->ap_sc->sc_flags & AHCI_F_IGN_FR) == 0)
1704                         ahci_pwait_set(ap, AHCI_PREG_CMD, AHCI_PREG_CMD_FR);
1705         }
1706
1707         /*
1708          * 10.10.1 place us in the Listen state.
1709          *
1710          * 10.10.3 DET must be set to 0 and found to be 0 before
1711          * setting SUD to 0.
1712          *
1713          * Deactivating SUD only applies if the controller supports SUD, it
1714          * is a bit unclear what happens w/regards to detecting hotplug
1715          * if it doesn't.
1716          */
1717         r = AHCI_PREG_SCTL_IPM_DISABLED |
1718             AHCI_PREG_SCTL_SPM_DISABLED;
1719         ahci_pwrite(ap, AHCI_PREG_SCTL, r);
1720         ahci_os_sleep(10);
1721         cmd &= ~AHCI_PREG_CMD_SUD;
1722         ahci_pwrite(ap, AHCI_PREG_CMD, cmd);
1723         ahci_os_sleep(10);
1724
1725         /*
1726          * 10.10.1
1727          *
1728          * Transition su to the spin-up state.  HBA shall send COMRESET and
1729          * begin initialization sequence (whatever that means).  Presumably
1730          * this is edge-triggered.  Following the spin-up state the HBA
1731          * will automatically transition to the Normal state.
1732          *
1733          * This only applies if the controller supports SUD.
1734          * NEVER use AHCI_PREG_DET_DISABLE.
1735          */
1736         cmd |= AHCI_PREG_CMD_POD |
1737                AHCI_PREG_CMD_SUD |
1738                AHCI_PREG_CMD_ICC_ACTIVE;
1739         ahci_pwrite(ap, AHCI_PREG_CMD, cmd);
1740         ahci_os_sleep(10);
1741
1742         /*
1743          * Flush SERR_DIAG_X so the TFD can update.
1744          */
1745         ahci_flush_tfd(ap);
1746
1747         /*
1748          * Clean out pending ccbs
1749          */
1750         while (ap->ap_active) {
1751                 slot = ffs(ap->ap_active) - 1;
1752                 ap->ap_active &= ~(1 << slot);
1753                 ap->ap_expired &= ~(1 << slot);
1754                 --ap->ap_active_cnt;
1755                 ccb = &ap->ap_ccbs[slot];
1756                 if (ccb->ccb_xa.flags & ATA_F_TIMEOUT_RUNNING) {
1757                         callout_stop(&ccb->ccb_timeout);
1758                         ccb->ccb_xa.flags &= ~ATA_F_TIMEOUT_RUNNING;
1759                 }
1760                 ccb->ccb_xa.flags &= ~(ATA_F_TIMEOUT_DESIRED |
1761                                        ATA_F_TIMEOUT_EXPIRED);
1762                 ccb->ccb_xa.state = ATA_S_TIMEOUT;
1763                 ccb->ccb_done(ccb);
1764                 ccb->ccb_xa.complete(&ccb->ccb_xa);
1765         }
1766         while (ap->ap_sactive) {
1767                 slot = ffs(ap->ap_sactive) - 1;
1768                 ap->ap_sactive &= ~(1 << slot);
1769                 ap->ap_expired &= ~(1 << slot);
1770                 ccb = &ap->ap_ccbs[slot];
1771                 if (ccb->ccb_xa.flags & ATA_F_TIMEOUT_RUNNING) {
1772                         callout_stop(&ccb->ccb_timeout);
1773                         ccb->ccb_xa.flags &= ~ATA_F_TIMEOUT_RUNNING;
1774                 }
1775                 ccb->ccb_xa.flags &= ~(ATA_F_TIMEOUT_DESIRED |
1776                                        ATA_F_TIMEOUT_EXPIRED);
1777                 ccb->ccb_xa.state = ATA_S_TIMEOUT;
1778                 ccb->ccb_done(ccb);
1779                 ccb->ccb_xa.complete(&ccb->ccb_xa);
1780         }
1781         KKASSERT(ap->ap_active_cnt == 0);
1782
1783         while ((ccb = TAILQ_FIRST(&ap->ap_ccb_pending)) != NULL) {
1784                 TAILQ_REMOVE(&ap->ap_ccb_pending, ccb, ccb_entry);
1785                 ccb->ccb_xa.state = ATA_S_TIMEOUT;
1786                 ccb->ccb_xa.flags &= ~ATA_F_TIMEOUT_DESIRED;
1787                 ccb->ccb_done(ccb);
1788                 ccb->ccb_xa.complete(&ccb->ccb_xa);
1789         }
1790
1791         /*
1792          * Hot-plug device detection should work at this point.  e.g. on
1793          * AMD chipsets Spin-Up/Normal state is sufficient for hot-plug
1794          * detection and entering RESET (continuous COMRESET by setting INIT)
1795          * will actually prevent hot-plug detection from working properly.
1796          *
1797          * There may be cases where this will fail to work, I have some
1798          * additional code to place the HBA in RESET (send continuous
1799          * COMRESET) and hopefully get DIAG.X or other events when something
1800          * is plugged in.  Unfortunately this isn't universal and can
1801          * also prevent events from generating interrupts.
1802          */
1803
1804 #if 0
1805         /*
1806          * Transition us to the Reset state.  Theoretically we send a
1807          * continuous stream of COMRESETs in this state.
1808          */
1809         r |= AHCI_PREG_SCTL_DET_INIT;
1810         if (AhciForceGen1 & (1 << ap->ap_num)) {
1811                 kprintf("%s: Force 1.5Gbits\n", PORTNAME(ap));
1812                 r |= AHCI_PREG_SCTL_SPD_GEN1;
1813         } else {
1814                 r |= AHCI_PREG_SCTL_SPD_ANY;
1815         }
1816         ahci_pwrite(ap, AHCI_PREG_SCTL, r);
1817         ahci_os_sleep(10);
1818
1819         /*
1820          * Flush SERR_DIAG_X so the TFD can update.
1821          */
1822         ahci_flush_tfd(ap);
1823 #endif
1824         /* NOP */
1825 }
1826
1827 /*
1828  * We can't loop on the X bit, a continuous COMINIT received will make
1829  * it loop forever.  Just assume one event has built up and clear X
1830  * so the task file descriptor can update.
1831  */
1832 void
1833 ahci_flush_tfd(struct ahci_port *ap)
1834 {
1835         u_int32_t r;
1836
1837         r = ahci_pread(ap, AHCI_PREG_SERR);
1838         if (r & AHCI_PREG_SERR_DIAG_X)
1839                 ahci_pwrite(ap, AHCI_PREG_SERR, AHCI_PREG_SERR_DIAG_X);
1840 }
1841
1842 /*
1843  * Figure out what type of device is connected to the port, ATAPI or
1844  * DISK.
1845  */
1846 int
1847 ahci_port_signature_detect(struct ahci_port *ap, struct ata_port *at)
1848 {
1849         u_int32_t sig;
1850
1851         sig = ahci_pread(ap, AHCI_PREG_SIG);
1852         if (bootverbose)
1853                 kprintf("%s: sig %08x\n", ATANAME(ap, at), sig);
1854         if ((sig & 0xffff0000) == (SATA_SIGNATURE_ATAPI & 0xffff0000)) {
1855                 return(ATA_PORT_T_ATAPI);
1856         } else if ((sig & 0xffff0000) ==
1857                  (SATA_SIGNATURE_PORT_MULTIPLIER & 0xffff0000)) {
1858                 return(ATA_PORT_T_PM);
1859         } else {
1860                 return(ATA_PORT_T_DISK);
1861         }
1862 }
1863
1864 /*
1865  * Load the DMA descriptor table for a CCB's buffer.
1866  */
1867 int
1868 ahci_load_prdt(struct ahci_ccb *ccb)
1869 {
1870         struct ahci_port                *ap = ccb->ccb_port;
1871         struct ahci_softc               *sc = ap->ap_sc;
1872         struct ata_xfer                 *xa = &ccb->ccb_xa;
1873         struct ahci_prdt                *prdt = ccb->ccb_cmd_table->prdt;
1874         bus_dmamap_t                    dmap = ccb->ccb_dmamap;
1875         struct ahci_cmd_hdr             *cmd_slot = ccb->ccb_cmd_hdr;
1876         int                             error;
1877
1878         if (xa->datalen == 0) {
1879                 ccb->ccb_cmd_hdr->prdtl = 0;
1880                 return (0);
1881         }
1882
1883         error = bus_dmamap_load(sc->sc_tag_data, dmap,
1884                                 xa->data, xa->datalen,
1885                                 ahci_load_prdt_callback,
1886                                 &prdt,
1887                                 ((xa->flags & ATA_F_NOWAIT) ?
1888                                     BUS_DMA_NOWAIT : BUS_DMA_WAITOK));
1889         if (error != 0) {
1890                 kprintf("%s: error %d loading dmamap\n", PORTNAME(ap), error);
1891                 return (1);
1892         }
1893 #if 0
1894         if (xa->flags & ATA_F_PIO)
1895                 prdt->flags |= htole32(AHCI_PRDT_FLAG_INTR);
1896 #endif
1897
1898         cmd_slot->prdtl = htole16(prdt - ccb->ccb_cmd_table->prdt + 1);
1899
1900         if (xa->flags & ATA_F_READ)
1901                 bus_dmamap_sync(sc->sc_tag_data, dmap, BUS_DMASYNC_PREREAD);
1902         if (xa->flags & ATA_F_WRITE)
1903                 bus_dmamap_sync(sc->sc_tag_data, dmap, BUS_DMASYNC_PREWRITE);
1904
1905         return (0);
1906 }
1907
1908 /*
1909  * Callback from BUSDMA system to load the segment list.  The passed segment
1910  * list is a temporary structure.
1911  */
1912 static
1913 void
1914 ahci_load_prdt_callback(void *info, bus_dma_segment_t *segs, int nsegs,
1915                         int error)
1916 {
1917         struct ahci_prdt *prd = *(void **)info;
1918         u_int64_t addr;
1919
1920         KKASSERT(nsegs <= AHCI_MAX_PRDT);
1921
1922         while (nsegs) {
1923                 addr = segs->ds_addr;
1924                 prd->dba_hi = htole32((u_int32_t)(addr >> 32));
1925                 prd->dba_lo = htole32((u_int32_t)addr);
1926                 prd->flags = htole32(segs->ds_len - 1);
1927                 --nsegs;
1928                 if (nsegs)
1929                         ++prd;
1930                 ++segs;
1931         }
1932         *(void **)info = prd;   /* return last valid segment */
1933 }
1934
1935 void
1936 ahci_unload_prdt(struct ahci_ccb *ccb)
1937 {
1938         struct ahci_port                *ap = ccb->ccb_port;
1939         struct ahci_softc               *sc = ap->ap_sc;
1940         struct ata_xfer                 *xa = &ccb->ccb_xa;
1941         bus_dmamap_t                    dmap = ccb->ccb_dmamap;
1942
1943         if (xa->datalen != 0) {
1944                 if (xa->flags & ATA_F_READ) {
1945                         bus_dmamap_sync(sc->sc_tag_data, dmap,
1946                                         BUS_DMASYNC_POSTREAD);
1947                 }
1948                 if (xa->flags & ATA_F_WRITE) {
1949                         bus_dmamap_sync(sc->sc_tag_data, dmap,
1950                                         BUS_DMASYNC_POSTWRITE);
1951                 }
1952                 bus_dmamap_unload(sc->sc_tag_data, dmap);
1953
1954                 /*
1955                  * prdbc is only updated by hardware for non-NCQ commands.
1956                  */
1957                 if (ccb->ccb_xa.flags & ATA_F_NCQ) {
1958                         xa->resid = 0;
1959                 } else {
1960                         if (ccb->ccb_cmd_hdr->prdbc == 0 &&
1961                             ccb->ccb_xa.state == ATA_S_COMPLETE) {
1962                                 kprintf("%s: WARNING!  Unload prdbc resid "
1963                                         "was zero! tag=%d\n",
1964                                         ATANAME(ap, xa->at), ccb->ccb_slot);
1965                         }
1966                         xa->resid = xa->datalen -
1967                             le32toh(ccb->ccb_cmd_hdr->prdbc);
1968                 }
1969         }
1970 }
1971
1972 /*
1973  * Start a command and poll for completion.
1974  *
1975  * timeout is in ms and only counts once the command gets on-chip.
1976  *
1977  * Returns ATA_S_* state, compare against ATA_S_COMPLETE to determine
1978  * that no error occured.
1979  *
1980  * NOTE: If the caller specifies a NULL timeout function the caller is
1981  *       responsible for clearing hardware state on failure, but we will
1982  *       deal with removing the ccb from any pending queue.
1983  *
1984  * NOTE: NCQ should never be used with this function.
1985  *
1986  * NOTE: If the port is in a failed state and stopped we do not try
1987  *       to activate the ccb.
1988  */
1989 int
1990 ahci_poll(struct ahci_ccb *ccb, int timeout,
1991           void (*timeout_fn)(struct ahci_ccb *))
1992 {
1993         struct ahci_port *ap = ccb->ccb_port;
1994
1995         if (ccb->ccb_port->ap_state == AP_S_FATAL_ERROR) {
1996                 ccb->ccb_xa.state = ATA_S_ERROR;
1997                 return(ccb->ccb_xa.state);
1998         }
1999         crit_enter();
2000 #if 0
2001         kprintf("%s: Start command %02x tag=%d\n",
2002                 ATANAME(ccb->ccb_port, ccb->ccb_xa.at),
2003                 ccb->ccb_xa.fis->command, ccb->ccb_slot);
2004 #endif
2005         ahci_start(ccb);
2006
2007         do {
2008                 ahci_port_intr(ap, 1);
2009                 switch(ccb->ccb_xa.state) {
2010                 case ATA_S_ONCHIP:
2011                         timeout -= ahci_os_softsleep();
2012                         break;
2013                 case ATA_S_PENDING:
2014                         ahci_os_softsleep();
2015                         ahci_check_active_timeouts(ap);
2016                         break;
2017                 default:
2018                         crit_exit();
2019                         return (ccb->ccb_xa.state);
2020                 }
2021         } while (timeout > 0);
2022
2023         if ((ccb->ccb_xa.flags & ATA_F_SILENT) == 0) {
2024                 kprintf("%s: Poll timeout slot %d CMD: %b TFD: 0x%b SERR: %b\n",
2025                         ATANAME(ap, ccb->ccb_xa.at), ccb->ccb_slot,
2026                         ahci_pread(ap, AHCI_PREG_CMD), AHCI_PFMT_CMD,
2027                         ahci_pread(ap, AHCI_PREG_TFD), AHCI_PFMT_TFD_STS,
2028                         ahci_pread(ap, AHCI_PREG_SERR), AHCI_PFMT_SERR);
2029         }
2030
2031         timeout_fn(ccb);
2032
2033         crit_exit();
2034
2035         return(ccb->ccb_xa.state);
2036 }
2037
2038 /*
2039  * When polling we have to check if the currently active CCB(s)
2040  * have timed out as the callout will be deadlocked while we
2041  * hold the port lock.
2042  */
2043 void
2044 ahci_check_active_timeouts(struct ahci_port *ap)
2045 {
2046         struct ahci_ccb *ccb;
2047         u_int32_t mask;
2048         int tag;
2049
2050         mask = ap->ap_active | ap->ap_sactive;
2051         while (mask) {
2052                 tag = ffs(mask) - 1;
2053                 mask &= ~(1 << tag);
2054                 ccb = &ap->ap_ccbs[tag];
2055                 if (ccb->ccb_xa.flags & ATA_F_TIMEOUT_EXPIRED) {
2056                         ahci_ata_cmd_timeout(ccb);
2057                 }
2058         }
2059 }
2060
2061 static
2062 __inline
2063 void
2064 ahci_start_timeout(struct ahci_ccb *ccb)
2065 {
2066         if (ccb->ccb_xa.flags & ATA_F_TIMEOUT_DESIRED) {
2067                 ccb->ccb_xa.flags |= ATA_F_TIMEOUT_RUNNING;
2068                 callout_reset(&ccb->ccb_timeout,
2069                               (ccb->ccb_xa.timeout * hz + 999) / 1000,
2070                               ahci_ata_cmd_timeout_unserialized, ccb);
2071         }
2072 }
2073
2074 void
2075 ahci_start(struct ahci_ccb *ccb)
2076 {
2077         struct ahci_port                *ap = ccb->ccb_port;
2078         struct ahci_softc               *sc = ap->ap_sc;
2079
2080         KKASSERT(ccb->ccb_xa.state == ATA_S_PENDING);
2081
2082         /* Zero transferred byte count before transfer */
2083         ccb->ccb_cmd_hdr->prdbc = 0;
2084
2085         /* Sync command list entry and corresponding command table entry */
2086         bus_dmamap_sync(sc->sc_tag_cmdh,
2087                         AHCI_DMA_MAP(ap->ap_dmamem_cmd_list),
2088                         BUS_DMASYNC_PREWRITE);
2089         bus_dmamap_sync(sc->sc_tag_cmdt,
2090                         AHCI_DMA_MAP(ap->ap_dmamem_cmd_table),
2091                         BUS_DMASYNC_PREWRITE);
2092
2093         /* Prepare RFIS area for write by controller */
2094         bus_dmamap_sync(sc->sc_tag_rfis,
2095                         AHCI_DMA_MAP(ap->ap_dmamem_rfis),
2096                         BUS_DMASYNC_PREREAD);
2097
2098         /*
2099          * There's no point trying to optimize this, it only shaves a few
2100          * nanoseconds so just queue the command and call our generic issue.
2101          */
2102         ahci_issue_pending_commands(ap, ccb);
2103 }
2104
2105 /*
2106  * While holding the port lock acquire exclusive access to the port.
2107  *
2108  * This is used when running the state machine to initialize and identify
2109  * targets over a port multiplier.  Setting exclusive access prevents
2110  * ahci_port_intr() from activating any requests sitting on the pending
2111  * queue.
2112  */
2113 void
2114 ahci_beg_exclusive_access(struct ahci_port *ap, struct ata_port *at)
2115 {
2116         KKASSERT((ap->ap_flags & AP_F_EXCLUSIVE_ACCESS) == 0);
2117         ap->ap_flags |= AP_F_EXCLUSIVE_ACCESS;
2118         while (ap->ap_active || ap->ap_sactive) {
2119                 ahci_port_intr(ap, 1);
2120                 ahci_os_softsleep();
2121         }
2122 }
2123
2124 void
2125 ahci_end_exclusive_access(struct ahci_port *ap, struct ata_port *at)
2126 {
2127         KKASSERT((ap->ap_flags & AP_F_EXCLUSIVE_ACCESS) != 0);
2128         ap->ap_flags &= ~AP_F_EXCLUSIVE_ACCESS;
2129         ahci_issue_pending_commands(ap, NULL);
2130 }
2131
2132 #if 0
2133
2134 static void
2135 fubar(struct ahci_ccb *ccb)
2136 {
2137         struct ahci_port *ap = ccb->ccb_port;
2138         struct ahci_cmd_hdr     *cmd;
2139         struct ahci_cmd_table   *tab;
2140         struct ahci_prdt        *prdt;
2141         int i;
2142
2143         kprintf("%s: ISSUE %02x\n",
2144                 ATANAME(ap, ccb->ccb_xa.at),
2145                 ccb->ccb_xa.fis->command);
2146         cmd = ccb->ccb_cmd_hdr;
2147         tab = ccb->ccb_cmd_table;
2148         prdt = ccb->ccb_cmd_table->prdt;
2149         kprintf("cmd flags=%04x prdtl=%d prdbc=%d ctba=%08x%08x\n",
2150                 cmd->flags, cmd->prdtl, cmd->prdbc,
2151                 cmd->ctba_hi, cmd->ctba_lo);
2152         for (i = 0; i < cmd->prdtl; ++i) {
2153                 kprintf("\t%d dba=%08x%08x res=%08x flags=%08x\n",
2154                         i, prdt->dba_hi, prdt->dba_lo, prdt->reserved,
2155                         prdt->flags);
2156         }
2157         kprintf("tab\n");
2158 }
2159
2160 #endif
2161
2162 /*
2163  * If ccb is not NULL enqueue and/or issue it.
2164  *
2165  * If ccb is NULL issue whatever we can from the queue.  However, nothing
2166  * new is issued if the exclusive access flag is set or expired ccb's are
2167  * present.
2168  *
2169  * If existing commands are still active (ap_active/ap_sactive) we can only
2170  * issue matching new commands.
2171  */
2172 void
2173 ahci_issue_pending_commands(struct ahci_port *ap, struct ahci_ccb *ccb)
2174 {
2175         u_int32_t               mask;
2176         int                     limit;
2177
2178         /*
2179          * Enqueue the ccb.
2180          *
2181          * If just running the queue and in exclusive access mode we
2182          * just return.  Also in this case if there are any expired ccb's
2183          * we want to clear the queue so the port can be safely stopped.
2184          */
2185         if (ccb) {
2186                 TAILQ_INSERT_TAIL(&ap->ap_ccb_pending, ccb, ccb_entry);
2187         } else if ((ap->ap_flags & AP_F_EXCLUSIVE_ACCESS) || ap->ap_expired) {
2188                 return;
2189         }
2190
2191         /*
2192          * Pull the next ccb off the queue and run it if possible.
2193          */
2194         if ((ccb = TAILQ_FIRST(&ap->ap_ccb_pending)) == NULL)
2195                 return;
2196
2197         /*
2198          * Handle exclusivity requirements.
2199          *
2200          * ATA_F_EXCLUSIVE is used when we want to be the only command
2201          * running.
2202          *
2203          * ATA_F_AUTOSENSE is used when we want the D2H rfis loaded
2204          * back into the ccb on a normal (non-errored) command completion.
2205          * For example, for PM requests to target 15.  Because the AHCI
2206          * spec does not stop the command processor and has only one rfis
2207          * area (for non-FBSS anyway), AUTOSENSE currently implies EXCLUSIVE.
2208          * Otherwise multiple completions can destroy the rfis data before
2209          * we have a chance to copy it.
2210          */
2211         if (ap->ap_active & ~ap->ap_expired) {
2212                 /*
2213                  * There may be multiple ccb's already running,
2214                  * if any are running and ap_run_flags sets
2215                  * one of these flags then we know only one is
2216                  * running.
2217                  *
2218                  * XXX Current AUTOSENSE code forces exclusivity
2219                  *     to simplify the code.
2220                  */
2221                 if (ap->ap_run_flags &
2222                     (ATA_F_EXCLUSIVE | ATA_F_AUTOSENSE)) {
2223                         return;
2224                 }
2225
2226                 if (ccb->ccb_xa.flags &
2227                     (ATA_F_EXCLUSIVE | ATA_F_AUTOSENSE)) {
2228                         return;
2229                 }
2230         }
2231
2232         if (ccb->ccb_xa.flags & ATA_F_NCQ) {
2233                 /*
2234                  * The next command is a NCQ command and can be issued as
2235                  * long as currently active commands are not standard.
2236                  */
2237                 if (ap->ap_active) {
2238                         KKASSERT(ap->ap_active_cnt > 0);
2239                         return;
2240                 }
2241                 KKASSERT(ap->ap_active_cnt == 0);
2242
2243                 mask = 0;
2244                 do {
2245                         TAILQ_REMOVE(&ap->ap_ccb_pending, ccb, ccb_entry);
2246                         mask |= 1 << ccb->ccb_slot;
2247                         ccb->ccb_xa.state = ATA_S_ONCHIP;
2248                         ahci_start_timeout(ccb);
2249                         ap->ap_run_flags = ccb->ccb_xa.flags;
2250                         ccb = TAILQ_FIRST(&ap->ap_ccb_pending);
2251                 } while (ccb && (ccb->ccb_xa.flags & ATA_F_NCQ) &&
2252                          (ap->ap_run_flags &
2253                              (ATA_F_EXCLUSIVE | ATA_F_AUTOSENSE)) == 0);
2254
2255                 ap->ap_sactive |= mask;
2256                 ahci_pwrite(ap, AHCI_PREG_SACT, mask);
2257                 ahci_pwrite(ap, AHCI_PREG_CI, mask);
2258         } else {
2259                 /*
2260                  * The next command is a standard command and can be issued
2261                  * as long as currently active commands are not NCQ.
2262                  *
2263                  * We limit ourself to 1 command if we have a port multiplier,
2264                  * (at least without FBSS support), otherwise timeouts on
2265                  * one port can race completions on other ports (see
2266                  * ahci_ata_cmd_timeout() for more information).
2267                  *
2268                  * If not on a port multiplier generally allow up to 4
2269                  * standard commands to be enqueued.  Remember that the
2270                  * command processor will still process them sequentially.
2271                  */
2272                 if (ap->ap_sactive)
2273                         return;
2274                 if (ap->ap_type == ATA_PORT_T_PM)
2275                         limit = 1;
2276                 else if (ap->ap_sc->sc_ncmds > 4)
2277                         limit = 4;
2278                 else
2279                         limit = 2;
2280
2281                 while (ap->ap_active_cnt < limit && ccb &&
2282                        (ccb->ccb_xa.flags & ATA_F_NCQ) == 0) {
2283                         TAILQ_REMOVE(&ap->ap_ccb_pending, ccb, ccb_entry);
2284 #if 0
2285                         fubar(ccb);
2286 #endif
2287                         ap->ap_active |= 1 << ccb->ccb_slot;
2288                         ap->ap_active_cnt++;
2289                         ap->ap_run_flags = ccb->ccb_xa.flags;
2290                         ccb->ccb_xa.state = ATA_S_ONCHIP;
2291                         ahci_pwrite(ap, AHCI_PREG_CI, 1 << ccb->ccb_slot);
2292                         ahci_start_timeout(ccb);
2293                         if ((ap->ap_run_flags &
2294                             (ATA_F_EXCLUSIVE | ATA_F_AUTOSENSE)) == 0) {
2295                                 break;
2296                         }
2297                         ccb = TAILQ_FIRST(&ap->ap_ccb_pending);
2298                         if (ccb && (ccb->ccb_xa.flags &
2299                                     (ATA_F_EXCLUSIVE | ATA_F_AUTOSENSE))) {
2300                                 break;
2301                         }
2302                 }
2303         }
2304 }
2305
2306 void
2307 ahci_intr(void *arg)
2308 {
2309         struct ahci_softc       *sc = arg;
2310         struct ahci_port        *ap;
2311         u_int32_t               is;
2312         u_int32_t               ack;
2313         int                     port;
2314
2315         /*
2316          * Check if the master enable is up, and whether any interrupts are
2317          * pending.
2318          */
2319         if ((sc->sc_flags & AHCI_F_INT_GOOD) == 0)
2320                 return;
2321         is = ahci_read(sc, AHCI_REG_IS);
2322         if (is == 0 || is == 0xffffffff) {
2323                 return;
2324         }
2325         is &= sc->sc_portmask;
2326
2327 #ifdef AHCI_COALESCE
2328         /* Check coalescing interrupt first */
2329         if (is & sc->sc_ccc_mask) {
2330                 DPRINTF(AHCI_D_INTR, "%s: command coalescing interrupt\n",
2331                     DEVNAME(sc));
2332                 is &= ~sc->sc_ccc_mask;
2333                 is |= sc->sc_ccc_ports_cur;
2334         }
2335 #endif
2336
2337         /*
2338          * Process interrupts for each port in a non-blocking fashion.
2339          *
2340          * The global IS bit is forced on if any unmasked port interrupts
2341          * are pending, even if we clear.
2342          */
2343         for (ack = 0; is; is &= ~(1 << port)) {
2344                 port = ffs(is) - 1;
2345                 ack |= 1 << port;
2346
2347                 ap = sc->sc_ports[port];
2348                 if (ap == NULL)
2349                         continue;
2350
2351                 if (ahci_os_lock_port_nb(ap) == 0) {
2352                         ahci_port_intr(ap, 0);
2353                         ahci_os_unlock_port(ap);
2354                 } else {
2355                         ahci_pwrite(ap, AHCI_PREG_IE, 0);
2356                         ahci_os_signal_port_thread(ap, AP_SIGF_PORTINT);
2357                 }
2358         }
2359         ahci_write(sc, AHCI_REG_IS, ack);
2360 }
2361
2362 /*
2363  * Core called from helper thread.
2364  */
2365 void
2366 ahci_port_thread_core(struct ahci_port *ap, int mask)
2367 {
2368         /*
2369          * Process any expired timedouts.
2370          */
2371         ahci_os_lock_port(ap);
2372         if (mask & AP_SIGF_TIMEOUT) {
2373                 ahci_check_active_timeouts(ap);
2374         }
2375
2376         /*
2377          * Process port interrupts which require a higher level of
2378          * intervention.
2379          */
2380         if (mask & AP_SIGF_PORTINT) {
2381                 ahci_port_intr(ap, 1);
2382                 ahci_port_interrupt_enable(ap);
2383                 ahci_os_unlock_port(ap);
2384         } else if (ap->ap_probe != ATA_PROBE_FAILED) {
2385                 ahci_port_intr(ap, 1);
2386                 ahci_port_interrupt_enable(ap);
2387                 ahci_os_unlock_port(ap);
2388         } else {
2389                 ahci_os_unlock_port(ap);
2390         }
2391 }
2392
2393 /*
2394  * Core per-port interrupt handler.
2395  *
2396  * If blockable is 0 we cannot call ahci_os_sleep() at all and we can only
2397  * deal with normal command completions which do not require blocking.
2398  */
2399 void
2400 ahci_port_intr(struct ahci_port *ap, int blockable)
2401 {
2402         struct ahci_softc       *sc = ap->ap_sc;
2403         u_int32_t               is, ci_saved, ci_masked;
2404         int                     slot;
2405         int                     stopped = 0;
2406         struct ahci_ccb         *ccb = NULL;
2407         struct ata_port         *ccb_at = NULL;
2408         volatile u_int32_t      *active;
2409         const u_int32_t         blockable_mask = AHCI_PREG_IS_TFES |
2410                                                  AHCI_PREG_IS_IFS |
2411                                                  AHCI_PREG_IS_PCS |
2412                                                  AHCI_PREG_IS_PRCS |
2413                                                  AHCI_PREG_IS_HBFS |
2414                                                  AHCI_PREG_IS_OFS |
2415                                                  AHCI_PREG_IS_UFS;
2416
2417         enum { NEED_NOTHING, NEED_REINIT, NEED_RESTART,
2418                NEED_HOTPLUG_INSERT, NEED_HOTPLUG_REMOVE } need = NEED_NOTHING;
2419
2420         /*
2421          * All basic command completions are always processed.
2422          */
2423         is = ahci_pread(ap, AHCI_PREG_IS);
2424         if (is & AHCI_PREG_IS_DPS)
2425                 ahci_pwrite(ap, AHCI_PREG_IS, is & AHCI_PREG_IS_DPS);
2426
2427         /*
2428          * If we can't block then we can't handle these here.  Disable
2429          * the interrupts in question so we don't live-lock, the helper
2430          * thread will re-enable them.
2431          *
2432          * If the port is in a completely failed state we do not want
2433          * to drop through to failed-command-processing if blockable is 0,
2434          * just let the thread deal with it all.
2435          *
2436          * Otherwise we fall through and still handle DHRS and any commands
2437          * which completed normally.  Even if we are errored we haven't
2438          * stopped the port yet so CI/SACT are still good.
2439          */
2440         if (blockable == 0) {
2441                 if (ap->ap_state == AP_S_FATAL_ERROR) {
2442                         ahci_pwrite(ap, AHCI_PREG_IE, 0);
2443                         ahci_os_signal_port_thread(ap, AP_SIGF_PORTINT);
2444                         return;
2445                 }
2446                 if (is & blockable_mask) {
2447                         ahci_pwrite(ap, AHCI_PREG_IE, 0);
2448                         ahci_os_signal_port_thread(ap, AP_SIGF_PORTINT);
2449                         return;
2450                 }
2451         }
2452
2453         /*
2454          * Either NCQ or non-NCQ commands will be active, never both.
2455          */
2456         if (ap->ap_sactive) {
2457                 KKASSERT(ap->ap_active == 0);
2458                 KKASSERT(ap->ap_active_cnt == 0);
2459                 ci_saved = ahci_pread(ap, AHCI_PREG_SACT);
2460                 active = &ap->ap_sactive;
2461         } else {
2462                 ci_saved = ahci_pread(ap, AHCI_PREG_CI);
2463                 active = &ap->ap_active;
2464         }
2465         KKASSERT(!(ap->ap_sactive && ap->ap_active));
2466 #if 0
2467         kprintf("CHECK act=%08x/%08x sact=%08x/%08x\n",
2468                 ap->ap_active, ahci_pread(ap, AHCI_PREG_CI),
2469                 ap->ap_sactive, ahci_pread(ap, AHCI_PREG_SACT));
2470 #endif
2471
2472         /*
2473          * Ignore AHCI_PREG_IS_PRCS when link power management is on
2474          */
2475         if (ap->link_pwr_mgmt != AHCI_LINK_PWR_MGMT_NONE) {
2476                 is &= ~AHCI_PREG_IS_PRCS;
2477                 ahci_pwrite(ap, AHCI_PREG_SERR,
2478                     AHCI_PREG_SERR_DIAG_N | AHCI_PREG_SERR_DIAG_W);
2479         }
2480
2481         /*
2482          * Command failed (blockable).
2483          *
2484          * See AHCI 1.1 spec 6.2.2.1 and 6.2.2.2.
2485          *
2486          * This stops command processing.
2487          */
2488         if (is & AHCI_PREG_IS_TFES) {
2489                 u_int32_t tfd, serr;
2490                 int     err_slot;
2491
2492 process_error:
2493                 tfd = ahci_pread(ap, AHCI_PREG_TFD);
2494                 serr = ahci_pread(ap, AHCI_PREG_SERR);
2495
2496                 /*
2497                  * Load the error slot and restart command processing.
2498                  * CLO if we need to.  The error slot may not be valid.
2499                  * MUST BE DONE BEFORE CLEARING ST!
2500                  *
2501                  * Cycle ST.
2502                  *
2503                  * It is unclear but we may have to clear SERR to reenable
2504                  * error processing.
2505                  */
2506                 err_slot = AHCI_PREG_CMD_CCS(ahci_pread(ap, AHCI_PREG_CMD));
2507                 ahci_pwrite(ap, AHCI_PREG_IS, AHCI_PREG_IS_TFES |
2508                                               AHCI_PREG_IS_PSS |
2509                                               AHCI_PREG_IS_DHRS |
2510                                               AHCI_PREG_IS_SDBS);
2511                 is &= ~(AHCI_PREG_IS_TFES | AHCI_PREG_IS_PSS |
2512                         AHCI_PREG_IS_DHRS | AHCI_PREG_IS_SDBS);
2513                 ahci_pwrite(ap, AHCI_PREG_SERR, serr);
2514                 ahci_port_stop(ap, 0);
2515                 ahci_os_hardsleep(10);
2516                 if (tfd & (AHCI_PREG_TFD_STS_BSY | AHCI_PREG_TFD_STS_DRQ)) {
2517                         kprintf("%s: Issuing CLO\n", PORTNAME(ap));
2518                         ahci_port_clo(ap);
2519                 }
2520
2521                 /*
2522                  * We are now stopped and need a restart.  If we have to
2523                  * process a NCQ error we will temporarily start and then
2524                  * stop the port again, so this condition holds.
2525                  */
2526                 stopped = 1;
2527                 need = NEED_RESTART;
2528
2529                 /*
2530                  * ATAPI errors are fairly common from probing, just
2531                  * report disk errors or if bootverbose is on.
2532                  */
2533                 if (bootverbose || ap->ap_type != ATA_PORT_T_ATAPI) {
2534                         kprintf("%s: TFES slot %d ci_saved = %08x\n",
2535                                 PORTNAME(ap), err_slot, ci_saved);
2536                 }
2537
2538                 /*
2539                  * If we got an error on an error CCB just complete it
2540                  * with an error.  ci_saved has the mask to restart
2541                  * (the err_ccb will be removed from it by finish_error).
2542                  */
2543                 if (ap->ap_flags & AP_F_ERR_CCB_RESERVED) {
2544                         err_slot = ap->ap_err_ccb->ccb_slot;
2545                         goto finish_error;
2546                 }
2547
2548                 /*
2549                  * If NCQ commands were active get the error slot from
2550                  * the log page.  NCQ is not supported for PM's so this
2551                  * is a direct-attached target.
2552                  *
2553                  * Otherwise if no commands were active we have a problem.
2554                  *
2555                  * Otherwise if the error slot is bad we have a problem.
2556                  *
2557                  * Otherwise process the error for the slot.
2558                  */
2559                 if (ap->ap_sactive) {
2560                         ahci_port_start(ap);
2561                         err_slot = ahci_port_read_ncq_error(ap, 0);
2562                         ahci_port_stop(ap, 0);
2563                 } else if (ap->ap_active == 0) {
2564                         kprintf("%s: TFES with no commands pending\n",
2565                                 PORTNAME(ap));
2566                         err_slot = -1;
2567                 } else if (err_slot < 0 || err_slot >= ap->ap_sc->sc_ncmds) {
2568                         kprintf("%s: bad error slot %d\n",
2569                                 PORTNAME(ap), err_slot);
2570                         err_slot = -1;
2571                 } else {
2572                         ccb = &ap->ap_ccbs[err_slot];
2573
2574                         /*
2575                          * Validate the errored ccb.  Note that ccb_at can
2576                          * be NULL for direct-attached ccb's.
2577                          *
2578                          * Copy received taskfile data from the RFIS.
2579                          */
2580                         if (ccb->ccb_xa.state == ATA_S_ONCHIP) {
2581                                 ccb_at = ccb->ccb_xa.at;
2582                                 memcpy(&ccb->ccb_xa.rfis, ap->ap_rfis->rfis,
2583                                        sizeof(struct ata_fis_d2h));
2584                                 if (bootverbose) {
2585                                         kprintf("%s: Copying rfis slot %d\n",
2586                                                 ATANAME(ap, ccb_at), err_slot);
2587                                 }
2588                         } else {
2589                                 kprintf("%s: Cannot copy rfis, CCB slot "
2590                                         "%d is not on-chip (state=%d)\n",
2591                                         ATANAME(ap, ccb->ccb_xa.at),
2592                                         err_slot, ccb->ccb_xa.state);
2593                                 err_slot = -1;
2594                         }
2595                 }
2596
2597                 /*
2598                  * If we could not determine the errored slot then
2599                  * reset the port.
2600                  */
2601                 if (err_slot < 0) {
2602                         kprintf("%s: TFES: Unable to determine errored slot\n",
2603                                 PORTNAME(ap));
2604                         if (ap->ap_flags & AP_F_IN_RESET)
2605                                 goto fatal;
2606                         goto failall;
2607                 }
2608
2609                 /*
2610                  * Finish error on slot.  We will restart ci_saved
2611                  * commands except the errored slot which we generate
2612                  * a failure for.
2613                  */
2614 finish_error:
2615                 ccb = &ap->ap_ccbs[err_slot];
2616                 ci_saved &= ~(1 << err_slot);
2617                 KKASSERT(ccb->ccb_xa.state == ATA_S_ONCHIP);
2618                 ccb->ccb_xa.state = ATA_S_ERROR;
2619         } else if (is & AHCI_PREG_IS_DHRS) {
2620                 /*
2621                  * Command posted D2H register FIS to the rfis (non-blocking).
2622                  *
2623                  * A normal completion with an error may set DHRS instead
2624                  * of TFES.  The CCS bits are only valid if ERR was set.
2625                  * If ERR is set command processing was probably stopped.
2626                  *
2627                  * If ERR was not set we can only copy-back data for
2628                  * exclusive-mode commands because otherwise we won't know
2629                  * which tag the rfis belonged to.
2630                  *
2631                  * err_slot must be read from the CCS before any other port
2632                  * action, such as stopping the port.
2633                  *
2634                  * WARNING!     This is not well documented in the AHCI spec.
2635                  *              It can be found in the state machine tables
2636                  *              but not in the explanations.
2637                  */
2638                 u_int32_t tfd;
2639                 u_int32_t cmd;
2640                 int err_slot;
2641
2642                 tfd = ahci_pread(ap, AHCI_PREG_TFD);
2643                 cmd = ahci_pread(ap, AHCI_PREG_CMD);
2644
2645                 if ((tfd & AHCI_PREG_TFD_STS_ERR) &&
2646                     (cmd & AHCI_PREG_CMD_CR) == 0) {
2647                         err_slot = AHCI_PREG_CMD_CCS(
2648                                                 ahci_pread(ap, AHCI_PREG_CMD));
2649                         ccb = &ap->ap_ccbs[err_slot];
2650                         kprintf("%s: DHRS tfd=%b err_slot=%d cmd=%02x\n",
2651                                 PORTNAME(ap),
2652                                 tfd, AHCI_PFMT_TFD_STS,
2653                                 err_slot, ccb->ccb_xa.fis->command);
2654                         goto process_error;
2655                 }
2656                 /*
2657                  * NO ELSE... copy back is in the normal command completion
2658                  * code and only if no error occured and ATA_F_AUTOSENSE
2659                  * was set.
2660                  */
2661                 ahci_pwrite(ap, AHCI_PREG_IS, AHCI_PREG_IS_DHRS);
2662         }
2663
2664         /*
2665          * Device notification to us (non-blocking)
2666          *
2667          * NOTE!  On some parts notification bits can cause an IPMS
2668          *        interrupt instead of a SDBS interrupt.
2669          *
2670          * NOTE!  On some parts (e.g. VBOX, probably intel ICHx),
2671          *        SDBS notifies us of the completion of a NCQ command
2672          *        and DBS does not.
2673          */
2674         if (is & (AHCI_PREG_IS_SDBS | AHCI_PREG_IS_IPMS)) {
2675                 u_int32_t data;
2676
2677                 ahci_pwrite(ap, AHCI_PREG_IS,
2678                                 AHCI_PREG_IS_SDBS | AHCI_PREG_IS_IPMS);
2679                 if (sc->sc_cap & AHCI_REG_CAP_SSNTF) {
2680                         data = ahci_pread(ap, AHCI_PREG_SNTF);
2681                         if (data) {
2682                                 ahci_pwrite(ap, AHCI_PREG_IS,
2683                                                 AHCI_PREG_IS_SDBS);
2684                                 kprintf("%s: NOTIFY %08x\n",
2685                                         PORTNAME(ap), data);
2686                                 ahci_pwrite(ap, AHCI_PREG_SERR,
2687                                                 AHCI_PREG_SERR_DIAG_N);
2688                                 ahci_pwrite(ap, AHCI_PREG_SNTF, data);
2689                                 ahci_cam_changed(ap, NULL, -1);
2690                         }
2691                 }
2692                 is &= ~(AHCI_PREG_IS_SDBS | AHCI_PREG_IS_IPMS);
2693         }
2694
2695         /*
2696          * Spurious IFS errors (blockable) - when AP_F_IGNORE_IFS is set.
2697          *
2698          * Spurious IFS errors can occur while we are doing a reset
2699          * sequence through a PM, probably due to an unexpected FIS
2700          * being received during the PM target reset sequence.  Chipsets
2701          * are supposed to mask these events but some do not.
2702          *
2703          * Try to recover from the condition.
2704          */
2705         if ((is & AHCI_PREG_IS_IFS) && (ap->ap_flags & AP_F_IGNORE_IFS)) {
2706                 u_int32_t serr = ahci_pread(ap, AHCI_PREG_SERR);
2707                 if ((ap->ap_flags & AP_F_IFS_IGNORED) == 0) {
2708                         kprintf("%s: IFS during PM probe (ignored) "
2709                                 "IS=%b, SERR=%b\n",
2710                                 PORTNAME(ap),
2711                                 is, AHCI_PFMT_IS,
2712                                 serr, AHCI_PFMT_SERR);
2713                         ap->ap_flags |= AP_F_IFS_IGNORED;
2714                 }
2715
2716                 /*
2717                  * Try to clear the error condition.  The IFS error killed
2718                  * the port so stop it so we can restart it.
2719                  */
2720                 ahci_pwrite(ap, AHCI_PREG_SERR, -1);
2721                 ahci_pwrite(ap, AHCI_PREG_IS, AHCI_PREG_IS_IFS);
2722                 is &= ~AHCI_PREG_IS_IFS;
2723                 need = NEED_RESTART;
2724                 goto failall;
2725         }
2726
2727         /*
2728          * Port change (hot-plug) (blockable).
2729          *
2730          * A PRCS interrupt can occur:
2731          *      (1) On hot-unplug / normal-unplug (phy lost)
2732          *      (2) Sometimes on hot-plug too.
2733          *
2734          * A PCS interrupt can occur in a number of situations:
2735          *      (1) On hot-plug once communication is established
2736          *      (2) On hot-unplug sometimes.
2737          *      (3) For chipsets with badly written firmware it can occur
2738          *          during INIT/RESET sequences due to the device reset.
2739          *      (4) For chipsets with badly written firmware it can occur
2740          *          when it thinks an unsolicited COMRESET is received
2741          *          during a INIT/RESET sequence, even though we actually
2742          *          did request it.
2743          *
2744          * XXX We can then check the CPS (Cold Presence State) bit, if
2745          * supported, to determine if a device is plugged in or not and do
2746          * the right thing.
2747          *
2748          * PCS interrupts are cleared by clearing DIAG_X.  If this occurs
2749          * command processing is automatically stopped (CR goes inactive)
2750          * and the port must be stopped and restarted.
2751          *
2752          * WARNING: AMD parts (e.g. 880G chipset, probably others) can
2753          *          generate PCS on initialization even when device is
2754          *          already connected up.  It is unclear why this happens.
2755          *          Depending on the state of the device detect this can
2756          *          cause us to go into harsh reinit or hot-plug insertion
2757          *          mode.
2758          *
2759          * WARNING: PCS errors can be repetitive (e.g. unsolicited COMRESET
2760          *          continues to flow in from the device), we must clear the
2761          *          interrupt in all cases and enforce a delay to prevent
2762          *          a livelock and give the port time to settle down.
2763          *          Only print something if we aren't in INIT/HARD-RESET.
2764          */
2765         if (is & (AHCI_PREG_IS_PCS | AHCI_PREG_IS_PRCS)) {
2766                 /*
2767                  * Try to clear the error.  Because of the repetitiveness
2768                  * of this interrupt avoid any harsh action if the port is
2769                  * already in the init or hard-reset probe state.
2770                  */
2771                 ahci_pwrite(ap, AHCI_PREG_SERR, -1);
2772                 /* (AHCI_PREG_SERR_DIAG_N | AHCI_PREG_SERR_DIAG_X) */
2773                 ahci_pwrite(ap, AHCI_PREG_IS,
2774                             is & (AHCI_PREG_IS_PCS | AHCI_PREG_IS_PRCS));
2775
2776                 /*
2777                  * Ignore PCS/PRCS errors during probes (but still clear the
2778                  * interrupt to avoid a livelock).  The AMD 880/890/SB850
2779                  * chipsets do not mask PCS/PRCS internally during reset
2780                  * sequences.
2781                  */
2782                 if (ap->ap_flags & AP_F_IN_RESET)
2783                         goto skip_pcs;
2784
2785                 if (ap->ap_probe == ATA_PROBE_NEED_INIT ||
2786                     ap->ap_probe == ATA_PROBE_NEED_HARD_RESET) {
2787                         is &= ~(AHCI_PREG_IS_PCS | AHCI_PREG_IS_PRCS);
2788                         need = NEED_NOTHING;
2789                         ahci_os_sleep(1000);
2790                         goto failall;
2791                 }
2792                 kprintf("%s: Transient Errors: %b (%d)\n",
2793                         PORTNAME(ap), is, AHCI_PFMT_IS, ap->ap_probe);
2794                 is &= ~(AHCI_PREG_IS_PCS | AHCI_PREG_IS_PRCS);
2795                 ahci_os_sleep(200);
2796
2797                 /*
2798                  * Stop the port and figure out what to do next.
2799                  */
2800                 ahci_port_stop(ap, 0);
2801                 stopped = 1;
2802
2803                 switch (ahci_pread(ap, AHCI_PREG_SSTS) & AHCI_PREG_SSTS_DET) {
2804                 case AHCI_PREG_SSTS_DET_DEV:
2805                         /*
2806                          * Device detect
2807                          */
2808                         if (ap->ap_probe == ATA_PROBE_FAILED) {
2809                                 need = NEED_HOTPLUG_INSERT;
2810                                 goto fatal;
2811                         }
2812                         need = NEED_RESTART;
2813                         break;
2814                 case AHCI_PREG_SSTS_DET_DEV_NE:
2815                         /*
2816                          * Device not communicating.  AMD parts seem to
2817                          * like to throw this error on initialization
2818                          * for no reason that I can fathom.
2819                          */
2820                         kprintf("%s: Device present but not communicating, "
2821                                 "attempting port restart\n",
2822                                 PORTNAME(ap));
2823                         need = NEED_REINIT;
2824                         goto fatal;
2825                 default:
2826                         if (ap->ap_probe != ATA_PROBE_FAILED) {
2827                                 need = NEED_HOTPLUG_REMOVE;
2828                                 goto fatal;
2829                         }
2830                         need = NEED_RESTART;
2831                         break;
2832                 }
2833 skip_pcs:
2834                 ;
2835         }
2836
2837         /*
2838          * Check for remaining errors - they are fatal. (blockable)
2839          */
2840         if (is & (AHCI_PREG_IS_TFES | AHCI_PREG_IS_HBFS | AHCI_PREG_IS_IFS |
2841                   AHCI_PREG_IS_OFS | AHCI_PREG_IS_UFS)) {
2842                 u_int32_t serr;
2843
2844                 ahci_pwrite(ap, AHCI_PREG_IS,
2845                             is & (AHCI_PREG_IS_TFES | AHCI_PREG_IS_HBFS |
2846                                   AHCI_PREG_IS_IFS | AHCI_PREG_IS_OFS |
2847                                   AHCI_PREG_IS_UFS));
2848                 serr = ahci_pread(ap, AHCI_PREG_SERR);
2849                 kprintf("%s: Unrecoverable errors (IS: %b, SERR: %b), "
2850                         "disabling port.\n",
2851                         PORTNAME(ap),
2852                         is, AHCI_PFMT_IS,
2853                         serr, AHCI_PFMT_SERR
2854                 );
2855                 is &= ~(AHCI_PREG_IS_TFES | AHCI_PREG_IS_HBFS |
2856                         AHCI_PREG_IS_IFS | AHCI_PREG_IS_OFS |
2857                         AHCI_PREG_IS_UFS);
2858
2859                 /*
2860                  * Fail all commands but then what?  For now try to
2861                  * reinitialize the port.
2862                  */
2863                 need = NEED_REINIT;
2864                 goto fatal;
2865         }
2866
2867         /*
2868          * Fail all outstanding commands if we know the port won't recover.
2869          *
2870          * We may have a ccb_at if the failed command is known and was
2871          * being sent to a device over a port multiplier (PM).  In this
2872          * case if the port itself has not completely failed we fail just
2873          * the commands related to that target.
2874          *
2875          * ci_saved contains the mask of active commands as of when the
2876          * error occured, prior to any port stops.
2877          */
2878         if (ap->ap_state == AP_S_FATAL_ERROR) {
2879 fatal:
2880                 ap->ap_state = AP_S_FATAL_ERROR;
2881 failall:
2882                 ahci_port_stop(ap, 0);
2883                 stopped = 1;
2884
2885                 /*
2886                  * Error all the active slots not already errored.
2887                  */
2888                 ci_masked = ci_saved & *active & ~ap->ap_expired;
2889                 if (ci_masked) {
2890                         kprintf("%s: Failing all commands: %08x\n",
2891                                 PORTNAME(ap), ci_masked);
2892                 }
2893
2894                 while (ci_masked) {
2895                         slot = ffs(ci_masked) - 1;
2896                         ccb = &ap->ap_ccbs[slot];
2897                         ccb->ccb_xa.state = ATA_S_TIMEOUT;
2898                         ap->ap_expired |= 1 << slot;
2899                         ci_saved &= ~(1 << slot);
2900                         ci_masked &= ~(1 << slot);
2901                 }
2902
2903                 /*
2904                  * Clear bits in ci_saved (cause completions to be run)
2905                  * for all slots which are not active.
2906                  */
2907                 ci_saved &= ~*active;
2908
2909                 /*
2910                  * Don't restart the port if our problems were deemed fatal.
2911                  *
2912                  * Also acknowlege all fatal interrupt sources to prevent
2913                  * a livelock.
2914                  */
2915                 if (ap->ap_state == AP_S_FATAL_ERROR) {
2916                         if (need == NEED_RESTART)
2917                                 need = NEED_NOTHING;
2918                         ahci_pwrite(ap, AHCI_PREG_IS,
2919                                     AHCI_PREG_IS_TFES | AHCI_PREG_IS_HBFS |
2920                                     AHCI_PREG_IS_IFS | AHCI_PREG_IS_OFS |
2921                                     AHCI_PREG_IS_UFS);
2922                 }
2923         }
2924
2925         /*
2926          * If we are stopped the AHCI chipset is supposed to have cleared
2927          * CI and SACT.  Did it?  If it didn't we try very hard to clear
2928          * the fields otherwise we may end up completing CCBs which are
2929          * actually still active.
2930          *
2931          * IFS errors on (at least) AMD chipsets create this confusion.
2932          */
2933         if (stopped) {
2934                 u_int32_t mask;
2935                 if ((mask = ahci_pactive(ap)) != 0) {
2936                         kprintf("%s: chipset failed to clear "
2937                                 "active cmds %08x\n",
2938                                 PORTNAME(ap), mask);
2939                         ahci_port_start(ap);
2940                         ahci_port_stop(ap, 0);
2941                         if ((mask = ahci_pactive(ap)) != 0) {
2942                                 kprintf("%s: unable to prod the chip into "
2943                                         "clearing active cmds %08x\n",
2944                                         PORTNAME(ap), mask);
2945                                 /* what do we do now? */
2946                         }
2947                 }
2948         }
2949
2950         /*
2951          * CCB completion (non blocking).
2952          *
2953          * CCB completion is detected by noticing its slot's bit in CI has
2954          * changed to zero some time after we activated it.
2955          * If we are polling, we may only be interested in particular slot(s).
2956          *
2957          * Any active bits not saved are completed within the restrictions
2958          * imposed by the caller.
2959          */
2960         ci_masked = ~ci_saved & *active;
2961         while (ci_masked) {
2962                 slot = ffs(ci_masked) - 1;
2963                 ccb = &ap->ap_ccbs[slot];
2964                 ci_masked &= ~(1 << slot);
2965
2966                 DPRINTF(AHCI_D_INTR, "%s: slot %d is complete%s\n",
2967                     PORTNAME(ap), slot, ccb->ccb_xa.state == ATA_S_ERROR ?
2968                     " (error)" : "");
2969
2970                 bus_dmamap_sync(sc->sc_tag_cmdh,
2971                                 AHCI_DMA_MAP(ap->ap_dmamem_cmd_list),
2972                                 BUS_DMASYNC_POSTWRITE);
2973
2974                 bus_dmamap_sync(sc->sc_tag_cmdt,
2975                                 AHCI_DMA_MAP(ap->ap_dmamem_cmd_table),
2976                                 BUS_DMASYNC_POSTWRITE);
2977
2978                 bus_dmamap_sync(sc->sc_tag_rfis,
2979                                 AHCI_DMA_MAP(ap->ap_dmamem_rfis),
2980                                 BUS_DMASYNC_POSTREAD);
2981
2982                 *active &= ~(1 << ccb->ccb_slot);
2983                 if (active == &ap->ap_active) {
2984                         KKASSERT(ap->ap_active_cnt > 0);
2985                         --ap->ap_active_cnt;
2986                 }
2987
2988                 /*
2989                  * Complete the ccb.  If the ccb was marked expired it
2990                  * was probably already removed from the command processor,
2991                  * so don't take the clear ci_saved bit as meaning the
2992                  * command actually succeeded, it didn't.
2993                  */
2994                 if (ap->ap_expired & (1 << ccb->ccb_slot)) {
2995                         ap->ap_expired &= ~(1 << ccb->ccb_slot);
2996                         ccb->ccb_xa.state = ATA_S_TIMEOUT;
2997                         ccb->ccb_done(ccb);
2998                         ccb->ccb_xa.complete(&ccb->ccb_xa);
2999                 } else {
3000                         if (ccb->ccb_xa.state == ATA_S_ONCHIP) {
3001                                 ccb->ccb_xa.state = ATA_S_COMPLETE;
3002                                 if (ccb->ccb_xa.flags & ATA_F_AUTOSENSE) {
3003                                         memcpy(&ccb->ccb_xa.rfis,
3004                                             ap->ap_rfis->rfis,
3005                                             sizeof(struct ata_fis_d2h));
3006                                         if (ccb->ccb_xa.state == ATA_S_TIMEOUT)
3007                                                 ccb->ccb_xa.state = ATA_S_ERROR;
3008                                 }
3009                         }
3010                         ccb->ccb_done(ccb);
3011                 }
3012         }
3013
3014         /*
3015          * Cleanup.  Will not be set if non-blocking.
3016          */
3017         switch(need) {
3018         case NEED_NOTHING:
3019                 /*
3020                  * If operating normally and not stopped the interrupt was
3021                  * probably just a normal completion and we may be able to
3022                  * issue more commands.
3023                  */
3024                 if (stopped == 0 && ap->ap_state != AP_S_FATAL_ERROR)
3025                         ahci_issue_pending_commands(ap, NULL);
3026                 break;
3027         case NEED_RESTART:
3028                 /*
3029                  * A recoverable error occured and we can restart outstanding
3030                  * commands on the port.
3031                  */
3032                 ci_saved &= ~ap->ap_expired;
3033                 if (ci_saved) {
3034                         kprintf("%s: Restart %08x\n", PORTNAME(ap), ci_saved);
3035                         ahci_issue_saved_commands(ap, ci_saved);
3036                 }
3037
3038                 /*
3039                  * Potentially issue new commands if not in a failed
3040                  * state.
3041                  */
3042                 if (ap->ap_state != AP_S_FATAL_ERROR) {
3043                         ahci_port_start(ap);
3044                         ahci_issue_pending_commands(ap, NULL);
3045                 }
3046                 break;
3047         case NEED_REINIT:
3048                 /*
3049                  * Something horrible happened to the port and we
3050                  * need to reinitialize it.
3051                  */
3052                 kprintf("%s: REINIT - Attempting to reinitialize the port "
3053                         "after it had a horrible accident\n",
3054                         PORTNAME(ap));
3055                 ap->ap_flags |= AP_F_IN_RESET;
3056                 ap->ap_flags |= AP_F_HARSH_REINIT;
3057                 ap->ap_probe = ATA_PROBE_NEED_INIT;
3058                 ahci_cam_changed(ap, NULL, -1);
3059                 break;
3060         case NEED_HOTPLUG_INSERT:
3061                 /*
3062                  * A hot-plug insertion event has occured and all
3063                  * outstanding commands have already been revoked.
3064                  *
3065                  * Don't recurse if this occurs while we are
3066                  * resetting the port.
3067                  */
3068                 if ((ap->ap_flags & AP_F_IN_RESET) == 0) {
3069                         kprintf("%s: HOTPLUG - Device inserted\n",
3070                                 PORTNAME(ap));
3071                         ap->ap_probe = ATA_PROBE_NEED_INIT;
3072                         ahci_cam_changed(ap, NULL, -1);
3073                 }
3074                 break;
3075         case NEED_HOTPLUG_REMOVE:
3076                 /*
3077                  * A hot-plug removal event has occured and all
3078                  * outstanding commands have already been revoked.
3079                  *
3080                  * Don't recurse if this occurs while we are
3081                  * resetting the port.
3082                  */
3083                 if ((ap->ap_flags & AP_F_IN_RESET) == 0) {
3084                         kprintf("%s: HOTPLUG - Device removed\n",
3085                                 PORTNAME(ap));
3086                         ahci_port_hardstop(ap);
3087                         /* ap_probe set to failed */
3088                         ahci_cam_changed(ap, NULL, -1);
3089                 }
3090                 break;
3091         default:
3092                 break;
3093         }
3094 }
3095
3096 struct ahci_ccb *
3097 ahci_get_ccb(struct ahci_port *ap)
3098 {
3099         struct ahci_ccb                 *ccb;
3100
3101         lockmgr(&ap->ap_ccb_lock, LK_EXCLUSIVE);
3102         ccb = TAILQ_FIRST(&ap->ap_ccb_free);
3103         if (ccb != NULL) {
3104                 KKASSERT(ccb->ccb_xa.state == ATA_S_PUT);
3105                 TAILQ_REMOVE(&ap->ap_ccb_free, ccb, ccb_entry);
3106                 ccb->ccb_xa.state = ATA_S_SETUP;
3107                 ccb->ccb_xa.flags = 0;
3108                 ccb->ccb_xa.at = NULL;
3109         }
3110         lockmgr(&ap->ap_ccb_lock, LK_RELEASE);
3111
3112         return (ccb);
3113 }
3114
3115 void
3116 ahci_put_ccb(struct ahci_ccb *ccb)
3117 {
3118         struct ahci_port                *ap = ccb->ccb_port;
3119
3120         lockmgr(&ap->ap_ccb_lock, LK_EXCLUSIVE);
3121         ccb->ccb_xa.state = ATA_S_PUT;
3122         TAILQ_INSERT_TAIL(&ap->ap_ccb_free, ccb, ccb_entry);
3123         lockmgr(&ap->ap_ccb_lock, LK_RELEASE);
3124 }
3125
3126 struct ahci_ccb *
3127 ahci_get_err_ccb(struct ahci_port *ap)
3128 {
3129         struct ahci_ccb *err_ccb;
3130         u_int32_t sact;
3131         u_int32_t ci;
3132
3133         /* No commands may be active on the chip. */
3134
3135         if (ap->ap_sc->sc_cap & AHCI_REG_CAP_SNCQ) {
3136                 sact = ahci_pread(ap, AHCI_PREG_SACT);
3137                 if (sact != 0) {
3138                         kprintf("%s: ahci_get_err_ccb but SACT %08x != 0?\n",
3139                                 PORTNAME(ap), sact);
3140                 }
3141         }
3142         ci = ahci_pread(ap, AHCI_PREG_CI);
3143         if (ci) {
3144                 kprintf("%s: ahci_get_err_ccb: ci not 0 (%08x)\n",
3145                         ap->ap_name, ci);
3146         }
3147         KKASSERT(ci == 0);
3148         KKASSERT((ap->ap_flags & AP_F_ERR_CCB_RESERVED) == 0);
3149         ap->ap_flags |= AP_F_ERR_CCB_RESERVED;
3150
3151         /* Save outstanding command state. */
3152         ap->ap_err_saved_active = ap->ap_active;
3153         ap->ap_err_saved_active_cnt = ap->ap_active_cnt;
3154         ap->ap_err_saved_sactive = ap->ap_sactive;
3155
3156         /*
3157          * Pretend we have no commands outstanding, so that completions won't
3158          * run prematurely.
3159          */
3160         ap->ap_active = ap->ap_active_cnt = ap->ap_sactive = 0;
3161
3162         /*
3163          * Grab a CCB to use for error recovery.  This should never fail, as
3164          * we ask atascsi to reserve one for us at init time.
3165          */
3166         err_ccb = ap->ap_err_ccb;
3167         KKASSERT(err_ccb != NULL);
3168         err_ccb->ccb_xa.flags = 0;
3169         err_ccb->ccb_done = ahci_empty_done;
3170
3171         return err_ccb;
3172 }
3173
3174 void
3175 ahci_put_err_ccb(struct ahci_ccb *ccb)
3176 {
3177         struct ahci_port *ap = ccb->ccb_port;
3178         u_int32_t sact;
3179         u_int32_t ci;
3180
3181         KKASSERT((ap->ap_flags & AP_F_ERR_CCB_RESERVED) != 0);
3182
3183         /*
3184          * No commands may be active on the chip
3185          */
3186         if (ap->ap_sc->sc_cap & AHCI_REG_CAP_SNCQ) {
3187                 sact = ahci_pread(ap, AHCI_PREG_SACT);
3188                 if (sact) {
3189                         panic("ahci_port_err_ccb(%d) but SACT %08x != 0\n",
3190                               ccb->ccb_slot, sact);
3191                 }
3192         }
3193         ci = ahci_pread(ap, AHCI_PREG_CI);
3194         if (ci) {
3195                 panic("ahci_put_err_ccb(%d) but CI %08x != 0 "
3196                       "(act=%08x sact=%08x)\n",
3197                       ccb->ccb_slot, ci,
3198                       ap->ap_active, ap->ap_sactive);
3199         }
3200
3201         KKASSERT(ccb == ap->ap_err_ccb);
3202
3203         /* Restore outstanding command state */
3204         ap->ap_sactive = ap->ap_err_saved_sactive;
3205         ap->ap_active_cnt = ap->ap_err_saved_active_cnt;
3206         ap->ap_active = ap->ap_err_saved_active;
3207
3208         ap->ap_flags &= ~AP_F_ERR_CCB_RESERVED;
3209 }
3210
3211 /*
3212  * Read log page to get NCQ error.
3213  *
3214  * NOTE: NCQ not currently supported on port multipliers. XXX
3215  */
3216 int
3217 ahci_port_read_ncq_error(struct ahci_port *ap, int target)
3218 {
3219         struct ata_log_page_10h *log;
3220         struct ahci_ccb         *ccb;
3221         struct ahci_ccb         *ccb2;
3222         struct ahci_cmd_hdr     *cmd_slot;
3223         struct ata_fis_h2d      *fis;
3224         int                     err_slot;
3225
3226         if (bootverbose) {
3227                 kprintf("%s: READ LOG PAGE target %d\n", PORTNAME(ap),
3228                         target);
3229         }
3230
3231         /*
3232          * Prep error CCB for READ LOG EXT, page 10h, 1 sector.
3233          *
3234          * Getting err_ccb clears active/sactive/active_cnt, putting
3235          * it back restores the fields.
3236          */
3237         ccb = ahci_get_err_ccb(ap);
3238         ccb->ccb_xa.flags = ATA_F_READ | ATA_F_POLL;
3239         ccb->ccb_xa.data = ap->ap_err_scratch;
3240         ccb->ccb_xa.datalen = 512;
3241         ccb->ccb_xa.complete = ahci_dummy_done;
3242         ccb->ccb_xa.at = ap->ap_ata[target];
3243
3244         fis = (struct ata_fis_h2d *)ccb->ccb_cmd_table->cfis;
3245         bzero(fis, sizeof(*fis));
3246         fis->type = ATA_FIS_TYPE_H2D;
3247         fis->flags = ATA_H2D_FLAGS_CMD | target;
3248         fis->command = ATA_C_READ_LOG_EXT;
3249         fis->lba_low = 0x10;            /* queued error log page (10h) */
3250         fis->sector_count = 1;          /* number of sectors (1) */
3251         fis->sector_count_exp = 0;
3252         fis->lba_mid = 0;               /* starting offset */
3253         fis->lba_mid_exp = 0;
3254         fis->device = 0;
3255
3256         cmd_slot = ccb->ccb_cmd_hdr;
3257         cmd_slot->flags = htole16(5);   /* FIS length: 5 DWORDS */
3258
3259         if (ahci_load_prdt(ccb) != 0) {
3260                 err_slot = -1;
3261                 goto err;
3262         }
3263
3264         ccb->ccb_xa.state = ATA_S_PENDING;
3265         if (ahci_poll(ccb, 1000, ahci_quick_timeout) != ATA_S_COMPLETE) {
3266                 err_slot = -1;
3267                 ahci_unload_prdt(ccb);
3268                 goto err;
3269         }
3270         ahci_unload_prdt(ccb);
3271
3272         /*
3273          * Success, extract failed register set and tags from the scratch
3274          * space.
3275          */
3276         log = (struct ata_log_page_10h *)ap->ap_err_scratch;
3277         if (log->err_regs.type & ATA_LOG_10H_TYPE_NOTQUEUED) {
3278                 /* Not queued bit was set - wasn't an NCQ error? */
3279                 kprintf("%s: read NCQ error page, but not an NCQ error?\n",
3280                         PORTNAME(ap));
3281                 err_slot = -1;
3282         } else {
3283                 /* Copy back the log record as a D2H register FIS. */
3284                 err_slot = log->err_regs.type & ATA_LOG_10H_TYPE_TAG_MASK;
3285
3286                 ccb2 = &ap->ap_ccbs[err_slot];
3287                 if (ccb2->ccb_xa.state == ATA_S_ONCHIP) {
3288                         kprintf("%s: read NCQ error page slot=%d\n",
3289                                 ATANAME(ap, ccb2->ccb_xa.at),
3290                                 err_slot);
3291                         memcpy(&ccb2->ccb_xa.rfis, &log->err_regs,
3292                                 sizeof(struct ata_fis_d2h));
3293                         ccb2->ccb_xa.rfis.type = ATA_FIS_TYPE_D2H;
3294                         ccb2->ccb_xa.rfis.flags = 0;
3295                 } else {
3296                         kprintf("%s: read NCQ error page slot=%d, "
3297                                 "slot does not match any cmds\n",
3298                                 ATANAME(ccb2->ccb_port, ccb2->ccb_xa.at),
3299                                 err_slot);
3300                         err_slot = -1;
3301                 }
3302         }
3303 err:
3304         ahci_put_err_ccb(ccb);
3305         kprintf("%s: DONE log page target %d err_slot=%d\n",
3306                 PORTNAME(ap), target, err_slot);
3307         return (err_slot);
3308 }
3309
3310 /*
3311  * Allocate memory for various structures DMAd by hardware.  The maximum
3312  * number of segments for these tags is 1 so the DMA memory will have a
3313  * single physical base address.
3314  */
3315 struct ahci_dmamem *
3316 ahci_dmamem_alloc(struct ahci_softc *sc, bus_dma_tag_t tag)
3317 {
3318         struct ahci_dmamem *adm;
3319         int     error;
3320
3321         adm = kmalloc(sizeof(*adm), M_DEVBUF, M_INTWAIT | M_ZERO);
3322
3323         error = bus_dmamem_alloc(tag, (void **)&adm->adm_kva,
3324                                  BUS_DMA_ZERO, &adm->adm_map);
3325         if (error == 0) {
3326                 adm->adm_tag = tag;
3327                 error = bus_dmamap_load(tag, adm->adm_map,
3328                                         adm->adm_kva,
3329                                         bus_dma_tag_getmaxsize(tag),
3330                                         ahci_dmamem_saveseg, &adm->adm_busaddr,
3331                                         0);
3332         }
3333         if (error) {
3334                 if (adm->adm_map) {
3335                         bus_dmamap_destroy(tag, adm->adm_map);
3336                         adm->adm_map = NULL;
3337                         adm->adm_tag = NULL;
3338                         adm->adm_kva = NULL;
3339                 }
3340                 kfree(adm, M_DEVBUF);
3341                 adm = NULL;
3342         }
3343         return (adm);
3344 }
3345
3346 static
3347 void
3348 ahci_dmamem_saveseg(void *info, bus_dma_segment_t *segs, int nsegs, int error)
3349 {
3350         KKASSERT(error == 0);
3351         KKASSERT(nsegs == 1);
3352         *(bus_addr_t *)info = segs->ds_addr;
3353 }
3354
3355
3356 void
3357 ahci_dmamem_free(struct ahci_softc *sc, struct ahci_dmamem *adm)
3358 {
3359         if (adm->adm_map) {
3360                 bus_dmamap_unload(adm->adm_tag, adm->adm_map);
3361                 bus_dmamap_destroy(adm->adm_tag, adm->adm_map);
3362                 adm->adm_map = NULL;
3363                 adm->adm_tag = NULL;
3364                 adm->adm_kva = NULL;
3365         }
3366         kfree(adm, M_DEVBUF);
3367 }
3368
3369 u_int32_t
3370 ahci_read(struct ahci_softc *sc, bus_size_t r)
3371 {
3372         bus_space_barrier(sc->sc_iot, sc->sc_ioh, r, 4,
3373                           BUS_SPACE_BARRIER_READ);
3374         return (bus_space_read_4(sc->sc_iot, sc->sc_ioh, r));
3375 }
3376
3377 void
3378 ahci_write(struct ahci_softc *sc, bus_size_t r, u_int32_t v)
3379 {
3380         bus_space_write_4(sc->sc_iot, sc->sc_ioh, r, v);
3381         bus_space_barrier(sc->sc_iot, sc->sc_ioh, r, 4,
3382                           BUS_SPACE_BARRIER_WRITE);
3383 }
3384
3385 u_int32_t
3386 ahci_pread(struct ahci_port *ap, bus_size_t r)
3387 {
3388         bus_space_barrier(ap->ap_sc->sc_iot, ap->ap_ioh, r, 4,
3389                           BUS_SPACE_BARRIER_READ);
3390         return (bus_space_read_4(ap->ap_sc->sc_iot, ap->ap_ioh, r));
3391 }
3392
3393 void
3394 ahci_pwrite(struct ahci_port *ap, bus_size_t r, u_int32_t v)
3395 {
3396         bus_space_write_4(ap->ap_sc->sc_iot, ap->ap_ioh, r, v);
3397         bus_space_barrier(ap->ap_sc->sc_iot, ap->ap_ioh, r, 4,
3398                           BUS_SPACE_BARRIER_WRITE);
3399 }
3400
3401 /*
3402  * Wait up to (timeout) milliseconds for the masked port register to
3403  * match the target.
3404  *
3405  * Timeout is in milliseconds.
3406  */
3407 int
3408 ahci_pwait_eq(struct ahci_port *ap, int timeout,
3409               bus_size_t r, u_int32_t mask, u_int32_t target)
3410 {
3411         int     t;
3412
3413         /*
3414          * Loop hard up to 100uS
3415          */
3416         for (t = 0; t < 100; ++t) {
3417                 if ((ahci_pread(ap, r) & mask) == target)
3418                         return (0);
3419                 ahci_os_hardsleep(1);   /* us */
3420         }
3421
3422         do {
3423                 timeout -= ahci_os_softsleep();
3424                 if ((ahci_pread(ap, r) & mask) == target)
3425                         return (0);
3426         } while (timeout > 0);
3427         return (1);
3428 }
3429
3430 int
3431 ahci_wait_ne(struct ahci_softc *sc, bus_size_t r, u_int32_t mask,
3432              u_int32_t target)
3433 {
3434         int     t;
3435
3436         /*
3437          * Loop hard up to 100uS
3438          */
3439         for (t = 0; t < 100; ++t) {
3440                 if ((ahci_read(sc, r) & mask) != target)
3441                         return (0);
3442                 ahci_os_hardsleep(1);   /* us */
3443         }
3444
3445         /*
3446          * And one millisecond the slow way
3447          */
3448         t = 1000;
3449         do {
3450                 t -= ahci_os_softsleep();
3451                 if ((ahci_read(sc, r) & mask) != target)
3452                         return (0);
3453         } while (t > 0);
3454
3455         return (1);
3456 }
3457
3458
3459 /*
3460  * Acquire an ata transfer.
3461  *
3462  * Pass a NULL at for direct-attached transfers, and a non-NULL at for
3463  * targets that go through the port multiplier.
3464  */
3465 struct ata_xfer *
3466 ahci_ata_get_xfer(struct ahci_port *ap, struct ata_port *at)
3467 {
3468         struct ahci_ccb         *ccb;
3469
3470         ccb = ahci_get_ccb(ap);
3471         if (ccb == NULL) {
3472                 DPRINTF(AHCI_D_XFER, "%s: ahci_ata_get_xfer: NULL ccb\n",
3473                     PORTNAME(ap));
3474                 return (NULL);
3475         }
3476
3477         DPRINTF(AHCI_D_XFER, "%s: ahci_ata_get_xfer got slot %d\n",
3478             PORTNAME(ap), ccb->ccb_slot);
3479
3480         bzero(ccb->ccb_xa.fis, sizeof(*ccb->ccb_xa.fis));
3481         ccb->ccb_xa.at = at;
3482         ccb->ccb_xa.fis->type = ATA_FIS_TYPE_H2D;
3483
3484         return (&ccb->ccb_xa);
3485 }
3486
3487 void
3488 ahci_ata_put_xfer(struct ata_xfer *xa)
3489 {
3490         struct ahci_ccb                 *ccb = (struct ahci_ccb *)xa;
3491
3492         DPRINTF(AHCI_D_XFER, "ahci_ata_put_xfer slot %d\n", ccb->ccb_slot);
3493
3494         ahci_put_ccb(ccb);
3495 }
3496
3497 int
3498 ahci_ata_cmd(struct ata_xfer *xa)
3499 {
3500         struct ahci_ccb                 *ccb = (struct ahci_ccb *)xa;
3501         struct ahci_cmd_hdr             *cmd_slot;
3502
3503         KKASSERT(xa->state == ATA_S_SETUP);
3504
3505         if (ccb->ccb_port->ap_state == AP_S_FATAL_ERROR)
3506                 goto failcmd;
3507         ccb->ccb_done = ahci_ata_cmd_done;
3508
3509         cmd_slot = ccb->ccb_cmd_hdr;
3510         cmd_slot->flags = htole16(5); /* FIS length (in DWORDs) */
3511         if (ccb->ccb_xa.at) {
3512                 cmd_slot->flags |= htole16(ccb->ccb_xa.at->at_target <<
3513                                            AHCI_CMD_LIST_FLAG_PMP_SHIFT);
3514         }
3515
3516         if (xa->flags & ATA_F_WRITE)
3517                 cmd_slot->flags |= htole16(AHCI_CMD_LIST_FLAG_W);
3518
3519         if (xa->flags & ATA_F_PACKET)
3520                 cmd_slot->flags |= htole16(AHCI_CMD_LIST_FLAG_A);
3521
3522         if (ahci_load_prdt(ccb) != 0)
3523                 goto failcmd;
3524
3525         xa->state = ATA_S_PENDING;
3526
3527         if (xa->flags & ATA_F_POLL)
3528                 return (ahci_poll(ccb, xa->timeout, ahci_ata_cmd_timeout));
3529
3530         crit_enter();
3531         KKASSERT((xa->flags & ATA_F_TIMEOUT_EXPIRED) == 0);
3532         xa->flags |= ATA_F_TIMEOUT_DESIRED;
3533         ahci_start(ccb);
3534         crit_exit();
3535         return (xa->state);
3536
3537 failcmd:
3538         crit_enter();
3539         xa->state = ATA_S_ERROR;
3540         xa->complete(xa);
3541         crit_exit();
3542         return (ATA_S_ERROR);
3543 }
3544
3545 void
3546 ahci_ata_cmd_done(struct ahci_ccb *ccb)
3547 {
3548         struct ata_xfer                 *xa = &ccb->ccb_xa;
3549
3550         /*
3551          * NOTE: callout does not lock port and may race us modifying
3552          * the flags, so make sure its stopped.
3553          */
3554         if (xa->flags & ATA_F_TIMEOUT_RUNNING) {
3555                 callout_stop(&ccb->ccb_timeout);
3556                 xa->flags &= ~ATA_F_TIMEOUT_RUNNING;
3557         }
3558         xa->flags &= ~(ATA_F_TIMEOUT_DESIRED | ATA_F_TIMEOUT_EXPIRED);
3559
3560         KKASSERT(xa->state != ATA_S_ONCHIP);
3561         ahci_unload_prdt(ccb);
3562
3563         if (xa->state != ATA_S_TIMEOUT)
3564                 xa->complete(xa);
3565 }
3566
3567 /*
3568  * Timeout from callout, MPSAFE - nothing can mess with the CCB's flags
3569  * while the callout is runing.
3570  *
3571  * We can't safely get the port lock here or delay, we could block
3572  * the callout thread.
3573  */
3574 static void
3575 ahci_ata_cmd_timeout_unserialized(void *arg)
3576 {
3577         struct ahci_ccb         *ccb = arg;
3578         struct ahci_port        *ap = ccb->ccb_port;
3579
3580         ccb->ccb_xa.flags &= ~ATA_F_TIMEOUT_RUNNING;
3581         ccb->ccb_xa.flags |= ATA_F_TIMEOUT_EXPIRED;
3582         ahci_os_signal_port_thread(ap, AP_SIGF_TIMEOUT);
3583 }
3584
3585 /*
3586  * Timeout code, typically called when the port command processor is running.
3587  *
3588  * We have to be very very careful here.  We cannot stop the port unless
3589  * CR is already clear or the only active commands remaining are timed-out
3590  * ones.  Otherwise stopping the port will race the command processor and
3591  * we can lose events.  While we can theoretically just restart everything
3592  * that could result in a double-issue which will not work for ATAPI commands.
3593  */
3594 void
3595 ahci_ata_cmd_timeout(struct ahci_ccb *ccb)
3596 {
3597         struct ata_xfer         *xa = &ccb->ccb_xa;
3598         struct ahci_port        *ap = ccb->ccb_port;
3599         struct ata_port         *at;
3600         u_int32_t               ci_saved;
3601         u_int32_t               mask;
3602         int                     slot;
3603
3604         at = ccb->ccb_xa.at;
3605
3606         kprintf("%s: CMD TIMEOUT state=%d slot=%d\n"
3607                 "\tcmd-reg 0x%b\n"
3608                 "\tsactive=%08x active=%08x expired=%08x\n"
3609                 "\t   sact=%08x     ci=%08x\n"
3610                 "\t    STS=%b\n",
3611                 ATANAME(ap, at),
3612                 ccb->ccb_xa.state, ccb->ccb_slot,
3613                 ahci_pread(ap, AHCI_PREG_CMD), AHCI_PFMT_CMD,
3614                 ap->ap_sactive, ap->ap_active, ap->ap_expired,
3615                 ahci_pread(ap, AHCI_PREG_SACT),
3616                 ahci_pread(ap, AHCI_PREG_CI),
3617                 ahci_pread(ap, AHCI_PREG_TFD), AHCI_PFMT_TFD_STS
3618         );
3619
3620
3621         /*
3622          * NOTE: Timeout will not be running if the command was polled.
3623          *       If we got here at least one of these flags should be set.
3624          */
3625         KKASSERT(xa->flags & (ATA_F_POLL | ATA_F_TIMEOUT_DESIRED |
3626                               ATA_F_TIMEOUT_RUNNING));
3627         xa->flags &= ~(ATA_F_TIMEOUT_RUNNING | ATA_F_TIMEOUT_EXPIRED);
3628
3629         if (ccb->ccb_xa.state == ATA_S_PENDING) {
3630                 TAILQ_REMOVE(&ap->ap_ccb_pending, ccb, ccb_entry);
3631                 ccb->ccb_xa.state = ATA_S_TIMEOUT;
3632                 ccb->ccb_done(ccb);
3633                 xa->complete(xa);
3634                 ahci_issue_pending_commands(ap, NULL);
3635                 return;
3636         }
3637         if (ccb->ccb_xa.state != ATA_S_ONCHIP) {
3638                 kprintf("%s: Unexpected state during timeout: %d\n",
3639                         ATANAME(ap, at), ccb->ccb_xa.state);
3640                 return;
3641         }
3642
3643         /*
3644          * Ok, we can only get this command off the chip if CR is inactive
3645          * or if the only commands running on the chip are all expired.
3646          * Otherwise we have to wait until the port is in a safe state.
3647          *
3648          * Do not set state here, it will cause polls to return when the
3649          * ccb is not yet off the chip.
3650          */
3651         ap->ap_expired |= 1 << ccb->ccb_slot;
3652
3653         if ((ahci_pread(ap, AHCI_PREG_CMD) & AHCI_PREG_CMD_CR) &&
3654             (ap->ap_active | ap->ap_sactive) != ap->ap_expired) {
3655                 /*
3656                  * If using FBSS or NCQ we can't safely stop the port
3657                  * right now.
3658                  */
3659                 kprintf("%s: Deferred timeout until its safe, slot %d\n",
3660                         ATANAME(ap, at), ccb->ccb_slot);
3661                 return;
3662         }
3663
3664         /*
3665          * We can safely stop the port and process all expired ccb's,
3666          * which will include our current ccb.
3667          */
3668         ci_saved = (ap->ap_sactive) ? ahci_pread(ap, AHCI_PREG_SACT) :
3669                                       ahci_pread(ap, AHCI_PREG_CI);
3670         ahci_port_stop(ap, 0);
3671
3672         while (ap->ap_expired) {
3673                 slot = ffs(ap->ap_expired) - 1;
3674                 ap->ap_expired &= ~(1 << slot);
3675                 ci_saved &= ~(1 << slot);
3676                 ccb = &ap->ap_ccbs[slot];
3677                 ccb->ccb_xa.state = ATA_S_TIMEOUT;
3678                 if (ccb->ccb_xa.flags & ATA_F_NCQ) {
3679                         KKASSERT(ap->ap_sactive & (1 << slot));
3680                         ap->ap_sactive &= ~(1 << slot);
3681                 } else {
3682                         KKASSERT(ap->ap_active & (1 << slot));
3683                         ap->ap_active &= ~(1 << slot);
3684                         --ap->ap_active_cnt;
3685                 }
3686                 ccb->ccb_done(ccb);
3687                 ccb->ccb_xa.complete(&ccb->ccb_xa);
3688         }
3689         /* ccb invalid now */
3690
3691         /*
3692          * We can safely CLO the port to clear any BSY/DRQ, a case which
3693          * can occur with port multipliers.  This will unbrick the port
3694          * and allow commands to other targets behind the PM continue.
3695          * (FBSS).
3696          *
3697          * Finally, once the port has been restarted we can issue any
3698          * previously saved pending commands, and run the port interrupt
3699          * code to handle any completions which may have occured when
3700          * we saved CI.
3701          */
3702         if (ahci_pread(ap, AHCI_PREG_TFD) &
3703                    (AHCI_PREG_TFD_STS_BSY | AHCI_PREG_TFD_STS_DRQ)) {
3704                 kprintf("%s: Warning, issuing CLO after timeout\n",
3705                         ATANAME(ap, at));
3706                 ahci_port_clo(ap);
3707         }
3708         ahci_port_start(ap);
3709
3710         /*
3711          * We absolutely must make sure the chipset cleared activity on
3712          * all slots.  This sometimes might not happen due to races with
3713          * a chipset interrupt which stops the port before we can manage
3714          * to.  For some reason some chipsets don't clear the active
3715          * commands when we turn off CMD_ST after the chip has stopped
3716          * operations itself.
3717          */
3718         if (ahci_pactive(ap) != 0) {
3719                 ahci_port_stop(ap, 0);
3720                 ahci_port_start(ap);
3721                 if ((mask = ahci_pactive(ap)) != 0) {
3722                         kprintf("%s: quick-timeout: chipset failed "
3723                                 "to clear active cmds %08x\n",
3724                                 PORTNAME(ap), mask);
3725                 }
3726         }
3727         ahci_issue_saved_commands(ap, ci_saved & ~ap->ap_expired);
3728         ahci_issue_pending_commands(ap, NULL);
3729         ahci_port_intr(ap, 0);
3730 }
3731
3732 /*
3733  * Issue a previously saved set of commands
3734  */
3735 void
3736 ahci_issue_saved_commands(struct ahci_port *ap, u_int32_t ci_saved)
3737 {
3738         if (ci_saved) {
3739                 KKASSERT(!((ap->ap_active & ci_saved) &&
3740                            (ap->ap_sactive & ci_saved)));
3741                 KKASSERT((ci_saved & ap->ap_expired) == 0);
3742                 if (ap->ap_sactive & ci_saved)
3743                         ahci_pwrite(ap, AHCI_PREG_SACT, ci_saved);
3744                 ahci_pwrite(ap, AHCI_PREG_CI, ci_saved);
3745         }
3746 }
3747
3748 /*
3749  * Used by the softreset, pmprobe, and read_ncq_error only, in very
3750  * specialized, controlled circumstances.
3751  *
3752  * Only one command may be pending.
3753  */
3754 void
3755 ahci_quick_timeout(struct ahci_ccb *ccb)
3756 {
3757         struct ahci_port *ap = ccb->ccb_port;
3758         u_int32_t mask;
3759
3760         switch (ccb->ccb_xa.state) {
3761         case ATA_S_PENDING:
3762                 TAILQ_REMOVE(&ap->ap_ccb_pending, ccb, ccb_entry);
3763                 ccb->ccb_xa.state = ATA_S_TIMEOUT;
3764                 break;
3765         case ATA_S_ONCHIP:
3766                 /*
3767                  * We have to clear the command on-chip.
3768                  */
3769                 KKASSERT(ap->ap_active == (1 << ccb->ccb_slot) &&
3770                          ap->ap_sactive == 0);
3771                 ahci_port_stop(ap, 0);
3