[deliverable/linux.git] / drivers / usb / usbip / vhci_sysfs.c

/*
 * Copyright (C) 2003-2008 Takahiro Hirofuchi
 *
 * This 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 of the License, or
 * (at your option) any later version.
 *
 * This 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
 * USA.
 */

#include <linux/kthread.h>
#include <linux/file.h>
#include <linux/net.h>

#include "usbip_common.h"
#include "vhci.h"

/* TODO: refine locking ?*/

/* Sysfs entry to show port status */
static ssize_t status_show(struct device *dev, struct device_attribute *attr,
			   char *out)
{
	char *s = out;
	int i = 0;

	BUG_ON(!the_controller || !out);

	spin_lock(&the_controller->lock);

	/*
	 * output example:
	 * prt sta spd dev socket           local_busid
	 * 000 004 000 000         c5a7bb80 1-2.3
	 * 001 004 000 000         d8cee980 2-3.4
	 *
	 * IP address can be retrieved from a socket pointer address by looking
	 * up /proc/net/{tcp,tcp6}. Also, a userland program may remember a
	 * port number and its peer IP address.
	 */
	out += sprintf(out,
		       "prt sta spd bus dev socket           local_busid\n");

	for (i = 0; i < VHCI_NPORTS; i++) {
		struct vhci_device *vdev = port_to_vdev(i);

		spin_lock(&vdev->ud.lock);
		out += sprintf(out, "%03u %03u ", i, vdev->ud.status);

		if (vdev->ud.status == VDEV_ST_USED) {
			out += sprintf(out, "%03u %08x ",
				       vdev->speed, vdev->devid);
			out += sprintf(out, "%16p ", vdev->ud.tcp_socket);
			out += sprintf(out, "%s", dev_name(&vdev->udev->dev));

		} else {
			out += sprintf(out, "000 000 000 0000000000000000 0-0");
		}

		out += sprintf(out, "\n");
		spin_unlock(&vdev->ud.lock);
	}

	spin_unlock(&the_controller->lock);

	return out - s;
}
static DEVICE_ATTR_RO(status);

/* Sysfs entry to shutdown a virtual connection */
static int vhci_port_disconnect(__u32 rhport)
{
	struct vhci_device *vdev;

	usbip_dbg_vhci_sysfs("enter\n");

	/* lock */
	spin_lock(&the_controller->lock);

	vdev = port_to_vdev(rhport);

	spin_lock(&vdev->ud.lock);
	if (vdev->ud.status == VDEV_ST_NULL) {
		pr_err("not connected %d\n", vdev->ud.status);

		/* unlock */
		spin_unlock(&vdev->ud.lock);
		spin_unlock(&the_controller->lock);

		return -EINVAL;
	}

	/* unlock */
	spin_unlock(&vdev->ud.lock);
	spin_unlock(&the_controller->lock);

	usbip_event_add(&vdev->ud, VDEV_EVENT_DOWN);

	return 0;
}

static ssize_t store_detach(struct device *dev, struct device_attribute *attr,
			    const char *buf, size_t count)
{
	int err;
	__u32 rhport = 0;

	if (sscanf(buf, "%u", &rhport) != 1)
		return -EINVAL;

	/* check rhport */
	if (rhport >= VHCI_NPORTS) {
		dev_err(dev, "invalid port %u\n", rhport);
		return -EINVAL;
	}

	err = vhci_port_disconnect(rhport);
	if (err < 0)
		return -EINVAL;

	usbip_dbg_vhci_sysfs("Leave\n");

	return count;
}
static DEVICE_ATTR(detach, S_IWUSR, NULL, store_detach);

/* Sysfs entry to establish a virtual connection */
static int valid_args(__u32 rhport, enum usb_device_speed speed)
{
	/* check rhport */
	if (rhport >= VHCI_NPORTS) {
		pr_err("port %u\n", rhport);
		return -EINVAL;
	}

	/* check speed */
	switch (speed) {
	case USB_SPEED_LOW:
	case USB_SPEED_FULL:
	case USB_SPEED_HIGH:
	case USB_SPEED_WIRELESS:
		break;
	default:
		pr_err("Failed attach request for unsupported USB speed: %s\n",
			usb_speed_string(speed));
		return -EINVAL;
	}

	return 0;
}

