1 /* Copyright (C) 2007,2008 Freescale Semiconductor, Inc.
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.
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.
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.
18 #ifndef __LINUX_USB_OTG_FSM_H
19 #define __LINUX_USB_OTG_FSM_H
21 #include <linux/mutex.h>
22 #include <linux/errno.h>
24 #define PROTO_UNDEF (0)
25 #define PROTO_HOST (1)
26 #define PROTO_GADGET (2)
28 #define OTG_STS_SELECTOR 0xF000 /* OTG status selector, according to
29 * OTG and EH 2.0 Chapter 6.2.3
33 #define HOST_REQUEST_FLAG 1 /* Host request flag, according to
34 * OTG and EH 2.0 Charpter 6.2.3
38 #define T_HOST_REQ_POLL (1500) /* 1500ms, HNP polling interval */
41 /* Standard OTG timers */
50 /* Auxiliary timers */
61 * struct otg_fsm - OTG state machine according to the OTG spec
65 * Common inputs for A and B device
66 * @id: TRUE for B-device, FALSE for A-device.
67 * @adp_change: TRUE when current ADP measurement (n) value, compared to the
68 * ADP measurement taken at n-2, differs by more than CADP_THR
69 * @power_up: TRUE when the OTG device first powers up its USB system and
70 * ADP measurement taken if ADP capable
72 * A-Device state inputs
73 * @a_srp_det: TRUE if the A-device detects SRP
74 * @a_vbus_vld: TRUE when VBUS voltage is in regulation
75 * @b_conn: TRUE if the A-device detects connection from the B-device
76 * @a_bus_resume: TRUE when the B-device detects that the A-device is signaling
78 * B-Device state inputs
79 * @a_bus_suspend: TRUE when the B-device detects that the A-device has put the
81 * @a_conn: TRUE if the B-device detects a connection from the A-device
82 * @b_se0_srp: TRUE when the line has been at SE0 for more than the minimum
83 * time before generating SRP
84 * @b_ssend_srp: TRUE when the VBUS has been below VOTG_SESS_VLD for more than
85 * the minimum time before generating SRP
86 * @b_sess_vld: TRUE when the B-device detects that the voltage on VBUS is
88 * @test_device: TRUE when the B-device switches to B-Host and detects an OTG
89 * test device. This must be set by host/hub driver
91 * Application inputs (A-Device)
92 * @a_bus_drop: TRUE when A-device application needs to power down the bus
93 * @a_bus_req: TRUE when A-device application wants to use the bus.
94 * FALSE to suspend the bus
96 * Application inputs (B-Device)
97 * @b_bus_req: TRUE during the time that the Application running on the
98 * B-device wants to use the bus
100 * Auxilary inputs (OTG v1.3 only. Obsolete now.)
101 * @a_sess_vld: TRUE if the A-device detects that VBUS is above VA_SESS_VLD
102 * @b_bus_suspend: TRUE when the A-device detects that the B-device has put
103 * the bus into suspend
104 * @b_bus_resume: TRUE when the A-device detects that the B-device is signaling
107 * OTG Output status. Read only for users. Updated by OTG FSM helpers defined
110 * Outputs for Both A and B device
111 * @drv_vbus: TRUE when A-device is driving VBUS
112 * @loc_conn: TRUE when the local device has signaled that it is connected
114 * @loc_sof: TRUE when the local device is generating activity on the bus
115 * @adp_prb: TRUE when the local device is in the process of doing
118 * Outputs for B-device state
119 * @adp_sns: TRUE when the B-device is in the process of carrying out
121 * @data_pulse: TRUE when the B-device is performing data line pulsing
125 * a_set_b_hnp_en: TRUE when the A-device has successfully set the
126 * b_hnp_enable bit in the B-device.
127 * Unused as OTG fsm uses otg->host->b_hnp_enable instead
128 * b_srp_done: TRUE when the B-device has completed initiating SRP
129 * b_hnp_enable: TRUE when the B-device has accepted the
130 * SetFeature(b_hnp_enable) B-device.
131 * Unused as OTG fsm uses otg->gadget->b_hnp_enable instead
132 * a_clr_err: Asserted (by application ?) to clear a_vbus_err due to an
133 * overcurrent condition and causes the A-device to transition
155 /* Auxilary inputs */
168 /* Internal variables */
174 /* Informative variables. All unused as of now */
179 /* Auxilary informative variables */
180 int a_suspend_req_inf;
182 /* Timeout indicator for timers */
183 int a_wait_vrise_tmout;
184 int a_wait_vfall_tmout;
185 int a_wait_bcon_tmout;
186 int a_aidl_bdis_tmout;
187 int b_ase0_brst_tmout;
188 int a_bidl_adis_tmout;
190 struct otg_fsm_ops *ops;
193 /* Current usb protocol used: 0:undefine; 1:host; 2:client */
197 struct delayed_work hnp_polling_work;
198 bool hnp_work_inited;
203 void (*chrg_vbus)(struct otg_fsm *fsm, int on);
204 void (*drv_vbus)(struct otg_fsm *fsm, int on);
205 void (*loc_conn)(struct otg_fsm *fsm, int on);
206 void (*loc_sof)(struct otg_fsm *fsm, int on);
207 void (*start_pulse)(struct otg_fsm *fsm);
208 void (*start_adp_prb)(struct otg_fsm *fsm);
209 void (*start_adp_sns)(struct otg_fsm *fsm);
210 void (*add_timer)(struct otg_fsm *fsm, enum otg_fsm_timer timer);
211 void (*del_timer)(struct otg_fsm *fsm, enum otg_fsm_timer timer);
212 int (*start_host)(struct otg_fsm *fsm, int on);
213 int (*start_gadget)(struct otg_fsm *fsm, int on);
217 static inline int otg_chrg_vbus(struct otg_fsm *fsm, int on)
219 if (!fsm->ops->chrg_vbus)
221 fsm->ops->chrg_vbus(fsm, on);
225 static inline int otg_drv_vbus(struct otg_fsm *fsm, int on)
227 if (!fsm->ops->drv_vbus)
229 if (fsm->drv_vbus != on) {
231 fsm->ops->drv_vbus(fsm, on);
236 static inline int otg_loc_conn(struct otg_fsm *fsm, int on)
238 if (!fsm->ops->loc_conn)
240 if (fsm->loc_conn != on) {
242 fsm->ops->loc_conn(fsm, on);
247 static inline int otg_loc_sof(struct otg_fsm *fsm, int on)
249 if (!fsm->ops->loc_sof)
251 if (fsm->loc_sof != on) {
253 fsm->ops->loc_sof(fsm, on);
258 static inline int otg_start_pulse(struct otg_fsm *fsm)
260 if (!fsm->ops->start_pulse)
262 if (!fsm->data_pulse) {
264 fsm->ops->start_pulse(fsm);
269 static inline int otg_start_adp_prb(struct otg_fsm *fsm)
271 if (!fsm->ops->start_adp_prb)
276 fsm->ops->start_adp_prb(fsm);
281 static inline int otg_start_adp_sns(struct otg_fsm *fsm)
283 if (!fsm->ops->start_adp_sns)
287 fsm->ops->start_adp_sns(fsm);
292 static inline int otg_add_timer(struct otg_fsm *fsm, enum otg_fsm_timer timer)
294 if (!fsm->ops->add_timer)
296 fsm->ops->add_timer(fsm, timer);
300 static inline int otg_del_timer(struct otg_fsm *fsm, enum otg_fsm_timer timer)
302 if (!fsm->ops->del_timer)
304 fsm->ops->del_timer(fsm, timer);
308 static inline int otg_start_host(struct otg_fsm *fsm, int on)
310 if (!fsm->ops->start_host)
312 return fsm->ops->start_host(fsm, on);
315 static inline int otg_start_gadget(struct otg_fsm *fsm, int on)
317 if (!fsm->ops->start_gadget)
319 return fsm->ops->start_gadget(fsm, on);
322 int otg_statemachine(struct otg_fsm *fsm);
324 #endif /* __LINUX_USB_OTG_FSM_H */