LXR linux/drivers/usb/usbip/stub.h

   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
  20#ifndef __USBIP_STUB_H
  21#define __USBIP_STUB_H
  22
  23#include <linux/list.h>
  24#include <linux/slab.h>
  25#include <linux/spinlock.h>
  26#include <linux/types.h>
  27#include <linux/usb.h>
  28#include <linux/wait.h>
  29
  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
  35struct stub_device {
  36        struct usb_device *udev;
  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
  61        wait_queue_head_t tx_waitq;
  62};
  63
  64/* private data into urb->priv */
  65struct 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
  74struct stub_unlink {
  75        unsigned long seqnum;
  76        struct list_head list;
  77        __u32 status;
  78};
  79
  80/* same as SYSFS_BUS_ID_SIZE */
  81#define BUSID_SIZE 32
  82
  83struct bus_id_priv {
  84        char name[BUSID_SIZE];
  85        char status;
  86        int interf_count;
  87        struct stub_device *sdev;
  88        struct usb_device *udev;
  89        char shutdown_busid;
  90};
  91
  92/* stub_priv is allocated from stub_priv_cache */
  93extern struct kmem_cache *stub_priv_cache;
  94
  95/* stub_dev.c */
  96extern struct usb_device_driver stub_driver;
  97
  98/* stub_main.c */
  99struct bus_id_priv *get_busid_priv(const char *busid);
 100int del_match_busid(char *busid);
 101void stub_device_cleanup_urbs(struct stub_device *sdev);
 102
 103/* stub_rx.c */
 104int stub_rx_loop(void *data);
 105
 106/* stub_tx.c */
 107void stub_enqueue_ret_unlink(struct stub_device *sdev, __u32 seqnum,
 108                             __u32 status);
 109void stub_complete(struct urb *urb);
 110int stub_tx_loop(void *data);
 111
 112#endif /* __USBIP_STUB_H */
 113