xref: /freebsd/sys/cam/ata/ata_all.c (revision 84dfba8d183d31e3412639ecb4b8ad4433cf7e80)
1 /*-
2  * Copyright (c) 2009 Alexander Motin <mav@FreeBSD.org>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
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.
14  *
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.
25  */
26 
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
29 
30 #include <sys/param.h>
31 
32 #ifdef _KERNEL
33 #include <opt_scsi.h>
34 
35 #include <sys/systm.h>
36 #include <sys/libkern.h>
37 #include <sys/kernel.h>
38 #include <sys/sysctl.h>
39 #else
40 #include <errno.h>
41 #include <stdio.h>
42 #include <stdlib.h>
43 #include <string.h>
44 #ifndef min
45 #define min(a,b) (((a)<(b))?(a):(b))
46 #endif
47 #endif
48 
49 #include <cam/cam.h>
50 #include <cam/cam_ccb.h>
51 #include <cam/cam_queue.h>
52 #include <cam/cam_xpt.h>
53 #include <sys/ata.h>
54 #include <cam/ata/ata_all.h>
55 #include <sys/sbuf.h>
56 #include <sys/endian.h>
57 
58 int
59 ata_version(int ver)
60 {
61 	int bit;
62 
63 	if (ver == 0xffff)
64 		return 0;
65 	for (bit = 15; bit >= 0; bit--)
66 		if (ver & (1<<bit))
67 			return bit;
68 	return 0;
69 }
70 
71 char *
72 ata_op_string(struct ata_cmd *cmd)
73 {
74 
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");
80 	case 0x06:
81 		switch (cmd->features) {
82 	        case 0x01: return ("DSM TRIM");
83 	        }
84 	        return "DSM";
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 0x67:
112 		if (cmd->features == 0xec)
113 			return ("SEP_ATTN IDENTIFY");
114 		switch (cmd->lba_low) {
115 		case 0x00: return ("SEP_ATTN READ BUFFER");
116 		case 0x02: return ("SEP_ATTN RECEIVE DIAGNOSTIC RESULTS");
117 		case 0x80: return ("SEP_ATTN WRITE BUFFER");
118 		case 0x82: return ("SEP_ATTN SEND DIAGNOSTIC");
119 		}
120 		return ("SEP_ATTN");
121 	case 0x70: return ("SEEK");
122 	case 0x87: return ("CFA_TRANSLATE_SECTOR");
123 	case 0x90: return ("EXECUTE_DEVICE_DIAGNOSTIC");
124 	case 0x92: return ("DOWNLOAD_MICROCODE");
125 	case 0xa0: return ("PACKET");
126 	case 0xa1: return ("ATAPI_IDENTIFY");
127 	case 0xa2: return ("SERVICE");
128 	case 0xb0: return ("SMART");
129 	case 0xb1: return ("DEVICE CONFIGURATION");
130 	case 0xc0: return ("CFA_ERASE");
131 	case 0xc4: return ("READ_MUL");
132 	case 0xc5: return ("WRITE_MUL");
133 	case 0xc6: return ("SET_MULTI");
134 	case 0xc7: return ("READ_DMA_QUEUED");
135 	case 0xc8: return ("READ_DMA");
136 	case 0xca: return ("WRITE_DMA");
137 	case 0xcc: return ("WRITE_DMA_QUEUED");
138 	case 0xcd: return ("CFA_WRITE_MULTIPLE_WITHOUT_ERASE");
139 	case 0xce: return ("WRITE_MUL_FUA48");
140 	case 0xd1: return ("CHECK_MEDIA_CARD_TYPE");
141 	case 0xda: return ("GET_MEDIA_STATUS");
142 	case 0xde: return ("MEDIA_LOCK");
143 	case 0xdf: return ("MEDIA_UNLOCK");
144 	case 0xe0: return ("STANDBY_IMMEDIATE");
145 	case 0xe1: return ("IDLE_IMMEDIATE");
146 	case 0xe2: return ("STANDBY");
147 	case 0xe3: return ("IDLE");
148 	case 0xe4: return ("READ_BUFFER/PM");
149 	case 0xe5: return ("CHECK_POWER_MODE");
150 	case 0xe6: return ("SLEEP");
151 	case 0xe7: return ("FLUSHCACHE");
152 	case 0xe8: return ("WRITE_PM");
153 	case 0xea: return ("FLUSHCACHE48");
154 	case 0xec: return ("ATA_IDENTIFY");
155 	case 0xed: return ("MEDIA_EJECT");
156 	case 0xef:
157 		switch (cmd->features) {
158 	        case 0x03: return ("SETFEATURES SET TRANSFER MODE");
159 	        case 0x02: return ("SETFEATURES ENABLE WCACHE");
160 	        case 0x82: return ("SETFEATURES DISABLE WCACHE");
161 	        case 0x06: return ("SETFEATURES ENABLE PUIS");
162 	        case 0x86: return ("SETFEATURES DISABLE PUIS");
163 	        case 0x07: return ("SETFEATURES SPIN-UP");
164 	        case 0x10: return ("SETFEATURES ENABLE SATA FEATURE");
165 	        case 0x90: return ("SETFEATURES DISABLE SATA FEATURE");
166 	        case 0xaa: return ("SETFEATURES ENABLE RCACHE");
167 	        case 0x55: return ("SETFEATURES DISABLE RCACHE");
168 	        }
169 	        return "SETFEATURES";
170 	case 0xf1: return ("SECURITY_SET_PASSWORD");
171 	case 0xf2: return ("SECURITY_UNLOCK");
172 	case 0xf3: return ("SECURITY_ERASE_PREPARE");
173 	case 0xf4: return ("SECURITY_ERASE_UNIT");
174 	case 0xf5: return ("SECURITY_FREEZE_LOCK");
175 	case 0xf6: return ("SECURITY_DISABLE_PASSWORD");
176 	case 0xf8: return ("READ_NATIVE_MAX_ADDRESS");
177 	case 0xf9: return ("SET_MAX_ADDRESS");
178 	}
179 	return "UNKNOWN";
180 }
181 
182 char *
183 ata_cmd_string(struct ata_cmd *cmd, char *cmd_string, size_t len)
184 {
185 
186 	snprintf(cmd_string, len, "%02x %02x %02x %02x "
187 	    "%02x %02x %02x %02x %02x %02x %02x %02x",
188 	    cmd->command, cmd->features,
189 	    cmd->lba_low, cmd->lba_mid, cmd->lba_high, cmd->device,
190 	    cmd->lba_low_exp, cmd->lba_mid_exp, cmd->lba_high_exp,
191 	    cmd->features_exp, cmd->sector_count, cmd->sector_count_exp);
192 
193 	return(cmd_string);
194 }
195 
196 char *
197 ata_res_string(struct ata_res *res, char *res_string, size_t len)
198 {
199 
200 	snprintf(res_string, len, "%02x %02x %02x %02x "
201 	    "%02x %02x %02x %02x %02x %02x %02x",
202 	    res->status, res->error,
203 	    res->lba_low, res->lba_mid, res->lba_high, res->device,
204 	    res->lba_low_exp, res->lba_mid_exp, res->lba_high_exp,
205 	    res->sector_count, res->sector_count_exp);
206 
207 	return(res_string);
208 }
209 
210 /*
211  * ata_command_sbuf() returns 0 for success and -1 for failure.
212  */
213 int
214 ata_command_sbuf(struct ccb_ataio *ataio, struct sbuf *sb)
215 {
216 	char cmd_str[(12 * 3) + 1];
217 
218 	sbuf_printf(sb, "%s. ACB: %s",
219 	    ata_op_string(&ataio->cmd),
220 	    ata_cmd_string(&ataio->cmd, cmd_str, sizeof(cmd_str)));
221 
222 	return(0);
223 }
224 
225 /*
226  * ata_status_abuf() returns 0 for success and -1 for failure.
227  */
228 int
229 ata_status_sbuf(struct ccb_ataio *ataio, struct sbuf *sb)
230 {
231 
232 	sbuf_printf(sb, "ATA status: %02x (%s%s%s%s%s%s%s%s)",
233 	    ataio->res.status,
234 	    (ataio->res.status & 0x80) ? "BSY " : "",
235 	    (ataio->res.status & 0x40) ? "DRDY " : "",
236 	    (ataio->res.status & 0x20) ? "DF " : "",
237 	    (ataio->res.status & 0x10) ? "SERV " : "",
238 	    (ataio->res.status & 0x08) ? "DRQ " : "",
239 	    (ataio->res.status & 0x04) ? "CORR " : "",
240 	    (ataio->res.status & 0x02) ? "IDX " : "",
241 	    (ataio->res.status & 0x01) ? "ERR" : "");
242 	if (ataio->res.status & 1) {
243 	    sbuf_printf(sb, ", error: %02x (%s%s%s%s%s%s%s%s)",
244 		ataio->res.error,
245 		(ataio->res.error & 0x80) ? "ICRC " : "",
246 		(ataio->res.error & 0x40) ? "UNC " : "",
247 		(ataio->res.error & 0x20) ? "MC " : "",
248 		(ataio->res.error & 0x10) ? "IDNF " : "",
249 		(ataio->res.error & 0x08) ? "MCR " : "",
250 		(ataio->res.error & 0x04) ? "ABRT " : "",
251 		(ataio->res.error & 0x02) ? "NM " : "",
252 		(ataio->res.error & 0x01) ? "ILI" : "");
253 	}
254 
255 	return(0);
256 }
257 
258 /*
259  * ata_res_sbuf() returns 0 for success and -1 for failure.
260  */
261 int
262 ata_res_sbuf(struct ccb_ataio *ataio, struct sbuf *sb)
263 {
264 	char res_str[(11 * 3) + 1];
265 
266 	sbuf_printf(sb, "RES: %s",
267 	    ata_res_string(&ataio->res, res_str, sizeof(res_str)));
268 
269 	return(0);
270 }
271 
272 void
273 ata_print_ident(struct ata_params *ident_data)
274 {
275 	char product[48], revision[16];
276 
277 	cam_strvis(product, ident_data->model, sizeof(ident_data->model),
278 		   sizeof(product));
279 	cam_strvis(revision, ident_data->revision, sizeof(ident_data->revision),
280 		   sizeof(revision));
281 	printf("<%s %s> %s-%d",
282 	    product, revision,
283 	    (ident_data->config == ATA_PROTO_CFA) ? "CFA" :
284 	    (ident_data->config & ATA_PROTO_ATAPI) ? "ATAPI" : "ATA",
285 	    ata_version(ident_data->version_major));
286 	if (ident_data->satacapabilities && ident_data->satacapabilities != 0xffff) {
287 		if (ident_data->satacapabilities & ATA_SATA_GEN3)
288 			printf(" SATA 3.x");
289 		else if (ident_data->satacapabilities & ATA_SATA_GEN2)
290 			printf(" SATA 2.x");
291 		else if (ident_data->satacapabilities & ATA_SATA_GEN1)
292 			printf(" SATA 1.x");
293 		else
294 			printf(" SATA");
295 	}
296 	printf(" device\n");
297 }
298 
299 void
300 ata_print_ident_short(struct ata_params *ident_data)
301 {
302 	char product[48], revision[16];
303 
304 	cam_strvis(product, ident_data->model, sizeof(ident_data->model),
305 		   sizeof(product));
306 	cam_strvis(revision, ident_data->revision, sizeof(ident_data->revision),
307 		   sizeof(revision));
308 	printf("<%s %s>", product, revision);
309 }
310 
311 void
312 semb_print_ident(struct sep_identify_data *ident_data)
313 {
314 	char vendor[9], product[17], revision[5], fw[5], in[7], ins[5];
315 
316 	cam_strvis(vendor, ident_data->vendor_id, 8, sizeof(vendor));
317 	cam_strvis(product, ident_data->product_id, 16, sizeof(product));
318 	cam_strvis(revision, ident_data->product_rev, 4, sizeof(revision));
319 	cam_strvis(fw, ident_data->firmware_rev, 4, sizeof(fw));
320 	cam_strvis(in, ident_data->interface_id, 6, sizeof(in));
321 	cam_strvis(ins, ident_data->interface_rev, 4, sizeof(ins));
322 	printf("<%s %s %s %s> SEMB %s %s device\n",
323 	    vendor, product, revision, fw, in, ins);
324 }
325 
326 void
327 semb_print_ident_short(struct sep_identify_data *ident_data)
328 {
329 	char vendor[9], product[17], revision[5], fw[5];
330 
331 	cam_strvis(vendor, ident_data->vendor_id, 8, sizeof(vendor));
332 	cam_strvis(product, ident_data->product_id, 16, sizeof(product));
333 	cam_strvis(revision, ident_data->product_rev, 4, sizeof(revision));
334 	cam_strvis(fw, ident_data->firmware_rev, 4, sizeof(fw));
335 	printf("<%s %s %s %s>", vendor, product, revision, fw);
336 }
337 
338 uint32_t
339 ata_logical_sector_size(struct ata_params *ident_data)
340 {
341 	if ((ident_data->pss & 0xc000) == 0x4000 &&
342 	    (ident_data->pss & ATA_PSS_LSSABOVE512)) {
343 		return ((u_int32_t)ident_data->lss_1 |
344 		    ((u_int32_t)ident_data->lss_2 << 16));
345 	}
346 	return (512);
347 }
348 
349 uint64_t
350 ata_physical_sector_size(struct ata_params *ident_data)
351 {
352 	if ((ident_data->pss & 0xc000) == 0x4000 &&
353 	    (ident_data->pss & ATA_PSS_MULTLS)) {
354 		return ((uint64_t)ata_logical_sector_size(ident_data) *
355 		    (1 << (ident_data->pss & ATA_PSS_LSPPS)));
356 	}
357 	return (512);
358 }
359 
360 uint64_t
361 ata_logical_sector_offset(struct ata_params *ident_data)
362 {
363 	if ((ident_data->lsalign & 0xc000) == 0x4000) {
364 		return ((uint64_t)ata_logical_sector_size(ident_data) *
365 		    (ident_data->lsalign & 0x3fff));
366 	}
367 	return (0);
368 }
369 
370 void
371 ata_28bit_cmd(struct ccb_ataio *ataio, uint8_t cmd, uint8_t features,
372     uint32_t lba, uint8_t sector_count)
373 {
374 	bzero(&ataio->cmd, sizeof(ataio->cmd));
375 	ataio->cmd.flags = 0;
376 	if (cmd == ATA_READ_DMA ||
377 	    cmd == ATA_READ_DMA_QUEUED ||
378 	    cmd == ATA_WRITE_DMA ||
379 	    cmd == ATA_WRITE_DMA_QUEUED)
380 		ataio->cmd.flags |= CAM_ATAIO_DMA;
381 	ataio->cmd.command = cmd;
382 	ataio->cmd.features = features;
383 	ataio->cmd.lba_low = lba;
384 	ataio->cmd.lba_mid = lba >> 8;
385 	ataio->cmd.lba_high = lba >> 16;
386 	ataio->cmd.device = ATA_DEV_LBA | ((lba >> 24) & 0x0f);
387 	ataio->cmd.sector_count = sector_count;
388 }
389 
390 void
391 ata_48bit_cmd(struct ccb_ataio *ataio, uint8_t cmd, uint16_t features,
392     uint64_t lba, uint16_t sector_count)
393 {
394 
395 	ataio->cmd.flags = CAM_ATAIO_48BIT;
396 	if (cmd == ATA_READ_DMA48 ||
397 	    cmd == ATA_READ_DMA_QUEUED48 ||
398 	    cmd == ATA_READ_STREAM_DMA48 ||
399 	    cmd == ATA_WRITE_DMA48 ||
400 	    cmd == ATA_WRITE_DMA_FUA48 ||
401 	    cmd == ATA_WRITE_DMA_QUEUED48 ||
402 	    cmd == ATA_WRITE_DMA_QUEUED_FUA48 ||
403 	    cmd == ATA_WRITE_STREAM_DMA48 ||
404 	    cmd == ATA_DATA_SET_MANAGEMENT)
405 		ataio->cmd.flags |= CAM_ATAIO_DMA;
406 	ataio->cmd.command = cmd;
407 	ataio->cmd.features = features;
408 	ataio->cmd.lba_low = lba;
409 	ataio->cmd.lba_mid = lba >> 8;
410 	ataio->cmd.lba_high = lba >> 16;
411 	ataio->cmd.device = ATA_DEV_LBA;
412 	ataio->cmd.lba_low_exp = lba >> 24;
413 	ataio->cmd.lba_mid_exp = lba >> 32;
414 	ataio->cmd.lba_high_exp = lba >> 40;
415 	ataio->cmd.features_exp = features >> 8;
416 	ataio->cmd.sector_count = sector_count;
417 	ataio->cmd.sector_count_exp = sector_count >> 8;
418 	ataio->cmd.control = 0;
419 }
420 
421 void
422 ata_ncq_cmd(struct ccb_ataio *ataio, uint8_t cmd,
423     uint64_t lba, uint16_t sector_count)
424 {
425 
426 	ataio->cmd.flags = CAM_ATAIO_48BIT | CAM_ATAIO_FPDMA;
427 	ataio->cmd.command = cmd;
428 	ataio->cmd.features = sector_count;
429 	ataio->cmd.lba_low = lba;
430 	ataio->cmd.lba_mid = lba >> 8;
431 	ataio->cmd.lba_high = lba >> 16;
432 	ataio->cmd.device = ATA_DEV_LBA;
433 	ataio->cmd.lba_low_exp = lba >> 24;
434 	ataio->cmd.lba_mid_exp = lba >> 32;
435 	ataio->cmd.lba_high_exp = lba >> 40;
436 	ataio->cmd.features_exp = sector_count >> 8;
437 	ataio->cmd.sector_count = 0;
438 	ataio->cmd.sector_count_exp = 0;
439 	ataio->cmd.control = 0;
440 }
441 
442 void
443 ata_reset_cmd(struct ccb_ataio *ataio)
444 {
445 	bzero(&ataio->cmd, sizeof(ataio->cmd));
446 	ataio->cmd.flags = CAM_ATAIO_CONTROL | CAM_ATAIO_NEEDRESULT;
447 	ataio->cmd.control = 0x04;
448 }
449 
450 void
451 ata_pm_read_cmd(struct ccb_ataio *ataio, int reg, int port)
452 {
453 	bzero(&ataio->cmd, sizeof(ataio->cmd));
454 	ataio->cmd.flags = CAM_ATAIO_NEEDRESULT;
455 	ataio->cmd.command = ATA_READ_PM;
456 	ataio->cmd.features = reg;
457 	ataio->cmd.device = port & 0x0f;
458 }
459 
460 void
461 ata_pm_write_cmd(struct ccb_ataio *ataio, int reg, int port, uint32_t val)
462 {
463 	bzero(&ataio->cmd, sizeof(ataio->cmd));
464 	ataio->cmd.flags = 0;
465 	ataio->cmd.command = ATA_WRITE_PM;
466 	ataio->cmd.features = reg;
467 	ataio->cmd.sector_count = val;
468 	ataio->cmd.lba_low = val >> 8;
469 	ataio->cmd.lba_mid = val >> 16;
470 	ataio->cmd.lba_high = val >> 24;
471 	ataio->cmd.device = port & 0x0f;
472 }
473 
474 void
475 ata_bswap(int8_t *buf, int len)
476 {
477 	u_int16_t *ptr = (u_int16_t*)(buf + len);
478 
479 	while (--ptr >= (u_int16_t*)buf)
480 		*ptr = be16toh(*ptr);
481 }
482 
483 void
484 ata_btrim(int8_t *buf, int len)
485 {
486 	int8_t *ptr;
487 
488 	for (ptr = buf; ptr < buf+len; ++ptr)
489 		if (!*ptr || *ptr == '_')
490 			*ptr = ' ';
491 	for (ptr = buf + len - 1; ptr >= buf && *ptr == ' '; --ptr)
492 		*ptr = 0;
493 }
494 
495 void
496 ata_bpack(int8_t *src, int8_t *dst, int len)
497 {
498 	int i, j, blank;
499 
500 	for (i = j = blank = 0 ; i < len; i++) {
501 		if (blank && src[i] == ' ') continue;
502 		if (blank && src[i] != ' ') {
503 			dst[j++] = src[i];
504 			blank = 0;
505 			continue;
506 		}
507 		if (src[i] == ' ') {
508 			blank = 1;
509 			if (i == 0)
510 			continue;
511 		}
512 		dst[j++] = src[i];
513 	}
514 	while (j < len)
515 		dst[j++] = 0x00;
516 }
517 
518 int
519 ata_max_pmode(struct ata_params *ap)
520 {
521     if (ap->atavalid & ATA_FLAG_64_70) {
522 	if (ap->apiomodes & 0x02)
523 	    return ATA_PIO4;
524 	if (ap->apiomodes & 0x01)
525 	    return ATA_PIO3;
526     }
527     if (ap->mwdmamodes & 0x04)
528 	return ATA_PIO4;
529     if (ap->mwdmamodes & 0x02)
530 	return ATA_PIO3;
531     if (ap->mwdmamodes & 0x01)
532 	return ATA_PIO2;
533     if ((ap->retired_piomode & ATA_RETIRED_PIO_MASK) == 0x200)
534 	return ATA_PIO2;
535     if ((ap->retired_piomode & ATA_RETIRED_PIO_MASK) == 0x100)
536 	return ATA_PIO1;
537     if ((ap->retired_piomode & ATA_RETIRED_PIO_MASK) == 0x000)
538 	return ATA_PIO0;
539     return ATA_PIO0;
540 }
541 
542 int
543 ata_max_wmode(struct ata_params *ap)
544 {
545     if (ap->mwdmamodes & 0x04)
546 	return ATA_WDMA2;
547     if (ap->mwdmamodes & 0x02)
548 	return ATA_WDMA1;
549     if (ap->mwdmamodes & 0x01)
550 	return ATA_WDMA0;
551     return -1;
552 }
553 
554 int
555 ata_max_umode(struct ata_params *ap)
556 {
557     if (ap->atavalid & ATA_FLAG_88) {
558 	if (ap->udmamodes & 0x40)
559 	    return ATA_UDMA6;
560 	if (ap->udmamodes & 0x20)
561 	    return ATA_UDMA5;
562 	if (ap->udmamodes & 0x10)
563 	    return ATA_UDMA4;
564 	if (ap->udmamodes & 0x08)
565 	    return ATA_UDMA3;
566 	if (ap->udmamodes & 0x04)
567 	    return ATA_UDMA2;
568 	if (ap->udmamodes & 0x02)
569 	    return ATA_UDMA1;
570 	if (ap->udmamodes & 0x01)
571 	    return ATA_UDMA0;
572     }
573     return -1;
574 }
575 
576 int
577 ata_max_mode(struct ata_params *ap, int maxmode)
578 {
579 
580 	if (maxmode == 0)
581 		maxmode = ATA_DMA_MAX;
582 	if (maxmode >= ATA_UDMA0 && ata_max_umode(ap) > 0)
583 		return (min(maxmode, ata_max_umode(ap)));
584 	if (maxmode >= ATA_WDMA0 && ata_max_wmode(ap) > 0)
585 		return (min(maxmode, ata_max_wmode(ap)));
586 	return (min(maxmode, ata_max_pmode(ap)));
587 }
588 
589 char *
590 ata_mode2string(int mode)
591 {
592     switch (mode) {
593     case -1: return "UNSUPPORTED";
594     case 0: return "NONE";
595     case ATA_PIO0: return "PIO0";
596     case ATA_PIO1: return "PIO1";
597     case ATA_PIO2: return "PIO2";
598     case ATA_PIO3: return "PIO3";
599     case ATA_PIO4: return "PIO4";
600     case ATA_WDMA0: return "WDMA0";
601     case ATA_WDMA1: return "WDMA1";
602     case ATA_WDMA2: return "WDMA2";
603     case ATA_UDMA0: return "UDMA0";
604     case ATA_UDMA1: return "UDMA1";
605     case ATA_UDMA2: return "UDMA2";
606     case ATA_UDMA3: return "UDMA3";
607     case ATA_UDMA4: return "UDMA4";
608     case ATA_UDMA5: return "UDMA5";
609     case ATA_UDMA6: return "UDMA6";
610     default:
611 	if (mode & ATA_DMA_MASK)
612 	    return "BIOSDMA";
613 	else
614 	    return "BIOSPIO";
615     }
616 }
617 
618 int
619 ata_string2mode(char *str)
620 {
621 	if (!strcasecmp(str, "PIO0")) return (ATA_PIO0);
622 	if (!strcasecmp(str, "PIO1")) return (ATA_PIO1);
623 	if (!strcasecmp(str, "PIO2")) return (ATA_PIO2);
624 	if (!strcasecmp(str, "PIO3")) return (ATA_PIO3);
625 	if (!strcasecmp(str, "PIO4")) return (ATA_PIO4);
626 	if (!strcasecmp(str, "WDMA0")) return (ATA_WDMA0);
627 	if (!strcasecmp(str, "WDMA1")) return (ATA_WDMA1);
628 	if (!strcasecmp(str, "WDMA2")) return (ATA_WDMA2);
629 	if (!strcasecmp(str, "UDMA0")) return (ATA_UDMA0);
630 	if (!strcasecmp(str, "UDMA16")) return (ATA_UDMA0);
631 	if (!strcasecmp(str, "UDMA1")) return (ATA_UDMA1);
632 	if (!strcasecmp(str, "UDMA25")) return (ATA_UDMA1);
633 	if (!strcasecmp(str, "UDMA2")) return (ATA_UDMA2);
634 	if (!strcasecmp(str, "UDMA33")) return (ATA_UDMA2);
635 	if (!strcasecmp(str, "UDMA3")) return (ATA_UDMA3);
636 	if (!strcasecmp(str, "UDMA44")) return (ATA_UDMA3);
637 	if (!strcasecmp(str, "UDMA4")) return (ATA_UDMA4);
638 	if (!strcasecmp(str, "UDMA66")) return (ATA_UDMA4);
639 	if (!strcasecmp(str, "UDMA5")) return (ATA_UDMA5);
640 	if (!strcasecmp(str, "UDMA100")) return (ATA_UDMA5);
641 	if (!strcasecmp(str, "UDMA6")) return (ATA_UDMA6);
642 	if (!strcasecmp(str, "UDMA133")) return (ATA_UDMA6);
643 	return (-1);
644 }
645 
646 
647 u_int
648 ata_mode2speed(int mode)
649 {
650 	switch (mode) {
651 	case ATA_PIO0:
652 	default:
653 		return (3300);
654 	case ATA_PIO1:
655 		return (5200);
656 	case ATA_PIO2:
657 		return (8300);
658 	case ATA_PIO3:
659 		return (11100);
660 	case ATA_PIO4:
661 		return (16700);
662 	case ATA_WDMA0:
663 		return (4200);
664 	case ATA_WDMA1:
665 		return (13300);
666 	case ATA_WDMA2:
667 		return (16700);
668 	case ATA_UDMA0:
669 		return (16700);
670 	case ATA_UDMA1:
671 		return (25000);
672 	case ATA_UDMA2:
673 		return (33300);
674 	case ATA_UDMA3:
675 		return (44400);
676 	case ATA_UDMA4:
677 		return (66700);
678 	case ATA_UDMA5:
679 		return (100000);
680 	case ATA_UDMA6:
681 		return (133000);
682 	}
683 }
684 
685 u_int
686 ata_revision2speed(int revision)
687 {
688 	switch (revision) {
689 	case 1:
690 	default:
691 		return (150000);
692 	case 2:
693 		return (300000);
694 	case 3:
695 		return (600000);
696 	}
697 }
698 
699 int
700 ata_speed2revision(u_int speed)
701 {
702 	switch (speed) {
703 	case 0:
704 		return (0);
705 	case 150000:
706 		return (1);
707 	case 300000:
708 		return (2);
709 	case 600000:
710 		return (3);
711 	default:
712 		return (-1);
713 	}
714 }
715 
716 int
717 ata_identify_match(caddr_t identbuffer, caddr_t table_entry)
718 {
719 	struct scsi_inquiry_pattern *entry;
720 	struct ata_params *ident;
721 
722 	entry = (struct scsi_inquiry_pattern *)table_entry;
723 	ident = (struct ata_params *)identbuffer;
724 
725 	if ((cam_strmatch(ident->model, entry->product,
726 			  sizeof(ident->model)) == 0)
727 	 && (cam_strmatch(ident->revision, entry->revision,
728 			  sizeof(ident->revision)) == 0)) {
729 		return (0);
730 	}
731         return (-1);
732 }
733 
734 int
735 ata_static_identify_match(caddr_t identbuffer, caddr_t table_entry)
736 {
737 	struct scsi_static_inquiry_pattern *entry;
738 	struct ata_params *ident;
739 
740 	entry = (struct scsi_static_inquiry_pattern *)table_entry;
741 	ident = (struct ata_params *)identbuffer;
742 
743 	if ((cam_strmatch(ident->model, entry->product,
744 			  sizeof(ident->model)) == 0)
745 	 && (cam_strmatch(ident->revision, entry->revision,
746 			  sizeof(ident->revision)) == 0)) {
747 		return (0);
748 	}
749         return (-1);
750 }
751 
752 void
753 semb_receive_diagnostic_results(struct ccb_ataio *ataio,
754     u_int32_t retries, void (*cbfcnp)(struct cam_periph *, union ccb*),
755     uint8_t tag_action, int pcv, uint8_t page_code,
756     uint8_t *data_ptr, uint16_t length, uint32_t timeout)
757 {
758 
759 	length = min(length, 1020);
760 	length = (length + 3) & ~3;
761 	cam_fill_ataio(ataio,
762 		      retries,
763 		      cbfcnp,
764 		      /*flags*/CAM_DIR_IN,
765 		      tag_action,
766 		      data_ptr,
767 		      length,
768 		      timeout);
769 	ata_28bit_cmd(ataio, ATA_SEP_ATTN,
770 	    pcv ? page_code : 0, 0x02, length / 4);
771 }
772 
773 void
774 semb_send_diagnostic(struct ccb_ataio *ataio,
775     u_int32_t retries, void (*cbfcnp)(struct cam_periph *, union ccb *),
776     uint8_t tag_action, uint8_t *data_ptr, uint16_t length, uint32_t timeout)
777 {
778 
779 	length = min(length, 1020);
780 	length = (length + 3) & ~3;
781 	cam_fill_ataio(ataio,
782 		      retries,
783 		      cbfcnp,
784 		      /*flags*/length ? CAM_DIR_OUT : CAM_DIR_NONE,
785 		      tag_action,
786 		      data_ptr,
787 		      length,
788 		      timeout);
789 	ata_28bit_cmd(ataio, ATA_SEP_ATTN,
790 	    length > 0 ? data_ptr[0] : 0, 0x82, length / 4);
791 }
792 
793 void
794 semb_read_buffer(struct ccb_ataio *ataio,
795     u_int32_t retries, void (*cbfcnp)(struct cam_periph *, union ccb*),
796     uint8_t tag_action, uint8_t page_code,
797     uint8_t *data_ptr, uint16_t length, uint32_t timeout)
798 {
799 
800 	length = min(length, 1020);
801 	length = (length + 3) & ~3;
802 	cam_fill_ataio(ataio,
803 		      retries,
804 		      cbfcnp,
805 		      /*flags*/CAM_DIR_IN,
806 		      tag_action,
807 		      data_ptr,
808 		      length,
809 		      timeout);
810 	ata_28bit_cmd(ataio, ATA_SEP_ATTN,
811 	    page_code, 0x00, length / 4);
812 }
813 
814 void
815 semb_write_buffer(struct ccb_ataio *ataio,
816     u_int32_t retries, void (*cbfcnp)(struct cam_periph *, union ccb *),
817     uint8_t tag_action, uint8_t *data_ptr, uint16_t length, uint32_t timeout)
818 {
819 
820 	length = min(length, 1020);
821 	length = (length + 3) & ~3;
822 	cam_fill_ataio(ataio,
823 		      retries,
824 		      cbfcnp,
825 		      /*flags*/length ? CAM_DIR_OUT : CAM_DIR_NONE,
826 		      tag_action,
827 		      data_ptr,
828 		      length,
829 		      timeout);
830 	ata_28bit_cmd(ataio, ATA_SEP_ATTN,
831 	    length > 0 ? data_ptr[0] : 0, 0x80, length / 4);
832 }
833 
834