From 8ee4b8968bffbe1f819821c0238956bdab6e7e76 Mon Sep 17 00:00:00 2001 From: Luca Toniolo <10792599+grandixximo@users.noreply.github.com> Date: Mon, 17 Aug 2026 19:01:36 +0800 Subject: [PATCH] mesa_modbus: mark as superseded by hm2_modbus (2.9 backport) Backport of the master deprecation with status adjusted for 2.9, per the PR #4386 and #4396 review discussions: mesa_modbus is superseded by the hm2_modbus driver and mesambccc-compiled MBCCB files. It remains available throughout the 2.9 series, while new configurations are encouraged to migrate. Only build-time and documentation notes in 2.9, no load-time warning: the driver is still fully supported in this series, so a nudge at modcompile time is enough. Add a stderr note to modcompile and notes in the README, the mesa_modbus driver doc, the modcompile man page and the docs index. --- docs/man/man1/modcompile.1 | 7 ++++++- docs/src/drivers/mesa_modbus.adoc | 2 ++ docs/src/index.tmpl | 2 +- src/hal/drivers/mesa-hostmot2/modbus/README.adoc | 5 +++++ src/hal/drivers/mesa-hostmot2/modbus/modcompile.py | 5 +++++ 5 files changed, 19 insertions(+), 2 deletions(-) diff --git a/docs/man/man1/modcompile.1 b/docs/man/man1/modcompile.1 index 0bf8134f852..a5f3f8b7d4b 100644 --- a/docs/man/man1/modcompile.1 +++ b/docs/man/man1/modcompile.1 @@ -24,7 +24,7 @@ .\" .TH modcompile "1" "2023-07-13" "LinuxCNC Documentation" "The Enhanced Machine Controller" .SH NAME -modcompile \- Utility for compiling Modbus drivers +modcompile \- Utility for compiling Modbus drivers (SUPERSEDED) .SH SYNOPSIS @@ -35,6 +35,11 @@ modcompile \- Utility for compiling Modbus drivers \fBmodcompile* [\fB-k\fR] [\fB-n\fR] [\fB-v\fR] module.mod ... .SH DESCRIPTION +\fBmodcompile\fR and the mesa_modbus framework are superseded by the +\fBhm2_modbus\fR driver and \fBmesambccc\fR-compiled MBCCB files. They remain +available throughout the 2.9 series, but new configurations are encouraged to +migrate. + The \fBmodcompile\fR utility is used to compile modbus drivers that use the PktUART interface of Mesa cards. diff --git a/docs/src/drivers/mesa_modbus.adoc b/docs/src/drivers/mesa_modbus.adoc index d17b0b455a3..ce280c766fd 100644 --- a/docs/src/drivers/mesa_modbus.adoc +++ b/docs/src/drivers/mesa_modbus.adoc @@ -5,6 +5,8 @@ = Mesa Modbus = +NOTE: The Mesa Modbus framework (modcompile and mesa_modbus) is superseded by the link:../man/man9/hm2_modbus.9.html[hm2_modbus] driver and mesambccc-compiled MBCCB files. It remains available throughout the 2.9 series, but new configurations are encouraged to migrate. + A framework to create custom, realtime, modbus drivers using the Mesa PktUART component. diff --git a/docs/src/index.tmpl b/docs/src/index.tmpl index ffa9ae415f5..73141c4a84e 100644 --- a/docs/src/index.tmpl +++ b/docs/src/index.tmpl @@ -200,7 +200,7 @@ function setup_page(){
  • Raspberry Pi GPIO Driver
  • Mesa HostMot2 Driver
  • Modbus to HAL Driver
    • -
  • Modbus framework for Mesa cards
    • +
  • Modbus framework for Mesa cards (superseded)
  • Mitsubishi VFD Driver
  • Motenc Driver
  • Opto22 Driver
    • diff --git a/src/hal/drivers/mesa-hostmot2/modbus/README.adoc b/src/hal/drivers/mesa-hostmot2/modbus/README.adoc index 7cfa602d44b..20ccfecf284 100644 --- a/src/hal/drivers/mesa-hostmot2/modbus/README.adoc +++ b/src/hal/drivers/mesa-hostmot2/modbus/README.adoc @@ -1,3 +1,8 @@ +NOTE: The mesa_modbus framework (this directory and modcompile) is +superseded by the hm2_modbus driver and mesambccc-compiled .mbccb +files. It remains available throughout the 2.9 series, but new +configurations are encouraged to migrate. + Do not edit mesa_modbus.c (Unless you are sure that you want to, of course). Create a new xxxxx.mod file that describes your particular modbus device diff --git a/src/hal/drivers/mesa-hostmot2/modbus/modcompile.py b/src/hal/drivers/mesa-hostmot2/modbus/modcompile.py index 2c1062c8698..9966756eb90 100644 --- a/src/hal/drivers/mesa-hostmot2/modbus/modcompile.py +++ b/src/hal/drivers/mesa-hostmot2/modbus/modcompile.py @@ -88,6 +88,11 @@ def main(): if len(args) < 1: raise SystemExit("No modules found (*.mod files) to compile."); + print("NOTE: modcompile and the mesa_modbus framework are superseded by the" + " hm2_modbus driver and mesambccc-compiled .mbccb files. They remain" + " available throughout the 2.9 series, but new configurations are" + " encouraged to migrate.", file=sys.stderr) + # Create a temporary directory and copy the C template into it tempdir = tempfile.mkdtemp(prefix="modcompile") BASE = os.path.abspath(os.path.join(os.path.dirname(sys.argv[0]), ".."))