2 * drivers/net/ibm_newemac/core.h
4 * Driver for PowerPC 4xx on-chip ethernet controller.
6 * Copyright 2007 Benjamin Herrenschmidt, IBM Corp.
7 * <benh@kernel.crashing.org>
9 * Based on the arch/ppc version of the driver:
11 * Copyright (c) 2004, 2005 Zultys Technologies.
12 * Eugene Surovegin <eugene.surovegin@zultys.com> or <ebs@ebshome.net>
14 * Based on original work by
15 * Armin Kuster <akuster@mvista.com>
16 * Johnnie Peters <jpeters@mvista.com>
17 * Copyright 2000, 2001 MontaVista Softare Inc.
19 * This program is free software; you can redistribute it and/or modify it
20 * under the terms of the GNU General Public License as published by the
21 * Free Software Foundation; either version 2 of the License, or (at your
22 * option) any later version.
25 #ifndef __IBM_NEWEMAC_CORE_H
26 #define __IBM_NEWEMAC_CORE_H
28 #include <linux/module.h>
29 #include <linux/init.h>
30 #include <linux/list.h>
31 #include <linux/kernel.h>
32 #include <linux/interrupt.h>
33 #include <linux/netdevice.h>
34 #include <linux/dma-mapping.h>
35 #include <linux/spinlock.h>
36 #include <linux/of_platform.h>
37 #include <linux/slab.h>
50 #define NUM_TX_BUFF CONFIG_IBM_NEW_EMAC_TXB
51 #define NUM_RX_BUFF CONFIG_IBM_NEW_EMAC_RXB
53 /* Simple sanity check */
54 #if NUM_TX_BUFF > 256 || NUM_RX_BUFF > 256
55 #error Invalid number of buffer descriptors (greater than 256)
58 #define EMAC_MIN_MTU 46
60 /* Maximum L2 header length (VLAN tagged, no FCS) */
61 #define EMAC_MTU_OVERHEAD (6 * 2 + 2 + 4)
63 /* RX BD size for the given MTU */
64 static inline int emac_rx_size(int mtu)
66 if (mtu > ETH_DATA_LEN)
67 return MAL_MAX_RX_SIZE;
69 return mal_rx_size(ETH_DATA_LEN + EMAC_MTU_OVERHEAD);
72 #define EMAC_DMA_ALIGN(x) ALIGN((x), dma_get_cache_alignment())
74 #define EMAC_RX_SKB_HEADROOM \
75 EMAC_DMA_ALIGN(CONFIG_IBM_NEW_EMAC_RX_SKB_HEADROOM)
77 /* Size of RX skb for the given MTU */
78 static inline int emac_rx_skb_size(int mtu)
80 int size = max(mtu + EMAC_MTU_OVERHEAD, emac_rx_size(mtu));
81 return EMAC_DMA_ALIGN(size + 2) + EMAC_RX_SKB_HEADROOM;
84 /* RX DMA sync size */
85 static inline int emac_rx_sync_size(int mtu)
87 return EMAC_DMA_ALIGN(emac_rx_size(mtu) + 2);
90 /* Driver statistcs is split into two parts to make it more cache friendly:
91 * - normal statistics (packet count, etc)
94 * When statistics is requested by ethtool, these parts are concatenated,
95 * normal one goes first.
97 * Please, keep these structures in sync with emac_stats_keys.
100 /* Normal TX/RX Statistics */
110 /* Error statistics */
111 struct emac_error_stats {
114 /* Software RX Errors */
115 u64 rx_dropped_stack;
117 u64 rx_dropped_error;
118 u64 rx_dropped_resize;
121 /* BD reported RX errors */
124 u64 rx_bd_bad_packet;
125 u64 rx_bd_runt_packet;
126 u64 rx_bd_short_event;
127 u64 rx_bd_alignment_error;
129 u64 rx_bd_packet_too_long;
130 u64 rx_bd_out_of_range;
132 /* EMAC IRQ reported RX errors */
139 u64 rx_alignment_error;
141 u64 rx_packet_too_long;
145 /* Software TX Errors */
147 /* BD reported TX errors */
150 u64 tx_bd_carrier_loss;
151 u64 tx_bd_excessive_deferral;
152 u64 tx_bd_excessive_collisions;
153 u64 tx_bd_late_collision;
154 u64 tx_bd_multple_collisions;
155 u64 tx_bd_single_collision;
158 /* EMAC IRQ reported TX errors */
165 #define EMAC_ETHTOOL_STATS_COUNT ((sizeof(struct emac_stats) + \
166 sizeof(struct emac_error_stats)) \
169 struct emac_instance {
170 struct net_device *ndev;
171 struct resource rsrc_regs;
172 struct emac_regs __iomem *emacp;
173 struct platform_device *ofdev;
174 struct device_node **blist; /* bootlist entry */
178 struct platform_device *mal_dev;
181 struct mal_instance *mal;
182 struct mal_commac commac;
190 struct mutex link_lock;
191 struct delayed_work link_work;
197 /* Shared MDIO if any */
199 struct platform_device *mdio_dev;
200 struct emac_instance *mdio_instance;
201 struct mutex mdio_lock;
203 /* ZMII infos if any */
206 struct platform_device *zmii_dev;
208 /* RGMII infos if any */
211 struct platform_device *rgmii_dev;
213 /* TAH infos if any */
216 struct platform_device *tah_dev;
222 /* OPB bus frequency in Mhz */
225 /* Cell index within an ASIC (for clk mgmnt) */
228 /* Max supported MTU */
231 /* Feature bits (from probe table) */
232 unsigned int features;
234 /* Tx and Rx fifo sizes & other infos in bytes */
236 u32 tx_fifo_size_gige;
238 u32 rx_fifo_size_gige;
240 u32 mal_burst_size; /* move to MAL ? */
242 /* IAHT and GAHT filter parameterization */
243 u32 xaht_slots_shift;
244 u32 xaht_width_shift;
246 /* Descriptor management
248 struct mal_descriptor *tx_desc;
253 struct mal_descriptor *rx_desc;
255 struct sk_buff *rx_sg_skb; /* 1 */
259 struct sk_buff *tx_skb[NUM_TX_BUFF];
260 struct sk_buff *rx_skb[NUM_RX_BUFF];
264 struct emac_error_stats estats;
265 struct net_device_stats nstats;
266 struct emac_stats stats;
271 int stop_timeout; /* in us */
275 struct work_struct reset_work;
280 * Features of various EMAC implementations
284 * No flow control on 40x according to the original driver
286 #define EMAC_FTR_NO_FLOW_CONTROL_40x 0x00000001
290 #define EMAC_FTR_EMAC4 0x00000002
292 * For the 440SPe, AMCC inexplicably changed the polarity of
293 * the "operation complete" bit in the MII control register.
295 #define EMAC_FTR_STACR_OC_INVERT 0x00000004
297 * Set if we have a TAH.
299 #define EMAC_FTR_HAS_TAH 0x00000008
301 * Set if we have a ZMII.
303 #define EMAC_FTR_HAS_ZMII 0x00000010
305 * Set if we have a RGMII.
307 #define EMAC_FTR_HAS_RGMII 0x00000020
309 * Set if we have new type STACR with STAOPC
311 #define EMAC_FTR_HAS_NEW_STACR 0x00000040
313 * Set if we need phy clock workaround for 440gx
315 #define EMAC_FTR_440GX_PHY_CLK_FIX 0x00000080
317 * Set if we need phy clock workaround for 440ep or 440gr
319 #define EMAC_FTR_440EP_PHY_CLK_FIX 0x00000100
321 * The 405EX and 460EX contain the EMAC4SYNC core
323 #define EMAC_FTR_EMAC4SYNC 0x00000200
325 * Set if we need phy clock workaround for 460ex or 460gt
327 #define EMAC_FTR_460EX_PHY_CLK_FIX 0x00000400
330 /* Right now, we don't quite handle the always/possible masks on the
331 * most optimal way as we don't have a way to say something like
332 * always EMAC4. Patches welcome.
335 EMAC_FTRS_ALWAYS = 0,
338 #ifdef CONFIG_IBM_NEW_EMAC_EMAC4
339 EMAC_FTR_EMAC4 | EMAC_FTR_EMAC4SYNC |
340 EMAC_FTR_HAS_NEW_STACR |
341 EMAC_FTR_STACR_OC_INVERT | EMAC_FTR_440GX_PHY_CLK_FIX |
343 #ifdef CONFIG_IBM_NEW_EMAC_TAH
346 #ifdef CONFIG_IBM_NEW_EMAC_ZMII
349 #ifdef CONFIG_IBM_NEW_EMAC_RGMII
352 #ifdef CONFIG_IBM_NEW_EMAC_NO_FLOW_CTRL
353 EMAC_FTR_NO_FLOW_CONTROL_40x |
355 EMAC_FTR_460EX_PHY_CLK_FIX |
356 EMAC_FTR_440EP_PHY_CLK_FIX,
359 static inline int emac_has_feature(struct emac_instance *dev,
360 unsigned long feature)
362 return (EMAC_FTRS_ALWAYS & feature) ||
363 (EMAC_FTRS_POSSIBLE & dev->features & feature);
367 * Various instances of the EMAC core have varying 1) number of
368 * address match slots, 2) width of the registers for handling address
369 * match slots, 3) number of registers for handling address match
370 * slots and 4) base offset for those registers.
372 * These macros and inlines handle these differences based on
373 * parameters supplied by the device structure which are, in turn,
374 * initialized based on the "compatible" entry in the device tree.
377 #define EMAC4_XAHT_SLOTS_SHIFT 6
378 #define EMAC4_XAHT_WIDTH_SHIFT 4
380 #define EMAC4SYNC_XAHT_SLOTS_SHIFT 8
381 #define EMAC4SYNC_XAHT_WIDTH_SHIFT 5
383 #define EMAC_XAHT_SLOTS(dev) (1 << (dev)->xaht_slots_shift)
384 #define EMAC_XAHT_WIDTH(dev) (1 << (dev)->xaht_width_shift)
385 #define EMAC_XAHT_REGS(dev) (1 << ((dev)->xaht_slots_shift - \
386 (dev)->xaht_width_shift))
388 #define EMAC_XAHT_CRC_TO_SLOT(dev, crc) \
389 ((EMAC_XAHT_SLOTS(dev) - 1) - \
390 ((crc) >> ((sizeof (u32) * BITS_PER_BYTE) - \
391 (dev)->xaht_slots_shift)))
393 #define EMAC_XAHT_SLOT_TO_REG(dev, slot) \
394 ((slot) >> (dev)->xaht_width_shift)
396 #define EMAC_XAHT_SLOT_TO_MASK(dev, slot) \
397 ((u32)(1 << (EMAC_XAHT_WIDTH(dev) - 1)) >> \
398 ((slot) & (u32)(EMAC_XAHT_WIDTH(dev) - 1)))
400 static inline u32 *emac_xaht_base(struct emac_instance *dev)
402 struct emac_regs __iomem *p = dev->emacp;
405 /* The first IAHT entry always is the base of the block of
406 * IAHT and GAHT registers.
408 if (emac_has_feature(dev, EMAC_FTR_EMAC4SYNC))
409 offset = offsetof(struct emac_regs, u1.emac4sync.iaht1);
411 offset = offsetof(struct emac_regs, u0.emac4.iaht1);
413 return (u32 *)((ptrdiff_t)p + offset);
416 static inline u32 *emac_gaht_base(struct emac_instance *dev)
418 /* GAHT registers always come after an identical number of
421 return emac_xaht_base(dev) + EMAC_XAHT_REGS(dev);
424 static inline u32 *emac_iaht_base(struct emac_instance *dev)
426 /* IAHT registers always come before an identical number of
429 return emac_xaht_base(dev);
432 /* Ethtool get_regs complex data.
433 * We want to get not just EMAC registers, but also MAL, ZMII, RGMII, TAH
436 * Returned BLOB consists of the ibm_emac_ethtool_regs_hdr,
437 * MAL registers, EMAC registers and optional ZMII, RGMII, TAH registers.
438 * Each register component is preceded with emac_ethtool_regs_subhdr.
439 * Order of the optional headers follows their relative bit posititions
440 * in emac_ethtool_regs_hdr.components
442 #define EMAC_ETHTOOL_REGS_ZMII 0x00000001
443 #define EMAC_ETHTOOL_REGS_RGMII 0x00000002
444 #define EMAC_ETHTOOL_REGS_TAH 0x00000004
446 struct emac_ethtool_regs_hdr {
450 struct emac_ethtool_regs_subhdr {
455 #define EMAC_ETHTOOL_REGS_VER 0
456 #define EMAC_ETHTOOL_REGS_SIZE(dev) ((dev)->rsrc_regs.end - \
457 (dev)->rsrc_regs.start + 1)
458 #define EMAC4_ETHTOOL_REGS_VER 1
459 #define EMAC4_ETHTOOL_REGS_SIZE(dev) ((dev)->rsrc_regs.end - \
460 (dev)->rsrc_regs.start + 1)
462 #endif /* __IBM_NEWEMAC_CORE_H */