?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
AHCI - follow fixes to CAM
[dragonfly.git] / sys / dev / disk / ahci / ahci_cam.c
blob0e30e932397bdaaecc93ae58e5516c2502e32f78
1 /*
2 * Copyright (c) 2009 The DragonFly Project. All rights reserved.
3 *
4 * This code is derived from software contributed to The DragonFly Project
5 * by Matthew Dillon <dillon@backplane.com>
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
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
16 * distribution.
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.
20 *
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
32 * SUCH DAMAGE.
33 *
34 *
35 * Copyright (c) 2007 David Gwynne <dlg@openbsd.org>
36 *
37 * Permission to use, copy, modify, and distribute this software for any
38 * purpose with or without fee is hereby granted, provided that the above
39 * copyright notice and this permission notice appear in all copies.
40 *
41 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
42 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
43 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
44 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
45 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
46 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
47 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
48 *
49 * $OpenBSD: atascsi.c,v 1.64 2009/02/16 21:19:06 miod Exp $
50 * $DragonFly$
51 */
52 /*
53 * Implement each SATA port as its own SCSI bus on CAM. This way we can
54 * implement future port multiplier features as individual devices on the
55 * bus.
56 *
57 * Much of the cdb<->xa conversion code was taken from OpenBSD, the rest
58 * was written natively for DragonFly.
59 */
60
61 #include "ahci.h"
62
63 const char *ScsiTypeArray[32] = {
64 "DIRECT",
65 "SEQUENTIAL",
66 "PRINTER",
67 "PROCESSOR",
68 "WORM",
69 "CDROM",
70 "SCANNER",
71 "OPTICAL",
72 "CHANGER",
73 "COMM",
74 "ASC0",
75 "ASC1",
76 "STORARRAY",
77 "ENCLOSURE",
78 "RBC",
79 "OCRW",
80 "0x10",
81 "OSD",
82 "ADC",
83 "0x13",
84 "0x14",
85 "0x15",
86 "0x16",
87 "0x17",
88 "0x18",
89 "0x19",
90 "0x1A",
91 "0x1B",
92 "0x1C",
93 "0x1D",
94 "0x1E",
95 "NODEVICE"
96 };
97
98 static void ahci_xpt_action(struct cam_sim *sim, union ccb *ccb);
99 static void ahci_xpt_poll(struct cam_sim *sim);
100 static void ahci_xpt_scsi_disk_io(struct ahci_port *ap,
101 struct ata_port *at, union ccb *ccb);
102 static void ahci_xpt_scsi_atapi_io(struct ahci_port *ap,
103 struct ata_port *at, union ccb *ccb);
104
105 static void ahci_ata_complete_disk_rw(struct ata_xfer *xa);
106 static void ahci_ata_complete_disk_synchronize_cache(struct ata_xfer *xa);
107 static void ahci_atapi_complete_cmd(struct ata_xfer *xa);
108 static void ahci_ata_dummy_sense(struct scsi_sense_data *sense_data);
109 static void ahci_ata_atapi_sense(struct ata_fis_d2h *rfis,
110 struct scsi_sense_data *sense_data);
111
112 static int ahci_cam_probe_disk(struct ahci_port *ap, struct ata_port *at);
113 static int ahci_cam_probe_atapi(struct ahci_port *ap, struct ata_port *at);
114 static void ahci_ata_dummy_done(struct ata_xfer *xa);
115 static void ata_fix_identify(struct ata_identify *id);
116 static void ahci_cam_rescan(struct ahci_port *ap);
117
118 int
119 ahci_cam_attach(struct ahci_port *ap)
120 {
121 struct cam_devq *devq;
122 struct cam_sim *sim;
123 int error;
124 int unit;
125
126 /*
127 * We want at least one ccb to be available for error processing
128 * so don't let CAM use more then ncmds - 1.
129 */
130 unit = device_get_unit(ap->ap_sc->sc_dev);
131 if (ap->ap_sc->sc_ncmds > 1)
132 devq = cam_simq_alloc(ap->ap_sc->sc_ncmds - 1);
133 else
134 devq = cam_simq_alloc(ap->ap_sc->sc_ncmds);
135 if (devq == NULL) {
136 return (ENOMEM);
137 }
138 sim = cam_sim_alloc(ahci_xpt_action, ahci_xpt_poll, "ahci",
139 (void *)ap, unit, &sim_mplock, 1, 1, devq);
140 cam_simq_release(devq);
141 if (sim == NULL) {
142 return (ENOMEM);
143 }
144 ap->ap_sim = sim;
145 error = xpt_bus_register(ap->ap_sim, ap->ap_num);
146 if (error != CAM_SUCCESS) {
147 ahci_cam_detach(ap);
148 return (EINVAL);
149 }
150 ap->ap_flags |= AP_F_BUS_REGISTERED;
151
152 error = ahci_cam_probe(ap, NULL);
153 if (error) {
154 ahci_cam_detach(ap);
155 return (EIO);
156 }
157 ap->ap_flags |= AP_F_CAM_ATTACHED;
158
159 return(0);
160 }
161
162 /*
163 * The state of the port has changed.
164 *
165 * If at is NULL the physical port has changed state.
166 * If at is non-NULL a particular target behind a PM has changed state.
167 *
168 * If found is -1 the target state must be queued to a non-interrupt context.
169 * (only works with at == NULL).
170 *
171 * If found is 0 the target was removed.
172 * If found is 1 the target was inserted.
173 */
174 void
175 ahci_cam_changed(struct ahci_port *ap, struct ata_port *atx, int found)
176 {
177 struct cam_path *tmppath;
178 int status;
179 int target;
180
181 target = atx ? atx->at_target : CAM_TARGET_WILDCARD;
182
183 if (ap->ap_sim == NULL)
184 return;
185 if (found == CAM_TARGET_WILDCARD) {
186 status = xpt_create_path(&tmppath, NULL,
187 cam_sim_path(ap->ap_sim),
188 target, CAM_LUN_WILDCARD);
189 if (status != CAM_REQ_CMP)
190 return;
191 ahci_cam_rescan(ap);
192 } else {
193 status = xpt_create_path(&tmppath, NULL,
194 cam_sim_path(ap->ap_sim),
195 target,
196 CAM_LUN_WILDCARD);
197 if (status != CAM_REQ_CMP)
198 return;
199 #if 0
200 /*
201 * This confuses CAM
202 */
203 if (found)
204 xpt_async(AC_FOUND_DEVICE, tmppath, NULL);
205 else
206 xpt_async(AC_LOST_DEVICE, tmppath, NULL);
207 #endif
208 }
209 xpt_free_path(tmppath);
210 }
211
212 void
213 ahci_cam_detach(struct ahci_port *ap)
214 {
215 int error;
216
217 if ((ap->ap_flags & AP_F_CAM_ATTACHED) == 0)
218 return;
219 get_mplock();
220 if (ap->ap_sim) {
221 xpt_freeze_simq(ap->ap_sim, 1);
222 }
223 if (ap->ap_flags & AP_F_BUS_REGISTERED) {
224 error = xpt_bus_deregister(cam_sim_path(ap->ap_sim));
225 KKASSERT(error == CAM_REQ_CMP);
226 ap->ap_flags &= ~AP_F_BUS_REGISTERED;
227 }
228 if (ap->ap_sim) {
229 cam_sim_free(ap->ap_sim);
230 ap->ap_sim = NULL;
231 }
232 rel_mplock();
233 ap->ap_flags &= ~AP_F_CAM_ATTACHED;
234 }
235
236 /*
237 * Once the AHCI port has been attached we need to probe for a device or
238 * devices on the port and setup various options.
239 *
240 * If at is NULL we are probing the direct-attached device on the port,
241 * which may or may not be a port multiplier.
242 */
243 int
244 ahci_cam_probe(struct ahci_port *ap, struct ata_port *atx)
245 {
246 struct ata_port *at;
247 struct ata_xfer *xa;
248 u_int64_t capacity;
249 u_int64_t capacity_bytes;
250 int model_len;
251 int status;
252 int error;
253 int devncqdepth;
254 int i;
255 const char *wcstr;
256 const char *rastr;
257 const char *scstr;
258 const char *type;
259
260 error = EIO;
261
262 /*
263 * A NULL atx indicates a probe of the directly connected device.
264 * A non-NULL atx indicates a device connected via a port multiplier.
265 * We need to preserve atx for calls to ahci_ata_get_xfer().
266 *
267 * at is always non-NULL. For directly connected devices we supply
268 * an (at) pointing to target 0.
269 */
270 if (atx == NULL) {
271 at = ap->ap_ata; /* direct attached - device 0 */
272 if (ap->ap_type == ATA_PORT_T_PM) {
273 kprintf("%s: Found Port Multiplier\n",
274 ATANAME(ap, atx));
275 ap->ap_probe = ATA_PROBE_GOOD;
276 return (0);
277 }
278 at->at_type = ap->ap_type;
279 } else {
280 at = atx;
281 if (atx->at_type == ATA_PORT_T_PM) {
282 kprintf("%s: Bogus device, reducing port count to %d\n",
283 ATANAME(ap, atx), atx->at_target);
284 if (ap->ap_pmcount > atx->at_target)
285 ap->ap_pmcount = atx->at_target;
286 goto err;
287 }
288 }
289 if (ap->ap_type == ATA_PORT_T_NONE)
290 goto err;
291 if (at->at_type == ATA_PORT_T_NONE)
292 goto err;
293
294 /*
295 * Issue identify, saving the result
296 */
297 xa = ahci_ata_get_xfer(ap, atx);
298 xa->complete = ahci_ata_dummy_done;
299 xa->data = &at->at_identify;
300 xa->datalen = sizeof(at->at_identify);
301 xa->fis->flags = ATA_H2D_FLAGS_CMD | at->at_target;
302
303 switch(at->at_type) {
304 case ATA_PORT_T_DISK:
305 xa->fis->command = ATA_C_IDENTIFY;
306 type = "DISK";
307 break;
308 case ATA_PORT_T_ATAPI:
309 xa->fis->command = ATA_C_ATAPI_IDENTIFY;
310 type = "ATAPI";
311 break;
312 default:
313 xa->fis->command = ATA_C_ATAPI_IDENTIFY;
314 type = "UNKNOWN(ATAPI?)";
315 break;
316 }
317 xa->fis->features = 0;
318 xa->fis->device = 0;
319 xa->flags = ATA_F_READ | ATA_F_PIO | ATA_F_POLL;
320 xa->timeout = 1000;
321
322 status = ahci_ata_cmd(xa);
323 if (status != ATA_COMPLETE) {
324 kprintf("%s: Detected %s device but unable to IDENTIFY\n",
325 ATANAME(ap, atx), type);
326 ahci_ata_put_xfer(xa);
327 goto err;
328 }
329 if (xa->state != ATA_S_COMPLETE) {
330 kprintf("%s: Detected %s device but unable to IDENTIFY "
331 " xa->state=%d\n",
332 ATANAME(ap, atx), type, xa->state);
333 ahci_ata_put_xfer(xa);
334 goto err;
335 }
336 ahci_ata_put_xfer(xa);
337
338 ata_fix_identify(&at->at_identify);
339
340 /*
341 * Read capacity using SATA probe info.
342 */
343 if (le16toh(at->at_identify.cmdset83) & 0x0400) {
344 /* LBA48 feature set supported */
345 capacity = 0;
346 for (i = 3; i >= 0; --i) {
347 capacity <<= 16;
348 capacity +=
349 le16toh(at->at_identify.addrsecxt[i]);
350 }
351 } else {
352 capacity = le16toh(at->at_identify.addrsec[1]);
353 capacity <<= 16;
354 capacity += le16toh(at->at_identify.addrsec[0]);
355 }
356 at->at_capacity = capacity;
357 if (atx == NULL)
358 ap->ap_probe = ATA_PROBE_GOOD;
359
360 capacity_bytes = capacity * 512;
361
362 /*
363 * Negotiate NCQ, throw away any ata_xfer's beyond the negotiated
364 * number of slots and limit the number of CAM ccb's to one less
365 * so we always have a slot available for recovery.
366 *
367 * NCQ is not used if ap_ncqdepth is 1 or the host controller does
368 * not support it, and in that case the driver can handle extra
369 * ccb's.
370 *
371 * NCQ is currently used only with direct-attached disks. It is
372 * not used with port multipliers or direct-attached ATAPI devices.
373 *
374 * Remember at least one extra CCB needs to be reserved for the
375 * error ccb.
376 */
377 if ((ap->ap_sc->sc_cap & AHCI_REG_CAP_SNCQ) &&
378 ap->ap_type == ATA_PORT_T_DISK &&
379 (le16toh(at->at_identify.satacap) & (1 << 8))) {
380 at->at_ncqdepth = (le16toh(at->at_identify.qdepth) & 0x1F) + 1;
381 devncqdepth = at->at_ncqdepth;
382 if (at->at_ncqdepth > ap->ap_sc->sc_ncmds)
383 at->at_ncqdepth = ap->ap_sc->sc_ncmds;
384 if (at->at_ncqdepth > 1) {
385 for (i = 0; i < ap->ap_sc->sc_ncmds; ++i) {
386 xa = ahci_ata_get_xfer(ap, atx);
387 if (xa->tag < at->at_ncqdepth) {
388 xa->state = ATA_S_COMPLETE;
389 ahci_ata_put_xfer(xa);
390 }
391 }
392 if (at->at_ncqdepth >= ap->ap_sc->sc_ncmds) {
393 cam_devq_resize(ap->ap_sim->devq,
394 at->at_ncqdepth - 1);
395 }
396 }
397 } else {
398 devncqdepth = 0;
399 }
400
401 /*
402 * Make the model string a bit more presentable
403 */
404 for (model_len = 40; model_len; --model_len) {
405 if (at->at_identify.model[model_len-1] == ' ')
406 continue;
407 if (at->at_identify.model[model_len-1] == 0)
408 continue;
409 break;
410 }
411
412 /*
413 * Generate informatiive strings.
414 *
415 * NOTE: We do not automatically set write caching, lookahead,
416 * or the security state for ATAPI devices.
417 */
418 if (at->at_identify.cmdset82 & ATA_IDENTIFY_WRITECACHE) {
419 if (at->at_identify.features85 & ATA_IDENTIFY_WRITECACHE)
420 wcstr = "enabled";
421 else if (at->at_type == ATA_PORT_T_ATAPI)
422 wcstr = "disabled";
423 else
424 wcstr = "enabling";
425 } else {
426 wcstr = "notsupp";
427 }
428
429 if (at->at_identify.cmdset82 & ATA_IDENTIFY_LOOKAHEAD) {
430 if (at->at_identify.features85 & ATA_IDENTIFY_LOOKAHEAD)
431 rastr = "enabled";
432 else if (at->at_type == ATA_PORT_T_ATAPI)
433 rastr = "disabled";
434 else
435 rastr = "enabling";
436 } else {
437 rastr = "notsupp";
438 }
439
440 if (at->at_identify.cmdset82 & ATA_IDENTIFY_SECURITY) {
441 if (at->at_identify.securestatus & ATA_SECURE_FROZEN)
442 scstr = "frozen";
443 else if (at->at_type == ATA_PORT_T_ATAPI)
444 scstr = "unfrozen";
445 else
446 scstr = "freezing";
447 } else {
448 scstr = "notsupp";
449 }
450
451 kprintf("%s: Found %s \"%*.*s %8.8s\" serial=\"%20.20s\"\n"
452 "%s: tags=%d/%d satacaps=%04x satafeat=%04x "
453 "capacity=%lld.%02dMB\n"
454 "%s: f85=%04x f86=%04x f87=%04x WC=%s RA=%s SEC=%s\n",
455 ATANAME(ap, atx),
456 type,
457 model_len, model_len,
458 at->at_identify.model,
459 at->at_identify.firmware,
460 at->at_identify.serial,
461
462 ATANAME(ap, atx),
463 devncqdepth, ap->ap_sc->sc_ncmds,
464 at->at_identify.satacap,
465 at->at_identify.satafsup,
466 (long long)capacity_bytes / (1024 * 1024),
467 (int)(capacity_bytes % (1024 * 1024)) * 100 / (1024 * 1024),
468
469 ATANAME(ap, atx),
470 at->at_identify.features85,
471 at->at_identify.features86,
472 at->at_identify.features87,
473 wcstr,
474 rastr,
475 scstr
476 );
477
478 /*
479 * Additional type-specific probing
480 */
481 switch(at->at_type) {
482 case ATA_PORT_T_DISK:
483 error = ahci_cam_probe_disk(ap, atx);
484 break;
485 case ATA_PORT_T_ATAPI:
486 error = ahci_cam_probe_atapi(ap, atx);
487 break;
488 default:
489 error = EIO;
490 break;
491 }
492 err:
493 if (error) {
494 at->at_probe = ATA_PROBE_FAILED;
495 if (atx == NULL)
496 ap->ap_probe = at->at_probe;
497 } else {
498 at->at_probe = ATA_PROBE_GOOD;
499 if (atx == NULL)
500 ap->ap_probe = at->at_probe;
501 }
502 return (error);
503 }
504
505 /*
506 * DISK-specific probe after initial ident
507 */
508 static int
509 ahci_cam_probe_disk(struct ahci_port *ap, struct ata_port *atx)
510 {
511 struct ata_port *at;
512 struct ata_xfer *xa;
513 int status;
514
515 at = atx ? atx : ap->ap_ata;
516
517 /*
518 * Enable write cache if supported
519 *
520 * NOTE: "WD My Book" external disk devices have a very poor
521 * daughter board between the the ESATA and the HD. Sending
522 * any ATA_C_SET_FEATURES commands will break the hardware port
523 * with a fatal protocol error. However, this device also
524 * indicates that WRITECACHE is already on and READAHEAD is
525 * not supported so we avoid the issue.
526 */
527 if ((at->at_identify.cmdset82 & ATA_IDENTIFY_WRITECACHE) &&
528 (at->at_identify.features85 & ATA_IDENTIFY_WRITECACHE) == 0) {
529 xa = ahci_ata_get_xfer(ap, atx);
530 xa->complete = ahci_ata_dummy_done;
531 xa->fis->command = ATA_C_SET_FEATURES;
532 /*xa->fis->features = ATA_SF_WRITECACHE_EN;*/
533 xa->fis->features = ATA_SF_LOOKAHEAD_EN;
534 xa->fis->flags = ATA_H2D_FLAGS_CMD | at->at_target;
535 xa->fis->device = 0;
536 xa->flags = ATA_F_READ | ATA_F_PIO | ATA_F_POLL;
537 xa->timeout = 1000;
538 xa->datalen = 0;
539 status = ahci_ata_cmd(xa);
540 if (status == ATA_COMPLETE)
541 at->at_features |= ATA_PORT_F_WCACHE;
542 ahci_ata_put_xfer(xa);
543 }
544
545 /*
546 * Enable readahead if supported
547 */
548 if ((at->at_identify.cmdset82 & ATA_IDENTIFY_LOOKAHEAD) &&
549 (at->at_identify.features85 & ATA_IDENTIFY_LOOKAHEAD) == 0) {
550 xa = ahci_ata_get_xfer(ap, atx);
551 xa->complete = ahci_ata_dummy_done;
552 xa->fis->command = ATA_C_SET_FEATURES;
553 xa->fis->features = ATA_SF_LOOKAHEAD_EN;
554 xa->fis->flags = ATA_H2D_FLAGS_CMD | at->at_target;
555 xa->fis->device = 0;
556 xa->flags = ATA_F_READ | ATA_F_PIO | ATA_F_POLL;
557 xa->timeout = 1000;
558 xa->datalen = 0;
559 status = ahci_ata_cmd(xa);
560 if (status == ATA_COMPLETE)
561 at->at_features |= ATA_PORT_F_RAHEAD;
562 ahci_ata_put_xfer(xa);
563 }
564
565 /*
566 * FREEZE LOCK the device so malicious users can't lock it on us.
567 * As there is no harm in issuing this to devices that don't
568 * support the security feature set we just send it, and don't bother
569 * checking if the device sends a command abort to tell us it doesn't
570 * support it
571 */
572 if ((at->at_identify.cmdset82 & ATA_IDENTIFY_SECURITY) &&
573 (at->at_identify.securestatus & ATA_SECURE_FROZEN) == 0) {
574 xa = ahci_ata_get_xfer(ap, atx);
575 xa->complete = ahci_ata_dummy_done;
576 xa->fis->command = ATA_C_SEC_FREEZE_LOCK;
577 xa->fis->flags = ATA_H2D_FLAGS_CMD | at->at_target;
578 xa->flags = ATA_F_READ | ATA_F_PIO | ATA_F_POLL;
579 xa->timeout = 1000;
580 xa->datalen = 0;
581 status = ahci_ata_cmd(xa);
582 if (status == ATA_COMPLETE)
583 at->at_features |= ATA_PORT_F_FRZLCK;
584 ahci_ata_put_xfer(xa);
585 }
586
587 return (0);
588 }
589
590 /*
591 * ATAPI-specific probe after initial ident
592 */
593 static int
594 ahci_cam_probe_atapi(struct ahci_port *ap, struct ata_port *atx)
595 {
596 return(0);
597 }
598
599 /*
600 * Fix byte ordering so buffers can be accessed as
601 * strings.
602 */
603 static void
604 ata_fix_identify(struct ata_identify *id)
605 {
606 u_int16_t *swap;
607 int i;
608
609 swap = (u_int16_t *)id->serial;
610 for (i = 0; i < sizeof(id->serial) / sizeof(u_int16_t); i++)
611 swap[i] = bswap16(swap[i]);
612
613 swap = (u_int16_t *)id->firmware;
614 for (i = 0; i < sizeof(id->firmware) / sizeof(u_int16_t); i++)
615 swap[i] = bswap16(swap[i]);
616
617 swap = (u_int16_t *)id->model;
618 for (i = 0; i < sizeof(id->model) / sizeof(u_int16_t); i++)
619 swap[i] = bswap16(swap[i]);
620 }
621
622 /*
623 * Dummy done callback for xa.
624 */
625 static void
626 ahci_ata_dummy_done(struct ata_xfer *xa)
627 {
628 }
629
630 /*
631 * Use an engineering request to initiate a target scan for devices
632 * behind a port multiplier.
633 *
634 * An asynchronous bus scan is used to avoid reentrancy issues.
635 */
636 static void
637 ahci_cam_rescan_callback(struct cam_periph *periph, union ccb *ccb)
638 {
639 struct ahci_port *ap = ccb->ccb_h.sim_priv.entries[0].ptr;
640
641 ap->ap_flags &= ~AP_F_SCAN_RUNNING;
642 if (ap->ap_flags & AP_F_SCAN_REQUESTED) {
643 ap->ap_flags &= ~AP_F_SCAN_REQUESTED;
644 ahci_cam_rescan(ap);
645 }
646 kfree(ccb, M_TEMP);
647 }
648
649 static void
650 ahci_cam_rescan(struct ahci_port *ap)
651 {
652 struct cam_path *path;
653 union ccb *ccb;
654 int status;
655 int i;
656
657 if (ap->ap_flags & AP_F_SCAN_RUNNING) {
658 ap->ap_flags |= AP_F_SCAN_REQUESTED;
659 return;
660 }
661 ap->ap_flags |= AP_F_SCAN_RUNNING;
662 for (i = 0; i < AHCI_MAX_PMPORTS; ++i) {
663 ap->ap_ata[i].at_features |= ATA_PORT_F_RESCAN;
664 }
665
666 ccb = kmalloc(sizeof(*ccb), M_TEMP, M_WAITOK | M_ZERO);
667 status = xpt_create_path(&path, xpt_periph, cam_sim_path(ap->ap_sim),
668 CAM_TARGET_WILDCARD, CAM_LUN_WILDCARD);
669 if (status != CAM_REQ_CMP)
670 return;
671
672 xpt_setup_ccb(&ccb->ccb_h, path, 5); /* 5 = low priority */
673 ccb->ccb_h.func_code = XPT_ENG_EXEC;
674 ccb->ccb_h.cbfcnp = ahci_cam_rescan_callback;
675 ccb->ccb_h.sim_priv.entries[0].ptr = ap;
676 ccb->crcn.flags = CAM_FLAG_NONE;
677 xpt_action_async(ccb);
678
679 /* scan is now underway */
680 }
681
682 static void
683 ahci_xpt_rescan(struct ahci_port *ap)
684 {
685 struct cam_path *path;
686 union ccb *ccb;
687 int status;
688
689 status = xpt_create_path(&path, xpt_periph, cam_sim_path(ap->ap_sim),
690 CAM_TARGET_WILDCARD, CAM_LUN_WILDCARD);
691 if (status != CAM_REQ_CMP)
692 return;
693 ccb = kmalloc(sizeof(*ccb), M_TEMP, M_WAITOK | M_ZERO);
694 xpt_setup_ccb(&ccb->ccb_h, path, 5); /* 5 = low priority */
695 ccb->ccb_h.func_code = XPT_SCAN_BUS;
696 ccb->ccb_h.cbfcnp = ahci_cam_rescan_callback;
697 ccb->ccb_h.sim_priv.entries[0].ptr = ap;
698 ccb->crcn.flags = CAM_FLAG_NONE;
699 xpt_action_async(ccb);
700 }
701
702 #if 0
703 ccb = xpt_alloc_ccb();
704 status = xpt_create_path(&ccb->ccb_h.path, xpt_periph,
705 cam_sim_path(ap->ap_sim),
706 CAM_TARGET_WILDCARD, CAM_LUN_WILDCARD);
707 if (status == CAM_REQ_CMP) {
708 kprintf("RESCAN SCSI BUS %d\n", ccb->ccb_h.timeout);
709 ccb->crcn.flags = CAM_FLAG_NONE;
710 xpt_rescan(ccb);
711 } else {
712 xpt_free_ccb(ccb);
713 }
714 #endif
715
716 /*
717 * Action function - dispatch command
718 */
719 static
720 void
721 ahci_xpt_action(struct cam_sim *sim, union ccb *ccb)
722 {
723 struct ahci_port *ap;
724 struct ata_port *at, *atx;
725 struct ccb_hdr *ccbh;
726 int unit;
727
728 /* XXX lock */
729 ap = cam_sim_softc(sim);
730 at = ap->ap_ata;
731 atx = NULL;
732 KKASSERT(ap != NULL);
733 ccbh = &ccb->ccb_h;
734 unit = cam_sim_unit(sim);
735
736 /*
737 * Early failure checks. These checks do not apply to XPT_PATH_INQ,
738 * otherwise the bus rescan will not remove the dead devices when
739 * unplugging a PM.
740 *
741 * For non-wildcards we have one target (0) and one lun (0),
742 * unless we have a port multiplier.
743 *
744 * A wildcard target indicates only the general bus is being
745 * probed.
746 *
747 * Calculate at and atx. at is always non-NULL. atx is only
748 * non-NULL for direct-attached devices. It will be NULL for
749 * devices behind a port multiplier.
750 *
751 * XXX What do we do with a LUN wildcard?
752 */
753 if (ccbh->target_id != CAM_TARGET_WILDCARD &&
754 ccbh->func_code != XPT_PATH_INQ) {
755 if (ap->ap_type == ATA_PORT_T_NONE) {
756 ccbh->status = CAM_DEV_NOT_THERE;
757 xpt_done(ccb);
758 return;
759 }
760 if (ccbh->target_id < 0 || ccbh->target_id >= ap->ap_pmcount) {
761 ccbh->status = CAM_DEV_NOT_THERE;
762 xpt_done(ccb);
763 return;
764 }
765 at += ccbh->target_id;
766 if (ap->ap_type == ATA_PORT_T_PM)
767 atx = at;
768
769 if (ccbh->target_lun != CAM_LUN_WILDCARD && ccbh->target_lun) {
770 ccbh->status = CAM_DEV_NOT_THERE;
771 xpt_done(ccb);
772 return;
773 }
774 }
775
776 /*
777 * Switch on the meta XPT command
778 */
779 switch(ccbh->func_code) {
780 case XPT_ENG_EXEC:
781 /*
782 * This routine is called after a port multiplier has been
783 * probed.
784 */
785 ccbh->status = CAM_REQ_CMP;
786 lwkt_serialize_enter(&ap->ap_sc->sc_serializer);
787 ahci_port_state_machine(ap);
788 lwkt_serialize_exit(&ap->ap_sc->sc_serializer);
789 xpt_done(ccb);
790
791 /*
792 * Rescanning the scsi bus should clean up the peripheral
793 * associations.
794 */
795 ahci_xpt_rescan(ap);
796 break;
797 case XPT_PATH_INQ:
798 /*
799 * This command always succeeds, otherwise the bus scan
800 * will not detach dead devices.
801 */
802 ccb->cpi.version_num = 1;
803 ccb->cpi.hba_inquiry = 0;
804 ccb->cpi.target_sprt = 0;
805 ccb->cpi.hba_misc = PIM_SEQSCAN;
806 ccb->cpi.hba_eng_cnt = 0;
807 bzero(ccb->cpi.vuhba_flags, sizeof(ccb->cpi.vuhba_flags));
808 ccb->cpi.max_target = AHCI_MAX_PMPORTS;
809 ccb->cpi.max_lun = 0;
810 ccb->cpi.async_flags = 0;
811 ccb->cpi.hpath_id = 0;
812 ccb->cpi.initiator_id = AHCI_MAX_PMPORTS - 1;
813 ccb->cpi.unit_number = cam_sim_unit(sim);
814 ccb->cpi.bus_id = cam_sim_bus(sim);
815 ccb->cpi.base_transfer_speed = 150000;
816 ccb->cpi.transport = XPORT_AHCI;
817 ccb->cpi.transport_version = 1;
818 ccb->cpi.protocol = PROTO_SCSI;
819 ccb->cpi.protocol_version = SCSI_REV_2;
820
821 ccbh->status = CAM_REQ_CMP;
822 if (ccbh->target_id != CAM_TARGET_WILDCARD) {
823 switch(ahci_pread(ap, AHCI_PREG_SSTS) &
824 AHCI_PREG_SSTS_SPD) {
825 case AHCI_PREG_SSTS_SPD_GEN1:
826 ccb->cpi.base_transfer_speed = 150000;
827 break;
828 case AHCI_PREG_SSTS_SPD_GEN2:
829 ccb->cpi.base_transfer_speed = 300000;
830 break;
831 default:
832 /* unknown */
833 ccb->cpi.base_transfer_speed = 1000;
834 break;
835 }
836 #if 0
837 if (ap->ap_type == ATA_PORT_T_NONE)
838 ccbh->status = CAM_DEV_NOT_THERE;
839 #endif
840 }
841 xpt_done(ccb);
842 break;
843 case XPT_RESET_DEV:
844 lwkt_serialize_enter(&ap->ap_sc->sc_serializer);
845 if (ap->ap_type == ATA_PORT_T_NONE) {
846 ccbh->status = CAM_DEV_NOT_THERE;
847 } else {
848 ahci_port_reset(ap, atx, 0);
849 ccbh->status = CAM_REQ_CMP;
850 }
851 lwkt_serialize_exit(&ap->ap_sc->sc_serializer);
852 xpt_done(ccb);
853 break;
854 case XPT_RESET_BUS:
855 lwkt_serialize_enter(&ap->ap_sc->sc_serializer);
856 ahci_port_reset(ap, NULL, 1);
857 lwkt_serialize_exit(&ap->ap_sc->sc_serializer);
858 ccbh->status = CAM_REQ_CMP;
859 xpt_done(ccb);
860 break;
861 case XPT_SET_TRAN_SETTINGS:
862 ccbh->status = CAM_FUNC_NOTAVAIL;
863 xpt_done(ccb);
864 break;
865 case XPT_GET_TRAN_SETTINGS:
866 ccb->cts.protocol = PROTO_SCSI;
867 ccb->cts.protocol_version = SCSI_REV_2;
868 ccb->cts.transport = XPORT_AHCI;
869 ccb->cts.transport_version = XPORT_VERSION_UNSPECIFIED;
870 ccb->cts.proto_specific.valid = 0;
871 ccb->cts.xport_specific.valid = 0;
872 ccbh->status = CAM_REQ_CMP;
873 xpt_done(ccb);
874 break;
875 case XPT_CALC_GEOMETRY:
876 cam_calc_geometry(&ccb->ccg, 1);
877 xpt_done(ccb);
878 break;
879 case XPT_SCSI_IO:
880 switch(at->at_type) {
881 case ATA_PORT_T_DISK:
882 ahci_xpt_scsi_disk_io(ap, atx, ccb);
883 break;
884 case ATA_PORT_T_ATAPI:
885 ahci_xpt_scsi_atapi_io(ap, atx, ccb);
886 break;
887 default:
888 ccbh->status = CAM_REQ_INVALID;
889 xpt_done(ccb);
890 break;
891 }
892 break;
893 default:
894 ccbh->status = CAM_REQ_INVALID;
895 xpt_done(ccb);
896 break;
897 }
898 }
899
900 /*
901 * Poll function.
902 *
903 * Generally this function gets called heavily when interrupts might be
904 * non-operational, during a halt/reboot or panic.
905 */
906 static
907 void
908 ahci_xpt_poll(struct cam_sim *sim)
909 {
910 struct ahci_port *ap;
911
912 ap = cam_sim_softc(sim);
913 crit_enter();
914 lwkt_serialize_enter(&ap->ap_sc->sc_serializer);
915 ahci_port_intr(ap);
916 lwkt_serialize_exit(&ap->ap_sc->sc_serializer);
917 crit_exit();
918 }
919
920 /*
921 * Convert the SCSI command in ccb to an ata_xfer command in xa
922 * for ATA_PORT_T_DISK operations. Set the completion function
923 * to convert the response back, then dispatch to the OpenBSD AHCI
924 * layer.
925 *
926 * AHCI DISK commands only support a limited command set, and we
927 * fake additional commands to make it play nice with the CAM subsystem.
928 */
929 static
930 void
931 ahci_xpt_scsi_disk_io(struct ahci_port *ap, struct ata_port *atx,
932 union ccb *ccb)
933 {
934 struct ccb_hdr *ccbh;
935 struct ccb_scsiio *csio;
936 struct ata_xfer *xa;
937 struct ata_port *at;
938 struct ata_fis_h2d *fis;
939 scsi_cdb_t cdb;
940 union scsi_data *rdata;
941 int rdata_len;
942 u_int64_t capacity;
943 u_int64_t lba;
944 u_int32_t count;
945
946 ccbh = &ccb->csio.ccb_h;
947 csio = &ccb->csio;
948 at = atx ? atx : &ap->ap_ata[0];
949
950 /*
951 * XXX not passing NULL at for direct attach!
952 */
953 xa = ahci_ata_get_xfer(ap, atx);
954 rdata = (void *)csio->data_ptr;
955 rdata_len = csio->dxfer_len;
956
957 /*
958 * Build the FIS or process the csio to completion.
959 */
960 cdb = (void *)((ccbh->flags & CAM_CDB_POINTER) ?
961 csio->cdb_io.cdb_ptr : csio->cdb_io.cdb_bytes);
962
963 switch(cdb->generic.opcode) {
964 case REQUEST_SENSE:
965 /*
966 * Auto-sense everything, so explicit sense requests
967 * return no-sense.
968 */
969 ccbh->status = CAM_SCSI_STATUS_ERROR;
970 break;
971 case INQUIRY:
972 /*
973 * Inquiry supported features
974 *
975 * [opcode, byte2, page_code, length, control]
976 */
977 if (cdb->inquiry.byte2 & SI_EVPD) {
978 switch(cdb->inquiry.page_code) {
979 case SVPD_SUPPORTED_PAGE_LIST:
980 /* XXX atascsi_disk_vpd_supported */
981 case SVPD_UNIT_SERIAL_NUMBER:
982 /* XXX atascsi_disk_vpd_serial */
983 case SVPD_UNIT_DEVID:
984 /* XXX atascsi_disk_vpd_ident */
985 default:
986 ccbh->status = CAM_FUNC_NOTAVAIL;
987 break;
988 }
989 } else {
990 bzero(rdata, rdata_len);
991 if (rdata_len < SHORT_INQUIRY_LENGTH) {
992 ccbh->status = CAM_CCB_LEN_ERR;
993 break;
994 }
995 if (rdata_len > sizeof(rdata->inquiry_data))
996 rdata_len = sizeof(rdata->inquiry_data);
997 rdata->inquiry_data.device = T_DIRECT;
998 rdata->inquiry_data.version = SCSI_REV_SPC2;
999 rdata->inquiry_data.response_format = 2;
1000 rdata->inquiry_data.additional_length = 32;
1001 bcopy("SATA ", rdata->inquiry_data.vendor, 8);
1002 bcopy(at->at_identify.model,
1003 rdata->inquiry_data.product,
1004 sizeof(rdata->inquiry_data.product));
1005 bcopy(at->at_identify.firmware,
1006 rdata->inquiry_data.revision,
1007 sizeof(rdata->inquiry_data.revision));
1008 ccbh->status = CAM_REQ_CMP;
1009 }
1010 break;
1011 case READ_CAPACITY_16:
1012 if (cdb->read_capacity_16.service_action != SRC16_SERVICE_ACTION) {
1013 ccbh->status = CAM_REQ_INVALID;
1014 break;
1015 }
1016 if (rdata_len < sizeof(rdata->read_capacity_data_16)) {
1017 ccbh->status = CAM_CCB_LEN_ERR;
1018 break;
1019 }
1020 /* fall through */
1021 case READ_CAPACITY:
1022 if (rdata_len < sizeof(rdata->read_capacity_data)) {
1023 ccbh->status = CAM_CCB_LEN_ERR;
1024 break;
1025 }
1026
1027 capacity = at->at_capacity;
1028
1029 bzero(rdata, rdata_len);
1030 if (cdb->generic.opcode == READ_CAPACITY) {
1031 rdata_len = sizeof(rdata->read_capacity_data);
1032 if (capacity > 0xFFFFFFFFU)
1033 capacity = 0xFFFFFFFFU;
1034 bzero(&rdata->read_capacity_data, rdata_len);
1035 scsi_ulto4b((u_int32_t)capacity - 1,
1036 rdata->read_capacity_data.addr);
1037 scsi_ulto4b(512, rdata->read_capacity_data.length);
1038 } else {
1039 rdata_len = sizeof(rdata->read_capacity_data_16);
1040 bzero(&rdata->read_capacity_data_16, rdata_len);
1041 scsi_u64to8b(capacity - 1,
1042 rdata->read_capacity_data_16.addr);
1043 scsi_ulto4b(512, rdata->read_capacity_data_16.length);
1044 }
1045 ccbh->status = CAM_REQ_CMP;
1046 break;
1047 case SYNCHRONIZE_CACHE:
1048 /*
1049 * Synchronize cache. Specification says this can take
1050 * greater then 30 seconds so give it at least 45.
1051 */
1052 fis = xa->fis;
1053 fis->flags = ATA_H2D_FLAGS_CMD;
1054 fis->command = ATA_C_FLUSH_CACHE;
1055 fis->device = 0;
1056 if (xa->timeout < 45000)
1057 xa->timeout = 45000;
1058 xa->datalen = 0;
1059 xa->flags = ATA_F_READ;
1060 xa->complete = ahci_ata_complete_disk_synchronize_cache;
1061 break;
1062 case TEST_UNIT_READY:
1063 case START_STOP_UNIT:
1064 case PREVENT_ALLOW:
1065 /*
1066 * Just silently return success
1067 */
1068 ccbh->status = CAM_REQ_CMP;
1069 rdata_len = 0;
1070 break;
1071 case ATA_PASS_12:
1072 case ATA_PASS_16:
1073 /*
1074 * XXX implement pass-through
1075 */
1076 ccbh->status = CAM_FUNC_NOTAVAIL;
1077 break;
1078 default:
1079 switch(cdb->generic.opcode) {
1080 case READ_6:
1081 lba = scsi_3btoul(cdb->rw_6.addr) & 0x1FFFFF;
1082 count = cdb->rw_6.length ? cdb->rw_6.length : 0x100;
1083 xa->flags = ATA_F_READ;
1084 break;
1085 case READ_10:
1086 lba = scsi_4btoul(cdb->rw_10.addr);
1087 count = scsi_2btoul(cdb->rw_10.length);
1088 xa->flags = ATA_F_READ;
1089 break;
1090 case READ_12:
1091 lba = scsi_4btoul(cdb->rw_12.addr);
1092 count = scsi_4btoul(cdb->rw_12.length);
1093 xa->flags = ATA_F_READ;
1094 break;
1095 case READ_16:
1096 lba = scsi_8btou64(cdb->rw_16.addr);
1097 count = scsi_4btoul(cdb->rw_16.length);
1098 xa->flags = ATA_F_READ;
1099 break;
1100 case WRITE_6:
1101 lba = scsi_3btoul(cdb->rw_6.addr) & 0x1FFFFF;
1102 count = cdb->rw_6.length ? cdb->rw_6.length : 0x100;
1103 xa->flags = ATA_F_WRITE;
1104 break;
1105 case WRITE_10:
1106 lba = scsi_4btoul(cdb->rw_10.addr);
1107 count = scsi_2btoul(cdb->rw_10.length);
1108 xa->flags = ATA_F_WRITE;
1109 break;
1110 case WRITE_12:
1111 lba = scsi_4btoul(cdb->rw_12.addr);
1112 count = scsi_4btoul(cdb->rw_12.length);
1113 xa->flags = ATA_F_WRITE;
1114 break;
1115 case WRITE_16:
1116 lba = scsi_8btou64(cdb->rw_16.addr);
1117 count = scsi_4btoul(cdb->rw_16.length);
1118 xa->flags = ATA_F_WRITE;
1119 break;
1120 default:
1121 ccbh->status = CAM_REQ_INVALID;
1122 break;
1123 }
1124 if (ccbh->status != CAM_REQ_INPROG)
1125 break;
1126
1127 fis = xa->fis;
1128 fis->flags = ATA_H2D_FLAGS_CMD;
1129 fis->lba_low = (u_int8_t)lba;
1130 fis->lba_mid = (u_int8_t)(lba >> 8);
1131 fis->lba_high = (u_int8_t)(lba >> 16);
1132 fis->device = ATA_H2D_DEVICE_LBA;
1133
1134 /*
1135 * NCQ only for direct-attached disks, do not currently
1136 * try to use NCQ with port multipliers.
1137 */
1138 if (at->at_ncqdepth > 1 &&
1139 ap->ap_type == ATA_PORT_T_DISK &&
1140 (ap->ap_sc->sc_cap & AHCI_REG_CAP_SNCQ) &&
1141 (ccbh->flags & CAM_POLLED) == 0) {
1142 /*
1143 * Use NCQ - always uses 48 bit addressing
1144 */
1145 xa->flags |= ATA_F_NCQ;
1146 fis->command = (xa->flags & ATA_F_WRITE) ?
1147 ATA_C_WRITE_FPDMA : ATA_C_READ_FPDMA;
1148 fis->lba_low_exp = (u_int8_t)(lba >> 24);
1149 fis->lba_mid_exp = (u_int8_t)(lba >> 32);
1150 fis->lba_high_exp = (u_int8_t)(lba >> 40);
1151 fis->sector_count = xa->tag << 3;
1152 fis->features = (u_int8_t)count;
1153 fis->features_exp = (u_int8_t)(count >> 8);
1154 } else if (count > 0x100 || lba > 0xFFFFFFFFU) {
1155 /*
1156 * Use LBA48
1157 */
1158 fis->command = (xa->flags & ATA_F_WRITE) ?
1159 ATA_C_WRITEDMA_EXT : ATA_C_READDMA_EXT;
1160 fis->lba_low_exp = (u_int8_t)(lba >> 24);
1161 fis->lba_mid_exp = (u_int8_t)(lba >> 32);
1162 fis->lba_high_exp = (u_int8_t)(lba >> 40);
1163 fis->sector_count = (u_int8_t)count;
1164 fis->sector_count_exp = (u_int8_t)(count >> 8);
1165 } else {
1166 /*
1167 * Use LBA
1168 *
1169 * NOTE: 256 sectors is supported, stored as 0.
1170 */
1171 fis->command = (xa->flags & ATA_F_WRITE) ?
1172 ATA_C_WRITEDMA : ATA_C_READDMA;
1173 fis->device |= (u_int8_t)(lba >> 24) & 0x0F;
1174 fis->sector_count = (u_int8_t)count;
1175 }
1176
1177 xa->data = csio->data_ptr;
1178 xa->datalen = csio->dxfer_len;
1179 xa->complete = ahci_ata_complete_disk_rw;
1180 xa->timeout = ccbh->timeout; /* milliseconds */
1181 if (ccbh->flags & CAM_POLLED)
1182 xa->flags |= ATA_F_POLL;
1183 break;
1184 }
1185
1186 /*
1187 * If the request is still in progress the xa and FIS have
1188 * been set up and must be dispatched. Otherwise the request
1189 * is complete.
1190 */
1191 if (ccbh->status == CAM_REQ_INPROG) {
1192 KKASSERT(xa->complete != NULL);
1193 xa->atascsi_private = ccb;
1194 ccb->ccb_h.sim_priv.entries[0].ptr = ap;
1195 lwkt_serialize_enter(&ap->ap_sc->sc_serializer);
1196 fis->flags |= at->at_target;
1197 ahci_ata_cmd(xa);
1198 lwkt_serialize_exit(&ap->ap_sc->sc_serializer);
1199 } else {
1200 ahci_ata_put_xfer(xa);
1201 xpt_done(ccb);
1202 }
1203 }
1204
1205 /*
1206 * Convert the SCSI command in ccb to an ata_xfer command in xa
1207 * for ATA_PORT_T_ATAPI operations. Set the completion function
1208 * to convert the response back, then dispatch to the OpenBSD AHCI
1209 * layer.
1210 */
1211 static
1212 void
1213 ahci_xpt_scsi_atapi_io(struct ahci_port *ap, struct ata_port *atx,
1214 union ccb *ccb)
1215 {
1216 struct ccb_hdr *ccbh;
1217 struct ccb_scsiio *csio;
1218 struct ata_xfer *xa;
1219 struct ata_fis_h2d *fis;
1220 scsi_cdb_t cdbs;
1221 scsi_cdb_t cdbd;
1222 int flags;
1223 struct ata_port *at;
1224
1225 ccbh = &ccb->csio.ccb_h;
1226 csio = &ccb->csio;
1227 at = atx ? atx : &ap->ap_ata[0];
1228
1229 switch (ccbh->flags & CAM_DIR_MASK) {
1230 case CAM_DIR_IN:
1231 flags = ATA_F_PACKET | ATA_F_READ;
1232 break;
1233 case CAM_DIR_OUT:
1234 flags = ATA_F_PACKET | ATA_F_WRITE;
1235 break;
1236 case CAM_DIR_NONE:
1237 flags = ATA_F_PACKET;
1238 break;
1239 default:
1240 ccbh->status = CAM_REQ_INVALID;
1241 xpt_done(ccb);
1242 return;
1243 /* NOT REACHED */
1244 }
1245
1246 /*
1247 * The command has to fit in the packet command buffer.
1248 */
1249 if (csio->cdb_len < 6 || csio->cdb_len > 16) {
1250 ccbh->status = CAM_CCB_LEN_ERR;
1251 xpt_done(ccb);
1252 return;
1253 }
1254
1255 /*
1256 * Initialize the XA and FIS.
1257 *
1258 * XXX not passing NULL at for direct attach!
1259 */
1260 xa = ahci_ata_get_xfer(ap, atx);
1261 fis = xa->fis;
1262
1263 fis->flags = ATA_H2D_FLAGS_CMD | at->at_target;
1264 fis->command = ATA_C_PACKET;
1265 fis->device = 0;
1266 fis->sector_count = xa->tag << 3;
1267 fis->features = ATA_H2D_FEATURES_DMA |
1268 ((flags & ATA_F_WRITE) ?
1269 ATA_H2D_FEATURES_DIR_WRITE : ATA_H2D_FEATURES_DIR_READ);
1270 fis->lba_mid = 0x00;
1271 fis->lba_high = 0x20;
1272
1273 xa->flags = flags;
1274 xa->data = csio->data_ptr;
1275 xa->datalen = csio->dxfer_len;
1276 xa->timeout = ccbh->timeout; /* milliseconds */
1277
1278 if (ccbh->flags & CAM_POLLED)
1279 xa->flags |= ATA_F_POLL;
1280
1281 /*
1282 * Copy the cdb to the packetcmd buffer in the FIS using a
1283 * convenient pointer in the xa.
1284 */
1285 cdbs = (void *)((ccbh->flags & CAM_CDB_POINTER) ?
1286 csio->cdb_io.cdb_ptr : csio->cdb_io.cdb_bytes);
1287 bcopy(cdbs, xa->packetcmd, csio->cdb_len);
1288
1289 #if 0
1290 kprintf("opcode %d cdb_len %d dxfer_len %d\n",
1291 cdbs->generic.opcode,
1292 csio->cdb_len, csio->dxfer_len);
1293 #endif
1294
1295 /*
1296 * Some ATAPI commands do not actually follow the SCSI standard.
1297 */
1298 cdbd = (void *)xa->packetcmd;
1299
1300 switch(cdbd->generic.opcode) {
1301 case INQUIRY:
1302 /*
1303 * Some ATAPI devices can't handle SI_EVPD being set
1304 * for a basic inquiry (page_code == 0).
1305 *
1306 * Some ATAPI devices can't handle long inquiry lengths,
1307 * don't ask me why. Truncate the inquiry length.
1308 */
1309 if ((cdbd->inquiry.byte2 & SI_EVPD) &&
1310 cdbd->inquiry.page_code == 0) {
1311 cdbd->inquiry.byte2 &= ~SI_EVPD;
1312 }
1313 if (cdbd->inquiry.page_code == 0 &&
1314 cdbd->inquiry.length > SHORT_INQUIRY_LENGTH) {
1315 cdbd->inquiry.length = SHORT_INQUIRY_LENGTH;
1316 }
1317 break;
1318 case READ_6:
1319 case WRITE_6:
1320 /*
1321 * Convert *_6 to *_10 commands. Most ATAPI devices
1322 * cannot handle the SCSI READ_6 and WRITE_6 commands.
1323 */
1324 cdbd->rw_10.opcode |= 0x20;
1325 cdbd->rw_10.byte2 = 0;
1326 cdbd->rw_10.addr[0] = cdbs->rw_6.addr[0] & 0x1F;
1327 cdbd->rw_10.addr[1] = cdbs->rw_6.addr[1];
1328 cdbd->rw_10.addr[2] = cdbs->rw_6.addr[2];
1329 cdbd->rw_10.addr[3] = 0;
1330 cdbd->rw_10.reserved = 0;
1331 cdbd->rw_10.length[0] = 0;
1332 cdbd->rw_10.length[1] = cdbs->rw_6.length;
1333 cdbd->rw_10.control = cdbs->rw_6.control;
1334 break;
1335 default:
1336 break;
1337 }
1338
1339 /*
1340 * And dispatch
1341 */
1342 xa->complete = ahci_atapi_complete_cmd;
1343 xa->atascsi_private = ccb;
1344 ccb->ccb_h.sim_priv.entries[0].ptr = ap;
1345 ahci_ata_cmd(xa);
1346 }
1347
1348 /*
1349 * Completion function for ATA_PORT_T_DISK cache synchronization.
1350 */
1351 static
1352 void
1353 ahci_ata_complete_disk_synchronize_cache(struct ata_xfer *xa)
1354 {
1355 union ccb *ccb = xa->atascsi_private;
1356 struct ccb_hdr *ccbh = &ccb->ccb_h;
1357 struct ahci_port *ap = ccb->ccb_h.sim_priv.entries[0].ptr;
1358
1359 switch(xa->state) {
1360 case ATA_S_COMPLETE:
1361 ccbh->status = CAM_REQ_CMP;
1362 ccb->csio.scsi_status = SCSI_STATUS_OK;
1363 break;
1364 case ATA_S_ERROR:
1365 kprintf("%s: synchronize_cache: error\n",
1366 ATANAME(ap, xa->at));
1367 ccbh->status = CAM_SCSI_STATUS_ERROR | CAM_AUTOSNS_VALID;
1368 ccb->csio.scsi_status = SCSI_STATUS_CHECK_COND;
1369 ahci_ata_dummy_sense(&ccb->csio.sense_data);
1370 break;
1371 case ATA_S_TIMEOUT:
1372 kprintf("%s: synchronize_cache: timeout\n",
1373 ATANAME(ap, xa->at));
1374 ccbh->status = CAM_CMD_TIMEOUT;
1375 break;
1376 default:
1377 kprintf("%s: synchronize_cache: unknown state %d\n",
1378 ATANAME(ap, xa->at), xa->state);
1379 ccbh->status = CAM_REQ_CMP_ERR;
1380 break;
1381 }
1382 ahci_ata_put_xfer(xa);
1383 lwkt_serialize_exit(&ap->ap_sc->sc_serializer);
1384 xpt_done(ccb);
1385 lwkt_serialize_enter(&ap->ap_sc->sc_serializer);
1386 }
1387
1388 /*
1389 * Completion function for ATA_PORT_T_DISK I/O
1390 */
1391 static
1392 void
1393 ahci_ata_complete_disk_rw(struct ata_xfer *xa)
1394 {
1395 union ccb *ccb = xa->atascsi_private;
1396 struct ccb_hdr *ccbh = &ccb->ccb_h;
1397 struct ahci_port *ap = ccb->ccb_h.sim_priv.entries[0].ptr;
1398
1399 switch(xa->state) {
1400 case ATA_S_COMPLETE:
1401 ccbh->status = CAM_REQ_CMP;
1402 ccb->csio.scsi_status = SCSI_STATUS_OK;
1403 break;
1404 case ATA_S_ERROR:
1405 kprintf("%s: disk_rw: error\n", ATANAME(ap, xa->at));
1406 ccbh->status = CAM_SCSI_STATUS_ERROR | CAM_AUTOSNS_VALID;
1407 ccb->csio.scsi_status = SCSI_STATUS_CHECK_COND;
1408 ahci_ata_dummy_sense(&ccb->csio.sense_data);
1409 break;
1410 case ATA_S_TIMEOUT:
1411 kprintf("%s: disk_rw: timeout\n", ATANAME(ap, xa->at));
1412 ccbh->status = CAM_CMD_TIMEOUT;
1413 break;
1414 default:
1415 kprintf("%s: disk_rw: unknown state %d\n",
1416 ATANAME(ap, xa->at), xa->state);
1417 ccbh->status = CAM_REQ_CMP_ERR;
1418 break;
1419 }
1420 ccb->csio.resid = xa->resid;
1421 ahci_ata_put_xfer(xa);
1422 lwkt_serialize_exit(&ap->ap_sc->sc_serializer);
1423 xpt_done(ccb);
1424 lwkt_serialize_enter(&ap->ap_sc->sc_serializer);
1425 }
1426
1427 /*
1428 * Completion function for ATA_PORT_T_ATAPI I/O
1429 *
1430 * Sense data is returned in the rfis.
1431 */
1432 static
1433 void
1434 ahci_atapi_complete_cmd(struct ata_xfer *xa)
1435 {
1436 union ccb *ccb = xa->atascsi_private;
1437 struct ccb_hdr *ccbh = &ccb->ccb_h;
1438 struct ahci_port *ap = ccb->ccb_h.sim_priv.entries[0].ptr;
1439 scsi_cdb_t cdb;
1440
1441 cdb = (void *)((ccb->ccb_h.flags & CAM_CDB_POINTER) ?
1442 ccb->csio.cdb_io.cdb_ptr : ccb->csio.cdb_io.cdb_bytes);
1443
1444 switch(xa->state) {
1445 case ATA_S_COMPLETE:
1446 ccbh->status = CAM_REQ_CMP;
1447 ccb->csio.scsi_status = SCSI_STATUS_OK;
1448 break;
1449 case ATA_S_ERROR:
1450 kprintf("%s: cmd %d: error\n",
1451 PORTNAME(ap), cdb->generic.opcode);
1452 ccbh->status = CAM_SCSI_STATUS_ERROR;
1453 ccb->csio.scsi_status = SCSI_STATUS_CHECK_COND;
1454 ahci_ata_atapi_sense(&xa->rfis, &ccb->csio.sense_data);
1455 break;
1456 case ATA_S_TIMEOUT:
1457 kprintf("%s: cmd %d: timeout\n",
1458 PORTNAME(ap), cdb->generic.opcode);
1459 ccbh->status = CAM_CMD_TIMEOUT;
1460 break;
1461 default:
1462 kprintf("%s: cmd %d: unknown state %d\n",
1463 PORTNAME(ap), cdb->generic.opcode, xa->state);
1464 ccbh->status = CAM_REQ_CMP_ERR;
1465 break;
1466 }
1467 ccb->csio.resid = xa->resid;
1468 ahci_ata_put_xfer(xa);
1469 lwkt_serialize_exit(&ap->ap_sc->sc_serializer);
1470 xpt_done(ccb);
1471 lwkt_serialize_enter(&ap->ap_sc->sc_serializer);
1472 }
1473
1474 /*
1475 * Construct dummy sense data for errors on DISKs
1476 */
1477 static
1478 void
1479 ahci_ata_dummy_sense(struct scsi_sense_data *sense_data)
1480 {
1481 sense_data->error_code = SSD_ERRCODE_VALID | SSD_CURRENT_ERROR;
1482 sense_data->segment = 0;
1483 sense_data->flags = SSD_KEY_MEDIUM_ERROR;
1484 sense_data->info[0] = 0;
1485 sense_data->info[1] = 0;
1486 sense_data->info[2] = 0;
1487 sense_data->info[3] = 0;
1488 sense_data->extra_len = 0;
1489 }
1490
1491 /*
1492 * Construct atapi sense data for errors on ATAPI
1493 *
1494 * The ATAPI sense data is stored in the passed rfis and must be converted
1495 * to SCSI sense data.
1496 */
1497 static
1498 void
1499 ahci_ata_atapi_sense(struct ata_fis_d2h *rfis,
1500 struct scsi_sense_data *sense_data)
1501 {
1502 sense_data->error_code = SSD_ERRCODE_VALID | SSD_CURRENT_ERROR;
1503 sense_data->segment = 0;
1504 sense_data->flags = (rfis->error & 0xF0) >> 4;
1505 if (rfis->error & 0x04)
1506 sense_data->flags |= SSD_KEY_ILLEGAL_REQUEST;
1507 if (rfis->error & 0x02)
1508 sense_data->flags |= SSD_EOM;
1509 if (rfis->error & 0x01)
1510 sense_data->flags |= SSD_ILI;
1511 sense_data->info[0] = 0;
1512 sense_data->info[1] = 0;
1513 sense_data->info[2] = 0;
1514 sense_data->info[3] = 0;
1515 sense_data->extra_len = 0;
1516 }
DragonFly BSD