blob: dc9490d1f42f7b4bf73f987c510407fa66bfd97e [file] [log] [blame]
Kuninori Morimotof1407d52011-04-04 13:44:59 +09001/*
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_DRIVER_H
18#define RENESAS_USB_DRIVER_H
19
20#include <linux/platform_device.h>
21#include <linux/usb/renesas_usbhs.h>
22
23struct usbhs_priv;
24
25#include "./mod.h"
26#include "./pipe.h"
27
28/*
29 *
30 * register define
31 *
32 */
33#define SYSCFG 0x0000
34#define BUSWAIT 0x0002
35#define DVSTCTR 0x0008
36#define CFIFO 0x0014
37#define CFIFOSEL 0x0020
38#define CFIFOCTR 0x0022
Kuninori Morimotoe73a9892011-06-06 14:19:03 +090039#define D0FIFO 0x0100
40#define D0FIFOSEL 0x0028
41#define D0FIFOCTR 0x002A
42#define D1FIFO 0x0120
43#define D1FIFOSEL 0x002C
44#define D1FIFOCTR 0x002E
Kuninori Morimotof1407d52011-04-04 13:44:59 +090045#define INTENB0 0x0030
46#define INTENB1 0x0032
47#define BRDYENB 0x0036
48#define NRDYENB 0x0038
49#define BEMPENB 0x003A
50#define INTSTS0 0x0040
51#define INTSTS1 0x0042
52#define BRDYSTS 0x0046
53#define NRDYSTS 0x0048
54#define BEMPSTS 0x004A
55#define FRMNUM 0x004C
56#define USBREQ 0x0054 /* USB request type register */
57#define USBVAL 0x0056 /* USB request value register */
58#define USBINDX 0x0058 /* USB request index register */
59#define USBLENG 0x005A /* USB request length register */
60#define DCPCFG 0x005C
61#define DCPMAXP 0x005E
62#define DCPCTR 0x0060
63#define PIPESEL 0x0064
64#define PIPECFG 0x0068
65#define PIPEBUF 0x006A
66#define PIPEMAXP 0x006C
67#define PIPEPERI 0x006E
68#define PIPEnCTR 0x0070
Kuninori Morimotoe73a9892011-06-06 14:19:03 +090069#define PIPE1TRE 0x0090
70#define PIPE1TRN 0x0092
71#define PIPE2TRE 0x0094
72#define PIPE2TRN 0x0096
73#define PIPE3TRE 0x0098
74#define PIPE3TRN 0x009A
75#define PIPE4TRE 0x009C
76#define PIPE4TRN 0x009E
77#define PIPE5TRE 0x00A0
78#define PIPE5TRN 0x00A2
79#define PIPEBTRE 0x00A4
80#define PIPEBTRN 0x00A6
81#define PIPECTRE 0x00A8
82#define PIPECTRN 0x00AA
83#define PIPEDTRE 0x00AC
84#define PIPEDTRN 0x00AE
85#define PIPEETRE 0x00B0
86#define PIPEETRN 0x00B2
87#define PIPEFTRE 0x00B4
88#define PIPEFTRN 0x00B6
89#define PIPE9TRE 0x00B8
90#define PIPE9TRN 0x00BA
91#define PIPEATRE 0x00BC
92#define PIPEATRN 0x00BE
Kuninori Morimotoeb051912011-10-10 22:06:46 -070093#define DEVADD0 0x00D0 /* Device address n configuration */
94#define DEVADD1 0x00D2
95#define DEVADD2 0x00D4
96#define DEVADD3 0x00D6
97#define DEVADD4 0x00D8
98#define DEVADD5 0x00DA
99#define DEVADD6 0x00DC
100#define DEVADD7 0x00DE
101#define DEVADD8 0x00E0
102#define DEVADD9 0x00E2
103#define DEVADDA 0x00E4
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900104
105/* SYSCFG */
106#define SCKE (1 << 10) /* USB Module Clock Enable */
107#define HSE (1 << 7) /* High-Speed Operation Enable */
108#define DCFM (1 << 6) /* Controller Function Select */
109#define DRPD (1 << 5) /* D+ Line/D- Line Resistance Control */
110#define DPRPU (1 << 4) /* D+ Line Resistance Control */
111#define USBE (1 << 0) /* USB Module Operation Enable */
112
113/* DVSTCTR */
114#define EXTLP (1 << 10) /* Controls the EXTLP pin output state */
115#define PWEN (1 << 9) /* Controls the PWEN pin output state */
Kuninori Morimoto258485d2011-10-10 22:01:40 -0700116#define USBRST (1 << 6) /* Bus Reset Output */
117#define UACT (1 << 4) /* USB Bus Enable */
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900118#define RHST (0x7) /* Reset Handshake */
119#define RHST_LOW_SPEED 1 /* Low-speed connection */
120#define RHST_FULL_SPEED 2 /* Full-speed connection */
121#define RHST_HIGH_SPEED 3 /* High-speed connection */
122
123/* CFIFOSEL */
Kuninori Morimotoe73a9892011-06-06 14:19:03 +0900124#define DREQE (1 << 12) /* DMA Transfer Request Enable */
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900125#define MBW_32 (0x2 << 10) /* CFIFO Port Access Bit Width */
126
127/* CFIFOCTR */
128#define BVAL (1 << 15) /* Buffer Memory Enable Flag */
129#define BCLR (1 << 14) /* CPU buffer clear */
130#define FRDY (1 << 13) /* FIFO Port Ready */
131#define DTLN_MASK (0x0FFF) /* Receive Data Length */
132
133/* INTENB0 */
134#define VBSE (1 << 15) /* Enable IRQ VBUS_0 and VBUSIN_0 */
135#define RSME (1 << 14) /* Enable IRQ Resume */
136#define SOFE (1 << 13) /* Enable IRQ Frame Number Update */
137#define DVSE (1 << 12) /* Enable IRQ Device State Transition */
138#define CTRE (1 << 11) /* Enable IRQ Control Stage Transition */
139#define BEMPE (1 << 10) /* Enable IRQ Buffer Empty */
140#define NRDYE (1 << 9) /* Enable IRQ Buffer Not Ready Response */
141#define BRDYE (1 << 8) /* Enable IRQ Buffer Ready */
142
143/* INTENB1 */
144#define BCHGE (1 << 14) /* USB Bus Change Interrupt Enable */
145#define DTCHE (1 << 12) /* Disconnection Detect Interrupt Enable */
146#define ATTCHE (1 << 11) /* Connection Detect Interrupt Enable */
147#define EOFERRE (1 << 6) /* EOF Error Detect Interrupt Enable */
148#define SIGNE (1 << 5) /* Setup Transaction Error Interrupt Enable */
149#define SACKE (1 << 4) /* Setup Transaction ACK Interrupt Enable */
150
151/* INTSTS0 */
Kuninori Morimotob002ff62011-04-28 16:41:20 +0900152#define VBINT (1 << 15) /* VBUS0_0 and VBUS1_0 Interrupt Status */
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900153#define DVST (1 << 12) /* Device State Transition Interrupt Status */
154#define CTRT (1 << 11) /* Control Stage Interrupt Status */
155#define BEMP (1 << 10) /* Buffer Empty Interrupt Status */
156#define BRDY (1 << 8) /* Buffer Ready Interrupt Status */
157#define VBSTS (1 << 7) /* VBUS_0 and VBUSIN_0 Input Status */
158#define VALID (1 << 3) /* USB Request Receive */
159
160#define DVSQ_MASK (0x3 << 4) /* Device State */
161#define POWER_STATE (0 << 4)
162#define DEFAULT_STATE (1 << 4)
163#define ADDRESS_STATE (2 << 4)
164#define CONFIGURATION_STATE (3 << 4)
165
166#define CTSQ_MASK (0x7) /* Control Transfer Stage */
167#define IDLE_SETUP_STAGE 0 /* Idle stage or setup stage */
168#define READ_DATA_STAGE 1 /* Control read data stage */
169#define READ_STATUS_STAGE 2 /* Control read status stage */
170#define WRITE_DATA_STAGE 3 /* Control write data stage */
171#define WRITE_STATUS_STAGE 4 /* Control write status stage */
172#define NODATA_STATUS_STAGE 5 /* Control write NoData status stage */
173#define SEQUENCE_ERROR 6 /* Control transfer sequence error */
174
Kuninori Morimoto89c1d2e2011-10-10 22:06:57 -0700175/* INTSTS1 */
176#define OVRCR (1 << 15) /* OVRCR Interrupt Status */
177#define BCHG (1 << 14) /* USB Bus Change Interrupt Status */
178#define DTCH (1 << 12) /* USB Disconnection Detect Interrupt Status */
179#define ATTCH (1 << 11) /* ATTCH Interrupt Status */
180#define EOFERR (1 << 6) /* EOF Error Detect Interrupt Status */
181#define SIGN (1 << 5) /* Setup Transaction Error Interrupt Status */
182#define SACK (1 << 4) /* Setup Transaction ACK Response Interrupt Status */
183
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900184/* PIPECFG */
185/* DCPCFG */
186#define TYPE_NONE (0 << 14) /* Transfer Type */
187#define TYPE_BULK (1 << 14)
188#define TYPE_INT (2 << 14)
189#define TYPE_ISO (3 << 14)
190#define DBLB (1 << 9) /* Double Buffer Mode */
191#define SHTNAK (1 << 7) /* Pipe Disable in Transfer End */
192#define DIR_OUT (1 << 4) /* Transfer Direction */
193
194/* PIPEMAXP */
195/* DCPMAXP */
196#define DEVSEL_MASK (0xF << 12) /* Device Select */
197#define DCP_MAXP_MASK (0x7F)
198#define PIPE_MAXP_MASK (0x7FF)
199
200/* PIPEBUF */
201#define BUFSIZE_SHIFT 10
202#define BUFSIZE_MASK (0x1F << BUFSIZE_SHIFT)
203#define BUFNMB_MASK (0xFF)
204
205/* PIPEnCTR */
206/* DCPCTR */
207#define BSTS (1 << 15) /* Buffer Status */
Kuninori Morimotoef8bedb2011-10-10 22:02:33 -0700208#define SUREQ (1 << 14) /* Sending SETUP Token */
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900209#define CSSTS (1 << 12) /* CSSTS Status */
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900210#define ACLRM (1 << 9) /* Buffer Auto-Clear Mode */
Kuninori Morimoto6e6db822011-10-10 22:05:30 -0700211#define SQCLR (1 << 8) /* Toggle Bit Clear */
212#define SQSET (1 << 7) /* Toggle Bit Set */
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900213#define PBUSY (1 << 5) /* Pipe Busy */
214#define PID_MASK (0x3) /* Response PID */
215#define PID_NAK 0
216#define PID_BUF 1
217#define PID_STALL10 2
218#define PID_STALL11 3
219
220#define CCPL (1 << 2) /* Control Transfer End Enable */
221
Kuninori Morimotoe73a9892011-06-06 14:19:03 +0900222/* PIPEnTRE */
223#define TRENB (1 << 9) /* Transaction Counter Enable */
224#define TRCLR (1 << 8) /* Transaction Counter Clear */
225
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900226/* FRMNUM */
227#define FRNM_MASK (0x7FF)
228
Kuninori Morimotoeb051912011-10-10 22:06:46 -0700229/* DEVADDn */
230#define UPPHUB(x) (((x) & 0xF) << 11) /* HUB Register */
231#define HUBPORT(x) (((x) & 0x7) << 8) /* HUB Port for Target Device */
232#define USBSPD(x) (((x) & 0x3) << 6) /* Device Transfer Rate */
233#define USBSPD_SPEED_LOW 0x1
234#define USBSPD_SPEED_FULL 0x2
235#define USBSPD_SPEED_HIGH 0x3
236
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900237/*
238 * struct
239 */
240struct usbhs_priv {
241
242 void __iomem *base;
243 unsigned int irq;
244
245 struct renesas_usbhs_platform_callback *pfunc;
246 struct renesas_usbhs_driver_param *dparam;
247
Kuninori Morimotobc573812011-04-28 16:41:14 +0900248 struct delayed_work notify_hotplug_work;
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900249 struct platform_device *pdev;
250
251 spinlock_t lock;
252
Kuninori Morimotob002ff62011-04-28 16:41:20 +0900253 u32 flags;
254
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900255 /*
256 * module control
257 */
258 struct usbhs_mod_info mod_info;
259
260 /*
261 * pipe control
262 */
263 struct usbhs_pipe_info pipe_info;
Kuninori Morimotod3af90a2011-06-06 14:18:44 +0900264
265 /*
266 * fifo control
267 */
268 struct usbhs_fifo_info fifo_info;
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900269};
270
271/*
272 * common
273 */
274u16 usbhs_read(struct usbhs_priv *priv, u32 reg);
275void usbhs_write(struct usbhs_priv *priv, u32 reg, u16 data);
276void usbhs_bset(struct usbhs_priv *priv, u32 reg, u16 mask, u16 data);
277
Kuninori Morimotobc573812011-04-28 16:41:14 +0900278int usbhsc_drvcllbck_notify_hotplug(struct platform_device *pdev);
Kuninori Morimoto97664a22011-06-06 14:18:38 +0900279
280#define usbhs_lock(p, f) spin_lock_irqsave(usbhs_priv_to_lock(p), f)
281#define usbhs_unlock(p, f) spin_unlock_irqrestore(usbhs_priv_to_lock(p), f)
282
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900283/*
284 * sysconfig
285 */
286void usbhs_sys_clock_ctrl(struct usbhs_priv *priv, int enable);
287void usbhs_sys_hispeed_ctrl(struct usbhs_priv *priv, int enable);
288void usbhs_sys_usb_ctrl(struct usbhs_priv *priv, int enable);
289void usbhs_sys_host_ctrl(struct usbhs_priv *priv, int enable);
290void usbhs_sys_function_ctrl(struct usbhs_priv *priv, int enable);
291
292/*
Kuninori Morimotoef8bedb2011-10-10 22:02:33 -0700293 * usb request
294 */
295void usbhs_usbreq_get_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req);
296void usbhs_usbreq_set_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req);
297
298/*
Kuninori Morimoto258485d2011-10-10 22:01:40 -0700299 * bus
300 */
301void usbhs_bus_send_sof_enable(struct usbhs_priv *priv);
302void usbhs_bus_send_reset(struct usbhs_priv *priv);
Kuninori Morimoto75587f52011-10-10 22:01:51 -0700303int usbhs_bus_get_speed(struct usbhs_priv *priv);
Kuninori Morimoto258485d2011-10-10 22:01:40 -0700304int usbhs_vbus_ctrl(struct usbhs_priv *priv, int enable);
305
306/*
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900307 * frame
308 */
309int usbhs_frame_get_num(struct usbhs_priv *priv);
310
311/*
Kuninori Morimotoeb051912011-10-10 22:06:46 -0700312 * device config
313 */
314int usbhs_set_device_speed(struct usbhs_priv *priv, int devnum, u16 upphub,
315 u16 hubport, u16 speed);
316
317/*
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900318 * data
319 */
Kuninori Morimoto206dcc22011-04-28 16:40:54 +0900320struct usbhs_priv *usbhs_pdev_to_priv(struct platform_device *pdev);
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900321#define usbhs_get_dparam(priv, param) (priv->dparam->param)
322#define usbhs_priv_to_pdev(priv) (priv->pdev)
323#define usbhs_priv_to_dev(priv) (&priv->pdev->dev)
324#define usbhs_priv_to_lock(priv) (&priv->lock)
325
326#endif /* RENESAS_USB_DRIVER_H */