From nobody Tue Apr 19 17:45:44 2022 X-Original-To: dev-commits-src-main@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 427A111D4880; Tue, 19 Apr 2022 17:45:45 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4KjWRs0rvXz3t4V; Tue, 19 Apr 2022 17:45:45 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1650390345; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=xjggZhqcL+s4ZaCEnk+EnUya+SMQUMWzBuloX0ISui4=; b=Ak5EM0nsRpIeysJFkLErL2BbSxw2W4QZBbDq7d3x0FiO6Xcci58h5W4djYzuj0FJg5e/TT PJdL25CntdM/jkiB1Jw2Kb4yW6lqYmdyzid9czfph41GMmoklK+TWAuURMY5P0FC8qgO4G qtEw+JXdP7mFC4jPevuQJza7uISod1Jzi7muBNd00pAvOxEaT8eixUbvlOVNJ8/+9UlVy4 LZdzy2EbN3VhojSkclLm2+SyM0u36ASMpZn14iyeltnKocM/oKglOcTF6g1c6mvSbiDR2f sTL9AkaS1InbyKIFzn0cgAq5JuKR4lVbAsySVIEloCWjLjCVo73Cr/0glx5/+Q== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id EC92F2B86B; Tue, 19 Apr 2022 17:45:44 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 23JHjip5037905; Tue, 19 Apr 2022 17:45:44 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 23JHjiDr037904; Tue, 19 Apr 2022 17:45:44 GMT (envelope-from git) Date: Tue, 19 Apr 2022 17:45:44 GMT Message-Id: <202204191745.23JHjiDr037904@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: John Baldwin Subject: git: 2a99dd30dfaa - main - Deprecate the 'devclass' argument from *DRIVER_MODULE() macros. List-Id: Commit messages for the main branch of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-main List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-src-main@freebsd.org X-BeenThere: dev-commits-src-main@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: jhb X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 2a99dd30dfaac98fea79f084b3a13c45199e1348 Auto-Submitted: auto-generated ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1650390345; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=xjggZhqcL+s4ZaCEnk+EnUya+SMQUMWzBuloX0ISui4=; b=KTyWdP4B9xCdD7qqpGCch6iHcexoUA+pkwy38lHxLg464QkLd1JGzDF58EFKAmUWFinKIA ll+DKXE6tUmRgdOk+WzusBKT76XinBvZ2JIWlb4vfOpi5RSNvBLvkRbQVb1yOyWZ63HLI+ vWyVqhp95Z6bI1M0R2rgWVq4V1iKmu6twyLkx0FB0EiQdpxP/kbpN9tOXLSAdbrjNjzUSX +UIy4SWda0GYOH6FdzNnOrDRfw2okZYsw7Vpugie+f9ehTpuSXJSmbxKKw/uLKUfCgLz47 imIRfB+/TOKI2bB69TMbUAQXZVoL5g2bSDxoAl++ADxNTSY7yTD0xtplx/tcEQ== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1650390345; a=rsa-sha256; cv=none; b=jI9pEzDZy7uKtP8QKvVW4RIyeMO1fuRB96FF/VOglfoudIZRmU00j2gOLwtlXpiwj0ywtj Tz3PRcBE78w75P+6CxGSRRb2KBfkVfr47cycjSgKhtcqqPznQIVhwqDYMGDZsD0DXDZudI 36y9PAZC1TVJCoxqJaxGuNWT5d9Z2T7RaeTxznl8h6o6sITWfw7YUR4QVjTxqCvCsxOOd7 MH7l+bHwUj+9cy9r7WyRLTadq0KqBKTZNlTVfIP0626Fxvp136KuOIfYCRgARcvaE0PPmO kedGgrGNFSKmdj6fSAc7Qx2Uj2o1hK5Tp14PQEWaD318CI1v56JZIIOcFWzTgw== ARC-Authentication-Results: i=1; mx1.freebsd.org; none X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by jhb: URL: https://cgit.FreeBSD.org/src/commit/?id=2a99dd30dfaac98fea79f084b3a13c45199e1348 commit 2a99dd30dfaac98fea79f084b3a13c45199e1348 Author: John Baldwin AuthorDate: 2022-04-19 17:43:06 +0000 Commit: John Baldwin CommitDate: 2022-04-19 17:43:57 +0000 Deprecate the 'devclass' argument from *DRIVER_MODULE() macros. This argument is useless for the vast majority of drivers. For now, use __VA_ARGS__ wrapper macros so that that the *DRIVER_MODULE() macros accept 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. Reviewed by: imp MFC after: 2 weeks Differential Revision: https://reviews.freebsd.org/D34963 --- share/man/man9/DRIVER_MODULE.9 | 24 +++++++++-------- share/man/man9/driver.9 | 4 +-- sys/sys/bus.h | 58 ++++++++++++++++++++++++++++++++++++------ 3 files changed, 64 insertions(+), 22 deletions(-) diff --git a/share/man/man9/DRIVER_MODULE.9 b/share/man/man9/DRIVER_MODULE.9 index 5d5927fba1e8..2f8ed333ee71 100644 --- a/share/man/man9/DRIVER_MODULE.9 +++ b/share/man/man9/DRIVER_MODULE.9 @@ -42,10 +42,10 @@ .In sys/kernel.h .In sys/bus.h .In sys/module.h -.Fn DRIVER_MODULE name busname "driver_t driver" "devclass_t devclass" "modeventhand_t evh" "void *arg" -.Fn DRIVER_MODULE_ORDERED name busname "driver_t driver" "devclass_t devclass" "modeventhand_t evh" "void *arg" "int order" -.Fn EARLY_DRIVER_MODULE name busname "driver_t driver" "devclass_t devclass" "modeventhand_t evh" "void *arg" "int pass" -.Fn EARLY_DRIVER_MODULE_ORDERED name busname "driver_t driver" "devclass_t devclass" "modeventhand_t evh" "void *arg" "enum sysinit_elem_order order" "int pass" +.Fn DRIVER_MODULE name busname "driver_t driver" "modeventhand_t evh" "void *arg" +.Fn DRIVER_MODULE_ORDERED name busname "driver_t driver" "modeventhand_t evh" "void *arg" "int order" +.Fn EARLY_DRIVER_MODULE name busname "driver_t driver" "modeventhand_t evh" "void *arg" "int pass" +.Fn EARLY_DRIVER_MODULE_ORDERED name busname "driver_t driver" "modeventhand_t evh" "void *arg" "enum sysinit_elem_order order" "int pass" .Sh DESCRIPTION The .Fn DRIVER_MODULE @@ -74,9 +74,9 @@ which is a pretty clean way of making front ends for different cards using the same driver on the same or different buses. For example, the following is allowed: .Pp -.Fn DRIVER_MODULE foo isa foo_driver foo_devclass NULL NULL ; +.Fn DRIVER_MODULE foo isa foo_driver NULL NULL ; .Pp -.Fn DRIVER_MODULE foo pci foo_driver foo_devclass NULL NULL ; +.Fn DRIVER_MODULE foo pci foo_driver NULL NULL ; .Pp .Fa driver is the driver of type @@ -86,11 +86,6 @@ two most important parts of the call to .Fn DRIVER_MODULE . .Pp The -.Fa devclass -argument contains the kernel-internal information about the device, -which will be used within the kernel driver module. -.Pp -The .Fa evh argument is the event handler which is called when the driver (or module) is loaded or unloaded (see @@ -146,6 +141,13 @@ for a specific pass level. .Xr module 9 , .Xr MODULE_PNP_INFO 9 , .Xr SYSINIT 9 +.Sh HISTORY +Prior to +.Fx 14.0 , +these macros accepted an additional +.Vt devclass_t +argument after +.Fa driver . .Sh AUTHORS This manual page was written by .An Alexander Langer Aq Mt alex@FreeBSD.org . diff --git a/share/man/man9/driver.9 b/share/man/man9/driver.9 index e801a188c732..d9d7b48c7863 100644 --- a/share/man/man9/driver.9 +++ b/share/man/man9/driver.9 @@ -67,9 +67,7 @@ static driver_t foo_driver = { sizeof(struct foo_softc) }; -static devclass_t foo_devclass; - -DRIVER_MODULE(foo, bogo, foo_driver, foo_devclass, NULL, NULL); +DRIVER_MODULE(foo, bogo, foo_driver, NULL, NULL); .Ed .Sh DESCRIPTION Each driver in the kernel is described by a diff --git a/sys/sys/bus.h b/sys/sys/bus.h index 8ed748b72bab..c9d10ab9afaf 100644 --- a/sys/sys/bus.h +++ b/sys/sys/bus.h @@ -800,14 +800,17 @@ struct driver_module_data { int dmd_pass; }; -#define EARLY_DRIVER_MODULE_ORDERED(name, busname, driver, devclass, \ +#define _DRIVER_MODULE_MACRO(_1, _2, _3, _4, _5, _6, _7, _8, NAME, ...) \ + NAME + +#define _EARLY_DRIVER_MODULE_ORDERED(name, busname, driver, devclass, \ evh, arg, order, pass) \ \ static struct driver_module_data name##_##busname##_driver_mod = { \ evh, arg, \ #busname, \ (kobj_class_t) &driver, \ - &devclass, \ + devclass, \ pass \ }; \ \ @@ -819,19 +822,58 @@ static moduledata_t name##_##busname##_mod = { \ DECLARE_MODULE(name##_##busname, name##_##busname##_mod, \ SI_SUB_DRIVERS, order) -#define EARLY_DRIVER_MODULE(name, busname, driver, devclass, evh, arg, pass) \ - EARLY_DRIVER_MODULE_ORDERED(name, busname, driver, devclass, \ +#define EARLY_DRIVER_MODULE_ORDERED7(name, busname, driver, evh, arg, \ + order, pass) \ + _EARLY_DRIVER_MODULE_ORDERED(name, busname, driver, NULL, evh, \ + arg, order, pass) + +#define EARLY_DRIVER_MODULE_ORDERED8(name, busname, driver, devclass, \ + evh, arg, order, pass) \ + _EARLY_DRIVER_MODULE_ORDERED(name, busname, driver, &devclass, \ + evh, arg, order, pass) + +#define EARLY_DRIVER_MODULE_ORDERED(...) \ + _DRIVER_MODULE_MACRO(__VA_ARGS__, EARLY_DRIVER_MODULE_ORDERED8, \ + EARLY_DRIVER_MODULE_ORDERED7)(__VA_ARGS__) + +#define EARLY_DRIVER_MODULE7(name, busname, driver, devclass, evh, arg, pass) \ + EARLY_DRIVER_MODULE_ORDERED8(name, busname, driver, devclass, \ evh, arg, SI_ORDER_MIDDLE, pass) -#define DRIVER_MODULE_ORDERED(name, busname, driver, devclass, evh, arg,\ +#define EARLY_DRIVER_MODULE6(name, busname, driver, evh, arg, pass) \ + EARLY_DRIVER_MODULE_ORDERED7(name, busname, driver, evh, arg, \ + SI_ORDER_MIDDLE, pass) + +#define EARLY_DRIVER_MODULE(...) \ + _DRIVER_MODULE_MACRO(__VA_ARGS__, INVALID, \ + EARLY_DRIVER_MODULE7, EARLY_DRIVER_MODULE6)(__VA_ARGS__) + +#define DRIVER_MODULE_ORDERED7(name, busname, driver, devclass, evh, arg,\ order) \ - EARLY_DRIVER_MODULE_ORDERED(name, busname, driver, devclass, \ + EARLY_DRIVER_MODULE_ORDERED8(name, busname, driver, devclass, \ evh, arg, order, BUS_PASS_DEFAULT) -#define DRIVER_MODULE(name, busname, driver, devclass, evh, arg) \ - EARLY_DRIVER_MODULE(name, busname, driver, devclass, evh, arg, \ +#define DRIVER_MODULE_ORDERED6(name, busname, driver, devclass, evh, arg,\ + order) \ + EARLY_DRIVER_MODULE_ORDERED7(name, busname, driver, evh, arg, \ + order, BUS_PASS_DEFAULT) + +#define DRIVER_MODULE_ORDERED(...) \ + _DRIVER_MODULE_MACRO(__VA_ARGS__, INVALID, \ + DRIVER_MODULE_ORDERED7, DRIVER_MODULE_ORDERED6)(__VA_ARGS__) + +#define DRIVER_MODULE6(name, busname, driver, devclass, evh, arg) \ + EARLY_DRIVER_MODULE7(name, busname, driver, devclass, evh, arg, \ BUS_PASS_DEFAULT) +#define DRIVER_MODULE5(name, busname, driver, evh, arg) \ + EARLY_DRIVER_MODULE6(name, busname, driver, evh, arg, \ + BUS_PASS_DEFAULT) + +#define DRIVER_MODULE(...) \ + _DRIVER_MODULE_MACRO(__VA_ARGS__, INVALID, INVALID, \ + DRIVER_MODULE6, DRIVER_MODULE5)(__VA_ARGS__) + /** * Generic ivar accessor generation macros for bus drivers */