/*
 * To start a new USB/IP attachment, a userland program needs to setup a TCP
 * connection and then write its socket descriptor with remote device
 * information into this sysfs file.
 *
 * A remote device is virtually attached to the root-hub port of @rhport with
 * @speed. @devid is embedded into a request to specify the remote device in a
 * server host.
 *
 * write() returns 0 on success, else negative errno.
 */
static ssize_t store_attach(struct device *dev, struct device_attribute *attr,
			    const char *buf, size_t count)
{
	struct vhci_device *vdev;
	struct socket *socket;
	int sockfd = 0;
	__u32 rhport = 0, devid = 0, speed = 0;
	int err;

	/*
	 * @rhport: port number of vhci_hcd
	 * @sockfd: socket descriptor of an established TCP connection
	 * @devid: unique device identifier in a remote host
	 * @speed: usb device speed in a remote host
	 */
	if (sscanf(buf, "%u %u %u %u", &rhport, &sockfd, &devid, &speed) != 4)
		return -EINVAL;

	usbip_dbg_vhci_sysfs("rhport(%u) sockfd(%u) devid(%u) speed(%u)\n",
			     rhport, sockfd, devid, speed);

	/* check received parameters */
	if (valid_args(rhport, speed) < 0)
		return -EINVAL;

	/* Extract socket from fd. */
	socket = sockfd_lookup(sockfd, &err);
	if (!socket)
		return -EINVAL;

	/* now need lock until setting vdev status as used */

	/* begin a lock */
	spin_lock(&the_controller->lock);
	vdev = port_to_vdev(rhport);
	spin_lock(&vdev->ud.lock);

	if (vdev->ud.status != VDEV_ST_NULL) {
		/* end of the lock */
		spin_unlock(&vdev->ud.lock);
		spin_unlock(&the_controller->lock);

		sockfd_put(socket);

		dev_err(dev, "port %d already used\n", rhport);
		return -EINVAL;
	}

	dev_info(dev,
		 "rhport(%u) sockfd(%d) devid(%u) speed(%u) speed_str(%s)\n",
		 rhport, sockfd, devid, speed, usb_speed_string(speed));

	vdev->devid         = devid;
	vdev->speed         = speed;
	vdev->ud.tcp_socket = socket;
	vdev->ud.status     = VDEV_ST_NOTASSIGNED;

	spin_unlock(&vdev->ud.lock);
	spin_unlock(&the_controller->lock);
	/* end the lock */

	vdev->ud.tcp_rx = kthread_get_run(vhci_rx_loop, &vdev->ud, "vhci_rx");
	vdev->ud.tcp_tx = kthread_get_run(vhci_tx_loop, &vdev->ud, "vhci_tx");

	rh_port_connect(rhport, speed);

	return count;
}
static DEVICE_ATTR(attach, S_IWUSR, NULL, store_attach);

static struct attribute *dev_attrs[] = {
	&dev_attr_status.attr,
	&dev_attr_detach.attr,
	&dev_attr_attach.attr,
	&dev_attr_usbip_debug.attr,
	NULL,
};

const struct attribute_group dev_attr_group = {
	.attrs = dev_attrs,
};
Commit	Line	Data
04679b34 TH	1	/*
	2	* Copyright (C) 2003-2008 Takahiro Hirofuchi
	3	*
	4	* This is free software; you can redistribute it and/or modify
	5	* it under the terms of the GNU General Public License as published by
	6	* the Free Software Foundation; either version 2 of the License, or
	7	* (at your option) any later version.
	8	*
	9	* This is distributed in the hope that it will be useful,
	10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	* GNU General Public License for more details.
	13	*
	14	* You should have received a copy of the GNU General Public License
	15	* along with this program; if not, write to the Free Software
	16	* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
	17	* USA.
	18	*/
	19
7aaacb43	20	#include <linux/kthread.h>
3d0a2a22	21	#include <linux/file.h>
7aaacb43	22	#include <linux/net.h>
7aaacb43	23
04679b34 TH	24	#include "usbip_common.h"
	25	#include "vhci.h"
	26
04679b34 TH	27	/* TODO: refine locking ?*/
	28
	29	/* Sysfs entry to show port status */
