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