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 !defined(CONFIG_DM_SCSI)
34 const struct pci_device_id scsi_device_list
[] = { SCSI_DEV_LIST
};
36 static struct scsi_cmd tempccb
; /* temporary scsi command buffer */
38 static unsigned char tempbuff
[512]; /* temporary data buffer */
40 #if !defined(CONFIG_DM_SCSI)
41 static int scsi_max_devs
; /* number of highest available scsi device */
43 static int scsi_curr_dev
; /* current device */
45 static struct blk_desc scsi_dev_desc
[CONFIG_SYS_SCSI_MAX_DEVICE
];
48 /* almost the maximum amount of the scsi_ext command.. */
49 #define SCSI_MAX_READ_BLK 0xFFFF
50 #define SCSI_LBA48_READ 0xFFFFFFF
52 static void scsi_print_error(struct scsi_cmd
*pccb
)
54 /* Dummy function that could print an error for debugging */
57 #ifdef CONFIG_SYS_64BIT_LBA
58 void scsi_setup_read16(struct scsi_cmd
*pccb
, lbaint_t start
,
61 pccb
->cmd
[0] = SCSI_READ16
;
62 pccb
->cmd
[1] = pccb
->lun
<< 5;
63 pccb
->cmd
[2] = (unsigned char)(start
>> 56) & 0xff;
64 pccb
->cmd
[3] = (unsigned char)(start
>> 48) & 0xff;
65 pccb
->cmd
[4] = (unsigned char)(start
>> 40) & 0xff;
66 pccb
->cmd
[5] = (unsigned char)(start
>> 32) & 0xff;
67 pccb
->cmd
[6] = (unsigned char)(start
>> 24) & 0xff;
68 pccb
->cmd
[7] = (unsigned char)(start
>> 16) & 0xff;
69 pccb
->cmd
[8] = (unsigned char)(start
>> 8) & 0xff;
70 pccb
->cmd
[9] = (unsigned char)start
& 0xff;
72 pccb
->cmd
[11] = (unsigned char)(blocks
>> 24) & 0xff;
73 pccb
->cmd
[12] = (unsigned char)(blocks
>> 16) & 0xff;
74 pccb
->cmd
[13] = (unsigned char)(blocks
>> 8) & 0xff;
75 pccb
->cmd
[14] = (unsigned char)blocks
& 0xff;
78 pccb
->msgout
[0] = SCSI_IDENTIFY
; /* NOT USED */
79 debug("scsi_setup_read16: cmd: %02X %02X startblk %02X%02X%02X%02X%02X%02X%02X%02X blccnt %02X%02X%02X%02X\n",
80 pccb
->cmd
[0], pccb
->cmd
[1],
81 pccb
->cmd
[2], pccb
->cmd
[3], pccb
->cmd
[4], pccb
->cmd
[5],
82 pccb
->cmd
[6], pccb
->cmd
[7], pccb
->cmd
[8], pccb
->cmd
[9],
83 pccb
->cmd
[11], pccb
->cmd
[12], pccb
->cmd
[13], pccb
->cmd
[14]);
87 static void scsi_setup_read_ext(struct scsi_cmd
*pccb
, lbaint_t start
,
88 unsigned short blocks
)
90 pccb
->cmd
[0] = SCSI_READ10
;
91 pccb
->cmd
[1] = pccb
->lun
<< 5;
92 pccb
->cmd
[2] = (unsigned char)(start
>> 24) & 0xff;
93 pccb
->cmd
[3] = (unsigned char)(start
>> 16) & 0xff;
94 pccb
->cmd
[4] = (unsigned char)(start
>> 8) & 0xff;
95 pccb
->cmd
[5] = (unsigned char)start
& 0xff;
97 pccb
->cmd
[7] = (unsigned char)(blocks
>> 8) & 0xff;
98 pccb
->cmd
[8] = (unsigned char)blocks
& 0xff;
101 pccb
->msgout
[0] = SCSI_IDENTIFY
; /* NOT USED */
102 debug("scsi_setup_read_ext: cmd: %02X %02X startblk %02X%02X%02X%02X blccnt %02X%02X\n",
103 pccb
->cmd
[0], pccb
->cmd
[1],
104 pccb
->cmd
[2], pccb
->cmd
[3], pccb
->cmd
[4], pccb
->cmd
[5],
105 pccb
->cmd
[7], pccb
->cmd
[8]);
108 static void scsi_setup_write_ext(struct scsi_cmd
*pccb
, lbaint_t start
,
109 unsigned short blocks
)
111 pccb
->cmd
[0] = SCSI_WRITE10
;
112 pccb
->cmd
[1] = pccb
->lun
<< 5;
113 pccb
->cmd
[2] = (unsigned char)(start
>> 24) & 0xff;
114 pccb
->cmd
[3] = (unsigned char)(start
>> 16) & 0xff;
115 pccb
->cmd
[4] = (unsigned char)(start
>> 8) & 0xff;
116 pccb
->cmd
[5] = (unsigned char)start
& 0xff;
118 pccb
->cmd
[7] = ((unsigned char)(blocks
>> 8)) & 0xff;
119 pccb
->cmd
[8] = (unsigned char)blocks
& 0xff;
122 pccb
->msgout
[0] = SCSI_IDENTIFY
; /* NOT USED */
123 debug("%s: cmd: %02X %02X startblk %02X%02X%02X%02X blccnt %02X%02X\n",
125 pccb
->cmd
[0], pccb
->cmd
[1],
126 pccb
->cmd
[2], pccb
->cmd
[3], pccb
->cmd
[4], pccb
->cmd
[5],
127 pccb
->cmd
[7], pccb
->cmd
[8]);
130 static void scsi_setup_inquiry(struct scsi_cmd
*pccb
)
132 pccb
->cmd
[0] = SCSI_INQUIRY
;
133 pccb
->cmd
[1] = pccb
->lun
<< 5;
136 if (pccb
->datalen
> 255)
139 pccb
->cmd
[4] = (unsigned char)pccb
->datalen
;
142 pccb
->msgout
[0] = SCSI_IDENTIFY
; /* NOT USED */
146 static ulong
scsi_read(struct udevice
*dev
, lbaint_t blknr
, lbaint_t blkcnt
,
149 static ulong
scsi_read(struct blk_desc
*block_dev
, lbaint_t blknr
,
150 lbaint_t blkcnt
, void *buffer
)
154 struct blk_desc
*block_dev
= dev_get_uclass_platdata(dev
);
155 struct udevice
*bdev
= dev
->parent
;
157 struct udevice
*bdev
= NULL
;
159 lbaint_t start
, 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 debug("\nscsi_read: dev %d startblk " LBAF
171 ", blccnt " LBAF
" buffer %lx\n",
172 block_dev
->devnum
, start
, blks
, (unsigned long)buffer
);
174 pccb
->pdata
= (unsigned char *)buf_addr
;
175 #ifdef CONFIG_SYS_64BIT_LBA
176 if (start
> SCSI_LBA48_READ
) {
177 unsigned long blocks
;
178 blocks
= min_t(lbaint_t
, blks
, SCSI_MAX_READ_BLK
);
179 pccb
->datalen
= block_dev
->blksz
* blocks
;
180 scsi_setup_read16(pccb
, start
, blocks
);
185 if (blks
> SCSI_MAX_READ_BLK
) {
186 pccb
->datalen
= block_dev
->blksz
*
188 smallblks
= SCSI_MAX_READ_BLK
;
189 scsi_setup_read_ext(pccb
, start
, smallblks
);
190 start
+= SCSI_MAX_READ_BLK
;
191 blks
-= SCSI_MAX_READ_BLK
;
193 pccb
->datalen
= block_dev
->blksz
* blks
;
194 smallblks
= (unsigned short)blks
;
195 scsi_setup_read_ext(pccb
, start
, smallblks
);
199 debug("scsi_read_ext: startblk " LBAF
200 ", blccnt %x buffer %" PRIXPTR
"\n",
201 start
, smallblks
, buf_addr
);
202 if (scsi_exec(bdev
, pccb
)) {
203 scsi_print_error(pccb
);
207 buf_addr
+= pccb
->datalen
;
209 debug("scsi_read_ext: end startblk " LBAF
210 ", blccnt %x buffer %" PRIXPTR
"\n", start
, smallblks
, buf_addr
);
214 /*******************************************************************************
218 /* Almost the maximum amount of the scsi_ext command.. */
219 #define SCSI_MAX_WRITE_BLK 0xFFFF
222 static ulong
scsi_write(struct udevice
*dev
, lbaint_t blknr
, lbaint_t blkcnt
,
225 static ulong
scsi_write(struct blk_desc
*block_dev
, lbaint_t blknr
,
226 lbaint_t blkcnt
, const void *buffer
)
230 struct blk_desc
*block_dev
= dev_get_uclass_platdata(dev
);
231 struct udevice
*bdev
= dev
->parent
;
233 struct udevice
*bdev
= NULL
;
235 lbaint_t start
, blks
;
237 unsigned short smallblks
;
238 struct scsi_cmd
*pccb
= (struct scsi_cmd
*)&tempccb
;
241 pccb
->target
= block_dev
->target
;
242 pccb
->lun
= block_dev
->lun
;
243 buf_addr
= (unsigned long)buffer
;
246 debug("\n%s: dev %d startblk " LBAF
", blccnt " LBAF
" buffer %lx\n",
247 __func__
, block_dev
->devnum
, start
, blks
, (unsigned long)buffer
);
249 pccb
->pdata
= (unsigned char *)buf_addr
;
250 if (blks
> SCSI_MAX_WRITE_BLK
) {
251 pccb
->datalen
= (block_dev
->blksz
*
253 smallblks
= SCSI_MAX_WRITE_BLK
;
254 scsi_setup_write_ext(pccb
, start
, smallblks
);
255 start
+= SCSI_MAX_WRITE_BLK
;
256 blks
-= SCSI_MAX_WRITE_BLK
;
258 pccb
->datalen
= block_dev
->blksz
* blks
;
259 smallblks
= (unsigned short)blks
;
260 scsi_setup_write_ext(pccb
, start
, smallblks
);
264 debug("%s: startblk " LBAF
", blccnt %x buffer %" PRIXPTR
"\n",
265 __func__
, start
, smallblks
, buf_addr
);
266 if (scsi_exec(bdev
, pccb
)) {
267 scsi_print_error(pccb
);
271 buf_addr
+= pccb
->datalen
;
273 debug("%s: end startblk " LBAF
", blccnt %x buffer %" PRIXPTR
"\n",
274 __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 */
294 ret
= dm_pci_find_device(scsi_device_list
[i
].vendor
,
295 scsi_device_list
[i
].device
, 0, &dev
);
297 busdevfunc
= dm_pci_get_bdf(dev
);
301 busdevfunc
= pci_find_device(scsi_device_list
[i
].vendor
,
302 scsi_device_list
[i
].device
,
305 if (busdevfunc
!= -1)
309 if (busdevfunc
== -1) {
310 printf("Error: SCSI Controller(s) ");
311 for (i
= 0; i
< ARRAY_SIZE(scsi_device_list
); i
++) {
313 scsi_device_list
[i
].vendor
,
314 scsi_device_list
[i
].device
);
316 printf("not found\n");
321 printf("SCSI Controller (%04X,%04X) found (%d:%d:%d)\n",
322 scsi_device_list
[i
].vendor
,
323 scsi_device_list
[i
].device
,
324 (busdevfunc
>> 16) & 0xFF,
325 (busdevfunc
>> 11) & 0x1F,
326 (busdevfunc
>> 8) & 0x7);
329 bootstage_start(BOOTSTAGE_ID_ACCUM_SCSI
, "ahci");
330 scsi_low_level_init(busdevfunc
);
332 bootstage_accum(BOOTSTAGE_ID_ACCUM_SCSI
);
336 /* copy src to dest, skipping leading and trailing blanks
337 * and null terminate the string
339 static void scsi_ident_cpy(unsigned char *dest
, unsigned char *src
,
345 while (start
< len
) {
346 if (src
[start
] != ' ')
351 while (end
> start
) {
356 for (; start
<= end
; start
++)
357 *dest
++= src
[start
];
361 static int scsi_read_capacity(struct udevice
*dev
, struct scsi_cmd
*pccb
,
362 lbaint_t
*capacity
, unsigned long *blksz
)
366 memset(pccb
->cmd
, '\0', sizeof(pccb
->cmd
));
367 pccb
->cmd
[0] = SCSI_RD_CAPAC10
;
368 pccb
->cmd
[1] = pccb
->lun
<< 5;
370 pccb
->msgout
[0] = SCSI_IDENTIFY
; /* NOT USED */
373 if (scsi_exec(dev
, pccb
))
376 *capacity
= ((lbaint_t
)pccb
->pdata
[0] << 24) |
377 ((lbaint_t
)pccb
->pdata
[1] << 16) |
378 ((lbaint_t
)pccb
->pdata
[2] << 8) |
379 ((lbaint_t
)pccb
->pdata
[3]);
381 if (*capacity
!= 0xffffffff) {
382 /* Read capacity (10) was sufficient for this drive. */
383 *blksz
= ((unsigned long)pccb
->pdata
[4] << 24) |
384 ((unsigned long)pccb
->pdata
[5] << 16) |
385 ((unsigned long)pccb
->pdata
[6] << 8) |
386 ((unsigned long)pccb
->pdata
[7]);
390 /* Read capacity (10) was insufficient. Use read capacity (16). */
391 memset(pccb
->cmd
, '\0', sizeof(pccb
->cmd
));
392 pccb
->cmd
[0] = SCSI_RD_CAPAC16
;
395 pccb
->msgout
[0] = SCSI_IDENTIFY
; /* NOT USED */
398 if (scsi_exec(dev
, pccb
))
401 *capacity
= ((uint64_t)pccb
->pdata
[0] << 56) |
402 ((uint64_t)pccb
->pdata
[1] << 48) |
403 ((uint64_t)pccb
->pdata
[2] << 40) |
404 ((uint64_t)pccb
->pdata
[3] << 32) |
405 ((uint64_t)pccb
->pdata
[4] << 24) |
406 ((uint64_t)pccb
->pdata
[5] << 16) |
407 ((uint64_t)pccb
->pdata
[6] << 8) |
408 ((uint64_t)pccb
->pdata
[7]);
410 *blksz
= ((uint64_t)pccb
->pdata
[8] << 56) |
411 ((uint64_t)pccb
->pdata
[9] << 48) |
412 ((uint64_t)pccb
->pdata
[10] << 40) |
413 ((uint64_t)pccb
->pdata
[11] << 32) |
414 ((uint64_t)pccb
->pdata
[12] << 24) |
415 ((uint64_t)pccb
->pdata
[13] << 16) |
416 ((uint64_t)pccb
->pdata
[14] << 8) |
417 ((uint64_t)pccb
->pdata
[15]);
424 * Some setup (fill-in) routines
426 static void scsi_setup_test_unit_ready(struct scsi_cmd
*pccb
)
428 pccb
->cmd
[0] = SCSI_TST_U_RDY
;
429 pccb
->cmd
[1] = pccb
->lun
<< 5;
435 pccb
->msgout
[0] = SCSI_IDENTIFY
; /* NOT USED */
439 * scsi_init_dev_desc_priv - initialize only SCSI specific blk_desc properties
441 * @dev_desc: Block device description pointer
443 static void scsi_init_dev_desc_priv(struct blk_desc
*dev_desc
)
445 dev_desc
->target
= 0xff;
446 dev_desc
->lun
= 0xff;
447 dev_desc
->log2blksz
=
448 LOG2_INVALID(typeof(dev_desc
->log2blksz
));
449 dev_desc
->type
= DEV_TYPE_UNKNOWN
;
450 dev_desc
->vendor
[0] = 0;
451 dev_desc
->product
[0] = 0;
452 dev_desc
->revision
[0] = 0;
453 dev_desc
->removable
= false;
454 #if !CONFIG_IS_ENABLED(BLK)
455 dev_desc
->block_read
= scsi_read
;
456 dev_desc
->block_write
= scsi_write
;
460 #if !defined(CONFIG_DM_SCSI)
462 * scsi_init_dev_desc - initialize all SCSI specific blk_desc properties
464 * @dev_desc: Block device description pointer
465 * @devnum: Device number
467 static void scsi_init_dev_desc(struct blk_desc
*dev_desc
, int devnum
)
471 dev_desc
->if_type
= IF_TYPE_SCSI
;
472 dev_desc
->devnum
= devnum
;
473 dev_desc
->part_type
= PART_TYPE_UNKNOWN
;
475 scsi_init_dev_desc_priv(dev_desc
);
480 * scsi_detect_dev - Detect scsi device
484 * @dev_desc: block device description
486 * The scsi_detect_dev detects and fills a dev_desc structure when the device is
489 * Return: 0 on success, error value otherwise
491 static int scsi_detect_dev(struct udevice
*dev
, int target
, int lun
,
492 struct blk_desc
*dev_desc
)
494 unsigned char perq
, modi
;
497 struct scsi_cmd
*pccb
= (struct scsi_cmd
*)&tempccb
;
499 pccb
->target
= target
;
501 pccb
->pdata
= (unsigned char *)&tempbuff
;
503 scsi_setup_inquiry(pccb
);
504 if (scsi_exec(dev
, pccb
)) {
505 if (pccb
->contr_stat
== SCSI_SEL_TIME_OUT
) {
507 * selection timeout => assuming no
510 debug("Selection timeout ID %d\n",
514 scsi_print_error(pccb
);
519 if ((perq
& 0x1f) == 0x1f)
520 return -ENODEV
; /* skip unknown devices */
521 if ((modi
& 0x80) == 0x80) /* drive is removable */
522 dev_desc
->removable
= true;
523 /* get info for this device */
524 scsi_ident_cpy((unsigned char *)dev_desc
->vendor
,
526 scsi_ident_cpy((unsigned char *)dev_desc
->product
,
528 scsi_ident_cpy((unsigned char *)dev_desc
->revision
,
530 dev_desc
->target
= pccb
->target
;
531 dev_desc
->lun
= pccb
->lun
;
534 scsi_setup_test_unit_ready(pccb
);
535 if (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
.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
));
600 printf(" Device %d: ", 0);
606 int scsi_scan_dev(struct udevice
*dev
, bool verbose
)
608 struct scsi_platdata
*uc_plat
; /* scsi controller platdata */
613 /* probe SCSI controller driver */
614 ret
= device_probe(dev
);
618 /* Get controller platdata */
619 uc_plat
= dev_get_uclass_platdata(dev
);
621 for (i
= 0; i
< uc_plat
->max_id
; i
++)
622 for (lun
= 0; lun
< uc_plat
->max_lun
; lun
++)
623 do_scsi_scan_one(dev
, i
, lun
, verbose
);
628 int scsi_scan(bool verbose
)
631 struct udevice
*dev
; /* SCSI controller */
635 printf("scanning bus for devices...\n");
637 blk_unbind_all(IF_TYPE_SCSI
);
639 ret
= uclass_get(UCLASS_SCSI
, &uc
);
643 uclass_foreach_dev(dev
, uc
) {
644 ret
= scsi_scan_dev(dev
, verbose
);
652 int scsi_scan(bool verbose
)
654 unsigned char i
, lun
;
658 printf("scanning bus for devices...\n");
659 for (i
= 0; i
< CONFIG_SYS_SCSI_MAX_DEVICE
; i
++)
660 scsi_init_dev_desc(&scsi_dev_desc
[i
], i
);
663 for (i
= 0; i
< CONFIG_SYS_SCSI_MAX_SCSI_ID
; i
++) {
664 for (lun
= 0; lun
< CONFIG_SYS_SCSI_MAX_LUN
; lun
++) {
665 ret
= scsi_detect_dev(NULL
, i
, lun
,
666 &scsi_dev_desc
[scsi_max_devs
]);
669 part_init(&scsi_dev_desc
[scsi_max_devs
]);
672 printf(" Device %d: ", 0);
673 dev_print(&scsi_dev_desc
[scsi_max_devs
]);
678 if (scsi_max_devs
> 0)
683 printf("Found %d device(s).\n", scsi_max_devs
);
684 #ifndef CONFIG_SPL_BUILD
685 setenv_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
,