xref: /linux/drivers/net/ethernet/stmicro/stmmac/dwmac_dma.h (revision 8f7aa3d3c7323f4ca2768a9e74ebbe359c4f8f88)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*******************************************************************************
3   DWMAC DMA Header file.
4 
5   Copyright (C) 2007-2009  STMicroelectronics Ltd
6 
7 
8   Author: Giuseppe Cavallaro <peppe.cavallaro@st.com>
9 *******************************************************************************/
10 
11 #ifndef __DWMAC_DMA_H__
12 #define __DWMAC_DMA_H__
13 
14 /* DMA CRS Control and Status Register Mapping */
15 #define DMA_BUS_MODE		0x00001000	/* Bus Mode */
16 #define DMA_XMT_POLL_DEMAND	0x00001004	/* Transmit Poll Demand */
17 #define DMA_RCV_POLL_DEMAND	0x00001008	/* Received Poll Demand */
18 #define DMA_RCV_BASE_ADDR	0x0000100c	/* Receive List Base */
19 #define DMA_TX_BASE_ADDR	0x00001010	/* Transmit List Base */
20 #define DMA_STATUS		0x00001014	/* Status Register */
21 #define DMA_CONTROL		0x00001018	/* Ctrl (Operational Mode) */
22 #define DMA_INTR_ENA		0x0000101c	/* Interrupt Enable */
23 #define DMA_MISSED_FRAME_CTR	0x00001020	/* Missed Frame Counter */
24 
25 /* Following DMA defines are channels oriented */
26 #define DMA_CHAN_BASE_OFFSET			0x100
27 
28 static inline u32 dma_chan_base_addr(u32 base, u32 chan)
29 {
30 	return base + chan * DMA_CHAN_BASE_OFFSET;
31 }
32 
33 #define DMA_CHAN_BUS_MODE(chan)	dma_chan_base_addr(DMA_BUS_MODE, chan)
34 #define DMA_CHAN_XMT_POLL_DEMAND(chan)	\
35 				dma_chan_base_addr(DMA_XMT_POLL_DEMAND, chan)
36 #define DMA_CHAN_RCV_POLL_DEMAND(chan)	\
37 				dma_chan_base_addr(DMA_RCV_POLL_DEMAND, chan)
38 #define DMA_CHAN_RCV_BASE_ADDR(chan)	\
39 				dma_chan_base_addr(DMA_RCV_BASE_ADDR, chan)
40 #define DMA_CHAN_TX_BASE_ADDR(chan)	\
41 				dma_chan_base_addr(DMA_TX_BASE_ADDR, chan)
42 #define DMA_CHAN_STATUS(chan)	dma_chan_base_addr(DMA_STATUS, chan)
43 #define DMA_CHAN_CONTROL(chan)	dma_chan_base_addr(DMA_CONTROL, chan)
44 #define DMA_CHAN_INTR_ENA(chan)	dma_chan_base_addr(DMA_INTR_ENA, chan)
45 #define DMA_CHAN_MISSED_FRAME_CTR(chan)	\
46 				dma_chan_base_addr(DMA_MISSED_FRAME_CTR, chan)
47 #define DMA_CHAN_RX_WATCHDOG(chan)	\
48 				dma_chan_base_addr(DMA_RX_WATCHDOG, chan)
49 
50 /* SW Reset */
51 #define DMA_BUS_MODE_SFT_RESET	0x00000001	/* Software Reset */
52 
53 /* Rx watchdog register */
54 #define DMA_RX_WATCHDOG		0x00001024
55 
56 /* AXI Master Bus Mode */
57 #define DMA_AXI_BUS_MODE	0x00001028
58 
59 #define DMA_AXI_EN_LPI		BIT(31)
60 #define DMA_AXI_LPI_XIT_FRM	BIT(30)
61 #define DMA_AXI_WR_OSR_LMT	GENMASK(23, 20)
62 #define DMA_AXI_WR_OSR_LMT_SHIFT	20
63 #define DMA_AXI_WR_OSR_LMT_MASK	0xf
64 #define DMA_AXI_RD_OSR_LMT	GENMASK(19, 16)
65 #define DMA_AXI_RD_OSR_LMT_SHIFT	16
66 #define DMA_AXI_RD_OSR_LMT_MASK	0xf
67 
68 #define DMA_AXI_OSR_MAX		0xf
69 #define DMA_AXI_MAX_OSR_LIMIT ((DMA_AXI_OSR_MAX << DMA_AXI_WR_OSR_LMT_SHIFT) | \
70 			       (DMA_AXI_OSR_MAX << DMA_AXI_RD_OSR_LMT_SHIFT))
71 #define DMA_BURST_LEN_DEFAULT	(DMA_AXI_BLEN256 | DMA_AXI_BLEN128 | \
72 				 DMA_AXI_BLEN64 | DMA_AXI_BLEN32 | \
73 				 DMA_AXI_BLEN16 | DMA_AXI_BLEN8 | \
74 				 DMA_AXI_BLEN4)
75 
76 #define	DMA_AXI_1KBBE		BIT(13)
77 
78 #define DMA_AXI_UNDEF		BIT(0)
79 
80 #define DMA_CUR_TX_BUF_ADDR	0x00001050	/* Current Host Tx Buffer */
81 #define DMA_CUR_RX_BUF_ADDR	0x00001054	/* Current Host Rx Buffer */
82 #define DMA_HW_FEATURE		0x00001058	/* HW Feature Register */
83 
84 /* DMA Control register defines */
85 #define DMA_CONTROL_ST		0x00002000	/* Start/Stop Transmission */
86 #define DMA_CONTROL_SR		0x00000002	/* Start/Stop Receive */
87 
88 /* DMA Normal interrupt */
89 #define DMA_INTR_ENA_NIE 0x00010000	/* Normal Summary */
90 #define DMA_INTR_ENA_TIE 0x00000001	/* Transmit Interrupt */
91 #define DMA_INTR_ENA_TUE 0x00000004	/* Transmit Buffer Unavailable */
92 #define DMA_INTR_ENA_RIE 0x00000040	/* Receive Interrupt */
93 #define DMA_INTR_ENA_ERE 0x00004000	/* Early Receive */
94 
95 #define DMA_INTR_NORMAL	(DMA_INTR_ENA_NIE | DMA_INTR_ENA_RIE | \
96 			DMA_INTR_ENA_TIE)
97 
98 /* DMA Abnormal interrupt */
99 #define DMA_INTR_ENA_AIE 0x00008000	/* Abnormal Summary */
100 #define DMA_INTR_ENA_FBE 0x00002000	/* Fatal Bus Error */
101 #define DMA_INTR_ENA_ETE 0x00000400	/* Early Transmit */
102 #define DMA_INTR_ENA_RWE 0x00000200	/* Receive Watchdog */
103 #define DMA_INTR_ENA_RSE 0x00000100	/* Receive Stopped */
104 #define DMA_INTR_ENA_RUE 0x00000080	/* Receive Buffer Unavailable */
105 #define DMA_INTR_ENA_UNE 0x00000020	/* Tx Underflow */
106 #define DMA_INTR_ENA_OVE 0x00000010	/* Receive Overflow */
107 #define DMA_INTR_ENA_TJE 0x00000008	/* Transmit Jabber */
108 #define DMA_INTR_ENA_TSE 0x00000002	/* Transmit Stopped */
109 
110 #define DMA_INTR_ABNORMAL	(DMA_INTR_ENA_AIE | DMA_INTR_ENA_FBE | \
111 				DMA_INTR_ENA_UNE)
112 
113 /* DMA default interrupt mask */
114 #define DMA_INTR_DEFAULT_MASK	(DMA_INTR_NORMAL | DMA_INTR_ABNORMAL)
115 #define DMA_INTR_DEFAULT_RX	(DMA_INTR_ENA_RIE)
116 #define DMA_INTR_DEFAULT_TX	(DMA_INTR_ENA_TIE)
117 
118 /* DMA Status register defines */
119 #define DMA_STATUS_GLPII	0x40000000	/* GMAC LPI interrupt */
120 #define DMA_STATUS_GPI		0x10000000	/* PMT interrupt */
121 #define DMA_STATUS_GMI		0x08000000	/* MMC interrupt */
122 #define DMA_STATUS_GLI		0x04000000	/* GMAC Line interface int */
123 #define DMA_STATUS_EB_MASK	0x00380000	/* Error Bits Mask */
124 #define DMA_STATUS_EB_TX_ABORT	0x00080000	/* Error Bits - TX Abort */
125 #define DMA_STATUS_EB_RX_ABORT	0x00100000	/* Error Bits - RX Abort */
126 #define DMA_STATUS_TS_MASK	0x00700000	/* Transmit Process State */
127 #define DMA_STATUS_TS_SHIFT	20
128 #define DMA_STATUS_RS_MASK	0x000e0000	/* Receive Process State */
129 #define DMA_STATUS_RS_SHIFT	17
130 #define DMA_STATUS_NIS	0x00010000	/* Normal Interrupt Summary */
131 #define DMA_STATUS_AIS	0x00008000	/* Abnormal Interrupt Summary */
132 #define DMA_STATUS_ERI	0x00004000	/* Early Receive Interrupt */
133 #define DMA_STATUS_FBI	0x00002000	/* Fatal Bus Error Interrupt */
134 #define DMA_STATUS_ETI	0x00000400	/* Early Transmit Interrupt */
135 #define DMA_STATUS_RWT	0x00000200	/* Receive Watchdog Timeout */
136 #define DMA_STATUS_RPS	0x00000100	/* Receive Process Stopped */
137 #define DMA_STATUS_RU	0x00000080	/* Receive Buffer Unavailable */
138 #define DMA_STATUS_RI	0x00000040	/* Receive Interrupt */
139 #define DMA_STATUS_UNF	0x00000020	/* Transmit Underflow */
140 #define DMA_STATUS_OVF	0x00000010	/* Receive Overflow */
141 #define DMA_STATUS_TJT	0x00000008	/* Transmit Jabber Timeout */
142 #define DMA_STATUS_TU	0x00000004	/* Transmit Buffer Unavailable */
143 #define DMA_STATUS_TPS	0x00000002	/* Transmit Process Stopped */
144 #define DMA_STATUS_TI	0x00000001	/* Transmit Interrupt */
145 #define DMA_CONTROL_FTF		0x00100000	/* Flush transmit FIFO */
146 
147 #define DMA_STATUS_MSK_COMMON		(DMA_STATUS_NIS | \
148 					 DMA_STATUS_AIS | \
149 					 DMA_STATUS_FBI)
150 
151 #define DMA_STATUS_MSK_RX		(DMA_STATUS_ERI | \
152 					 DMA_STATUS_RWT | \
153 					 DMA_STATUS_RPS | \
154 					 DMA_STATUS_RU | \
155 					 DMA_STATUS_RI | \
156 					 DMA_STATUS_OVF | \
157 					 DMA_STATUS_MSK_COMMON)
158 
159 #define DMA_STATUS_MSK_TX		(DMA_STATUS_ETI | \
160 					 DMA_STATUS_UNF | \
161 					 DMA_STATUS_TJT | \
162 					 DMA_STATUS_TU | \
163 					 DMA_STATUS_TPS | \
164 					 DMA_STATUS_TI | \
165 					 DMA_STATUS_MSK_COMMON)
166 
167 #define NUM_DWMAC100_DMA_REGS	9
168 #define NUM_DWMAC1000_DMA_REGS	23
169 #define NUM_DWMAC4_DMA_REGS	27
170 
171 void dwmac_enable_dma_transmission(void __iomem *ioaddr, u32 chan);
172 void dwmac_enable_dma_reception(void __iomem *ioaddr, u32 chan);
173 void dwmac_enable_dma_irq(struct stmmac_priv *priv, void __iomem *ioaddr,
174 			  u32 chan, bool rx, bool tx);
175 void dwmac_disable_dma_irq(struct stmmac_priv *priv, void __iomem *ioaddr,
176 			   u32 chan, bool rx, bool tx);
177 void dwmac_dma_start_tx(struct stmmac_priv *priv, void __iomem *ioaddr,
178 			u32 chan);
179 void dwmac_dma_stop_tx(struct stmmac_priv *priv, void __iomem *ioaddr,
180 		       u32 chan);
181 void dwmac_dma_start_rx(struct stmmac_priv *priv, void __iomem *ioaddr,
182 			u32 chan);
183 void dwmac_dma_stop_rx(struct stmmac_priv *priv, void __iomem *ioaddr,
184 		       u32 chan);
185 int dwmac_dma_interrupt(struct stmmac_priv *priv, void __iomem *ioaddr,
186 			struct stmmac_extra_stats *x, u32 chan, u32 dir);
187 int dwmac_dma_reset(void __iomem *ioaddr);
188 
189 #endif /* __DWMAC_DMA_H__ */
190