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