b1f56aca	30	static ssize_t status_show(struct device dev, struct device_attribute attr,
04679b34 TH	31	char *out)
	32	{
	33	char *s = out;
	34	int i = 0;
	35
2961f24f	36	BUG_ON(!the_controller \|\| !out);
04679b34 TH	37
	38	spin_lock(&the_controller->lock);
	39
	40	/*
	41	* output example:
	42	* prt sta spd dev socket local_busid
	43	* 000 004 000 000 c5a7bb80 1-2.3
	44	* 001 004 000 000 d8cee980 2-3.4
	45	*
	46	* IP address can be retrieved from a socket pointer address by looking
	47	* up /proc/net/{tcp,tcp6}. Also, a userland program may remember a
	48	* port number and its peer IP address.
	49	*/
6bb3ee69 CC	50	out += sprintf(out,
6bb3ee69 CC	51	"prt sta spd bus dev socket local_busid\n");
04679b34 TH	52
	53	for (i = 0; i < VHCI_NPORTS; i++) {
	54	struct vhci_device *vdev = port_to_vdev(i);
	55
	56	spin_lock(&vdev->ud.lock);
04679b34 TH	57	out += sprintf(out, "%03u %03u ", i, vdev->ud.status);
	58
	59	if (vdev->ud.status == VDEV_ST_USED) {
	60	out += sprintf(out, "%03u %08x ",
bd608f6c	61	vdev->speed, vdev->devid);
04679b34	62	out += sprintf(out, "%16p ", vdev->ud.tcp_socket);
e9133972	63	out += sprintf(out, "%s", dev_name(&vdev->udev->dev));
04679b34	64
bd608f6c	65	} else {
04679b34	66	out += sprintf(out, "000 000 000 0000000000000000 0-0");
bd608f6c	67	}
04679b34 TH	68
04679b34 TH	69	out += sprintf(out, "\n");
04679b34 TH	70	spin_unlock(&vdev->ud.lock);
	71	}
	72
	73	spin_unlock(&the_controller->lock);
	74
	75	return out - s;
	76	}
