drivers/usb/chipidea/ci.h

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