Quelle  fs_enet.h   Sprache: C

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef FS_ENET_H
#define FS_ENET_H

#include <linux/clk.h>
#include <linux/netdevice.h>
#include <linux/types.h>
#include <linux/list.h>
#include <linux/phy.h>
#include <linux/phylink.h>
#include <linux/dma-mapping.h>

#ifdef CONFIG_CPM1
#include <asm/cpm1.h>
#endif

#if defined(CONFIG_FS_ENET_HAS_FEC)
#include <asm/cpm.h>

#if defined(CONFIG_FS_ENET_MPC5121_FEC)
/* MPC5121 FEC has different register layout */
struct fec {
 u32 fec_reserved0;
 u32 fec_ievent;   /* Interrupt event reg */
 u32 fec_imask;   /* Interrupt mask reg */
 u32 fec_reserved1;
 u32 fec_r_des_active;  /* Receive descriptor reg */
 u32 fec_x_des_active;  /* Transmit descriptor reg */
 u32 fec_reserved2[3];
 u32 fec_ecntrl;   /* Ethernet control reg */
 u32 fec_reserved3[6];
 u32 fec_mii_data;  /* MII manage frame reg */
 u32 fec_mii_speed;  /* MII speed control reg */
 u32 fec_reserved4[7];
 u32 fec_mib_ctrlstat;  /* MIB control/status reg */
 u32 fec_reserved5[7];
 u32 fec_r_cntrl;  /* Receive control reg */
 u32 fec_reserved6[15];
 u32 fec_x_cntrl;  /* Transmit Control reg */
 u32 fec_reserved7[7];
 u32 fec_addr_low;  /* Low 32bits MAC address */
 u32 fec_addr_high;  /* High 16bits MAC address */
 u32 fec_opd;   /* Opcode + Pause duration */
 u32 fec_reserved8[10];
 u32 fec_hash_table_high; /* High 32bits hash table */
 u32 fec_hash_table_low;  /* Low 32bits hash table */
 u32 fec_grp_hash_table_high; /* High 32bits hash table */
 u32 fec_grp_hash_table_low; /* Low 32bits hash table */
 u32 fec_reserved9[7];
 u32 fec_x_wmrk;   /* FIFO transmit water mark */
 u32 fec_reserved10;
 u32 fec_r_bound;  /* FIFO receive bound reg */
 u32 fec_r_fstart;  /* FIFO receive start reg */
 u32 fec_reserved11[11];
 u32 fec_r_des_start;  /* Receive descriptor ring */
 u32 fec_x_des_start;  /* Transmit descriptor ring */
 u32 fec_r_buff_size;  /* Maximum receive buff size */
 u32 fec_reserved12[26];
 u32 fec_dma_control;  /* DMA Endian and other ctrl */
};
#endif

struct fec_info {
 struct fec __iomem *fecp;
 u32 mii_speed;
};
#endif

#ifdef CONFIG_CPM2
#include <asm/cpm2.h>
#endif

/* hw driver ops */
struct fs_ops {
 int (*setup_data)(struct net_device *dev);
 int (*allocate_bd)(struct net_device *dev);
 void (*free_bd)(struct net_device *dev);
 void (*cleanup_data)(struct net_device *dev);
 void (*set_multicast_list)(struct net_device *dev);
 void (*restart)(struct net_device *dev, phy_interface_t interface,
   int speed, int duplex);
 void (*stop)(struct net_device *dev);
 void (*napi_clear_event)(struct net_device *dev);
 void (*napi_enable)(struct net_device *dev);
 void (*napi_disable)(struct net_device *dev);
 void (*rx_bd_done)(struct net_device *dev);
 void (*tx_kickstart)(struct net_device *dev);
 u32 (*get_int_events)(struct net_device *dev);
 void (*clear_int_events)(struct net_device *dev, u32 int_events);
 void (*ev_error)(struct net_device *dev, u32 int_events);
 int (*get_regs)(struct net_device *dev, void *p, int *sizep);
 int (*get_regs_len)(struct net_device *dev);
 void (*tx_restart)(struct net_device *dev);
};

/* The FEC stores dest/src/type, data, and checksum for receive packets.
 */
#define MAX_MTU 1508  /* Allow fullsized pppoe packets over VLAN */
#define MIN_MTU 46  /* this is data size */
#define CRC_LEN 4

#define PKT_MAXBUF_SIZE  (MAX_MTU+ETH_HLEN+CRC_LEN)
#define PKT_MINBUF_SIZE  (MIN_MTU+ETH_HLEN+CRC_LEN)

/* Must be a multiple of 32 (to cover both FEC & FCC) */
#define PKT_MAXBLR_SIZE  ((PKT_MAXBUF_SIZE + 31) & ~31)
/* This is needed so that invalidate_xxx wont invalidate too much */
#define ENET_RX_ALIGN  16
#define ENET_RX_FRSIZE L1_CACHE_ALIGN(PKT_MAXBUF_SIZE + ENET_RX_ALIGN - 1)

