Merge git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/driver-core-2.6
[linux-2.6] / drivers / usb / gadget / gadget_chips.h
1 /*
2  * USB device controllers have lots of quirks.  Use these macros in
3  * gadget drivers or other code that needs to deal with them, and which
4  * autoconfigures instead of using early binding to the hardware.
5  *
6  * This SHOULD eventually work like the ARM mach_is_*() stuff, driven by
7  * some config file that gets updated as new hardware is supported.
8  * (And avoiding all runtime comparisons in typical one-choice configs!)
9  *
10  * NOTE:  some of these controller drivers may not be available yet.
11  * Some are available on 2.4 kernels; several are available, but not
12  * yet pushed in the 2.6 mainline tree.
13  */
14 #ifdef CONFIG_USB_GADGET_NET2280
15 #define gadget_is_net2280(g)    !strcmp("net2280", (g)->name)
16 #else
17 #define gadget_is_net2280(g)    0
18 #endif
19
20 #ifdef CONFIG_USB_GADGET_AMD5536UDC
21 #define gadget_is_amd5536udc(g) !strcmp("amd5536udc", (g)->name)
22 #else
23 #define gadget_is_amd5536udc(g) 0
24 #endif
25
26 #ifdef CONFIG_USB_GADGET_DUMMY_HCD
27 #define gadget_is_dummy(g)      !strcmp("dummy_udc", (g)->name)
28 #else
29 #define gadget_is_dummy(g)      0
30 #endif
31
32 #ifdef CONFIG_USB_GADGET_PXA25X
33 #define gadget_is_pxa(g)        !strcmp("pxa25x_udc", (g)->name)
34 #else
35 #define gadget_is_pxa(g)        0
36 #endif
37
38 #ifdef CONFIG_USB_GADGET_GOKU
39 #define gadget_is_goku(g)       !strcmp("goku_udc", (g)->name)
40 #else
41 #define gadget_is_goku(g)       0
42 #endif
43
44 /* SH3 UDC -- not yet ported 2.4 --> 2.6 */
45 #ifdef CONFIG_USB_GADGET_SUPERH
46 #define gadget_is_sh(g)         !strcmp("sh_udc", (g)->name)
47 #else
48 #define gadget_is_sh(g)         0
49 #endif
50
51 /* not yet stable on 2.6 (would help "original Zaurus") */
52 #ifdef CONFIG_USB_GADGET_SA1100
53 #define gadget_is_sa1100(g)     !strcmp("sa1100_udc", (g)->name)
54 #else
55 #define gadget_is_sa1100(g)     0
56 #endif
57
58 #ifdef CONFIG_USB_GADGET_LH7A40X
59 #define gadget_is_lh7a40x(g)    !strcmp("lh7a40x_udc", (g)->name)
60 #else
61 #define gadget_is_lh7a40x(g)    0
62 #endif
63
64 /* handhelds.org tree (?) */
65 #ifdef CONFIG_USB_GADGET_MQ11XX
66 #define gadget_is_mq11xx(g)     !strcmp("mq11xx_udc", (g)->name)
67 #else
68 #define gadget_is_mq11xx(g)     0
69 #endif
70
71 #ifdef CONFIG_USB_GADGET_OMAP
72 #define gadget_is_omap(g)       !strcmp("omap_udc", (g)->name)
73 #else
74 #define gadget_is_omap(g)       0
75 #endif
76
77 /* not yet ported 2.4 --> 2.6 */
78 #ifdef CONFIG_USB_GADGET_N9604
79 #define gadget_is_n9604(g)      !strcmp("n9604_udc", (g)->name)
80 #else
81 #define gadget_is_n9604(g)      0
82 #endif
83
84 /* various unstable versions available */
85 #ifdef CONFIG_USB_GADGET_PXA27X
86 #define gadget_is_pxa27x(g)     !strcmp("pxa27x_udc", (g)->name)
87 #else
88 #define gadget_is_pxa27x(g)     0
89 #endif
90
91 #ifdef CONFIG_USB_GADGET_ATMEL_USBA
92 #define gadget_is_atmel_usba(g) !strcmp("atmel_usba_udc", (g)->name)
93 #else
94 #define gadget_is_atmel_usba(g) 0
95 #endif
96
97 #ifdef CONFIG_USB_GADGET_S3C2410
98 #define gadget_is_s3c2410(g)    !strcmp("s3c2410_udc", (g)->name)
99 #else
100 #define gadget_is_s3c2410(g)    0
101 #endif
102
103 #ifdef CONFIG_USB_GADGET_AT91
104 #define gadget_is_at91(g)       !strcmp("at91_udc", (g)->name)
105 #else
106 #define gadget_is_at91(g)       0
107 #endif
108
109 /* status unclear */
110 #ifdef CONFIG_USB_GADGET_IMX
111 #define gadget_is_imx(g)        !strcmp("imx_udc", (g)->name)
112 #else
113 #define gadget_is_imx(g)        0
114 #endif
115
116 #ifdef CONFIG_USB_GADGET_FSL_USB2
117 #define gadget_is_fsl_usb2(g)   !strcmp("fsl-usb2-udc", (g)->name)
118 #else
119 #define gadget_is_fsl_usb2(g)   0
120 #endif
121
122 /* Mentor high speed function controller */
123 /* from Montavista kernel (?) */
124 #ifdef CONFIG_USB_GADGET_MUSBHSFC
125 #define gadget_is_musbhsfc(g)   !strcmp("musbhsfc_udc", (g)->name)
126 #else
127 #define gadget_is_musbhsfc(g)   0
128 #endif
129
130 /* Mentor high speed "dual role" controller, in peripheral role */
131 #ifdef CONFIG_USB_GADGET_MUSB_HDRC
132 #define gadget_is_musbhdrc(g)   !strcmp("musb_hdrc", (g)->name)
133 #else
134 #define gadget_is_musbhdrc(g)   0
135 #endif
136
137 /* from Montavista kernel (?) */
138 #ifdef CONFIG_USB_GADGET_MPC8272
139 #define gadget_is_mpc8272(g)    !strcmp("mpc8272_udc", (g)->name)
140 #else
141 #define gadget_is_mpc8272(g)    0
142 #endif
143
144 #ifdef CONFIG_USB_GADGET_M66592
145 #define gadget_is_m66592(g)     !strcmp("m66592_udc", (g)->name)
146 #else
147 #define gadget_is_m66592(g)     0
148 #endif
149
150
151 // CONFIG_USB_GADGET_SX2
152 // CONFIG_USB_GADGET_AU1X00
153 // ...
154
155
156 /**
157  * usb_gadget_controller_number - support bcdDevice id convention
158  * @gadget: the controller being driven
159  *
160  * Return a 2-digit BCD value associated with the peripheral controller,
161  * suitable for use as part of a bcdDevice value, or a negative error code.
162  *
163  * NOTE:  this convention is purely optional, and has no meaning in terms of
164  * any USB specification.  If you want to use a different convention in your
165  * gadget driver firmware -- maybe a more formal revision ID -- feel free.
166  *
167  * Hosts see these bcdDevice numbers, and are allowed (but not encouraged!)
168  * to change their behavior accordingly.  For example it might help avoiding
169  * some chip bug.
170  */
171 static inline int usb_gadget_controller_number(struct usb_gadget *gadget)
172 {
173         if (gadget_is_net2280(gadget))
174                 return 0x01;
175         else if (gadget_is_dummy(gadget))
176                 return 0x02;
177         else if (gadget_is_pxa(gadget))
178                 return 0x03;
179         else if (gadget_is_sh(gadget))
180                 return 0x04;
181         else if (gadget_is_sa1100(gadget))
182                 return 0x05;
183         else if (gadget_is_goku(gadget))
184                 return 0x06;
185         else if (gadget_is_mq11xx(gadget))
186                 return 0x07;
187         else if (gadget_is_omap(gadget))
188                 return 0x08;
189         else if (gadget_is_lh7a40x(gadget))
190                 return 0x09;
191         else if (gadget_is_n9604(gadget))
192                 return 0x10;
193         else if (gadget_is_pxa27x(gadget))
194                 return 0x11;
195         else if (gadget_is_s3c2410(gadget))
196                 return 0x12;
197         else if (gadget_is_at91(gadget))
198                 return 0x13;
199         else if (gadget_is_imx(gadget))
200                 return 0x14;
201         else if (gadget_is_musbhsfc(gadget))
202                 return 0x15;
203         else if (gadget_is_musbhdrc(gadget))
204                 return 0x16;
205         else if (gadget_is_mpc8272(gadget))
206                 return 0x17;
207         else if (gadget_is_atmel_usba(gadget))
208                 return 0x18;
209         else if (gadget_is_fsl_usb2(gadget))
210                 return 0x19;
211         else if (gadget_is_amd5536udc(gadget))
212                 return 0x20;
213         else if (gadget_is_m66592(gadget))
214                 return 0x21;
215         return -ENOENT;
216 }
217
218
219 /**
220  * gadget_supports_altsettings - return true if altsettings work
221  * @gadget: the gadget in question
222  */
223 static inline bool gadget_supports_altsettings(struct usb_gadget *gadget)
224 {
225         /* PXA 21x/25x/26x has no altsettings at all */
226         if (gadget_is_pxa(gadget))
227                 return false;
228
229         /* PXA 27x and 3xx have *broken* altsetting support */
230         if (gadget_is_pxa27x(gadget))
231                 return false;
232
233         /* SH3 hardware just doesn't do altsettings */
234         if (gadget_is_sh(gadget))
235                 return false;
236
237         /* Everything else is *presumably* fine ... */
238         return true;
239 }