347 lines
		
	
	
		
			10 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			347 lines
		
	
	
		
			10 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
| /* SPDX-License-Identifier: GPL-1.0+ */
 | |
| /*
 | |
|  * Renesas USB driver
 | |
|  *
 | |
|  * Copyright (C) 2011 Renesas Solutions Corp.
 | |
|  * Copyright (C) 2019 Renesas Electronics Corporation
 | |
|  * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
 | |
|  */
 | |
| #ifndef RENESAS_USB_DRIVER_H
 | |
| #define RENESAS_USB_DRIVER_H
 | |
| 
 | |
| #include <linux/clk.h>
 | |
| #include <linux/extcon.h>
 | |
| #include <linux/platform_device.h>
 | |
| #include <linux/reset.h>
 | |
| #include <linux/usb/renesas_usbhs.h>
 | |
| 
 | |
| struct usbhs_priv;
 | |
| 
 | |
| #include "mod.h"
 | |
| #include "pipe.h"
 | |
| 
 | |
| /*
 | |
|  *
 | |
|  *		register define
 | |
|  *
 | |
|  */
 | |
| #define SYSCFG		0x0000
 | |
| #define BUSWAIT		0x0002
 | |
| #define DVSTCTR		0x0008
 | |
| #define TESTMODE	0x000C
 | |
| #define CFIFO		0x0014
 | |
| #define CFIFOSEL	0x0020
 | |
| #define CFIFOCTR	0x0022
 | |
| #define D0FIFO		0x0100
 | |
| #define D0FIFOSEL	0x0028
 | |
| #define D0FIFOCTR	0x002A
 | |
| #define D1FIFO		0x0120
 | |
| #define D1FIFOSEL	0x002C
 | |
| #define D1FIFOCTR	0x002E
 | |
| #define INTENB0		0x0030
 | |
| #define INTENB1		0x0032
 | |
| #define BRDYENB		0x0036
 | |
| #define NRDYENB		0x0038
 | |
| #define BEMPENB		0x003A
 | |
| #define INTSTS0		0x0040
 | |
| #define INTSTS1		0x0042
 | |
| #define BRDYSTS		0x0046
 | |
| #define NRDYSTS		0x0048
 | |
| #define BEMPSTS		0x004A
 | |
| #define FRMNUM		0x004C
 | |
| #define USBREQ		0x0054	/* USB request type register */
 | |
| #define USBVAL		0x0056	/* USB request value register */
 | |
| #define USBINDX		0x0058	/* USB request index register */
 | |
| #define USBLENG		0x005A	/* USB request length register */
 | |
| #define DCPCFG		0x005C
 | |
| #define DCPMAXP		0x005E
 | |
| #define DCPCTR		0x0060
 | |
| #define PIPESEL		0x0064
 | |
| #define PIPECFG		0x0068
 | |
| #define PIPEBUF		0x006A
 | |
| #define PIPEMAXP	0x006C
 | |
| #define PIPEPERI	0x006E
 | |
| #define PIPEnCTR	0x0070
 | |
| #define PIPE1TRE	0x0090
 | |
| #define PIPE1TRN	0x0092
 | |
| #define PIPE2TRE	0x0094
 | |
| #define PIPE2TRN	0x0096
 | |
| #define PIPE3TRE	0x0098
 | |
| #define PIPE3TRN	0x009A
 | |
| #define PIPE4TRE	0x009C
 | |
| #define PIPE4TRN	0x009E
 | |
| #define PIPE5TRE	0x00A0
 | |
| #define PIPE5TRN	0x00A2
 | |
| #define PIPEBTRE	0x00A4
 | |
| #define PIPEBTRN	0x00A6
 | |
| #define PIPECTRE	0x00A8
 | |
| #define PIPECTRN	0x00AA
 | |
| #define PIPEDTRE	0x00AC
 | |
| #define PIPEDTRN	0x00AE
 | |
| #define PIPEETRE	0x00B0
 | |
| #define PIPEETRN	0x00B2
 | |
