linux/drivers/net/ethernet/aquantia/atlantic/aq_hw.h
<<
>>
Prefs
   1/* SPDX-License-Identifier: GPL-2.0-only */
   2/*
   3 * aQuantia Corporation Network Driver
   4 * Copyright (C) 2014-2019 aQuantia Corporation. All rights reserved
   5 */
   6
   7/* File aq_hw.h: Declaration of abstract interface for NIC hardware specific
   8 * functions.
   9 */
  10
  11#ifndef AQ_HW_H
  12#define AQ_HW_H
  13
  14#include "aq_common.h"
  15#include "aq_rss.h"
  16#include "hw_atl/hw_atl_utils.h"
  17
  18#define AQ_HW_MAC_COUNTER_HZ   312500000ll
  19#define AQ_HW_PHY_COUNTER_HZ   160000000ll
  20
  21#define AQ_RX_FIRST_LOC_FVLANID     0U
  22#define AQ_RX_LAST_LOC_FVLANID     15U
  23#define AQ_RX_FIRST_LOC_FETHERT    16U
  24#define AQ_RX_LAST_LOC_FETHERT     31U
  25#define AQ_RX_FIRST_LOC_FL3L4      32U
  26#define AQ_RX_LAST_LOC_FL3L4       39U
  27#define AQ_RX_MAX_RXNFC_LOC        AQ_RX_LAST_LOC_FL3L4
  28#define AQ_VLAN_MAX_FILTERS   \
  29                        (AQ_RX_LAST_LOC_FVLANID - AQ_RX_FIRST_LOC_FVLANID + 1U)
  30#define AQ_RX_QUEUE_NOT_ASSIGNED   0xFFU
  31
  32/* NIC H/W capabilities */
  33struct aq_hw_caps_s {
  34        u64 hw_features;
  35        u64 link_speed_msk;
  36        unsigned int hw_priv_flags;
  37        u32 media_type;
  38        u32 rxds_max;
  39        u32 txds_max;
  40        u32 rxds_min;
  41        u32 txds_min;
  42        u32 txhwb_alignment;
  43        u32 irq_mask;
  44        u32 vecs;
  45        u32 mtu;
  46        u32 mac_regs_count;
  47        u32 hw_alive_check_addr;
  48        u8 msix_irqs;
  49        u8 tcs;
  50        u8 rxd_alignment;
  51        u8 rxd_size;
  52        u8 txd_alignment;
  53        u8 txd_size;
  54        u8 tx_rings;
  55        u8 rx_rings;
  56        bool flow_control;
  57        bool is_64_dma;
  58};
  59
  60struct aq_hw_link_status_s {
  61        unsigned int mbps;
  62};
  63
  64struct aq_stats_s {
  65        u64 uprc;
  66        u64 mprc;
  67        u64 bprc;
  68        u64 erpt;
  69        u64 uptc;
  70        u64 mptc;
  71        u64 bptc;
  72        u64 erpr;
  73        u64 mbtc;
  74        u64 bbtc;
  75        u64 mbrc;
  76        u64 bbrc;
  77        u64 ubrc;
  78        u64 ubtc;
  79        u64 dpc;
  80        u64 dma_pkt_rc;
  81        u64 dma_pkt_tc;
  82        u64 dma_oct_rc;
  83        u64 dma_oct_tc;
  84};
  85
  86#define AQ_HW_IRQ_INVALID 0U
  87#define AQ_HW_IRQ_LEGACY  1U
  88#define AQ_HW_IRQ_MSI     2U
  89#define AQ_HW_IRQ_MSIX    3U
  90
  91#define AQ_HW_SERVICE_IRQS   1U
  92
  93#define AQ_HW_POWER_STATE_D0   0U
  94#define AQ_HW_POWER_STATE_D3   3U
  95
  96#define AQ_HW_FLAG_STARTED     0x00000004U
  97#define AQ_HW_FLAG_STOPPING    0x00000008U
  98#define AQ_HW_FLAG_RESETTING   0x00000010U
  99#define AQ_HW_FLAG_CLOSING     0x00000020U
 100#define AQ_HW_PTP_AVAILABLE    0x01000000U
 101#define AQ_HW_LINK_DOWN        0x04000000U
 102#define AQ_HW_FLAG_ERR_UNPLUG  0x40000000U
 103#define AQ_HW_FLAG_ERR_HW      0x80000000U
 104
 105#define AQ_HW_FLAG_ERRORS      (AQ_HW_FLAG_ERR_HW | AQ_HW_FLAG_ERR_UNPLUG)
 106
 107#define AQ_NIC_FLAGS_IS_NOT_READY (AQ_NIC_FLAG_STOPPING | \
 108                        AQ_NIC_FLAG_RESETTING | AQ_NIC_FLAG_CLOSING | \
 109                        AQ_NIC_FLAG_ERR_UNPLUG | AQ_NIC_FLAG_ERR_HW)
 110
 111#define AQ_NIC_FLAGS_IS_NOT_TX_READY (AQ_NIC_FLAGS_IS_NOT_READY | \
 112                                        AQ_NIC_LINK_DOWN)
 113
 114#define AQ_HW_MEDIA_TYPE_TP    1U
 115#define AQ_HW_MEDIA_TYPE_FIBRE 2U
 116
 117#define AQ_HW_TXD_MULTIPLE 8U
 118#define AQ_HW_RXD_MULTIPLE 8U
 119
 120#define AQ_HW_MULTICAST_ADDRESS_MAX     32U
 121
 122#define AQ_HW_LED_BLINK    0x2U
 123#define AQ_HW_LED_DEFAULT  0x0U
 124
 125enum aq_priv_flags {
 126        AQ_HW_LOOPBACK_DMA_SYS,
 127        AQ_HW_LOOPBACK_PKT_SYS,
 128        AQ_HW_LOOPBACK_DMA_NET,
 129        AQ_HW_LOOPBACK_PHYINT_SYS,
 130        AQ_HW_LOOPBACK_PHYEXT_SYS,
 131};
 132
 133#define AQ_HW_LOOPBACK_MASK     (BIT(AQ_HW_LOOPBACK_DMA_SYS) |\
 134                                 BIT(AQ_HW_LOOPBACK_PKT_SYS) |\
 135                                 BIT(AQ_HW_LOOPBACK_DMA_NET) |\
 136                                 BIT(AQ_HW_LOOPBACK_PHYINT_SYS) |\
 137                                 BIT(AQ_HW_LOOPBACK_PHYEXT_SYS))
 138
 139struct aq_hw_s {
 140        atomic_t flags;
 141        u8 rbl_enabled:1;
 142        struct aq_nic_cfg_s *aq_nic_cfg;
 143        const struct aq_fw_ops *aq_fw_ops;
 144        void __iomem *mmio;
 145        struct aq_hw_link_status_s aq_link_status;
 146        struct hw_atl_utils_mbox mbox;
 147        struct hw_atl_stats_s last_stats;
 148        struct aq_stats_s curr_stats;
 149        u64 speed;
 150        u32 itr_tx;
 151        u32 itr_rx;
 152        unsigned int chip_features;
 153        u32 fw_ver_actual;
 154        atomic_t dpc;
 155        u32 mbox_addr;
 156        u32 rpc_addr;
 157        u32 settings_addr;
 158        u32 rpc_tid;
 159        struct hw_atl_utils_fw_rpc rpc;
 160        s64 ptp_clk_offset;
 161        u16 phy_id;
 162};
 163
 164struct aq_ring_s;
 165struct aq_ring_param_s;
 166struct sk_buff;
 167struct aq_rx_filter_l3l4;
 168
 169struct aq_hw_ops {
 170
 171        int (*hw_ring_tx_xmit)(struct aq_hw_s *self, struct aq_ring_s *aq_ring,
 172                               unsigned int frags);
 173
 174        int (*hw_ring_rx_receive)(struct aq_hw_s *self,
 175                                  struct aq_ring_s *aq_ring);
 176
 177        int (*hw_ring_rx_fill)(struct aq_hw_s *self, struct aq_ring_s *aq_ring,
 178                               unsigned int sw_tail_old);
 179
 180        int (*hw_ring_tx_head_update)(struct aq_hw_s *self,
 181                                      struct aq_ring_s *aq_ring);
 182
 183        int (*hw_set_mac_address)(struct aq_hw_s *self, u8 *mac_addr);
 184
 185        int (*hw_reset)(struct aq_hw_s *self);
 186
 187        int (*hw_init)(struct aq_hw_s *self, u8 *mac_addr);
 188
 189        int (*hw_start)(struct aq_hw_s *self);
 190
 191        int (*hw_stop)(struct aq_hw_s *self);
 192
 193        int (*hw_ring_tx_init)(struct aq_hw_s *self, struct aq_ring_s *aq_ring,
 194                               struct aq_ring_param_s *aq_ring_param);
 195
 196        int (*hw_ring_tx_start)(struct aq_hw_s *self,
 197                                struct aq_ring_s *aq_ring);
 198
 199        int (*hw_ring_tx_stop)(struct aq_hw_s *self,
 200                               struct aq_ring_s *aq_ring);
 201
 202        int (*hw_ring_rx_init)(struct aq_hw_s *self,
 203                               struct aq_ring_s *aq_ring,
 204                               struct aq_ring_param_s *aq_ring_param);
 205
 206        int (*hw_ring_rx_start)(struct aq_hw_s *self,
 207                                struct aq_ring_s *aq_ring);
 208
 209        int (*hw_ring_rx_stop)(struct aq_hw_s *self,
 210                               struct aq_ring_s *aq_ring);
 211
 212        int (*hw_irq_enable)(struct aq_hw_s *self, u64 mask);
 213
 214        int (*hw_irq_disable)(struct aq_hw_s *self, u64 mask);
 215
 216        int (*hw_irq_read)(struct aq_hw_s *self, u64 *mask);
 217
 218        int (*hw_packet_filter_set)(struct aq_hw_s *self,
 219                                    unsigned int packet_filter);
 220
 221        int (*hw_filter_l3l4_set)(struct aq_hw_s *self,
 222                                  struct aq_rx_filter_l3l4 *data);
 223
 224        int (*hw_filter_l3l4_clear)(struct aq_hw_s *self,
 225                                    struct aq_rx_filter_l3l4 *data);
 226
 227        int (*hw_filter_l2_set)(struct aq_hw_s *self,
 228                                struct aq_rx_filter_l2 *data);
 229
 230        int (*hw_filter_l2_clear)(struct aq_hw_s *self,
 231                                  struct aq_rx_filter_l2 *data);
 232
 233        int (*hw_filter_vlan_set)(struct aq_hw_s *self,
 234                                  struct aq_rx_filter_vlan *aq_vlans);
 235
 236        int (*hw_filter_vlan_ctrl)(struct aq_hw_s *self, bool enable);
 237
 238        int (*hw_multicast_list_set)(struct aq_hw_s *self,
 239                                     u8 ar_mac[AQ_HW_MULTICAST_ADDRESS_MAX]
 240                                     [ETH_ALEN],
 241                                     u32 count);
 242
 243        int (*hw_interrupt_moderation_set)(struct aq_hw_s *self);
 244
 245        int (*hw_rss_set)(struct aq_hw_s *self,
 246                          struct aq_rss_parameters *rss_params);
 247
 248        int (*hw_rss_hash_set)(struct aq_hw_s *self,
 249                               struct aq_rss_parameters *rss_params);
 250
 251        int (*hw_get_regs)(struct aq_hw_s *self,
 252                           const struct aq_hw_caps_s *aq_hw_caps,
 253                           u32 *regs_buff);
 254
 255        struct aq_stats_s *(*hw_get_hw_stats)(struct aq_hw_s *self);
 256
 257        int (*hw_get_fw_version)(struct aq_hw_s *self, u32 *fw_version);
 258
 259        int (*hw_set_offload)(struct aq_hw_s *self,
 260                              struct aq_nic_cfg_s *aq_nic_cfg);
 261
 262        int (*hw_tx_tc_mode_get)(struct aq_hw_s *self, u32 *tc_mode);
 263
 264        int (*hw_rx_tc_mode_get)(struct aq_hw_s *self, u32 *tc_mode);
 265
 266        int (*hw_ring_hwts_rx_fill)(struct aq_hw_s *self,
 267                                    struct aq_ring_s *aq_ring);
 268
 269        int (*hw_ring_hwts_rx_receive)(struct aq_hw_s *self,
 270                                       struct aq_ring_s *ring);
 271
 272        void (*hw_get_ptp_ts)(struct aq_hw_s *self, u64 *stamp);
 273
 274        int (*hw_adj_clock_freq)(struct aq_hw_s *self, s32 delta);
 275
 276        int (*hw_adj_sys_clock)(struct aq_hw_s *self, s64 delta);
 277
 278        int (*hw_set_sys_clock)(struct aq_hw_s *self, u64 time, u64 ts);
 279
 280        int (*hw_ts_to_sys_clock)(struct aq_hw_s *self, u64 ts, u64 *time);
 281
 282        int (*hw_gpio_pulse)(struct aq_hw_s *self, u32 index, u64 start,
 283                             u32 period);
 284
 285        int (*hw_extts_gpio_enable)(struct aq_hw_s *self, u32 index,
 286                                    u32 enable);
 287
 288        int (*hw_get_sync_ts)(struct aq_hw_s *self, u64 *ts);
 289
 290        u16 (*rx_extract_ts)(struct aq_hw_s *self, u8 *p, unsigned int len,
 291                             u64 *timestamp);
 292
 293        int (*extract_hwts)(struct aq_hw_s *self, u8 *p, unsigned int len,
 294                            u64 *timestamp);
 295
 296        int (*hw_set_fc)(struct aq_hw_s *self, u32 fc, u32 tc);
 297
 298        int (*hw_set_loopback)(struct aq_hw_s *self, u32 mode, bool enable);
 299};
 300
 301struct aq_fw_ops {
 302        int (*init)(struct aq_hw_s *self);
 303
 304        int (*deinit)(struct aq_hw_s *self);
 305
 306        int (*reset)(struct aq_hw_s *self);
 307
 308        int (*renegotiate)(struct aq_hw_s *self);
 309
 310        int (*get_mac_permanent)(struct aq_hw_s *self, u8 *mac);
 311
 312        int (*set_link_speed)(struct aq_hw_s *self, u32 speed);
 313
 314        int (*set_state)(struct aq_hw_s *self,
 315                         enum hal_atl_utils_fw_state_e state);
 316
 317        int (*update_link_status)(struct aq_hw_s *self);
 318
 319        int (*update_stats)(struct aq_hw_s *self);
 320
 321        int (*get_phy_temp)(struct aq_hw_s *self, int *temp);
 322
 323        u32 (*get_flow_control)(struct aq_hw_s *self, u32 *fcmode);
 324
 325        int (*set_flow_control)(struct aq_hw_s *self);
 326
 327        int (*led_control)(struct aq_hw_s *self, u32 mode);
 328
 329        int (*set_phyloopback)(struct aq_hw_s *self, u32 mode, bool enable);
 330
 331        int (*set_power)(struct aq_hw_s *self, unsigned int power_state,
 332                         u8 *mac);
 333
 334        int (*send_fw_request)(struct aq_hw_s *self,
 335                               const struct hw_fw_request_iface *fw_req,
 336                               size_t size);
 337
 338        void (*enable_ptp)(struct aq_hw_s *self, int enable);
 339
 340        int (*set_eee_rate)(struct aq_hw_s *self, u32 speed);
 341
 342        int (*get_eee_rate)(struct aq_hw_s *self, u32 *rate,
 343                            u32 *supported_rates);
 344};
 345
 346#endif /* AQ_HW_H */
 347