usb/dwc3/core.h

1 /* SPDX-License-Identifier: GPL-2.0 */
3  * core.h - DesignWare USB3 DRD Core Header
5  * Copyright (C) 2010-2011 Texas Instruments Incorporated - https://www.ti.com
20 #include <linux/dma-mapping.h>
37  * DWC3 Multiport controllers support up to 15 High-Speed PHYs
197 /* Global SoC Bus Configuration Register: AHB-prot/AXI-cache/OCP-ReqInfo */
222 /* Global RX Threshold Configuration Register */
227 /* Global TX Threshold Configuration Register */
232 /* Global RX Threshold Configuration Register for DWC_usb31 only */
242 /* Global TX Threshold Configuration Register for DWC_usb31 only */
682  * struct dwc3_event_buffer - Software event buffer representation
716  * struct dwc3_ep - device side endpoint representation
729  * @number: endpoint number (1 - 15)
734  * @name: a human readable name e.g. ep1out-bulk
778 	 * anything larger than 256 - I can't see why people would want to do
779 	 * this though - then this type needs to be changed.
875  * struct dwc3_trb - transfer request block (hw format)
876  * @bpl: DW0-3
877  * @bph: DW4-7
878  * @size: DW8-B
879  * @ctrl: DWC-F
889  * struct dwc3_hwparams - copy of HWPARAMS registers
923 #define DWC3_NUM_EPS(p)		(((p)->hwparams3 &		\
925 #define DWC3_NUM_IN_EPS(p)	(((p)->hwparams3 &		\
932 #define DWC3_MST_CAPABLE(p)	(!!((p)->hwparams9 &		\
936  * struct dwc3_request - representation of a transfer request
953  * @mapped: true when request has been dma-mapped
973 #define DWC3_REQUEST_STATUS_UNKNOWN		-1
987  * struct dwc3_scratchpad_array - hibernation scratchpad array
995  * struct dwc3 - representation of our controller
1007  * @sysdev: pointer to the DMA-capable device
1039  * @current_dr_role: current role of operation when in dual-role mode
1040  * @desired_dr_role: desired role of operation when in dual-role mode
1044  *		- USBPHY_INTERFACE_MODE_UTMI
1045  *		- USBPHY_INTERFACE_MODE_UTMIW
1073  * @lpm_nyet_threshold: LPM NYET response threshold
1074  * @hird_threshold: HIRD threshold
1095  *	0	- utmi_sleep_n
1096  *	1	- utmi_l1_suspend_n
1104  *			not needed for DWC_usb31 version 1.70a-ea06 and below
1127  *			provide a free-running PHY clock.
1142  * @tx_de_emphasis_quirk: set if we enable Tx de-emphasis quirk
1143  * @tx_de_emphasis: Tx de-emphasis value
1144  *	0	- -6dB de-emphasis
1145  *	1	- -3.5dB de-emphasis
1146  *	2	- No de-emphasis
1147  *	3	- Reserved
1403 /* -------------------------------------------------------------------------- */
1419  * struct dwc3_event_depevt - Device Endpoint Events
1423  *	0x00	- Reserved
1424  *	0x01	- XferComplete
1425  *	0x02	- XferInProgress
1426  *	0x03	- XferNotReady
1427  *	0x04	- RxTxFifoEvt (IN->Underrun, OUT->Overrun)
1428  *	0x05	- Reserved
1429  *	0x06	- StreamEvt
1430  *	0x07	- EPCmdCmplt
1462 /* Control-only Status */
1478  * struct dwc3_event_devt - Device Events
1479  * @one_bit: indicates this is a non-endpoint event (not used)
1482  *	0	- DisconnEvt
1483  *	1	- USBRst
1484  *	2	- ConnectDone
1485  *	3	- ULStChng
1486  *	4	- WkUpEvt
1487  *	5	- Reserved
1488  *	6	- Suspend (EOPF on revisions 2.10a and prior)
1489  *	7	- SOF
1490  *	8	- Reserved
1491  *	9	- ErrticErr
1492  *	10	- CmdCmplt
1493  *	11	- EvntOverflow
1494  *	12	- VndrDevTstRcved
1509  * struct dwc3_event_gevt - Other Core Events
1510  * @one_bit: indicates this is a non-endpoint event (not used)
1512  * @phy_port_number: self-explanatory
1523  * union dwc3_event - representation of Event Buffer contents
1524  * @raw: raw 32-bit event
1539  * struct dwc3_gadget_ep_cmd_params - representation of endpoint command
1565 	(dwc->ip == _ip##_IP)
1568 	(DWC3_IP_IS(_ip) && dwc->revision == _ip##_REVISION_##_ver)
1571 	(DWC3_IP_IS(_ip) && dwc->revision < _ip##_REVISION_##_ver)
1575 	 dwc->revision >= _ip##_REVISION_##_from &&			\
1577 	  dwc->revision <= _ip##_REVISION_##_to))
1581 	 dwc->version_type >= _ip##_VERSIONTYPE_##_from &&		\
1583 	  dwc->version_type <= _ip##_VERSIONTYPE_##_to))
1586  * dwc3_mdwidth - get MDWIDTH value in bits
1595 	mdwidth = DWC3_GHWPARAMS0_MDWIDTH(dwc->hwparams.hwparams0);  in dwc3_mdwidth()
1597 		mdwidth += DWC3_GHWPARAMS6_MDWIDTH(dwc->hwparams.hwparams6);  in dwc3_mdwidth()