[mirror_ubuntu-jammy-kernel.git] / drivers / usb / storage / karma.c

// SPDX-License-Identifier: GPL-2.0+
/*
 * Driver for Rio Karma
 *
 *   (c) 2006 Bob Copeland <me@bobcopeland.com>
 *   (c) 2006 Keith Bennett <keith@mcs.st-and.ac.uk>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2, or (at your option) any
 * later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#include <linux/module.h>
#include <linux/slab.h>

#include <scsi/scsi.h>
#include <scsi/scsi_cmnd.h>
#include <scsi/scsi_device.h>

#include "usb.h"
#include "transport.h"
#include "debug.h"
#include "scsiglue.h"

#define DRV_NAME "ums-karma"

MODULE_DESCRIPTION("Driver for Rio Karma");
MODULE_AUTHOR("Bob Copeland <me@bobcopeland.com>, Keith Bennett <keith@mcs.st-and.ac.uk>");
MODULE_LICENSE("GPL");

#define RIO_PREFIX "RIOP\x00"
#define RIO_PREFIX_LEN 5
#define RIO_SEND_LEN 40
#define RIO_RECV_LEN 0x200

#define RIO_ENTER_STORAGE 0x1
#define RIO_LEAVE_STORAGE 0x2
#define RIO_RESET 0xC

struct karma_data {
	int in_storage;
	char *recv;
};

static int rio_karma_init(struct us_data *us);


/*
 * The table of devices
 */
#define UNUSUAL_DEV(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax, \
		    vendorName, productName, useProtocol, useTransport, \
		    initFunction, flags) \
{ USB_DEVICE_VER(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax), \
  .driver_info = (flags) }

static struct usb_device_id karma_usb_ids[] = {
#	include "unusual_karma.h"
	{ }		/* Terminating entry */
};
MODULE_DEVICE_TABLE(usb, karma_usb_ids);

#undef UNUSUAL_DEV

/*
 * The flags table
 */
#define UNUSUAL_DEV(idVendor, idProduct, bcdDeviceMin, bcdDeviceMax, \
		    vendor_name, product_name, use_protocol, use_transport, \
		    init_function, Flags) \
{ \
	.vendorName = vendor_name,	\
	.productName = product_name,	\
	.useProtocol = use_protocol,	\
	.useTransport = use_transport,	\
	.initFunction = init_function,	\
}

static struct us_unusual_dev karma_unusual_dev_list[] = {
#	include "unusual_karma.h"
	{ }		/* Terminating entry */
};

#undef UNUSUAL_DEV


/*
 * Send commands to Rio Karma.
 *
 * For each command we send 40 bytes starting 'RIOP\0' followed by
 * the command number and a sequence number, which the device will ack
 * with a 512-byte packet with the high four bits set and everything
 * else null.  Then we send 'RIOP\x80' followed by a zero and the
 * sequence number, until byte 5 in the response repeats the sequence
 * number.
 */
static int rio_karma_send_command(char cmd, struct us_data *us)
{
	int result;
	unsigned long timeout;
	static unsigned char seq = 1;
	struct karma_data *data = (struct karma_data *) us->extra;

	usb_stor_dbg(us, "sending command %04x\n", cmd);
	memset(us->iobuf, 0, RIO_SEND_LEN);
	memcpy(us->iobuf, RIO_PREFIX, RIO_PREFIX_LEN);
	us->iobuf[5] = cmd;
	us->iobuf[6] = seq;

	timeout = jiffies + msecs_to_jiffies(6000);
	for (;;) {
		result = usb_stor_bulk_transfer_buf(us, us->send_bulk_pipe,
			us->iobuf, RIO_SEND_LEN, NULL);
		if (result != USB_STOR_XFER_GOOD)
			goto err;

		result = usb_stor_bulk_transfer_buf(us, us->recv_bulk_pipe,
			data->recv, RIO_RECV_LEN, NULL);
		if (result != USB_STOR_XFER_GOOD)
			goto err;

		if (data->recv[5] == seq)
			break;

		if (time_after(jiffies, timeout))
			goto err;

		us->iobuf[4] = 0x80;
		us->iobuf[5] = 0;
		msleep(50);
	}

	seq++;
	if (seq == 0)
		seq = 1;

	usb_stor_dbg(us, "sent command %04x\n", cmd);
	return 0;
err:
	usb_stor_dbg(us, "command %04x failed\n", cmd);
	return USB_STOR_TRANSPORT_FAILED;
}

