blob: 1f15081bd8b2efc0e215cb0f8ca38bf13c86e5ce [file] [log] [blame]
// Support for several common scsi like command data block requests
//
// Copyright (C) 2010 Kevin O'Connor <kevin@koconnor.net>
// Copyright (C) 2002 MandrakeSoft S.A.
//
// This file may be distributed under the terms of the GNU LGPLv3 license.
#include "block.h" // struct disk_op_s
#include "blockcmd.h" // struct cdb_request_sense
#include "byteorder.h" // be32_to_cpu
#include "farptr.h" // GET_FLATPTR
#include "output.h" // dprintf
#include "std/disk.h" // DISK_RET_EPARAM
#include "string.h" // memset
#include "util.h" // timer_calc
#include "malloc.h"
/****************************************************************
* Low level command requests
****************************************************************/
static int
cdb_get_inquiry(struct disk_op_s *op, struct cdbres_inquiry *data)
{
struct cdb_request_sense cmd;
memset(&cmd, 0, sizeof(cmd));
cmd.command = CDB_CMD_INQUIRY;
cmd.length = sizeof(*data);
op->command = CMD_SCSI;
op->count = 1;
op->buf_fl = data;
op->cdbcmd = &cmd;
op->blocksize = sizeof(*data);
return process_op(op);
}
// Request SENSE
static int
cdb_get_sense(struct disk_op_s *op, struct cdbres_request_sense *data)
{
struct cdb_request_sense cmd;
memset(&cmd, 0, sizeof(cmd));
cmd.command = CDB_CMD_REQUEST_SENSE;
cmd.length = sizeof(*data);
op->command = CMD_SCSI;
op->count = 1;
op->buf_fl = data;
op->cdbcmd = &cmd;
op->blocksize = sizeof(*data);
return process_op(op);
}
// Test unit ready
static int
cdb_test_unit_ready(struct disk_op_s *op)
{
struct cdb_request_sense cmd;
memset(&cmd, 0, sizeof(cmd));
cmd.command = CDB_CMD_TEST_UNIT_READY;
op->command = CMD_SCSI;
op->count = 0;
op->buf_fl = NULL;
op->cdbcmd = &cmd;
op->blocksize = 0;
return process_op(op);
}
// Request capacity
static int
cdb_read_capacity(struct disk_op_s *op, struct cdbres_read_capacity *data)
{
struct cdb_read_capacity cmd;
memset(&cmd, 0, sizeof(cmd));
cmd.command = CDB_CMD_READ_CAPACITY;
op->command = CMD_SCSI;
op->count = 1;
op->buf_fl = data;
op->cdbcmd = &cmd;
op->blocksize = sizeof(*data);
return process_op(op);
}
// Mode sense, geometry page.
static int
cdb_mode_sense_geom(struct disk_op_s *op, struct cdbres_mode_sense_geom *data)
{
struct cdb_mode_sense cmd;
memset(&cmd, 0, sizeof(cmd));
cmd.command = CDB_CMD_MODE_SENSE;
cmd.flags = 8; /* DBD */
cmd.page = MODE_PAGE_HD_GEOMETRY;
cmd.count = cpu_to_be16(sizeof(*data));
op->command = CMD_SCSI;
op->count = 1;
op->buf_fl = data;
op->cdbcmd = &cmd;
op->blocksize = sizeof(*data);
return process_op(op);
}
/****************************************************************
* Main SCSI commands
****************************************************************/
// Create a scsi command request from a disk_op_s request
int
scsi_fill_cmd(struct disk_op_s *op, void *cdbcmd, int maxcdb)
{
switch (op->command) {
case CMD_READ:
case CMD_WRITE: ;
struct cdb_rwdata_10 *cmd = cdbcmd;
memset(cmd, 0, maxcdb);
cmd->command = (op->command == CMD_READ ? CDB_CMD_READ_10
: CDB_CMD_WRITE_10);
cmd->lba = cpu_to_be32(op->lba);
cmd->count = cpu_to_be16(op->count);
return GET_FLATPTR(op->drive_fl->blksize);
case CMD_SCSI:
if (MODESEGMENT)
return -1;
memcpy(cdbcmd, op->cdbcmd, maxcdb);
return op->blocksize;
default:
return -1;
}
}
// Determine if the command is a request to pull data from the device
int
scsi_is_read(struct disk_op_s *op)
{
return op->command == CMD_READ || (
!MODESEGMENT && op->command == CMD_SCSI && op->blocksize);
}
// Check if a SCSI device is ready to receive commands
int
scsi_is_ready(struct disk_op_s *op)
{
ASSERT32FLAT();
dprintf(6, "scsi_is_ready (drive=%p)\n", op->drive_fl);
/* Retry TEST UNIT READY for 5 seconds unless MEDIUM NOT PRESENT is
* reported by the device. If the device reports "IN PROGRESS",
* 30 seconds is added. */
int in_progress = 0;
u32 end = timer_calc(5000);
for (;;) {
if (timer_check(end)) {
dprintf(1, "test unit ready failed\n");
return -1;
}
int ret = cdb_test_unit_ready(op);
if (!ret)
// Success
break;
struct cdbres_request_sense sense;
ret = cdb_get_sense(op, &sense);
if (ret)
// Error - retry.
continue;
// Sense succeeded.
if (sense.asc == 0x3a) { /* MEDIUM NOT PRESENT */
dprintf(1, "Device reports MEDIUM NOT PRESENT\n");
return -1;
}
if (sense.asc == 0x04 && sense.ascq == 0x01 && !in_progress) {
/* IN PROGRESS OF BECOMING READY */
dprintf(1, "Waiting for device to detect medium... ");
/* Allow 30 seconds more */
end = timer_calc(30000);
in_progress = 1;
}
}
return 0;
}
#define CDB_CMD_REPORT_LUNS 0xA0
struct cdb_report_luns {
u8 command;
u8 reserved_01[5];
u32 length;
u8 pad[6];
} PACKED;
struct scsi_lun {
u16 lun[4];
};
struct cdbres_report_luns {
u32 length;
u32 reserved;
struct scsi_lun luns[];
};
static u64 scsilun2u64(struct scsi_lun *scsi_lun)
{
int i;
u64 ret = 0;
for (i = 0; i < ARRAY_SIZE(scsi_lun->lun); i++)
ret |= be16_to_cpu(scsi_lun->lun[i]) << (16 * i);
return ret;
}
// Issue REPORT LUNS on a temporary drive and iterate reported luns calling
// @add_lun for each
int scsi_rep_luns_scan(struct drive_s *tmp_drive, scsi_add_lun add_lun)
{
int ret = -1;
/* start with the smallest possible buffer, otherwise some devices in QEMU
* may (incorrectly) error out on returning less data than fits in it */
u32 maxluns = 1;
u32 nluns, i;
struct cdb_report_luns cdb = {
.command = CDB_CMD_REPORT_LUNS,
};
struct disk_op_s op = {
.drive_fl = tmp_drive,
.command = CMD_SCSI,
.count = 1,
.cdbcmd = &cdb,
};
struct cdbres_report_luns *resp;
ASSERT32FLAT();
while (1) {
op.blocksize = sizeof(struct cdbres_report_luns) +
maxluns * sizeof(struct scsi_lun);
op.buf_fl = malloc_tmp(op.blocksize);
if (!op.buf_fl) {
warn_noalloc();
return -1;
}
cdb.length = cpu_to_be32(op.blocksize);
if (process_op(&op) != DISK_RET_SUCCESS)
goto out;
resp = op.buf_fl;
nluns = be32_to_cpu(resp->length) / sizeof(struct scsi_lun);
if (nluns <= maxluns)
break;
free(op.buf_fl);
maxluns = nluns;
}
for (i = 0, ret = 0; i < nluns; i++) {
u64 lun = scsilun2u64(&resp->luns[i]);
if (lun >> 32)
continue;
ret += !add_lun((u32)lun, tmp_drive);
}
out:
free(op.buf_fl);
return ret;
}
// Iterate LUNs on the target and call @add_lun for each
int scsi_sequential_scan(struct drive_s *tmp_drive, u32 maxluns,
scsi_add_lun add_lun)
{
int ret;
u32 lun;
for (lun = 0, ret = 0; lun < maxluns; lun++)
ret += !add_lun(lun, tmp_drive);
return ret;
}
// Validate drive, find block size / sector count, and register drive.
int
scsi_drive_setup(struct drive_s *drive, const char *s, int prio)
{
ASSERT32FLAT();
struct disk_op_s dop;
memset(&dop, 0, sizeof(dop));
dop.drive_fl = drive;
struct cdbres_inquiry data;
int ret = cdb_get_inquiry(&dop, &data);
if (ret)
return ret;
char vendor[sizeof(data.vendor)+1], product[sizeof(data.product)+1];
char rev[sizeof(data.rev)+1];
strtcpy(vendor, data.vendor, sizeof(vendor));
nullTrailingSpace(vendor);
strtcpy(product, data.product, sizeof(product));
nullTrailingSpace(product);
strtcpy(rev, data.rev, sizeof(rev));
nullTrailingSpace(rev);
int pdt = data.pdt & 0x1f;
int removable = !!(data.removable & 0x80);
dprintf(1, "%s vendor='%s' product='%s' rev='%s' type=%d removable=%d\n"
, s, vendor, product, rev, pdt, removable);
drive->removable = removable;
if (pdt == SCSI_TYPE_CDROM) {
drive->blksize = CDROM_SECTOR_SIZE;
drive->sectors = (u64)-1;
char *desc = znprintf(MAXDESCSIZE, "DVD/CD [%s Drive %s %s %s]"
, s, vendor, product, rev);
boot_add_cd(drive, desc, prio);
return 0;
}
if (pdt != SCSI_TYPE_DISK)
return -1;
ret = scsi_is_ready(&dop);
if (ret) {
dprintf(1, "scsi_is_ready returned %d\n", ret);
return ret;
}
struct cdbres_read_capacity capdata;
ret = cdb_read_capacity(&dop, &capdata);
if (ret)
return ret;
// READ CAPACITY returns the address of the last block.
// We do not bother with READ CAPACITY(16) because BIOS does not support
// 64-bit LBA anyway.
drive->blksize = be32_to_cpu(capdata.blksize);
if (drive->blksize != DISK_SECTOR_SIZE) {
dprintf(1, "%s: unsupported block size %d\n", s, drive->blksize);
return -1;
}
drive->sectors = (u64)be32_to_cpu(capdata.sectors) + 1;
dprintf(1, "%s blksize=%d sectors=%u\n"
, s, drive->blksize, (unsigned)drive->sectors);
// We do not recover from USB stalls, so try to be safe and avoid
// sending the command if the (obsolete, but still provided by QEMU)
// fixed disk geometry page may not be supported.
//
// We could also send the command only to small disks (e.g. <504MiB)
// but some old USB keys only support a very small subset of SCSI which
// does not even include the MODE SENSE command!
//
if (CONFIG_QEMU_HARDWARE && memcmp(vendor, "QEMU", 5) == 0) {
struct cdbres_mode_sense_geom geomdata;
ret = cdb_mode_sense_geom(&dop, &geomdata);
if (ret == 0) {
u32 cylinders;
cylinders = geomdata.cyl[0] << 16;
cylinders |= geomdata.cyl[1] << 8;
cylinders |= geomdata.cyl[2];
if (cylinders && geomdata.heads &&
drive->sectors <= 0xFFFFFFFFULL &&
((u32)drive->sectors % (geomdata.heads * cylinders) == 0)) {
drive->pchs.cylinder = cylinders;
drive->pchs.head = geomdata.heads;
drive->pchs.sector = (u32)drive->sectors / (geomdata.heads * cylinders);
}
}
}
char *desc = znprintf(MAXDESCSIZE, "%s Drive %s %s %s"
, s, vendor, product, rev);
boot_add_hd(drive, desc, prio);
return 0;
}