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>
30 #include <linux/ulpi/interface.h>
666  * struct dwc3_event_buffer - Software event buffer representation
700  * struct dwc3_ep - device side endpoint representation
713  * @number: endpoint number (1 - 15)
718  * @name: a human readable name e.g. ep1out-bulk
762 	 * anything larger than 256 - I can't see why people would want to do
763 	 * this though - then this type needs to be changed.
859  * struct dwc3_trb - transfer request block (hw format)
860  * @bpl: DW0-3
861  * @bph: DW4-7
862  * @size: DW8-B
863  * @ctrl: DWC-F
873  * struct dwc3_hwparams - copy of HWPARAMS registers
907 #define DWC3_NUM_EPS(p)		(((p)->hwparams3 &		\
909 #define DWC3_NUM_IN_EPS(p)	(((p)->hwparams3 &		\
916 #define DWC3_MST_CAPABLE(p)	(!!((p)->hwparams9 &		\
920  * struct dwc3_request - representation of a transfer request
937  * @mapped: true when request has been dma-mapped
957 #define DWC3_REQUEST_STATUS_UNKNOWN		-1
971  * struct dwc3_scratchpad_array - hibernation scratchpad array
979  * struct dwc3 - representation of our controller
991  * @sysdev: pointer to the DMA-capable device
1021  * @current_dr_role: current role of operation when in dual-role mode
1022  * @desired_dr_role: desired role of operation when in dual-role mode
1026  *		- USBPHY_INTERFACE_MODE_UTMI
1027  *		- USBPHY_INTERFACE_MODE_UTMIW
1037  * @ulpi: pointer to ulpi interface
1038  * @ulpi_ready: flag to indicate that ULPI is initialized
1046  * @link_state: link state
1065  * @hsphy_interface: "utmi" or "ulpi"
1075  *	0	- utmi_sleep_n
1076  *	1	- utmi_l1_suspend_n
1084  *			not needed for DWC_usb31 version 1.70a-ea06 and below
1085  * @usb3_lpm_capable: set if hadrware supports Link Power Management
1100  * @dis_u1_entry_quirk: set if link entering into U1 state needs to be disabled.
1101  * @dis_u2_entry_quirk: set if link entering into U2 state needs to be disabled.
1107  *			provide a free-running PHY clock.
1120  * @tx_de_emphasis_quirk: set if we enable Tx de-emphasis quirk
1121  * @tx_de_emphasis: Tx de-emphasis value
1122  *	0	- -6dB de-emphasis
1123  *	1	- -3.5dB de-emphasis
1124  *	2	- No de-emphasis
1125  *	3	- Reserved
1184 	struct ulpi		*ulpi;  member
1372 /* -------------------------------------------------------------------------- */
1388  * struct dwc3_event_depevt - Device Endpoint Events
1392  *	0x00	- Reserved
1393  *	0x01	- XferComplete
1394  *	0x02	- XferInProgress
1395  *	0x03	- XferNotReady
1396  *	0x04	- RxTxFifoEvt (IN->Underrun, OUT->Overrun)
1397  *	0x05	- Reserved
1398  *	0x06	- StreamEvt
1399  *	0x07	- EPCmdCmplt
1431 /* Control-only Status */
1447  * struct dwc3_event_devt - Device Events
1448  * @one_bit: indicates this is a non-endpoint event (not used)
1451  *	0	- DisconnEvt
1452  *	1	- USBRst
1453  *	2	- ConnectDone
1454  *	3	- ULStChng
1455  *	4	- WkUpEvt
1456  *	5	- Reserved
1457  *	6	- Suspend (EOPF on revisions 2.10a and prior)
1458  *	7	- SOF
1459  *	8	- Reserved
1460  *	9	- ErrticErr
1461  *	10	- CmdCmplt
1462  *	11	- EvntOverflow
1463  *	12	- VndrDevTstRcved
1478  * struct dwc3_event_gevt - Other Core Events
1479  * @one_bit: indicates this is a non-endpoint event (not used)
1481  * @phy_port_number: self-explanatory
1492  * union dwc3_event - representation of Event Buffer contents
1493  * @raw: raw 32-bit event
1508  * struct dwc3_gadget_ep_cmd_params - representation of endpoint command
1534 	(dwc->ip == _ip##_IP)
1537 	(DWC3_IP_IS(_ip) && dwc->revision == _ip##_REVISION_##_ver)
1540 	(DWC3_IP_IS(_ip) && dwc->revision < _ip##_REVISION_##_ver)
1544 	 dwc->revision >= _ip##_REVISION_##_from &&			\
1546 	  dwc->revision <= _ip##_REVISION_##_to))
1550 	 dwc->version_type >= _ip##_VERSIONTYPE_##_from &&		\
1552 	  dwc->version_type <= _ip##_VERSIONTYPE_##_to))
1555  * dwc3_mdwidth - get MDWIDTH value in bits
1564 	mdwidth = DWC3_GHWPARAMS0_MDWIDTH(dwc->hwparams.hwparams0);  in dwc3_mdwidth()
1566 		mdwidth += DWC3_GHWPARAMS6_MDWIDTH(dwc->hwparams.hwparams6);  in dwc3_mdwidth()