xref: /linux/drivers/usb/chipidea/otg_fsm.h (revision 3932b9ca55b0be314a36d3e84faff3e823c081f5)
1 /*
2  * Copyright (C) 2014 Freescale Semiconductor, Inc.
3  *
4  * Author: Jun Li
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 as
8  * published by the Free Software Foundation.
9  */
10 
11 #ifndef __DRIVERS_USB_CHIPIDEA_OTG_FSM_H
12 #define __DRIVERS_USB_CHIPIDEA_OTG_FSM_H
13 
14 #include <linux/usb/otg-fsm.h>
15 
16 /*
17  *  A-DEVICE timing  constants
18  */
19 
20 /* Wait for VBUS Rise  */
21 #define TA_WAIT_VRISE        (100)	/* a_wait_vrise: section 7.1.2
22 					 * a_wait_vrise_tmr: section 7.4.5.1
23 					 * TA_VBUS_RISE <= 100ms, section 4.4
24 					 * Table 4-1: Electrical Characteristics
25 					 * ->DC Electrical Timing
26 					 */
27 /* Wait for VBUS Fall  */
28 #define TA_WAIT_VFALL        (1000)	/* a_wait_vfall: section 7.1.7
29 					 * a_wait_vfall_tmr: section: 7.4.5.2
30 					 */
31 /* Wait for B-Connect */
32 #define TA_WAIT_BCON         (10000)	/* a_wait_bcon: section 7.1.3
33 					 * TA_WAIT_BCON: should be between 1100
34 					 * and 30000 ms, section 5.5, Table 5-1
35 					 */
36 /* A-Idle to B-Disconnect */
37 #define TA_AIDL_BDIS         (5000)	/* a_suspend min 200 ms, section 5.2.1
38 					 * TA_AIDL_BDIS: section 5.5, Table 5-1
39 					 */
40 /* B-Idle to A-Disconnect */
41 #define TA_BIDL_ADIS         (500)	/* TA_BIDL_ADIS: section 5.2.1
42 					 * 500ms is used for B switch to host
43 					 * for safe
44 					 */
45 
46 /*
47  * B-device timing constants
48  */
49 
50 /* Data-Line Pulse Time*/
51 #define TB_DATA_PLS          (10)	/* b_srp_init,continue 5~10ms
52 					 * section:5.1.3
53 					 */
54 /* SRP Fail Time  */
55 #define TB_SRP_FAIL          (6000)	/* b_srp_init,fail time 5~6s
56 					 * section:5.1.6
57 					 */
58 /* A-SE0 to B-Reset  */
59 #define TB_ASE0_BRST         (155)	/* minimum 155 ms, section:5.3.1 */
60 /* SE0 Time Before SRP */
61 #define TB_SE0_SRP           (1000)	/* b_idle,minimum 1s, section:5.1.2 */
62 /* SSEND time before SRP */
63 #define TB_SSEND_SRP         (1500)	/* minimum 1.5 sec, section:5.1.2 */
64 
65 #define TB_SESS_VLD          (1000)
66 
67 enum ci_otg_fsm_timer_index {
68 	/*
69 	 * CI specific timers, start from the end
70 	 * of standard and auxiliary OTG timers
71 	 */
72 	B_DATA_PLS = NUM_OTG_FSM_TIMERS,
73 	B_SSEND_SRP,
74 	B_SESS_VLD,
75 
76 	NUM_CI_OTG_FSM_TIMERS,
77 };
78 
79 struct ci_otg_fsm_timer {
80 	unsigned long expires;  /* Number of count increase to timeout */
81 	unsigned long count;    /* Tick counter */
82 	void (*function)(void *, unsigned long);        /* Timeout function */
83 	unsigned long data;     /* Data passed to function */
84 	struct list_head list;
85 };
86 
87 struct ci_otg_fsm_timer_list {
88 	struct ci_otg_fsm_timer *timer_list[NUM_CI_OTG_FSM_TIMERS];
89 	struct list_head active_timers;
90 };
91 
92 #ifdef CONFIG_USB_OTG_FSM
93 
94 int ci_hdrc_otg_fsm_init(struct ci_hdrc *ci);
95 int ci_otg_fsm_work(struct ci_hdrc *ci);
96 irqreturn_t ci_otg_fsm_irq(struct ci_hdrc *ci);
97 void ci_hdrc_otg_fsm_start(struct ci_hdrc *ci);
98 void ci_hdrc_otg_fsm_remove(struct ci_hdrc *ci);
99 
100 #else
101 
102 static inline int ci_hdrc_otg_fsm_init(struct ci_hdrc *ci)
103 {
104 	return 0;
105 }
106 
107 static inline int ci_otg_fsm_work(struct ci_hdrc *ci)
108 {
109 	return -ENXIO;
110 }
111 
112 static inline irqreturn_t ci_otg_fsm_irq(struct ci_hdrc *ci)
113 {
114 	return IRQ_NONE;
115 }
116 
117 static inline void ci_hdrc_otg_fsm_start(struct ci_hdrc *ci)
118 {
119 
120 }
121 
122 static inline void ci_hdrc_otg_fsm_remove(struct ci_hdrc *ci)
123 {
124 
125 }
126 
127 #endif
128 
129 #endif /* __DRIVERS_USB_CHIPIDEA_OTG_FSM_H */
130