Commit | Line | Data |
---|---|---|
e443b333 AS |
1 | /* |
2 | * ci.h - common structures, functions, and macros of the ChipIdea driver | |
3 | * | |
4 | * Copyright (C) 2008 Chipidea - MIPS Technologies, Inc. All rights reserved. | |
5 | * | |
6 | * Author: David Lopo | |
7 | * | |
8 | * This program is free software; you can redistribute it and/or modify | |
9 | * it under the terms of the GNU General Public License version 2 as | |
10 | * published by the Free Software Foundation. | |
11 | */ | |
12 | ||
13 | #ifndef __DRIVERS_USB_CHIPIDEA_CI_H | |
14 | #define __DRIVERS_USB_CHIPIDEA_CI_H | |
15 | ||
16 | #include <linux/list.h> | |
5f36e231 | 17 | #include <linux/irqreturn.h> |
eb70e5ab | 18 | #include <linux/usb.h> |
e443b333 AS |
19 | #include <linux/usb/gadget.h> |
20 | ||
21 | /****************************************************************************** | |
22 | * DEFINE | |
23 | *****************************************************************************/ | |
24 | #define DMA_ADDR_INVALID (~(dma_addr_t)0) | |
25 | #define CI13XXX_PAGE_SIZE 4096ul /* page size for TD's */ | |
26 | #define ENDPT_MAX 32 | |
27 | ||
28 | /****************************************************************************** | |
29 | * STRUCTURES | |
30 | *****************************************************************************/ | |
551a8ac6 AS |
31 | /** |
32 | * struct ci13xxx_ep - endpoint representation | |
33 | * @ep: endpoint structure for gadget drivers | |
34 | * @dir: endpoint direction (TX/RX) | |
35 | * @num: endpoint number | |
36 | * @type: endpoint type | |
37 | * @name: string description of the endpoint | |
38 | * @qh: queue head for this endpoint | |
39 | * @wedge: is the endpoint wedged | |
40 | * @udc: pointer to the controller | |
41 | * @lock: pointer to controller's spinlock | |
42 | * @device: pointer to gadget's struct device | |
43 | * @td_pool: pointer to controller's TD pool | |
44 | */ | |
e443b333 | 45 | struct ci13xxx_ep { |
551a8ac6 AS |
46 | struct usb_ep ep; |
47 | u8 dir; | |
48 | u8 num; | |
49 | u8 type; | |
50 | char name[16]; | |
e443b333 | 51 | struct { |
551a8ac6 AS |
52 | struct list_head queue; |
53 | struct ci13xxx_qh *ptr; | |
54 | dma_addr_t dma; | |
55 | } qh; | |
56 | int wedge; | |
e443b333 AS |
57 | |
58 | /* global resources */ | |
551a8ac6 AS |
59 | struct ci13xxx *udc; |
60 | spinlock_t *lock; | |
61 | struct device *device; | |
62 | struct dma_pool *td_pool; | |
e443b333 AS |
63 | }; |
64 | ||
5f36e231 AS |
65 | enum ci_role { |
66 | CI_ROLE_HOST = 0, | |
67 | CI_ROLE_GADGET, | |
68 | CI_ROLE_END, | |
69 | }; | |
70 | ||
71 | /** | |
72 | * struct ci_role_driver - host/gadget role driver | |
73 | * start: start this role | |
74 | * stop: stop this role | |
75 | * irq: irq handler for this role | |
76 | * name: role name string (host/gadget) | |
77 | */ | |
78 | struct ci_role_driver { | |
79 | int (*start)(struct ci13xxx *); | |
80 | void (*stop)(struct ci13xxx *); | |
81 | irqreturn_t (*irq)(struct ci13xxx *); | |
82 | const char *name; | |
83 | }; | |
84 | ||
551a8ac6 AS |
85 | /** |
86 | * struct hw_bank - hardware register mapping representation | |
87 | * @lpm: set if the device is LPM capable | |
eb70e5ab | 88 | * @phys: physical address of the controller's registers |
551a8ac6 AS |
89 | * @abs: absolute address of the beginning of register window |
90 | * @cap: capability registers | |
91 | * @op: operational registers | |
92 | * @size: size of the register window | |
93 | * @regmap: register lookup table | |
94 | */ | |
e443b333 | 95 | struct hw_bank { |
551a8ac6 | 96 | unsigned lpm; |
eb70e5ab | 97 | resource_size_t phys; |
551a8ac6 AS |
98 | void __iomem *abs; |
99 | void __iomem *cap; | |
100 | void __iomem *op; | |
101 | size_t size; | |
102 | void __iomem **regmap; | |
e443b333 AS |
103 | }; |
104 | ||
551a8ac6 AS |
105 | /** |
106 | * struct ci13xxx - chipidea device representation | |
107 | * @dev: pointer to parent device | |
108 | * @lock: access synchronization | |
109 | * @hw_bank: hardware register mapping | |
110 | * @irq: IRQ number | |
111 | * @roles: array of supported roles for this controller | |
112 | * @role: current role | |
113 | * @is_otg: if the device is otg-capable | |
114 | * @work: work for role changing | |
115 | * @wq: workqueue thread | |
116 | * @qh_pool: allocation pool for queue heads | |
117 | * @td_pool: allocation pool for transfer descriptors | |
118 | * @gadget: device side representation for peripheral controller | |
119 | * @driver: gadget driver | |
120 | * @hw_ep_max: total number of endpoints supported by hardware | |
121 | * @ci13xxx_ep: array of endpoints | |
122 | * @ep0_dir: ep0 direction | |
123 | * @ep0out: pointer to ep0 OUT endpoint | |
124 | * @ep0in: pointer to ep0 IN endpoint | |
125 | * @status: ep0 status request | |
126 | * @setaddr: if we should set the address on status completion | |
127 | * @address: usb address received from the host | |
128 | * @remote_wakeup: host-enabled remote wakeup | |
129 | * @suspended: suspended by host | |
130 | * @test_mode: the selected test mode | |
131 | * @udc_driver: platform specific information supplied by parent device | |
132 | * @vbus_active: is VBUS active | |
133 | * @transceiver: pointer to USB PHY, if any | |
eb70e5ab | 134 | * @hcd: pointer to usb_hcd for ehci host driver |
551a8ac6 | 135 | */ |
e443b333 | 136 | struct ci13xxx { |
551a8ac6 AS |
137 | struct device *dev; |
138 | spinlock_t lock; | |
139 | struct hw_bank hw_bank; | |
140 | int irq; | |
141 | struct ci_role_driver *roles[CI_ROLE_END]; | |
142 | enum ci_role role; | |
143 | bool is_otg; | |
144 | struct work_struct work; | |
145 | struct workqueue_struct *wq; | |
146 | ||
147 | struct dma_pool *qh_pool; | |
148 | struct dma_pool *td_pool; | |
149 | ||
150 | struct usb_gadget gadget; | |
151 | struct usb_gadget_driver *driver; | |
152 | unsigned hw_ep_max; | |
153 | struct ci13xxx_ep ci13xxx_ep[ENDPT_MAX]; | |
154 | u32 ep0_dir; | |
155 | struct ci13xxx_ep *ep0out, *ep0in; | |
156 | ||
157 | struct usb_request *status; | |
158 | bool setaddr; | |
159 | u8 address; | |
160 | u8 remote_wakeup; | |
161 | u8 suspended; | |
162 | u8 test_mode; | |
163 | ||
164 | struct ci13xxx_udc_driver *udc_driver; | |
165 | int vbus_active; | |
166 | struct usb_phy *transceiver; | |
eb70e5ab | 167 | struct usb_hcd *hcd; |
e443b333 AS |
168 | }; |
169 | ||
5f36e231 AS |
170 | static inline struct ci_role_driver *ci_role(struct ci13xxx *ci) |
171 | { | |
172 | BUG_ON(ci->role >= CI_ROLE_END || !ci->roles[ci->role]); | |
173 | return ci->roles[ci->role]; | |
174 | } | |
175 | ||
176 | static inline int ci_role_start(struct ci13xxx *ci, enum ci_role role) | |
177 | { | |
178 | int ret; | |
179 | ||
180 | if (role >= CI_ROLE_END) | |
181 | return -EINVAL; | |
182 | ||
183 | if (!ci->roles[role]) | |
184 | return -ENXIO; | |
185 | ||
186 | ret = ci->roles[role]->start(ci); | |
187 | if (!ret) | |
188 | ci->role = role; | |
189 | return ret; | |
190 | } | |
191 | ||
192 | static inline void ci_role_stop(struct ci13xxx *ci) | |
193 | { | |
194 | enum ci_role role = ci->role; | |
195 | ||
196 | if (role == CI_ROLE_END) | |
197 | return; | |
198 | ||
199 | ci->role = CI_ROLE_END; | |
200 | ||
201 | ci->roles[role]->stop(ci); | |
202 | } | |
203 | ||
e443b333 AS |
204 | /****************************************************************************** |
205 | * REGISTERS | |
206 | *****************************************************************************/ | |
207 | /* register size */ | |
208 | #define REG_BITS (32) | |
209 | ||
210 | /* register indices */ | |
211 | enum ci13xxx_regs { | |
212 | CAP_CAPLENGTH, | |
213 | CAP_HCCPARAMS, | |
214 | CAP_DCCPARAMS, | |
215 | CAP_TESTMODE, | |
216 | CAP_LAST = CAP_TESTMODE, | |
217 | OP_USBCMD, | |
218 | OP_USBSTS, | |
219 | OP_USBINTR, | |
220 | OP_DEVICEADDR, | |
221 | OP_ENDPTLISTADDR, | |
222 | OP_PORTSC, | |
223 | OP_DEVLC, | |
5f36e231 | 224 | OP_OTGSC, |
e443b333 AS |
225 | OP_USBMODE, |
226 | OP_ENDPTSETUPSTAT, | |
227 | OP_ENDPTPRIME, | |
228 | OP_ENDPTFLUSH, | |
229 | OP_ENDPTSTAT, | |
230 | OP_ENDPTCOMPLETE, | |
231 | OP_ENDPTCTRL, | |
232 | /* endptctrl1..15 follow */ | |
233 | OP_LAST = OP_ENDPTCTRL + ENDPT_MAX / 2, | |
234 | }; | |
235 | ||
e443b333 AS |
236 | /** |
237 | * ffs_nr: find first (least significant) bit set | |
238 | * @x: the word to search | |
239 | * | |
240 | * This function returns bit number (instead of position) | |
241 | */ | |
242 | static inline int ffs_nr(u32 x) | |
243 | { | |
244 | int n = ffs(x); | |
245 | ||
246 | return n ? n-1 : 32; | |
247 | } | |
248 | ||
249 | /** | |
250 | * hw_read: reads from a hw register | |
251 | * @reg: register index | |
252 | * @mask: bitfield mask | |
253 | * | |
254 | * This function returns register contents | |
255 | */ | |
256 | static inline u32 hw_read(struct ci13xxx *udc, enum ci13xxx_regs reg, u32 mask) | |
257 | { | |
258 | return ioread32(udc->hw_bank.regmap[reg]) & mask; | |
259 | } | |
260 | ||
261 | /** | |
262 | * hw_write: writes to a hw register | |
263 | * @reg: register index | |
264 | * @mask: bitfield mask | |
265 | * @data: new value | |
266 | */ | |
267 | static inline void hw_write(struct ci13xxx *udc, enum ci13xxx_regs reg, | |
268 | u32 mask, u32 data) | |
269 | { | |
270 | if (~mask) | |
271 | data = (ioread32(udc->hw_bank.regmap[reg]) & ~mask) | |
272 | | (data & mask); | |
273 | ||
274 | iowrite32(data, udc->hw_bank.regmap[reg]); | |
275 | } | |
276 | ||
277 | /** | |
278 | * hw_test_and_clear: tests & clears a hw register | |
279 | * @reg: register index | |
280 | * @mask: bitfield mask | |
281 | * | |
282 | * This function returns register contents | |
283 | */ | |
284 | static inline u32 hw_test_and_clear(struct ci13xxx *udc, enum ci13xxx_regs reg, | |
285 | u32 mask) | |
286 | { | |
287 | u32 val = ioread32(udc->hw_bank.regmap[reg]) & mask; | |
288 | ||
289 | iowrite32(val, udc->hw_bank.regmap[reg]); | |
290 | return val; | |
291 | } | |
292 | ||
293 | /** | |
294 | * hw_test_and_write: tests & writes a hw register | |
295 | * @reg: register index | |
296 | * @mask: bitfield mask | |
297 | * @data: new value | |
298 | * | |
299 | * This function returns register contents | |
300 | */ | |
301 | static inline u32 hw_test_and_write(struct ci13xxx *udc, enum ci13xxx_regs reg, | |
302 | u32 mask, u32 data) | |
303 | { | |
304 | u32 val = hw_read(udc, reg, ~0); | |
305 | ||
306 | hw_write(udc, reg, mask, data); | |
307 | return (val & mask) >> ffs_nr(mask); | |
308 | } | |
309 | ||
eb70e5ab | 310 | int hw_device_reset(struct ci13xxx *ci, u32 mode); |
e443b333 AS |
311 | |
312 | int hw_port_test_set(struct ci13xxx *ci, u8 mode); | |
313 | ||
314 | u8 hw_port_test_get(struct ci13xxx *ci); | |
315 | ||
316 | #endif /* __DRIVERS_USB_CHIPIDEA_CI_H */ |