2 * Copyright (c) 2009 Alexander Motin <mav@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer,
10 * without modification, immediately at the beginning of the file.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/param.h>
35 #include <sys/systm.h>
36 #include <sys/libkern.h>
37 #include <sys/kernel.h>
38 #include <sys/sysctl.h>
45 #define min(a,b) (((a)<(b))?(a):(b))
50 #include <cam/cam_ccb.h>
51 #include <cam/cam_queue.h>
52 #include <cam/cam_xpt.h>
54 #include <cam/ata/ata_all.h>
56 #include <sys/endian.h>
65 for (bit = 15; bit >= 0; bit--)
72 ata_op_string(struct ata_cmd *cmd)
75 if (cmd->control & 0x04)
76 return ("SOFT_RESET");
77 switch (cmd->command) {
78 case 0x00: return ("NOP");
79 case 0x03: return ("CFA_REQUEST_EXTENDED_ERROR");
81 switch (cmd->features) {
82 case 0x01: return ("DSM TRIM");
85 case 0x08: return ("DEVICE_RESET");
86 case 0x20: return ("READ");
87 case 0x24: return ("READ48");
88 case 0x25: return ("READ_DMA48");
89 case 0x26: return ("READ_DMA_QUEUED48");
90 case 0x27: return ("READ_NATIVE_MAX_ADDRESS48");
91 case 0x29: return ("READ_MUL48");
92 case 0x2a: return ("READ_STREAM_DMA48");
93 case 0x2b: return ("READ_STREAM48");
94 case 0x2f: return ("READ_LOG_EXT");
95 case 0x30: return ("WRITE");
96 case 0x34: return ("WRITE48");
97 case 0x35: return ("WRITE_DMA48");
98 case 0x36: return ("WRITE_DMA_QUEUED48");
99 case 0x37: return ("SET_MAX_ADDRESS48");
100 case 0x39: return ("WRITE_MUL48");
101 case 0x3a: return ("WRITE_STREAM_DMA48");
102 case 0x3b: return ("WRITE_STREAM48");
103 case 0x3d: return ("WRITE_DMA_FUA48");
104 case 0x3e: return ("WRITE_DMA_QUEUED_FUA48");
105 case 0x3f: return ("WRITE_LOG_EXT");
106 case 0x40: return ("READ_VERIFY");
107 case 0x42: return ("READ_VERIFY48");
108 case 0x51: return ("CONFIGURE_STREAM");
109 case 0x60: return ("READ_FPDMA_QUEUED");
110 case 0x61: return ("WRITE_FPDMA_QUEUED");
111 case 0x70: return ("SEEK");
112 case 0x87: return ("CFA_TRANSLATE_SECTOR");
113 case 0x90: return ("EXECUTE_DEVICE_DIAGNOSTIC");
114 case 0x92: return ("DOWNLOAD_MICROCODE");
115 case 0xa0: return ("PACKET");
116 case 0xa1: return ("ATAPI_IDENTIFY");
117 case 0xa2: return ("SERVICE");
118 case 0xb0: return ("SMART");
119 case 0xb1: return ("DEVICE CONFIGURATION");
120 case 0xc0: return ("CFA_ERASE");
121 case 0xc4: return ("READ_MUL");
122 case 0xc5: return ("WRITE_MUL");
123 case 0xc6: return ("SET_MULTI");
124 case 0xc7: return ("READ_DMA_QUEUED");
125 case 0xc8: return ("READ_DMA");
126 case 0xca: return ("WRITE_DMA");
127 case 0xcc: return ("WRITE_DMA_QUEUED");
128 case 0xcd: return ("CFA_WRITE_MULTIPLE_WITHOUT_ERASE");
129 case 0xce: return ("WRITE_MUL_FUA48");
130 case 0xd1: return ("CHECK_MEDIA_CARD_TYPE");
131 case 0xda: return ("GET_MEDIA_STATUS");
132 case 0xde: return ("MEDIA_LOCK");
133 case 0xdf: return ("MEDIA_UNLOCK");
134 case 0xe0: return ("STANDBY_IMMEDIATE");
135 case 0xe1: return ("IDLE_IMMEDIATE");
136 case 0xe2: return ("STANDBY");
137 case 0xe3: return ("IDLE");
138 case 0xe4: return ("READ_BUFFER/PM");
139 case 0xe5: return ("CHECK_POWER_MODE");
140 case 0xe6: return ("SLEEP");
141 case 0xe7: return ("FLUSHCACHE");
142 case 0xe8: return ("WRITE_PM");
143 case 0xea: return ("FLUSHCACHE48");
144 case 0xec: return ("ATA_IDENTIFY");
145 case 0xed: return ("MEDIA_EJECT");
147 switch (cmd->features) {
148 case 0x03: return ("SETFEATURES SET TRANSFER MODE");
149 case 0x02: return ("SETFEATURES ENABLE WCACHE");
150 case 0x82: return ("SETFEATURES DISABLE WCACHE");
151 case 0x06: return ("SETFEATURES ENABLE PUIS");
152 case 0x86: return ("SETFEATURES DISABLE PUIS");
153 case 0x07: return ("SETFEATURES SPIN-UP");
154 case 0x10: return ("SETFEATURES ENABLE SATA FEATURE");
155 case 0x90: return ("SETFEATURES DISABLE SATA FEATURE");
156 case 0xaa: return ("SETFEATURES ENABLE RCACHE");
157 case 0x55: return ("SETFEATURES DISABLE RCACHE");
159 return "SETFEATURES";
160 case 0xf1: return ("SECURITY_SET_PASSWORD");
161 case 0xf2: return ("SECURITY_UNLOCK");
162 case 0xf3: return ("SECURITY_ERASE_PREPARE");
163 case 0xf4: return ("SECURITY_ERASE_UNIT");
164 case 0xf5: return ("SECURITY_FREE_LOCK");
165 case 0xf6: return ("SECURITY DISABLE PASSWORD");
166 case 0xf8: return ("READ_NATIVE_MAX_ADDRESS");
167 case 0xf9: return ("SET_MAX_ADDRESS");
173 ata_cmd_string(struct ata_cmd *cmd, char *cmd_string, size_t len)
176 snprintf(cmd_string, len, "%02x %02x %02x %02x "
177 "%02x %02x %02x %02x %02x %02x %02x %02x",
178 cmd->command, cmd->features,
179 cmd->lba_low, cmd->lba_mid, cmd->lba_high, cmd->device,
180 cmd->lba_low_exp, cmd->lba_mid_exp, cmd->lba_high_exp,
181 cmd->features_exp, cmd->sector_count, cmd->sector_count_exp);
187 ata_res_string(struct ata_res *res, char *res_string, size_t len)
190 snprintf(res_string, len, "%02x %02x %02x %02x "
191 "%02x %02x %02x %02x %02x %02x %02x",
192 res->status, res->error,
193 res->lba_low, res->lba_mid, res->lba_high, res->device,
194 res->lba_low_exp, res->lba_mid_exp, res->lba_high_exp,
195 res->sector_count, res->sector_count_exp);
201 * ata_command_sbuf() returns 0 for success and -1 for failure.
204 ata_command_sbuf(struct ccb_ataio *ataio, struct sbuf *sb)
206 char cmd_str[(12 * 3) + 1];
208 sbuf_printf(sb, "%s. ACB: %s",
209 ata_op_string(&ataio->cmd),
210 ata_cmd_string(&ataio->cmd, cmd_str, sizeof(cmd_str)));
216 * ata_status_abuf() returns 0 for success and -1 for failure.
219 ata_status_sbuf(struct ccb_ataio *ataio, struct sbuf *sb)
222 sbuf_printf(sb, "ATA status: %02x (%s%s%s%s%s%s%s%s)",
224 (ataio->res.status & 0x80) ? "BSY " : "",
225 (ataio->res.status & 0x40) ? "DRDY " : "",
226 (ataio->res.status & 0x20) ? "DF " : "",
227 (ataio->res.status & 0x10) ? "SERV " : "",
228 (ataio->res.status & 0x08) ? "DRQ " : "",
229 (ataio->res.status & 0x04) ? "CORR " : "",
230 (ataio->res.status & 0x02) ? "IDX " : "",
231 (ataio->res.status & 0x01) ? "ERR" : "");
232 if (ataio->res.status & 1) {
233 sbuf_printf(sb, ", error: %02x (%s%s%s%s%s%s%s%s)",
235 (ataio->res.error & 0x80) ? "ICRC " : "",
236 (ataio->res.error & 0x40) ? "UNC " : "",
237 (ataio->res.error & 0x20) ? "MC " : "",
238 (ataio->res.error & 0x10) ? "IDNF " : "",
239 (ataio->res.error & 0x08) ? "MCR " : "",
240 (ataio->res.error & 0x04) ? "ABRT " : "",
241 (ataio->res.error & 0x02) ? "NM " : "",
242 (ataio->res.error & 0x01) ? "ILI" : "");
249 * ata_res_sbuf() returns 0 for success and -1 for failure.
252 ata_res_sbuf(struct ccb_ataio *ataio, struct sbuf *sb)
254 char res_str[(11 * 3) + 1];
256 sbuf_printf(sb, "RES: %s",
257 ata_res_string(&ataio->res, res_str, sizeof(res_str)));
263 ata_print_ident(struct ata_params *ident_data)
265 char product[48], revision[16];
267 cam_strvis(product, ident_data->model, sizeof(ident_data->model),
269 cam_strvis(revision, ident_data->revision, sizeof(ident_data->revision),
271 printf("<%s %s> %s-%d",
273 (ident_data->config == ATA_PROTO_CFA) ? "CFA" :
274 (ident_data->config & ATA_PROTO_ATAPI) ? "ATAPI" : "ATA",
275 ata_version(ident_data->version_major));
276 if (ident_data->satacapabilities && ident_data->satacapabilities != 0xffff) {
277 if (ident_data->satacapabilities & ATA_SATA_GEN3)
279 else if (ident_data->satacapabilities & ATA_SATA_GEN2)
281 else if (ident_data->satacapabilities & ATA_SATA_GEN1)
290 ata_logical_sector_size(struct ata_params *ident_data)
292 if ((ident_data->pss & 0xc000) == 0x4000 &&
293 (ident_data->pss & ATA_PSS_LSSABOVE512)) {
294 return ((u_int32_t)ident_data->lss_1 |
295 ((u_int32_t)ident_data->lss_2 << 16));
301 ata_physical_sector_size(struct ata_params *ident_data)
303 if ((ident_data->pss & 0xc000) == 0x4000 &&
304 (ident_data->pss & ATA_PSS_MULTLS)) {
305 return ((uint64_t)ata_logical_sector_size(ident_data) *
306 (1 << (ident_data->pss & ATA_PSS_LSPPS)));
312 ata_logical_sector_offset(struct ata_params *ident_data)
314 if ((ident_data->lsalign & 0xc000) == 0x4000) {
315 return ((uint64_t)ata_logical_sector_size(ident_data) *
316 (ident_data->lsalign & 0x3fff));
322 ata_28bit_cmd(struct ccb_ataio *ataio, uint8_t cmd, uint8_t features,
323 uint32_t lba, uint8_t sector_count)
325 bzero(&ataio->cmd, sizeof(ataio->cmd));
326 ataio->cmd.flags = 0;
327 if (cmd == ATA_READ_DMA ||
328 cmd == ATA_READ_DMA_QUEUED ||
329 cmd == ATA_WRITE_DMA ||
330 cmd == ATA_WRITE_DMA_QUEUED)
331 ataio->cmd.flags |= CAM_ATAIO_DMA;
332 ataio->cmd.command = cmd;
333 ataio->cmd.features = features;
334 ataio->cmd.lba_low = lba;
335 ataio->cmd.lba_mid = lba >> 8;
336 ataio->cmd.lba_high = lba >> 16;
337 ataio->cmd.device = 0x40 | ((lba >> 24) & 0x0f);
338 ataio->cmd.sector_count = sector_count;
342 ata_48bit_cmd(struct ccb_ataio *ataio, uint8_t cmd, uint16_t features,
343 uint64_t lba, uint16_t sector_count)
345 bzero(&ataio->cmd, sizeof(ataio->cmd));
346 ataio->cmd.flags = CAM_ATAIO_48BIT;
347 if (cmd == ATA_READ_DMA48 ||
348 cmd == ATA_READ_DMA_QUEUED48 ||
349 cmd == ATA_READ_STREAM_DMA48 ||
350 cmd == ATA_WRITE_DMA48 ||
351 cmd == ATA_WRITE_DMA_FUA48 ||
352 cmd == ATA_WRITE_DMA_QUEUED48 ||
353 cmd == ATA_WRITE_DMA_QUEUED_FUA48 ||
354 cmd == ATA_WRITE_STREAM_DMA48 ||
355 cmd == ATA_DATA_SET_MANAGEMENT)
356 ataio->cmd.flags |= CAM_ATAIO_DMA;
357 ataio->cmd.command = cmd;
358 ataio->cmd.features = features;
359 ataio->cmd.lba_low = lba;
360 ataio->cmd.lba_mid = lba >> 8;
361 ataio->cmd.lba_high = lba >> 16;
362 ataio->cmd.device = 0x40;
363 ataio->cmd.lba_low_exp = lba >> 24;
364 ataio->cmd.lba_mid_exp = lba >> 32;
365 ataio->cmd.lba_high_exp = lba >> 40;
366 ataio->cmd.features_exp = features >> 8;
367 ataio->cmd.sector_count = sector_count;
368 ataio->cmd.sector_count_exp = sector_count >> 8;
372 ata_ncq_cmd(struct ccb_ataio *ataio, uint8_t cmd,
373 uint64_t lba, uint16_t sector_count)
375 bzero(&ataio->cmd, sizeof(ataio->cmd));
376 ataio->cmd.flags = CAM_ATAIO_48BIT | CAM_ATAIO_FPDMA;
377 ataio->cmd.command = cmd;
378 ataio->cmd.features = sector_count;
379 ataio->cmd.lba_low = lba;
380 ataio->cmd.lba_mid = lba >> 8;
381 ataio->cmd.lba_high = lba >> 16;
382 ataio->cmd.device = 0x40;
383 ataio->cmd.lba_low_exp = lba >> 24;
384 ataio->cmd.lba_mid_exp = lba >> 32;
385 ataio->cmd.lba_high_exp = lba >> 40;
386 ataio->cmd.features_exp = sector_count >> 8;
390 ata_reset_cmd(struct ccb_ataio *ataio)
392 bzero(&ataio->cmd, sizeof(ataio->cmd));
393 ataio->cmd.flags = CAM_ATAIO_CONTROL | CAM_ATAIO_NEEDRESULT;
394 ataio->cmd.control = 0x04;
398 ata_pm_read_cmd(struct ccb_ataio *ataio, int reg, int port)
400 bzero(&ataio->cmd, sizeof(ataio->cmd));
401 ataio->cmd.flags = CAM_ATAIO_NEEDRESULT;
402 ataio->cmd.command = ATA_READ_PM;
403 ataio->cmd.features = reg;
404 ataio->cmd.device = port & 0x0f;
408 ata_pm_write_cmd(struct ccb_ataio *ataio, int reg, int port, uint32_t val)
410 bzero(&ataio->cmd, sizeof(ataio->cmd));
411 ataio->cmd.flags = 0;
412 ataio->cmd.command = ATA_WRITE_PM;
413 ataio->cmd.features = reg;
414 ataio->cmd.sector_count = val;
415 ataio->cmd.lba_low = val >> 8;
416 ataio->cmd.lba_mid = val >> 16;
417 ataio->cmd.lba_high = val >> 24;
418 ataio->cmd.device = port & 0x0f;
422 ata_bswap(int8_t *buf, int len)
424 u_int16_t *ptr = (u_int16_t*)(buf + len);
426 while (--ptr >= (u_int16_t*)buf)
427 *ptr = be16toh(*ptr);
431 ata_btrim(int8_t *buf, int len)
435 for (ptr = buf; ptr < buf+len; ++ptr)
436 if (!*ptr || *ptr == '_')
438 for (ptr = buf + len - 1; ptr >= buf && *ptr == ' '; --ptr)
443 ata_bpack(int8_t *src, int8_t *dst, int len)
447 for (i = j = blank = 0 ; i < len; i++) {
448 if (blank && src[i] == ' ') continue;
449 if (blank && src[i] != ' ') {
466 ata_max_pmode(struct ata_params *ap)
468 if (ap->atavalid & ATA_FLAG_64_70) {
469 if (ap->apiomodes & 0x02)
471 if (ap->apiomodes & 0x01)
474 if (ap->mwdmamodes & 0x04)
476 if (ap->mwdmamodes & 0x02)
478 if (ap->mwdmamodes & 0x01)
480 if ((ap->retired_piomode & ATA_RETIRED_PIO_MASK) == 0x200)
482 if ((ap->retired_piomode & ATA_RETIRED_PIO_MASK) == 0x100)
484 if ((ap->retired_piomode & ATA_RETIRED_PIO_MASK) == 0x000)
490 ata_max_wmode(struct ata_params *ap)
492 if (ap->mwdmamodes & 0x04)
494 if (ap->mwdmamodes & 0x02)
496 if (ap->mwdmamodes & 0x01)
502 ata_max_umode(struct ata_params *ap)
504 if (ap->atavalid & ATA_FLAG_88) {
505 if (ap->udmamodes & 0x40)
507 if (ap->udmamodes & 0x20)
509 if (ap->udmamodes & 0x10)
511 if (ap->udmamodes & 0x08)
513 if (ap->udmamodes & 0x04)
515 if (ap->udmamodes & 0x02)
517 if (ap->udmamodes & 0x01)
524 ata_max_mode(struct ata_params *ap, int maxmode)
528 maxmode = ATA_DMA_MAX;
529 if (maxmode >= ATA_UDMA0 && ata_max_umode(ap) > 0)
530 return (min(maxmode, ata_max_umode(ap)));
531 if (maxmode >= ATA_WDMA0 && ata_max_wmode(ap) > 0)
532 return (min(maxmode, ata_max_wmode(ap)));
533 return (min(maxmode, ata_max_pmode(ap)));
537 ata_mode2string(int mode)
540 case -1: return "UNSUPPORTED";
541 case 0: return "NONE";
542 case ATA_PIO0: return "PIO0";
543 case ATA_PIO1: return "PIO1";
544 case ATA_PIO2: return "PIO2";
545 case ATA_PIO3: return "PIO3";
546 case ATA_PIO4: return "PIO4";
547 case ATA_WDMA0: return "WDMA0";
548 case ATA_WDMA1: return "WDMA1";
549 case ATA_WDMA2: return "WDMA2";
550 case ATA_UDMA0: return "UDMA0";
551 case ATA_UDMA1: return "UDMA1";
552 case ATA_UDMA2: return "UDMA2";
553 case ATA_UDMA3: return "UDMA3";
554 case ATA_UDMA4: return "UDMA4";
555 case ATA_UDMA5: return "UDMA5";
556 case ATA_UDMA6: return "UDMA6";
558 if (mode & ATA_DMA_MASK)
566 ata_string2mode(char *str)
568 if (!strcasecmp(str, "PIO0")) return (ATA_PIO0);
569 if (!strcasecmp(str, "PIO1")) return (ATA_PIO1);
570 if (!strcasecmp(str, "PIO2")) return (ATA_PIO2);
571 if (!strcasecmp(str, "PIO3")) return (ATA_PIO3);
572 if (!strcasecmp(str, "PIO4")) return (ATA_PIO4);
573 if (!strcasecmp(str, "WDMA0")) return (ATA_WDMA0);
574 if (!strcasecmp(str, "WDMA1")) return (ATA_WDMA1);
575 if (!strcasecmp(str, "WDMA2")) return (ATA_WDMA2);
576 if (!strcasecmp(str, "UDMA0")) return (ATA_UDMA0);
577 if (!strcasecmp(str, "UDMA16")) return (ATA_UDMA0);
578 if (!strcasecmp(str, "UDMA1")) return (ATA_UDMA1);
579 if (!strcasecmp(str, "UDMA25")) return (ATA_UDMA1);
580 if (!strcasecmp(str, "UDMA2")) return (ATA_UDMA2);
581 if (!strcasecmp(str, "UDMA33")) return (ATA_UDMA2);
582 if (!strcasecmp(str, "UDMA3")) return (ATA_UDMA3);
583 if (!strcasecmp(str, "UDMA44")) return (ATA_UDMA3);
584 if (!strcasecmp(str, "UDMA4")) return (ATA_UDMA4);
585 if (!strcasecmp(str, "UDMA66")) return (ATA_UDMA4);
586 if (!strcasecmp(str, "UDMA5")) return (ATA_UDMA5);
587 if (!strcasecmp(str, "UDMA100")) return (ATA_UDMA5);
588 if (!strcasecmp(str, "UDMA6")) return (ATA_UDMA6);
589 if (!strcasecmp(str, "UDMA133")) return (ATA_UDMA6);
595 ata_mode2speed(int mode)
633 ata_revision2speed(int revision)
647 ata_speed2revision(u_int speed)
664 ata_identify_match(caddr_t identbuffer, caddr_t table_entry)
666 struct scsi_inquiry_pattern *entry;
667 struct ata_params *ident;
669 entry = (struct scsi_inquiry_pattern *)table_entry;
670 ident = (struct ata_params *)identbuffer;
672 if ((cam_strmatch(ident->model, entry->product,
673 sizeof(ident->model)) == 0)
674 && (cam_strmatch(ident->revision, entry->revision,
675 sizeof(ident->revision)) == 0)) {
682 ata_static_identify_match(caddr_t identbuffer, caddr_t table_entry)
684 struct scsi_static_inquiry_pattern *entry;
685 struct ata_params *ident;
687 entry = (struct scsi_static_inquiry_pattern *)table_entry;
688 ident = (struct ata_params *)identbuffer;
690 if ((cam_strmatch(ident->model, entry->product,
691 sizeof(ident->model)) == 0)
692 && (cam_strmatch(ident->revision, entry->revision,
693 sizeof(ident->revision)) == 0)) {