2011-04-18 14:01:59 -06:00
|
|
|
/* Copyright (C) 2007,2008 Freescale Semiconductor, Inc.
|
|
|
|
*
|
|
|
|
* This program is free software; you can redistribute it and/or modify it
|
|
|
|
* under the terms of the GNU General Public License as published by the
|
|
|
|
* Free Software Foundation; either version 2 of the License, or (at your
|
|
|
|
* option) any later version.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful, but
|
|
|
|
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
|
* General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License along
|
|
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
|
|
* 675 Mass Ave, Cambridge, MA 02139, USA.
|
|
|
|
*/
|
|
|
|
|
2013-11-26 09:08:58 -07:00
|
|
|
#ifndef __LINUX_USB_OTG_FSM_H
|
|
|
|
#define __LINUX_USB_OTG_FSM_H
|
|
|
|
|
2013-11-25 19:46:05 -07:00
|
|
|
#include <linux/mutex.h>
|
2013-11-26 09:06:00 -07:00
|
|
|
#include <linux/errno.h>
|
|
|
|
|
2011-04-18 14:01:59 -06:00
|
|
|
#undef VERBOSE
|
|
|
|
|
|
|
|
#ifdef VERBOSE
|
2013-06-28 12:32:55 -06:00
|
|
|
#define VDBG(fmt, args...) pr_debug("[%s] " fmt , \
|
|
|
|
__func__, ## args)
|
2011-04-18 14:01:59 -06:00
|
|
|
#else
|
|
|
|
#define VDBG(stuff...) do {} while (0)
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#ifdef VERBOSE
|
|
|
|
#define MPC_LOC printk("Current Location [%s]:[%d]\n", __FILE__, __LINE__)
|
|
|
|
#else
|
|
|
|
#define MPC_LOC do {} while (0)
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#define PROTO_UNDEF (0)
|
|
|
|
#define PROTO_HOST (1)
|
|
|
|
#define PROTO_GADGET (2)
|
|
|
|
|
2013-10-02 21:42:04 -06:00
|
|
|
enum otg_fsm_timer {
|
2013-10-02 21:42:04 -06:00
|
|
|
/* Standard OTG timers */
|
2013-10-02 21:42:04 -06:00
|
|
|
A_WAIT_VRISE,
|
2013-10-02 21:42:04 -06:00
|
|
|
A_WAIT_VFALL,
|
2013-10-02 21:42:04 -06:00
|
|
|
A_WAIT_BCON,
|
|
|
|
A_AIDL_BDIS,
|
|
|
|
B_ASE0_BRST,
|
2013-10-02 21:42:04 -06:00
|
|
|
A_BIDL_ADIS,
|
|
|
|
|
|
|
|
/* Auxiliary timers */
|
2013-10-02 21:42:04 -06:00
|
|
|
B_SE0_SRP,
|
|
|
|
B_SRP_FAIL,
|
|
|
|
A_WAIT_ENUM,
|
2013-10-02 21:42:04 -06:00
|
|
|
|
2013-10-02 21:42:04 -06:00
|
|
|
NUM_OTG_FSM_TIMERS,
|
|
|
|
};
|
|
|
|
|
2011-04-18 14:01:59 -06:00
|
|
|
/* OTG state machine according to the OTG spec */
|
|
|
|
struct otg_fsm {
|
|
|
|
/* Input */
|
2013-10-02 21:42:04 -06:00
|
|
|
int id;
|
2013-10-02 21:42:04 -06:00
|
|
|
int adp_change;
|
|
|
|
int power_up;
|
|
|
|
int test_device;
|
2013-10-02 21:42:04 -06:00
|
|
|
int a_bus_drop;
|
|
|
|
int a_bus_req;
|
2013-10-02 21:42:04 -06:00
|
|
|
int a_srp_det;
|
|
|
|
int a_vbus_vld;
|
|
|
|
int b_conn;
|
2011-04-18 14:01:59 -06:00
|
|
|
int a_bus_resume;
|
|
|
|
int a_bus_suspend;
|
|
|
|
int a_conn;
|
2013-10-02 21:42:04 -06:00
|
|
|
int b_bus_req;
|
2011-04-18 14:01:59 -06:00
|
|
|
int b_se0_srp;
|
2013-10-02 21:42:04 -06:00
|
|
|
int b_ssend_srp;
|
2011-04-18 14:01:59 -06:00
|
|
|
int b_sess_vld;
|
2013-10-02 21:42:04 -06:00
|
|
|
/* Auxilary inputs */
|
|
|
|
int a_sess_vld;
|
|
|
|
int b_bus_resume;
|
|
|
|
int b_bus_suspend;
|
|
|
|
|
|
|
|
/* Output */
|
|
|
|
int data_pulse;
|
|
|
|
int drv_vbus;
|
|
|
|
int loc_conn;
|
|
|
|
int loc_sof;
|
|
|
|
int adp_prb;
|
|
|
|
int adp_sns;
|
2011-04-18 14:01:59 -06:00
|
|
|
|
|
|
|
/* Internal variables */
|
|
|
|
int a_set_b_hnp_en;
|
|
|
|
int b_srp_done;
|
|
|
|
int b_hnp_enable;
|
2013-10-02 21:42:04 -06:00
|
|
|
int a_clr_err;
|
2011-04-18 14:01:59 -06:00
|
|
|
|
2013-10-02 21:42:04 -06:00
|
|
|
/* Informative variables */
|
|
|
|
int a_bus_drop_inf;
|
|
|
|
int a_bus_req_inf;
|
|
|
|
int a_clr_err_inf;
|
|
|
|
int b_bus_req_inf;
|
|
|
|
/* Auxilary informative variables */
|
|
|
|
int a_suspend_req_inf;
|
|
|
|
|
2011-04-18 14:01:59 -06:00
|
|
|
/* Timeout indicator for timers */
|
|
|
|
int a_wait_vrise_tmout;
|
2013-10-02 21:42:04 -06:00
|
|
|
int a_wait_vfall_tmout;
|
2011-04-18 14:01:59 -06:00
|
|
|
int a_wait_bcon_tmout;
|
|
|
|
int a_aidl_bdis_tmout;
|
|
|
|
int b_ase0_brst_tmout;
|
2013-10-02 21:42:04 -06:00
|
|
|
int a_bidl_adis_tmout;
|
2011-04-18 14:01:59 -06:00
|
|
|
|
|
|
|
struct otg_fsm_ops *ops;
|
2012-02-13 04:24:06 -07:00
|
|
|
struct usb_otg *otg;
|
2011-04-18 14:01:59 -06:00
|
|
|
|
|
|
|
/* Current usb protocol used: 0:undefine; 1:host; 2:client */
|
|
|
|
int protocol;
|
2013-11-25 19:46:05 -07:00
|
|
|
struct mutex lock;
|
2011-04-18 14:01:59 -06:00
|
|
|
};
|
|
|
|
|
|
|
|
struct otg_fsm_ops {
|
2013-10-02 21:42:04 -06:00
|
|
|
void (*chrg_vbus)(struct otg_fsm *fsm, int on);
|
|
|
|
void (*drv_vbus)(struct otg_fsm *fsm, int on);
|
|
|
|
void (*loc_conn)(struct otg_fsm *fsm, int on);
|
|
|
|
void (*loc_sof)(struct otg_fsm *fsm, int on);
|
|
|
|
void (*start_pulse)(struct otg_fsm *fsm);
|
2013-10-02 21:42:04 -06:00
|
|
|
void (*start_adp_prb)(struct otg_fsm *fsm);
|
|
|
|
void (*start_adp_sns)(struct otg_fsm *fsm);
|
2013-10-02 21:42:04 -06:00
|
|
|
void (*add_timer)(struct otg_fsm *fsm, enum otg_fsm_timer timer);
|
|
|
|
void (*del_timer)(struct otg_fsm *fsm, enum otg_fsm_timer timer);
|
2011-04-18 14:01:59 -06:00
|
|
|
int (*start_host)(struct otg_fsm *fsm, int on);
|
|
|
|
int (*start_gadget)(struct otg_fsm *fsm, int on);
|
|
|
|
};
|
|
|
|
|
|
|
|
|
2013-10-02 21:42:04 -06:00
|
|
|
static inline int otg_chrg_vbus(struct otg_fsm *fsm, int on)
|
2011-04-18 14:01:59 -06:00
|
|
|
{
|
2013-10-02 21:42:04 -06:00
|
|
|
if (!fsm->ops->chrg_vbus)
|
|
|
|
return -EOPNOTSUPP;
|
2013-10-02 21:42:04 -06:00
|
|
|
fsm->ops->chrg_vbus(fsm, on);
|
2013-10-02 21:42:04 -06:00
|
|
|
return 0;
|
2011-04-18 14:01:59 -06:00
|
|
|
}
|
|
|
|
|
2013-10-02 21:42:04 -06:00
|
|
|
static inline int otg_drv_vbus(struct otg_fsm *fsm, int on)
|
2011-04-18 14:01:59 -06:00
|
|
|
{
|
2013-10-02 21:42:04 -06:00
|
|
|
if (!fsm->ops->drv_vbus)
|
|
|
|
return -EOPNOTSUPP;
|
2011-04-18 14:01:59 -06:00
|
|
|
if (fsm->drv_vbus != on) {
|
|
|
|
fsm->drv_vbus = on;
|
2013-10-02 21:42:04 -06:00
|
|
|
fsm->ops->drv_vbus(fsm, on);
|
2011-04-18 14:01:59 -06:00
|
|
|
}
|
2013-10-02 21:42:04 -06:00
|
|
|
return 0;
|
2011-04-18 14:01:59 -06:00
|
|
|
}
|
|
|
|
|
2013-10-02 21:42:04 -06:00
|
|
|
static inline int otg_loc_conn(struct otg_fsm *fsm, int on)
|
2011-04-18 14:01:59 -06:00
|
|
|
{
|
2013-10-02 21:42:04 -06:00
|
|
|
if (!fsm->ops->loc_conn)
|
|
|
|
return -EOPNOTSUPP;
|
2011-04-18 14:01:59 -06:00
|
|
|
if (fsm->loc_conn != on) {
|
|
|
|
fsm->loc_conn = on;
|
2013-10-02 21:42:04 -06:00
|
|
|
fsm->ops->loc_conn(fsm, on);
|
2011-04-18 14:01:59 -06:00
|
|
|
}
|
2013-10-02 21:42:04 -06:00
|
|
|
return 0;
|
2011-04-18 14:01:59 -06:00
|
|
|
}
|
|
|
|
|
2013-10-02 21:42:04 -06:00
|
|
|
static inline int otg_loc_sof(struct otg_fsm *fsm, int on)
|
2011-04-18 14:01:59 -06:00
|
|
|
{
|
2013-10-02 21:42:04 -06:00
|
|
|
if (!fsm->ops->loc_sof)
|
|
|
|
return -EOPNOTSUPP;
|
2011-04-18 14:01:59 -06:00
|
|
|
if (fsm->loc_sof != on) {
|
|
|
|
fsm->loc_sof = on;
|
2013-10-02 21:42:04 -06:00
|
|
|
fsm->ops->loc_sof(fsm, on);
|
2011-04-18 14:01:59 -06:00
|
|
|
}
|
2013-10-02 21:42:04 -06:00
|
|
|
return 0;
|
2011-04-18 14:01:59 -06:00
|
|
|
}
|
|
|
|
|
2013-10-02 21:42:04 -06:00
|
|
|
static inline int otg_start_pulse(struct otg_fsm *fsm)
|
2011-04-18 14:01:59 -06:00
|
|
|
{
|
2013-10-02 21:42:04 -06:00
|
|
|
if (!fsm->ops->start_pulse)
|
|
|
|
return -EOPNOTSUPP;
|
2013-10-02 21:42:04 -06:00
|
|
|
if (!fsm->data_pulse) {
|
|
|
|
fsm->data_pulse = 1;
|
|
|
|
fsm->ops->start_pulse(fsm);
|
|
|
|
}
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline int otg_start_adp_prb(struct otg_fsm *fsm)
|
|
|
|
{
|
|
|
|
if (!fsm->ops->start_adp_prb)
|
|
|
|
return -EOPNOTSUPP;
|
|
|
|
if (!fsm->adp_prb) {
|
|
|
|
fsm->adp_sns = 0;
|
|
|
|
fsm->adp_prb = 1;
|
|
|
|
fsm->ops->start_adp_prb(fsm);
|
|
|
|
}
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline int otg_start_adp_sns(struct otg_fsm *fsm)
|
|
|
|
{
|
|
|
|
if (!fsm->ops->start_adp_sns)
|
|
|
|
return -EOPNOTSUPP;
|
|
|
|
if (!fsm->adp_sns) {
|
|
|
|
fsm->adp_sns = 1;
|
|
|
|
fsm->ops->start_adp_sns(fsm);
|
|
|
|
}
|
2013-10-02 21:42:04 -06:00
|
|
|
return 0;
|
2011-04-18 14:01:59 -06:00
|
|
|
}
|
|
|
|
|
2013-10-02 21:42:04 -06:00
|
|
|
static inline int otg_add_timer(struct otg_fsm *fsm, enum otg_fsm_timer timer)
|
2011-04-18 14:01:59 -06:00
|
|
|
{
|
2013-10-02 21:42:04 -06:00
|
|
|
if (!fsm->ops->add_timer)
|
|
|
|
return -EOPNOTSUPP;
|
2013-10-02 21:42:04 -06:00
|
|
|
fsm->ops->add_timer(fsm, timer);
|
2013-10-02 21:42:04 -06:00
|
|
|
return 0;
|
2011-04-18 14:01:59 -06:00
|
|
|
}
|
|
|
|
|
2013-10-02 21:42:04 -06:00
|
|
|
static inline int otg_del_timer(struct otg_fsm *fsm, enum otg_fsm_timer timer)
|
2011-04-18 14:01:59 -06:00
|
|
|
{
|
2013-10-02 21:42:04 -06:00
|
|
|
if (!fsm->ops->del_timer)
|
|
|
|
return -EOPNOTSUPP;
|
2013-10-02 21:42:04 -06:00
|
|
|
fsm->ops->del_timer(fsm, timer);
|
2013-10-02 21:42:04 -06:00
|
|
|
return 0;
|
2011-04-18 14:01:59 -06:00
|
|
|
}
|
|
|
|
|
2013-10-02 21:42:04 -06:00
|
|
|
static inline int otg_start_host(struct otg_fsm *fsm, int on)
|
|
|
|
{
|
|
|
|
if (!fsm->ops->start_host)
|
|
|
|
return -EOPNOTSUPP;
|
|
|
|
return fsm->ops->start_host(fsm, on);
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline int otg_start_gadget(struct otg_fsm *fsm, int on)
|
|
|
|
{
|
|
|
|
if (!fsm->ops->start_gadget)
|
|
|
|
return -EOPNOTSUPP;
|
|
|
|
return fsm->ops->start_gadget(fsm, on);
|
|
|
|
}
|
|
|
|
|
2011-04-18 14:01:59 -06:00
|
|
|
int otg_statemachine(struct otg_fsm *fsm);
|
2013-11-26 09:08:58 -07:00
|
|
|
|
|
|
|
#endif /* __LINUX_USB_OTG_FSM_H */
|