[linux.git] / drivers / staging / 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 show_status(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(status, S_IRUGO, show_status, NULL);

/* 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;

	sscanf(buf, "%u", &rhport);

	/* 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("speed %d\n", 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;

	/*
	 * @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
	 */
	sscanf(buf, "%u %u %u %u", &rhport, &sockfd, &devid, &speed);

	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. */
	/* The correct way to clean this up is to fput(socket->file). */
	socket = sockfd_to_socket(sockfd);
	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);

		fput(socket->file);

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

	dev_info(dev, "rhport(%u) sockfd(%d) devid(%u) speed(%u)\n",
		 rhport, sockfd, devid, 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 */
	30	static ssize_t show_status(struct device dev, struct device_attribute attr,
	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	*/
	50	out += sprintf(out, "prt sta spd bus dev socket "
	51	"local_busid\n");
	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	}
	77	static DEVICE_ATTR(status, S_IRUGO, show_status, NULL);
	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
	117	sscanf(buf, "%u", &rhport);
	118
	119	/* check rhport */
	120	if (rhport >= VHCI_NPORTS) {
1a4b6f66	121	dev_err(dev, "invalid port %u\n", rhport);
04679b34 TH	122	return -EINVAL;
	123	}
	124
	125	err = vhci_port_disconnect(rhport);
	126	if (err < 0)
	127	return -EINVAL;
	128
b8868e45	129	usbip_dbg_vhci_sysfs("Leave\n");
bd608f6c	130
04679b34 TH	131	return count;
	132	}
	133	static DEVICE_ATTR(detach, S_IWUSR, NULL, store_detach);
	134
	135	/* Sysfs entry to establish a virtual connection */
	136	static int valid_args(__u32 rhport, enum usb_device_speed speed)
	137	{
	138	/* check rhport */
988e7520	139	if (rhport >= VHCI_NPORTS) {
1a4b6f66	140	pr_err("port %u\n", rhport);
04679b34 TH	141	return -EINVAL;
	142	}
	143
	144	/* check speed */
	145	switch (speed) {
	146	case USB_SPEED_LOW:
	147	case USB_SPEED_FULL:
	148	case USB_SPEED_HIGH:
551cdbbe	149	case USB_SPEED_WIRELESS:
04679b34 TH	150	break;
04679b34 TH	151	default:
1a4b6f66	152	pr_err("speed %d\n", speed);
04679b34 TH	153	return -EINVAL;
	154	}
	155
	156	return 0;
	157	}
	158
	159	/*
	160	* To start a new USB/IP attachment, a userland program needs to setup a TCP
	161	* connection and then write its socket descriptor with remote device
	162	* information into this sysfs file.
	163	*
	164	* A remote device is virtually attached to the root-hub port of @rhport with
	165	* @speed. @devid is embedded into a request to specify the remote device in a
	166	* server host.
	167	*
	168	* write() returns 0 on success, else negative errno.
	169	*/
	170	static ssize_t store_attach(struct device dev, struct device_attribute attr,
	171	const char *buf, size_t count)
	172	{
	173	struct vhci_device *vdev;
	174	struct socket *socket;
	175	int sockfd = 0;
	176	__u32 rhport = 0, devid = 0, speed = 0;
	177
	178	/*
	179	* @rhport: port number of vhci_hcd
	180	* @sockfd: socket descriptor of an established TCP connection
	181	* @devid: unique device identifier in a remote host
	182	* @speed: usb device speed in a remote host
	183	*/
	184	sscanf(buf, "%u %u %u %u", &rhport, &sockfd, &devid, &speed);
	185
b8868e45	186	usbip_dbg_vhci_sysfs("rhport(%u) sockfd(%u) devid(%u) speed(%u)\n",
bd608f6c	187	rhport, sockfd, devid, speed);
04679b34 TH	188
	189	/* check received parameters */
	190	if (valid_args(rhport, speed) < 0)
	191	return -EINVAL;
	192
3d0a2a22 BB	193	/* Extract socket from fd. */
3d0a2a22 BB	194	/* The correct way to clean this up is to fput(socket->file). */
04679b34 TH	195	socket = sockfd_to_socket(sockfd);
04679b34 TH	196	if (!socket)
a6d81814	197	return -EINVAL;
04679b34 TH	198
	199	/* now need lock until setting vdev status as used */
	200
	201	/* begin a lock */
	202	spin_lock(&the_controller->lock);
04679b34	203	vdev = port_to_vdev(rhport);
04679b34 TH	204	spin_lock(&vdev->ud.lock);
	205
	206	if (vdev->ud.status != VDEV_ST_NULL) {
	207	/* end of the lock */
	208	spin_unlock(&vdev->ud.lock);
	209	spin_unlock(&the_controller->lock);
	210
3d0a2a22 BB	211	fput(socket->file);
3d0a2a22 BB	212
1a4b6f66	213	dev_err(dev, "port %d already used\n", rhport);
04679b34 TH	214	return -EINVAL;
	215	}
	216
1a4b6f66	217	dev_info(dev, "rhport(%u) sockfd(%d) devid(%u) speed(%u)\n",
1a4b6f66	218	rhport, sockfd, devid, speed);
04679b34 TH	219
	220	vdev->devid = devid;
	221	vdev->speed = speed;
	222	vdev->ud.tcp_socket = socket;
	223	vdev->ud.status = VDEV_ST_NOTASSIGNED;
	224
	225	spin_unlock(&vdev->ud.lock);
	226	spin_unlock(&the_controller->lock);
	227	/* end the lock */
	228
ba46ce30 ON	229	vdev->ud.tcp_rx = kthread_get_run(vhci_rx_loop, &vdev->ud, "vhci_rx");
ba46ce30 ON	230	vdev->ud.tcp_tx = kthread_get_run(vhci_tx_loop, &vdev->ud, "vhci_tx");
d1b2e95a	231
04679b34 TH	232	rh_port_connect(rhport, speed);
	233
	234	return count;
	235	}
	236	static DEVICE_ATTR(attach, S_IWUSR, NULL, store_attach);
	237
	238	static struct attribute *dev_attrs[] = {
	239	&dev_attr_status.attr,
	240	&dev_attr_detach.attr,
	241	&dev_attr_attach.attr,
	242	&dev_attr_usbip_debug.attr,
	243	NULL,
	244	};
	245
cf77acfc	246	const struct attribute_group dev_attr_group = {
04679b34 TH	247	.attrs = dev_attrs,
04679b34 TH	248	};