1 // SPDX-License-Identifier: GPL-2.0+
4 * Denis Peter, MPL AG Switzerland
17 #include <dm/device-internal.h>
18 #include <dm/uclass-internal.h>
20 #if !defined(CONFIG_DM_SCSI)
21 # ifdef CONFIG_SCSI_DEV_LIST
22 # define SCSI_DEV_LIST CONFIG_SCSI_DEV_LIST
24 # ifdef CONFIG_SATA_ULI5288
26 # define SCSI_VEND_ID 0x10b9
27 # define SCSI_DEV_ID 0x5288
29 # elif !defined(CONFIG_SCSI_AHCI_PLAT)
30 # error no scsi device defined
32 # define SCSI_DEV_LIST {SCSI_VEND_ID, SCSI_DEV_ID}
36 #if defined(CONFIG_PCI) && !defined(CONFIG_SCSI_AHCI_PLAT) && \
37 !defined(CONFIG_DM_SCSI)
38 const struct pci_device_id scsi_device_list[] = { SCSI_DEV_LIST };
40 static struct scsi_cmd tempccb; /* temporary scsi command buffer */
42 static unsigned char tempbuff[512]; /* temporary data buffer */
44 #if !defined(CONFIG_DM_SCSI)
45 static int scsi_max_devs; /* number of highest available scsi device */
47 static int scsi_curr_dev; /* current device */
49 static struct blk_desc scsi_dev_desc[CONFIG_SYS_SCSI_MAX_DEVICE];
52 /* almost the maximum amount of the scsi_ext command.. */
53 #define SCSI_MAX_BLK 0xFFFF
54 #define SCSI_LBA48_READ 0xFFFFFFF
56 static void scsi_print_error(struct scsi_cmd *pccb)
58 /* Dummy function that could print an error for debugging */
61 #ifdef CONFIG_SYS_64BIT_LBA
62 void scsi_setup_read16(struct scsi_cmd *pccb, lbaint_t start,
65 pccb->cmd[0] = SCSI_READ16;
66 pccb->cmd[1] = pccb->lun << 5;
67 pccb->cmd[2] = (unsigned char)(start >> 56) & 0xff;
68 pccb->cmd[3] = (unsigned char)(start >> 48) & 0xff;
69 pccb->cmd[4] = (unsigned char)(start >> 40) & 0xff;
70 pccb->cmd[5] = (unsigned char)(start >> 32) & 0xff;
71 pccb->cmd[6] = (unsigned char)(start >> 24) & 0xff;
72 pccb->cmd[7] = (unsigned char)(start >> 16) & 0xff;
73 pccb->cmd[8] = (unsigned char)(start >> 8) & 0xff;
74 pccb->cmd[9] = (unsigned char)start & 0xff;
76 pccb->cmd[11] = (unsigned char)(blocks >> 24) & 0xff;
77 pccb->cmd[12] = (unsigned char)(blocks >> 16) & 0xff;
78 pccb->cmd[13] = (unsigned char)(blocks >> 8) & 0xff;
79 pccb->cmd[14] = (unsigned char)blocks & 0xff;
82 pccb->msgout[0] = SCSI_IDENTIFY; /* NOT USED */
83 debug("scsi_setup_read16: cmd: %02X %02X startblk %02X%02X%02X%02X%02X%02X%02X%02X blccnt %02X%02X%02X%02X\n",
84 pccb->cmd[0], pccb->cmd[1],
85 pccb->cmd[2], pccb->cmd[3], pccb->cmd[4], pccb->cmd[5],
86 pccb->cmd[6], pccb->cmd[7], pccb->cmd[8], pccb->cmd[9],
87 pccb->cmd[11], pccb->cmd[12], pccb->cmd[13], pccb->cmd[14]);
91 static void scsi_setup_inquiry(struct scsi_cmd *pccb)
93 pccb->cmd[0] = SCSI_INQUIRY;
94 pccb->cmd[1] = pccb->lun << 5;
97 if (pccb->datalen > 255)
100 pccb->cmd[4] = (unsigned char)pccb->datalen;
103 pccb->msgout[0] = SCSI_IDENTIFY; /* NOT USED */
107 static void scsi_setup_read_ext(struct scsi_cmd *pccb, lbaint_t start,
108 unsigned short blocks)
110 pccb->cmd[0] = SCSI_READ10;
111 pccb->cmd[1] = pccb->lun << 5;
112 pccb->cmd[2] = (unsigned char)(start >> 24) & 0xff;
113 pccb->cmd[3] = (unsigned char)(start >> 16) & 0xff;
114 pccb->cmd[4] = (unsigned char)(start >> 8) & 0xff;
115 pccb->cmd[5] = (unsigned char)start & 0xff;
117 pccb->cmd[7] = (unsigned char)(blocks >> 8) & 0xff;
118 pccb->cmd[8] = (unsigned char)blocks & 0xff;
121 pccb->msgout[0] = SCSI_IDENTIFY; /* NOT USED */
122 debug("scsi_setup_read_ext: 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_write_ext(struct scsi_cmd *pccb, lbaint_t start,
129 unsigned short blocks)
131 pccb->cmd[0] = SCSI_WRITE10;
132 pccb->cmd[1] = pccb->lun << 5;
133 pccb->cmd[2] = (unsigned char)(start >> 24) & 0xff;
134 pccb->cmd[3] = (unsigned char)(start >> 16) & 0xff;
135 pccb->cmd[4] = (unsigned char)(start >> 8) & 0xff;
136 pccb->cmd[5] = (unsigned char)start & 0xff;
138 pccb->cmd[7] = ((unsigned char)(blocks >> 8)) & 0xff;
139 pccb->cmd[8] = (unsigned char)blocks & 0xff;
142 pccb->msgout[0] = SCSI_IDENTIFY; /* NOT USED */
143 debug("%s: cmd: %02X %02X startblk %02X%02X%02X%02X blccnt %02X%02X\n",
145 pccb->cmd[0], pccb->cmd[1],
146 pccb->cmd[2], pccb->cmd[3], pccb->cmd[4], pccb->cmd[5],
147 pccb->cmd[7], pccb->cmd[8]);
150 static ulong scsi_read(struct udevice *dev, lbaint_t blknr, lbaint_t blkcnt,
153 struct blk_desc *block_dev = dev_get_uclass_plat(dev);
154 struct udevice *bdev = dev->parent;
155 struct scsi_plat *uc_plat = dev_get_uclass_plat(bdev);
156 lbaint_t start, blks, max_blks;
158 unsigned short smallblks = 0;
159 struct scsi_cmd *pccb = (struct scsi_cmd *)&tempccb;
162 pccb->target = block_dev->target;
163 pccb->lun = block_dev->lun;
164 buf_addr = (unsigned long)buffer;
167 if (uc_plat->max_bytes_per_req)
168 max_blks = uc_plat->max_bytes_per_req / block_dev->blksz;
170 max_blks = SCSI_MAX_BLK;
172 debug("\nscsi_read: dev %d startblk " LBAF
173 ", blccnt " LBAF " buffer %lx\n",
174 block_dev->devnum, start, blks, (unsigned long)buffer);
176 pccb->pdata = (unsigned char *)buf_addr;
177 pccb->dma_dir = DMA_FROM_DEVICE;
178 #ifdef CONFIG_SYS_64BIT_LBA
179 if (start > SCSI_LBA48_READ) {
180 unsigned long blocks;
181 blocks = min_t(lbaint_t, blks, max_blks);
182 pccb->datalen = block_dev->blksz * blocks;
183 scsi_setup_read16(pccb, start, blocks);
188 if (blks > max_blks) {
189 pccb->datalen = block_dev->blksz * max_blks;
190 smallblks = max_blks;
191 scsi_setup_read_ext(pccb, start, smallblks);
195 pccb->datalen = block_dev->blksz * blks;
196 smallblks = (unsigned short)blks;
197 scsi_setup_read_ext(pccb, start, smallblks);
201 debug("scsi_read_ext: startblk " LBAF
202 ", blccnt %x buffer %lX\n",
203 start, smallblks, buf_addr);
204 if (scsi_exec(bdev, pccb)) {
205 scsi_print_error(pccb);
209 buf_addr += pccb->datalen;
211 debug("scsi_read_ext: end startblk " LBAF
212 ", blccnt %x buffer %lX\n", start, smallblks, buf_addr);
216 /*******************************************************************************
220 static ulong scsi_write(struct udevice *dev, lbaint_t blknr, lbaint_t blkcnt,
223 struct blk_desc *block_dev = dev_get_uclass_plat(dev);
224 struct udevice *bdev = dev->parent;
225 struct scsi_plat *uc_plat = dev_get_uclass_plat(bdev);
226 lbaint_t start, blks, max_blks;
228 unsigned short smallblks;
229 struct scsi_cmd *pccb = (struct scsi_cmd *)&tempccb;
232 pccb->target = block_dev->target;
233 pccb->lun = block_dev->lun;
234 buf_addr = (unsigned long)buffer;
237 if (uc_plat->max_bytes_per_req)
238 max_blks = uc_plat->max_bytes_per_req / block_dev->blksz;
240 max_blks = SCSI_MAX_BLK;
242 debug("\n%s: dev %d startblk " LBAF ", blccnt " LBAF " buffer %lx\n",
243 __func__, block_dev->devnum, start, blks, (unsigned long)buffer);
245 pccb->pdata = (unsigned char *)buf_addr;
246 pccb->dma_dir = DMA_TO_DEVICE;
247 if (blks > max_blks) {
248 pccb->datalen = block_dev->blksz * max_blks;
249 smallblks = max_blks;
250 scsi_setup_write_ext(pccb, start, smallblks);
254 pccb->datalen = block_dev->blksz * blks;
255 smallblks = (unsigned short)blks;
256 scsi_setup_write_ext(pccb, start, smallblks);
260 debug("%s: startblk " LBAF ", blccnt %x buffer %lx\n",
261 __func__, start, smallblks, buf_addr);
262 if (scsi_exec(bdev, pccb)) {
263 scsi_print_error(pccb);
267 buf_addr += pccb->datalen;
269 debug("%s: end startblk " LBAF ", blccnt %x buffer %lX\n",
270 __func__, start, smallblks, buf_addr);
275 #if defined(CONFIG_PCI) && !defined(CONFIG_SCSI_AHCI_PLAT) && \
276 !defined(CONFIG_DM_SCSI)
282 * Find a device from the list, this driver will support a single
285 for (i = 0; i < ARRAY_SIZE(scsi_device_list); i++) {
286 /* get PCI Device ID */
291 ret = dm_pci_find_device(scsi_device_list[i].vendor,
292 scsi_device_list[i].device, 0, &dev);
294 busdevfunc = dm_pci_get_bdf(dev);
298 busdevfunc = pci_find_device(scsi_device_list[i].vendor,
299 scsi_device_list[i].device,
302 if (busdevfunc != -1)
306 if (busdevfunc == -1) {
307 printf("Error: SCSI Controller(s) ");
308 for (i = 0; i < ARRAY_SIZE(scsi_device_list); i++) {
310 scsi_device_list[i].vendor,
311 scsi_device_list[i].device);
313 printf("not found\n");
318 printf("SCSI Controller (%04X,%04X) found (%d:%d:%d)\n",
319 scsi_device_list[i].vendor,
320 scsi_device_list[i].device,
321 (busdevfunc >> 16) & 0xFF,
322 (busdevfunc >> 11) & 0x1F,
323 (busdevfunc >> 8) & 0x7);
326 bootstage_start(BOOTSTAGE_ID_ACCUM_SCSI, "ahci");
327 scsi_low_level_init(busdevfunc);
329 bootstage_accum(BOOTSTAGE_ID_ACCUM_SCSI);
333 /* copy src to dest, skipping leading and trailing blanks
334 * and null terminate the string
336 static void scsi_ident_cpy(unsigned char *dest, unsigned char *src,
342 while (start < len) {
343 if (src[start] != ' ')
348 while (end > start) {
353 for (; start <= end; start++)
354 *dest ++= src[start];
358 static int scsi_read_capacity(struct udevice *dev, struct scsi_cmd *pccb,
359 lbaint_t *capacity, unsigned long *blksz)
363 memset(pccb->cmd, '\0', sizeof(pccb->cmd));
364 pccb->cmd[0] = SCSI_RD_CAPAC10;
365 pccb->cmd[1] = pccb->lun << 5;
367 pccb->msgout[0] = SCSI_IDENTIFY; /* NOT USED */
370 if (scsi_exec(dev, pccb))
373 *capacity = ((lbaint_t)pccb->pdata[0] << 24) |
374 ((lbaint_t)pccb->pdata[1] << 16) |
375 ((lbaint_t)pccb->pdata[2] << 8) |
376 ((lbaint_t)pccb->pdata[3]);
378 if (*capacity != 0xffffffff) {
379 /* Read capacity (10) was sufficient for this drive. */
380 *blksz = ((unsigned long)pccb->pdata[4] << 24) |
381 ((unsigned long)pccb->pdata[5] << 16) |
382 ((unsigned long)pccb->pdata[6] << 8) |
383 ((unsigned long)pccb->pdata[7]);
387 /* Read capacity (10) was insufficient. Use read capacity (16). */
388 memset(pccb->cmd, '\0', sizeof(pccb->cmd));
389 pccb->cmd[0] = SCSI_RD_CAPAC16;
392 pccb->msgout[0] = SCSI_IDENTIFY; /* NOT USED */
395 pccb->dma_dir = DMA_FROM_DEVICE;
396 if (scsi_exec(dev, pccb))
399 *capacity = ((uint64_t)pccb->pdata[0] << 56) |
400 ((uint64_t)pccb->pdata[1] << 48) |
401 ((uint64_t)pccb->pdata[2] << 40) |
402 ((uint64_t)pccb->pdata[3] << 32) |
403 ((uint64_t)pccb->pdata[4] << 24) |
404 ((uint64_t)pccb->pdata[5] << 16) |
405 ((uint64_t)pccb->pdata[6] << 8) |
406 ((uint64_t)pccb->pdata[7]);
408 *blksz = ((uint64_t)pccb->pdata[8] << 56) |
409 ((uint64_t)pccb->pdata[9] << 48) |
410 ((uint64_t)pccb->pdata[10] << 40) |
411 ((uint64_t)pccb->pdata[11] << 32) |
412 ((uint64_t)pccb->pdata[12] << 24) |
413 ((uint64_t)pccb->pdata[13] << 16) |
414 ((uint64_t)pccb->pdata[14] << 8) |
415 ((uint64_t)pccb->pdata[15]);
422 * Some setup (fill-in) routines
424 static void scsi_setup_test_unit_ready(struct scsi_cmd *pccb)
426 pccb->cmd[0] = SCSI_TST_U_RDY;
427 pccb->cmd[1] = pccb->lun << 5;
433 pccb->msgout[0] = SCSI_IDENTIFY; /* NOT USED */
437 * scsi_init_dev_desc_priv - initialize only SCSI specific blk_desc properties
439 * @dev_desc: Block device description pointer
441 static void scsi_init_dev_desc_priv(struct blk_desc *dev_desc)
443 dev_desc->target = 0xff;
444 dev_desc->lun = 0xff;
445 dev_desc->log2blksz =
446 LOG2_INVALID(typeof(dev_desc->log2blksz));
447 dev_desc->type = DEV_TYPE_UNKNOWN;
448 dev_desc->vendor[0] = 0;
449 dev_desc->product[0] = 0;
450 dev_desc->revision[0] = 0;
451 dev_desc->removable = false;
454 #if !defined(CONFIG_DM_SCSI)
456 * scsi_init_dev_desc - initialize all SCSI specific blk_desc properties
458 * @dev_desc: Block device description pointer
459 * @devnum: Device number
461 static void scsi_init_dev_desc(struct blk_desc *dev_desc, int devnum)
465 dev_desc->if_type = IF_TYPE_SCSI;
466 dev_desc->devnum = devnum;
467 dev_desc->part_type = PART_TYPE_UNKNOWN;
469 scsi_init_dev_desc_priv(dev_desc);
474 * scsi_detect_dev - Detect scsi device
478 * @dev_desc: block device description
480 * The scsi_detect_dev detects and fills a dev_desc structure when the device is
483 * Return: 0 on success, error value otherwise
485 static int scsi_detect_dev(struct udevice *dev, int target, int lun,
486 struct blk_desc *dev_desc)
488 unsigned char perq, modi;
491 struct scsi_cmd *pccb = (struct scsi_cmd *)&tempccb;
494 pccb->target = target;
496 pccb->pdata = (unsigned char *)&tempbuff;
498 pccb->dma_dir = DMA_FROM_DEVICE;
499 scsi_setup_inquiry(pccb);
500 if (scsi_exec(dev, pccb)) {
501 if (pccb->contr_stat == SCSI_SEL_TIME_OUT) {
503 * selection timeout => assuming no
506 debug("Selection timeout ID %d\n",
510 scsi_print_error(pccb);
515 if ((perq & 0x1f) == 0x1f)
516 return -ENODEV; /* skip unknown devices */
517 if ((modi & 0x80) == 0x80) /* drive is removable */
518 dev_desc->removable = true;
519 /* get info for this device */
520 scsi_ident_cpy((unsigned char *)dev_desc->vendor,
522 scsi_ident_cpy((unsigned char *)dev_desc->product,
524 scsi_ident_cpy((unsigned char *)dev_desc->revision,
526 dev_desc->target = pccb->target;
527 dev_desc->lun = pccb->lun;
529 for (count = 0; count < 3; count++) {
531 scsi_setup_test_unit_ready(pccb);
532 err = scsi_exec(dev, pccb);
537 if (dev_desc->removable) {
538 dev_desc->type = perq;
541 scsi_print_error(pccb);
544 if (scsi_read_capacity(dev, pccb, &capacity, &blksz)) {
545 scsi_print_error(pccb);
548 dev_desc->lba = capacity;
549 dev_desc->blksz = blksz;
550 dev_desc->log2blksz = LOG2(dev_desc->blksz);
551 dev_desc->type = perq;
557 * (re)-scan the scsi bus and reports scsi device info
558 * to the user if mode = 1
560 #if defined(CONFIG_DM_SCSI)
561 static int do_scsi_scan_one(struct udevice *dev, int id, int lun, bool verbose)
564 struct udevice *bdev;
566 struct blk_desc *bdesc;
570 * detect the scsi driver to get information about its geometry (block
571 * size, number of blocks) and other parameters (ids, type, ...)
573 scsi_init_dev_desc_priv(&bd);
574 if (scsi_detect_dev(dev, id, lun, &bd))
578 * Create only one block device and do detection
579 * to make sure that there won't be a lot of
580 * block devices created
582 snprintf(str, sizeof(str), "id%dlun%d", id, lun);
583 ret = blk_create_devicef(dev, "scsi_blk", str, IF_TYPE_SCSI, -1,
584 bd.blksz, bd.lba, &bdev);
586 debug("Can't create device\n");
590 bdesc = dev_get_uclass_plat(bdev);
593 bdesc->removable = bd.removable;
594 bdesc->type = bd.type;
595 memcpy(&bdesc->vendor, &bd.vendor, sizeof(bd.vendor));
596 memcpy(&bdesc->product, &bd.product, sizeof(bd.product));
597 memcpy(&bdesc->revision, &bd.revision, sizeof(bd.revision));
598 if (IS_ENABLED(CONFIG_SYS_BIG_ENDIAN)) {
599 ata_swap_buf_le16((u16 *)&bdesc->vendor, sizeof(bd.vendor) / 2);
600 ata_swap_buf_le16((u16 *)&bdesc->product, sizeof(bd.product) / 2);
601 ata_swap_buf_le16((u16 *)&bdesc->revision, sizeof(bd.revision) / 2);
605 printf(" Device %d: ", bdesc->devnum);
611 int scsi_scan_dev(struct udevice *dev, bool verbose)
613 struct scsi_plat *uc_plat; /* scsi controller plat */
618 /* probe SCSI controller driver */
619 ret = device_probe(dev);
623 /* Get controller plat */
624 uc_plat = dev_get_uclass_plat(dev);
626 for (i = 0; i < uc_plat->max_id; i++)
627 for (lun = 0; lun < uc_plat->max_lun; lun++)
628 do_scsi_scan_one(dev, i, lun, verbose);
633 int scsi_scan(bool verbose)
636 struct udevice *dev; /* SCSI controller */
640 printf("scanning bus for devices...\n");
642 blk_unbind_all(IF_TYPE_SCSI);
644 ret = uclass_get(UCLASS_SCSI, &uc);
648 uclass_foreach_dev(dev, uc) {
649 ret = scsi_scan_dev(dev, verbose);
657 int scsi_scan(bool verbose)
659 unsigned char i, lun;
663 printf("scanning bus for devices...\n");
664 for (i = 0; i < CONFIG_SYS_SCSI_MAX_DEVICE; i++)
665 scsi_init_dev_desc(&scsi_dev_desc[i], i);
668 for (i = 0; i < CONFIG_SYS_SCSI_MAX_SCSI_ID; i++) {
669 for (lun = 0; lun < CONFIG_SYS_SCSI_MAX_LUN; lun++) {
670 struct blk_desc *bdesc = &scsi_dev_desc[scsi_max_devs];
672 ret = scsi_detect_dev(NULL, i, lun, bdesc);
678 printf(" Device %d: ", bdesc->devnum);
684 if (scsi_max_devs > 0)
689 printf("Found %d device(s).\n", scsi_max_devs);
690 #ifndef CONFIG_SPL_BUILD
691 env_set_ulong("scsidevs", scsi_max_devs);
698 static const struct blk_ops scsi_blk_ops = {
703 U_BOOT_DRIVER(scsi_blk) = {
706 .ops = &scsi_blk_ops,
709 U_BOOT_LEGACY_BLK(scsi) = {
710 .if_typename = "scsi",
711 .if_type = IF_TYPE_SCSI,
712 .max_devs = CONFIG_SYS_SCSI_MAX_DEVICE,
713 .desc = scsi_dev_desc,