linux/drivers/net/ethernet/intel/igc/igc.h

/* SPDX-License-Identifier: GPL-2.0 */
/* Copyright (c)  2018 Intel Corporation */

#ifndef _IGC_H_
#define _IGC_H_

#include <linux/kobject.h>
#include <linux/pci.h>
#include <linux/netdevice.h>
#include <linux/vmalloc.h>
#include <linux/ethtool.h>
#include <linux/sctp.h>
#include <linux/ptp_clock_kernel.h>
#include <linux/timecounter.h>
#include <linux/net_tstamp.h>
#include <linux/bitfield.h>
#include <linux/hrtimer.h>
#include <net/xdp.h>

#include "igc_hw.h"

void igc_ethtool_set_ops(struct net_device *);

/* Transmit and receive queues */
#define IGC_MAX_RX_QUEUES
#define IGC_MAX_TX_QUEUES

#define MAX_Q_VECTORS
#define MAX_STD_JUMBO_FRAME_SIZE

#define MAX_ETYPE_FILTER
#define IGC_RETA_SIZE

/* SDP support */
#define IGC_N_EXTTS
#define IGC_N_PEROUT
#define IGC_N_SDP

#define MAX_FLEX_FILTER

#define IGC_MAX_TX_TSTAMP_REGS

enum igc_mac_filter_type {};

struct igc_tx_queue_stats {};

struct igc_rx_queue_stats {};

struct igc_rx_packet_stats {};

enum igc_tx_buffer_type {};

/* wrapper around a pointer to a socket buffer,
 * so a DMA handle can be stored along with the buffer
 */
struct igc_tx_buffer {};

struct igc_tx_timestamp_request {};

struct igc_inline_rx_tstamps {};

struct igc_ring_container {};

struct igc_ring {} ____cacheline_internodealigned_in_smp;

/* Board specific private data structure */
struct igc_adapter {};

void igc_up(struct igc_adapter *adapter);
void igc_down(struct igc_adapter *adapter);
int igc_open(struct net_device *netdev);
int igc_close(struct net_device *netdev);
int igc_setup_tx_resources(struct igc_ring *ring);
int igc_setup_rx_resources(struct igc_ring *ring);
void igc_free_tx_resources(struct igc_ring *ring);
void igc_free_rx_resources(struct igc_ring *ring);
unsigned int igc_get_max_rss_queues(struct igc_adapter *adapter);
void igc_set_flag_queue_pairs(struct igc_adapter *adapter,
			      const u32 max_rss_queues);
int igc_reinit_queues(struct igc_adapter *adapter);
void igc_write_rss_indir_tbl(struct igc_adapter *adapter);
bool igc_has_link(struct igc_adapter *adapter);
void igc_reset(struct igc_adapter *adapter);
void igc_update_stats(struct igc_adapter *adapter);
void igc_disable_rx_ring(struct igc_ring *ring);
void igc_enable_rx_ring(struct igc_ring *ring);
void igc_disable_tx_ring(struct igc_ring *ring);
void igc_enable_tx_ring(struct igc_ring *ring);
int igc_xsk_wakeup(struct net_device *dev, u32 queue_id, u32 flags);

/* AF_XDP TX metadata operations */
extern const struct xsk_tx_metadata_ops igc_xsk_tx_metadata_ops;

/* igc_dump declarations */
void igc_rings_dump(struct igc_adapter *adapter);
void igc_regs_dump(struct igc_adapter *adapter);

extern char igc_driver_name[];

#define IGC_REGS_LEN

/* flags controlling PTP/1588 function */
#define IGC_PTP_ENABLED

/* Flags definitions */
#define IGC_FLAG_HAS_MSI
#define IGC_FLAG_QUEUE_PAIRS
#define IGC_FLAG_DMAC
#define IGC_FLAG_PTP
#define IGC_FLAG_WOL_SUPPORTED
#define IGC_FLAG_NEED_LINK_UPDATE
#define IGC_FLAG_HAS_MSIX
#define IGC_FLAG_EEE
#define IGC_FLAG_VLAN_PROMISC
#define IGC_FLAG_RX_LEGACY
#define IGC_FLAG_TSN_QBV_ENABLED
#define IGC_FLAG_TSN_QAV_ENABLED
#define IGC_FLAG_TSN_LEGACY_ENABLED

#define IGC_FLAG_TSN_ANY_ENABLED

#define IGC_FLAG_RSS_FIELD_IPV4_UDP
#define IGC_FLAG_RSS_FIELD_IPV6_UDP

#define IGC_MRQC_ENABLE_RSS_MQ
#define IGC_MRQC_RSS_FIELD_IPV4_UDP
#define IGC_MRQC_RSS_FIELD_IPV6_UDP

/* RX-desc Write-Back format RSS Type's */
enum igc_rss_type_num {};
#define IGC_RSS_TYPE_MAX_TABLE
#define IGC_RSS_TYPE_MASK

/* igc_rss_type - Rx descriptor RSS type field */
static inline u32 igc_rss_type(const union igc_adv_rx_desc *rx_desc)
{}

/* Interrupt defines */
#define IGC_START_ITR
#define IGC_4K_ITR
#define IGC_20K_ITR
#define IGC_70K_ITR

#define IGC_DEFAULT_ITR
#define IGC_MAX_ITR_USECS
#define IGC_MIN_ITR_USECS
#define NON_Q_VECTORS
#define MAX_MSIX_ENTRIES

/* TX/RX descriptor defines */
#define IGC_DEFAULT_TXD
#define IGC_DEFAULT_TX_WORK
#define IGC_MIN_TXD
#define IGC_MAX_TXD

#define IGC_DEFAULT_RXD
#define IGC_MIN_RXD
#define IGC_MAX_RXD