| #define PIPEFTRE	0x00B4
 | |
| #define PIPEFTRN	0x00B6
 | |
| #define PIPE9TRE	0x00B8
 | |
| #define PIPE9TRN	0x00BA
 | |
| #define PIPEATRE	0x00BC
 | |
| #define PIPEATRN	0x00BE
 | |
| #define DEVADD0		0x00D0 /* Device address n configuration */
 | |
| #define DEVADD1		0x00D2
 | |
| #define DEVADD2		0x00D4
 | |
| #define DEVADD3		0x00D6
 | |
| #define DEVADD4		0x00D8
 | |
| #define DEVADD5		0x00DA
 | |
| #define DEVADD6		0x00DC
 | |
| #define DEVADD7		0x00DE
 | |
| #define DEVADD8		0x00E0
 | |
| #define DEVADD9		0x00E2
 | |
| #define DEVADDA		0x00E4
 | |
| #define D2FIFOSEL	0x00F0	/* for R-Car Gen2 */
 | |
| #define D2FIFOCTR	0x00F2	/* for R-Car Gen2 */
 | |
| #define D3FIFOSEL	0x00F4	/* for R-Car Gen2 */
 | |
| #define D3FIFOCTR	0x00F6	/* for R-Car Gen2 */
 | |
| #define SUSPMODE	0x0102	/* for RZ/A */
 | |
| 
 | |
| /* SYSCFG */
 | |
| #define SCKE	(1 << 10)	/* USB Module Clock Enable */
 | |
| #define CNEN	(1 << 8)	/* Single-ended receiver operation Enable */
 | |
| #define HSE	(1 << 7)	/* High-Speed Operation Enable */
 | |
| #define DCFM	(1 << 6)	/* Controller Function Select */
 | |
| #define DRPD	(1 << 5)	/* D+ Line/D- Line Resistance Control */
 | |
| #define DPRPU	(1 << 4)	/* D+ Line Resistance Control */
 | |
| #define USBE	(1 << 0)	/* USB Module Operation Enable */
 | |
| #define UCKSEL	(1 << 2)	/* Clock Select for RZ/A1 */
 | |
| #define UPLLE	(1 << 1)	/* USB PLL Enable for RZ/A1 */
 | |
| 
 | |
| /* DVSTCTR */
 | |
| #define EXTLP	(1 << 10)	/* Controls the EXTLP pin output state */
 | |
| #define PWEN	(1 << 9)	/* Controls the PWEN pin output state */
 | |
| #define USBRST	(1 << 6)	/* Bus Reset Output */
 | |
| #define UACT	(1 << 4)	/* USB Bus Enable */
 | |
| #define RHST	(0x7)		/* Reset Handshake */
 | |
| #define  RHST_LOW_SPEED  1	/* Low-speed connection */
 | |
| #define  RHST_FULL_SPEED 2	/* Full-speed connection */
 | |
| #define  RHST_HIGH_SPEED 3	/* High-speed connection */
 | |
| 
 | |
| /* CFIFOSEL */
 | |
| #define DREQE	(1 << 12)	/* DMA Transfer Request Enable */
 | |
| #define MBW_32	(0x2 << 10)	/* CFIFO Port Access Bit Width */
 | |
| 
 | |
| /* CFIFOCTR */
 | |
| #define BVAL	(1 << 15)	/* Buffer Memory Enable Flag */
 | |
| #define BCLR	(1 << 14)	/* CPU buffer clear */
 | |
| #define FRDY	(1 << 13)	/* FIFO Port Ready */
 | |
| #define DTLN_MASK (0x0FFF)	/* Receive Data Length */
 | |
| 
 | |
| /* INTENB0 */
 | |
| #define VBSE	(1 << 15)	/* Enable IRQ VBUS_0 and VBUSIN_0 */
 | |
| #define RSME	(1 << 14)	/* Enable IRQ Resume */
 | |
| #define SOFE	(1 << 13)	/* Enable IRQ Frame Number Update */
 | |
