1 // SPDX-License-Identifier: GPL-2.0+
4 * Denis Peter, MPL AG Switzerland
16 #include <dm/device-internal.h>
17 #include <dm/uclass-internal.h>
19 #if !defined(CONFIG_DM_SCSI)
20 # ifdef CONFIG_SCSI_DEV_LIST
21 # define SCSI_DEV_LIST CONFIG_SCSI_DEV_LIST
23 # ifdef CONFIG_SATA_ULI5288
25 # define SCSI_VEND_ID 0x10b9
26 # define SCSI_DEV_ID 0x5288
28 # elif !defined(CONFIG_SCSI_AHCI_PLAT)
29 # error no scsi device defined
31 # define SCSI_DEV_LIST {SCSI_VEND_ID, SCSI_DEV_ID}
35 #if defined(CONFIG_PCI) && !defined(CONFIG_SCSI_AHCI_PLAT) && \
36 !defined(CONFIG_DM_SCSI)
37 const struct pci_device_id scsi_device_list[] = { SCSI_DEV_LIST };
39 static struct scsi_cmd tempccb; /* temporary scsi command buffer */
41 static unsigned char tempbuff[512]; /* temporary data buffer */
43 #if !defined(CONFIG_DM_SCSI)
44 static int scsi_max_devs; /* number of highest available scsi device */
46 static int scsi_curr_dev; /* current device */
48 static struct blk_desc scsi_dev_desc[CONFIG_SYS_SCSI_MAX_DEVICE];
51 /* almost the maximum amount of the scsi_ext command.. */
52 #define SCSI_MAX_BLK 0xFFFF
53 #define SCSI_LBA48_READ 0xFFFFFFF
55 static void scsi_print_error(struct scsi_cmd *pccb)
57 /* Dummy function that could print an error for debugging */
60 #ifdef CONFIG_SYS_64BIT_LBA
61 void scsi_setup_read16(struct scsi_cmd *pccb, lbaint_t start,
64 pccb->cmd[0] = SCSI_READ16;
65 pccb->cmd[1] = pccb->lun << 5;
66 pccb->cmd[2] = (unsigned char)(start >> 56) & 0xff;
67 pccb->cmd[3] = (unsigned char)(start >> 48) & 0xff;
68 pccb->cmd[4] = (unsigned char)(start >> 40) & 0xff;
69 pccb->cmd[5] = (unsigned char)(start >> 32) & 0xff;
70 pccb->cmd[6] = (unsigned char)(start >> 24) & 0xff;
71 pccb->cmd[7] = (unsigned char)(start >> 16) & 0xff;
72 pccb->cmd[8] = (unsigned char)(start >> 8) & 0xff;
73 pccb->cmd[9] = (unsigned char)start & 0xff;
75 pccb->cmd[11] = (unsigned char)(blocks >> 24) & 0xff;
76 pccb->cmd[12] = (unsigned char)(blocks >> 16) & 0xff;
77 pccb->cmd[13] = (unsigned char)(blocks >> 8) & 0xff;
78 pccb->cmd[14] = (unsigned char)blocks & 0xff;
81 pccb->msgout[0] = SCSI_IDENTIFY; /* NOT USED */
82 debug("scsi_setup_read16: cmd: %02X %02X startblk %02X%02X%02X%02X%02X%02X%02X%02X blccnt %02X%02X%02X%02X\n",
83 pccb->cmd[0], pccb->cmd[1],
84 pccb->cmd[2], pccb->cmd[3], pccb->cmd[4], pccb->cmd[5],
85 pccb->cmd[6], pccb->cmd[7], pccb->cmd[8], pccb->cmd[9],
86 pccb->cmd[11], pccb->cmd[12], pccb->cmd[13], pccb->cmd[14]);
90 static void scsi_setup_inquiry(struct scsi_cmd *pccb)
92 pccb->cmd[0] = SCSI_INQUIRY;
93 pccb->cmd[1] = pccb->lun << 5;
96 if (pccb->datalen > 255)
99 pccb->cmd[4] = (unsigned char)pccb->datalen;
102 pccb->msgout[0] = SCSI_IDENTIFY; /* NOT USED */
106 static void scsi_setup_read_ext(struct scsi_cmd *pccb, lbaint_t start,
107 unsigned short blocks)
109 pccb->cmd[0] = SCSI_READ10;
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("scsi_setup_read_ext: cmd: %02X %02X startblk %02X%02X%02X%02X blccnt %02X%02X\n",
122 pccb->cmd[0], pccb->cmd[1],
123 pccb->cmd[2], pccb->cmd[3], pccb->cmd[4], pccb->cmd[5],
124 pccb->cmd[7], pccb->cmd[8]);
127 static void scsi_setup_write_ext(struct scsi_cmd *pccb, lbaint_t start,
128 unsigned short blocks)
130 pccb->cmd[0] = SCSI_WRITE10;
131 pccb->cmd[1] = pccb->lun << 5;
132 pccb->cmd[2] = (unsigned char)(start >> 24) & 0xff;
133 pccb->cmd[3] = (unsigned char)(start >> 16) & 0xff;
134 pccb->cmd[4] = (unsigned char)(start >> 8) & 0xff;
135 pccb->cmd[5] = (unsigned char)start & 0xff;
137 pccb->cmd[7] = ((unsigned char)(blocks >> 8)) & 0xff;
138 pccb->cmd[8] = (unsigned char)blocks & 0xff;
141 pccb->msgout[0] = SCSI_IDENTIFY; /* NOT USED */
142 debug("%s: cmd: %02X %02X startblk %02X%02X%02X%02X blccnt %02X%02X\n",
144 pccb->cmd[0], pccb->cmd[1],
145 pccb->cmd[2], pccb->cmd[3], pccb->cmd[4], pccb->cmd[5],
146 pccb->cmd[7], pccb->cmd[8]);
149 static ulong scsi_read(struct udevice *dev, lbaint_t blknr, lbaint_t blkcnt,
152 struct blk_desc *block_dev = dev_get_uclass_platdata(dev);
153 struct udevice *bdev = dev->parent;
154 struct scsi_platdata *uc_plat = dev_get_uclass_platdata(bdev);
155 lbaint_t start, blks, max_blks;
157 unsigned short smallblks = 0;
158 struct scsi_cmd *pccb = (struct scsi_cmd *)&tempccb;
161 pccb->target = block_dev->target;
162 pccb->lun = block_dev->lun;
163 buf_addr = (unsigned long)buffer;
166 if (uc_plat->max_bytes_per_req)
167 max_blks = uc_plat->max_bytes_per_req / block_dev->blksz;
169 max_blks = SCSI_MAX_BLK;
171 debug("\nscsi_read: dev %d startblk " LBAF
172 ", blccnt " LBAF " buffer %lx\n",
173 block_dev->devnum, start, blks, (unsigned long)buffer);
175 pccb->pdata = (unsigned char *)buf_addr;
176 pccb->dma_dir = DMA_FROM_DEVICE;
177 #ifdef CONFIG_SYS_64BIT_LBA
178 if (start > SCSI_LBA48_READ) {
179 unsigned long blocks;
180 blocks = min_t(lbaint_t, blks, max_blks);
181 pccb->datalen = block_dev->blksz * blocks;
182 scsi_setup_read16(pccb, start, blocks);
187 if (blks > max_blks) {
188 pccb->datalen = block_dev->blksz * max_blks;
189 smallblks = max_blks;
190 scsi_setup_read_ext(pccb, start, smallblks);
194 pccb->datalen = block_dev->blksz * blks;
195 smallblks = (unsigned short)blks;
196 scsi_setup_read_ext(pccb, start, smallblks);
200 debug("scsi_read_ext: startblk " LBAF
201 ", blccnt %x buffer %lX\n",
202 start, smallblks, buf_addr);
203 if (scsi_exec(bdev, pccb)) {
204 scsi_print_error(pccb);
208 buf_addr += pccb->datalen;
210 debug("scsi_read_ext: end startblk " LBAF
211 ", blccnt %x buffer %lX\n", start, smallblks, buf_addr);
215 /*******************************************************************************
219 static ulong scsi_write(struct udevice *dev, lbaint_t blknr, lbaint_t blkcnt,
222 struct blk_desc *block_dev = dev_get_uclass_platdata(dev);
223 struct udevice *bdev = dev->parent;
224 struct scsi_platdata *uc_plat = dev_get_uclass_platdata(bdev);
225 lbaint_t start, blks, max_blks;
227 unsigned short smallblks;
228 struct scsi_cmd *pccb = (struct scsi_cmd *)&tempccb;
231 pccb->target = block_dev->target;
232 pccb->lun = block_dev->lun;
233 buf_addr = (unsigned long)buffer;
236 if (uc_plat->max_bytes_per_req)
237 max_blks = uc_plat->max_bytes_per_req / block_dev->blksz;
239 max_blks = SCSI_MAX_BLK;
241 debug("\n%s: dev %d startblk " LBAF ", blccnt " LBAF " buffer %lx\n",
242 __func__, block_dev->devnum, start, blks, (unsigned long)buffer);
244 pccb->pdata = (unsigned char *)buf_addr;
245 pccb->dma_dir = DMA_TO_DEVICE;
246 if (blks > max_blks) {
247 pccb->datalen = block_dev->blksz * max_blks;
248 smallblks = max_blks;
249 scsi_setup_write_ext(pccb, start, smallblks);
253 pccb->datalen = block_dev->blksz * blks;
254 smallblks = (unsigned short)blks;
255 scsi_setup_write_ext(pccb, start, smallblks);
259 debug("%s: startblk " LBAF ", blccnt %x buffer %lx\n",
260 __func__, start, smallblks, buf_addr);
261 if (scsi_exec(bdev, pccb)) {
262 scsi_print_error(pccb);
266 buf_addr += pccb->datalen;
268 debug("%s: end startblk " LBAF ", blccnt %x buffer %lX\n",
269 __func__, start, smallblks, buf_addr);
274 #if defined(CONFIG_PCI) && !defined(CONFIG_SCSI_AHCI_PLAT) && \
275 !defined(CONFIG_DM_SCSI)
281 * Find a device from the list, this driver will support a single
284 for (i = 0; i < ARRAY_SIZE(scsi_device_list); i++) {
285 /* get PCI Device ID */
290 ret = dm_pci_find_device(scsi_device_list[i].vendor,
291 scsi_device_list[i].device, 0, &dev);
293 busdevfunc = dm_pci_get_bdf(dev);
297 busdevfunc = pci_find_device(scsi_device_list[i].vendor,
298 scsi_device_list[i].device,
301 if (busdevfunc != -1)
305 if (busdevfunc == -1) {
306 printf("Error: SCSI Controller(s) ");
307 for (i = 0; i < ARRAY_SIZE(scsi_device_list); i++) {
309 scsi_device_list[i].vendor,
310 scsi_device_list[i].device);
312 printf("not found\n");
317 printf("SCSI Controller (%04X,%04X) found (%d:%d:%d)\n",
318 scsi_device_list[i].vendor,
319 scsi_device_list[i].device,
320 (busdevfunc >> 16) & 0xFF,
321 (busdevfunc >> 11) & 0x1F,
322 (busdevfunc >> 8) & 0x7);
325 bootstage_start(BOOTSTAGE_ID_ACCUM_SCSI, "ahci");
326 scsi_low_level_init(busdevfunc);
328 bootstage_accum(BOOTSTAGE_ID_ACCUM_SCSI);
332 /* copy src to dest, skipping leading and trailing blanks
333 * and null terminate the string
335 static void scsi_ident_cpy(unsigned char *dest, unsigned char *src,
341 while (start < len) {
342 if (src[start] != ' ')
347 while (end > start) {
352 for (; start <= end; start++)
353 *dest ++= src[start];
357 static int scsi_read_capacity(struct udevice *dev, struct scsi_cmd *pccb,
358 lbaint_t *capacity, unsigned long *blksz)
362 memset(pccb->cmd, '\0', sizeof(pccb->cmd));
363 pccb->cmd[0] = SCSI_RD_CAPAC10;
364 pccb->cmd[1] = pccb->lun << 5;
366 pccb->msgout[0] = SCSI_IDENTIFY; /* NOT USED */
369 if (scsi_exec(dev, pccb))
372 *capacity = ((lbaint_t)pccb->pdata[0] << 24) |
373 ((lbaint_t)pccb->pdata[1] << 16) |
374 ((lbaint_t)pccb->pdata[2] << 8) |
375 ((lbaint_t)pccb->pdata[3]);
377 if (*capacity != 0xffffffff) {
378 /* Read capacity (10) was sufficient for this drive. */
379 *blksz = ((unsigned long)pccb->pdata[4] << 24) |
380 ((unsigned long)pccb->pdata[5] << 16) |
381 ((unsigned long)pccb->pdata[6] << 8) |
382 ((unsigned long)pccb->pdata[7]);
386 /* Read capacity (10) was insufficient. Use read capacity (16). */
387 memset(pccb->cmd, '\0', sizeof(pccb->cmd));
388 pccb->cmd[0] = SCSI_RD_CAPAC16;
391 pccb->msgout[0] = SCSI_IDENTIFY; /* NOT USED */
394 pccb->dma_dir = DMA_FROM_DEVICE;
395 if (scsi_exec(dev, pccb))
398 *capacity = ((uint64_t)pccb->pdata[0] << 56) |
399 ((uint64_t)pccb->pdata[1] << 48) |
400 ((uint64_t)pccb->pdata[2] << 40) |
401 ((uint64_t)pccb->pdata[3] << 32) |
402 ((uint64_t)pccb->pdata[4] << 24) |
403 ((uint64_t)pccb->pdata[5] << 16) |
404 ((uint64_t)pccb->pdata[6] << 8) |
405 ((uint64_t)pccb->pdata[7]);
407 *blksz = ((uint64_t)pccb->pdata[8] << 56) |
408 ((uint64_t)pccb->pdata[9] << 48) |
409 ((uint64_t)pccb->pdata[10] << 40) |
410 ((uint64_t)pccb->pdata[11] << 32) |
411 ((uint64_t)pccb->pdata[12] << 24) |
412 ((uint64_t)pccb->pdata[13] << 16) |
413 ((uint64_t)pccb->pdata[14] << 8) |
414 ((uint64_t)pccb->pdata[15]);
421 * Some setup (fill-in) routines
423 static void scsi_setup_test_unit_ready(struct scsi_cmd *pccb)
425 pccb->cmd[0] = SCSI_TST_U_RDY;
426 pccb->cmd[1] = pccb->lun << 5;
432 pccb->msgout[0] = SCSI_IDENTIFY; /* NOT USED */
436 * scsi_init_dev_desc_priv - initialize only SCSI specific blk_desc properties
438 * @dev_desc: Block device description pointer
440 static void scsi_init_dev_desc_priv(struct blk_desc *dev_desc)
442 dev_desc->target = 0xff;
443 dev_desc->lun = 0xff;
444 dev_desc->log2blksz =
445 LOG2_INVALID(typeof(dev_desc->log2blksz));
446 dev_desc->type = DEV_TYPE_UNKNOWN;
447 dev_desc->vendor[0] = 0;
448 dev_desc->product[0] = 0;
449 dev_desc->revision[0] = 0;
450 dev_desc->removable = false;
453 #if !defined(CONFIG_DM_SCSI)
455 * scsi_init_dev_desc - initialize all SCSI specific blk_desc properties
457 * @dev_desc: Block device description pointer
458 * @devnum: Device number
460 static void scsi_init_dev_desc(struct blk_desc *dev_desc, int devnum)
464 dev_desc->if_type = IF_TYPE_SCSI;
465 dev_desc->devnum = devnum;
466 dev_desc->part_type = PART_TYPE_UNKNOWN;
468 scsi_init_dev_desc_priv(dev_desc);
473 * scsi_detect_dev - Detect scsi device
477 * @dev_desc: block device description
479 * The scsi_detect_dev detects and fills a dev_desc structure when the device is
482 * Return: 0 on success, error value otherwise
484 static int scsi_detect_dev(struct udevice *dev, int target, int lun,
485 struct blk_desc *dev_desc)
487 unsigned char perq, modi;
490 struct scsi_cmd *pccb = (struct scsi_cmd *)&tempccb;
493 pccb->target = target;
495 pccb->pdata = (unsigned char *)&tempbuff;
497 pccb->dma_dir = DMA_FROM_DEVICE;
498 scsi_setup_inquiry(pccb);
499 if (scsi_exec(dev, pccb)) {
500 if (pccb->contr_stat == SCSI_SEL_TIME_OUT) {
502 * selection timeout => assuming no
505 debug("Selection timeout ID %d\n",
509 scsi_print_error(pccb);
514 if ((perq & 0x1f) == 0x1f)
515 return -ENODEV; /* skip unknown devices */
516 if ((modi & 0x80) == 0x80) /* drive is removable */
517 dev_desc->removable = true;
518 /* get info for this device */
519 scsi_ident_cpy((unsigned char *)dev_desc->vendor,
521 scsi_ident_cpy((unsigned char *)dev_desc->product,
523 scsi_ident_cpy((unsigned char *)dev_desc->revision,
525 dev_desc->target = pccb->target;
526 dev_desc->lun = pccb->lun;
528 for (count = 0; count < 3; count++) {
530 scsi_setup_test_unit_ready(pccb);
531 err = scsi_exec(dev, pccb);
536 if (dev_desc->removable) {
537 dev_desc->type = perq;
540 scsi_print_error(pccb);
543 if (scsi_read_capacity(dev, pccb, &capacity, &blksz)) {
544 scsi_print_error(pccb);
547 dev_desc->lba = capacity;
548 dev_desc->blksz = blksz;
549 dev_desc->log2blksz = LOG2(dev_desc->blksz);
550 dev_desc->type = perq;
556 * (re)-scan the scsi bus and reports scsi device info
557 * to the user if mode = 1
559 #if defined(CONFIG_DM_SCSI)
560 static int do_scsi_scan_one(struct udevice *dev, int id, int lun, bool verbose)
563 struct udevice *bdev;
565 struct blk_desc *bdesc;
569 * detect the scsi driver to get information about its geometry (block
570 * size, number of blocks) and other parameters (ids, type, ...)
572 scsi_init_dev_desc_priv(&bd);
573 if (scsi_detect_dev(dev, id, lun, &bd))
577 * Create only one block device and do detection
578 * to make sure that there won't be a lot of
579 * block devices created
581 snprintf(str, sizeof(str), "id%dlun%d", id, lun);
582 ret = blk_create_devicef(dev, "scsi_blk", str, IF_TYPE_SCSI, -1,
583 bd.blksz, bd.lba, &bdev);
585 debug("Can't create device\n");
589 bdesc = dev_get_uclass_platdata(bdev);
592 bdesc->removable = bd.removable;
593 bdesc->type = bd.type;
594 memcpy(&bdesc->vendor, &bd.vendor, sizeof(bd.vendor));
595 memcpy(&bdesc->product, &bd.product, sizeof(bd.product));
596 memcpy(&bdesc->revision, &bd.revision, sizeof(bd.revision));
599 printf(" Device %d: ", bdesc->devnum);
605 int scsi_scan_dev(struct udevice *dev, bool verbose)
607 struct scsi_platdata *uc_plat; /* scsi controller platdata */
612 /* probe SCSI controller driver */
613 ret = device_probe(dev);
617 /* Get controller platdata */
618 uc_plat = dev_get_uclass_platdata(dev);
620 for (i = 0; i < uc_plat->max_id; i++)
621 for (lun = 0; lun < uc_plat->max_lun; lun++)
622 do_scsi_scan_one(dev, i, lun, verbose);
627 int scsi_scan(bool verbose)
630 struct udevice *dev; /* SCSI controller */
634 printf("scanning bus for devices...\n");
636 blk_unbind_all(IF_TYPE_SCSI);
638 ret = uclass_get(UCLASS_SCSI, &uc);
642 uclass_foreach_dev(dev, uc) {
643 ret = scsi_scan_dev(dev, verbose);
651 int scsi_scan(bool verbose)
653 unsigned char i, lun;
657 printf("scanning bus for devices...\n");
658 for (i = 0; i < CONFIG_SYS_SCSI_MAX_DEVICE; i++)
659 scsi_init_dev_desc(&scsi_dev_desc[i], i);
662 for (i = 0; i < CONFIG_SYS_SCSI_MAX_SCSI_ID; i++) {
663 for (lun = 0; lun < CONFIG_SYS_SCSI_MAX_LUN; lun++) {
664 struct blk_desc *bdesc = &scsi_dev_desc[scsi_max_devs];
666 ret = scsi_detect_dev(NULL, i, lun, bdesc);
672 printf(" Device %d: ", bdesc->devnum);
678 if (scsi_max_devs > 0)
683 printf("Found %d device(s).\n", scsi_max_devs);
684 #ifndef CONFIG_SPL_BUILD
685 env_set_ulong("scsidevs", scsi_max_devs);
692 static const struct blk_ops scsi_blk_ops = {
697 U_BOOT_DRIVER(scsi_blk) = {
700 .ops = &scsi_blk_ops,
703 U_BOOT_LEGACY_BLK(scsi) = {
704 .if_typename = "scsi",
705 .if_type = IF_TYPE_SCSI,
706 .max_devs = CONFIG_SYS_SCSI_MAX_DEVICE,
707 .desc = scsi_dev_desc,