[deliverable/linux.git] / drivers / staging / usbip / vhci.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.
 *
 */

#ifndef __USBIP_VHCI_H
#define __USBIP_VHCI_H

#include <linux/device.h>
#include <linux/list.h>
#include <linux/spinlock.h>
#include <linux/sysfs.h>
#include <linux/types.h>
#include <linux/usb.h>
#include <linux/usb/hcd.h>
#include <linux/wait.h>

struct vhci_device {
	struct usb_device *udev;

	/*
	 * devid specifies a remote usb device uniquely instead
	 * of combination of busnum and devnum.
	 */
	__u32 devid;

	/* speed of a remote device */
	enum usb_device_speed speed;

	/* vhci root-hub port to which this device is attached */
	__u32 rhport;

	struct usbip_device ud;

	/* lock for the below link lists */
	spinlock_t priv_lock;

	/* vhci_priv is linked to one of them. */
	struct list_head priv_tx;
	struct list_head priv_rx;

	/* vhci_unlink is linked to one of them */
	struct list_head unlink_tx;
	struct list_head unlink_rx;

	/* vhci_tx thread sleeps for this queue */
	wait_queue_head_t waitq_tx;
};

/* urb->hcpriv, use container_of() */
struct vhci_priv {
	unsigned long seqnum;
	struct list_head list;

	struct vhci_device *vdev;
	struct urb *urb;
};

struct vhci_unlink {
	/* seqnum of this request */
	unsigned long seqnum;

	struct list_head list;

	/* seqnum of the unlink target */
	unsigned long unlink_seqnum;
};

/* Number of supported ports. Value has an upperbound of USB_MAXCHILDREN */
#define VHCI_NPORTS 8

/* for usb_bus.hcpriv */
struct vhci_hcd {
	spinlock_t lock;

	u32 port_status[VHCI_NPORTS];

	unsigned resuming:1;
	unsigned long re_timeout;

	atomic_t seqnum;

	/*
	 * NOTE:
	 * wIndex shows the port number and begins from 1.
	 * But, the index of this array begins from 0.
	 */
	struct vhci_device vdev[VHCI_NPORTS];
};

extern struct vhci_hcd *the_controller;
extern const struct attribute_group dev_attr_group;

/* vhci_hcd.c */
void rh_port_connect(int rhport, enum usb_device_speed speed);

/* vhci_rx.c */
struct urb *pickup_urb_and_free_priv(struct vhci_device *vdev, __u32 seqnum);
int vhci_rx_loop(void *data);

/* vhci_tx.c */
int vhci_tx_loop(void *data);

static inline struct vhci_device *port_to_vdev(__u32 port)
{
	return &the_controller->vdev[port];
}

static inline struct vhci_hcd *hcd_to_vhci(struct usb_hcd *hcd)
{
	return (struct vhci_hcd *) (hcd->hcd_priv);
}

static inline struct usb_hcd *vhci_to_hcd(struct vhci_hcd *vhci)
{
	return container_of((void *) vhci, struct usb_hcd, hcd_priv);
}

static inline struct device *vhci_dev(struct vhci_hcd *vhci)
{
	return vhci_to_hcd(vhci)->self.controller;
}

#endif /* __USBIP_VHCI_H */
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	*
04679b34 TH	9	*/
04679b34 TH	10
306dac69 TK	11	#ifndef __USBIP_VHCI_H
	12	#define __USBIP_VHCI_H
	13
7aaacb43	14	#include <linux/device.h>
	15	#include <linux/list.h>
	16	#include <linux/spinlock.h>
	17	#include <linux/sysfs.h>
	18	#include <linux/types.h>
	19	#include <linux/usb.h>
