]> pilppa.com Git - linux-2.6-omap-h63xx.git/commitdiff
musb_hdrc cleanup -- comments, dates
authorDavid Brownell <david-b@pacbell.net>
Sat, 25 Aug 2007 21:41:49 +0000 (14:41 -0700)
committerTony Lindgren <tony@atomide.com>
Mon, 27 Aug 2007 07:04:46 +0000 (00:04 -0700)
Clarify dates in comments ... they are from 2006.  Drop reference
to the Mentor "2.2a" code base; it's not remotely relevant any more.

Also fix up a few comments, and remove a few "sparse" warnings,
mostly on DaVinci.

Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
13 files changed:
drivers/usb/musb/cppi_dma.c
drivers/usb/musb/cppi_dma.h
drivers/usb/musb/davinci.c
drivers/usb/musb/davinci.h
drivers/usb/musb/musb_core.c
drivers/usb/musb/musb_gadget.c
drivers/usb/musb/musb_gadget_ep0.c
drivers/usb/musb/musb_host.c
drivers/usb/musb/musb_host.h
drivers/usb/musb/musb_io.h
drivers/usb/musb/musb_procfs.c
drivers/usb/musb/musb_virthub.c
drivers/usb/musb/musbhsdma.c

index 297baa757bb0ebf68b107f611e2e29d3565c34bc..e2637f6c4eb640aca692d9225b38bb788dcd5e8f 100644 (file)
@@ -3,7 +3,7 @@
  *
  * This file implements a DMA  interface using TI's CPPI DMA.
  * For now it's DaVinci-only, but CPPI isn't specific to DaVinci or USB.
- * TUSB 6010 over VLYNQ has CPPI that looks much like DaVinci.
+ * The TUSB6020, using VLYNQ, has CPPI that looks much like DaVinci.
  */
 
 #include <linux/usb.h>
 #include "cppi_dma.h"
 
 
