d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
9469c92974
freebsd-nq/sys/dev/usb/usb_msctest.c
Andrew Thompson 4eae601ebd MFp4 //depot/projects/usb@159909 
- make usb2_power_mask_t 16-bit
- remove "usb2_config_sub" structure from "usb2_config". To compensate for this
  "usb2_config" has a new field called "usb_mode" which select for which mode
  the current xfer entry is active. Options are: a) Device mode only b) Host
  mode only (default-by-zero) c) Both modes.  This change was scripted using
  the following sed script: "s/\.mh\././g".
- the standard packet size table in "usb_transfer.c" is now a function, hence
  the code for the function uses less memory than the table itself.

Submitted by:	Hans Petter Selasky
2009-04-05 18:20:38 +00:00

575 lines
13 KiB
C
Raw Blame History

/* $FreeBSD$ */
/*-
* Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/*
* The following file contains code that will detect USB autoinstall
* disks.
*
* TODO: Potentially we could add code to automatically detect USB
* mass storage quirks for not supported SCSI commands!
*/
#include <dev/usb/usb_mfunc.h>
#include <dev/usb/usb_error.h>
#include <dev/usb/usb.h>
#define USB_DEBUG_VAR usb2_debug
#include <dev/usb/usb_core.h>
#include <dev/usb/usb_busdma.h>
#include <dev/usb/usb_process.h>
#include <dev/usb/usb_transfer.h>
#include <dev/usb/usb_msctest.h>
#include <dev/usb/usb_debug.h>
#include <dev/usb/usb_busdma.h>
#include <dev/usb/usb_device.h>
#include <dev/usb/usb_request.h>
#include <dev/usb/usb_util.h>
#include <dev/usb/usb_lookup.h>
#include <dev/usb/usb_mfunc.h>
#include <dev/usb/usb_error.h>
#include <dev/usb/usb.h>
enum {
ST_COMMAND,
ST_DATA_RD,
ST_DATA_RD_CS,
ST_DATA_WR,
ST_DATA_WR_CS,
ST_STATUS,
ST_MAX,
};
enum {
DIR_IN,
DIR_OUT,
DIR_NONE,
};
#define BULK_SIZE 64 /* dummy */
/* Command Block Wrapper */
struct bbb_cbw {
uDWord dCBWSignature;
#define CBWSIGNATURE 0x43425355
uDWord dCBWTag;
uDWord dCBWDataTransferLength;
uByte bCBWFlags;
#define CBWFLAGS_OUT 0x00
#define CBWFLAGS_IN 0x80
uByte bCBWLUN;
uByte bCDBLength;
#define CBWCDBLENGTH 16
uByte CBWCDB[CBWCDBLENGTH];
} __packed;
/* Command Status Wrapper */
struct bbb_csw {
uDWord dCSWSignature;
#define CSWSIGNATURE 0x53425355
uDWord dCSWTag;
uDWord dCSWDataResidue;
uByte bCSWStatus;
#define CSWSTATUS_GOOD 0x0
#define CSWSTATUS_FAILED 0x1
#define CSWSTATUS_PHASE 0x2
} __packed;
struct bbb_transfer {
struct mtx mtx;
struct cv cv;
struct bbb_cbw cbw;
struct bbb_csw csw;
struct usb2_xfer *xfer[ST_MAX];
uint8_t *data_ptr;
usb2_size_t data_len; /* bytes */
usb2_size_t data_rem; /* bytes */
usb2_timeout_t data_timeout; /* ms */
usb2_frlength_t actlen; /* bytes */
uint8_t cmd_len; /* bytes */
uint8_t dir;
uint8_t lun;
uint8_t state;
uint8_t error;
uint8_t status_try;
uint8_t buffer[256];
};
static usb2_callback_t bbb_command_callback;
static usb2_callback_t bbb_data_read_callback;
static usb2_callback_t bbb_data_rd_cs_callback;
static usb2_callback_t bbb_data_write_callback;
static usb2_callback_t bbb_data_wr_cs_callback;
static usb2_callback_t bbb_status_callback;
static const struct usb2_config bbb_config[ST_MAX] = {
[ST_COMMAND] = {
.type = UE_BULK,
.endpoint = UE_ADDR_ANY,
.direction = UE_DIR_OUT,
.bufsize = sizeof(struct bbb_cbw),
.callback = &bbb_command_callback,
.timeout = 4 * USB_MS_HZ, /* 4 seconds */
},
[ST_DATA_RD] = {
.type = UE_BULK,
.endpoint = UE_ADDR_ANY,
.direction = UE_DIR_IN,
.bufsize = BULK_SIZE,
.flags = {.proxy_buffer = 1,.short_xfer_ok = 1,},
.callback = &bbb_data_read_callback,
.timeout = 4 * USB_MS_HZ, /* 4 seconds */
},
[ST_DATA_RD_CS] = {
.type = UE_CONTROL,
.endpoint = 0x00, /* Control pipe */
.direction = UE_DIR_ANY,
.bufsize = sizeof(struct usb2_device_request),
.callback = &bbb_data_rd_cs_callback,
.timeout = 1 * USB_MS_HZ, /* 1 second */
},
[ST_DATA_WR] = {
.type = UE_BULK,
.endpoint = UE_ADDR_ANY,
.direction = UE_DIR_OUT,
.bufsize = BULK_SIZE,
.flags = {.proxy_buffer = 1,},
.callback = &bbb_data_write_callback,
.timeout = 4 * USB_MS_HZ, /* 4 seconds */
},
[ST_DATA_WR_CS] = {
.type = UE_CONTROL,
.endpoint = 0x00, /* Control pipe */
.direction = UE_DIR_ANY,
.bufsize = sizeof(struct usb2_device_request),
.callback = &bbb_data_wr_cs_callback,
.timeout = 1 * USB_MS_HZ, /* 1 second */
},
[ST_STATUS] = {
.type = UE_BULK,
.endpoint = UE_ADDR_ANY,
.direction = UE_DIR_IN,
.bufsize = sizeof(struct bbb_csw),
.flags = {.short_xfer_ok = 1,},
.callback = &bbb_status_callback,
.timeout = 1 * USB_MS_HZ, /* 1 second */
},
};
static void
bbb_done(struct bbb_transfer *sc, uint8_t error)
{
struct usb2_xfer *xfer;
xfer = sc->xfer[sc->state];
/* verify the error code */
if (error) {
switch (USB_GET_STATE(xfer)) {
case USB_ST_SETUP:
case USB_ST_TRANSFERRED:
error = 1;
break;
default:
error = 2;
break;
}
}
sc->error = error;
sc->state = ST_COMMAND;
sc->status_try = 1;
usb2_cv_signal(&sc->cv);
}
static void
bbb_transfer_start(struct bbb_transfer *sc, uint8_t xfer_index)
{
sc->state = xfer_index;
usb2_transfer_start(sc->xfer[xfer_index]);
}
static void
bbb_data_clear_stall_callback(struct usb2_xfer *xfer,
uint8_t next_xfer, uint8_t stall_xfer)
{
struct bbb_transfer *sc = xfer->priv_sc;
if (usb2_clear_stall_callback(xfer, sc->xfer[stall_xfer])) {
switch (USB_GET_STATE(xfer)) {
case USB_ST_SETUP:
case USB_ST_TRANSFERRED:
bbb_transfer_start(sc, next_xfer);
break;
default:
bbb_done(sc, 1);
break;
}
}
}
static void
bbb_command_callback(struct usb2_xfer *xfer)
{
struct bbb_transfer *sc = xfer->priv_sc;
uint32_t tag;
switch (USB_GET_STATE(xfer)) {
case USB_ST_TRANSFERRED:
bbb_transfer_start
(sc, ((sc->dir == DIR_IN) ? ST_DATA_RD :
(sc->dir == DIR_OUT) ? ST_DATA_WR :
ST_STATUS));
break;
case USB_ST_SETUP:
sc->status_try = 0;
tag = UGETDW(sc->cbw.dCBWTag) + 1;
USETDW(sc->cbw.dCBWSignature, CBWSIGNATURE);
USETDW(sc->cbw.dCBWTag, tag);
USETDW(sc->cbw.dCBWDataTransferLength, (uint32_t)sc->data_len);
sc->cbw.bCBWFlags = ((sc->dir == DIR_IN) ? CBWFLAGS_IN : CBWFLAGS_OUT);
sc->cbw.bCBWLUN = sc->lun;
sc->cbw.bCDBLength = sc->cmd_len;
if (sc->cbw.bCDBLength > sizeof(sc->cbw.CBWCDB)) {
sc->cbw.bCDBLength = sizeof(sc->cbw.CBWCDB);
DPRINTFN(0, "Truncating long command!\n");
}
xfer->frlengths[0] = sizeof(sc->cbw);
usb2_set_frame_data(xfer, &sc->cbw, 0);
usb2_start_hardware(xfer);
break;
default: /* Error */
bbb_done(sc, 1);
break;
}
}
static void
bbb_data_read_callback(struct usb2_xfer *xfer)
{
struct bbb_transfer *sc = xfer->priv_sc;
usb2_frlength_t max_bulk = xfer->max_data_length;
switch (USB_GET_STATE(xfer)) {
case USB_ST_TRANSFERRED:
sc->data_rem -= xfer->actlen;
sc->data_ptr += xfer->actlen;
sc->actlen += xfer->actlen;
if (xfer->actlen < xfer->sumlen) {
/* short transfer */
sc->data_rem = 0;
}
case USB_ST_SETUP:
DPRINTF("max_bulk=%d, data_rem=%d\n",
max_bulk, sc->data_rem);
if (sc->data_rem == 0) {
bbb_transfer_start(sc, ST_STATUS);
break;
}
if (max_bulk > sc->data_rem) {
max_bulk = sc->data_rem;
}
xfer->timeout = sc->data_timeout;
xfer->frlengths[0] = max_bulk;
usb2_set_frame_data(xfer, sc->data_ptr, 0);
usb2_start_hardware(xfer);
break;
default: /* Error */
if (xfer->error == USB_ERR_CANCELLED) {
bbb_done(sc, 1);
} else {
bbb_transfer_start(sc, ST_DATA_RD_CS);
}
break;
}
}
static void
bbb_data_rd_cs_callback(struct usb2_xfer *xfer)
{
bbb_data_clear_stall_callback(xfer, ST_STATUS,
ST_DATA_RD);
}
static void
bbb_data_write_callback(struct usb2_xfer *xfer)
{
struct bbb_transfer *sc = xfer->priv_sc;
usb2_frlength_t max_bulk = xfer->max_data_length;
switch (USB_GET_STATE(xfer)) {
case USB_ST_TRANSFERRED:
sc->data_rem -= xfer->actlen;
sc->data_ptr += xfer->actlen;
sc->actlen += xfer->actlen;
if (xfer->actlen < xfer->sumlen) {
/* short transfer */
sc->data_rem = 0;
}
case USB_ST_SETUP:
DPRINTF("max_bulk=%d, data_rem=%d\n",
max_bulk, sc->data_rem);
if (sc->data_rem == 0) {
bbb_transfer_start(sc, ST_STATUS);
return;
}
if (max_bulk > sc->data_rem) {
max_bulk = sc->data_rem;
}
xfer->timeout = sc->data_timeout;
xfer->frlengths[0] = max_bulk;
usb2_set_frame_data(xfer, sc->data_ptr, 0);
usb2_start_hardware(xfer);
return;
default: /* Error */
if (xfer->error == USB_ERR_CANCELLED) {
bbb_done(sc, 1);
} else {
bbb_transfer_start(sc, ST_DATA_WR_CS);
}
return;
}
}
static void
bbb_data_wr_cs_callback(struct usb2_xfer *xfer)
{
bbb_data_clear_stall_callback(xfer, ST_STATUS,
ST_DATA_WR);
}
static void
bbb_status_callback(struct usb2_xfer *xfer)
{
struct bbb_transfer *sc = xfer->priv_sc;
switch (USB_GET_STATE(xfer)) {
case USB_ST_TRANSFERRED:
/* very simple status check */
if (xfer->actlen < sizeof(sc->csw)) {
bbb_done(sc, 1);/* error */
} else if (sc->csw.bCSWStatus == CSWSTATUS_GOOD) {
bbb_done(sc, 0);/* success */
} else {
bbb_done(sc, 1);/* error */
}
break;
case USB_ST_SETUP:
xfer->frlengths[0] = sizeof(sc->csw);
usb2_set_frame_data(xfer, &sc->csw, 0);
usb2_start_hardware(xfer);
break;
default:
DPRINTFN(0, "Failed to read CSW: %s, try %d\n",
usb2_errstr(xfer->error), sc->status_try);
if ((xfer->error == USB_ERR_CANCELLED) ||
(sc->status_try)) {
bbb_done(sc, 1);
} else {
sc->status_try = 1;
bbb_transfer_start(sc, ST_DATA_RD_CS);
}
break;
}
}
/*------------------------------------------------------------------------*
* bbb_command_start - execute a SCSI command synchronously
*
* Return values
* 0: Success
* Else: Failure
*------------------------------------------------------------------------*/
static uint8_t
bbb_command_start(struct bbb_transfer *sc, uint8_t dir, uint8_t lun,
void *data_ptr, usb2_size_t data_len, uint8_t cmd_len,
usb2_timeout_t data_timeout)
{
sc->lun = lun;
sc->dir = data_len ? dir : DIR_NONE;
sc->data_ptr = data_ptr;
sc->data_len = data_len;
sc->data_rem = data_len;
sc->data_timeout = (data_timeout + USB_MS_HZ);
sc->actlen = 0;
sc->cmd_len = cmd_len;
usb2_transfer_start(sc->xfer[sc->state]);
while (usb2_transfer_pending(sc->xfer[sc->state])) {
usb2_cv_wait(&sc->cv, &sc->mtx);
}
return (sc->error);
}
/*------------------------------------------------------------------------*
* usb2_test_autoinstall
*
* Return values:
* 0: This interface is an auto install disk (CD-ROM)
* Else: Not an auto install disk.
*------------------------------------------------------------------------*/
usb2_error_t
usb2_test_autoinstall(struct usb2_device *udev, uint8_t iface_index,
uint8_t do_eject)
{
struct usb2_interface *iface;
struct usb2_interface_descriptor *id;
usb2_error_t err;
uint8_t timeout;
uint8_t sid_type;
struct bbb_transfer *sc;
if (udev == NULL) {
return (USB_ERR_INVAL);
}
iface = usb2_get_iface(udev, iface_index);
if (iface == NULL) {
return (USB_ERR_INVAL);
}
id = iface->idesc;
if (id == NULL) {
return (USB_ERR_INVAL);
}
if (id->bInterfaceClass != UICLASS_MASS) {
return (USB_ERR_INVAL);
}
switch (id->bInterfaceSubClass) {
case UISUBCLASS_SCSI:
case UISUBCLASS_UFI:
break;
default:
return (USB_ERR_INVAL);
}
switch (id->bInterfaceProtocol) {
case UIPROTO_MASS_BBB_OLD:
case UIPROTO_MASS_BBB:
break;
default:
return (USB_ERR_INVAL);
}
sc = malloc(sizeof(*sc), M_USB, M_WAITOK | M_ZERO);
if (sc == NULL) {
return (USB_ERR_NOMEM);
}
mtx_init(&sc->mtx, "USB autoinstall", NULL, MTX_DEF);
usb2_cv_init(&sc->cv, "WBBB");
err = usb2_transfer_setup(udev,
&iface_index, sc->xfer, bbb_config,
ST_MAX, sc, &sc->mtx);
if (err) {
goto done;
}
mtx_lock(&sc->mtx);
timeout = 4; /* tries */
repeat_inquiry:
sc->cbw.CBWCDB[0] = 0x12; /* INQUIRY */
sc->cbw.CBWCDB[1] = 0;
sc->cbw.CBWCDB[2] = 0;
sc->cbw.CBWCDB[3] = 0;
sc->cbw.CBWCDB[4] = 0x24; /* length */
sc->cbw.CBWCDB[5] = 0;
err = bbb_command_start(sc, DIR_IN, 0,
sc->buffer, 0x24, 6, USB_MS_HZ);
if ((sc->actlen != 0) && (err == 0)) {
sid_type = sc->buffer[0] & 0x1F;
if (sid_type == 0x05) {
/* CD-ROM */
if (do_eject) {
/* 0: opcode: SCSI START/STOP */
sc->cbw.CBWCDB[0] = 0x1b;
/* 1: byte2: Not immediate */
sc->cbw.CBWCDB[1] = 0x00;
/* 2..3: reserved */
sc->cbw.CBWCDB[2] = 0x00;
sc->cbw.CBWCDB[3] = 0x00;
/* 4: Load/Eject command */
sc->cbw.CBWCDB[4] = 0x02;
/* 5: control */
sc->cbw.CBWCDB[5] = 0x00;
err = bbb_command_start(sc, DIR_OUT, 0,
NULL, 0, 6, USB_MS_HZ);
DPRINTFN(0, "Eject CD command "
"status: %s\n", usb2_errstr(err));
}
err = 0;
goto done;
}
} else if ((err != 2) && --timeout) {
usb2_pause_mtx(&sc->mtx, hz);
goto repeat_inquiry;
}
err = USB_ERR_INVAL;
goto done;
done:
mtx_unlock(&sc->mtx);
usb2_transfer_unsetup(sc->xfer, ST_MAX);
mtx_destroy(&sc->mtx);
usb2_cv_destroy(&sc->cv);
free(sc, M_USB);
return (err);
}
Reference in New Issue View Git Blame Copy Permalink