include/linux/usb/otg-fsm.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 #ifndef __LINUX_USB_OTG_FSM_H
  19 #define __LINUX_USB_OTG_FSM_H
  20
  21 #include <linux/mutex.h>
  22 #include <linux/errno.h>
  23
  24 #undef VERBOSE
  25
  26 #ifdef VERBOSE
  27 #define VDBG(fmt, args...) pr_debug("[%s]  " fmt , \
  28                                  __func__, ## args)
  29 #else
  30 #define VDBG(stuff...)  do {} while (0)
  31 #endif
  32
  33 #ifdef VERBOSE
  34 #define MPC_LOC printk("Current Location [%s]:[%d]\n", __FILE__, __LINE__)
  35 #else
  36 #define MPC_LOC do {} while (0)
  37 #endif
  38
  39 #define PROTO_UNDEF     (0)
  40 #define PROTO_HOST      (1)
  41 #define PROTO_GADGET    (2)
  42
  43 enum otg_fsm_timer {
  44         /* Standard OTG timers */
  45         A_WAIT_VRISE,
  46         A_WAIT_VFALL,
  47         A_WAIT_BCON,
  48         A_AIDL_BDIS,
  49         B_ASE0_BRST,
  50         A_BIDL_ADIS,
  51
  52         /* Auxiliary timers */
  53         B_SE0_SRP,
  54         B_SRP_FAIL,
  55         A_WAIT_ENUM,
  56         B_DATA_PLS,
  57         B_SSEND_SRP,
  58
  59         NUM_OTG_FSM_TIMERS,
  60 };
  61
  62 /* OTG state machine according to the OTG spec */
  63 struct otg_fsm {
  64         /* Input */
  65         int id;
  66         int adp_change;
  67         int power_up;
  68         int test_device;
  69         int a_bus_drop;
  70         int a_bus_req;
  71         int a_srp_det;
  72         int a_vbus_vld;
  73         int b_conn;
  74         int a_bus_resume;
  75         int a_bus_suspend;
  76         int a_conn;
  77         int b_bus_req;
  78         int b_se0_srp;
  79         int b_ssend_srp;
  80         int b_sess_vld;
  81         /* Auxilary inputs */
  82         int a_sess_vld;
  83         int b_bus_resume;
  84         int b_bus_suspend;
  85
  86         /* Output */
  87         int data_pulse;
  88         int drv_vbus;
  89         int loc_conn;
  90         int loc_sof;
  91         int adp_prb;
  92         int adp_sns;
  93
  94         /* Internal variables */
  95         int a_set_b_hnp_en;
  96         int b_srp_done;
  97         int b_hnp_enable;
  98         int a_clr_err;
  99
 100         /* Informative variables */
 101         int a_bus_drop_inf;
 102         int a_bus_req_inf;
 103         int a_clr_err_inf;
 104         int b_bus_req_inf;
 105         /* Auxilary informative variables */
 106         int a_suspend_req_inf;
 107
 108         /* Timeout indicator for timers */
 109         int a_wait_vrise_tmout;
 110         int a_wait_vfall_tmout;
 111         int a_wait_bcon_tmout;
 112         int a_aidl_bdis_tmout;
 113         int b_ase0_brst_tmout;
 114         int a_bidl_adis_tmout;
 115
 116         struct otg_fsm_ops *ops;
 117         struct usb_otg *otg;
 118
 119         /* Current usb protocol used: 0:undefine; 1:host; 2:client */
 120         int protocol;
 121         struct mutex lock;
 122 };
 123
 124 struct otg_fsm_ops {
 125         void    (*chrg_vbus)(struct otg_fsm *fsm, int on);
 126         void    (*drv_vbus)(struct otg_fsm *fsm, int on);
 127         void    (*loc_conn)(struct otg_fsm *fsm, int on);
 128         void    (*loc_sof)(struct otg_fsm *fsm, int on);
 129         void    (*start_pulse)(struct otg_fsm *fsm);
 130         void    (*start_adp_prb)(struct otg_fsm *fsm);
 131         void    (*start_adp_sns)(struct otg_fsm *fsm);
 132         void    (*add_timer)(struct otg_fsm *fsm, enum otg_fsm_timer timer);
 133         void    (*del_timer)(struct otg_fsm *fsm, enum otg_fsm_timer timer);
 134         int     (*start_host)(struct otg_fsm *fsm, int on);
 135         int     (*start_gadget)(struct otg_fsm *fsm, int on);
 136 };
 137
 138
 139 static inline int otg_chrg_vbus(struct otg_fsm *fsm, int on)
 140 {
 141         if (!fsm->ops->chrg_vbus)
 142                 return -EOPNOTSUPP;
 143         fsm->ops->chrg_vbus(fsm, on);
 144         return 0;
 145 }
 146
 147 static inline int otg_drv_vbus(struct otg_fsm *fsm, int on)
 148 {
 149         if (!fsm->ops->drv_vbus)
 150                 return -EOPNOTSUPP;
 151         if (fsm->drv_vbus != on) {
 152                 fsm->drv_vbus = on;
 153                 fsm->ops->drv_vbus(fsm, on);
 154         }
 155         return 0;
 156 }
 157
 158 static inline int otg_loc_conn(struct otg_fsm *fsm, int on)
 159 {
 160         if (!fsm->ops->loc_conn)
 161                 return -EOPNOTSUPP;
 162         if (fsm->loc_conn != on) {
 163                 fsm->loc_conn = on;
 164                 fsm->ops->loc_conn(fsm, on);
 165         }
 166         return 0;
 167 }
 168
 169 static inline int otg_loc_sof(struct otg_fsm *fsm, int on)
 170 {
 171         if (!fsm->ops->loc_sof)
 172                 return -EOPNOTSUPP;
 173         if (fsm->loc_sof != on) {
 174                 fsm->loc_sof = on;
 175                 fsm->ops->loc_sof(fsm, on);
 176         }
 177         return 0;
 178 }
 179
 180 static inline int otg_start_pulse(struct otg_fsm *fsm)
 181 {
 182         if (!fsm->ops->start_pulse)
 183                 return -EOPNOTSUPP;
 184         if (!fsm->data_pulse) {
 185                 fsm->data_pulse = 1;
 186                 fsm->ops->start_pulse(fsm);
 187         }
 188         return 0;
 189 }
 190
 191 static inline int otg_start_adp_prb(struct otg_fsm *fsm)
 192 {
 193         if (!fsm->ops->start_adp_prb)
 194                 return -EOPNOTSUPP;
 195         if (!fsm->adp_prb) {
 196                 fsm->adp_sns = 0;
 197                 fsm->adp_prb = 1;
 198                 fsm->ops->start_adp_prb(fsm);
 199         }
 200         return 0;
 201 }
 202
 203 static inline int otg_start_adp_sns(struct otg_fsm *fsm)
 204 {
 205         if (!fsm->ops->start_adp_sns)
 206                 return -EOPNOTSUPP;
 207         if (!fsm->adp_sns) {
 208                 fsm->adp_sns = 1;
 209                 fsm->ops->start_adp_sns(fsm);
 210         }
 211         return 0;
 212 }
 213
 214 static inline int otg_add_timer(struct otg_fsm *fsm, enum otg_fsm_timer timer)
 215 {
 216         if (!fsm->ops->add_timer)
 217                 return -EOPNOTSUPP;
 218         fsm->ops->add_timer(fsm, timer);
 219         return 0;
 220 }
 221
 222 static inline int otg_del_timer(struct otg_fsm *fsm, enum otg_fsm_timer timer)
 223 {
 224         if (!fsm->ops->del_timer)
 225                 return -EOPNOTSUPP;
 226         fsm->ops->del_timer(fsm, timer);
 227         return 0;
 228 }
 229
 230 static inline int otg_start_host(struct otg_fsm *fsm, int on)
 231 {
 232         if (!fsm->ops->start_host)
 233                 return -EOPNOTSUPP;
 234         return fsm->ops->start_host(fsm, on);
 235 }
 236
 237 static inline int otg_start_gadget(struct otg_fsm *fsm, int on)
 238 {
 239         if (!fsm->ops->start_gadget)
 240                 return -EOPNOTSUPP;
 241         return fsm->ops->start_gadget(fsm, on);
 242 }
 243
 244 int otg_statemachine(struct otg_fsm *fsm);
 245
 246 #endif /* __LINUX_USB_OTG_FSM_H */