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 enum otg_fsm_timer {
  38         /* Standard OTG timers */
  39         A_WAIT_VRISE,
  40         A_WAIT_VFALL,
  41         A_WAIT_BCON,
  42         A_AIDL_BDIS,
  43         B_ASE0_BRST,
  44         A_BIDL_ADIS,
  45
  46         /* Auxiliary timers */
  47         B_SE0_SRP,
  48         B_SRP_FAIL,
  49         A_WAIT_ENUM,
  50
  51         NUM_OTG_FSM_TIMERS,
  52 };
  53
  54 /* OTG state machine according to the OTG spec */
  55 struct otg_fsm {
  56         /* Input */
  57         int a_bus_drop;
  58         int a_bus_req;
  59         int a_bus_resume;
  60         int a_bus_suspend;
  61         int a_conn;
  62         int b_bus_req;
  63         int a_sess_vld;
  64         int a_srp_det;
  65         int a_vbus_vld;
  66         int b_bus_resume;
  67         int b_bus_suspend;
  68         int b_conn;
  69         int b_se0_srp;
  70         int b_ssend_srp;
  71         int b_sess_vld;
  72         int id;
  73
  74         /* Internal variables */
  75         int a_set_b_hnp_en;
  76         int b_srp_done;
  77         int b_hnp_enable;
  78         int a_clr_err;
  79
  80         /* Timeout indicator for timers */
  81         int a_wait_vrise_tmout;
  82         int a_wait_vfall_tmout;
  83         int a_wait_bcon_tmout;
  84         int a_aidl_bdis_tmout;
  85         int b_ase0_brst_tmout;
  86         int a_bidl_adis_tmout;
  87
  88         /* Informative variables */
  89         int a_bus_drop_inf;
  90         int a_bus_req_inf;
  91         int a_clr_err_inf;
  92         int a_suspend_req_inf;
  93         int b_bus_req_inf;
  94
  95         /* Output */
  96         int drv_vbus;
  97         int loc_conn;
  98         int loc_sof;
  99
 100         struct otg_fsm_ops *ops;
 101         struct usb_otg *otg;
 102
 103         /* Current usb protocol used: 0:undefine; 1:host; 2:client */
 104         int protocol;
 105         spinlock_t lock;
 106 };
 107
 108 struct otg_fsm_ops {
 109         void    (*chrg_vbus)(struct otg_fsm *fsm, int on);
 110         void    (*drv_vbus)(struct otg_fsm *fsm, int on);
 111         void    (*loc_conn)(struct otg_fsm *fsm, int on);
 112         void    (*loc_sof)(struct otg_fsm *fsm, int on);
 113         void    (*start_pulse)(struct otg_fsm *fsm);
 114         void    (*add_timer)(struct otg_fsm *fsm, enum otg_fsm_timer timer);
 115         void    (*del_timer)(struct otg_fsm *fsm, enum otg_fsm_timer timer);
 116         int     (*start_host)(struct otg_fsm *fsm, int on);
 117         int     (*start_gadget)(struct otg_fsm *fsm, int on);
 118 };
 119
 120
 121 static inline int otg_chrg_vbus(struct otg_fsm *fsm, int on)
 122 {
 123         if (!fsm->ops->chrg_vbus)
 124                 return -EOPNOTSUPP;
 125         fsm->ops->chrg_vbus(fsm, on);
 126         return 0;
 127 }
 128
 129 static inline int otg_drv_vbus(struct otg_fsm *fsm, int on)
 130 {
 131         if (!fsm->ops->drv_vbus)
 132                 return -EOPNOTSUPP;
 133         if (fsm->drv_vbus != on) {
 134                 fsm->drv_vbus = on;
 135                 fsm->ops->drv_vbus(fsm, on);
 136         }
 137         return 0;
 138 }
 139
 140 static inline int otg_loc_conn(struct otg_fsm *fsm, int on)
 141 {
 142         if (!fsm->ops->loc_conn)
 143                 return -EOPNOTSUPP;
 144         if (fsm->loc_conn != on) {
 145                 fsm->loc_conn = on;
 146                 fsm->ops->loc_conn(fsm, on);
 147         }
 148         return 0;
 149 }
 150
 151 static inline int otg_loc_sof(struct otg_fsm *fsm, int on)
 152 {
 153         if (!fsm->ops->loc_sof)
 154                 return -EOPNOTSUPP;
 155         if (fsm->loc_sof != on) {
 156                 fsm->loc_sof = on;
 157                 fsm->ops->loc_sof(fsm, on);
 158         }
 159         return 0;
 160 }
 161
 162 static inline int otg_start_pulse(struct otg_fsm *fsm)
 163 {
 164         if (!fsm->ops->start_pulse)
 165                 return -EOPNOTSUPP;
 166         fsm->ops->start_pulse(fsm);
 167         return 0;
 168 }
 169
 170 static inline int otg_add_timer(struct otg_fsm *fsm, enum otg_fsm_timer timer)
 171 {
 172         if (!fsm->ops->add_timer)
 173                 return -EOPNOTSUPP;
 174         fsm->ops->add_timer(fsm, timer);
 175         return 0;
 176 }
 177
 178 static inline int otg_del_timer(struct otg_fsm *fsm, enum otg_fsm_timer timer)
 179 {
 180         if (!fsm->ops->del_timer)
 181                 return -EOPNOTSUPP;
 182         fsm->ops->del_timer(fsm, timer);
 183         return 0;
 184 }
 185
 186 static inline int otg_start_host(struct otg_fsm *fsm, int on)
 187 {
 188         if (!fsm->ops->start_host)
 189                 return -EOPNOTSUPP;
 190         return fsm->ops->start_host(fsm, on);
 191 }
 192
 193 static inline int otg_start_gadget(struct otg_fsm *fsm, int on)
 194 {
 195         if (!fsm->ops->start_gadget)
 196                 return -EOPNOTSUPP;
 197         return fsm->ops->start_gadget(fsm, on);
 198 }
 199
 200 int otg_statemachine(struct otg_fsm *fsm);