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>
209 /* Global RX Threshold Configuration Register */
214 /* Global TX Threshold Configuration Register */
219 /* Global RX Threshold Configuration Register for DWC_usb31 only */
229 /* Global TX Threshold Configuration Register for DWC_usb31 only */
667  * struct dwc3_event_buffer - Software event buffer representation
701  * struct dwc3_ep - device side endpoint representation
714  * @number: endpoint number (1 - 15)
719  * @name: a human readable name e.g. ep1out-bulk
763 	 * anything larger than 256 - I can't see why people would want to do
764 	 * this though - then this type needs to be changed.
860  * struct dwc3_trb - transfer request block (hw format)
861  * @bpl: DW0-3
862  * @bph: DW4-7
863  * @size: DW8-B
864  * @ctrl: DWC-F
874  * struct dwc3_hwparams - copy of HWPARAMS registers
909 #define DWC3_NUM_EPS(p)		(((p)->hwparams3 &		\
911 #define DWC3_NUM_IN_EPS(p)	(((p)->hwparams3 &		\
921 #define DWC3_MST_CAPABLE(p)	(!!((p)->hwparams9 &		\
925  * struct dwc3_request - representation of a transfer request
942  * @mapped: true when request has been dma-mapped
962 #define DWC3_REQUEST_STATUS_UNKNOWN		-1
976  * struct dwc3_scratchpad_array - hibernation scratchpad array
984  * struct dwc3 - representation of our controller
996  * @sysdev: pointer to the DMA-capable device
1026  * @current_dr_role: current role of operation when in dual-role mode
1027  * @desired_dr_role: desired role of operation when in dual-role mode
1031  *		- USBPHY_INTERFACE_MODE_UTMI
1032  *		- USBPHY_INTERFACE_MODE_UTMIW
1058  * @lpm_nyet_threshold: LPM NYET response threshold
1059  * @hird_threshold: HIRD threshold
1080  *	0	- utmi_sleep_n
1081  *	1	- utmi_l1_suspend_n
1089  *			not needed for DWC_usb31 version 1.70a-ea06 and below
1112  *			provide a free-running PHY clock.
1125  * @tx_de_emphasis_quirk: set if we enable Tx de-emphasis quirk
1126  * @tx_de_emphasis: Tx de-emphasis value
1127  *	0	- -6dB de-emphasis
1128  *	1	- -3.5dB de-emphasis
1129  *	2	- No de-emphasis
1130  *	3	- Reserved
1377 /* -------------------------------------------------------------------------- */
1393  * struct dwc3_event_depevt - Device Endpoint Events
1397  *	0x00	- Reserved
1398  *	0x01	- XferComplete
1399  *	0x02	- XferInProgress
1400  *	0x03	- XferNotReady
1401  *	0x04	- RxTxFifoEvt (IN->Underrun, OUT->Overrun)
1402  *	0x05	- Reserved
1403  *	0x06	- StreamEvt
1404  *	0x07	- EPCmdCmplt
1436 /* Control-only Status */
1452  * struct dwc3_event_devt - Device Events
1453  * @one_bit: indicates this is a non-endpoint event (not used)
1456  *	0	- DisconnEvt
1457  *	1	- USBRst
1458  *	2	- ConnectDone
1459  *	3	- ULStChng
1460  *	4	- WkUpEvt
1461  *	5	- Reserved
1462  *	6	- Suspend (EOPF on revisions 2.10a and prior)
1463  *	7	- SOF
1464  *	8	- Reserved
1465  *	9	- ErrticErr
1466  *	10	- CmdCmplt
1467  *	11	- EvntOverflow
1468  *	12	- VndrDevTstRcved
1483  * struct dwc3_event_gevt - Other Core Events
1484  * @one_bit: indicates this is a non-endpoint event (not used)
1486  * @phy_port_number: self-explanatory
1497  * union dwc3_event - representation of Event Buffer contents
1498  * @raw: raw 32-bit event
1513  * struct dwc3_gadget_ep_cmd_params - representation of endpoint command
1539 	(dwc->ip == _ip##_IP)
1542 	(DWC3_IP_IS(_ip) && dwc->revision == _ip##_REVISION_##_ver)
1545 	(DWC3_IP_IS(_ip) && dwc->revision < _ip##_REVISION_##_ver)
1549 	 dwc->revision >= _ip##_REVISION_##_from &&			\
1551 	  dwc->revision <= _ip##_REVISION_##_to))
1555 	 dwc->version_type >= _ip##_VERSIONTYPE_##_from &&		\
1557 	  dwc->version_type <= _ip##_VERSIONTYPE_##_to))
1560  * dwc3_mdwidth - get MDWIDTH value in bits
1569 	mdwidth = DWC3_GHWPARAMS0_MDWIDTH(dwc->hwparams.hwparams0);  in dwc3_mdwidth()
1571 		mdwidth += DWC3_GHWPARAMS6_MDWIDTH(dwc->hwparams.hwparams6);  in dwc3_mdwidth()