/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * drivers/net/ethernet/ibm/emac/core.h
 *
 * Driver for PowerPC 4xx on-chip ethernet controller.
 *
 * Copyright 2007 Benjamin Herrenschmidt, IBM Corp.
 *                <benh@kernel.crashing.org>
 *
 * Based on the arch/ppc version of the driver:
 *
 * Copyright (c) 2004, 2005 Zultys Technologies.
 * Eugene Surovegin <eugene.surovegin@zultys.com> or <ebs@ebshome.net>
 *
 * Based on original work by
 *      Armin Kuster <akuster@mvista.com>
 *  Johnnie Peters <jpeters@mvista.com>
 *      Copyright 2000, 2001 MontaVista Softare Inc.
 */
#ifndef __IBM_NEWEMAC_CORE_H
#define __IBM_NEWEMAC_CORE_H

#include <linux/module.h>
#include <linux/list.h>
#include <linux/kernel.h>
#include <linux/interrupt.h>
#include <linux/netdevice.h>
#include <linux/dma-mapping.h>
#include <linux/spinlock.h>
#include <linux/slab.h>

#include <asm/io.h>
#include <asm/dcr.h>

#include "emac.h"
#include "phy.h"
#include "zmii.h"
#include "rgmii.h"
#include "mal.h"
#include "tah.h"
#include "debug.h"

#define NUM_TX_BUFF   CONFIG_IBM_EMAC_TXB
#define NUM_RX_BUFF   CONFIG_IBM_EMAC_RXB

/* Simple sanity check */
#if NUM_TX_BUFF > 256 || NUM_RX_BUFF > 256
#error Invalid number of buffer descriptors (greater than 256)
#endif

#define EMAC_MIN_MTU   46

/* Maximum L2 header length (VLAN tagged, no FCS) */
#define EMAC_MTU_OVERHEAD  (6 * 2 + 2 + 4)

/* RX BD size for the given MTU */
static inline int emac_rx_size(int mtu)
{
 if (mtu > ETH_DATA_LEN)
  return MAL_MAX_RX_SIZE;
 else
  return mal_rx_size(ETH_DATA_LEN + EMAC_MTU_OVERHEAD);
}

/* Size of RX skb for the given MTU */
static inline int emac_rx_skb_size(int mtu)
{
 int size = max(mtu + EMAC_MTU_OVERHEAD, emac_rx_size(mtu));

 return SKB_DATA_ALIGN(size + NET_IP_ALIGN) + NET_SKB_PAD;
}

/* RX DMA sync size */
static inline int emac_rx_sync_size(int mtu)
{
 return SKB_DATA_ALIGN(emac_rx_size(mtu) + NET_IP_ALIGN);
}

/* Driver statistcs is split into two parts to make it more cache friendly:
 *   - normal statistics (packet count, etc)
 *   - error statistics
 *
 * When statistics is requested by ethtool, these parts are concatenated,
 * normal one goes first.
 *
 * Please, keep these structures in sync with emac_stats_keys.
 */

/* Normal TX/RX Statistics */
struct emac_stats {
 u64 rx_packets;
 u64 rx_bytes;
 u64 tx_packets;
 u64 tx_bytes;
 u64 rx_packets_csum;
 u64 tx_packets_csum;
};

/* Error statistics */
struct emac_error_stats {
 u64 tx_undo;

 /* Software RX Errors */
 u64 rx_dropped_stack;
 u64 rx_dropped_oom;
 u64 rx_dropped_error;
 u64 rx_dropped_resize;
 u64 rx_dropped_mtu;
 u64 rx_stopped;
 /* BD reported RX errors */
 u64 rx_bd_errors;
 u64 rx_bd_overrun;
 u64 rx_bd_bad_packet;
 u64 rx_bd_runt_packet;
 u64 rx_bd_short_event;
 u64 rx_bd_alignment_error;
 u64 rx_bd_bad_fcs;
 u64 rx_bd_packet_too_long;
 u64 rx_bd_out_of_range;
 u64 rx_bd_in_range;
 /* EMAC IRQ reported RX errors */
 u64 rx_parity;
 u64 rx_fifo_overrun;
 u64 rx_overrun;
 u64 rx_bad_packet;
 u64 rx_runt_packet;
 u64 rx_short_event;
 u64 rx_alignment_error;
 u64 rx_bad_fcs;
 u64 rx_packet_too_long;
 u64 rx_out_of_range;
 u64 rx_in_range;

