1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /* atl2.h -- atl2 driver definitions
4 * Copyright(c) 2007 Atheros Corporation. All rights reserved.
5 * Copyright(c) 2006 xiong huang <xiong.huang@atheros.com>
6 * Copyright(c) 2007 Chris Snook <csnook@redhat.com>
8 * Derived from Intel e1000 driver
9 * Copyright(c) 1999 - 2005 Intel Corporation. All rights reserved.
15 #include <linux/atomic.h>
16 #include <linux/netdevice.h>
21 #ifndef _ATL2_OSDEP_H_
22 #define _ATL2_OSDEP_H_
24 #include <linux/pci.h>
25 #include <linux/delay.h>
26 #include <linux/interrupt.h>
27 #include <linux/if_ether.h>
31 #ifdef ETHTOOL_OPS_COMPAT
32 int ethtool_ioctl(struct ifreq
*ifr
);
35 #define PCI_COMMAND_REGISTER PCI_COMMAND
36 #define CMD_MEM_WRT_INVALIDATE PCI_COMMAND_INVALIDATE
38 #define ATL2_WRITE_REG(a, reg, value) (iowrite32((value), \
39 ((a)->hw_addr + (reg))))
41 #define ATL2_WRITE_FLUSH(a) (ioread32((a)->hw_addr))
43 #define ATL2_READ_REG(a, reg) (ioread32((a)->hw_addr + (reg)))
45 #define ATL2_WRITE_REGB(a, reg, value) (iowrite8((value), \
46 ((a)->hw_addr + (reg))))
48 #define ATL2_READ_REGB(a, reg) (ioread8((a)->hw_addr + (reg)))
50 #define ATL2_WRITE_REGW(a, reg, value) (iowrite16((value), \
51 ((a)->hw_addr + (reg))))
53 #define ATL2_READ_REGW(a, reg) (ioread16((a)->hw_addr + (reg)))
55 #define ATL2_WRITE_REG_ARRAY(a, reg, offset, value) \
56 (iowrite32((value), (((a)->hw_addr + (reg)) + ((offset) << 2))))
58 #define ATL2_READ_REG_ARRAY(a, reg, offset) \
59 (ioread32(((a)->hw_addr + (reg)) + ((offset) << 2)))
61 #endif /* _ATL2_OSDEP_H_ */
66 /* function prototype */
67 static s32
atl2_reset_hw(struct atl2_hw
*hw
);
68 static s32
atl2_read_mac_addr(struct atl2_hw
*hw
);
69 static s32
atl2_init_hw(struct atl2_hw
*hw
);
70 static s32
atl2_get_speed_and_duplex(struct atl2_hw
*hw
, u16
*speed
,
72 static u32
atl2_hash_mc_addr(struct atl2_hw
*hw
, u8
*mc_addr
);
73 static void atl2_hash_set(struct atl2_hw
*hw
, u32 hash_value
);
74 static s32
atl2_read_phy_reg(struct atl2_hw
*hw
, u16 reg_addr
, u16
*phy_data
);
75 static s32
atl2_write_phy_reg(struct atl2_hw
*hw
, u32 reg_addr
, u16 phy_data
);
76 static void atl2_read_pci_cfg(struct atl2_hw
*hw
, u32 reg
, u16
*value
);
77 static void atl2_write_pci_cfg(struct atl2_hw
*hw
, u32 reg
, u16
*value
);
78 static void atl2_set_mac_addr(struct atl2_hw
*hw
);
79 static bool atl2_read_eeprom(struct atl2_hw
*hw
, u32 Offset
, u32
*pValue
);
80 static bool atl2_write_eeprom(struct atl2_hw
*hw
, u32 offset
, u32 value
);
81 static s32
atl2_phy_init(struct atl2_hw
*hw
);
82 static int atl2_check_eeprom_exist(struct atl2_hw
*hw
);
83 static void atl2_force_ps(struct atl2_hw
*hw
);
85 /* register definition */
87 /* Block IDLE Status Register */
88 #define IDLE_STATUS_RXMAC 1 /* 1: RXMAC is non-IDLE */
89 #define IDLE_STATUS_TXMAC 2 /* 1: TXMAC is non-IDLE */
90 #define IDLE_STATUS_DMAR 8 /* 1: DMAR is non-IDLE */
91 #define IDLE_STATUS_DMAW 4 /* 1: DMAW is non-IDLE */
93 /* MDIO Control Register */
94 #define MDIO_WAIT_TIMES 10
96 /* MAC Control Register */
97 #define MAC_CTRL_DBG_TX_BKPRESURE 0x100000 /* 1: TX max backoff */
98 #define MAC_CTRL_MACLP_CLK_PHY 0x8000000 /* 1: 25MHz from phy */
99 #define MAC_CTRL_HALF_LEFT_BUF_SHIFT 28
100 #define MAC_CTRL_HALF_LEFT_BUF_MASK 0xF /* MAC retry buf x32B */
102 /* Internal SRAM Partition Register */
103 #define REG_SRAM_TXRAM_END 0x1500 /* Internal tail address of TXRAM
104 * default: 2byte*1024 */
105 #define REG_SRAM_RXRAM_END 0x1502 /* Internal tail address of RXRAM
106 * default: 2byte*1024 */
108 /* Descriptor Control register */
109 #define REG_TXD_BASE_ADDR_LO 0x1544 /* The base address of the Transmit
110 * Data Mem low 32-bit(dword align) */
111 #define REG_TXD_MEM_SIZE 0x1548 /* Transmit Data Memory size(by
112 * double word , max 256KB) */
113 #define REG_TXS_BASE_ADDR_LO 0x154C /* The base address of the Transmit
114 * Status Memory low 32-bit(dword word
116 #define REG_TXS_MEM_SIZE 0x1550 /* double word unit, max 4*2047
118 #define REG_RXD_BASE_ADDR_LO 0x1554 /* The base address of the Transmit
119 * Status Memory low 32-bit(unit 8
121 #define REG_RXD_BUF_NUM 0x1558 /* Receive Data & Status Memory buffer
122 * number (unit 1536bytes, max
125 /* DMAR Control Register */
126 #define REG_DMAR 0x1580
127 #define DMAR_EN 0x1 /* 1: Enable DMAR */
129 /* TX Cur-Through (early tx threshold) Control Register */
130 #define REG_TX_CUT_THRESH 0x1590 /* TxMac begin transmit packet
131 * threshold(unit word) */
133 /* DMAW Control Register */
134 #define REG_DMAW 0x15A0
137 /* Flow control register */
138 #define REG_PAUSE_ON_TH 0x15A8 /* RXD high watermark of overflow
139 * threshold configuration register */
140 #define REG_PAUSE_OFF_TH 0x15AA /* RXD lower watermark of overflow
141 * threshold configuration register */
143 /* Mailbox Register */
144 #define REG_MB_TXD_WR_IDX 0x15f0 /* double word align */
145 #define REG_MB_RXD_RD_IDX 0x15F4 /* RXD Read index (unit: 1536byets) */
147 /* Interrupt Status Register */
148 #define ISR_TIMER 1 /* Interrupt when Timer counts down to zero */
149 #define ISR_MANUAL 2 /* Software manual interrupt, for debug. Set
150 * when SW_MAN_INT_EN is set in Table 51
151 * Selene Master Control Register
152 * (Offset 0x1400). */
153 #define ISR_RXF_OV 4 /* RXF overflow interrupt */
154 #define ISR_TXF_UR 8 /* TXF underrun interrupt */
155 #define ISR_TXS_OV 0x10 /* Internal transmit status buffer full
157 #define ISR_RXS_OV 0x20 /* Internal receive status buffer full
159 #define ISR_LINK_CHG 0x40 /* Link Status Change Interrupt */
160 #define ISR_HOST_TXD_UR 0x80
161 #define ISR_HOST_RXD_OV 0x100 /* Host rx data memory full , one pulse */
162 #define ISR_DMAR_TO_RST 0x200 /* DMAR op timeout interrupt. SW should
164 #define ISR_DMAW_TO_RST 0x400
165 #define ISR_PHY 0x800 /* phy interrupt */
166 #define ISR_TS_UPDATE 0x10000 /* interrupt after new tx pkt status written
168 #define ISR_RS_UPDATE 0x20000 /* interrupt ater new rx pkt status written
170 #define ISR_TX_EARLY 0x40000 /* interrupt when txmac begin transmit one
173 #define ISR_TX_EVENT (ISR_TXF_UR | ISR_TXS_OV | ISR_HOST_TXD_UR |\
174 ISR_TS_UPDATE | ISR_TX_EARLY)
175 #define ISR_RX_EVENT (ISR_RXF_OV | ISR_RXS_OV | ISR_HOST_RXD_OV |\
178 #define IMR_NORMAL_MASK (\
188 /* Receive MAC Statistics Registers */
189 #define REG_STS_RX_PAUSE 0x1700 /* Num pause packets received */
190 #define REG_STS_RXD_OV 0x1704 /* Num frames dropped due to RX
192 #define REG_STS_RXS_OV 0x1708 /* Num frames dropped due to RX
193 * Status Buffer Overflow */
194 #define REG_STS_RX_FILTER 0x170C /* Num packets dropped due to
195 * address filtering */
197 /* MII definitions */
199 /* PHY Common Register */
200 #define MII_SMARTSPEED 0x14
201 #define MII_DBG_ADDR 0x1D
202 #define MII_DBG_DATA 0x1E
204 /* PCI Command Register Bit Definitions */
205 #define PCI_REG_COMMAND 0x04
206 #define CMD_IO_SPACE 0x0001
207 #define CMD_MEMORY_SPACE 0x0002
208 #define CMD_BUS_MASTER 0x0004
210 #define MEDIA_TYPE_100M_FULL 1
211 #define MEDIA_TYPE_100M_HALF 2
212 #define MEDIA_TYPE_10M_FULL 3
213 #define MEDIA_TYPE_10M_HALF 4
215 #define AUTONEG_ADVERTISE_SPEED_DEFAULT 0x000F /* Everything */
217 /* The size (in bytes) of a ethernet packet */
218 #define MAXIMUM_ETHERNET_FRAME_SIZE 1518 /* with FCS */
219 #define MINIMUM_ETHERNET_FRAME_SIZE 64 /* with FCS */
220 #define MAX_JUMBO_FRAME_SIZE 0x2000
222 struct tx_pkt_header
{
223 unsigned pkt_size
:11;
224 unsigned:4; /* reserved */
225 unsigned ins_vlan
:1; /* txmac should insert vlan */
226 unsigned short vlan
; /* vlan tag */
228 /* FIXME: replace above bitfields with MASK/SHIFT defines below */
229 #define TX_PKT_HEADER_SIZE_MASK 0x7FF
230 #define TX_PKT_HEADER_SIZE_SHIFT 0
231 #define TX_PKT_HEADER_INS_VLAN_MASK 0x1
232 #define TX_PKT_HEADER_INS_VLAN_SHIFT 15
233 #define TX_PKT_HEADER_VLAN_TAG_MASK 0xFFFF
234 #define TX_PKT_HEADER_VLAN_TAG_SHIFT 16
236 struct tx_pkt_status
{
237 unsigned pkt_size
:11;
238 unsigned:5; /* reserved */
239 unsigned ok
:1; /* current packet transmitted without error */
240 unsigned bcast
:1; /* broadcast packet */
241 unsigned mcast
:1; /* multicast packet */
242 unsigned pause
:1; /* transmiited a pause frame */
244 unsigned defer
:1; /* current packet is xmitted with defer */
245 unsigned exc_defer
:1;
246 unsigned single_col
:1;
247 unsigned multi_col
:1;
249 unsigned abort_col
:1;
250 unsigned underrun
:1; /* current packet is aborted
251 * due to txram underrun */
252 unsigned:3; /* reserved */
253 unsigned update
:1; /* always 1'b1 in tx_status_buf */
255 /* FIXME: replace above bitfields with MASK/SHIFT defines below */
256 #define TX_PKT_STATUS_SIZE_MASK 0x7FF
257 #define TX_PKT_STATUS_SIZE_SHIFT 0
258 #define TX_PKT_STATUS_OK_MASK 0x1
259 #define TX_PKT_STATUS_OK_SHIFT 16
260 #define TX_PKT_STATUS_BCAST_MASK 0x1
261 #define TX_PKT_STATUS_BCAST_SHIFT 17
262 #define TX_PKT_STATUS_MCAST_MASK 0x1
263 #define TX_PKT_STATUS_MCAST_SHIFT 18
264 #define TX_PKT_STATUS_PAUSE_MASK 0x1
265 #define TX_PKT_STATUS_PAUSE_SHIFT 19
266 #define TX_PKT_STATUS_CTRL_MASK 0x1
267 #define TX_PKT_STATUS_CTRL_SHIFT 20
268 #define TX_PKT_STATUS_DEFER_MASK 0x1
269 #define TX_PKT_STATUS_DEFER_SHIFT 21
270 #define TX_PKT_STATUS_EXC_DEFER_MASK 0x1
271 #define TX_PKT_STATUS_EXC_DEFER_SHIFT 22
272 #define TX_PKT_STATUS_SINGLE_COL_MASK 0x1
273 #define TX_PKT_STATUS_SINGLE_COL_SHIFT 23
274 #define TX_PKT_STATUS_MULTI_COL_MASK 0x1
275 #define TX_PKT_STATUS_MULTI_COL_SHIFT 24
276 #define TX_PKT_STATUS_LATE_COL_MASK 0x1
277 #define TX_PKT_STATUS_LATE_COL_SHIFT 25
278 #define TX_PKT_STATUS_ABORT_COL_MASK 0x1
279 #define TX_PKT_STATUS_ABORT_COL_SHIFT 26
280 #define TX_PKT_STATUS_UNDERRUN_MASK 0x1
281 #define TX_PKT_STATUS_UNDERRUN_SHIFT 27
282 #define TX_PKT_STATUS_UPDATE_MASK 0x1
283 #define TX_PKT_STATUS_UPDATE_SHIFT 31
285 struct rx_pkt_status
{
286 unsigned pkt_size
:11; /* packet size, max 2047 bytes */
287 unsigned:5; /* reserved */
288 unsigned ok
:1; /* current packet received ok without error */
289 unsigned bcast
:1; /* current packet is broadcast */
290 unsigned mcast
:1; /* current packet is multicast */
293 unsigned crc
:1; /* received a packet with crc error */
294 unsigned code
:1; /* received a packet with code error */
295 unsigned runt
:1; /* received a packet less than 64 bytes
297 unsigned frag
:1; /* received a packet less than 64 bytes
299 unsigned trunc
:1; /* current frame truncated due to rxram full */
300 unsigned align
:1; /* this packet is alignment error */
301 unsigned vlan
:1; /* this packet has vlan */
302 unsigned:3; /* reserved */
304 unsigned short vtag
; /* vlan tag */
307 /* FIXME: replace above bitfields with MASK/SHIFT defines below */
308 #define RX_PKT_STATUS_SIZE_MASK 0x7FF
309 #define RX_PKT_STATUS_SIZE_SHIFT 0
310 #define RX_PKT_STATUS_OK_MASK 0x1
311 #define RX_PKT_STATUS_OK_SHIFT 16
312 #define RX_PKT_STATUS_BCAST_MASK 0x1
313 #define RX_PKT_STATUS_BCAST_SHIFT 17
314 #define RX_PKT_STATUS_MCAST_MASK 0x1
315 #define RX_PKT_STATUS_MCAST_SHIFT 18
316 #define RX_PKT_STATUS_PAUSE_MASK 0x1
317 #define RX_PKT_STATUS_PAUSE_SHIFT 19
318 #define RX_PKT_STATUS_CTRL_MASK 0x1
319 #define RX_PKT_STATUS_CTRL_SHIFT 20
320 #define RX_PKT_STATUS_CRC_MASK 0x1
321 #define RX_PKT_STATUS_CRC_SHIFT 21
322 #define RX_PKT_STATUS_CODE_MASK 0x1
323 #define RX_PKT_STATUS_CODE_SHIFT 22
324 #define RX_PKT_STATUS_RUNT_MASK 0x1
325 #define RX_PKT_STATUS_RUNT_SHIFT 23
326 #define RX_PKT_STATUS_FRAG_MASK 0x1
327 #define RX_PKT_STATUS_FRAG_SHIFT 24
328 #define RX_PKT_STATUS_TRUNK_MASK 0x1
329 #define RX_PKT_STATUS_TRUNK_SHIFT 25
330 #define RX_PKT_STATUS_ALIGN_MASK 0x1
331 #define RX_PKT_STATUS_ALIGN_SHIFT 26
332 #define RX_PKT_STATUS_VLAN_MASK 0x1
333 #define RX_PKT_STATUS_VLAN_SHIFT 27
334 #define RX_PKT_STATUS_UPDATE_MASK 0x1
335 #define RX_PKT_STATUS_UPDATE_SHIFT 31
336 #define RX_PKT_STATUS_VLAN_TAG_MASK 0xFFFF
337 #define RX_PKT_STATUS_VLAN_TAG_SHIFT 32
340 struct rx_pkt_status status
;
341 unsigned char packet
[1536-sizeof(struct rx_pkt_status
)];
344 enum atl2_speed_duplex
{
351 struct atl2_spi_flash_dev
{
352 const char *manu_name
; /* manufacturer id */
365 /* Structure containing variables used by the shared code (atl2_hw.c) */
371 u8 max_retry
; /* Retransmission maximum, afterwards the
372 * packet will be discarded. */
373 u8 jam_ipg
; /* IPG to start JAM for collision based flow
374 * control in half-duplex mode. In unit of
376 u8 ipgt
; /* Desired back to back inter-packet gap. The
377 * default is 96-bit time. */
378 u8 min_ifg
; /* Minimum number of IFG to enforce in between
379 * RX frames. Frame gap below such IFP is
381 u8 ipgr1
; /* 64bit Carrier-Sense window */
382 u8 ipgr2
; /* 96-bit IPG window */
383 u8 retry_buf
; /* When half-duplex mode, should hold some
384 * bytes for mac retry . (8*4bytes unit) */
388 u16 lcol
; /* Collision Window */
392 u16 autoneg_advertised
;
395 u16 mii_autoneg_adv_reg
;
408 u16 subsystem_vendor_id
;
415 u8 mac_addr
[ETH_ALEN
];
416 u8 perm_mac_addr
[ETH_ALEN
];
419 /* bool phy_preamble_sup; */
423 #endif /* _ATL2_HW_H_ */
425 struct atl2_ring_header
{
426 /* pointer to the descriptor ring memory */
428 /* physical address of the descriptor ring */
430 /* length of descriptor ring in bytes */
434 /* board specific private data structure */
435 struct atl2_adapter
{
436 /* OS defined structs */
437 struct net_device
*netdev
;
438 struct pci_dev
*pdev
;
443 spinlock_t stats_lock
;
445 struct work_struct reset_task
;
446 struct work_struct link_chg_task
;
447 struct timer_list watchdog_timer
;
448 struct timer_list phy_config_timer
;
450 unsigned long cfg_phy
;
453 /* All Descriptor memory */
458 struct tx_pkt_header
*txd_ring
;
461 struct tx_pkt_status
*txs_ring
;
464 struct rx_desc
*rxd_ring
;
467 u32 txd_ring_size
; /* bytes per unit */
468 u32 txs_ring_size
; /* dwords per unit */
469 u32 rxd_ring_size
; /* 1536 bytes per unit */
471 /* read /write ptr: */
478 atomic_t txd_read_ptr
;
479 atomic_t txs_write_ptr
;
482 /* Interrupt Moderator timer ( 2us resolution) */
484 /* Interrupt Clear timer (2us resolution) */
488 /* structs defined in atl2_hw.h */
489 u32 bd_number
; /* board number */
496 /* u32 regs_buff[ATL2_REGS_LEN]; */
508 #endif /* _ATL2_H_ */