27729aad	20	#include <linux/usb/hcd.h>
7aaacb43	21	#include <linux/wait.h>
04679b34	22
04679b34 TH	23	struct vhci_device {
	24	struct usb_device *udev;
	25
	26	/*
	27	* devid specifies a remote usb device uniquely instead
	28	* of combination of busnum and devnum.
	29	*/
	30	__u32 devid;
	31
	32	/* speed of a remote device */
	33	enum usb_device_speed speed;
	34
ddbc9bc9	35	/* vhci root-hub port to which this device is attached */
04679b34 TH	36	__u32 rhport;
	37
	38	struct usbip_device ud;
	39
04679b34 TH	40	/* lock for the below link lists */
	41	spinlock_t priv_lock;
	42
	43	/* vhci_priv is linked to one of them. */
	44	struct list_head priv_tx;
	45	struct list_head priv_rx;
	46
	47	/* vhci_unlink is linked to one of them */
	48	struct list_head unlink_tx;
	49	struct list_head unlink_rx;
	50
	51	/* vhci_tx thread sleeps for this queue */
	52	wait_queue_head_t waitq_tx;
	53	};
	54
04679b34 TH	55	/* urb->hcpriv, use container_of() */
	56	struct vhci_priv {
	57	unsigned long seqnum;
	58	struct list_head list;
	59
	60	struct vhci_device *vdev;
	61	struct urb *urb;
	62	};
	63
04679b34 TH	64	struct vhci_unlink {
	65	/* seqnum of this request */
	66	unsigned long seqnum;
	67
	68	struct list_head list;
	69
	70	/* seqnum of the unlink target */
	71	unsigned long unlink_seqnum;
	72	};
	73
1132b9aa	74	/* Number of supported ports. Value has an upperbound of USB_MAXCHILDREN */
04679b34 TH	75	#define VHCI_NPORTS 8
	76
	77	/* for usb_bus.hcpriv */
	78	struct vhci_hcd {
ddbc9bc9	79	spinlock_t lock;
04679b34	80
ddbc9bc9	81	u32 port_status[VHCI_NPORTS];
04679b34	82
ddbc9bc9	83	unsigned resuming:1;
ddbc9bc9	84	unsigned long re_timeout;
04679b34 TH	85
	86	atomic_t seqnum;
	87
	88	/*
	89	* NOTE:
	90	* wIndex shows the port number and begins from 1.
	91	* But, the index of this array begins from 0.
	92	*/
	93	struct vhci_device vdev[VHCI_NPORTS];
04679b34 TH	94	};
04679b34 TH	95
04679b34	96	extern struct vhci_hcd *the_controller;
cf77acfc	97	extern const struct attribute_group dev_attr_group;
04679b34	98
04679b34 TH	99	/* vhci_hcd.c */
04679b34 TH	100	void rh_port_connect(int rhport, enum usb_device_speed speed);
04679b34	101
fc184a35	102	/* vhci_rx.c */
ddbc9bc9	103	struct urb pickup_urb_and_free_priv(struct vhci_device vdev, __u32 seqnum);
fc184a35	104	int vhci_rx_loop(void *data);
b92a5e23	105
fc184a35	106	/* vhci_tx.c */
fc184a35	107	int vhci_tx_loop(void *data);
04679b34 TH	108
	109	static inline struct vhci_device *port_to_vdev(__u32 port)
	110	{
	111	return &the_controller->vdev[port];
	112	}
	113
	114	static inline struct vhci_hcd hcd_to_vhci(struct usb_hcd hcd)
	115	{
	116	return (struct vhci_hcd *) (hcd->hcd_priv);
	117	}
	118
	119	static inline struct usb_hcd vhci_to_hcd(struct vhci_hcd vhci)
	120	{
	121	return container_of((void *) vhci, struct usb_hcd, hcd_priv);
	122	}
	123
	124	static inline struct device vhci_dev(struct vhci_hcd vhci)
	125	{
	126	return vhci_to_hcd(vhci)->self.controller;
	127	}
306dac69 TK	128
306dac69 TK	129	#endif /* __USBIP_VHCI_H */