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 	enum aq_tc_mode tc_mode;
66 	u32 priv_flags;
67 	u8  tcs;
68 	u8 prio_tc_map[8];
69 	u32 tc_max_rate[AQ_CFG_TCS_MAX];
70 	unsigned long tc_min_rate_msk;
71 	u32 tc_min_rate[AQ_CFG_TCS_MAX];
72 	struct aq_rss_parameters aq_rss;
73 	u32 eee_speeds;
74 };
75 
76 #define AQ_NIC_FLAG_STARTED     0x00000004U
77 #define AQ_NIC_FLAG_STOPPING    0x00000008U
78 #define AQ_NIC_FLAG_RESETTING   0x00000010U
79 #define AQ_NIC_FLAG_CLOSING     0x00000020U
80 #define AQ_NIC_PTP_DPATH_UP     0x02000000U
81 #define AQ_NIC_LINK_DOWN        0x04000000U
82 #define AQ_NIC_FLAG_ERR_UNPLUG  0x40000000U
83 #define AQ_NIC_FLAG_ERR_HW      0x80000000U
84 
85 #define AQ_NIC_QUIRK_BAD_PTP    BIT(0)
86 
87 #define AQ_NIC_WOL_MODES        (WAKE_MAGIC |\
88 				 WAKE_PHY)
89 
90 #define AQ_NIC_CFG_RING_PER_TC(_NIC_CFG_) \
91 	(((_NIC_CFG_)->tc_mode == AQ_TC_MODE_4TCS) ? 8 : 4)
92 
93 #define AQ_NIC_CFG_TCVEC2RING(_NIC_CFG_, _TC_, _VEC_) \
94 	((_TC_) * AQ_NIC_CFG_RING_PER_TC(_NIC_CFG_) + (_VEC_))
95 
96 #define AQ_NIC_RING2QMAP(_NIC_, _ID_) \
97 	((_ID_) / AQ_NIC_CFG_RING_PER_TC(&(_NIC_)->aq_nic_cfg) * \
98 		(_NIC_)->aq_vecs + \
99 	((_ID_) % AQ_NIC_CFG_RING_PER_TC(&(_NIC_)->aq_nic_cfg)))
100 
101 struct aq_hw_rx_fl2 {
102 	struct aq_rx_filter_vlan aq_vlans[AQ_VLAN_MAX_FILTERS];
103 };
104 
105 struct aq_hw_rx_fl3l4 {
106 	u8 active_ipv4;
107 	u8 active_ipv6:2;
108 	u8 is_ipv6;
109 	u8 reserved_count;
110 };
111 
112 struct aq_hw_rx_fltrs_s {
113 	struct hlist_head     filter_list;
114 	u16                   active_filters;
115 	struct aq_hw_rx_fl2   fl2;
116 	struct aq_hw_rx_fl3l4 fl3l4;
117 	/* filter ether type */
118 	u8 fet_reserved_count;
119 };
120 
121 struct aq_nic_s {
122 	atomic_t flags;
123 	u32 msg_enable;
124 	struct aq_vec_s *aq_vec[AQ_CFG_VECS_MAX];
125 	struct aq_ring_s *aq_ring_tx[AQ_HW_QUEUES_MAX];
126 	struct aq_hw_s *aq_hw;
127 	struct net_device *ndev;
128 	unsigned int aq_vecs;
129 	unsigned int packet_filter;
130 	unsigned int power_state;
131 	u8 port;
132 	const struct aq_hw_ops *aq_hw_ops;
133 	const struct aq_fw_ops *aq_fw_ops;
134 	struct aq_nic_cfg_s aq_nic_cfg;
135 	struct timer_list service_timer;
136 	struct work_struct service_task;
137 	struct timer_list polling_timer;
138 	struct aq_hw_link_status_s link_status;
139 	struct {
140 		u32 count;
141 		u8 ar[AQ_HW_MULTICAST_ADDRESS_MAX][ETH_ALEN];
142 	} mc_list;
143 	/* Bitmask of currently assigned vlans from linux */
144 	unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
145 
146 	struct pci_dev *pdev;
147 	unsigned int msix_entry_mask;
148 	u32 irqvecs;
149 	/* mutex to serialize FW interface access operations */
150 	struct mutex fwreq_mutex;
151 #if IS_ENABLED(CONFIG_MACSEC)
152 	struct aq_macsec_cfg *macsec_cfg;
153 #endif
154 	/* PTP support */
155 	struct aq_ptp_s *aq_ptp;
156 	struct aq_hw_rx_fltrs_s aq_hw_rx_fltrs;
157 };
158 
159 static inline struct device *aq_nic_get_dev(struct aq_nic_s *self)
160 {
161 	return self->ndev->dev.parent;
162 }
163 
164 void aq_nic_ndev_init(struct aq_nic_s *self);
165 struct aq_nic_s *aq_nic_alloc_hot(struct net_device *ndev);
166 void aq_nic_set_tx_ring(struct aq_nic_s *self, unsigned int idx,
167 			struct aq_ring_s *ring);
168 struct net_device *aq_nic_get_ndev(struct aq_nic_s *self);
169 int aq_nic_init(struct aq_nic_s *self);
170 void aq_nic_cfg_start(struct aq_nic_s *self);
171 int aq_nic_ndev_register(struct aq_nic_s *self);
172 void aq_nic_ndev_free(struct aq_nic_s *self);
173 int aq_nic_start(struct aq_nic_s *self);
174 unsigned int aq_nic_map_skb(struct aq_nic_s *self, struct sk_buff *skb,
175 			    struct aq_ring_s *ring);
176 int aq_nic_xmit(struct aq_nic_s *self, struct sk_buff *skb);
177 int aq_nic_get_regs(struct aq_nic_s *self, struct ethtool_regs *regs, void *p);
178 int aq_nic_get_regs_count(struct aq_nic_s *self);
179 u64 *aq_nic_get_stats(struct aq_nic_s *self, u64 *data);
180 int aq_nic_stop(struct aq_nic_s *self);
181 void aq_nic_deinit(struct aq_nic_s *self, bool link_down);
182 void aq_nic_set_power(struct aq_nic_s *self);
183 void aq_nic_free_hot_resources(struct aq_nic_s *self);
184 void aq_nic_free_vectors(struct aq_nic_s *self);
185 int aq_nic_realloc_vectors(struct aq_nic_s *self);
186 int aq_nic_set_mtu(struct aq_nic_s *self, int new_mtu);
187 int aq_nic_set_mac(struct aq_nic_s *self, struct net_device *ndev);
188 int aq_nic_set_packet_filter(struct aq_nic_s *self, unsigned int flags);
189 int aq_nic_set_multicast_list(struct aq_nic_s *self, struct net_device *ndev);
190 unsigned int aq_nic_get_link_speed(struct aq_nic_s *self);
191 void aq_nic_get_link_ksettings(struct aq_nic_s *self,
192 			       struct ethtool_link_ksettings *cmd);
193 int aq_nic_set_link_ksettings(struct aq_nic_s *self,
194 			      const struct ethtool_link_ksettings *cmd);
195 struct aq_nic_cfg_s *aq_nic_get_cfg(struct aq_nic_s *self);
196 u32 aq_nic_get_fw_version(struct aq_nic_s *self);
197 int aq_nic_set_loopback(struct aq_nic_s *self);
198 int aq_nic_update_interrupt_moderation_settings(struct aq_nic_s *self);
199 void aq_nic_shutdown(struct aq_nic_s *self);
200 u8 aq_nic_reserve_filter(struct aq_nic_s *self, enum aq_rx_filter_type type);
201 void aq_nic_release_filter(struct aq_nic_s *self, enum aq_rx_filter_type type,
202 			   u32 location);
203 int aq_nic_setup_tc_mqprio(struct aq_nic_s *self, u32 tcs, u8 *prio_tc_map);
204 int aq_nic_setup_tc_max_rate(struct aq_nic_s *self, const unsigned int tc,
205 			     const u32 max_rate);
206 int aq_nic_setup_tc_min_rate(struct aq_nic_s *self, const unsigned int tc,
207 			     const u32 min_rate);
208 #endif /* AQ_NIC_H */
209