1 /*******************************************************************************
2   DWMAC DMA Header file.
3 
4   Copyright (C) 2007-2009  STMicroelectronics Ltd
5 
6   This program is free software; you can redistribute it and/or modify it
7   under the terms and conditions of the GNU General Public License,
8   version 2, as published by the Free Software Foundation.
9 
10   This program is distributed in the hope it will be useful, but WITHOUT
11   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
13   more details.
14 
15   You should have received a copy of the GNU General Public License along with
16   this program; if not, write to the Free Software Foundation, Inc.,
17   51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
18 
19   The full GNU General Public License is included in this distribution in
20   the file called "COPYING".
21 
22   Author: Giuseppe Cavallaro <peppe.cavallaro@st.com>
23 *******************************************************************************/
24 
25 #ifndef __DWMAC_DMA_H__
26 #define __DWMAC_DMA_H__
27 
28 /* DMA CRS Control and Status Register Mapping */
29 #define DMA_BUS_MODE		0x00001000	/* Bus Mode */
30 #define DMA_XMT_POLL_DEMAND	0x00001004	/* Transmit Poll Demand */
31 #define DMA_RCV_POLL_DEMAND	0x00001008	/* Received Poll Demand */
32 #define DMA_RCV_BASE_ADDR	0x0000100c	/* Receive List Base */
33 #define DMA_TX_BASE_ADDR	0x00001010	/* Transmit List Base */
34 #define DMA_STATUS		0x00001014	/* Status Register */
35 #define DMA_CONTROL		0x00001018	/* Ctrl (Operational Mode) */
36 #define DMA_INTR_ENA		0x0000101c	/* Interrupt Enable */
37 #define DMA_MISSED_FRAME_CTR	0x00001020	/* Missed Frame Counter */
38 
39 /* SW Reset */
40 #define DMA_BUS_MODE_SFT_RESET	0x00000001	/* Software Reset */
41 
42 /* Rx watchdog register */
43 #define DMA_RX_WATCHDOG		0x00001024
44 
45 /* AXI Master Bus Mode */
46 #define DMA_AXI_BUS_MODE	0x00001028
47 
48 #define DMA_AXI_EN_LPI		BIT(31)
49 #define DMA_AXI_LPI_XIT_FRM	BIT(30)
50 #define DMA_AXI_WR_OSR_LMT	GENMASK(23, 20)
51 #define DMA_AXI_WR_OSR_LMT_SHIFT	20
52 #define DMA_AXI_WR_OSR_LMT_MASK	0xf
53 #define DMA_AXI_RD_OSR_LMT	GENMASK(19, 16)
54 #define DMA_AXI_RD_OSR_LMT_SHIFT	16
55 #define DMA_AXI_RD_OSR_LMT_MASK	0xf
56 
57 #define DMA_AXI_OSR_MAX		0xf
58 #define DMA_AXI_MAX_OSR_LIMIT ((DMA_AXI_OSR_MAX << DMA_AXI_WR_OSR_LMT_SHIFT) | \
59 			       (DMA_AXI_OSR_MAX << DMA_AXI_RD_OSR_LMT_SHIFT))
60 #define	DMA_AXI_1KBBE		BIT(13)
61 #define DMA_AXI_AAL		BIT(12)
62 #define DMA_AXI_BLEN256		BIT(7)
63 #define DMA_AXI_BLEN128		BIT(6)
64 #define DMA_AXI_BLEN64		BIT(5)
65 #define DMA_AXI_BLEN32		BIT(4)
66 #define DMA_AXI_BLEN16		BIT(3)
67 #define DMA_AXI_BLEN8		BIT(2)
68 #define DMA_AXI_BLEN4		BIT(1)
69 #define DMA_BURST_LEN_DEFAULT	(DMA_AXI_BLEN256 | DMA_AXI_BLEN128 | \
70 				 DMA_AXI_BLEN64 | DMA_AXI_BLEN32 | \
71 				 DMA_AXI_BLEN16 | DMA_AXI_BLEN8 | \
72 				 DMA_AXI_BLEN4)
73 
74 #define DMA_AXI_UNDEF		BIT(0)
75 
76 #define DMA_AXI_BURST_LEN_MASK	0x000000FE
77 
78 #define DMA_CUR_TX_BUF_ADDR	0x00001050	/* Current Host Tx Buffer */
79 #define DMA_CUR_RX_BUF_ADDR	0x00001054	/* Current Host Rx Buffer */
80 #define DMA_HW_FEATURE		0x00001058	/* HW Feature Register */
81 
82 /* DMA Control register defines */
83 #define DMA_CONTROL_ST		0x00002000	/* Start/Stop Transmission */
84 #define DMA_CONTROL_SR		0x00000002	/* Start/Stop Receive */
85 
86 /* DMA Normal interrupt */
87 #define DMA_INTR_ENA_NIE 0x00010000	/* Normal Summary */
88 #define DMA_INTR_ENA_TIE 0x00000001	/* Transmit Interrupt */
89 #define DMA_INTR_ENA_TUE 0x00000004	/* Transmit Buffer Unavailable */
90 #define DMA_INTR_ENA_RIE 0x00000040	/* Receive Interrupt */
91 #define DMA_INTR_ENA_ERE 0x00004000	/* Early Receive */
92 
93 #define DMA_INTR_NORMAL	(DMA_INTR_ENA_NIE | DMA_INTR_ENA_RIE | \
94 			DMA_INTR_ENA_TIE)
95 
96 /* DMA Abnormal interrupt */
97 #define DMA_INTR_ENA_AIE 0x00008000	/* Abnormal Summary */
98 #define DMA_INTR_ENA_FBE 0x00002000	/* Fatal Bus Error */
99 #define DMA_INTR_ENA_ETE 0x00000400	/* Early Transmit */
100 #define DMA_INTR_ENA_RWE 0x00000200	/* Receive Watchdog */
101 #define DMA_INTR_ENA_RSE 0x00000100	/* Receive Stopped */
102 #define DMA_INTR_ENA_RUE 0x00000080	/* Receive Buffer Unavailable */
103 #define DMA_INTR_ENA_UNE 0x00000020	/* Tx Underflow */
104 #define DMA_INTR_ENA_OVE 0x00000010	/* Receive Overflow */
105 #define DMA_INTR_ENA_TJE 0x00000008	/* Transmit Jabber */
106 #define DMA_INTR_ENA_TSE 0x00000002	/* Transmit Stopped */
107 
108 #define DMA_INTR_ABNORMAL	(DMA_INTR_ENA_AIE | DMA_INTR_ENA_FBE | \
109 				DMA_INTR_ENA_UNE)
110 
111 /* DMA default interrupt mask */
112 #define DMA_INTR_DEFAULT_MASK	(DMA_INTR_NORMAL | DMA_INTR_ABNORMAL)
113 
114 /* DMA Status register defines */
115 #define DMA_STATUS_GLPII	0x40000000	/* GMAC LPI interrupt */
116 #define DMA_STATUS_GPI		0x10000000	/* PMT interrupt */
117 #define DMA_STATUS_GMI		0x08000000	/* MMC interrupt */
118 #define DMA_STATUS_GLI		0x04000000	/* GMAC Line interface int */
119 #define DMA_STATUS_EB_MASK	0x00380000	/* Error Bits Mask */
120 #define DMA_STATUS_EB_TX_ABORT	0x00080000	/* Error Bits - TX Abort */
121 #define DMA_STATUS_EB_RX_ABORT	0x00100000	/* Error Bits - RX Abort */
122 #define DMA_STATUS_TS_MASK	0x00700000	/* Transmit Process State */
123 #define DMA_STATUS_TS_SHIFT	20
124 #define DMA_STATUS_RS_MASK	0x000e0000	/* Receive Process State */
125 #define DMA_STATUS_RS_SHIFT	17
126 #define DMA_STATUS_NIS	0x00010000	/* Normal Interrupt Summary */
127 #define DMA_STATUS_AIS	0x00008000	/* Abnormal Interrupt Summary */
128 #define DMA_STATUS_ERI	0x00004000	/* Early Receive Interrupt */
129 #define DMA_STATUS_FBI	0x00002000	/* Fatal Bus Error Interrupt */
130 #define DMA_STATUS_ETI	0x00000400	/* Early Transmit Interrupt */
131 #define DMA_STATUS_RWT	0x00000200	/* Receive Watchdog Timeout */
132 #define DMA_STATUS_RPS	0x00000100	/* Receive Process Stopped */
133 #define DMA_STATUS_RU	0x00000080	/* Receive Buffer Unavailable */
134 #define DMA_STATUS_RI	0x00000040	/* Receive Interrupt */
135 #define DMA_STATUS_UNF	0x00000020	/* Transmit Underflow */
136 #define DMA_STATUS_OVF	0x00000010	/* Receive Overflow */
137 #define DMA_STATUS_TJT	0x00000008	/* Transmit Jabber Timeout */
138 #define DMA_STATUS_TU	0x00000004	/* Transmit Buffer Unavailable */
139 #define DMA_STATUS_TPS	0x00000002	/* Transmit Process Stopped */
140 #define DMA_STATUS_TI	0x00000001	/* Transmit Interrupt */
141 #define DMA_CONTROL_FTF		0x00100000	/* Flush transmit FIFO */
142 
143 void dwmac_enable_dma_transmission(void __iomem *ioaddr);
144 void dwmac_enable_dma_irq(void __iomem *ioaddr);
145 void dwmac_disable_dma_irq(void __iomem *ioaddr);
146 void dwmac_dma_start_tx(void __iomem *ioaddr);
147 void dwmac_dma_stop_tx(void __iomem *ioaddr);
148 void dwmac_dma_start_rx(void __iomem *ioaddr);
149 void dwmac_dma_stop_rx(void __iomem *ioaddr);
150 int dwmac_dma_interrupt(void __iomem *ioaddr, struct stmmac_extra_stats *x);
151 int dwmac_dma_reset(void __iomem *ioaddr);
152 
153 #endif /* __DWMAC_DMA_H__ */
154