/*
 * Trap START_STOP and READ_10 to leave/re-enter storage mode.
 * Everything else is propagated to the normal bulk layer.
 */
static int rio_karma_transport(struct scsi_cmnd *srb, struct us_data *us)
{
	int ret;
	struct karma_data *data = (struct karma_data *) us->extra;

	if (srb->cmnd[0] == READ_10 && !data->in_storage) {
		ret = rio_karma_send_command(RIO_ENTER_STORAGE, us);
		if (ret)
			return ret;

		data->in_storage = 1;
		return usb_stor_Bulk_transport(srb, us);
	} else if (srb->cmnd[0] == START_STOP) {
		ret = rio_karma_send_command(RIO_LEAVE_STORAGE, us);
		if (ret)
			return ret;

		data->in_storage = 0;
		return rio_karma_send_command(RIO_RESET, us);
	}
	return usb_stor_Bulk_transport(srb, us);
}

static void rio_karma_destructor(void *extra)
{
	struct karma_data *data = (struct karma_data *) extra;
	kfree(data->recv);
}

static int rio_karma_init(struct us_data *us)
{
	int ret = 0;
	struct karma_data *data = kzalloc(sizeof(struct karma_data), GFP_NOIO);
	if (!data)
		goto out;

	data->recv = kmalloc(RIO_RECV_LEN, GFP_NOIO);
	if (!data->recv) {
		kfree(data);
		goto out;
	}

	us->extra = data;
	us->extra_destructor = rio_karma_destructor;
	ret = rio_karma_send_command(RIO_ENTER_STORAGE, us);
	data->in_storage = (ret == 0);
out:
	return ret;
}

static struct scsi_host_template karma_host_template;

static int karma_probe(struct usb_interface *intf,
			 const struct usb_device_id *id)
{
	struct us_data *us;
	int result;

	result = usb_stor_probe1(&us, intf, id,
			(id - karma_usb_ids) + karma_unusual_dev_list,
			&karma_host_template);
	if (result)
		return result;

	us->transport_name = "Rio Karma/Bulk";
	us->transport = rio_karma_transport;
	us->transport_reset = usb_stor_Bulk_reset;

	result = usb_stor_probe2(us);
	return result;
}

static struct usb_driver karma_driver = {
	.name =		DRV_NAME,
	.probe =	karma_probe,
	.disconnect =	usb_stor_disconnect,
	.suspend =	usb_stor_suspend,
	.resume =	usb_stor_resume,
	.reset_resume =	usb_stor_reset_resume,
	.pre_reset =	usb_stor_pre_reset,
	.post_reset =	usb_stor_post_reset,
	.id_table =	karma_usb_ids,
	.soft_unbind =	1,
	.no_dynamic_id = 1,
};

module_usb_stor_driver(karma_driver, karma_host_template, DRV_NAME);
Commit	Line	Data
5fd54ace	1	// SPDX-License-Identifier: GPL-2.0+
f0183a33 FB	2	/*
f0183a33 FB	3	* Driver for Rio Karma
dfe0d3ba MD	4	*
	5	* (c) 2006 Bob Copeland <me@bobcopeland.com>
	6	* (c) 2006 Keith Bennett <keith@mcs.st-and.ac.uk>
	7	*
	8	* This program is free software; you can redistribute it and/or modify it
	9	* under the terms of the GNU General Public License as published by the
	10	* Free Software Foundation; either version 2, or (at your option) any
	11	* later version.
	12	*
	13	* This program is distributed in the hope that it will be useful, but
	14	* WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	16	* General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU General Public License along
	19	* with this program; if not, write to the Free Software Foundation, Inc.,
	20	* 675 Mass Ave, Cambridge, MA 02139, USA.
	21	*/
	22
c1033784	23	#include <linux/module.h>
5a0e3ad6	24	#include <linux/slab.h>
c1033784	25
dfe0d3ba MD	26	#include <scsi/scsi.h>
	27	#include <scsi/scsi_cmnd.h>
	28	#include <scsi/scsi_device.h>
	29
	30	#include "usb.h"
	31	#include "transport.h"
	32	#include "debug.h"
