diff options
| author | Ioana Ciornei <ioana.ciornei@nxp.com> | 2018-07-27 17:43:18 +0300 |
|---|---|---|
| committer | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2018-07-27 17:18:19 +0200 |
| commit | a89bac0a2ca45c9a44f2a35523252d9d8082aa03 (patch) | |
| tree | 5eadcba7c7c8fffe9c6571889c46b752deac1de3 /drivers/staging/fsl-dpaa2 | |
| parent | f970bec3cf9ab59ae5ae1ad03c76a912d0f72418 (diff) | |
staging: fsl-dpaa2/ethsw: document nested structs as per kernel-doc
Document nested structs per kernel-doc requirements by moving
all comments before the actual struct.
Signed-off-by: Ioana Ciornei <ioana.ciornei@nxp.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'drivers/staging/fsl-dpaa2')
| -rw-r--r-- | drivers/staging/fsl-dpaa2/ethsw/dpsw.h | 27 |
1 files changed, 12 insertions, 15 deletions
diff --git a/drivers/staging/fsl-dpaa2/ethsw/dpsw.h b/drivers/staging/fsl-dpaa2/ethsw/dpsw.h index 82f80c409ec3..db43fa3782b8 100644 --- a/drivers/staging/fsl-dpaa2/ethsw/dpsw.h +++ b/drivers/staging/fsl-dpaa2/ethsw/dpsw.h @@ -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; |