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 struct scsi_cmd 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(struct scsi_cmd *pccb)
53 /* Dummy function that could print an error for debugging */
56 #ifdef CONFIG_SYS_64BIT_LBA
57 void scsi_setup_read16(struct scsi_cmd *pccb, lbaint_t start,
60 pccb->cmd[0] = SCSI_READ16;
61 pccb->cmd[1] = pccb->lun << 5;
62 pccb->cmd[2] = (unsigned char)(start >> 56) & 0xff;
63 pccb->cmd[3] = (unsigned char)(start >> 48) & 0xff;
64 pccb->cmd[4] = (unsigned char)(start >> 40) & 0xff;
65 pccb->cmd[5] = (unsigned char)(start >> 32) & 0xff;
66 pccb->cmd[6] = (unsigned char)(start >> 24) & 0xff;
67 pccb->cmd[7] = (unsigned char)(start >> 16) & 0xff;
68 pccb->cmd[8] = (unsigned char)(start >> 8) & 0xff;
69 pccb->cmd[9] = (unsigned char)start & 0xff;
71 pccb->cmd[11] = (unsigned char)(blocks >> 24) & 0xff;
72 pccb->cmd[12] = (unsigned char)(blocks >> 16) & 0xff;
73 pccb->cmd[13] = (unsigned char)(blocks >> 8) & 0xff;
74 pccb->cmd[14] = (unsigned char)blocks & 0xff;
77 pccb->msgout[0] = SCSI_IDENTIFY; /* NOT USED */
78 debug("scsi_setup_read16: cmd: %02X %02X startblk %02X%02X%02X%02X%02X%02X%02X%02X blccnt %02X%02X%02X%02X\n",
79 pccb->cmd[0], pccb->cmd[1],
80 pccb->cmd[2], pccb->cmd[3], pccb->cmd[4], pccb->cmd[5],
81 pccb->cmd[6], pccb->cmd[7], pccb->cmd[8], pccb->cmd[9],
82 pccb->cmd[11], pccb->cmd[12], pccb->cmd[13], pccb->cmd[14]);
86 static void scsi_setup_read_ext(struct scsi_cmd *pccb, lbaint_t start,
87 unsigned short blocks)
89 pccb->cmd[0] = SCSI_READ10;
90 pccb->cmd[1] = pccb->lun << 5;
91 pccb->cmd[2] = (unsigned char)(start >> 24) & 0xff;
92 pccb->cmd[3] = (unsigned char)(start >> 16) & 0xff;
93 pccb->cmd[4] = (unsigned char)(start >> 8) & 0xff;
94 pccb->cmd[5] = (unsigned char)start & 0xff;
96 pccb->cmd[7] = (unsigned char)(blocks >> 8) & 0xff;
97 pccb->cmd[8] = (unsigned char)blocks & 0xff;
100 pccb->msgout[0] = SCSI_IDENTIFY; /* NOT USED */
101 debug("scsi_setup_read_ext: cmd: %02X %02X startblk %02X%02X%02X%02X blccnt %02X%02X\n",
102 pccb->cmd[0], pccb->cmd[1],
103 pccb->cmd[2], pccb->cmd[3], pccb->cmd[4], pccb->cmd[5],
104 pccb->cmd[7], pccb->cmd[8]);
107 static void scsi_setup_write_ext(struct scsi_cmd *pccb, lbaint_t start,
108 unsigned short blocks)
110 pccb->cmd[0] = SCSI_WRITE10;
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("%s: cmd: %02X %02X startblk %02X%02X%02X%02X blccnt %02X%02X\n",
124 pccb->cmd[0], pccb->cmd[1],
125 pccb->cmd[2], pccb->cmd[3], pccb->cmd[4], pccb->cmd[5],
126 pccb->cmd[7], pccb->cmd[8]);
129 static void scsi_setup_inquiry(struct scsi_cmd *pccb)
131 pccb->cmd[0] = SCSI_INQUIRY;
132 pccb->cmd[1] = pccb->lun << 5;
135 if (pccb->datalen > 255)
138 pccb->cmd[4] = (unsigned char)pccb->datalen;
141 pccb->msgout[0] = SCSI_IDENTIFY; /* NOT USED */
145 static ulong scsi_read(struct udevice *dev, lbaint_t blknr, lbaint_t blkcnt,
148 static ulong scsi_read(struct blk_desc *block_dev, lbaint_t blknr,
149 lbaint_t blkcnt, void *buffer)
153 struct blk_desc *block_dev = dev_get_uclass_platdata(dev);
155 lbaint_t start, 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 debug("\nscsi_read: dev %d startblk " LBAF
167 ", blccnt " LBAF " buffer %lx\n",
168 block_dev->devnum, start, blks, (unsigned long)buffer);
170 pccb->pdata = (unsigned char *)buf_addr;
171 #ifdef CONFIG_SYS_64BIT_LBA
172 if (start > SCSI_LBA48_READ) {
173 unsigned long blocks;
174 blocks = min_t(lbaint_t, blks, SCSI_MAX_READ_BLK);
175 pccb->datalen = block_dev->blksz * blocks;
176 scsi_setup_read16(pccb, start, blocks);
181 if (blks > SCSI_MAX_READ_BLK) {
182 pccb->datalen = block_dev->blksz *
184 smallblks = SCSI_MAX_READ_BLK;
185 scsi_setup_read_ext(pccb, start, smallblks);
186 start += SCSI_MAX_READ_BLK;
187 blks -= SCSI_MAX_READ_BLK;
189 pccb->datalen = block_dev->blksz * blks;
190 smallblks = (unsigned short)blks;
191 scsi_setup_read_ext(pccb, start, smallblks);
195 debug("scsi_read_ext: startblk " LBAF
196 ", blccnt %x buffer %" PRIXPTR "\n",
197 start, smallblks, buf_addr);
198 if (scsi_exec(pccb) != true) {
199 scsi_print_error(pccb);
203 buf_addr += pccb->datalen;
205 debug("scsi_read_ext: end startblk " LBAF
206 ", blccnt %x buffer %" PRIXPTR "\n", start, smallblks, buf_addr);
210 /*******************************************************************************
214 /* Almost the maximum amount of the scsi_ext command.. */
215 #define SCSI_MAX_WRITE_BLK 0xFFFF
218 static ulong scsi_write(struct udevice *dev, lbaint_t blknr, lbaint_t blkcnt,
221 static ulong scsi_write(struct blk_desc *block_dev, lbaint_t blknr,
222 lbaint_t blkcnt, const void *buffer)
226 struct blk_desc *block_dev = dev_get_uclass_platdata(dev);
228 lbaint_t start, blks;
230 unsigned short smallblks;
231 struct scsi_cmd *pccb = (struct scsi_cmd *)&tempccb;
234 pccb->target = block_dev->target;
235 pccb->lun = block_dev->lun;
236 buf_addr = (unsigned long)buffer;
239 debug("\n%s: dev %d startblk " LBAF ", blccnt " LBAF " buffer %lx\n",
240 __func__, block_dev->devnum, start, blks, (unsigned long)buffer);
242 pccb->pdata = (unsigned char *)buf_addr;
243 if (blks > SCSI_MAX_WRITE_BLK) {
244 pccb->datalen = (block_dev->blksz *
246 smallblks = SCSI_MAX_WRITE_BLK;
247 scsi_setup_write_ext(pccb, start, smallblks);
248 start += SCSI_MAX_WRITE_BLK;
249 blks -= SCSI_MAX_WRITE_BLK;
251 pccb->datalen = block_dev->blksz * blks;
252 smallblks = (unsigned short)blks;
253 scsi_setup_write_ext(pccb, start, smallblks);
257 debug("%s: startblk " LBAF ", blccnt %x buffer %" PRIXPTR "\n",
258 __func__, start, smallblks, buf_addr);
259 if (scsi_exec(pccb) != true) {
260 scsi_print_error(pccb);
264 buf_addr += pccb->datalen;
266 debug("%s: end startblk " LBAF ", blccnt %x buffer %" PRIXPTR "\n",
267 __func__, start, smallblks, buf_addr);
271 #if defined(CONFIG_PCI) && !defined(CONFIG_SCSI_AHCI_PLAT)
277 * Find a device from the list, this driver will support a single
280 for (i = 0; i < ARRAY_SIZE(scsi_device_list); i++) {
281 /* get PCI Device ID */
286 ret = dm_pci_find_device(scsi_device_list[i].vendor,
287 scsi_device_list[i].device, 0, &dev);
289 busdevfunc = dm_pci_get_bdf(dev);
293 busdevfunc = pci_find_device(scsi_device_list[i].vendor,
294 scsi_device_list[i].device,
297 if (busdevfunc != -1)
301 if (busdevfunc == -1) {
302 printf("Error: SCSI Controller(s) ");
303 for (i = 0; i < ARRAY_SIZE(scsi_device_list); i++) {
305 scsi_device_list[i].vendor,
306 scsi_device_list[i].device);
308 printf("not found\n");
313 printf("SCSI Controller (%04X,%04X) found (%d:%d:%d)\n",
314 scsi_device_list[i].vendor,
315 scsi_device_list[i].device,
316 (busdevfunc >> 16) & 0xFF,
317 (busdevfunc >> 11) & 0x1F,
318 (busdevfunc >> 8) & 0x7);
321 bootstage_start(BOOTSTAGE_ID_ACCUM_SCSI, "ahci");
322 scsi_low_level_init(busdevfunc);
324 bootstage_accum(BOOTSTAGE_ID_ACCUM_SCSI);
328 /* copy src to dest, skipping leading and trailing blanks
329 * and null terminate the string
331 static void scsi_ident_cpy(unsigned char *dest, unsigned char *src,
337 while (start < len) {
338 if (src[start] != ' ')
343 while (end > start) {
348 for (; start <= end; start++)
349 *dest ++= src[start];
353 static int scsi_read_capacity(struct scsi_cmd *pccb, lbaint_t *capacity,
354 unsigned long *blksz)
358 memset(pccb->cmd, '\0', sizeof(pccb->cmd));
359 pccb->cmd[0] = SCSI_RD_CAPAC10;
360 pccb->cmd[1] = pccb->lun << 5;
362 pccb->msgout[0] = SCSI_IDENTIFY; /* NOT USED */
365 if (scsi_exec(pccb) != true)
368 *capacity = ((lbaint_t)pccb->pdata[0] << 24) |
369 ((lbaint_t)pccb->pdata[1] << 16) |
370 ((lbaint_t)pccb->pdata[2] << 8) |
371 ((lbaint_t)pccb->pdata[3]);
373 if (*capacity != 0xffffffff) {
374 /* Read capacity (10) was sufficient for this drive. */
375 *blksz = ((unsigned long)pccb->pdata[4] << 24) |
376 ((unsigned long)pccb->pdata[5] << 16) |
377 ((unsigned long)pccb->pdata[6] << 8) |
378 ((unsigned long)pccb->pdata[7]);
382 /* Read capacity (10) was insufficient. Use read capacity (16). */
383 memset(pccb->cmd, '\0', sizeof(pccb->cmd));
384 pccb->cmd[0] = SCSI_RD_CAPAC16;
387 pccb->msgout[0] = SCSI_IDENTIFY; /* NOT USED */
390 if (scsi_exec(pccb) != true)
393 *capacity = ((uint64_t)pccb->pdata[0] << 56) |
394 ((uint64_t)pccb->pdata[1] << 48) |
395 ((uint64_t)pccb->pdata[2] << 40) |
396 ((uint64_t)pccb->pdata[3] << 32) |
397 ((uint64_t)pccb->pdata[4] << 24) |
398 ((uint64_t)pccb->pdata[5] << 16) |
399 ((uint64_t)pccb->pdata[6] << 8) |
400 ((uint64_t)pccb->pdata[7]);
402 *blksz = ((uint64_t)pccb->pdata[8] << 56) |
403 ((uint64_t)pccb->pdata[9] << 48) |
404 ((uint64_t)pccb->pdata[10] << 40) |
405 ((uint64_t)pccb->pdata[11] << 32) |
406 ((uint64_t)pccb->pdata[12] << 24) |
407 ((uint64_t)pccb->pdata[13] << 16) |
408 ((uint64_t)pccb->pdata[14] << 8) |
409 ((uint64_t)pccb->pdata[15]);
416 * Some setup (fill-in) routines
418 static void scsi_setup_test_unit_ready(struct scsi_cmd *pccb)
420 pccb->cmd[0] = SCSI_TST_U_RDY;
421 pccb->cmd[1] = pccb->lun << 5;
427 pccb->msgout[0] = SCSI_IDENTIFY; /* NOT USED */
431 * scsi_init_dev_desc_priv - initialize only SCSI specific blk_desc properties
433 * @dev_desc: Block device description pointer
435 static void scsi_init_dev_desc_priv(struct blk_desc *dev_desc)
437 dev_desc->target = 0xff;
438 dev_desc->lun = 0xff;
439 dev_desc->log2blksz =
440 LOG2_INVALID(typeof(dev_desc->log2blksz));
441 dev_desc->type = DEV_TYPE_UNKNOWN;
442 dev_desc->vendor[0] = 0;
443 dev_desc->product[0] = 0;
444 dev_desc->revision[0] = 0;
445 dev_desc->removable = false;
447 dev_desc->block_read = scsi_read;
448 dev_desc->block_write = scsi_write;
452 #if !defined(CONFIG_DM_SCSI)
454 * scsi_init_dev_desc - initialize all SCSI specific blk_desc properties
456 * @dev_desc: Block device description pointer
457 * @devnum: Device number
459 static void scsi_init_dev_desc(struct blk_desc *dev_desc, int devnum)
463 dev_desc->if_type = IF_TYPE_SCSI;
464 dev_desc->devnum = devnum;
465 dev_desc->part_type = PART_TYPE_UNKNOWN;
467 scsi_init_dev_desc_priv(dev_desc);
472 * scsi_detect_dev - Detect scsi device
476 * @dev_desc: block device description
478 * The scsi_detect_dev detects and fills a dev_desc structure when the device is
481 * Return: 0 on success, error value otherwise
483 static int scsi_detect_dev(int target, int lun, struct blk_desc *dev_desc)
485 unsigned char perq, modi;
488 struct scsi_cmd *pccb = (struct scsi_cmd *)&tempccb;
490 pccb->target = target;
492 pccb->pdata = (unsigned char *)&tempbuff;
494 scsi_setup_inquiry(pccb);
495 if (scsi_exec(pccb) != true) {
496 if (pccb->contr_stat == SCSI_SEL_TIME_OUT) {
498 * selection timeout => assuming no
501 debug("Selection timeout ID %d\n",
505 scsi_print_error(pccb);
510 if ((perq & 0x1f) == 0x1f)
511 return -ENODEV; /* skip unknown devices */
512 if ((modi & 0x80) == 0x80) /* drive is removable */
513 dev_desc->removable = true;
514 /* get info for this device */
515 scsi_ident_cpy((unsigned char *)dev_desc->vendor,
517 scsi_ident_cpy((unsigned char *)dev_desc->product,
519 scsi_ident_cpy((unsigned char *)dev_desc->revision,
521 dev_desc->target = pccb->target;
522 dev_desc->lun = pccb->lun;
525 scsi_setup_test_unit_ready(pccb);
526 if (scsi_exec(pccb) != true) {
527 if (dev_desc->removable) {
528 dev_desc->type = perq;
531 scsi_print_error(pccb);
534 if (scsi_read_capacity(pccb, &capacity, &blksz)) {
535 scsi_print_error(pccb);
538 dev_desc->lba = capacity;
539 dev_desc->blksz = blksz;
540 dev_desc->log2blksz = LOG2(dev_desc->blksz);
541 dev_desc->type = perq;
547 * (re)-scan the scsi bus and reports scsi device info
548 * to the user if mode = 1
550 #if defined(CONFIG_DM_SCSI)
551 static int do_scsi_scan_one(struct udevice *dev, int id, int lun, int mode)
554 struct udevice *bdev;
556 struct blk_desc *bdesc;
560 * detect the scsi driver to get information about its geometry (block
561 * size, number of blocks) and other parameters (ids, type, ...)
563 scsi_init_dev_desc_priv(&bd);
564 if (scsi_detect_dev(id, lun, &bd))
568 * Create only one block device and do detection
569 * to make sure that there won't be a lot of
570 * block devices created
572 snprintf(str, sizeof(str), "id%dlun%d", id, lun);
573 ret = blk_create_devicef(dev, "scsi_blk", str, IF_TYPE_SCSI, -1,
574 bd.blksz, bd.blksz * bd.lba, &bdev);
576 debug("Can't create device\n");
580 bdesc = dev_get_uclass_platdata(bdev);
583 bdesc->removable = bd.removable;
584 bdesc->type = bd.type;
585 memcpy(&bdesc->vendor, &bd.vendor, sizeof(bd.vendor));
586 memcpy(&bdesc->product, &bd.product, sizeof(bd.product));
587 memcpy(&bdesc->revision, &bd.revision, sizeof(bd.revision));
591 printf(" Device %d: ", 0);
597 int scsi_scan(int mode)
599 unsigned char i, lun;
601 struct udevice *dev; /* SCSI controller */
605 printf("scanning bus for devices...\n");
607 blk_unbind_all(IF_TYPE_SCSI);
609 ret = uclass_get(UCLASS_SCSI, &uc);
613 uclass_foreach_dev(dev, uc) {
614 struct scsi_platdata *plat; /* scsi controller platdata */
616 /* probe SCSI controller driver */
617 ret = device_probe(dev);
621 /* Get controller platdata */
622 plat = dev_get_platdata(dev);
624 for (i = 0; i < plat->max_id; i++)
625 for (lun = 0; lun < plat->max_lun; lun++)
626 do_scsi_scan_one(dev, i, lun, mode);
632 int scsi_scan(int mode)
634 unsigned char i, lun;
638 printf("scanning bus for devices...\n");
639 for (i = 0; i < CONFIG_SYS_SCSI_MAX_DEVICE; i++)
640 scsi_init_dev_desc(&scsi_dev_desc[i], i);
643 for (i = 0; i < CONFIG_SYS_SCSI_MAX_SCSI_ID; i++) {
644 for (lun = 0; lun < CONFIG_SYS_SCSI_MAX_LUN; lun++) {
645 ret = scsi_detect_dev(i, lun,
646 &scsi_dev_desc[scsi_max_devs]);
649 part_init(&scsi_dev_desc[scsi_max_devs]);
652 printf(" Device %d: ", 0);
653 dev_print(&scsi_dev_desc[scsi_max_devs]);
658 if (scsi_max_devs > 0)
663 printf("Found %d device(s).\n", scsi_max_devs);
664 #ifndef CONFIG_SPL_BUILD
665 setenv_ulong("scsidevs", scsi_max_devs);
672 static const struct blk_ops scsi_blk_ops = {
677 U_BOOT_DRIVER(scsi_blk) = {
680 .ops = &scsi_blk_ops,
683 U_BOOT_LEGACY_BLK(scsi) = {
684 .if_typename = "scsi",
685 .if_type = IF_TYPE_SCSI,
686 .max_devs = CONFIG_SYS_SCSI_MAX_DEVICE,
687 .desc = scsi_dev_desc,