1 // SPDX-License-Identifier: GPL-2.0+ !! 1 /* Copyright (C) 2007,2008 Freescale Semiconductor, Inc.
2 /* !! 2 *
3 * Copyright (C) 2007,2008 Freescale Semicondu !! 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.
4 */ 16 */
5 17
6 #ifndef __LINUX_USB_OTG_FSM_H 18 #ifndef __LINUX_USB_OTG_FSM_H
7 #define __LINUX_USB_OTG_FSM_H 19 #define __LINUX_USB_OTG_FSM_H
8 20
9 #include <linux/mutex.h> 21 #include <linux/mutex.h>
10 #include <linux/errno.h> 22 #include <linux/errno.h>
11 23
12 #define PROTO_UNDEF (0) 24 #define PROTO_UNDEF (0)
13 #define PROTO_HOST (1) 25 #define PROTO_HOST (1)
14 #define PROTO_GADGET (2) 26 #define PROTO_GADGET (2)
15 27
16 #define OTG_STS_SELECTOR 0xF000 /* OTG 28 #define OTG_STS_SELECTOR 0xF000 /* OTG status selector, according to
17 * OTG 29 * OTG and EH 2.0 Chapter 6.2.3
18 * Tab 30 * Table:6-4
19 */ 31 */
20 32
21 #define HOST_REQUEST_FLAG 1 /* Hos 33 #define HOST_REQUEST_FLAG 1 /* Host request flag, according to
22 * OTG 34 * OTG and EH 2.0 Charpter 6.2.3
23 * Tab 35 * Table:6-5
24 */ 36 */
25 37
26 #define T_HOST_REQ_POLL (1500) /* 150 38 #define T_HOST_REQ_POLL (1500) /* 1500ms, HNP polling interval */
27 39
28 enum otg_fsm_timer { 40 enum otg_fsm_timer {
29 /* Standard OTG timers */ 41 /* Standard OTG timers */
30 A_WAIT_VRISE, 42 A_WAIT_VRISE,
31 A_WAIT_VFALL, 43 A_WAIT_VFALL,
32 A_WAIT_BCON, 44 A_WAIT_BCON,
33 A_AIDL_BDIS, 45 A_AIDL_BDIS,
34 B_ASE0_BRST, 46 B_ASE0_BRST,
35 A_BIDL_ADIS, 47 A_BIDL_ADIS,
36 B_AIDL_BDIS, 48 B_AIDL_BDIS,
37 49
38 /* Auxiliary timers */ 50 /* Auxiliary timers */
39 B_SE0_SRP, 51 B_SE0_SRP,
40 B_SRP_FAIL, 52 B_SRP_FAIL,
41 A_WAIT_ENUM, 53 A_WAIT_ENUM,
42 B_DATA_PLS, 54 B_DATA_PLS,
43 B_SSEND_SRP, 55 B_SSEND_SRP,
44 56
45 NUM_OTG_FSM_TIMERS, 57 NUM_OTG_FSM_TIMERS,
46 }; 58 };
47 59
48 /** 60 /**
49 * struct otg_fsm - OTG state machine accordin 61 * struct otg_fsm - OTG state machine according to the OTG spec
50 * 62 *
51 * OTG hardware Inputs 63 * OTG hardware Inputs
52 * 64 *
53 * Common inputs for A and B device 65 * Common inputs for A and B device
54 * @id: TRUE for B-device, FALSE for A 66 * @id: TRUE for B-device, FALSE for A-device.
55 * @adp_change: TRUE when current ADP measurem 67 * @adp_change: TRUE when current ADP measurement (n) value, compared to the
56 * ADP measurement taken at n-2, 68 * ADP measurement taken at n-2, differs by more than CADP_THR
57 * @power_up: TRUE when the OTG device first 69 * @power_up: TRUE when the OTG device first powers up its USB system and
58 * ADP measurement taken if ADP c 70 * ADP measurement taken if ADP capable
59 * 71 *
60 * A-Device state inputs 72 * A-Device state inputs
61 * @a_srp_det: TRUE if the A-device detects S 73 * @a_srp_det: TRUE if the A-device detects SRP
62 * @a_vbus_vld: TRUE when VBUS voltage is in r 74 * @a_vbus_vld: TRUE when VBUS voltage is in regulation
63 * @b_conn: TRUE if the A-device detects c 75 * @b_conn: TRUE if the A-device detects connection from the B-device
64 * @a_bus_resume: TRUE when the B-device detec 76 * @a_bus_resume: TRUE when the B-device detects that the A-device is signaling
65 * a resume (K state) 77 * a resume (K state)
66 * B-Device state inputs 78 * B-Device state inputs
67 * @a_bus_suspend: TRUE when the B-device dete 79 * @a_bus_suspend: TRUE when the B-device detects that the A-device has put the
68 * bus into suspend 80 * bus into suspend
69 * @a_conn: TRUE if the B-device detects a 81 * @a_conn: TRUE if the B-device detects a connection from the A-device
70 * @b_se0_srp: TRUE when the line has been at 82 * @b_se0_srp: TRUE when the line has been at SE0 for more than the minimum
71 * time before generating SRP 83 * time before generating SRP
72 * @b_ssend_srp: TRUE when the VBUS has been b 84 * @b_ssend_srp: TRUE when the VBUS has been below VOTG_SESS_VLD for more than
73 * the minimum time before gener 85 * the minimum time before generating SRP
74 * @b_sess_vld: TRUE when the B-device detects 86 * @b_sess_vld: TRUE when the B-device detects that the voltage on VBUS is
75 * above VOTG_SESS_VLD 87 * above VOTG_SESS_VLD
76 * @test_device: TRUE when the B-device switch 88 * @test_device: TRUE when the B-device switches to B-Host and detects an OTG
77 * test device. This must be set 89 * test device. This must be set by host/hub driver
78 * 90 *
79 * Application inputs (A-Device) 91 * Application inputs (A-Device)
80 * @a_bus_drop: TRUE when A-device application 92 * @a_bus_drop: TRUE when A-device application needs to power down the bus
81 * @a_bus_req: TRUE when A-device application 93 * @a_bus_req: TRUE when A-device application wants to use the bus.
82 * FALSE to suspend the bus 94 * FALSE to suspend the bus
83 * 95 *
84 * Application inputs (B-Device) 96 * Application inputs (B-Device)
85 * @b_bus_req: TRUE during the time that the 97 * @b_bus_req: TRUE during the time that the Application running on the
86 * B-device wants to use the bus 98 * B-device wants to use the bus
87 * 99 *
88 * Auxiliary inputs (OTG v1.3 only. Obsol !! 100 * Auxilary inputs (OTG v1.3 only. Obsolete now.)
89 * @a_sess_vld: TRUE if the A-device detects t 101 * @a_sess_vld: TRUE if the A-device detects that VBUS is above VA_SESS_VLD
90 * @b_bus_suspend: TRUE when the A-device dete 102 * @b_bus_suspend: TRUE when the A-device detects that the B-device has put
91 * the bus into suspend 103 * the bus into suspend
92 * @b_bus_resume: TRUE when the A-device detec 104 * @b_bus_resume: TRUE when the A-device detects that the B-device is signaling
93 * resume on the bus 105 * resume on the bus
94 * 106 *
95 * OTG Output status. Read only for users. Upd 107 * OTG Output status. Read only for users. Updated by OTG FSM helpers defined
96 * in this file 108 * in this file
97 * 109 *
98 * Outputs for Both A and B device 110 * Outputs for Both A and B device
99 * @drv_vbus: TRUE when A-device is driving 111 * @drv_vbus: TRUE when A-device is driving VBUS
100 * @loc_conn: TRUE when the local device has 112 * @loc_conn: TRUE when the local device has signaled that it is connected
101 * to the bus 113 * to the bus
102 * @loc_sof: TRUE when the local device is 114 * @loc_sof: TRUE when the local device is generating activity on the bus
103 * @adp_prb: TRUE when the local device is 115 * @adp_prb: TRUE when the local device is in the process of doing
104 * ADP probing 116 * ADP probing
105 * 117 *
106 * Outputs for B-device state 118 * Outputs for B-device state
107 * @adp_sns: TRUE when the B-device is in t 119 * @adp_sns: TRUE when the B-device is in the process of carrying out
108 * ADP sensing 120 * ADP sensing
109 * @data_pulse: TRUE when the B-device is perf 121 * @data_pulse: TRUE when the B-device is performing data line pulsing
110 * 122 *
111 * Internal Variables 123 * Internal Variables
112 * 124 *
113 * a_set_b_hnp_en: TRUE when the A-device has 125 * a_set_b_hnp_en: TRUE when the A-device has successfully set the
114 * b_hnp_enable bit in the B-devi 126 * b_hnp_enable bit in the B-device.
115 * Unused as OTG fsm uses otg- 127 * Unused as OTG fsm uses otg->host->b_hnp_enable instead
116 * b_srp_done: TRUE when the B-device has com 128 * b_srp_done: TRUE when the B-device has completed initiating SRP
117 * b_hnp_enable: TRUE when the B-device has ac 129 * b_hnp_enable: TRUE when the B-device has accepted the
118 * SetFeature(b_hnp_enable) B-dev 130 * SetFeature(b_hnp_enable) B-device.
119 * Unused as OTG fsm uses otg->ga 131 * Unused as OTG fsm uses otg->gadget->b_hnp_enable instead
120 * a_clr_err: Asserted (by application ?) to 132 * a_clr_err: Asserted (by application ?) to clear a_vbus_err due to an
121 * overcurrent condition and caus 133 * overcurrent condition and causes the A-device to transition
122 * to a_wait_vfall 134 * to a_wait_vfall
123 */ 135 */
124 struct otg_fsm { 136 struct otg_fsm {
125 /* Input */ 137 /* Input */
126 int id; 138 int id;
127 int adp_change; 139 int adp_change;
128 int power_up; 140 int power_up;
129 int a_srp_det; 141 int a_srp_det;
130 int a_vbus_vld; 142 int a_vbus_vld;
131 int b_conn; 143 int b_conn;
132 int a_bus_resume; 144 int a_bus_resume;
133 int a_bus_suspend; 145 int a_bus_suspend;
134 int a_conn; 146 int a_conn;
135 int b_se0_srp; 147 int b_se0_srp;
136 int b_ssend_srp; 148 int b_ssend_srp;
137 int b_sess_vld; 149 int b_sess_vld;
138 int test_device; 150 int test_device;
139 int a_bus_drop; 151 int a_bus_drop;
140 int a_bus_req; 152 int a_bus_req;
141 int b_bus_req; 153 int b_bus_req;
142 154
143 /* Auxiliary inputs */ !! 155 /* Auxilary inputs */
144 int a_sess_vld; 156 int a_sess_vld;
145 int b_bus_resume; 157 int b_bus_resume;
146 int b_bus_suspend; 158 int b_bus_suspend;
147 159
148 /* Output */ 160 /* Output */
149 int drv_vbus; 161 int drv_vbus;
150 int loc_conn; 162 int loc_conn;
151 int loc_sof; 163 int loc_sof;
152 int adp_prb; 164 int adp_prb;
153 int adp_sns; 165 int adp_sns;
154 int data_pulse; 166 int data_pulse;
155 167
156 /* Internal variables */ 168 /* Internal variables */
157 int a_set_b_hnp_en; 169 int a_set_b_hnp_en;
158 int b_srp_done; 170 int b_srp_done;
159 int b_hnp_enable; 171 int b_hnp_enable;
160 int a_clr_err; 172 int a_clr_err;
161 173
162 /* Informative variables. All unused a 174 /* Informative variables. All unused as of now */
163 int a_bus_drop_inf; 175 int a_bus_drop_inf;
164 int a_bus_req_inf; 176 int a_bus_req_inf;
165 int a_clr_err_inf; 177 int a_clr_err_inf;
166 int b_bus_req_inf; 178 int b_bus_req_inf;
167 /* Auxiliary informative variables */ !! 179 /* Auxilary informative variables */
168 int a_suspend_req_inf; 180 int a_suspend_req_inf;
169 181
170 /* Timeout indicator for timers */ 182 /* Timeout indicator for timers */
171 int a_wait_vrise_tmout; 183 int a_wait_vrise_tmout;
172 int a_wait_vfall_tmout; 184 int a_wait_vfall_tmout;
173 int a_wait_bcon_tmout; 185 int a_wait_bcon_tmout;
174 int a_aidl_bdis_tmout; 186 int a_aidl_bdis_tmout;
175 int b_ase0_brst_tmout; 187 int b_ase0_brst_tmout;
176 int a_bidl_adis_tmout; 188 int a_bidl_adis_tmout;
177 189
178 struct otg_fsm_ops *ops; 190 struct otg_fsm_ops *ops;
179 struct usb_otg *otg; 191 struct usb_otg *otg;
180 192
181 /* Current usb protocol used: 0:undefi 193 /* Current usb protocol used: 0:undefine; 1:host; 2:client */
182 int protocol; 194 int protocol;
183 struct mutex lock; 195 struct mutex lock;
184 u8 *host_req_flag; 196 u8 *host_req_flag;
185 struct delayed_work hnp_polling_work; 197 struct delayed_work hnp_polling_work;
186 bool hnp_work_inited; 198 bool hnp_work_inited;
187 bool state_changed; 199 bool state_changed;
188 }; 200 };
189 201
190 struct otg_fsm_ops { 202 struct otg_fsm_ops {
191 void (*chrg_vbus)(struct otg_fsm *f 203 void (*chrg_vbus)(struct otg_fsm *fsm, int on);
192 void (*drv_vbus)(struct otg_fsm *fs 204 void (*drv_vbus)(struct otg_fsm *fsm, int on);
193 void (*loc_conn)(struct otg_fsm *fs 205 void (*loc_conn)(struct otg_fsm *fsm, int on);
194 void (*loc_sof)(struct otg_fsm *fsm 206 void (*loc_sof)(struct otg_fsm *fsm, int on);
195 void (*start_pulse)(struct otg_fsm 207 void (*start_pulse)(struct otg_fsm *fsm);
196 void (*start_adp_prb)(struct otg_fs 208 void (*start_adp_prb)(struct otg_fsm *fsm);
197 void (*start_adp_sns)(struct otg_fs 209 void (*start_adp_sns)(struct otg_fsm *fsm);
198 void (*add_timer)(struct otg_fsm *f 210 void (*add_timer)(struct otg_fsm *fsm, enum otg_fsm_timer timer);
199 void (*del_timer)(struct otg_fsm *f 211 void (*del_timer)(struct otg_fsm *fsm, enum otg_fsm_timer timer);
200 int (*start_host)(struct otg_fsm * 212 int (*start_host)(struct otg_fsm *fsm, int on);
201 int (*start_gadget)(struct otg_fsm 213 int (*start_gadget)(struct otg_fsm *fsm, int on);
202 }; 214 };
203 215
204 216
205 static inline int otg_chrg_vbus(struct otg_fsm 217 static inline int otg_chrg_vbus(struct otg_fsm *fsm, int on)
206 { 218 {
207 if (!fsm->ops->chrg_vbus) 219 if (!fsm->ops->chrg_vbus)
208 return -EOPNOTSUPP; 220 return -EOPNOTSUPP;
209 fsm->ops->chrg_vbus(fsm, on); 221 fsm->ops->chrg_vbus(fsm, on);
210 return 0; 222 return 0;
211 } 223 }
212 224
213 static inline int otg_drv_vbus(struct otg_fsm 225 static inline int otg_drv_vbus(struct otg_fsm *fsm, int on)
214 { 226 {
215 if (!fsm->ops->drv_vbus) 227 if (!fsm->ops->drv_vbus)
216 return -EOPNOTSUPP; 228 return -EOPNOTSUPP;
217 if (fsm->drv_vbus != on) { 229 if (fsm->drv_vbus != on) {
218 fsm->drv_vbus = on; 230 fsm->drv_vbus = on;
219 fsm->ops->drv_vbus(fsm, on); 231 fsm->ops->drv_vbus(fsm, on);
220 } 232 }
221 return 0; 233 return 0;
222 } 234 }
223 235
224 static inline int otg_loc_conn(struct otg_fsm 236 static inline int otg_loc_conn(struct otg_fsm *fsm, int on)
225 { 237 {
226 if (!fsm->ops->loc_conn) 238 if (!fsm->ops->loc_conn)
227 return -EOPNOTSUPP; 239 return -EOPNOTSUPP;
228 if (fsm->loc_conn != on) { 240 if (fsm->loc_conn != on) {
229 fsm->loc_conn = on; 241 fsm->loc_conn = on;
230 fsm->ops->loc_conn(fsm, on); 242 fsm->ops->loc_conn(fsm, on);
231 } 243 }
232 return 0; 244 return 0;
233 } 245 }
234 246
235 static inline int otg_loc_sof(struct otg_fsm * 247 static inline int otg_loc_sof(struct otg_fsm *fsm, int on)
236 { 248 {
237 if (!fsm->ops->loc_sof) 249 if (!fsm->ops->loc_sof)
238 return -EOPNOTSUPP; 250 return -EOPNOTSUPP;
239 if (fsm->loc_sof != on) { 251 if (fsm->loc_sof != on) {
240 fsm->loc_sof = on; 252 fsm->loc_sof = on;
241 fsm->ops->loc_sof(fsm, on); 253 fsm->ops->loc_sof(fsm, on);
242 } 254 }
243 return 0; 255 return 0;
244 } 256 }
245 257
246 static inline int otg_start_pulse(struct otg_f 258 static inline int otg_start_pulse(struct otg_fsm *fsm)
247 { 259 {
248 if (!fsm->ops->start_pulse) 260 if (!fsm->ops->start_pulse)
249 return -EOPNOTSUPP; 261 return -EOPNOTSUPP;
250 if (!fsm->data_pulse) { 262 if (!fsm->data_pulse) {
251 fsm->data_pulse = 1; 263 fsm->data_pulse = 1;
252 fsm->ops->start_pulse(fsm); 264 fsm->ops->start_pulse(fsm);
253 } 265 }
254 return 0; 266 return 0;
255 } 267 }
256 268
257 static inline int otg_start_adp_prb(struct otg 269 static inline int otg_start_adp_prb(struct otg_fsm *fsm)
258 { 270 {
259 if (!fsm->ops->start_adp_prb) 271 if (!fsm->ops->start_adp_prb)
260 return -EOPNOTSUPP; 272 return -EOPNOTSUPP;
261 if (!fsm->adp_prb) { 273 if (!fsm->adp_prb) {
262 fsm->adp_sns = 0; 274 fsm->adp_sns = 0;
263 fsm->adp_prb = 1; 275 fsm->adp_prb = 1;
264 fsm->ops->start_adp_prb(fsm); 276 fsm->ops->start_adp_prb(fsm);
265 } 277 }
266 return 0; 278 return 0;
267 } 279 }
268 280
269 static inline int otg_start_adp_sns(struct otg 281 static inline int otg_start_adp_sns(struct otg_fsm *fsm)
270 { 282 {
271 if (!fsm->ops->start_adp_sns) 283 if (!fsm->ops->start_adp_sns)
272 return -EOPNOTSUPP; 284 return -EOPNOTSUPP;
273 if (!fsm->adp_sns) { 285 if (!fsm->adp_sns) {
274 fsm->adp_sns = 1; 286 fsm->adp_sns = 1;
275 fsm->ops->start_adp_sns(fsm); 287 fsm->ops->start_adp_sns(fsm);
276 } 288 }
277 return 0; 289 return 0;
278 } 290 }
279 291
280 static inline int otg_add_timer(struct otg_fsm 292 static inline int otg_add_timer(struct otg_fsm *fsm, enum otg_fsm_timer timer)
281 { 293 {
282 if (!fsm->ops->add_timer) 294 if (!fsm->ops->add_timer)
283 return -EOPNOTSUPP; 295 return -EOPNOTSUPP;
284 fsm->ops->add_timer(fsm, timer); 296 fsm->ops->add_timer(fsm, timer);
285 return 0; 297 return 0;
286 } 298 }
287 299
288 static inline int otg_del_timer(struct otg_fsm 300 static inline int otg_del_timer(struct otg_fsm *fsm, enum otg_fsm_timer timer)
289 { 301 {
290 if (!fsm->ops->del_timer) 302 if (!fsm->ops->del_timer)
291 return -EOPNOTSUPP; 303 return -EOPNOTSUPP;
292 fsm->ops->del_timer(fsm, timer); 304 fsm->ops->del_timer(fsm, timer);
293 return 0; 305 return 0;
294 } 306 }
295 307
296 static inline int otg_start_host(struct otg_fs 308 static inline int otg_start_host(struct otg_fsm *fsm, int on)
297 { 309 {
298 if (!fsm->ops->start_host) 310 if (!fsm->ops->start_host)
299 return -EOPNOTSUPP; 311 return -EOPNOTSUPP;
300 return fsm->ops->start_host(fsm, on); 312 return fsm->ops->start_host(fsm, on);
301 } 313 }
302 314
303 static inline int otg_start_gadget(struct otg_ 315 static inline int otg_start_gadget(struct otg_fsm *fsm, int on)
304 { 316 {
305 if (!fsm->ops->start_gadget) 317 if (!fsm->ops->start_gadget)
306 return -EOPNOTSUPP; 318 return -EOPNOTSUPP;
307 return fsm->ops->start_gadget(fsm, on) 319 return fsm->ops->start_gadget(fsm, on);
308 } 320 }
309 321
310 int otg_statemachine(struct otg_fsm *fsm); 322 int otg_statemachine(struct otg_fsm *fsm);
311 323
312 #endif /* __LINUX_USB_OTG_FSM_H */ 324 #endif /* __LINUX_USB_OTG_FSM_H */
313 325
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.