3 * Denis Peter, MPL AG Switzerland
5 * SPDX-License-Identifier: GPL-2.0+
13 #include <dm/device-internal.h>
14 #include <dm/uclass-internal.h>
16 #if !defined(CONFIG_DM_SCSI)
17 #ifdef CONFIG_SCSI_DEV_LIST
18 #define SCSI_DEV_LIST CONFIG_SCSI_DEV_LIST
20 #ifdef CONFIG_SATA_ULI5288
22 #define SCSI_VEND_ID 0x10b9
23 #define SCSI_DEV_ID 0x5288
25 #elif !defined(CONFIG_SCSI_AHCI_PLAT)
26 #error no scsi device defined
28 #define SCSI_DEV_LIST {SCSI_VEND_ID, SCSI_DEV_ID}
32 #if defined(CONFIG_PCI) && !defined(CONFIG_SCSI_AHCI_PLAT)
33 const struct pci_device_id scsi_device_list[] = { SCSI_DEV_LIST };
35 static ccb tempccb; /* temporary scsi command buffer */
37 static unsigned char tempbuff[512]; /* temporary data buffer */
39 #if !defined(CONFIG_DM_SCSI)
40 static int scsi_max_devs; /* number of highest available scsi device */
42 static int scsi_curr_dev; /* current device */
44 static struct blk_desc scsi_dev_desc[CONFIG_SYS_SCSI_MAX_DEVICE];
47 /* almost the maximum amount of the scsi_ext command.. */
48 #define SCSI_MAX_READ_BLK 0xFFFF
49 #define SCSI_LBA48_READ 0xFFFFFFF
51 static void scsi_print_error(ccb *pccb)
53 /* Dummy function that could print an error for debugging */
56 #ifdef CONFIG_SYS_64BIT_LBA
57 void scsi_setup_read16(ccb *pccb, lbaint_t start, unsigned long blocks)
59 pccb->cmd[0] = SCSI_READ16;
60 pccb->cmd[1] = pccb->lun << 5;
61 pccb->cmd[2] = (unsigned char)(start >> 56) & 0xff;
62 pccb->cmd[3] = (unsigned char)(start >> 48) & 0xff;
63 pccb->cmd[4] = (unsigned char)(start >> 40) & 0xff;
64 pccb->cmd[5] = (unsigned char)(start >> 32) & 0xff;
65 pccb->cmd[6] = (unsigned char)(start >> 24) & 0xff;
66 pccb->cmd[7] = (unsigned char)(start >> 16) & 0xff;
67 pccb->cmd[8] = (unsigned char)(start >> 8) & 0xff;
68 pccb->cmd[9] = (unsigned char)start & 0xff;
70 pccb->cmd[11] = (unsigned char)(blocks >> 24) & 0xff;
71 pccb->cmd[12] = (unsigned char)(blocks >> 16) & 0xff;
72 pccb->cmd[13] = (unsigned char)(blocks >> 8) & 0xff;
73 pccb->cmd[14] = (unsigned char)blocks & 0xff;
76 pccb->msgout[0] = SCSI_IDENTIFY; /* NOT USED */
77 debug("scsi_setup_read16: cmd: %02X %02X startblk %02X%02X%02X%02X%02X%02X%02X%02X blccnt %02X%02X%02X%02X\n",
78 pccb->cmd[0], pccb->cmd[1],
79 pccb->cmd[2], pccb->cmd[3], pccb->cmd[4], pccb->cmd[5],
80 pccb->cmd[6], pccb->cmd[7], pccb->cmd[8], pccb->cmd[9],
81 pccb->cmd[11], pccb->cmd[12], pccb->cmd[13], pccb->cmd[14]);
85 static void scsi_setup_read_ext(ccb *pccb, lbaint_t start,
86 unsigned short blocks)
88 pccb->cmd[0] = SCSI_READ10;
89 pccb->cmd[1] = pccb->lun << 5;
90 pccb->cmd[2] = (unsigned char)(start >> 24) & 0xff;
91 pccb->cmd[3] = (unsigned char)(start >> 16) & 0xff;
92 pccb->cmd[4] = (unsigned char)(start >> 8) & 0xff;
93 pccb->cmd[5] = (unsigned char)start & 0xff;
95 pccb->cmd[7] = (unsigned char)(blocks >> 8) & 0xff;
96 pccb->cmd[8] = (unsigned char)blocks & 0xff;
99 pccb->msgout[0] = SCSI_IDENTIFY; /* NOT USED */
100 debug("scsi_setup_read_ext: cmd: %02X %02X startblk %02X%02X%02X%02X blccnt %02X%02X\n",
101 pccb->cmd[0], pccb->cmd[1],
102 pccb->cmd[2], pccb->cmd[3], pccb->cmd[4], pccb->cmd[5],
103 pccb->cmd[7], pccb->cmd[8]);
106 static void scsi_setup_write_ext(ccb *pccb, lbaint_t start,
107 unsigned short blocks)
109 pccb->cmd[0] = SCSI_WRITE10;
110 pccb->cmd[1] = pccb->lun << 5;
111 pccb->cmd[2] = (unsigned char)(start >> 24) & 0xff;
112 pccb->cmd[3] = (unsigned char)(start >> 16) & 0xff;
113 pccb->cmd[4] = (unsigned char)(start >> 8) & 0xff;
114 pccb->cmd[5] = (unsigned char)start & 0xff;
116 pccb->cmd[7] = ((unsigned char)(blocks >> 8)) & 0xff;
117 pccb->cmd[8] = (unsigned char)blocks & 0xff;
120 pccb->msgout[0] = SCSI_IDENTIFY; /* NOT USED */
121 debug("%s: cmd: %02X %02X startblk %02X%02X%02X%02X blccnt %02X%02X\n",
123 pccb->cmd[0], pccb->cmd[1],
124 pccb->cmd[2], pccb->cmd[3], pccb->cmd[4], pccb->cmd[5],
125 pccb->cmd[7], pccb->cmd[8]);
128 static void scsi_setup_inquiry(ccb *pccb)
130 pccb->cmd[0] = SCSI_INQUIRY;
131 pccb->cmd[1] = pccb->lun << 5;
134 if (pccb->datalen > 255)
137 pccb->cmd[4] = (unsigned char)pccb->datalen;
140 pccb->msgout[0] = SCSI_IDENTIFY; /* NOT USED */
144 static ulong scsi_read(struct udevice *dev, lbaint_t blknr, lbaint_t blkcnt,
147 static ulong scsi_read(struct blk_desc *block_dev, lbaint_t blknr,
148 lbaint_t blkcnt, void *buffer)
152 struct blk_desc *block_dev = dev_get_uclass_platdata(dev);
154 lbaint_t start, blks;
156 unsigned short smallblks = 0;
157 ccb *pccb = (ccb *)&tempccb;
160 pccb->target = block_dev->target;
161 pccb->lun = block_dev->lun;
162 buf_addr = (unsigned long)buffer;
165 debug("\nscsi_read: dev %d startblk " LBAF
166 ", blccnt " LBAF " buffer %lx\n",
167 block_dev->devnum, start, blks, (unsigned long)buffer);
169 pccb->pdata = (unsigned char *)buf_addr;
170 #ifdef CONFIG_SYS_64BIT_LBA
171 if (start > SCSI_LBA48_READ) {
172 unsigned long blocks;
173 blocks = min_t(lbaint_t, blks, SCSI_MAX_READ_BLK);
174 pccb->datalen = block_dev->blksz * blocks;
175 scsi_setup_read16(pccb, start, blocks);
180 if (blks > SCSI_MAX_READ_BLK) {
181 pccb->datalen = block_dev->blksz *
183 smallblks = SCSI_MAX_READ_BLK;
184 scsi_setup_read_ext(pccb, start, smallblks);
185 start += SCSI_MAX_READ_BLK;
186 blks -= SCSI_MAX_READ_BLK;
188 pccb->datalen = block_dev->blksz * blks;
189 smallblks = (unsigned short)blks;
190 scsi_setup_read_ext(pccb, start, smallblks);
194 debug("scsi_read_ext: startblk " LBAF
195 ", blccnt %x buffer %" PRIXPTR "\n",
196 start, smallblks, buf_addr);
197 if (scsi_exec(pccb) != true) {
198 scsi_print_error(pccb);
202 buf_addr += pccb->datalen;
204 debug("scsi_read_ext: end startblk " LBAF
205 ", blccnt %x buffer %" PRIXPTR "\n", start, smallblks, buf_addr);
209 /*******************************************************************************
213 /* Almost the maximum amount of the scsi_ext command.. */
214 #define SCSI_MAX_WRITE_BLK 0xFFFF
217 static ulong scsi_write(struct udevice *dev, lbaint_t blknr, lbaint_t blkcnt,
220 static ulong scsi_write(struct blk_desc *block_dev, lbaint_t blknr,
221 lbaint_t blkcnt, const void *buffer)
225 struct blk_desc *block_dev = dev_get_uclass_platdata(dev);
227 lbaint_t start, blks;
229 unsigned short smallblks;
230 ccb *pccb = (ccb *)&tempccb;
233 pccb->target = block_dev->target;
234 pccb->lun = block_dev->lun;
235 buf_addr = (unsigned long)buffer;
238 debug("\n%s: dev %d startblk " LBAF ", blccnt " LBAF " buffer %lx\n",
239 __func__, block_dev->devnum, start, blks, (unsigned long)buffer);
241 pccb->pdata = (unsigned char *)buf_addr;
242 if (blks > SCSI_MAX_WRITE_BLK) {
243 pccb->datalen = (block_dev->blksz *
245 smallblks = SCSI_MAX_WRITE_BLK;
246 scsi_setup_write_ext(pccb, start, smallblks);
247 start += SCSI_MAX_WRITE_BLK;
248 blks -= SCSI_MAX_WRITE_BLK;
250 pccb->datalen = block_dev->blksz * blks;
251 smallblks = (unsigned short)blks;
252 scsi_setup_write_ext(pccb, start, smallblks);
256 debug("%s: startblk " LBAF ", blccnt %x buffer %" PRIXPTR "\n",
257 __func__, start, smallblks, buf_addr);
258 if (scsi_exec(pccb) != true) {
259 scsi_print_error(pccb);
263 buf_addr += pccb->datalen;
265 debug("%s: end startblk " LBAF ", blccnt %x buffer %" PRIXPTR "\n",
266 __func__, start, smallblks, buf_addr);
270 #if defined(CONFIG_PCI) && !defined(CONFIG_SCSI_AHCI_PLAT)
276 * Find a device from the list, this driver will support a single
279 for (i = 0; i < ARRAY_SIZE(scsi_device_list); i++) {
280 /* get PCI Device ID */
285 ret = dm_pci_find_device(scsi_device_list[i].vendor,
286 scsi_device_list[i].device, 0, &dev);
288 busdevfunc = dm_pci_get_bdf(dev);
292 busdevfunc = pci_find_device(scsi_device_list[i].vendor,
293 scsi_device_list[i].device,
296 if (busdevfunc != -1)
300 if (busdevfunc == -1) {
301 printf("Error: SCSI Controller(s) ");
302 for (i = 0; i < ARRAY_SIZE(scsi_device_list); i++) {
304 scsi_device_list[i].vendor,
305 scsi_device_list[i].device);
307 printf("not found\n");
312 printf("SCSI Controller (%04X,%04X) found (%d:%d:%d)\n",
313 scsi_device_list[i].vendor,
314 scsi_device_list[i].device,
315 (busdevfunc >> 16) & 0xFF,
316 (busdevfunc >> 11) & 0x1F,
317 (busdevfunc >> 8) & 0x7);
320 bootstage_start(BOOTSTAGE_ID_ACCUM_SCSI, "ahci");
321 scsi_low_level_init(busdevfunc);
323 bootstage_accum(BOOTSTAGE_ID_ACCUM_SCSI);
327 /* copy src to dest, skipping leading and trailing blanks
328 * and null terminate the string
330 static void scsi_ident_cpy(unsigned char *dest, unsigned char *src,
336 while (start < len) {
337 if (src[start] != ' ')
342 while (end > start) {
347 for (; start <= end; start++)
348 *dest ++= src[start];
352 static int scsi_read_capacity(ccb *pccb, lbaint_t *capacity,
353 unsigned long *blksz)
357 memset(pccb->cmd, '\0', sizeof(pccb->cmd));
358 pccb->cmd[0] = SCSI_RD_CAPAC10;
359 pccb->cmd[1] = pccb->lun << 5;
361 pccb->msgout[0] = SCSI_IDENTIFY; /* NOT USED */
364 if (scsi_exec(pccb) != true)
367 *capacity = ((lbaint_t)pccb->pdata[0] << 24) |
368 ((lbaint_t)pccb->pdata[1] << 16) |
369 ((lbaint_t)pccb->pdata[2] << 8) |
370 ((lbaint_t)pccb->pdata[3]);
372 if (*capacity != 0xffffffff) {
373 /* Read capacity (10) was sufficient for this drive. */
374 *blksz = ((unsigned long)pccb->pdata[4] << 24) |
375 ((unsigned long)pccb->pdata[5] << 16) |
376 ((unsigned long)pccb->pdata[6] << 8) |
377 ((unsigned long)pccb->pdata[7]);
381 /* Read capacity (10) was insufficient. Use read capacity (16). */
382 memset(pccb->cmd, '\0', sizeof(pccb->cmd));
383 pccb->cmd[0] = SCSI_RD_CAPAC16;
386 pccb->msgout[0] = SCSI_IDENTIFY; /* NOT USED */
389 if (scsi_exec(pccb) != true)
392 *capacity = ((uint64_t)pccb->pdata[0] << 56) |
393 ((uint64_t)pccb->pdata[1] << 48) |
394 ((uint64_t)pccb->pdata[2] << 40) |
395 ((uint64_t)pccb->pdata[3] << 32) |
396 ((uint64_t)pccb->pdata[4] << 24) |
397 ((uint64_t)pccb->pdata[5] << 16) |
398 ((uint64_t)pccb->pdata[6] << 8) |
399 ((uint64_t)pccb->pdata[7]);
401 *blksz = ((uint64_t)pccb->pdata[8] << 56) |
402 ((uint64_t)pccb->pdata[9] << 48) |
403 ((uint64_t)pccb->pdata[10] << 40) |
404 ((uint64_t)pccb->pdata[11] << 32) |
405 ((uint64_t)pccb->pdata[12] << 24) |
406 ((uint64_t)pccb->pdata[13] << 16) |
407 ((uint64_t)pccb->pdata[14] << 8) |
408 ((uint64_t)pccb->pdata[15]);
415 * Some setup (fill-in) routines
417 static void scsi_setup_test_unit_ready(ccb *pccb)
419 pccb->cmd[0] = SCSI_TST_U_RDY;
420 pccb->cmd[1] = pccb->lun << 5;
426 pccb->msgout[0] = SCSI_IDENTIFY; /* NOT USED */
430 * scsi_init_dev_desc_priv - initialize only SCSI specific blk_desc properties
432 * @dev_desc: Block device description pointer
434 static void scsi_init_dev_desc_priv(struct blk_desc *dev_desc)
436 dev_desc->target = 0xff;
437 dev_desc->lun = 0xff;
438 dev_desc->log2blksz =
439 LOG2_INVALID(typeof(dev_desc->log2blksz));
440 dev_desc->type = DEV_TYPE_UNKNOWN;
441 dev_desc->vendor[0] = 0;
442 dev_desc->product[0] = 0;
443 dev_desc->revision[0] = 0;
444 dev_desc->removable = false;
446 dev_desc->block_read = scsi_read;
447 dev_desc->block_write = scsi_write;
451 #if !defined(CONFIG_DM_SCSI)
453 * scsi_init_dev_desc - initialize all SCSI specific blk_desc properties
455 * @dev_desc: Block device description pointer
456 * @devnum: Device number
458 static void scsi_init_dev_desc(struct blk_desc *dev_desc, int devnum)
462 dev_desc->if_type = IF_TYPE_SCSI;
463 dev_desc->devnum = devnum;
464 dev_desc->part_type = PART_TYPE_UNKNOWN;
466 scsi_init_dev_desc_priv(dev_desc);
471 * scsi_detect_dev - Detect scsi device
475 * @dev_desc: block device description
477 * The scsi_detect_dev detects and fills a dev_desc structure when the device is
480 * Return: 0 on success, error value otherwise
482 static int scsi_detect_dev(int target, int lun, struct blk_desc *dev_desc)
484 unsigned char perq, modi;
487 ccb *pccb = (ccb *)&tempccb;
489 pccb->target = target;
491 pccb->pdata = (unsigned char *)&tempbuff;
493 scsi_setup_inquiry(pccb);
494 if (scsi_exec(pccb) != true) {
495 if (pccb->contr_stat == SCSI_SEL_TIME_OUT) {
497 * selection timeout => assuming no
500 debug("Selection timeout ID %d\n",
504 scsi_print_error(pccb);
509 if ((perq & 0x1f) == 0x1f)
510 return -ENODEV; /* skip unknown devices */
511 if ((modi & 0x80) == 0x80) /* drive is removable */
512 dev_desc->removable = true;
513 /* get info for this device */
514 scsi_ident_cpy((unsigned char *)dev_desc->vendor,
516 scsi_ident_cpy((unsigned char *)dev_desc->product,
518 scsi_ident_cpy((unsigned char *)dev_desc->revision,
520 dev_desc->target = pccb->target;
521 dev_desc->lun = pccb->lun;
524 scsi_setup_test_unit_ready(pccb);
525 if (scsi_exec(pccb) != true) {
526 if (dev_desc->removable) {
527 dev_desc->type = perq;
530 scsi_print_error(pccb);
533 if (scsi_read_capacity(pccb, &capacity, &blksz)) {
534 scsi_print_error(pccb);
537 dev_desc->lba = capacity;
538 dev_desc->blksz = blksz;
539 dev_desc->log2blksz = LOG2(dev_desc->blksz);
540 dev_desc->type = perq;
546 * (re)-scan the scsi bus and reports scsi device info
547 * to the user if mode = 1
549 #if defined(CONFIG_DM_SCSI)
550 static int do_scsi_scan_one(struct udevice *dev, int id, int lun, int mode)
553 struct udevice *bdev;
555 struct blk_desc *bdesc;
559 * detect the scsi driver to get information about its geometry (block
560 * size, number of blocks) and other parameters (ids, type, ...)
562 scsi_init_dev_desc_priv(&bd);
563 if (scsi_detect_dev(id, lun, &bd))
567 * Create only one block device and do detection
568 * to make sure that there won't be a lot of
569 * block devices created
571 snprintf(str, sizeof(str), "id%dlun%d", id, lun);
572 ret = blk_create_devicef(dev, "scsi_blk", str, IF_TYPE_SCSI, -1,
573 bd.blksz, bd.blksz * bd.lba, &bdev);
575 debug("Can't create device\n");
579 bdesc = dev_get_uclass_platdata(bdev);
582 bdesc->removable = bd.removable;
583 bdesc->type = bd.type;
584 memcpy(&bdesc->vendor, &bd.vendor, sizeof(bd.vendor));
585 memcpy(&bdesc->product, &bd.product, sizeof(bd.product));
586 memcpy(&bdesc->revision, &bd.revision, sizeof(bd.revision));
590 printf(" Device %d: ", 0);
596 int scsi_scan(int mode)
598 unsigned char i, lun;
600 struct udevice *dev; /* SCSI controller */
604 printf("scanning bus for devices...\n");
606 blk_unbind_all(IF_TYPE_SCSI);
608 ret = uclass_get(UCLASS_SCSI, &uc);
612 uclass_foreach_dev(dev, uc) {
613 struct scsi_platdata *plat; /* scsi controller platdata */
615 /* probe SCSI controller driver */
616 ret = device_probe(dev);
620 /* Get controller platdata */
621 plat = dev_get_platdata(dev);
623 for (i = 0; i < plat->max_id; i++)
624 for (lun = 0; lun < plat->max_lun; lun++)
625 do_scsi_scan_one(dev, i, lun, mode);
631 int scsi_scan(int mode)
633 unsigned char i, lun;
637 printf("scanning bus for devices...\n");
638 for (i = 0; i < CONFIG_SYS_SCSI_MAX_DEVICE; i++)
639 scsi_init_dev_desc(&scsi_dev_desc[i], i);
642 for (i = 0; i < CONFIG_SYS_SCSI_MAX_SCSI_ID; i++) {
643 for (lun = 0; lun < CONFIG_SYS_SCSI_MAX_LUN; lun++) {
644 ret = scsi_detect_dev(i, lun,
645 &scsi_dev_desc[scsi_max_devs]);
648 part_init(&scsi_dev_desc[scsi_max_devs]);
651 printf(" Device %d: ", 0);
652 dev_print(&scsi_dev_desc[scsi_max_devs]);
657 if (scsi_max_devs > 0)
662 printf("Found %d device(s).\n", scsi_max_devs);
663 #ifndef CONFIG_SPL_BUILD
664 setenv_ulong("scsidevs", scsi_max_devs);
671 static const struct blk_ops scsi_blk_ops = {
676 U_BOOT_DRIVER(scsi_blk) = {
679 .ops = &scsi_blk_ops,
682 U_BOOT_LEGACY_BLK(scsi) = {
683 .if_typename = "scsi",
684 .if_type = IF_TYPE_SCSI,
685 .max_devs = CONFIG_SYS_SCSI_MAX_DEVICE,
686 .desc = scsi_dev_desc,