mirror of
https://github.com/torvalds/linux.git
synced 2024-12-05 02:23:16 +00:00
nfp: only use kdoc style comments for kdoc
Update comments to only use kdoc style comments, starting with '/**', for kdoc. Flagged by ./scripts/kernel-doc Signed-off-by: Simon Horman <simon.horman@corigine.com> Acked-by: Randy Dunlap <rdunlap@infradead.org> Tested-by: Randy Dunlap <rdunlap@infradead.org> Link: https://lore.kernel.org/r/20220126090803.5582-1-simon.horman@corigine.com Signed-off-by: Jakub Kicinski <kuba@kernel.org>
This commit is contained in:
parent
15f75fd319
commit
49db8a70a0
@ -1,8 +1,7 @@
|
||||
/* SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) */
|
||||
/* Copyright (C) 2015-2018 Netronome Systems, Inc. */
|
||||
|
||||
/*
|
||||
* nfp_net_ctrl.h
|
||||
/* nfp_net_ctrl.h
|
||||
* Netronome network device driver: Control BAR layout
|
||||
* Authors: Jakub Kicinski <jakub.kicinski@netronome.com>
|
||||
* Jason McMullan <jason.mcmullan@netronome.com>
|
||||
@ -15,30 +14,24 @@
|
||||
|
||||
#include <linux/types.h>
|
||||
|
||||
/**
|
||||
* Configuration BAR size.
|
||||
/* Configuration BAR size.
|
||||
*
|
||||
* The configuration BAR is 8K in size, but due to
|
||||
* THB-350, 32k needs to be reserved.
|
||||
*/
|
||||
#define NFP_NET_CFG_BAR_SZ (32 * 1024)
|
||||
|
||||
/**
|
||||
* Offset in Freelist buffer where packet starts on RX
|
||||
*/
|
||||
/* Offset in Freelist buffer where packet starts on RX */
|
||||
#define NFP_NET_RX_OFFSET 32
|
||||
|
||||
/**
|
||||
* LSO parameters
|
||||
/* LSO parameters
|
||||
* %NFP_NET_LSO_MAX_HDR_SZ: Maximum header size supported for LSO frames
|
||||
* %NFP_NET_LSO_MAX_SEGS: Maximum number of segments LSO frame can produce
|
||||
*/
|
||||
#define NFP_NET_LSO_MAX_HDR_SZ 255
|
||||
#define NFP_NET_LSO_MAX_SEGS 64
|
||||
|
||||
/**
|
||||
* Prepend field types
|
||||
*/
|
||||
/* Prepend field types */
|
||||
#define NFP_NET_META_FIELD_SIZE 4
|
||||
#define NFP_NET_META_HASH 1 /* next field carries hash type */
|
||||
#define NFP_NET_META_MARK 2
|
||||
@ -49,9 +42,7 @@
|
||||
|
||||
#define NFP_META_PORT_ID_CTRL ~0U
|
||||
|
||||
/**
|
||||
* Hash type pre-pended when a RSS hash was computed
|
||||
*/
|
||||
/* Hash type pre-pended when a RSS hash was computed */
|
||||
#define NFP_NET_RSS_NONE 0
|
||||
#define NFP_NET_RSS_IPV4 1
|
||||
#define NFP_NET_RSS_IPV6 2
|
||||
@ -63,16 +54,14 @@
|
||||
#define NFP_NET_RSS_IPV6_UDP 8
|
||||
#define NFP_NET_RSS_IPV6_EX_UDP 9
|
||||
|
||||
/**
|
||||
* Ring counts
|
||||
/* Ring counts
|
||||
* %NFP_NET_TXR_MAX: Maximum number of TX rings
|
||||
* %NFP_NET_RXR_MAX: Maximum number of RX rings
|
||||
*/
|
||||
#define NFP_NET_TXR_MAX 64
|
||||
#define NFP_NET_RXR_MAX 64
|
||||
|
||||
/**
|
||||
* Read/Write config words (0x0000 - 0x002c)
|
||||
/* Read/Write config words (0x0000 - 0x002c)
|
||||
* %NFP_NET_CFG_CTRL: Global control
|
||||
* %NFP_NET_CFG_UPDATE: Indicate which fields are updated
|
||||
* %NFP_NET_CFG_TXRS_ENABLE: Bitmask of enabled TX rings
|
||||
@ -147,8 +136,7 @@
|
||||
#define NFP_NET_CFG_LSC 0x0020
|
||||
#define NFP_NET_CFG_MACADDR 0x0024
|
||||
|
||||
/**
|
||||
* Read-only words (0x0030 - 0x0050):
|
||||
/* Read-only words (0x0030 - 0x0050):
|
||||
* %NFP_NET_CFG_VERSION: Firmware version number
|
||||
* %NFP_NET_CFG_STS: Status
|
||||
* %NFP_NET_CFG_CAP: Capabilities (same bits as %NFP_NET_CFG_CTRL)
|
||||
@ -193,36 +181,31 @@
|
||||
#define NFP_NET_CFG_START_TXQ 0x0048
|
||||
#define NFP_NET_CFG_START_RXQ 0x004c
|
||||
|
||||
/**
|
||||
* Prepend configuration
|
||||
/* Prepend configuration
|
||||
*/
|
||||
#define NFP_NET_CFG_RX_OFFSET 0x0050
|
||||
#define NFP_NET_CFG_RX_OFFSET_DYNAMIC 0 /* Prepend mode */
|
||||
|
||||
/**
|
||||
* RSS capabilities
|
||||
/* RSS capabilities
|
||||
* %NFP_NET_CFG_RSS_CAP_HFUNC: supported hash functions (same bits as
|
||||
* %NFP_NET_CFG_RSS_HFUNC)
|
||||
*/
|
||||
#define NFP_NET_CFG_RSS_CAP 0x0054
|
||||
#define NFP_NET_CFG_RSS_CAP_HFUNC 0xff000000
|
||||
|
||||
/**
|
||||
* TLV area start
|
||||
/* TLV area start
|
||||
* %NFP_NET_CFG_TLV_BASE: start anchor of the TLV area
|
||||
*/
|
||||
#define NFP_NET_CFG_TLV_BASE 0x0058
|
||||
|
||||
/**
|
||||
* VXLAN/UDP encap configuration
|
||||
/* VXLAN/UDP encap configuration
|
||||
* %NFP_NET_CFG_VXLAN_PORT: Base address of table of tunnels' UDP dst ports
|
||||
* %NFP_NET_CFG_VXLAN_SZ: Size of the UDP port table in bytes
|
||||
*/
|
||||
#define NFP_NET_CFG_VXLAN_PORT 0x0060
|
||||
#define NFP_NET_CFG_VXLAN_SZ 0x0008
|
||||
|
||||
/**
|
||||
* BPF section
|
||||
/* BPF section
|
||||
* %NFP_NET_CFG_BPF_ABI: BPF ABI version
|
||||
* %NFP_NET_CFG_BPF_CAP: BPF capabilities
|
||||
* %NFP_NET_CFG_BPF_MAX_LEN: Maximum size of JITed BPF code in bytes
|
||||
@ -247,14 +230,12 @@
|
||||
#define NFP_NET_CFG_BPF_CFG_MASK 7ULL
|
||||
#define NFP_NET_CFG_BPF_ADDR_MASK (~NFP_NET_CFG_BPF_CFG_MASK)
|
||||
|
||||
/**
|
||||
* 40B reserved for future use (0x0098 - 0x00c0)
|
||||
/* 40B reserved for future use (0x0098 - 0x00c0)
|
||||
*/
|
||||
#define NFP_NET_CFG_RESERVED 0x0098
|
||||
#define NFP_NET_CFG_RESERVED_SZ 0x0028
|
||||
|
||||
/**
|
||||
* RSS configuration (0x0100 - 0x01ac):
|
||||
/* RSS configuration (0x0100 - 0x01ac):
|
||||
* Used only when NFP_NET_CFG_CTRL_RSS is enabled
|
||||
* %NFP_NET_CFG_RSS_CFG: RSS configuration word
|
||||
* %NFP_NET_CFG_RSS_KEY: RSS "secret" key
|
||||
@ -281,8 +262,7 @@
|
||||
NFP_NET_CFG_RSS_KEY_SZ)
|
||||
#define NFP_NET_CFG_RSS_ITBL_SZ 0x80
|
||||
|
||||
/**
|
||||
* TX ring configuration (0x200 - 0x800)
|
||||
/* TX ring configuration (0x200 - 0x800)
|
||||
* %NFP_NET_CFG_TXR_BASE: Base offset for TX ring configuration
|
||||
* %NFP_NET_CFG_TXR_ADDR: Per TX ring DMA address (8B entries)
|
||||
* %NFP_NET_CFG_TXR_WB_ADDR: Per TX ring write back DMA address (8B entries)
|
||||
@ -301,8 +281,7 @@
|
||||
#define NFP_NET_CFG_TXR_IRQ_MOD(_x) (NFP_NET_CFG_TXR_BASE + 0x500 + \
|
||||
((_x) * 0x4))
|
||||
|
||||
/**
|
||||
* RX ring configuration (0x0800 - 0x0c00)
|
||||
/* RX ring configuration (0x0800 - 0x0c00)
|
||||
* %NFP_NET_CFG_RXR_BASE: Base offset for RX ring configuration
|
||||
* %NFP_NET_CFG_RXR_ADDR: Per RX ring DMA address (8B entries)
|
||||
* %NFP_NET_CFG_RXR_SZ: Per RX ring ring size (1B entries)
|
||||
@ -318,8 +297,7 @@
|
||||
#define NFP_NET_CFG_RXR_IRQ_MOD(_x) (NFP_NET_CFG_RXR_BASE + 0x300 + \
|
||||
((_x) * 0x4))
|
||||
|
||||
/**
|
||||
* Interrupt Control/Cause registers (0x0c00 - 0x0d00)
|
||||
/* Interrupt Control/Cause registers (0x0c00 - 0x0d00)
|
||||
* These registers are only used when MSI-X auto-masking is not
|
||||
* enabled (%NFP_NET_CFG_CTRL_MSIXAUTO not set). The array is index
|
||||
* by MSI-X entry and are 1B in size. If an entry is zero, the
|
||||
@ -334,8 +312,7 @@
|
||||
#define NFP_NET_CFG_ICR_RXTX 0x1
|
||||
#define NFP_NET_CFG_ICR_LSC 0x2
|
||||
|
||||
/**
|
||||
* General device stats (0x0d00 - 0x0d90)
|
||||
/* General device stats (0x0d00 - 0x0d90)
|
||||
* all counters are 64bit.
|
||||
*/
|
||||
#define NFP_NET_CFG_STATS_BASE 0x0d00
|
||||
@ -368,8 +345,7 @@
|
||||
#define NFP_NET_CFG_STATS_APP3_FRAMES (NFP_NET_CFG_STATS_BASE + 0xc0)
|
||||
#define NFP_NET_CFG_STATS_APP3_BYTES (NFP_NET_CFG_STATS_BASE + 0xc8)
|
||||
|
||||
/**
|
||||
* Per ring stats (0x1000 - 0x1800)
|
||||
/* Per ring stats (0x1000 - 0x1800)
|
||||
* options, 64bit per entry
|
||||
* %NFP_NET_CFG_TXR_STATS: TX ring statistics (Packet and Byte count)
|
||||
* %NFP_NET_CFG_RXR_STATS: RX ring statistics (Packet and Byte count)
|
||||
@ -381,8 +357,7 @@
|
||||
#define NFP_NET_CFG_RXR_STATS(_x) (NFP_NET_CFG_RXR_STATS_BASE + \
|
||||
((_x) * 0x10))
|
||||
|
||||
/**
|
||||
* General use mailbox area (0x1800 - 0x19ff)
|
||||
/* General use mailbox area (0x1800 - 0x19ff)
|
||||
* 4B used for update command and 4B return code
|
||||
* followed by a max of 504B of variable length value
|
||||
*/
|
||||
@ -399,8 +374,7 @@
|
||||
#define NFP_NET_CFG_MBOX_CMD_PCI_DSCP_PRIOMAP_SET 5
|
||||
#define NFP_NET_CFG_MBOX_CMD_TLV_CMSG 6
|
||||
|
||||
/**
|
||||
* VLAN filtering using general use mailbox
|
||||
/* VLAN filtering using general use mailbox
|
||||
* %NFP_NET_CFG_VLAN_FILTER: Base address of VLAN filter mailbox
|
||||
* %NFP_NET_CFG_VLAN_FILTER_VID: VLAN ID to filter
|
||||
* %NFP_NET_CFG_VLAN_FILTER_PROTO: VLAN proto to filter
|
||||
@ -411,8 +385,7 @@
|
||||
#define NFP_NET_CFG_VLAN_FILTER_PROTO (NFP_NET_CFG_VLAN_FILTER + 2)
|
||||
#define NFP_NET_CFG_VLAN_FILTER_SZ 0x0004
|
||||
|
||||
/**
|
||||
* TLV capabilities
|
||||
/* TLV capabilities
|
||||
* %NFP_NET_CFG_TLV_TYPE: Offset of type within the TLV
|
||||
* %NFP_NET_CFG_TLV_TYPE_REQUIRED: Driver must be able to parse the TLV
|
||||
* %NFP_NET_CFG_TLV_LENGTH: Offset of length within the TLV
|
||||
@ -438,8 +411,7 @@
|
||||
#define NFP_NET_CFG_TLV_HEADER_TYPE 0x7fff0000
|
||||
#define NFP_NET_CFG_TLV_HEADER_LENGTH 0x0000ffff
|
||||
|
||||
/**
|
||||
* Capability TLV types
|
||||
/* Capability TLV types
|
||||
*
|
||||
* %NFP_NET_CFG_TLV_TYPE_UNKNOWN:
|
||||
* Special TLV type to catch bugs, should never be encountered. Drivers should
|
||||
@ -512,8 +484,7 @@
|
||||
|
||||
struct device;
|
||||
|
||||
/**
|
||||
* struct nfp_net_tlv_caps - parsed control BAR TLV capabilities
|
||||
/* struct nfp_net_tlv_caps - parsed control BAR TLV capabilities
|
||||
* @me_freq_mhz: ME clock_freq (MHz)
|
||||
* @mbox_off: vNIC mailbox area offset
|
||||
* @mbox_len: vNIC mailbox area length
|
||||
|
@ -4,8 +4,7 @@
|
||||
#ifndef _NFP_NET_SRIOV_H_
|
||||
#define _NFP_NET_SRIOV_H_
|
||||
|
||||
/**
|
||||
* SRIOV VF configuration.
|
||||
/* SRIOV VF configuration.
|
||||
* The configuration memory begins with a mailbox region for communication with
|
||||
* the firmware followed by individual VF entries.
|
||||
*/
|
||||
|
@ -132,8 +132,7 @@ void nfp_devlink_port_unregister(struct nfp_port *port);
|
||||
void nfp_devlink_port_type_eth_set(struct nfp_port *port);
|
||||
void nfp_devlink_port_type_clear(struct nfp_port *port);
|
||||
|
||||
/**
|
||||
* Mac stats (0x0000 - 0x0200)
|
||||
/* Mac stats (0x0000 - 0x0200)
|
||||
* all counters are 64bit.
|
||||
*/
|
||||
#define NFP_MAC_STATS_BASE 0x0000
|
||||
|
Loading…
Reference in New Issue
Block a user