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 id;
  58         int adp_change;
  59         int power_up;
  60         int test_device;
  61         int a_bus_drop;
  62         int a_bus_req;
  63         int a_srp_det;
  64         int a_vbus_vld;
  65         int b_conn;
  66         int a_bus_resume;
  67         int a_bus_suspend;
  68         int a_conn;
  69         int b_bus_req;
  70         int b_se0_srp;
  71         int b_ssend_srp;
  72         int b_sess_vld;
  73         /* Auxilary inputs */
  74         int a_sess_vld;
  75         int b_bus_resume;
  76         int b_bus_suspend;
  77
  78         /* Output */
  79         int data_pulse;
  80         int drv_vbus;
  81         int loc_conn;
  82         int loc_sof;
  83         int adp_prb;
  84         int adp_sns;
  85
  86         /* Internal variables */
  87         int a_set_b_hnp_en;
  88         int b_srp_done;
  89         int b_hnp_enable;
  90         int a_clr_err;
  91
  92         /* Informative variables */
  93         int a_bus_drop_inf;
  94         int a_bus_req_inf;
  95         int a_clr_err_inf;
  96         int b_bus_req_inf;
  97         /* Auxilary informative variables */
  98         int a_suspend_req_inf;
  99
 100         /* Timeout indicator for timers */
 101         int a_wait_vrise_tmout;
 102         int a_wait_vfall_tmout;
 103         int a_wait_bcon_tmout;
 104         int a_aidl_bdis_tmout;
 105         int b_ase0_brst_tmout;
 106         int a_bidl_adis_tmout;
 107
 108         struct otg_fsm_ops *ops;
 109         struct usb_otg *otg;
 110
 111         /* Current usb protocol used: 0:undefine; 1:host; 2:client */
 112         int protocol;
 113         spinlock_t lock;
 114 };
 115
 116 struct otg_fsm_ops {
 117         void    (*chrg_vbus)(struct otg_fsm *fsm, int on);
 118         void    (*drv_vbus)(struct otg_fsm *fsm, int on);
 119         void    (*loc_conn)(struct otg_fsm *fsm, int on);
 120         void    (*loc_sof)(struct otg_fsm *fsm, int on);
 121         void    (*start_pulse)(struct otg_fsm *fsm);
 122         void    (*start_adp_prb)(struct otg_fsm *fsm);
 123         void    (*start_adp_sns)(struct otg_fsm *fsm);
 124         void    (*add_timer)(struct otg_fsm *fsm, enum otg_fsm_timer timer);
 125         void    (*del_timer)(struct otg_fsm *fsm, enum otg_fsm_timer timer);
 126         int     (*start_host)(struct otg_fsm *fsm, int on);
 127         int     (*start_gadget)(struct otg_fsm *fsm, int on);
 128 };
 129
 130
 131 static inline int otg_chrg_vbus(struct otg_fsm *fsm, int on)
 132 {
 133         if (!fsm->ops->chrg_vbus)
 134                 return -EOPNOTSUPP;
 135         fsm->ops->chrg_vbus(fsm, on);
 136         return 0;
 137 }
 138
 139 static inline int otg_drv_vbus(struct otg_fsm *fsm, int on)
 140 {
 141         if (!fsm->ops->drv_vbus)
 142                 return -EOPNOTSUPP;
 143         if (fsm->drv_vbus != on) {
 144                 fsm->drv_vbus = on;
 145                 fsm->ops->drv_vbus(fsm, on);
 146         }
 147         return 0;
 148 }
 149
 150 static inline int otg_loc_conn(struct otg_fsm *fsm, int on)
 151 {
 152         if (!fsm->ops->loc_conn)
 153                 return -EOPNOTSUPP;
 154         if (fsm->loc_conn != on) {
 155                 fsm->loc_conn = on;
 156                 fsm->ops->loc_conn(fsm, on);
 157         }
 158         return 0;
 159 }
 160
 161 static inline int otg_loc_sof(struct otg_fsm *fsm, int on)
 162 {
 163         if (!fsm->ops->loc_sof)
 164                 return -EOPNOTSUPP;
 165         if (fsm->loc_sof != on) {
 166                 fsm->loc_sof = on;
 167                 fsm->ops->loc_sof(fsm, on);
 168         }
 169         return 0;
 170 }
 171
 172 static inline int otg_start_pulse(struct otg_fsm *fsm)
 173 {
 174         if (!fsm->ops->start_pulse)
 175                 return -EOPNOTSUPP;
 176         if (!fsm->data_pulse) {
 177                 fsm->data_pulse = 1;
 178                 fsm->ops->start_pulse(fsm);
 179         }
 180         return 0;
 181 }
 182
 183 static inline int otg_start_adp_prb(struct otg_fsm *fsm)
 184 {
 185         if (!fsm->ops->start_adp_prb)
 186                 return -EOPNOTSUPP;
 187         if (!fsm->adp_prb) {
 188                 fsm->adp_sns = 0;
 189                 fsm->adp_prb = 1;
 190                 fsm->ops->start_adp_prb(fsm);
 191         }
 192         return 0;
 193 }
 194
 195 static inline int otg_start_adp_sns(struct otg_fsm *fsm)
 196 {
 197         if (!fsm->ops->start_adp_sns)
 198                 return -EOPNOTSUPP;
 199         if (!fsm->adp_sns) {
 200                 fsm->adp_sns = 1;
 201                 fsm->ops->start_adp_sns(fsm);
 202         }
 203         return 0;
 204 }
 205
 206 static inline int otg_add_timer(struct otg_fsm *fsm, enum otg_fsm_timer timer)
 207 {
 208         if (!fsm->ops->add_timer)
 209                 return -EOPNOTSUPP;
 210         fsm->ops->add_timer(fsm, timer);
 211         return 0;
 212 }
 213
 214 static inline int otg_del_timer(struct otg_fsm *fsm, enum otg_fsm_timer timer)
 215 {
 216         if (!fsm->ops->del_timer)
 217                 return -EOPNOTSUPP;
 218         fsm->ops->del_timer(fsm, timer);
 219         return 0;
 220 }
 221
 222 static inline int otg_start_host(struct otg_fsm *fsm, int on)
 223 {
 224         if (!fsm->ops->start_host)
 225                 return -EOPNOTSUPP;
 226         return fsm->ops->start_host(fsm, on);
 227 }
 228
 229 static inline int otg_start_gadget(struct otg_fsm *fsm, int on)
 230 {
 231         if (!fsm->ops->start_gadget)
 232                 return -EOPNOTSUPP;
 233         return fsm->ops->start_gadget(fsm, on);
 234 }
 235
 236 int otg_statemachine(struct otg_fsm *fsm);