1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * aQuantia Corporation Network Driver
4  * Copyright (C) 2014-2017 aQuantia Corporation. All rights reserved
5  */
6 
7 /* File aq_nic.h: Declaration of common code for NIC. */
8 
9 #ifndef AQ_NIC_H
10 #define AQ_NIC_H
11 
12 #include "aq_common.h"
13 #include "aq_rss.h"
14 #include "aq_hw.h"
15 
16 struct aq_ring_s;
17 struct aq_hw_ops;
18 struct aq_fw_s;
19 struct aq_vec_s;
20 
21 struct aq_nic_cfg_s {
22 	const struct aq_hw_caps_s *aq_hw_caps;
23 	u64 features;
24 	u32 rxds;		/* rx ring size, descriptors # */
25 	u32 txds;		/* tx ring size, descriptors # */
26 	u32 vecs;		/* allocated rx/tx vectors */
27 	u32 link_irq_vec;
28 	u32 irq_type;
29 	u32 itr;
30 	u16 rx_itr;
31 	u16 tx_itr;
32 	u32 rxpageorder;
33 	u32 num_rss_queues;
34 	u32 mtu;
35 	u32 flow_control;
36 	u32 link_speed_msk;
37 	u32 wol;
38 	u16 is_mc_list_enabled;
39 	u16 mc_list_count;
40 	bool is_autoneg;
41 	bool is_polling;
42 	bool is_rss;
43 	bool is_lro;
44 	u8  tcs;
45 	struct aq_rss_parameters aq_rss;
46 	u32 eee_speeds;
47 };
48 
49 #define AQ_NIC_FLAG_STARTED     0x00000004U
50 #define AQ_NIC_FLAG_STOPPING    0x00000008U
51 #define AQ_NIC_FLAG_RESETTING   0x00000010U
52 #define AQ_NIC_FLAG_CLOSING     0x00000020U
53 #define AQ_NIC_LINK_DOWN        0x04000000U
54 #define AQ_NIC_FLAG_ERR_UNPLUG  0x40000000U
55 #define AQ_NIC_FLAG_ERR_HW      0x80000000U
56 
57 #define AQ_NIC_WOL_ENABLED	BIT(0)
58 
59 #define AQ_NIC_TCVEC2RING(_NIC_, _TC_, _VEC_) \
60 	((_TC_) * AQ_CFG_TCS_MAX + (_VEC_))
61 
62 struct aq_hw_rx_fl2 {
63 	struct aq_rx_filter_vlan aq_vlans[AQ_VLAN_MAX_FILTERS];
64 };
65 
66 struct aq_hw_rx_fl3l4 {
67 	u8   active_ipv4;
68 	u8   active_ipv6:2;
69 	u8 is_ipv6;
70 };
71 
72 struct aq_hw_rx_fltrs_s {
73 	struct hlist_head     filter_list;
74 	u16                   active_filters;
75 	struct aq_hw_rx_fl2   fl2;
76 	struct aq_hw_rx_fl3l4 fl3l4;
77 };
78 
79 struct aq_nic_s {
80 	atomic_t flags;
81 	struct aq_vec_s *aq_vec[AQ_CFG_VECS_MAX];
82 	struct aq_ring_s *aq_ring_tx[AQ_CFG_VECS_MAX * AQ_CFG_TCS_MAX];
83 	struct aq_hw_s *aq_hw;
84 	struct net_device *ndev;
85 	unsigned int aq_vecs;
86 	unsigned int packet_filter;
87 	unsigned int power_state;
88 	u8 port;
89 	const struct aq_hw_ops *aq_hw_ops;
90 	const struct aq_fw_ops *aq_fw_ops;
91 	struct aq_nic_cfg_s aq_nic_cfg;
92 	struct timer_list service_timer;
93 	struct work_struct service_task;
94 	struct timer_list polling_timer;
95 	struct aq_hw_link_status_s link_status;
96 	struct {
97 		u32 count;
98 		u8 ar[AQ_HW_MULTICAST_ADDRESS_MAX][ETH_ALEN];
99 	} mc_list;
100 	/* Bitmask of currently assigned vlans from linux */
101 	unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
102 
103 	struct pci_dev *pdev;
104 	unsigned int msix_entry_mask;
105 	u32 irqvecs;
106 	/* mutex to serialize FW interface access operations */
107 	struct mutex fwreq_mutex;
108 	struct aq_hw_rx_fltrs_s aq_hw_rx_fltrs;
109 };
110 
111 static inline struct device *aq_nic_get_dev(struct aq_nic_s *self)
112 {
113 	return self->ndev->dev.parent;
114 }
115 
116 void aq_nic_ndev_init(struct aq_nic_s *self);
117 struct aq_nic_s *aq_nic_alloc_hot(struct net_device *ndev);
118 void aq_nic_set_tx_ring(struct aq_nic_s *self, unsigned int idx,
119 			struct aq_ring_s *ring);
120 struct net_device *aq_nic_get_ndev(struct aq_nic_s *self);
121 int aq_nic_init(struct aq_nic_s *self);
122 void aq_nic_cfg_start(struct aq_nic_s *self);
123 int aq_nic_ndev_register(struct aq_nic_s *self);
124 void aq_nic_ndev_free(struct aq_nic_s *self);
125 int aq_nic_start(struct aq_nic_s *self);
126 int aq_nic_xmit(struct aq_nic_s *self, struct sk_buff *skb);
127 int aq_nic_get_regs(struct aq_nic_s *self, struct ethtool_regs *regs, void *p);
128 int aq_nic_get_regs_count(struct aq_nic_s *self);
129 void aq_nic_get_stats(struct aq_nic_s *self, u64 *data);
130 int aq_nic_stop(struct aq_nic_s *self);
131 void aq_nic_deinit(struct aq_nic_s *self);
132 void aq_nic_free_hot_resources(struct aq_nic_s *self);
133 void aq_nic_free_vectors(struct aq_nic_s *self);
134 int aq_nic_set_mtu(struct aq_nic_s *self, int new_mtu);
135 int aq_nic_set_mac(struct aq_nic_s *self, struct net_device *ndev);
136 int aq_nic_set_packet_filter(struct aq_nic_s *self, unsigned int flags);
137 int aq_nic_set_multicast_list(struct aq_nic_s *self, struct net_device *ndev);
138 unsigned int aq_nic_get_link_speed(struct aq_nic_s *self);
139 void aq_nic_get_link_ksettings(struct aq_nic_s *self,
140 			       struct ethtool_link_ksettings *cmd);
141 int aq_nic_set_link_ksettings(struct aq_nic_s *self,
142 			      const struct ethtool_link_ksettings *cmd);
143 struct aq_nic_cfg_s *aq_nic_get_cfg(struct aq_nic_s *self);
144 u32 aq_nic_get_fw_version(struct aq_nic_s *self);
145 int aq_nic_change_pm_state(struct aq_nic_s *self, pm_message_t *pm_msg);
146 int aq_nic_update_interrupt_moderation_settings(struct aq_nic_s *self);
147 void aq_nic_shutdown(struct aq_nic_s *self);
148 
149 #endif /* AQ_NIC_H */
150