| #define DVSE	(1 << 12)	/* Enable IRQ Device State Transition */
 | |
| #define CTRE	(1 << 11)	/* Enable IRQ Control Stage Transition */
 | |
| #define BEMPE	(1 << 10)	/* Enable IRQ Buffer Empty */
 | |
| #define NRDYE	(1 << 9)	/* Enable IRQ Buffer Not Ready Response */
 | |
| #define BRDYE	(1 << 8)	/* Enable IRQ Buffer Ready */
 | |
| 
 | |
| /* INTENB1 */
 | |
| #define BCHGE	(1 << 14)	/* USB Bus Change Interrupt Enable */
 | |
| #define DTCHE	(1 << 12)	/* Disconnection Detect Interrupt Enable */
 | |
| #define ATTCHE	(1 << 11)	/* Connection Detect Interrupt Enable */
 | |
| #define EOFERRE	(1 << 6)	/* EOF Error Detect Interrupt Enable */
 | |
| #define SIGNE	(1 << 5)	/* Setup Transaction Error Interrupt Enable */
 | |
| #define SACKE	(1 << 4)	/* Setup Transaction ACK Interrupt Enable */
 | |
| 
 | |
| /* INTSTS0 */
 | |
| #define VBINT	(1 << 15)	/* VBUS0_0 and VBUS1_0 Interrupt Status */
 | |
| #define DVST	(1 << 12)	/* Device State Transition Interrupt Status */
 | |
| #define CTRT	(1 << 11)	/* Control Stage Interrupt Status */
 | |
| #define BEMP	(1 << 10)	/* Buffer Empty Interrupt Status */
 | |
| #define BRDY	(1 << 8)	/* Buffer Ready Interrupt Status */
 | |
| #define VBSTS	(1 << 7)	/* VBUS_0 and VBUSIN_0 Input Status */
 | |
| #define VALID	(1 << 3)	/* USB Request Receive */
 | |
| 
 | |
| #define DVSQ_MASK		(0x7 << 4)	/* Device State */
 | |
| #define  POWER_STATE		(0 << 4)
 | |
| #define  DEFAULT_STATE		(1 << 4)
 | |
| #define  ADDRESS_STATE		(2 << 4)
 | |
| #define  CONFIGURATION_STATE	(3 << 4)
 | |
| #define  SUSPENDED_STATE	(4 << 4)
 | |
| 
 | |
| #define CTSQ_MASK		(0x7)	/* Control Transfer Stage */
 | |
| #define  IDLE_SETUP_STAGE	0	/* Idle stage or setup stage */
 | |
| #define  READ_DATA_STAGE	1	/* Control read data stage */
 | |
| #define  READ_STATUS_STAGE	2	/* Control read status stage */
 | |
| #define  WRITE_DATA_STAGE	3	/* Control write data stage */
 | |
| #define  WRITE_STATUS_STAGE	4	/* Control write status stage */
 | |
| #define  NODATA_STATUS_STAGE	5	/* Control write NoData status stage */
 | |
| #define  SEQUENCE_ERROR		6	/* Control transfer sequence error */
 | |
| 
 | |
| /* INTSTS1 */
 | |
| #define OVRCR	(1 << 15) /* OVRCR Interrupt Status */
 | |
| #define BCHG	(1 << 14) /* USB Bus Change Interrupt Status */
 | |
| #define DTCH	(1 << 12) /* USB Disconnection Detect Interrupt Status */
 | |
| #define ATTCH	(1 << 11) /* ATTCH Interrupt Status */
 | |
| #define EOFERR	(1 << 6)  /* EOF Error Detect Interrupt Status */
 | |
| #define SIGN	(1 << 5)  /* Setup Transaction Error Interrupt Status */
 | |
| #define SACK	(1 << 4)  /* Setup Transaction ACK Response Interrupt Status */
 | |
| 
 | |
| /* PIPECFG */
 | |
| /* DCPCFG */
 | |
| #define TYPE_NONE	(0 << 14)	/* Transfer Type */
 | |