struct fs_platform_info {
 /* device specific information */
 u32 cp_command;  /* CPM page/sblock/mcn */

 u32 dpram_offset;

 int rx_ring, tx_ring; /* number of buffers on rx */
 int rx_copybreak; /* limit we copy small frames */
 int napi_weight; /* NAPI weight */
};

struct fs_enet_private {
 struct napi_struct napi;
 struct device *dev; /* pointer back to the device (must be initialized first) */
 struct net_device *ndev;
 spinlock_t lock; /* during all ops except TX pckt processing */
 spinlock_t tx_lock; /* during fs_start_xmit and fs_tx         */
 struct fs_platform_info *fpi;
 struct work_struct timeout_work;
 const struct fs_ops *ops;
 int rx_ring, tx_ring;
 dma_addr_t ring_mem_addr;
 void __iomem *ring_base;
 struct sk_buff **rx_skbuff;
 struct sk_buff **tx_skbuff;
 char *mapped_as_page;
 cbd_t __iomem *rx_bd_base; /* Address of Rx and Tx buffers.    */
 cbd_t __iomem *tx_bd_base;
 cbd_t __iomem *dirty_tx; /* ring entries to be free()ed.     */
 cbd_t __iomem *cur_rx;
 cbd_t __iomem *cur_tx;
 int tx_free;
 u32 msg_enable;
 struct phylink *phylink;
 struct phylink_config phylink_config;
 int interrupt;

 /* event masks */
 u32 ev_napi;  /* mask of NAPI events */
 u32 ev;   /* event mask          */
 u32 ev_err;  /* error event mask       */

 u16 bd_rx_empty; /* mask of BD rx empty   */
 u16 bd_rx_err;  /* mask of BD rx errors   */

 union {
  struct {
   int idx;  /* FEC1 = 0, FEC2 = 1  */
   void __iomem *fecp; /* hw registers        */
   u32 hthi, htlo;  /* state for multicast */
  } fec;

  struct {
   int idx;  /* FCC1-3 = 0-2        */
   void __iomem *fccp; /* hw registers        */
   void __iomem *ep; /* parameter ram       */
   void __iomem *fcccp; /* hw registers cont.  */
   void __iomem *mem; /* FCC DPRAM */
   u32 gaddrh, gaddrl; /* group address       */
  } fcc;

  struct {
   int idx;  /* FEC1 = 0, FEC2 = 1  */
   void __iomem *sccp; /* hw registers        */
   void __iomem *ep; /* parameter ram       */
   u32 hthi, htlo;  /* state for multicast */
  } scc;

 };
};

/***************************************************************************/

void fs_init_bds(struct net_device *dev);
void fs_cleanup_bds(struct net_device *dev);

/***************************************************************************/

#define DRV_MODULE_NAME  "fs_enet"
#define PFX DRV_MODULE_NAME ": "

/***************************************************************************/
/* buffer descriptor access macros */

/* access macros */
#if defined(CONFIG_CPM1)
/* for a CPM1 __raw_xxx's are sufficient */
#define __cbd_out32(addr, x) __raw_writel(x, addr)
#define __cbd_out16(addr, x) __raw_writew(x, addr)
#define __cbd_in32(addr) __raw_readl(addr)
#define __cbd_in16(addr) __raw_readw(addr)
#else
/* for others play it safe */
#define __cbd_out32(addr, x) out_be32(addr, x)
#define __cbd_out16(addr, x) out_be16(addr, x)
#define __cbd_in32(addr) in_be32(addr)
#define __cbd_in16(addr) in_be16(addr)
#endif

/* write */
#define CBDW_SC(_cbd, _sc)   __cbd_out16(&(_cbd)->cbd_sc, (_sc))
#define CBDW_DATLEN(_cbd, _datlen) __cbd_out16(&(_cbd)->cbd_datlen, (_datlen))
#define CBDW_BUFADDR(_cbd, _bufaddr) __cbd_out32(&(_cbd)->cbd_bufaddr, (_bufaddr))

/* read */
#define CBDR_SC(_cbd)    __cbd_in16(&(_cbd)->cbd_sc)
#define CBDR_DATLEN(_cbd)  __cbd_in16(&(_cbd)->cbd_datlen)
#define CBDR_BUFADDR(_cbd)  __cbd_in32(&(_cbd)->cbd_bufaddr)

/* set bits */
#define CBDS_SC(_cbd, _sc)   CBDW_SC(_cbd, CBDR_SC(_cbd) | (_sc))

/* clear bits */
#define CBDC_SC(_cbd, _sc)   CBDW_SC(_cbd, CBDR_SC(_cbd) & ~(_sc))

/*******************************************************************/

extern const struct fs_ops fs_fec_ops;
extern const struct fs_ops fs_fcc_ops;
extern const struct fs_ops fs_scc_ops;

/*******************************************************************/

#endif