UbiquitousOS
/
OpenCloudOS-Kernel
mirror of https://gitee.com/OpenCloudOS/OpenCloudOS-Kernel.git
11
0
Fork 0
Code Issues Projects Releases Wiki Activity

USB: gadget: gadget zero cleanups 

Clean up gadget zero, using newer APIs and conventions:

 - gadget_is_dualspeed() and gadget_is_otg() ... #ifdef removal

 - Remove many now-needless #includes

 - Use the VERBOSE_DEBUG convention

 - Some whitespace fixes.

 - A few comment updates
 
 - Plus a few other small cleanups:  don't pass gfp_t around when it's
   always going to be GFP_ATOMIC, and do static init of serial number.

Also go to straight GPL; there's no real point in dual licensing this
stuff any more.

Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
This commit is contained in:
David Brownell 2007-08-02 12:20:05 -07:00 committed by Greg Kroah-Hartman
parent 2e806f67cc
commit ca2bdf4bcc
1 changed files with 96 additions and 141 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

237
drivers/usb/gadget/zero.c
View File

@ -1,38 +1,22 @@
/* /*
* zero.c -- Gadget Zero, for USB development * zero.c -- Gadget Zero, for USB development
* *
* Copyright (C) 2003-2004 David Brownell * Copyright (C) 2003-2007 David Brownell
* All rights reserved. * All rights reserved.
* *
* Redistribution and use in source and binary forms, with or without * This program is free software; you can redistribute it and/or modify
* modification, are permitted provided that the following conditions * it under the terms of the GNU General Public License as published by
* are met: * the Free Software Foundation; either version 2 of the License, or
* 1. Redistributions of source code must retain the above copyright * (at your option) any later version.
* notice, this list of conditions, and the following disclaimer,
* without modification.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. The names of the above-listed copyright holders may not be used
* to endorse or promote products derived from this software without
* specific prior written permission.
* *
* ALTERNATIVELY, this software may be distributed under the terms of the * This program is distributed in the hope that it will be useful,
* GNU General Public License ("GPL") as published by the Free Software * but WITHOUT ANY WARRANTY; without even the implied warranty of
* Foundation, either version 2 of that License or (at your option) any * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* later version. * GNU General Public License for more details.
* *
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS * You should have received a copy of the GNU General Public License
* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, * along with this program; if not, write to the Free Software
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/ */
@ -57,30 +41,18 @@
* Many drivers will only have one configuration, letting them be much * Many drivers will only have one configuration, letting them be much
* simpler if they also don't support high speed operation (like this * simpler if they also don't support high speed operation (like this
* driver does). * driver does).
*
* Why is *this* driver using two configurations, rather than setting up
* two interfaces with different functions? To help verify that multiple
* configuration infrastucture is working correctly; also, so that it can
* work with low capability USB controllers without four bulk endpoints.
*/ */
#define DEBUG 1 /* #define VERBOSE_DEBUG */
// #define VERBOSE
#include <linux/module.h>
#include <linux/kernel.h> #include <linux/kernel.h>
#include <linux/delay.h>
#include <linux/ioport.h>
#include <linux/slab.h>
#include <linux/errno.h>
#include <linux/init.h>
#include <linux/timer.h>
#include <linux/list.h>
#include <linux/interrupt.h>
#include <linux/utsname.h> #include <linux/utsname.h>
#include <linux/device.h> #include <linux/device.h>
#include <linux/moduleparam.h>
#include <asm/byteorder.h>
#include <asm/io.h>
#include <asm/irq.h>
#include <asm/system.h>
#include <asm/unaligned.h>
#include <linux/usb/ch9.h> #include <linux/usb/ch9.h>
#include <linux/usb_gadget.h> #include <linux/usb_gadget.h>
@ -90,7 +62,7 @@
/*-------------------------------------------------------------------------*/ /*-------------------------------------------------------------------------*/
#define DRIVER_VERSION "St Patrick's Day 2004" #define DRIVER_VERSION "Lughnasadh, 2007"
static const char shortname [] = "zero"; static const char shortname [] = "zero";
static const char longname [] = "Gadget Zero"; static const char longname [] = "Gadget Zero";
@ -131,30 +103,16 @@ struct zero_dev {
struct timer_list resume; struct timer_list resume;
}; };
#define xprintk(d,level,fmt,args...) \ #define DBG(d, fmt, args...) \
dev_printk(level , &(d)->gadget->dev , fmt , ## args) dev_dbg(&(d)->gadget->dev , fmt , ## args)
#define VDBG(d, fmt, args...) \
#ifdef DEBUG dev_vdbg(&(d)->gadget->dev , fmt , ## args)
#define DBG(dev,fmt,args...) \ #define ERROR(d, fmt, args...) \
xprintk(dev , KERN_DEBUG , fmt , ## args) dev_err(&(d)->gadget->dev , fmt , ## args)
#else #define WARN(d, fmt, args...) \
#define DBG(dev,fmt,args...) \ dev_warn(&(d)->gadget->dev , fmt , ## args)
do { } while (0) #define INFO(d, fmt, args...) \
#endif /* DEBUG */ dev_info(&(d)->gadget->dev , fmt , ## args)
#ifdef VERBOSE
#define VDBG DBG
#else
#define VDBG(dev,fmt,args...) \
do { } while (0)
#endif /* VERBOSE */
#define ERROR(dev,fmt,args...) \
xprintk(dev , KERN_ERR , fmt , ## args)
#define WARN(dev,fmt,args...) \
xprintk(dev , KERN_WARNING , fmt , ## args)
#define INFO(dev,fmt,args...) \
xprintk(dev , KERN_INFO , fmt , ## args)
/*-------------------------------------------------------------------------*/ /*-------------------------------------------------------------------------*/
@ -326,8 +284,6 @@ static const struct usb_descriptor_header *fs_loopback_function [] = {
NULL, NULL,
}; };
#ifdef CONFIG_USB_GADGET_DUALSPEED
/* /*
* usb 2.0 devices need to expose both high speed and full speed * usb 2.0 devices need to expose both high speed and full speed
* descriptors, unless they only run at full speed. * descriptors, unless they only run at full speed.
@ -383,17 +339,20 @@ static const struct usb_descriptor_header *hs_loopback_function [] = {
}; };
/* maxpacket and other transfer characteristics vary by speed. */ /* maxpacket and other transfer characteristics vary by speed. */
#define ep_desc(g,hs,fs) (((g)->speed==USB_SPEED_HIGH)?(hs):(fs)) static inline struct usb_endpoint_descriptor *
ep_desc(struct usb_gadget *g, struct usb_endpoint_descriptor *hs,
struct usb_endpoint_descriptor *fs)
{
if (gadget_is_dualspeed(g) && g->speed == USB_SPEED_HIGH)
return hs;
return fs;
}
#else static char manufacturer[50];
/* if there's no high speed support, maxpacket doesn't change. */ /* default serial number takes at least two packets */
#define ep_desc(g,hs,fs) fs static char serial[] = "0123456789.0123456789.0123456789";
#endif /* !CONFIG_USB_GADGET_DUALSPEED */
static char manufacturer [50];
static char serial [40];
/* static strings, in UTF-8 */ /* static strings, in UTF-8 */
static struct usb_string strings [] = { static struct usb_string strings [] = {
@ -435,30 +394,29 @@ config_buf (struct usb_gadget *gadget,
int is_source_sink; int is_source_sink;
int len; int len;
const struct usb_descriptor_header **function; const struct usb_descriptor_header **function;
#ifdef CONFIG_USB_GADGET_DUALSPEED int hs = 0;
int hs = (gadget->speed == USB_SPEED_HIGH);
#endif
/* two configurations will always be index 0 and index 1 */ /* two configurations will always be index 0 and index 1 */
if (index > 1) if (index > 1)
return -EINVAL; return -EINVAL;
is_source_sink = loopdefault ? (index == 1) : (index == 0); is_source_sink = loopdefault ? (index == 1) : (index == 0);
#ifdef CONFIG_USB_GADGET_DUALSPEED if (gadget_is_dualspeed(gadget)) {
if (type == USB_DT_OTHER_SPEED_CONFIG) hs = (gadget->speed == USB_SPEED_HIGH);
hs = !hs; if (type == USB_DT_OTHER_SPEED_CONFIG)
hs = !hs;
}
if (hs) if (hs)
function = is_source_sink function = is_source_sink
? hs_source_sink_function ? hs_source_sink_function
: hs_loopback_function; : hs_loopback_function;
else else
#endif
function = is_source_sink function = is_source_sink
? fs_source_sink_function ? fs_source_sink_function
: fs_loopback_function; : fs_loopback_function;
/* for now, don't advertise srp-only devices */ /* for now, don't advertise srp-only devices */
if (!gadget->is_otg) if (!gadget_is_otg(gadget))
function++; function++;
len = usb_gadget_config_buf (is_source_sink len = usb_gadget_config_buf (is_source_sink
@ -498,6 +456,19 @@ static void free_ep_req (struct usb_ep *ep, struct usb_request *req)
/*-------------------------------------------------------------------------*/ /*-------------------------------------------------------------------------*/
/*
* SOURCE/SINK FUNCTION ... a primary testing vehicle for USB peripherals,
* this just sinks bulk packets OUT to the peripheral and sources them IN
* to the host, optionally with specific data patterns.
*
* In terms of control messaging, this supports all the standard requests
* plus two that support control-OUT tests.
*
* Note that because this doesn't queue more than one request at a time,
* some other function must be used to test queueing logic. The network
* link (g_ether) is probably the best option for that.
*/
/* optionally require specific source/sink data patterns */ /* optionally require specific source/sink data patterns */
static int static int
@ -534,12 +505,7 @@ check_read_data (
return 0; return 0;
} }
static void static void reinit_write_data(struct usb_ep *ep, struct usb_request *req)
reinit_write_data (
struct zero_dev *dev,
struct usb_ep *ep,
struct usb_request *req
)
{ {
unsigned i; unsigned i;
u8 *buf = req->buf; u8 *buf = req->buf;
@ -566,16 +532,16 @@ static void source_sink_complete (struct usb_ep *ep, struct usb_request *req)
switch (status) { switch (status) {
case 0: /* normal completion? */ case 0: /* normal completion? */
if (ep == dev->out_ep) { if (ep == dev->out_ep) {
check_read_data (dev, ep, req); check_read_data (dev, ep, req);
memset (req->buf, 0x55, req->length); memset (req->buf, 0x55, req->length);
} else } else
reinit_write_data (dev, ep, req); reinit_write_data(ep, req);
break; break;
/* this endpoint is normally active while we're configured */ /* this endpoint is normally active while we're configured */
case -ECONNABORTED: /* hardware forced ep reset */ case -ECONNABORTED: /* hardware forced ep reset */
case -ECONNRESET: /* request dequeued */ case -ECONNRESET: /* request dequeued */
case -ESHUTDOWN: /* disconnect from host */ case -ESHUTDOWN: /* disconnect from host */
VDBG (dev, "%s gone (%d), %d/%d\n", ep->name, status, VDBG (dev, "%s gone (%d), %d/%d\n", ep->name, status,
@ -607,8 +573,7 @@ static void source_sink_complete (struct usb_ep *ep, struct usb_request *req)
} }
} }
static struct usb_request * static struct usb_request *source_sink_start_ep(struct usb_ep *ep)
source_sink_start_ep (struct usb_ep *ep, gfp_t gfp_flags)
{ {
struct usb_request *req; struct usb_request *req;
int status; int status;
@ -621,11 +586,11 @@ source_sink_start_ep (struct usb_ep *ep, gfp_t gfp_flags)
req->complete = source_sink_complete; req->complete = source_sink_complete;
if (strcmp (ep->name, EP_IN_NAME) == 0) if (strcmp (ep->name, EP_IN_NAME) == 0)
reinit_write_data (ep->driver_data, ep, req); reinit_write_data(ep, req);
else else
memset (req->buf, 0x55, req->length); memset (req->buf, 0x55, req->length);
status = usb_ep_queue (ep, req, gfp_flags); status = usb_ep_queue(ep, req, GFP_ATOMIC);
if (status) { if (status) {
struct zero_dev *dev = ep->driver_data; struct zero_dev *dev = ep->driver_data;
@ -637,8 +602,7 @@ source_sink_start_ep (struct usb_ep *ep, gfp_t gfp_flags)
return req; return req;
} }
static int static int set_source_sink_config(struct zero_dev *dev)
set_source_sink_config (struct zero_dev *dev, gfp_t gfp_flags)
{ {
int result = 0; int result = 0;
struct usb_ep *ep; struct usb_ep *ep;
@ -653,8 +617,7 @@ set_source_sink_config (struct zero_dev *dev, gfp_t gfp_flags)
result = usb_ep_enable (ep, d); result = usb_ep_enable (ep, d);
if (result == 0) { if (result == 0) {
ep->driver_data = dev; ep->driver_data = dev;
if (source_sink_start_ep(ep, gfp_flags) if (source_sink_start_ep(ep) != NULL) {
!= NULL) {
dev->in_ep = ep; dev->in_ep = ep;
continue; continue;
} }
@ -668,8 +631,7 @@ set_source_sink_config (struct zero_dev *dev, gfp_t gfp_flags)
result = usb_ep_enable (ep, d); result = usb_ep_enable (ep, d);
if (result == 0) { if (result == 0) {
ep->driver_data = dev; ep->driver_data = dev;
if (source_sink_start_ep(ep, gfp_flags) if (source_sink_start_ep(ep) != NULL) {
!= NULL) {
dev->out_ep = ep; dev->out_ep = ep;
continue; continue;
} }
@ -701,7 +663,7 @@ static void loopback_complete (struct usb_ep *ep, struct usb_request *req)
switch (status) { switch (status) {
case 0: /* normal completion? */ case 0: /* normal completion? */
if (ep == dev->out_ep) { if (ep == dev->out_ep) {
/* loop this OUT packet back IN to the host */ /* loop this OUT packet back IN to the host */
req->zero = (req->actual < req->length); req->zero = (req->actual < req->length);
@ -735,7 +697,7 @@ static void loopback_complete (struct usb_ep *ep, struct usb_request *req)
* rely on the hardware driver to clean up on disconnect or * rely on the hardware driver to clean up on disconnect or
* endpoint disable. * endpoint disable.
*/ */
case -ECONNABORTED: /* hardware forced ep reset */ case -ECONNABORTED: /* hardware forced ep reset */
case -ECONNRESET: /* request dequeued */ case -ECONNRESET: /* request dequeued */
case -ESHUTDOWN: /* disconnect from host */ case -ESHUTDOWN: /* disconnect from host */
free_ep_req (ep, req); free_ep_req (ep, req);
@ -743,8 +705,7 @@ static void loopback_complete (struct usb_ep *ep, struct usb_request *req)
} }
} }
static int static int set_loopback_config(struct zero_dev *dev)
set_loopback_config (struct zero_dev *dev, gfp_t gfp_flags)
{ {
int result = 0; int result = 0;
struct usb_ep *ep; struct usb_ep *ep;
@ -844,8 +805,7 @@ static void zero_reset_config (struct zero_dev *dev)
* code can do, perhaps by disallowing more than one configuration or * code can do, perhaps by disallowing more than one configuration or
* by limiting configuration choices (like the pxa2xx). * by limiting configuration choices (like the pxa2xx).
*/ */
static int static int zero_set_config(struct zero_dev *dev, unsigned number)
zero_set_config (struct zero_dev *dev, unsigned number, gfp_t gfp_flags)
{ {
int result = 0; int result = 0;
struct usb_gadget *gadget = dev->gadget; struct usb_gadget *gadget = dev->gadget;
@ -855,17 +815,17 @@ zero_set_config (struct zero_dev *dev, unsigned number, gfp_t gfp_flags)
if (gadget_is_sa1100 (gadget) && dev->config) { if (gadget_is_sa1100 (gadget) && dev->config) {
/* tx fifo is full, but we can't clear it...*/ /* tx fifo is full, but we can't clear it...*/
INFO (dev, "can't change configurations\n"); ERROR(dev, "can't change configurations\n");
return -ESPIPE; return -ESPIPE;
} }
zero_reset_config (dev); zero_reset_config (dev);
switch (number) { switch (number) {
case CONFIG_SOURCE_SINK: case CONFIG_SOURCE_SINK:
result = set_source_sink_config (dev, gfp_flags); result = set_source_sink_config(dev);
break; break;
case CONFIG_LOOPBACK: case CONFIG_LOOPBACK:
result = set_loopback_config (dev, gfp_flags); result = set_loopback_config(dev);
break; break;
default: default:
result = -EINVAL; result = -EINVAL;
@ -885,7 +845,7 @@ zero_set_config (struct zero_dev *dev, unsigned number, gfp_t gfp_flags)
case USB_SPEED_LOW: speed = "low"; break; case USB_SPEED_LOW: speed = "low"; break;
case USB_SPEED_FULL: speed = "full"; break; case USB_SPEED_FULL: speed = "full"; break;
case USB_SPEED_HIGH: speed = "high"; break; case USB_SPEED_HIGH: speed = "high"; break;
default: speed = "?"; break; default: speed = "?"; break;
} }
dev->config = number; dev->config = number;
@ -938,19 +898,17 @@ zero_setup (struct usb_gadget *gadget, const struct usb_ctrlrequest *ctrl)
value = min (w_length, (u16) sizeof device_desc); value = min (w_length, (u16) sizeof device_desc);
memcpy (req->buf, &device_desc, value); memcpy (req->buf, &device_desc, value);
break; break;
#ifdef CONFIG_USB_GADGET_DUALSPEED
case USB_DT_DEVICE_QUALIFIER: case USB_DT_DEVICE_QUALIFIER:
if (!gadget->is_dualspeed) if (!gadget_is_dualspeed(gadget))
break; break;
value = min (w_length, (u16) sizeof dev_qualifier); value = min (w_length, (u16) sizeof dev_qualifier);
memcpy (req->buf, &dev_qualifier, value); memcpy (req->buf, &dev_qualifier, value);
break; break;
case USB_DT_OTHER_SPEED_CONFIG: case USB_DT_OTHER_SPEED_CONFIG:
if (!gadget->is_dualspeed) if (!gadget_is_dualspeed(gadget))
break; break;
// FALLTHROUGH // FALLTHROUGH
#endif /* CONFIG_USB_GADGET_DUALSPEED */
case USB_DT_CONFIG: case USB_DT_CONFIG:
value = config_buf (gadget, req->buf, value = config_buf (gadget, req->buf,
w_value >> 8, w_value >> 8,
@ -984,7 +942,7 @@ zero_setup (struct usb_gadget *gadget, const struct usb_ctrlrequest *ctrl)
else else
VDBG (dev, "HNP inactive\n"); VDBG (dev, "HNP inactive\n");
spin_lock (&dev->lock); spin_lock (&dev->lock);
value = zero_set_config (dev, w_value, GFP_ATOMIC); value = zero_set_config(dev, w_value);
spin_unlock (&dev->lock); spin_unlock (&dev->lock);
break; break;
case USB_REQ_GET_CONFIGURATION: case USB_REQ_GET_CONFIGURATION:
@ -1013,7 +971,7 @@ zero_setup (struct usb_gadget *gadget, const struct usb_ctrlrequest *ctrl)
* use this "reset the config" shortcut. * use this "reset the config" shortcut.
*/ */
zero_reset_config (dev); zero_reset_config (dev);
zero_set_config (dev, config, GFP_ATOMIC); zero_set_config(dev, config);
value = 0; value = 0;
} }
spin_unlock (&dev->lock); spin_unlock (&dev->lock);
@ -1163,7 +1121,7 @@ autoconf_fail:
} }
EP_IN_NAME = ep->name; EP_IN_NAME = ep->name;
ep->driver_data = ep; /* claim */ ep->driver_data = ep; /* claim */
ep = usb_ep_autoconfig (gadget, &fs_sink_desc); ep = usb_ep_autoconfig (gadget, &fs_sink_desc);
if (!ep) if (!ep)
goto autoconf_fail; goto autoconf_fail;
@ -1207,16 +1165,18 @@ autoconf_fail:
device_desc.bMaxPacketSize0 = gadget->ep0->maxpacket; device_desc.bMaxPacketSize0 = gadget->ep0->maxpacket;
#ifdef CONFIG_USB_GADGET_DUALSPEED if (gadget_is_dualspeed(gadget)) {
/* assume ep0 uses the same value for both speeds ... */ /* assume ep0 uses the same value for both speeds ... */
dev_qualifier.bMaxPacketSize0 = device_desc.bMaxPacketSize0; dev_qualifier.bMaxPacketSize0 = device_desc.bMaxPacketSize0;
/* and that all endpoints are dual-speed */ /* and that all endpoints are dual-speed */
hs_source_desc.bEndpointAddress = fs_source_desc.bEndpointAddress; hs_source_desc.bEndpointAddress =
hs_sink_desc.bEndpointAddress = fs_sink_desc.bEndpointAddress; fs_source_desc.bEndpointAddress;
#endif hs_sink_desc.bEndpointAddress =
fs_sink_desc.bEndpointAddress;
}
if (gadget->is_otg) { if (gadget_is_otg(gadget)) {
otg_descriptor.bmAttributes |= USB_OTG_HNP, otg_descriptor.bmAttributes |= USB_OTG_HNP,
source_sink_config.bmAttributes |= USB_CONFIG_ATT_WAKEUP; source_sink_config.bmAttributes |= USB_CONFIG_ATT_WAKEUP;
loopback_config.bmAttributes |= USB_CONFIG_ATT_WAKEUP; loopback_config.bmAttributes |= USB_CONFIG_ATT_WAKEUP;
@ -1294,23 +1254,18 @@ static struct usb_gadget_driver zero_driver = {
.suspend = zero_suspend, .suspend = zero_suspend,
.resume = zero_resume, .resume = zero_resume,
.driver = { .driver = {
.name = (char *) shortname, .name = (char *) shortname,
.owner = THIS_MODULE, .owner = THIS_MODULE,
}, },
}; };
MODULE_AUTHOR ("David Brownell"); MODULE_AUTHOR("David Brownell");
MODULE_LICENSE ("Dual BSD/GPL"); MODULE_LICENSE("GPL");
static int __init init (void) static int __init init (void)
{ {
/* a real value would likely come through some id prom
* or module option. this one takes at least two packets.
*/
strlcpy (serial, "0123456789.0123456789.0123456789", sizeof serial);
return usb_gadget_register_driver (&zero_driver); return usb_gadget_register_driver (&zero_driver);
} }
module_init (init); module_init (init);