| #define TYPE_BULK	(1 << 14)
 | |
| #define TYPE_INT	(2 << 14)
 | |
| #define TYPE_ISO	(3 << 14)
 | |
| #define BFRE		(1 << 10)	/* BRDY Interrupt Operation Spec. */
 | |
| #define DBLB		(1 << 9)	/* Double Buffer Mode */
 | |
| #define SHTNAK		(1 << 7)	/* Pipe Disable in Transfer End */
 | |
| #define DIR_OUT		(1 << 4)	/* Transfer Direction */
 | |
| 
 | |
| /* PIPEMAXP */
 | |
| /* DCPMAXP */
 | |
| #define DEVSEL_MASK	(0xF << 12)	/* Device Select */
 | |
| #define DCP_MAXP_MASK	(0x7F)
 | |
| #define PIPE_MAXP_MASK	(0x7FF)
 | |
| 
 | |
| /* PIPEBUF */
 | |
| #define BUFSIZE_SHIFT	10
 | |
| #define BUFSIZE_MASK	(0x1F << BUFSIZE_SHIFT)
 | |
| #define BUFNMB_MASK	(0xFF)
 | |
| 
 | |
| /* PIPEnCTR */
 | |
| /* DCPCTR */
 | |
| #define BSTS		(1 << 15)	/* Buffer Status */
 | |
| #define SUREQ		(1 << 14)	/* Sending SETUP Token */
 | |
| #define INBUFM		(1 << 14)	/* (PIPEnCTR) Transfer Buffer Monitor */
 | |
| #define CSSTS		(1 << 12)	/* CSSTS Status */
 | |
| #define	ACLRM		(1 << 9)	/* Buffer Auto-Clear Mode */
 | |
| #define SQCLR		(1 << 8)	/* Toggle Bit Clear */
 | |
| #define SQSET		(1 << 7)	/* Toggle Bit Set */
 | |
| #define SQMON		(1 << 6)	/* Toggle Bit Check */
 | |
| #define PBUSY		(1 << 5)	/* Pipe Busy */
 | |
| #define PID_MASK	(0x3)		/* Response PID */
 | |
| #define  PID_NAK	0
 | |
| #define  PID_BUF	1
 | |
| #define  PID_STALL10	2
 | |
| #define  PID_STALL11	3
 | |
| 
 | |
| #define CCPL		(1 << 2)	/* Control Transfer End Enable */
 | |
| 
 | |
| /* PIPEnTRE */
 | |
| #define TRENB		(1 << 9)	/* Transaction Counter Enable */
 | |
| #define TRCLR		(1 << 8)	/* Transaction Counter Clear */
 | |
| 
 | |
| /* FRMNUM */
 | |
| #define FRNM_MASK	(0x7FF)
 | |
| 
 | |
| /* DEVADDn */
 | |
| #define UPPHUB(x)	(((x) & 0xF) << 11)	/* HUB Register */
 | |
| #define HUBPORT(x)	(((x) & 0x7) << 8)	/* HUB Port for Target Device */
 | |
| #define USBSPD(x)	(((x) & 0x3) << 6)	/* Device Transfer Rate */
 | |
| #define USBSPD_SPEED_LOW	0x1
 | |
| #define USBSPD_SPEED_FULL	0x2
 | |
| #define USBSPD_SPEED_HIGH	0x3
 | |
| 
 | |
| /* SUSPMODE */
 | |
| #define SUSPM		(1 << 14)	/* SuspendM Control */
 | |
| 
 | |
| /*
 | |
|  *		struct
 | |
|  */
 | |
