/* * Copyright (c) 2013 Johannes Berg * * This file is free software: you may copy, redistribute and/or modify it * under the terms of the GNU General Public License as published by the * Free Software Foundation, either version 2 of the License, or (at your * option) any later version. * * This file is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . * * This file incorporates work covered by the following copyright and * permission notice: * * Copyright (c) 2012 Qualcomm Atheros, Inc. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ #ifndef ALX_HW_H_ #define ALX_HW_H_ #include #include #include #include #include "reg.h" /* Transmit Packet Descriptor, contains 4 32-bit words. * * 31 16 0 * +----------------+----------------+ * | vlan-tag | buf length | * +----------------+----------------+ * | Word 1 | * +----------------+----------------+ * | Word 2: buf addr lo | * +----------------+----------------+ * | Word 3: buf addr hi | * +----------------+----------------+ * * Word 2 and 3 combine to form a 64-bit buffer address * * Word 1 has three forms, depending on the state of bit 8/12/13: * if bit8 =='1', the definition is just for custom checksum offload. * if bit8 == '0' && bit12 == '1' && bit13 == '1', the *FIRST* descriptor * for the skb is special for LSO V2, Word 2 become total skb length , * Word 3 is meaningless. * other condition, the definition is for general skb or ip/tcp/udp * checksum or LSO(TSO) offload. * * Here is the depiction: * * 0-+ 0-+ * 1 | 1 | * 2 | 2 | * 3 | Payload offset 3 | L4 header offset * 4 | (7:0) 4 | (7:0) * 5 | 5 | * 6 | 6 | * 7-+ 7-+ * 8 Custom csum enable = 1 8 Custom csum enable = 0 * 9 General IPv4 checksum 9 General IPv4 checksum * 10 General TCP checksum 10 General TCP checksum * 11 General UDP checksum 11 General UDP checksum * 12 Large Send Segment enable 12 Large Send Segment enable * 13 Large Send Segment type 13 Large Send Segment type * 14 VLAN tagged 14 VLAN tagged * 15 Insert VLAN tag 15 Insert VLAN tag * 16 IPv4 packet 16 IPv4 packet * 17 Ethernet frame type 17 Ethernet frame type * 18-+ 18-+ * 19 | 19 | * 20 | 20 | * 21 | Custom csum offset 21 | * 22 | (25:18) 22 | * 23 | 23 | MSS (30:18) * 24 | 24 | * 25-+ 25 | * 26-+ 26 | * 27 | 27 | * 28 | Reserved 28 | * 29 | 29 | * 30-+ 30-+ * 31 End of packet 31 End of packet */ struct alx_txd { __le16 len; __le16 vlan_tag; __le32 word1; union { __le64 addr; struct { __le32 pkt_len; __le32 resvd; } l; } adrl; } __packed; /* tpd word 1 */ #define TPD_CXSUMSTART_MASK 0x00FF #define TPD_CXSUMSTART_SHIFT 0 #define TPD_L4HDROFFSET_MASK 0x00FF #define TPD_L4HDROFFSET_SHIFT 0 #define TPD_CXSUM_EN_MASK 0x0001 #define TPD_CXSUM_EN_SHIFT 8 #define TPD_IP_XSUM_MASK 0x0001 #define TPD_IP_XSUM_SHIFT 9 #define TPD_TCP_XSUM_MASK 0x0001 #define TPD_TCP_XSUM_SHIFT 10 #define TPD_UDP_XSUM_MASK 0x0001 #define TPD_UDP_XSUM_SHIFT 11 #define TPD_LSO_EN_MASK 0x0001 #define TPD_LSO_EN_SHIFT 12 #define TPD_LSO_V2_MASK 0x0001 #define TPD_LSO_V2_SHIFT 13 #define TPD_VLTAGGED_MASK 0x0001 #define TPD_VLTAGGED_SHIFT 14 #define TPD_INS_VLTAG_MASK 0x0001 #define TPD_INS_VLTAG_SHIFT 15 #define TPD_IPV4_MASK 0x0001 #define TPD_IPV4_SHIFT 16 #define TPD_ETHTYPE_MASK 0x0001 #define TPD_ETHTYPE_SHIFT 17 #define TPD_CXSUMOFFSET_MASK 0x00FF #define TPD_CXSUMOFFSET_SHIFT 18 #define TPD_MSS_MASK 0x1FFF #define TPD_MSS_SHIFT 18 #define TPD_EOP_MASK 0x0001 #define TPD_EOP_SHIFT 31 #define DESC_GET(_x, _name) ((_x) >> _name##SHIFT & _name##MASK) /* Receive Free Descriptor */ struct alx_rfd { __le64 addr; /* data buffer address, length is * declared in register --- every * buffer has the same size */ } __packed; /* Receive Return Descriptor, contains 4 32-bit words. * * 31 16 0 * +----------------+----------------+ * | Word 0 | * +----------------+----------------+ * | Word 1: RSS Hash value | * +----------------+----------------+ * | Word 2 | * +----------------+----------------+ * | Word 3 | * +----------------+----------------+ * * Word 0 depiction & Word 2 depiction: * * 0--+ 0--+ * 1 | 1 | * 2 | 2 | * 3 | 3 | * 4 | 4 | * 5 | 5 | * 6 | 6 | * 7 | IP payload checksum 7 | VLAN tag * 8 | (15:0) 8 | (15:0) * 9 | 9 | * 10 | 10 | * 11 | 11 | * 12 | 12 | * 13 | 13 | * 14 | 14 | * 15-+ 15-+ * 16-+ 16-+ * 17 | Number of RFDs 17 | * 18 | (19:16) 18 | * 19-+ 19 | Protocol ID * 20-+ 20 | (23:16) * 21 | 21 | * 22 | 22 | * 23 | 23-+ * 24 | 24 | Reserved * 25 | Start index of RFD-ring 25-+ * 26 | (31:20) 26 | RSS Q-num (27:25) * 27 | 27-+ * 28 | 28-+ * 29 | 29 | RSS Hash algorithm * 30 | 30 | (31:28) * 31-+ 31-+ * * Word 3 depiction: * * 0--+ * 1 | * 2 | * 3 | * 4 | * 5 | * 6 | * 7 | Packet length (include FCS) * 8 | (13:0) * 9 | * 10 | * 11 | * 12 | * 13-+ * 14 L4 Header checksum error * 15 IPv4 checksum error * 16 VLAN tagged * 17-+ * 18 | Protocol ID (19:17) * 19-+ * 20 Receive error summary * 21 FCS(CRC) error * 22 Frame alignment error * 23 Truncated packet * 24 Runt packet * 25 Incomplete packet due to insufficient rx-desc * 26 Broadcast packet * 27 Multicast packet * 28 Ethernet type (EII or 802.3) * 29 FIFO overflow * 30 Length error (for 802.3, length field mismatch with actual len) * 31 Updated, indicate to driver that this RRD is refreshed. */ struct alx_rrd { __le32 word0; __le32 rss_hash; __le32 word2; __le32 word3; } __packed; /* rrd word 0 */ #define RRD_XSUM_MASK 0xFFFF #define RRD_XSUM_SHIFT 0 #define RRD_NOR_MASK 0x000F #define RRD_NOR_SHIFT 16 #define RRD_SI_MASK 0x0FFF #define RRD_SI_SHIFT 20 /* rrd word 2 */ #define RRD_VLTAG_MASK 0xFFFF #define RRD_VLTAG_SHIFT 0 #define RRD_PID_MASK 0x00FF #define RRD_PID_SHIFT 16 /* non-ip packet */ #define RRD_PID_NONIP 0 /* ipv4(only) */ #define RRD_PID_IPV4 1 /* tcp/ipv6 */ #define RRD_PID_IPV6TCP 2 /* tcp/ipv4 */ #define RRD_PID_IPV4TCP 3 /* udp/ipv6 */ #define RRD_PID_IPV6UDP 4 /* udp/ipv4 */ #define RRD_PID_IPV4UDP 5 /* ipv6(only) */ #define RRD_PID_IPV6 6 /* LLDP packet */ #define RRD_PID_LLDP 7 /* 1588 packet */ #define RRD_PID_1588 8 #define RRD_RSSQ_MASK 0x0007 #define RRD_RSSQ_SHIFT 25 #define RRD_RSSALG_MASK 0x000F #define RRD_RSSALG_SHIFT 28 #define RRD_RSSALG_TCPV6 0x1 #define RRD_RSSALG_IPV6 0x2 #define RRD_RSSALG_TCPV4 0x4 #define RRD_RSSALG_IPV4 0x8 /* rrd word 3 */ #define RRD_PKTLEN_MASK 0x3FFF #define RRD_PKTLEN_SHIFT 0 #define RRD_ERR_L4_MASK 0x0001 #define RRD_ERR_L4_SHIFT 14 #define RRD_ERR_IPV4_MASK 0x0001 #define RRD_ERR_IPV4_SHIFT 15 #define RRD_VLTAGGED_MASK 0x0001 #define RRD_VLTAGGED_SHIFT 16 #define RRD_OLD_PID_MASK 0x0007 #define RRD_OLD_PID_SHIFT 17 #define RRD_ERR_RES_MASK 0x0001 #define RRD_ERR_RES_SHIFT 20 #define RRD_ERR_FCS_MASK 0x0001 #define RRD_ERR_FCS_SHIFT 21 #define RRD_ERR_FAE_MASK 0x0001 #define RRD_ERR_FAE_SHIFT 22 #define RRD_ERR_TRUNC_MASK 0x0001 #define RRD_ERR_TRUNC_SHIFT 23 #define RRD_ERR_RUNT_MASK 0x0001 #define RRD_ERR_RUNT_SHIFT 24 #define RRD_ERR_ICMP_MASK 0x0001 #define RRD_ERR_ICMP_SHIFT 25 #define RRD_BCAST_MASK 0x0001 #define RRD_BCAST_SHIFT 26 #define RRD_MCAST_MASK 0x0001 #define RRD_MCAST_SHIFT 27 #define RRD_ETHTYPE_MASK 0x0001 #define RRD_ETHTYPE_SHIFT 28 #define RRD_ERR_FIFOV_MASK 0x0001 #define RRD_ERR_FIFOV_SHIFT 29 #define RRD_ERR_LEN_MASK 0x0001 #define RRD_ERR_LEN_SHIFT 30 #define RRD_UPDATED_MASK 0x0001 #define RRD_UPDATED_SHIFT 31 #define ALX_MAX_SETUP_LNK_CYCLE 50 /* for FlowControl */ #define ALX_FC_RX 0x01 #define ALX_FC_TX 0x02 #define ALX_FC_ANEG 0x04 /* for sleep control */ #define ALX_SLEEP_WOL_PHY 0x00000001 #define ALX_SLEEP_WOL_MAGIC 0x00000002 #define ALX_SLEEP_CIFS 0x00000004 #define ALX_SLEEP_ACTIVE (ALX_SLEEP_WOL_PHY | \ ALX_SLEEP_WOL_MAGIC | \ ALX_SLEEP_CIFS) /* for RSS hash type */ #define ALX_RSS_HASH_TYPE_IPV4 0x1 #define ALX_RSS_HASH_TYPE_IPV4_TCP 0x2 #define ALX_RSS_HASH_TYPE_IPV6 0x4 #define ALX_RSS_HASH_TYPE_IPV6_TCP 0x8 #define ALX_RSS_HASH_TYPE_ALL (ALX_RSS_HASH_TYPE_IPV4 | \ ALX_RSS_HASH_TYPE_IPV4_TCP | \ ALX_RSS_HASH_TYPE_IPV6 | \ ALX_RSS_HASH_TYPE_IPV6_TCP) #define ALX_FRAME_PAD 16 #define ALX_RAW_MTU(_mtu) (_mtu + ETH_HLEN + ETH_FCS_LEN + VLAN_HLEN) #define ALX_MAX_FRAME_LEN(_mtu) (ALIGN((ALX_RAW_MTU(_mtu) + ALX_FRAME_PAD), 8)) #define ALX_DEF_RXBUF_SIZE ALX_MAX_FRAME_LEN(1500) #define ALX_MAX_JUMBO_PKT_SIZE (9*1024) #define ALX_MAX_TSO_PKT_SIZE (7*1024) #define ALX_MAX_FRAME_SIZE ALX_MAX_JUMBO_PKT_SIZE #define ALX_MAX_RX_QUEUES 8 #define ALX_MAX_TX_QUEUES 4 #define ALX_MAX_HANDLED_INTRS 5 #define ALX_ISR_MISC (ALX_ISR_PCIE_LNKDOWN | \ ALX_ISR_DMAW | \ ALX_ISR_DMAR | \ ALX_ISR_SMB | \ ALX_ISR_MANU | \ ALX_ISR_TIMER) #define ALX_ISR_FATAL (ALX_ISR_PCIE_LNKDOWN | \ ALX_ISR_DMAW | ALX_ISR_DMAR) #define ALX_ISR_ALERT (ALX_ISR_RXF_OV | \ ALX_ISR_TXF_UR | \ ALX_ISR_RFD_UR) #define ALX_ISR_ALL_QUEUES (ALX_ISR_TX_Q0 | \ ALX_ISR_TX_Q1 | \ ALX_ISR_TX_Q2 | \ ALX_ISR_TX_Q3 | \ ALX_ISR_RX_Q0 | \ ALX_ISR_RX_Q1 | \ ALX_ISR_RX_Q2 | \ ALX_ISR_RX_Q3 | \ ALX_ISR_RX_Q4 | \ ALX_ISR_RX_Q5 | \ ALX_ISR_RX_Q6 | \ ALX_ISR_RX_Q7) /* Statistics counters collected by the MAC * * The order of the fields must match the strings in alx_gstrings_stats * All stats fields should be u64 * See ethtool.c */ struct alx_hw_stats { /* rx */ u64 rx_ok; /* good RX packets */ u64 rx_bcast; /* good RX broadcast packets */ u64 rx_mcast; /* good RX multicast packets */ u64 rx_pause; /* RX pause frames */ u64 rx_ctrl; /* RX control packets other than pause frames */ u64 rx_fcs_err; /* RX packets with bad FCS */ u64 rx_len_err; /* RX packets with length != actual size */ u64 rx_byte_cnt; /* good bytes received. FCS is NOT included */ u64 rx_runt; /* RX packets < 64 bytes with good FCS */ u64 rx_frag; /* RX packets < 64 bytes with bad FCS */ u64 rx_sz_64B; /* 64 byte RX packets */ u64 rx_sz_127B; /* 65-127 byte RX packets */ u64 rx_sz_255B; /* 128-255 byte RX packets */ u64 rx_sz_511B; /* 256-511 byte RX packets */ u64 rx_sz_1023B; /* 512-1023 byte RX packets */ u64 rx_sz_1518B; /* 1024-1518 byte RX packets */ u64 rx_sz_max; /* 1519 byte to MTU RX packets */ u64 rx_ov_sz; /* truncated RX packets, size > MTU */ u64 rx_ov_rxf; /* frames dropped due to RX FIFO overflow */ u64 rx_ov_rrd; /* frames dropped due to RRD overflow */ u64 rx_align_err; /* alignment errors */ u64 rx_bc_byte_cnt; /* RX broadcast bytes, excluding FCS */ u64 rx_mc_byte_cnt; /* RX multicast bytes, excluding FCS */ u64 rx_err_addr; /* packets dropped due to address filtering */ /* tx */ u64 tx_ok; /* good TX packets */ u64 tx_bcast; /* good TX broadcast packets */ u64 tx_mcast; /* good TX multicast packets */ u64 tx_pause; /* TX pause frames */ u64 tx_exc_defer; /* TX packets deferred excessively */ u64 tx_ctrl; /* TX control frames, excluding pause frames */ u64 tx_defer; /* TX packets deferred */ u64 tx_byte_cnt; /* bytes transmitted, FCS is NOT included */ u64 tx_sz_64B; /* 64 byte TX packets */ u64 tx_sz_127B; /* 65-127 byte TX packets */ u64 tx_sz_255B; /* 128-255 byte TX packets */ u64 tx_sz_511B; /* 256-511 byte TX packets */ u64 tx_sz_1023B; /* 512-1023 byte TX packets */ u64 tx_sz_1518B; /* 1024-1518 byte TX packets */ u64 tx_sz_max; /* 1519 byte to MTU TX packets */ u64 tx_single_col; /* packets TX after a single collision */ u64 tx_multi_col; /* packets TX after multiple collisions */ u64 tx_late_col; /* TX packets with late collisions */ u64 tx_abort_col; /* TX packets aborted w/excessive collisions */ u64 tx_underrun; /* TX packets aborted due to TX FIFO underrun * or TRD FIFO underrun */ u64 tx_trd_eop; /* reads beyond the EOP into the next frame * when TRD was not written timely */ u64 tx_len_err; /* TX packets where length != actual size */ u64 tx_trunc; /* TX packets truncated due to size > MTU */ u64 tx_bc_byte_cnt; /* broadcast bytes transmitted, excluding FCS */ u64 tx_mc_byte_cnt; /* multicast bytes transmitted, excluding FCS */ u64 update; }; /* maximum interrupt vectors for msix */ #define ALX_MAX_MSIX_INTRS 16 #define ALX_GET_FIELD(_data, _field) \ (((_data) >> _field ## _SHIFT) & _field ## _MASK) #define ALX_SET_FIELD(_data, _field, _value) do { \ (_data) &= ~(_field ## _MASK << _field ## _SHIFT); \ (_data) |= ((_value) & _field ## _MASK) << _field ## _SHIFT;\ } while (0) struct alx_hw { struct pci_dev *pdev; u8 __iomem *hw_addr; /* current & permanent mac addr */ u8 mac_addr[ETH_ALEN]; u8 perm_addr[ETH_ALEN]; u16 mtu; u16 imt; u8 dma_chnl; u8 max_dma_chnl; /* tpd threshold to trig INT */ u32 ith_tpd; u32 rx_ctrl; u32 mc_hash[2]; u32 smb_timer; /* SPEED_* + DUPLEX_*, SPEED_UNKNOWN if link is down */ int link_speed; u8 duplex; /* auto-neg advertisement or force mode config */ u8 flowctrl; u32 adv_cfg; spinlock_t mdio_lock; struct mdio_if_info mdio; u16 phy_id[2]; /* PHY link patch flag */ bool lnk_patch; /* cumulated stats from the hardware (registers are cleared on read) */ struct alx_hw_stats stats; }; static inline int alx_hw_revision(struct alx_hw *hw) { return hw->pdev->revision >> ALX_PCI_REVID_SHIFT; } static inline bool alx_hw_with_cr(struct alx_hw *hw) { return hw->pdev->revision & 1; } static inline bool alx_hw_giga(struct alx_hw *hw) { return hw->pdev->device & 1; } static inline void alx_write_mem8(struct alx_hw *hw, u32 reg, u8 val) { writeb(val, hw->hw_addr + reg); } static inline void alx_write_mem16(struct alx_hw *hw, u32 reg, u16 val) { writew(val, hw->hw_addr + reg); } static inline u16 alx_read_mem16(struct alx_hw *hw, u32 reg) { return readw(hw->hw_addr + reg); } static inline void alx_write_mem32(struct alx_hw *hw, u32 reg, u32 val) { writel(val, hw->hw_addr + reg); } static inline u32 alx_read_mem32(struct alx_hw *hw, u32 reg) { return readl(hw->hw_addr + reg); } static inline void alx_post_write(struct alx_hw *hw) { readl(hw->hw_addr); } int alx_get_perm_macaddr(struct alx_hw *hw, u8 *addr); void alx_reset_phy(struct alx_hw *hw); void alx_reset_pcie(struct alx_hw *hw); void alx_enable_aspm(struct alx_hw *hw, bool l0s_en, bool l1_en); int alx_setup_speed_duplex(struct alx_hw *hw, u32 ethadv, u8 flowctrl); void alx_post_phy_link(struct alx_hw *hw); int alx_read_phy_reg(struct alx_hw *hw, u16 reg, u16 *phy_data); int alx_write_phy_reg(struct alx_hw *hw, u16 reg, u16 phy_data); int alx_read_phy_ext(struct alx_hw *hw, u8 dev, u16 reg, u16 *pdata); int alx_write_phy_ext(struct alx_hw *hw, u8 dev, u16 reg, u16 data); int alx_read_phy_link(struct alx_hw *hw); int alx_clear_phy_intr(struct alx_hw *hw); void alx_cfg_mac_flowcontrol(struct alx_hw *hw, u8 fc); void alx_start_mac(struct alx_hw *hw); int alx_reset_mac(struct alx_hw *hw); void alx_set_macaddr(struct alx_hw *hw, const u8 *addr); bool alx_phy_configured(struct alx_hw *hw); void alx_configure_basic(struct alx_hw *hw); void alx_mask_msix(struct alx_hw *hw, int index, bool mask); void alx_disable_rss(struct alx_hw *hw); bool alx_get_phy_info(struct alx_hw *hw); void alx_update_hw_stats(struct alx_hw *hw); static inline u32 alx_speed_to_ethadv(int speed, u8 duplex) { if (speed == SPEED_1000 && duplex == DUPLEX_FULL) return ADVERTISED_1000baseT_Full; if (speed == SPEED_100 && duplex == DUPLEX_FULL) return ADVERTISED_100baseT_Full; if (speed == SPEED_100 && duplex== DUPLEX_HALF) return ADVERTISED_100baseT_Half; if (speed == SPEED_10 && duplex == DUPLEX_FULL) return ADVERTISED_10baseT_Full; if (speed == SPEED_10 && duplex == DUPLEX_HALF) return ADVERTISED_10baseT_Half; return 0; } #endif