staging: fsl-dpaa2: document nested structs as per kernel-doc
v2 cover staging: fsl-dpaa2: document nested structs as per kernel-doc
Document nested structs per kernel-doc requirements by moving all comments before the actual struct.
Changes in v2:
- remove comments of non-existent fields
Ioana Ciornei (2):
staging: fsl-dpaa2/eth: document nested structs as per kernel-doc
staging: fsl-dpaa2/ethsw: document nested structs as per kernel-doc
drivers/staging/fsl-dpaa2/ethernet/dpkg.h | 70 +++++++--------- drivers/staging/fsl-dpaa2/ethernet/dpni.h | 129 +++++++++++++++++------------- drivers/staging/fsl-dpaa2/ethsw/dpsw.h | 27 +++---- 3 files changed, 111 insertions(+), 115 deletions(-)
Signature · 1 line
1.9.1
PATCH v2 1/2 staging: fsl-dpaa2/eth: document nested structs as per kernel-doc
Document nested structs per kernel-doc requirements by moving all comments before the actual struct.
---
Changes in v2:
- remove comments of non-existent fields
drivers/staging/fsl-dpaa2/ethernet/dpkg.h | 70 +++++++--------- drivers/staging/fsl-dpaa2/ethernet/dpni.h | 129 +++++++++++++++++------------- 2 files changed, 99 insertions(+), 100 deletions(-)
drivers/staging/fsl-dpaa2/ethernet/dpkg.h +27 -43
@@ -89,45 +89,41 @@ struct dpkg_mask {/** * struct dpkg_extract - A structure for defining a single extraction * @type: Determines how the union below is interpreted: -* DPKG_EXTRACT_FROM_HDR: selects 'from_hdr'; -* DPKG_EXTRACT_FROM_DATA: selects 'from_data'; -* DPKG_EXTRACT_FROM_PARSE: selects 'from_parse' +* DPKG_EXTRACT_FROM_HDR: selects 'from_hdr'; +* DPKG_EXTRACT_FROM_DATA: selects 'from_data'; +* DPKG_EXTRACT_FROM_PARSE: selects 'from_parse' * @extract: Selects extraction method +* @extract.from_hdr: Used when 'type = DPKG_EXTRACT_FROM_HDR' +* @extract.from_data: Used when 'type = DPKG_EXTRACT_FROM_DATA' +* @extract.from_parse: Used when 'type = DPKG_EXTRACT_FROM_PARSE' +* @extract.from_hdr.prot: Any of the supported headers +* @extract.from_hdr.type: Defines the type of header extraction: +* DPKG_FROM_HDR: use size & offset below; +* DPKG_FROM_FIELD: use field, size and offset below; +* DPKG_FULL_FIELD: use field below +* @extract.from_hdr.field: One of the supported fields (NH_FLD_) +* @extract.from_hdr.size: Size in bytes +* @extract.from_hdr.offset: Byte offset +* @extract.from_hdr.hdr_index: Clear for cases not listed below; +* Used for protocols that may have more than a single +* header, 0 indicates an outer header; +* Supported protocols (possible values): +* NET_PROT_VLAN (0, HDR_INDEX_LAST); +* NET_PROT_MPLS (0, 1, HDR_INDEX_LAST); +* NET_PROT_IP(0, HDR_INDEX_LAST); +* NET_PROT_IPv4(0, HDR_INDEX_LAST); +* NET_PROT_IPv6(0, HDR_INDEX_LAST); +* @extract.from_data.size: Size in bytes +* @extract.from_data.offset: Byte offset +* @extract.from_parse.size: Size in bytes +* @extract.from_parse.offset: Byte offset * @num_of_byte_masks: Defines the number of valid entries in the array below; * This is also the number of bytes to be used as masks * @masks: Masks parameters */ struct dpkg_extract { enum dpkg_extract_type type; - /** - * union extract - Selects extraction method - * @from_hdr - Used when 'type = DPKG_EXTRACT_FROM_HDR' - * @from_data - Used when 'type = DPKG_EXTRACT_FROM_DATA' - * @from_parse - Used when 'type = DPKG_EXTRACT_FROM_PARSE' - */ union { - /** - * struct from_hdr - Used when 'type = DPKG_EXTRACT_FROM_HDR' - * @prot: Any of the supported headers - * @type: Defines the type of header extraction: - * DPKG_FROM_HDR: use size & offset below; - * DPKG_FROM_FIELD: use field, size and offset below; - * DPKG_FULL_FIELD: use field below - * @field: One of the supported fields (NH_FLD_) - * - * @size: Size in bytes - * @offset: Byte offset - * @hdr_index: Clear for cases not listed below; - * Used for protocols that may have more than a single - * header, 0 indicates an outer header; - * Supported protocols (possible values): - * NET_PROT_VLAN (0, HDR_INDEX_LAST); - * NET_PROT_MPLS (0, 1, HDR_INDEX_LAST); - * NET_PROT_IP(0, HDR_INDEX_LAST); - * NET_PROT_IPv4(0, HDR_INDEX_LAST); - * NET_PROT_IPv6(0, HDR_INDEX_LAST); - */ - struct { enum net_prot prot; enum dpkg_extract_from_hdr_type type;
@@ -136,22 +132,10 @@ struct dpkg_extract {u8 offset;u8 hdr_index; } from_hdr; -/** -* struct from_data - Used when 'type = DPKG_EXTRACT_FROM_DATA' -* @size: Size in bytes -* @offset: Byte offset -*/ struct {u8 size;u8 offset; } from_data; - -/** -* struct from_parse - Used when -* 'type = DPKG_EXTRACT_FROM_PARSE' -* @size: Size in bytes -* @offset: Byte offset -*/ struct {u8 size;u8 offset;
drivers/staging/fsl-dpaa2/ethernet/dpni.h +72 -57
171 lines not on this page · raw message
Signature · 1 line
1.9.1
PATCH v2 2/2 staging: fsl-dpaa2/ethsw: document nested structs as per kernel-doc
In reply to Ioana CiorneiDocument nested structs per kernel-doc requirements by moving all comments before the actual struct.
---
Changes in v2:
- none
drivers/staging/fsl-dpaa2/ethsw/dpsw.h | 27 ++++++++++++--------------- 1 file changed, 12 insertions(+), 15 deletions(-)
drivers/staging/fsl-dpaa2/ethsw/dpsw.h +12 -15
@@ -79,24 +79,21 @@ enum dpsw_component_type {* struct dpsw_cfg - DPSW configuration * @num_ifs: Number of external and internal interfaces * @adv: Advanced parameters; default is all zeros; -* use this structure to change default settings +* use this structure to change default settings +* @adv.options: Enable/Disable DPSW features (bitmap) +* @adv.max_vlans: Maximum Number of VLAN's; 0 - indicates default 16 +* @adv.max_meters_per_if: Number of meters per interface +* @adv.max_fdbs: Maximum Number of FDB's; 0 - indicates default 16 +* @adv.max_fdb_entries: Number of FDB entries for default FDB table; +* 0 - indicates default 1024 entries. +* @adv.fdb_aging_time: Default FDB aging time for default FDB table; +* 0 - indicates default 300 seconds +* @adv.max_fdb_mc_groups: Number of multicast groups in each FDB table; +* 0 - indicates default 32 +* @adv.component_type: Indicates the component type of this bridge */ struct dpsw_cfg {u16 num_ifs; -/** -* struct adv - Advanced parameters -* @options: Enable/Disable DPSW features (bitmap) -* @max_vlans: Maximum Number of VLAN's; 0 - indicates default 16 -* @max_meters_per_if: Number of meters per interface -* @max_fdbs: Maximum Number of FDB's; 0 - indicates default 16 -* @max_fdb_entries: Number of FDB entries for default FDB table; -* 0 - indicates default 1024 entries. -* @fdb_aging_time: Default FDB aging time for default FDB table; -* 0 - indicates default 300 seconds -* @max_fdb_mc_groups: Number of multicast groups in each FDB table; -* 0 - indicates default 32 -* @component_type: Indicates the component type of this bridge -*/ struct {u64 options;u16 max_vlans;
Signature · 1 line
1.9.1