| struct usbhs_priv {
 | |
| 
 | |
| 	void __iomem *base;
 | |
| 	unsigned int irq;
 | |
| 
 | |
| 	const struct renesas_usbhs_platform_callback *pfunc;
 | |
| 	struct renesas_usbhs_driver_param	dparam;
 | |
| 
 | |
| 	struct delayed_work notify_hotplug_work;
 | |
| 	struct platform_device *pdev;
 | |
| 
 | |
| 	struct extcon_dev *edev;
 | |
| 
 | |
| 	spinlock_t		lock;
 | |
| 
 | |
| 	/*
 | |
| 	 * module control
 | |
| 	 */
 | |
| 	struct usbhs_mod_info mod_info;
 | |
| 
 | |
| 	/*
 | |
| 	 * pipe control
 | |
| 	 */
 | |
| 	struct usbhs_pipe_info pipe_info;
 | |
| 
 | |
| 	/*
 | |
| 	 * fifo control
 | |
| 	 */
 | |
| 	struct usbhs_fifo_info fifo_info;
 | |
| 
 | |
| 	struct phy *phy;
 | |
| 	struct reset_control *rsts;
 | |
| 	struct clk *clks[2];
 | |
| };
 | |
| 
 | |
| /*
 | |
|  * common
 | |
|  */
 | |
| u16 usbhs_read(struct usbhs_priv *priv, u32 reg);
 | |
| void usbhs_write(struct usbhs_priv *priv, u32 reg, u16 data);
 | |
| void usbhs_bset(struct usbhs_priv *priv, u32 reg, u16 mask, u16 data);
 | |
| 
 | |
| #define usbhs_lock(p, f) spin_lock_irqsave(usbhs_priv_to_lock(p), f)
 | |
| #define usbhs_unlock(p, f) spin_unlock_irqrestore(usbhs_priv_to_lock(p), f)
 | |
| 
 | |
| int usbhs_get_id_as_gadget(struct platform_device *pdev);
 | |
| 
 | |
| /*
 | |
|  * sysconfig
 | |
|  */
 | |
| void usbhs_sys_host_ctrl(struct usbhs_priv *priv, int enable);
 | |
| void usbhs_sys_function_ctrl(struct usbhs_priv *priv, int enable);
 | |
| void usbhs_sys_function_pullup(struct usbhs_priv *priv, int enable);
 | |
| void usbhs_sys_set_test_mode(struct usbhs_priv *priv, u16 mode);
 | |
| 
 | |
| /*
 | |
|  * usb request
 | |
|  */
 | |
| void usbhs_usbreq_get_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req);
 | |
| void usbhs_usbreq_set_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req);
 | |
| 
 | |
| /*
 | |
|  * bus
 | |
|  */
 | |
| void usbhs_bus_send_sof_enable(struct usbhs_priv *priv);
 | |
| void usbhs_bus_send_reset(struct usbhs_priv *priv);
 | |
| int usbhs_bus_get_speed(struct usbhs_priv *priv);
 | |
| int usbhs_vbus_ctrl(struct usbhs_priv *priv, int enable);
 | |
| int usbhsc_schedule_notify_hotplug(struct platform_device *pdev);
 | |
| 
 | |
| /*
 | |
|  * frame
 | |
|  */
 | |
| int usbhs_frame_get_num(struct usbhs_priv *priv);
 | |
| 
 | |
| /*
 | |
|  * device config
 | |
|  */
 | |
| int usbhs_set_device_config(struct usbhs_priv *priv, int devnum, u16 upphub,
 | |
| 			   u16 hubport, u16 speed);
 | |
| 
 | |
| /*
 | |
|  * interrupt functions
 | |
|  */
 | |
| void usbhs_xxxsts_clear(struct usbhs_priv *priv, u16 sts_reg, u16 bit);
 | |
| 
 | |
| /*
 | |
|  * data
 | |
|  */
 | |
| struct usbhs_priv *usbhs_pdev_to_priv(struct platform_device *pdev);
 | |
| #define usbhs_get_dparam(priv, param)	(priv->dparam.param)
 | |
| #define usbhs_priv_to_pdev(priv)	(priv->pdev)
 | |
| #define usbhs_priv_to_dev(priv)		(&priv->pdev->dev)
 | |
| #define usbhs_priv_to_lock(priv)	(&priv->lock)
 | |
| 
 | |
| #endif /* RENESAS_USB_DRIVER_H */
 |