Commit d3b8c049 authored by Andrew Lunn's avatar Andrew Lunn Committed by David S. Miller
Browse files

dsa: Add boilerplate helper to register DSA tag driver modules 



A DSA tag driver module will need to register the tag protocols it
implements with the DSA core. Add macros containing this boiler plate.

The registration/unregistration code is currently just a stub. A Later
patch will add the real implementation.

Signed-off-by: default avatarAndrew Lunn <andrew@lunn.ch>
Reviewed-by: default avatarFlorian Fainelli <f.fainelli@gmail.com>

v2
Fix indent of #endif
Rewrite to move list pointer into a new structure
v3
Move kdoc next to macro
Fix THIS_MODULE indentation

Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent 056eed2f

include/net/dsa.h

+66 −0
Original line number Diff line number Diff line
@@ -594,4 +594,70 @@ int dsa_port_get_ethtool_phy_stats(struct dsa_port *dp, uint64_t *data); 
int dsa_port_get_phy_sset_count(struct dsa_port *dp);

void dsa_port_phylink_mac_change(struct dsa_switch *ds, int port, bool up);



struct dsa_tag_driver {

	const struct dsa_device_ops *ops;

	struct list_head list;

	struct module *owner;

};



void dsa_tag_drivers_register(struct dsa_tag_driver *dsa_tag_driver_array[],

			      unsigned int count,

			      struct module *owner);

void dsa_tag_drivers_unregister(struct dsa_tag_driver *dsa_tag_driver_array[],

				unsigned int count);



#define dsa_tag_driver_module_drivers(__dsa_tag_drivers_array, __count)	\

static int __init dsa_tag_driver_module_init(void)			\

{									\

	dsa_tag_drivers_register(__dsa_tag_drivers_array, __count,	\

				 THIS_MODULE);				\

	return 0;							\

}									\

module_init(dsa_tag_driver_module_init);				\

									\

static void __exit dsa_tag_driver_module_exit(void)			\

{									\

	dsa_tag_drivers_unregister(__dsa_tag_drivers_array, __count);	\

}									\

module_exit(dsa_tag_driver_module_exit)



/**

 * module_dsa_tag_drivers() - Helper macro for registering DSA tag

 * drivers

 * @__ops_array: Array of tag driver strucutres

 *

 * Helper macro for DSA tag drivers which do not do anything special

 * in module init/exit. Each module may only use this macro once, and

 * calling it replaces module_init() and module_exit().

 */

#define module_dsa_tag_drivers(__ops_array)				\

dsa_tag_driver_module_drivers(__ops_array, ARRAY_SIZE(__ops_array))



#define DSA_TAG_DRIVER_NAME(__ops) dsa_tag_driver ## _ ## __ops



/* Create a static structure we can build a linked list of dsa_tag

 * drivers

 */

#define DSA_TAG_DRIVER(__ops)						\

static struct dsa_tag_driver DSA_TAG_DRIVER_NAME(__ops) = {		\

	.ops = &__ops,							\

}



/**

 * module_dsa_tag_driver() - Helper macro for registering a single DSA tag

 * driver

 * @__ops: Single tag driver structures

 *

 * Helper macro for DSA tag drivers which do not do anything special

 * in module init/exit. Each module may only use this macro once, and

 * calling it replaces module_init() and module_exit().

 */

#define module_dsa_tag_driver(__ops)					\

DSA_TAG_DRIVER(__ops);							\

									\

static struct dsa_tag_driver *dsa_tag_driver_array[] =	{		\

	&DSA_TAG_DRIVER_NAME(__ops)					\

};									\

module_dsa_tag_drivers(dsa_tag_driver_array)

#endif

net/dsa/dsa.c

+12 −0
Original line number Diff line number Diff line
@@ -76,6 +76,18 @@ const struct dsa_device_ops *dsa_device_ops[DSA_TAG_LAST] = { 
	[DSA_TAG_PROTO_NONE] = &none_ops,

};



void dsa_tag_drivers_register(struct dsa_tag_driver *dsa_tag_driver_array[],

			      unsigned int count, struct module *owner)

{

}

EXPORT_SYMBOL_GPL(dsa_tag_drivers_register);



void dsa_tag_drivers_unregister(struct dsa_tag_driver *dsa_tag_driver_array[],

				unsigned int count)

{

}

EXPORT_SYMBOL_GPL(dsa_tag_drivers_unregister);



const char *dsa_tag_protocol_to_str(const struct dsa_device_ops *ops)

{

	return ops->name;

net/dsa/tag_brcm.c

+15 −1
Original line number Diff line number Diff line
@@ -175,6 +175,7 @@ const struct dsa_device_ops brcm_netdev_ops = { 
	.overhead = BRCM_TAG_LEN,

};



DSA_TAG_DRIVER(brcm_netdev_ops);

MODULE_ALIAS_DSA_TAG_DRIVER(DSA_TAG_PROTO_BRCM);

#endif
@@ -203,5 +204,18 @@ const struct dsa_device_ops brcm_prepend_netdev_ops = { 
};

#endif



MODULE_LICENSE("GPL");

DSA_TAG_DRIVER(brcm_prepend_netdev_ops);

MODULE_ALIAS_DSA_TAG_DRIVER(DSA_TAG_PROTO_BRCM_PREPEND);



static struct dsa_tag_driver *dsa_tag_driver_array[] =	{

#if IS_ENABLED(CONFIG_NET_DSA_TAG_BRCM)

	&DSA_TAG_DRIVER_NAME(brcm_netdev_ops),

#endif

#if IS_ENABLED(CONFIG_NET_DSA_TAG_BRCM_PREPEND)

	&DSA_TAG_DRIVER_NAME(brcm_prepend_netdev_ops),

#endif

};



module_dsa_tag_drivers(dsa_tag_driver_array);



MODULE_LICENSE("GPL");

net/dsa/tag_dsa.c

+2 −0
Original line number Diff line number Diff line
@@ -161,3 +161,5 @@ const struct dsa_device_ops dsa_netdev_ops = { 


MODULE_LICENSE("GPL");

MODULE_ALIAS_DSA_TAG_DRIVER(DSA_TAG_PROTO_DSA);



module_dsa_tag_driver(dsa_netdev_ops);

net/dsa/tag_edsa.c

+2 −0
Original line number Diff line number Diff line
@@ -180,3 +180,5 @@ const struct dsa_device_ops edsa_netdev_ops = { 


MODULE_LICENSE("GPL");

MODULE_ALIAS_DSA_TAG_DRIVER(DSA_TAG_PROTO_EDSA);



module_dsa_tag_driver(edsa_netdev_ops);

CRA Git | Maintained and supported by SUSTech CRA and CCSE