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