17975306ac70ec61875c055a9fa7d8f1c18d248c
[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(&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
1362         /*
1363          * Idle the port,
1364          */
1365         *pmdetectp = 0;
1366         ahci_port_stop(ap, 0);
1367         ap->ap_state = AP_S_NORMAL;
1368         ahci_os_sleep(10);
1369
1370         /*
1371          * The port may have been quiescent with its SUD bit cleared, so
1372          * set the SUD (spin up device).
1373          *
1374          * NOTE: I do not know if SUD is a hardware pin/low-level signal
1375          *       or if it is messaged.
1376          */
1377         cmd = ahci_pread(ap, AHCI_PREG_CMD) & ~AHCI_PREG_CMD_ICC;
1378
1379         cmd |= AHCI_PREG_CMD_SUD | AHCI_PREG_CMD_POD;
1380         ahci_pwrite(ap, AHCI_PREG_CMD, cmd);
1381         ahci_os_sleep(10);
1382
1383         /*
1384          * Make sure that all power management is disabled.
1385          *
1386          * NOTE!  AHCI_PREG_SCTL_DET_DISABLE seems to be highly unreliable
1387          *        on multiple chipsets and can brick the chipset or even
1388          *        the whole PC.  Never use it.
1389          */
1390         ap->ap_type = ATA_PORT_T_NONE;
1391
1392         r = AHCI_PREG_SCTL_IPM_DISABLED |
1393             AHCI_PREG_SCTL_SPM_DISABLED;
1394         ahci_pwrite(ap, AHCI_PREG_SCTL, r);
1395         ahci_os_sleep(10);
1396
1397         /*
1398          * Start transmitting COMRESET.  The spec says that COMRESET must
1399          * be sent for at least 1ms but in actual fact numerous devices
1400          * appear to take much longer.  Delay a whole second here.
1401          *
1402          * In addition, SATA-3 ports can take longer to train, so even
1403          * SATA-2 devices which would normally detect very quickly may
1404          * take longer when plugged into a SATA-3 port.
1405          */
1406         r |= AHCI_PREG_SCTL_DET_INIT;
1407         if (AhciForceGen1 & (1 << ap->ap_num))
1408                 r |= AHCI_PREG_SCTL_SPD_GEN1;
1409         else
1410                 r |= AHCI_PREG_SCTL_SPD_ANY;
1411         ahci_pwrite(ap, AHCI_PREG_SCTL, r);
1412         ahci_os_sleep(1000);
1413         r &= ~AHCI_PREG_SCTL_SPD;
1414
1415         ap->ap_flags &= ~AP_F_HARSH_REINIT;
1416
1417         /*
1418          * Only SERR_DIAG_X needs to be cleared for TFD updates, but
1419          * since we are hard-resetting the port we might as well clear
1420          * the whole enchillada.
1421          *
1422          * Wait 1 whole second after clearing INIT before checking
1423          * the device detection bits in an attempt to work around chipsets
1424          * which do not properly mask PCS/PRCS during low level init.
1425          */
1426         ahci_flush_tfd(ap);
1427         ahci_pwrite(ap, AHCI_PREG_SERR, -1);
1428         ahci_os_sleep(10);
1429
1430         r &= ~AHCI_PREG_SCTL_DET_INIT;
1431         r |= AHCI_PREG_SCTL_DET_NONE;
1432         ahci_pwrite(ap, AHCI_PREG_SCTL, r);
1433         ahci_os_sleep(1000);
1434
1435         /*
1436          * Try to determine if there is a device on the port.
1437          *
1438          * Give the device 3/10 second to at least be detected.
1439          * If we fail clear PRCS (phy detect) since we may cycled
1440          * the phy and probably caused another PRCS interrupt.
1441          */
1442         loop = 300;
1443         while (loop > 0) {
1444                 r = ahci_pread(ap, AHCI_PREG_SSTS);
1445                 if (r & AHCI_PREG_SSTS_DET)
1446                         break;
1447                 loop -= ahci_os_softsleep();
1448         }
1449         if (loop == 0) {
1450                 ahci_pwrite(ap, AHCI_PREG_IS, AHCI_PREG_IS_PRCS);
1451                 if (bootverbose) {
1452                         kprintf("%s: Port appears to be unplugged\n",
1453                                 PORTNAME(ap));
1454                 }
1455                 error = ENODEV;
1456                 goto done;
1457         }
1458
1459         /*
1460          * There is something on the port.  Regardless of what happens
1461          * after this tell the caller to try to detect a port multiplier.
1462          *
1463          * Give the device 3 seconds to fully negotiate.
1464          */
1465         *pmdetectp = 1;
1466
1467         if (ahci_pwait_eq(ap, 3000, AHCI_PREG_SSTS,
1468                           AHCI_PREG_SSTS_DET, AHCI_PREG_SSTS_DET_DEV)) {
1469                 if (bootverbose) {
1470                         kprintf("%s: Device may be powered down\n",
1471                                 PORTNAME(ap));
1472                 }
1473                 error = ENODEV;
1474                 goto done;
1475         }
1476
1477         /*
1478          * We got something that definitely looks like a device.  Give
1479          * the device time to send us its first D2H FIS.  Waiting for
1480          * BSY to clear accomplishes this.
1481          *
1482          * NOTE: A port multiplier may or may not clear BSY here,
1483          *       depending on what is sitting in target 0 behind it.
1484          */
1485         ahci_flush_tfd(ap);
1486         if (ahci_pwait_clr_to(ap, 3000, AHCI_PREG_TFD,
1487                             AHCI_PREG_TFD_STS_BSY | AHCI_PREG_TFD_STS_DRQ)) {
1488                 error = EBUSY;
1489         } else {
1490                 error = 0;
1491         }
1492
1493 done:
1494         ahci_flush_tfd(ap);
1495         return error;
1496 }
1497
1498
1499 /*
1500  * AHCI port reset, Section 10.4.2
1501  *
1502  * This function does a hard reset of the port.  Note that the device
1503  * connected to the port could still end-up hung.
1504  */
1505 int
1506 ahci_port_hardreset(struct ahci_port *ap, int hard)
1507 {
1508         u_int32_t data;
1509         int     error;
1510         int     pmdetect;
1511
1512         if (bootverbose)
1513                 kprintf("%s: START HARDRESET\n", PORTNAME(ap));
1514         ap->ap_flags |= AP_F_IN_RESET;
1515
1516         error = ahci_comreset(ap, &pmdetect);
1517
1518         /*
1519          * We may be asked to perform a port multiplier check even if the
1520          * comreset failed.  This typically occurs when the PM has nothing
1521          * in slot 0, which can cause BSY to remain set.
1522          *
1523          * If the PM detection is successful it will override (error),
1524          * otherwise (error) is retained.  If an error does occur it
1525          * is possible that a normal device has blown up on us DUE to
1526          * the PM detection code, so re-run the comreset and assume
1527          * a normal device.
1528          */
1529         if (pmdetect) {
1530                 if (ap->ap_sc->sc_cap & AHCI_REG_CAP_SPM) {
1531                         error = ahci_pm_port_probe(ap, error);
1532                         if (error) {
1533                                 error = ahci_comreset(ap, &pmdetect);
1534                         }
1535                 }
1536         }
1537
1538         /*
1539          * Finish up.
1540          */
1541         ahci_os_sleep(500);
1542
1543         switch(error) {
1544         case 0:
1545                 /*
1546                  * All good, make sure the port is running and set the
1547                  * probe state.  Ignore the signature junk (it's unreliable)
1548                  * until we get to the softreset code.
1549                  */
1550                 if (ahci_port_start(ap)) {
1551                         kprintf("%s: failed to start command DMA on port, "
1552                                 "disabling\n", PORTNAME(ap));
1553                         error = EBUSY;
1554                         break;
1555                 }
1556                 if (ap->ap_type == ATA_PORT_T_PM)
1557                         ap->ap_probe = ATA_PROBE_GOOD;
1558                 else
1559                         ap->ap_probe = ATA_PROBE_NEED_SOFT_RESET;
1560                 break;
1561         case ENODEV:
1562                 /*
1563                  * Normal device probe failure
1564                  */
1565                 data = ahci_pread(ap, AHCI_PREG_SSTS);
1566
1567                 switch(data & AHCI_PREG_SSTS_DET) {
1568                 case AHCI_PREG_SSTS_DET_DEV_NE:
1569                         kprintf("%s: Device not communicating\n",
1570                                 PORTNAME(ap));
1571                         break;
1572                 case AHCI_PREG_SSTS_DET_PHYOFFLINE:
1573                         kprintf("%s: PHY offline\n",
1574                                 PORTNAME(ap));
1575                         break;
1576                 default:
1577                         kprintf("%s: No device detected\n",
1578                                 PORTNAME(ap));
1579                         break;
1580                 }
1581                 ahci_port_hardstop(ap);
1582                 break;
1583         default:
1584                 /*
1585                  * Abnormal probe (EBUSY)
1586                  */
1587                 kprintf("%s: Device on port is bricked\n",
1588                         PORTNAME(ap));
1589                 ahci_port_hardstop(ap);
1590 #if 0
1591                 rc = ahci_port_reset(ap, atx, 0);
1592                 if (rc) {
1593                         kprintf("%s: Unable unbrick device\n",
1594                                 PORTNAME(ap));
1595                 } else {
1596                         kprintf("%s: Successfully unbricked\n",
1597                                 PORTNAME(ap));
1598                 }
1599 #endif
1600                 break;
1601         }
1602
1603         /*
1604          * Clean up
1605          */
1606         ahci_pwrite(ap, AHCI_PREG_SERR, -1);
1607         ahci_pwrite(ap, AHCI_PREG_IS, AHCI_PREG_IS_PCS | AHCI_PREG_IS_PRCS);
1608
1609         ap->ap_flags &= ~AP_F_IN_RESET;
1610
1611         if (bootverbose)
1612                 kprintf("%s: END HARDRESET %d\n", PORTNAME(ap), error);
1613         return (error);
1614 }
1615
1616 /*
1617  * Hard-stop on hot-swap device removal.  See 10.10.1
1618  *
1619  * Place the port in a mode that will allow it to detect hot-swap insertions.
1620  * This is a bit imprecise because just setting-up SCTL to DET_INIT doesn't
1621  * seem to do the job.
1622  *
1623  * FIS reception is left enabled but command processing is disabled.
1624  * Cycling FIS reception (FRE) can brick ports.
1625  */
1626 void
1627 ahci_port_hardstop(struct ahci_port *ap)
1628 {
1629         struct ahci_ccb *ccb;
1630         struct ata_port *at;
1631         u_int32_t r;
1632         u_int32_t cmd;
1633         int slot;
1634         int i;
1635
1636         /*
1637          * Stop the port.  We can't modify things like SUD if the port
1638          * is running.
1639          */
1640         ap->ap_state = AP_S_FATAL_ERROR;
1641         ap->ap_probe = ATA_PROBE_FAILED;
1642         ap->ap_type = ATA_PORT_T_NONE;
1643         ahci_port_stop(ap, 0);
1644         cmd = ahci_pread(ap, AHCI_PREG_CMD);
1645         cmd &= ~(AHCI_PREG_CMD_CLO | AHCI_PREG_CMD_PMA | AHCI_PREG_CMD_ICC);
1646         ahci_pwrite(ap, AHCI_PREG_CMD, cmd);
1647
1648         /*
1649          * Clean up AT sub-ports on SATA port.
1650          */
1651         for (i = 0; ap->ap_ata && i < AHCI_MAX_PMPORTS; ++i) {
1652                 at = ap->ap_ata[i];
1653                 at->at_type = ATA_PORT_T_NONE;
1654                 at->at_probe = ATA_PROBE_FAILED;
1655         }
1656
1657         /*
1658          * Make sure FRE is active.  There isn't anything we can do if it
1659          * fails so just ignore errors.
1660          */
1661         if ((cmd & AHCI_PREG_CMD_FRE) == 0) {
1662                 cmd |= AHCI_PREG_CMD_FRE;
1663                 ahci_pwrite(ap, AHCI_PREG_CMD, cmd);
1664                 if ((ap->ap_sc->sc_flags & AHCI_F_IGN_FR) == 0)
1665                         ahci_pwait_set(ap, AHCI_PREG_CMD, AHCI_PREG_CMD_FR);
1666         }
1667
1668         /*
1669          * 10.10.3 DET must be set to 0 before setting SUD to 0.
1670          * 10.10.1 place us in the Listen state.
1671          *
1672          * Deactivating SUD only applies if the controller supports SUD.
1673          */
1674         ahci_pwrite(ap, AHCI_PREG_SCTL, AHCI_PREG_SCTL_IPM_DISABLED);
1675         ahci_os_sleep(1);
1676         if (cmd & AHCI_PREG_CMD_SUD) {
1677                 cmd &= ~AHCI_PREG_CMD_SUD;
1678                 ahci_pwrite(ap, AHCI_PREG_CMD, cmd);
1679         }
1680         ahci_os_sleep(1);
1681
1682         /*
1683          * Transition su to the spin-up state.  HVA shall send COMRESET and
1684          * begin initialization sequence (whatever that means).
1685          *
1686          * This only applies if the controller supports SUD.
1687          * NEVER use AHCI_PREG_DET_DISABLE.
1688          */
1689         cmd |= AHCI_PREG_CMD_POD | AHCI_PREG_CMD_SUD;
1690         cmd |= AHCI_PREG_CMD_ICC_ACTIVE;
1691         ahci_pwrite(ap, AHCI_PREG_CMD, cmd);
1692         ahci_os_sleep(1);
1693
1694         /*
1695          * Transition us to the Reset state.  Theoretically we send a
1696          * continuous stream of COMRESETs in this state.
1697          */
1698         r = AHCI_PREG_SCTL_IPM_DISABLED | AHCI_PREG_SCTL_DET_INIT;
1699         if (AhciForceGen1 & (1 << ap->ap_num)) {
1700                 kprintf("%s: Force 1.5Gbits\n", PORTNAME(ap));
1701                 r |= AHCI_PREG_SCTL_SPD_GEN1;
1702         } else {
1703                 r |= AHCI_PREG_SCTL_SPD_ANY;
1704         }
1705         ahci_pwrite(ap, AHCI_PREG_SCTL, r);
1706         ahci_os_sleep(1);
1707
1708         /*
1709          * Flush SERR_DIAG_X so the TFD can update.
1710          */
1711         ahci_flush_tfd(ap);
1712
1713         /*
1714          * Clean out pending ccbs
1715          */
1716         while (ap->ap_active) {
1717                 slot = ffs(ap->ap_active) - 1;
1718                 ap->ap_active &= ~(1 << slot);
1719                 ap->ap_expired &= ~(1 << slot);
1720                 --ap->ap_active_cnt;
1721                 ccb = &ap->ap_ccbs[slot];
1722                 if (ccb->ccb_xa.flags & ATA_F_TIMEOUT_RUNNING) {
1723                         callout_stop(&ccb->ccb_timeout);
1724                         ccb->ccb_xa.flags &= ~ATA_F_TIMEOUT_RUNNING;
1725                 }
1726                 ccb->ccb_xa.flags &= ~(ATA_F_TIMEOUT_DESIRED |
1727                                        ATA_F_TIMEOUT_EXPIRED);
1728                 ccb->ccb_xa.state = ATA_S_TIMEOUT;
1729                 ccb->ccb_done(ccb);
1730                 ccb->ccb_xa.complete(&ccb->ccb_xa);
1731         }
1732         while (ap->ap_sactive) {
1733                 slot = ffs(ap->ap_sactive) - 1;
1734                 ap->ap_sactive &= ~(1 << slot);
1735                 ap->ap_expired &= ~(1 << slot);
1736                 ccb = &ap->ap_ccbs[slot];
1737                 if (ccb->ccb_xa.flags & ATA_F_TIMEOUT_RUNNING) {
1738                         callout_stop(&ccb->ccb_timeout);
1739                         ccb->ccb_xa.flags &= ~ATA_F_TIMEOUT_RUNNING;
1740                 }
1741                 ccb->ccb_xa.flags &= ~(ATA_F_TIMEOUT_DESIRED |
1742                                        ATA_F_TIMEOUT_EXPIRED);
1743                 ccb->ccb_xa.state = ATA_S_TIMEOUT;
1744                 ccb->ccb_done(ccb);
1745                 ccb->ccb_xa.complete(&ccb->ccb_xa);
1746         }
1747         KKASSERT(ap->ap_active_cnt == 0);
1748
1749         while ((ccb = TAILQ_FIRST(&ap->ap_ccb_pending)) != NULL) {
1750                 TAILQ_REMOVE(&ap->ap_ccb_pending, ccb, ccb_entry);
1751                 ccb->ccb_xa.state = ATA_S_TIMEOUT;
1752                 ccb->ccb_xa.flags &= ~ATA_F_TIMEOUT_DESIRED;
1753                 ccb->ccb_done(ccb);
1754                 ccb->ccb_xa.complete(&ccb->ccb_xa);
1755         }
1756
1757         /*
1758          * Leave us in COMRESET (both SUD and INIT active), the HBA should
1759          * hopefully send us a DIAG_X-related interrupt if it receives
1760          * a COMINIT, and if not that then at least a Phy transition
1761          * interrupt.
1762          *
1763          * If we transition INIT from 1->0 to begin the initalization
1764          * sequence it is unclear if that sequence will remain active
1765          * until the next device insertion.
1766          *
1767          * If we go back to the listen state it is unclear if the
1768          * device will actually send us a COMINIT, since we aren't
1769          * sending any COMRESET's
1770          */
1771         /* NOP */
1772 }
1773
1774 /*
1775  * We can't loop on the X bit, a continuous COMINIT received will make
1776  * it loop forever.  Just assume one event has built up and clear X
1777  * so the task file descriptor can update.
1778  */
1779 void
1780 ahci_flush_tfd(struct ahci_port *ap)
1781 {
1782         u_int32_t r;
1783
1784         r = ahci_pread(ap, AHCI_PREG_SERR);
1785         if (r & AHCI_PREG_SERR_DIAG_X)
1786                 ahci_pwrite(ap, AHCI_PREG_SERR, AHCI_PREG_SERR_DIAG_X);
1787 }
1788
1789 /*
1790  * Figure out what type of device is connected to the port, ATAPI or
1791  * DISK.
1792  */
1793 int
1794 ahci_port_signature_detect(struct ahci_port *ap, struct ata_port *at)
1795 {
1796         u_int32_t sig;
1797
1798         sig = ahci_pread(ap, AHCI_PREG_SIG);
1799         if (bootverbose)
1800                 kprintf("%s: sig %08x\n", ATANAME(ap, at), sig);
1801         if ((sig & 0xffff0000) == (SATA_SIGNATURE_ATAPI & 0xffff0000)) {
1802                 return(ATA_PORT_T_ATAPI);
1803         } else if ((sig & 0xffff0000) ==
1804                  (SATA_SIGNATURE_PORT_MULTIPLIER & 0xffff0000)) {
1805                 return(ATA_PORT_T_PM);
1806         } else {
1807                 return(ATA_PORT_T_DISK);
1808         }
1809 }
1810
1811 /*
1812  * Load the DMA descriptor table for a CCB's buffer.
1813  */
1814 int
1815 ahci_load_prdt(struct ahci_ccb *ccb)
1816 {
1817         struct ahci_port                *ap = ccb->ccb_port;
1818         struct ahci_softc               *sc = ap->ap_sc;
1819         struct ata_xfer                 *xa = &ccb->ccb_xa;
1820         struct ahci_prdt                *prdt = ccb->ccb_cmd_table->prdt;
1821         bus_dmamap_t                    dmap = ccb->ccb_dmamap;
1822         struct ahci_cmd_hdr             *cmd_slot = ccb->ccb_cmd_hdr;
1823         int                             error;
1824
1825         if (xa->datalen == 0) {
1826                 ccb->ccb_cmd_hdr->prdtl = 0;
1827                 return (0);
1828         }
1829
1830         error = bus_dmamap_load(sc->sc_tag_data, dmap,
1831                                 xa->data, xa->datalen,
1832                                 ahci_load_prdt_callback,
1833                                 &prdt,
1834                                 ((xa->flags & ATA_F_NOWAIT) ?
1835                                     BUS_DMA_NOWAIT : BUS_DMA_WAITOK));
1836         if (error != 0) {
1837                 kprintf("%s: error %d loading dmamap\n", PORTNAME(ap), error);
1838                 return (1);
1839         }
1840 #if 0
1841         if (xa->flags & ATA_F_PIO)
1842                 prdt->flags |= htole32(AHCI_PRDT_FLAG_INTR);
1843 #endif
1844
1845         cmd_slot->prdtl = htole16(prdt - ccb->ccb_cmd_table->prdt + 1);
1846
1847         if (xa->flags & ATA_F_READ)
1848                 bus_dmamap_sync(sc->sc_tag_data, dmap, BUS_DMASYNC_PREREAD);
1849         if (xa->flags & ATA_F_WRITE)
1850                 bus_dmamap_sync(sc->sc_tag_data, dmap, BUS_DMASYNC_PREWRITE);
1851
1852         return (0);
1853 }
1854
1855 /*
1856  * Callback from BUSDMA system to load the segment list.  The passed segment
1857  * list is a temporary structure.
1858  */
1859 static
1860 void
1861 ahci_load_prdt_callback(void *info, bus_dma_segment_t *segs, int nsegs,
1862                         int error)
1863 {
1864         struct ahci_prdt *prd = *(void **)info;
1865         u_int64_t addr;
1866
1867         KKASSERT(nsegs <= AHCI_MAX_PRDT);
1868
1869         while (nsegs) {
1870                 addr = segs->ds_addr;
1871                 prd->dba_hi = htole32((u_int32_t)(addr >> 32));
1872                 prd->dba_lo = htole32((u_int32_t)addr);
1873                 prd->flags = htole32(segs->ds_len - 1);
1874                 --nsegs;
1875                 if (nsegs)
1876                         ++prd;
1877                 ++segs;
1878         }
1879         *(void **)info = prd;   /* return last valid segment */
1880 }
1881
1882 void
1883 ahci_unload_prdt(struct ahci_ccb *ccb)
1884 {
1885         struct ahci_port                *ap = ccb->ccb_port;
1886         struct ahci_softc               *sc = ap->ap_sc;
1887         struct ata_xfer                 *xa = &ccb->ccb_xa;
1888         bus_dmamap_t                    dmap = ccb->ccb_dmamap;
1889
1890         if (xa->datalen != 0) {
1891                 if (xa->flags & ATA_F_READ) {
1892                         bus_dmamap_sync(sc->sc_tag_data, dmap,
1893                                         BUS_DMASYNC_POSTREAD);
1894                 }
1895                 if (xa->flags & ATA_F_WRITE) {
1896                         bus_dmamap_sync(sc->sc_tag_data, dmap,
1897                                         BUS_DMASYNC_POSTWRITE);
1898                 }
1899                 bus_dmamap_unload(sc->sc_tag_data, dmap);
1900
1901                 /*
1902                  * prdbc is only updated by hardware for non-NCQ commands.
1903                  */
1904                 if (ccb->ccb_xa.flags & ATA_F_NCQ) {
1905                         xa->resid = 0;
1906                 } else {
1907                         if (ccb->ccb_cmd_hdr->prdbc == 0 &&
1908                             ccb->ccb_xa.state == ATA_S_COMPLETE) {
1909                                 kprintf("%s: WARNING!  Unload prdbc resid "
1910                                         "was zero! tag=%d\n",
1911                                         ATANAME(ap, xa->at), ccb->ccb_slot);
1912                         }
1913                         xa->resid = xa->datalen -
1914                             le32toh(ccb->ccb_cmd_hdr->prdbc);
1915                 }
1916         }
1917 }
1918
1919 /*
1920  * Start a command and poll for completion.
1921  *
1922  * timeout is in ms and only counts once the command gets on-chip.
1923  *
1924  * Returns ATA_S_* state, compare against ATA_S_COMPLETE to determine
1925  * that no error occured.
1926  *
1927  * NOTE: If the caller specifies a NULL timeout function the caller is
1928  *       responsible for clearing hardware state on failure, but we will
1929  *       deal with removing the ccb from any pending queue.
1930  *
1931  * NOTE: NCQ should never be used with this function.
1932  *
1933  * NOTE: If the port is in a failed state and stopped we do not try
1934  *       to activate the ccb.
1935  */
1936 int
1937 ahci_poll(struct ahci_ccb *ccb, int timeout,
1938           void (*timeout_fn)(struct ahci_ccb *))
1939 {
1940         struct ahci_port *ap = ccb->ccb_port;
1941
1942         if (ccb->ccb_port->ap_state == AP_S_FATAL_ERROR) {
1943                 ccb->ccb_xa.state = ATA_S_ERROR;
1944                 return(ccb->ccb_xa.state);
1945         }
1946         crit_enter();
1947 #if 0
1948         kprintf("%s: Start command %02x tag=%d\n",
1949                 ATANAME(ccb->ccb_port, ccb->ccb_xa.at),
1950                 ccb->ccb_xa.fis->command, ccb->ccb_slot);
1951 #endif
1952         ahci_start(ccb);
1953
1954         do {
1955                 ahci_port_intr(ap, 1);
1956                 switch(ccb->ccb_xa.state) {
1957                 case ATA_S_ONCHIP:
1958                         timeout -= ahci_os_softsleep();
1959                         break;
1960                 case ATA_S_PENDING:
1961                         ahci_os_softsleep();
1962                         ahci_check_active_timeouts(ap);
1963                         break;
1964                 default:
1965                         crit_exit();
1966                         return (ccb->ccb_xa.state);
1967                 }
1968         } while (timeout > 0);
1969
1970         if ((ccb->ccb_xa.flags & ATA_F_SILENT) == 0) {
1971                 kprintf("%s: Poll timeout slot %d CMD: %b TFD: 0x%b SERR: %b\n",
1972                         ATANAME(ap, ccb->ccb_xa.at), ccb->ccb_slot,
1973                         ahci_pread(ap, AHCI_PREG_CMD), AHCI_PFMT_CMD,
1974                         ahci_pread(ap, AHCI_PREG_TFD), AHCI_PFMT_TFD_STS,
1975                         ahci_pread(ap, AHCI_PREG_SERR), AHCI_PFMT_SERR);
1976         }
1977
1978         timeout_fn(ccb);
1979
1980         crit_exit();
1981
1982         return(ccb->ccb_xa.state);
1983 }
1984
1985 /*
1986  * When polling we have to check if the currently active CCB(s)
1987  * have timed out as the callout will be deadlocked while we
1988  * hold the port lock.
1989  */
1990 void
1991 ahci_check_active_timeouts(struct ahci_port *ap)
1992 {
1993         struct ahci_ccb *ccb;
1994         u_int32_t mask;
1995         int tag;
1996
1997         mask = ap->ap_active | ap->ap_sactive;
1998         while (mask) {
1999                 tag = ffs(mask) - 1;
2000                 mask &= ~(1 << tag);
2001                 ccb = &ap->ap_ccbs[tag];
2002                 if (ccb->ccb_xa.flags & ATA_F_TIMEOUT_EXPIRED) {
2003                         ahci_ata_cmd_timeout(ccb);
2004                 }
2005         }
2006 }
2007
2008 static
2009 __inline
2010 void
2011 ahci_start_timeout(struct ahci_ccb *ccb)
2012 {
2013         if (ccb->ccb_xa.flags & ATA_F_TIMEOUT_DESIRED) {
2014                 ccb->ccb_xa.flags |= ATA_F_TIMEOUT_RUNNING;
2015                 callout_reset(&ccb->ccb_timeout,
2016                               (ccb->ccb_xa.timeout * hz + 999) / 1000,
2017                               ahci_ata_cmd_timeout_unserialized, ccb);
2018         }
2019 }
2020
2021 void
2022 ahci_start(struct ahci_ccb *ccb)
2023 {
2024         struct ahci_port                *ap = ccb->ccb_port;
2025         struct ahci_softc               *sc = ap->ap_sc;
2026
2027         KKASSERT(ccb->ccb_xa.state == ATA_S_PENDING);
2028
2029         /* Zero transferred byte count before transfer */
2030         ccb->ccb_cmd_hdr->prdbc = 0;
2031
2032         /* Sync command list entry and corresponding command table entry */
2033         bus_dmamap_sync(sc->sc_tag_cmdh,
2034                         AHCI_DMA_MAP(ap->ap_dmamem_cmd_list),
2035                         BUS_DMASYNC_PREWRITE);
2036         bus_dmamap_sync(sc->sc_tag_cmdt,
2037                         AHCI_DMA_MAP(ap->ap_dmamem_cmd_table),
2038                         BUS_DMASYNC_PREWRITE);
2039
2040         /* Prepare RFIS area for write by controller */
2041         bus_dmamap_sync(sc->sc_tag_rfis,
2042                         AHCI_DMA_MAP(ap->ap_dmamem_rfis),
2043                         BUS_DMASYNC_PREREAD);
2044
2045         /*
2046          * There's no point trying to optimize this, it only shaves a few
2047          * nanoseconds so just queue the command and call our generic issue.
2048          */
2049         ahci_issue_pending_commands(ap, ccb);
2050 }
2051
2052 /*
2053  * While holding the port lock acquire exclusive access to the port.
2054  *
2055  * This is used when running the state machine to initialize and identify
2056  * targets over a port multiplier.  Setting exclusive access prevents
2057  * ahci_port_intr() from activating any requests sitting on the pending
2058  * queue.
2059  */
2060 void
2061 ahci_beg_exclusive_access(struct ahci_port *ap, struct ata_port *at)
2062 {
2063         KKASSERT((ap->ap_flags & AP_F_EXCLUSIVE_ACCESS) == 0);
2064         ap->ap_flags |= AP_F_EXCLUSIVE_ACCESS;
2065         while (ap->ap_active || ap->ap_sactive) {
2066                 ahci_port_intr(ap, 1);
2067                 ahci_os_softsleep();
2068         }
2069 }
2070
2071 void
2072 ahci_end_exclusive_access(struct ahci_port *ap, struct ata_port *at)
2073 {
2074         KKASSERT((ap->ap_flags & AP_F_EXCLUSIVE_ACCESS) != 0);
2075         ap->ap_flags &= ~AP_F_EXCLUSIVE_ACCESS;
2076         ahci_issue_pending_commands(ap, NULL);
2077 }
2078
2079 #if 0
2080
2081 static void
2082 fubar(struct ahci_ccb *ccb)
2083 {
2084         struct ahci_port *ap = ccb->ccb_port;
2085         struct ahci_cmd_hdr     *cmd;
2086         struct ahci_cmd_table   *tab;
2087         struct ahci_prdt        *prdt;
2088         int i;
2089
2090         kprintf("%s: ISSUE %02x\n",
2091                 ATANAME(ap, ccb->ccb_xa.at),
2092                 ccb->ccb_xa.fis->command);
2093         cmd = ccb->ccb_cmd_hdr;
2094         tab = ccb->ccb_cmd_table;
2095         prdt = ccb->ccb_cmd_table->prdt;
2096         kprintf("cmd flags=%04x prdtl=%d prdbc=%d ctba=%08x%08x\n",
2097                 cmd->flags, cmd->prdtl, cmd->prdbc,
2098                 cmd->ctba_hi, cmd->ctba_lo);
2099         for (i = 0; i < cmd->prdtl; ++i) {
2100                 kprintf("\t%d dba=%08x%08x res=%08x flags=%08x\n",
2101                         i, prdt->dba_hi, prdt->dba_lo, prdt->reserved,
2102                         prdt->flags);
2103         }
2104         kprintf("tab\n");
2105 }
2106
2107 #endif
2108
2109 /*
2110  * If ccb is not NULL enqueue and/or issue it.
2111  *
2112  * If ccb is NULL issue whatever we can from the queue.  However, nothing
2113  * new is issued if the exclusive access flag is set or expired ccb's are
2114  * present.
2115  *
2116  * If existing commands are still active (ap_active/ap_sactive) we can only
2117  * issue matching new commands.
2118  */
2119 void
2120 ahci_issue_pending_commands(struct ahci_port *ap, struct ahci_ccb *ccb)
2121 {
2122         u_int32_t               mask;
2123         int                     limit;
2124
2125         /*
2126          * Enqueue the ccb.
2127          *
2128          * If just running the queue and in exclusive access mode we
2129          * just return.  Also in this case if there are any expired ccb's
2130          * we want to clear the queue so the port can be safely stopped.
2131          */
2132         if (ccb) {
2133                 TAILQ_INSERT_TAIL(&ap->ap_ccb_pending, ccb, ccb_entry);
2134         } else if ((ap->ap_flags & AP_F_EXCLUSIVE_ACCESS) || ap->ap_expired) {
2135                 return;
2136         }
2137
2138         /*
2139          * Pull the next ccb off the queue and run it if possible.
2140          */
2141         if ((ccb = TAILQ_FIRST(&ap->ap_ccb_pending)) == NULL)
2142                 return;
2143
2144         /*
2145          * Handle exclusivity requirements.
2146          *
2147          * ATA_F_EXCLUSIVE is used when we want to be the only command
2148          * running.
2149          *
2150          * ATA_F_AUTOSENSE is used when we want the D2H rfis loaded
2151          * back into the ccb on a normal (non-errored) command completion.
2152          * For example, for PM requests to target 15.  Because the AHCI
2153          * spec does not stop the command processor and has only one rfis
2154          * area (for non-FBSS anyway), AUTOSENSE currently implies EXCLUSIVE.
2155          * Otherwise multiple completions can destroy the rfis data before
2156          * we have a chance to copy it.
2157          */
2158         if (ap->ap_active & ~ap->ap_expired) {
2159                 /*
2160                  * There may be multiple ccb's already running,
2161                  * if any are running and ap_run_flags sets
2162                  * one of these flags then we know only one is
2163                  * running.
2164                  *
2165                  * XXX Current AUTOSENSE code forces exclusivity
2166                  *     to simplify the code.
2167                  */
2168                 if (ap->ap_run_flags &
2169                     (ATA_F_EXCLUSIVE | ATA_F_AUTOSENSE)) {
2170                         return;
2171                 }
2172
2173                 if (ccb->ccb_xa.flags &
2174                     (ATA_F_EXCLUSIVE | ATA_F_AUTOSENSE)) {
2175                         return;
2176                 }
2177         }
2178
2179         if (ccb->ccb_xa.flags & ATA_F_NCQ) {
2180                 /*
2181                  * The next command is a NCQ command and can be issued as
2182                  * long as currently active commands are not standard.
2183                  */
2184                 if (ap->ap_active) {
2185                         KKASSERT(ap->ap_active_cnt > 0);
2186                         return;
2187                 }
2188                 KKASSERT(ap->ap_active_cnt == 0);
2189
2190                 mask = 0;
2191                 do {
2192                         TAILQ_REMOVE(&ap->ap_ccb_pending, ccb, ccb_entry);
2193                         mask |= 1 << ccb->ccb_slot;
2194                         ccb->ccb_xa.state = ATA_S_ONCHIP;
2195                         ahci_start_timeout(ccb);
2196                         ap->ap_run_flags = ccb->ccb_xa.flags;
2197                         ccb = TAILQ_FIRST(&ap->ap_ccb_pending);
2198                 } while (ccb && (ccb->ccb_xa.flags & ATA_F_NCQ) &&
2199                          (ap->ap_run_flags &
2200                              (ATA_F_EXCLUSIVE | ATA_F_AUTOSENSE)) == 0);
2201
2202                 ap->ap_sactive |= mask;
2203                 ahci_pwrite(ap, AHCI_PREG_SACT, mask);
2204                 ahci_pwrite(ap, AHCI_PREG_CI, mask);
2205         } else {
2206                 /*
2207                  * The next command is a standard command and can be issued
2208                  * as long as currently active commands are not NCQ.
2209                  *
2210                  * We limit ourself to 1 command if we have a port multiplier,
2211                  * (at least without FBSS support), otherwise timeouts on
2212                  * one port can race completions on other ports (see
2213                  * ahci_ata_cmd_timeout() for more information).
2214                  *
2215                  * If not on a port multiplier generally allow up to 4
2216                  * standard commands to be enqueued.  Remember that the
2217                  * command processor will still process them sequentially.
2218                  */
2219                 if (ap->ap_sactive)
2220                         return;
2221                 if (ap->ap_type == ATA_PORT_T_PM)
2222                         limit = 1;
2223                 else if (ap->ap_sc->sc_ncmds > 4)
2224                         limit = 4;
2225                 else
2226                         limit = 2;
2227
2228                 while (ap->ap_active_cnt < limit && ccb &&
2229                        (ccb->ccb_xa.flags & ATA_F_NCQ) == 0) {
2230                         TAILQ_REMOVE(&ap->ap_ccb_pending, ccb, ccb_entry);
2231 #if 0
2232                         fubar(ccb);
2233 #endif
2234                         ap->ap_active |= 1 << ccb->ccb_slot;
2235                         ap->ap_active_cnt++;
2236                         ap->ap_run_flags = ccb->ccb_xa.flags;
2237                         ccb->ccb_xa.state = ATA_S_ONCHIP;
2238                         ahci_pwrite(ap, AHCI_PREG_CI, 1 << ccb->ccb_slot);
2239                         ahci_start_timeout(ccb);
2240                         if ((ap->ap_run_flags &
2241                             (ATA_F_EXCLUSIVE | ATA_F_AUTOSENSE)) == 0) {
2242                                 break;
2243                         }
2244                         ccb = TAILQ_FIRST(&ap->ap_ccb_pending);
2245                         if (ccb && (ccb->ccb_xa.flags &
2246                                     (ATA_F_EXCLUSIVE | ATA_F_AUTOSENSE))) {
2247                                 break;
2248                         }
2249                 }
2250         }
2251 }
2252
2253 void
2254 ahci_intr(void *arg)
2255 {
2256         struct ahci_softc       *sc = arg;
2257         struct ahci_port        *ap;
2258         u_int32_t               is;
2259         u_int32_t               ack;
2260         int                     port;
2261
2262         /*
2263          * Check if the master enable is up, and whether any interrupts are
2264          * pending.
2265          */
2266         if ((sc->sc_flags & AHCI_F_INT_GOOD) == 0)
2267                 return;
2268         is = ahci_read(sc, AHCI_REG_IS);
2269         if (is == 0 || is == 0xffffffff) {
2270                 return;
2271         }
2272         is &= sc->sc_portmask;
2273
2274 #ifdef AHCI_COALESCE
2275         /* Check coalescing interrupt first */
2276         if (is & sc->sc_ccc_mask) {
2277                 DPRINTF(AHCI_D_INTR, "%s: command coalescing interrupt\n",
2278                     DEVNAME(sc));
2279                 is &= ~sc->sc_ccc_mask;
2280                 is |= sc->sc_ccc_ports_cur;
2281         }
2282 #endif
2283
2284         /*
2285          * Process interrupts for each port in a non-blocking fashion.
2286          *
2287          * The global IS bit is forced on if any unmasked port interrupts
2288          * are pending, even if we clear.
2289          */
2290         for (ack = 0; is; is &= ~(1 << port)) {
2291                 port = ffs(is) - 1;
2292                 ack |= 1 << port;
2293
2294                 ap = sc->sc_ports[port];
2295                 if (ap == NULL)
2296                         continue;
2297
2298                 if (ahci_os_lock_port_nb(ap) == 0) {
2299                         ahci_port_intr(ap, 0);
2300                         ahci_os_unlock_port(ap);
2301                 } else {
2302                         ahci_pwrite(ap, AHCI_PREG_IE, 0);
2303                         ahci_os_signal_port_thread(ap, AP_SIGF_PORTINT);
2304                 }
2305         }
2306         ahci_write(sc, AHCI_REG_IS, ack);
2307 }
2308
2309 /*
2310  * Core called from helper thread.
2311  */
2312 void
2313 ahci_port_thread_core(struct ahci_port *ap, int mask)
2314 {
2315         /*
2316          * Process any expired timedouts.
2317          */
2318         ahci_os_lock_port(ap);
2319         if (mask & AP_SIGF_TIMEOUT) {
2320                 ahci_check_active_timeouts(ap);
2321         }
2322
2323         /*
2324          * Process port interrupts which require a higher level of
2325          * intervention.
2326          */
2327         if (mask & AP_SIGF_PORTINT) {
2328                 ahci_port_intr(ap, 1);
2329                 ahci_port_interrupt_enable(ap);
2330                 ahci_os_unlock_port(ap);
2331         } else if (ap->ap_probe != ATA_PROBE_FAILED) {
2332                 ahci_port_intr(ap, 1);
2333                 ahci_port_interrupt_enable(ap);
2334                 ahci_os_unlock_port(ap);
2335         } else {
2336                 ahci_os_unlock_port(ap);
2337         }
2338 }
2339
2340 /*
2341  * Core per-port interrupt handler.
2342  *
2343  * If blockable is 0 we cannot call ahci_os_sleep() at all and we can only
2344  * deal with normal command completions which do not require blocking.
2345  */
2346 void
2347 ahci_port_intr(struct ahci_port *ap, int blockable)
2348 {
2349         struct ahci_softc       *sc = ap->ap_sc;
2350         u_int32_t               is, ci_saved, ci_masked;
2351         int                     slot;
2352         int                     stopped = 0;
2353         struct ahci_ccb         *ccb = NULL;
2354         struct ata_port         *ccb_at = NULL;
2355         volatile u_int32_t      *active;
2356         const u_int32_t         blockable_mask = AHCI_PREG_IS_TFES |
2357                                                  AHCI_PREG_IS_IFS |
2358                                                  AHCI_PREG_IS_PCS |
2359                                                  AHCI_PREG_IS_PRCS |
2360                                                  AHCI_PREG_IS_HBFS |
2361                                                  AHCI_PREG_IS_OFS |
2362                                                  AHCI_PREG_IS_UFS;
2363
2364         enum { NEED_NOTHING, NEED_REINIT, NEED_RESTART,
2365                NEED_HOTPLUG_INSERT, NEED_HOTPLUG_REMOVE } need = NEED_NOTHING;
2366
2367         /*
2368          * All basic command completions are always processed.
2369          */
2370         is = ahci_pread(ap, AHCI_PREG_IS);
2371         if (is & AHCI_PREG_IS_DPS)
2372                 ahci_pwrite(ap, AHCI_PREG_IS, is & AHCI_PREG_IS_DPS);
2373
2374         /*
2375          * If we can't block then we can't handle these here.  Disable
2376          * the interrupts in question so we don't live-lock, the helper
2377          * thread will re-enable them.
2378          *
2379          * If the port is in a completely failed state we do not want
2380          * to drop through to failed-command-processing if blockable is 0,
2381          * just let the thread deal with it all.
2382          *
2383          * Otherwise we fall through and still handle DHRS and any commands
2384          * which completed normally.  Even if we are errored we haven't
2385          * stopped the port yet so CI/SACT are still good.
2386          */
2387         if (blockable == 0) {
2388                 if (ap->ap_state == AP_S_FATAL_ERROR) {
2389                         ahci_pwrite(ap, AHCI_PREG_IE, 0);
2390                         ahci_os_signal_port_thread(ap, AP_SIGF_PORTINT);
2391                         return;
2392                 }
2393                 if (is & blockable_mask) {
2394                         ahci_pwrite(ap, AHCI_PREG_IE, 0);
2395                         ahci_os_signal_port_thread(ap, AP_SIGF_PORTINT);
2396                         return;
2397                 }
2398         }
2399
2400         /*
2401          * Either NCQ or non-NCQ commands will be active, never both.
2402          */
2403         if (ap->ap_sactive) {
2404                 KKASSERT(ap->ap_active == 0);
2405                 KKASSERT(ap->ap_active_cnt == 0);
2406                 ci_saved = ahci_pread(ap, AHCI_PREG_SACT);
2407                 active = &ap->ap_sactive;
2408         } else {
2409                 ci_saved = ahci_pread(ap, AHCI_PREG_CI);
2410                 active = &ap->ap_active;
2411         }
2412         KKASSERT(!(ap->ap_sactive && ap->ap_active));
2413 #if 0
2414         kprintf("CHECK act=%08x/%08x sact=%08x/%08x\n",
2415                 ap->ap_active, ahci_pread(ap, AHCI_PREG_CI),
2416                 ap->ap_sactive, ahci_pread(ap, AHCI_PREG_SACT));
2417 #endif
2418
2419         /*
2420          * Ignore AHCI_PREG_IS_PRCS when link power management is on
2421          */
2422         if (ap->link_pwr_mgmt != AHCI_LINK_PWR_MGMT_NONE) {
2423                 is &= ~AHCI_PREG_IS_PRCS;
2424                 ahci_pwrite(ap, AHCI_PREG_SERR,
2425                     AHCI_PREG_SERR_DIAG_N | AHCI_PREG_SERR_DIAG_W);
2426         }
2427
2428         /*
2429          * Command failed (blockable).
2430          *
2431          * See AHCI 1.1 spec 6.2.2.1 and 6.2.2.2.
2432          *
2433          * This stops command processing.
2434          */
2435         if (is & AHCI_PREG_IS_TFES) {
2436                 u_int32_t tfd, serr;
2437                 int     err_slot;
2438
2439 process_error:
2440                 tfd = ahci_pread(ap, AHCI_PREG_TFD);
2441                 serr = ahci_pread(ap, AHCI_PREG_SERR);
2442
2443                 /*
2444                  * Load the error slot and restart command processing.
2445                  * CLO if we need to.  The error slot may not be valid.
2446                  * MUST BE DONE BEFORE CLEARING ST!
2447                  *
2448                  * Cycle ST.
2449                  *
2450                  * It is unclear but we may have to clear SERR to reenable
2451                  * error processing.
2452                  */
2453                 err_slot = AHCI_PREG_CMD_CCS(ahci_pread(ap, AHCI_PREG_CMD));
2454                 ahci_pwrite(ap, AHCI_PREG_IS, AHCI_PREG_IS_TFES |
2455                                               AHCI_PREG_IS_PSS |
2456                                               AHCI_PREG_IS_DHRS |
2457                                               AHCI_PREG_IS_SDBS);
2458                 is &= ~(AHCI_PREG_IS_TFES | AHCI_PREG_IS_PSS |
2459                         AHCI_PREG_IS_DHRS | AHCI_PREG_IS_SDBS);
2460                 ahci_pwrite(ap, AHCI_PREG_SERR, serr);
2461                 ahci_port_stop(ap, 0);
2462                 ahci_os_hardsleep(10);
2463                 if (tfd & (AHCI_PREG_TFD_STS_BSY | AHCI_PREG_TFD_STS_DRQ)) {
2464                         kprintf("%s: Issuing CLO\n", PORTNAME(ap));
2465                         ahci_port_clo(ap);
2466                 }
2467
2468                 /*
2469                  * We are now stopped and need a restart.  If we have to
2470                  * process a NCQ error we will temporarily start and then
2471                  * stop the port again, so this condition holds.
2472                  */
2473                 stopped = 1;
2474                 need = NEED_RESTART;
2475
2476                 /*
2477                  * ATAPI errors are fairly common from probing, just
2478                  * report disk errors or if bootverbose is on.
2479                  */
2480                 if (bootverbose || ap->ap_type != ATA_PORT_T_ATAPI) {
2481                         kprintf("%s: TFES slot %d ci_saved = %08x\n",
2482                                 PORTNAME(ap), err_slot, ci_saved);
2483                 }
2484
2485                 /*
2486                  * If we got an error on an error CCB just complete it
2487                  * with an error.  ci_saved has the mask to restart
2488                  * (the err_ccb will be removed from it by finish_error).
2489                  */
2490                 if (ap->ap_flags & AP_F_ERR_CCB_RESERVED) {
2491                         err_slot = ap->ap_err_ccb->ccb_slot;
2492                         goto finish_error;
2493                 }
2494
2495                 /*
2496                  * If NCQ commands were active get the error slot from
2497                  * the log page.  NCQ is not supported for PM's so this
2498                  * is a direct-attached target.
2499                  *
2500                  * Otherwise if no commands were active we have a problem.
2501                  *
2502                  * Otherwise if the error slot is bad we have a problem.
2503                  *
2504                  * Otherwise process the error for the slot.
2505                  */
2506                 if (ap->ap_sactive) {
2507                         ahci_port_start(ap);
2508                         err_slot = ahci_port_read_ncq_error(ap, 0);
2509                         ahci_port_stop(ap, 0);
2510                 } else if (ap->ap_active == 0) {
2511                         kprintf("%s: TFES with no commands pending\n",
2512                                 PORTNAME(ap));
2513                         err_slot = -1;
2514                 } else if (err_slot < 0 || err_slot >= ap->ap_sc->sc_ncmds) {
2515                         kprintf("%s: bad error slot %d\n",
2516                                 PORTNAME(ap), err_slot);
2517                         err_slot = -1;
2518                 } else {
2519                         ccb = &ap->ap_ccbs[err_slot];
2520
2521                         /*
2522                          * Validate the errored ccb.  Note that ccb_at can
2523                          * be NULL for direct-attached ccb's.
2524                          *
2525                          * Copy received taskfile data from the RFIS.
2526                          */
2527                         if (ccb->ccb_xa.state == ATA_S_ONCHIP) {
2528                                 ccb_at = ccb->ccb_xa.at;
2529                                 memcpy(&ccb->ccb_xa.rfis, ap->ap_rfis->rfis,
2530                                        sizeof(struct ata_fis_d2h));
2531                                 if (bootverbose) {
2532                                         kprintf("%s: Copying rfis slot %d\n",
2533                                                 ATANAME(ap, ccb_at), err_slot);
2534                                 }
2535                         } else {
2536                                 kprintf("%s: Cannot copy rfis, CCB slot "
2537                                         "%d is not on-chip (state=%d)\n",
2538                                         ATANAME(ap, ccb->ccb_xa.at),
2539                                         err_slot, ccb->ccb_xa.state);
2540                                 err_slot = -1;
2541                         }
2542                 }
2543
2544                 /*
2545                  * If we could not determine the errored slot then
2546                  * reset the port.
2547                  */
2548                 if (err_slot < 0) {
2549                         kprintf("%s: TFES: Unable to determine errored slot\n",
2550                                 PORTNAME(ap));
2551                         if (ap->ap_flags & AP_F_IN_RESET)
2552                                 goto fatal;
2553                         goto failall;
2554                 }
2555
2556                 /*
2557                  * Finish error on slot.  We will restart ci_saved
2558                  * commands except the errored slot which we generate
2559                  * a failure for.
2560                  */
2561 finish_error:
2562                 ccb = &ap->ap_ccbs[err_slot];
2563                 ci_saved &= ~(1 << err_slot);
2564                 KKASSERT(ccb->ccb_xa.state == ATA_S_ONCHIP);
2565                 ccb->ccb_xa.state = ATA_S_ERROR;
2566         } else if (is & AHCI_PREG_IS_DHRS) {
2567                 /*
2568                  * Command posted D2H register FIS to the rfis (non-blocking).
2569                  *
2570                  * A normal completion with an error may set DHRS instead
2571                  * of TFES.  The CCS bits are only valid if ERR was set.
2572                  * If ERR is set command processing was probably stopped.
2573                  *
2574                  * If ERR was not set we can only copy-back data for
2575                  * exclusive-mode commands because otherwise we won't know
2576                  * which tag the rfis belonged to.
2577                  *
2578                  * err_slot must be read from the CCS before any other port
2579                  * action, such as stopping the port.
2580                  *
2581                  * WARNING!     This is not well documented in the AHCI spec.
2582                  *              It can be found in the state machine tables
2583                  *              but not in the explanations.
2584                  */
2585                 u_int32_t tfd;
2586                 u_int32_t cmd;
2587                 int err_slot;
2588
2589                 tfd = ahci_pread(ap, AHCI_PREG_TFD);
2590                 cmd = ahci_pread(ap, AHCI_PREG_CMD);
2591
2592                 if ((tfd & AHCI_PREG_TFD_STS_ERR) &&
2593                     (cmd & AHCI_PREG_CMD_CR) == 0) {
2594                         err_slot = AHCI_PREG_CMD_CCS(
2595                                                 ahci_pread(ap, AHCI_PREG_CMD));
2596                         ccb = &ap->ap_ccbs[err_slot];
2597                         kprintf("%s: DHRS tfd=%b err_slot=%d cmd=%02x\n",
2598                                 PORTNAME(ap),
2599                                 tfd, AHCI_PFMT_TFD_STS,
2600                                 err_slot, ccb->ccb_xa.fis->command);
2601                         goto process_error;
2602                 }
2603                 /*
2604                  * NO ELSE... copy back is in the normal command completion
2605                  * code and only if no error occured and ATA_F_AUTOSENSE
2606                  * was set.
2607                  */
2608                 ahci_pwrite(ap, AHCI_PREG_IS, AHCI_PREG_IS_DHRS);
2609         }
2610
2611         /*
2612          * Device notification to us (non-blocking)
2613          *
2614          * NOTE!  On some parts notification bits can cause an IPMS
2615          *        interrupt instead of a SDBS interrupt.
2616          *
2617          * NOTE!  On some parts (e.g. VBOX, probably intel ICHx),
2618          *        SDBS notifies us of the completion of a NCQ command
2619          *        and DBS does not.
2620          */
2621         if (is & (AHCI_PREG_IS_SDBS | AHCI_PREG_IS_IPMS)) {
2622                 u_int32_t data;
2623
2624                 ahci_pwrite(ap, AHCI_PREG_IS,
2625                                 AHCI_PREG_IS_SDBS | AHCI_PREG_IS_IPMS);
2626                 if (sc->sc_cap & AHCI_REG_CAP_SSNTF) {
2627                         data = ahci_pread(ap, AHCI_PREG_SNTF);
2628                         if (data) {
2629                                 ahci_pwrite(ap, AHCI_PREG_IS,
2630                                                 AHCI_PREG_IS_SDBS);
2631                                 kprintf("%s: NOTIFY %08x\n",
2632                                         PORTNAME(ap), data);
2633                                 ahci_pwrite(ap, AHCI_PREG_SERR,
2634                                                 AHCI_PREG_SERR_DIAG_N);
2635                                 ahci_pwrite(ap, AHCI_PREG_SNTF, data);
2636                                 ahci_cam_changed(ap, NULL, -1);
2637                         }
2638                 }
2639                 is &= ~(AHCI_PREG_IS_SDBS | AHCI_PREG_IS_IPMS);
2640         }
2641
2642         /*
2643          * Spurious IFS errors (blockable) - when AP_F_IGNORE_IFS is set.
2644          *
2645          * Spurious IFS errors can occur while we are doing a reset
2646          * sequence through a PM, probably due to an unexpected FIS
2647          * being received during the PM target reset sequence.  Chipsets
2648          * are supposed to mask these events but some do not.
2649          *
2650          * Try to recover from the condition.
2651          */
2652         if ((is & AHCI_PREG_IS_IFS) && (ap->ap_flags & AP_F_IGNORE_IFS)) {
2653                 u_int32_t serr = ahci_pread(ap, AHCI_PREG_SERR);
2654                 if ((ap->ap_flags & AP_F_IFS_IGNORED) == 0) {
2655                         kprintf("%s: IFS during PM probe (ignored) "
2656                                 "IS=%b, SERR=%b\n",
2657                                 PORTNAME(ap),
2658                                 is, AHCI_PFMT_IS,
2659                                 serr, AHCI_PFMT_SERR);
2660                         ap->ap_flags |= AP_F_IFS_IGNORED;
2661                 }
2662
2663                 /*
2664                  * Try to clear the error condition.  The IFS error killed
2665                  * the port so stop it so we can restart it.
2666                  */
2667                 ahci_pwrite(ap, AHCI_PREG_SERR, -1);
2668                 ahci_pwrite(ap, AHCI_PREG_IS, AHCI_PREG_IS_IFS);
2669                 is &= ~AHCI_PREG_IS_IFS;
2670                 need = NEED_RESTART;
2671                 goto failall;
2672         }
2673
2674         /*
2675          * Port change (hot-plug) (blockable).
2676          *
2677          * A PRCS interrupt can occur:
2678          *      (1) On hot-unplug / normal-unplug (phy lost)
2679          *      (2) Sometimes on hot-plug too.
2680          *
2681          * A PCS interrupt can occur in a number of situations:
2682          *      (1) On hot-plug once communication is established
2683          *      (2) On hot-unplug sometimes.
2684          *      (3) For chipsets with badly written firmware it can occur
2685          *          during INIT/RESET sequences due to the device reset.
2686          *      (4) For chipsets with badly written firmware it can occur
2687          *          when it thinks an unsolicited COMRESET is received
2688          *          during a INIT/RESET sequence, even though we actually
2689          *          did request it.
2690          *
2691          * XXX We can then check the CPS (Cold Presence State) bit, if
2692          * supported, to determine if a device is plugged in or not and do
2693          * the right thing.
2694          *
2695          * PCS interrupts are cleared by clearing DIAG_X.  If this occurs
2696          * command processing is automatically stopped (CR goes inactive)
2697          * and the port must be stopped and restarted.
2698          *
2699          * WARNING: AMD parts (e.g. 880G chipset, probably others) can
2700          *          generate PCS on initialization even when device is
2701          *          already connected up.  It is unclear why this happens.
2702          *          Depending on the state of the device detect this can
2703          *          cause us to go into harsh reinit or hot-plug insertion
2704          *          mode.
2705          *
2706          * WARNING: PCS errors can be repetitive (e.g. unsolicited COMRESET
2707          *          continues to flow in from the device), we must clear the
2708          *          interrupt in all cases and enforce a delay to prevent
2709          *          a livelock and give the port time to settle down.
2710          *          Only print something if we aren't in INIT/HARD-RESET.
2711          */
2712         if (is & (AHCI_PREG_IS_PCS | AHCI_PREG_IS_PRCS)) {
2713                 /*
2714                  * Try to clear the error.  Because of the repetitiveness
2715                  * of this interrupt avoid any harsh action if the port is
2716                  * already in the init or hard-reset probe state.
2717                  */
2718                 ahci_pwrite(ap, AHCI_PREG_SERR, -1);
2719                 /* (AHCI_PREG_SERR_DIAG_N | AHCI_PREG_SERR_DIAG_X) */
2720                 ahci_pwrite(ap, AHCI_PREG_IS,
2721                             is & (AHCI_PREG_IS_PCS | AHCI_PREG_IS_PRCS));
2722
2723                 /*
2724                  * Ignore PCS/PRCS errors during probes (but still clear the
2725                  * interrupt to avoid a livelock).  The AMD 880/890/SB850
2726                  * chipsets do not mask PCS/PRCS internally during reset
2727                  * sequences.
2728                  */
2729                 if (ap->ap_flags & AP_F_IN_RESET) {
2730                         kprintf("S");
2731                         goto skip_pcs;
2732                 }
2733
2734                 if (ap->ap_probe == ATA_PROBE_NEED_INIT ||
2735                     ap->ap_probe == ATA_PROBE_NEED_HARD_RESET) {
2736                         is &= ~(AHCI_PREG_IS_PCS | AHCI_PREG_IS_PRCS);
2737                         need = NEED_NOTHING;
2738                         ahci_os_sleep(1000);
2739                         goto failall;
2740                 }
2741                 kprintf("%s: Transient Errors: %b (%d)\n",
2742                         PORTNAME(ap), is, AHCI_PFMT_IS, ap->ap_probe);
2743                 is &= ~(AHCI_PREG_IS_PCS | AHCI_PREG_IS_PRCS);
2744                 ahci_os_sleep(200);
2745
2746                 /*
2747                  * Stop the port and figure out what to do next.
2748                  */
2749                 ahci_port_stop(ap, 0);
2750                 stopped = 1;
2751
2752                 switch (ahci_pread(ap, AHCI_PREG_SSTS) & AHCI_PREG_SSTS_DET) {
2753                 case AHCI_PREG_SSTS_DET_DEV:
2754                         /*
2755                          * Device detect
2756                          */
2757                         if (ap->ap_probe == ATA_PROBE_FAILED) {
2758                                 need = NEED_HOTPLUG_INSERT;
2759                                 goto fatal;
2760                         }
2761                         need = NEED_RESTART;
2762                         break;
2763                 case AHCI_PREG_SSTS_DET_DEV_NE:
2764                         /*
2765                          * Device not communicating.  AMD parts seem to
2766                          * like to throw this error on initialization
2767                          * for no reason that I can fathom.
2768                          */
2769                         kprintf("%s: Device present but not communicating, "
2770                                 "attempting port restart\n",
2771                                 PORTNAME(ap));
2772                         need = NEED_REINIT;
2773                         goto fatal;
2774                 default:
2775                         if (ap->ap_probe != ATA_PROBE_FAILED) {
2776                                 need = NEED_HOTPLUG_REMOVE;
2777                                 goto fatal;
2778                         }
2779                         need = NEED_RESTART;
2780                         break;
2781                 }
2782 skip_pcs:
2783                 ;
2784         }
2785
2786         /*
2787          * Check for remaining errors - they are fatal. (blockable)
2788          */
2789         if (is & (AHCI_PREG_IS_TFES | AHCI_PREG_IS_HBFS | AHCI_PREG_IS_IFS |
2790                   AHCI_PREG_IS_OFS | AHCI_PREG_IS_UFS)) {
2791                 u_int32_t serr;
2792
2793                 ahci_pwrite(ap, AHCI_PREG_IS,
2794                             is & (AHCI_PREG_IS_TFES | AHCI_PREG_IS_HBFS |
2795                                   AHCI_PREG_IS_IFS | AHCI_PREG_IS_OFS |
2796                                   AHCI_PREG_IS_UFS));
2797                 serr = ahci_pread(ap, AHCI_PREG_SERR);
2798                 kprintf("%s: Unrecoverable errors (IS: %b, SERR: %b), "
2799                         "disabling port.\n",
2800                         PORTNAME(ap),
2801                         is, AHCI_PFMT_IS,
2802                         serr, AHCI_PFMT_SERR
2803                 );
2804                 is &= ~(AHCI_PREG_IS_TFES | AHCI_PREG_IS_HBFS |
2805                         AHCI_PREG_IS_IFS | AHCI_PREG_IS_OFS |
2806                         AHCI_PREG_IS_UFS);
2807
2808                 /*
2809                  * Fail all commands but then what?  For now try to
2810                  * reinitialize the port.
2811                  */
2812                 need = NEED_REINIT;
2813                 goto fatal;
2814         }
2815
2816         /*
2817          * Fail all outstanding commands if we know the port won't recover.
2818          *
2819          * We may have a ccb_at if the failed command is known and was
2820          * being sent to a device over a port multiplier (PM).  In this
2821          * case if the port itself has not completely failed we fail just
2822          * the commands related to that target.
2823          *
2824          * ci_saved contains the mask of active commands as of when the
2825          * error occured, prior to any port stops.
2826          */
2827         if (ap->ap_state == AP_S_FATAL_ERROR) {
2828 fatal:
2829                 ap->ap_state = AP_S_FATAL_ERROR;
2830 failall:
2831                 ahci_port_stop(ap, 0);
2832                 stopped = 1;
2833
2834                 /*
2835                  * Error all the active slots not already errored.
2836                  */
2837                 ci_masked = ci_saved & *active & ~ap->ap_expired;
2838                 if (ci_masked) {
2839                         kprintf("%s: Failing all commands: %08x\n",
2840                                 PORTNAME(ap), ci_masked);
2841                 }
2842
2843                 while (ci_masked) {
2844                         slot = ffs(ci_masked) - 1;
2845                         ccb = &ap->ap_ccbs[slot];
2846                         ccb->ccb_xa.state = ATA_S_TIMEOUT;
2847                         ap->ap_expired |= 1 << slot;
2848                         ci_saved &= ~(1 << slot);
2849                         ci_masked &= ~(1 << slot);
2850                 }
2851
2852                 /*
2853                  * Clear bits in ci_saved (cause completions to be run)
2854                  * for all slots which are not active.
2855                  */
2856                 ci_saved &= ~*active;
2857
2858                 /*
2859                  * Don't restart the port if our problems were deemed fatal.
2860                  *
2861                  * Also acknowlege all fatal interrupt sources to prevent
2862                  * a livelock.
2863                  */
2864                 if (ap->ap_state == AP_S_FATAL_ERROR) {
2865                         if (need == NEED_RESTART)
2866                                 need = NEED_NOTHING;
2867                         ahci_pwrite(ap, AHCI_PREG_IS,
2868                                     AHCI_PREG_IS_TFES | AHCI_PREG_IS_HBFS |
2869                                     AHCI_PREG_IS_IFS | AHCI_PREG_IS_OFS |
2870                                     AHCI_PREG_IS_UFS);
2871                 }
2872         }
2873
2874         /*
2875          * If we are stopped the AHCI chipset is supposed to have cleared
2876          * CI and SACT.  Did it?  If it didn't we try very hard to clear
2877          * the fields otherwise we may end up completing CCBs which are
2878          * actually still active.
2879          *
2880          * IFS errors on (at least) AMD chipsets create this confusion.
2881          */
2882         if (stopped) {
2883                 u_int32_t mask;
2884                 if ((mask = ahci_pactive(ap)) != 0) {
2885                         kprintf("%s: chipset failed to clear "
2886                                 "active cmds %08x\n",
2887                                 PORTNAME(ap), mask);
2888                         ahci_port_start(ap);
2889                         ahci_port_stop(ap, 0);
2890                         if ((mask = ahci_pactive(ap)) != 0) {
2891                                 kprintf("%s: unable to prod the chip into "
2892                                         "clearing active cmds %08x\n",
2893                                         PORTNAME(ap), mask);
2894                                 /* what do we do now? */
2895                         }
2896                 }
2897         }
2898
2899         /*
2900          * CCB completion (non blocking).
2901          *
2902          * CCB completion is detected by noticing its slot's bit in CI has
2903          * changed to zero some time after we activated it.
2904          * If we are polling, we may only be interested in particular slot(s).
2905          *
2906          * Any active bits not saved are completed within the restrictions
2907          * imposed by the caller.
2908          */
2909         ci_masked = ~ci_saved & *active;
2910         while (ci_masked) {
2911                 slot = ffs(ci_masked) - 1;
2912                 ccb = &ap->ap_ccbs[slot];
2913                 ci_masked &= ~(1 << slot);
2914
2915                 DPRINTF(AHCI_D_INTR, "%s: slot %d is complete%s\n",
2916                     PORTNAME(ap), slot, ccb->ccb_xa.state == ATA_S_ERROR ?
2917                     " (error)" : "");
2918
2919                 bus_dmamap_sync(sc->sc_tag_cmdh,
2920                                 AHCI_DMA_MAP(ap->ap_dmamem_cmd_list),
2921                                 BUS_DMASYNC_POSTWRITE);
2922
2923                 bus_dmamap_sync(sc->sc_tag_cmdt,
2924                                 AHCI_DMA_MAP(ap->ap_dmamem_cmd_table),
2925                                 BUS_DMASYNC_POSTWRITE);
2926
2927                 bus_dmamap_sync(sc->sc_tag_rfis,
2928                                 AHCI_DMA_MAP(ap->ap_dmamem_rfis),
2929                                 BUS_DMASYNC_POSTREAD);
2930
2931                 *active &= ~(1 << ccb->ccb_slot);
2932                 if (active == &ap->ap_active) {
2933                         KKASSERT(ap->ap_active_cnt > 0);
2934                         --ap->ap_active_cnt;
2935                 }
2936
2937                 /*
2938                  * Complete the ccb.  If the ccb was marked expired it
2939                  * was probably already removed from the command processor,
2940                  * so don't take the clear ci_saved bit as meaning the
2941                  * command actually succeeded, it didn't.
2942                  */
2943                 if (ap->ap_expired & (1 << ccb->ccb_slot)) {
2944                         ap->ap_expired &= ~(1 << ccb->ccb_slot);
2945                         ccb->ccb_xa.state = ATA_S_TIMEOUT;
2946                         ccb->ccb_done(ccb);
2947                         ccb->ccb_xa.complete(&ccb->ccb_xa);
2948                 } else {
2949                         if (ccb->ccb_xa.state == ATA_S_ONCHIP) {
2950                                 ccb->ccb_xa.state = ATA_S_COMPLETE;
2951                                 if (ccb->ccb_xa.flags & ATA_F_AUTOSENSE) {
2952                                         memcpy(&ccb->ccb_xa.rfis,
2953                                             ap->ap_rfis->rfis,
2954                                             sizeof(struct ata_fis_d2h));
2955                                         if (ccb->ccb_xa.state == ATA_S_TIMEOUT)
2956                                                 ccb->ccb_xa.state = ATA_S_ERROR;
2957                                 }
2958                         }
2959                         ccb->ccb_done(ccb);
2960                 }
2961         }
2962
2963         /*
2964          * Cleanup.  Will not be set if non-blocking.
2965          */
2966         switch(need) {
2967         case NEED_NOTHING:
2968                 /*
2969                  * If operating normally and not stopped the interrupt was
2970                  * probably just a normal completion and we may be able to
2971                  * issue more commands.
2972                  */
2973                 if (stopped == 0 && ap->ap_state != AP_S_FATAL_ERROR)
2974                         ahci_issue_pending_commands(ap, NULL);
2975                 break;
2976         case NEED_RESTART:
2977                 /*
2978                  * A recoverable error occured and we can restart outstanding
2979                  * commands on the port.
2980                  */
2981                 ci_saved &= ~ap->ap_expired;
2982                 if (ci_saved) {
2983                         kprintf("%s: Restart %08x\n", PORTNAME(ap), ci_saved);
2984                         ahci_issue_saved_commands(ap, ci_saved);
2985                 }
2986
2987                 /*
2988                  * Potentially issue new commands if not in a failed
2989                  * state.
2990                  */
2991                 if (ap->ap_state != AP_S_FATAL_ERROR) {
2992                         ahci_port_start(ap);
2993                         ahci_issue_pending_commands(ap, NULL);
2994                 }
2995                 break;
2996         case NEED_REINIT:
2997                 /*
2998                  * Something horrible happened to the port and we
2999                  * need to reinitialize it.
3000                  */
3001                 kprintf("%s: REINIT - Attempting to reinitialize the port "
3002                         "after it had a horrible accident\n",
3003                         PORTNAME(ap));
3004                 ap->ap_flags |= AP_F_IN_RESET;
3005                 ap->ap_flags |= AP_F_HARSH_REINIT;
3006                 ap->ap_probe = ATA_PROBE_NEED_INIT;
3007                 ahci_cam_changed(ap, NULL, -1);
3008                 break;
3009         case NEED_HOTPLUG_INSERT:
3010                 /*
3011                  * A hot-plug insertion event has occured and all
3012                  * outstanding commands have already been revoked.
3013                  *
3014                  * Don't recurse if this occurs while we are
3015                  * resetting the port.
3016                  */
3017                 if ((ap->ap_flags & AP_F_IN_RESET) == 0) {
3018                         kprintf("%s: HOTPLUG - Device inserted\n",
3019                                 PORTNAME(ap));
3020                         ap->ap_probe = ATA_PROBE_NEED_INIT;
3021                         ahci_cam_changed(ap, NULL, -1);
3022                 }
3023                 break;
3024         case NEED_HOTPLUG_REMOVE:
3025                 /*
3026                  * A hot-plug removal event has occured and all
3027                  * outstanding commands have already been revoked.
3028                  *
3029                  * Don't recurse if this occurs while we are
3030                  * resetting the port.
3031                  */
3032                 if ((ap->ap_flags & AP_F_IN_RESET) == 0) {
3033                         kprintf("%s: HOTPLUG - Device removed\n",
3034                                 PORTNAME(ap));
3035                         ahci_port_hardstop(ap);
3036                         /* ap_probe set to failed */
3037                         ahci_cam_changed(ap, NULL, -1);
3038                 }
3039                 break;
3040         default:
3041                 break;
3042         }
3043 }
3044
3045 struct ahci_ccb *
3046 ahci_get_ccb(struct ahci_port *ap)
3047 {
3048         struct ahci_ccb                 *ccb;
3049
3050         lockmgr(&ap->ap_ccb_lock, LK_EXCLUSIVE);
3051         ccb = TAILQ_FIRST(&ap->ap_ccb_free);
3052         if (ccb != NULL) {
3053                 KKASSERT(ccb->ccb_xa.state == ATA_S_PUT);
3054                 TAILQ_REMOVE(&ap->ap_ccb_free, ccb, ccb_entry);
3055                 ccb->ccb_xa.state = ATA_S_SETUP;
3056                 ccb->ccb_xa.flags = 0;
3057                 ccb->ccb_xa.at = NULL;
3058         }
3059         lockmgr(&ap->ap_ccb_lock, LK_RELEASE);
3060
3061         return (ccb);
3062 }
3063
3064 void
3065 ahci_put_ccb(struct ahci_ccb *ccb)
3066 {
3067         struct ahci_port                *ap = ccb->ccb_port;
3068
3069         ccb->ccb_xa.state = ATA_S_PUT;
3070         lockmgr(&ap->ap_ccb_lock, LK_EXCLUSIVE);
3071         TAILQ_INSERT_TAIL(&ap->ap_ccb_free, ccb, ccb_entry);
3072         lockmgr(&ap->ap_ccb_lock, LK_RELEASE);
3073 }
3074
3075 struct ahci_ccb *
3076 ahci_get_err_ccb(struct ahci_port *ap)
3077 {
3078         struct ahci_ccb *err_ccb;
3079         u_int32_t sact;
3080         u_int32_t ci;
3081
3082         /* No commands may be active on the chip. */
3083
3084         if (ap->ap_sc->sc_cap & AHCI_REG_CAP_SNCQ) {
3085                 sact = ahci_pread(ap, AHCI_PREG_SACT);
3086                 if (sact != 0) {
3087                         kprintf("%s: ahci_get_err_ccb but SACT %08x != 0?\n",
3088                                 PORTNAME(ap), sact);
3089                 }
3090         }
3091         ci = ahci_pread(ap, AHCI_PREG_CI);
3092         if (ci) {
3093                 kprintf("%s: ahci_get_err_ccb: ci not 0 (%08x)\n",
3094                         ap->ap_name, ci);
3095         }
3096         KKASSERT(ci == 0);
3097         KKASSERT((ap->ap_flags & AP_F_ERR_CCB_RESERVED) == 0);
3098         ap->ap_flags |= AP_F_ERR_CCB_RESERVED;
3099
3100         /* Save outstanding command state. */
3101         ap->ap_err_saved_active = ap->ap_active;
3102         ap->ap_err_saved_active_cnt = ap->ap_active_cnt;
3103         ap->ap_err_saved_sactive = ap->ap_sactive;
3104
3105         /*
3106          * Pretend we have no commands outstanding, so that completions won't
3107          * run prematurely.
3108          */
3109         ap->ap_active = ap->ap_active_cnt = ap->ap_sactive = 0;
3110
3111         /*
3112          * Grab a CCB to use for error recovery.  This should never fail, as
3113          * we ask atascsi to reserve one for us at init time.
3114          */
3115         err_ccb = ap->ap_err_ccb;
3116         KKASSERT(err_ccb != NULL);
3117         err_ccb->ccb_xa.flags = 0;
3118         err_ccb->ccb_done = ahci_empty_done;
3119
3120         return err_ccb;
3121 }
3122
3123 void
3124 ahci_put_err_ccb(struct ahci_ccb *ccb)
3125 {
3126         struct ahci_port *ap = ccb->ccb_port;
3127         u_int32_t sact;
3128         u_int32_t ci;
3129
3130         KKASSERT((ap->ap_flags & AP_F_ERR_CCB_RESERVED) != 0);
3131
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) {
3138                         panic("ahci_port_err_ccb(%d) but SACT %08x != 0\n",
3139                               ccb->ccb_slot, sact);
3140                 }
3141         }
3142         ci = ahci_pread(ap, AHCI_PREG_CI);
3143         if (ci) {
3144                 panic("ahci_put_err_ccb(%d) but CI %08x != 0 "
3145                       "(act=%08x sact=%08x)\n",
3146                       ccb->ccb_slot, ci,
3147                       ap->ap_active, ap->ap_sactive);
3148         }
3149
3150         KKASSERT(ccb == ap->ap_err_ccb);
3151
3152         /* Restore outstanding command state */
3153         ap->ap_sactive = ap->ap_err_saved_sactive;
3154         ap->ap_active_cnt = ap->ap_err_saved_active_cnt;
3155         ap->ap_active = ap->ap_err_saved_active;
3156
3157         ap->ap_flags &= ~AP_F_ERR_CCB_RESERVED;
3158 }
3159
3160 /*
3161  * Read log page to get NCQ error.
3162  *
3163  * NOTE: NCQ not currently supported on port multipliers. XXX
3164  */
3165 int
3166 ahci_port_read_ncq_error(struct ahci_port *ap, int target)
3167 {
3168         struct ata_log_page_10h *log;
3169         struct ahci_ccb         *ccb;
3170         struct ahci_ccb         *ccb2;
3171         struct ahci_cmd_hdr     *cmd_slot;
3172         struct ata_fis_h2d      *fis;
3173         int                     err_slot;
3174
3175         if (bootverbose) {
3176                 kprintf("%s: READ LOG PAGE target %d\n", PORTNAME(ap),
3177                         target);
3178         }
3179
3180         /*
3181          * Prep error CCB for READ LOG EXT, page 10h, 1 sector.
3182          *
3183          * Getting err_ccb clears active/sactive/active_cnt, putting
3184          * it back restores the fields.
3185          */
3186         ccb = ahci_get_err_ccb(ap);
3187         ccb->ccb_xa.flags = ATA_F_READ | ATA_F_POLL;
3188         ccb->ccb_xa.data = ap->ap_err_scratch;
3189         ccb->ccb_xa.datalen = 512;
3190         ccb->ccb_xa.complete = ahci_dummy_done;
3191         ccb->ccb_xa.at = ap->ap_ata[target];
3192
3193         fis = (struct ata_fis_h2d *)ccb->ccb_cmd_table->cfis;
3194         bzero(fis, sizeof(*fis));
3195         fis->type = ATA_FIS_TYPE_H2D;
3196         fis->flags = ATA_H2D_FLAGS_CMD | target;
3197         fis->command = ATA_C_READ_LOG_EXT;
3198         fis->lba_low = 0x10;            /* queued error log page (10h) */
3199         fis->sector_count = 1;          /* number of sectors (1) */
3200         fis->sector_count_exp = 0;
3201         fis->lba_mid = 0;               /* starting offset */
3202         fis->lba_mid_exp = 0;
3203         fis->device = 0;
3204
3205         cmd_slot = ccb->ccb_cmd_hdr;
3206         cmd_slot->flags = htole16(5);   /* FIS length: 5 DWORDS */
3207
3208         if (ahci_load_prdt(ccb) != 0) {
3209                 err_slot = -1;
3210                 goto err;
3211         }
3212
3213         ccb->ccb_xa.state = ATA_S_PENDING;
3214         if (ahci_poll(ccb, 1000, ahci_quick_timeout) != ATA_S_COMPLETE) {
3215                 err_slot = -1;
3216                 ahci_unload_prdt(ccb);
3217                 goto err;
3218         }
3219         ahci_unload_prdt(ccb);
3220
3221         /*
3222          * Success, extract failed register set and tags from the scratch
3223          * space.
3224          */
3225         log = (struct ata_log_page_10h *)ap->ap_err_scratch;
3226         if (log->err_regs.type & ATA_LOG_10H_TYPE_NOTQUEUED) {
3227                 /* Not queued bit was set - wasn't an NCQ error? */
3228                 kprintf("%s: read NCQ error page, but not an NCQ error?\n",
3229                         PORTNAME(ap));
3230                 err_slot = -1;
3231         } else {
3232                 /* Copy back the log record as a D2H register FIS. */
3233                 err_slot = log->err_regs.type & ATA_LOG_10H_TYPE_TAG_MASK;
3234
3235                 ccb2 = &ap->ap_ccbs[err_slot];
3236                 if (ccb2->ccb_xa.state == ATA_S_ONCHIP) {
3237                         kprintf("%s: read NCQ error page slot=%d\n",
3238                                 ATANAME(ap, ccb2->ccb_xa.at),
3239                                 err_slot);
3240                         memcpy(&ccb2->ccb_xa.rfis, &log->err_regs,
3241                                 sizeof(struct ata_fis_d2h));
3242                         ccb2->ccb_xa.rfis.type = ATA_FIS_TYPE_D2H;
3243                         ccb2->ccb_xa.rfis.flags = 0;
3244                 } else {
3245                         kprintf("%s: read NCQ error page slot=%d, "
3246                                 "slot does not match any cmds\n",
3247                                 ATANAME(ccb2->ccb_port, ccb2->ccb_xa.at),
3248                                 err_slot);
3249                         err_slot = -1;
3250                 }
3251         }
3252 err:
3253         ahci_put_err_ccb(ccb);
3254         kprintf("%s: DONE log page target %d err_slot=%d\n",
3255                 PORTNAME(ap), target, err_slot);
3256         return (err_slot);
3257 }
3258
3259 /*
3260  * Allocate memory for various structures DMAd by hardware.  The maximum
3261  * number of segments for these tags is 1 so the DMA memory will have a
3262  * single physical base address.
3263  */
3264 struct ahci_dmamem *
3265 ahci_dmamem_alloc(struct ahci_softc *sc, bus_dma_tag_t tag)
3266 {
3267         struct ahci_dmamem *adm;
3268         int     error;
3269
3270         adm = kmalloc(sizeof(*adm), M_DEVBUF, M_INTWAIT | M_ZERO);
3271
3272         error = bus_dmamem_alloc(tag, (void **)&adm->adm_kva,
3273                                  BUS_DMA_ZERO, &adm->adm_map);
3274         if (error == 0) {
3275                 adm->adm_tag = tag;
3276                 error = bus_dmamap_load(tag, adm->adm_map,
3277                                         adm->adm_kva,
3278                                         bus_dma_tag_getmaxsize(tag),
3279                                         ahci_dmamem_saveseg, &adm->adm_busaddr,
3280                                         0);
3281         }
3282         if (error) {
3283                 if (adm->adm_map) {
3284                         bus_dmamap_destroy(tag, adm->adm_map);
3285                         adm->adm_map = NULL;
3286                         adm->adm_tag = NULL;
3287                         adm->adm_kva = NULL;
3288                 }
3289                 kfree(adm, M_DEVBUF);
3290                 adm = NULL;
3291         }
3292         return (adm);
3293 }
3294
3295 static
3296 void
3297 ahci_dmamem_saveseg(void *info, bus_dma_segment_t *segs, int nsegs, int error)
3298 {
3299         KKASSERT(error == 0);
3300         KKASSERT(nsegs == 1);
3301         *(bus_addr_t *)info = segs->ds_addr;
3302 }
3303
3304
3305 void
3306 ahci_dmamem_free(struct ahci_softc *sc, struct ahci_dmamem *adm)
3307 {
3308         if (adm->adm_map) {
3309                 bus_dmamap_unload(adm->adm_tag, adm->adm_map);
3310                 bus_dmamap_destroy(adm->adm_tag, adm->adm_map);
3311                 adm->adm_map = NULL;
3312                 adm->adm_tag = NULL;
3313                 adm->adm_kva = NULL;
3314         }
3315         kfree(adm, M_DEVBUF);
3316 }
3317
3318 u_int32_t
3319 ahci_read(struct ahci_softc *sc, bus_size_t r)
3320 {
3321         bus_space_barrier(sc->sc_iot, sc->sc_ioh, r, 4,
3322                           BUS_SPACE_BARRIER_READ);
3323         return (bus_space_read_4(sc->sc_iot, sc->sc_ioh, r));
3324 }
3325
3326 void
3327 ahci_write(struct ahci_softc *sc, bus_size_t r, u_int32_t v)
3328 {
3329         bus_space_write_4(sc->sc_iot, sc->sc_ioh, r, v);
3330         bus_space_barrier(sc->sc_iot, sc->sc_ioh, r, 4,
3331                           BUS_SPACE_BARRIER_WRITE);
3332 }
3333
3334 u_int32_t
3335 ahci_pread(struct ahci_port *ap, bus_size_t r)
3336 {
3337         bus_space_barrier(ap->ap_sc->sc_iot, ap->ap_ioh, r, 4,
3338                           BUS_SPACE_BARRIER_READ);
3339         return (bus_space_read_4(ap->ap_sc->sc_iot, ap->ap_ioh, r));
3340 }
3341
3342 void
3343 ahci_pwrite(struct ahci_port *ap, bus_size_t r, u_int32_t v)
3344 {
3345         bus_space_write_4(ap->ap_sc->sc_iot, ap->ap_ioh, r, v);
3346         bus_space_barrier(ap->ap_sc->sc_iot, ap->ap_ioh, r, 4,
3347                           BUS_SPACE_BARRIER_WRITE);
3348 }
3349
3350 /*
3351  * Wait up to (timeout) milliseconds for the masked port register to
3352  * match the target.
3353  *
3354  * Timeout is in milliseconds.
3355  */
3356 int
3357 ahci_pwait_eq(struct ahci_port *ap, int timeout,
3358               bus_size_t r, u_int32_t mask, u_int32_t target)
3359 {
3360         int     t;
3361
3362         /*
3363          * Loop hard up to 100uS
3364          */
3365         for (t = 0; t < 100; ++t) {
3366                 if ((ahci_pread(ap, r) & mask) == target)
3367                         return (0);
3368                 ahci_os_hardsleep(1);   /* us */
3369         }
3370
3371         do {
3372                 timeout -= ahci_os_softsleep();
3373                 if ((ahci_pread(ap, r) & mask) == target)
3374                         return (0);
3375         } while (timeout > 0);
3376         return (1);
3377 }
3378
3379 int
3380 ahci_wait_ne(struct ahci_softc *sc, bus_size_t r, u_int32_t mask,
3381              u_int32_t target)
3382 {
3383         int     t;
3384
3385         /*
3386          * Loop hard up to 100uS
3387          */
3388         for (t = 0; t < 100; ++t) {
3389                 if ((ahci_read(sc, r) & mask) != target)
3390                         return (0);
3391                 ahci_os_hardsleep(1);   /* us */
3392         }
3393
3394         /*
3395          * And one millisecond the slow way
3396          */
3397         t = 1000;
3398         do {
3399                 t -= ahci_os_softsleep();
3400                 if ((ahci_read(sc, r) & mask) != target)
3401                         return (0);
3402         } while (t > 0);
3403
3404         return (1);
3405 }
3406
3407
3408 /*
3409  * Acquire an ata transfer.
3410  *
3411  * Pass a NULL at for direct-attached transfers, and a non-NULL at for
3412  * targets that go through the port multiplier.
3413  */
3414 struct ata_xfer *
3415 ahci_ata_get_xfer(struct ahci_port *ap, struct ata_port *at)
3416 {
3417         struct ahci_ccb         *ccb;
3418
3419         ccb = ahci_get_ccb(ap);
3420         if (ccb == NULL) {
3421                 DPRINTF(AHCI_D_XFER, "%s: ahci_ata_get_xfer: NULL ccb\n",
3422                     PORTNAME(ap));
3423                 return (NULL);
3424         }
3425
3426         DPRINTF(AHCI_D_XFER, "%s: ahci_ata_get_xfer got slot %d\n",
3427             PORTNAME(ap), ccb->ccb_slot);
3428
3429         bzero(ccb->ccb_xa.fis, sizeof(*ccb->ccb_xa.fis));
3430         ccb->ccb_xa.at = at;
3431         ccb->ccb_xa.fis->type = ATA_FIS_TYPE_H2D;
3432
3433         return (&ccb->ccb_xa);
3434 }
3435
3436 void
3437 ahci_ata_put_xfer(struct ata_xfer *xa)
3438 {
3439         struct ahci_ccb                 *ccb = (struct ahci_ccb *)xa;
3440
3441         DPRINTF(AHCI_D_XFER, "ahci_ata_put_xfer slot %d\n", ccb->ccb_slot);
3442
3443         ahci_put_ccb(ccb);
3444 }
3445
3446 int
3447 ahci_ata_cmd(struct ata_xfer *xa)
3448 {
3449         struct ahci_ccb                 *ccb = (struct ahci_ccb *)xa;
3450         struct ahci_cmd_hdr             *cmd_slot;
3451
3452         KKASSERT(xa->state == ATA_S_SETUP);
3453
3454         if (ccb->ccb_port->ap_state == AP_S_FATAL_ERROR)
3455                 goto failcmd;
3456         ccb->ccb_done = ahci_ata_cmd_done;
3457
3458         cmd_slot = ccb->ccb_cmd_hdr;
3459         cmd_slot->flags = htole16(5); /* FIS length (in DWORDs) */
3460         if (ccb->ccb_xa.at) {
3461                 cmd_slot->flags |= htole16(ccb->ccb_xa.at->at_target <<
3462                                            AHCI_CMD_LIST_FLAG_PMP_SHIFT);
3463         }
3464
3465         if (xa->flags & ATA_F_WRITE)
3466                 cmd_slot->flags |= htole16(AHCI_CMD_LIST_FLAG_W);
3467
3468         if (xa->flags & ATA_F_PACKET)
3469                 cmd_slot->flags |= htole16(AHCI_CMD_LIST_FLAG_A);
3470
3471         if (ahci_load_prdt(ccb) != 0)
3472                 goto failcmd;
3473
3474         xa->state = ATA_S_PENDING;
3475
3476         if (xa->flags & ATA_F_POLL)
3477                 return (ahci_poll(ccb, xa->timeout, ahci_ata_cmd_timeout));
3478
3479         crit_enter();
3480         KKASSERT((xa->flags & ATA_F_TIMEOUT_EXPIRED) == 0);
3481         xa->flags |= ATA_F_TIMEOUT_DESIRED;
3482         ahci_start(ccb);
3483         crit_exit();
3484         return (xa->state);
3485
3486 failcmd:
3487         crit_enter();
3488         xa->state = ATA_S_ERROR;
3489         xa->complete(xa);
3490         crit_exit();
3491         return (ATA_S_ERROR);
3492 }
3493
3494 void
3495 ahci_ata_cmd_done(struct ahci_ccb *ccb)
3496 {
3497         struct ata_xfer                 *xa = &ccb->ccb_xa;
3498
3499         /*
3500          * NOTE: callout does not lock port and may race us modifying
3501          * the flags, so make sure its stopped.
3502          */
3503         if (xa->flags & ATA_F_TIMEOUT_RUNNING) {
3504                 callout_stop(&ccb->ccb_timeout);
3505                 xa->flags &= ~ATA_F_TIMEOUT_RUNNING;
3506         }
3507         xa->flags &= ~(ATA_F_TIMEOUT_DESIRED | ATA_F_TIMEOUT_EXPIRED);
3508
3509         KKASSERT(xa->state != ATA_S_ONCHIP);
3510         ahci_unload_prdt(ccb);
3511
3512         if (xa->state != ATA_S_TIMEOUT)
3513                 xa->complete(xa);
3514 }
3515
3516 /*
3517  * Timeout from callout, MPSAFE - nothing can mess with the CCB's flags
3518  * while the callout is runing.
3519  *
3520  * We can't safely get the port lock here or delay, we could block
3521  * the callout thread.
3522  */
3523 static void
3524 ahci_ata_cmd_timeout_unserialized(void *arg)
3525 {
3526         struct ahci_ccb         *ccb = arg;
3527         struct ahci_port        *ap = ccb->ccb_port;
3528
3529         ccb->ccb_xa.flags &= ~ATA_F_TIMEOUT_RUNNING;
3530         ccb->ccb_xa.flags |= ATA_F_TIMEOUT_EXPIRED;
3531         ahci_os_signal_port_thread(ap, AP_SIGF_TIMEOUT);
3532 }
3533
3534 /*
3535  * Timeout code, typically called when the port command processor is running.
3536  *
3537  * We have to be very very careful here.  We cannot stop the port unless
3538  * CR is already clear or the only active commands remaining are timed-out
3539  * ones.  Otherwise stopping the port will race the command processor and
3540  * we can lose events.  While we can theoretically just restart everything
3541  * that could result in a double-issue which will not work for ATAPI commands.
3542  */
3543 void
3544 ahci_ata_cmd_timeout(struct ahci_ccb *ccb)
3545 {
3546         struct ata_xfer         *xa = &ccb->ccb_xa;
3547         struct ahci_port        *ap = ccb->ccb_port;
3548         struct ata_port         *at;
3549         u_int32_t               ci_saved;
3550         u_int32_t               mask;
3551         int                     slot;
3552
3553         at = ccb->ccb_xa.at;
3554
3555         kprintf("%s: CMD TIMEOUT state=%d slot=%d\n"
3556                 "\tcmd-reg 0x%b\n"
3557                 "\tsactive=%08x active=%08x expired=%08x\n"
3558                 "\t   sact=%08x     ci=%08x\n"
3559                 "\t    STS=%b\n",
3560                 ATANAME(ap, at),
3561                 ccb->ccb_xa.state, ccb->ccb_slot,
3562                 ahci_pread(ap, AHCI_PREG_CMD), AHCI_PFMT_CMD,
3563                 ap->ap_sactive, ap->ap_active, ap->ap_expired,
3564                 ahci_pread(ap, AHCI_PREG_SACT),
3565                 ahci_pread(ap, AHCI_PREG_CI),
3566                 ahci_pread(ap, AHCI_PREG_TFD), AHCI_PFMT_TFD_STS
3567         );
3568
3569
3570         /*
3571          * NOTE: Timeout will not be running if the command was polled.
3572          *       If we got here at least one of these flags should be set.
3573          */
3574         KKASSERT(xa->flags & (ATA_F_POLL | ATA_F_TIMEOUT_DESIRED |
3575                               ATA_F_TIMEOUT_RUNNING));
3576         xa->flags &= ~(ATA_F_TIMEOUT_RUNNING | ATA_F_TIMEOUT_EXPIRED);
3577
3578         if (ccb->ccb_xa.state == ATA_S_PENDING) {
3579                 TAILQ_REMOVE(&ap->ap_ccb_pending, ccb, ccb_entry);
3580                 ccb->ccb_xa.state = ATA_S_TIMEOUT;
3581                 ccb->ccb_done(ccb);
3582                 xa->complete(xa);
3583                 ahci_issue_pending_commands(ap, NULL);
3584                 return;
3585         }
3586         if (ccb->ccb_xa.state != ATA_S_ONCHIP) {
3587                 kprintf("%s: Unexpected state during timeout: %d\n",
3588                         ATANAME(ap, at), ccb->ccb_xa.state);
3589                 return;
3590         }
3591
3592         /*
3593          * Ok, we can only get this command off the chip if CR is inactive
3594          * or if the only commands running on the chip are all expired.
3595          * Otherwise we have to wait until the port is in a safe state.
3596          *
3597          * Do not set state here, it will cause polls to return when the
3598          * ccb is not yet off the chip.
3599          */
3600         ap->ap_expired |= 1 << ccb->ccb_slot;
3601
3602         if ((ahci_pread(ap, AHCI_PREG_CMD) & AHCI_PREG_CMD_CR) &&
3603             (ap->ap_active | ap->ap_sactive) != ap->ap_expired) {
3604                 /*
3605                  * If using FBSS or NCQ we can't safely stop the port
3606                  * right now.
3607                  */
3608                 kprintf("%s: Deferred timeout until its safe, slot %d\n",
3609                         ATANAME(ap, at), ccb->ccb_slot);
3610                 return;
3611         }
3612
3613         /*
3614          * We can safely stop the port and process all expired ccb's,
3615          * which will include our current ccb.
3616          */
3617         ci_saved = (ap->ap_sactive) ? ahci_pread(ap, AHCI_PREG_SACT) :
3618                                       ahci_pread(ap, AHCI_PREG_CI);
3619         ahci_port_stop(ap, 0);
3620
3621         while (ap->ap_expired) {
3622                 slot = ffs(ap->ap_expired) - 1;
3623                 ap->ap_expired &= ~(1 << slot);
3624                 ci_saved &= ~(1 << slot);
3625                 ccb = &ap->ap_ccbs[slot];
3626                 ccb->ccb_xa.state = ATA_S_TIMEOUT;
3627                 if (ccb->ccb_xa.flags & ATA_F_NCQ) {
3628                         KKASSERT(ap->ap_sactive & (1 << slot));
3629                         ap->ap_sactive &= ~(1 << slot);
3630                 } else {
3631                         KKASSERT(ap->ap_active & (1 << slot));
3632                         ap->ap_active &= ~(1 << slot);
3633                         --ap->ap_active_cnt;
3634                 }
3635                 ccb->ccb_done(ccb);
3636                 ccb->ccb_xa.complete(&ccb->ccb_xa);
3637         }
3638         /* ccb invalid now */
3639
3640         /*
3641          * We can safely CLO the port to clear any BSY/DRQ, a case which
3642          * can occur with port multipliers.  This will unbrick the port
3643          * and allow commands to other targets behind the PM continue.
3644          * (FBSS).
3645          *
3646          * Finally, once the port has been restarted we can issue any
3647          * previously saved pending commands, and run the port interrupt
3648          * code to handle any completions which may have occured when
3649          * we saved CI.
3650          */
3651         if (ahci_pread(ap, AHCI_PREG_TFD) &
3652                    (AHCI_PREG_TFD_STS_BSY | AHCI_PREG_TFD_STS_DRQ)) {
3653                 kprintf("%s: Warning, issuing CLO after timeout\n",
3654                         ATANAME(ap, at));
3655                 ahci_port_clo(ap);
3656         }
3657         ahci_port_start(ap);
3658
3659         /*
3660          * We absolutely must make sure the chipset cleared activity on
3661          * all slots.  This sometimes might not happen due to races with
3662          * a chipset interrupt which stops the port before we can manage
3663          * to.  For some reason some chipsets don't clear the active
3664          * commands when we turn off CMD_ST after the chip has stopped
3665          * operations itself.
3666          */
3667         if (ahci_pactive(ap) != 0) {
3668                 ahci_port_stop(ap, 0);
3669                 ahci_port_start(ap);
3670                 if ((mask = ahci_pactive(ap)) != 0) {
3671                         kprintf("%s: quick-timeout: chipset failed "
3672                                 "to clear active cmds %08x\n",
3673                                 PORTNAME(ap), mask);
3674                 }
3675         }
3676         ahci_issue_saved_commands(ap, ci_saved & ~ap->ap_expired);
3677         ahci_issue_pending_commands(ap, NULL);
3678         ahci_port_intr(ap, 0);
3679 }
3680
3681 /*
3682  * Issue a previously saved set of commands
3683  */
3684 void
3685 ahci_issue_saved_commands(struct ahci_port *ap, u_int32_t ci_saved)
3686 {
3687         if (ci_saved) {
3688                 KKASSERT(!((ap->ap_active & ci_saved) &&
3689                            (ap->ap_sactive & ci_saved)));
3690                 KKASSERT((ci_saved & ap->ap_expired) == 0);
3691                 if (ap->ap_sactive & ci_saved)
3692                         ahci_pwrite(ap, AHCI_PREG_SACT, ci_saved);
3693                 ahci_pwrite(ap, AHCI_PREG_CI, ci_saved);
3694         }
3695 }
3696
3697 /*
3698  * Used by the softreset, pmprobe, and read_ncq_error only, in very
3699  * specialized, controlled circumstances.
3700  *
3701  * Only one command may be pending.
3702  */
3703 void
3704 ahci_quick_timeout(struct ahci_ccb *ccb)
3705 {
3706         struct ahci_port *ap = ccb->ccb_port;
3707         u_int32_t mask;
3708
3709         switch (ccb->ccb_xa.state) {
3710         case ATA_S_PENDING:
3711                 TAILQ_REMOVE(&ap->ap_ccb_pending, ccb, ccb_entry);
3712                 ccb->ccb_xa.state = ATA_S_TIMEOUT;
3713                 break;
3714         case ATA_S_ONCHIP:
3715                 /*
3716                  * We have to clear the command on-chip.
3717                  */
3718                 KKASSERT(ap->ap_active == (1 << ccb->ccb_slot) &&
3719                          ap->ap_sactive == 0);
3720                 ahci_port_stop(ap, 0);
3721                 ahci_port_start(ap);
3722                 if (ahci_pactive(ap) != 0) {
3723                         ahci_port_stop(ap, 0);
3724                         ahci_port_start(ap);
3725                         if ((mask = ahci_pactive(ap)) != 0) {
3726                                 kprintf("%s: quick-timeout: chipset failed "
3727                                         "to clear active cmds %08x\n",
3728                                         PORTNAME(ap), mask);
3729                         }
3730                 }
3731
3732                 ccb->ccb_xa.state = ATA_S_TIMEOUT;
3733                 ap->ap_active &= ~(1 << ccb->ccb_slot);
3734                 KKASSERT(ap->ap_active_cnt > 0);
3735                 --ap->ap_active_cnt;
3736                 break;
3737         default:
3738                 panic("%s: ahci_quick_timeout: ccb in bad state %d",
3739                       ATANAME(ap, ccb->ccb_xa.at), ccb->ccb_xa.state);
3740         }
3741 }
3742
3743 static void
3744 ahci_dummy_done(struct ata_xfer *xa)
3745 {
3746 }
3747
3748 static void
3749 ahci_empty_done(struct ahci_ccb *ccb)
3750 {
3751 }
3752
3753 int
3754 ahci_set_feature(struct ahci_port *ap, struct ata_port *atx,
3755                  int feature, int enable)
3756 {
3757         struct ata_port *at;
3758         struct ata_xfer *xa;
3759         int error;
3760
3761         at = atx ? atx : ap->ap_ata[0];
3762
3763         xa = ahci_ata_get_xfer(ap, atx);
3764
3765         xa->fis->type = ATA_FIS_TYPE_H2D;
3766         xa->fis->flags = ATA_H2D_FLAGS_CMD | at->at_target;
3767         xa->fis->command = ATA_C_SET_FEATURES;
3768         xa->fis->features = enable ? ATA_C_SATA_FEATURE_ENA :
3769                                      ATA_C_SATA_FEATURE_DIS;
3770         xa->fis->sector_count = feature;
3771         xa->fis->control = ATA_FIS_CONTROL_4BIT;
3772
3773         xa->complete = ahci_dummy_done;
3774         xa->datalen = 0;
3775         xa->flags = ATA_F_POLL;
3776         xa->timeout = 1000;
3777
3778         if (ahci_ata_cmd(xa) == ATA_S_COMPLETE)
3779                 error = 0;
3780         else
3781                 error = EIO;
3782         ahci_ata_put_xfer(xa);
3783         return(error);
3784 }