2 * ci.h - common structures, functions, and macros of the ChipIdea driver
4 * Copyright (C) 2008 Chipidea - MIPS Technologies, Inc. All rights reserved.
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.
13 #ifndef __DRIVERS_USB_CHIPIDEA_CI_H
14 #define __DRIVERS_USB_CHIPIDEA_CI_H
16 #include <linux/list.h>
17 #include <linux/irqreturn.h>
18 #include <linux/usb/gadget.h>
20 /******************************************************************************
22 *****************************************************************************/
23 #define DMA_ADDR_INVALID (~(dma_addr_t)0)
24 #define CI13XXX_PAGE_SIZE 4096ul /* page size for TD's */
27 /******************************************************************************
29 *****************************************************************************/
31 * struct ci13xxx_ep - endpoint representation
32 * @ep: endpoint structure for gadget drivers
33 * @dir: endpoint direction (TX/RX)
34 * @num: endpoint number
35 * @type: endpoint type
36 * @name: string description of the endpoint
37 * @qh: queue head for this endpoint
38 * @wedge: is the endpoint wedged
39 * @udc: pointer to the controller
40 * @lock: pointer to controller's spinlock
41 * @device: pointer to gadget's struct device
42 * @td_pool: pointer to controller's TD pool
51 struct list_head queue;
52 struct ci13xxx_qh *ptr;
57 /* global resources */
60 struct device *device;
61 struct dma_pool *td_pool;
71 * struct ci_role_driver - host/gadget role driver
72 * start: start this role
73 * stop: stop this role
74 * irq: irq handler for this role
75 * name: role name string (host/gadget)
77 struct ci_role_driver {
78 int (*start)(struct ci13xxx *);
79 void (*stop)(struct ci13xxx *);
80 irqreturn_t (*irq)(struct ci13xxx *);
85 * struct hw_bank - hardware register mapping representation
86 * @lpm: set if the device is LPM capable
87 * @abs: absolute address of the beginning of register window
88 * @cap: capability registers
89 * @op: operational registers
90 * @size: size of the register window
91 * @regmap: register lookup table
99 void __iomem **regmap;
103 * struct ci13xxx - chipidea device representation
104 * @dev: pointer to parent device
105 * @lock: access synchronization
106 * @hw_bank: hardware register mapping
108 * @roles: array of supported roles for this controller
109 * @role: current role
110 * @is_otg: if the device is otg-capable
111 * @work: work for role changing
112 * @wq: workqueue thread
113 * @qh_pool: allocation pool for queue heads
114 * @td_pool: allocation pool for transfer descriptors
115 * @gadget: device side representation for peripheral controller
116 * @driver: gadget driver
117 * @hw_ep_max: total number of endpoints supported by hardware
118 * @ci13xxx_ep: array of endpoints
119 * @ep0_dir: ep0 direction
120 * @ep0out: pointer to ep0 OUT endpoint
121 * @ep0in: pointer to ep0 IN endpoint
122 * @status: ep0 status request
123 * @setaddr: if we should set the address on status completion
124 * @address: usb address received from the host
125 * @remote_wakeup: host-enabled remote wakeup
126 * @suspended: suspended by host
127 * @test_mode: the selected test mode
128 * @udc_driver: platform specific information supplied by parent device
129 * @vbus_active: is VBUS active
130 * @transceiver: pointer to USB PHY, if any
135 struct hw_bank hw_bank;
137 struct ci_role_driver *roles[CI_ROLE_END];
140 struct work_struct work;
141 struct workqueue_struct *wq;
143 struct dma_pool *qh_pool;
144 struct dma_pool *td_pool;
146 struct usb_gadget gadget;
147 struct usb_gadget_driver *driver;
149 struct ci13xxx_ep ci13xxx_ep[ENDPT_MAX];
151 struct ci13xxx_ep *ep0out, *ep0in;
153 struct usb_request *status;
160 struct ci13xxx_udc_driver *udc_driver;
162 struct usb_phy *transceiver;
165 static inline struct ci_role_driver *ci_role(struct ci13xxx *ci)
167 BUG_ON(ci->role >= CI_ROLE_END || !ci->roles[ci->role]);
168 return ci->roles[ci->role];
171 static inline int ci_role_start(struct ci13xxx *ci, enum ci_role role)
175 if (role >= CI_ROLE_END)
178 if (!ci->roles[role])
181 ret = ci->roles[role]->start(ci);
187 static inline void ci_role_stop(struct ci13xxx *ci)
189 enum ci_role role = ci->role;
191 if (role == CI_ROLE_END)
194 ci->role = CI_ROLE_END;
196 ci->roles[role]->stop(ci);
199 /******************************************************************************
201 *****************************************************************************/
203 #define REG_BITS (32)
205 /* register indices */
211 CAP_LAST = CAP_TESTMODE,
227 /* endptctrl1..15 follow */
228 OP_LAST = OP_ENDPTCTRL + ENDPT_MAX / 2,
232 * ffs_nr: find first (least significant) bit set
233 * @x: the word to search
235 * This function returns bit number (instead of position)
237 static inline int ffs_nr(u32 x)
245 * hw_read: reads from a hw register
246 * @reg: register index
247 * @mask: bitfield mask
249 * This function returns register contents
251 static inline u32 hw_read(struct ci13xxx *udc, enum ci13xxx_regs reg, u32 mask)
253 return ioread32(udc->hw_bank.regmap[reg]) & mask;
257 * hw_write: writes to a hw register
258 * @reg: register index
259 * @mask: bitfield mask
262 static inline void hw_write(struct ci13xxx *udc, enum ci13xxx_regs reg,
266 data = (ioread32(udc->hw_bank.regmap[reg]) & ~mask)
269 iowrite32(data, udc->hw_bank.regmap[reg]);
273 * hw_test_and_clear: tests & clears a hw register
274 * @reg: register index
275 * @mask: bitfield mask
277 * This function returns register contents
279 static inline u32 hw_test_and_clear(struct ci13xxx *udc, enum ci13xxx_regs reg,
282 u32 val = ioread32(udc->hw_bank.regmap[reg]) & mask;
284 iowrite32(val, udc->hw_bank.regmap[reg]);
289 * hw_test_and_write: tests & writes a hw register
290 * @reg: register index
291 * @mask: bitfield mask
294 * This function returns register contents
296 static inline u32 hw_test_and_write(struct ci13xxx *udc, enum ci13xxx_regs reg,
299 u32 val = hw_read(udc, reg, ~0);
301 hw_write(udc, reg, mask, data);
302 return (val & mask) >> ffs_nr(mask);
305 int hw_device_reset(struct ci13xxx *ci);
307 int hw_port_test_set(struct ci13xxx *ci, u8 mode);
309 u8 hw_port_test_get(struct ci13xxx *ci);
311 #endif /* __DRIVERS_USB_CHIPIDEA_CI_H */