* [U-Boot] [RESEND PATCH 0/5] usb:udc:composite: Samsung's UDC cleanup and composite gadget implementation
@ 2012-05-02 11:11 Lukasz Majewski
2012-05-02 11:11 ` [U-Boot] [RESEND PATCH 1/5] usb:udc: Remove duplicated USB definitions from include/linux/usb/ch9.h file Lukasz Majewski
` (4 more replies)
0 siblings, 5 replies; 9+ messages in thread
From: Lukasz Majewski @ 2012-05-02 11:11 UTC (permalink / raw)
To: u-boot
This patch serie has been created as a combination of several patches previously
sent to u-boot mailing list:
- Duplicated USB code has been removed.
- Samsung's UDC driver has been cleaned up -> DEBUG_ macros have been replaced
with debug_cond() calls.
- Version v4. of composite gadget implementation for u-boot.
Those patches have been rebased on top of u-boot-usb/master.
Lukasz Majewski (5):
usb:udc: Remove duplicated USB definitions from
include/linux/usb/ch9.h file
usb:udc:samsung:cleanup Replace DEBUG_* macros with debug_cond()
calls
usb:gadget:composite USB composite gadget support
usb:gadget:composite: Support for composite at gadget.h
usb:udc:samsung Add functions for storing private gadget data in UDC
driver
drivers/usb/gadget/composite.c | 1082 +++++++++++++++++++++++++++++
drivers/usb/gadget/config.c | 1 +
drivers/usb/gadget/epautoconf.c | 1 +
drivers/usb/gadget/ether.c | 1 +
drivers/usb/gadget/s3c_udc_otg.c | 53 +-
drivers/usb/gadget/s3c_udc_otg_xfer_dma.c | 287 +++++---
drivers/usb/gadget/usbstring.c | 1 +
include/linux/usb/ch9.h | 67 --
include/linux/usb/composite.h | 350 ++++++++++
include/linux/usb/gadget.h | 6 +
include/usb/lin_gadget_compat.h | 24 +-
include/usb/s3c_udc.h | 49 +--
12 files changed, 1668 insertions(+), 254 deletions(-)
create mode 100644 drivers/usb/gadget/composite.c
create mode 100644 include/linux/usb/composite.h
--
1.7.2.3
^ permalink raw reply [flat|nested] 9+ messages in thread* [U-Boot] [RESEND PATCH 1/5] usb:udc: Remove duplicated USB definitions from include/linux/usb/ch9.h file 2012-05-02 11:11 [U-Boot] [RESEND PATCH 0/5] usb:udc:composite: Samsung's UDC cleanup and composite gadget implementation Lukasz Majewski @ 2012-05-02 11:11 ` Lukasz Majewski 2012-05-02 11:11 ` [U-Boot] [RESEND PATCH 2/5] usb:udc:samsung:cleanup Replace DEBUG_* macros with debug_cond() calls Lukasz Majewski ` (3 subsequent siblings) 4 siblings, 0 replies; 9+ messages in thread From: Lukasz Majewski @ 2012-05-02 11:11 UTC (permalink / raw) To: u-boot Remove the repeated USB descriptor code and use usbdescriptors.h file. ch9.h file has been copied from linux and is needed for USB gadget related work. Now usbdescriptors.h and ch9.h shall be used together. Signed-off-by: Lukasz Majewski <l.majewski@samsung.com> Signed-off-by: Kyungmin Park <kyungmin.park@samsung.com> Cc: Marek Vasut <marex@denx.de> --- drivers/usb/gadget/config.c | 1 + drivers/usb/gadget/epautoconf.c | 1 + drivers/usb/gadget/ether.c | 1 + drivers/usb/gadget/s3c_udc_otg.c | 1 + drivers/usb/gadget/usbstring.c | 1 + include/linux/usb/ch9.h | 67 -------------------------------------- include/usb/s3c_udc.h | 1 + 7 files changed, 6 insertions(+), 67 deletions(-) diff --git a/drivers/usb/gadget/config.c b/drivers/usb/gadget/config.c index f9163a8..f88d0c1 100644 --- a/drivers/usb/gadget/config.c +++ b/drivers/usb/gadget/config.c @@ -27,6 +27,7 @@ #include <linux/string.h> #include <linux/usb/ch9.h> +#include <usbdescriptors.h> #include <linux/usb/gadget.h> diff --git a/drivers/usb/gadget/epautoconf.c b/drivers/usb/gadget/epautoconf.c index 5b8776e..b656c8b 100644 --- a/drivers/usb/gadget/epautoconf.c +++ b/drivers/usb/gadget/epautoconf.c @@ -23,6 +23,7 @@ #include <common.h> #include <linux/usb/ch9.h> +#include <usbdescriptors.h> #include <asm/errno.h> #include <linux/usb/gadget.h> #include <asm/unaligned.h> diff --git a/drivers/usb/gadget/ether.c b/drivers/usb/gadget/ether.c index 9fb0e80..f693fea 100644 --- a/drivers/usb/gadget/ether.c +++ b/drivers/usb/gadget/ether.c @@ -24,6 +24,7 @@ #include <asm/errno.h> #include <linux/netdevice.h> #include <linux/usb/ch9.h> +#include <usbdescriptors.h> #include <linux/usb/cdc.h> #include <linux/usb/gadget.h> #include <net.h> diff --git a/drivers/usb/gadget/s3c_udc_otg.c b/drivers/usb/gadget/s3c_udc_otg.c index 1050a98..f7f7b54 100644 --- a/drivers/usb/gadget/s3c_udc_otg.c +++ b/drivers/usb/gadget/s3c_udc_otg.c @@ -37,6 +37,7 @@ #include <malloc.h> #include <linux/usb/ch9.h> +#include <usbdescriptors.h> #include <linux/usb/gadget.h> #include <asm/byteorder.h> diff --git a/drivers/usb/gadget/usbstring.c b/drivers/usb/gadget/usbstring.c index 95555cf..4dbe060 100644 --- a/drivers/usb/gadget/usbstring.c +++ b/drivers/usb/gadget/usbstring.c @@ -13,6 +13,7 @@ #include <common.h> #include <asm/errno.h> #include <linux/usb/ch9.h> +#include <usbdescriptors.h> #include <linux/usb/gadget.h> #include <asm/unaligned.h> diff --git a/include/linux/usb/ch9.h b/include/linux/usb/ch9.h index 49b7483..ce1d1e1 100644 --- a/include/linux/usb/ch9.h +++ b/include/linux/usb/ch9.h @@ -204,28 +204,6 @@ struct usb_descriptor_header { __u8 bDescriptorType; } __attribute__ ((packed)); - -/*-------------------------------------------------------------------------*/ - -/* USB_DT_DEVICE: Device descriptor */ -struct usb_device_descriptor { - __u8 bLength; - __u8 bDescriptorType; - - __le16 bcdUSB; - __u8 bDeviceClass; - __u8 bDeviceSubClass; - __u8 bDeviceProtocol; - __u8 bMaxPacketSize0; - __le16 idVendor; - __le16 idProduct; - __le16 bcdDevice; - __u8 iManufacturer; - __u8 iProduct; - __u8 iSerialNumber; - __u8 bNumConfigurations; -} __attribute__ ((packed)); - #define USB_DT_DEVICE_SIZE 18 @@ -282,56 +260,11 @@ struct usb_config_descriptor { #define USB_CONFIG_ATT_WAKEUP (1 << 5) /* can wakeup */ #define USB_CONFIG_ATT_BATTERY (1 << 4) /* battery powered */ -/*-------------------------------------------------------------------------*/ - -/* USB_DT_STRING: String descriptor */ -struct usb_string_descriptor { - __u8 bLength; - __u8 bDescriptorType; - - __le16 wData[1]; /* UTF-16LE encoded */ -} __attribute__ ((packed)); - /* note that "string" zero is special, it holds language codes that * the device supports, not Unicode characters. */ -/*-------------------------------------------------------------------------*/ - -/* USB_DT_INTERFACE: Interface descriptor */ -struct usb_interface_descriptor { - __u8 bLength; - __u8 bDescriptorType; - - __u8 bInterfaceNumber; - __u8 bAlternateSetting; - __u8 bNumEndpoints; - __u8 bInterfaceClass; - __u8 bInterfaceSubClass; - __u8 bInterfaceProtocol; - __u8 iInterface; -} __attribute__ ((packed)); - #define USB_DT_INTERFACE_SIZE 9 - -/*-------------------------------------------------------------------------*/ - -/* USB_DT_ENDPOINT: Endpoint descriptor */ -struct usb_endpoint_descriptor { - __u8 bLength; - __u8 bDescriptorType; - - __u8 bEndpointAddress; - __u8 bmAttributes; - __le16 wMaxPacketSize; - __u8 bInterval; - - /* NOTE: these two are _only_ in audio endpoints. */ - /* use USB_DT_ENDPOINT*_SIZE in bLength, not sizeof. */ - __u8 bRefresh; - __u8 bSynchAddress; -} __attribute__ ((packed)); - #define USB_DT_ENDPOINT_SIZE 7 #define USB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */ diff --git a/include/usb/s3c_udc.h b/include/usb/s3c_udc.h index 6c973b6..3e6135a 100644 --- a/include/usb/s3c_udc.h +++ b/include/usb/s3c_udc.h @@ -24,6 +24,7 @@ #include <asm/errno.h> #include <linux/usb/ch9.h> +#include <usbdescriptors.h> #include <linux/usb/gadget.h> #include <linux/list.h> #include <usb/lin_gadget_compat.h> -- 1.7.2.3 ^ permalink raw reply related [flat|nested] 9+ messages in thread
* [U-Boot] [RESEND PATCH 2/5] usb:udc:samsung:cleanup Replace DEBUG_* macros with debug_cond() calls 2012-05-02 11:11 [U-Boot] [RESEND PATCH 0/5] usb:udc:composite: Samsung's UDC cleanup and composite gadget implementation Lukasz Majewski 2012-05-02 11:11 ` [U-Boot] [RESEND PATCH 1/5] usb:udc: Remove duplicated USB definitions from include/linux/usb/ch9.h file Lukasz Majewski @ 2012-05-02 11:11 ` Lukasz Majewski 2012-05-02 11:11 ` [U-Boot] [RESEND PATCH 3/5] usb:gadget:composite USB composite gadget support Lukasz Majewski ` (2 subsequent siblings) 4 siblings, 0 replies; 9+ messages in thread From: Lukasz Majewski @ 2012-05-02 11:11 UTC (permalink / raw) To: u-boot This patch cleans up the Samsung's UDC driver. It replaces several DEBUG_* macros with debug_cond(). Signed-off-by: Lukasz Majewski <l.majewski@samsung.com> Signed-off-by: Kyungmin Park <kyungmin.park@samsung.com> Cc: Marek Vasut <marex@denx.de> --- drivers/usb/gadget/s3c_udc_otg.c | 37 ++-- drivers/usb/gadget/s3c_udc_otg_xfer_dma.c | 287 +++++++++++++++++------------ include/usb/s3c_udc.h | 48 ----- 3 files changed, 188 insertions(+), 184 deletions(-) diff --git a/drivers/usb/gadget/s3c_udc_otg.c b/drivers/usb/gadget/s3c_udc_otg.c index f7f7b54..24ff346 100644 --- a/drivers/usb/gadget/s3c_udc_otg.c +++ b/drivers/usb/gadget/s3c_udc_otg.c @@ -54,19 +54,11 @@ #define OTG_DMA_MODE 1 -#undef DEBUG_S3C_UDC_SETUP -#undef DEBUG_S3C_UDC_EP0 -#undef DEBUG_S3C_UDC_ISR -#undef DEBUG_S3C_UDC_OUT_EP -#undef DEBUG_S3C_UDC_IN_EP -#undef DEBUG_S3C_UDC - -/* #define DEBUG_S3C_UDC_SETUP */ -/* #define DEBUG_S3C_UDC_EP0 */ -/* #define DEBUG_S3C_UDC_ISR */ -/* #define DEBUG_S3C_UDC_OUT_EP */ -/* #define DEBUG_S3C_UDC_IN_EP */ -/* #define DEBUG_S3C_UDC */ +#define DEBUG_SETUP 0 +#define DEBUG_EP0 0 +#define DEBUG_ISR 0 +#define DEBUG_OUT_EP 0 +#define DEBUG_IN_EP 0 #include <usb/s3c_udc.h> @@ -217,7 +209,7 @@ void otg_phy_off(struct s3c_udc *dev) */ static void udc_disable(struct s3c_udc *dev) { - DEBUG_SETUP("%s: %p\n", __func__, dev); + debug_cond(DEBUG_SETUP != 0, "%s: %p\n", __func__, dev); udc_set_address(dev, 0); @@ -235,7 +227,7 @@ static void udc_reinit(struct s3c_udc *dev) { unsigned int i; - DEBUG_SETUP("%s: %p\n", __func__, dev); + debug_cond(DEBUG_SETUP != 0, "%s: %p\n", __func__, dev); /* device/ep0 records init */ INIT_LIST_HEAD(&dev->gadget.ep_list); @@ -266,12 +258,13 @@ static void udc_reinit(struct s3c_udc *dev) */ static int udc_enable(struct s3c_udc *dev) { - DEBUG_SETUP("%s: %p\n", __func__, dev); + debug_cond(DEBUG_SETUP != 0, "%s: %p\n", __func__, dev); otg_phy_init(dev); reconfig_usbd(); - DEBUG_SETUP("S3C USB 2.0 OTG Controller Core Initialized : 0x%x\n", + debug_cond(DEBUG_SETUP != 0, + "S3C USB 2.0 OTG Controller Core Initialized : 0x%x\n", readl(®->gintmsk)); dev->gadget.speed = USB_SPEED_UNKNOWN; @@ -288,7 +281,7 @@ int usb_gadget_register_driver(struct usb_gadget_driver *driver) int retval = 0; unsigned long flags; - DEBUG_SETUP("%s: %s\n", __func__, "no name"); + debug_cond(DEBUG_SETUP != 0, "%s: %s\n", __func__, "no name"); if (!driver || (driver->speed != USB_SPEED_FULL @@ -312,7 +305,8 @@ int usb_gadget_register_driver(struct usb_gadget_driver *driver) retval = driver->bind(&dev->gadget); if (retval) { - DEBUG_SETUP("%s: bind to driver --> error %d\n", + debug_cond(DEBUG_SETUP != 0, + "%s: bind to driver --> error %d\n", dev->gadget.name, retval); dev->driver = 0; return retval; @@ -320,7 +314,8 @@ int usb_gadget_register_driver(struct usb_gadget_driver *driver) enable_irq(IRQ_OTG); - DEBUG_SETUP("Registered gadget driver %s\n", dev->gadget.name); + debug_cond(DEBUG_SETUP != 0, + "Registered gadget driver %s\n", dev->gadget.name); udc_enable(dev); return 0; @@ -378,7 +373,7 @@ static void done(struct s3c_ep *ep, struct s3c_request *req, int status) /* don't modify queue heads during completion callback */ ep->stopped = 1; -#ifdef DEBUG_S3C_UDC +#ifdef DEBUG printf("calling complete callback\n"); { int i, len = req->req.length; diff --git a/drivers/usb/gadget/s3c_udc_otg_xfer_dma.c b/drivers/usb/gadget/s3c_udc_otg_xfer_dma.c index afd4931..baac563 100644 --- a/drivers/usb/gadget/s3c_udc_otg_xfer_dma.c +++ b/drivers/usb/gadget/s3c_udc_otg_xfer_dma.c @@ -53,7 +53,7 @@ static inline void s3c_udc_ep0_zlp(struct s3c_udc *dev) writel(ep_ctrl|DEPCTL_EPENA|DEPCTL_CNAK, ®->in_endp[EP0_CON].diepctl); - DEBUG_EP0("%s:EP0 ZLP DIEPCTL0 = 0x%x\n", + debug_cond(DEBUG_EP0 != 0, "%s:EP0 ZLP DIEPCTL0 = 0x%x\n", __func__, readl(®->in_endp[EP0_CON].diepctl)); dev->ep0state = WAIT_FOR_IN_COMPLETE; } @@ -62,7 +62,8 @@ void s3c_udc_pre_setup(void) { u32 ep_ctrl; - debug_cond(DEBUG_IN_EP, "%s : Prepare Setup packets.\n", __func__); + debug_cond(DEBUG_IN_EP, + "%s : Prepare Setup packets.\n", __func__); invalidate_dcache_range((unsigned long) usb_ctrl_dma_addr, (unsigned long) usb_ctrl_dma_addr @@ -75,9 +76,9 @@ void s3c_udc_pre_setup(void) ep_ctrl = readl(®->out_endp[EP0_CON].doepctl); writel(ep_ctrl|DEPCTL_EPENA, ®->out_endp[EP0_CON].doepctl); - DEBUG_EP0("%s:EP0 ZLP DIEPCTL0 = 0x%x\n", + debug_cond(DEBUG_EP0 != 0, "%s:EP0 ZLP DIEPCTL0 = 0x%x\n", __func__, readl(®->in_endp[EP0_CON].diepctl)); - DEBUG_EP0("%s:EP0 ZLP DOEPCTL0 = 0x%x\n", + debug_cond(DEBUG_EP0 != 0, "%s:EP0 ZLP DOEPCTL0 = 0x%x\n", __func__, readl(®->out_endp[EP0_CON].doepctl)); } @@ -86,9 +87,9 @@ static inline void s3c_ep0_complete_out(void) { u32 ep_ctrl; - DEBUG_EP0("%s:EP0 ZLP DIEPCTL0 = 0x%x\n", + debug_cond(DEBUG_EP0 != 0, "%s:EP0 ZLP DIEPCTL0 = 0x%x\n", __func__, readl(®->in_endp[EP0_CON].diepctl)); - DEBUG_EP0("%s:EP0 ZLP DOEPCTL0 = 0x%x\n", + debug_cond(DEBUG_EP0 != 0, "%s:EP0 ZLP DOEPCTL0 = 0x%x\n", __func__, readl(®->out_endp[EP0_CON].doepctl)); debug_cond(DEBUG_IN_EP, @@ -106,9 +107,9 @@ static inline void s3c_ep0_complete_out(void) writel(ep_ctrl|DEPCTL_EPENA|DEPCTL_CNAK, ®->out_endp[EP0_CON].doepctl); - DEBUG_EP0("%s:EP0 ZLP DIEPCTL0 = 0x%x\n", + debug_cond(DEBUG_EP0 != 0, "%s:EP0 ZLP DIEPCTL0 = 0x%x\n", __func__, readl(®->in_endp[EP0_CON].diepctl)); - DEBUG_EP0("%s:EP0 ZLP DOEPCTL0 = 0x%x\n", + debug_cond(DEBUG_EP0 != 0, "%s:EP0 ZLP DOEPCTL0 = 0x%x\n", __func__, readl(®->out_endp[EP0_CON].doepctl)); } @@ -145,14 +146,15 @@ static int setdma_rx(struct s3c_ep *ep, struct s3c_request *req) ®->out_endp[ep_num].doeptsiz); writel(DEPCTL_EPENA|DEPCTL_CNAK|ctrl, ®->out_endp[ep_num].doepctl); - DEBUG_OUT_EP("%s: EP%d RX DMA start : DOEPDMA = 0x%x," - "DOEPTSIZ = 0x%x, DOEPCTL = 0x%x\n" - "\tbuf = 0x%p, pktcnt = %d, xfersize = %d\n", - __func__, ep_num, - readl(®->out_endp[ep_num].doepdma), - readl(®->out_endp[ep_num].doeptsiz), - readl(®->out_endp[ep_num].doepctl), - buf, pktcnt, length); + debug_cond(DEBUG_OUT_EP != 0, + "%s: EP%d RX DMA start : DOEPDMA = 0x%x," + "DOEPTSIZ = 0x%x, DOEPCTL = 0x%x\n" + "\tbuf = 0x%p, pktcnt = %d, xfersize = %d\n", + __func__, ep_num, + readl(®->out_endp[ep_num].doepdma), + readl(®->out_endp[ep_num].doeptsiz), + readl(®->out_endp[ep_num].doepctl), + buf, pktcnt, length); return 0; } @@ -225,8 +227,9 @@ static void complete_rx(struct s3c_udc *dev, u8 ep_num) u32 *p = the_controller->dma_buf[ep_index(ep)+1]; if (list_empty(&ep->queue)) { - DEBUG_OUT_EP("%s: RX DMA done : NULL REQ on OUT EP-%d\n", - __func__, ep_num); + debug_cond(DEBUG_OUT_EP != 0, + "%s: RX DMA done : NULL REQ on OUT EP-%d\n", + __func__, ep_num); return; } @@ -249,14 +252,15 @@ static void complete_rx(struct s3c_udc *dev, u8 ep_num) req->req.actual += min(xfer_size, req->req.length - req->req.actual); is_short = (xfer_size < ep->ep.maxpacket); - DEBUG_OUT_EP("%s: RX DMA done : ep = %d, rx bytes = %d/%d, " - "is_short = %d, DOEPTSIZ = 0x%x, remained bytes = %d\n", - __func__, ep_num, req->req.actual, req->req.length, - is_short, ep_tsr, xfer_size); + debug_cond(DEBUG_OUT_EP != 0, + "%s: RX DMA done : ep = %d, rx bytes = %d/%d, " + "is_short = %d, DOEPTSIZ = 0x%x, remained bytes = %d\n", + __func__, ep_num, req->req.actual, req->req.length, + is_short, ep_tsr, xfer_size); if (is_short || req->req.actual == req->req.length) { if (ep_num == EP0_CON && dev->ep0state == DATA_STATE_RECV) { - DEBUG_OUT_EP(" => Send ZLP\n"); + debug_cond(DEBUG_OUT_EP != 0, " => Send ZLP\n"); s3c_udc_ep0_zlp(dev); /* packet will be completed in complete_tx() */ dev->ep0state = WAIT_FOR_IN_COMPLETE; @@ -266,8 +270,9 @@ static void complete_rx(struct s3c_udc *dev, u8 ep_num) if (!list_empty(&ep->queue)) { req = list_entry(ep->queue.next, struct s3c_request, queue); - DEBUG_OUT_EP("%s: Next Rx request start...\n", - __func__); + debug_cond(DEBUG_OUT_EP != 0, + "%s: Next Rx request start...\n", + __func__); setdma_rx(ep, req); } } @@ -392,8 +397,9 @@ static void process_ep_in_intr(struct s3c_udc *dev) while (ep_intr) { if (ep_intr & DAINT_IN_EP_INT(1)) { ep_intr_status = readl(®->in_endp[ep_num].diepint); - debug_cond(DEBUG_IN_EP, "\tEP%d-IN : DIEPINT = 0x%x\n", - ep_num, ep_intr_status); + debug_cond(DEBUG_IN_EP, + "\tEP%d-IN : DIEPINT = 0x%x\n", + ep_num, ep_intr_status); /* Interrupt Clear */ writel(ep_intr_status, ®->in_endp[ep_num].diepint); @@ -430,16 +436,18 @@ static void process_ep_out_intr(struct s3c_udc *dev) u8 ep_num = 0; ep_intr = readl(®->daint); - DEBUG_OUT_EP("*** %s: EP OUT interrupt : DAINT = 0x%x\n", - __func__, ep_intr); + debug_cond(DEBUG_OUT_EP != 0, + "*** %s: EP OUT interrupt : DAINT = 0x%x\n", + __func__, ep_intr); ep_intr = (ep_intr >> DAINT_OUT_BIT) & DAINT_MASK; while (ep_intr) { if (ep_intr & 0x1) { ep_intr_status = readl(®->out_endp[ep_num].doepint); - DEBUG_OUT_EP("\tEP%d-OUT : DOEPINT = 0x%x\n", - ep_num, ep_intr_status); + debug_cond(DEBUG_OUT_EP != 0, + "\tEP%d-OUT : DOEPINT = 0x%x\n", + ep_num, ep_intr_status); /* Interrupt Clear */ writel(ep_intr_status, ®->out_endp[ep_num].doepint); @@ -457,7 +465,8 @@ static void process_ep_out_intr(struct s3c_udc *dev) if (ep_intr_status & CTRL_OUT_EP_SETUP_PHASE_DONE) { - DEBUG_OUT_EP("SETUP packet arrived\n"); + debug_cond(DEBUG_OUT_EP != 0, + "SETUP packet arrived\n"); s3c_handle_ep0(dev); } } else { @@ -503,7 +512,8 @@ static int s3c_udc_irq(int irq, void *_dev) usb_status = (readl(®->dsts) & 0x6); if (usb_status & (USB_FULL_30_60MHZ | USB_FULL_48MHZ)) { - debug_cond(DEBUG_ISR, "\t\tFull Speed Detection\n"); + debug_cond(DEBUG_ISR, + "\t\tFull Speed Detection\n"); set_max_pktsize(dev, USB_SPEED_FULL); } else { @@ -571,7 +581,8 @@ static int s3c_udc_irq(int irq, void *_dev) } else { reset_available = 1; - debug_cond(DEBUG_ISR, "\t\tRESET handling skipped\n"); + debug_cond(DEBUG_ISR, + "\t\tRESET handling skipped\n"); } } @@ -635,7 +646,7 @@ static int s3c_queue(struct usb_ep *_ep, struct usb_request *_req, _req, _req->length, _req->buf, list_empty(&ep->queue), ep->stopped); -#ifdef DEBUG_S3C_UDC +#ifdef DEBUG { int i, len = _req->length; @@ -662,14 +673,15 @@ static int s3c_queue(struct usb_ep *_ep, struct usb_request *_req, } else if (ep_is_in(ep)) { gintsts = readl(®->gintsts); debug_cond(DEBUG_IN_EP, - "%s: ep_is_in, S3C_UDC_OTG_GINTSTS=0x%x\n", - __func__, gintsts); + "%s: ep_is_in, S3C_UDC_OTG_GINTSTS=0x%x\n", + __func__, gintsts); setdma_tx(ep, req); } else { gintsts = readl(®->gintsts); - DEBUG_OUT_EP("%s:ep_is_out, S3C_UDC_OTG_GINTSTS=0x%x\n", - __func__, gintsts); + debug_cond(DEBUG_OUT_EP != 0, + "%s:ep_is_out, S3C_UDC_OTG_GINTSTS=0x%x\n", + __func__, gintsts); setdma_rx(ep, req); } @@ -697,7 +709,7 @@ static int write_fifo_ep0(struct s3c_ep *ep, struct s3c_request *req) max = ep_maxpacket(ep); - DEBUG_EP0("%s: max = %d\n", __func__, max); + debug_cond(DEBUG_EP0 != 0, "%s: max = %d\n", __func__, max); count = setdma_tx(ep, req); @@ -712,10 +724,11 @@ static int write_fifo_ep0(struct s3c_ep *ep, struct s3c_request *req) is_last = 1; } - DEBUG_EP0("%s: wrote %s %d bytes%s %d left %p\n", __func__, - ep->ep.name, count, - is_last ? "/L" : "", - req->req.length - req->req.actual - count, req); + debug_cond(DEBUG_EP0 != 0, + "%s: wrote %s %d bytes%s %d left %p\n", __func__, + ep->ep.name, count, + is_last ? "/L" : "", + req->req.length - req->req.actual - count, req); /* requests complete when all IN data is in the FIFO */ if (is_last) { @@ -736,8 +749,9 @@ int s3c_fifo_read(struct s3c_ep *ep, u32 *cp, int max) (unsigned long) ep->dev->dma_buf[ep_index(ep)] + DMA_BUFFER_SIZE); - DEBUG_EP0("%s: bytes=%d, ep_index=%d %p\n", __func__, - bytes, ep_index(ep), ep->dev->dma_buf[ep_index(ep)]); + debug_cond(DEBUG_EP0 != 0, + "%s: bytes=%d, ep_index=%d %p\n", __func__, + bytes, ep_index(ep), ep->dev->dma_buf[ep_index(ep)]); return bytes; } @@ -756,8 +770,9 @@ static void udc_set_address(struct s3c_udc *dev, unsigned char address) s3c_udc_ep0_zlp(dev); - DEBUG_EP0("%s: USB OTG 2.0 Device address=%d, DCFG=0x%x\n", - __func__, address, readl(®->dcfg)); + debug_cond(DEBUG_EP0 != 0, + "%s: USB OTG 2.0 Device address=%d, DCFG=0x%x\n", + __func__, address, readl(®->dcfg)); dev->usb_address = address; } @@ -778,8 +793,9 @@ static inline void s3c_udc_ep0_set_stall(struct s3c_ep *ep) writel(ep_ctrl, ®->in_endp[EP0_CON].diepctl); - DEBUG_EP0("%s: set ep%d stall, DIEPCTL0 = 0x%x\n", - __func__, ep_index(ep), ®->in_endp[EP0_CON].diepctl); + debug_cond(DEBUG_EP0 != 0, + "%s: set ep%d stall, DIEPCTL0 = 0x%p\n", + __func__, ep_index(ep), ®->in_endp[EP0_CON].diepctl); /* * The application can only set this bit, and the core clears it, * when a SETUP token is received for this endpoint @@ -803,8 +819,9 @@ static void s3c_ep0_read(struct s3c_udc *dev) return; } - DEBUG_EP0("%s: req = %p, req.length = 0x%x, req.actual = 0x%x\n", - __func__, req, req->req.length, req->req.actual); + debug_cond(DEBUG_EP0 != 0, + "%s: req = %p, req.length = 0x%x, req.actual = 0x%x\n", + __func__, req, req->req.length, req->req.actual); if (req->req.length == 0) { /* zlp for Set_configuration, Set_interface, @@ -813,8 +830,9 @@ static void s3c_ep0_read(struct s3c_udc *dev) ep->len = 0; s3c_udc_ep0_zlp(dev); - DEBUG_EP0("%s: req.length = 0, bRequest = %d\n", - __func__, usb_ctrl->bRequest); + debug_cond(DEBUG_EP0 != 0, + "%s: req.length = 0, bRequest = %d\n", + __func__, usb_ctrl->bRequest); return; } @@ -836,12 +854,13 @@ static int s3c_ep0_write(struct s3c_udc *dev) req = list_entry(ep->queue.next, struct s3c_request, queue); if (!req) { - DEBUG_EP0("%s: NULL REQ\n", __func__); + debug_cond(DEBUG_EP0 != 0, "%s: NULL REQ\n", __func__); return 0; } - DEBUG_EP0("%s: req = %p, req.length = 0x%x, req.actual = 0x%x\n", - __func__, req, req->req.length, req->req.actual); + debug_cond(DEBUG_EP0 != 0, + "%s: req = %p, req.length = 0x%x, req.actual = 0x%x\n", + __func__, req, req->req.length, req->req.actual); if (req->req.length - req->req.actual == ep0_fifo_size) { /* Next write will end with the packet size, */ @@ -854,11 +873,13 @@ static int s3c_ep0_write(struct s3c_udc *dev) if ((ret == 1) && !need_zlp) { /* Last packet */ dev->ep0state = WAIT_FOR_COMPLETE; - DEBUG_EP0("%s: finished, waiting for status\n", __func__); + debug_cond(DEBUG_EP0 != 0, + "%s: finished, waiting for status\n", __func__); } else { dev->ep0state = DATA_STATE_XMIT; - DEBUG_EP0("%s: not finished\n", __func__); + debug_cond(DEBUG_EP0 != 0, + "%s: not finished\n", __func__); } return 1; @@ -873,30 +894,35 @@ int s3c_udc_get_status(struct s3c_udc *dev, u32 ep_ctrl; u32 *p = the_controller->dma_buf[1]; - DEBUG_SETUP("%s: *** USB_REQ_GET_STATUS\n", __func__); + debug_cond(DEBUG_SETUP != 0, + "%s: *** USB_REQ_GET_STATUS\n", __func__); printf("crq->brequest:0x%x\n", crq->bRequestType & USB_RECIP_MASK); switch (crq->bRequestType & USB_RECIP_MASK) { case USB_RECIP_INTERFACE: g_status = 0; - DEBUG_SETUP("\tGET_STATUS:USB_RECIP_INTERFACE, g_stauts = %d\n", - g_status); + debug_cond(DEBUG_SETUP != 0, + "\tGET_STATUS:USB_RECIP_INTERFACE, g_stauts = %d\n", + g_status); break; case USB_RECIP_DEVICE: g_status = 0x1; /* Self powered */ - DEBUG_SETUP("\tGET_STATUS: USB_RECIP_DEVICE, g_stauts = %d\n", - g_status); + debug_cond(DEBUG_SETUP != 0, + "\tGET_STATUS: USB_RECIP_DEVICE, g_stauts = %d\n", + g_status); break; case USB_RECIP_ENDPOINT: if (crq->wLength > 2) { - DEBUG_SETUP("\tGET_STATUS:Not support EP or wLength\n"); + debug_cond(DEBUG_SETUP != 0, + "\tGET_STATUS:Not support EP or wLength\n"); return 1; } g_status = dev->ep[ep_num].stopped; - DEBUG_SETUP("\tGET_STATUS: USB_RECIP_ENDPOINT, g_stauts = %d\n", - g_status); + debug_cond(DEBUG_SETUP != 0, + "\tGET_STATUS: USB_RECIP_ENDPOINT, g_stauts = %d\n", + g_status); break; @@ -1134,11 +1160,13 @@ static int s3c_udc_clear_feature(struct usb_ep *_ep) ep_num = ep_index(ep); dev = ep->dev; - DEBUG_SETUP("%s: ep_num = %d, is_in = %d, clear_feature_flag = %d\n", - __func__, ep_num, ep_is_in(ep), clear_feature_flag); + debug_cond(DEBUG_SETUP != 0, + "%s: ep_num = %d, is_in = %d, clear_feature_flag = %d\n", + __func__, ep_num, ep_is_in(ep), clear_feature_flag); if (usb_ctrl->wLength != 0) { - DEBUG_SETUP("\tCLEAR_FEATURE: wLength is not zero.....\n"); + debug_cond(DEBUG_SETUP != 0, + "\tCLEAR_FEATURE: wLength is not zero.....\n"); return 1; } @@ -1146,11 +1174,13 @@ static int s3c_udc_clear_feature(struct usb_ep *_ep) case USB_RECIP_DEVICE: switch (usb_ctrl->wValue) { case USB_DEVICE_REMOTE_WAKEUP: - DEBUG_SETUP("\tOFF:USB_DEVICE_REMOTE_WAKEUP\n"); + debug_cond(DEBUG_SETUP != 0, + "\tOFF:USB_DEVICE_REMOTE_WAKEUP\n"); break; case USB_DEVICE_TEST_MODE: - DEBUG_SETUP("\tCLEAR_FEATURE: USB_DEVICE_TEST_MODE\n"); + debug_cond(DEBUG_SETUP != 0, + "\tCLEAR_FEATURE: USB_DEVICE_TEST_MODE\n"); /** @todo Add CLEAR_FEATURE for TEST modes. */ break; } @@ -1159,8 +1189,9 @@ static int s3c_udc_clear_feature(struct usb_ep *_ep) break; case USB_RECIP_ENDPOINT: - DEBUG_SETUP("\tCLEAR_FEATURE:USB_RECIP_ENDPOINT, wValue = %d\n", - usb_ctrl->wValue); + debug_cond(DEBUG_SETUP != 0, + "\tCLEAR_FEATURE:USB_RECIP_ENDPOINT, wValue = %d\n", + usb_ctrl->wValue); if (usb_ctrl->wValue == USB_ENDPOINT_HALT) { if (ep_num == 0) { @@ -1193,11 +1224,13 @@ static int s3c_udc_set_feature(struct usb_ep *_ep) ep_num = ep_index(ep); dev = ep->dev; - DEBUG_SETUP("%s: *** USB_REQ_SET_FEATURE , ep_num = %d\n", + debug_cond(DEBUG_SETUP != 0, + "%s: *** USB_REQ_SET_FEATURE , ep_num = %d\n", __func__, ep_num); if (usb_ctrl->wLength != 0) { - DEBUG_SETUP("\tSET_FEATURE: wLength is not zero.....\n"); + debug_cond(DEBUG_SETUP != 0, + "\tSET_FEATURE: wLength is not zero.....\n"); return 1; } @@ -1205,20 +1238,24 @@ static int s3c_udc_set_feature(struct usb_ep *_ep) case USB_RECIP_DEVICE: switch (usb_ctrl->wValue) { case USB_DEVICE_REMOTE_WAKEUP: - DEBUG_SETUP("\tSET_FEATURE:USB_DEVICE_REMOTE_WAKEUP\n"); + debug_cond(DEBUG_SETUP != 0, + "\tSET_FEATURE:USB_DEVICE_REMOTE_WAKEUP\n"); break; case USB_DEVICE_B_HNP_ENABLE: - DEBUG_SETUP("\tSET_FEATURE: USB_DEVICE_B_HNP_ENABLE\n"); + debug_cond(DEBUG_SETUP != 0, + "\tSET_FEATURE: USB_DEVICE_B_HNP_ENABLE\n"); break; case USB_DEVICE_A_HNP_SUPPORT: /* RH port supports HNP */ - DEBUG_SETUP("\tSET_FEATURE:USB_DEVICE_A_HNP_SUPPORT\n"); + debug_cond(DEBUG_SETUP != 0, + "\tSET_FEATURE:USB_DEVICE_A_HNP_SUPPORT\n"); break; case USB_DEVICE_A_ALT_HNP_SUPPORT: /* other RH port does */ - DEBUG_SETUP("\tSET: USB_DEVICE_A_ALT_HNP_SUPPORT\n"); + debug_cond(DEBUG_SETUP != 0, + "\tSET: USB_DEVICE_A_ALT_HNP_SUPPORT\n"); break; } @@ -1226,11 +1263,13 @@ static int s3c_udc_set_feature(struct usb_ep *_ep) return 0; case USB_RECIP_INTERFACE: - DEBUG_SETUP("\tSET_FEATURE: USB_RECIP_INTERFACE\n"); + debug_cond(DEBUG_SETUP != 0, + "\tSET_FEATURE: USB_RECIP_INTERFACE\n"); break; case USB_RECIP_ENDPOINT: - DEBUG_SETUP("\tSET_FEATURE: USB_RECIP_ENDPOINT\n"); + debug_cond(DEBUG_SETUP != 0, + "\tSET_FEATURE: USB_RECIP_ENDPOINT\n"); if (usb_ctrl->wValue == USB_ENDPOINT_HALT) { if (ep_num == 0) { s3c_udc_ep0_set_stall(ep); @@ -1262,14 +1301,15 @@ void s3c_ep0_setup(struct s3c_udc *dev) /* read control req from fifo (8 bytes) */ s3c_fifo_read(ep, (u32 *)usb_ctrl, 8); - DEBUG_SETUP("%s: bRequestType = 0x%x(%s), bRequest = 0x%x" - "\twLength = 0x%x, wValue = 0x%x, wIndex= 0x%x\n", - __func__, usb_ctrl->bRequestType, - (usb_ctrl->bRequestType & USB_DIR_IN) ? "IN" : "OUT", - usb_ctrl->bRequest, - usb_ctrl->wLength, usb_ctrl->wValue, usb_ctrl->wIndex); + debug_cond(DEBUG_SETUP != 0, + "%s: bRequestType = 0x%x(%s), bRequest = 0x%x" + "\twLength = 0x%x, wValue = 0x%x, wIndex= 0x%x\n", + __func__, usb_ctrl->bRequestType, + (usb_ctrl->bRequestType & USB_DIR_IN) ? "IN" : "OUT", + usb_ctrl->bRequest, + usb_ctrl->wLength, usb_ctrl->wValue, usb_ctrl->wIndex); -#ifdef DEBUG_S3C_UDC +#ifdef DEBUG { int i, len = sizeof(*usb_ctrl); char *p = (char *)usb_ctrl; @@ -1286,10 +1326,12 @@ void s3c_ep0_setup(struct s3c_udc *dev) if (usb_ctrl->bRequest == GET_MAX_LUN_REQUEST && usb_ctrl->wLength != 1) { - DEBUG_SETUP("\t%s:GET_MAX_LUN_REQUEST:invalid", - __func__); - DEBUG_SETUP("wLength = %d, setup returned\n", - usb_ctrl->wLength); + debug_cond(DEBUG_SETUP != 0, + "\t%s:GET_MAX_LUN_REQUEST:invalid", + __func__); + debug_cond(DEBUG_SETUP != 0, + "wLength = %d, setup returned\n", + usb_ctrl->wLength); s3c_udc_ep0_set_stall(ep); dev->ep0state = WAIT_FOR_SETUP; @@ -1298,8 +1340,9 @@ void s3c_ep0_setup(struct s3c_udc *dev) } else if (usb_ctrl->bRequest == BOT_RESET_REQUEST && usb_ctrl->wLength != 0) { /* Bulk-Only *mass storge reset of class-specific request */ - DEBUG_SETUP("%s:BOT Rest:invalid wLength =%d, setup returned\n", - __func__, usb_ctrl->wLength); + debug_cond(DEBUG_SETUP != 0, + "%s:BOT Rest:invalid wLength =%d, setup returned\n", + __func__, usb_ctrl->wLength); s3c_udc_ep0_set_stall(ep); dev->ep0state = WAIT_FOR_SETUP; @@ -1323,8 +1366,9 @@ void s3c_ep0_setup(struct s3c_udc *dev) if (dev->req_std) { switch (usb_ctrl->bRequest) { case USB_REQ_SET_ADDRESS: - DEBUG_SETUP("%s: *** USB_REQ_SET_ADDRESS (%d)\n", - __func__, usb_ctrl->wValue); + debug_cond(DEBUG_SETUP != 0, + "%s: *** USB_REQ_SET_ADDRESS (%d)\n", + __func__, usb_ctrl->wValue); if (usb_ctrl->bRequestType != (USB_TYPE_STANDARD | USB_RECIP_DEVICE)) break; @@ -1333,9 +1377,11 @@ void s3c_ep0_setup(struct s3c_udc *dev) return; case USB_REQ_SET_CONFIGURATION: - DEBUG_SETUP("=====================================\n"); - DEBUG_SETUP("%s: USB_REQ_SET_CONFIGURATION (%d)\n", - __func__, usb_ctrl->wValue); + debug_cond(DEBUG_SETUP != 0, + "=====================================\n"); + debug_cond(DEBUG_SETUP != 0, + "%s: USB_REQ_SET_CONFIGURATION (%d)\n", + __func__, usb_ctrl->wValue); if (usb_ctrl->bRequestType == USB_RECIP_DEVICE) reset_available = 1; @@ -1343,13 +1389,15 @@ void s3c_ep0_setup(struct s3c_udc *dev) break; case USB_REQ_GET_DESCRIPTOR: - DEBUG_SETUP("%s: *** USB_REQ_GET_DESCRIPTOR\n", - __func__); + debug_cond(DEBUG_SETUP != 0, + "%s: *** USB_REQ_GET_DESCRIPTOR\n", + __func__); break; case USB_REQ_SET_INTERFACE: - DEBUG_SETUP("%s: *** USB_REQ_SET_INTERFACE (%d)\n", - __func__, usb_ctrl->wValue); + debug_cond(DEBUG_SETUP != 0, + "%s: *** USB_REQ_SET_INTERFACE (%d)\n", + __func__, usb_ctrl->wValue); if (usb_ctrl->bRequestType == USB_RECIP_INTERFACE) reset_available = 1; @@ -1357,8 +1405,9 @@ void s3c_ep0_setup(struct s3c_udc *dev) break; case USB_REQ_GET_CONFIGURATION: - DEBUG_SETUP("%s: *** USB_REQ_GET_CONFIGURATION\n", - __func__); + debug_cond(DEBUG_SETUP != 0, + "%s: *** USB_REQ_GET_CONFIGURATION\n", + __func__); break; case USB_REQ_GET_STATUS: @@ -1384,8 +1433,9 @@ void s3c_ep0_setup(struct s3c_udc *dev) break; default: - DEBUG_SETUP("%s: *** Default of usb_ctrl->bRequest=0x%x" - "happened.\n", __func__, usb_ctrl->bRequest); + debug_cond(DEBUG_SETUP != 0, + "%s: *** Default of usb_ctrl->bRequest=0x%x" + "happened.\n", __func__, usb_ctrl->bRequest); break; } } @@ -1394,7 +1444,8 @@ void s3c_ep0_setup(struct s3c_udc *dev) if (likely(dev->driver)) { /* device-2-host (IN) or no data setup command, * process immediately */ - DEBUG_SETUP("%s:usb_ctrlreq will be passed to fsg_setup()\n", + debug_cond(DEBUG_SETUP != 0, + "%s:usb_ctrlreq will be passed to fsg_setup()\n", __func__); spin_unlock(&dev->lock); @@ -1406,17 +1457,20 @@ void s3c_ep0_setup(struct s3c_udc *dev) s3c_udc_ep0_set_stall(ep); dev->ep0state = WAIT_FOR_SETUP; - DEBUG_SETUP("\tdev->driver->setup failed (%d)," + debug_cond(DEBUG_SETUP != 0, + "\tdev->driver->setup failed (%d)," " bRequest = %d\n", i, usb_ctrl->bRequest); } else if (dev->req_pending) { dev->req_pending = 0; - DEBUG_SETUP("\tdev->req_pending...\n"); + debug_cond(DEBUG_SETUP != 0, + "\tdev->req_pending...\n"); } - DEBUG_SETUP("\tep0state = %s\n", state_names[dev->ep0state]); + debug_cond(DEBUG_SETUP != 0, + "\tep0state = %s\n", state_names[dev->ep0state]); } } @@ -1427,18 +1481,21 @@ void s3c_ep0_setup(struct s3c_udc *dev) static void s3c_handle_ep0(struct s3c_udc *dev) { if (dev->ep0state == WAIT_FOR_SETUP) { - DEBUG_OUT_EP("%s: WAIT_FOR_SETUP\n", __func__); + debug_cond(DEBUG_OUT_EP != 0, + "%s: WAIT_FOR_SETUP\n", __func__); s3c_ep0_setup(dev); } else { - DEBUG_OUT_EP("%s: strange state!!(state = %s)\n", + debug_cond(DEBUG_OUT_EP != 0, + "%s: strange state!!(state = %s)\n", __func__, state_names[dev->ep0state]); } } static void s3c_ep0_kick(struct s3c_udc *dev, struct s3c_ep *ep) { - DEBUG_EP0("%s: ep_is_in = %d\n", __func__, ep_is_in(ep)); + debug_cond(DEBUG_EP0 != 0, + "%s: ep_is_in = %d\n", __func__, ep_is_in(ep)); if (ep_is_in(ep)) { dev->ep0state = DATA_STATE_XMIT; s3c_ep0_write(dev); diff --git a/include/usb/s3c_udc.h b/include/usb/s3c_udc.h index 3e6135a..6a8fd44 100644 --- a/include/usb/s3c_udc.h +++ b/include/usb/s3c_udc.h @@ -112,54 +112,6 @@ extern struct s3c_udc *the_controller; #define ep_index(EP) ((EP)->bEndpointAddress&0xF) #define ep_maxpacket(EP) ((EP)->ep.maxpacket) -/*-------------------------------------------------------------------------*/ -/* #define DEBUG_UDC */ -#ifdef DEBUG_UDC -#define DBG(stuff...) printf("udc: " stuff) -#else -#define DBG(stuff...) do {} while (0) -#endif - -#ifdef DEBUG_S3C_UDC_SETUP -#define DEBUG_SETUP(fmt, args...) printk(fmt, ##args) -#else -#define DEBUG_SETUP(fmt, args...) do {} while (0) -#endif - -#ifdef DEBUG_S3C_UDC_EP0 -#define DEBUG_EP0(fmt, args...) printk(fmt, ##args) -#else -#define DEBUG_EP0(fmt, args...) do {} while (0) -#endif - -#ifdef DEBUG_S3C_UDC_ISR -#define DEBUG_ISR 1 -#else -#define DEBUG_ISR 0 -#endif - -#ifdef DEBUG_S3C_UDC_OUT_EP -#define DEBUG_OUT_EP(fmt, args...) printk(fmt, ##args) -#else -#define DEBUG_OUT_EP(fmt, args...) do {} while (0) -#endif - -#ifdef DEBUG_S3C_UDC_IN_EP -#define DEBUG_IN_EP 1 -#else -#define DEBUG_IN_EP 0 -#endif - -#if defined(DEBUG_S3C_UDC_SETUP) || defined(DEBUG_S3C_UDC_EP0) || \ - defined(DEBUG_S3C_UDC_ISR) || defined(DEBUG_S3C_UDC_OUT_EP) || \ - defined(DEBUG_S3C_UDC_IN_EP) || defined(DEBUG_S3C_UDC) -#define DEBUG -#endif - -#define ERR(stuff...) printf("ERR udc: " stuff) -#define WARN(stuff...) printf("WARNING udc: " stuff) -#define INFO(stuff...) printf("INFO udc: " stuff) - extern void otg_phy_init(struct s3c_udc *dev); extern void otg_phy_off(struct s3c_udc *dev); -- 1.7.2.3 ^ permalink raw reply related [flat|nested] 9+ messages in thread
* [U-Boot] [RESEND PATCH 3/5] usb:gadget:composite USB composite gadget support 2012-05-02 11:11 [U-Boot] [RESEND PATCH 0/5] usb:udc:composite: Samsung's UDC cleanup and composite gadget implementation Lukasz Majewski 2012-05-02 11:11 ` [U-Boot] [RESEND PATCH 1/5] usb:udc: Remove duplicated USB definitions from include/linux/usb/ch9.h file Lukasz Majewski 2012-05-02 11:11 ` [U-Boot] [RESEND PATCH 2/5] usb:udc:samsung:cleanup Replace DEBUG_* macros with debug_cond() calls Lukasz Majewski @ 2012-05-02 11:11 ` Lukasz Majewski 2012-05-02 13:25 ` Marek Vasut 2012-05-02 15:47 ` [U-Boot] [RESEND++ " Lukasz Majewski 2012-05-02 11:11 ` [U-Boot] [RESEND PATCH 4/5] usb:gadget:composite: Support for composite at gadget.h Lukasz Majewski 2012-05-02 11:11 ` [U-Boot] [RESEND PATCH 5/5] usb:udc:samsung Add functions for storing private gadget data in UDC driver Lukasz Majewski 4 siblings, 2 replies; 9+ messages in thread From: Lukasz Majewski @ 2012-05-02 11:11 UTC (permalink / raw) To: u-boot USB Composite gadget implementation for u-boot. It builds on top of USB UDC drivers. This commit is based on following files from Linux Kernel v2.6.36: ./include/linux/usb/composite.h ./drivers/usb/gadget/composite.c SHA1: d187abb9a83e6c6b6e9f2ca17962bdeafb4bc903 Signed-off-by: Lukasz Majewski <l.majewski@samsung.com> Signed-off-by: Kyungmin Park <kyungmin.park@samsung.com> Cc: Marek Vasut <marex@denx.de> --- Changes for v2: - Squash the strict kernel files with u-boot compatibility layer. - Removal of dead/kernel specific code - Comments corrected according to u-boot coding style --- drivers/usb/gadget/composite.c | 1082 +++++++++++++++++++++++++++++++++++++++ include/linux/usb/composite.h | 350 +++++++++++++ include/usb/lin_gadget_compat.h | 24 +- 3 files changed, 1454 insertions(+), 2 deletions(-) create mode 100644 drivers/usb/gadget/composite.c create mode 100644 include/linux/usb/composite.h diff --git a/drivers/usb/gadget/composite.c b/drivers/usb/gadget/composite.c new file mode 100644 index 0000000..905077d --- /dev/null +++ b/drivers/usb/gadget/composite.c @@ -0,0 +1,1082 @@ +/* + * composite.c - infrastructure for Composite USB Gadgets + * + * Copyright (C) 2006-2008 David Brownell + * U-boot porting: Lukasz Majewski <l.majewski@samsung.com> + * + * 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ +#undef DEBUG + +#include <linux/bitops.h> +#include <linux/usb/composite.h> + +#define USB_BUFSIZ 4096 + +static struct usb_composite_driver *composite; + +/** + * usb_add_function() - add a function to a configuration + * @config: the configuration + * @function: the function being added + * Context: single threaded during gadget setup + * + * After initialization, each configuration must have one or more + * functions added to it. Adding a function involves calling its @bind() + * method to allocate resources such as interface and string identifiers + * and endpoints. + * + * This function returns the value of the function's bind(), which is + * zero for success else a negative errno value. + */ +int usb_add_function(struct usb_configuration *config, + struct usb_function *function) +{ + int value = -EINVAL; + + debug("adding '%s'/%p to config '%s'/%p\n", + function->name, function, + config->label, config); + + if (!function->set_alt || !function->disable) + goto done; + + function->config = config; + list_add_tail(&function->list, &config->functions); + + if (function->bind) { + value = function->bind(config, function); + if (value < 0) { + list_del(&function->list); + function->config = NULL; + } + } else + value = 0; + + if (!config->fullspeed && function->descriptors) + config->fullspeed = 1; + if (!config->highspeed && function->hs_descriptors) + config->highspeed = 1; + +done: + if (value) + debug("adding '%s'/%p --> %d\n", + function->name, function, value); + return value; +} + +/** + * usb_function_deactivate - prevent function and gadget enumeration + * @function: the function that isn't yet ready to respond + * + * Blocks response of the gadget driver to host enumeration by + * preventing the data line pullup from being activated. This is + * normally called during @bind() processing to change from the + * initial "ready to respond" state, or when a required resource + * becomes available. + * + * For example, drivers that serve as a passthrough to a userspace + * daemon can block enumeration unless that daemon (such as an OBEX, + * MTP, or print server) is ready to handle host requests. + * + * Not all systems support software control of their USB peripheral + * data pullups. + * + * Returns zero on success, else negative errno. + */ +int usb_function_deactivate(struct usb_function *function) +{ + struct usb_composite_dev *cdev = function->config->cdev; + int status = 0; + + if (cdev->deactivations == 0) + status = usb_gadget_disconnect(cdev->gadget); + if (status == 0) + cdev->deactivations++; + + return status; +} + +/** + * usb_function_activate - allow function and gadget enumeration + * @function: function on which usb_function_activate() was called + * + * Reverses effect of usb_function_deactivate(). If no more functions + * are delaying their activation, the gadget driver will respond to + * host enumeration procedures. + * + * Returns zero on success, else negative errno. + */ +int usb_function_activate(struct usb_function *function) +{ + struct usb_composite_dev *cdev = function->config->cdev; + int status = 0; + + if (cdev->deactivations == 0) + status = -EINVAL; + else { + cdev->deactivations--; + if (cdev->deactivations == 0) + status = usb_gadget_connect(cdev->gadget); + } + + return status; +} + +/** + * usb_interface_id() - allocate an unused interface ID + * @config: configuration associated with the interface + * @function: function handling the interface + * Context: single threaded during gadget setup + * + * usb_interface_id() is called from usb_function.bind() callbacks to + * allocate new interface IDs. The function driver will then store that + * ID in interface, association, CDC union, and other descriptors. It + * will also handle any control requests targetted at that interface, + * particularly changing its altsetting via set_alt(). There may + * also be class-specific or vendor-specific requests to handle. + * + * All interface identifier should be allocated using this routine, to + * ensure that for example different functions don't wrongly assign + * different meanings to the same identifier. Note that since interface + * identifers are configuration-specific, functions used in more than + * one configuration (or more than once in a given configuration) need + * multiple versions of the relevant descriptors. + * + * Returns the interface ID which was allocated; or -ENODEV if no + * more interface IDs can be allocated. + */ +int usb_interface_id(struct usb_configuration *config, + struct usb_function *function) +{ + unsigned char id = config->next_interface_id; + + if (id < MAX_CONFIG_INTERFACES) { + config->interface[id] = function; + config->next_interface_id = id + 1; + return id; + } + return -ENODEV; +} + +static int config_buf(struct usb_configuration *config, + enum usb_device_speed speed, void *buf, u8 type) +{ + int len = USB_BUFSIZ - USB_DT_CONFIG_SIZE; + void *next = buf + USB_DT_CONFIG_SIZE; + struct usb_descriptor_header **descriptors; + struct usb_config_descriptor *c = buf; + int status; + struct usb_function *f; + + /* write the config descriptor */ + c = buf; + c->bLength = USB_DT_CONFIG_SIZE; + c->bDescriptorType = type; + + c->bNumInterfaces = config->next_interface_id; + c->bConfigurationValue = config->bConfigurationValue; + c->iConfiguration = config->iConfiguration; + c->bmAttributes = USB_CONFIG_ATT_ONE | config->bmAttributes; + c->bMaxPower = config->bMaxPower ? : (CONFIG_USB_GADGET_VBUS_DRAW / 2); + + /* There may be e.g. OTG descriptors */ + if (config->descriptors) { + status = usb_descriptor_fillbuf(next, len, + config->descriptors); + if (status < 0) + return status; + len -= status; + next += status; + } + + /* add each function's descriptors */ + list_for_each_entry(f, &config->functions, list) { + if (speed == USB_SPEED_HIGH) + descriptors = f->hs_descriptors; + else + descriptors = f->descriptors; + if (!descriptors) + continue; + status = usb_descriptor_fillbuf(next, len, + (const struct usb_descriptor_header **) descriptors); + if (status < 0) + return status; + len -= status; + next += status; + } + + len = next - buf; + c->wTotalLength = cpu_to_le16(len); + return len; +} + +static int config_desc(struct usb_composite_dev *cdev, unsigned w_value) +{ + enum usb_device_speed speed = USB_SPEED_UNKNOWN; + struct usb_gadget *gadget = cdev->gadget; + u8 type = w_value >> 8; + int hs = 0; + struct usb_configuration *c; + + if (gadget_is_dualspeed(gadget)) { + if (gadget->speed == USB_SPEED_HIGH) + hs = 1; + if (type == USB_DT_OTHER_SPEED_CONFIG) + hs = !hs; + if (hs) + speed = USB_SPEED_HIGH; + } + + w_value &= 0xff; + list_for_each_entry(c, &cdev->configs, list) { + if (speed == USB_SPEED_HIGH) { + if (!c->highspeed) + continue; + } else { + if (!c->fullspeed) + continue; + } + if (w_value == 0) + return config_buf(c, speed, cdev->req->buf, type); + w_value--; + } + return -EINVAL; +} + +static int count_configs(struct usb_composite_dev *cdev, unsigned type) +{ + struct usb_gadget *gadget = cdev->gadget; + unsigned count = 0; + int hs = 0; + struct usb_configuration *c; + + if (gadget_is_dualspeed(gadget)) { + if (gadget->speed == USB_SPEED_HIGH) + hs = 1; + if (type == USB_DT_DEVICE_QUALIFIER) + hs = !hs; + } + list_for_each_entry(c, &cdev->configs, list) { + /* ignore configs that won't work at this speed */ + if (hs) { + if (!c->highspeed) + continue; + } else { + if (!c->fullspeed) + continue; + } + count++; + } + return count; +} + +static void device_qual(struct usb_composite_dev *cdev) +{ + struct usb_qualifier_descriptor *qual = cdev->req->buf; + + qual->bLength = sizeof(*qual); + qual->bDescriptorType = USB_DT_DEVICE_QUALIFIER; + /* POLICY: same bcdUSB and device type info at both speeds */ + qual->bcdUSB = cdev->desc.bcdUSB; + qual->bDeviceClass = cdev->desc.bDeviceClass; + qual->bDeviceSubClass = cdev->desc.bDeviceSubClass; + qual->bDeviceProtocol = cdev->desc.bDeviceProtocol; + /* ASSUME same EP0 fifo size at both speeds */ + qual->bMaxPacketSize0 = cdev->desc.bMaxPacketSize0; + qual->bNumConfigurations = count_configs(cdev, USB_DT_DEVICE_QUALIFIER); + qual->bRESERVED = 0; +} + +static void reset_config(struct usb_composite_dev *cdev) +{ + struct usb_function *f; + + debug("%s:\n", __func__); + + list_for_each_entry(f, &cdev->config->functions, list) { + if (f->disable) + f->disable(f); + + bitmap_zero(f->endpoints, 32); + } + cdev->config = NULL; +} + +static int set_config(struct usb_composite_dev *cdev, + const struct usb_ctrlrequest *ctrl, unsigned number) +{ + struct usb_gadget *gadget = cdev->gadget; + unsigned power = gadget_is_otg(gadget) ? 8 : 100; + struct usb_descriptor_header **descriptors; + int result = -EINVAL; + struct usb_endpoint_descriptor *ep; + struct usb_configuration *c = NULL; + int addr; + int tmp; + struct usb_function *f; + + if (cdev->config) + reset_config(cdev); + + if (number) { + list_for_each_entry(c, &cdev->configs, list) { + if (c->bConfigurationValue == number) { + result = 0; + break; + } + } + if (result < 0) + goto done; + } else + result = 0; + + debug("%s: %s speed config #%d: %s\n", __func__, + ({ char *speed; + switch (gadget->speed) { + case USB_SPEED_LOW: + speed = "low"; + break; + case USB_SPEED_FULL: + speed = "full"; + break; + case USB_SPEED_HIGH: + speed = "high"; + break; + default: + speed = "?"; + break; + }; + speed; + }), number, c ? c->label : "unconfigured"); + + if (!c) + goto done; + + cdev->config = c; + + /* Initialize all interfaces by setting them to altsetting zero. */ + for (tmp = 0; tmp < MAX_CONFIG_INTERFACES; tmp++) { + f = c->interface[tmp]; + if (!f) + break; + + /* + * Record which endpoints are used by the function. This is used + * to dispatch control requests targeted at that endpoint to the + * function's setup callback instead of the current + * configuration's setup callback. + */ + if (gadget->speed == USB_SPEED_HIGH) + descriptors = f->hs_descriptors; + else + descriptors = f->descriptors; + + for (; *descriptors; ++descriptors) { + if ((*descriptors)->bDescriptorType != USB_DT_ENDPOINT) + continue; + + ep = (struct usb_endpoint_descriptor *)*descriptors; + addr = ((ep->bEndpointAddress & 0x80) >> 3) + | (ep->bEndpointAddress & 0x0f); + __set_bit(addr, f->endpoints); + } + + result = f->set_alt(f, tmp, 0); + if (result < 0) { + debug("interface %d (%s/%p) alt 0 --> %d\n", + tmp, f->name, f, result); + + reset_config(cdev); + goto done; + } + } + + /* when we return, be sure our power usage is valid */ + power = c->bMaxPower ? (2 * c->bMaxPower) : CONFIG_USB_GADGET_VBUS_DRAW; +done: + usb_gadget_vbus_draw(gadget, power); + return result; +} + +/** + * usb_add_config() - add a configuration to a device. + * @cdev: wraps the USB gadget + * @config: the configuration, with bConfigurationValue assigned + * Context: single threaded during gadget setup + * + * One of the main tasks of a composite driver's bind() routine is to + * add each of the configurations it supports, using this routine. + * + * This function returns the value of the configuration's bind(), which + * is zero for success else a negative errno value. Binding configurations + * assigns global resources including string IDs, and per-configuration + * resources such as interface IDs and endpoints. + */ +int usb_add_config(struct usb_composite_dev *cdev, + struct usb_configuration *config) +{ + int status = -EINVAL; + struct usb_configuration *c; + struct usb_function *f; + unsigned int i; + + debug("%s: adding config #%u '%s'/%p\n", __func__, + config->bConfigurationValue, + config->label, config); + + if (!config->bConfigurationValue || !config->bind) + goto done; + + /* Prevent duplicate configuration identifiers */ + list_for_each_entry(c, &cdev->configs, list) { + if (c->bConfigurationValue == config->bConfigurationValue) { + status = -EBUSY; + goto done; + } + } + + config->cdev = cdev; + list_add_tail(&config->list, &cdev->configs); + + INIT_LIST_HEAD(&config->functions); + config->next_interface_id = 0; + + status = config->bind(config); + if (status < 0) { + list_del(&config->list); + config->cdev = NULL; + } else { + debug("cfg %d/%p speeds:%s%s\n", + config->bConfigurationValue, config, + config->highspeed ? " high" : "", + config->fullspeed + ? (gadget_is_dualspeed(cdev->gadget) + ? " full" + : " full/low") + : ""); + + for (i = 0; i < MAX_CONFIG_INTERFACES; i++) { + f = config->interface[i]; + if (!f) + continue; + debug("%s: interface %d = %s/%p\n", + __func__, i, f->name, f); + } + } + + usb_ep_autoconfig_reset(cdev->gadget); + +done: + if (status) + debug("added config '%s'/%u --> %d\n", config->label, + config->bConfigurationValue, status); + return status; +} + +/* + * We support strings in multiple languages ... string descriptor zero + * says which languages are supported. The typical case will be that + * only one language (probably English) is used, with I18N handled on + * the host side. + */ + +static void collect_langs(struct usb_gadget_strings **sp, __le16 *buf) +{ + const struct usb_gadget_strings *s; + u16 language; + __le16 *tmp; + + while (*sp) { + s = *sp; + language = cpu_to_le16(s->language); + for (tmp = buf; *tmp && tmp < &buf[126]; tmp++) { + if (*tmp == language) + goto repeat; + } + *tmp++ = language; +repeat: + sp++; + } +} + +static int lookup_string( + struct usb_gadget_strings **sp, + void *buf, + u16 language, + int id +) +{ + int value; + struct usb_gadget_strings *s; + + while (*sp) { + s = *sp++; + if (s->language != language) + continue; + value = usb_gadget_get_string(s, id, buf); + if (value > 0) + return value; + } + return -EINVAL; +} + +static int get_string(struct usb_composite_dev *cdev, + void *buf, u16 language, int id) +{ + struct usb_string_descriptor *s = buf; + struct usb_gadget_strings **sp; + int len; + struct usb_configuration *c; + struct usb_function *f; + + /* + * Yes, not only is USB's I18N support probably more than most + * folk will ever care about ... also, it's all supported here. + * (Except for UTF8 support for Unicode's "Astral Planes".) + */ + + /* 0 == report all available language codes */ + if (id == 0) { + memset(s, 0, 256); + s->bDescriptorType = USB_DT_STRING; + + sp = composite->strings; + if (sp) + collect_langs(sp, s->wData); + + list_for_each_entry(c, &cdev->configs, list) { + sp = c->strings; + if (sp) + collect_langs(sp, s->wData); + + list_for_each_entry(f, &c->functions, list) { + sp = f->strings; + if (sp) + collect_langs(sp, s->wData); + } + } + + for (len = 0; len <= 126 && s->wData[len]; len++) + continue; + if (!len) + return -EINVAL; + + s->bLength = 2 * (len + 1); + return s->bLength; + } + + /* + * Otherwise, look up and return a specified string. String IDs + * are device-scoped, so we look up each string table we're told + * about. These lookups are infrequent; simpler-is-better here. + */ + if (composite->strings) { + len = lookup_string(composite->strings, buf, language, id); + if (len > 0) + return len; + } + list_for_each_entry(c, &cdev->configs, list) { + if (c->strings) { + len = lookup_string(c->strings, buf, language, id); + if (len > 0) + return len; + } + list_for_each_entry(f, &c->functions, list) { + if (!f->strings) + continue; + len = lookup_string(f->strings, buf, language, id); + if (len > 0) + return len; + } + } + return -EINVAL; +} + +/** + * usb_string_id() - allocate an unused string ID + * @cdev: the device whose string descriptor IDs are being allocated + * Context: single threaded during gadget setup + * + * @usb_string_id() is called from bind() callbacks to allocate + * string IDs. Drivers for functions, configurations, or gadgets will + * then store that ID in the appropriate descriptors and string table. + * + * All string identifier should be allocated using this, + * @usb_string_ids_tab() or @usb_string_ids_n() routine, to ensure + * that for example different functions don't wrongly assign different + * meanings to the same identifier. + */ +int usb_string_id(struct usb_composite_dev *cdev) +{ + if (cdev->next_string_id < 254) { + /* + * string id 0 is reserved by USB spec for list of + * supported languages + * 255 reserved as well? -- mina86 + */ + cdev->next_string_id++; + return cdev->next_string_id; + } + return -ENODEV; +} + +/** + * usb_string_ids() - allocate unused string IDs in batch + * @cdev: the device whose string descriptor IDs are being allocated + * @str: an array of usb_string objects to assign numbers to + * Context: single threaded during gadget setup + * + * @usb_string_ids() is called from bind() callbacks to allocate + * string IDs. Drivers for functions, configurations, or gadgets will + * then copy IDs from the string table to the appropriate descriptors + * and string table for other languages. + * + * All string identifier should be allocated using this, + * @usb_string_id() or @usb_string_ids_n() routine, to ensure that for + * example different functions don't wrongly assign different meanings + * to the same identifier. + */ +int usb_string_ids_tab(struct usb_composite_dev *cdev, struct usb_string *str) +{ + u8 next = cdev->next_string_id; + + for (; str->s; ++str) { + if (next >= 254) + return -ENODEV; + str->id = ++next; + } + + cdev->next_string_id = next; + + return 0; +} + +/** + * usb_string_ids_n() - allocate unused string IDs in batch + * @c: the device whose string descriptor IDs are being allocated + * @n: number of string IDs to allocate + * Context: single threaded during gadget setup + * + * Returns the first requested ID. This ID and next @n-1 IDs are now + * valid IDs. At least provided that @n is non-zero because if it + * is, returns last requested ID which is now very useful information. + * + * @usb_string_ids_n() is called from bind() callbacks to allocate + * string IDs. Drivers for functions, configurations, or gadgets will + * then store that ID in the appropriate descriptors and string table. + * + * All string identifier should be allocated using this, + * @usb_string_id() or @usb_string_ids_n() routine, to ensure that for + * example different functions don't wrongly assign different meanings + * to the same identifier. + */ +int usb_string_ids_n(struct usb_composite_dev *c, unsigned n) +{ + u8 next = c->next_string_id; + + if (n > 254 || next + n > 254) + return -ENODEV; + + c->next_string_id += n; + return next + 1; +} + +static void composite_setup_complete(struct usb_ep *ep, struct usb_request *req) +{ + if (req->status || req->actual != req->length) + debug("%s: setup complete --> %d, %d/%d\n", __func__, + req->status, req->actual, req->length); +} + +/* + * The setup() callback implements all the ep0 functionality that's + * not handled lower down, in hardware or the hardware driver(like + * device and endpoint feature flags, and their status). It's all + * housekeeping for the gadget function we're implementing. Most of + * the work is in config and function specific setup. + */ +static int +composite_setup(struct usb_gadget *gadget, const struct usb_ctrlrequest *ctrl) +{ + u16 w_length = le16_to_cpu(ctrl->wLength); + u16 w_index = le16_to_cpu(ctrl->wIndex); + u16 w_value = le16_to_cpu(ctrl->wValue); + struct usb_composite_dev *cdev = get_gadget_data(gadget); + u8 intf = w_index & 0xFF; + int value = -EOPNOTSUPP; + struct usb_request *req = cdev->req; + struct usb_function *f = NULL; + int standard; + u8 endp; + struct usb_configuration *c; + + /* + * partial re-init of the response message; the function or the + * gadget might need to intercept e.g. a control-OUT completion + * when we delegate to it. + */ + req->zero = 0; + req->complete = composite_setup_complete; + req->length = USB_BUFSIZ; + gadget->ep0->driver_data = cdev; + standard = (ctrl->bRequestType & USB_TYPE_MASK) + == USB_TYPE_STANDARD; + if (!standard) + goto unknown; + + switch (ctrl->bRequest) { + + /* we handle all standard USB descriptors */ + case USB_REQ_GET_DESCRIPTOR: + if (ctrl->bRequestType != USB_DIR_IN) + goto unknown; + switch (w_value >> 8) { + + case USB_DT_DEVICE: + cdev->desc.bNumConfigurations = + count_configs(cdev, USB_DT_DEVICE); + value = min(w_length, (u16) sizeof cdev->desc); + memcpy(req->buf, &cdev->desc, value); + break; + case USB_DT_DEVICE_QUALIFIER: + if (!gadget_is_dualspeed(gadget)) + break; + device_qual(cdev); + value = min_t(w_length, + sizeof(struct usb_qualifier_descriptor)); + break; + case USB_DT_OTHER_SPEED_CONFIG: + if (!gadget_is_dualspeed(gadget)) + break; + + case USB_DT_CONFIG: + value = config_desc(cdev, w_value); + if (value >= 0) + value = min(w_length, (u16) value); + break; + case USB_DT_STRING: + value = get_string(cdev, req->buf, + w_index, w_value & 0xff); + if (value >= 0) + value = min(w_length, (u16) value); + break; + default: + goto unknown; + } + break; + + /* any number of configs can work */ + case USB_REQ_SET_CONFIGURATION: + if (ctrl->bRequestType != 0) + goto unknown; + if (gadget_is_otg(gadget)) { + if (gadget->a_hnp_support) + debug("HNP available\n"); + else if (gadget->a_alt_hnp_support) + debug("HNP on another port\n"); + else + debug("HNP inactive\n"); + } + + value = set_config(cdev, ctrl, w_value); + break; + case USB_REQ_GET_CONFIGURATION: + if (ctrl->bRequestType != USB_DIR_IN) + goto unknown; + if (cdev->config) + *(u8 *)req->buf = cdev->config->bConfigurationValue; + else + *(u8 *)req->buf = 0; + value = min(w_length, (u16) 1); + break; + + /* + * function drivers must handle get/set altsetting; if there's + * no get() method, we know only altsetting zero works. + */ + case USB_REQ_SET_INTERFACE: + if (ctrl->bRequestType != USB_RECIP_INTERFACE) + goto unknown; + if (!cdev->config || w_index >= MAX_CONFIG_INTERFACES) + break; + f = cdev->config->interface[intf]; + if (!f) + break; + if (w_value && !f->set_alt) + break; + value = f->set_alt(f, w_index, w_value); + break; + case USB_REQ_GET_INTERFACE: + if (ctrl->bRequestType != (USB_DIR_IN|USB_RECIP_INTERFACE)) + goto unknown; + if (!cdev->config || w_index >= MAX_CONFIG_INTERFACES) + break; + f = cdev->config->interface[intf]; + if (!f) + break; + /* lots of interfaces only need altsetting zero... */ + value = f->get_alt ? f->get_alt(f, w_index) : 0; + if (value < 0) + break; + *((u8 *)req->buf) = value; + value = min(w_length, (u16) 1); + break; + default: +unknown: + debug("non-core control req%02x.%02x v%04x i%04x l%d\n", + ctrl->bRequestType, ctrl->bRequest, + w_value, w_index, w_length); + + /* + * functions always handle their interfaces and endpoints... + * punt other recipients (other, WUSB, ...) to the current + * configuration code. + */ + switch (ctrl->bRequestType & USB_RECIP_MASK) { + case USB_RECIP_INTERFACE: + f = cdev->config->interface[intf]; + break; + + case USB_RECIP_ENDPOINT: + endp = ((w_index & 0x80) >> 3) | (w_index & 0x0f); + list_for_each_entry(f, &cdev->config->functions, list) { + if (test_bit(endp, f->endpoints)) + break; + } + if (&f->list == &cdev->config->functions) + f = NULL; + break; + } + + if (f && f->setup) + value = f->setup(f, ctrl); + else { + c = cdev->config; + if (c && c->setup) + value = c->setup(c, ctrl); + } + + goto done; + } + + /* respond with data transfer before status phase? */ + if (value >= 0) { + req->length = value; + req->zero = value < w_length; + value = usb_ep_queue(gadget->ep0, req, GFP_KERNEL); + if (value < 0) { + debug("ep_queue --> %d\n", value); + req->status = 0; + composite_setup_complete(gadget->ep0, req); + } + } + +done: + /* device either stalls (value < 0) or reports success */ + return value; +} + +static void composite_disconnect(struct usb_gadget *gadget) +{ + struct usb_composite_dev *cdev = get_gadget_data(gadget); + + if (cdev->config) + reset_config(cdev); + if (composite->disconnect) + composite->disconnect(cdev); +} + +static void composite_unbind(struct usb_gadget *gadget) +{ + struct usb_composite_dev *cdev = get_gadget_data(gadget); + struct usb_configuration *c; + struct usb_function *f; + + /* + * composite_disconnect() must already have been called + * by the underlying peripheral controller driver! + * so there's no i/o concurrency that could affect the + * state protected by cdev->lock. + */ + BUG_ON(cdev->config); + + while (!list_empty(&cdev->configs)) { + c = list_first_entry(&cdev->configs, + struct usb_configuration, list); + while (!list_empty(&c->functions)) { + f = list_first_entry(&c->functions, + struct usb_function, list); + list_del(&f->list); + if (f->unbind) { + debug("unbind function '%s'/%p\n", + f->name, f); + f->unbind(c, f); + } + } + list_del(&c->list); + if (c->unbind) { + debug("unbind config '%s'/%p\n", c->label, c); + c->unbind(c); + } + } + if (composite->unbind) + composite->unbind(cdev); + + if (cdev->req) { + kfree(cdev->req->buf); + usb_ep_free_request(gadget->ep0, cdev->req); + } + kfree(cdev); + set_gadget_data(gadget, NULL); + + composite = NULL; +} + +static int composite_bind(struct usb_gadget *gadget) +{ + int status = -ENOMEM; + struct usb_composite_dev *cdev; + + cdev = calloc(sizeof *cdev, 1); + if (!cdev) + return status; + + cdev->gadget = gadget; + set_gadget_data(gadget, cdev); + INIT_LIST_HEAD(&cdev->configs); + + /* preallocate control response and buffer */ + cdev->req = usb_ep_alloc_request(gadget->ep0, GFP_KERNEL); + if (!cdev->req) + goto fail; + cdev->req->buf = kmalloc(USB_BUFSIZ, GFP_KERNEL); + if (!cdev->req->buf) + goto fail; + cdev->req->complete = composite_setup_complete; + gadget->ep0->driver_data = cdev; + + cdev->bufsiz = USB_BUFSIZ; + cdev->driver = composite; + + usb_gadget_set_selfpowered(gadget); + usb_ep_autoconfig_reset(cdev->gadget); + + status = composite->bind(cdev); + if (status < 0) + goto fail; + + cdev->desc = *composite->dev; + cdev->desc.bMaxPacketSize0 = gadget->ep0->maxpacket; + + debug("%s: ready\n", composite->name); + return 0; + +fail: + composite_unbind(gadget); + return status; +} + +static void +composite_suspend(struct usb_gadget *gadget) +{ + struct usb_composite_dev *cdev = get_gadget_data(gadget); + struct usb_function *f; + + debug("%s: suspend\n", __func__); + if (cdev->config) { + list_for_each_entry(f, &cdev->config->functions, list) { + if (f->suspend) + f->suspend(f); + } + } + if (composite->suspend) + composite->suspend(cdev); + + cdev->suspended = 1; +} + +static void +composite_resume(struct usb_gadget *gadget) +{ + struct usb_composite_dev *cdev = get_gadget_data(gadget); + struct usb_function *f; + + debug("%s: resume\n", __func__); + if (composite->resume) + composite->resume(cdev); + if (cdev->config) { + list_for_each_entry(f, &cdev->config->functions, list) { + if (f->resume) + f->resume(f); + } + } + + cdev->suspended = 0; +} + +static struct usb_gadget_driver composite_driver = { + .speed = USB_SPEED_HIGH, + + .bind = composite_bind, + .unbind = composite_unbind, + + .setup = composite_setup, + .disconnect = composite_disconnect, + + .suspend = composite_suspend, + .resume = composite_resume, +}; + +/** + * usb_composite_register() - register a composite driver + * @driver: the driver to register + * Context: single threaded during gadget setup + * + * This function is used to register drivers using the composite driver + * framework. The return value is zero, or a negative errno value. + * Those values normally come from the driver's @bind method, which does + * all the work of setting up the driver to match the hardware. + * + * On successful return, the gadget is ready to respond to requests from + * the host, unless one of its components invokes usb_gadget_disconnect() + * while it was binding. That would usually be done in order to wait for + * some userspace participation. + */ +int usb_composite_register(struct usb_composite_driver *driver) +{ + if (!driver || !driver->dev || !driver->bind || composite) + return -EINVAL; + + if (!driver->name) + driver->name = "composite"; + composite = driver; + + return usb_gadget_register_driver(&composite_driver); +} + +/** + * usb_composite_unregister() - unregister a composite driver + * @driver: the driver to unregister + * + * This function is used to unregister drivers using the composite + * driver framework. + */ +void usb_composite_unregister(struct usb_composite_driver *driver) +{ + if (composite != driver) + return; + usb_gadget_unregister_driver(&composite_driver); +} diff --git a/include/linux/usb/composite.h b/include/linux/usb/composite.h new file mode 100644 index 0000000..53cb095 --- /dev/null +++ b/include/linux/usb/composite.h @@ -0,0 +1,350 @@ +/* + * composite.h -- framework for usb gadgets which are composite devices + * + * Copyright (C) 2006-2008 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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef __LINUX_USB_COMPOSITE_H +#define __LINUX_USB_COMPOSITE_H + +/* + * This framework is an optional layer on top of the USB Gadget interface, + * making it easier to build (a) Composite devices, supporting multiple + * functions within any single configuration, and (b) Multi-configuration + * devices, also supporting multiple functions but without necessarily + * having more than one function per configuration. + * + * Example: a device with a single configuration supporting both network + * link and mass storage functions is a composite device. Those functions + * might alternatively be packaged in individual configurations, but in + * the composite model the host can use both functions at the same time. + */ + +#include <common.h> +#include <linux/usb/ch9.h> +#include <linux/usb/gadget.h> +#include <usb/lin_gadget_compat.h> + +struct usb_configuration; + +/** + * struct usb_function - describes one function of a configuration + * @name: For diagnostics, identifies the function. + * @strings: tables of strings, keyed by identifiers assigned during bind() + * and by language IDs provided in control requests + * @descriptors: Table of full (or low) speed descriptors, using interface and + * string identifiers assigned during @bind(). If this pointer is null, + * the function will not be available at full speed (or at low speed). + * @hs_descriptors: Table of high speed descriptors, using interface and + * string identifiers assigned during @bind(). If this pointer is null, + * the function will not be available at high speed. + * @config: assigned when @usb_add_function() is called; this is the + * configuration with which this function is associated. + * @bind: Before the gadget can register, all of its functions bind() to the + * available resources including string and interface identifiers used + * in interface or class descriptors; endpoints; I/O buffers; and so on. + * @unbind: Reverses @bind; called as a side effect of unregistering the + * driver which added this function. + * @set_alt: (REQUIRED) Reconfigures altsettings; function drivers may + * initialize usb_ep.driver data at this time (when it is used). + * Note that setting an interface to its current altsetting resets + * interface state, and that all interfaces have a disabled state. + * @get_alt: Returns the active altsetting. If this is not provided, + * then only altsetting zero is supported. + * @disable: (REQUIRED) Indicates the function should be disabled. Reasons + * include host resetting or reconfiguring the gadget, and disconnection. + * @setup: Used for interface-specific control requests. + * @suspend: Notifies functions when the host stops sending USB traffic. + * @resume: Notifies functions when the host restarts USB traffic. + * + * A single USB function uses one or more interfaces, and should in most + * cases support operation at both full and high speeds. Each function is + * associated by @usb_add_function() with a one configuration; that function + * causes @bind() to be called so resources can be allocated as part of + * setting up a gadget driver. Those resources include endpoints, which + * should be allocated using @usb_ep_autoconfig(). + * + * To support dual speed operation, a function driver provides descriptors + * for both high and full speed operation. Except in rare cases that don't + * involve bulk endpoints, each speed needs different endpoint descriptors. + * + * Function drivers choose their own strategies for managing instance data. + * The simplest strategy just declares it "static', which means the function + * can only be activated once. If the function needs to be exposed in more + * than one configuration at a given speed, it needs to support multiple + * usb_function structures (one for each configuration). + * + * A more complex strategy might encapsulate a @usb_function structure inside + * a driver-specific instance structure to allows multiple activations. An + * example of multiple activations might be a CDC ACM function that supports + * two or more distinct instances within the same configuration, providing + * several independent logical data links to a USB host. + */ +struct usb_function { + const char *name; + struct usb_gadget_strings **strings; + struct usb_descriptor_header **descriptors; + struct usb_descriptor_header **hs_descriptors; + + struct usb_configuration *config; + + /* REVISIT: bind() functions can be marked __init, which + * makes trouble for section mismatch analysis. See if + * we can't restructure things to avoid mismatching. + * Related: unbind() may kfree() but bind() won't... + */ + + /* configuration management: bind/unbind */ + int (*bind)(struct usb_configuration *, + struct usb_function *); + void (*unbind)(struct usb_configuration *, + struct usb_function *); + + /* runtime state management */ + int (*set_alt)(struct usb_function *, + unsigned interface, unsigned alt); + int (*get_alt)(struct usb_function *, + unsigned interface); + void (*disable)(struct usb_function *); + int (*setup)(struct usb_function *, + const struct usb_ctrlrequest *); + void (*suspend)(struct usb_function *); + void (*resume)(struct usb_function *); + + /* private: */ + /* internals */ + struct list_head list; + DECLARE_BITMAP(endpoints, 32); +}; + +int usb_add_function(struct usb_configuration *, struct usb_function *); + +int usb_function_deactivate(struct usb_function *); +int usb_function_activate(struct usb_function *); + +int usb_interface_id(struct usb_configuration *, struct usb_function *); + +/** + * ep_choose - select descriptor endpoint at current device speed + * @g: gadget, connected and running at some speed + * @hs: descriptor to use for high speed operation + * @fs: descriptor to use for full or low speed operation + */ +static inline struct usb_endpoint_descriptor * +ep_choose(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; +} + +#define MAX_CONFIG_INTERFACES 16 /* arbitrary; max 255 */ + +/** + * struct usb_configuration - represents one gadget configuration + * @label: For diagnostics, describes the configuration. + * @strings: Tables of strings, keyed by identifiers assigned during @bind() + * and by language IDs provided in control requests. + * @descriptors: Table of descriptors preceding all function descriptors. + * Examples include OTG and vendor-specific descriptors. + * @bind: Called from @usb_add_config() to allocate resources unique to this + * configuration and to call @usb_add_function() for each function used. + * @unbind: Reverses @bind; called as a side effect of unregistering the + * driver which added this configuration. + * @setup: Used to delegate control requests that aren't handled by standard + * device infrastructure or directed at a specific interface. + * @bConfigurationValue: Copied into configuration descriptor. + * @iConfiguration: Copied into configuration descriptor. + * @bmAttributes: Copied into configuration descriptor. + * @bMaxPower: Copied into configuration descriptor. + * @cdev: assigned by @usb_add_config() before calling @bind(); this is + * the device associated with this configuration. + * + * Configurations are building blocks for gadget drivers structured around + * function drivers. Simple USB gadgets require only one function and one + * configuration, and handle dual-speed hardware by always providing the same + * functionality. Slightly more complex gadgets may have more than one + * single-function configuration at a given speed; or have configurations + * that only work at one speed. + * + * Composite devices are, by definition, ones with configurations which + * include more than one function. + * + * The lifecycle of a usb_configuration includes allocation, initialization + * of the fields described above, and calling @usb_add_config() to set up + * internal data and bind it to a specific device. The configuration's + * @bind() method is then used to initialize all the functions and then + * call @usb_add_function() for them. + * + * Those functions would normally be independant of each other, but that's + * not mandatory. CDC WMC devices are an example where functions often + * depend on other functions, with some functions subsidiary to others. + * Such interdependency may be managed in any way, so long as all of the + * descriptors complete by the time the composite driver returns from + * its bind() routine. + */ +struct usb_configuration { + const char *label; + struct usb_gadget_strings **strings; + const struct usb_descriptor_header **descriptors; + + /* REVISIT: bind() functions can be marked __init, which + * makes trouble for section mismatch analysis. See if + * we can't restructure things to avoid mismatching... + */ + + /* configuration management: bind/unbind */ + int (*bind)(struct usb_configuration *); + void (*unbind)(struct usb_configuration *); + int (*setup)(struct usb_configuration *, + const struct usb_ctrlrequest *); + + /* fields in the config descriptor */ + u8 bConfigurationValue; + u8 iConfiguration; + u8 bmAttributes; + u8 bMaxPower; + + struct usb_composite_dev *cdev; + + /* private: */ + /* internals */ + struct list_head list; + struct list_head functions; + u8 next_interface_id; + unsigned highspeed:1; + unsigned fullspeed:1; + struct usb_function *interface[MAX_CONFIG_INTERFACES]; +}; + +int usb_add_config(struct usb_composite_dev *, + struct usb_configuration *); + +/** + * struct usb_composite_driver - groups configurations into a gadget + * @name: For diagnostics, identifies the driver. + * @dev: Template descriptor for the device, including default device + * identifiers. + * @strings: tables of strings, keyed by identifiers assigned during bind() + * and language IDs provided in control requests + * @bind: (REQUIRED) Used to allocate resources that are shared across the + * whole device, such as string IDs, and add its configurations using + * @usb_add_config(). This may fail by returning a negative errno + * value; it should return zero on successful initialization. + * @unbind: Reverses @bind(); called as a side effect of unregistering + * this driver. + * @disconnect: optional driver disconnect method + * @suspend: Notifies when the host stops sending USB traffic, + * after function notifications + * @resume: Notifies configuration when the host restarts USB traffic, + * before function notifications + * + * Devices default to reporting self powered operation. Devices which rely + * on bus powered operation should report this in their @bind() method. + * + * Before returning from @bind, various fields in the template descriptor + * may be overridden. These include the idVendor/idProduct/bcdDevice values + * normally to bind the appropriate host side driver, and the three strings + * (iManufacturer, iProduct, iSerialNumber) normally used to provide user + * meaningful device identifiers. (The strings will not be defined unless + * they are defined in @dev and @strings.) The correct ep0 maxpacket size + * is also reported, as defined by the underlying controller driver. + */ +struct usb_composite_driver { + const char *name; + const struct usb_device_descriptor *dev; + struct usb_gadget_strings **strings; + + /* REVISIT: bind() functions can be marked __init, which + * makes trouble for section mismatch analysis. See if + * we can't restructure things to avoid mismatching... + */ + + int (*bind)(struct usb_composite_dev *); + int (*unbind)(struct usb_composite_dev *); + + void (*disconnect)(struct usb_composite_dev *); + + /* global suspend hooks */ + void (*suspend)(struct usb_composite_dev *); + void (*resume)(struct usb_composite_dev *); +}; + +extern int usb_composite_register(struct usb_composite_driver *); +extern void usb_composite_unregister(struct usb_composite_driver *); + + +/** + * struct usb_composite_device - represents one composite usb gadget + * @gadget: read-only, abstracts the gadget's usb peripheral controller + * @req: used for control responses; buffer is pre-allocated + * @bufsiz: size of buffer pre-allocated in @req + * @config: the currently active configuration + * + * One of these devices is allocated and initialized before the + * associated device driver's bind() is called. + * + * OPEN ISSUE: it appears that some WUSB devices will need to be + * built by combining a normal (wired) gadget with a wireless one. + * This revision of the gadget framework should probably try to make + * sure doing that won't hurt too much. + * + * One notion for how to handle Wireless USB devices involves: + * (a) a second gadget here, discovery mechanism TBD, but likely + * needing separate "register/unregister WUSB gadget" calls; + * (b) updates to usb_gadget to include flags "is it wireless", + * "is it wired", plus (presumably in a wrapper structure) + * bandgroup and PHY info; + * (c) presumably a wireless_ep wrapping a usb_ep, and reporting + * wireless-specific parameters like maxburst and maxsequence; + * (d) configurations that are specific to wireless links; + * (e) function drivers that understand wireless configs and will + * support wireless for (additional) function instances; + * (f) a function to support association setup (like CBAF), not + * necessarily requiring a wireless adapter; + * (g) composite device setup that can create one or more wireless + * configs, including appropriate association setup support; + * (h) more, TBD. + */ +struct usb_composite_dev { + struct usb_gadget *gadget; + struct usb_request *req; + unsigned bufsiz; + + struct usb_configuration *config; + + /* private: */ + /* internals */ + unsigned int suspended:1; + struct usb_device_descriptor desc; + struct list_head configs; + struct usb_composite_driver *driver; + u8 next_string_id; + + /* the gadget driver won't enable the data pullup + * while the deactivation count is nonzero. + */ + unsigned deactivations; +}; + +extern int usb_string_id(struct usb_composite_dev *c); +extern int usb_string_ids_tab(struct usb_composite_dev *c, + struct usb_string *str); +extern int usb_string_ids_n(struct usb_composite_dev *c, unsigned n); + +#endif /* __LINUX_USB_COMPOSITE_H */ diff --git a/include/usb/lin_gadget_compat.h b/include/usb/lin_gadget_compat.h index fce3be7..47c6387 100644 --- a/include/usb/lin_gadget_compat.h +++ b/include/usb/lin_gadget_compat.h @@ -36,8 +36,8 @@ #define mutex_lock(...) #define mutex_unlock(...) -#define WARN_ON(x) if (x) {printf("WARNING in %s line %d\n" \ - , __FILE__, __LINE__); } +#define WARN_ON(x) do { if (x) printf("WARNING in %s line %d\n" \ + , __FILE__, __LINE__); } while (0) #define KERN_WARNING #define KERN_ERR @@ -56,6 +56,26 @@ #define __iomem #define min_t min + +#define BITS_PER_BYTE 8 +#define BITS_TO_LONGS(nr) \ + DIV_ROUND_UP(nr, BITS_PER_BYTE * sizeof(long)) +#define DECLARE_BITMAP(name, bits) \ + unsigned long name[BITS_TO_LONGS(bits)] + +#define small_const_nbits(nbits) \ + (__builtin_constant_p(nbits) && (nbits) <= BITS_PER_LONG) + +static inline void bitmap_zero(unsigned long *dst, int nbits) +{ + if (small_const_nbits(nbits)) + *dst = 0UL; + else { + int len = BITS_TO_LONGS(nbits) * sizeof(unsigned long); + memset(dst, 0, len); + } +} + #define dma_cache_maint(addr, size, mode) cache_flush() void cache_flush(void); -- 1.7.2.3 ^ permalink raw reply related [flat|nested] 9+ messages in thread
* [U-Boot] [RESEND PATCH 3/5] usb:gadget:composite USB composite gadget support 2012-05-02 11:11 ` [U-Boot] [RESEND PATCH 3/5] usb:gadget:composite USB composite gadget support Lukasz Majewski @ 2012-05-02 13:25 ` Marek Vasut 2012-05-02 15:47 ` [U-Boot] [RESEND++ " Lukasz Majewski 1 sibling, 0 replies; 9+ messages in thread From: Marek Vasut @ 2012-05-02 13:25 UTC (permalink / raw) To: u-boot Dear Lukasz Majewski, > USB Composite gadget implementation for u-boot. It builds on top > of USB UDC drivers. > > This commit is based on following files from Linux Kernel v2.6.36: This one still doens't apply -- fails at lin-gadget-compat ... can you rebase this particular one? I just pushed u-boot-usb with 1,2,4,5 of your patches > > ./include/linux/usb/composite.h > ./drivers/usb/gadget/composite.c > > SHA1: d187abb9a83e6c6b6e9f2ca17962bdeafb4bc903 > > Signed-off-by: Lukasz Majewski <l.majewski@samsung.com> > Signed-off-by: Kyungmin Park <kyungmin.park@samsung.com> > Cc: Marek Vasut <marex@denx.de> > > --- > Changes for v2: > - Squash the strict kernel files with u-boot compatibility layer. > - Removal of dead/kernel specific code > - Comments corrected according to u-boot coding style > --- > drivers/usb/gadget/composite.c | 1082 > +++++++++++++++++++++++++++++++++++++++ include/linux/usb/composite.h | > 350 +++++++++++++ > include/usb/lin_gadget_compat.h | 24 +- > 3 files changed, 1454 insertions(+), 2 deletions(-) > create mode 100644 drivers/usb/gadget/composite.c > create mode 100644 include/linux/usb/composite.h > > diff --git a/drivers/usb/gadget/composite.c > b/drivers/usb/gadget/composite.c new file mode 100644 > index 0000000..905077d > --- /dev/null > +++ b/drivers/usb/gadget/composite.c > @@ -0,0 +1,1082 @@ > +/* > + * composite.c - infrastructure for Composite USB Gadgets > + * > + * Copyright (C) 2006-2008 David Brownell > + * U-boot porting: Lukasz Majewski <l.majewski@samsung.com> > + * > + * 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 > USA + */ > +#undef DEBUG > + > +#include <linux/bitops.h> > +#include <linux/usb/composite.h> > + > +#define USB_BUFSIZ 4096 > + > +static struct usb_composite_driver *composite; > + > +/** > + * usb_add_function() - add a function to a configuration > + * @config: the configuration > + * @function: the function being added > + * Context: single threaded during gadget setup > + * > + * After initialization, each configuration must have one or more > + * functions added to it. Adding a function involves calling its @bind() > + * method to allocate resources such as interface and string identifiers > + * and endpoints. > + * > + * This function returns the value of the function's bind(), which is > + * zero for success else a negative errno value. > + */ > +int usb_add_function(struct usb_configuration *config, > + struct usb_function *function) > +{ > + int value = -EINVAL; > + > + debug("adding '%s'/%p to config '%s'/%p\n", > + function->name, function, > + config->label, config); > + > + if (!function->set_alt || !function->disable) > + goto done; > + > + function->config = config; > + list_add_tail(&function->list, &config->functions); > + > + if (function->bind) { > + value = function->bind(config, function); > + if (value < 0) { > + list_del(&function->list); > + function->config = NULL; > + } > + } else > + value = 0; > + > + if (!config->fullspeed && function->descriptors) > + config->fullspeed = 1; > + if (!config->highspeed && function->hs_descriptors) > + config->highspeed = 1; > + > +done: > + if (value) > + debug("adding '%s'/%p --> %d\n", > + function->name, function, value); > + return value; > +} > + > +/** > + * usb_function_deactivate - prevent function and gadget enumeration > + * @function: the function that isn't yet ready to respond > + * > + * Blocks response of the gadget driver to host enumeration by > + * preventing the data line pullup from being activated. This is > + * normally called during @bind() processing to change from the > + * initial "ready to respond" state, or when a required resource > + * becomes available. > + * > + * For example, drivers that serve as a passthrough to a userspace > + * daemon can block enumeration unless that daemon (such as an OBEX, > + * MTP, or print server) is ready to handle host requests. > + * > + * Not all systems support software control of their USB peripheral > + * data pullups. > + * > + * Returns zero on success, else negative errno. > + */ > +int usb_function_deactivate(struct usb_function *function) > +{ > + struct usb_composite_dev *cdev = function->config->cdev; > + int status = 0; > + > + if (cdev->deactivations == 0) > + status = usb_gadget_disconnect(cdev->gadget); > + if (status == 0) > + cdev->deactivations++; > + > + return status; > +} > + > +/** > + * usb_function_activate - allow function and gadget enumeration > + * @function: function on which usb_function_activate() was called > + * > + * Reverses effect of usb_function_deactivate(). If no more functions > + * are delaying their activation, the gadget driver will respond to > + * host enumeration procedures. > + * > + * Returns zero on success, else negative errno. > + */ > +int usb_function_activate(struct usb_function *function) > +{ > + struct usb_composite_dev *cdev = function->config->cdev; > + int status = 0; > + > + if (cdev->deactivations == 0) > + status = -EINVAL; > + else { > + cdev->deactivations--; > + if (cdev->deactivations == 0) > + status = usb_gadget_connect(cdev->gadget); > + } > + > + return status; > +} > + > +/** > + * usb_interface_id() - allocate an unused interface ID > + * @config: configuration associated with the interface > + * @function: function handling the interface > + * Context: single threaded during gadget setup > + * > + * usb_interface_id() is called from usb_function.bind() callbacks to > + * allocate new interface IDs. The function driver will then store that > + * ID in interface, association, CDC union, and other descriptors. It > + * will also handle any control requests targetted at that interface, > + * particularly changing its altsetting via set_alt(). There may > + * also be class-specific or vendor-specific requests to handle. > + * > + * All interface identifier should be allocated using this routine, to > + * ensure that for example different functions don't wrongly assign > + * different meanings to the same identifier. Note that since interface > + * identifers are configuration-specific, functions used in more than > + * one configuration (or more than once in a given configuration) need > + * multiple versions of the relevant descriptors. > + * > + * Returns the interface ID which was allocated; or -ENODEV if no > + * more interface IDs can be allocated. > + */ > +int usb_interface_id(struct usb_configuration *config, > + struct usb_function *function) > +{ > + unsigned char id = config->next_interface_id; > + > + if (id < MAX_CONFIG_INTERFACES) { > + config->interface[id] = function; > + config->next_interface_id = id + 1; > + return id; > + } > + return -ENODEV; > +} > + > +static int config_buf(struct usb_configuration *config, > + enum usb_device_speed speed, void *buf, u8 type) > +{ > + int len = USB_BUFSIZ - USB_DT_CONFIG_SIZE; > + void *next = buf + USB_DT_CONFIG_SIZE; > + struct usb_descriptor_header **descriptors; > + struct usb_config_descriptor *c = buf; > + int status; > + struct usb_function *f; > + > + /* write the config descriptor */ > + c = buf; > + c->bLength = USB_DT_CONFIG_SIZE; > + c->bDescriptorType = type; > + > + c->bNumInterfaces = config->next_interface_id; > + c->bConfigurationValue = config->bConfigurationValue; > + c->iConfiguration = config->iConfiguration; > + c->bmAttributes = USB_CONFIG_ATT_ONE | config->bmAttributes; > + c->bMaxPower = config->bMaxPower ? : (CONFIG_USB_GADGET_VBUS_DRAW / 2); > + > + /* There may be e.g. OTG descriptors */ > + if (config->descriptors) { > + status = usb_descriptor_fillbuf(next, len, > + config->descriptors); > + if (status < 0) > + return status; > + len -= status; > + next += status; > + } > + > + /* add each function's descriptors */ > + list_for_each_entry(f, &config->functions, list) { > + if (speed == USB_SPEED_HIGH) > + descriptors = f->hs_descriptors; > + else > + descriptors = f->descriptors; > + if (!descriptors) > + continue; > + status = usb_descriptor_fillbuf(next, len, > + (const struct usb_descriptor_header **) descriptors); > + if (status < 0) > + return status; > + len -= status; > + next += status; > + } > + > + len = next - buf; > + c->wTotalLength = cpu_to_le16(len); > + return len; > +} > + > +static int config_desc(struct usb_composite_dev *cdev, unsigned w_value) > +{ > + enum usb_device_speed speed = USB_SPEED_UNKNOWN; > + struct usb_gadget *gadget = cdev->gadget; > + u8 type = w_value >> 8; > + int hs = 0; > + struct usb_configuration *c; > + > + if (gadget_is_dualspeed(gadget)) { > + if (gadget->speed == USB_SPEED_HIGH) > + hs = 1; > + if (type == USB_DT_OTHER_SPEED_CONFIG) > + hs = !hs; > + if (hs) > + speed = USB_SPEED_HIGH; > + } > + > + w_value &= 0xff; > + list_for_each_entry(c, &cdev->configs, list) { > + if (speed == USB_SPEED_HIGH) { > + if (!c->highspeed) > + continue; > + } else { > + if (!c->fullspeed) > + continue; > + } > + if (w_value == 0) > + return config_buf(c, speed, cdev->req->buf, type); > + w_value--; > + } > + return -EINVAL; > +} > + > +static int count_configs(struct usb_composite_dev *cdev, unsigned type) > +{ > + struct usb_gadget *gadget = cdev->gadget; > + unsigned count = 0; > + int hs = 0; > + struct usb_configuration *c; > + > + if (gadget_is_dualspeed(gadget)) { > + if (gadget->speed == USB_SPEED_HIGH) > + hs = 1; > + if (type == USB_DT_DEVICE_QUALIFIER) > + hs = !hs; > + } > + list_for_each_entry(c, &cdev->configs, list) { > + /* ignore configs that won't work at this speed */ > + if (hs) { > + if (!c->highspeed) > + continue; > + } else { > + if (!c->fullspeed) > + continue; > + } > + count++; > + } > + return count; > +} > + > +static void device_qual(struct usb_composite_dev *cdev) > +{ > + struct usb_qualifier_descriptor *qual = cdev->req->buf; > + > + qual->bLength = sizeof(*qual); > + qual->bDescriptorType = USB_DT_DEVICE_QUALIFIER; > + /* POLICY: same bcdUSB and device type info at both speeds */ > + qual->bcdUSB = cdev->desc.bcdUSB; > + qual->bDeviceClass = cdev->desc.bDeviceClass; > + qual->bDeviceSubClass = cdev->desc.bDeviceSubClass; > + qual->bDeviceProtocol = cdev->desc.bDeviceProtocol; > + /* ASSUME same EP0 fifo size at both speeds */ > + qual->bMaxPacketSize0 = cdev->desc.bMaxPacketSize0; > + qual->bNumConfigurations = count_configs(cdev, USB_DT_DEVICE_QUALIFIER); > + qual->bRESERVED = 0; > +} > + > +static void reset_config(struct usb_composite_dev *cdev) > +{ > + struct usb_function *f; > + > + debug("%s:\n", __func__); > + > + list_for_each_entry(f, &cdev->config->functions, list) { > + if (f->disable) > + f->disable(f); > + > + bitmap_zero(f->endpoints, 32); > + } > + cdev->config = NULL; > +} > + > +static int set_config(struct usb_composite_dev *cdev, > + const struct usb_ctrlrequest *ctrl, unsigned number) > +{ > + struct usb_gadget *gadget = cdev->gadget; > + unsigned power = gadget_is_otg(gadget) ? 8 : 100; > + struct usb_descriptor_header **descriptors; > + int result = -EINVAL; > + struct usb_endpoint_descriptor *ep; > + struct usb_configuration *c = NULL; > + int addr; > + int tmp; > + struct usb_function *f; > + > + if (cdev->config) > + reset_config(cdev); > + > + if (number) { > + list_for_each_entry(c, &cdev->configs, list) { > + if (c->bConfigurationValue == number) { > + result = 0; > + break; > + } > + } > + if (result < 0) > + goto done; > + } else > + result = 0; > + > + debug("%s: %s speed config #%d: %s\n", __func__, > + ({ char *speed; > + switch (gadget->speed) { > + case USB_SPEED_LOW: > + speed = "low"; > + break; > + case USB_SPEED_FULL: > + speed = "full"; > + break; > + case USB_SPEED_HIGH: > + speed = "high"; > + break; > + default: > + speed = "?"; > + break; > + }; > + speed; > + }), number, c ? c->label : "unconfigured"); > + > + if (!c) > + goto done; > + > + cdev->config = c; > + > + /* Initialize all interfaces by setting them to altsetting zero. */ > + for (tmp = 0; tmp < MAX_CONFIG_INTERFACES; tmp++) { > + f = c->interface[tmp]; > + if (!f) > + break; > + > + /* > + * Record which endpoints are used by the function. This is used > + * to dispatch control requests targeted at that endpoint to the > + * function's setup callback instead of the current > + * configuration's setup callback. > + */ > + if (gadget->speed == USB_SPEED_HIGH) > + descriptors = f->hs_descriptors; > + else > + descriptors = f->descriptors; > + > + for (; *descriptors; ++descriptors) { > + if ((*descriptors)->bDescriptorType != USB_DT_ENDPOINT) > + continue; > + > + ep = (struct usb_endpoint_descriptor *)*descriptors; > + addr = ((ep->bEndpointAddress & 0x80) >> 3) > + | (ep->bEndpointAddress & 0x0f); > + __set_bit(addr, f->endpoints); > + } > + > + result = f->set_alt(f, tmp, 0); > + if (result < 0) { > + debug("interface %d (%s/%p) alt 0 --> %d\n", > + tmp, f->name, f, result); > + > + reset_config(cdev); > + goto done; > + } > + } > + > + /* when we return, be sure our power usage is valid */ > + power = c->bMaxPower ? (2 * c->bMaxPower) : CONFIG_USB_GADGET_VBUS_DRAW; > +done: > + usb_gadget_vbus_draw(gadget, power); > + return result; > +} > + > +/** > + * usb_add_config() - add a configuration to a device. > + * @cdev: wraps the USB gadget > + * @config: the configuration, with bConfigurationValue assigned > + * Context: single threaded during gadget setup > + * > + * One of the main tasks of a composite driver's bind() routine is to > + * add each of the configurations it supports, using this routine. > + * > + * This function returns the value of the configuration's bind(), which > + * is zero for success else a negative errno value. Binding > configurations + * assigns global resources including string IDs, and > per-configuration + * resources such as interface IDs and endpoints. > + */ > +int usb_add_config(struct usb_composite_dev *cdev, > + struct usb_configuration *config) > +{ > + int status = -EINVAL; > + struct usb_configuration *c; > + struct usb_function *f; > + unsigned int i; > + > + debug("%s: adding config #%u '%s'/%p\n", __func__, > + config->bConfigurationValue, > + config->label, config); > + > + if (!config->bConfigurationValue || !config->bind) > + goto done; > + > + /* Prevent duplicate configuration identifiers */ > + list_for_each_entry(c, &cdev->configs, list) { > + if (c->bConfigurationValue == config->bConfigurationValue) { > + status = -EBUSY; > + goto done; > + } > + } > + > + config->cdev = cdev; > + list_add_tail(&config->list, &cdev->configs); > + > + INIT_LIST_HEAD(&config->functions); > + config->next_interface_id = 0; > + > + status = config->bind(config); > + if (status < 0) { > + list_del(&config->list); > + config->cdev = NULL; > + } else { > + debug("cfg %d/%p speeds:%s%s\n", > + config->bConfigurationValue, config, > + config->highspeed ? " high" : "", > + config->fullspeed > + ? (gadget_is_dualspeed(cdev->gadget) > + ? " full" > + : " full/low") > + : ""); > + > + for (i = 0; i < MAX_CONFIG_INTERFACES; i++) { > + f = config->interface[i]; > + if (!f) > + continue; > + debug("%s: interface %d = %s/%p\n", > + __func__, i, f->name, f); > + } > + } > + > + usb_ep_autoconfig_reset(cdev->gadget); > + > +done: > + if (status) > + debug("added config '%s'/%u --> %d\n", config->label, > + config->bConfigurationValue, status); > + return status; > +} > + > +/* > + * We support strings in multiple languages ... string descriptor zero > + * says which languages are supported. The typical case will be that > + * only one language (probably English) is used, with I18N handled on > + * the host side. > + */ > + > +static void collect_langs(struct usb_gadget_strings **sp, __le16 *buf) > +{ > + const struct usb_gadget_strings *s; > + u16 language; > + __le16 *tmp; > + > + while (*sp) { > + s = *sp; > + language = cpu_to_le16(s->language); > + for (tmp = buf; *tmp && tmp < &buf[126]; tmp++) { > + if (*tmp == language) > + goto repeat; > + } > + *tmp++ = language; > +repeat: > + sp++; > + } > +} > + > +static int lookup_string( > + struct usb_gadget_strings **sp, > + void *buf, > + u16 language, > + int id > +) > +{ > + int value; > + struct usb_gadget_strings *s; > + > + while (*sp) { > + s = *sp++; > + if (s->language != language) > + continue; > + value = usb_gadget_get_string(s, id, buf); > + if (value > 0) > + return value; > + } > + return -EINVAL; > +} > + > +static int get_string(struct usb_composite_dev *cdev, > + void *buf, u16 language, int id) > +{ > + struct usb_string_descriptor *s = buf; > + struct usb_gadget_strings **sp; > + int len; > + struct usb_configuration *c; > + struct usb_function *f; > + > + /* > + * Yes, not only is USB's I18N support probably more than most > + * folk will ever care about ... also, it's all supported here. > + * (Except for UTF8 support for Unicode's "Astral Planes".) > + */ > + > + /* 0 == report all available language codes */ > + if (id == 0) { > + memset(s, 0, 256); > + s->bDescriptorType = USB_DT_STRING; > + > + sp = composite->strings; > + if (sp) > + collect_langs(sp, s->wData); > + > + list_for_each_entry(c, &cdev->configs, list) { > + sp = c->strings; > + if (sp) > + collect_langs(sp, s->wData); > + > + list_for_each_entry(f, &c->functions, list) { > + sp = f->strings; > + if (sp) > + collect_langs(sp, s->wData); > + } > + } > + > + for (len = 0; len <= 126 && s->wData[len]; len++) > + continue; > + if (!len) > + return -EINVAL; > + > + s->bLength = 2 * (len + 1); > + return s->bLength; > + } > + > + /* > + * Otherwise, look up and return a specified string. String IDs > + * are device-scoped, so we look up each string table we're told > + * about. These lookups are infrequent; simpler-is-better here. > + */ > + if (composite->strings) { > + len = lookup_string(composite->strings, buf, language, id); > + if (len > 0) > + return len; > + } > + list_for_each_entry(c, &cdev->configs, list) { > + if (c->strings) { > + len = lookup_string(c->strings, buf, language, id); > + if (len > 0) > + return len; > + } > + list_for_each_entry(f, &c->functions, list) { > + if (!f->strings) > + continue; > + len = lookup_string(f->strings, buf, language, id); > + if (len > 0) > + return len; > + } > + } > + return -EINVAL; > +} > + > +/** > + * usb_string_id() - allocate an unused string ID > + * @cdev: the device whose string descriptor IDs are being allocated > + * Context: single threaded during gadget setup > + * > + * @usb_string_id() is called from bind() callbacks to allocate > + * string IDs. Drivers for functions, configurations, or gadgets will > + * then store that ID in the appropriate descriptors and string table. > + * > + * All string identifier should be allocated using this, > + * @usb_string_ids_tab() or @usb_string_ids_n() routine, to ensure > + * that for example different functions don't wrongly assign different > + * meanings to the same identifier. > + */ > +int usb_string_id(struct usb_composite_dev *cdev) > +{ > + if (cdev->next_string_id < 254) { > + /* > + * string id 0 is reserved by USB spec for list of > + * supported languages > + * 255 reserved as well? -- mina86 > + */ > + cdev->next_string_id++; > + return cdev->next_string_id; > + } > + return -ENODEV; > +} > + > +/** > + * usb_string_ids() - allocate unused string IDs in batch > + * @cdev: the device whose string descriptor IDs are being allocated > + * @str: an array of usb_string objects to assign numbers to > + * Context: single threaded during gadget setup > + * > + * @usb_string_ids() is called from bind() callbacks to allocate > + * string IDs. Drivers for functions, configurations, or gadgets will > + * then copy IDs from the string table to the appropriate descriptors > + * and string table for other languages. > + * > + * All string identifier should be allocated using this, > + * @usb_string_id() or @usb_string_ids_n() routine, to ensure that for > + * example different functions don't wrongly assign different meanings > + * to the same identifier. > + */ > +int usb_string_ids_tab(struct usb_composite_dev *cdev, struct usb_string > *str) +{ > + u8 next = cdev->next_string_id; > + > + for (; str->s; ++str) { > + if (next >= 254) > + return -ENODEV; > + str->id = ++next; > + } > + > + cdev->next_string_id = next; > + > + return 0; > +} > + > +/** > + * usb_string_ids_n() - allocate unused string IDs in batch > + * @c: the device whose string descriptor IDs are being allocated > + * @n: number of string IDs to allocate > + * Context: single threaded during gadget setup > + * > + * Returns the first requested ID. This ID and next @n-1 IDs are now > + * valid IDs. At least provided that @n is non-zero because if it > + * is, returns last requested ID which is now very useful information. > + * > + * @usb_string_ids_n() is called from bind() callbacks to allocate > + * string IDs. Drivers for functions, configurations, or gadgets will > + * then store that ID in the appropriate descriptors and string table. > + * > + * All string identifier should be allocated using this, > + * @usb_string_id() or @usb_string_ids_n() routine, to ensure that for > + * example different functions don't wrongly assign different meanings > + * to the same identifier. > + */ > +int usb_string_ids_n(struct usb_composite_dev *c, unsigned n) > +{ > + u8 next = c->next_string_id; > + > + if (n > 254 || next + n > 254) > + return -ENODEV; > + > + c->next_string_id += n; > + return next + 1; > +} > + > +static void composite_setup_complete(struct usb_ep *ep, struct usb_request > *req) +{ > + if (req->status || req->actual != req->length) > + debug("%s: setup complete --> %d, %d/%d\n", __func__, > + req->status, req->actual, req->length); > +} > + > +/* > + * The setup() callback implements all the ep0 functionality that's > + * not handled lower down, in hardware or the hardware driver(like > + * device and endpoint feature flags, and their status). It's all > + * housekeeping for the gadget function we're implementing. Most of > + * the work is in config and function specific setup. > + */ > +static int > +composite_setup(struct usb_gadget *gadget, const struct usb_ctrlrequest > *ctrl) +{ > + u16 w_length = le16_to_cpu(ctrl->wLength); > + u16 w_index = le16_to_cpu(ctrl->wIndex); > + u16 w_value = le16_to_cpu(ctrl->wValue); > + struct usb_composite_dev *cdev = get_gadget_data(gadget); > + u8 intf = w_index & 0xFF; > + int value = -EOPNOTSUPP; > + struct usb_request *req = cdev->req; > + struct usb_function *f = NULL; > + int standard; > + u8 endp; > + struct usb_configuration *c; > + > + /* > + * partial re-init of the response message; the function or the > + * gadget might need to intercept e.g. a control-OUT completion > + * when we delegate to it. > + */ > + req->zero = 0; > + req->complete = composite_setup_complete; > + req->length = USB_BUFSIZ; > + gadget->ep0->driver_data = cdev; > + standard = (ctrl->bRequestType & USB_TYPE_MASK) > + == USB_TYPE_STANDARD; > + if (!standard) > + goto unknown; > + > + switch (ctrl->bRequest) { > + > + /* we handle all standard USB descriptors */ > + case USB_REQ_GET_DESCRIPTOR: > + if (ctrl->bRequestType != USB_DIR_IN) > + goto unknown; > + switch (w_value >> 8) { > + > + case USB_DT_DEVICE: > + cdev->desc.bNumConfigurations = > + count_configs(cdev, USB_DT_DEVICE); > + value = min(w_length, (u16) sizeof cdev->desc); > + memcpy(req->buf, &cdev->desc, value); > + break; > + case USB_DT_DEVICE_QUALIFIER: > + if (!gadget_is_dualspeed(gadget)) > + break; > + device_qual(cdev); > + value = min_t(w_length, > + sizeof(struct usb_qualifier_descriptor)); > + break; > + case USB_DT_OTHER_SPEED_CONFIG: > + if (!gadget_is_dualspeed(gadget)) > + break; > + > + case USB_DT_CONFIG: > + value = config_desc(cdev, w_value); > + if (value >= 0) > + value = min(w_length, (u16) value); > + break; > + case USB_DT_STRING: > + value = get_string(cdev, req->buf, > + w_index, w_value & 0xff); > + if (value >= 0) > + value = min(w_length, (u16) value); > + break; > + default: > + goto unknown; > + } > + break; > + > + /* any number of configs can work */ > + case USB_REQ_SET_CONFIGURATION: > + if (ctrl->bRequestType != 0) > + goto unknown; > + if (gadget_is_otg(gadget)) { > + if (gadget->a_hnp_support) > + debug("HNP available\n"); > + else if (gadget->a_alt_hnp_support) > + debug("HNP on another port\n"); > + else > + debug("HNP inactive\n"); > + } > + > + value = set_config(cdev, ctrl, w_value); > + break; > + case USB_REQ_GET_CONFIGURATION: > + if (ctrl->bRequestType != USB_DIR_IN) > + goto unknown; > + if (cdev->config) > + *(u8 *)req->buf = cdev->config->bConfigurationValue; > + else > + *(u8 *)req->buf = 0; > + value = min(w_length, (u16) 1); > + break; > + > + /* > + * function drivers must handle get/set altsetting; if there's > + * no get() method, we know only altsetting zero works. > + */ > + case USB_REQ_SET_INTERFACE: > + if (ctrl->bRequestType != USB_RECIP_INTERFACE) > + goto unknown; > + if (!cdev->config || w_index >= MAX_CONFIG_INTERFACES) > + break; > + f = cdev->config->interface[intf]; > + if (!f) > + break; > + if (w_value && !f->set_alt) > + break; > + value = f->set_alt(f, w_index, w_value); > + break; > + case USB_REQ_GET_INTERFACE: > + if (ctrl->bRequestType != (USB_DIR_IN|USB_RECIP_INTERFACE)) > + goto unknown; > + if (!cdev->config || w_index >= MAX_CONFIG_INTERFACES) > + break; > + f = cdev->config->interface[intf]; > + if (!f) > + break; > + /* lots of interfaces only need altsetting zero... */ > + value = f->get_alt ? f->get_alt(f, w_index) : 0; > + if (value < 0) > + break; > + *((u8 *)req->buf) = value; > + value = min(w_length, (u16) 1); > + break; > + default: > +unknown: > + debug("non-core control req%02x.%02x v%04x i%04x l%d\n", > + ctrl->bRequestType, ctrl->bRequest, > + w_value, w_index, w_length); > + > + /* > + * functions always handle their interfaces and endpoints... > + * punt other recipients (other, WUSB, ...) to the current > + * configuration code. > + */ > + switch (ctrl->bRequestType & USB_RECIP_MASK) { > + case USB_RECIP_INTERFACE: > + f = cdev->config->interface[intf]; > + break; > + > + case USB_RECIP_ENDPOINT: > + endp = ((w_index & 0x80) >> 3) | (w_index & 0x0f); > + list_for_each_entry(f, &cdev->config->functions, list) { > + if (test_bit(endp, f->endpoints)) > + break; > + } > + if (&f->list == &cdev->config->functions) > + f = NULL; > + break; > + } > + > + if (f && f->setup) > + value = f->setup(f, ctrl); > + else { > + c = cdev->config; > + if (c && c->setup) > + value = c->setup(c, ctrl); > + } > + > + goto done; > + } > + > + /* respond with data transfer before status phase? */ > + if (value >= 0) { > + req->length = value; > + req->zero = value < w_length; > + value = usb_ep_queue(gadget->ep0, req, GFP_KERNEL); > + if (value < 0) { > + debug("ep_queue --> %d\n", value); > + req->status = 0; > + composite_setup_complete(gadget->ep0, req); > + } > + } > + > +done: > + /* device either stalls (value < 0) or reports success */ > + return value; > +} > + > +static void composite_disconnect(struct usb_gadget *gadget) > +{ > + struct usb_composite_dev *cdev = get_gadget_data(gadget); > + > + if (cdev->config) > + reset_config(cdev); > + if (composite->disconnect) > + composite->disconnect(cdev); > +} > + > +static void composite_unbind(struct usb_gadget *gadget) > +{ > + struct usb_composite_dev *cdev = get_gadget_data(gadget); > + struct usb_configuration *c; > + struct usb_function *f; > + > + /* > + * composite_disconnect() must already have been called > + * by the underlying peripheral controller driver! > + * so there's no i/o concurrency that could affect the > + * state protected by cdev->lock. > + */ > + BUG_ON(cdev->config); > + > + while (!list_empty(&cdev->configs)) { > + c = list_first_entry(&cdev->configs, > + struct usb_configuration, list); > + while (!list_empty(&c->functions)) { > + f = list_first_entry(&c->functions, > + struct usb_function, list); > + list_del(&f->list); > + if (f->unbind) { > + debug("unbind function '%s'/%p\n", > + f->name, f); > + f->unbind(c, f); > + } > + } > + list_del(&c->list); > + if (c->unbind) { > + debug("unbind config '%s'/%p\n", c->label, c); > + c->unbind(c); > + } > + } > + if (composite->unbind) > + composite->unbind(cdev); > + > + if (cdev->req) { > + kfree(cdev->req->buf); > + usb_ep_free_request(gadget->ep0, cdev->req); > + } > + kfree(cdev); > + set_gadget_data(gadget, NULL); > + > + composite = NULL; > +} > + > +static int composite_bind(struct usb_gadget *gadget) > +{ > + int status = -ENOMEM; > + struct usb_composite_dev *cdev; > + > + cdev = calloc(sizeof *cdev, 1); > + if (!cdev) > + return status; > + > + cdev->gadget = gadget; > + set_gadget_data(gadget, cdev); > + INIT_LIST_HEAD(&cdev->configs); > + > + /* preallocate control response and buffer */ > + cdev->req = usb_ep_alloc_request(gadget->ep0, GFP_KERNEL); > + if (!cdev->req) > + goto fail; > + cdev->req->buf = kmalloc(USB_BUFSIZ, GFP_KERNEL); > + if (!cdev->req->buf) > + goto fail; > + cdev->req->complete = composite_setup_complete; > + gadget->ep0->driver_data = cdev; > + > + cdev->bufsiz = USB_BUFSIZ; > + cdev->driver = composite; > + > + usb_gadget_set_selfpowered(gadget); > + usb_ep_autoconfig_reset(cdev->gadget); > + > + status = composite->bind(cdev); > + if (status < 0) > + goto fail; > + > + cdev->desc = *composite->dev; > + cdev->desc.bMaxPacketSize0 = gadget->ep0->maxpacket; > + > + debug("%s: ready\n", composite->name); > + return 0; > + > +fail: > + composite_unbind(gadget); > + return status; > +} > + > +static void > +composite_suspend(struct usb_gadget *gadget) > +{ > + struct usb_composite_dev *cdev = get_gadget_data(gadget); > + struct usb_function *f; > + > + debug("%s: suspend\n", __func__); > + if (cdev->config) { > + list_for_each_entry(f, &cdev->config->functions, list) { > + if (f->suspend) > + f->suspend(f); > + } > + } > + if (composite->suspend) > + composite->suspend(cdev); > + > + cdev->suspended = 1; > +} > + > +static void > +composite_resume(struct usb_gadget *gadget) > +{ > + struct usb_composite_dev *cdev = get_gadget_data(gadget); > + struct usb_function *f; > + > + debug("%s: resume\n", __func__); > + if (composite->resume) > + composite->resume(cdev); > + if (cdev->config) { > + list_for_each_entry(f, &cdev->config->functions, list) { > + if (f->resume) > + f->resume(f); > + } > + } > + > + cdev->suspended = 0; > +} > + > +static struct usb_gadget_driver composite_driver = { > + .speed = USB_SPEED_HIGH, > + > + .bind = composite_bind, > + .unbind = composite_unbind, > + > + .setup = composite_setup, > + .disconnect = composite_disconnect, > + > + .suspend = composite_suspend, > + .resume = composite_resume, > +}; > + > +/** > + * usb_composite_register() - register a composite driver > + * @driver: the driver to register > + * Context: single threaded during gadget setup > + * > + * This function is used to register drivers using the composite driver > + * framework. The return value is zero, or a negative errno value. > + * Those values normally come from the driver's @bind method, which does > + * all the work of setting up the driver to match the hardware. > + * > + * On successful return, the gadget is ready to respond to requests from > + * the host, unless one of its components invokes usb_gadget_disconnect() > + * while it was binding. That would usually be done in order to wait for > + * some userspace participation. > + */ > +int usb_composite_register(struct usb_composite_driver *driver) > +{ > + if (!driver || !driver->dev || !driver->bind || composite) > + return -EINVAL; > + > + if (!driver->name) > + driver->name = "composite"; > + composite = driver; > + > + return usb_gadget_register_driver(&composite_driver); > +} > + > +/** > + * usb_composite_unregister() - unregister a composite driver > + * @driver: the driver to unregister > + * > + * This function is used to unregister drivers using the composite > + * driver framework. > + */ > +void usb_composite_unregister(struct usb_composite_driver *driver) > +{ > + if (composite != driver) > + return; > + usb_gadget_unregister_driver(&composite_driver); > +} > diff --git a/include/linux/usb/composite.h b/include/linux/usb/composite.h > new file mode 100644 > index 0000000..53cb095 > --- /dev/null > +++ b/include/linux/usb/composite.h > @@ -0,0 +1,350 @@ > +/* > + * composite.h -- framework for usb gadgets which are composite devices > + * > + * Copyright (C) 2006-2008 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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 > USA + */ > + > +#ifndef __LINUX_USB_COMPOSITE_H > +#define __LINUX_USB_COMPOSITE_H > + > +/* > + * This framework is an optional layer on top of the USB Gadget interface, > + * making it easier to build (a) Composite devices, supporting multiple > + * functions within any single configuration, and (b) Multi-configuration > + * devices, also supporting multiple functions but without necessarily > + * having more than one function per configuration. > + * > + * Example: a device with a single configuration supporting both network > + * link and mass storage functions is a composite device. Those functions > + * might alternatively be packaged in individual configurations, but in > + * the composite model the host can use both functions at the same time. > + */ > + > +#include <common.h> > +#include <linux/usb/ch9.h> > +#include <linux/usb/gadget.h> > +#include <usb/lin_gadget_compat.h> > + > +struct usb_configuration; > + > +/** > + * struct usb_function - describes one function of a configuration > + * @name: For diagnostics, identifies the function. > + * @strings: tables of strings, keyed by identifiers assigned during > bind() + * and by language IDs provided in control requests > + * @descriptors: Table of full (or low) speed descriptors, using interface > and + * string identifiers assigned during @bind(). If this pointer is > null, + * the function will not be available at full speed (or at low > speed). + * @hs_descriptors: Table of high speed descriptors, using > interface and + * string identifiers assigned during @bind(). If this > pointer is null, + * the function will not be available at high speed. > + * @config: assigned when @usb_add_function() is called; this is the > + * configuration with which this function is associated. > + * @bind: Before the gadget can register, all of its functions bind() to > the + * available resources including string and interface identifiers > used + * in interface or class descriptors; endpoints; I/O buffers; and so > on. + * @unbind: Reverses @bind; called as a side effect of unregistering > the + * driver which added this function. > + * @set_alt: (REQUIRED) Reconfigures altsettings; function drivers may > + * initialize usb_ep.driver data at this time (when it is used). > + * Note that setting an interface to its current altsetting resets > + * interface state, and that all interfaces have a disabled state. > + * @get_alt: Returns the active altsetting. If this is not provided, > + * then only altsetting zero is supported. > + * @disable: (REQUIRED) Indicates the function should be disabled. > Reasons + * include host resetting or reconfiguring the gadget, and > disconnection. + * @setup: Used for interface-specific control requests. > + * @suspend: Notifies functions when the host stops sending USB traffic. > + * @resume: Notifies functions when the host restarts USB traffic. > + * > + * A single USB function uses one or more interfaces, and should in most > + * cases support operation at both full and high speeds. Each function is > + * associated by @usb_add_function() with a one configuration; that > function + * causes @bind() to be called so resources can be allocated as > part of + * setting up a gadget driver. Those resources include > endpoints, which + * should be allocated using @usb_ep_autoconfig(). > + * > + * To support dual speed operation, a function driver provides descriptors > + * for both high and full speed operation. Except in rare cases that > don't + * involve bulk endpoints, each speed needs different endpoint > descriptors. + * > + * Function drivers choose their own strategies for managing instance > data. + * The simplest strategy just declares it "static', which means the > function + * can only be activated once. If the function needs to be > exposed in more + * than one configuration at a given speed, it needs to > support multiple + * usb_function structures (one for each configuration). > + * > + * A more complex strategy might encapsulate a @usb_function structure > inside + * a driver-specific instance structure to allows multiple > activations. An + * example of multiple activations might be a CDC ACM > function that supports + * two or more distinct instances within the same > configuration, providing + * several independent logical data links to a > USB host. > + */ > +struct usb_function { > + const char *name; > + struct usb_gadget_strings **strings; > + struct usb_descriptor_header **descriptors; > + struct usb_descriptor_header **hs_descriptors; > + > + struct usb_configuration *config; > + > + /* REVISIT: bind() functions can be marked __init, which > + * makes trouble for section mismatch analysis. See if > + * we can't restructure things to avoid mismatching. > + * Related: unbind() may kfree() but bind() won't... > + */ > + > + /* configuration management: bind/unbind */ > + int (*bind)(struct usb_configuration *, > + struct usb_function *); > + void (*unbind)(struct usb_configuration *, > + struct usb_function *); > + > + /* runtime state management */ > + int (*set_alt)(struct usb_function *, > + unsigned interface, unsigned alt); > + int (*get_alt)(struct usb_function *, > + unsigned interface); > + void (*disable)(struct usb_function *); > + int (*setup)(struct usb_function *, > + const struct usb_ctrlrequest *); > + void (*suspend)(struct usb_function *); > + void (*resume)(struct usb_function *); > + > + /* private: */ > + /* internals */ > + struct list_head list; > + DECLARE_BITMAP(endpoints, 32); > +}; > + > +int usb_add_function(struct usb_configuration *, struct usb_function *); > + > +int usb_function_deactivate(struct usb_function *); > +int usb_function_activate(struct usb_function *); > + > +int usb_interface_id(struct usb_configuration *, struct usb_function *); > + > +/** > + * ep_choose - select descriptor endpoint at current device speed > + * @g: gadget, connected and running at some speed > + * @hs: descriptor to use for high speed operation > + * @fs: descriptor to use for full or low speed operation > + */ > +static inline struct usb_endpoint_descriptor * > +ep_choose(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; > +} > + > +#define MAX_CONFIG_INTERFACES 16 /* arbitrary; max 255 */ > + > +/** > + * struct usb_configuration - represents one gadget configuration > + * @label: For diagnostics, describes the configuration. > + * @strings: Tables of strings, keyed by identifiers assigned during > @bind() + * and by language IDs provided in control requests. > + * @descriptors: Table of descriptors preceding all function descriptors. > + * Examples include OTG and vendor-specific descriptors. > + * @bind: Called from @usb_add_config() to allocate resources unique to > this + * configuration and to call @usb_add_function() for each function > used. + * @unbind: Reverses @bind; called as a side effect of > unregistering the + * driver which added this configuration. > + * @setup: Used to delegate control requests that aren't handled by > standard + * device infrastructure or directed at a specific interface. > + * @bConfigurationValue: Copied into configuration descriptor. > + * @iConfiguration: Copied into configuration descriptor. > + * @bmAttributes: Copied into configuration descriptor. > + * @bMaxPower: Copied into configuration descriptor. > + * @cdev: assigned by @usb_add_config() before calling @bind(); this is > + * the device associated with this configuration. > + * > + * Configurations are building blocks for gadget drivers structured around > + * function drivers. Simple USB gadgets require only one function and one > + * configuration, and handle dual-speed hardware by always providing the > same + * functionality. Slightly more complex gadgets may have more than > one + * single-function configuration at a given speed; or have > configurations + * that only work at one speed. > + * > + * Composite devices are, by definition, ones with configurations which > + * include more than one function. > + * > + * The lifecycle of a usb_configuration includes allocation, > initialization + * of the fields described above, and calling > @usb_add_config() to set up + * internal data and bind it to a specific > device. The configuration's + * @bind() method is then used to initialize > all the functions and then + * call @usb_add_function() for them. > + * > + * Those functions would normally be independant of each other, but that's > + * not mandatory. CDC WMC devices are an example where functions often > + * depend on other functions, with some functions subsidiary to others. > + * Such interdependency may be managed in any way, so long as all of the > + * descriptors complete by the time the composite driver returns from > + * its bind() routine. > + */ > +struct usb_configuration { > + const char *label; > + struct usb_gadget_strings **strings; > + const struct usb_descriptor_header **descriptors; > + > + /* REVISIT: bind() functions can be marked __init, which > + * makes trouble for section mismatch analysis. See if > + * we can't restructure things to avoid mismatching... > + */ > + > + /* configuration management: bind/unbind */ > + int (*bind)(struct usb_configuration *); > + void (*unbind)(struct usb_configuration *); > + int (*setup)(struct usb_configuration *, > + const struct usb_ctrlrequest *); > + > + /* fields in the config descriptor */ > + u8 bConfigurationValue; > + u8 iConfiguration; > + u8 bmAttributes; > + u8 bMaxPower; > + > + struct usb_composite_dev *cdev; > + > + /* private: */ > + /* internals */ > + struct list_head list; > + struct list_head functions; > + u8 next_interface_id; > + unsigned highspeed:1; > + unsigned fullspeed:1; > + struct usb_function *interface[MAX_CONFIG_INTERFACES]; > +}; > + > +int usb_add_config(struct usb_composite_dev *, > + struct usb_configuration *); > + > +/** > + * struct usb_composite_driver - groups configurations into a gadget > + * @name: For diagnostics, identifies the driver. > + * @dev: Template descriptor for the device, including default device > + * identifiers. > + * @strings: tables of strings, keyed by identifiers assigned during > bind() + * and language IDs provided in control requests > + * @bind: (REQUIRED) Used to allocate resources that are shared across the > + * whole device, such as string IDs, and add its configurations using > + * @usb_add_config(). This may fail by returning a negative errno > + * value; it should return zero on successful initialization. > + * @unbind: Reverses @bind(); called as a side effect of unregistering > + * this driver. > + * @disconnect: optional driver disconnect method > + * @suspend: Notifies when the host stops sending USB traffic, > + * after function notifications > + * @resume: Notifies configuration when the host restarts USB traffic, > + * before function notifications > + * > + * Devices default to reporting self powered operation. Devices which > rely + * on bus powered operation should report this in their @bind() > method. + * > + * Before returning from @bind, various fields in the template descriptor > + * may be overridden. These include the idVendor/idProduct/bcdDevice > values + * normally to bind the appropriate host side driver, and the > three strings + * (iManufacturer, iProduct, iSerialNumber) normally used > to provide user + * meaningful device identifiers. (The strings will not > be defined unless + * they are defined in @dev and @strings.) The correct > ep0 maxpacket size + * is also reported, as defined by the underlying > controller driver. + */ > +struct usb_composite_driver { > + const char *name; > + const struct usb_device_descriptor *dev; > + struct usb_gadget_strings **strings; > + > + /* REVISIT: bind() functions can be marked __init, which > + * makes trouble for section mismatch analysis. See if > + * we can't restructure things to avoid mismatching... > + */ > + > + int (*bind)(struct usb_composite_dev *); > + int (*unbind)(struct usb_composite_dev *); > + > + void (*disconnect)(struct usb_composite_dev *); > + > + /* global suspend hooks */ > + void (*suspend)(struct usb_composite_dev *); > + void (*resume)(struct usb_composite_dev *); > +}; > + > +extern int usb_composite_register(struct usb_composite_driver *); > +extern void usb_composite_unregister(struct usb_composite_driver *); > + > + > +/** > + * struct usb_composite_device - represents one composite usb gadget > + * @gadget: read-only, abstracts the gadget's usb peripheral controller > + * @req: used for control responses; buffer is pre-allocated > + * @bufsiz: size of buffer pre-allocated in @req > + * @config: the currently active configuration > + * > + * One of these devices is allocated and initialized before the > + * associated device driver's bind() is called. > + * > + * OPEN ISSUE: it appears that some WUSB devices will need to be > + * built by combining a normal (wired) gadget with a wireless one. > + * This revision of the gadget framework should probably try to make > + * sure doing that won't hurt too much. > + * > + * One notion for how to handle Wireless USB devices involves: > + * (a) a second gadget here, discovery mechanism TBD, but likely > + * needing separate "register/unregister WUSB gadget" calls; > + * (b) updates to usb_gadget to include flags "is it wireless", > + * "is it wired", plus (presumably in a wrapper structure) > + * bandgroup and PHY info; > + * (c) presumably a wireless_ep wrapping a usb_ep, and reporting > + * wireless-specific parameters like maxburst and maxsequence; > + * (d) configurations that are specific to wireless links; > + * (e) function drivers that understand wireless configs and will > + * support wireless for (additional) function instances; > + * (f) a function to support association setup (like CBAF), not > + * necessarily requiring a wireless adapter; > + * (g) composite device setup that can create one or more wireless > + * configs, including appropriate association setup support; > + * (h) more, TBD. > + */ > +struct usb_composite_dev { > + struct usb_gadget *gadget; > + struct usb_request *req; > + unsigned bufsiz; > + > + struct usb_configuration *config; > + > + /* private: */ > + /* internals */ > + unsigned int suspended:1; > + struct usb_device_descriptor desc; > + struct list_head configs; > + struct usb_composite_driver *driver; > + u8 next_string_id; > + > + /* the gadget driver won't enable the data pullup > + * while the deactivation count is nonzero. > + */ > + unsigned deactivations; > +}; > + > +extern int usb_string_id(struct usb_composite_dev *c); > +extern int usb_string_ids_tab(struct usb_composite_dev *c, > + struct usb_string *str); > +extern int usb_string_ids_n(struct usb_composite_dev *c, unsigned n); > + > +#endif /* __LINUX_USB_COMPOSITE_H */ > diff --git a/include/usb/lin_gadget_compat.h > b/include/usb/lin_gadget_compat.h index fce3be7..47c6387 100644 > --- a/include/usb/lin_gadget_compat.h > +++ b/include/usb/lin_gadget_compat.h > @@ -36,8 +36,8 @@ > #define mutex_lock(...) > #define mutex_unlock(...) > > -#define WARN_ON(x) if (x) {printf("WARNING in %s line %d\n" \ > - , __FILE__, __LINE__); } > +#define WARN_ON(x) do { if (x) printf("WARNING in %s line %d\n" \ > + , __FILE__, __LINE__); } while (0) > > #define KERN_WARNING > #define KERN_ERR > @@ -56,6 +56,26 @@ > > #define __iomem > #define min_t min > + > +#define BITS_PER_BYTE 8 > +#define BITS_TO_LONGS(nr) \ > + DIV_ROUND_UP(nr, BITS_PER_BYTE * sizeof(long)) > +#define DECLARE_BITMAP(name, bits) \ > + unsigned long name[BITS_TO_LONGS(bits)] > + > +#define small_const_nbits(nbits) \ > + (__builtin_constant_p(nbits) && (nbits) <= BITS_PER_LONG) > + > +static inline void bitmap_zero(unsigned long *dst, int nbits) > +{ > + if (small_const_nbits(nbits)) > + *dst = 0UL; > + else { > + int len = BITS_TO_LONGS(nbits) * sizeof(unsigned long); > + memset(dst, 0, len); > + } > +} > + > #define dma_cache_maint(addr, size, mode) cache_flush() > void cache_flush(void); ^ permalink raw reply [flat|nested] 9+ messages in thread
* [U-Boot] [RESEND++ PATCH 3/5] usb:gadget:composite USB composite gadget support 2012-05-02 11:11 ` [U-Boot] [RESEND PATCH 3/5] usb:gadget:composite USB composite gadget support Lukasz Majewski 2012-05-02 13:25 ` Marek Vasut @ 2012-05-02 15:47 ` Lukasz Majewski 2012-05-02 15:49 ` Marek Vasut 1 sibling, 1 reply; 9+ messages in thread From: Lukasz Majewski @ 2012-05-02 15:47 UTC (permalink / raw) To: u-boot USB Composite gadget implementation for u-boot. It builds on top of USB UDC drivers. This commit is based on following files from Linux Kernel v2.6.36: ./include/linux/usb/composite.h ./drivers/usb/gadget/composite.c SHA1: d187abb9a83e6c6b6e9f2ca17962bdeafb4bc903 Signed-off-by: Lukasz Majewski <l.majewski@samsung.com> Signed-off-by: Kyungmin Park <kyungmin.park@samsung.com> Cc: Marek Vasut <marex@denx.de> --- drivers/usb/gadget/composite.c | 1082 +++++++++++++++++++++++++++++++++++++++ include/linux/usb/composite.h | 350 +++++++++++++ include/usb/lin_gadget_compat.h | 19 + 3 files changed, 1451 insertions(+), 0 deletions(-) create mode 100644 drivers/usb/gadget/composite.c create mode 100644 include/linux/usb/composite.h diff --git a/drivers/usb/gadget/composite.c b/drivers/usb/gadget/composite.c new file mode 100644 index 0000000..ebb5131 --- /dev/null +++ b/drivers/usb/gadget/composite.c @@ -0,0 +1,1082 @@ +/* + * composite.c - infrastructure for Composite USB Gadgets + * + * Copyright (C) 2006-2008 David Brownell + * U-boot porting: Lukasz Majewski <l.majewski@samsung.com> + * + * 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + */ +#undef DEBUG + +#include <linux/bitops.h> +#include <linux/usb/composite.h> + +#define USB_BUFSIZ 4096 + +static struct usb_composite_driver *composite; + +/** + * usb_add_function() - add a function to a configuration + * @config: the configuration + * @function: the function being added + * Context: single threaded during gadget setup + * + * After initialization, each configuration must have one or more + * functions added to it. Adding a function involves calling its @bind() + * method to allocate resources such as interface and string identifiers + * and endpoints. + * + * This function returns the value of the function's bind(), which is + * zero for success else a negative errno value. + */ +int usb_add_function(struct usb_configuration *config, + struct usb_function *function) +{ + int value = -EINVAL; + + debug("adding '%s'/%p to config '%s'/%p\n", + function->name, function, + config->label, config); + + if (!function->set_alt || !function->disable) + goto done; + + function->config = config; + list_add_tail(&function->list, &config->functions); + + if (function->bind) { + value = function->bind(config, function); + if (value < 0) { + list_del(&function->list); + function->config = NULL; + } + } else + value = 0; + + if (!config->fullspeed && function->descriptors) + config->fullspeed = 1; + if (!config->highspeed && function->hs_descriptors) + config->highspeed = 1; + +done: + if (value) + debug("adding '%s'/%p --> %d\n", + function->name, function, value); + return value; +} + +/** + * usb_function_deactivate - prevent function and gadget enumeration + * @function: the function that isn't yet ready to respond + * + * Blocks response of the gadget driver to host enumeration by + * preventing the data line pullup from being activated. This is + * normally called during @bind() processing to change from the + * initial "ready to respond" state, or when a required resource + * becomes available. + * + * For example, drivers that serve as a passthrough to a userspace + * daemon can block enumeration unless that daemon (such as an OBEX, + * MTP, or print server) is ready to handle host requests. + * + * Not all systems support software control of their USB peripheral + * data pullups. + * + * Returns zero on success, else negative errno. + */ +int usb_function_deactivate(struct usb_function *function) +{ + struct usb_composite_dev *cdev = function->config->cdev; + int status = 0; + + if (cdev->deactivations == 0) + status = usb_gadget_disconnect(cdev->gadget); + if (status == 0) + cdev->deactivations++; + + return status; +} + +/** + * usb_function_activate - allow function and gadget enumeration + * @function: function on which usb_function_activate() was called + * + * Reverses effect of usb_function_deactivate(). If no more functions + * are delaying their activation, the gadget driver will respond to + * host enumeration procedures. + * + * Returns zero on success, else negative errno. + */ +int usb_function_activate(struct usb_function *function) +{ + struct usb_composite_dev *cdev = function->config->cdev; + int status = 0; + + if (cdev->deactivations == 0) + status = -EINVAL; + else { + cdev->deactivations--; + if (cdev->deactivations == 0) + status = usb_gadget_connect(cdev->gadget); + } + + return status; +} + +/** + * usb_interface_id() - allocate an unused interface ID + * @config: configuration associated with the interface + * @function: function handling the interface + * Context: single threaded during gadget setup + * + * usb_interface_id() is called from usb_function.bind() callbacks to + * allocate new interface IDs. The function driver will then store that + * ID in interface, association, CDC union, and other descriptors. It + * will also handle any control requests targetted at that interface, + * particularly changing its altsetting via set_alt(). There may + * also be class-specific or vendor-specific requests to handle. + * + * All interface identifier should be allocated using this routine, to + * ensure that for example different functions don't wrongly assign + * different meanings to the same identifier. Note that since interface + * identifers are configuration-specific, functions used in more than + * one configuration (or more than once in a given configuration) need + * multiple versions of the relevant descriptors. + * + * Returns the interface ID which was allocated; or -ENODEV if no + * more interface IDs can be allocated. + */ +int usb_interface_id(struct usb_configuration *config, + struct usb_function *function) +{ + unsigned char id = config->next_interface_id; + + if (id < MAX_CONFIG_INTERFACES) { + config->interface[id] = function; + config->next_interface_id = id + 1; + return id; + } + return -ENODEV; +} + +static int config_buf(struct usb_configuration *config, + enum usb_device_speed speed, void *buf, u8 type) +{ + int len = USB_BUFSIZ - USB_DT_CONFIG_SIZE; + void *next = buf + USB_DT_CONFIG_SIZE; + struct usb_descriptor_header **descriptors; + struct usb_config_descriptor *c = buf; + int status; + struct usb_function *f; + + /* write the config descriptor */ + c = buf; + c->bLength = USB_DT_CONFIG_SIZE; + c->bDescriptorType = type; + + c->bNumInterfaces = config->next_interface_id; + c->bConfigurationValue = config->bConfigurationValue; + c->iConfiguration = config->iConfiguration; + c->bmAttributes = USB_CONFIG_ATT_ONE | config->bmAttributes; + c->bMaxPower = config->bMaxPower ? : (CONFIG_USB_GADGET_VBUS_DRAW / 2); + + /* There may be e.g. OTG descriptors */ + if (config->descriptors) { + status = usb_descriptor_fillbuf(next, len, + config->descriptors); + if (status < 0) + return status; + len -= status; + next += status; + } + + /* add each function's descriptors */ + list_for_each_entry(f, &config->functions, list) { + if (speed == USB_SPEED_HIGH) + descriptors = f->hs_descriptors; + else + descriptors = f->descriptors; + if (!descriptors) + continue; + status = usb_descriptor_fillbuf(next, len, + (const struct usb_descriptor_header **) descriptors); + if (status < 0) + return status; + len -= status; + next += status; + } + + len = next - buf; + c->wTotalLength = cpu_to_le16(len); + return len; +} + +static int config_desc(struct usb_composite_dev *cdev, unsigned w_value) +{ + enum usb_device_speed speed = USB_SPEED_UNKNOWN; + struct usb_gadget *gadget = cdev->gadget; + u8 type = w_value >> 8; + int hs = 0; + struct usb_configuration *c; + + if (gadget_is_dualspeed(gadget)) { + if (gadget->speed == USB_SPEED_HIGH) + hs = 1; + if (type == USB_DT_OTHER_SPEED_CONFIG) + hs = !hs; + if (hs) + speed = USB_SPEED_HIGH; + } + + w_value &= 0xff; + list_for_each_entry(c, &cdev->configs, list) { + if (speed == USB_SPEED_HIGH) { + if (!c->highspeed) + continue; + } else { + if (!c->fullspeed) + continue; + } + if (w_value == 0) + return config_buf(c, speed, cdev->req->buf, type); + w_value--; + } + return -EINVAL; +} + +static int count_configs(struct usb_composite_dev *cdev, unsigned type) +{ + struct usb_gadget *gadget = cdev->gadget; + unsigned count = 0; + int hs = 0; + struct usb_configuration *c; + + if (gadget_is_dualspeed(gadget)) { + if (gadget->speed == USB_SPEED_HIGH) + hs = 1; + if (type == USB_DT_DEVICE_QUALIFIER) + hs = !hs; + } + list_for_each_entry(c, &cdev->configs, list) { + /* ignore configs that won't work at this speed */ + if (hs) { + if (!c->highspeed) + continue; + } else { + if (!c->fullspeed) + continue; + } + count++; + } + return count; +} + +static void device_qual(struct usb_composite_dev *cdev) +{ + struct usb_qualifier_descriptor *qual = cdev->req->buf; + + qual->bLength = sizeof(*qual); + qual->bDescriptorType = USB_DT_DEVICE_QUALIFIER; + /* POLICY: same bcdUSB and device type info at both speeds */ + qual->bcdUSB = cdev->desc.bcdUSB; + qual->bDeviceClass = cdev->desc.bDeviceClass; + qual->bDeviceSubClass = cdev->desc.bDeviceSubClass; + qual->bDeviceProtocol = cdev->desc.bDeviceProtocol; + /* ASSUME same EP0 fifo size at both speeds */ + qual->bMaxPacketSize0 = cdev->desc.bMaxPacketSize0; + qual->bNumConfigurations = count_configs(cdev, USB_DT_DEVICE_QUALIFIER); + qual->bRESERVED = 0; +} + +static void reset_config(struct usb_composite_dev *cdev) +{ + struct usb_function *f; + + debug("%s:\n", __func__); + + list_for_each_entry(f, &cdev->config->functions, list) { + if (f->disable) + f->disable(f); + + bitmap_zero(f->endpoints, 32); + } + cdev->config = NULL; +} + +static int set_config(struct usb_composite_dev *cdev, + const struct usb_ctrlrequest *ctrl, unsigned number) +{ + struct usb_gadget *gadget = cdev->gadget; + unsigned power = gadget_is_otg(gadget) ? 8 : 100; + struct usb_descriptor_header **descriptors; + int result = -EINVAL; + struct usb_endpoint_descriptor *ep; + struct usb_configuration *c = NULL; + int addr; + int tmp; + struct usb_function *f; + + if (cdev->config) + reset_config(cdev); + + if (number) { + list_for_each_entry(c, &cdev->configs, list) { + if (c->bConfigurationValue == number) { + result = 0; + break; + } + } + if (result < 0) + goto done; + } else + result = 0; + + debug("%s: %s speed config #%d: %s\n", __func__, + ({ char *speed; + switch (gadget->speed) { + case USB_SPEED_LOW: + speed = "low"; + break; + case USB_SPEED_FULL: + speed = "full"; + break; + case USB_SPEED_HIGH: + speed = "high"; + break; + default: + speed = "?"; + break; + }; + speed; + }), number, c ? c->label : "unconfigured"); + + if (!c) + goto done; + + cdev->config = c; + + /* Initialize all interfaces by setting them to altsetting zero. */ + for (tmp = 0; tmp < MAX_CONFIG_INTERFACES; tmp++) { + f = c->interface[tmp]; + if (!f) + break; + + /* + * Record which endpoints are used by the function. This is used + * to dispatch control requests targeted at that endpoint to the + * function's setup callback instead of the current + * configuration's setup callback. + */ + if (gadget->speed == USB_SPEED_HIGH) + descriptors = f->hs_descriptors; + else + descriptors = f->descriptors; + + for (; *descriptors; ++descriptors) { + if ((*descriptors)->bDescriptorType != USB_DT_ENDPOINT) + continue; + + ep = (struct usb_endpoint_descriptor *)*descriptors; + addr = ((ep->bEndpointAddress & 0x80) >> 3) + | (ep->bEndpointAddress & 0x0f); + __set_bit(addr, f->endpoints); + } + + result = f->set_alt(f, tmp, 0); + if (result < 0) { + debug("interface %d (%s/%p) alt 0 --> %d\n", + tmp, f->name, f, result); + + reset_config(cdev); + goto done; + } + } + + /* when we return, be sure our power usage is valid */ + power = c->bMaxPower ? (2 * c->bMaxPower) : CONFIG_USB_GADGET_VBUS_DRAW; +done: + usb_gadget_vbus_draw(gadget, power); + return result; +} + +/** + * usb_add_config() - add a configuration to a device. + * @cdev: wraps the USB gadget + * @config: the configuration, with bConfigurationValue assigned + * Context: single threaded during gadget setup + * + * One of the main tasks of a composite driver's bind() routine is to + * add each of the configurations it supports, using this routine. + * + * This function returns the value of the configuration's bind(), which + * is zero for success else a negative errno value. Binding configurations + * assigns global resources including string IDs, and per-configuration + * resources such as interface IDs and endpoints. + */ +int usb_add_config(struct usb_composite_dev *cdev, + struct usb_configuration *config) +{ + int status = -EINVAL; + struct usb_configuration *c; + struct usb_function *f; + unsigned int i; + + debug("%s: adding config #%u '%s'/%p\n", __func__, + config->bConfigurationValue, + config->label, config); + + if (!config->bConfigurationValue || !config->bind) + goto done; + + /* Prevent duplicate configuration identifiers */ + list_for_each_entry(c, &cdev->configs, list) { + if (c->bConfigurationValue == config->bConfigurationValue) { + status = -EBUSY; + goto done; + } + } + + config->cdev = cdev; + list_add_tail(&config->list, &cdev->configs); + + INIT_LIST_HEAD(&config->functions); + config->next_interface_id = 0; + + status = config->bind(config); + if (status < 0) { + list_del(&config->list); + config->cdev = NULL; + } else { + debug("cfg %d/%p speeds:%s%s\n", + config->bConfigurationValue, config, + config->highspeed ? " high" : "", + config->fullspeed + ? (gadget_is_dualspeed(cdev->gadget) + ? " full" + : " full/low") + : ""); + + for (i = 0; i < MAX_CONFIG_INTERFACES; i++) { + f = config->interface[i]; + if (!f) + continue; + debug("%s: interface %d = %s/%p\n", + __func__, i, f->name, f); + } + } + + usb_ep_autoconfig_reset(cdev->gadget); + +done: + if (status) + debug("added config '%s'/%u --> %d\n", config->label, + config->bConfigurationValue, status); + return status; +} + +/* + * We support strings in multiple languages ... string descriptor zero + * says which languages are supported. The typical case will be that + * only one language (probably English) is used, with I18N handled on + * the host side. + */ + +static void collect_langs(struct usb_gadget_strings **sp, __le16 *buf) +{ + const struct usb_gadget_strings *s; + u16 language; + __le16 *tmp; + + while (*sp) { + s = *sp; + language = cpu_to_le16(s->language); + for (tmp = buf; *tmp && tmp < &buf[126]; tmp++) { + if (*tmp == language) + goto repeat; + } + *tmp++ = language; +repeat: + sp++; + } +} + +static int lookup_string( + struct usb_gadget_strings **sp, + void *buf, + u16 language, + int id +) +{ + int value; + struct usb_gadget_strings *s; + + while (*sp) { + s = *sp++; + if (s->language != language) + continue; + value = usb_gadget_get_string(s, id, buf); + if (value > 0) + return value; + } + return -EINVAL; +} + +static int get_string(struct usb_composite_dev *cdev, + void *buf, u16 language, int id) +{ + struct usb_string_descriptor *s = buf; + struct usb_gadget_strings **sp; + int len; + struct usb_configuration *c; + struct usb_function *f; + + /* + * Yes, not only is USB's I18N support probably more than most + * folk will ever care about ... also, it's all supported here. + * (Except for UTF8 support for Unicode's "Astral Planes".) + */ + + /* 0 == report all available language codes */ + if (id == 0) { + memset(s, 0, 256); + s->bDescriptorType = USB_DT_STRING; + + sp = composite->strings; + if (sp) + collect_langs(sp, s->wData); + + list_for_each_entry(c, &cdev->configs, list) { + sp = c->strings; + if (sp) + collect_langs(sp, s->wData); + + list_for_each_entry(f, &c->functions, list) { + sp = f->strings; + if (sp) + collect_langs(sp, s->wData); + } + } + + for (len = 0; len <= 126 && s->wData[len]; len++) + continue; + if (!len) + return -EINVAL; + + s->bLength = 2 * (len + 1); + return s->bLength; + } + + /* + * Otherwise, look up and return a specified string. String IDs + * are device-scoped, so we look up each string table we're told + * about. These lookups are infrequent; simpler-is-better here. + */ + if (composite->strings) { + len = lookup_string(composite->strings, buf, language, id); + if (len > 0) + return len; + } + list_for_each_entry(c, &cdev->configs, list) { + if (c->strings) { + len = lookup_string(c->strings, buf, language, id); + if (len > 0) + return len; + } + list_for_each_entry(f, &c->functions, list) { + if (!f->strings) + continue; + len = lookup_string(f->strings, buf, language, id); + if (len > 0) + return len; + } + } + return -EINVAL; +} + +/** + * usb_string_id() - allocate an unused string ID + * @cdev: the device whose string descriptor IDs are being allocated + * Context: single threaded during gadget setup + * + * @usb_string_id() is called from bind() callbacks to allocate + * string IDs. Drivers for functions, configurations, or gadgets will + * then store that ID in the appropriate descriptors and string table. + * + * All string identifier should be allocated using this, + * @usb_string_ids_tab() or @usb_string_ids_n() routine, to ensure + * that for example different functions don't wrongly assign different + * meanings to the same identifier. + */ +int usb_string_id(struct usb_composite_dev *cdev) +{ + if (cdev->next_string_id < 254) { + /* + * string id 0 is reserved by USB spec for list of + * supported languages + * 255 reserved as well? -- mina86 + */ + cdev->next_string_id++; + return cdev->next_string_id; + } + return -ENODEV; +} + +/** + * usb_string_ids() - allocate unused string IDs in batch + * @cdev: the device whose string descriptor IDs are being allocated + * @str: an array of usb_string objects to assign numbers to + * Context: single threaded during gadget setup + * + * @usb_string_ids() is called from bind() callbacks to allocate + * string IDs. Drivers for functions, configurations, or gadgets will + * then copy IDs from the string table to the appropriate descriptors + * and string table for other languages. + * + * All string identifier should be allocated using this, + * @usb_string_id() or @usb_string_ids_n() routine, to ensure that for + * example different functions don't wrongly assign different meanings + * to the same identifier. + */ +int usb_string_ids_tab(struct usb_composite_dev *cdev, struct usb_string *str) +{ + u8 next = cdev->next_string_id; + + for (; str->s; ++str) { + if (next >= 254) + return -ENODEV; + str->id = ++next; + } + + cdev->next_string_id = next; + + return 0; +} + +/** + * usb_string_ids_n() - allocate unused string IDs in batch + * @c: the device whose string descriptor IDs are being allocated + * @n: number of string IDs to allocate + * Context: single threaded during gadget setup + * + * Returns the first requested ID. This ID and next @n-1 IDs are now + * valid IDs. At least provided that @n is non-zero because if it + * is, returns last requested ID which is now very useful information. + * + * @usb_string_ids_n() is called from bind() callbacks to allocate + * string IDs. Drivers for functions, configurations, or gadgets will + * then store that ID in the appropriate descriptors and string table. + * + * All string identifier should be allocated using this, + * @usb_string_id() or @usb_string_ids_n() routine, to ensure that for + * example different functions don't wrongly assign different meanings + * to the same identifier. + */ +int usb_string_ids_n(struct usb_composite_dev *c, unsigned n) +{ + u8 next = c->next_string_id; + + if (n > 254 || next + n > 254) + return -ENODEV; + + c->next_string_id += n; + return next + 1; +} + +static void composite_setup_complete(struct usb_ep *ep, struct usb_request *req) +{ + if (req->status || req->actual != req->length) + debug("%s: setup complete --> %d, %d/%d\n", __func__, + req->status, req->actual, req->length); +} + +/* + * The setup() callback implements all the ep0 functionality that's + * not handled lower down, in hardware or the hardware driver(like + * device and endpoint feature flags, and their status). It's all + * housekeeping for the gadget function we're implementing. Most of + * the work is in config and function specific setup. + */ +static int +composite_setup(struct usb_gadget *gadget, const struct usb_ctrlrequest *ctrl) +{ + u16 w_length = le16_to_cpu(ctrl->wLength); + u16 w_index = le16_to_cpu(ctrl->wIndex); + u16 w_value = le16_to_cpu(ctrl->wValue); + struct usb_composite_dev *cdev = get_gadget_data(gadget); + u8 intf = w_index & 0xFF; + int value = -EOPNOTSUPP; + struct usb_request *req = cdev->req; + struct usb_function *f = NULL; + int standard; + u8 endp; + struct usb_configuration *c; + + /* + * partial re-init of the response message; the function or the + * gadget might need to intercept e.g. a control-OUT completion + * when we delegate to it. + */ + req->zero = 0; + req->complete = composite_setup_complete; + req->length = USB_BUFSIZ; + gadget->ep0->driver_data = cdev; + standard = (ctrl->bRequestType & USB_TYPE_MASK) + == USB_TYPE_STANDARD; + if (!standard) + goto unknown; + + switch (ctrl->bRequest) { + + /* we handle all standard USB descriptors */ + case USB_REQ_GET_DESCRIPTOR: + if (ctrl->bRequestType != USB_DIR_IN) + goto unknown; + switch (w_value >> 8) { + + case USB_DT_DEVICE: + cdev->desc.bNumConfigurations = + count_configs(cdev, USB_DT_DEVICE); + value = min(w_length, (u16) sizeof cdev->desc); + memcpy(req->buf, &cdev->desc, value); + break; + case USB_DT_DEVICE_QUALIFIER: + if (!gadget_is_dualspeed(gadget)) + break; + device_qual(cdev); + value = min(w_length, + sizeof(struct usb_qualifier_descriptor)); + break; + case USB_DT_OTHER_SPEED_CONFIG: + if (!gadget_is_dualspeed(gadget)) + break; + + case USB_DT_CONFIG: + value = config_desc(cdev, w_value); + if (value >= 0) + value = min(w_length, (u16) value); + break; + case USB_DT_STRING: + value = get_string(cdev, req->buf, + w_index, w_value & 0xff); + if (value >= 0) + value = min(w_length, (u16) value); + break; + default: + goto unknown; + } + break; + + /* any number of configs can work */ + case USB_REQ_SET_CONFIGURATION: + if (ctrl->bRequestType != 0) + goto unknown; + if (gadget_is_otg(gadget)) { + if (gadget->a_hnp_support) + debug("HNP available\n"); + else if (gadget->a_alt_hnp_support) + debug("HNP on another port\n"); + else + debug("HNP inactive\n"); + } + + value = set_config(cdev, ctrl, w_value); + break; + case USB_REQ_GET_CONFIGURATION: + if (ctrl->bRequestType != USB_DIR_IN) + goto unknown; + if (cdev->config) + *(u8 *)req->buf = cdev->config->bConfigurationValue; + else + *(u8 *)req->buf = 0; + value = min(w_length, (u16) 1); + break; + + /* + * function drivers must handle get/set altsetting; if there's + * no get() method, we know only altsetting zero works. + */ + case USB_REQ_SET_INTERFACE: + if (ctrl->bRequestType != USB_RECIP_INTERFACE) + goto unknown; + if (!cdev->config || w_index >= MAX_CONFIG_INTERFACES) + break; + f = cdev->config->interface[intf]; + if (!f) + break; + if (w_value && !f->set_alt) + break; + value = f->set_alt(f, w_index, w_value); + break; + case USB_REQ_GET_INTERFACE: + if (ctrl->bRequestType != (USB_DIR_IN|USB_RECIP_INTERFACE)) + goto unknown; + if (!cdev->config || w_index >= MAX_CONFIG_INTERFACES) + break; + f = cdev->config->interface[intf]; + if (!f) + break; + /* lots of interfaces only need altsetting zero... */ + value = f->get_alt ? f->get_alt(f, w_index) : 0; + if (value < 0) + break; + *((u8 *)req->buf) = value; + value = min(w_length, (u16) 1); + break; + default: +unknown: + debug("non-core control req%02x.%02x v%04x i%04x l%d\n", + ctrl->bRequestType, ctrl->bRequest, + w_value, w_index, w_length); + + /* + * functions always handle their interfaces and endpoints... + * punt other recipients (other, WUSB, ...) to the current + * configuration code. + */ + switch (ctrl->bRequestType & USB_RECIP_MASK) { + case USB_RECIP_INTERFACE: + f = cdev->config->interface[intf]; + break; + + case USB_RECIP_ENDPOINT: + endp = ((w_index & 0x80) >> 3) | (w_index & 0x0f); + list_for_each_entry(f, &cdev->config->functions, list) { + if (test_bit(endp, f->endpoints)) + break; + } + if (&f->list == &cdev->config->functions) + f = NULL; + break; + } + + if (f && f->setup) + value = f->setup(f, ctrl); + else { + c = cdev->config; + if (c && c->setup) + value = c->setup(c, ctrl); + } + + goto done; + } + + /* respond with data transfer before status phase? */ + if (value >= 0) { + req->length = value; + req->zero = value < w_length; + value = usb_ep_queue(gadget->ep0, req, GFP_KERNEL); + if (value < 0) { + debug("ep_queue --> %d\n", value); + req->status = 0; + composite_setup_complete(gadget->ep0, req); + } + } + +done: + /* device either stalls (value < 0) or reports success */ + return value; +} + +static void composite_disconnect(struct usb_gadget *gadget) +{ + struct usb_composite_dev *cdev = get_gadget_data(gadget); + + if (cdev->config) + reset_config(cdev); + if (composite->disconnect) + composite->disconnect(cdev); +} + +static void composite_unbind(struct usb_gadget *gadget) +{ + struct usb_composite_dev *cdev = get_gadget_data(gadget); + struct usb_configuration *c; + struct usb_function *f; + + /* + * composite_disconnect() must already have been called + * by the underlying peripheral controller driver! + * so there's no i/o concurrency that could affect the + * state protected by cdev->lock. + */ + BUG_ON(cdev->config); + + while (!list_empty(&cdev->configs)) { + c = list_first_entry(&cdev->configs, + struct usb_configuration, list); + while (!list_empty(&c->functions)) { + f = list_first_entry(&c->functions, + struct usb_function, list); + list_del(&f->list); + if (f->unbind) { + debug("unbind function '%s'/%p\n", + f->name, f); + f->unbind(c, f); + } + } + list_del(&c->list); + if (c->unbind) { + debug("unbind config '%s'/%p\n", c->label, c); + c->unbind(c); + } + } + if (composite->unbind) + composite->unbind(cdev); + + if (cdev->req) { + kfree(cdev->req->buf); + usb_ep_free_request(gadget->ep0, cdev->req); + } + kfree(cdev); + set_gadget_data(gadget, NULL); + + composite = NULL; +} + +static int composite_bind(struct usb_gadget *gadget) +{ + int status = -ENOMEM; + struct usb_composite_dev *cdev; + + cdev = calloc(sizeof *cdev, 1); + if (!cdev) + return status; + + cdev->gadget = gadget; + set_gadget_data(gadget, cdev); + INIT_LIST_HEAD(&cdev->configs); + + /* preallocate control response and buffer */ + cdev->req = usb_ep_alloc_request(gadget->ep0, GFP_KERNEL); + if (!cdev->req) + goto fail; + cdev->req->buf = memalign(CONFIG_SYS_CACHELINE_SIZE, USB_BUFSIZ); + if (!cdev->req->buf) + goto fail; + cdev->req->complete = composite_setup_complete; + gadget->ep0->driver_data = cdev; + + cdev->bufsiz = USB_BUFSIZ; + cdev->driver = composite; + + usb_gadget_set_selfpowered(gadget); + usb_ep_autoconfig_reset(cdev->gadget); + + status = composite->bind(cdev); + if (status < 0) + goto fail; + + cdev->desc = *composite->dev; + cdev->desc.bMaxPacketSize0 = gadget->ep0->maxpacket; + + debug("%s: ready\n", composite->name); + return 0; + +fail: + composite_unbind(gadget); + return status; +} + +static void +composite_suspend(struct usb_gadget *gadget) +{ + struct usb_composite_dev *cdev = get_gadget_data(gadget); + struct usb_function *f; + + debug("%s: suspend\n", __func__); + if (cdev->config) { + list_for_each_entry(f, &cdev->config->functions, list) { + if (f->suspend) + f->suspend(f); + } + } + if (composite->suspend) + composite->suspend(cdev); + + cdev->suspended = 1; +} + +static void +composite_resume(struct usb_gadget *gadget) +{ + struct usb_composite_dev *cdev = get_gadget_data(gadget); + struct usb_function *f; + + debug("%s: resume\n", __func__); + if (composite->resume) + composite->resume(cdev); + if (cdev->config) { + list_for_each_entry(f, &cdev->config->functions, list) { + if (f->resume) + f->resume(f); + } + } + + cdev->suspended = 0; +} + +static struct usb_gadget_driver composite_driver = { + .speed = USB_SPEED_HIGH, + + .bind = composite_bind, + .unbind = composite_unbind, + + .setup = composite_setup, + .disconnect = composite_disconnect, + + .suspend = composite_suspend, + .resume = composite_resume, +}; + +/** + * usb_composite_register() - register a composite driver + * @driver: the driver to register + * Context: single threaded during gadget setup + * + * This function is used to register drivers using the composite driver + * framework. The return value is zero, or a negative errno value. + * Those values normally come from the driver's @bind method, which does + * all the work of setting up the driver to match the hardware. + * + * On successful return, the gadget is ready to respond to requests from + * the host, unless one of its components invokes usb_gadget_disconnect() + * while it was binding. That would usually be done in order to wait for + * some userspace participation. + */ +int usb_composite_register(struct usb_composite_driver *driver) +{ + if (!driver || !driver->dev || !driver->bind || composite) + return -EINVAL; + + if (!driver->name) + driver->name = "composite"; + composite = driver; + + return usb_gadget_register_driver(&composite_driver); +} + +/** + * usb_composite_unregister() - unregister a composite driver + * @driver: the driver to unregister + * + * This function is used to unregister drivers using the composite + * driver framework. + */ +void usb_composite_unregister(struct usb_composite_driver *driver) +{ + if (composite != driver) + return; + usb_gadget_unregister_driver(&composite_driver); +} diff --git a/include/linux/usb/composite.h b/include/linux/usb/composite.h new file mode 100644 index 0000000..53cb095 --- /dev/null +++ b/include/linux/usb/composite.h @@ -0,0 +1,350 @@ +/* + * composite.h -- framework for usb gadgets which are composite devices + * + * Copyright (C) 2006-2008 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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef __LINUX_USB_COMPOSITE_H +#define __LINUX_USB_COMPOSITE_H + +/* + * This framework is an optional layer on top of the USB Gadget interface, + * making it easier to build (a) Composite devices, supporting multiple + * functions within any single configuration, and (b) Multi-configuration + * devices, also supporting multiple functions but without necessarily + * having more than one function per configuration. + * + * Example: a device with a single configuration supporting both network + * link and mass storage functions is a composite device. Those functions + * might alternatively be packaged in individual configurations, but in + * the composite model the host can use both functions at the same time. + */ + +#include <common.h> +#include <linux/usb/ch9.h> +#include <linux/usb/gadget.h> +#include <usb/lin_gadget_compat.h> + +struct usb_configuration; + +/** + * struct usb_function - describes one function of a configuration + * @name: For diagnostics, identifies the function. + * @strings: tables of strings, keyed by identifiers assigned during bind() + * and by language IDs provided in control requests + * @descriptors: Table of full (or low) speed descriptors, using interface and + * string identifiers assigned during @bind(). If this pointer is null, + * the function will not be available at full speed (or at low speed). + * @hs_descriptors: Table of high speed descriptors, using interface and + * string identifiers assigned during @bind(). If this pointer is null, + * the function will not be available at high speed. + * @config: assigned when @usb_add_function() is called; this is the + * configuration with which this function is associated. + * @bind: Before the gadget can register, all of its functions bind() to the + * available resources including string and interface identifiers used + * in interface or class descriptors; endpoints; I/O buffers; and so on. + * @unbind: Reverses @bind; called as a side effect of unregistering the + * driver which added this function. + * @set_alt: (REQUIRED) Reconfigures altsettings; function drivers may + * initialize usb_ep.driver data at this time (when it is used). + * Note that setting an interface to its current altsetting resets + * interface state, and that all interfaces have a disabled state. + * @get_alt: Returns the active altsetting. If this is not provided, + * then only altsetting zero is supported. + * @disable: (REQUIRED) Indicates the function should be disabled. Reasons + * include host resetting or reconfiguring the gadget, and disconnection. + * @setup: Used for interface-specific control requests. + * @suspend: Notifies functions when the host stops sending USB traffic. + * @resume: Notifies functions when the host restarts USB traffic. + * + * A single USB function uses one or more interfaces, and should in most + * cases support operation at both full and high speeds. Each function is + * associated by @usb_add_function() with a one configuration; that function + * causes @bind() to be called so resources can be allocated as part of + * setting up a gadget driver. Those resources include endpoints, which + * should be allocated using @usb_ep_autoconfig(). + * + * To support dual speed operation, a function driver provides descriptors + * for both high and full speed operation. Except in rare cases that don't + * involve bulk endpoints, each speed needs different endpoint descriptors. + * + * Function drivers choose their own strategies for managing instance data. + * The simplest strategy just declares it "static', which means the function + * can only be activated once. If the function needs to be exposed in more + * than one configuration at a given speed, it needs to support multiple + * usb_function structures (one for each configuration). + * + * A more complex strategy might encapsulate a @usb_function structure inside + * a driver-specific instance structure to allows multiple activations. An + * example of multiple activations might be a CDC ACM function that supports + * two or more distinct instances within the same configuration, providing + * several independent logical data links to a USB host. + */ +struct usb_function { + const char *name; + struct usb_gadget_strings **strings; + struct usb_descriptor_header **descriptors; + struct usb_descriptor_header **hs_descriptors; + + struct usb_configuration *config; + + /* REVISIT: bind() functions can be marked __init, which + * makes trouble for section mismatch analysis. See if + * we can't restructure things to avoid mismatching. + * Related: unbind() may kfree() but bind() won't... + */ + + /* configuration management: bind/unbind */ + int (*bind)(struct usb_configuration *, + struct usb_function *); + void (*unbind)(struct usb_configuration *, + struct usb_function *); + + /* runtime state management */ + int (*set_alt)(struct usb_function *, + unsigned interface, unsigned alt); + int (*get_alt)(struct usb_function *, + unsigned interface); + void (*disable)(struct usb_function *); + int (*setup)(struct usb_function *, + const struct usb_ctrlrequest *); + void (*suspend)(struct usb_function *); + void (*resume)(struct usb_function *); + + /* private: */ + /* internals */ + struct list_head list; + DECLARE_BITMAP(endpoints, 32); +}; + +int usb_add_function(struct usb_configuration *, struct usb_function *); + +int usb_function_deactivate(struct usb_function *); +int usb_function_activate(struct usb_function *); + +int usb_interface_id(struct usb_configuration *, struct usb_function *); + +/** + * ep_choose - select descriptor endpoint at current device speed + * @g: gadget, connected and running at some speed + * @hs: descriptor to use for high speed operation + * @fs: descriptor to use for full or low speed operation + */ +static inline struct usb_endpoint_descriptor * +ep_choose(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; +} + +#define MAX_CONFIG_INTERFACES 16 /* arbitrary; max 255 */ + +/** + * struct usb_configuration - represents one gadget configuration + * @label: For diagnostics, describes the configuration. + * @strings: Tables of strings, keyed by identifiers assigned during @bind() + * and by language IDs provided in control requests. + * @descriptors: Table of descriptors preceding all function descriptors. + * Examples include OTG and vendor-specific descriptors. + * @bind: Called from @usb_add_config() to allocate resources unique to this + * configuration and to call @usb_add_function() for each function used. + * @unbind: Reverses @bind; called as a side effect of unregistering the + * driver which added this configuration. + * @setup: Used to delegate control requests that aren't handled by standard + * device infrastructure or directed at a specific interface. + * @bConfigurationValue: Copied into configuration descriptor. + * @iConfiguration: Copied into configuration descriptor. + * @bmAttributes: Copied into configuration descriptor. + * @bMaxPower: Copied into configuration descriptor. + * @cdev: assigned by @usb_add_config() before calling @bind(); this is + * the device associated with this configuration. + * + * Configurations are building blocks for gadget drivers structured around + * function drivers. Simple USB gadgets require only one function and one + * configuration, and handle dual-speed hardware by always providing the same + * functionality. Slightly more complex gadgets may have more than one + * single-function configuration at a given speed; or have configurations + * that only work at one speed. + * + * Composite devices are, by definition, ones with configurations which + * include more than one function. + * + * The lifecycle of a usb_configuration includes allocation, initialization + * of the fields described above, and calling @usb_add_config() to set up + * internal data and bind it to a specific device. The configuration's + * @bind() method is then used to initialize all the functions and then + * call @usb_add_function() for them. + * + * Those functions would normally be independant of each other, but that's + * not mandatory. CDC WMC devices are an example where functions often + * depend on other functions, with some functions subsidiary to others. + * Such interdependency may be managed in any way, so long as all of the + * descriptors complete by the time the composite driver returns from + * its bind() routine. + */ +struct usb_configuration { + const char *label; + struct usb_gadget_strings **strings; + const struct usb_descriptor_header **descriptors; + + /* REVISIT: bind() functions can be marked __init, which + * makes trouble for section mismatch analysis. See if + * we can't restructure things to avoid mismatching... + */ + + /* configuration management: bind/unbind */ + int (*bind)(struct usb_configuration *); + void (*unbind)(struct usb_configuration *); + int (*setup)(struct usb_configuration *, + const struct usb_ctrlrequest *); + + /* fields in the config descriptor */ + u8 bConfigurationValue; + u8 iConfiguration; + u8 bmAttributes; + u8 bMaxPower; + + struct usb_composite_dev *cdev; + + /* private: */ + /* internals */ + struct list_head list; + struct list_head functions; + u8 next_interface_id; + unsigned highspeed:1; + unsigned fullspeed:1; + struct usb_function *interface[MAX_CONFIG_INTERFACES]; +}; + +int usb_add_config(struct usb_composite_dev *, + struct usb_configuration *); + +/** + * struct usb_composite_driver - groups configurations into a gadget + * @name: For diagnostics, identifies the driver. + * @dev: Template descriptor for the device, including default device + * identifiers. + * @strings: tables of strings, keyed by identifiers assigned during bind() + * and language IDs provided in control requests + * @bind: (REQUIRED) Used to allocate resources that are shared across the + * whole device, such as string IDs, and add its configurations using + * @usb_add_config(). This may fail by returning a negative errno + * value; it should return zero on successful initialization. + * @unbind: Reverses @bind(); called as a side effect of unregistering + * this driver. + * @disconnect: optional driver disconnect method + * @suspend: Notifies when the host stops sending USB traffic, + * after function notifications + * @resume: Notifies configuration when the host restarts USB traffic, + * before function notifications + * + * Devices default to reporting self powered operation. Devices which rely + * on bus powered operation should report this in their @bind() method. + * + * Before returning from @bind, various fields in the template descriptor + * may be overridden. These include the idVendor/idProduct/bcdDevice values + * normally to bind the appropriate host side driver, and the three strings + * (iManufacturer, iProduct, iSerialNumber) normally used to provide user + * meaningful device identifiers. (The strings will not be defined unless + * they are defined in @dev and @strings.) The correct ep0 maxpacket size + * is also reported, as defined by the underlying controller driver. + */ +struct usb_composite_driver { + const char *name; + const struct usb_device_descriptor *dev; + struct usb_gadget_strings **strings; + + /* REVISIT: bind() functions can be marked __init, which + * makes trouble for section mismatch analysis. See if + * we can't restructure things to avoid mismatching... + */ + + int (*bind)(struct usb_composite_dev *); + int (*unbind)(struct usb_composite_dev *); + + void (*disconnect)(struct usb_composite_dev *); + + /* global suspend hooks */ + void (*suspend)(struct usb_composite_dev *); + void (*resume)(struct usb_composite_dev *); +}; + +extern int usb_composite_register(struct usb_composite_driver *); +extern void usb_composite_unregister(struct usb_composite_driver *); + + +/** + * struct usb_composite_device - represents one composite usb gadget + * @gadget: read-only, abstracts the gadget's usb peripheral controller + * @req: used for control responses; buffer is pre-allocated + * @bufsiz: size of buffer pre-allocated in @req + * @config: the currently active configuration + * + * One of these devices is allocated and initialized before the + * associated device driver's bind() is called. + * + * OPEN ISSUE: it appears that some WUSB devices will need to be + * built by combining a normal (wired) gadget with a wireless one. + * This revision of the gadget framework should probably try to make + * sure doing that won't hurt too much. + * + * One notion for how to handle Wireless USB devices involves: + * (a) a second gadget here, discovery mechanism TBD, but likely + * needing separate "register/unregister WUSB gadget" calls; + * (b) updates to usb_gadget to include flags "is it wireless", + * "is it wired", plus (presumably in a wrapper structure) + * bandgroup and PHY info; + * (c) presumably a wireless_ep wrapping a usb_ep, and reporting + * wireless-specific parameters like maxburst and maxsequence; + * (d) configurations that are specific to wireless links; + * (e) function drivers that understand wireless configs and will + * support wireless for (additional) function instances; + * (f) a function to support association setup (like CBAF), not + * necessarily requiring a wireless adapter; + * (g) composite device setup that can create one or more wireless + * configs, including appropriate association setup support; + * (h) more, TBD. + */ +struct usb_composite_dev { + struct usb_gadget *gadget; + struct usb_request *req; + unsigned bufsiz; + + struct usb_configuration *config; + + /* private: */ + /* internals */ + unsigned int suspended:1; + struct usb_device_descriptor desc; + struct list_head configs; + struct usb_composite_driver *driver; + u8 next_string_id; + + /* the gadget driver won't enable the data pullup + * while the deactivation count is nonzero. + */ + unsigned deactivations; +}; + +extern int usb_string_id(struct usb_composite_dev *c); +extern int usb_string_ids_tab(struct usb_composite_dev *c, + struct usb_string *str); +extern int usb_string_ids_n(struct usb_composite_dev *c, unsigned n); + +#endif /* __LINUX_USB_COMPOSITE_H */ diff --git a/include/usb/lin_gadget_compat.h b/include/usb/lin_gadget_compat.h index 8287b9d..5bdcb8d 100644 --- a/include/usb/lin_gadget_compat.h +++ b/include/usb/lin_gadget_compat.h @@ -44,6 +44,25 @@ #define ENOTSUPP 524 /* Operation is not supported */ +#define BITS_PER_BYTE 8 +#define BITS_TO_LONGS(nr) \ + DIV_ROUND_UP(nr, BITS_PER_BYTE * sizeof(long)) +#define DECLARE_BITMAP(name, bits) \ + unsigned long name[BITS_TO_LONGS(bits)] + +#define small_const_nbits(nbits) \ + (__builtin_constant_p(nbits) && (nbits) <= BITS_PER_LONG) + +static inline void bitmap_zero(unsigned long *dst, int nbits) +{ + if (small_const_nbits(nbits)) + *dst = 0UL; + else { + int len = BITS_TO_LONGS(nbits) * sizeof(unsigned long); + memset(dst, 0, len); + } +} + #define dma_cache_maint(addr, size, mode) cache_flush() void cache_flush(void); -- 1.7.2.3 ^ permalink raw reply related [flat|nested] 9+ messages in thread
* [U-Boot] [RESEND++ PATCH 3/5] usb:gadget:composite USB composite gadget support 2012-05-02 15:47 ` [U-Boot] [RESEND++ " Lukasz Majewski @ 2012-05-02 15:49 ` Marek Vasut 0 siblings, 0 replies; 9+ messages in thread From: Marek Vasut @ 2012-05-02 15:49 UTC (permalink / raw) To: u-boot Dear Lukasz Majewski, > USB Composite gadget implementation for u-boot. It builds on top > of USB UDC drivers. > > This commit is based on following files from Linux Kernel v2.6.36: Ok, applied, thanks ;-) > > ./include/linux/usb/composite.h > ./drivers/usb/gadget/composite.c > > SHA1: d187abb9a83e6c6b6e9f2ca17962bdeafb4bc903 > > Signed-off-by: Lukasz Majewski <l.majewski@samsung.com> > Signed-off-by: Kyungmin Park <kyungmin.park@samsung.com> > Cc: Marek Vasut <marex@denx.de> > --- > drivers/usb/gadget/composite.c | 1082 > +++++++++++++++++++++++++++++++++++++++ include/linux/usb/composite.h | > 350 +++++++++++++ > include/usb/lin_gadget_compat.h | 19 + > 3 files changed, 1451 insertions(+), 0 deletions(-) > create mode 100644 drivers/usb/gadget/composite.c > create mode 100644 include/linux/usb/composite.h > > diff --git a/drivers/usb/gadget/composite.c > b/drivers/usb/gadget/composite.c new file mode 100644 > index 0000000..ebb5131 > --- /dev/null > +++ b/drivers/usb/gadget/composite.c > @@ -0,0 +1,1082 @@ > +/* > + * composite.c - infrastructure for Composite USB Gadgets > + * > + * Copyright (C) 2006-2008 David Brownell > + * U-boot porting: Lukasz Majewski <l.majewski@samsung.com> > + * > + * 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 > USA + */ > +#undef DEBUG > + > +#include <linux/bitops.h> > +#include <linux/usb/composite.h> > + > +#define USB_BUFSIZ 4096 > + > +static struct usb_composite_driver *composite; > + > +/** > + * usb_add_function() - add a function to a configuration > + * @config: the configuration > + * @function: the function being added > + * Context: single threaded during gadget setup > + * > + * After initialization, each configuration must have one or more > + * functions added to it. Adding a function involves calling its @bind() > + * method to allocate resources such as interface and string identifiers > + * and endpoints. > + * > + * This function returns the value of the function's bind(), which is > + * zero for success else a negative errno value. > + */ > +int usb_add_function(struct usb_configuration *config, > + struct usb_function *function) > +{ > + int value = -EINVAL; > + > + debug("adding '%s'/%p to config '%s'/%p\n", > + function->name, function, > + config->label, config); > + > + if (!function->set_alt || !function->disable) > + goto done; > + > + function->config = config; > + list_add_tail(&function->list, &config->functions); > + > + if (function->bind) { > + value = function->bind(config, function); > + if (value < 0) { > + list_del(&function->list); > + function->config = NULL; > + } > + } else > + value = 0; > + > + if (!config->fullspeed && function->descriptors) > + config->fullspeed = 1; > + if (!config->highspeed && function->hs_descriptors) > + config->highspeed = 1; > + > +done: > + if (value) > + debug("adding '%s'/%p --> %d\n", > + function->name, function, value); > + return value; > +} > + > +/** > + * usb_function_deactivate - prevent function and gadget enumeration > + * @function: the function that isn't yet ready to respond > + * > + * Blocks response of the gadget driver to host enumeration by > + * preventing the data line pullup from being activated. This is > + * normally called during @bind() processing to change from the > + * initial "ready to respond" state, or when a required resource > + * becomes available. > + * > + * For example, drivers that serve as a passthrough to a userspace > + * daemon can block enumeration unless that daemon (such as an OBEX, > + * MTP, or print server) is ready to handle host requests. > + * > + * Not all systems support software control of their USB peripheral > + * data pullups. > + * > + * Returns zero on success, else negative errno. > + */ > +int usb_function_deactivate(struct usb_function *function) > +{ > + struct usb_composite_dev *cdev = function->config->cdev; > + int status = 0; > + > + if (cdev->deactivations == 0) > + status = usb_gadget_disconnect(cdev->gadget); > + if (status == 0) > + cdev->deactivations++; > + > + return status; > +} > + > +/** > + * usb_function_activate - allow function and gadget enumeration > + * @function: function on which usb_function_activate() was called > + * > + * Reverses effect of usb_function_deactivate(). If no more functions > + * are delaying their activation, the gadget driver will respond to > + * host enumeration procedures. > + * > + * Returns zero on success, else negative errno. > + */ > +int usb_function_activate(struct usb_function *function) > +{ > + struct usb_composite_dev *cdev = function->config->cdev; > + int status = 0; > + > + if (cdev->deactivations == 0) > + status = -EINVAL; > + else { > + cdev->deactivations--; > + if (cdev->deactivations == 0) > + status = usb_gadget_connect(cdev->gadget); > + } > + > + return status; > +} > + > +/** > + * usb_interface_id() - allocate an unused interface ID > + * @config: configuration associated with the interface > + * @function: function handling the interface > + * Context: single threaded during gadget setup > + * > + * usb_interface_id() is called from usb_function.bind() callbacks to > + * allocate new interface IDs. The function driver will then store that > + * ID in interface, association, CDC union, and other descriptors. It > + * will also handle any control requests targetted at that interface, > + * particularly changing its altsetting via set_alt(). There may > + * also be class-specific or vendor-specific requests to handle. > + * > + * All interface identifier should be allocated using this routine, to > + * ensure that for example different functions don't wrongly assign > + * different meanings to the same identifier. Note that since interface > + * identifers are configuration-specific, functions used in more than > + * one configuration (or more than once in a given configuration) need > + * multiple versions of the relevant descriptors. > + * > + * Returns the interface ID which was allocated; or -ENODEV if no > + * more interface IDs can be allocated. > + */ > +int usb_interface_id(struct usb_configuration *config, > + struct usb_function *function) > +{ > + unsigned char id = config->next_interface_id; > + > + if (id < MAX_CONFIG_INTERFACES) { > + config->interface[id] = function; > + config->next_interface_id = id + 1; > + return id; > + } > + return -ENODEV; > +} > + > +static int config_buf(struct usb_configuration *config, > + enum usb_device_speed speed, void *buf, u8 type) > +{ > + int len = USB_BUFSIZ - USB_DT_CONFIG_SIZE; > + void *next = buf + USB_DT_CONFIG_SIZE; > + struct usb_descriptor_header **descriptors; > + struct usb_config_descriptor *c = buf; > + int status; > + struct usb_function *f; > + > + /* write the config descriptor */ > + c = buf; > + c->bLength = USB_DT_CONFIG_SIZE; > + c->bDescriptorType = type; > + > + c->bNumInterfaces = config->next_interface_id; > + c->bConfigurationValue = config->bConfigurationValue; > + c->iConfiguration = config->iConfiguration; > + c->bmAttributes = USB_CONFIG_ATT_ONE | config->bmAttributes; > + c->bMaxPower = config->bMaxPower ? : (CONFIG_USB_GADGET_VBUS_DRAW / 2); > + > + /* There may be e.g. OTG descriptors */ > + if (config->descriptors) { > + status = usb_descriptor_fillbuf(next, len, > + config->descriptors); > + if (status < 0) > + return status; > + len -= status; > + next += status; > + } > + > + /* add each function's descriptors */ > + list_for_each_entry(f, &config->functions, list) { > + if (speed == USB_SPEED_HIGH) > + descriptors = f->hs_descriptors; > + else > + descriptors = f->descriptors; > + if (!descriptors) > + continue; > + status = usb_descriptor_fillbuf(next, len, > + (const struct usb_descriptor_header **) descriptors); > + if (status < 0) > + return status; > + len -= status; > + next += status; > + } > + > + len = next - buf; > + c->wTotalLength = cpu_to_le16(len); > + return len; > +} > + > +static int config_desc(struct usb_composite_dev *cdev, unsigned w_value) > +{ > + enum usb_device_speed speed = USB_SPEED_UNKNOWN; > + struct usb_gadget *gadget = cdev->gadget; > + u8 type = w_value >> 8; > + int hs = 0; > + struct usb_configuration *c; > + > + if (gadget_is_dualspeed(gadget)) { > + if (gadget->speed == USB_SPEED_HIGH) > + hs = 1; > + if (type == USB_DT_OTHER_SPEED_CONFIG) > + hs = !hs; > + if (hs) > + speed = USB_SPEED_HIGH; > + } > + > + w_value &= 0xff; > + list_for_each_entry(c, &cdev->configs, list) { > + if (speed == USB_SPEED_HIGH) { > + if (!c->highspeed) > + continue; > + } else { > + if (!c->fullspeed) > + continue; > + } > + if (w_value == 0) > + return config_buf(c, speed, cdev->req->buf, type); > + w_value--; > + } > + return -EINVAL; > +} > + > +static int count_configs(struct usb_composite_dev *cdev, unsigned type) > +{ > + struct usb_gadget *gadget = cdev->gadget; > + unsigned count = 0; > + int hs = 0; > + struct usb_configuration *c; > + > + if (gadget_is_dualspeed(gadget)) { > + if (gadget->speed == USB_SPEED_HIGH) > + hs = 1; > + if (type == USB_DT_DEVICE_QUALIFIER) > + hs = !hs; > + } > + list_for_each_entry(c, &cdev->configs, list) { > + /* ignore configs that won't work at this speed */ > + if (hs) { > + if (!c->highspeed) > + continue; > + } else { > + if (!c->fullspeed) > + continue; > + } > + count++; > + } > + return count; > +} > + > +static void device_qual(struct usb_composite_dev *cdev) > +{ > + struct usb_qualifier_descriptor *qual = cdev->req->buf; > + > + qual->bLength = sizeof(*qual); > + qual->bDescriptorType = USB_DT_DEVICE_QUALIFIER; > + /* POLICY: same bcdUSB and device type info at both speeds */ > + qual->bcdUSB = cdev->desc.bcdUSB; > + qual->bDeviceClass = cdev->desc.bDeviceClass; > + qual->bDeviceSubClass = cdev->desc.bDeviceSubClass; > + qual->bDeviceProtocol = cdev->desc.bDeviceProtocol; > + /* ASSUME same EP0 fifo size at both speeds */ > + qual->bMaxPacketSize0 = cdev->desc.bMaxPacketSize0; > + qual->bNumConfigurations = count_configs(cdev, USB_DT_DEVICE_QUALIFIER); > + qual->bRESERVED = 0; > +} > + > +static void reset_config(struct usb_composite_dev *cdev) > +{ > + struct usb_function *f; > + > + debug("%s:\n", __func__); > + > + list_for_each_entry(f, &cdev->config->functions, list) { > + if (f->disable) > + f->disable(f); > + > + bitmap_zero(f->endpoints, 32); > + } > + cdev->config = NULL; > +} > + > +static int set_config(struct usb_composite_dev *cdev, > + const struct usb_ctrlrequest *ctrl, unsigned number) > +{ > + struct usb_gadget *gadget = cdev->gadget; > + unsigned power = gadget_is_otg(gadget) ? 8 : 100; > + struct usb_descriptor_header **descriptors; > + int result = -EINVAL; > + struct usb_endpoint_descriptor *ep; > + struct usb_configuration *c = NULL; > + int addr; > + int tmp; > + struct usb_function *f; > + > + if (cdev->config) > + reset_config(cdev); > + > + if (number) { > + list_for_each_entry(c, &cdev->configs, list) { > + if (c->bConfigurationValue == number) { > + result = 0; > + break; > + } > + } > + if (result < 0) > + goto done; > + } else > + result = 0; > + > + debug("%s: %s speed config #%d: %s\n", __func__, > + ({ char *speed; > + switch (gadget->speed) { > + case USB_SPEED_LOW: > + speed = "low"; > + break; > + case USB_SPEED_FULL: > + speed = "full"; > + break; > + case USB_SPEED_HIGH: > + speed = "high"; > + break; > + default: > + speed = "?"; > + break; > + }; > + speed; > + }), number, c ? c->label : "unconfigured"); > + > + if (!c) > + goto done; > + > + cdev->config = c; > + > + /* Initialize all interfaces by setting them to altsetting zero. */ > + for (tmp = 0; tmp < MAX_CONFIG_INTERFACES; tmp++) { > + f = c->interface[tmp]; > + if (!f) > + break; > + > + /* > + * Record which endpoints are used by the function. This is used > + * to dispatch control requests targeted at that endpoint to the > + * function's setup callback instead of the current > + * configuration's setup callback. > + */ > + if (gadget->speed == USB_SPEED_HIGH) > + descriptors = f->hs_descriptors; > + else > + descriptors = f->descriptors; > + > + for (; *descriptors; ++descriptors) { > + if ((*descriptors)->bDescriptorType != USB_DT_ENDPOINT) > + continue; > + > + ep = (struct usb_endpoint_descriptor *)*descriptors; > + addr = ((ep->bEndpointAddress & 0x80) >> 3) > + | (ep->bEndpointAddress & 0x0f); > + __set_bit(addr, f->endpoints); > + } > + > + result = f->set_alt(f, tmp, 0); > + if (result < 0) { > + debug("interface %d (%s/%p) alt 0 --> %d\n", > + tmp, f->name, f, result); > + > + reset_config(cdev); > + goto done; > + } > + } > + > + /* when we return, be sure our power usage is valid */ > + power = c->bMaxPower ? (2 * c->bMaxPower) : CONFIG_USB_GADGET_VBUS_DRAW; > +done: > + usb_gadget_vbus_draw(gadget, power); > + return result; > +} > + > +/** > + * usb_add_config() - add a configuration to a device. > + * @cdev: wraps the USB gadget > + * @config: the configuration, with bConfigurationValue assigned > + * Context: single threaded during gadget setup > + * > + * One of the main tasks of a composite driver's bind() routine is to > + * add each of the configurations it supports, using this routine. > + * > + * This function returns the value of the configuration's bind(), which > + * is zero for success else a negative errno value. Binding > configurations + * assigns global resources including string IDs, and > per-configuration + * resources such as interface IDs and endpoints. > + */ > +int usb_add_config(struct usb_composite_dev *cdev, > + struct usb_configuration *config) > +{ > + int status = -EINVAL; > + struct usb_configuration *c; > + struct usb_function *f; > + unsigned int i; > + > + debug("%s: adding config #%u '%s'/%p\n", __func__, > + config->bConfigurationValue, > + config->label, config); > + > + if (!config->bConfigurationValue || !config->bind) > + goto done; > + > + /* Prevent duplicate configuration identifiers */ > + list_for_each_entry(c, &cdev->configs, list) { > + if (c->bConfigurationValue == config->bConfigurationValue) { > + status = -EBUSY; > + goto done; > + } > + } > + > + config->cdev = cdev; > + list_add_tail(&config->list, &cdev->configs); > + > + INIT_LIST_HEAD(&config->functions); > + config->next_interface_id = 0; > + > + status = config->bind(config); > + if (status < 0) { > + list_del(&config->list); > + config->cdev = NULL; > + } else { > + debug("cfg %d/%p speeds:%s%s\n", > + config->bConfigurationValue, config, > + config->highspeed ? " high" : "", > + config->fullspeed > + ? (gadget_is_dualspeed(cdev->gadget) > + ? " full" > + : " full/low") > + : ""); > + > + for (i = 0; i < MAX_CONFIG_INTERFACES; i++) { > + f = config->interface[i]; > + if (!f) > + continue; > + debug("%s: interface %d = %s/%p\n", > + __func__, i, f->name, f); > + } > + } > + > + usb_ep_autoconfig_reset(cdev->gadget); > + > +done: > + if (status) > + debug("added config '%s'/%u --> %d\n", config->label, > + config->bConfigurationValue, status); > + return status; > +} > + > +/* > + * We support strings in multiple languages ... string descriptor zero > + * says which languages are supported. The typical case will be that > + * only one language (probably English) is used, with I18N handled on > + * the host side. > + */ > + > +static void collect_langs(struct usb_gadget_strings **sp, __le16 *buf) > +{ > + const struct usb_gadget_strings *s; > + u16 language; > + __le16 *tmp; > + > + while (*sp) { > + s = *sp; > + language = cpu_to_le16(s->language); > + for (tmp = buf; *tmp && tmp < &buf[126]; tmp++) { > + if (*tmp == language) > + goto repeat; > + } > + *tmp++ = language; > +repeat: > + sp++; > + } > +} > + > +static int lookup_string( > + struct usb_gadget_strings **sp, > + void *buf, > + u16 language, > + int id > +) > +{ > + int value; > + struct usb_gadget_strings *s; > + > + while (*sp) { > + s = *sp++; > + if (s->language != language) > + continue; > + value = usb_gadget_get_string(s, id, buf); > + if (value > 0) > + return value; > + } > + return -EINVAL; > +} > + > +static int get_string(struct usb_composite_dev *cdev, > + void *buf, u16 language, int id) > +{ > + struct usb_string_descriptor *s = buf; > + struct usb_gadget_strings **sp; > + int len; > + struct usb_configuration *c; > + struct usb_function *f; > + > + /* > + * Yes, not only is USB's I18N support probably more than most > + * folk will ever care about ... also, it's all supported here. > + * (Except for UTF8 support for Unicode's "Astral Planes".) > + */ > + > + /* 0 == report all available language codes */ > + if (id == 0) { > + memset(s, 0, 256); > + s->bDescriptorType = USB_DT_STRING; > + > + sp = composite->strings; > + if (sp) > + collect_langs(sp, s->wData); > + > + list_for_each_entry(c, &cdev->configs, list) { > + sp = c->strings; > + if (sp) > + collect_langs(sp, s->wData); > + > + list_for_each_entry(f, &c->functions, list) { > + sp = f->strings; > + if (sp) > + collect_langs(sp, s->wData); > + } > + } > + > + for (len = 0; len <= 126 && s->wData[len]; len++) > + continue; > + if (!len) > + return -EINVAL; > + > + s->bLength = 2 * (len + 1); > + return s->bLength; > + } > + > + /* > + * Otherwise, look up and return a specified string. String IDs > + * are device-scoped, so we look up each string table we're told > + * about. These lookups are infrequent; simpler-is-better here. > + */ > + if (composite->strings) { > + len = lookup_string(composite->strings, buf, language, id); > + if (len > 0) > + return len; > + } > + list_for_each_entry(c, &cdev->configs, list) { > + if (c->strings) { > + len = lookup_string(c->strings, buf, language, id); > + if (len > 0) > + return len; > + } > + list_for_each_entry(f, &c->functions, list) { > + if (!f->strings) > + continue; > + len = lookup_string(f->strings, buf, language, id); > + if (len > 0) > + return len; > + } > + } > + return -EINVAL; > +} > + > +/** > + * usb_string_id() - allocate an unused string ID > + * @cdev: the device whose string descriptor IDs are being allocated > + * Context: single threaded during gadget setup > + * > + * @usb_string_id() is called from bind() callbacks to allocate > + * string IDs. Drivers for functions, configurations, or gadgets will > + * then store that ID in the appropriate descriptors and string table. > + * > + * All string identifier should be allocated using this, > + * @usb_string_ids_tab() or @usb_string_ids_n() routine, to ensure > + * that for example different functions don't wrongly assign different > + * meanings to the same identifier. > + */ > +int usb_string_id(struct usb_composite_dev *cdev) > +{ > + if (cdev->next_string_id < 254) { > + /* > + * string id 0 is reserved by USB spec for list of > + * supported languages > + * 255 reserved as well? -- mina86 > + */ > + cdev->next_string_id++; > + return cdev->next_string_id; > + } > + return -ENODEV; > +} > + > +/** > + * usb_string_ids() - allocate unused string IDs in batch > + * @cdev: the device whose string descriptor IDs are being allocated > + * @str: an array of usb_string objects to assign numbers to > + * Context: single threaded during gadget setup > + * > + * @usb_string_ids() is called from bind() callbacks to allocate > + * string IDs. Drivers for functions, configurations, or gadgets will > + * then copy IDs from the string table to the appropriate descriptors > + * and string table for other languages. > + * > + * All string identifier should be allocated using this, > + * @usb_string_id() or @usb_string_ids_n() routine, to ensure that for > + * example different functions don't wrongly assign different meanings > + * to the same identifier. > + */ > +int usb_string_ids_tab(struct usb_composite_dev *cdev, struct usb_string > *str) +{ > + u8 next = cdev->next_string_id; > + > + for (; str->s; ++str) { > + if (next >= 254) > + return -ENODEV; > + str->id = ++next; > + } > + > + cdev->next_string_id = next; > + > + return 0; > +} > + > +/** > + * usb_string_ids_n() - allocate unused string IDs in batch > + * @c: the device whose string descriptor IDs are being allocated > + * @n: number of string IDs to allocate > + * Context: single threaded during gadget setup > + * > + * Returns the first requested ID. This ID and next @n-1 IDs are now > + * valid IDs. At least provided that @n is non-zero because if it > + * is, returns last requested ID which is now very useful information. > + * > + * @usb_string_ids_n() is called from bind() callbacks to allocate > + * string IDs. Drivers for functions, configurations, or gadgets will > + * then store that ID in the appropriate descriptors and string table. > + * > + * All string identifier should be allocated using this, > + * @usb_string_id() or @usb_string_ids_n() routine, to ensure that for > + * example different functions don't wrongly assign different meanings > + * to the same identifier. > + */ > +int usb_string_ids_n(struct usb_composite_dev *c, unsigned n) > +{ > + u8 next = c->next_string_id; > + > + if (n > 254 || next + n > 254) > + return -ENODEV; > + > + c->next_string_id += n; > + return next + 1; > +} > + > +static void composite_setup_complete(struct usb_ep *ep, struct usb_request > *req) +{ > + if (req->status || req->actual != req->length) > + debug("%s: setup complete --> %d, %d/%d\n", __func__, > + req->status, req->actual, req->length); > +} > + > +/* > + * The setup() callback implements all the ep0 functionality that's > + * not handled lower down, in hardware or the hardware driver(like > + * device and endpoint feature flags, and their status). It's all > + * housekeeping for the gadget function we're implementing. Most of > + * the work is in config and function specific setup. > + */ > +static int > +composite_setup(struct usb_gadget *gadget, const struct usb_ctrlrequest > *ctrl) +{ > + u16 w_length = le16_to_cpu(ctrl->wLength); > + u16 w_index = le16_to_cpu(ctrl->wIndex); > + u16 w_value = le16_to_cpu(ctrl->wValue); > + struct usb_composite_dev *cdev = get_gadget_data(gadget); > + u8 intf = w_index & 0xFF; > + int value = -EOPNOTSUPP; > + struct usb_request *req = cdev->req; > + struct usb_function *f = NULL; > + int standard; > + u8 endp; > + struct usb_configuration *c; > + > + /* > + * partial re-init of the response message; the function or the > + * gadget might need to intercept e.g. a control-OUT completion > + * when we delegate to it. > + */ > + req->zero = 0; > + req->complete = composite_setup_complete; > + req->length = USB_BUFSIZ; > + gadget->ep0->driver_data = cdev; > + standard = (ctrl->bRequestType & USB_TYPE_MASK) > + == USB_TYPE_STANDARD; > + if (!standard) > + goto unknown; > + > + switch (ctrl->bRequest) { > + > + /* we handle all standard USB descriptors */ > + case USB_REQ_GET_DESCRIPTOR: > + if (ctrl->bRequestType != USB_DIR_IN) > + goto unknown; > + switch (w_value >> 8) { > + > + case USB_DT_DEVICE: > + cdev->desc.bNumConfigurations = > + count_configs(cdev, USB_DT_DEVICE); > + value = min(w_length, (u16) sizeof cdev->desc); > + memcpy(req->buf, &cdev->desc, value); > + break; > + case USB_DT_DEVICE_QUALIFIER: > + if (!gadget_is_dualspeed(gadget)) > + break; > + device_qual(cdev); > + value = min(w_length, > + sizeof(struct usb_qualifier_descriptor)); > + break; > + case USB_DT_OTHER_SPEED_CONFIG: > + if (!gadget_is_dualspeed(gadget)) > + break; > + > + case USB_DT_CONFIG: > + value = config_desc(cdev, w_value); > + if (value >= 0) > + value = min(w_length, (u16) value); > + break; > + case USB_DT_STRING: > + value = get_string(cdev, req->buf, > + w_index, w_value & 0xff); > + if (value >= 0) > + value = min(w_length, (u16) value); > + break; > + default: > + goto unknown; > + } > + break; > + > + /* any number of configs can work */ > + case USB_REQ_SET_CONFIGURATION: > + if (ctrl->bRequestType != 0) > + goto unknown; > + if (gadget_is_otg(gadget)) { > + if (gadget->a_hnp_support) > + debug("HNP available\n"); > + else if (gadget->a_alt_hnp_support) > + debug("HNP on another port\n"); > + else > + debug("HNP inactive\n"); > + } > + > + value = set_config(cdev, ctrl, w_value); > + break; > + case USB_REQ_GET_CONFIGURATION: > + if (ctrl->bRequestType != USB_DIR_IN) > + goto unknown; > + if (cdev->config) > + *(u8 *)req->buf = cdev->config->bConfigurationValue; > + else > + *(u8 *)req->buf = 0; > + value = min(w_length, (u16) 1); > + break; > + > + /* > + * function drivers must handle get/set altsetting; if there's > + * no get() method, we know only altsetting zero works. > + */ > + case USB_REQ_SET_INTERFACE: > + if (ctrl->bRequestType != USB_RECIP_INTERFACE) > + goto unknown; > + if (!cdev->config || w_index >= MAX_CONFIG_INTERFACES) > + break; > + f = cdev->config->interface[intf]; > + if (!f) > + break; > + if (w_value && !f->set_alt) > + break; > + value = f->set_alt(f, w_index, w_value); > + break; > + case USB_REQ_GET_INTERFACE: > + if (ctrl->bRequestType != (USB_DIR_IN|USB_RECIP_INTERFACE)) > + goto unknown; > + if (!cdev->config || w_index >= MAX_CONFIG_INTERFACES) > + break; > + f = cdev->config->interface[intf]; > + if (!f) > + break; > + /* lots of interfaces only need altsetting zero... */ > + value = f->get_alt ? f->get_alt(f, w_index) : 0; > + if (value < 0) > + break; > + *((u8 *)req->buf) = value; > + value = min(w_length, (u16) 1); > + break; > + default: > +unknown: > + debug("non-core control req%02x.%02x v%04x i%04x l%d\n", > + ctrl->bRequestType, ctrl->bRequest, > + w_value, w_index, w_length); > + > + /* > + * functions always handle their interfaces and endpoints... > + * punt other recipients (other, WUSB, ...) to the current > + * configuration code. > + */ > + switch (ctrl->bRequestType & USB_RECIP_MASK) { > + case USB_RECIP_INTERFACE: > + f = cdev->config->interface[intf]; > + break; > + > + case USB_RECIP_ENDPOINT: > + endp = ((w_index & 0x80) >> 3) | (w_index & 0x0f); > + list_for_each_entry(f, &cdev->config->functions, list) { > + if (test_bit(endp, f->endpoints)) > + break; > + } > + if (&f->list == &cdev->config->functions) > + f = NULL; > + break; > + } > + > + if (f && f->setup) > + value = f->setup(f, ctrl); > + else { > + c = cdev->config; > + if (c && c->setup) > + value = c->setup(c, ctrl); > + } > + > + goto done; > + } > + > + /* respond with data transfer before status phase? */ > + if (value >= 0) { > + req->length = value; > + req->zero = value < w_length; > + value = usb_ep_queue(gadget->ep0, req, GFP_KERNEL); > + if (value < 0) { > + debug("ep_queue --> %d\n", value); > + req->status = 0; > + composite_setup_complete(gadget->ep0, req); > + } > + } > + > +done: > + /* device either stalls (value < 0) or reports success */ > + return value; > +} > + > +static void composite_disconnect(struct usb_gadget *gadget) > +{ > + struct usb_composite_dev *cdev = get_gadget_data(gadget); > + > + if (cdev->config) > + reset_config(cdev); > + if (composite->disconnect) > + composite->disconnect(cdev); > +} > + > +static void composite_unbind(struct usb_gadget *gadget) > +{ > + struct usb_composite_dev *cdev = get_gadget_data(gadget); > + struct usb_configuration *c; > + struct usb_function *f; > + > + /* > + * composite_disconnect() must already have been called > + * by the underlying peripheral controller driver! > + * so there's no i/o concurrency that could affect the > + * state protected by cdev->lock. > + */ > + BUG_ON(cdev->config); > + > + while (!list_empty(&cdev->configs)) { > + c = list_first_entry(&cdev->configs, > + struct usb_configuration, list); > + while (!list_empty(&c->functions)) { > + f = list_first_entry(&c->functions, > + struct usb_function, list); > + list_del(&f->list); > + if (f->unbind) { > + debug("unbind function '%s'/%p\n", > + f->name, f); > + f->unbind(c, f); > + } > + } > + list_del(&c->list); > + if (c->unbind) { > + debug("unbind config '%s'/%p\n", c->label, c); > + c->unbind(c); > + } > + } > + if (composite->unbind) > + composite->unbind(cdev); > + > + if (cdev->req) { > + kfree(cdev->req->buf); > + usb_ep_free_request(gadget->ep0, cdev->req); > + } > + kfree(cdev); > + set_gadget_data(gadget, NULL); > + > + composite = NULL; > +} > + > +static int composite_bind(struct usb_gadget *gadget) > +{ > + int status = -ENOMEM; > + struct usb_composite_dev *cdev; > + > + cdev = calloc(sizeof *cdev, 1); > + if (!cdev) > + return status; > + > + cdev->gadget = gadget; > + set_gadget_data(gadget, cdev); > + INIT_LIST_HEAD(&cdev->configs); > + > + /* preallocate control response and buffer */ > + cdev->req = usb_ep_alloc_request(gadget->ep0, GFP_KERNEL); > + if (!cdev->req) > + goto fail; > + cdev->req->buf = memalign(CONFIG_SYS_CACHELINE_SIZE, USB_BUFSIZ); > + if (!cdev->req->buf) > + goto fail; > + cdev->req->complete = composite_setup_complete; > + gadget->ep0->driver_data = cdev; > + > + cdev->bufsiz = USB_BUFSIZ; > + cdev->driver = composite; > + > + usb_gadget_set_selfpowered(gadget); > + usb_ep_autoconfig_reset(cdev->gadget); > + > + status = composite->bind(cdev); > + if (status < 0) > + goto fail; > + > + cdev->desc = *composite->dev; > + cdev->desc.bMaxPacketSize0 = gadget->ep0->maxpacket; > + > + debug("%s: ready\n", composite->name); > + return 0; > + > +fail: > + composite_unbind(gadget); > + return status; > +} > + > +static void > +composite_suspend(struct usb_gadget *gadget) > +{ > + struct usb_composite_dev *cdev = get_gadget_data(gadget); > + struct usb_function *f; > + > + debug("%s: suspend\n", __func__); > + if (cdev->config) { > + list_for_each_entry(f, &cdev->config->functions, list) { > + if (f->suspend) > + f->suspend(f); > + } > + } > + if (composite->suspend) > + composite->suspend(cdev); > + > + cdev->suspended = 1; > +} > + > +static void > +composite_resume(struct usb_gadget *gadget) > +{ > + struct usb_composite_dev *cdev = get_gadget_data(gadget); > + struct usb_function *f; > + > + debug("%s: resume\n", __func__); > + if (composite->resume) > + composite->resume(cdev); > + if (cdev->config) { > + list_for_each_entry(f, &cdev->config->functions, list) { > + if (f->resume) > + f->resume(f); > + } > + } > + > + cdev->suspended = 0; > +} > + > +static struct usb_gadget_driver composite_driver = { > + .speed = USB_SPEED_HIGH, > + > + .bind = composite_bind, > + .unbind = composite_unbind, > + > + .setup = composite_setup, > + .disconnect = composite_disconnect, > + > + .suspend = composite_suspend, > + .resume = composite_resume, > +}; > + > +/** > + * usb_composite_register() - register a composite driver > + * @driver: the driver to register > + * Context: single threaded during gadget setup > + * > + * This function is used to register drivers using the composite driver > + * framework. The return value is zero, or a negative errno value. > + * Those values normally come from the driver's @bind method, which does > + * all the work of setting up the driver to match the hardware. > + * > + * On successful return, the gadget is ready to respond to requests from > + * the host, unless one of its components invokes usb_gadget_disconnect() > + * while it was binding. That would usually be done in order to wait for > + * some userspace participation. > + */ > +int usb_composite_register(struct usb_composite_driver *driver) > +{ > + if (!driver || !driver->dev || !driver->bind || composite) > + return -EINVAL; > + > + if (!driver->name) > + driver->name = "composite"; > + composite = driver; > + > + return usb_gadget_register_driver(&composite_driver); > +} > + > +/** > + * usb_composite_unregister() - unregister a composite driver > + * @driver: the driver to unregister > + * > + * This function is used to unregister drivers using the composite > + * driver framework. > + */ > +void usb_composite_unregister(struct usb_composite_driver *driver) > +{ > + if (composite != driver) > + return; > + usb_gadget_unregister_driver(&composite_driver); > +} > diff --git a/include/linux/usb/composite.h b/include/linux/usb/composite.h > new file mode 100644 > index 0000000..53cb095 > --- /dev/null > +++ b/include/linux/usb/composite.h > @@ -0,0 +1,350 @@ > +/* > + * composite.h -- framework for usb gadgets which are composite devices > + * > + * Copyright (C) 2006-2008 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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 > USA + */ > + > +#ifndef __LINUX_USB_COMPOSITE_H > +#define __LINUX_USB_COMPOSITE_H > + > +/* > + * This framework is an optional layer on top of the USB Gadget interface, > + * making it easier to build (a) Composite devices, supporting multiple > + * functions within any single configuration, and (b) Multi-configuration > + * devices, also supporting multiple functions but without necessarily > + * having more than one function per configuration. > + * > + * Example: a device with a single configuration supporting both network > + * link and mass storage functions is a composite device. Those functions > + * might alternatively be packaged in individual configurations, but in > + * the composite model the host can use both functions at the same time. > + */ > + > +#include <common.h> > +#include <linux/usb/ch9.h> > +#include <linux/usb/gadget.h> > +#include <usb/lin_gadget_compat.h> > + > +struct usb_configuration; > + > +/** > + * struct usb_function - describes one function of a configuration > + * @name: For diagnostics, identifies the function. > + * @strings: tables of strings, keyed by identifiers assigned during > bind() + * and by language IDs provided in control requests > + * @descriptors: Table of full (or low) speed descriptors, using interface > and + * string identifiers assigned during @bind(). If this pointer is > null, + * the function will not be available at full speed (or at low > speed). + * @hs_descriptors: Table of high speed descriptors, using > interface and + * string identifiers assigned during @bind(). If this > pointer is null, + * the function will not be available at high speed. > + * @config: assigned when @usb_add_function() is called; this is the > + * configuration with which this function is associated. > + * @bind: Before the gadget can register, all of its functions bind() to > the + * available resources including string and interface identifiers > used + * in interface or class descriptors; endpoints; I/O buffers; and so > on. + * @unbind: Reverses @bind; called as a side effect of unregistering > the + * driver which added this function. > + * @set_alt: (REQUIRED) Reconfigures altsettings; function drivers may > + * initialize usb_ep.driver data at this time (when it is used). > + * Note that setting an interface to its current altsetting resets > + * interface state, and that all interfaces have a disabled state. > + * @get_alt: Returns the active altsetting. If this is not provided, > + * then only altsetting zero is supported. > + * @disable: (REQUIRED) Indicates the function should be disabled. > Reasons + * include host resetting or reconfiguring the gadget, and > disconnection. + * @setup: Used for interface-specific control requests. > + * @suspend: Notifies functions when the host stops sending USB traffic. > + * @resume: Notifies functions when the host restarts USB traffic. > + * > + * A single USB function uses one or more interfaces, and should in most > + * cases support operation at both full and high speeds. Each function is > + * associated by @usb_add_function() with a one configuration; that > function + * causes @bind() to be called so resources can be allocated as > part of + * setting up a gadget driver. Those resources include > endpoints, which + * should be allocated using @usb_ep_autoconfig(). > + * > + * To support dual speed operation, a function driver provides descriptors > + * for both high and full speed operation. Except in rare cases that > don't + * involve bulk endpoints, each speed needs different endpoint > descriptors. + * > + * Function drivers choose their own strategies for managing instance > data. + * The simplest strategy just declares it "static', which means the > function + * can only be activated once. If the function needs to be > exposed in more + * than one configuration at a given speed, it needs to > support multiple + * usb_function structures (one for each configuration). > + * > + * A more complex strategy might encapsulate a @usb_function structure > inside + * a driver-specific instance structure to allows multiple > activations. An + * example of multiple activations might be a CDC ACM > function that supports + * two or more distinct instances within the same > configuration, providing + * several independent logical data links to a > USB host. > + */ > +struct usb_function { > + const char *name; > + struct usb_gadget_strings **strings; > + struct usb_descriptor_header **descriptors; > + struct usb_descriptor_header **hs_descriptors; > + > + struct usb_configuration *config; > + > + /* REVISIT: bind() functions can be marked __init, which > + * makes trouble for section mismatch analysis. See if > + * we can't restructure things to avoid mismatching. > + * Related: unbind() may kfree() but bind() won't... > + */ > + > + /* configuration management: bind/unbind */ > + int (*bind)(struct usb_configuration *, > + struct usb_function *); > + void (*unbind)(struct usb_configuration *, > + struct usb_function *); > + > + /* runtime state management */ > + int (*set_alt)(struct usb_function *, > + unsigned interface, unsigned alt); > + int (*get_alt)(struct usb_function *, > + unsigned interface); > + void (*disable)(struct usb_function *); > + int (*setup)(struct usb_function *, > + const struct usb_ctrlrequest *); > + void (*suspend)(struct usb_function *); > + void (*resume)(struct usb_function *); > + > + /* private: */ > + /* internals */ > + struct list_head list; > + DECLARE_BITMAP(endpoints, 32); > +}; > + > +int usb_add_function(struct usb_configuration *, struct usb_function *); > + > +int usb_function_deactivate(struct usb_function *); > +int usb_function_activate(struct usb_function *); > + > +int usb_interface_id(struct usb_configuration *, struct usb_function *); > + > +/** > + * ep_choose - select descriptor endpoint at current device speed > + * @g: gadget, connected and running at some speed > + * @hs: descriptor to use for high speed operation > + * @fs: descriptor to use for full or low speed operation > + */ > +static inline struct usb_endpoint_descriptor * > +ep_choose(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; > +} > + > +#define MAX_CONFIG_INTERFACES 16 /* arbitrary; max 255 */ > + > +/** > + * struct usb_configuration - represents one gadget configuration > + * @label: For diagnostics, describes the configuration. > + * @strings: Tables of strings, keyed by identifiers assigned during > @bind() + * and by language IDs provided in control requests. > + * @descriptors: Table of descriptors preceding all function descriptors. > + * Examples include OTG and vendor-specific descriptors. > + * @bind: Called from @usb_add_config() to allocate resources unique to > this + * configuration and to call @usb_add_function() for each function > used. + * @unbind: Reverses @bind; called as a side effect of > unregistering the + * driver which added this configuration. > + * @setup: Used to delegate control requests that aren't handled by > standard + * device infrastructure or directed at a specific interface. > + * @bConfigurationValue: Copied into configuration descriptor. > + * @iConfiguration: Copied into configuration descriptor. > + * @bmAttributes: Copied into configuration descriptor. > + * @bMaxPower: Copied into configuration descriptor. > + * @cdev: assigned by @usb_add_config() before calling @bind(); this is > + * the device associated with this configuration. > + * > + * Configurations are building blocks for gadget drivers structured around > + * function drivers. Simple USB gadgets require only one function and one > + * configuration, and handle dual-speed hardware by always providing the > same + * functionality. Slightly more complex gadgets may have more than > one + * single-function configuration at a given speed; or have > configurations + * that only work at one speed. > + * > + * Composite devices are, by definition, ones with configurations which > + * include more than one function. > + * > + * The lifecycle of a usb_configuration includes allocation, > initialization + * of the fields described above, and calling > @usb_add_config() to set up + * internal data and bind it to a specific > device. The configuration's + * @bind() method is then used to initialize > all the functions and then + * call @usb_add_function() for them. > + * > + * Those functions would normally be independant of each other, but that's > + * not mandatory. CDC WMC devices are an example where functions often > + * depend on other functions, with some functions subsidiary to others. > + * Such interdependency may be managed in any way, so long as all of the > + * descriptors complete by the time the composite driver returns from > + * its bind() routine. > + */ > +struct usb_configuration { > + const char *label; > + struct usb_gadget_strings **strings; > + const struct usb_descriptor_header **descriptors; > + > + /* REVISIT: bind() functions can be marked __init, which > + * makes trouble for section mismatch analysis. See if > + * we can't restructure things to avoid mismatching... > + */ > + > + /* configuration management: bind/unbind */ > + int (*bind)(struct usb_configuration *); > + void (*unbind)(struct usb_configuration *); > + int (*setup)(struct usb_configuration *, > + const struct usb_ctrlrequest *); > + > + /* fields in the config descriptor */ > + u8 bConfigurationValue; > + u8 iConfiguration; > + u8 bmAttributes; > + u8 bMaxPower; > + > + struct usb_composite_dev *cdev; > + > + /* private: */ > + /* internals */ > + struct list_head list; > + struct list_head functions; > + u8 next_interface_id; > + unsigned highspeed:1; > + unsigned fullspeed:1; > + struct usb_function *interface[MAX_CONFIG_INTERFACES]; > +}; > + > +int usb_add_config(struct usb_composite_dev *, > + struct usb_configuration *); > + > +/** > + * struct usb_composite_driver - groups configurations into a gadget > + * @name: For diagnostics, identifies the driver. > + * @dev: Template descriptor for the device, including default device > + * identifiers. > + * @strings: tables of strings, keyed by identifiers assigned during > bind() + * and language IDs provided in control requests > + * @bind: (REQUIRED) Used to allocate resources that are shared across the > + * whole device, such as string IDs, and add its configurations using > + * @usb_add_config(). This may fail by returning a negative errno > + * value; it should return zero on successful initialization. > + * @unbind: Reverses @bind(); called as a side effect of unregistering > + * this driver. > + * @disconnect: optional driver disconnect method > + * @suspend: Notifies when the host stops sending USB traffic, > + * after function notifications > + * @resume: Notifies configuration when the host restarts USB traffic, > + * before function notifications > + * > + * Devices default to reporting self powered operation. Devices which > rely + * on bus powered operation should report this in their @bind() > method. + * > + * Before returning from @bind, various fields in the template descriptor > + * may be overridden. These include the idVendor/idProduct/bcdDevice > values + * normally to bind the appropriate host side driver, and the > three strings + * (iManufacturer, iProduct, iSerialNumber) normally used > to provide user + * meaningful device identifiers. (The strings will not > be defined unless + * they are defined in @dev and @strings.) The correct > ep0 maxpacket size + * is also reported, as defined by the underlying > controller driver. + */ > +struct usb_composite_driver { > + const char *name; > + const struct usb_device_descriptor *dev; > + struct usb_gadget_strings **strings; > + > + /* REVISIT: bind() functions can be marked __init, which > + * makes trouble for section mismatch analysis. See if > + * we can't restructure things to avoid mismatching... > + */ > + > + int (*bind)(struct usb_composite_dev *); > + int (*unbind)(struct usb_composite_dev *); > + > + void (*disconnect)(struct usb_composite_dev *); > + > + /* global suspend hooks */ > + void (*suspend)(struct usb_composite_dev *); > + void (*resume)(struct usb_composite_dev *); > +}; > + > +extern int usb_composite_register(struct usb_composite_driver *); > +extern void usb_composite_unregister(struct usb_composite_driver *); > + > + > +/** > + * struct usb_composite_device - represents one composite usb gadget > + * @gadget: read-only, abstracts the gadget's usb peripheral controller > + * @req: used for control responses; buffer is pre-allocated > + * @bufsiz: size of buffer pre-allocated in @req > + * @config: the currently active configuration > + * > + * One of these devices is allocated and initialized before the > + * associated device driver's bind() is called. > + * > + * OPEN ISSUE: it appears that some WUSB devices will need to be > + * built by combining a normal (wired) gadget with a wireless one. > + * This revision of the gadget framework should probably try to make > + * sure doing that won't hurt too much. > + * > + * One notion for how to handle Wireless USB devices involves: > + * (a) a second gadget here, discovery mechanism TBD, but likely > + * needing separate "register/unregister WUSB gadget" calls; > + * (b) updates to usb_gadget to include flags "is it wireless", > + * "is it wired", plus (presumably in a wrapper structure) > + * bandgroup and PHY info; > + * (c) presumably a wireless_ep wrapping a usb_ep, and reporting > + * wireless-specific parameters like maxburst and maxsequence; > + * (d) configurations that are specific to wireless links; > + * (e) function drivers that understand wireless configs and will > + * support wireless for (additional) function instances; > + * (f) a function to support association setup (like CBAF), not > + * necessarily requiring a wireless adapter; > + * (g) composite device setup that can create one or more wireless > + * configs, including appropriate association setup support; > + * (h) more, TBD. > + */ > +struct usb_composite_dev { > + struct usb_gadget *gadget; > + struct usb_request *req; > + unsigned bufsiz; > + > + struct usb_configuration *config; > + > + /* private: */ > + /* internals */ > + unsigned int suspended:1; > + struct usb_device_descriptor desc; > + struct list_head configs; > + struct usb_composite_driver *driver; > + u8 next_string_id; > + > + /* the gadget driver won't enable the data pullup > + * while the deactivation count is nonzero. > + */ > + unsigned deactivations; > +}; > + > +extern int usb_string_id(struct usb_composite_dev *c); > +extern int usb_string_ids_tab(struct usb_composite_dev *c, > + struct usb_string *str); > +extern int usb_string_ids_n(struct usb_composite_dev *c, unsigned n); > + > +#endif /* __LINUX_USB_COMPOSITE_H */ > diff --git a/include/usb/lin_gadget_compat.h > b/include/usb/lin_gadget_compat.h index 8287b9d..5bdcb8d 100644 > --- a/include/usb/lin_gadget_compat.h > +++ b/include/usb/lin_gadget_compat.h > @@ -44,6 +44,25 @@ > > #define ENOTSUPP 524 /* Operation is not supported */ > > +#define BITS_PER_BYTE 8 > +#define BITS_TO_LONGS(nr) \ > + DIV_ROUND_UP(nr, BITS_PER_BYTE * sizeof(long)) > +#define DECLARE_BITMAP(name, bits) \ > + unsigned long name[BITS_TO_LONGS(bits)] > + > +#define small_const_nbits(nbits) \ > + (__builtin_constant_p(nbits) && (nbits) <= BITS_PER_LONG) > + > +static inline void bitmap_zero(unsigned long *dst, int nbits) > +{ > + if (small_const_nbits(nbits)) > + *dst = 0UL; > + else { > + int len = BITS_TO_LONGS(nbits) * sizeof(unsigned long); > + memset(dst, 0, len); > + } > +} > + > #define dma_cache_maint(addr, size, mode) cache_flush() > void cache_flush(void); ^ permalink raw reply [flat|nested] 9+ messages in thread
* [U-Boot] [RESEND PATCH 4/5] usb:gadget:composite: Support for composite at gadget.h 2012-05-02 11:11 [U-Boot] [RESEND PATCH 0/5] usb:udc:composite: Samsung's UDC cleanup and composite gadget implementation Lukasz Majewski ` (2 preceding siblings ...) 2012-05-02 11:11 ` [U-Boot] [RESEND PATCH 3/5] usb:gadget:composite USB composite gadget support Lukasz Majewski @ 2012-05-02 11:11 ` Lukasz Majewski 2012-05-02 11:11 ` [U-Boot] [RESEND PATCH 5/5] usb:udc:samsung Add functions for storing private gadget data in UDC driver Lukasz Majewski 4 siblings, 0 replies; 9+ messages in thread From: Lukasz Majewski @ 2012-05-02 11:11 UTC (permalink / raw) To: u-boot Add device data pointer to the USB gadget's device struct. Wrapper for extracting usb_gadget from Linux's usb device Signed-off-by: Lukasz Majewski <l.majewski@samsung.com> Signed-off-by: Kyungmin Park <kyungmin.park@samsung.com> Cc: Marek Vasut <marex@denx.de> --- Changes for v2: - Two separate patches regarding gadget.h file squashed together --- include/linux/usb/gadget.h | 6 ++++++ 1 files changed, 6 insertions(+), 0 deletions(-) diff --git a/include/linux/usb/gadget.h b/include/linux/usb/gadget.h index 275cb5f..eba865e 100644 --- a/include/linux/usb/gadget.h +++ b/include/linux/usb/gadget.h @@ -411,6 +411,7 @@ struct usb_gadget_ops { struct device { void *driver_data; /* data private to the driver */ + void *device_data; /* data private to the device */ }; /** @@ -481,6 +482,11 @@ static inline void *get_gadget_data(struct usb_gadget *gadget) return gadget->dev.driver_data; } +static inline struct usb_gadget *dev_to_usb_gadget(struct device *dev) +{ + return container_of(dev, struct usb_gadget, dev); +} + /* iterates the non-control endpoints; 'tmp' is a struct usb_ep pointer */ #define gadget_for_each_ep(tmp, gadget) \ list_for_each_entry(tmp, &(gadget)->ep_list, ep_list) -- 1.7.2.3 ^ permalink raw reply related [flat|nested] 9+ messages in thread
* [U-Boot] [RESEND PATCH 5/5] usb:udc:samsung Add functions for storing private gadget data in UDC driver 2012-05-02 11:11 [U-Boot] [RESEND PATCH 0/5] usb:udc:composite: Samsung's UDC cleanup and composite gadget implementation Lukasz Majewski ` (3 preceding siblings ...) 2012-05-02 11:11 ` [U-Boot] [RESEND PATCH 4/5] usb:gadget:composite: Support for composite at gadget.h Lukasz Majewski @ 2012-05-02 11:11 ` Lukasz Majewski 4 siblings, 0 replies; 9+ messages in thread From: Lukasz Majewski @ 2012-05-02 11:11 UTC (permalink / raw) To: u-boot This commit adds support for storing private data to Samsung's UDC driver. This data is afterward used by usb gadget. Signed-off-by: Lukasz Majewski <l.majewski@samsung.com> Signed-off-by: Kyungmin Park <kyungmin.park@samsung.com> Cc: Marek Vasut <marex@denx.de> --- drivers/usb/gadget/s3c_udc_otg.c | 15 ++++++++++++++- 1 files changed, 14 insertions(+), 1 deletions(-) diff --git a/drivers/usb/gadget/s3c_udc_otg.c b/drivers/usb/gadget/s3c_udc_otg.c index 24ff346..41b738a 100644 --- a/drivers/usb/gadget/s3c_udc_otg.c +++ b/drivers/usb/gadget/s3c_udc_otg.c @@ -30,7 +30,7 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA * */ - +#undef DEBUG #include <common.h> #include <asm/errno.h> #include <linux/list.h> @@ -125,6 +125,19 @@ static void nuke(struct s3c_ep *ep, int status); static int s3c_udc_set_halt(struct usb_ep *_ep, int value); static void s3c_udc_set_nak(struct s3c_ep *ep); +void set_udc_gadget_private_data(void *p) +{ + debug_cond(DEBUG_SETUP != 0, + "%s: the_controller: 0x%p, p: 0x%p\n", __func__, + the_controller, p); + the_controller->gadget.dev.device_data = p; +} + +void *get_udc_gadget_private_data(struct usb_gadget *gadget) +{ + return gadget->dev.device_data; +} + static struct usb_ep_ops s3c_ep_ops = { .enable = s3c_ep_enable, .disable = s3c_ep_disable, -- 1.7.2.3 ^ permalink raw reply related [flat|nested] 9+ messages in thread
end of thread, other threads:[~2012-05-02 15:49 UTC | newest] Thread overview: 9+ messages (download: mbox.gz follow: Atom feed -- links below jump to the message on this page -- 2012-05-02 11:11 [U-Boot] [RESEND PATCH 0/5] usb:udc:composite: Samsung's UDC cleanup and composite gadget implementation Lukasz Majewski 2012-05-02 11:11 ` [U-Boot] [RESEND PATCH 1/5] usb:udc: Remove duplicated USB definitions from include/linux/usb/ch9.h file Lukasz Majewski 2012-05-02 11:11 ` [U-Boot] [RESEND PATCH 2/5] usb:udc:samsung:cleanup Replace DEBUG_* macros with debug_cond() calls Lukasz Majewski 2012-05-02 11:11 ` [U-Boot] [RESEND PATCH 3/5] usb:gadget:composite USB composite gadget support Lukasz Majewski 2012-05-02 13:25 ` Marek Vasut 2012-05-02 15:47 ` [U-Boot] [RESEND++ " Lukasz Majewski 2012-05-02 15:49 ` Marek Vasut 2012-05-02 11:11 ` [U-Boot] [RESEND PATCH 4/5] usb:gadget:composite: Support for composite at gadget.h Lukasz Majewski 2012-05-02 11:11 ` [U-Boot] [RESEND PATCH 5/5] usb:udc:samsung Add functions for storing private gadget data in UDC driver Lukasz Majewski
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.