-/* CPPI DMA status 7-mar:
+/* CPPI DMA status 7-mar-2006:
  *
  * - See musb_{host,gadget}.c for more info
  *
  * - Correct RX DMA generally forces the engine into irq-per-packet mode,
  *   which can easily saturate the CPU under non-mass-storage loads.
  *
- * NOTES 24-aug (2.6.18-rc4):
+ * NOTES 24-aug-2006 (2.6.18-rc4):
  *
  * - peripheral RXDMA wedged in a test with packets of length 512/512/1.
  *   evidently after the 1 byte packet was received and acked, the queue
@@ -539,7 +539,7 @@ static inline int cppi_autoreq_update(struct cppi_channel *rx,
  * ========
  * TX is a lot more reasonable than RX; it doesn't need to run in
  * irq-per-packet mode very often.  RNDIS mode seems to behave too
- * (other how it handles the exactly-N-packets case).  Building a
+ * (except how it handles the exactly-N-packets case).  Building a
  * txdma queue with multiple requests (urb or usb_request) looks
  * like it would work ... but fault handling would need much testing.
  *
index 6e6e09cdd842b59826f9a4c4281f9d9372c002ad..74218e6edcf979ed188d14c1baa3b98719ff748f 100644 (file)
@@ -48,19 +48,14 @@ struct cppi_descriptor {
 
 struct cppi;
 
-/**
- *  Channel Control Structure
- *
- * CPPI  Channel Control structure. Using he same for Tx/Rx. If need be
- * derive out of this later.
- */
+/* CPPI  Channel Control structure */
 struct cppi_channel {
        /* First field must be dma_channel for easy type casting
         * FIXME just use container_of() and be typesafe instead!
         */
        struct dma_channel Channel;
 
-       /* back pointer to the Dma Controller structure */
+       /* back pointer to the DMA Controller structure */
        struct cppi             *controller;
 
        /* which direction of which endpoint? */
@@ -92,12 +87,7 @@ struct cppi_channel {
        struct list_head        tx_complete;
 };
 
-/**
- *  CPPI Dma Controller Object
- *
- *  CPPI Dma controller object.Encapsulates all bookeeping and Data
- *  structures pertaining to the CPPI Dma Controller.
- */
+/* CPPI DMA controller object */
 struct cppi {
        struct dma_controller           Controller;
        struct musb                     *musb;
index 85300dd809107015616e41d373688c1837a5bd02..3477800e3d475b759cfd9891f2cc46df582de8e5 100644 (file)
@@ -57,8 +57,9 @@ static inline void phy_on(void)
 {
        /* start the on-chip PHY and its PLL */
        __raw_writel(USBPHY_SESNDEN | USBPHY_VBDTCTEN | USBPHY_PHYPLLON,
-                       IO_ADDRESS(USBPHY_CTL_PADDR));
-       while ((__raw_readl(IO_ADDRESS(USBPHY_CTL_PADDR))
+                       (void __force __iomem *) IO_ADDRESS(USBPHY_CTL_PADDR));
+       while ((__raw_readl((void __force __iomem *)
+                               IO_ADDRESS(USBPHY_CTL_PADDR))
                        & USBPHY_PHYCLKGD) == 0)
                cpu_relax();
 }
@@ -66,7 +67,7 @@ static inline void phy_on(void)
 static inline void phy_off(void)
 {
        /* powerdown the on-chip PHY and its oscillator */
-       __raw_writel(USBPHY_OSCPDWN | USBPHY_PHYPDWN,
+       __raw_writel(USBPHY_OSCPDWN | USBPHY_PHYPDWN, (void __force __iomem *)
                        IO_ADDRESS(USBPHY_CTL_PADDR));
 }
 
@@ -149,7 +150,7 @@ static void evm_deferred_drvvbus(struct work_struct *ignored)
        davinci_i2c_expander_op(0x3a, USB_DRVVBUS, vbus_state);
        vbus_state = !vbus_state;
 }
-DECLARE_WORK(evm_vbus_work, evm_deferred_drvvbus);
+static DECLARE_WORK(evm_vbus_work, evm_deferred_drvvbus);
 
 #endif /* modified board */
 #endif /* EVM */
@@ -189,7 +190,7 @@ static void davinci_source_power(struct musb *musb, int is_on, int immediate)
 static void davinci_set_vbus(struct musb *musb, int is_on)
 {
        WARN_ON(is_on && is_peripheral_active(musb));
-       return davinci_source_power(musb, is_on, 0);
+       davinci_source_power(musb, is_on, 0);
 }
 
 
@@ -200,7 +201,7 @@ static struct timer_list otg_workaround;
 static void otg_timer(unsigned long _musb)
 {
        struct musb             *musb = (void *)_musb;
-       void    *__iomem        mregs = musb->mregs;
+       void __iomem            *mregs = musb->mregs;
        u8                      devctl;
        unsigned long           flags;
 
@@ -260,7 +261,7 @@ static irqreturn_t davinci_interrupt(int irq, void *__hci)
        unsigned long   flags;
        irqreturn_t     retval = IRQ_NONE;
        struct musb     *musb = __hci;
-       void            *__iomem tibase = musb->ctrl_base;
+       void __iomem    *tibase = musb->ctrl_base;
        u32             tmp;
 
        spin_lock_irqsave(&musb->lock, flags);
@@ -309,7 +310,7 @@ static irqreturn_t davinci_interrupt(int irq, void *__hci)
         */
        if (tmp & (DAVINCI_INTR_DRVVBUS << DAVINCI_USB_USBINT_SHIFT)) {
                int     drvvbus = musb_readl(tibase, DAVINCI_USB_STAT_REG);
-               void    *__iomem mregs = musb->mregs;
+               void __iomem *mregs = musb->mregs;
                u8      devctl = musb_readb(mregs, MUSB_DEVCTL);
                int     err = musb->int_usb & MUSB_INTR_VBUSERROR;
 
@@ -322,7 +323,7 @@ static irqreturn_t davinci_interrupt(int irq, void *__hci)
                         * to get VBUS errors during enumeration.
                         *
                         * This is a workaround, but newer RTL from Mentor
-                        * seems to lalow a better one: "re"starting sessions
+                        * seems to allow a better one: "re"starting sessions
                         * without waiting (on EVM, a **long** time) for VBUS
                         * to stop registering in devctl.
                         */
@@ -378,8 +379,8 @@ static irqreturn_t davinci_interrupt(int irq, void *__hci)
 
 int __init musb_platform_init(struct musb *musb)
 {
-       void    *__iomem tibase = musb->ctrl_base;
-       u32     revision;
+       void __iomem    *tibase = musb->ctrl_base;
+       u32             revision;
 
        musb->mregs += DAVINCI_BASE_OFFSET;
 #if 0
@@ -416,8 +417,8 @@ int __init musb_platform_init(struct musb *musb)
 
        /* NOTE:  irqs are in mixed mode, not bypass to pure-musb */
        pr_debug("DaVinci OTG revision %08x phy %03x control %02x\n",
-               revision,
-               __raw_readl((void *__iomem) IO_ADDRESS(USBPHY_CTL_PADDR)),
+               revision, __raw_readl((void __force __iomem *)
+                               IO_ADDRESS(USBPHY_CTL_PADDR)),
                musb_readb(tibase, DAVINCI_USB_CTRL_REG));
 
        musb->isr = davinci_interrupt;
index d2cadae169f4eb8db2e0fd05eb65c87e0e1e182b..2dcb7cd4839925780b7fa684a6763b1b33e8aec7 100644 (file)
@@ -76,7 +76,7 @@
 #define DAVINCI_DMA_ALL_CHANNELS_ENABLE        0xF
 #define DAVINCI_DMA_ALL_CHANNELS_DISABLE 0xF
 
-/* REVISIT relying on "volatile" here is wrong ... */
+/* FIXME relying on "volatile" here is wrong ... */
 
 /* define structures of Rx/Tx stateRam entries */
 struct cppi_tx_stateram {
index 078e8856970f75114f6918ad1caaf375e4126b36..253288044ca691887e6de210641aafcae0c632d2 100644 (file)
@@ -135,7 +135,7 @@ const char *otg_state_string(struct musb *musb)
 #define DRIVER_AUTHOR "Mentor Graphics, Texas Instruments, Nokia"
 #define DRIVER_DESC "Inventra Dual-Role USB Controller Driver"
 
-#define MUSB_VERSION_BASE "2.2a/db-0.5.2"
+#define MUSB_VERSION_BASE "6.0"
 
 #ifndef MUSB_VERSION_SUFFIX
 #define MUSB_VERSION_SUFFIX    ""
index 544bfa2f22df5d3795f53a5f7e58a85a1a93e65d..0fb963578017993375be8a6dbfb94f45cb1126a6 100644 (file)
@@ -46,7 +46,7 @@
 #include "musb_core.h"
 
 
-/* MUSB PERIPHERAL status 3-mar:
+/* MUSB PERIPHERAL status 3-mar-2006:
  *
  * - EP0 seems solid.  It passes both USBCV and usbtest control cases.
  *   Minor glitches:
@@ -88,9 +88,7 @@
  *     + TUSB 6010, platform-specific dma in the works
  */
 
-/**************************************************************************
-Handling completion
-**************************************************************************/
+/* ----------------------------------------------------------------------- */
 
 /*
  * Immediately complete a request.
@@ -192,9 +190,9 @@ static void nuke(struct musb_ep *ep, const int status)
        }
 }
 
-/**************************************************************************
- * TX/IN and RX/OUT Data transfers
- **************************************************************************/
+/* ----------------------------------------------------------------------- */
+
+/* Data transfers - pure PIO, pure DMA, or mixed mode */
 
 /*
  * This assumes the separate CPPI engine is responding to DMA requests
@@ -1377,7 +1375,7 @@ static const struct usb_ep_ops musb_ep_ops = {
        .fifo_flush     = musb_gadget_fifo_flush
 };
 
-/***********************************************************************/
+/* ----------------------------------------------------------------------- */
 
 static int musb_gadget_get_frame(struct usb_gadget *gadget)
 {
@@ -1532,9 +1530,9 @@ static const struct usb_gadget_ops musb_gadget_operations = {
        .pullup                 = musb_gadget_pullup,
 };
 
-/****************************************************************
- * Registration operations
- ****************************************************************/
+/* ----------------------------------------------------------------------- */
+
+/* Registration */
 
 /* Only this registration code "knows" the rule (from USB standards)
  * about there being only one external upstream port.  It assumes
@@ -1869,7 +1867,7 @@ int usb_gadget_unregister_driver(struct usb_gadget_driver *driver)
 EXPORT_SYMBOL(usb_gadget_unregister_driver);
 
 
-/***********************************************************************/
+/* ----------------------------------------------------------------------- */
 
 /* lifecycle operations called through plat_uds.c */
 
index 78e2f892b59dc5db1bd7d3ec5d6bb96c7c2b578e..35293598dc5539ba3ebb1ef288c5aeb5f338a9e5 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * MUSB OTG driver ep0 handling
+ * MUSB OTG peripheral driver ep0 handling
  *
  * Copyright 2005 Mentor Graphics Corporation
  * Copyright (C) 2005-2006 by Texas Instruments
@@ -978,6 +978,4 @@ const struct usb_ep_ops musb_g_ep0_ops = {
        .queue          = musb_g_ep0_queue,
        .dequeue        = musb_g_ep0_dequeue,
        .set_halt       = musb_g_ep0_halt,
-       .fifo_status    = NULL,
-       .fifo_flush     = NULL,
 };
index 398f70afeb0b8e193d216aa8f8253e2dca829d31..79518ae955dd7f7ecafbeb35188e522180bc68a7 100644 (file)
@@ -72,7 +72,7 @@
  *
  * - Not tested with HNP, but some SRP paths seem to behave.
  *
- * NOTE 24-August:
+ * NOTE 24-August-2006:
  *
  * - Bulk traffic finally uses both sides of hardware ep1, freeing up an
  *   extra endpoint for periodic use enabling hub + keybd + mouse.  That
  */
 
 
-/*************************** Forwards ***************************/
-
 static void musb_ep_program(struct musb *musb, u8 epnum,
                        struct urb *urb, unsigned int nOut,
                        u8 * buf, u32 len);
@@ -685,8 +683,6 @@ static void musb_ep_program(struct musb *musb, u8 epnum,
 
                /* general endpoint setup */
                if (epnum) {
-                       u16     csr = csr;
-
                        /* ASSERT:  TXCSR_DMAENAB was already cleared */
 
                        /* flush all old state, set default */
index 0f41b46dfe38e73573daf58962fe62f7a3a6815b..d7f546f17428d225704af96fc43a22a7d11dfe6a 100644 (file)
@@ -46,8 +46,7 @@ static inline struct musb *hcd_to_musb(struct usb_hcd *hcd)
        return (void *) hcd->hcd_priv;
 }
 
-/* stored in "usb_host_endpoint.hcpriv" for scheduled endpoints
- */
+/* stored in "usb_host_endpoint.hcpriv" for scheduled endpoints */
 struct musb_qh {
        struct usb_host_endpoint *hep;          /* usbcore info */
        struct usb_device       *dev;
index 5decdbe7f8df7da640740b9cddc816455cb034de..9d06ed755bafca9002363106cc07dd115d305926 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * MUSB OTG driver Linux-specific architecture defines
+ * MUSB OTG driver register I/O
  *
  * Copyright 2005 Mentor Graphics Corporation
  * Copyright (C) 2005-2006 by Texas Instruments
index 5e632320c9cf815f99d182f612b6d2424b3158f5..ca53d13797d30629c8fecbbbefde7d54da7d14b7 100644 (file)
  *
  */
 
-/*
- * Inventra Controller Driver (ICD) for Linux.
- *
- * The code managing debug files (currently in procfs).
- */
-
 #include <linux/kernel.h>
 #include <linux/proc_fs.h>
 #include <linux/seq_file.h>
@@ -478,7 +472,7 @@ dump_end_info(struct musb *musb, u8 epnum, char *aBuffer, unsigned max)
        return buf - aBuffer;
 }
 
-/** Dump the current status and compile options.
+/* Dump the current status and compile options.
  * @param musb the device driver instance
  * @param buffer where to dump the status; it must be big enough hold the
  * result otherwise "BAD THINGS HAPPENS(TM)".
@@ -537,7 +531,7 @@ static int dump_header_stats(struct musb *musb, char *buffer)
 
 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
        code = sprintf(buffer, "Peripheral address: %02x\n",
-                       musb_readb(musb, MUSB_FADDR));
+                       musb_readb(musb->ctrl_base, MUSB_FADDR));
        if (code <= 0)
                goto done;
        buffer += code;
@@ -560,7 +554,8 @@ static int dump_header_stats(struct musb *musb, char *buffer)
                        "\n",
                        musb_readl(musb->ctrl_base, DAVINCI_USB_CTRL_REG),
                        musb_readl(musb->ctrl_base, DAVINCI_USB_STAT_REG),
-                       __raw_readl(IO_ADDRESS(USBPHY_CTL_PADDR)),
+                       __raw_readl((void __force __iomem *)
+                                       IO_ADDRESS(USBPHY_CTL_PADDR)),
                        musb_readl(musb->ctrl_base, DAVINCI_RNDIS_REG),
                        musb_readl(musb->ctrl_base, DAVINCI_AUTOREQ_REG),
                        musb_readl(musb->ctrl_base,
index 618d8a558166544c4c1aafb798b5d1aff1591be6..b123d8e6250f6884cc892832f2a7d52c747e31a7 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * MUSB OTG driver virtual hub support
+ * MUSB OTG driver virtual root hub support
  *
  * Copyright 2005 Mentor Graphics Corporation
  * Copyright (C) 2005-2006 by Texas Instruments
index 71690e52df1b379dd0b89a3ccb1fa20b95b05bd9..a45c1c0b099c69fb5ebdc171bdcfd1ba824f8727 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * MUSB OTG driver internal DMA controller support
+ * MUSB OTG driver - support for Mentor's DMA controller
  *
  * Copyright 2005 Mentor Graphics Corporation
  * Copyright (C) 2005-2007 by Texas Instruments
  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  *
  */
-
-/*
- * Implementation for the DMA controller within the MUSBMHDRC.
- */
-
 #include <linux/device.h>
 #include <linux/interrupt.h>
 #include <linux/platform_device.h>