Deprecate the 'devclass' argument from *DRIVER_MODULE() macros.
ClosedPublic
Actions

Authored by jhb on Apr 19 2022, 5:13 PM.

Details

Reviewers

Group Reviewers

Commits

rG5f684c7cb8ee: Deprecate the 'devclass' argument from *DRIVER_MODULE() macros.
rG2a99dd30dfaa: Deprecate the 'devclass' argument from *DRIVER_MODULE() macros.

Summary

This argument is useless for the vast majority of drivers. For now,
use VA_ARGS wrapper macros so that that the *DRIVER_MODULE()
macros except both the old version (with a devclass) and the new
version (which omits the argument and stores NULL in the
driver_module_data structure). This provides an API compatiblity
shim that can be merged to older stable branches.

Once all drivers relevant to 14.0 (both in and out of tree) have been
updated, the API compat shims can be dropped.

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

jhb created this revision.Apr 19 2022, 5:13 PM

Herald added a reviewer: manpages. · View Herald TranscriptApr 19 2022, 5:13 PM

jhb requested review of this revision.Apr 19 2022, 5:13 PM

jhb added a parent revision: D34962: devclass_add_driver: Permit NULL to be passed in dcp..

Harbormaster completed remote builds in B45230: Diff 105174.Apr 19 2022, 5:13 PM

jhb added a child revision: D34964: cxgbe: Remove unused devclass arguments to *DRIVER_MODULE()..Apr 19 2022, 5:13 PM

Update DRIVER_MODULE.9 which I missed earlier.

Harbormaster completed remote builds in B45232: Diff 105176.Apr 19 2022, 5:17 PM

While I normally I hate this kind of tricky vararg stuff, I think in this case, it's good.

This revision is now accepted and ready to land.Apr 19 2022, 5:20 PM

Closed by commit rG2a99dd30dfaa: Deprecate the 'devclass' argument from *DRIVER_MODULE() macros. (authored by jhb). · Explain WhyApr 19 2022, 5:46 PM

This revision was automatically updated to reflect the committed changes.

jhb added a commit: rG2a99dd30dfaa: Deprecate the 'devclass' argument from *DRIVER_MODULE() macros..

Commit message typo: s/except/accept/

share/man/man9/DRIVER_MODULE.9
147	Putting the cart before the horse here? If I understand the intent of this change right, it deprecates the devclass argument, but doesn't remove it yet. Documenting that would alleviate confusion when exposed to drivers still using it.

jhb added inline comments.Apr 22 2022, 9:31 PM

share/man/man9/DRIVER_MODULE.9
147	It will be gone in a couple of weeks, and my intent is that people writing new code shouldn't use it. I also plan to MFC the API change to make it optional so that any new code going forward should not use it even on older supported branches.