 /* Software TX Errors */
 u64 tx_dropped;
 /* BD reported TX errors */
 u64 tx_bd_errors;
 u64 tx_bd_bad_fcs;
 u64 tx_bd_carrier_loss;
 u64 tx_bd_excessive_deferral;
 u64 tx_bd_excessive_collisions;
 u64 tx_bd_late_collision;
 u64 tx_bd_multple_collisions;
 u64 tx_bd_single_collision;
 u64 tx_bd_underrun;
 u64 tx_bd_sqe;
 /* EMAC IRQ reported TX errors */
 u64 tx_parity;
 u64 tx_underrun;
 u64 tx_sqe;
 u64 tx_errors;
};

#define EMAC_ETHTOOL_STATS_COUNT ((sizeof(struct emac_stats) + \
       sizeof(struct emac_error_stats)) \
      / sizeof(u64))

struct emac_instance {
 struct net_device  *ndev;
 struct emac_regs  __iomem *emacp;
 struct platform_device  *ofdev;
 struct device_node  **blist; /* bootlist entry */

 /* MAL linkage */
 u32    mal_ph;
 struct platform_device  *mal_dev;
 u32    mal_rx_chan;
 u32    mal_tx_chan;
 struct mal_instance  *mal;
 struct mal_commac  commac;

 /* PHY infos */
 phy_interface_t   phy_mode;
 u32    phy_map;
 u32    phy_address;
 u32    phy_feat_exc;
 struct mii_phy   phy;
 struct mutex   link_lock;
 struct delayed_work  link_work;
 int    link_polling;

 /* GPCS PHY infos */
 u32    gpcs_address;

 /* Shared MDIO if any */
 u32    mdio_ph;
 struct platform_device  *mdio_dev;
 struct emac_instance  *mdio_instance;
 struct mutex   mdio_lock;

 /* ZMII infos if any */
 u32    zmii_ph;
 u32    zmii_port;
 struct platform_device  *zmii_dev;

 /* RGMII infos if any */
 u32    rgmii_ph;
 u32    rgmii_port;
 struct platform_device  *rgmii_dev;

 /* TAH infos if any */
 u32    tah_ph;
 u32    tah_port;
 struct platform_device  *tah_dev;

 /* IRQs */
 int    wol_irq;
 int    emac_irq;

 /* OPB bus frequency in Mhz */
 u32    opb_bus_freq;

 /* Cell index within an ASIC (for clk mgmnt) */
 u32    cell_index;

 /* Max supported MTU */
 u32    max_mtu;

 /* Feature bits (from probe table) */
 unsigned int   features;

 /* Tx and Rx fifo sizes & other infos in bytes */
 u32    tx_fifo_size;
 u32    tx_fifo_size_gige;
 u32    rx_fifo_size;
 u32    rx_fifo_size_gige;
 u32    fifo_entry_size;
 u32    mal_burst_size; /* move to MAL ? */

 /* IAHT and GAHT filter parameterization */
 u32    xaht_slots_shift;
 u32    xaht_width_shift;

 /* Descriptor management
 */
 struct mal_descriptor  *tx_desc;
 int    tx_cnt;
 int    tx_slot;
 int    ack_slot;

 struct mal_descriptor  *rx_desc;
 int    rx_slot;
 struct sk_buff   *rx_sg_skb; /* 1 */
 int     rx_skb_size;
 int    rx_sync_size;

 struct sk_buff   *tx_skb[NUM_TX_BUFF];
 struct sk_buff   *rx_skb[NUM_RX_BUFF];

