blob: 8c5fc12ad7781f7a83ef9ec142107fd542b1e0f8 [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
Sergei Shtylyovd7b39682014-12-16 01:42:13 +030020#include <linux/extcon.h>
Kuninori Morimotof1407d52011-04-04 13:44:59 +090021#include <linux/platform_device.h>
22#include <linux/usb/renesas_usbhs.h>
23
24struct usbhs_priv;
25
Paul Bollecc502bb2012-06-03 18:39:13 +020026#include "mod.h"
27#include "pipe.h"
Kuninori Morimotof1407d52011-04-04 13:44:59 +090028
29/*
30 *
31 * register define
32 *
33 */
34#define SYSCFG 0x0000
35#define BUSWAIT 0x0002
36#define DVSTCTR 0x0008
Kuninori Morimotodfbb7f42011-11-24 17:28:35 -080037#define TESTMODE 0x000C
Kuninori Morimotof1407d52011-04-04 13:44:59 +090038#define CFIFO 0x0014
39#define CFIFOSEL 0x0020
40#define CFIFOCTR 0x0022
Kuninori Morimotoe73a9892011-06-06 14:19:03 +090041#define D0FIFO 0x0100
42#define D0FIFOSEL 0x0028
43#define D0FIFOCTR 0x002A
44#define D1FIFO 0x0120
45#define D1FIFOSEL 0x002C
46#define D1FIFOCTR 0x002E
Kuninori Morimotof1407d52011-04-04 13:44:59 +090047#define INTENB0 0x0030
48#define INTENB1 0x0032
49#define BRDYENB 0x0036
50#define NRDYENB 0x0038
51#define BEMPENB 0x003A
52#define INTSTS0 0x0040
53#define INTSTS1 0x0042
54#define BRDYSTS 0x0046
55#define NRDYSTS 0x0048
56#define BEMPSTS 0x004A
57#define FRMNUM 0x004C
58#define USBREQ 0x0054 /* USB request type register */
59#define USBVAL 0x0056 /* USB request value register */
60#define USBINDX 0x0058 /* USB request index register */
61#define USBLENG 0x005A /* USB request length register */
62#define DCPCFG 0x005C
63#define DCPMAXP 0x005E
64#define DCPCTR 0x0060
65#define PIPESEL 0x0064
66#define PIPECFG 0x0068
67#define PIPEBUF 0x006A
68#define PIPEMAXP 0x006C
69#define PIPEPERI 0x006E
70#define PIPEnCTR 0x0070
Kuninori Morimotoe73a9892011-06-06 14:19:03 +090071#define PIPE1TRE 0x0090
72#define PIPE1TRN 0x0092
73#define PIPE2TRE 0x0094
74#define PIPE2TRN 0x0096
75#define PIPE3TRE 0x0098
76#define PIPE3TRN 0x009A
77#define PIPE4TRE 0x009C
78#define PIPE4TRN 0x009E
79#define PIPE5TRE 0x00A0
80#define PIPE5TRN 0x00A2
81#define PIPEBTRE 0x00A4
82#define PIPEBTRN 0x00A6
83#define PIPECTRE 0x00A8
84#define PIPECTRN 0x00AA
85#define PIPEDTRE 0x00AC
86#define PIPEDTRN 0x00AE
87#define PIPEETRE 0x00B0
88#define PIPEETRN 0x00B2
89#define PIPEFTRE 0x00B4
90#define PIPEFTRN 0x00B6
91#define PIPE9TRE 0x00B8
92#define PIPE9TRN 0x00BA
93#define PIPEATRE 0x00BC
94#define PIPEATRN 0x00BE
Kuninori Morimotoeb051912011-10-10 22:06:46 -070095#define DEVADD0 0x00D0 /* Device address n configuration */
96#define DEVADD1 0x00D2
97#define DEVADD2 0x00D4
98#define DEVADD3 0x00D6
99#define DEVADD4 0x00D8
100#define DEVADD5 0x00DA
101#define DEVADD6 0x00DC
102#define DEVADD7 0x00DE
103#define DEVADD8 0x00E0
104#define DEVADD9 0x00E2
105#define DEVADDA 0x00E4
Yoshihiro Shimodad3cf6a42014-11-10 20:02:47 +0900106#define D2FIFOSEL 0x00F0 /* for R-Car Gen2 */
107#define D2FIFOCTR 0x00F2 /* for R-Car Gen2 */
108#define D3FIFOSEL 0x00F4 /* for R-Car Gen2 */
109#define D3FIFOCTR 0x00F6 /* for R-Car Gen2 */
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900110
111/* SYSCFG */
112#define SCKE (1 << 10) /* USB Module Clock Enable */
113#define HSE (1 << 7) /* High-Speed Operation Enable */
114#define DCFM (1 << 6) /* Controller Function Select */
115#define DRPD (1 << 5) /* D+ Line/D- Line Resistance Control */
116#define DPRPU (1 << 4) /* D+ Line Resistance Control */
117#define USBE (1 << 0) /* USB Module Operation Enable */
118
119/* DVSTCTR */
120#define EXTLP (1 << 10) /* Controls the EXTLP pin output state */
121#define PWEN (1 << 9) /* Controls the PWEN pin output state */
Kuninori Morimoto258485d2011-10-10 22:01:40 -0700122#define USBRST (1 << 6) /* Bus Reset Output */
123#define UACT (1 << 4) /* USB Bus Enable */
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900124#define RHST (0x7) /* Reset Handshake */
125#define RHST_LOW_SPEED 1 /* Low-speed connection */
126#define RHST_FULL_SPEED 2 /* Full-speed connection */
127#define RHST_HIGH_SPEED 3 /* High-speed connection */
128
129/* CFIFOSEL */
Kuninori Morimotoe73a9892011-06-06 14:19:03 +0900130#define DREQE (1 << 12) /* DMA Transfer Request Enable */
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900131#define MBW_32 (0x2 << 10) /* CFIFO Port Access Bit Width */
132
133/* CFIFOCTR */
134#define BVAL (1 << 15) /* Buffer Memory Enable Flag */
135#define BCLR (1 << 14) /* CPU buffer clear */
136#define FRDY (1 << 13) /* FIFO Port Ready */
137#define DTLN_MASK (0x0FFF) /* Receive Data Length */
138
139/* INTENB0 */
140#define VBSE (1 << 15) /* Enable IRQ VBUS_0 and VBUSIN_0 */
141#define RSME (1 << 14) /* Enable IRQ Resume */
142#define SOFE (1 << 13) /* Enable IRQ Frame Number Update */
143#define DVSE (1 << 12) /* Enable IRQ Device State Transition */
144#define CTRE (1 << 11) /* Enable IRQ Control Stage Transition */
145#define BEMPE (1 << 10) /* Enable IRQ Buffer Empty */
146#define NRDYE (1 << 9) /* Enable IRQ Buffer Not Ready Response */
147#define BRDYE (1 << 8) /* Enable IRQ Buffer Ready */
148
149/* INTENB1 */
150#define BCHGE (1 << 14) /* USB Bus Change Interrupt Enable */
151#define DTCHE (1 << 12) /* Disconnection Detect Interrupt Enable */
152#define ATTCHE (1 << 11) /* Connection Detect Interrupt Enable */
153#define EOFERRE (1 << 6) /* EOF Error Detect Interrupt Enable */
154#define SIGNE (1 << 5) /* Setup Transaction Error Interrupt Enable */
155#define SACKE (1 << 4) /* Setup Transaction ACK Interrupt Enable */
156
157/* INTSTS0 */
Kuninori Morimotob002ff62011-04-28 16:41:20 +0900158#define VBINT (1 << 15) /* VBUS0_0 and VBUS1_0 Interrupt Status */
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900159#define DVST (1 << 12) /* Device State Transition Interrupt Status */
160#define CTRT (1 << 11) /* Control Stage Interrupt Status */
161#define BEMP (1 << 10) /* Buffer Empty Interrupt Status */
162#define BRDY (1 << 8) /* Buffer Ready Interrupt Status */
163#define VBSTS (1 << 7) /* VBUS_0 and VBUSIN_0 Input Status */
164#define VALID (1 << 3) /* USB Request Receive */
165
166#define DVSQ_MASK (0x3 << 4) /* Device State */
167#define POWER_STATE (0 << 4)
168#define DEFAULT_STATE (1 << 4)
169#define ADDRESS_STATE (2 << 4)
170#define CONFIGURATION_STATE (3 << 4)
171
172#define CTSQ_MASK (0x7) /* Control Transfer Stage */
173#define IDLE_SETUP_STAGE 0 /* Idle stage or setup stage */
174#define READ_DATA_STAGE 1 /* Control read data stage */
175#define READ_STATUS_STAGE 2 /* Control read status stage */
176#define WRITE_DATA_STAGE 3 /* Control write data stage */
177#define WRITE_STATUS_STAGE 4 /* Control write status stage */
178#define NODATA_STATUS_STAGE 5 /* Control write NoData status stage */
179#define SEQUENCE_ERROR 6 /* Control transfer sequence error */
180
Kuninori Morimoto89c1d2e2011-10-10 22:06:57 -0700181/* INTSTS1 */
182#define OVRCR (1 << 15) /* OVRCR Interrupt Status */
183#define BCHG (1 << 14) /* USB Bus Change Interrupt Status */
184#define DTCH (1 << 12) /* USB Disconnection Detect Interrupt Status */
185#define ATTCH (1 << 11) /* ATTCH Interrupt Status */
186#define EOFERR (1 << 6) /* EOF Error Detect Interrupt Status */
187#define SIGN (1 << 5) /* Setup Transaction Error Interrupt Status */
188#define SACK (1 << 4) /* Setup Transaction ACK Response Interrupt Status */
189
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900190/* PIPECFG */
191/* DCPCFG */
192#define TYPE_NONE (0 << 14) /* Transfer Type */
193#define TYPE_BULK (1 << 14)
194#define TYPE_INT (2 << 14)
195#define TYPE_ISO (3 << 14)
Yoshihiro Shimodaab330cf2015-03-12 15:35:20 +0900196#define BFRE (1 << 10) /* BRDY Interrupt Operation Spec. */
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900197#define DBLB (1 << 9) /* Double Buffer Mode */
198#define SHTNAK (1 << 7) /* Pipe Disable in Transfer End */
199#define DIR_OUT (1 << 4) /* Transfer Direction */
200
201/* PIPEMAXP */
202/* DCPMAXP */
203#define DEVSEL_MASK (0xF << 12) /* Device Select */
204#define DCP_MAXP_MASK (0x7F)
205#define PIPE_MAXP_MASK (0x7FF)
206
207/* PIPEBUF */
208#define BUFSIZE_SHIFT 10
209#define BUFSIZE_MASK (0x1F << BUFSIZE_SHIFT)
210#define BUFNMB_MASK (0xFF)
211
212/* PIPEnCTR */
213/* DCPCTR */
214#define BSTS (1 << 15) /* Buffer Status */
Kuninori Morimotoef8bedb2011-10-10 22:02:33 -0700215#define SUREQ (1 << 14) /* Sending SETUP Token */
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900216#define CSSTS (1 << 12) /* CSSTS Status */
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900217#define ACLRM (1 << 9) /* Buffer Auto-Clear Mode */
Kuninori Morimoto6e6db822011-10-10 22:05:30 -0700218#define SQCLR (1 << 8) /* Toggle Bit Clear */
219#define SQSET (1 << 7) /* Toggle Bit Set */
Yoshihiro Shimodaab330cf2015-03-12 15:35:20 +0900220#define SQMON (1 << 6) /* Toggle Bit Check */
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900221#define PBUSY (1 << 5) /* Pipe Busy */
222#define PID_MASK (0x3) /* Response PID */
223#define PID_NAK 0
224#define PID_BUF 1
225#define PID_STALL10 2
226#define PID_STALL11 3
227
228#define CCPL (1 << 2) /* Control Transfer End Enable */
229
Kuninori Morimotoe73a9892011-06-06 14:19:03 +0900230/* PIPEnTRE */
231#define TRENB (1 << 9) /* Transaction Counter Enable */
232#define TRCLR (1 << 8) /* Transaction Counter Clear */
233
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900234/* FRMNUM */
235#define FRNM_MASK (0x7FF)
236
Kuninori Morimotoeb051912011-10-10 22:06:46 -0700237/* DEVADDn */
238#define UPPHUB(x) (((x) & 0xF) << 11) /* HUB Register */
239#define HUBPORT(x) (((x) & 0x7) << 8) /* HUB Port for Target Device */
240#define USBSPD(x) (((x) & 0x3) << 6) /* Device Transfer Rate */
241#define USBSPD_SPEED_LOW 0x1
242#define USBSPD_SPEED_FULL 0x2
243#define USBSPD_SPEED_HIGH 0x3
244
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900245/*
246 * struct
247 */
248struct usbhs_priv {
249
250 void __iomem *base;
251 unsigned int irq;
Shimoda, Yoshihiro53069af2012-01-05 15:37:18 +0900252 unsigned long irqflags;
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900253
Kuninori Morimoto48298202011-10-12 21:02:22 -0700254 struct renesas_usbhs_platform_callback pfunc;
255 struct renesas_usbhs_driver_param dparam;
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900256
Kuninori Morimotobc573812011-04-28 16:41:14 +0900257 struct delayed_work notify_hotplug_work;
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900258 struct platform_device *pdev;
259
Sergei Shtylyovd7b39682014-12-16 01:42:13 +0300260 struct extcon_dev *edev;
261
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900262 spinlock_t lock;
263
Kuninori Morimotob002ff62011-04-28 16:41:20 +0900264 u32 flags;
265
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900266 /*
267 * module control
268 */
269 struct usbhs_mod_info mod_info;
270
271 /*
272 * pipe control
273 */
274 struct usbhs_pipe_info pipe_info;
Kuninori Morimotod3af90a2011-06-06 14:18:44 +0900275
276 /*
277 * fifo control
278 */
279 struct usbhs_fifo_info fifo_info;
Ulrich Hecht8ecef002014-07-10 09:53:59 +0200280
Yoshihiro Shimodac042b852014-10-07 12:43:04 +0900281 struct usb_phy *usb_phy;
Yoshihiro Shimoda420974a2014-10-07 12:43:06 +0900282 struct phy *phy;
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900283};
284
285/*
286 * common
287 */
288u16 usbhs_read(struct usbhs_priv *priv, u32 reg);
289void usbhs_write(struct usbhs_priv *priv, u32 reg, u16 data);
290void usbhs_bset(struct usbhs_priv *priv, u32 reg, u16 mask, u16 data);
291
Kuninori Morimoto97664a22011-06-06 14:18:38 +0900292#define usbhs_lock(p, f) spin_lock_irqsave(usbhs_priv_to_lock(p), f)
293#define usbhs_unlock(p, f) spin_unlock_irqrestore(usbhs_priv_to_lock(p), f)
294
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900295/*
296 * sysconfig
297 */
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900298void usbhs_sys_host_ctrl(struct usbhs_priv *priv, int enable);
299void usbhs_sys_function_ctrl(struct usbhs_priv *priv, int enable);
kuninori.morimoto.gx@renesas.com4cd2f592012-10-15 23:24:19 -0700300void usbhs_sys_function_pullup(struct usbhs_priv *priv, int enable);
Kuninori Morimotodfbb7f42011-11-24 17:28:35 -0800301void usbhs_sys_set_test_mode(struct usbhs_priv *priv, u16 mode);
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900302
303/*
Kuninori Morimotoef8bedb2011-10-10 22:02:33 -0700304 * usb request
305 */
306void usbhs_usbreq_get_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req);
307void usbhs_usbreq_set_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req);
308
309/*
Kuninori Morimoto258485d2011-10-10 22:01:40 -0700310 * bus
311 */
312void usbhs_bus_send_sof_enable(struct usbhs_priv *priv);
313void usbhs_bus_send_reset(struct usbhs_priv *priv);
Kuninori Morimoto75587f52011-10-10 22:01:51 -0700314int usbhs_bus_get_speed(struct usbhs_priv *priv);
Kuninori Morimoto258485d2011-10-10 22:01:40 -0700315int usbhs_vbus_ctrl(struct usbhs_priv *priv, int enable);
316
317/*
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900318 * frame
319 */
320int usbhs_frame_get_num(struct usbhs_priv *priv);
321
322/*
Kuninori Morimotoeb051912011-10-10 22:06:46 -0700323 * device config
324 */
Kuninori Morimoto3dd49262011-10-31 00:47:13 -0700325int usbhs_set_device_config(struct usbhs_priv *priv, int devnum, u16 upphub,
Kuninori Morimotoeb051912011-10-10 22:06:46 -0700326 u16 hubport, u16 speed);
327
328/*
Yoshihiro Shimodaab330cf2015-03-12 15:35:20 +0900329 * interrupt functions
330 */
331void usbhs_xxxsts_clear(struct usbhs_priv *priv, u16 sts_reg, u16 bit);
332
333/*
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900334 * data
335 */
Kuninori Morimoto206dcc22011-04-28 16:40:54 +0900336struct usbhs_priv *usbhs_pdev_to_priv(struct platform_device *pdev);
Kuninori Morimoto48298202011-10-12 21:02:22 -0700337#define usbhs_get_dparam(priv, param) (priv->dparam.param)
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900338#define usbhs_priv_to_pdev(priv) (priv->pdev)
339#define usbhs_priv_to_dev(priv) (&priv->pdev->dev)
340#define usbhs_priv_to_lock(priv) (&priv->lock)
341
342#endif /* RENESAS_USB_DRIVER_H */