1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * aQuantia Corporation Network Driver
4 * Copyright (C) 2014-2017 aQuantia Corporation. All rights reserved
7 /* File aq_hw.h: Declaration of abstract interface for NIC hardware specific
14 #include "aq_common.h"
16 #include "hw_atl/hw_atl_utils.h"
18 #define AQ_RX_FIRST_LOC_FVLANID 0U
19 #define AQ_RX_LAST_LOC_FVLANID 15U
20 #define AQ_RX_FIRST_LOC_FETHERT 16U
21 #define AQ_RX_LAST_LOC_FETHERT 31U
22 #define AQ_RX_FIRST_LOC_FL3L4 32U
23 #define AQ_RX_LAST_LOC_FL3L4 39U
24 #define AQ_RX_MAX_RXNFC_LOC AQ_RX_LAST_LOC_FL3L4
25 #define AQ_VLAN_MAX_FILTERS \
26 (AQ_RX_LAST_LOC_FVLANID - AQ_RX_FIRST_LOC_FVLANID + 1U)
27 #define AQ_RX_QUEUE_NOT_ASSIGNED 0xFFU
29 /* NIC H/W capabilities */
33 unsigned int hw_priv_flags;
44 u32 hw_alive_check_addr;
57 struct aq_hw_link_status_s {
83 #define AQ_HW_IRQ_INVALID 0U
84 #define AQ_HW_IRQ_LEGACY 1U
85 #define AQ_HW_IRQ_MSI 2U
86 #define AQ_HW_IRQ_MSIX 3U
88 #define AQ_HW_SERVICE_IRQS 1U
90 #define AQ_HW_POWER_STATE_D0 0U
91 #define AQ_HW_POWER_STATE_D3 3U
93 #define AQ_HW_FLAG_STARTED 0x00000004U
94 #define AQ_HW_FLAG_STOPPING 0x00000008U
95 #define AQ_HW_FLAG_RESETTING 0x00000010U
96 #define AQ_HW_FLAG_CLOSING 0x00000020U
97 #define AQ_HW_LINK_DOWN 0x04000000U
98 #define AQ_HW_FLAG_ERR_UNPLUG 0x40000000U
99 #define AQ_HW_FLAG_ERR_HW 0x80000000U
101 #define AQ_HW_FLAG_ERRORS (AQ_HW_FLAG_ERR_HW | AQ_HW_FLAG_ERR_UNPLUG)
103 #define AQ_NIC_FLAGS_IS_NOT_READY (AQ_NIC_FLAG_STOPPING | \
104 AQ_NIC_FLAG_RESETTING | AQ_NIC_FLAG_CLOSING | \
105 AQ_NIC_FLAG_ERR_UNPLUG | AQ_NIC_FLAG_ERR_HW)
107 #define AQ_NIC_FLAGS_IS_NOT_TX_READY (AQ_NIC_FLAGS_IS_NOT_READY | \
110 #define AQ_HW_MEDIA_TYPE_TP 1U
111 #define AQ_HW_MEDIA_TYPE_FIBRE 2U
113 #define AQ_HW_TXD_MULTIPLE 8U
114 #define AQ_HW_RXD_MULTIPLE 8U
116 #define AQ_HW_MULTICAST_ADDRESS_MAX 32U
121 struct aq_nic_cfg_s *aq_nic_cfg;
122 const struct aq_fw_ops *aq_fw_ops;
124 struct aq_hw_link_status_s aq_link_status;
125 struct hw_atl_utils_mbox mbox;
126 struct hw_atl_stats_s last_stats;
127 struct aq_stats_s curr_stats;
131 unsigned int chip_features;
137 struct hw_atl_utils_fw_rpc rpc;
141 struct aq_ring_param_s;
143 struct aq_rx_filter_l3l4;
147 int (*hw_ring_tx_xmit)(struct aq_hw_s *self, struct aq_ring_s *aq_ring,
150 int (*hw_ring_rx_receive)(struct aq_hw_s *self,
151 struct aq_ring_s *aq_ring);
153 int (*hw_ring_rx_fill)(struct aq_hw_s *self, struct aq_ring_s *aq_ring,
154 unsigned int sw_tail_old);
156 int (*hw_ring_tx_head_update)(struct aq_hw_s *self,
157 struct aq_ring_s *aq_ring);
159 int (*hw_set_mac_address)(struct aq_hw_s *self, u8 *mac_addr);
161 int (*hw_reset)(struct aq_hw_s *self);
163 int (*hw_init)(struct aq_hw_s *self, u8 *mac_addr);
165 int (*hw_start)(struct aq_hw_s *self);
167 int (*hw_stop)(struct aq_hw_s *self);
169 int (*hw_ring_tx_init)(struct aq_hw_s *self, struct aq_ring_s *aq_ring,
170 struct aq_ring_param_s *aq_ring_param);
172 int (*hw_ring_tx_start)(struct aq_hw_s *self,
173 struct aq_ring_s *aq_ring);
175 int (*hw_ring_tx_stop)(struct aq_hw_s *self,
176 struct aq_ring_s *aq_ring);
178 int (*hw_ring_rx_init)(struct aq_hw_s *self,
179 struct aq_ring_s *aq_ring,
180 struct aq_ring_param_s *aq_ring_param);
182 int (*hw_ring_rx_start)(struct aq_hw_s *self,
183 struct aq_ring_s *aq_ring);
185 int (*hw_ring_rx_stop)(struct aq_hw_s *self,
186 struct aq_ring_s *aq_ring);
188 int (*hw_irq_enable)(struct aq_hw_s *self, u64 mask);
190 int (*hw_irq_disable)(struct aq_hw_s *self, u64 mask);
192 int (*hw_irq_read)(struct aq_hw_s *self, u64 *mask);
194 int (*hw_packet_filter_set)(struct aq_hw_s *self,
195 unsigned int packet_filter);
197 int (*hw_filter_l3l4_set)(struct aq_hw_s *self,
198 struct aq_rx_filter_l3l4 *data);
200 int (*hw_filter_l3l4_clear)(struct aq_hw_s *self,
201 struct aq_rx_filter_l3l4 *data);
203 int (*hw_filter_l2_set)(struct aq_hw_s *self,
204 struct aq_rx_filter_l2 *data);
206 int (*hw_filter_l2_clear)(struct aq_hw_s *self,
207 struct aq_rx_filter_l2 *data);
209 int (*hw_filter_vlan_set)(struct aq_hw_s *self,
210 struct aq_rx_filter_vlan *aq_vlans);
212 int (*hw_filter_vlan_ctrl)(struct aq_hw_s *self, bool enable);
214 int (*hw_multicast_list_set)(struct aq_hw_s *self,
215 u8 ar_mac[AQ_HW_MULTICAST_ADDRESS_MAX]
219 int (*hw_interrupt_moderation_set)(struct aq_hw_s *self);
221 int (*hw_rss_set)(struct aq_hw_s *self,
222 struct aq_rss_parameters *rss_params);
224 int (*hw_rss_hash_set)(struct aq_hw_s *self,
225 struct aq_rss_parameters *rss_params);
227 int (*hw_get_regs)(struct aq_hw_s *self,
228 const struct aq_hw_caps_s *aq_hw_caps,
231 struct aq_stats_s *(*hw_get_hw_stats)(struct aq_hw_s *self);
233 int (*hw_get_fw_version)(struct aq_hw_s *self, u32 *fw_version);
235 int (*hw_set_offload)(struct aq_hw_s *self,
236 struct aq_nic_cfg_s *aq_nic_cfg);
238 int (*hw_set_fc)(struct aq_hw_s *self, u32 fc, u32 tc);
242 int (*init)(struct aq_hw_s *self);
244 int (*deinit)(struct aq_hw_s *self);
246 int (*reset)(struct aq_hw_s *self);
248 int (*renegotiate)(struct aq_hw_s *self);
250 int (*get_mac_permanent)(struct aq_hw_s *self, u8 *mac);
252 int (*set_link_speed)(struct aq_hw_s *self, u32 speed);
254 int (*set_state)(struct aq_hw_s *self,
255 enum hal_atl_utils_fw_state_e state);
257 int (*update_link_status)(struct aq_hw_s *self);
259 int (*update_stats)(struct aq_hw_s *self);
261 int (*get_phy_temp)(struct aq_hw_s *self, int *temp);
263 u32 (*get_flow_control)(struct aq_hw_s *self, u32 *fcmode);
265 int (*set_flow_control)(struct aq_hw_s *self);
267 int (*set_power)(struct aq_hw_s *self, unsigned int power_state,
270 int (*set_eee_rate)(struct aq_hw_s *self, u32 speed);
272 int (*get_eee_rate)(struct aq_hw_s *self, u32 *rate,
273 u32 *supported_rates);