 /* Stats
 */
 struct emac_error_stats  estats;
 struct emac_stats   stats;

 /* Misc
 */
 int    reset_failed;
 int    stop_timeout; /* in us */
 int    no_mcast;
 int    mcast_pending;
 int    opened;
 struct work_struct  reset_work;
 spinlock_t   lock;
};

/*
 * Features of various EMAC implementations
 */

/*
 * No flow control on 40x according to the original driver
 */
#define EMAC_FTR_NO_FLOW_CONTROL_40x 0x00000001
/*
 * Cell is an EMAC4
 */
#define EMAC_FTR_EMAC4   0x00000002
/*
 * For the 440SPe, AMCC inexplicably changed the polarity of
 * the "operation complete" bit in the MII control register.
 */
#define EMAC_FTR_STACR_OC_INVERT 0x00000004
/*
 * Set if we have a TAH.
 */
#define EMAC_FTR_HAS_TAH  0x00000008
/*
 * Set if we have a ZMII.
 */
#define EMAC_FTR_HAS_ZMII  0x00000010
/*
 * Set if we have a RGMII.
 */
#define EMAC_FTR_HAS_RGMII  0x00000020
/*
 * Set if we have new type STACR with STAOPC
 */
#define EMAC_FTR_HAS_NEW_STACR  0x00000040
/*
 * Set if we need phy clock workaround for 440gx
 */
#define EMAC_FTR_440GX_PHY_CLK_FIX 0x00000080
/*
 * Set if we need phy clock workaround for 440ep or 440gr
 */
#define EMAC_FTR_440EP_PHY_CLK_FIX 0x00000100
/*
 * The 405EX and 460EX contain the EMAC4SYNC core
 */
#define EMAC_FTR_EMAC4SYNC  0x00000200
/*
 * Set if we need phy clock workaround for 460ex or 460gt
 */
#define EMAC_FTR_460EX_PHY_CLK_FIX 0x00000400
/*
 * APM821xx requires Jumbo frame size set explicitly
 */
#define EMAC_APM821XX_REQ_JUMBO_FRAME_SIZE 0x00000800
/*
 * APM821xx does not support Half Duplex mode
 */
#define EMAC_FTR_APM821XX_NO_HALF_DUPLEX 0x00001000

/* Right now, we don't quite handle the always/possible masks on the
 * most optimal way as we don't have a way to say something like
 * always EMAC4. Patches welcome.
 */
enum {
 EMAC_FTRS_ALWAYS = 0,

 EMAC_FTRS_POSSIBLE =
#ifdef CONFIG_IBM_EMAC_EMAC4
     EMAC_FTR_EMAC4 | EMAC_FTR_EMAC4SYNC |
     EMAC_FTR_HAS_NEW_STACR |
     EMAC_FTR_STACR_OC_INVERT | EMAC_FTR_440GX_PHY_CLK_FIX |
#endif
#ifdef CONFIG_IBM_EMAC_TAH
     EMAC_FTR_HAS_TAH |
#endif
#ifdef CONFIG_IBM_EMAC_ZMII
     EMAC_FTR_HAS_ZMII |
#endif
#ifdef CONFIG_IBM_EMAC_RGMII
     EMAC_FTR_HAS_RGMII |
#endif
#ifdef CONFIG_IBM_EMAC_NO_FLOW_CTRL
     EMAC_FTR_NO_FLOW_CONTROL_40x |
#endif
 EMAC_FTR_460EX_PHY_CLK_FIX |
 EMAC_FTR_440EP_PHY_CLK_FIX |
 EMAC_APM821XX_REQ_JUMBO_FRAME_SIZE |
 EMAC_FTR_APM821XX_NO_HALF_DUPLEX,
};

static inline int emac_has_feature(struct emac_instance *dev,
       unsigned long feature)
{
 return (EMAC_FTRS_ALWAYS & feature) ||
        (EMAC_FTRS_POSSIBLE & dev->features & feature);
}

