2 * Copyright (c) 2009 The DragonFly Project. All rights reserved.
4 * This code is derived from software contributed to The DragonFly Project
5 * by Matthew Dillon <dillon@backplane.com>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * 3. Neither the name of The DragonFly Project nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific, prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 static void sili_pm_dummy_done(struct ata_xfer *xa);
38 static void sili_pm_empty_done(struct sili_ccb *ccb);
41 * This is called for PM attachments and hot-plug insertion events, and
42 * typically not called again until after an unplug/replug sequence.
44 * We just fall through to the hard-reset code, we don't need to
45 * set up any initial conditions.
48 sili_pm_port_init(struct sili_port *ap, struct ata_port *at)
50 at->at_probe = ATA_PROBE_NEED_HARD_RESET;
55 * This is called from the port hardreset code.
58 sili_pm_port_probe(struct sili_port *ap, int orig_error)
65 * Clean up the port state machine
67 sili_pwrite(ap, SILI_PREG_CTL_SET, SILI_PREG_CTL_PMA);
68 sili_pwrite(ap, SILI_PREG_CTL_SET, SILI_PREG_CTL_INIT);
69 if (sili_pwait_clr_to(ap, 5000, SILI_PREG_STATUS, SILI_PREG_CTL_INIT)) {
70 kprintf("%s: PM probe: unable to init port\n",
74 if (sili_pwait_set(ap, SILI_PREG_STATUS, SILI_PREG_STATUS_READY)) {
75 kprintf("%s: PM probe: port will not come ready\n",
81 * Issue a soft-reset of target 15
83 ap->ap_state = AP_S_NORMAL;
84 sili_pwrite(ap, SILI_PREG_SERR, -1);
85 error = sili_pm_softreset(ap, 15);
88 error = sili_pm_identify(ap);
91 * Finalize. If the softreset failed. Re-init the port
92 * state machine again so the normal non-PM softreset does
96 for (i = 0; i < SILI_MAX_PMPORTS; ++i) {
98 at->at_probe = ATA_PROBE_NEED_INIT;
99 at->at_features |= ATA_PORT_F_RESCAN;
100 at->at_features &= ~ATA_PORT_F_READLOG;
102 ap->ap_type = ATA_PORT_T_PM;
106 sili_pwrite(ap, SILI_PREG_CTL_CLR, SILI_PREG_CTL_PMA);
108 if (orig_error == 0) {
109 if (sili_pwait_set_to(ap, 5000, SILI_PREG_STATUS,
110 SILI_PREG_STATUS_READY)) {
111 kprintf("%s: PM probe: port will not come ready\n",
119 sili_pwrite(ap, SILI_PREG_CTL_CLR, SILI_PREG_CTL_RESUME);
120 sili_pwrite(ap, SILI_PREG_CTL_CLR, SILI_PREG_CTL_PMA);
121 sili_pwrite(ap, SILI_PREG_CTL_SET, SILI_PREG_CTL_INIT);
122 if (sili_pwait_clr_to(ap, 5000, SILI_PREG_STATUS, SILI_PREG_CTL_INIT)) {
123 kprintf("%s: PM probe: unable to init port\n",
127 if (sili_pwait_set(ap, SILI_PREG_STATUS, SILI_PREG_STATUS_READY)) {
128 kprintf("%s: PM probe: port will not come ready\n",
132 kprintf("ORIG ERROR %d\n", orig_error);
137 * If we originally detected a device redo the device reset to
138 * try to clear the mess.
140 sili_pwrite(ap, SILI_PREG_CTL_SET, SILI_PREG_CTL_DEVRESET);
141 if (sili_pwait_clr(ap, SILI_PREG_CTL_SET, SILI_PREG_CTL_DEVRESET)) {
142 kprintf("%s: PM probe: unable to reset\n", PORTNAME(ap));
145 if (sili_pwait_set(ap, SILI_PREG_STATUS, SILI_PREG_STATUS_READY)) {
146 kprintf("%s: PM probe: port will not come ready\n",
155 * Identify the port multiplier
158 sili_pm_identify(struct sili_port *ap)
166 ap->ap_probe = ATA_PROBE_FAILED;
167 if (sili_pm_read(ap, 15, 0, &chipid))
169 if (sili_pm_read(ap, 15, 1, &rev))
171 if (sili_pm_read(ap, 15, 2, &nports))
173 nports &= 0x0000000F; /* only the low 4 bits */
175 ap->ap_probe = ATA_PROBE_GOOD;
176 kprintf("%s: Port multiplier: chip=%08x rev=0x%b nports=%d\n",
179 rev, SATA_PFMT_PM_REV,
181 ap->ap_pmcount = nports;
183 if (sili_pm_read(ap, 15, SATA_PMREG_FEA, &data1)) {
184 kprintf("%s: Port multiplier: Warning, "
185 "cannot read feature register\n", PORTNAME(ap));
187 kprintf("%s: Port multiplier features: 0x%b\n",
192 if (sili_pm_read(ap, 15, SATA_PMREG_FEAEN, &data2) == 0) {
193 kprintf("%s: Port multiplier defaults: 0x%b\n",
200 * Turn on async notification if we support and the PM supports it.
201 * This allows the PM to forward async notification events to us and
202 * it will also generate an event for target 15 for hot-plug events
203 * (or is supposed to anyway).
205 if ((ap->ap_sc->sc_flags & SILI_F_SSNTF) &&
206 (data1 & SATA_PMFEA_ASYNCNOTIFY)) {
207 u_int32_t serr_bits = SATA_PM_SERR_DIAG_N |
209 data2 |= SATA_PMFEA_ASYNCNOTIFY;
210 if (sili_pm_write(ap, 15, SATA_PMREG_FEAEN, data2)) {
211 kprintf("%s: Port multiplier: AsyncNotify cannot be "
212 "enabled\n", PORTNAME(ap));
213 } else if (sili_pm_write(ap, 15, SATA_PMREG_EEENA, serr_bits)) {
214 kprintf("%s: Port mulltiplier: AsyncNotify unable "
215 "to enable error info bits\n", PORTNAME(ap));
217 kprintf("%s: Port multiplier: AsyncNotify enabled\n",
224 kprintf("%s: Port multiplier cannot be identified\n", PORTNAME(ap));
229 * Do a COMRESET sequence on the target behind a port multiplier.
231 * If hard is 2 we also cycle the phy on the target.
233 * This must be done prior to any softreset or probe attempts on
234 * targets behind the port multiplier.
236 * Returns 0 on success or an error.
239 sili_pm_hardreset(struct sili_port *ap, int target, int hard)
246 at = &ap->ap_ata[target];
249 * Turn off power management and kill the phy on the target
250 * if requested. Hold state for 10ms.
252 data = SATA_PM_SCTL_IPM_DISABLED;
254 data |= SATA_PM_SCTL_DET_DISABLE;
255 if (sili_pm_write(ap, target, SATA_PMREG_SERR, -1))
257 if (sili_pm_write(ap, target, SATA_PMREG_SCTL, data))
262 * Start transmitting COMRESET. COMRESET must be sent for at
265 at->at_probe = ATA_PROBE_FAILED;
266 at->at_type = ATA_PORT_T_NONE;
267 data = SATA_PM_SCTL_IPM_DISABLED | SATA_PM_SCTL_DET_INIT;
268 if (SiliForceGen1 & (1 << ap->ap_num)) {
269 kprintf("%s.%d: Force 1.5GBits\n", PORTNAME(ap), target);
270 data |= SATA_PM_SCTL_SPD_GEN1;
272 data |= SATA_PM_SCTL_SPD_ANY;
274 if (sili_pm_write(ap, target, SATA_PMREG_SCTL, data))
278 * It takes about 100ms for the DET logic to settle down,
279 * from trial and error testing. If this is too short
280 * the softreset code will fail.
284 if (sili_pm_phy_status(ap, target, &data)) {
285 kprintf("%s: (A)Cannot clear phy status\n",
290 * Flush any status, then clear DET to initiate negotiation.
292 * We need to give the phy layer a bit of time to settle down
293 * or we may catch a detection glitch instead of the actual
296 sili_pm_write(ap, target, SATA_PMREG_SERR, -1);
297 data = SATA_PM_SCTL_IPM_DISABLED | SATA_PM_SCTL_DET_NONE;
298 if (sili_pm_write(ap, target, SATA_PMREG_SCTL, data))
303 * Try to determine if there is a device on the port.
305 * Give the device 3/10 second to at least be detected.
306 * If we fail clear any pending status since we may have
307 * cycled the phy and probably caused another PRCS interrupt.
309 for (loop = 3; loop; --loop) {
310 if (sili_pm_read(ap, target, SATA_PMREG_SSTS, &data))
312 if (data & SATA_PM_SSTS_DET)
317 kprintf("%s.%d: Port appears to be unplugged\n",
318 PORTNAME(ap), target);
324 * There is something on the port. Give the device 3 seconds
325 * to fully negotiate.
327 for (loop = 30; loop; --loop) {
328 if (sili_pm_read(ap, target, SATA_PMREG_SSTS, &data))
330 if ((data & SATA_PM_SSTS_DET) == SATA_PM_SSTS_DET_DEV)
336 * Device not detected
339 kprintf("%s: Device may be powered down\n",
348 * Wait 200ms to give the device time to send its first D2H FIS.
349 * If we do not wait long enough our softreset sequence can collide
350 * with the end of the device's reset sequence.
352 * XXX how do we poll that particular target's BSY status via the
355 kprintf("%s.%d: Device detected data=%08x\n",
356 PORTNAME(ap), target, data);
361 at->at_probe = error ? ATA_PROBE_FAILED : ATA_PROBE_NEED_SOFT_RESET;
366 * SILI soft reset through port multiplier.
368 * This function keeps port communications intact and attempts to generate
369 * a reset to the connected device using device commands. Unlike
370 * hard-port operations we can't do fancy stop/starts or stuff like
371 * that without messing up other commands that might be running or
374 * The SII chip will do the whole mess for us.
377 sili_pm_softreset(struct sili_port *ap, int target)
380 struct sili_ccb *ccb;
381 struct sili_prb *prb;
388 at = &ap->ap_ata[target];
390 DPRINTF(SILI_D_VERBOSE, "%s: soft reset\n", PORTNAME(ap));
393 * Prep the special soft-reset SII command.
395 ccb = sili_get_err_ccb(ap);
396 ccb->ccb_done = sili_pm_empty_done;
397 ccb->ccb_xa.flags = ATA_F_POLL | ATA_F_EXCLUSIVE | ATA_F_AUTOSENSE;
398 ccb->ccb_xa.complete = sili_pm_dummy_done;
402 bzero(&prb->prb_h2d, sizeof(prb->prb_h2d));
403 prb->prb_h2d.flags = at->at_target;
404 prb->prb_control = SILI_PRB_CTRL_SOFTRESET;
405 prb->prb_override = 0;
406 prb->prb_xfer_count = 0;
408 ccb->ccb_xa.state = ATA_S_PENDING;
410 timeout = (target == 15) ? 1000 : 8000;
413 * NOTE: Must use sili_quick_timeout() because we hold the err_ccb
415 if (sili_poll(ccb, timeout, sili_quick_timeout) != ATA_S_COMPLETE) {
417 kprintf("%s: (PM) Softreset FIS failed\n",
420 sili_put_err_ccb(ccb);
424 sig = (prb->prb_d2h.lba_high << 24) |
425 (prb->prb_d2h.lba_mid << 16) |
426 (prb->prb_d2h.lba_low << 8) |
427 (prb->prb_d2h.sector_count);
428 kprintf("%s: PM SOFTRESET SIGNATURE %08x\n", ATANAME(ap, at), sig);
430 sili_put_err_ccb(ccb);
433 * Clear the phy status of the target so we can get a new event.
435 * Target 15 is the PM itself and these registers have
436 * different meanings.
439 if (sili_pm_phy_status(ap, target, &data)) {
440 kprintf("%s: (C)Cannot clear phy status\n",
443 sili_pm_write(ap, target, SATA_PMREG_SERR, -1);
447 * If the softreset is trying to clear a BSY condition after a
448 * normal portreset we assign the port type.
450 * If the softreset is being run first as part of the ccb error
451 * processing code then report if the device signature changed
454 if (at->at_type == ATA_PORT_T_NONE) {
455 at->at_type = sili_port_signature(ap, at, sig);
457 if (sili_port_signature(ap, at, sig) != at->at_type) {
458 kprintf("%s: device signature unexpectedly "
459 "changed\n", ATANAME(ap, at));
460 error = EBUSY; /* XXX */
466 * Clear error status so we can detect removal.
468 * Target 15 is the PM itself and these registers have
469 * different meanings.
471 if (error == 0 && target != 15) {
472 if (sili_pm_write(ap, target, SATA_PMREG_SERR, -1)) {
473 kprintf("%s: sili_pm_softreset unable to clear SERR\n",
475 ap->ap_flags &= ~AP_F_IGNORE_IFS;
479 at->at_probe = error ? ATA_PROBE_FAILED : ATA_PROBE_NEED_IDENT;
485 * Return the phy status for a target behind a port multiplier and
486 * reset SATA_PMREG_SERR.
488 * Returned bits follow SILI_PREG_SSTS bits. The SILI_PREG_SSTS_SPD
489 * bits can be used to determine the link speed and will be 0 if there
492 * 0 is returned if any communications error occurs.
495 sili_pm_phy_status(struct sili_port *ap, int target, u_int32_t *datap)
499 error = sili_pm_read(ap, target, SATA_PMREG_SSTS, datap);
501 error = sili_pm_write(ap, target, SATA_PMREG_SERR, -1);
508 sili_pm_set_feature(struct sili_port *ap, int feature, int enable)
513 xa = sili_ata_get_xfer(ap, &ap->ap_ata[15]);
515 xa->fis->type = ATA_FIS_TYPE_H2D;
516 xa->fis->flags = ATA_H2D_FLAGS_CMD | 15;
517 xa->fis->command = enable ? ATA_C_SATA_FEATURE_ENA :
518 ATA_C_SATA_FEATURE_DIS;
519 xa->fis->sector_count = feature;
520 xa->fis->control = ATA_FIS_CONTROL_4BIT;
522 xa->complete = sili_pm_dummy_done;
524 xa->flags = ATA_F_POLL | ATA_F_EXCLUSIVE;
527 if (sili_ata_cmd(xa) == ATA_S_COMPLETE)
531 sili_ata_put_xfer(xa);
536 * Check that a target is still good.
539 sili_pm_check_good(struct sili_port *ap, int target)
545 * It looks like we might have to read the EINFO register
546 * to allow the PM to generate a new event.
548 if (sili_pm_read(ap, 15, SATA_PMREG_EINFO, &data)) {
549 kprintf("%s: Port multiplier EINFO could not be read\n",
553 if (sili_pm_write(ap, target, SATA_PMREG_SERR, -1)) {
554 kprintf("%s: Port multiplier: SERR could not be cleared\n",
558 if (target == CAM_TARGET_WILDCARD || target >= ap->ap_pmcount)
560 at = &ap->ap_ata[target];
563 * If the device needs an init or hard reset also make sure the
566 if (at->at_probe <= ATA_PROBE_NEED_HARD_RESET) {
567 /*kprintf("%s DOHARD\n", ATANAME(ap, at));*/
568 sili_pm_hardreset(ap, target, 1);
572 * Read the detect status
574 if (sili_pm_read(ap, target, SATA_PMREG_SSTS, &data)) {
575 kprintf("%s: Unable to access PM SSTS register target %d\n",
576 PORTNAME(ap), target);
579 if ((data & SATA_PM_SSTS_DET) != SATA_PM_SSTS_DET_DEV) {
580 /*kprintf("%s: DETECT %08x\n", ATANAME(ap, at), data);*/
581 if (at->at_probe != ATA_PROBE_FAILED) {
582 at->at_probe = ATA_PROBE_FAILED;
583 at->at_type = ATA_PORT_T_NONE;
584 at->at_features |= ATA_PORT_F_RESCAN;
585 kprintf("%s: HOTPLUG (PM) - Device removed\n",
589 if (at->at_probe == ATA_PROBE_FAILED) {
590 at->at_probe = ATA_PROBE_NEED_HARD_RESET;
591 at->at_features |= ATA_PORT_F_RESCAN;
592 kprintf("%s: HOTPLUG (PM) - Device inserted\n",
602 sili_pm_read(struct sili_port *ap, int target, int which, u_int32_t *datap)
607 xa = sili_ata_get_xfer(ap, &ap->ap_ata[15]);
609 xa->fis->type = ATA_FIS_TYPE_H2D;
610 xa->fis->flags = ATA_H2D_FLAGS_CMD | 15;
611 xa->fis->command = ATA_C_READ_PM;
612 xa->fis->features = which;
613 xa->fis->device = target | ATA_H2D_DEVICE_LBA;
614 xa->fis->control = ATA_FIS_CONTROL_4BIT;
616 xa->complete = sili_pm_dummy_done;
618 xa->flags = ATA_F_POLL | ATA_F_AUTOSENSE;
621 if (sili_ata_cmd(xa) == ATA_S_COMPLETE) {
622 *datap = xa->rfis->sector_count | (xa->rfis->lba_low << 8) |
623 (xa->rfis->lba_mid << 16) | (xa->rfis->lba_high << 24);
626 kprintf("%s.%d pm_read SCA[%d] failed\n",
627 PORTNAME(ap), target, which);
631 sili_ata_put_xfer(xa);
636 * Write a PM register
639 sili_pm_write(struct sili_port *ap, int target, int which, u_int32_t data)
644 xa = sili_ata_get_xfer(ap, &ap->ap_ata[15]);
646 xa->fis->type = ATA_FIS_TYPE_H2D;
647 xa->fis->flags = ATA_H2D_FLAGS_CMD | 15;
648 xa->fis->command = ATA_C_WRITE_PM;
649 xa->fis->features = which;
650 xa->fis->device = target | ATA_H2D_DEVICE_LBA;
651 xa->fis->sector_count = (u_int8_t)data;
652 xa->fis->lba_low = (u_int8_t)(data >> 8);
653 xa->fis->lba_mid = (u_int8_t)(data >> 16);
654 xa->fis->lba_high = (u_int8_t)(data >> 24);
655 xa->fis->control = ATA_FIS_CONTROL_4BIT;
657 xa->complete = sili_pm_dummy_done;
659 xa->flags = ATA_F_POLL | ATA_F_EXCLUSIVE;
662 if (sili_ata_cmd(xa) == ATA_S_COMPLETE)
666 sili_ata_put_xfer(xa);
671 * Dummy done callback for xa.
674 sili_pm_dummy_done(struct ata_xfer *xa)
679 sili_pm_empty_done(struct sili_ccb *ccb)