aa519be3 AM	33	#include "scsiglue.h"
	34
	35	#define DRV_NAME "ums-karma"
dfe0d3ba	36
4246b06a MG	37	MODULE_DESCRIPTION("Driver for Rio Karma");
	38	MODULE_AUTHOR("Bob Copeland <me@bobcopeland.com>, Keith Bennett <keith@mcs.st-and.ac.uk>");
	39	MODULE_LICENSE("GPL");
	40
dfe0d3ba MD	41	#define RIO_PREFIX "RIOP\x00"
	42	#define RIO_PREFIX_LEN 5
	43	#define RIO_SEND_LEN 40
	44	#define RIO_RECV_LEN 0x200
	45
	46	#define RIO_ENTER_STORAGE 0x1
	47	#define RIO_LEAVE_STORAGE 0x2
	48	#define RIO_RESET 0xC
	49
dfe0d3ba MD	50	struct karma_data {
	51	int in_storage;
	52	char *recv;
	53	};
	54
c1033784 AS	55	static int rio_karma_init(struct us_data *us);
	56
	57
	58	/*
	59	* The table of devices
	60	*/
	61	#define UNUSUAL_DEV(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax, \
	62	vendorName, productName, useProtocol, useTransport, \
	63	initFunction, flags) \
	64	{ USB_DEVICE_VER(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax), \
f61870ee	65	.driver_info = (flags) }
c1033784	66
f35e0d56	67	static struct usb_device_id karma_usb_ids[] = {
c1033784 AS	68	# include "unusual_karma.h"
	69	{ } /* Terminating entry */
	70	};
	71	MODULE_DEVICE_TABLE(usb, karma_usb_ids);
	72
	73	#undef UNUSUAL_DEV
	74
	75	/*
	76	* The flags table
	77	*/
	78	#define UNUSUAL_DEV(idVendor, idProduct, bcdDeviceMin, bcdDeviceMax, \
	79	vendor_name, product_name, use_protocol, use_transport, \
	80	init_function, Flags) \
	81	{ \
	82	.vendorName = vendor_name, \
	83	.productName = product_name, \
	84	.useProtocol = use_protocol, \
	85	.useTransport = use_transport, \
	86	.initFunction = init_function, \
	87	}
	88
	89	static struct us_unusual_dev karma_unusual_dev_list[] = {
	90	# include "unusual_karma.h"
	91	{ } /* Terminating entry */
	92	};
	93
	94	#undef UNUSUAL_DEV
	95
	96
dfe0d3ba MD	97	/*
	98	* Send commands to Rio Karma.
	99	*
	100	* For each command we send 40 bytes starting 'RIOP\0' followed by
	101	* the command number and a sequence number, which the device will ack
	102	* with a 512-byte packet with the high four bits set and everything
	103	* else null. Then we send 'RIOP\x80' followed by a zero and the
	104	* sequence number, until byte 5 in the response repeats the sequence
	105	* number.
	106	*/
	107	static int rio_karma_send_command(char cmd, struct us_data *us)
	108	{
dd1203c9	109	int result;
dfe0d3ba MD	110	unsigned long timeout;
	111	static unsigned char seq = 1;
	112	struct karma_data data = (struct karma_data ) us->extra;
	113
191648d0	114	usb_stor_dbg(us, "sending command %04x\n", cmd);
dfe0d3ba MD	115	memset(us->iobuf, 0, RIO_SEND_LEN);
	116	memcpy(us->iobuf, RIO_PREFIX, RIO_PREFIX_LEN);
	117	us->iobuf[5] = cmd;
	118	us->iobuf[6] = seq;
	119
	120	timeout = jiffies + msecs_to_jiffies(6000);
	121	for (;;) {
	122	result = usb_stor_bulk_transfer_buf(us, us->send_bulk_pipe,
dd1203c9	123	us->iobuf, RIO_SEND_LEN, NULL);
dfe0d3ba MD	124	if (result != USB_STOR_XFER_GOOD)
	125	goto err;
	126
	127	result = usb_stor_bulk_transfer_buf(us, us->recv_bulk_pipe,
dd1203c9	128	data->recv, RIO_RECV_LEN, NULL);
dfe0d3ba MD	129	if (result != USB_STOR_XFER_GOOD)
	130	goto err;
	131
	132	if (data->recv[5] == seq)
	133	break;
	134
	135	if (time_after(jiffies, timeout))
	136	goto err;
	137
	138	us->iobuf[4] = 0x80;
	139	us->iobuf[5] = 0;
	140	msleep(50);
	141	}
	142
	143	seq++;
	144	if (seq == 0)
	145	seq = 1;
	146
191648d0	147	usb_stor_dbg(us, "sent command %04x\n", cmd);
dfe0d3ba MD	148	return 0;
dfe0d3ba MD	149	err:
191648d0	150	usb_stor_dbg(us, "command %04x failed\n", cmd);
dfe0d3ba MD	151	return USB_STOR_TRANSPORT_FAILED;
	152	}
	153
	154	/*
	155	* Trap START_STOP and READ_10 to leave/re-enter storage mode.
	156	* Everything else is propagated to the normal bulk layer.
	157	*/