/*
 * Various instances of the EMAC core have varying 1) number of
 * address match slots, 2) width of the registers for handling address
 * match slots, 3) number of registers for handling address match
 * slots and 4) base offset for those registers.
 *
 * These macros and inlines handle these differences based on
 * parameters supplied by the device structure which are, in turn,
 * initialized based on the "compatible" entry in the device tree.
 */

#define EMAC4_XAHT_SLOTS_SHIFT  6
#define EMAC4_XAHT_WIDTH_SHIFT  4

#define EMAC4SYNC_XAHT_SLOTS_SHIFT 8
#define EMAC4SYNC_XAHT_WIDTH_SHIFT 5

/* The largest span between slots and widths above is 3 */
#define EMAC_XAHT_MAX_REGS  (1 << 3)

#define EMAC_XAHT_SLOTS(dev)          (1 << (dev)->xaht_slots_shift)
#define EMAC_XAHT_WIDTH(dev)          (1 << (dev)->xaht_width_shift)
#define EMAC_XAHT_REGS(dev)           (1 << ((dev)->xaht_slots_shift - \
            (dev)->xaht_width_shift))

#define EMAC_XAHT_CRC_TO_SLOT(dev, crc)   \
 ((EMAC_XAHT_SLOTS(dev) - 1) -   \
  ((crc) >> ((sizeof (u32) * BITS_PER_BYTE) - \
      (dev)->xaht_slots_shift)))

#define EMAC_XAHT_SLOT_TO_REG(dev, slot)  \
 ((slot) >> (dev)->xaht_width_shift)

#define EMAC_XAHT_SLOT_TO_MASK(dev, slot)  \
 ((u32)(1 << (EMAC_XAHT_WIDTH(dev) - 1)) >> \
  ((slot) & (u32)(EMAC_XAHT_WIDTH(dev) - 1)))

static inline u32 __iomem *emac_xaht_base(struct emac_instance *dev)
{
 struct emac_regs __iomem *p = dev->emacp;
 int offset;

 /* The first IAHT entry always is the base of the block of
  * IAHT and GAHT registers.
 */
 if (emac_has_feature(dev, EMAC_FTR_EMAC4SYNC))
  offset = offsetof(struct emac_regs, u1.emac4sync.iaht1);
 else
  offset = offsetof(struct emac_regs, u0.emac4.iaht1);

 return (u32 __iomem *)((__force ptrdiff_t)p + offset);
}

static inline u32 __iomem *emac_gaht_base(struct emac_instance *dev)
{
 /* GAHT registers always come after an identical number of
  * IAHT registers.
 */
 return emac_xaht_base(dev) + EMAC_XAHT_REGS(dev);
}

static inline u32 *emac_iaht_base(struct emac_instance *dev)
{
 /* IAHT registers always come before an identical number of
  * GAHT registers.
 */
 return emac_xaht_base(dev);
}

/* Ethtool get_regs complex data.
 * We want to get not just EMAC registers, but also MAL, ZMII, RGMII, TAH
 * when available.
 *
 * Returned BLOB consists of the ibm_emac_ethtool_regs_hdr,
 * MAL registers, EMAC registers and optional ZMII, RGMII, TAH registers.
 * Each register component is preceded with emac_ethtool_regs_subhdr.
 * Order of the optional headers follows their relative bit posititions
 * in emac_ethtool_regs_hdr.components
 */
#define EMAC_ETHTOOL_REGS_ZMII  0x00000001
#define EMAC_ETHTOOL_REGS_RGMII  0x00000002
#define EMAC_ETHTOOL_REGS_TAH  0x00000004

struct emac_ethtool_regs_hdr {
 u32 components;
};

struct emac_ethtool_regs_subhdr {
 u32 version;
 u32 index;
};

#define EMAC_ETHTOOL_REGS_VER  3
#define EMAC4_ETHTOOL_REGS_VER  4
#define EMAC4SYNC_ETHTOOL_REGS_VER 5

#endif /* __IBM_NEWEMAC_CORE_H */