drivers/net/ethernet/chelsio/cxgb/common.h - linux - Git at Google

 /* SPDX-License-Identifier: GPL-2.0-only */
 /*****************************************************************************
  *                                                                           *
  * File: common.h                                                            *
  * $Revision: 1.21 $                                                         *
  * $Date: 2005/06/22 00:43:25 $                                              *
  * Description:                                                              *
  *  part of the Chelsio 10Gb Ethernet Driver.                                *
  *                                                                           *
  *                                                                           *
  * http://www.chelsio.com                                                    *
  *                                                                           *
  * Copyright (c) 2003 - 2005 Chelsio Communications, Inc.                    *
  * All rights reserved.                                                      *
  *                                                                           *
  * Maintainers: maintainers@chelsio.com                                      *
  *                                                                           *
  * Authors: Dimitrios Michailidis   <dm@chelsio.com>                         *
  *          Tina Yang               <tainay@chelsio.com>                     *
  *          Felix Marti             <felix@chelsio.com>                      *
  *          Scott Bardone           <sbardone@chelsio.com>                   *
  *          Kurt Ottaway            <kottaway@chelsio.com>                   *
  *          Frank DiMambro          <frank@chelsio.com>                      *
  *                                                                           *
  * History:                                                                  *
  *                                                                           *
  ****************************************************************************/

 #define pr_fmt(fmt) "cxgb: " fmt

 #ifndef _CXGB_COMMON_H_
 #define _CXGB_COMMON_H_

 #include <linux/module.h>
 #include <linux/netdevice.h>
 #include <linux/types.h>
 #include <linux/delay.h>
 #include <linux/pci.h>
 #include <linux/ethtool.h>
 #include <linux/if_vlan.h>
 #include <linux/mdio.h>
 #include <linux/crc32.h>
 #include <linux/slab.h>
 #include <asm/io.h>
 #include <linux/pci_ids.h>

 #define DRV_DESCRIPTION "Chelsio 10Gb Ethernet Driver"
 #define DRV_NAME "cxgb"

 #define CH_DEVICE(devid, ssid, idx) \
 	{ PCI_VENDOR_ID_CHELSIO, devid, PCI_ANY_ID, ssid, 0, 0, idx }

 #define SUPPORTED_PAUSE       (1 << 13)
 #define SUPPORTED_LOOPBACK    (1 << 15)

 #define ADVERTISED_PAUSE      (1 << 13)
 #define ADVERTISED_ASYM_PAUSE (1 << 14)

 typedef struct adapter adapter_t;

 struct t1_rx_mode {
        struct net_device *dev;
 };

 #define t1_rx_mode_promisc(rm)	(rm->dev->flags & IFF_PROMISC)
 #define t1_rx_mode_allmulti(rm)	(rm->dev->flags & IFF_ALLMULTI)
 #define t1_rx_mode_mc_cnt(rm)	(netdev_mc_count(rm->dev))
 #define t1_get_netdev(rm)	(rm->dev)

 #define	MAX_NPORTS 4
 #define PORT_MASK ((1 << MAX_NPORTS) - 1)
 #define NMTUS      8
 #define TCB_SIZE   128

 #define SPEED_INVALID 0xffff
 #define DUPLEX_INVALID 0xff

 /* Max frame size PM3393 can handle. Includes Ethernet header and CRC. */
 #define PM3393_MAX_FRAME_SIZE 9600

 #define VSC7326_MAX_MTU 9600

 enum {
 	CHBT_BOARD_N110,
 	CHBT_BOARD_N210,
 	CHBT_BOARD_7500,
 	CHBT_BOARD_8000,
 	CHBT_BOARD_CHT101,
 	CHBT_BOARD_CHT110,
 	CHBT_BOARD_CHT210,
 	CHBT_BOARD_CHT204,
 	CHBT_BOARD_CHT204V,
 	CHBT_BOARD_CHT204E,
 	CHBT_BOARD_CHN204,
 	CHBT_BOARD_COUGAR,
 	CHBT_BOARD_6800,
 	CHBT_BOARD_SIMUL,
 };

 enum {
 	CHBT_TERM_FPGA,
 	CHBT_TERM_T1,
 	CHBT_TERM_T2,
 	CHBT_TERM_T3
 };

 enum {
 	CHBT_MAC_CHELSIO_A,
 	CHBT_MAC_IXF1010,
 	CHBT_MAC_PM3393,
 	CHBT_MAC_VSC7321,
 	CHBT_MAC_DUMMY
 };

 enum {
 	CHBT_PHY_88E1041,
 	CHBT_PHY_88E1111,
 	CHBT_PHY_88X2010,
 	CHBT_PHY_XPAK,
 	CHBT_PHY_MY3126,
 	CHBT_PHY_8244,
 	CHBT_PHY_DUMMY
 };

 enum {
 	PAUSE_RX      = 1 << 0,
 	PAUSE_TX      = 1 << 1,
 	PAUSE_AUTONEG = 1 << 2
 };

 /* Revisions of T1 chip */
 enum {
 	TERM_T1A   = 0,
 	TERM_T1B   = 1,
 	TERM_T2    = 3
 };

 struct sge_params {
 	unsigned int cmdQ_size[2];
 	unsigned int freelQ_size[2];
 	unsigned int large_buf_capacity;
 	unsigned int rx_coalesce_usecs;
 	unsigned int last_rx_coalesce_raw;
 	unsigned int default_rx_coalesce_usecs;
 	unsigned int sample_interval_usecs;
 	unsigned int coalesce_enable;
 	unsigned int polling;
 };

 struct chelsio_pci_params {
 	unsigned short speed;
 	unsigned char  width;
 	unsigned char  is_pcix;
 };

 struct tp_params {
 	unsigned int pm_size;
 	unsigned int cm_size;
 	unsigned int pm_rx_base;
 	unsigned int pm_tx_base;
 	unsigned int pm_rx_pg_size;
 	unsigned int pm_tx_pg_size;
 	unsigned int pm_rx_num_pgs;
 	unsigned int pm_tx_num_pgs;
 	unsigned int rx_coalescing_size;
 	unsigned int use_5tuple_mode;
 };

 struct mc5_params {
 	unsigned int mode;       /* selects MC5 width */
 	unsigned int nservers;   /* size of server region */
 	unsigned int nroutes;    /* size of routing region */
 };

 /* Default MC5 region sizes */
 #define DEFAULT_SERVER_REGION_LEN 256
 #define DEFAULT_RT_REGION_LEN 1024

 struct adapter_params {
 	struct sge_params sge;
 	struct mc5_params mc5;
 	struct tp_params  tp;
 	struct chelsio_pci_params pci;

 	const struct board_info *brd_info;

 	unsigned short mtus[NMTUS];
 	unsigned int   nports;          /* # of ethernet ports */
 	unsigned int   stats_update_period;
 	unsigned short chip_revision;
 	unsigned char  chip_version;
 	unsigned char  is_asic;
 	unsigned char  has_msi;
 };

 struct link_config {
 	unsigned int   supported;        /* link capabilities */
 	unsigned int   advertising;      /* advertised capabilities */
 	unsigned short requested_speed;  /* speed user has requested */
 	unsigned short speed;            /* actual link speed */
 	unsigned char  requested_duplex; /* duplex user has requested */
 	unsigned char  duplex;           /* actual link duplex */
 	unsigned char  requested_fc;     /* flow control user has requested */
 	unsigned char  fc;               /* actual link flow control */
 	unsigned char  autoneg;          /* autonegotiating? */
 };

 struct cmac;
 struct cphy;

 struct port_info {
 	struct net_device *dev;
 	struct cmac *mac;
 	struct cphy *phy;
 	struct link_config link_config;
 };

 struct sge;
 struct peespi;

 struct adapter {
 	u8 __iomem *regs;
 	struct pci_dev *pdev;
 	unsigned long registered_device_map;
 	unsigned long open_device_map;
 	unsigned long flags;

 	const char *name;
 	int msg_enable;
 	u32 mmio_len;

 	struct adapter_params params;

 	/* Terminator modules. */
 	struct sge    *sge;
 	struct peespi *espi;
 	struct petp   *tp;

 	struct napi_struct napi;
 	struct port_info port[MAX_NPORTS];
 	struct delayed_work stats_update_task;
 	struct timer_list stats_update_timer;

 	spinlock_t tpi_lock;
 	spinlock_t work_lock;
 	spinlock_t mac_lock;

 	/* guards async operations */
 	spinlock_t async_lock ____cacheline_aligned;
 	u32 pending_thread_intr;
 	u32 slow_intr_mask;
 	int t1powersave;
 };

 enum {                                           /* adapter flags */
 	FULL_INIT_DONE        = 1 << 0,
 };

 struct mdio_ops;
 struct gmac;
 struct gphy;

 struct board_info {
 	unsigned char           board;
 	unsigned char           port_number;
 	unsigned long           caps;
 	unsigned char           chip_term;
 	unsigned char           chip_mac;
 	unsigned char           chip_phy;
 	unsigned int            clock_core;
 	unsigned int            clock_mc3;
 	unsigned int            clock_mc4;
 	unsigned int            espi_nports;
 	unsigned int            clock_elmer0;
 	unsigned char           mdio_mdien;
 	unsigned char           mdio_mdiinv;
 	unsigned char           mdio_mdc;
 	unsigned char           mdio_phybaseaddr;
 	const struct gmac      *gmac;
 	const struct gphy      *gphy;
 	const struct mdio_ops  *mdio_ops;
 	const char             *desc;
 };

 static inline int t1_is_asic(const adapter_t *adapter)
 {
 	return adapter->params.is_asic;
 }

 extern const struct pci_device_id t1_pci_tbl[];

 static inline int adapter_matches_type(const adapter_t *adapter,
 				       int version, int revision)
 {
 	return adapter->params.chip_version == version &&
 	       adapter->params.chip_revision == revision;
 }

 #define t1_is_T1B(adap) adapter_matches_type(adap, CHBT_TERM_T1, TERM_T1B)
 #define is_T2(adap)     adapter_matches_type(adap, CHBT_TERM_T2, TERM_T2)

 /* Returns true if an adapter supports VLAN acceleration and TSO */
 static inline int vlan_tso_capable(const adapter_t *adapter)
 {
 	return !t1_is_T1B(adapter);
 }

 #define for_each_port(adapter, iter) \
 	for (iter = 0; iter < (adapter)->params.nports; ++iter)

 #define board_info(adapter) ((adapter)->params.brd_info)
 #define is_10G(adapter) (board_info(adapter)->caps & SUPPORTED_10000baseT_Full)

 static inline unsigned int core_ticks_per_usec(const adapter_t *adap)
 {
 	return board_info(adap)->clock_core / 1000000;
 }

 int __t1_tpi_read(adapter_t *adapter, u32 addr, u32 *valp);
 int __t1_tpi_write(adapter_t *adapter, u32 addr, u32 value);
 int t1_tpi_write(adapter_t *adapter, u32 addr, u32 value);
 int t1_tpi_read(adapter_t *adapter, u32 addr, u32 *value);

 void t1_interrupts_enable(adapter_t *adapter);
 void t1_interrupts_disable(adapter_t *adapter);
 void t1_interrupts_clear(adapter_t *adapter);
 int t1_elmer0_ext_intr_handler(adapter_t *adapter);
 irqreturn_t t1_slow_intr_handler(adapter_t *adapter);

 int t1_link_start(struct cphy *phy, struct cmac *mac, struct link_config *lc);
 const struct board_info *t1_get_board_info(unsigned int board_id);
 int t1_seeprom_read(adapter_t *adapter, u32 addr, __le32 *data);
 int t1_get_board_rev(adapter_t *adapter, const struct board_info *bi,
 		     struct adapter_params *p);
 int t1_init_hw_modules(adapter_t *adapter);
 int t1_init_sw_modules(adapter_t *adapter, const struct board_info *bi);
 void t1_free_sw_modules(adapter_t *adapter);
 void t1_link_changed(adapter_t *adapter, int port_id);
 void t1_link_negotiated(adapter_t *adapter, int port_id, int link_stat,
 			    int speed, int duplex, int pause);
 #endif /* _CXGB_COMMON_H_ */
	/* SPDX-License-Identifier: GPL-2.0-only */
	/*****************************************************************************
	* *
	* File: common.h *
	* $Revision: 1.21 $ *
	* $Date: 2005/06/22 00:43:25 $ *
	* Description: *
	* part of the Chelsio 10Gb Ethernet Driver. *
	* *
	* *
	* http://www.chelsio.com *
	* *
	* Copyright (c) 2003 - 2005 Chelsio Communications, Inc. *
	* All rights reserved. *
	* *
	* Maintainers: maintainers@chelsio.com *
	* *
	* Authors: Dimitrios Michailidis <dm@chelsio.com> *
	* Tina Yang <tainay@chelsio.com> *
	* Felix Marti <felix@chelsio.com> *
	* Scott Bardone <sbardone@chelsio.com> *
	* Kurt Ottaway <kottaway@chelsio.com> *
	* Frank DiMambro <frank@chelsio.com> *
	* *
	* History: *
	* *
	****************************************************************************/

	#define pr_fmt(fmt) "cxgb: " fmt

	#ifndef _CXGB_COMMON_H_
	#define _CXGB_COMMON_H_

	#include <linux/module.h>
	#include <linux/netdevice.h>
	#include <linux/types.h>
	#include <linux/delay.h>
	#include <linux/pci.h>
	#include <linux/ethtool.h>
	#include <linux/if_vlan.h>
	#include <linux/mdio.h>
	#include <linux/crc32.h>
	#include <linux/slab.h>
	#include <asm/io.h>
	#include <linux/pci_ids.h>

	#define DRV_DESCRIPTION "Chelsio 10Gb Ethernet Driver"
	#define DRV_NAME "cxgb"

	#define CH_DEVICE(devid, ssid, idx) \
	{ PCI_VENDOR_ID_CHELSIO, devid, PCI_ANY_ID, ssid, 0, 0, idx }

	#define SUPPORTED_PAUSE (1 << 13)
	#define SUPPORTED_LOOPBACK (1 << 15)

	#define ADVERTISED_PAUSE (1 << 13)
	#define ADVERTISED_ASYM_PAUSE (1 << 14)

	typedef struct adapter adapter_t;

	struct t1_rx_mode {
	struct net_device *dev;
	};

	#define t1_rx_mode_promisc(rm) (rm->dev->flags & IFF_PROMISC)
	#define t1_rx_mode_allmulti(rm) (rm->dev->flags & IFF_ALLMULTI)
	#define t1_rx_mode_mc_cnt(rm) (netdev_mc_count(rm->dev))
	#define t1_get_netdev(rm) (rm->dev)

	#define MAX_NPORTS 4
	#define PORT_MASK ((1 << MAX_NPORTS) - 1)
	#define NMTUS 8
	#define TCB_SIZE 128

	#define SPEED_INVALID 0xffff
	#define DUPLEX_INVALID 0xff

	/* Max frame size PM3393 can handle. Includes Ethernet header and CRC. */
	#define PM3393_MAX_FRAME_SIZE 9600

	#define VSC7326_MAX_MTU 9600

	enum {
	CHBT_BOARD_N110,
	CHBT_BOARD_N210,
	CHBT_BOARD_7500,
	CHBT_BOARD_8000,
	CHBT_BOARD_CHT101,
	CHBT_BOARD_CHT110,
	CHBT_BOARD_CHT210,
	CHBT_BOARD_CHT204,
	CHBT_BOARD_CHT204V,
	CHBT_BOARD_CHT204E,
	CHBT_BOARD_CHN204,
	CHBT_BOARD_COUGAR,
	CHBT_BOARD_6800,
	CHBT_BOARD_SIMUL,
	};

	enum {
	CHBT_TERM_FPGA,
	CHBT_TERM_T1,
	CHBT_TERM_T2,
	CHBT_TERM_T3
	};

	enum {
	CHBT_MAC_CHELSIO_A,
	CHBT_MAC_IXF1010,
	CHBT_MAC_PM3393,
	CHBT_MAC_VSC7321,
	CHBT_MAC_DUMMY
	};

	enum {
	CHBT_PHY_88E1041,
	CHBT_PHY_88E1111,
	CHBT_PHY_88X2010,
	CHBT_PHY_XPAK,
	CHBT_PHY_MY3126,
	CHBT_PHY_8244,
	CHBT_PHY_DUMMY
	};

	enum {
	PAUSE_RX = 1 << 0,
	PAUSE_TX = 1 << 1,
	PAUSE_AUTONEG = 1 << 2
	};

	/* Revisions of T1 chip */
	enum {
	TERM_T1A = 0,
	TERM_T1B = 1,
	TERM_T2 = 3
	};

	struct sge_params {
	unsigned int cmdQ_size[2];
	unsigned int freelQ_size[2];
	unsigned int large_buf_capacity;
	unsigned int rx_coalesce_usecs;
	unsigned int last_rx_coalesce_raw;
	unsigned int default_rx_coalesce_usecs;
	unsigned int sample_interval_usecs;
	unsigned int coalesce_enable;
	unsigned int polling;
	};

	struct chelsio_pci_params {
	unsigned short speed;
	unsigned char width;
	unsigned char is_pcix;
	};

	struct tp_params {
	unsigned int pm_size;
	unsigned int cm_size;
	unsigned int pm_rx_base;
	unsigned int pm_tx_base;
	unsigned int pm_rx_pg_size;
	unsigned int pm_tx_pg_size;
	unsigned int pm_rx_num_pgs;
	unsigned int pm_tx_num_pgs;
	unsigned int rx_coalescing_size;
	unsigned int use_5tuple_mode;
	};

	struct mc5_params {
	unsigned int mode; /* selects MC5 width */
	unsigned int nservers; /* size of server region */
	unsigned int nroutes; /* size of routing region */
	};

	/* Default MC5 region sizes */
	#define DEFAULT_SERVER_REGION_LEN 256
	#define DEFAULT_RT_REGION_LEN 1024

	struct adapter_params {
	struct sge_params sge;
	struct mc5_params mc5;
	struct tp_params tp;
	struct chelsio_pci_params pci;

	const struct board_info *brd_info;

	unsigned short mtus[NMTUS];
	unsigned int nports; /* # of ethernet ports */
	unsigned int stats_update_period;
	unsigned short chip_revision;
	unsigned char chip_version;
	unsigned char is_asic;
	unsigned char has_msi;
	};

	struct link_config {
	unsigned int supported; /* link capabilities */
	unsigned int advertising; /* advertised capabilities */
	unsigned short requested_speed; /* speed user has requested */
	unsigned short speed; /* actual link speed */
	unsigned char requested_duplex; /* duplex user has requested */
	unsigned char duplex; /* actual link duplex */
	unsigned char requested_fc; /* flow control user has requested */
	unsigned char fc; /* actual link flow control */
	unsigned char autoneg; /* autonegotiating? */
	};

	struct cmac;
	struct cphy;

	struct port_info {
	struct net_device *dev;
	struct cmac *mac;
	struct cphy *phy;
	struct link_config link_config;
	};

	struct sge;
	struct peespi;

	struct adapter {
	u8 __iomem *regs;
	struct pci_dev *pdev;
	unsigned long registered_device_map;
	unsigned long open_device_map;
	unsigned long flags;

	const char *name;
	int msg_enable;
	u32 mmio_len;

	struct adapter_params params;

	/* Terminator modules. */
	struct sge *sge;
	struct peespi *espi;
	struct petp *tp;

	struct napi_struct napi;
	struct port_info port[MAX_NPORTS];
	struct delayed_work stats_update_task;
	struct timer_list stats_update_timer;

	spinlock_t tpi_lock;
	spinlock_t work_lock;
	spinlock_t mac_lock;

	/* guards async operations */
	spinlock_t async_lock ____cacheline_aligned;
	u32 pending_thread_intr;
	u32 slow_intr_mask;
	int t1powersave;
	};

	enum { /* adapter flags */
	FULL_INIT_DONE = 1 << 0,
	};

	struct mdio_ops;
	struct gmac;
	struct gphy;

	struct board_info {
	unsigned char board;
	unsigned char port_number;
	unsigned long caps;
	unsigned char chip_term;
	unsigned char chip_mac;
	unsigned char chip_phy;
	unsigned int clock_core;
	unsigned int clock_mc3;
	unsigned int clock_mc4;
	unsigned int espi_nports;
	unsigned int clock_elmer0;
	unsigned char mdio_mdien;
	unsigned char mdio_mdiinv;
	unsigned char mdio_mdc;
	unsigned char mdio_phybaseaddr;
	const struct gmac *gmac;
	const struct gphy *gphy;
	const struct mdio_ops *mdio_ops;
	const char *desc;
	};

	static inline int t1_is_asic(const adapter_t *adapter)
	{
	return adapter->params.is_asic;
	}

	extern const struct pci_device_id t1_pci_tbl[];

	static inline int adapter_matches_type(const adapter_t *adapter,
	int version, int revision)
	{
	return adapter->params.chip_version == version &&
	adapter->params.chip_revision == revision;
	}

	#define t1_is_T1B(adap) adapter_matches_type(adap, CHBT_TERM_T1, TERM_T1B)
	#define is_T2(adap) adapter_matches_type(adap, CHBT_TERM_T2, TERM_T2)

	/* Returns true if an adapter supports VLAN acceleration and TSO */
	static inline int vlan_tso_capable(const adapter_t *adapter)
	{
	return !t1_is_T1B(adapter);
	}

	#define for_each_port(adapter, iter) \
	for (iter = 0; iter < (adapter)->params.nports; ++iter)

	#define board_info(adapter) ((adapter)->params.brd_info)
	#define is_10G(adapter) (board_info(adapter)->caps & SUPPORTED_10000baseT_Full)

	static inline unsigned int core_ticks_per_usec(const adapter_t *adap)
	{
	return board_info(adap)->clock_core / 1000000;
	}

	int __t1_tpi_read(adapter_t adapter, u32 addr, u32 valp);
	int __t1_tpi_write(adapter_t *adapter, u32 addr, u32 value);
	int t1_tpi_write(adapter_t *adapter, u32 addr, u32 value);
	int t1_tpi_read(adapter_t adapter, u32 addr, u32 value);

	void t1_interrupts_enable(adapter_t *adapter);
	void t1_interrupts_disable(adapter_t *adapter);
	void t1_interrupts_clear(adapter_t *adapter);
	int t1_elmer0_ext_intr_handler(adapter_t *adapter);
	irqreturn_t t1_slow_intr_handler(adapter_t *adapter);

	int t1_link_start(struct cphy phy, struct cmac mac, struct link_config *lc);
	const struct board_info *t1_get_board_info(unsigned int board_id);
	int t1_seeprom_read(adapter_t adapter, u32 addr, __le32 data);
	int t1_get_board_rev(adapter_t adapter, const struct board_info bi,
	struct adapter_params *p);
	int t1_init_hw_modules(adapter_t *adapter);
	int t1_init_sw_modules(adapter_t adapter, const struct board_info bi);
	void t1_free_sw_modules(adapter_t *adapter);
	void t1_link_changed(adapter_t *adapter, int port_id);
	void t1_link_negotiated(adapter_t *adapter, int port_id, int link_stat,
	int speed, int duplex, int pause);
	#endif /* _CXGB_COMMON_H_ */