Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit a89bac0a authored by Ioana Ciornei's avatar Ioana Ciornei Committed by Greg Kroah-Hartman
Browse files

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: default avatarIoana Ciornei <ioana.ciornei@nxp.com>
Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent f970bec3

drivers/staging/fsl-dpaa2/ethsw/dpsw.h

+12 −15
Original line number Diff line number Diff line
@@ -80,23 +80,20 @@ enum dpsw_component_type { 
 * @num_ifs: Number of external and internal interfaces

 * @adv: Advanced parameters; default is all zeros;

 *	 use this structure to change default settings

 */

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;

 * @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.

	 * @fdb_aging_time: Default FDB aging time for default FDB table;

 * @adv.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;

 * @adv.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

 * @adv.component_type: Indicates the component type of this bridge

 */

struct dpsw_cfg {

	u16 num_ifs;

	struct {

		u64 options;

		u16 max_vlans;