1 // SPDX-License-Identifier: GPL-2.0+
4 * Denis Peter, MPL AG Switzerland
7 #define LOG_CATEGORY UCLASS_SCSI
12 #include <bootstage.h>
20 #include <dm/device-internal.h>
21 #include <dm/uclass-internal.h>
23 #if !defined(CONFIG_DM_SCSI)
24 # ifdef CFG_SCSI_DEV_LIST
25 # define SCSI_DEV_LIST CFG_SCSI_DEV_LIST
27 # ifdef CONFIG_SATA_ULI5288
29 # define SCSI_VEND_ID 0x10b9
30 # define SCSI_DEV_ID 0x5288
32 # elif !defined(CONFIG_SCSI_AHCI_PLAT)
33 # error no scsi device defined
35 # define SCSI_DEV_LIST {SCSI_VEND_ID, SCSI_DEV_ID}
39 #if defined(CONFIG_PCI) && !defined(CONFIG_SCSI_AHCI_PLAT) && \
40 !defined(CONFIG_DM_SCSI)
41 const struct pci_device_id scsi_device_list[] = { SCSI_DEV_LIST };
43 static struct scsi_cmd tempccb; /* temporary scsi command buffer */
45 static unsigned char tempbuff[512]; /* temporary data buffer */
47 #if !defined(CONFIG_DM_SCSI)
48 static int scsi_max_devs; /* number of highest available scsi device */
50 static int scsi_curr_dev; /* current device */
52 static struct blk_desc scsi_dev_desc[SCSI_MAX_DEVICE];
55 /* almost the maximum amount of the scsi_ext command.. */
56 #define SCSI_MAX_BLK 0xFFFF
57 #define SCSI_LBA48_READ 0xFFFFFFF
59 static void scsi_print_error(struct scsi_cmd *pccb)
61 /* Dummy function that could print an error for debugging */
64 #ifdef CONFIG_SYS_64BIT_LBA
65 void scsi_setup_read16(struct scsi_cmd *pccb, lbaint_t start,
68 pccb->cmd[0] = SCSI_READ16;
69 pccb->cmd[1] = pccb->lun << 5;
70 pccb->cmd[2] = (unsigned char)(start >> 56) & 0xff;
71 pccb->cmd[3] = (unsigned char)(start >> 48) & 0xff;
72 pccb->cmd[4] = (unsigned char)(start >> 40) & 0xff;
73 pccb->cmd[5] = (unsigned char)(start >> 32) & 0xff;
74 pccb->cmd[6] = (unsigned char)(start >> 24) & 0xff;
75 pccb->cmd[7] = (unsigned char)(start >> 16) & 0xff;
76 pccb->cmd[8] = (unsigned char)(start >> 8) & 0xff;
77 pccb->cmd[9] = (unsigned char)start & 0xff;
79 pccb->cmd[11] = (unsigned char)(blocks >> 24) & 0xff;
80 pccb->cmd[12] = (unsigned char)(blocks >> 16) & 0xff;
81 pccb->cmd[13] = (unsigned char)(blocks >> 8) & 0xff;
82 pccb->cmd[14] = (unsigned char)blocks & 0xff;
85 pccb->msgout[0] = SCSI_IDENTIFY; /* NOT USED */
86 debug("scsi_setup_read16: cmd: %02X %02X startblk %02X%02X%02X%02X%02X%02X%02X%02X blccnt %02X%02X%02X%02X\n",
87 pccb->cmd[0], pccb->cmd[1],
88 pccb->cmd[2], pccb->cmd[3], pccb->cmd[4], pccb->cmd[5],
89 pccb->cmd[6], pccb->cmd[7], pccb->cmd[8], pccb->cmd[9],
90 pccb->cmd[11], pccb->cmd[12], pccb->cmd[13], pccb->cmd[14]);
94 static void scsi_setup_inquiry(struct scsi_cmd *pccb)
96 pccb->cmd[0] = SCSI_INQUIRY;
97 pccb->cmd[1] = pccb->lun << 5;
100 if (pccb->datalen > 255)
103 pccb->cmd[4] = (unsigned char)pccb->datalen;
106 pccb->msgout[0] = SCSI_IDENTIFY; /* NOT USED */
110 static void scsi_setup_read_ext(struct scsi_cmd *pccb, lbaint_t start,
111 unsigned short blocks)
113 pccb->cmd[0] = SCSI_READ10;
114 pccb->cmd[1] = pccb->lun << 5;
115 pccb->cmd[2] = (unsigned char)(start >> 24) & 0xff;
116 pccb->cmd[3] = (unsigned char)(start >> 16) & 0xff;
117 pccb->cmd[4] = (unsigned char)(start >> 8) & 0xff;
118 pccb->cmd[5] = (unsigned char)start & 0xff;
120 pccb->cmd[7] = (unsigned char)(blocks >> 8) & 0xff;
121 pccb->cmd[8] = (unsigned char)blocks & 0xff;
124 pccb->msgout[0] = SCSI_IDENTIFY; /* NOT USED */
125 debug("scsi_setup_read_ext: cmd: %02X %02X startblk %02X%02X%02X%02X blccnt %02X%02X\n",
126 pccb->cmd[0], pccb->cmd[1],
127 pccb->cmd[2], pccb->cmd[3], pccb->cmd[4], pccb->cmd[5],
128 pccb->cmd[7], pccb->cmd[8]);
131 static void scsi_setup_write_ext(struct scsi_cmd *pccb, lbaint_t start,
132 unsigned short blocks)
134 pccb->cmd[0] = SCSI_WRITE10;
135 pccb->cmd[1] = pccb->lun << 5;
136 pccb->cmd[2] = (unsigned char)(start >> 24) & 0xff;
137 pccb->cmd[3] = (unsigned char)(start >> 16) & 0xff;
138 pccb->cmd[4] = (unsigned char)(start >> 8) & 0xff;
139 pccb->cmd[5] = (unsigned char)start & 0xff;
141 pccb->cmd[7] = ((unsigned char)(blocks >> 8)) & 0xff;
142 pccb->cmd[8] = (unsigned char)blocks & 0xff;
145 pccb->msgout[0] = SCSI_IDENTIFY; /* NOT USED */
146 debug("%s: cmd: %02X %02X startblk %02X%02X%02X%02X blccnt %02X%02X\n",
148 pccb->cmd[0], pccb->cmd[1],
149 pccb->cmd[2], pccb->cmd[3], pccb->cmd[4], pccb->cmd[5],
150 pccb->cmd[7], pccb->cmd[8]);
153 static ulong scsi_read(struct udevice *dev, lbaint_t blknr, lbaint_t blkcnt,
156 struct blk_desc *block_dev = dev_get_uclass_plat(dev);
157 struct udevice *bdev = dev->parent;
158 struct scsi_plat *uc_plat = dev_get_uclass_plat(bdev);
159 lbaint_t start, blks, max_blks;
161 unsigned short smallblks = 0;
162 struct scsi_cmd *pccb = (struct scsi_cmd *)&tempccb;
165 pccb->target = block_dev->target;
166 pccb->lun = block_dev->lun;
167 buf_addr = (unsigned long)buffer;
170 if (uc_plat->max_bytes_per_req)
171 max_blks = uc_plat->max_bytes_per_req / block_dev->blksz;
173 max_blks = SCSI_MAX_BLK;
175 debug("\nscsi_read: dev %d startblk " LBAF
176 ", blccnt " LBAF " buffer %lx\n",
177 block_dev->devnum, start, blks, (unsigned long)buffer);
179 pccb->pdata = (unsigned char *)buf_addr;
180 pccb->dma_dir = DMA_FROM_DEVICE;
181 #ifdef CONFIG_SYS_64BIT_LBA
182 if (start > SCSI_LBA48_READ) {
183 unsigned long blocks;
184 blocks = min_t(lbaint_t, blks, max_blks);
185 pccb->datalen = block_dev->blksz * blocks;
186 scsi_setup_read16(pccb, start, blocks);
191 if (blks > max_blks) {
192 pccb->datalen = block_dev->blksz * max_blks;
193 smallblks = max_blks;
194 scsi_setup_read_ext(pccb, start, smallblks);
198 pccb->datalen = block_dev->blksz * blks;
199 smallblks = (unsigned short)blks;
200 scsi_setup_read_ext(pccb, start, smallblks);
204 debug("scsi_read_ext: startblk " LBAF
205 ", blccnt %x buffer %lX\n",
206 start, smallblks, buf_addr);
207 if (scsi_exec(bdev, pccb)) {
208 scsi_print_error(pccb);
212 buf_addr += pccb->datalen;
214 debug("scsi_read_ext: end startblk " LBAF
215 ", blccnt %x buffer %lX\n", start, smallblks, buf_addr);
219 /*******************************************************************************
223 static ulong scsi_write(struct udevice *dev, lbaint_t blknr, lbaint_t blkcnt,
226 struct blk_desc *block_dev = dev_get_uclass_plat(dev);
227 struct udevice *bdev = dev->parent;
228 struct scsi_plat *uc_plat = dev_get_uclass_plat(bdev);
229 lbaint_t start, blks, max_blks;
231 unsigned short smallblks;
232 struct scsi_cmd *pccb = (struct scsi_cmd *)&tempccb;
235 pccb->target = block_dev->target;
236 pccb->lun = block_dev->lun;
237 buf_addr = (unsigned long)buffer;
240 if (uc_plat->max_bytes_per_req)
241 max_blks = uc_plat->max_bytes_per_req / block_dev->blksz;
243 max_blks = SCSI_MAX_BLK;
245 debug("\n%s: dev %d startblk " LBAF ", blccnt " LBAF " buffer %lx\n",
246 __func__, block_dev->devnum, start, blks, (unsigned long)buffer);
248 pccb->pdata = (unsigned char *)buf_addr;
249 pccb->dma_dir = DMA_TO_DEVICE;
250 if (blks > max_blks) {
251 pccb->datalen = block_dev->blksz * max_blks;
252 smallblks = max_blks;
253 scsi_setup_write_ext(pccb, start, smallblks);
257 pccb->datalen = block_dev->blksz * blks;
258 smallblks = (unsigned short)blks;
259 scsi_setup_write_ext(pccb, start, smallblks);
263 debug("%s: startblk " LBAF ", blccnt %x buffer %lx\n",
264 __func__, start, smallblks, buf_addr);
265 if (scsi_exec(bdev, pccb)) {
266 scsi_print_error(pccb);
270 buf_addr += pccb->datalen;
272 debug("%s: end startblk " LBAF ", blccnt %x buffer %lX\n",
273 __func__, start, smallblks, buf_addr);
278 #if defined(CONFIG_PCI) && !defined(CONFIG_SCSI_AHCI_PLAT) && \
279 !defined(CONFIG_DM_SCSI)
285 * Find a device from the list, this driver will support a single
288 for (i = 0; i < ARRAY_SIZE(scsi_device_list); i++) {
289 /* get PCI Device ID */
293 ret = dm_pci_find_device(scsi_device_list[i].vendor,
294 scsi_device_list[i].device, 0, &dev);
296 busdevfunc = dm_pci_get_bdf(dev);
299 if (busdevfunc != -1)
303 if (busdevfunc == -1) {
304 printf("Error: SCSI Controller(s) ");
305 for (i = 0; i < ARRAY_SIZE(scsi_device_list); i++) {
307 scsi_device_list[i].vendor,
308 scsi_device_list[i].device);
310 printf("not found\n");
315 printf("SCSI Controller (%04X,%04X) found (%d:%d:%d)\n",
316 scsi_device_list[i].vendor,
317 scsi_device_list[i].device,
318 (busdevfunc >> 16) & 0xFF,
319 (busdevfunc >> 11) & 0x1F,
320 (busdevfunc >> 8) & 0x7);
323 bootstage_start(BOOTSTAGE_ID_ACCUM_SCSI, "ahci");
324 scsi_low_level_init(busdevfunc);
326 bootstage_accum(BOOTSTAGE_ID_ACCUM_SCSI);
330 /* copy src to dest, skipping leading and trailing blanks
331 * and null terminate the string
333 static void scsi_ident_cpy(unsigned char *dest, unsigned char *src,
339 while (start < len) {
340 if (src[start] != ' ')
345 while (end > start) {
350 for (; start <= end; start++)
351 *dest ++= src[start];
355 static int scsi_read_capacity(struct udevice *dev, struct scsi_cmd *pccb,
356 lbaint_t *capacity, unsigned long *blksz)
360 memset(pccb->cmd, '\0', sizeof(pccb->cmd));
361 pccb->cmd[0] = SCSI_RD_CAPAC10;
362 pccb->cmd[1] = pccb->lun << 5;
364 pccb->msgout[0] = SCSI_IDENTIFY; /* NOT USED */
367 if (scsi_exec(dev, pccb))
370 *capacity = ((lbaint_t)pccb->pdata[0] << 24) |
371 ((lbaint_t)pccb->pdata[1] << 16) |
372 ((lbaint_t)pccb->pdata[2] << 8) |
373 ((lbaint_t)pccb->pdata[3]);
375 if (*capacity != 0xffffffff) {
376 /* Read capacity (10) was sufficient for this drive. */
377 *blksz = ((unsigned long)pccb->pdata[4] << 24) |
378 ((unsigned long)pccb->pdata[5] << 16) |
379 ((unsigned long)pccb->pdata[6] << 8) |
380 ((unsigned long)pccb->pdata[7]);
384 /* Read capacity (10) was insufficient. Use read capacity (16). */
385 memset(pccb->cmd, '\0', sizeof(pccb->cmd));
386 pccb->cmd[0] = SCSI_RD_CAPAC16;
389 pccb->msgout[0] = SCSI_IDENTIFY; /* NOT USED */
392 pccb->dma_dir = DMA_FROM_DEVICE;
393 if (scsi_exec(dev, pccb))
396 *capacity = ((uint64_t)pccb->pdata[0] << 56) |
397 ((uint64_t)pccb->pdata[1] << 48) |
398 ((uint64_t)pccb->pdata[2] << 40) |
399 ((uint64_t)pccb->pdata[3] << 32) |
400 ((uint64_t)pccb->pdata[4] << 24) |
401 ((uint64_t)pccb->pdata[5] << 16) |
402 ((uint64_t)pccb->pdata[6] << 8) |
403 ((uint64_t)pccb->pdata[7]);
405 *blksz = ((uint64_t)pccb->pdata[8] << 56) |
406 ((uint64_t)pccb->pdata[9] << 48) |
407 ((uint64_t)pccb->pdata[10] << 40) |
408 ((uint64_t)pccb->pdata[11] << 32) |
409 ((uint64_t)pccb->pdata[12] << 24) |
410 ((uint64_t)pccb->pdata[13] << 16) |
411 ((uint64_t)pccb->pdata[14] << 8) |
412 ((uint64_t)pccb->pdata[15]);
419 * Some setup (fill-in) routines
421 static void scsi_setup_test_unit_ready(struct scsi_cmd *pccb)
423 pccb->cmd[0] = SCSI_TST_U_RDY;
424 pccb->cmd[1] = pccb->lun << 5;
430 pccb->msgout[0] = SCSI_IDENTIFY; /* NOT USED */
434 * scsi_init_dev_desc_priv - initialize only SCSI specific blk_desc properties
436 * @dev_desc: Block device description pointer
438 static void scsi_init_dev_desc_priv(struct blk_desc *dev_desc)
440 dev_desc->target = 0xff;
441 dev_desc->lun = 0xff;
442 dev_desc->log2blksz =
443 LOG2_INVALID(typeof(dev_desc->log2blksz));
444 dev_desc->type = DEV_TYPE_UNKNOWN;
445 dev_desc->vendor[0] = 0;
446 dev_desc->product[0] = 0;
447 dev_desc->revision[0] = 0;
448 dev_desc->removable = false;
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->uclass_id = UCLASS_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(struct udevice *dev, int target, int lun,
483 struct blk_desc *dev_desc)
485 unsigned char perq, modi;
488 struct scsi_cmd *pccb = (struct scsi_cmd *)&tempccb;
491 pccb->target = target;
493 pccb->pdata = (unsigned char *)&tempbuff;
495 pccb->dma_dir = DMA_FROM_DEVICE;
496 scsi_setup_inquiry(pccb);
497 if (scsi_exec(dev, pccb)) {
498 if (pccb->contr_stat == SCSI_SEL_TIME_OUT) {
500 * selection timeout => assuming no
503 debug("Selection timeout ID %d\n",
507 scsi_print_error(pccb);
512 if ((perq & 0x1f) == 0x1f)
513 return -ENODEV; /* skip unknown devices */
514 if ((modi & 0x80) == 0x80) /* drive is removable */
515 dev_desc->removable = true;
516 /* get info for this device */
517 scsi_ident_cpy((unsigned char *)dev_desc->vendor,
519 scsi_ident_cpy((unsigned char *)dev_desc->product,
521 scsi_ident_cpy((unsigned char *)dev_desc->revision,
523 dev_desc->target = pccb->target;
524 dev_desc->lun = pccb->lun;
526 for (count = 0; count < 3; count++) {
528 scsi_setup_test_unit_ready(pccb);
529 err = scsi_exec(dev, pccb);
534 if (dev_desc->removable) {
535 dev_desc->type = perq;
538 scsi_print_error(pccb);
541 if (scsi_read_capacity(dev, pccb, &capacity, &blksz)) {
542 scsi_print_error(pccb);
545 dev_desc->lba = capacity;
546 dev_desc->blksz = blksz;
547 dev_desc->log2blksz = LOG2(dev_desc->blksz);
548 dev_desc->type = perq;
554 * (re)-scan the scsi bus and reports scsi device info
555 * to the user if mode = 1
557 #if defined(CONFIG_DM_SCSI)
558 static int do_scsi_scan_one(struct udevice *dev, int id, int lun, bool verbose)
561 struct udevice *bdev;
563 struct blk_desc *bdesc;
567 * detect the scsi driver to get information about its geometry (block
568 * size, number of blocks) and other parameters (ids, type, ...)
570 scsi_init_dev_desc_priv(&bd);
571 if (scsi_detect_dev(dev, id, lun, &bd))
575 * Create only one block device and do detection
576 * to make sure that there won't be a lot of
577 * block devices created
579 snprintf(str, sizeof(str), "id%dlun%d", id, lun);
582 return log_msg_ret("nam", -ENOMEM);
583 ret = blk_create_devicef(dev, "scsi_blk", name, UCLASS_SCSI, -1,
584 bd.blksz, bd.lba, &bdev);
586 debug("Can't create device\n");
589 device_set_name_alloced(bdev);
591 bdesc = dev_get_uclass_plat(bdev);
594 bdesc->removable = bd.removable;
595 bdesc->type = bd.type;
596 memcpy(&bdesc->vendor, &bd.vendor, sizeof(bd.vendor));
597 memcpy(&bdesc->product, &bd.product, sizeof(bd.product));
598 memcpy(&bdesc->revision, &bd.revision, sizeof(bd.revision));
599 if (IS_ENABLED(CONFIG_SYS_BIG_ENDIAN)) {
600 ata_swap_buf_le16((u16 *)&bdesc->vendor, sizeof(bd.vendor) / 2);
601 ata_swap_buf_le16((u16 *)&bdesc->product, sizeof(bd.product) / 2);
602 ata_swap_buf_le16((u16 *)&bdesc->revision, sizeof(bd.revision) / 2);
605 ret = blk_probe_or_unbind(bdev);
607 /* TODO: undo create */
608 return log_msg_ret("pro", ret);
610 ret = bootdev_setup_sibling_blk(bdev, "scsi_bootdev");
612 return log_msg_ret("bd", ret);
615 printf(" Device %d: ", bdesc->devnum);
621 int scsi_scan_dev(struct udevice *dev, bool verbose)
623 struct scsi_plat *uc_plat; /* scsi controller plat */
628 /* probe SCSI controller driver */
629 ret = device_probe(dev);
633 /* Get controller plat */
634 uc_plat = dev_get_uclass_plat(dev);
636 for (i = 0; i < uc_plat->max_id; i++)
637 for (lun = 0; lun < uc_plat->max_lun; lun++)
638 do_scsi_scan_one(dev, i, lun, verbose);
643 int scsi_scan(bool verbose)
646 struct udevice *dev; /* SCSI controller */
650 printf("scanning bus for devices...\n");
652 ret = uclass_get(UCLASS_SCSI, &uc);
656 /* remove all children of the SCSI devices */
657 uclass_foreach_dev(dev, uc) {
658 log_debug("unbind %s\n", dev->name);
659 ret = device_chld_remove(dev, NULL, DM_REMOVE_NORMAL);
661 ret = device_chld_unbind(dev, NULL);
664 printf("unable to unbind devices (%dE)\n", ret);
665 return log_msg_ret("unb", ret);
669 uclass_foreach_dev(dev, uc) {
670 ret = scsi_scan_dev(dev, verbose);
678 int scsi_scan(bool verbose)
680 unsigned char i, lun;
684 printf("scanning bus for devices...\n");
685 for (i = 0; i < SCSI_MAX_DEVICE; i++)
686 scsi_init_dev_desc(&scsi_dev_desc[i], i);
689 for (i = 0; i < CONFIG_SYS_SCSI_MAX_SCSI_ID; i++) {
690 for (lun = 0; lun < CONFIG_SYS_SCSI_MAX_LUN; lun++) {
691 struct blk_desc *bdesc = &scsi_dev_desc[scsi_max_devs];
693 ret = scsi_detect_dev(NULL, i, lun, bdesc);
699 printf(" Device %d: ", bdesc->devnum);
705 if (scsi_max_devs > 0)
710 printf("Found %d device(s).\n", scsi_max_devs);
711 #ifndef CONFIG_SPL_BUILD
712 env_set_ulong("scsidevs", scsi_max_devs);
719 static const struct blk_ops scsi_blk_ops = {
724 U_BOOT_DRIVER(scsi_blk) = {
727 .ops = &scsi_blk_ops,
730 U_BOOT_LEGACY_BLK(scsi) = {
731 .uclass_idname = "scsi",
732 .uclass_id = UCLASS_SCSI,
733 .max_devs = SCSI_MAX_DEVICE,
734 .desc = scsi_dev_desc,