c1033784	158	static int rio_karma_transport(struct scsi_cmnd srb, struct us_data us)
dfe0d3ba MD	159	{
	160	int ret;
	161	struct karma_data data = (struct karma_data ) us->extra;
	162
	163	if (srb->cmnd[0] == READ_10 && !data->in_storage) {
	164	ret = rio_karma_send_command(RIO_ENTER_STORAGE, us);
	165	if (ret)
	166	return ret;
	167
	168	data->in_storage = 1;
	169	return usb_stor_Bulk_transport(srb, us);
	170	} else if (srb->cmnd[0] == START_STOP) {
	171	ret = rio_karma_send_command(RIO_LEAVE_STORAGE, us);
	172	if (ret)
	173	return ret;
	174
	175	data->in_storage = 0;
	176	return rio_karma_send_command(RIO_RESET, us);
	177	}
	178	return usb_stor_Bulk_transport(srb, us);
	179	}
	180
	181	static void rio_karma_destructor(void *extra)
	182	{
	183	struct karma_data data = (struct karma_data ) extra;
	184	kfree(data->recv);
	185	}
	186
c1033784	187	static int rio_karma_init(struct us_data *us)
dfe0d3ba MD	188	{
	189	int ret = 0;
	190	struct karma_data *data = kzalloc(sizeof(struct karma_data), GFP_NOIO);
	191	if (!data)
	192	goto out;
	193
	194	data->recv = kmalloc(RIO_RECV_LEN, GFP_NOIO);
	195	if (!data->recv) {
	196	kfree(data);
	197	goto out;
	198	}
	199
	200	us->extra = data;
	201	us->extra_destructor = rio_karma_destructor;
	202	ret = rio_karma_send_command(RIO_ENTER_STORAGE, us);
	203	data->in_storage = (ret == 0);
	204	out:
	205	return ret;
	206	}
c1033784	207
aa519be3 AM	208	static struct scsi_host_template karma_host_template;
aa519be3 AM	209
c1033784 AS	210	static int karma_probe(struct usb_interface *intf,
	211	const struct usb_device_id *id)
	212	{
	213	struct us_data *us;
	214	int result;
	215
	216	result = usb_stor_probe1(&us, intf, id,
aa519be3 AM	217	(id - karma_usb_ids) + karma_unusual_dev_list,
aa519be3 AM	218	&karma_host_template);
c1033784 AS	219	if (result)
	220	return result;
	221
	222	us->transport_name = "Rio Karma/Bulk";
	223	us->transport = rio_karma_transport;
	224	us->transport_reset = usb_stor_Bulk_reset;
	225
	226	result = usb_stor_probe2(us);
	227	return result;
	228	}
	229
	230	static struct usb_driver karma_driver = {
aa519be3	231	.name = DRV_NAME,
c1033784 AS	232	.probe = karma_probe,
	233	.disconnect = usb_stor_disconnect,
	234	.suspend = usb_stor_suspend,
	235	.resume = usb_stor_resume,
	236	.reset_resume = usb_stor_reset_resume,
	237	.pre_reset = usb_stor_pre_reset,
	238	.post_reset = usb_stor_post_reset,
	239	.id_table = karma_usb_ids,
	240	.soft_unbind = 1,
e73b2db6	241	.no_dynamic_id = 1,
c1033784 AS	242	};
c1033784 AS	243
aa519be3	244	module_usb_stor_driver(karma_driver, karma_host_template, DRV_NAME);