drivers/usb/musb/musb_gadget.h

   1 /*
   2  * MUSB OTG driver peripheral defines
   3  *
   4  * Copyright 2005 Mentor Graphics Corporation
   5  * Copyright (C) 2005-2006 by Texas Instruments
   6  * Copyright (C) 2006-2007 Nokia Corporation
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * version 2 as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  20  * 02110-1301 USA
  21  *
  22  * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
  23  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  24  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN
  25  * NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  27  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  28  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
  29  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  31  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  *
  33  */
  34
  35 #ifndef __MUSB_GADGET_H
  36 #define __MUSB_GADGET_H
  37
  38 struct musb_request {
  39         struct usb_request      request;
  40         struct musb_ep          *ep;
  41         struct musb             *musb;
  42         u8 tx;                  /* endpoint direction */
  43         u8 epnum;
  44         u8 mapped;
  45 };
  46
  47 static inline struct musb_request *to_musb_request(struct usb_request *req)
  48 {
  49         return req ? container_of(req, struct musb_request, request) : NULL;
  50 }
  51
  52 extern struct usb_request *
  53 musb_alloc_request(struct usb_ep *ep, gfp_t gfp_flags);
  54 extern void musb_free_request(struct usb_ep *ep, struct usb_request *req);
  55
  56
  57 /*
  58  * struct musb_ep - peripheral side view of endpoint rx or tx side
  59  */
  60 struct musb_ep {
  61         /* stuff towards the head is basically write-once. */
  62         struct usb_ep                   end_point;
  63         char                            name[12];
  64         struct musb_hw_ep               *hw_ep;
  65         struct musb                     *musb;
  66         u8                              current_epnum;
  67
  68         /* ... when enabled/disabled ... */
  69         u8                              type;
  70         u8                              is_in;
  71         u16                             packet_sz;
  72         const struct usb_endpoint_descriptor    *desc;
  73         struct dma_channel              *dma;
  74
  75         /* later things are modified based on usage */
  76         struct list_head                req_list;
  77
  78         u8                              wedged;
  79
  80         /* true if lock must be dropped but req_list may not be advanced */
  81         u8                              busy;
  82
  83         u8                              hb_mult;
  84 };
  85
  86 static inline struct musb_ep *to_musb_ep(struct usb_ep *ep)
  87 {
  88         return ep ? container_of(ep, struct musb_ep, end_point) : NULL;
  89 }
  90
  91 static inline struct usb_request *next_request(struct musb_ep *ep)
  92 {
  93         struct list_head        *queue = &ep->req_list;
  94
  95         if (list_empty(queue))
  96                 return NULL;
  97         return container_of(queue->next, struct usb_request, list);
  98 }
  99
 100 extern void musb_g_tx(struct musb *musb, u8 epnum);
 101 extern void musb_g_rx(struct musb *musb, u8 epnum);
 102
 103 extern const struct usb_ep_ops musb_g_ep0_ops;
 104
 105 extern int musb_gadget_setup(struct musb *);
 106 extern void musb_gadget_cleanup(struct musb *);
 107
 108 extern void musb_g_giveback(struct musb_ep *, struct usb_request *, int);
 109
 110 extern void musb_ep_restart(struct musb *, struct musb_request *);
 111
 112 #endif          /* __MUSB_GADGET_H */