Loading...
1/*
2 * drivers/net/ethernet/ibm/emac/core.h
3 *
4 * Driver for PowerPC 4xx on-chip ethernet controller.
5 *
6 * Copyright 2007 Benjamin Herrenschmidt, IBM Corp.
7 * <benh@kernel.crashing.org>
8 *
9 * Based on the arch/ppc version of the driver:
10 *
11 * Copyright (c) 2004, 2005 Zultys Technologies.
12 * Eugene Surovegin <eugene.surovegin@zultys.com> or <ebs@ebshome.net>
13 *
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.
18 *
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.
23 *
24 */
25#ifndef __IBM_NEWEMAC_CORE_H
26#define __IBM_NEWEMAC_CORE_H
27
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>
38
39#include <asm/io.h>
40#include <asm/dcr.h>
41
42#include "emac.h"
43#include "phy.h"
44#include "zmii.h"
45#include "rgmii.h"
46#include "mal.h"
47#include "tah.h"
48#include "debug.h"
49
50#define NUM_TX_BUFF CONFIG_IBM_EMAC_TXB
51#define NUM_RX_BUFF CONFIG_IBM_EMAC_RXB
52
53/* Simple sanity check */
54#if NUM_TX_BUFF > 256 || NUM_RX_BUFF > 256
55#error Invalid number of buffer descriptors (greater than 256)
56#endif
57
58#define EMAC_MIN_MTU 46
59
60/* Maximum L2 header length (VLAN tagged, no FCS) */
61#define EMAC_MTU_OVERHEAD (6 * 2 + 2 + 4)
62
63/* RX BD size for the given MTU */
64static inline int emac_rx_size(int mtu)
65{
66 if (mtu > ETH_DATA_LEN)
67 return MAL_MAX_RX_SIZE;
68 else
69 return mal_rx_size(ETH_DATA_LEN + EMAC_MTU_OVERHEAD);
70}
71
72#define EMAC_DMA_ALIGN(x) ALIGN((x), dma_get_cache_alignment())
73
74#define EMAC_RX_SKB_HEADROOM \
75 EMAC_DMA_ALIGN(CONFIG_IBM_EMAC_RX_SKB_HEADROOM)
76
77/* Size of RX skb for the given MTU */
78static inline int emac_rx_skb_size(int mtu)
79{
80 int size = max(mtu + EMAC_MTU_OVERHEAD, emac_rx_size(mtu));
81 return EMAC_DMA_ALIGN(size + 2) + EMAC_RX_SKB_HEADROOM;
82}
83
84/* RX DMA sync size */
85static inline int emac_rx_sync_size(int mtu)
86{
87 return EMAC_DMA_ALIGN(emac_rx_size(mtu) + 2);
88}
89
90/* Driver statistcs is split into two parts to make it more cache friendly:
91 * - normal statistics (packet count, etc)
92 * - error statistics
93 *
94 * When statistics is requested by ethtool, these parts are concatenated,
95 * normal one goes first.
96 *
97 * Please, keep these structures in sync with emac_stats_keys.
98 */
99
100/* Normal TX/RX Statistics */
101struct emac_stats {
102 u64 rx_packets;
103 u64 rx_bytes;
104 u64 tx_packets;
105 u64 tx_bytes;
106 u64 rx_packets_csum;
107 u64 tx_packets_csum;
108};
109
110/* Error statistics */
111struct emac_error_stats {
112 u64 tx_undo;
113
114 /* Software RX Errors */
115 u64 rx_dropped_stack;
116 u64 rx_dropped_oom;
117 u64 rx_dropped_error;
118 u64 rx_dropped_resize;
119 u64 rx_dropped_mtu;
120 u64 rx_stopped;
121 /* BD reported RX errors */
122 u64 rx_bd_errors;
123 u64 rx_bd_overrun;
124 u64 rx_bd_bad_packet;
125 u64 rx_bd_runt_packet;
126 u64 rx_bd_short_event;
127 u64 rx_bd_alignment_error;
128 u64 rx_bd_bad_fcs;
129 u64 rx_bd_packet_too_long;
130 u64 rx_bd_out_of_range;
131 u64 rx_bd_in_range;
132 /* EMAC IRQ reported RX errors */
133 u64 rx_parity;
134 u64 rx_fifo_overrun;
135 u64 rx_overrun;
136 u64 rx_bad_packet;
137 u64 rx_runt_packet;
138 u64 rx_short_event;
139 u64 rx_alignment_error;
140 u64 rx_bad_fcs;
141 u64 rx_packet_too_long;
142 u64 rx_out_of_range;
143 u64 rx_in_range;
144
145 /* Software TX Errors */
146 u64 tx_dropped;
147 /* BD reported TX errors */
148 u64 tx_bd_errors;
149 u64 tx_bd_bad_fcs;
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;
156 u64 tx_bd_underrun;
157 u64 tx_bd_sqe;
158 /* EMAC IRQ reported TX errors */
159 u64 tx_parity;
160 u64 tx_underrun;
161 u64 tx_sqe;
162 u64 tx_errors;
163};
164
165#define EMAC_ETHTOOL_STATS_COUNT ((sizeof(struct emac_stats) + \
166 sizeof(struct emac_error_stats)) \
167 / sizeof(u64))
168
169struct 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 */
175
176 /* MAL linkage */
177 u32 mal_ph;
178 struct platform_device *mal_dev;
179 u32 mal_rx_chan;
180 u32 mal_tx_chan;
181 struct mal_instance *mal;
182 struct mal_commac commac;
183
184 /* PHY infos */
185 u32 phy_mode;
186 u32 phy_map;
187 u32 phy_address;
188 u32 phy_feat_exc;
189 struct mii_phy phy;
190 struct mutex link_lock;
191 struct delayed_work link_work;
192 int link_polling;
193
194 /* GPCS PHY infos */
195 u32 gpcs_address;
196
197 /* Shared MDIO if any */
198 u32 mdio_ph;
199 struct platform_device *mdio_dev;
200 struct emac_instance *mdio_instance;
201 struct mutex mdio_lock;
202
203 /* ZMII infos if any */
204 u32 zmii_ph;
205 u32 zmii_port;
206 struct platform_device *zmii_dev;
207
208 /* RGMII infos if any */
209 u32 rgmii_ph;
210 u32 rgmii_port;
211 struct platform_device *rgmii_dev;
212
213 /* TAH infos if any */
214 u32 tah_ph;
215 u32 tah_port;
216 struct platform_device *tah_dev;
217
218 /* IRQs */
219 int wol_irq;
220 int emac_irq;
221
222 /* OPB bus frequency in Mhz */
223 u32 opb_bus_freq;
224
225 /* Cell index within an ASIC (for clk mgmnt) */
226 u32 cell_index;
227
228 /* Max supported MTU */
229 u32 max_mtu;
230
231 /* Feature bits (from probe table) */
232 unsigned int features;
233
234 /* Tx and Rx fifo sizes & other infos in bytes */
235 u32 tx_fifo_size;
236 u32 tx_fifo_size_gige;
237 u32 rx_fifo_size;
238 u32 rx_fifo_size_gige;
239 u32 fifo_entry_size;
240 u32 mal_burst_size; /* move to MAL ? */
241
242 /* IAHT and GAHT filter parameterization */
243 u32 xaht_slots_shift;
244 u32 xaht_width_shift;
245
246 /* Descriptor management
247 */
248 struct mal_descriptor *tx_desc;
249 int tx_cnt;
250 int tx_slot;
251 int ack_slot;
252
253 struct mal_descriptor *rx_desc;
254 int rx_slot;
255 struct sk_buff *rx_sg_skb; /* 1 */
256 int rx_skb_size;
257 int rx_sync_size;
258
259 struct sk_buff *tx_skb[NUM_TX_BUFF];
260 struct sk_buff *rx_skb[NUM_RX_BUFF];
261
262 /* Stats
263 */
264 struct emac_error_stats estats;
265 struct net_device_stats nstats;
266 struct emac_stats stats;
267
268 /* Misc
269 */
270 int reset_failed;
271 int stop_timeout; /* in us */
272 int no_mcast;
273 int mcast_pending;
274 int opened;
275 struct work_struct reset_work;
276 spinlock_t lock;
277};
278
279/*
280 * Features of various EMAC implementations
281 */
282
283/*
284 * No flow control on 40x according to the original driver
285 */
286#define EMAC_FTR_NO_FLOW_CONTROL_40x 0x00000001
287/*
288 * Cell is an EMAC4
289 */
290#define EMAC_FTR_EMAC4 0x00000002
291/*
292 * For the 440SPe, AMCC inexplicably changed the polarity of
293 * the "operation complete" bit in the MII control register.
294 */
295#define EMAC_FTR_STACR_OC_INVERT 0x00000004
296/*
297 * Set if we have a TAH.
298 */
299#define EMAC_FTR_HAS_TAH 0x00000008
300/*
301 * Set if we have a ZMII.
302 */
303#define EMAC_FTR_HAS_ZMII 0x00000010
304/*
305 * Set if we have a RGMII.
306 */
307#define EMAC_FTR_HAS_RGMII 0x00000020
308/*
309 * Set if we have new type STACR with STAOPC
310 */
311#define EMAC_FTR_HAS_NEW_STACR 0x00000040
312/*
313 * Set if we need phy clock workaround for 440gx
314 */
315#define EMAC_FTR_440GX_PHY_CLK_FIX 0x00000080
316/*
317 * Set if we need phy clock workaround for 440ep or 440gr
318 */
319#define EMAC_FTR_440EP_PHY_CLK_FIX 0x00000100
320/*
321 * The 405EX and 460EX contain the EMAC4SYNC core
322 */
323#define EMAC_FTR_EMAC4SYNC 0x00000200
324/*
325 * Set if we need phy clock workaround for 460ex or 460gt
326 */
327#define EMAC_FTR_460EX_PHY_CLK_FIX 0x00000400
328/*
329 * APM821xx requires Jumbo frame size set explicitly
330 */
331#define EMAC_APM821XX_REQ_JUMBO_FRAME_SIZE 0x00000800
332/*
333 * APM821xx does not support Half Duplex mode
334 */
335#define EMAC_FTR_APM821XX_NO_HALF_DUPLEX 0x00001000
336
337/* Right now, we don't quite handle the always/possible masks on the
338 * most optimal way as we don't have a way to say something like
339 * always EMAC4. Patches welcome.
340 */
341enum {
342 EMAC_FTRS_ALWAYS = 0,
343
344 EMAC_FTRS_POSSIBLE =
345#ifdef CONFIG_IBM_EMAC_EMAC4
346 EMAC_FTR_EMAC4 | EMAC_FTR_EMAC4SYNC |
347 EMAC_FTR_HAS_NEW_STACR |
348 EMAC_FTR_STACR_OC_INVERT | EMAC_FTR_440GX_PHY_CLK_FIX |
349#endif
350#ifdef CONFIG_IBM_EMAC_TAH
351 EMAC_FTR_HAS_TAH |
352#endif
353#ifdef CONFIG_IBM_EMAC_ZMII
354 EMAC_FTR_HAS_ZMII |
355#endif
356#ifdef CONFIG_IBM_EMAC_RGMII
357 EMAC_FTR_HAS_RGMII |
358#endif
359#ifdef CONFIG_IBM_EMAC_NO_FLOW_CTRL
360 EMAC_FTR_NO_FLOW_CONTROL_40x |
361#endif
362 EMAC_FTR_460EX_PHY_CLK_FIX |
363 EMAC_FTR_440EP_PHY_CLK_FIX |
364 EMAC_APM821XX_REQ_JUMBO_FRAME_SIZE |
365 EMAC_FTR_APM821XX_NO_HALF_DUPLEX,
366};
367
368static inline int emac_has_feature(struct emac_instance *dev,
369 unsigned long feature)
370{
371 return (EMAC_FTRS_ALWAYS & feature) ||
372 (EMAC_FTRS_POSSIBLE & dev->features & feature);
373}
374
375/*
376 * Various instances of the EMAC core have varying 1) number of
377 * address match slots, 2) width of the registers for handling address
378 * match slots, 3) number of registers for handling address match
379 * slots and 4) base offset for those registers.
380 *
381 * These macros and inlines handle these differences based on
382 * parameters supplied by the device structure which are, in turn,
383 * initialized based on the "compatible" entry in the device tree.
384 */
385
386#define EMAC4_XAHT_SLOTS_SHIFT 6
387#define EMAC4_XAHT_WIDTH_SHIFT 4
388
389#define EMAC4SYNC_XAHT_SLOTS_SHIFT 8
390#define EMAC4SYNC_XAHT_WIDTH_SHIFT 5
391
392#define EMAC_XAHT_SLOTS(dev) (1 << (dev)->xaht_slots_shift)
393#define EMAC_XAHT_WIDTH(dev) (1 << (dev)->xaht_width_shift)
394#define EMAC_XAHT_REGS(dev) (1 << ((dev)->xaht_slots_shift - \
395 (dev)->xaht_width_shift))
396
397#define EMAC_XAHT_CRC_TO_SLOT(dev, crc) \
398 ((EMAC_XAHT_SLOTS(dev) - 1) - \
399 ((crc) >> ((sizeof (u32) * BITS_PER_BYTE) - \
400 (dev)->xaht_slots_shift)))
401
402#define EMAC_XAHT_SLOT_TO_REG(dev, slot) \
403 ((slot) >> (dev)->xaht_width_shift)
404
405#define EMAC_XAHT_SLOT_TO_MASK(dev, slot) \
406 ((u32)(1 << (EMAC_XAHT_WIDTH(dev) - 1)) >> \
407 ((slot) & (u32)(EMAC_XAHT_WIDTH(dev) - 1)))
408
409static inline u32 *emac_xaht_base(struct emac_instance *dev)
410{
411 struct emac_regs __iomem *p = dev->emacp;
412 int offset;
413
414 /* The first IAHT entry always is the base of the block of
415 * IAHT and GAHT registers.
416 */
417 if (emac_has_feature(dev, EMAC_FTR_EMAC4SYNC))
418 offset = offsetof(struct emac_regs, u1.emac4sync.iaht1);
419 else
420 offset = offsetof(struct emac_regs, u0.emac4.iaht1);
421
422 return (u32 *)((ptrdiff_t)p + offset);
423}
424
425static inline u32 *emac_gaht_base(struct emac_instance *dev)
426{
427 /* GAHT registers always come after an identical number of
428 * IAHT registers.
429 */
430 return emac_xaht_base(dev) + EMAC_XAHT_REGS(dev);
431}
432
433static inline u32 *emac_iaht_base(struct emac_instance *dev)
434{
435 /* IAHT registers always come before an identical number of
436 * GAHT registers.
437 */
438 return emac_xaht_base(dev);
439}
440
441/* Ethtool get_regs complex data.
442 * We want to get not just EMAC registers, but also MAL, ZMII, RGMII, TAH
443 * when available.
444 *
445 * Returned BLOB consists of the ibm_emac_ethtool_regs_hdr,
446 * MAL registers, EMAC registers and optional ZMII, RGMII, TAH registers.
447 * Each register component is preceded with emac_ethtool_regs_subhdr.
448 * Order of the optional headers follows their relative bit posititions
449 * in emac_ethtool_regs_hdr.components
450 */
451#define EMAC_ETHTOOL_REGS_ZMII 0x00000001
452#define EMAC_ETHTOOL_REGS_RGMII 0x00000002
453#define EMAC_ETHTOOL_REGS_TAH 0x00000004
454
455struct emac_ethtool_regs_hdr {
456 u32 components;
457};
458
459struct emac_ethtool_regs_subhdr {
460 u32 version;
461 u32 index;
462};
463
464#define EMAC_ETHTOOL_REGS_VER 0
465#define EMAC_ETHTOOL_REGS_SIZE(dev) ((dev)->rsrc_regs.end - \
466 (dev)->rsrc_regs.start + 1)
467#define EMAC4_ETHTOOL_REGS_VER 1
468#define EMAC4_ETHTOOL_REGS_SIZE(dev) ((dev)->rsrc_regs.end - \
469 (dev)->rsrc_regs.start + 1)
470
471#endif /* __IBM_NEWEMAC_CORE_H */
1/* SPDX-License-Identifier: GPL-2.0-or-later */
2/*
3 * drivers/net/ethernet/ibm/emac/core.h
4 *
5 * Driver for PowerPC 4xx on-chip ethernet controller.
6 *
7 * Copyright 2007 Benjamin Herrenschmidt, IBM Corp.
8 * <benh@kernel.crashing.org>
9 *
10 * Based on the arch/ppc version of the driver:
11 *
12 * Copyright (c) 2004, 2005 Zultys Technologies.
13 * Eugene Surovegin <eugene.surovegin@zultys.com> or <ebs@ebshome.net>
14 *
15 * Based on original work by
16 * Armin Kuster <akuster@mvista.com>
17 * Johnnie Peters <jpeters@mvista.com>
18 * Copyright 2000, 2001 MontaVista Softare Inc.
19 */
20#ifndef __IBM_NEWEMAC_CORE_H
21#define __IBM_NEWEMAC_CORE_H
22
23#include <linux/module.h>
24#include <linux/list.h>
25#include <linux/kernel.h>
26#include <linux/interrupt.h>
27#include <linux/netdevice.h>
28#include <linux/dma-mapping.h>
29#include <linux/spinlock.h>
30#include <linux/slab.h>
31
32#include <asm/io.h>
33#include <asm/dcr.h>
34
35#include "emac.h"
36#include "phy.h"
37#include "zmii.h"
38#include "rgmii.h"
39#include "mal.h"
40#include "tah.h"
41#include "debug.h"
42
43#define NUM_TX_BUFF CONFIG_IBM_EMAC_TXB
44#define NUM_RX_BUFF CONFIG_IBM_EMAC_RXB
45
46/* Simple sanity check */
47#if NUM_TX_BUFF > 256 || NUM_RX_BUFF > 256
48#error Invalid number of buffer descriptors (greater than 256)
49#endif
50
51#define EMAC_MIN_MTU 46
52
53/* Maximum L2 header length (VLAN tagged, no FCS) */
54#define EMAC_MTU_OVERHEAD (6 * 2 + 2 + 4)
55
56/* RX BD size for the given MTU */
57static inline int emac_rx_size(int mtu)
58{
59 if (mtu > ETH_DATA_LEN)
60 return MAL_MAX_RX_SIZE;
61 else
62 return mal_rx_size(ETH_DATA_LEN + EMAC_MTU_OVERHEAD);
63}
64
65/* Size of RX skb for the given MTU */
66static inline int emac_rx_skb_size(int mtu)
67{
68 int size = max(mtu + EMAC_MTU_OVERHEAD, emac_rx_size(mtu));
69
70 return SKB_DATA_ALIGN(size + NET_IP_ALIGN) + NET_SKB_PAD;
71}
72
73/* RX DMA sync size */
74static inline int emac_rx_sync_size(int mtu)
75{
76 return SKB_DATA_ALIGN(emac_rx_size(mtu) + NET_IP_ALIGN);
77}
78
79/* Driver statistcs is split into two parts to make it more cache friendly:
80 * - normal statistics (packet count, etc)
81 * - error statistics
82 *
83 * When statistics is requested by ethtool, these parts are concatenated,
84 * normal one goes first.
85 *
86 * Please, keep these structures in sync with emac_stats_keys.
87 */
88
89/* Normal TX/RX Statistics */
90struct emac_stats {
91 u64 rx_packets;
92 u64 rx_bytes;
93 u64 tx_packets;
94 u64 tx_bytes;
95 u64 rx_packets_csum;
96 u64 tx_packets_csum;
97};
98
99/* Error statistics */
100struct emac_error_stats {
101 u64 tx_undo;
102
103 /* Software RX Errors */
104 u64 rx_dropped_stack;
105 u64 rx_dropped_oom;
106 u64 rx_dropped_error;
107 u64 rx_dropped_resize;
108 u64 rx_dropped_mtu;
109 u64 rx_stopped;
110 /* BD reported RX errors */
111 u64 rx_bd_errors;
112 u64 rx_bd_overrun;
113 u64 rx_bd_bad_packet;
114 u64 rx_bd_runt_packet;
115 u64 rx_bd_short_event;
116 u64 rx_bd_alignment_error;
117 u64 rx_bd_bad_fcs;
118 u64 rx_bd_packet_too_long;
119 u64 rx_bd_out_of_range;
120 u64 rx_bd_in_range;
121 /* EMAC IRQ reported RX errors */
122 u64 rx_parity;
123 u64 rx_fifo_overrun;
124 u64 rx_overrun;
125 u64 rx_bad_packet;
126 u64 rx_runt_packet;
127 u64 rx_short_event;
128 u64 rx_alignment_error;
129 u64 rx_bad_fcs;
130 u64 rx_packet_too_long;
131 u64 rx_out_of_range;
132 u64 rx_in_range;
133
134 /* Software TX Errors */
135 u64 tx_dropped;
136 /* BD reported TX errors */
137 u64 tx_bd_errors;
138 u64 tx_bd_bad_fcs;
139 u64 tx_bd_carrier_loss;
140 u64 tx_bd_excessive_deferral;
141 u64 tx_bd_excessive_collisions;
142 u64 tx_bd_late_collision;
143 u64 tx_bd_multple_collisions;
144 u64 tx_bd_single_collision;
145 u64 tx_bd_underrun;
146 u64 tx_bd_sqe;
147 /* EMAC IRQ reported TX errors */
148 u64 tx_parity;
149 u64 tx_underrun;
150 u64 tx_sqe;
151 u64 tx_errors;
152};
153
154#define EMAC_ETHTOOL_STATS_COUNT ((sizeof(struct emac_stats) + \
155 sizeof(struct emac_error_stats)) \
156 / sizeof(u64))
157
158struct emac_instance {
159 struct net_device *ndev;
160 struct emac_regs __iomem *emacp;
161 struct platform_device *ofdev;
162 struct device_node **blist; /* bootlist entry */
163
164 /* MAL linkage */
165 u32 mal_ph;
166 struct platform_device *mal_dev;
167 u32 mal_rx_chan;
168 u32 mal_tx_chan;
169 struct mal_instance *mal;
170 struct mal_commac commac;
171
172 /* PHY infos */
173 phy_interface_t phy_mode;
174 u32 phy_map;
175 u32 phy_address;
176 u32 phy_feat_exc;
177 struct mii_phy phy;
178 struct mutex link_lock;
179 struct delayed_work link_work;
180 int link_polling;
181
182 /* GPCS PHY infos */
183 u32 gpcs_address;
184
185 /* Shared MDIO if any */
186 u32 mdio_ph;
187 struct platform_device *mdio_dev;
188 struct emac_instance *mdio_instance;
189 struct mutex mdio_lock;
190
191 /* ZMII infos if any */
192 u32 zmii_ph;
193 u32 zmii_port;
194 struct platform_device *zmii_dev;
195
196 /* RGMII infos if any */
197 u32 rgmii_ph;
198 u32 rgmii_port;
199 struct platform_device *rgmii_dev;
200
201 /* TAH infos if any */
202 u32 tah_ph;
203 u32 tah_port;
204 struct platform_device *tah_dev;
205
206 /* IRQs */
207 int wol_irq;
208 int emac_irq;
209
210 /* OPB bus frequency in Mhz */
211 u32 opb_bus_freq;
212
213 /* Cell index within an ASIC (for clk mgmnt) */
214 u32 cell_index;
215
216 /* Max supported MTU */
217 u32 max_mtu;
218
219 /* Feature bits (from probe table) */
220 unsigned int features;
221
222 /* Tx and Rx fifo sizes & other infos in bytes */
223 u32 tx_fifo_size;
224 u32 tx_fifo_size_gige;
225 u32 rx_fifo_size;
226 u32 rx_fifo_size_gige;
227 u32 fifo_entry_size;
228 u32 mal_burst_size; /* move to MAL ? */
229
230 /* IAHT and GAHT filter parameterization */
231 u32 xaht_slots_shift;
232 u32 xaht_width_shift;
233
234 /* Descriptor management
235 */
236 struct mal_descriptor *tx_desc;
237 int tx_cnt;
238 int tx_slot;
239 int ack_slot;
240
241 struct mal_descriptor *rx_desc;
242 int rx_slot;
243 struct sk_buff *rx_sg_skb; /* 1 */
244 int rx_skb_size;
245 int rx_sync_size;
246
247 struct sk_buff *tx_skb[NUM_TX_BUFF];
248 struct sk_buff *rx_skb[NUM_RX_BUFF];
249
250 /* Stats
251 */
252 struct emac_error_stats estats;
253 struct emac_stats stats;
254
255 /* Misc
256 */
257 int reset_failed;
258 int stop_timeout; /* in us */
259 int no_mcast;
260 int mcast_pending;
261 int opened;
262 struct work_struct reset_work;
263 spinlock_t lock;
264};
265
266/*
267 * Features of various EMAC implementations
268 */
269
270/*
271 * No flow control on 40x according to the original driver
272 */
273#define EMAC_FTR_NO_FLOW_CONTROL_40x 0x00000001
274/*
275 * Cell is an EMAC4
276 */
277#define EMAC_FTR_EMAC4 0x00000002
278/*
279 * For the 440SPe, AMCC inexplicably changed the polarity of
280 * the "operation complete" bit in the MII control register.
281 */
282#define EMAC_FTR_STACR_OC_INVERT 0x00000004
283/*
284 * Set if we have a TAH.
285 */
286#define EMAC_FTR_HAS_TAH 0x00000008
287/*
288 * Set if we have a ZMII.
289 */
290#define EMAC_FTR_HAS_ZMII 0x00000010
291/*
292 * Set if we have a RGMII.
293 */
294#define EMAC_FTR_HAS_RGMII 0x00000020
295/*
296 * Set if we have new type STACR with STAOPC
297 */
298#define EMAC_FTR_HAS_NEW_STACR 0x00000040
299/*
300 * Set if we need phy clock workaround for 440gx
301 */
302#define EMAC_FTR_440GX_PHY_CLK_FIX 0x00000080
303/*
304 * Set if we need phy clock workaround for 440ep or 440gr
305 */
306#define EMAC_FTR_440EP_PHY_CLK_FIX 0x00000100
307/*
308 * The 405EX and 460EX contain the EMAC4SYNC core
309 */
310#define EMAC_FTR_EMAC4SYNC 0x00000200
311/*
312 * Set if we need phy clock workaround for 460ex or 460gt
313 */
314#define EMAC_FTR_460EX_PHY_CLK_FIX 0x00000400
315/*
316 * APM821xx requires Jumbo frame size set explicitly
317 */
318#define EMAC_APM821XX_REQ_JUMBO_FRAME_SIZE 0x00000800
319/*
320 * APM821xx does not support Half Duplex mode
321 */
322#define EMAC_FTR_APM821XX_NO_HALF_DUPLEX 0x00001000
323
324/* Right now, we don't quite handle the always/possible masks on the
325 * most optimal way as we don't have a way to say something like
326 * always EMAC4. Patches welcome.
327 */
328enum {
329 EMAC_FTRS_ALWAYS = 0,
330
331 EMAC_FTRS_POSSIBLE =
332#ifdef CONFIG_IBM_EMAC_EMAC4
333 EMAC_FTR_EMAC4 | EMAC_FTR_EMAC4SYNC |
334 EMAC_FTR_HAS_NEW_STACR |
335 EMAC_FTR_STACR_OC_INVERT | EMAC_FTR_440GX_PHY_CLK_FIX |
336#endif
337#ifdef CONFIG_IBM_EMAC_TAH
338 EMAC_FTR_HAS_TAH |
339#endif
340#ifdef CONFIG_IBM_EMAC_ZMII
341 EMAC_FTR_HAS_ZMII |
342#endif
343#ifdef CONFIG_IBM_EMAC_RGMII
344 EMAC_FTR_HAS_RGMII |
345#endif
346#ifdef CONFIG_IBM_EMAC_NO_FLOW_CTRL
347 EMAC_FTR_NO_FLOW_CONTROL_40x |
348#endif
349 EMAC_FTR_460EX_PHY_CLK_FIX |
350 EMAC_FTR_440EP_PHY_CLK_FIX |
351 EMAC_APM821XX_REQ_JUMBO_FRAME_SIZE |
352 EMAC_FTR_APM821XX_NO_HALF_DUPLEX,
353};
354
355static inline int emac_has_feature(struct emac_instance *dev,
356 unsigned long feature)
357{
358 return (EMAC_FTRS_ALWAYS & feature) ||
359 (EMAC_FTRS_POSSIBLE & dev->features & feature);
360}
361
362/*
363 * Various instances of the EMAC core have varying 1) number of
364 * address match slots, 2) width of the registers for handling address
365 * match slots, 3) number of registers for handling address match
366 * slots and 4) base offset for those registers.
367 *
368 * These macros and inlines handle these differences based on
369 * parameters supplied by the device structure which are, in turn,
370 * initialized based on the "compatible" entry in the device tree.
371 */
372
373#define EMAC4_XAHT_SLOTS_SHIFT 6
374#define EMAC4_XAHT_WIDTH_SHIFT 4
375
376#define EMAC4SYNC_XAHT_SLOTS_SHIFT 8
377#define EMAC4SYNC_XAHT_WIDTH_SHIFT 5
378
379/* The largest span between slots and widths above is 3 */
380#define EMAC_XAHT_MAX_REGS (1 << 3)
381
382#define EMAC_XAHT_SLOTS(dev) (1 << (dev)->xaht_slots_shift)
383#define EMAC_XAHT_WIDTH(dev) (1 << (dev)->xaht_width_shift)
384#define EMAC_XAHT_REGS(dev) (1 << ((dev)->xaht_slots_shift - \
385 (dev)->xaht_width_shift))
386
387#define EMAC_XAHT_CRC_TO_SLOT(dev, crc) \
388 ((EMAC_XAHT_SLOTS(dev) - 1) - \
389 ((crc) >> ((sizeof (u32) * BITS_PER_BYTE) - \
390 (dev)->xaht_slots_shift)))
391
392#define EMAC_XAHT_SLOT_TO_REG(dev, slot) \
393 ((slot) >> (dev)->xaht_width_shift)
394
395#define EMAC_XAHT_SLOT_TO_MASK(dev, slot) \
396 ((u32)(1 << (EMAC_XAHT_WIDTH(dev) - 1)) >> \
397 ((slot) & (u32)(EMAC_XAHT_WIDTH(dev) - 1)))
398
399static inline u32 __iomem *emac_xaht_base(struct emac_instance *dev)
400{
401 struct emac_regs __iomem *p = dev->emacp;
402 int offset;
403
404 /* The first IAHT entry always is the base of the block of
405 * IAHT and GAHT registers.
406 */
407 if (emac_has_feature(dev, EMAC_FTR_EMAC4SYNC))
408 offset = offsetof(struct emac_regs, u1.emac4sync.iaht1);
409 else
410 offset = offsetof(struct emac_regs, u0.emac4.iaht1);
411
412 return (u32 __iomem *)((__force ptrdiff_t)p + offset);
413}
414
415static inline u32 __iomem *emac_gaht_base(struct emac_instance *dev)
416{
417 /* GAHT registers always come after an identical number of
418 * IAHT registers.
419 */
420 return emac_xaht_base(dev) + EMAC_XAHT_REGS(dev);
421}
422
423static inline u32 *emac_iaht_base(struct emac_instance *dev)
424{
425 /* IAHT registers always come before an identical number of
426 * GAHT registers.
427 */
428 return emac_xaht_base(dev);
429}
430
431/* Ethtool get_regs complex data.
432 * We want to get not just EMAC registers, but also MAL, ZMII, RGMII, TAH
433 * when available.
434 *
435 * Returned BLOB consists of the ibm_emac_ethtool_regs_hdr,
436 * MAL registers, EMAC registers and optional ZMII, RGMII, TAH registers.
437 * Each register component is preceded with emac_ethtool_regs_subhdr.
438 * Order of the optional headers follows their relative bit posititions
439 * in emac_ethtool_regs_hdr.components
440 */
441#define EMAC_ETHTOOL_REGS_ZMII 0x00000001
442#define EMAC_ETHTOOL_REGS_RGMII 0x00000002
443#define EMAC_ETHTOOL_REGS_TAH 0x00000004
444
445struct emac_ethtool_regs_hdr {
446 u32 components;
447};
448
449struct emac_ethtool_regs_subhdr {
450 u32 version;
451 u32 index;
452};
453
454#define EMAC_ETHTOOL_REGS_VER 3
455#define EMAC4_ETHTOOL_REGS_VER 4
456#define EMAC4SYNC_ETHTOOL_REGS_VER 5
457
458#endif /* __IBM_NEWEMAC_CORE_H */