[mirror_ubuntu-artful-kernel.git] / drivers / usb / usbip / stub.h

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

#ifndef __USBIP_STUB_H
#define __USBIP_STUB_H

#include <linux/list.h>
#include <linux/slab.h>
#include <linux/spinlock.h>
#include <linux/types.h>
#include <linux/usb.h>
#include <linux/wait.h>

#define STUB_BUSID_OTHER 0
#define STUB_BUSID_REMOV 1
#define STUB_BUSID_ADDED 2
#define STUB_BUSID_ALLOC 3

struct stub_device {
	struct usb_device *udev;

	struct usbip_device ud;
	__u32 devid;

	/*
	 * stub_priv preserves private data of each urb.
	 * It is allocated as stub_priv_cache and assigned to urb->context.
	 *
	 * stub_priv is always linked to any one of 3 lists;
	 *	priv_init: linked to this until the comletion of a urb.
	 *	priv_tx  : linked to this after the completion of a urb.
	 *	priv_free: linked to this after the sending of the result.
	 *
	 * Any of these list operations should be locked by priv_lock.
	 */
	spinlock_t priv_lock;
	struct list_head priv_init;
	struct list_head priv_tx;
	struct list_head priv_free;

	/* see comments for unlinking in stub_rx.c */
	struct list_head unlink_tx;
	struct list_head unlink_free;

	wait_queue_head_t tx_waitq;
};

/* private data into urb->priv */
struct stub_priv {
	unsigned long seqnum;
	struct list_head list;
	struct stub_device *sdev;
	struct urb *urb;

	int unlinking;
};

struct stub_unlink {
	unsigned long seqnum;
	struct list_head list;
	__u32 status;
};

/* same as SYSFS_BUS_ID_SIZE */
#define BUSID_SIZE 32

struct bus_id_priv {
	char name[BUSID_SIZE];
	char status;
	int interf_count;
	struct stub_device *sdev;
	struct usb_device *udev;
	char shutdown_busid;
};

/* stub_priv is allocated from stub_priv_cache */
extern struct kmem_cache *stub_priv_cache;

/* stub_dev.c */
extern struct usb_device_driver stub_driver;

/* stub_main.c */
struct bus_id_priv *get_busid_priv(const char *busid);
int del_match_busid(char *busid);
void stub_device_cleanup_urbs(struct stub_device *sdev);

/* stub_rx.c */
int stub_rx_loop(void *data);

/* stub_tx.c */
void stub_enqueue_ret_unlink(struct stub_device *sdev, __u32 seqnum,
			     __u32 status);
void stub_complete(struct urb *urb);
int stub_tx_loop(void *data);

#endif /* __USBIP_STUB_H */
Commit	Line	Data
4d7b5c7f 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
306dac69 TK	20	#ifndef __USBIP_STUB_H
	21	#define __USBIP_STUB_H
	22
4d7b5c7f	23	#include <linux/list.h>
4d7b5c7f	24	#include <linux/slab.h>
7aaacb43	25	#include <linux/spinlock.h>
	26	#include <linux/types.h>
	27	#include <linux/usb.h>
	28	#include <linux/wait.h>
4d7b5c7f	29
aa5873e9 EK	30	#define STUB_BUSID_OTHER 0
	31	#define STUB_BUSID_REMOV 1
	32	#define STUB_BUSID_ADDED 2
	33	#define STUB_BUSID_ALLOC 3
	34
4d7b5c7f	35	struct stub_device {
2d8f4595	36	struct usb_device *udev;
4d7b5c7f TH	37
	38	struct usbip_device ud;
	39	__u32 devid;
	40
	41	/*
	42	* stub_priv preserves private data of each urb.
	43	* It is allocated as stub_priv_cache and assigned to urb->context.
	44	*
	45	* stub_priv is always linked to any one of 3 lists;
	46	* priv_init: linked to this until the comletion of a urb.
	47	* priv_tx : linked to this after the completion of a urb.
	48	* priv_free: linked to this after the sending of the result.
	49	*
	50	* Any of these list operations should be locked by priv_lock.
	51	*/
	52	spinlock_t priv_lock;
	53	struct list_head priv_init;
	54	struct list_head priv_tx;
	55	struct list_head priv_free;
	56
	57	/* see comments for unlinking in stub_rx.c */
	58	struct list_head unlink_tx;
	59	struct list_head unlink_free;
	60
4d7b5c7f TH	61	wait_queue_head_t tx_waitq;
	62	};
	63
	64	/* private data into urb->priv */
	65	struct stub_priv {
	66	unsigned long seqnum;
	67	struct list_head list;
	68	struct stub_device *sdev;
	69	struct urb *urb;
	70
	71	int unlinking;
	72	};
	73
	74	struct stub_unlink {
	75	unsigned long seqnum;
	76	struct list_head list;
	77	__u32 status;
	78	};
	79
3e4fda9f	80	/* same as SYSFS_BUS_ID_SIZE */
3e4fda9f	81	#define BUSID_SIZE 32
87352760	82
aa5873e9 EK	83	struct bus_id_priv {
	84	char name[BUSID_SIZE];
	85	char status;
	86	int interf_count;
	87	struct stub_device *sdev;
a46034ca	88	struct usb_device *udev;
aa5873e9 EK	89	char shutdown_busid;
aa5873e9 EK	90	};
4d7b5c7f	91
499aaae0	92	/* stub_priv is allocated from stub_priv_cache */
4d7b5c7f TH	93	extern struct kmem_cache *stub_priv_cache;
4d7b5c7f TH	94
4d7b5c7f	95	/* stub_dev.c */
b7945b77	96	extern struct usb_device_driver stub_driver;
4d7b5c7f	97
4d7b5c7f	98	/* stub_main.c */
aa5873e9 EK	99	struct bus_id_priv get_busid_priv(const char busid);
aa5873e9 EK	100	int del_match_busid(char *busid);
4d7b5c7f	101	void stub_device_cleanup_urbs(struct stub_device *sdev);
499aaae0	102
	103	/* stub_rx.c */
	104	int stub_rx_loop(void *data);
	105
	106	/* stub_tx.c */
	107	void stub_enqueue_ret_unlink(struct stub_device *sdev, __u32 seqnum,
	108	__u32 status);
	109	void stub_complete(struct urb *urb);
	110	int stub_tx_loop(void *data);
306dac69 TK	111
306dac69 TK	112	#endif /* __USBIP_STUB_H */