Merge branch 'for-4.6/core' of git://git.kernel.dk/linux-block
[deliverable/linux.git] / drivers / net / ethernet / moxa / moxart_ether.h
CommitLineData
6c821bd9
JJ
1/* MOXA ART Ethernet (RTL8201CP) driver.
2 *
3 * Copyright (C) 2013 Jonas Jensen
4 *
5 * Jonas Jensen <jonas.jensen@gmail.com>
6 *
7 * Based on code from
8 * Moxa Technology Co., Ltd. <www.moxa.com>
9 *
10 * This file is licensed under the terms of the GNU General Public
11 * License version 2. This program is licensed "as is" without any
12 * warranty of any kind, whether express or implied.
13 */
14
15#ifndef _MOXART_ETHERNET_H
16#define _MOXART_ETHERNET_H
17
18#define TX_REG_OFFSET_DESC0 0
19#define TX_REG_OFFSET_DESC1 4
20#define TX_REG_OFFSET_DESC2 8
21#define TX_REG_DESC_SIZE 16
22
23#define RX_REG_OFFSET_DESC0 0
24#define RX_REG_OFFSET_DESC1 4
25#define RX_REG_OFFSET_DESC2 8
26#define RX_REG_DESC_SIZE 16
27
28#define TX_DESC0_PKT_LATE_COL 0x1 /* abort, late collision */
29#define TX_DESC0_RX_PKT_EXS_COL 0x2 /* abort, >16 collisions */
30#define TX_DESC0_DMA_OWN 0x80000000 /* owned by controller */
31#define TX_DESC1_BUF_SIZE_MASK 0x7ff
32#define TX_DESC1_LTS 0x8000000 /* last TX packet */
33#define TX_DESC1_FTS 0x10000000 /* first TX packet */
34#define TX_DESC1_FIFO_COMPLETE 0x20000000
35#define TX_DESC1_INTR_COMPLETE 0x40000000
36#define TX_DESC1_END 0x80000000
37#define TX_DESC2_ADDRESS_PHYS 0
38#define TX_DESC2_ADDRESS_VIRT 4
39
40#define RX_DESC0_FRAME_LEN 0
41#define RX_DESC0_FRAME_LEN_MASK 0x7FF
42#define RX_DESC0_MULTICAST 0x10000
43#define RX_DESC0_BROADCAST 0x20000
44#define RX_DESC0_ERR 0x40000
45#define RX_DESC0_CRC_ERR 0x80000
46#define RX_DESC0_FTL 0x100000
47#define RX_DESC0_RUNT 0x200000 /* packet less than 64 bytes */
48#define RX_DESC0_ODD_NB 0x400000 /* receive odd nibbles */
49#define RX_DESC0_LRS 0x10000000 /* last receive segment */
50#define RX_DESC0_FRS 0x20000000 /* first receive segment */
51#define RX_DESC0_DMA_OWN 0x80000000
52#define RX_DESC1_BUF_SIZE_MASK 0x7FF
53#define RX_DESC1_END 0x80000000
54#define RX_DESC2_ADDRESS_PHYS 0
55#define RX_DESC2_ADDRESS_VIRT 4
56
57#define TX_DESC_NUM 64
58#define TX_DESC_NUM_MASK (TX_DESC_NUM-1)
59#define TX_NEXT(N) (((N) + 1) & (TX_DESC_NUM_MASK))
60#define TX_BUF_SIZE 1600
61#define TX_BUF_SIZE_MAX (TX_DESC1_BUF_SIZE_MASK+1)
62
63#define RX_DESC_NUM 64
64#define RX_DESC_NUM_MASK (RX_DESC_NUM-1)
65#define RX_NEXT(N) (((N) + 1) & (RX_DESC_NUM_MASK))
66#define RX_BUF_SIZE 1600
67#define RX_BUF_SIZE_MAX (RX_DESC1_BUF_SIZE_MASK+1)
68
69#define REG_INTERRUPT_STATUS 0
70#define REG_INTERRUPT_MASK 4
71#define REG_MAC_MS_ADDRESS 8
72#define REG_MAC_LS_ADDRESS 12
73#define REG_MCAST_HASH_TABLE0 16
74#define REG_MCAST_HASH_TABLE1 20
75#define REG_TX_POLL_DEMAND 24
76#define REG_RX_POLL_DEMAND 28
77#define REG_TXR_BASE_ADDRESS 32
78#define REG_RXR_BASE_ADDRESS 36
79#define REG_INT_TIMER_CTRL 40
80#define REG_APOLL_TIMER_CTRL 44
81#define REG_DMA_BLEN_CTRL 48
82#define REG_RESERVED1 52
83#define REG_MAC_CTRL 136
84#define REG_MAC_STATUS 140
85#define REG_PHY_CTRL 144
86#define REG_PHY_WRITE_DATA 148
87#define REG_FLOW_CTRL 152
88#define REG_BACK_PRESSURE 156
89#define REG_RESERVED2 160
90#define REG_TEST_SEED 196
91#define REG_DMA_FIFO_STATE 200
92#define REG_TEST_MODE 204
93#define REG_RESERVED3 208
94#define REG_TX_COL_COUNTER 212
95#define REG_RPF_AEP_COUNTER 216
96#define REG_XM_PG_COUNTER 220
97#define REG_RUNT_TLC_COUNTER 224
98#define REG_CRC_FTL_COUNTER 228
99#define REG_RLC_RCC_COUNTER 232
100#define REG_BROC_COUNTER 236
101#define REG_MULCA_COUNTER 240
102#define REG_RP_COUNTER 244
103#define REG_XP_COUNTER 248
104
105#define REG_PHY_CTRL_OFFSET 0x0
106#define REG_PHY_STATUS 0x1
107#define REG_PHY_ID1 0x2
108#define REG_PHY_ID2 0x3
109#define REG_PHY_ANA 0x4
110#define REG_PHY_ANLPAR 0x5
111#define REG_PHY_ANE 0x6
112#define REG_PHY_ECTRL1 0x10
113#define REG_PHY_QPDS 0x11
114#define REG_PHY_10BOP 0x12
115#define REG_PHY_ECTRL2 0x13
116#define REG_PHY_FTMAC100_WRITE 0x8000000
117#define REG_PHY_FTMAC100_READ 0x4000000
118
119/* REG_INTERRUPT_STATUS */
120#define RPKT_FINISH BIT(0) /* DMA data received */
121#define NORXBUF BIT(1) /* receive buffer unavailable */
122#define XPKT_FINISH BIT(2) /* DMA moved data to TX FIFO */
123#define NOTXBUF BIT(3) /* transmit buffer unavailable */
124#define XPKT_OK_INT_STS BIT(4) /* transmit to ethernet success */
125#define XPKT_LOST_INT_STS BIT(5) /* transmit ethernet lost (collision) */
126#define RPKT_SAV BIT(6) /* FIFO receive success */
127#define RPKT_LOST_INT_STS BIT(7) /* FIFO full, receive failed */
128#define AHB_ERR BIT(8) /* AHB error */
129#define PHYSTS_CHG BIT(9) /* PHY link status change */
130
131/* REG_INTERRUPT_MASK */
132#define RPKT_FINISH_M BIT(0)
133#define NORXBUF_M BIT(1)
134#define XPKT_FINISH_M BIT(2)
135#define NOTXBUF_M BIT(3)
136#define XPKT_OK_M BIT(4)
137#define XPKT_LOST_M BIT(5)
138#define RPKT_SAV_M BIT(6)
139#define RPKT_LOST_M BIT(7)
140#define AHB_ERR_M BIT(8)
141#define PHYSTS_CHG_M BIT(9)
142
143/* REG_MAC_MS_ADDRESS */
144#define MAC_MADR_MASK 0xffff /* 2 MSB MAC address */
145
146/* REG_INT_TIMER_CTRL */
147#define TXINT_TIME_SEL BIT(15) /* TX cycle time period */
148#define TXINT_THR_MASK 0x7000
149#define TXINT_CNT_MASK 0xf00
150#define RXINT_TIME_SEL BIT(7) /* RX cycle time period */
151#define RXINT_THR_MASK 0x70
152#define RXINT_CNT_MASK 0xF
153
154/* REG_APOLL_TIMER_CTRL */
155#define TXPOLL_TIME_SEL BIT(12) /* TX poll time period */
156#define TXPOLL_CNT_MASK 0xf00
157#define TXPOLL_CNT_SHIFT_BIT 8
158#define RXPOLL_TIME_SEL BIT(4) /* RX poll time period */
159#define RXPOLL_CNT_MASK 0xF
160#define RXPOLL_CNT_SHIFT_BIT 0
161
162/* REG_DMA_BLEN_CTRL */
163#define RX_THR_EN BIT(9) /* RX FIFO threshold arbitration */
164#define RXFIFO_HTHR_MASK 0x1c0
165#define RXFIFO_LTHR_MASK 0x38
166#define INCR16_EN BIT(2) /* AHB bus INCR16 burst command */
167#define INCR8_EN BIT(1) /* AHB bus INCR8 burst command */
168#define INCR4_EN BIT(0) /* AHB bus INCR4 burst command */
169
170/* REG_MAC_CTRL */
171#define RX_BROADPKT BIT(17) /* receive broadcast packets */
172#define RX_MULTIPKT BIT(16) /* receive all multicast packets */
173#define FULLDUP BIT(15) /* full duplex */
174#define CRC_APD BIT(14) /* append CRC to transmitted packet */
175#define RCV_ALL BIT(12) /* ignore incoming packet destination */
176#define RX_FTL BIT(11) /* accept packets larger than 1518 B */
177#define RX_RUNT BIT(10) /* accept packets smaller than 64 B */
178#define HT_MULTI_EN BIT(9) /* accept on hash and mcast pass */
179#define RCV_EN BIT(8) /* receiver enable */
180#define ENRX_IN_HALFTX BIT(6) /* enable receive in half duplex mode */
181#define XMT_EN BIT(5) /* transmit enable */
182#define CRC_DIS BIT(4) /* disable CRC check when receiving */
183#define LOOP_EN BIT(3) /* internal loop-back */
184#define SW_RST BIT(2) /* software reset, last 64 AHB clocks */
185#define RDMA_EN BIT(1) /* enable receive DMA chan */
186#define XDMA_EN BIT(0) /* enable transmit DMA chan */
187
188/* REG_MAC_STATUS */
189#define COL_EXCEED BIT(11) /* more than 16 collisions */
190#define LATE_COL BIT(10) /* transmit late collision detected */
191#define XPKT_LOST BIT(9) /* transmit to ethernet lost */
192#define XPKT_OK BIT(8) /* transmit to ethernet success */
193#define RUNT_MAC_STS BIT(7) /* receive runt detected */
194#define FTL_MAC_STS BIT(6) /* receive frame too long detected */
195#define CRC_ERR_MAC_STS BIT(5)
196#define RPKT_LOST BIT(4) /* RX FIFO full, receive failed */
197#define RPKT_SAVE BIT(3) /* RX FIFO receive success */
198#define COL BIT(2) /* collision, incoming packet dropped */
199#define MCPU_BROADCAST BIT(1)
200#define MCPU_MULTICAST BIT(0)
201
202/* REG_PHY_CTRL */
203#define MIIWR BIT(27) /* init write sequence (auto cleared)*/
204#define MIIRD BIT(26)
205#define REGAD_MASK 0x3e00000
206#define PHYAD_MASK 0x1f0000
207#define MIIRDATA_MASK 0xffff
208
209/* REG_PHY_WRITE_DATA */
210#define MIIWDATA_MASK 0xffff
211
212/* REG_FLOW_CTRL */
213#define PAUSE_TIME_MASK 0xffff0000
214#define FC_HIGH_MASK 0xf000
215#define FC_LOW_MASK 0xf00
216#define RX_PAUSE BIT(4) /* receive pause frame */
217#define TX_PAUSED BIT(3) /* transmit pause due to receive */
218#define FCTHR_EN BIT(2) /* enable threshold mode. */
219#define TX_PAUSE BIT(1) /* transmit pause frame */
220#define FC_EN BIT(0) /* flow control mode enable */
221
222/* REG_BACK_PRESSURE */
223#define BACKP_LOW_MASK 0xf00
224#define BACKP_JAM_LEN_MASK 0xf0
225#define BACKP_MODE BIT(1) /* address mode */
226#define BACKP_ENABLE BIT(0)
227
228/* REG_TEST_SEED */
229#define TEST_SEED_MASK 0x3fff
230
231/* REG_DMA_FIFO_STATE */
232#define TX_DMA_REQUEST BIT(31)
233#define RX_DMA_REQUEST BIT(30)
234#define TX_DMA_GRANT BIT(29)
235#define RX_DMA_GRANT BIT(28)
236#define TX_FIFO_EMPTY BIT(27)
237#define RX_FIFO_EMPTY BIT(26)
238#define TX_DMA2_SM_MASK 0x7000
239#define TX_DMA1_SM_MASK 0xf00
240#define RX_DMA2_SM_MASK 0x70
241#define RX_DMA1_SM_MASK 0xF
242
243/* REG_TEST_MODE */
244#define SINGLE_PKT BIT(26) /* single packet mode */
245#define PTIMER_TEST BIT(25) /* automatic polling timer test mode */
246#define ITIMER_TEST BIT(24) /* interrupt timer test mode */
247#define TEST_SEED_SELECT BIT(22)
248#define SEED_SELECT BIT(21)
249#define TEST_MODE BIT(20)
250#define TEST_TIME_MASK 0xffc00
251#define TEST_EXCEL_MASK 0x3e0
252
253/* REG_TX_COL_COUNTER */
254#define TX_MCOL_MASK 0xffff0000
255#define TX_MCOL_SHIFT_BIT 16
256#define TX_SCOL_MASK 0xffff
257#define TX_SCOL_SHIFT_BIT 0
258
259/* REG_RPF_AEP_COUNTER */
260#define RPF_MASK 0xffff0000
261#define RPF_SHIFT_BIT 16
262#define AEP_MASK 0xffff
263#define AEP_SHIFT_BIT 0
264
265/* REG_XM_PG_COUNTER */
266#define XM_MASK 0xffff0000
267#define XM_SHIFT_BIT 16
268#define PG_MASK 0xffff
269#define PG_SHIFT_BIT 0
270
271/* REG_RUNT_TLC_COUNTER */
272#define RUNT_CNT_MASK 0xffff0000
273#define RUNT_CNT_SHIFT_BIT 16
274#define TLCC_MASK 0xffff
275#define TLCC_SHIFT_BIT 0
276
277/* REG_CRC_FTL_COUNTER */
278#define CRCER_CNT_MASK 0xffff0000
279#define CRCER_CNT_SHIFT_BIT 16
280#define FTL_CNT_MASK 0xffff
281#define FTL_CNT_SHIFT_BIT 0
282
283/* REG_RLC_RCC_COUNTER */
284#define RLC_MASK 0xffff0000
285#define RLC_SHIFT_BIT 16
286#define RCC_MASK 0xffff
287#define RCC_SHIFT_BIT 0
288
289/* REG_PHY_STATUS */
290#define AN_COMPLETE 0x20
291#define LINK_STATUS 0x4
292
293struct moxart_mac_priv_t {
294 void __iomem *base;
295 struct net_device_stats stats;
296 unsigned int reg_maccr;
297 unsigned int reg_imr;
298 struct napi_struct napi;
299 struct net_device *ndev;
300
301 dma_addr_t rx_base;
302 dma_addr_t rx_mapping[RX_DESC_NUM];
59a557be 303 void *rx_desc_base;
6c821bd9
JJ
304 unsigned char *rx_buf_base;
305 unsigned char *rx_buf[RX_DESC_NUM];
306 unsigned int rx_head;
307 unsigned int rx_buf_size;
308
309 dma_addr_t tx_base;
310 dma_addr_t tx_mapping[TX_DESC_NUM];
59a557be 311 void *tx_desc_base;
6c821bd9
JJ
312 unsigned char *tx_buf_base;
313 unsigned char *tx_buf[RX_DESC_NUM];
314 unsigned int tx_head;
315 unsigned int tx_buf_size;
316
317 spinlock_t txlock;
318 unsigned int tx_len[TX_DESC_NUM];
319 struct sk_buff *tx_skb[TX_DESC_NUM];
320 unsigned int tx_tail;
321};
322
323#if TX_BUF_SIZE >= TX_BUF_SIZE_MAX
324#error MOXA ART Ethernet device driver TX buffer is too large!
325#endif
326#if RX_BUF_SIZE >= RX_BUF_SIZE_MAX
327#error MOXA ART Ethernet device driver RX buffer is too large!
328#endif
329
330#endif
This page took 0.17396 seconds and 5 git commands to generate.