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
8  *	    Sebastian Andrzej Siewior <bigeasy@linutronix.de>
20 #include <linux/dma-mapping.h>
670  * struct dwc3_event_buffer - Software event buffer representation
704  * struct dwc3_ep - device side endpoint representation
717  * @number: endpoint number (1 - 15)
722  * @name: a human readable name e.g. ep1out-bulk
765 	 * anything larger than 256 - I can't see why people would want to do
766 	 * this though - then this type needs to be changed.
862  * struct dwc3_trb - transfer request block (hw format)
863  * @bpl: DW0-3
864  * @bph: DW4-7
865  * @size: DW8-B
866  * @ctrl: DWC-F
876  * struct dwc3_hwparams - copy of HWPARAMS registers
910 #define DWC3_NUM_EPS(p)		(((p)->hwparams3 &		\
912 #define DWC3_NUM_IN_EPS(p)	(((p)->hwparams3 &		\
919 #define DWC3_MST_CAPABLE(p)	(!!((p)->hwparams9 &		\
923  * struct dwc3_request - representation of a transfer request
940  * @mapped: true when request has been dma-mapped
960 #define DWC3_REQUEST_STATUS_UNKNOWN		-1
974  * struct dwc3_scratchpad_array - hibernation scratchpad array
982  * struct dwc3 - representation of our controller
994  * @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
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.
1127  * @tx_de_emphasis_quirk: set if we enable Tx de-emphasis quirk
1128  * @tx_de_emphasis: Tx de-emphasis value
1129  *	0	- -6dB de-emphasis
1130  *	1	- -3.5dB de-emphasis
1131  *	2	- No de-emphasis
1132  *	3	- Reserved
1374 /* -------------------------------------------------------------------------- */
1390  * struct dwc3_event_depevt - Device Endpoint Events
1394  *	0x00	- Reserved
1395  *	0x01	- XferComplete
1396  *	0x02	- XferInProgress
1397  *	0x03	- XferNotReady
1398  *	0x04	- RxTxFifoEvt (IN->Underrun, OUT->Overrun)
1399  *	0x05	- Reserved
1400  *	0x06	- StreamEvt
1401  *	0x07	- EPCmdCmplt
1433 /* Control-only Status */
1449  * struct dwc3_event_devt - Device Events
1450  * @one_bit: indicates this is a non-endpoint event (not used)
1453  *	0	- DisconnEvt
1454  *	1	- USBRst
1455  *	2	- ConnectDone
1456  *	3	- ULStChng
1457  *	4	- WkUpEvt
1458  *	5	- Reserved
1459  *	6	- Suspend (EOPF on revisions 2.10a and prior)
1460  *	7	- SOF
1461  *	8	- Reserved
1462  *	9	- ErrticErr
1463  *	10	- CmdCmplt
1464  *	11	- EvntOverflow
1465  *	12	- VndrDevTstRcved
1480  * struct dwc3_event_gevt - Other Core Events
1481  * @one_bit: indicates this is a non-endpoint event (not used)
1483  * @phy_port_number: self-explanatory
1494  * union dwc3_event - representation of Event Buffer contents
1495  * @raw: raw 32-bit event
1510  * struct dwc3_gadget_ep_cmd_params - representation of endpoint command
1536 	(dwc->ip == _ip##_IP)
1539 	(DWC3_IP_IS(_ip) && dwc->revision == _ip##_REVISION_##_ver)
1542 	(DWC3_IP_IS(_ip) && dwc->revision < _ip##_REVISION_##_ver)
1546 	 dwc->revision >= _ip##_REVISION_##_from &&			\
1548 	  dwc->revision <= _ip##_REVISION_##_to))
1552 	 dwc->version_type >= _ip##_VERSIONTYPE_##_from &&		\
1554 	  dwc->version_type <= _ip##_VERSIONTYPE_##_to))
1557  * dwc3_mdwidth - get MDWIDTH value in bits
1566 	mdwidth = DWC3_GHWPARAMS0_MDWIDTH(dwc->hwparams.hwparams0);  in dwc3_mdwidth()
1568 		mdwidth += DWC3_GHWPARAMS6_MDWIDTH(dwc->hwparams.hwparams6);  in dwc3_mdwidth()