drivers/usb/phy/phy-fsm-usb.h

   1 /* Copyright (C) 2007,2008 Freescale Semiconductor, Inc.
   2  *
   3  * This program is free software; you can redistribute  it and/or modify it
   4  * under  the terms of  the GNU General  Public License as published by the
   5  * Free Software Foundation;  either version 2 of the  License, or (at your
   6  * option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful, but
   9  * WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11  * General Public License for more details.
  12  *
  13  * You should have received a copy of the  GNU General Public License along
  14  * with this program; if not, write  to the Free Software Foundation, Inc.,
  15  * 675 Mass Ave, Cambridge, MA 02139, USA.
  16  */
  17
  18 #undef VERBOSE
  19
  20 #ifdef VERBOSE
  21 #define VDBG(fmt, args...) pr_debug("[%s]  " fmt , \
  22                                  __func__, ## args)
  23 #else
  24 #define VDBG(stuff...)  do {} while (0)
  25 #endif
  26
  27 #ifdef VERBOSE
  28 #define MPC_LOC printk("Current Location [%s]:[%d]\n", __FILE__, __LINE__)
  29 #else
  30 #define MPC_LOC do {} while (0)
  31 #endif
  32
  33 #define PROTO_UNDEF     (0)
  34 #define PROTO_HOST      (1)
  35 #define PROTO_GADGET    (2)
  36
  37 /* OTG state machine according to the OTG spec */
  38 struct otg_fsm {
  39         /* Input */
  40         int a_bus_resume;
  41         int a_bus_suspend;
  42         int a_conn;
  43         int a_sess_vld;
  44         int a_srp_det;
  45         int a_vbus_vld;
  46         int b_bus_resume;
  47         int b_bus_suspend;
  48         int b_conn;
  49         int b_se0_srp;
  50         int b_sess_end;
  51         int b_sess_vld;
  52         int id;
  53
  54         /* Internal variables */
  55         int a_set_b_hnp_en;
  56         int b_srp_done;
  57         int b_hnp_enable;
  58
  59         /* Timeout indicator for timers */
  60         int a_wait_vrise_tmout;
  61         int a_wait_bcon_tmout;
  62         int a_aidl_bdis_tmout;
  63         int b_ase0_brst_tmout;
  64
  65         /* Informative variables */
  66         int a_bus_drop;
  67         int a_bus_req;
  68         int a_clr_err;
  69         int a_suspend_req;
  70         int b_bus_req;
  71
  72         /* Output */
  73         int drv_vbus;
  74         int loc_conn;
  75         int loc_sof;
  76
  77         struct otg_fsm_ops *ops;
  78         struct usb_otg *otg;
  79
  80         /* Current usb protocol used: 0:undefine; 1:host; 2:client */
  81         int protocol;
  82         spinlock_t lock;
  83 };
  84
  85 struct otg_fsm_ops {
  86         void    (*chrg_vbus)(int on);
  87         void    (*drv_vbus)(int on);
  88         void    (*loc_conn)(int on);
  89         void    (*loc_sof)(int on);
  90         void    (*start_pulse)(void);
  91         void    (*add_timer)(void *timer);
  92         void    (*del_timer)(void *timer);
  93         int     (*start_host)(struct otg_fsm *fsm, int on);
  94         int     (*start_gadget)(struct otg_fsm *fsm, int on);
  95 };
  96
  97
  98 static inline void otg_chrg_vbus(struct otg_fsm *fsm, int on)
  99 {
 100         fsm->ops->chrg_vbus(on);
 101 }
 102
 103 static inline void otg_drv_vbus(struct otg_fsm *fsm, int on)
 104 {
 105         if (fsm->drv_vbus != on) {
 106                 fsm->drv_vbus = on;
 107                 fsm->ops->drv_vbus(on);
 108         }
 109 }
 110
 111 static inline void otg_loc_conn(struct otg_fsm *fsm, int on)
 112 {
 113         if (fsm->loc_conn != on) {
 114                 fsm->loc_conn = on;
 115                 fsm->ops->loc_conn(on);
 116         }
 117 }
 118
 119 static inline void otg_loc_sof(struct otg_fsm *fsm, int on)
 120 {
 121         if (fsm->loc_sof != on) {
 122                 fsm->loc_sof = on;
 123                 fsm->ops->loc_sof(on);
 124         }
 125 }
 126
 127 static inline void otg_start_pulse(struct otg_fsm *fsm)
 128 {
 129         fsm->ops->start_pulse();
 130 }
 131
 132 static inline void otg_add_timer(struct otg_fsm *fsm, void *timer)
 133 {
 134         fsm->ops->add_timer(timer);
 135 }
 136
 137 static inline void otg_del_timer(struct otg_fsm *fsm, void *timer)
 138 {
 139         fsm->ops->del_timer(timer);
 140 }
 141
 142 int otg_statemachine(struct otg_fsm *fsm);
 143
 144 /* Defined by device specific driver, for different timer implementation */
 145 extern struct fsl_otg_timer *a_wait_vrise_tmr, *a_wait_bcon_tmr,
 146         *a_aidl_bdis_tmr, *b_ase0_brst_tmr, *b_se0_srp_tmr, *b_srp_fail_tmr,
 147         *a_wait_enum_tmr;