Linux kernel & device driver programming

Cross-Referenced Linux and Device Driver Code

[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ]
Version: [ 2.6.11.8 ] [ 2.6.25 ] [ 2.6.25.8 ] [ 2.6.31.13 ] Architecture: [ i386 ]
  1 /*
  2  * linux/drivers/usb/gadget/pxa2xx_udc.h
  3  * Intel PXA2xx on-chip full speed USB device controller
  4  *
  5  * Copyright (C) 2003 Robert Schwebel <r.schwebel@pengutronix.de>, Pengutronix
  6  * Copyright (C) 2003 David Brownell
  7  *
  8  *
  9  * This program is free software; you can redistribute it and/or modify
 10  * it under the terms of the GNU General Public License as published by
 11  * the Free Software Foundation; either version 2 of the License, or
 12  * (at your option) any later version.
 13  *
 14  * This program is distributed in the hope that it will be useful,
 15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
 16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 17  * GNU General Public License for more details.
 18  *
 19  * You should have received a copy of the GNU General Public License
 20  * along with this program; if not, write to the Free Software
 21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 22  */
 23 
 24 #ifndef __LINUX_USB_GADGET_PXA2XX_H
 25 #define __LINUX_USB_GADGET_PXA2XX_H
 26 
 27 #include <linux/types.h>
 28 
 29 /*-------------------------------------------------------------------------*/
 30 
 31 /* pxa2xx has this (move to include/asm-arm/arch-pxa/pxa-regs.h) */
 32 #define UFNRH_SIR       (1 << 7)        /* SOF interrupt request */
 33 #define UFNRH_SIM       (1 << 6)        /* SOF interrupt mask */
 34 #define UFNRH_IPE14     (1 << 5)        /* ISO packet error, ep14 */
 35 #define UFNRH_IPE9      (1 << 4)        /* ISO packet error, ep9 */
 36 #define UFNRH_IPE4      (1 << 3)        /* ISO packet error, ep4 */
 37 
 38 /* pxa255 has this (move to include/asm-arm/arch-pxa/pxa-regs.h) */
 39 #define UDCCFR          UDC_RES2        /* UDC Control Function Register */
 40 #define UDCCFR_AREN     (1 << 7)        /* ACK response enable (now) */
 41 #define UDCCFR_ACM      (1 << 2)        /* ACK control mode (wait for AREN) */
 42 
 43 /* latest pxa255 errata define new "must be one" bits in UDCCFR */
 44 #define UDCCFR_MB1      (0xff & ~(UDCCFR_AREN|UDCCFR_ACM))
 45 
 46 /*-------------------------------------------------------------------------*/
 47 
 48 struct pxa2xx_udc;
 49 
 50 struct pxa2xx_ep {
 51         struct usb_ep                           ep;
 52         struct pxa2xx_udc                       *dev;
 53 
 54         const struct usb_endpoint_descriptor    *desc;
 55         struct list_head                        queue;
 56         unsigned long                           pio_irqs;
 57 
 58         unsigned short                          fifo_size;
 59         u8                                      bEndpointAddress;
 60         u8                                      bmAttributes;
 61 
 62         unsigned                                stopped : 1;
 63         unsigned                                dma_fixup : 1;
 64 
 65         /* UDCCS = UDC Control/Status for this EP
 66          * UBCR = UDC Byte Count Remaining (contents of OUT fifo)
 67          * UDDR = UDC Endpoint Data Register (the fifo)
 68          * DRCM = DMA Request Channel Map
 69          */
 70         volatile u32                            *reg_udccs;
 71         volatile u32                            *reg_ubcr;
 72         volatile u32                            *reg_uddr;
 73 };
 74 
 75 struct pxa2xx_request {
 76         struct usb_request                      req;
 77         struct list_head                        queue;
 78 };
 79 
 80 enum ep0_state {
 81         EP0_IDLE,
 82         EP0_IN_DATA_PHASE,
 83         EP0_OUT_DATA_PHASE,
 84         EP0_END_XFER,
 85         EP0_STALL,
 86 };
 87 
 88 #define EP0_FIFO_SIZE   ((unsigned)16)
 89 #define BULK_FIFO_SIZE  ((unsigned)64)
 90 #define ISO_FIFO_SIZE   ((unsigned)256)
 91 #define INT_FIFO_SIZE   ((unsigned)8)
 92 
 93 struct udc_stats {
 94         struct ep0stats {
 95                 unsigned long           ops;
 96                 unsigned long           bytes;
 97         } read, write;
 98         unsigned long                   irqs;
 99 };
