xref: /linux/drivers/usb/renesas_usbhs/mod.h (revision cff4fa8415a3224a5abdd2b1dd7f431e4ea49366)
1 /*
2  * Renesas USB driver
3  *
4  * Copyright (C) 2011 Renesas Solutions Corp.
5  * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software
14  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
15  *
16  */
17 #ifndef RENESAS_USB_MOD_H
18 #define RENESAS_USB_MOD_H
19 
20 #include <linux/spinlock.h>
21 #include <linux/usb/renesas_usbhs.h>
22 #include "./common.h"
23 
24 /*
25  *	struct
26  */
27 struct usbhs_irq_state {
28 	u16 intsts0;
29 	u16 intsts1;
30 	u16 brdysts;
31 	u16 nrdysts;
32 	u16 bempsts;
33 	u16 dvstctr;
34 };
35 
36 struct usbhs_mod {
37 	char *name;
38 
39 	/*
40 	 * entry point from common.c
41 	 */
42 	int (*start)(struct usbhs_priv *priv);
43 	int (*stop)(struct usbhs_priv *priv);
44 
45 	/* INTSTS0 :: DVST (DVSQ) */
46 	int (*irq_dev_state)(struct usbhs_priv *priv,
47 			     struct usbhs_irq_state *irq_state);
48 
49 	/* INTSTS0 :: CTRT (CTSQ) */
50 	int (*irq_ctrl_stage)(struct usbhs_priv *priv,
51 			      struct usbhs_irq_state *irq_state);
52 
53 	/* INTSTS0 :: BEMP */
54 	/* BEMPSTS */
55 	int (*irq_empty)(struct usbhs_priv *priv,
56 			 struct usbhs_irq_state *irq_state);
57 	u16 irq_bempsts;
58 
59 	/* INTSTS0 :: BRDY */
60 	/* BRDYSTS */
61 	int (*irq_ready)(struct usbhs_priv *priv,
62 			 struct usbhs_irq_state *irq_state);
63 	u16 irq_brdysts;
64 
65 	struct usbhs_priv *priv;
66 };
67 
68 struct usbhs_mod_info {
69 	struct usbhs_mod *mod[USBHS_MAX];
70 	struct usbhs_mod *curt; /* current mod */
71 
72 	/*
73 	 * INTSTS0 :: VBINT
74 	 *
75 	 * This function will be used as autonomy mode
76 	 * when platform cannot call notify_hotplug.
77 	 *
78 	 * This callback cannot be member of "struct usbhs_mod"
79 	 * because it will be used even though
80 	 * host/gadget has not been selected.
81 	 */
82 	int (*irq_vbus)(struct usbhs_priv *priv,
83 			struct usbhs_irq_state *irq_state);
84 };
85 
86 /*
87  *		for host/gadget module
88  */
89 struct usbhs_mod *usbhs_mod_get(struct usbhs_priv *priv, int id);
90 struct usbhs_mod *usbhs_mod_get_current(struct usbhs_priv *priv);
91 void usbhs_mod_register(struct usbhs_priv *priv, struct usbhs_mod *usb, int id);
92 int usbhs_mod_is_host(struct usbhs_priv *priv, struct usbhs_mod *mod);
93 int usbhs_mod_change(struct usbhs_priv *priv, int id);
94 int usbhs_mod_probe(struct usbhs_priv *priv);
95 void usbhs_mod_remove(struct usbhs_priv *priv);
96 
97 void usbhs_mod_autonomy_mode(struct usbhs_priv *priv);
98 
99 /*
100  *		status functions
101  */
102 int usbhs_status_get_usb_speed(struct usbhs_irq_state *irq_state);
103 int usbhs_status_get_device_state(struct usbhs_irq_state *irq_state);
104 int usbhs_status_get_ctrl_stage(struct usbhs_irq_state *irq_state);
105 
106 /*
107  *		callback functions
108  */
109 void usbhs_irq_callback_update(struct usbhs_priv *priv, struct usbhs_mod *mod);
110 
111 
112 #define usbhs_mod_call(priv, func, param...)		\
113 	({						\
114 		struct usbhs_mod *mod;			\
115 		mod = usbhs_mod_get_current(priv);	\
116 		!mod		? -ENODEV :		\
117 		!mod->func	? 0 :			\
118 		 mod->func(param);			\
119 	})
120 
121 /*
122  * gadget control
123  */
124 #ifdef CONFIG_USB_RENESAS_USBHS_UDC
125 extern int __devinit usbhs_mod_gadget_probe(struct usbhs_priv *priv);
126 extern void __devexit usbhs_mod_gadget_remove(struct usbhs_priv *priv);
127 #else
128 static inline int usbhs_mod_gadget_probe(struct usbhs_priv *priv)
129 {
130 	return 0;
131 }
132 static inline void usbhs_mod_gadget_remove(struct usbhs_priv *priv)
133 {
134 }
135 #endif
136 
137 #endif /* RENESAS_USB_MOD_H */
138