/* Supported Rx Buffer Sizes */
#define IGC_RXBUFFER_256
#define IGC_RXBUFFER_2048
#define IGC_RXBUFFER_3072

#define AUTO_ALL_MODES
#define IGC_RX_HDR_LEN

/* Transmit and receive latency (for PTP timestamps) */
#define IGC_I225_TX_LATENCY_10
#define IGC_I225_TX_LATENCY_100
#define IGC_I225_TX_LATENCY_1000
#define IGC_I225_TX_LATENCY_2500
#define IGC_I225_RX_LATENCY_10
#define IGC_I225_RX_LATENCY_100
#define IGC_I225_RX_LATENCY_1000
#define IGC_I225_RX_LATENCY_2500

/* RX and TX descriptor control thresholds.
 * PTHRESH - MAC will consider prefetch if it has fewer than this number of
 *           descriptors available in its onboard memory.
 *           Setting this to 0 disables RX descriptor prefetch.
 * HTHRESH - MAC will only prefetch if there are at least this many descriptors
 *           available in host memory.
 *           If PTHRESH is 0, this should also be 0.
 * WTHRESH - RX descriptor writeback threshold - MAC will delay writing back
 *           descriptors until either it has this many to write back, or the
 *           ITR timer expires.
 */
#define IGC_RX_PTHRESH
#define IGC_RX_HTHRESH
#define IGC_TX_PTHRESH
#define IGC_TX_HTHRESH
#define IGC_RX_WTHRESH
#define IGC_TX_WTHRESH

#define IGC_RX_DMA_ATTR

#define IGC_TS_HDR_LEN

#define IGC_SKB_PAD

#if (PAGE_SIZE < 8192)
#define IGC_MAX_FRAME_BUILD_SKB
#else
#define IGC_MAX_FRAME_BUILD_SKB
#endif

/* How many Rx Buffers do we bundle into one write to the hardware ? */
#define IGC_RX_BUFFER_WRITE

/* VLAN info */
#define IGC_TX_FLAGS_VLAN_MASK
#define IGC_TX_FLAGS_VLAN_SHIFT

/* igc_test_staterr - tests bits within Rx descriptor status and error fields */
static inline __le32 igc_test_staterr(union igc_adv_rx_desc *rx_desc,
				      const u32 stat_err_bits)
{}

enum igc_state_t {};

enum igc_tx_flags {};

enum igc_boards {};

/* The largest size we can write to the descriptor is 65535.  In order to
 * maintain a power of two alignment we have to limit ourselves to 32K.
 */
#define IGC_MAX_TXD_PWR
#define IGC_MAX_DATA_PER_TXD

/* Tx Descriptors needed, worst case */
#define TXD_USE_COUNT(S)
#define DESC_NEEDED

struct igc_rx_buffer {};

/* context wrapper around xdp_buff to provide access to descriptor metadata */
struct igc_xdp_buff {};

struct igc_metadata_request {};

struct igc_q_vector {};

enum igc_filter_match_flags {};

struct igc_nfc_filter {};

struct igc_nfc_rule {};

/* IGC supports a total of 32 NFC rules: 16 MAC address based, 8 VLAN priority
 * based, 8 ethertype based and 32 Flex filter based rules.
 */
#define IGC_MAX_RXNFC_RULES

struct igc_flex_filter {};

/* igc_desc_unused - calculate if we have unused descriptors */
static inline u16 igc_desc_unused(const struct igc_ring *ring)
{}

static inline s32 igc_get_phy_info(struct igc_hw *hw)
{}

static inline s32 igc_reset_phy(struct igc_hw *hw)
{}

static inline struct netdev_queue *txring_txq(const struct igc_ring *tx_ring)
{}

enum igc_ring_flags_t {};

#define ring_uses_large_buffer(ring)
#define set_ring_uses_large_buffer(ring)
#define clear_ring_uses_large_buffer(ring)

#define ring_uses_build_skb(ring)

static inline unsigned int igc_rx_bufsz(struct igc_ring *ring)
{}

static inline unsigned int igc_rx_pg_order(struct igc_ring *ring)
{}

static inline s32 igc_read_phy_reg(struct igc_hw *hw, u32 offset, u16 *data)
{}

void igc_reinit_locked(struct igc_adapter *);
struct igc_nfc_rule *igc_get_nfc_rule(struct igc_adapter *adapter,
				      u32 location);
int igc_add_nfc_rule(struct igc_adapter *adapter, struct igc_nfc_rule *rule);
void igc_del_nfc_rule(struct igc_adapter *adapter, struct igc_nfc_rule *rule);

void igc_ptp_init(struct igc_adapter *adapter);
void igc_ptp_reset(struct igc_adapter *adapter);
void igc_ptp_suspend(struct igc_adapter *adapter);
void igc_ptp_stop(struct igc_adapter *adapter);
ktime_t igc_ptp_rx_pktstamp(struct igc_adapter *adapter, __le32 *buf);
int igc_ptp_set_ts_config(struct net_device *netdev, struct ifreq *ifr);
int igc_ptp_get_ts_config(struct net_device *netdev, struct ifreq *ifr);
void igc_ptp_tx_hang(struct igc_adapter *adapter);
void igc_ptp_read(struct igc_adapter *adapter, struct timespec64 *ts);
void igc_ptp_tx_tstamp_event(struct igc_adapter *adapter);

int igc_led_setup(struct igc_adapter *adapter);
void igc_led_free(struct igc_adapter *adapter);

#define igc_rx_pg_size(_ring)

#define IGC_TXD_DCMD

#define IGC_RX_DESC(R, i)
#define IGC_TX_DESC(R, i)
#define IGC_TX_CTXTDESC(R, i)

#endif /* _IGC_H_ */