can: Kconfig: rename config symbol CAN_DEV into CAN_NETLINK
authorVincent Mailhol <mailhol.vincent@wanadoo.fr>
Fri, 10 Jun 2022 14:30:03 +0000 (23:30 +0900)
committerMarc Kleine-Budde <mkl@pengutronix.de>
Sat, 11 Jun 2022 15:11:01 +0000 (17:11 +0200)
In the next patches, the scope of the can-dev module will grow to
engloble the software/virtual drivers (slcan, v(x)can). To this
extent, release CAN_DEV by renaming it into CAN_NETLINK. The config
symbol CAN_DEV will be reused to cover this extended scope.

The rationale for the name CAN_NETLINK is that netlink is the
predominant feature added here.

The current description only mentions platform drivers despite the
fact that this symbol is also required by "normal" devices (e.g. USB
or PCI) which do not fall under the platform devices category. The
description is updated accordingly to fix this gap.

Link: https://lore.kernel.org/all/20220610143009.323579-2-mailhol.vincent@wanadoo.fr
Signed-off-by: Vincent Mailhol <mailhol.vincent@wanadoo.fr>
Acked-by: Max Staudt <max@enpas.org>
Tested-by: Oliver Hartkopp <socketcan@hartkopp.net>
Signed-off-by: Marc Kleine-Budde <mkl@pengutronix.de>
drivers/net/can/Kconfig
drivers/net/can/dev/Makefile

index b2dcc1e5a388f6564887e829781b476d303df85f..99f189ad35ad8ab39f433d9b3dbb26549d9db1a2 100644 (file)
@@ -48,15 +48,19 @@ config CAN_SLCAN
          can be changed by the 'maxdev=xx' module option. This driver can
          also be built as a module. If so, the module will be called slcan.
 
-config CAN_DEV
-       tristate "Platform CAN drivers with Netlink support"
+config CAN_NETLINK
+       tristate "CAN device drivers with Netlink support"
        default y
        help
-         Enables the common framework for platform CAN drivers with Netlink
-         support. This is the standard library for CAN drivers.
-         If unsure, say Y.
+         Enables the common framework for CAN device drivers. This is the
+         standard library and provides features for the Netlink interface such
+         as bittiming validation, support of CAN error states, device restart
+         and others.
+
+         This is required by all platform and hardware CAN drivers. If you
+         plan to use such devices or if unsure, say Y.
 
-if CAN_DEV
+if CAN_NETLINK
 
 config CAN_CALC_BITTIMING
        bool "CAN bit-timing calculation"
@@ -164,7 +168,7 @@ source "drivers/net/can/softing/Kconfig"
 source "drivers/net/can/spi/Kconfig"
 source "drivers/net/can/usb/Kconfig"
 
-endif
+endif #CAN_NETLINK
 
 config CAN_DEBUG_DEVICES
        bool "CAN devices debugging messages"
index af2901db473caa4e30536e26ecd134005af670b0..5b4c813c62223381799a3cb00a5d38d6490bbe55 100644 (file)
@@ -1,6 +1,6 @@
 # SPDX-License-Identifier: GPL-2.0
 
-obj-$(CONFIG_CAN_DEV)          += can-dev.o
+obj-$(CONFIG_CAN_NETLINK) += can-dev.o
 can-dev-y                      += bittiming.o
 can-dev-y                      += dev.o
 can-dev-y                      += length.o