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