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