/* * Atheros AR71xx built-in ethernet mac driver * * Copyright (c) 2016-2017 The Linux Foundation. All rights reserved. * Copyright (C) 2008-2010 Gabor Juhos * Copyright (C) 2008 Imre Kaloz * * Based on Atheros' AG7100 driver * * This program is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 as published * by the Free Software Foundation. */ #ifndef __AG71XX_H #define __AG71XX_H #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #define AG71XX_DRV_NAME "ag71xx" #define AG71XX_DRV_VERSION "0.5.35" #define AR7240_NUM_PHYS 5 /* For our NAPI weight bigger does *NOT* mean better - it means more * D-cache misses and lots more wasted cycles than we'll ever * possibly gain from saving instructions. */ #define AG71XX_NAPI_WEIGHT 32 #define AG71XX_OOM_REFILL (1 + HZ/10) #define AG71XX_INT_ERR (AG71XX_INT_RX_BE | AG71XX_INT_TX_BE) #define AG71XX_INT_TX (AG71XX_INT_TX_PS) #define AG71XX_INT_RX (AG71XX_INT_RX_PR | AG71XX_INT_RX_OF) #define AG71XX_INT_POLL (AG71XX_INT_RX | AG71XX_INT_TX) #define AG71XX_INT_INIT (AG71XX_INT_ERR | AG71XX_INT_POLL) #define AG71XX_TX_MTU_LEN 1540 #define AG71XX_RX_PKT_SIZE \ (ETH_FRAME_LEN + ETH_FCS_LEN + VLAN_HLEN) #define AG71XX_RX_BUF_SIZE (AG71XX_RX_PKT_SIZE + NET_SKB_PAD + NET_IP_ALIGN) /* The 802.11n driver circa 10.1.389 requires a significant amount of headroom * to avoid reallocating and copying when transmitting a buffer. This causes * this driver to pre-allocate enough headroom to avoid the reallocation later. */ #define AG71XX_HACK_WIFI_HEADROOM 128 #define AG71XX_TX_RING_SIZE_DEFAULT 128 #define AG71XX_RX_RING_SIZE_DEFAULT 224 #define AG71XX_TX_RING_SIZE_MAX 256 #define AG71XX_RX_RING_SIZE_MAX 256 #define AG71XX_JUMBO_LEN 9000 #define DESC_JUMBO_PKTLEN_M 0x3FFF #ifdef CONFIG_AG71XX_DEBUG #define DBG(fmt, args...) pr_debug(fmt, ## args) #else #define DBG(fmt, args...) do {} while (0) #endif #define ag71xx_assert(_cond) \ do { \ if (_cond) \ break; \ printk("%s,%d: assertion failed\n", __FILE__, __LINE__); \ BUG(); \ } while (0) struct ag71xx_desc { volatile u32 data; volatile u32 ctrl; #define DESC_EMPTY BIT(31) #define DESC_MORE BIT(24) #define DESC_PKTLEN_M 0xfff volatile u32 next; volatile u32 pad; } __attribute__((aligned(4))); struct ag71xx_buf { struct sk_buff *skb; struct ag71xx_desc *desc; struct ag71xx_buf *next; union { u16 len; dma_addr_t dma_addr; }; }; /* RX or TX descriptor ring. */ struct ag71xx_ring { /* "Hot" fields in the data path. */ struct ag71xx_buf *curr; struct ag71xx_buf *dirty; u16 size; u16 used; /* "Cold" fields - not used in the data path. */ struct ag71xx_buf *buf; u16 mask; u16 desc_size; u8 *descs_cpu; dma_addr_t descs_dma; void __iomem *iomem; }; struct ag71xx_mdio { struct mii_bus *mii_bus; int mii_irq[PHY_MAX_ADDR]; void __iomem *mdio_base; struct ag71xx_mdio_platform_data *pdata; }; struct ag71xx_int_stats { unsigned long rx_pr; unsigned long rx_be; unsigned long rx_of; unsigned long tx_ps; unsigned long tx_be; unsigned long tx_ur; unsigned long total; }; struct ag71xx_napi_stats { unsigned long napi_calls; unsigned long rx_count; unsigned long rx_packets; unsigned long rx_packets_max; unsigned long tx_count; unsigned long tx_packets; unsigned long tx_packets_max; unsigned long rx[AG71XX_NAPI_WEIGHT + 1]; unsigned long tx[AG71XX_NAPI_WEIGHT + 1]; }; struct ag71xx_debug { struct dentry *debugfs_dir; struct ag71xx_int_stats int_stats; struct ag71xx_napi_stats napi_stats; }; struct ag71xx { /* Critical data related to the per-packet data path are clustered * early in this structure to help improve the D-cache footprint. */ struct ag71xx_ring rx_ring ____cacheline_aligned; struct ag71xx_ring tx_ring ____cacheline_aligned; void __iomem *rx_ctrl_reg; void __iomem *rx_status_reg; void __iomem *tx_ctrl_reg; void __iomem *tx_status_reg; void __iomem *int_status_reg; unsigned int rx_buf_offset; unsigned int rx_buf_size; struct net_device *dev; struct platform_device *pdev; /* Serialises access to regs */ spinlock_t lock; struct napi_struct napi; unsigned int gmac_num; /* From this point onwards we're not looking at per-packet fields. */ struct ag71xx_buf *ring_bufs; void __iomem *mac_base; void __iomem *sgmii_base; void __iomem *pll_base; u32 msg_enable; struct ag71xx_desc *stop_desc; dma_addr_t stop_desc_dma; bool tx_stopped; struct mii_bus *mii_bus; struct phy_device *phy_dev; void *phy_priv; unsigned int link; unsigned int speed; int duplex; struct work_struct restart_work; struct delayed_work link_work; #ifdef CONFIG_AG71XX_DEBUG_FS struct ag71xx_debug debug; #endif }; extern struct ethtool_ops ag71xx_ethtool_ops; void ag71xx_link_adjust(struct ag71xx *ag); int ag71xx_mdio_driver_init(void) __init; void ag71xx_mdio_driver_exit(void); int ag71xx_phy_connect(struct ag71xx *ag); void ag71xx_phy_disconnect(struct ag71xx *ag); void ag71xx_phy_start(struct ag71xx *ag); void ag71xx_phy_stop(struct ag71xx *ag); static inline struct ag71xx_platform_data *ag71xx_get_pdata(struct ag71xx *ag) { return ag->pdev->dev.platform_data; } /* Register offsets */ #define AG71XX_REG_MAC_CFG1 0x0000 #define AG71XX_REG_MAC_CFG2 0x0004 #define AG71XX_REG_MAC_IPG 0x0008 #define AG71XX_REG_MAC_HDX 0x000c #define AG71XX_REG_MAC_MFL 0x0010 #define AG71XX_REG_MII_CFG 0x0020 #define AG71XX_REG_MII_CMD 0x0024 #define AG71XX_REG_MII_ADDR 0x0028 #define AG71XX_REG_MII_CTRL 0x002c #define AG71XX_REG_MII_STATUS 0x0030 #define AG71XX_REG_MII_IND 0x0034 #define AG71XX_REG_MAC_IFCTL 0x0038 #define AG71XX_REG_MAC_ADDR1 0x0040 #define AG71XX_REG_MAC_ADDR2 0x0044 #define AG71XX_REG_FIFO_CFG0 0x0048 #define AG71XX_REG_FIFO_CFG1 0x004c #define AG71XX_REG_FIFO_CFG2 0x0050 #define AG71XX_REG_FIFO_CFG3 0x0054 #define AG71XX_REG_FIFO_CFG4 0x0058 #define AG71XX_REG_FIFO_CFG5 0x005c #define AG71XX_REG_FIFO_RAM0 0x0060 #define AG71XX_REG_FIFO_RAM1 0x0064 #define AG71XX_REG_FIFO_RAM2 0x0068 #define AG71XX_REG_FIFO_RAM3 0x006c #define AG71XX_REG_FIFO_RAM4 0x0070 #define AG71XX_REG_FIFO_RAM5 0x0074 #define AG71XX_REG_FIFO_RAM6 0x0078 #define AG71XX_REG_FIFO_RAM7 0x007c #define AG71XX_REG_TX_CTRL 0x0180 #define AG71XX_REG_TX_DESC 0x0184 #define AG71XX_REG_TX_STATUS 0x0188 #define AG71XX_REG_RX_CTRL 0x018c #define AG71XX_REG_RX_DESC 0x0190 #define AG71XX_REG_RX_STATUS 0x0194 #define AG71XX_REG_INT_ENABLE 0x0198 #define AG71XX_REG_INT_STATUS 0x019c #define AG71XX_REG_FIFO_THRESH 0x01a4 #define AG71XX_REG_FIFO_DEPTH 0x01a8 #define AG71XX_REG_RX_SM 0x01b0 #define AG71XX_REG_TX_SM 0x01b4 #define AG71XX_REG_IG_ACL 0x23c #define AG71XX_IG_ACL_FRA_DISABLE 0x60000000 #define AG71XX_CFG_3_HD_VAL 0x00f00040 #define AG71XX_FIFO_TH_HD_HALF_VAL 0x00880060 #define AG71XX_FIFO_TH_HD_FULL_VAL 0x01d80160 #define MAC_CFG1_TXE BIT(0) /* Tx Enable */ #define MAC_CFG1_STX BIT(1) /* Synchronize Tx Enable */ #define MAC_CFG1_RXE BIT(2) /* Rx Enable */ #define MAC_CFG1_SRX BIT(3) /* Synchronize Rx Enable */ #define MAC_CFG1_TFC BIT(4) /* Tx Flow Control Enable */ #define MAC_CFG1_RFC BIT(5) /* Rx Flow Control Enable */ #define MAC_CFG1_LB BIT(8) /* Loopback mode */ #define MAC_CFG1_SR BIT(31) /* Soft Reset */ #define MAC_CFG2_FDX BIT(0) #define MAC_CFG2_CRC_EN BIT(1) #define MAC_CFG2_PAD_CRC_EN BIT(2) #define MAC_CFG2_LEN_CHECK BIT(4) #define MAC_CFG2_HUGE_FRAME_EN BIT(5) #define MAC_CFG2_IF_1000 BIT(9) #define MAC_CFG2_IF_10_100 BIT(8) #define FIFO_CFG0_WTM BIT(0) /* Watermark Module */ #define FIFO_CFG0_RXS BIT(1) /* Rx System Module */ #define FIFO_CFG0_RXF BIT(2) /* Rx Fabric Module */ #define FIFO_CFG0_TXS BIT(3) /* Tx System Module */ #define FIFO_CFG0_TXF BIT(4) /* Tx Fabric Module */ #define FIFO_CFG0_ALL (FIFO_CFG0_WTM | FIFO_CFG0_RXS | FIFO_CFG0_RXF \ | FIFO_CFG0_TXS | FIFO_CFG0_TXF) #define FIFO_CFG0_ENABLE_SHIFT 8 #define FIFO_CFG4_DE BIT(0) /* Drop Event */ #define FIFO_CFG4_DV BIT(1) /* RX_DV Event */ #define FIFO_CFG4_FC BIT(2) /* False Carrier */ #define FIFO_CFG4_CE BIT(3) /* Code Error */ #define FIFO_CFG4_CR BIT(4) /* CRC error */ #define FIFO_CFG4_LM BIT(5) /* Length Mismatch */ #define FIFO_CFG4_LO BIT(6) /* Length out of range */ #define FIFO_CFG4_OK BIT(7) /* Packet is OK */ #define FIFO_CFG4_MC BIT(8) /* Multicast Packet */ #define FIFO_CFG4_BC BIT(9) /* Broadcast Packet */ #define FIFO_CFG4_DR BIT(10) /* Dribble */ #define FIFO_CFG4_CF BIT(11) /* Control Frame */ #define FIFO_CFG4_PF BIT(12) /* Pause Frame */ #define FIFO_CFG4_UO BIT(13) /* Unsupported Opcode */ #define FIFO_CFG4_VT BIT(14) /* VLAN tag detected */ #define FIFO_CFG4_LE BIT(15) /* Long Event */ #define FIFO_CFG4_FT BIT(16) /* Frame Truncated */ #define FIFO_CFG4_UC BIT(17) /* Unicast Packet */ #define FIFO_CFG5_DE BIT(0) /* Drop Event */ #define FIFO_CFG5_DV BIT(1) /* RX_DV Event */ #define FIFO_CFG5_FC BIT(2) /* False Carrier */ #define FIFO_CFG5_CE BIT(3) /* Code Error */ #define FIFO_CFG5_CR BIT(4) /* CRC error */ #define FIFO_CFG5_LM BIT(5) /* Length Mismatch */ #define FIFO_CFG5_LO BIT(6) /* Length out of range */ #define FIFO_CFG5_OK BIT(7) /* Packet is OK */ #define FIFO_CFG5_MC BIT(8) /* Multicast Packet */ #define FIFO_CFG5_BC BIT(9) /* Broadcast Packet */ #define FIFO_CFG5_DR BIT(10) /* Dribble */ #define FIFO_CFG5_CF BIT(11) /* Control Frame */ #define FIFO_CFG5_PF BIT(12) /* Pause Frame */ #define FIFO_CFG5_UO BIT(13) /* Unsupported Opcode */ #define FIFO_CFG5_VT BIT(14) /* VLAN tag detected */ #define FIFO_CFG5_LE BIT(15) /* Long Event */ #define FIFO_CFG5_FT BIT(16) /* Frame Truncated */ #define FIFO_CFG5_UC BIT(17) /* Unicast Packet */ #define FIFO_CFG5_SF BIT(18) /* Short Frame */ #define FIFO_CFG5_BM BIT(19) /* Byte Mode */ #define AG71XX_INT_TX_PS BIT(0) #define AG71XX_INT_TX_UR BIT(1) #define AG71XX_INT_TX_BE BIT(3) #define AG71XX_INT_RX_PR BIT(4) #define AG71XX_INT_RX_OF BIT(6) #define AG71XX_INT_RX_BE BIT(7) #define MAC_IFCTL_SPEED BIT(16) #define MII_CFG_CLK_DIV_4 0 #define MII_CFG_CLK_DIV_6 2 #define MII_CFG_CLK_DIV_8 3 #define MII_CFG_CLK_DIV_10 4 #define MII_CFG_CLK_DIV_14 5 #define MII_CFG_CLK_DIV_20 6 #define MII_CFG_CLK_DIV_28 7 #define MII_CFG_CLK_DIV_34 8 #define MII_CFG_CLK_DIV_42 9 #define MII_CFG_CLK_DIV_50 10 #define MII_CFG_CLK_DIV_58 11 #define MII_CFG_CLK_DIV_66 12 #define MII_CFG_CLK_DIV_74 13 #define MII_CFG_CLK_DIV_82 14 #define MII_CFG_CLK_DIV_98 15 #define MII_CFG_RESET BIT(31) #define MII_CMD_WRITE 0x0 #define MII_CMD_READ 0x1 #define MII_ADDR_SHIFT 8 #define MII_IND_BUSY BIT(0) #define MII_IND_INVALID BIT(2) #define MII_PHY_SPEC_STATUS 0x11 #define MII_PHY_LINK_STATUS BIT(10) #define TX_CTRL_TXE BIT(0) /* Tx Enable */ #define TX_STATUS_PS BIT(0) /* Packet Sent */ #define TX_STATUS_UR BIT(1) /* Tx Underrun */ #define TX_STATUS_BE BIT(3) /* Bus Error */ #define RX_CTRL_RXE BIT(0) /* Rx Enable */ #define RX_STATUS_PR BIT(0) /* Packet Received */ #define RX_STATUS_OF BIT(2) /* Rx Overflow */ #define RX_STATUS_BE BIT(3) /* Bus Error */ #define QCA956X_DAM_RESET_OFFSET1 0xb90001bc #define QCA956X_DAM_RESET_OFFSET2 0xba0001bc #define QCA956X_JUMBO_ENABLE (BIT(28) | BIT(29)) #define QCA956X_DAM_RESET_SIZE 0x4 typedef enum { AG71XX_SGMII_SPEED_10T = 0, AG71XX_SGMII_SPEED_100T, AG71XX_SGMII_SPEED_1000T, } ag71xx_sgmii_speed_t; typedef enum { AG71XX_SGMII_HALF_DUPLEX = 0, AG71XX_SGMII_FULL_DUPLEX, } ag71xx_sgmii_duplex_t; #define SGMII_PHY_MGMT_CTRL 0x1c #define SGMII_SPEED_SEL1_SET(x) (x << 6) #define SGMII_SPEED_SEL0_SET(x) (x << 13) #define SGMII_PHY_RESET_SET(x) (x << 15) #define SGMII_DUPLEX_SET(x) (x << 8) #define SGMII_CONFIG 0x34 #define SGMII_MODE_CTRL_SET(x) (x) #define SGMII_FORCE_SPEED_SET(x) (x << 5) #define SGMII_SPEED_SET(x) (x << 6) #define SGMII_RESET 0x14 #define SGMII_RX_CLK_N BIT(0) #define SGMII_TX_CLK_N BIT(1) #define SGMII_RX_125M BIT(2) #define SGMII_TX_125M BIT(3) #define SGMII_HW_RX_125M BIT(4) #define SGMII_DEBUG 0x58 #define SGMII_LINK_MAX_TRY 10 #define AG71XX_PLL_SGMII 0x48 #define AG71XX_PLL_GIGE BIT(24) #define AG71XX_PLL_GIGE_CLK BIT(25) #define AG71XX_PLL_100 0x101 #define AG71XX_PLL_10 0x1313 #define AG71XX_INTF_CTRL_SPEED BIT(16) #define AG71XX_MAC0_OFFSET 0 #define AG71XX_MAC1_OFFSET 6 static inline void ag71xx_check_reg_offset(struct ag71xx *ag, unsigned reg) { switch (reg) { case AG71XX_REG_MAC_CFG1 ... AG71XX_REG_MAC_MFL: case AG71XX_REG_MAC_IFCTL ... AG71XX_REG_TX_SM: case AG71XX_REG_MII_CFG: break; default: BUG(); } } static inline void ag71xx_wr_fast(void __iomem *r, u32 value) { __raw_writel(value, r); } static inline void ag71xx_wr_flush(void __iomem *r) { (void)__raw_readl(r); } static inline void ag71xx_wr(struct ag71xx *ag, unsigned reg, u32 value) { void __iomem *r; ag71xx_check_reg_offset(ag, reg); r = ag->mac_base + reg; __raw_writel(value, r); /* flush write */ (void)__raw_readl(r); } static inline void ag71xx_sgmii_wr(struct ag71xx *ag, unsigned reg, u32 value) { void __iomem *r; r = ag->sgmii_base + reg; __raw_writel(value, r); /* flush write */ (void)__raw_readl(r); } static inline void ag71xx_pll_wr(struct ag71xx *ag, unsigned reg, u32 value) { void __iomem *r; r = ag->pll_base + reg; __raw_writel(value, r); /* flush write */ (void)__raw_readl(r); } static inline u32 ag71xx_rr_fast(void __iomem *r) { return __raw_readl(r); } static inline u32 ag71xx_pll_rr(struct ag71xx *ag, unsigned reg) { void __iomem *r; r = ag->pll_base + reg; return __raw_readl(r); } static inline u32 ag71xx_sgmii_rr(struct ag71xx *ag, unsigned reg) { void __iomem *r; r = ag->sgmii_base + reg; return __raw_readl(r); } static inline u32 ag71xx_rr(struct ag71xx *ag, unsigned reg) { void __iomem *r; ag71xx_check_reg_offset(ag, reg); r = ag->mac_base + reg; return __raw_readl(r); } static inline void ag71xx_sb(struct ag71xx *ag, unsigned reg, u32 mask) { void __iomem *r; ag71xx_check_reg_offset(ag, reg); r = ag->mac_base + reg; __raw_writel(__raw_readl(r) | mask, r); /* flush write */ (void)__raw_readl(r); } static inline void ag71xx_cb(struct ag71xx *ag, unsigned reg, u32 mask) { void __iomem *r; ag71xx_check_reg_offset(ag, reg); r = ag->mac_base + reg; __raw_writel(__raw_readl(r) & ~mask, r); /* flush write */ (void)__raw_readl(r); } static inline void ag71xx_int_enable(struct ag71xx *ag, u32 ints) { ag71xx_sb(ag, AG71XX_REG_INT_ENABLE, ints); } static inline void ag71xx_int_disable(struct ag71xx *ag, u32 ints) { ag71xx_cb(ag, AG71XX_REG_INT_ENABLE, ints); } #ifdef CONFIG_AG71XX_AR8216_SUPPORT void ag71xx_add_ar8216_header(struct ag71xx *ag, struct sk_buff *skb); int ag71xx_remove_ar8216_header(struct ag71xx *ag, struct sk_buff *skb, int pktlen); static inline int ag71xx_has_ar8216(struct ag71xx *ag) { return ag71xx_get_pdata(ag)->has_ar8216; } #else static inline void ag71xx_add_ar8216_header(struct ag71xx *ag, struct sk_buff *skb) { } static inline int ag71xx_remove_ar8216_header(struct ag71xx *ag, struct sk_buff *skb, int pktlen) { return 0; } static inline int ag71xx_has_ar8216(struct ag71xx *ag) { return 0; } #endif #ifdef CONFIG_AG71XX_DEBUG_FS int ag71xx_debugfs_root_init(void); void ag71xx_debugfs_root_exit(void); int ag71xx_debugfs_init(struct ag71xx *ag); void ag71xx_debugfs_exit(struct ag71xx *ag); void ag71xx_debugfs_update_int_stats(struct ag71xx *ag, u32 status); void ag71xx_debugfs_update_napi_stats(struct ag71xx *ag, int rx, int tx); #else static inline int ag71xx_debugfs_root_init(void) { return 0; } static inline void ag71xx_debugfs_root_exit(void) {} static inline int ag71xx_debugfs_init(struct ag71xx *ag) { return 0; } static inline void ag71xx_debugfs_exit(struct ag71xx *ag) {} static inline void ag71xx_debugfs_update_int_stats(struct ag71xx *ag, u32 status) {} static inline void ag71xx_debugfs_update_napi_stats(struct ag71xx *ag, int rx, int tx) {} #endif /* CONFIG_AG71XX_DEBUG_FS */ void ag71xx_ar7240_start(struct ag71xx *ag); void ag71xx_ar7240_stop(struct ag71xx *ag); int ag71xx_ar7240_init(struct ag71xx *ag); void ag71xx_ar7240_cleanup(struct ag71xx *ag); int ag71xx_mdio_mii_read(struct ag71xx_mdio *am, int addr, int reg); void ag71xx_mdio_mii_write(struct ag71xx_mdio *am, int addr, int reg, u16 val); u16 ar7240sw_phy_read(struct mii_bus *mii, unsigned phy_addr, unsigned reg_addr); int ar7240sw_phy_write(struct mii_bus *mii, unsigned phy_addr, unsigned reg_addr, u16 reg_val); void ag71xx_sgmii_flag_set(u8 flag); u8 ag71xx_sgmii_flag_get(void); void ag71xx_sgmii_set_link( struct ag71xx *ag, ag71xx_sgmii_speed_t speed, ag71xx_sgmii_duplex_t duplex); void ag71xx_sgmii_get_link( struct ag71xx *ag, ag71xx_sgmii_speed_t *speed, ag71xx_sgmii_duplex_t *duplex); typedef int (*port_link_notify_func)(unsigned char port_id, unsigned char link, unsigned char speed, unsigned char duplex); void ar7240_port_link_notify_register(port_link_notify_func func); #endif /* _AG71XX_H */