USB: make hcd.h public (drivers dependency)

The usbcore headers: hcd.h and hub.h are shared between usbcore,
HCDs and a couple of other drivers (e.g. USBIP modules).
So, it makes sense to move them into a more public location and
to cleanup dependency of those modules on kernel internal headers.
This patch moves hcd.h from drivers/usb/core into include/linux/usb/

Signed-of-by: Eric Lescouet <eric@lescouet.org>
Cc: Alan Stern <stern@rowland.harvard.edu>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>

1 files changed, 578 insertions, 0 deletions

diff --git a/include/linux/usb/hcd.h b/include/linux/usb/hcd.h
new file mode 100644
index 000000000000..c7e575cb3149
--- /dev/null
+++ b/include/linux/usb/hcd.h
@@ -0,0 +1,578 @@
+/*
+ * Copyright (c) 2001-2002 by David Brownell
+ *
+ * This program 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 program 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., 675 Mass Ave, Cambridge, MA 02139, USA.
+ */
+
+#ifndef __USB_CORE_HCD_H
+#define __USB_CORE_HCD_H
+
+#ifdef __KERNEL__
+
+#include <linux/rwsem.h>
+
+#define MAX_TOPO_LEVEL          6
+
+/* This file contains declarations of usbcore internals that are mostly
+ * used or exposed by Host Controller Drivers.
+ */
+
+/*
+ * USB Packet IDs (PIDs)
+ */
+#define USB_PID_EXT                     0xf0    /* USB 2.0 LPM ECN */
+#define USB_PID_OUT                     0xe1
+#define USB_PID_ACK                     0xd2
+#define USB_PID_DATA0                   0xc3
+#define USB_PID_PING                    0xb4    /* USB 2.0 */
+#define USB_PID_SOF                     0xa5
+#define USB_PID_NYET                    0x96    /* USB 2.0 */
+#define USB_PID_DATA2                   0x87    /* USB 2.0 */
+#define USB_PID_SPLIT                   0x78    /* USB 2.0 */
+#define USB_PID_IN                      0x69
+#define USB_PID_NAK                     0x5a
+#define USB_PID_DATA1                   0x4b
+#define USB_PID_PREAMBLE                0x3c    /* Token mode */
+#define USB_PID_ERR                     0x3c    /* USB 2.0: handshake mode */
+#define USB_PID_SETUP                   0x2d
+#define USB_PID_STALL                   0x1e
+#define USB_PID_MDATA                   0x0f    /* USB 2.0 */
+
+/*-------------------------------------------------------------------------*/
+
+/*
+ * USB Host Controller Driver (usb_hcd) framework
+ *
+ * Since "struct usb_bus" is so thin, you can't share much code in it.
+ * This framework is a layer over that, and should be more sharable.
+ *
+ * @authorized_default: Specifies if new devices are authorized to
+ *                      connect by default or they require explicit
+ *                      user space authorization; this bit is settable
+ *                      through /sys/class/usb_host/X/authorized_default.
+ *                      For the rest is RO, so we don't lock to r/w it.
+ */
+
+/*-------------------------------------------------------------------------*/
+
+struct usb_hcd {
+
+        /*
+         * housekeeping
+         */
+        struct usb_bus          self;           /* hcd is-a bus */
+        struct kref             kref;           /* reference counter */
+
+        const char              *product_desc;  /* product/vendor string */
+        char                    irq_descr[24];  /* driver + bus # */
+
+        struct timer_list       rh_timer;       /* drives root-hub polling */
+        struct urb              *status_urb;    /* the current status urb */
+#ifdef CONFIG_USB_SUSPEND
+        struct work_struct      wakeup_work;    /* for remote wakeup */
+#endif
+
+        /*
+         * hardware info/state
+         */
+        const struct hc_driver  *driver;        /* hw-specific hooks */
+
+        /* Flags that need to be manipulated atomically */
+        unsigned long           flags;
+#define HCD_FLAG_HW_ACCESSIBLE  0x00000001
+#define HCD_FLAG_SAW_IRQ        0x00000002
+
+        unsigned                rh_registered:1;/* is root hub registered? */
+
+        /* The next flag is a stopgap, to be removed when all the HCDs
+         * support the new root-hub polling mechanism. */
+        unsigned                uses_new_polling:1;
+        unsigned                poll_rh:1;      /* poll for rh status? */
+        unsigned                poll_pending:1; /* status has changed? */
+        unsigned                wireless:1;     /* Wireless USB HCD */
+        unsigned                authorized_default:1;
+        unsigned                has_tt:1;       /* Integrated TT in root hub */
+
+        int                     irq;            /* irq allocated */
+        void __iomem            *regs;          /* device memory/io */
+        u64                     rsrc_start;     /* memory/io resource start */
+        u64                     rsrc_len;       /* memory/io resource length */
+        unsigned                power_budget;   /* in mA, 0 = no limit */
+
+        /* bandwidth_mutex should be taken before adding or removing
+         * any new bus bandwidth constraints:
+         *   1. Before adding a configuration for a new device.
+         *   2. Before removing the configuration to put the device into
+         *      the addressed state.
+         *   3. Before selecting a different configuration.
+         *   4. Before selecting an alternate interface setting.
+         *
+         * bandwidth_mutex should be dropped after a successful control message
+         * to the device, or resetting the bandwidth after a failed attempt.
+         */
+        struct mutex            bandwidth_mutex;
+
+
+#define HCD_BUFFER_POOLS        4
+        struct dma_pool         *pool [HCD_BUFFER_POOLS];
+
+        int                     state;
+#       define  __ACTIVE                0x01
+#       define  __SUSPEND               0x04
+#       define  __TRANSIENT             0x80
+
+#       define  HC_STATE_HALT           0
+#       define  HC_STATE_RUNNING        (__ACTIVE)
+#       define  HC_STATE_QUIESCING      (__SUSPEND|__TRANSIENT|__ACTIVE)
+#       define  HC_STATE_RESUMING       (__SUSPEND|__TRANSIENT)
+#       define  HC_STATE_SUSPENDED      (__SUSPEND)
+
+#define HC_IS_RUNNING(state) ((state) & __ACTIVE)
+#define HC_IS_SUSPENDED(state) ((state) & __SUSPEND)
+
+        /* more shared queuing code would be good; it should support
+         * smarter scheduling, handle transaction translators, etc;
+         * input size of periodic table to an interrupt scheduler.
+         * (ohci 32, uhci 1024, ehci 256/512/1024).
+         */
+
+        /* The HC driver's private data is stored at the end of
+         * this structure.
+         */
+        unsigned long hcd_priv[0]
+                        __attribute__ ((aligned(sizeof(unsigned long))));
+};
+
+/* 2.4 does this a bit differently ... */
+static inline struct usb_bus *hcd_to_bus(struct usb_hcd *hcd)
+{
+        return &hcd->self;
+}
+
+static inline struct usb_hcd *bus_to_hcd(struct usb_bus *bus)
+{
+        return container_of(bus, struct usb_hcd, self);
+}
+
+struct hcd_timeout {    /* timeouts we allocate */
+        struct list_head        timeout_list;
+        struct timer_list       timer;
+};
+
+/*-------------------------------------------------------------------------*/
+
+
+struct hc_driver {
+        const char      *description;   /* "ehci-hcd" etc */
+        const char      *product_desc;  /* product/vendor string */
+        size_t          hcd_priv_size;  /* size of private data */
+
+        /* irq handler */
+        irqreturn_t     (*irq) (struct usb_hcd *hcd);
+
+        int     flags;
+#define HCD_MEMORY      0x0001          /* HC regs use memory (else I/O) */
+#define HCD_LOCAL_MEM   0x0002          /* HC needs local memory */
+#define HCD_USB11       0x0010          /* USB 1.1 */
+#define HCD_USB2        0x0020          /* USB 2.0 */
+#define HCD_USB3        0x0040          /* USB 3.0 */
+#define HCD_MASK        0x0070
+
+        /* called to init HCD and root hub */
+        int     (*reset) (struct usb_hcd *hcd);