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