usb/dwc3/core.h

1 /* SPDX-License-Identifier: GPL-2.0 */
3  * core.h - DesignWare USB3 DRD Core Header
5  * Copyright (C) 2015 Texas Instruments Incorporated - http://www.ti.com
8  *	    Sebastian Andrzej Siewior <bigeasy@linutronix.de>
10  * Taken from Linux Kernel v3.19-rc1 (drivers/usb/dwc3/core.h) and ported
378  * struct dwc3_event_buffer - Software event buffer representation
408 #define DWC3_TRB_MASK		(DWC3_TRB_NUM - 1)
411  * struct dwc3_ep - device side endpoint representation
424  * @number: endpoint number (1 - 15)
428  * @name: a human readable name e.g. ep1out-bulk
539  * struct dwc3_trb - transfer request block (hw format)
540  * @bpl: DW0-3
541  * @bph: DW4-7
542  * @size: DW8-B
543  * @trl: DWC-F
553  * dwc3_hwparams - copy of HWPARAMS registers
554  * @hwparams0 - GHWPARAMS0
555  * @hwparams1 - GHWPARAMS1
556  * @hwparams2 - GHWPARAMS2
557  * @hwparams3 - GHWPARAMS3
558  * @hwparams4 - GHWPARAMS4
559  * @hwparams5 - GHWPARAMS5
560  * @hwparams6 - GHWPARAMS6
561  * @hwparams7 - GHWPARAMS7
562  * @hwparams8 - GHWPARAMS8
587 #define DWC3_NUM_EPS(p)		(((p)->hwparams3 &		\
589 #define DWC3_NUM_IN_EPS(p)	(((p)->hwparams3 &		\
611  * struct dwc3_scratchpad_array - hibernation scratchpad array
619  * struct dwc3 - representation of our controller
671  * 	0	- utmi_sleep_n
672  * 	1	- utmi_l1_suspend_n
691  * @tx_de_emphasis_quirk: set if we enable Tx de-emphasis quirk
692  * @tx_de_emphasis: Tx de-emphasis value
693  * 	0	- -6dB de-emphasis
694  * 	1	- -3.5dB de-emphasis
695  * 	2	- No de-emphasis
696  * 	3	- Reserved
823 /* -------------------------------------------------------------------------- */
825 /* -------------------------------------------------------------------------- */
841  * dwc3_ep_event_string - returns event name
850 		return "Transfer In-Progress";  in dwc3_ep_event_string()
865  * struct dwc3_event_depvt - Device Endpoint Events
869  *	0x00	- Reserved
870  *	0x01	- XferComplete
871  *	0x02	- XferInProgress
872  *	0x03	- XferNotReady
873  *	0x04	- RxTxFifoEvt (IN->Underrun, OUT->Overrun)
874  *	0x05	- Reserved
875  *	0x06	- StreamEvt
876  *	0x07	- EPCmdCmplt
903 /* Control-only Status */
911  * struct dwc3_event_devt - Device Events
912  * @one_bit: indicates this is a non-endpoint event (not used)
915  *	0	- DisconnEvt
916  *	1	- USBRst
917  *	2	- ConnectDone
918  *	3	- ULStChng
919  *	4	- WkUpEvt
920  *	5	- Reserved
921  *	6	- EOPF
922  *	7	- SOF
923  *	8	- Reserved
924  *	9	- ErrticErr
925  *	10	- CmdCmplt
926  *	11	- EvntOverflow
927  *	12	- VndrDevTstRcved
942  * struct dwc3_event_gevt - Other Core Events
943  * @one_bit: indicates this is a non-endpoint event (not used)
945  * @phy_port_number: self-explanatory
956  * union dwc3_event - representation of Event Buffer contents
957  * @raw: raw 32-bit event
972  * struct dwc3_gadget_ep_cmd_params - representation of endpoint command