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