b1f56aca	77	static DEVICE_ATTR_RO(status);
04679b34 TH	78
	79	/* Sysfs entry to shutdown a virtual connection */
	80	static int vhci_port_disconnect(__u32 rhport)
	81	{
	82	struct vhci_device *vdev;
	83
b8868e45	84	usbip_dbg_vhci_sysfs("enter\n");
04679b34 TH	85
	86	/* lock */
	87	spin_lock(&the_controller->lock);
	88
	89	vdev = port_to_vdev(rhport);
	90
	91	spin_lock(&vdev->ud.lock);
	92	if (vdev->ud.status == VDEV_ST_NULL) {
1a4b6f66	93	pr_err("not connected %d\n", vdev->ud.status);
04679b34 TH	94
	95	/* unlock */
	96	spin_unlock(&vdev->ud.lock);
	97	spin_unlock(&the_controller->lock);
	98
	99	return -EINVAL;
	100	}
	101
	102	/* unlock */
	103	spin_unlock(&vdev->ud.lock);
	104	spin_unlock(&the_controller->lock);
	105
	106	usbip_event_add(&vdev->ud, VDEV_EVENT_DOWN);
	107
	108	return 0;
	109	}
	110
	111	static ssize_t store_detach(struct device dev, struct device_attribute attr,
	112	const char *buf, size_t count)
	113	{
	114	int err;
	115	__u32 rhport = 0;
	116
88fa1ebf JG	117	if (sscanf(buf, "%u", &rhport) != 1)
88fa1ebf JG	118	return -EINVAL;
04679b34 TH	119
	120	/* check rhport */
	121	if (rhport >= VHCI_NPORTS) {
1a4b6f66	122	dev_err(dev, "invalid port %u\n", rhport);
04679b34 TH	123	return -EINVAL;
	124	}
	125
	126	err = vhci_port_disconnect(rhport);
	127	if (err < 0)
	128	return -EINVAL;
	129
b8868e45	130	usbip_dbg_vhci_sysfs("Leave\n");
bd608f6c	131
04679b34 TH	132	return count;
	133	}
	134	static DEVICE_ATTR(detach, S_IWUSR, NULL, store_detach);
	135
	136	/* Sysfs entry to establish a virtual connection */
	137	static int valid_args(__u32 rhport, enum usb_device_speed speed)
	138	{
	139	/* check rhport */
988e7520	140	if (rhport >= VHCI_NPORTS) {
1a4b6f66	141	pr_err("port %u\n", rhport);
04679b34 TH	142	return -EINVAL;
	143	}
	144
	145	/* check speed */
	146	switch (speed) {
	147	case USB_SPEED_LOW:
	148	case USB_SPEED_FULL:
	149	case USB_SPEED_HIGH:
551cdbbe	150	case USB_SPEED_WIRELESS:
04679b34 TH	151	break;
04679b34 TH	152	default:
8360fb0d SK	153	pr_err("Failed attach request for unsupported USB speed: %s\n",
8360fb0d SK	154	usb_speed_string(speed));
04679b34 TH	155	return -EINVAL;
	156	}
	157
	158	return 0;
	159	}
	160
	161	/*
	162	* To start a new USB/IP attachment, a userland program needs to setup a TCP
	163	* connection and then write its socket descriptor with remote device
	164	* information into this sysfs file.
	165	*
	166	* A remote device is virtually attached to the root-hub port of @rhport with
	167	* @speed. @devid is embedded into a request to specify the remote device in a
	168	* server host.
	169	*
	170	* write() returns 0 on success, else negative errno.
	171	*/
	172	static ssize_t store_attach(struct device dev, struct device_attribute attr,
	173	const char *buf, size_t count)
	174	{
	175	struct vhci_device *vdev;
	176	struct socket *socket;
	177	int sockfd = 0;
	178	__u32 rhport = 0, devid = 0, speed = 0;
964ea96e	179	int err;
04679b34 TH	180
	181	/*
	182	* @rhport: port number of vhci_hcd
	183	* @sockfd: socket descriptor of an established TCP connection
	184	* @devid: unique device identifier in a remote host
	185	* @speed: usb device speed in a remote host
	186	*/
de4734bc	187	if (sscanf(buf, "%u %u %u %u", &rhport, &sockfd, &devid, &speed) != 4)
88fa1ebf	188	return -EINVAL;
04679b34	189
b8868e45	190	usbip_dbg_vhci_sysfs("rhport(%u) sockfd(%u) devid(%u) speed(%u)\n",
bd608f6c	191	rhport, sockfd, devid, speed);
04679b34 TH	192
	193	/* check received parameters */
	194	if (valid_args(rhport, speed) < 0)
	195	return -EINVAL;
	196
3d0a2a22	197	/* Extract socket from fd. */
964ea96e	198	socket = sockfd_lookup(sockfd, &err);
04679b34	199	if (!socket)
a6d81814	200	return -EINVAL;
04679b34 TH	201
	202	/* now need lock until setting vdev status as used */
	203
	204	/* begin a lock */
	205	spin_lock(&the_controller->lock);
04679b34	206	vdev = port_to_vdev(rhport);
04679b34 TH	207	spin_lock(&vdev->ud.lock);
	208
	209	if (vdev->ud.status != VDEV_ST_NULL) {
	210	/* end of the lock */
	211	spin_unlock(&vdev->ud.lock);
	212	spin_unlock(&the_controller->lock);
	213
964ea96e	214	sockfd_put(socket);
3d0a2a22	215
1a4b6f66	216	dev_err(dev, "port %d already used\n", rhport);
04679b34 TH	217	return -EINVAL;
	218	}
	219
a6646ea6 SK	220	dev_info(dev,
	221	"rhport(%u) sockfd(%d) devid(%u) speed(%u) speed_str(%s)\n",
	222	rhport, sockfd, devid, speed, usb_speed_string(speed));
04679b34 TH	223
	224	vdev->devid = devid;
	225	vdev->speed = speed;
	226	vdev->ud.tcp_socket = socket;
	227	vdev->ud.status = VDEV_ST_NOTASSIGNED;
	228
	229	spin_unlock(&vdev->ud.lock);
	230	spin_unlock(&the_controller->lock);
	231	/* end the lock */
	232
ba46ce30 ON	233	vdev->ud.tcp_rx = kthread_get_run(vhci_rx_loop, &vdev->ud, "vhci_rx");
ba46ce30 ON	234	vdev->ud.tcp_tx = kthread_get_run(vhci_tx_loop, &vdev->ud, "vhci_tx");
d1b2e95a	235
04679b34 TH	236	rh_port_connect(rhport, speed);
	237
	238	return count;
	239	}
	240	static DEVICE_ATTR(attach, S_IWUSR, NULL, store_attach);
	241
	242	static struct attribute *dev_attrs[] = {
	243	&dev_attr_status.attr,
	244	&dev_attr_detach.attr,
	245	&dev_attr_attach.attr,
	246	&dev_attr_usbip_debug.attr,
	247	NULL,
	248	};
	249
cf77acfc	250	const struct attribute_group dev_attr_group = {
04679b34 TH	251	.attrs = dev_attrs,
04679b34 TH	252	};