100 
101 #ifdef CONFIG_USB_PXA2XX_SMALL
102 /* when memory's tight, SMALL config saves code+data.  */
103 #define PXA_UDC_NUM_ENDPOINTS   3
104 #endif
105 
106 #ifndef PXA_UDC_NUM_ENDPOINTS
107 #define PXA_UDC_NUM_ENDPOINTS   16
108 #endif
109 
110 struct pxa2xx_udc {
111         struct usb_gadget                       gadget;
112         struct usb_gadget_driver                *driver;
113 
114         enum ep0_state                          ep0state;
115         struct udc_stats                        stats;
116         unsigned                                got_irq : 1,
117                                                 vbus : 1,
118                                                 pullup : 1,
119                                                 has_cfr : 1,
120                                                 req_pending : 1,
121                                                 req_std : 1,
122                                                 req_config : 1,
123                                                 suspended : 1,
124                                                 active : 1;
125 
126 #define start_watchdog(dev) mod_timer(&dev->timer, jiffies + (HZ/200))
127         struct timer_list                       timer;
128 
129         struct device                           *dev;
130         struct clk                              *clk;
131         struct pxa2xx_udc_mach_info             *mach;
132         u64                                     dma_mask;
133         struct pxa2xx_ep                        ep [PXA_UDC_NUM_ENDPOINTS];
134 
135 #ifdef CONFIG_USB_GADGET_DEBUG_FS
136         struct dentry                           *debugfs_udc;
137 #endif
138 };
139 
140 /*-------------------------------------------------------------------------*/
141 
142 #ifdef CONFIG_ARCH_LUBBOCK
143 #include <asm/arch/lubbock.h>
144 /* lubbock can also report usb connect/disconnect irqs */
145 #endif
146 
147 static struct pxa2xx_udc *the_controller;
148 
149 /*-------------------------------------------------------------------------*/
150 
151 /*
152  * Debugging support vanishes in non-debug builds.  DBG_NORMAL should be
153  * mostly silent during normal use/testing, with no timing side-effects.
154  */
155 #define DBG_NORMAL      1       /* error paths, device state transitions */
156 #define DBG_VERBOSE     2       /* add some success path trace info */
157 #define DBG_NOISY       3       /* ... even more: request level */
158 #define DBG_VERY_NOISY  4       /* ... even more: packet level */
159 
160 #define DMSG(stuff...)  pr_debug("udc: " stuff)
161 
162 #ifdef DEBUG
163 
164 static int is_vbus_present(void);
165 
166 static const char *state_name[] = {
167         "EP0_IDLE",
168         "EP0_IN_DATA_PHASE", "EP0_OUT_DATA_PHASE",
169         "EP0_END_XFER", "EP0_STALL"
170 };
171 
172 #ifdef VERBOSE_DEBUG
173 #    define UDC_DEBUG DBG_VERBOSE
174 #else
175 #    define UDC_DEBUG DBG_NORMAL
176 #endif
177 
178 static void __maybe_unused
179 dump_udccr(const char *label)
180 {
181         u32     udccr = UDCCR;
182         DMSG("%s %02X =%s%s%s%s%s%s%s%s\n",
183                 label, udccr,
184                 (udccr & UDCCR_REM) ? " rem" : "",
185                 (udccr & UDCCR_RSTIR) ? " rstir" : "",
186                 (udccr & UDCCR_SRM) ? " srm" : "",
187                 (udccr & UDCCR_SUSIR) ? " susir" : "",
188                 (udccr & UDCCR_RESIR) ? " resir" : "",
189                 (udccr & UDCCR_RSM) ? " rsm" : "",
190                 (udccr & UDCCR_UDA) ? " uda" : "",
191                 (udccr & UDCCR_UDE) ? " ude" : "");
192 }
193 
194 static void __maybe_unused
195 dump_udccs0(const char *label)
196 {
197         u32             udccs0 = UDCCS0;
198 
199         DMSG("%s %s %02X =%s%s%s%s%s%s%s%s\n",
200                 label, state_name[the_controller->ep0state], udccs0,
201                 (udccs0 & UDCCS0_SA) ? " sa" : "",
202                 (udccs0 & UDCCS0_RNE) ? " rne" : "",
203                 (udccs0 & UDCCS0_FST) ? " fst" : "",
204                 (udccs0 & UDCCS0_SST) ? " sst" : "",
205                 (udccs0 & UDCCS0_DRWF) ? " dwrf" : "",
206                 (udccs0 & UDCCS0_FTF) ? " ftf" : "",
207                 (udccs0 & UDCCS0_IPR) ? " ipr" : "",
208                 (udccs0 & UDCCS0_OPR) ? " opr" : "");
209 }
210 
211 static void __maybe_unused
212 dump_state(struct pxa2xx_udc *dev)
213 {
214         u32             tmp;
215         unsigned        i;
216 
217         DMSG("%s %s, uicr %02X.%02X, usir %02X.%02x, ufnr %02X.%02X\n",
218                 is_vbus_present() ? "host " : "disconnected",
219                 state_name[dev->ep0state],
220                 UICR1, UICR0, USIR1, USIR0, UFNRH, UFNRL);
221         dump_udccr("udccr");
222         if (dev->has_cfr) {
223                 tmp = UDCCFR;
224                 DMSG("udccfr %02X =%s%s\n", tmp,
225                         (tmp & UDCCFR_AREN) ? " aren" : "",
226                         (tmp & UDCCFR_ACM) ? " acm" : "");
227         }
228 
229         if (!dev->driver) {
230                 DMSG("no gadget driver bound\n");
231                 return;
232         } else
233                 DMSG("ep0 driver '%s'\n", dev->driver->driver.name);
234 
235         if (!is_vbus_present())
236                 return;
237 
238         dump_udccs0 ("udccs0");
239         DMSG("ep0 IN %lu/%lu, OUT %lu/%lu\n",
240                 dev->stats.write.bytes, dev->stats.write.ops,
241                 dev->stats.read.bytes, dev->stats.read.ops);
242 
243         for (i = 1; i < PXA_UDC_NUM_ENDPOINTS; i++) {
244                 if (dev->ep [i].desc == NULL)
245                         continue;
246                 DMSG ("udccs%d = %02x\n", i, *dev->ep->reg_udccs);
247         }
248 }
249 
250 #else
251 
252 #define dump_udccr(x)   do{}while(0)
253 #define dump_udccs0(x)  do{}while(0)
254 #define dump_state(x)   do{}while(0)
255 
256 #define UDC_DEBUG ((unsigned)0)
257 
258 #endif
259 
260 #define DBG(lvl, stuff...) do{if ((lvl) <= UDC_DEBUG) DMSG(stuff);}while(0)
261 
262 #define ERR(stuff...)           pr_err("udc: " stuff)
263 #define WARN(stuff...)          pr_warning("udc: " stuff)
264 #define INFO(stuff...)          pr_info("udc: " stuff)
265 
266 
267 #endif /* __LINUX_USB_GADGET_PXA2XX_H */
268 
  This page was automatically generated by the LXR engine.