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