From owner-dev-commits-src-main@freebsd.org Wed May 19 22:25:25 2021 Return-Path: Delivered-To: dev-commits-src-main@mailman.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.nyi.freebsd.org (Postfix) with ESMTP id AC0B164D2EC; Wed, 19 May 2021 22:25:25 +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 4FlnW94MBWz3jpn; Wed, 19 May 2021 22:25:25 +0000 (UTC) (envelope-from git@FreeBSD.org) 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 74A1C1ABC9; Wed, 19 May 2021 22:25:25 +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 14JMPPGM081855; Wed, 19 May 2021 22:25:25 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 14JMPPgA081854; Wed, 19 May 2021 22:25:25 GMT (envelope-from git) Date: Wed, 19 May 2021 22:25:25 GMT Message-Id: <202105192225.14JMPPgA081854@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Warner Losh Subject: git: 96480d9b338b - main - cam_sim: add doxygen to cam_sim_alloc_dev MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: imp X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 96480d9b338bd501d1a92bd961a0776ff0c39f71 Auto-Submitted: auto-generated X-BeenThere: dev-commits-src-main@freebsd.org X-Mailman-Version: 2.1.34 Precedence: list List-Id: Commit messages for the main branch of the src repository List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 19 May 2021 22:25:25 -0000 The branch main has been updated by imp: URL: https://cgit.FreeBSD.org/src/commit/?id=96480d9b338bd501d1a92bd961a0776ff0c39f71 commit 96480d9b338bd501d1a92bd961a0776ff0c39f71 Author: Warner Losh AuthorDate: 2021-05-16 15:37:26 +0000 Commit: Warner Losh CommitDate: 2021-05-19 21:59:09 +0000 cam_sim: add doxygen to cam_sim_alloc_dev cam_sim_alloc_dev was overlooked when cam_sim_alloc was documented. Add doxygen docs for it, pointing at cam_sim_alloc. Sponsored by: Netflix --- sys/cam/cam_sim.c | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/sys/cam/cam_sim.c b/sys/cam/cam_sim.c index 5b6d43b81d5d..64427795426e 100644 --- a/sys/cam/cam_sim.c +++ b/sys/cam/cam_sim.c @@ -130,11 +130,19 @@ cam_sim_alloc(sim_action_func sim_action, sim_poll_func sim_poll, return (sim); } +/** + * @brief allocate a new sim and fill in the details with a device_t + * + * Just like @c cam_sim_alloc, but with an additional paramter. + * + * @param dev A newbus device that's associated with the + * sim. Must be non-NULL. + */ struct cam_sim * cam_sim_alloc_dev(sim_action_func sim_action, sim_poll_func sim_poll, - const char *sim_name, void *softc, device_t dev, - struct mtx *mtx, int max_dev_transactions, - int max_tagged_dev_transactions, struct cam_devq *queue) + const char *sim_name, void *softc, device_t dev, struct mtx *mtx, + int max_dev_transactions, int max_tagged_dev_transactions, + struct cam_devq *queue) { struct cam_sim *sim;