1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */
2*4882a593Smuzhiyun /* Atlantic Network Driver
3*4882a593Smuzhiyun *
4*4882a593Smuzhiyun * Copyright (C) 2014-2019 aQuantia Corporation
5*4882a593Smuzhiyun * Copyright (C) 2019-2020 Marvell International Ltd.
6*4882a593Smuzhiyun */
7*4882a593Smuzhiyun
8*4882a593Smuzhiyun /* File aq_nic.h: Declaration of common code for NIC. */
9*4882a593Smuzhiyun
10*4882a593Smuzhiyun #ifndef AQ_NIC_H
11*4882a593Smuzhiyun #define AQ_NIC_H
12*4882a593Smuzhiyun
13*4882a593Smuzhiyun #include "aq_common.h"
14*4882a593Smuzhiyun #include "aq_rss.h"
15*4882a593Smuzhiyun #include "aq_hw.h"
16*4882a593Smuzhiyun
17*4882a593Smuzhiyun struct aq_ring_s;
18*4882a593Smuzhiyun struct aq_hw_ops;
19*4882a593Smuzhiyun struct aq_fw_s;
20*4882a593Smuzhiyun struct aq_vec_s;
21*4882a593Smuzhiyun struct aq_macsec_cfg;
22*4882a593Smuzhiyun struct aq_ptp_s;
23*4882a593Smuzhiyun enum aq_rx_filter_type;
24*4882a593Smuzhiyun
25*4882a593Smuzhiyun enum aq_fc_mode {
26*4882a593Smuzhiyun AQ_NIC_FC_OFF = 0,
27*4882a593Smuzhiyun AQ_NIC_FC_TX,
28*4882a593Smuzhiyun AQ_NIC_FC_RX,
29*4882a593Smuzhiyun AQ_NIC_FC_FULL,
30*4882a593Smuzhiyun };
31*4882a593Smuzhiyun
32*4882a593Smuzhiyun struct aq_fc_info {
33*4882a593Smuzhiyun enum aq_fc_mode req;
34*4882a593Smuzhiyun enum aq_fc_mode cur;
35*4882a593Smuzhiyun };
36*4882a593Smuzhiyun
37*4882a593Smuzhiyun struct aq_nic_cfg_s {
38*4882a593Smuzhiyun const struct aq_hw_caps_s *aq_hw_caps;
39*4882a593Smuzhiyun u64 features;
40*4882a593Smuzhiyun u32 rxds; /* rx ring size, descriptors # */
41*4882a593Smuzhiyun u32 txds; /* tx ring size, descriptors # */
42*4882a593Smuzhiyun u32 vecs; /* allocated rx/tx vectors */
43*4882a593Smuzhiyun u32 link_irq_vec;
44*4882a593Smuzhiyun u32 irq_type;
45*4882a593Smuzhiyun u32 itr;
46*4882a593Smuzhiyun u16 rx_itr;
47*4882a593Smuzhiyun u16 tx_itr;
48*4882a593Smuzhiyun u32 rxpageorder;
49*4882a593Smuzhiyun u32 num_rss_queues;
50*4882a593Smuzhiyun u32 mtu;
51*4882a593Smuzhiyun struct aq_fc_info fc;
52*4882a593Smuzhiyun u32 link_speed_msk;
53*4882a593Smuzhiyun u32 wol;
54*4882a593Smuzhiyun u8 is_vlan_rx_strip;
55*4882a593Smuzhiyun u8 is_vlan_tx_insert;
56*4882a593Smuzhiyun bool is_vlan_force_promisc;
57*4882a593Smuzhiyun u16 is_mc_list_enabled;
58*4882a593Smuzhiyun u16 mc_list_count;
59*4882a593Smuzhiyun bool is_autoneg;
60*4882a593Smuzhiyun bool is_polling;
61*4882a593Smuzhiyun bool is_rss;
62*4882a593Smuzhiyun bool is_lro;
63*4882a593Smuzhiyun bool is_qos;
64*4882a593Smuzhiyun bool is_ptp;
65*4882a593Smuzhiyun bool is_media_detect;
66*4882a593Smuzhiyun int downshift_counter;
67*4882a593Smuzhiyun enum aq_tc_mode tc_mode;
68*4882a593Smuzhiyun u32 priv_flags;
69*4882a593Smuzhiyun u8 tcs;
70*4882a593Smuzhiyun u8 prio_tc_map[8];
71*4882a593Smuzhiyun u32 tc_max_rate[AQ_CFG_TCS_MAX];
72*4882a593Smuzhiyun unsigned long tc_min_rate_msk;
73*4882a593Smuzhiyun u32 tc_min_rate[AQ_CFG_TCS_MAX];
74*4882a593Smuzhiyun struct aq_rss_parameters aq_rss;
75*4882a593Smuzhiyun u32 eee_speeds;
76*4882a593Smuzhiyun };
77*4882a593Smuzhiyun
78*4882a593Smuzhiyun #define AQ_NIC_FLAG_STARTED 0x00000004U
79*4882a593Smuzhiyun #define AQ_NIC_FLAG_STOPPING 0x00000008U
80*4882a593Smuzhiyun #define AQ_NIC_FLAG_RESETTING 0x00000010U
81*4882a593Smuzhiyun #define AQ_NIC_FLAG_CLOSING 0x00000020U
82*4882a593Smuzhiyun #define AQ_NIC_PTP_DPATH_UP 0x02000000U
83*4882a593Smuzhiyun #define AQ_NIC_LINK_DOWN 0x04000000U
84*4882a593Smuzhiyun #define AQ_NIC_FLAG_ERR_UNPLUG 0x40000000U
85*4882a593Smuzhiyun #define AQ_NIC_FLAG_ERR_HW 0x80000000U
86*4882a593Smuzhiyun
87*4882a593Smuzhiyun #define AQ_NIC_QUIRK_BAD_PTP BIT(0)
88*4882a593Smuzhiyun
89*4882a593Smuzhiyun #define AQ_NIC_WOL_MODES (WAKE_MAGIC |\
90*4882a593Smuzhiyun WAKE_PHY)
91*4882a593Smuzhiyun
92*4882a593Smuzhiyun #define AQ_NIC_CFG_RING_PER_TC(_NIC_CFG_) \
93*4882a593Smuzhiyun (((_NIC_CFG_)->tc_mode == AQ_TC_MODE_4TCS) ? 8 : 4)
94*4882a593Smuzhiyun
95*4882a593Smuzhiyun #define AQ_NIC_CFG_TCVEC2RING(_NIC_CFG_, _TC_, _VEC_) \
96*4882a593Smuzhiyun ((_TC_) * AQ_NIC_CFG_RING_PER_TC(_NIC_CFG_) + (_VEC_))
97*4882a593Smuzhiyun
98*4882a593Smuzhiyun #define AQ_NIC_RING2QMAP(_NIC_, _ID_) \
99*4882a593Smuzhiyun ((_ID_) / AQ_NIC_CFG_RING_PER_TC(&(_NIC_)->aq_nic_cfg) * \
100*4882a593Smuzhiyun (_NIC_)->aq_vecs + \
101*4882a593Smuzhiyun ((_ID_) % AQ_NIC_CFG_RING_PER_TC(&(_NIC_)->aq_nic_cfg)))
102*4882a593Smuzhiyun
103*4882a593Smuzhiyun struct aq_hw_rx_fl2 {
104*4882a593Smuzhiyun struct aq_rx_filter_vlan aq_vlans[AQ_VLAN_MAX_FILTERS];
105*4882a593Smuzhiyun };
106*4882a593Smuzhiyun
107*4882a593Smuzhiyun struct aq_hw_rx_fl3l4 {
108*4882a593Smuzhiyun u8 active_ipv4;
109*4882a593Smuzhiyun u8 active_ipv6:2;
110*4882a593Smuzhiyun u8 is_ipv6;
111*4882a593Smuzhiyun u8 reserved_count;
112*4882a593Smuzhiyun };
113*4882a593Smuzhiyun
114*4882a593Smuzhiyun struct aq_hw_rx_fltrs_s {
115*4882a593Smuzhiyun struct hlist_head filter_list;
116*4882a593Smuzhiyun u16 active_filters;
117*4882a593Smuzhiyun struct aq_hw_rx_fl2 fl2;
118*4882a593Smuzhiyun struct aq_hw_rx_fl3l4 fl3l4;
119*4882a593Smuzhiyun /* filter ether type */
120*4882a593Smuzhiyun u8 fet_reserved_count;
121*4882a593Smuzhiyun };
122*4882a593Smuzhiyun
123*4882a593Smuzhiyun struct aq_nic_s {
124*4882a593Smuzhiyun atomic_t flags;
125*4882a593Smuzhiyun u32 msg_enable;
126*4882a593Smuzhiyun struct aq_vec_s *aq_vec[AQ_CFG_VECS_MAX];
127*4882a593Smuzhiyun struct aq_ring_s *aq_ring_tx[AQ_HW_QUEUES_MAX];
128*4882a593Smuzhiyun struct aq_hw_s *aq_hw;
129*4882a593Smuzhiyun struct net_device *ndev;
130*4882a593Smuzhiyun unsigned int aq_vecs;
131*4882a593Smuzhiyun unsigned int packet_filter;
132*4882a593Smuzhiyun unsigned int power_state;
133*4882a593Smuzhiyun u8 port;
134*4882a593Smuzhiyun const struct aq_hw_ops *aq_hw_ops;
135*4882a593Smuzhiyun const struct aq_fw_ops *aq_fw_ops;
136*4882a593Smuzhiyun struct aq_nic_cfg_s aq_nic_cfg;
137*4882a593Smuzhiyun struct timer_list service_timer;
138*4882a593Smuzhiyun struct work_struct service_task;
139*4882a593Smuzhiyun struct timer_list polling_timer;
140*4882a593Smuzhiyun struct aq_hw_link_status_s link_status;
141*4882a593Smuzhiyun struct {
142*4882a593Smuzhiyun u32 count;
143*4882a593Smuzhiyun u8 ar[AQ_HW_MULTICAST_ADDRESS_MAX][ETH_ALEN];
144*4882a593Smuzhiyun } mc_list;
145*4882a593Smuzhiyun /* Bitmask of currently assigned vlans from linux */
146*4882a593Smuzhiyun unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
147*4882a593Smuzhiyun
148*4882a593Smuzhiyun struct pci_dev *pdev;
149*4882a593Smuzhiyun unsigned int msix_entry_mask;
150*4882a593Smuzhiyun u32 irqvecs;
151*4882a593Smuzhiyun /* mutex to serialize FW interface access operations */
152*4882a593Smuzhiyun struct mutex fwreq_mutex;
153*4882a593Smuzhiyun #if IS_ENABLED(CONFIG_MACSEC)
154*4882a593Smuzhiyun struct aq_macsec_cfg *macsec_cfg;
155*4882a593Smuzhiyun /* mutex to protect data in macsec_cfg */
156*4882a593Smuzhiyun struct mutex macsec_mutex;
157*4882a593Smuzhiyun #endif
158*4882a593Smuzhiyun /* PTP support */
159*4882a593Smuzhiyun struct aq_ptp_s *aq_ptp;
160*4882a593Smuzhiyun struct aq_hw_rx_fltrs_s aq_hw_rx_fltrs;
161*4882a593Smuzhiyun };
162*4882a593Smuzhiyun
aq_nic_get_dev(struct aq_nic_s * self)163*4882a593Smuzhiyun static inline struct device *aq_nic_get_dev(struct aq_nic_s *self)
164*4882a593Smuzhiyun {
165*4882a593Smuzhiyun return self->ndev->dev.parent;
166*4882a593Smuzhiyun }
167*4882a593Smuzhiyun
168*4882a593Smuzhiyun void aq_nic_ndev_init(struct aq_nic_s *self);
169*4882a593Smuzhiyun struct aq_nic_s *aq_nic_alloc_hot(struct net_device *ndev);
170*4882a593Smuzhiyun void aq_nic_set_tx_ring(struct aq_nic_s *self, unsigned int idx,
171*4882a593Smuzhiyun struct aq_ring_s *ring);
172*4882a593Smuzhiyun struct net_device *aq_nic_get_ndev(struct aq_nic_s *self);
173*4882a593Smuzhiyun int aq_nic_init(struct aq_nic_s *self);
174*4882a593Smuzhiyun void aq_nic_cfg_start(struct aq_nic_s *self);
175*4882a593Smuzhiyun int aq_nic_ndev_register(struct aq_nic_s *self);
176*4882a593Smuzhiyun void aq_nic_ndev_free(struct aq_nic_s *self);
177*4882a593Smuzhiyun int aq_nic_start(struct aq_nic_s *self);
178*4882a593Smuzhiyun unsigned int aq_nic_map_skb(struct aq_nic_s *self, struct sk_buff *skb,
179*4882a593Smuzhiyun struct aq_ring_s *ring);
180*4882a593Smuzhiyun int aq_nic_xmit(struct aq_nic_s *self, struct sk_buff *skb);
181*4882a593Smuzhiyun int aq_nic_get_regs(struct aq_nic_s *self, struct ethtool_regs *regs, void *p);
182*4882a593Smuzhiyun int aq_nic_get_regs_count(struct aq_nic_s *self);
183*4882a593Smuzhiyun u64 *aq_nic_get_stats(struct aq_nic_s *self, u64 *data);
184*4882a593Smuzhiyun int aq_nic_stop(struct aq_nic_s *self);
185*4882a593Smuzhiyun void aq_nic_deinit(struct aq_nic_s *self, bool link_down);
186*4882a593Smuzhiyun void aq_nic_set_power(struct aq_nic_s *self);
187*4882a593Smuzhiyun void aq_nic_free_hot_resources(struct aq_nic_s *self);
188*4882a593Smuzhiyun void aq_nic_free_vectors(struct aq_nic_s *self);
189*4882a593Smuzhiyun int aq_nic_realloc_vectors(struct aq_nic_s *self);
190*4882a593Smuzhiyun int aq_nic_set_mtu(struct aq_nic_s *self, int new_mtu);
191*4882a593Smuzhiyun int aq_nic_set_mac(struct aq_nic_s *self, struct net_device *ndev);
192*4882a593Smuzhiyun int aq_nic_set_packet_filter(struct aq_nic_s *self, unsigned int flags);
193*4882a593Smuzhiyun int aq_nic_set_multicast_list(struct aq_nic_s *self, struct net_device *ndev);
194*4882a593Smuzhiyun unsigned int aq_nic_get_link_speed(struct aq_nic_s *self);
195*4882a593Smuzhiyun void aq_nic_get_link_ksettings(struct aq_nic_s *self,
196*4882a593Smuzhiyun struct ethtool_link_ksettings *cmd);
197*4882a593Smuzhiyun int aq_nic_set_link_ksettings(struct aq_nic_s *self,
198*4882a593Smuzhiyun const struct ethtool_link_ksettings *cmd);
199*4882a593Smuzhiyun struct aq_nic_cfg_s *aq_nic_get_cfg(struct aq_nic_s *self);
200*4882a593Smuzhiyun u32 aq_nic_get_fw_version(struct aq_nic_s *self);
201*4882a593Smuzhiyun int aq_nic_set_loopback(struct aq_nic_s *self);
202*4882a593Smuzhiyun int aq_nic_set_downshift(struct aq_nic_s *self, int val);
203*4882a593Smuzhiyun int aq_nic_set_media_detect(struct aq_nic_s *self, int val);
204*4882a593Smuzhiyun int aq_nic_update_interrupt_moderation_settings(struct aq_nic_s *self);
205*4882a593Smuzhiyun void aq_nic_shutdown(struct aq_nic_s *self);
206*4882a593Smuzhiyun u8 aq_nic_reserve_filter(struct aq_nic_s *self, enum aq_rx_filter_type type);
207*4882a593Smuzhiyun void aq_nic_release_filter(struct aq_nic_s *self, enum aq_rx_filter_type type,
208*4882a593Smuzhiyun u32 location);
209*4882a593Smuzhiyun int aq_nic_setup_tc_mqprio(struct aq_nic_s *self, u32 tcs, u8 *prio_tc_map);
210*4882a593Smuzhiyun int aq_nic_setup_tc_max_rate(struct aq_nic_s *self, const unsigned int tc,
211*4882a593Smuzhiyun const u32 max_rate);
212*4882a593Smuzhiyun int aq_nic_setup_tc_min_rate(struct aq_nic_s *self, const unsigned int tc,
213*4882a593Smuzhiyun const u32 min_rate);
214*4882a593Smuzhiyun #endif /* AQ_NIC_H */
215