4 * Copyright (c) 2009 The DragonFly Project. All rights reserved.
6 * This code is derived from software contributed to The DragonFly Project
7 * by Matthew Dillon <dillon@backplane.com>
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
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
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.
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
37 * Copyright (c) 2007 David Gwynne <dlg@openbsd.org>
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.
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.
51 * $OpenBSD: atascsi.c,v 1.64 2009/02/16 21:19:06 miod Exp $
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
58 * Much of the cdb<->xa conversion code was taken from OpenBSD, the rest
59 * was written natively for DragonFly.
64 static void ahci_xpt_action(struct cam_sim
*sim
, union ccb
*ccb
);
65 static void ahci_xpt_poll(struct cam_sim
*sim
);
66 static void ahci_xpt_scsi_disk_io(struct ahci_port
*ap
,
67 struct ata_port
*at
, union ccb
*ccb
);
68 static void ahci_xpt_scsi_atapi_io(struct ahci_port
*ap
,
69 struct ata_port
*at
, union ccb
*ccb
);
70 static void ahci_xpt_page_inquiry(struct ahci_port
*ap
,
71 struct ata_port
*at
, union ccb
*ccb
);
73 static void ahci_ata_complete_disk_rw(struct ata_xfer
*xa
);
74 static void ahci_ata_complete_disk_synchronize_cache(struct ata_xfer
*xa
);
75 static void ahci_atapi_complete_cmd(struct ata_xfer
*xa
);
76 static void ahci_ata_dummy_sense(struct scsi_sense_data
*sense_data
);
77 static void ahci_ata_atapi_sense(struct ata_fis_d2h
*rfis
,
78 struct scsi_sense_data
*sense_data
);
80 static int ahci_cam_probe_disk(struct ahci_port
*ap
, struct ata_port
*at
);
81 static int ahci_cam_probe_atapi(struct ahci_port
*ap
, struct ata_port
*at
);
82 static int ahci_set_xfer(struct ahci_port
*ap
, struct ata_port
*atx
);
83 static void ahci_ata_dummy_done(struct ata_xfer
*xa
);
84 static void ata_fix_identify(struct ata_identify
*id
);
85 static void ahci_cam_rescan(struct ahci_port
*ap
);
86 static void ahci_strip_string(const char **basep
, int *lenp
);
89 ahci_cam_attach(struct ahci_port
*ap
)
91 struct cam_devq
*devq
;
97 * We want at least one ccb to be available for error processing
98 * so don't let CAM use more then ncmds - 1.
100 unit
= device_get_unit(ap
->ap_sc
->sc_dev
);
101 if (ap
->ap_sc
->sc_ncmds
> 1)
102 devq
= cam_simq_alloc(ap
->ap_sc
->sc_ncmds
- 1);
104 devq
= cam_simq_alloc(ap
->ap_sc
->sc_ncmds
);
110 * Give the devq enough room to run with 32 max_dev_transactions,
111 * but set the overall max tags to 1 until NCQ is negotiated.
113 sim
= cam_sim_alloc(ahci_xpt_action
, ahci_xpt_poll
, "ahci",
114 (void *)ap
, unit
, &ap
->ap_sim_lock
,
116 cam_simq_release(devq
);
121 ahci_os_unlock_port(ap
);
122 lockmgr(&ap
->ap_sim_lock
, LK_EXCLUSIVE
);
123 error
= xpt_bus_register(ap
->ap_sim
, ap
->ap_num
);
124 lockmgr(&ap
->ap_sim_lock
, LK_RELEASE
);
125 ahci_os_lock_port(ap
);
126 if (error
!= CAM_SUCCESS
) {
130 ap
->ap_flags
|= AP_F_BUS_REGISTERED
;
132 if (ap
->ap_probe
== ATA_PROBE_NEED_IDENT
)
133 error
= ahci_cam_probe(ap
, NULL
);
140 ap
->ap_flags
|= AP_F_CAM_ATTACHED
;
146 * The state of the port has changed.
148 * If at is NULL the physical port has changed state.
149 * If at is non-NULL a particular target behind a PM has changed state.
151 * If found is -1 the target state must be queued to a non-interrupt context.
152 * (only works with at == NULL).
154 * If found is 0 the target was removed.
155 * If found is 1 the target was inserted.
158 ahci_cam_changed(struct ahci_port
*ap
, struct ata_port
*atx
, int found
)
160 struct cam_path
*tmppath
;
164 target
= atx
? atx
->at_target
: CAM_TARGET_WILDCARD
;
166 if (ap
->ap_sim
== NULL
)
168 if (found
== CAM_TARGET_WILDCARD
) {
169 status
= xpt_create_path(&tmppath
, NULL
,
170 cam_sim_path(ap
->ap_sim
),
171 target
, CAM_LUN_WILDCARD
);
172 if (status
!= CAM_REQ_CMP
)
176 status
= xpt_create_path(&tmppath
, NULL
,
177 cam_sim_path(ap
->ap_sim
),
180 if (status
!= CAM_REQ_CMP
)
187 xpt_async(AC_FOUND_DEVICE
, tmppath
, NULL
);
189 xpt_async(AC_LOST_DEVICE
, tmppath
, NULL
);
192 xpt_free_path(tmppath
);
196 ahci_cam_detach(struct ahci_port
*ap
)
200 if ((ap
->ap_flags
& AP_F_CAM_ATTACHED
) == 0)
202 lockmgr(&ap
->ap_sim_lock
, LK_EXCLUSIVE
);
204 xpt_freeze_simq(ap
->ap_sim
, 1);
206 if (ap
->ap_flags
& AP_F_BUS_REGISTERED
) {
207 error
= xpt_bus_deregister(cam_sim_path(ap
->ap_sim
));
208 KKASSERT(error
== CAM_REQ_CMP
);
209 ap
->ap_flags
&= ~AP_F_BUS_REGISTERED
;
212 cam_sim_free(ap
->ap_sim
);
215 lockmgr(&ap
->ap_sim_lock
, LK_RELEASE
);
216 ap
->ap_flags
&= ~AP_F_CAM_ATTACHED
;
220 * Once the AHCI port has been attached we need to probe for a device or
221 * devices on the port and setup various options.
223 * If at is NULL we are probing the direct-attached device on the port,
224 * which may or may not be a port multiplier.
227 ahci_cam_probe(struct ahci_port
*ap
, struct ata_port
*atx
)
232 u_int64_t capacity_bytes
;
239 const char *model_id
;
240 const char *firmware_id
;
241 const char *serial_id
;
250 * Delayed CAM attachment for initial probe, sim may be NULL
252 if (ap
->ap_sim
== NULL
)
256 * A NULL atx indicates a probe of the directly connected device.
257 * A non-NULL atx indicates a device connected via a port multiplier.
258 * We need to preserve atx for calls to ahci_ata_get_xfer().
260 * at is always non-NULL. For directly connected devices we supply
261 * an (at) pointing to target 0.
264 at
= ap
->ap_ata
[0]; /* direct attached - device 0 */
265 if (ap
->ap_type
== ATA_PORT_T_PM
) {
266 kprintf("%s: Found Port Multiplier\n",
270 at
->at_type
= ap
->ap_type
;
273 if (atx
->at_type
== ATA_PORT_T_PM
) {
274 kprintf("%s: Bogus device, reducing port count to %d\n",
275 ATANAME(ap
, atx
), atx
->at_target
);
276 if (ap
->ap_pmcount
> atx
->at_target
)
277 ap
->ap_pmcount
= atx
->at_target
;
281 if (ap
->ap_type
== ATA_PORT_T_NONE
)
283 if (at
->at_type
== ATA_PORT_T_NONE
)
287 * Issue identify, saving the result
289 xa
= ahci_ata_get_xfer(ap
, atx
);
290 xa
->complete
= ahci_ata_dummy_done
;
291 xa
->data
= &at
->at_identify
;
292 xa
->datalen
= sizeof(at
->at_identify
);
293 xa
->flags
= ATA_F_READ
| ATA_F_PIO
| ATA_F_POLL
;
294 xa
->fis
->flags
= ATA_H2D_FLAGS_CMD
| at
->at_target
;
296 switch(at
->at_type
) {
297 case ATA_PORT_T_DISK
:
298 xa
->fis
->command
= ATA_C_IDENTIFY
;
301 case ATA_PORT_T_ATAPI
:
302 xa
->fis
->command
= ATA_C_ATAPI_IDENTIFY
;
303 xa
->flags
|= ATA_F_AUTOSENSE
;
307 xa
->fis
->command
= ATA_C_ATAPI_IDENTIFY
;
308 type
= "UNKNOWN(ATAPI?)";
311 xa
->fis
->features
= 0;
315 if (ahci_ata_cmd(xa
) != ATA_S_COMPLETE
) {
316 kprintf("%s: Detected %s device but unable to IDENTIFY\n",
317 ATANAME(ap
, atx
), type
);
318 ahci_ata_put_xfer(xa
);
321 ahci_ata_put_xfer(xa
);
323 ata_fix_identify(&at
->at_identify
);
326 * Read capacity using SATA probe info.
328 if (le16toh(at
->at_identify
.cmdset83
) & 0x0400) {
329 /* LBA48 feature set supported */
331 for (i
= 3; i
>= 0; --i
) {
334 le16toh(at
->at_identify
.addrsecxt
[i
]);
337 capacity
= le16toh(at
->at_identify
.addrsec
[1]);
339 capacity
+= le16toh(at
->at_identify
.addrsec
[0]);
342 capacity
= 1024 * 1024 / 512;
343 at
->at_capacity
= capacity
;
345 ap
->ap_probe
= ATA_PROBE_GOOD
;
347 capacity_bytes
= capacity
* 512;
350 * Negotiate NCQ, throw away any ata_xfer's beyond the negotiated
351 * number of slots and limit the number of CAM ccb's to one less
352 * so we always have a slot available for recovery.
354 * NCQ is not used if ap_ncqdepth is 1 or the host controller does
355 * not support it, and in that case the driver can handle extra
358 * NCQ is currently used only with direct-attached disks. It is
359 * not used with port multipliers or direct-attached ATAPI devices.
361 * Remember at least one extra CCB needs to be reserved for the
364 if ((ap
->ap_sc
->sc_cap
& AHCI_REG_CAP_SNCQ
) &&
365 ap
->ap_type
== ATA_PORT_T_DISK
&&
366 (le16toh(at
->at_identify
.satacap
) & (1 << 8))) {
367 at
->at_ncqdepth
= (le16toh(at
->at_identify
.qdepth
) & 0x1F) + 1;
368 devncqdepth
= at
->at_ncqdepth
;
369 if (at
->at_ncqdepth
> ap
->ap_sc
->sc_ncmds
)
370 at
->at_ncqdepth
= ap
->ap_sc
->sc_ncmds
;
371 if (at
->at_ncqdepth
> 1) {
372 for (i
= 0; i
< ap
->ap_sc
->sc_ncmds
; ++i
) {
373 xa
= ahci_ata_get_xfer(ap
, atx
);
374 if (xa
->tag
< at
->at_ncqdepth
) {
375 xa
->state
= ATA_S_COMPLETE
;
376 ahci_ata_put_xfer(xa
);
379 if (at
->at_ncqdepth
>= ap
->ap_sc
->sc_ncmds
) {
380 cam_sim_set_max_tags(ap
->ap_sim
,
381 at
->at_ncqdepth
- 1);
388 model_len
= sizeof(at
->at_identify
.model
);
389 model_id
= at
->at_identify
.model
;
390 ahci_strip_string(&model_id
, &model_len
);
392 firmware_len
= sizeof(at
->at_identify
.firmware
);
393 firmware_id
= at
->at_identify
.firmware
;
394 ahci_strip_string(&firmware_id
, &firmware_len
);
396 serial_len
= sizeof(at
->at_identify
.serial
);
397 serial_id
= at
->at_identify
.serial
;
398 ahci_strip_string(&serial_id
, &serial_len
);
401 * Generate informatiive strings.
403 * NOTE: We do not automatically set write caching, lookahead,
404 * or the security state for ATAPI devices.
406 if (at
->at_identify
.cmdset82
& ATA_IDENTIFY_WRITECACHE
) {
407 if (at
->at_identify
.features85
& ATA_IDENTIFY_WRITECACHE
)
409 else if (at
->at_type
== ATA_PORT_T_ATAPI
)
417 if (at
->at_identify
.cmdset82
& ATA_IDENTIFY_LOOKAHEAD
) {
418 if (at
->at_identify
.features85
& ATA_IDENTIFY_LOOKAHEAD
)
420 else if (at
->at_type
== ATA_PORT_T_ATAPI
)
428 if (at
->at_identify
.cmdset82
& ATA_IDENTIFY_SECURITY
) {
429 if (at
->at_identify
.securestatus
& ATA_SECURE_FROZEN
)
431 else if (at
->at_type
== ATA_PORT_T_ATAPI
)
433 else if (AhciNoFeatures
& (1 << ap
->ap_num
))
434 scstr
= "<disabled>";
441 kprintf("%s: Found %s \"%*.*s %*.*s\" serial=\"%*.*s\"\n"
442 "%s: tags=%d/%d satacap=%04x satafea=%04x NCQ=%s "
443 "capacity=%lld.%02dMB\n",
447 model_len
, model_len
, model_id
,
448 firmware_len
, firmware_len
, firmware_id
,
449 serial_len
, serial_len
, serial_id
,
452 devncqdepth
, ap
->ap_sc
->sc_ncmds
,
453 at
->at_identify
.satacap
,
454 at
->at_identify
.satafsup
,
455 (at
->at_ncqdepth
> 1 ? "YES" : "NO"),
456 (long long)capacity_bytes
/ (1024 * 1024),
457 (int)(capacity_bytes
% (1024 * 1024)) * 100 / (1024 * 1024)
459 kprintf("%s: f85=%04x f86=%04x f87=%04x WC=%s RA=%s SEC=%s\n",
461 at
->at_identify
.features85
,
462 at
->at_identify
.features86
,
463 at
->at_identify
.features87
,
470 * Additional type-specific probing
472 switch(at
->at_type
) {
473 case ATA_PORT_T_DISK
:
474 error
= ahci_cam_probe_disk(ap
, atx
);
476 case ATA_PORT_T_ATAPI
:
477 error
= ahci_cam_probe_atapi(ap
, atx
);
485 at
->at_probe
= ATA_PROBE_FAILED
;
487 ap
->ap_probe
= at
->at_probe
;
489 at
->at_probe
= ATA_PROBE_GOOD
;
491 ap
->ap_probe
= at
->at_probe
;
497 * DISK-specific probe after initial ident
500 ahci_cam_probe_disk(struct ahci_port
*ap
, struct ata_port
*atx
)
505 at
= atx
? atx
: ap
->ap_ata
[0];
508 * Set dummy xfer mode
510 ahci_set_xfer(ap
, atx
);
513 * Enable write cache if supported
515 * NOTE: "WD My Book" external disk devices have a very poor
516 * daughter board between the the ESATA and the HD. Sending
517 * any ATA_C_SET_FEATURES commands will break the hardware port
518 * with a fatal protocol error. However, this device also
519 * indicates that WRITECACHE is already on and READAHEAD is
520 * not supported so we avoid the issue.
522 if ((at
->at_identify
.cmdset82
& ATA_IDENTIFY_WRITECACHE
) &&
523 (at
->at_identify
.features85
& ATA_IDENTIFY_WRITECACHE
) == 0) {
524 xa
= ahci_ata_get_xfer(ap
, atx
);
525 xa
->complete
= ahci_ata_dummy_done
;
526 xa
->fis
->command
= ATA_C_SET_FEATURES
;
527 xa
->fis
->features
= ATA_SF_WRITECACHE_EN
;
528 /* xa->fis->features = ATA_SF_LOOKAHEAD_EN; */
529 xa
->fis
->flags
= ATA_H2D_FLAGS_CMD
| at
->at_target
;
531 xa
->flags
= ATA_F_PIO
| ATA_F_POLL
;
534 if (ahci_ata_cmd(xa
) == ATA_S_COMPLETE
)
535 at
->at_features
|= ATA_PORT_F_WCACHE
;
537 kprintf("%s: Unable to enable write-caching\n",
539 ahci_ata_put_xfer(xa
);
543 * Enable readahead if supported
545 if ((at
->at_identify
.cmdset82
& ATA_IDENTIFY_LOOKAHEAD
) &&
546 (at
->at_identify
.features85
& ATA_IDENTIFY_LOOKAHEAD
) == 0) {
547 xa
= ahci_ata_get_xfer(ap
, atx
);
548 xa
->complete
= ahci_ata_dummy_done
;
549 xa
->fis
->command
= ATA_C_SET_FEATURES
;
550 xa
->fis
->features
= ATA_SF_LOOKAHEAD_EN
;
551 xa
->fis
->flags
= ATA_H2D_FLAGS_CMD
| at
->at_target
;
553 xa
->flags
= ATA_F_PIO
| ATA_F_POLL
;
556 if (ahci_ata_cmd(xa
) == ATA_S_COMPLETE
)
557 at
->at_features
|= ATA_PORT_F_RAHEAD
;
559 kprintf("%s: Unable to enable read-ahead\n",
561 ahci_ata_put_xfer(xa
);
565 * FREEZE LOCK the device so malicious users can't lock it on us.
566 * As there is no harm in issuing this to devices that don't
567 * support the security feature set we just send it, and don't bother
568 * checking if the device sends a command abort to tell us it doesn't
571 if ((at
->at_identify
.cmdset82
& ATA_IDENTIFY_SECURITY
) &&
572 (at
->at_identify
.securestatus
& ATA_SECURE_FROZEN
) == 0 &&
573 (AhciNoFeatures
& (1 << ap
->ap_num
)) == 0) {
574 xa
= ahci_ata_get_xfer(ap
, atx
);
575 xa
->complete
= ahci_ata_dummy_done
;
576 xa
->fis
->command
= ATA_C_SEC_FREEZE_LOCK
;
577 xa
->fis
->flags
= ATA_H2D_FLAGS_CMD
| at
->at_target
;
578 xa
->flags
= ATA_F_PIO
| ATA_F_POLL
;
581 if (ahci_ata_cmd(xa
) == ATA_S_COMPLETE
)
582 at
->at_features
|= ATA_PORT_F_FRZLCK
;
584 kprintf("%s: Unable to set security freeze\n",
586 ahci_ata_put_xfer(xa
);
593 * ATAPI-specific probe after initial ident
596 ahci_cam_probe_atapi(struct ahci_port
*ap
, struct ata_port
*atx
)
598 ahci_set_xfer(ap
, atx
);
603 * Setting the transfer mode is irrelevant for the SATA transport
604 * but some (atapi) devices seem to need it anyway. In addition
605 * if we are running through a SATA->PATA converter for some reason
606 * beyond my comprehension we might have to set the mode.
608 * We only support DMA modes for SATA attached devices, so don't bother
612 ahci_set_xfer(struct ahci_port
*ap
, struct ata_port
*atx
)
619 at
= atx
? atx
: ap
->ap_ata
[0];
622 * Figure out the supported UDMA mode. Ignore other legacy modes.
624 mask
= le16toh(at
->at_identify
.ultradma
);
625 if ((mask
& 0xFF) == 0 || mask
== 0xFFFF)
629 while ((mask
& 0x8000) == 0) {
635 * SATA atapi devices often still report a dma mode, even though
636 * it is irrelevant for SATA transport. It is also possible that
637 * we are running through a SATA->PATA converter and seeing the
640 * In this case the device may require a (dummy) SETXFER to be
641 * sent before it will work properly.
643 xa
= ahci_ata_get_xfer(ap
, atx
);
644 xa
->complete
= ahci_ata_dummy_done
;
645 xa
->fis
->command
= ATA_C_SET_FEATURES
;
646 xa
->fis
->features
= ATA_SF_SETXFER
;
647 xa
->fis
->flags
= ATA_H2D_FLAGS_CMD
| at
->at_target
;
648 xa
->fis
->sector_count
= mode
;
649 xa
->flags
= ATA_F_PIO
| ATA_F_POLL
;
652 if (ahci_ata_cmd(xa
) != ATA_S_COMPLETE
) {
653 kprintf("%s: Unable to set dummy xfer mode \n",
655 } else if (bootverbose
) {
656 kprintf("%s: Set dummy xfer mode to %02x\n",
657 ATANAME(ap
, atx
), mode
);
659 ahci_ata_put_xfer(xa
);
664 * Fix byte ordering so buffers can be accessed as
668 ata_fix_identify(struct ata_identify
*id
)
673 swap
= (u_int16_t
*)id
->serial
;
674 for (i
= 0; i
< sizeof(id
->serial
) / sizeof(u_int16_t
); i
++)
675 swap
[i
] = bswap16(swap
[i
]);
677 swap
= (u_int16_t
*)id
->firmware
;
678 for (i
= 0; i
< sizeof(id
->firmware
) / sizeof(u_int16_t
); i
++)
679 swap
[i
] = bswap16(swap
[i
]);
681 swap
= (u_int16_t
*)id
->model
;
682 for (i
= 0; i
< sizeof(id
->model
) / sizeof(u_int16_t
); i
++)
683 swap
[i
] = bswap16(swap
[i
]);
687 * Dummy done callback for xa.
690 ahci_ata_dummy_done(struct ata_xfer
*xa
)
695 * Use an engineering request to initiate a target scan for devices
696 * behind a port multiplier.
698 * An asynchronous bus scan is used to avoid reentrancy issues.
701 ahci_cam_rescan_callback(struct cam_periph
*periph
, union ccb
*ccb
)
703 struct ahci_port
*ap
= ccb
->ccb_h
.sim_priv
.entries
[0].ptr
;
705 if (ccb
->ccb_h
.func_code
== XPT_SCAN_BUS
) {
706 ap
->ap_flags
&= ~AP_F_SCAN_RUNNING
;
707 if (ap
->ap_flags
& AP_F_SCAN_REQUESTED
) {
708 ap
->ap_flags
&= ~AP_F_SCAN_REQUESTED
;
711 ap
->ap_flags
|= AP_F_SCAN_COMPLETED
;
712 wakeup(&ap
->ap_flags
);
718 ahci_cam_rescan(struct ahci_port
*ap
)
720 struct cam_path
*path
;
725 if (ap
->ap_flags
& AP_F_SCAN_RUNNING
) {
726 ap
->ap_flags
|= AP_F_SCAN_REQUESTED
;
729 ap
->ap_flags
|= AP_F_SCAN_RUNNING
;
730 for (i
= 0; i
< AHCI_MAX_PMPORTS
; ++i
) {
731 ap
->ap_ata
[i
]->at_features
|= ATA_PORT_F_RESCAN
;
734 status
= xpt_create_path(&path
, xpt_periph
, cam_sim_path(ap
->ap_sim
),
735 CAM_TARGET_WILDCARD
, CAM_LUN_WILDCARD
);
736 if (status
!= CAM_REQ_CMP
)
739 ccb
= xpt_alloc_ccb();
740 xpt_setup_ccb(&ccb
->ccb_h
, path
, 5); /* 5 = low priority */
741 ccb
->ccb_h
.func_code
= XPT_ENG_EXEC
;
742 ccb
->ccb_h
.cbfcnp
= ahci_cam_rescan_callback
;
743 ccb
->ccb_h
.sim_priv
.entries
[0].ptr
= ap
;
744 ccb
->crcn
.flags
= CAM_FLAG_NONE
;
745 xpt_action_async(ccb
);
749 ahci_xpt_rescan(struct ahci_port
*ap
)
751 struct cam_path
*path
;
755 status
= xpt_create_path(&path
, xpt_periph
, cam_sim_path(ap
->ap_sim
),
756 CAM_TARGET_WILDCARD
, CAM_LUN_WILDCARD
);
757 if (status
!= CAM_REQ_CMP
)
760 ccb
= xpt_alloc_ccb();
761 xpt_setup_ccb(&ccb
->ccb_h
, path
, 5); /* 5 = low priority */
762 ccb
->ccb_h
.func_code
= XPT_SCAN_BUS
;
763 ccb
->ccb_h
.cbfcnp
= ahci_cam_rescan_callback
;
764 ccb
->ccb_h
.sim_priv
.entries
[0].ptr
= ap
;
765 ccb
->crcn
.flags
= CAM_FLAG_NONE
;
766 xpt_action_async(ccb
);
770 * Action function - dispatch command
774 ahci_xpt_action(struct cam_sim
*sim
, union ccb
*ccb
)
776 struct ahci_port
*ap
;
777 struct ata_port
*at
, *atx
;
778 struct ccb_hdr
*ccbh
;
782 ap
= cam_sim_softc(sim
);
784 KKASSERT(ap
!= NULL
);
786 unit
= cam_sim_unit(sim
);
789 * Early failure checks. These checks do not apply to XPT_PATH_INQ,
790 * otherwise the bus rescan will not remove the dead devices when
793 * For non-wildcards we have one target (0) and one lun (0),
794 * unless we have a port multiplier.
796 * A wildcard target indicates only the general bus is being
799 * Calculate at and atx. at is always non-NULL. atx is only
800 * non-NULL for direct-attached devices. It will be NULL for
801 * devices behind a port multiplier.
803 * XXX What do we do with a LUN wildcard?
805 if (ccbh
->target_id
!= CAM_TARGET_WILDCARD
&&
806 ccbh
->func_code
!= XPT_PATH_INQ
) {
807 if (ap
->ap_type
== ATA_PORT_T_NONE
) {
808 ccbh
->status
= CAM_DEV_NOT_THERE
;
812 if (ccbh
->target_id
< 0 || ccbh
->target_id
>= ap
->ap_pmcount
) {
813 ccbh
->status
= CAM_DEV_NOT_THERE
;
817 at
= ap
->ap_ata
[ccbh
->target_id
];
818 if (ap
->ap_type
== ATA_PORT_T_PM
)
821 if (ccbh
->target_lun
!= CAM_LUN_WILDCARD
&& ccbh
->target_lun
) {
822 ccbh
->status
= CAM_DEV_NOT_THERE
;
831 * Switch on the meta XPT command
833 switch(ccbh
->func_code
) {
836 * This routine is called after a port multiplier has been
839 ccbh
->status
= CAM_REQ_CMP
;
840 ahci_os_lock_port(ap
);
841 ahci_port_state_machine(ap
, 0);
842 ahci_os_unlock_port(ap
);
848 * This command always succeeds, otherwise the bus scan
849 * will not detach dead devices.
851 ccb
->cpi
.version_num
= 1;
852 ccb
->cpi
.hba_inquiry
= 0;
853 ccb
->cpi
.target_sprt
= 0;
854 ccb
->cpi
.hba_misc
= PIM_SEQSCAN
;
855 ccb
->cpi
.hba_eng_cnt
= 0;
856 bzero(ccb
->cpi
.vuhba_flags
, sizeof(ccb
->cpi
.vuhba_flags
));
857 ccb
->cpi
.max_target
= AHCI_MAX_PMPORTS
- 1;
858 ccb
->cpi
.max_lun
= 0;
859 ccb
->cpi
.async_flags
= 0;
860 ccb
->cpi
.hpath_id
= 0;
861 ccb
->cpi
.initiator_id
= AHCI_MAX_PMPORTS
- 1;
862 ccb
->cpi
.unit_number
= cam_sim_unit(sim
);
863 ccb
->cpi
.bus_id
= cam_sim_bus(sim
);
864 ccb
->cpi
.base_transfer_speed
= 150000;
865 ccb
->cpi
.transport
= XPORT_SATA
;
866 ccb
->cpi
.transport_version
= 1;
867 ccb
->cpi
.protocol
= PROTO_SCSI
;
868 ccb
->cpi
.protocol_version
= SCSI_REV_2
;
870 ccbh
->status
= CAM_REQ_CMP
;
871 if (ccbh
->target_id
== CAM_TARGET_WILDCARD
) {
872 ahci_os_lock_port(ap
);
873 ahci_port_state_machine(ap
, 0);
874 ahci_os_unlock_port(ap
);
876 switch(ahci_pread(ap
, AHCI_PREG_SSTS
) &
877 AHCI_PREG_SSTS_SPD
) {
878 case AHCI_PREG_SSTS_SPD_GEN1
:
879 ccb
->cpi
.base_transfer_speed
= 150000;
881 case AHCI_PREG_SSTS_SPD_GEN2
:
882 ccb
->cpi
.base_transfer_speed
= 300000;
884 case AHCI_PREG_SSTS_SPD_GEN3
:
885 ccb
->cpi
.base_transfer_speed
= 600000;
889 ccb
->cpi
.base_transfer_speed
= 1000;
893 if (ap
->ap_type
== ATA_PORT_T_NONE
)
894 ccbh
->status
= CAM_DEV_NOT_THERE
;
900 ahci_os_lock_port(ap
);
901 if (ap
->ap_type
== ATA_PORT_T_NONE
) {
902 ccbh
->status
= CAM_DEV_NOT_THERE
;
904 ahci_port_reset(ap
, atx
, 0);
905 ccbh
->status
= CAM_REQ_CMP
;
907 ahci_os_unlock_port(ap
);
911 ahci_os_lock_port(ap
);
912 ahci_port_reset(ap
, NULL
, 1);
913 ahci_os_unlock_port(ap
);
914 ccbh
->status
= CAM_REQ_CMP
;
917 case XPT_SET_TRAN_SETTINGS
:
918 ccbh
->status
= CAM_FUNC_NOTAVAIL
;
921 case XPT_GET_TRAN_SETTINGS
:
922 ccb
->cts
.protocol
= PROTO_SCSI
;
923 ccb
->cts
.protocol_version
= SCSI_REV_2
;
924 ccb
->cts
.transport
= XPORT_SATA
;
925 ccb
->cts
.transport_version
= XPORT_VERSION_UNSPECIFIED
;
926 ccb
->cts
.proto_specific
.valid
= 0;
927 ccb
->cts
.xport_specific
.valid
= 0;
928 ccbh
->status
= CAM_REQ_CMP
;
931 case XPT_CALC_GEOMETRY
:
932 cam_calc_geometry(&ccb
->ccg
, 1);
937 * Our parallel startup code might have only probed through
938 * to the IDENT, so do the last step if necessary.
940 if (at
->at_probe
== ATA_PROBE_NEED_IDENT
)
941 ahci_cam_probe(ap
, atx
);
942 if (at
->at_probe
!= ATA_PROBE_GOOD
) {
943 ccbh
->status
= CAM_DEV_NOT_THERE
;
947 switch(at
->at_type
) {
948 case ATA_PORT_T_DISK
:
949 ahci_xpt_scsi_disk_io(ap
, atx
, ccb
);
951 case ATA_PORT_T_ATAPI
:
952 ahci_xpt_scsi_atapi_io(ap
, atx
, ccb
);
955 ccbh
->status
= CAM_REQ_INVALID
;
963 struct ccb_scsiio
*csio
;
965 cdb
= (void *)((ccbh
->flags
& CAM_CDB_POINTER
) ?
966 csio
->cdb_io
.cdb_ptr
: csio
->cdb_io
.cdb_bytes
);
967 cdb
->generic
.opcode
= TRIM
;
968 ahci_xpt_scsi_disk_io(ap
, atx
, ccb
);
972 ccbh
->status
= CAM_REQ_INVALID
;
981 * Generally this function gets called heavily when interrupts might be
982 * non-operational, during a halt/reboot or panic.
986 ahci_xpt_poll(struct cam_sim
*sim
)
988 struct ahci_port
*ap
;
990 ap
= cam_sim_softc(sim
);
992 ahci_os_lock_port(ap
);
993 ahci_port_intr(ap
, 1);
994 ahci_os_unlock_port(ap
);
999 * Convert the SCSI command in ccb to an ata_xfer command in xa
1000 * for ATA_PORT_T_DISK operations. Set the completion function
1001 * to convert the response back, then dispatch to the OpenBSD AHCI
1004 * AHCI DISK commands only support a limited command set, and we
1005 * fake additional commands to make it play nice with the CAM subsystem.
1009 ahci_xpt_scsi_disk_io(struct ahci_port
*ap
, struct ata_port
*atx
,
1012 struct ccb_hdr
*ccbh
;
1013 struct ccb_scsiio
*csio
;
1014 struct ata_xfer
*xa
;
1015 struct ata_port
*at
;
1016 struct ata_fis_h2d
*fis
;
1017 struct ata_pass_12
*atp12
;
1018 struct ata_pass_16
*atp16
;
1020 union scsi_data
*rdata
;
1026 ccbh
= &ccb
->csio
.ccb_h
;
1028 at
= atx
? atx
: ap
->ap_ata
[0];
1031 * XXX not passing NULL at for direct attach!
1033 xa
= ahci_ata_get_xfer(ap
, atx
);
1034 rdata
= (void *)csio
->data_ptr
;
1035 rdata_len
= csio
->dxfer_len
;
1038 * Build the FIS or process the csio to completion.
1040 cdb
= (void *)((ccbh
->flags
& CAM_CDB_POINTER
) ?
1041 csio
->cdb_io
.cdb_ptr
: csio
->cdb_io
.cdb_bytes
);
1043 switch(cdb
->generic
.opcode
) {
1046 * Auto-sense everything, so explicit sense requests
1049 ccbh
->status
= CAM_SCSI_STATUS_ERROR
;
1053 * Inquiry supported features
1055 * [opcode, byte2, page_code, length, control]
1057 if (cdb
->inquiry
.byte2
& SI_EVPD
) {
1058 ahci_xpt_page_inquiry(ap
, at
, ccb
);
1060 bzero(rdata
, rdata_len
);
1061 if (rdata_len
< SHORT_INQUIRY_LENGTH
) {
1062 ccbh
->status
= CAM_CCB_LEN_ERR
;
1065 if (rdata_len
> sizeof(rdata
->inquiry_data
))
1066 rdata_len
= sizeof(rdata
->inquiry_data
);
1067 rdata
->inquiry_data
.device
= T_DIRECT
;
1068 rdata
->inquiry_data
.version
= SCSI_REV_SPC2
;
1069 rdata
->inquiry_data
.response_format
= 2;
1070 rdata
->inquiry_data
.additional_length
= 32;
1071 bcopy("SATA ", rdata
->inquiry_data
.vendor
, 8);
1072 bcopy(at
->at_identify
.model
,
1073 rdata
->inquiry_data
.product
,
1074 sizeof(rdata
->inquiry_data
.product
));
1075 bcopy(at
->at_identify
.firmware
,
1076 rdata
->inquiry_data
.revision
,
1077 sizeof(rdata
->inquiry_data
.revision
));
1078 ccbh
->status
= CAM_REQ_CMP
;
1082 * Use the vendor specific area to set the TRIM status
1085 if (at
->at_identify
.support_dsm
) {
1086 rdata
->inquiry_data
.vendor_specific1
[0] =
1087 at
->at_identify
.support_dsm
&ATA_SUPPORT_DSM_TRIM
;
1088 rdata
->inquiry_data
.vendor_specific1
[1] =
1089 at
->at_identify
.max_dsm_blocks
;
1092 case READ_CAPACITY_16
:
1093 if (cdb
->read_capacity_16
.service_action
!= SRC16_SERVICE_ACTION
) {
1094 ccbh
->status
= CAM_REQ_INVALID
;
1097 if (rdata_len
< sizeof(rdata
->read_capacity_data_16
)) {
1098 ccbh
->status
= CAM_CCB_LEN_ERR
;
1103 if (rdata_len
< sizeof(rdata
->read_capacity_data
)) {
1104 ccbh
->status
= CAM_CCB_LEN_ERR
;
1108 capacity
= at
->at_capacity
;
1110 bzero(rdata
, rdata_len
);
1111 if (cdb
->generic
.opcode
== READ_CAPACITY
) {
1112 rdata_len
= sizeof(rdata
->read_capacity_data
);
1113 if (capacity
> 0xFFFFFFFFU
)
1114 capacity
= 0xFFFFFFFFU
;
1115 bzero(&rdata
->read_capacity_data
, rdata_len
);
1116 scsi_ulto4b((u_int32_t
)capacity
- 1,
1117 rdata
->read_capacity_data
.addr
);
1118 scsi_ulto4b(512, rdata
->read_capacity_data
.length
);
1120 rdata_len
= sizeof(rdata
->read_capacity_data_16
);
1121 bzero(&rdata
->read_capacity_data_16
, rdata_len
);
1122 scsi_u64to8b(capacity
- 1,
1123 rdata
->read_capacity_data_16
.addr
);
1124 scsi_ulto4b(512, rdata
->read_capacity_data_16
.length
);
1126 ccbh
->status
= CAM_REQ_CMP
;
1128 case SYNCHRONIZE_CACHE
:
1130 * Synchronize cache. Specification says this can take
1131 * greater then 30 seconds so give it at least 45.
1134 fis
->flags
= ATA_H2D_FLAGS_CMD
;
1135 fis
->command
= ATA_C_FLUSH_CACHE
;
1137 if (xa
->timeout
< 45000)
1138 xa
->timeout
= 45000;
1141 xa
->complete
= ahci_ata_complete_disk_synchronize_cache
;
1145 fis
->command
= ATA_C_DATA_SET_MANAGEMENT
;
1146 fis
->features
= (u_int8_t
)ATA_SF_DSM_TRIM
;
1147 fis
->features_exp
= (u_int8_t
)(ATA_SF_DSM_TRIM
>> 8);
1149 xa
->flags
= ATA_F_WRITE
;
1150 fis
->flags
= ATA_H2D_FLAGS_CMD
;
1152 xa
->data
= csio
->data_ptr
;
1153 xa
->datalen
= csio
->dxfer_len
;
1154 xa
->timeout
= ccbh
->timeout
*50; /* milliseconds */
1156 fis
->sector_count
=(u_int8_t
)(xa
->datalen
/512);
1157 fis
->sector_count_exp
=(u_int8_t
)((xa
->datalen
/512)>>8);
1160 fis
->lba_low
= (u_int8_t
)lba
;
1161 fis
->lba_mid
= (u_int8_t
)(lba
>> 8);
1162 fis
->lba_high
= (u_int8_t
)(lba
>> 16);
1163 fis
->lba_low_exp
= (u_int8_t
)(lba
>> 24);
1164 fis
->lba_mid_exp
= (u_int8_t
)(lba
>> 32);
1165 fis
->lba_high_exp
= (u_int8_t
)(lba
>> 40);
1167 fis
->device
= ATA_H2D_DEVICE_LBA
;
1168 xa
->data
= csio
->data_ptr
;
1170 xa
->complete
= ahci_ata_complete_disk_rw
;
1171 ccbh
->status
= CAM_REQ_INPROG
;
1173 case TEST_UNIT_READY
:
1174 case START_STOP_UNIT
:
1177 * Just silently return success
1179 ccbh
->status
= CAM_REQ_CMP
;
1183 atp12
= &cdb
->ata_pass_12
;
1186 * Figure out the flags to be used, depending on the direction of the
1189 switch (ccbh
->flags
& CAM_DIR_MASK
) {
1191 xa
->flags
= ATA_F_READ
;
1194 xa
->flags
= ATA_F_WRITE
;
1199 xa
->flags
|= ATA_F_POLL
| ATA_F_EXCLUSIVE
;
1200 xa
->data
= csio
->data_ptr
;
1201 xa
->datalen
= csio
->dxfer_len
;
1202 xa
->complete
= ahci_ata_complete_disk_rw
;
1203 xa
->timeout
= ccbh
->timeout
;
1206 * Populate the fis from the information we received through CAM
1209 fis
->flags
= ATA_H2D_FLAGS_CMD
; /* maybe also atp12->flags ? */
1210 fis
->features
= atp12
->features
;
1211 fis
->sector_count
= atp12
->sector_count
;
1212 fis
->lba_low
= atp12
->lba_low
;
1213 fis
->lba_mid
= atp12
->lba_mid
;
1214 fis
->lba_high
= atp12
->lba_high
;
1215 fis
->device
= atp12
->device
; /* maybe always 0? */
1216 fis
->command
= atp12
->command
;
1217 fis
->control
= atp12
->control
;
1220 * Mark as in progress so it is sent to the device.
1222 ccbh
->status
= CAM_REQ_INPROG
;
1225 atp16
= &cdb
->ata_pass_16
;
1228 * Figure out the flags to be used, depending on the direction of the
1231 switch (ccbh
->flags
& CAM_DIR_MASK
) {
1233 xa
->flags
= ATA_F_READ
;
1236 xa
->flags
= ATA_F_WRITE
;
1241 xa
->flags
|= ATA_F_POLL
| ATA_F_EXCLUSIVE
;
1242 xa
->data
= csio
->data_ptr
;
1243 xa
->datalen
= csio
->dxfer_len
;
1244 xa
->complete
= ahci_ata_complete_disk_rw
;
1245 xa
->timeout
= ccbh
->timeout
;
1248 * Populate the fis from the information we received through CAM
1251 fis
->flags
= ATA_H2D_FLAGS_CMD
; /* maybe also atp16->flags ? */
1252 fis
->features
= atp16
->features
;
1253 fis
->features_exp
= atp16
->features_ext
;
1254 fis
->sector_count
= atp16
->sector_count
;
1255 fis
->sector_count_exp
= atp16
->sector_count_ext
;
1256 fis
->lba_low
= atp16
->lba_low
;
1257 fis
->lba_low_exp
= atp16
->lba_low_ext
;
1258 fis
->lba_mid
= atp16
->lba_mid
;
1259 fis
->lba_mid_exp
= atp16
->lba_mid_ext
;
1260 fis
->lba_high
= atp16
->lba_high
;
1261 fis
->lba_mid_exp
= atp16
->lba_mid_ext
;
1262 fis
->device
= atp16
->device
; /* maybe always 0? */
1263 fis
->command
= atp16
->command
;
1266 * Mark as in progress so it is sent to the device.
1268 ccbh
->status
= CAM_REQ_INPROG
;
1271 switch(cdb
->generic
.opcode
) {
1273 lba
= scsi_3btoul(cdb
->rw_6
.addr
) & 0x1FFFFF;
1274 count
= cdb
->rw_6
.length
? cdb
->rw_6
.length
: 0x100;
1275 xa
->flags
= ATA_F_READ
;
1278 lba
= scsi_4btoul(cdb
->rw_10
.addr
);
1279 count
= scsi_2btoul(cdb
->rw_10
.length
);
1280 xa
->flags
= ATA_F_READ
;
1283 lba
= scsi_4btoul(cdb
->rw_12
.addr
);
1284 count
= scsi_4btoul(cdb
->rw_12
.length
);
1285 xa
->flags
= ATA_F_READ
;
1288 lba
= scsi_8btou64(cdb
->rw_16
.addr
);
1289 count
= scsi_4btoul(cdb
->rw_16
.length
);
1290 xa
->flags
= ATA_F_READ
;
1293 lba
= scsi_3btoul(cdb
->rw_6
.addr
) & 0x1FFFFF;
1294 count
= cdb
->rw_6
.length
? cdb
->rw_6
.length
: 0x100;
1295 xa
->flags
= ATA_F_WRITE
;
1298 lba
= scsi_4btoul(cdb
->rw_10
.addr
);
1299 count
= scsi_2btoul(cdb
->rw_10
.length
);
1300 xa
->flags
= ATA_F_WRITE
;
1303 lba
= scsi_4btoul(cdb
->rw_12
.addr
);
1304 count
= scsi_4btoul(cdb
->rw_12
.length
);
1305 xa
->flags
= ATA_F_WRITE
;
1308 lba
= scsi_8btou64(cdb
->rw_16
.addr
);
1309 count
= scsi_4btoul(cdb
->rw_16
.length
);
1310 xa
->flags
= ATA_F_WRITE
;
1313 ccbh
->status
= CAM_REQ_INVALID
;
1316 if (ccbh
->status
!= CAM_REQ_INPROG
)
1320 fis
->flags
= ATA_H2D_FLAGS_CMD
;
1321 fis
->lba_low
= (u_int8_t
)lba
;
1322 fis
->lba_mid
= (u_int8_t
)(lba
>> 8);
1323 fis
->lba_high
= (u_int8_t
)(lba
>> 16);
1324 fis
->device
= ATA_H2D_DEVICE_LBA
;
1327 * NCQ only for direct-attached disks, do not currently
1328 * try to use NCQ with port multipliers.
1330 if (at
->at_ncqdepth
> 1 &&
1331 ap
->ap_type
== ATA_PORT_T_DISK
&&
1332 (ap
->ap_sc
->sc_cap
& AHCI_REG_CAP_SNCQ
) &&
1333 (ccbh
->flags
& CAM_POLLED
) == 0) {
1335 * Use NCQ - always uses 48 bit addressing
1337 xa
->flags
|= ATA_F_NCQ
;
1338 fis
->command
= (xa
->flags
& ATA_F_WRITE
) ?
1339 ATA_C_WRITE_FPDMA
: ATA_C_READ_FPDMA
;
1340 fis
->lba_low_exp
= (u_int8_t
)(lba
>> 24);
1341 fis
->lba_mid_exp
= (u_int8_t
)(lba
>> 32);
1342 fis
->lba_high_exp
= (u_int8_t
)(lba
>> 40);
1343 fis
->sector_count
= xa
->tag
<< 3;
1344 fis
->features
= (u_int8_t
)count
;
1345 fis
->features_exp
= (u_int8_t
)(count
>> 8);
1346 } else if (count
> 0x100 || lba
> 0x0FFFFFFFU
) {
1350 fis
->command
= (xa
->flags
& ATA_F_WRITE
) ?
1351 ATA_C_WRITEDMA_EXT
: ATA_C_READDMA_EXT
;
1352 fis
->lba_low_exp
= (u_int8_t
)(lba
>> 24);
1353 fis
->lba_mid_exp
= (u_int8_t
)(lba
>> 32);
1354 fis
->lba_high_exp
= (u_int8_t
)(lba
>> 40);
1355 fis
->sector_count
= (u_int8_t
)count
;
1356 fis
->sector_count_exp
= (u_int8_t
)(count
>> 8);
1361 * NOTE: 256 sectors is supported, stored as 0.
1363 fis
->command
= (xa
->flags
& ATA_F_WRITE
) ?
1364 ATA_C_WRITEDMA
: ATA_C_READDMA
;
1365 fis
->device
|= (u_int8_t
)(lba
>> 24) & 0x0F;
1366 fis
->sector_count
= (u_int8_t
)count
;
1369 xa
->data
= csio
->data_ptr
;
1370 xa
->datalen
= csio
->dxfer_len
;
1371 xa
->complete
= ahci_ata_complete_disk_rw
;
1372 xa
->timeout
= ccbh
->timeout
; /* milliseconds */
1374 if (xa
->timeout
> 10000) /* XXX - debug */
1375 xa
->timeout
= 10000;
1377 if (ccbh
->flags
& CAM_POLLED
)
1378 xa
->flags
|= ATA_F_POLL
;
1383 * If the request is still in progress the xa and FIS have
1384 * been set up (except for the PM target), and must be dispatched.
1385 * Otherwise the request was completed.
1387 if (ccbh
->status
== CAM_REQ_INPROG
) {
1388 KKASSERT(xa
->complete
!= NULL
);
1389 xa
->atascsi_private
= ccb
;
1390 ccb
->ccb_h
.sim_priv
.entries
[0].ptr
= ap
;
1391 ahci_os_lock_port(ap
);
1392 xa
->fis
->flags
|= at
->at_target
;
1394 ahci_os_unlock_port(ap
);
1396 ahci_ata_put_xfer(xa
);
1402 * Convert the SCSI command in ccb to an ata_xfer command in xa
1403 * for ATA_PORT_T_ATAPI operations. Set the completion function
1404 * to convert the response back, then dispatch to the OpenBSD AHCI
1409 ahci_xpt_scsi_atapi_io(struct ahci_port
*ap
, struct ata_port
*atx
,
1412 struct ccb_hdr
*ccbh
;
1413 struct ccb_scsiio
*csio
;
1414 struct ata_xfer
*xa
;
1415 struct ata_fis_h2d
*fis
;
1419 struct ata_port
*at
;
1421 ccbh
= &ccb
->csio
.ccb_h
;
1423 at
= atx
? atx
: ap
->ap_ata
[0];
1425 switch (ccbh
->flags
& CAM_DIR_MASK
) {
1427 flags
= ATA_F_PACKET
| ATA_F_READ
;
1430 flags
= ATA_F_PACKET
| ATA_F_WRITE
;
1433 flags
= ATA_F_PACKET
;
1436 ccbh
->status
= CAM_REQ_INVALID
;
1443 * Special handling to get the rfis back into host memory while
1444 * still allowing the chip to run commands in parallel to
1445 * ATAPI devices behind a PM.
1447 flags
|= ATA_F_AUTOSENSE
;
1450 * The command has to fit in the packet command buffer.
1452 if (csio
->cdb_len
< 6 || csio
->cdb_len
> 16) {
1453 ccbh
->status
= CAM_CCB_LEN_ERR
;
1459 * Initialize the XA and FIS. It is unclear how much of
1460 * this has to mimic the equivalent ATA command.
1462 * XXX not passing NULL at for direct attach!
1464 xa
= ahci_ata_get_xfer(ap
, atx
);
1467 fis
->flags
= ATA_H2D_FLAGS_CMD
| at
->at_target
;
1468 fis
->command
= ATA_C_PACKET
;
1469 fis
->device
= ATA_H2D_DEVICE_LBA
;
1470 fis
->sector_count
= xa
->tag
<< 3;
1471 if (flags
& (ATA_F_READ
| ATA_F_WRITE
)) {
1472 if (flags
& ATA_F_WRITE
) {
1473 fis
->features
= ATA_H2D_FEATURES_DMA
|
1474 ATA_H2D_FEATURES_DIR_WRITE
;
1476 fis
->features
= ATA_H2D_FEATURES_DMA
|
1477 ATA_H2D_FEATURES_DIR_READ
;
1483 fis
->control
= ATA_FIS_CONTROL_4BIT
;
1486 xa
->data
= csio
->data_ptr
;
1487 xa
->datalen
= csio
->dxfer_len
;
1488 xa
->timeout
= ccbh
->timeout
; /* milliseconds */
1490 if (ccbh
->flags
& CAM_POLLED
)
1491 xa
->flags
|= ATA_F_POLL
;
1494 * Copy the cdb to the packetcmd buffer in the FIS using a
1495 * convenient pointer in the xa.
1497 * Zero-out any trailing bytes in case the ATAPI device cares.
1499 cdbs
= (void *)((ccbh
->flags
& CAM_CDB_POINTER
) ?
1500 csio
->cdb_io
.cdb_ptr
: csio
->cdb_io
.cdb_bytes
);
1501 bcopy(cdbs
, xa
->packetcmd
, csio
->cdb_len
);
1502 if (csio
->cdb_len
< 16)
1503 bzero(xa
->packetcmd
+ csio
->cdb_len
, 16 - csio
->cdb_len
);
1506 kprintf("opcode %d cdb_len %d dxfer_len %d\n",
1507 cdbs
->generic
.opcode
,
1508 csio
->cdb_len
, csio
->dxfer_len
);
1512 * Some ATAPI commands do not actually follow the SCSI standard.
1514 cdbd
= (void *)xa
->packetcmd
;
1516 switch(cdbd
->generic
.opcode
) {
1519 * Force SENSE requests to the ATAPI sense length.
1521 * It is unclear if this is needed or not.
1523 if (cdbd
->sense
.length
== SSD_FULL_SIZE
) {
1525 kprintf("%s: Shortening sense request\n",
1528 cdbd
->sense
.length
= offsetof(struct scsi_sense_data
,
1534 * Some ATAPI devices can't handle long inquiry lengths,
1535 * don't ask me why. Truncate the inquiry length.
1537 if (cdbd
->inquiry
.page_code
== 0 &&
1538 cdbd
->inquiry
.length
> SHORT_INQUIRY_LENGTH
) {
1539 cdbd
->inquiry
.length
= SHORT_INQUIRY_LENGTH
;
1545 * Convert *_6 to *_10 commands. Most ATAPI devices
1546 * cannot handle the SCSI READ_6 and WRITE_6 commands.
1548 cdbd
->rw_10
.opcode
|= 0x20;
1549 cdbd
->rw_10
.byte2
= 0;
1550 cdbd
->rw_10
.addr
[0] = cdbs
->rw_6
.addr
[0] & 0x1F;
1551 cdbd
->rw_10
.addr
[1] = cdbs
->rw_6
.addr
[1];
1552 cdbd
->rw_10
.addr
[2] = cdbs
->rw_6
.addr
[2];
1553 cdbd
->rw_10
.addr
[3] = 0;
1554 cdbd
->rw_10
.reserved
= 0;
1555 cdbd
->rw_10
.length
[0] = 0;
1556 cdbd
->rw_10
.length
[1] = cdbs
->rw_6
.length
;
1557 cdbd
->rw_10
.control
= cdbs
->rw_6
.control
;
1566 xa
->complete
= ahci_atapi_complete_cmd
;
1567 xa
->atascsi_private
= ccb
;
1568 ccb
->ccb_h
.sim_priv
.entries
[0].ptr
= ap
;
1569 ahci_os_lock_port(ap
);
1571 ahci_os_unlock_port(ap
);
1575 * Simulate page inquiries for disk attachments.
1579 ahci_xpt_page_inquiry(struct ahci_port
*ap
, struct ata_port
*at
, union ccb
*ccb
)
1582 struct scsi_vpd_supported_page_list list
;
1583 struct scsi_vpd_unit_serial_number serno
;
1584 struct scsi_vpd_unit_devid devid
;
1592 page
= kmalloc(sizeof(*page
), M_DEVBUF
, M_WAITOK
| M_ZERO
);
1594 cdb
= (void *)((ccb
->ccb_h
.flags
& CAM_CDB_POINTER
) ?
1595 ccb
->csio
.cdb_io
.cdb_ptr
: ccb
->csio
.cdb_io
.cdb_bytes
);
1597 switch(cdb
->inquiry
.page_code
) {
1598 case SVPD_SUPPORTED_PAGE_LIST
:
1600 page
->list
.device
= T_DIRECT
;
1601 page
->list
.page_code
= SVPD_SUPPORTED_PAGE_LIST
;
1602 page
->list
.list
[i
++] = SVPD_SUPPORTED_PAGE_LIST
;
1603 page
->list
.list
[i
++] = SVPD_UNIT_SERIAL_NUMBER
;
1604 page
->list
.list
[i
++] = SVPD_UNIT_DEVID
;
1605 page
->list
.length
= i
;
1606 len
= offsetof(struct scsi_vpd_supported_page_list
, list
[3]);
1608 case SVPD_UNIT_SERIAL_NUMBER
:
1610 j
= sizeof(at
->at_identify
.serial
);
1611 for (i
= 0; i
< j
&& at
->at_identify
.serial
[i
] == ' '; ++i
)
1613 while (j
> i
&& at
->at_identify
.serial
[j
-1] == ' ')
1615 page
->serno
.device
= T_DIRECT
;
1616 page
->serno
.page_code
= SVPD_UNIT_SERIAL_NUMBER
;
1617 page
->serno
.length
= j
- i
;
1618 bcopy(at
->at_identify
.serial
+ i
,
1619 page
->serno
.serial_num
, j
- i
);
1620 len
= offsetof(struct scsi_vpd_unit_serial_number
,
1623 case SVPD_UNIT_DEVID
:
1624 /* fall through for now */
1626 ccb
->ccb_h
.status
= CAM_FUNC_NOTAVAIL
;
1630 if (ccb
->ccb_h
.status
== CAM_REQ_INPROG
) {
1631 if (len
<= ccb
->csio
.dxfer_len
) {
1632 ccb
->ccb_h
.status
= CAM_REQ_CMP
;
1633 bzero(ccb
->csio
.data_ptr
, ccb
->csio
.dxfer_len
);
1634 bcopy(page
, ccb
->csio
.data_ptr
, len
);
1635 ccb
->csio
.resid
= ccb
->csio
.dxfer_len
- len
;
1637 ccb
->ccb_h
.status
= CAM_CCB_LEN_ERR
;
1640 kfree(page
, M_DEVBUF
);
1644 * Completion function for ATA_PORT_T_DISK cache synchronization.
1648 ahci_ata_complete_disk_synchronize_cache(struct ata_xfer
*xa
)
1650 union ccb
*ccb
= xa
->atascsi_private
;
1651 struct ccb_hdr
*ccbh
= &ccb
->ccb_h
;
1652 struct ahci_port
*ap
= ccb
->ccb_h
.sim_priv
.entries
[0].ptr
;
1655 case ATA_S_COMPLETE
:
1656 ccbh
->status
= CAM_REQ_CMP
;
1657 ccb
->csio
.scsi_status
= SCSI_STATUS_OK
;
1660 kprintf("%s: synchronize_cache: error\n",
1661 ATANAME(ap
, xa
->at
));
1662 ccbh
->status
= CAM_SCSI_STATUS_ERROR
| CAM_AUTOSNS_VALID
;
1663 ccb
->csio
.scsi_status
= SCSI_STATUS_CHECK_COND
;
1664 ahci_ata_dummy_sense(&ccb
->csio
.sense_data
);
1667 kprintf("%s: synchronize_cache: timeout\n",
1668 ATANAME(ap
, xa
->at
));
1669 ccbh
->status
= CAM_CMD_TIMEOUT
;
1672 kprintf("%s: synchronize_cache: unknown state %d\n",
1673 ATANAME(ap
, xa
->at
), xa
->state
);
1674 panic("%s: Unknown state", ATANAME(ap
, xa
->at
));
1675 ccbh
->status
= CAM_REQ_CMP_ERR
;
1678 ahci_ata_put_xfer(xa
);
1679 ahci_os_unlock_port(ap
);
1681 ahci_os_lock_port(ap
);
1685 * Completion function for ATA_PORT_T_DISK I/O
1689 ahci_ata_complete_disk_rw(struct ata_xfer
*xa
)
1691 union ccb
*ccb
= xa
->atascsi_private
;
1692 struct ccb_hdr
*ccbh
= &ccb
->ccb_h
;
1693 struct ahci_port
*ap
= ccb
->ccb_h
.sim_priv
.entries
[0].ptr
;
1696 case ATA_S_COMPLETE
:
1697 ccbh
->status
= CAM_REQ_CMP
;
1698 ccb
->csio
.scsi_status
= SCSI_STATUS_OK
;
1701 kprintf("%s: disk_rw: error\n", ATANAME(ap
, xa
->at
));
1702 ccbh
->status
= CAM_SCSI_STATUS_ERROR
| CAM_AUTOSNS_VALID
;
1703 ccb
->csio
.scsi_status
= SCSI_STATUS_CHECK_COND
;
1704 ahci_ata_dummy_sense(&ccb
->csio
.sense_data
);
1707 kprintf("%s: disk_rw: timeout\n", ATANAME(ap
, xa
->at
));
1708 ccbh
->status
= CAM_CMD_TIMEOUT
;
1709 ccb
->csio
.scsi_status
= SCSI_STATUS_CHECK_COND
;
1710 ahci_ata_dummy_sense(&ccb
->csio
.sense_data
);
1713 kprintf("%s: disk_rw: unknown state %d\n",
1714 ATANAME(ap
, xa
->at
), xa
->state
);
1715 panic("%s: Unknown state", ATANAME(ap
, xa
->at
));
1716 ccbh
->status
= CAM_REQ_CMP_ERR
;
1719 ccb
->csio
.resid
= xa
->resid
;
1720 ahci_ata_put_xfer(xa
);
1721 ahci_os_unlock_port(ap
);
1723 ahci_os_lock_port(ap
);
1727 * Completion function for ATA_PORT_T_ATAPI I/O
1729 * Sense data is returned in the rfis.
1733 ahci_atapi_complete_cmd(struct ata_xfer
*xa
)
1735 union ccb
*ccb
= xa
->atascsi_private
;
1736 struct ccb_hdr
*ccbh
= &ccb
->ccb_h
;
1737 struct ahci_port
*ap
= ccb
->ccb_h
.sim_priv
.entries
[0].ptr
;
1740 cdb
= (void *)((ccb
->ccb_h
.flags
& CAM_CDB_POINTER
) ?
1741 ccb
->csio
.cdb_io
.cdb_ptr
: ccb
->csio
.cdb_io
.cdb_bytes
);
1744 case ATA_S_COMPLETE
:
1745 ccbh
->status
= CAM_REQ_CMP
;
1746 ccb
->csio
.scsi_status
= SCSI_STATUS_OK
;
1749 ccbh
->status
= CAM_SCSI_STATUS_ERROR
;
1750 ccb
->csio
.scsi_status
= SCSI_STATUS_CHECK_COND
;
1751 ahci_ata_atapi_sense(&xa
->rfis
, &ccb
->csio
.sense_data
);
1754 kprintf("%s: cmd %d: timeout\n",
1755 PORTNAME(ap
), cdb
->generic
.opcode
);
1756 ccbh
->status
= CAM_CMD_TIMEOUT
;
1757 ccb
->csio
.scsi_status
= SCSI_STATUS_CHECK_COND
;
1758 ahci_ata_dummy_sense(&ccb
->csio
.sense_data
);
1761 kprintf("%s: cmd %d: unknown state %d\n",
1762 PORTNAME(ap
), cdb
->generic
.opcode
, xa
->state
);
1763 panic("%s: Unknown state", PORTNAME(ap
));
1764 ccbh
->status
= CAM_REQ_CMP_ERR
;
1767 ccb
->csio
.resid
= xa
->resid
;
1768 ahci_ata_put_xfer(xa
);
1769 ahci_os_unlock_port(ap
);
1771 ahci_os_lock_port(ap
);
1775 * Construct dummy sense data for errors on DISKs
1779 ahci_ata_dummy_sense(struct scsi_sense_data
*sense_data
)
1781 sense_data
->error_code
= SSD_ERRCODE_VALID
| SSD_CURRENT_ERROR
;
1782 sense_data
->segment
= 0;
1783 sense_data
->flags
= SSD_KEY_MEDIUM_ERROR
;
1784 sense_data
->info
[0] = 0;
1785 sense_data
->info
[1] = 0;
1786 sense_data
->info
[2] = 0;
1787 sense_data
->info
[3] = 0;
1788 sense_data
->extra_len
= 0;
1792 * Construct atapi sense data for errors on ATAPI
1794 * The ATAPI sense data is stored in the passed rfis and must be converted
1795 * to SCSI sense data.
1799 ahci_ata_atapi_sense(struct ata_fis_d2h
*rfis
,
1800 struct scsi_sense_data
*sense_data
)
1802 sense_data
->error_code
= SSD_ERRCODE_VALID
| SSD_CURRENT_ERROR
;
1803 sense_data
->segment
= 0;
1804 sense_data
->flags
= (rfis
->error
& 0xF0) >> 4;
1805 if (rfis
->error
& 0x04)
1806 sense_data
->flags
|= SSD_KEY_ILLEGAL_REQUEST
;
1807 if (rfis
->error
& 0x02)
1808 sense_data
->flags
|= SSD_EOM
;
1809 if (rfis
->error
& 0x01)
1810 sense_data
->flags
|= SSD_ILI
;
1811 sense_data
->info
[0] = 0;
1812 sense_data
->info
[1] = 0;
1813 sense_data
->info
[2] = 0;
1814 sense_data
->info
[3] = 0;
1815 sense_data
->extra_len
= 0;
1820 ahci_strip_string(const char **basep
, int *lenp
)
1822 const char *base
= *basep
;
1825 while (len
&& (*base
== 0 || *base
== ' ')) {
1829 while (len
&& (base
[len
-1] == 0 || base
[len
-1] == ' '))