From nobody Fri Nov 24 18:35:00 2023 X-Original-To: dev-commits-src-all@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 4ScNv83wH8z52BYL; Fri, 24 Nov 2023 18:35:00 +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 4ScNv8316mz3Gm4; Fri, 24 Nov 2023 18:35:00 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1700850900; 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=p9Y481syPlTaM0yMvFpSFdsUSZxrgytSXHXWr8rgkAw=; b=dUwS6ueTeq4VbQAg2MNglM+j1PZNCmcMBnuOk9LnBSIthvs63+Ou0QzROPmQpn+tPo9UDQ X0cm67UIIuXPOFVCYIMixP+CWyPcU2oVYLR6bwdKaxHZodZ+1S6vMc5kJ8ODWDXfJZdIwz LFPt1EgibEEv/kmR0hsBgcVbIu1ug6leEkbzTqrJT1m3/pONvMseGUZZrp5rgLYaydw+1n iQNW/8j4mtjJQGUNoDUZ0xV1+zGi269DKbLgHGtcP/eelpBwdJQCl1QRqMu+SNVPppuzbu a48nG5w2ynz919D2fhUWjZj/JPBYRKtVet9m80zKZ77rR8Ut3GWUQZC91aCL0w== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1700850900; 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=p9Y481syPlTaM0yMvFpSFdsUSZxrgytSXHXWr8rgkAw=; b=aZfVcTndWNUKxnYrks49smaVEseHW3O1i1FDjwspzoPA3Hh+kOKXcbB5TQAWzAVcIYbYKW /ECXlOxsAkcGa30wRo3u6+CxkebJqnJ7ayy/Pr/bT7Fk9RfOo7qv8Mz6+REHuJjLRvrXIO 8LUWqrBowqBaiBqzZAMa3dNou+9b+CMCfBUqe/5xjLrNEmXb1cUfN+2keY1F0VjYJ1RiKZ UU6hd6ew0J6XOgG5qtNGCdTpJ/wpjdLfdG/t47t9aNDWrH7Q2dbrubHs3qnIQH2ASQJdr9 Nq+BepwBcoK1/HXmritM9XF5hqHfj6AN+9ufREm+EXYRRM2QV5fUDBGp/nts0Q== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1700850900; a=rsa-sha256; cv=none; b=af419n0WfeJwEEtEa3cGaNI21NLiIaAKQE4aJ/pRs3ytY5Y/Jwj6/iio8xFoSoSWlVx2DW ud3t1en+qITOP2IH2nZsZE5gYsofI21OJegp1njPA0IUJNktk8+poaWzTEmf7pfC0dQzAl fF5yvvv17plijfm/JPAQG0yHmRw+IVjOLLIxbmpYbY+dNPrm0rbcVFZbj4od+5O7hFuhTC X1xn/siTbsWLmsDhzA/+wNsDJokpjGD4QtiC12O4w3IbJow9em24VoP0ZabwRtaAbW+XXP g0UgGlgPapmB/0TByCrsokTW5/cWp1dRkPc6hy39fMtPK5bYN8sc3FvoPNM41A== 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 4ScNv81c8hzwTF; Fri, 24 Nov 2023 18:35:00 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.17.1/8.17.1) with ESMTP id 3AOIZ08O068886; Fri, 24 Nov 2023 18:35:00 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.17.1/8.17.1/Submit) id 3AOIZ0x4068883; Fri, 24 Nov 2023 18:35:00 GMT (envelope-from git) Date: Fri, 24 Nov 2023 18:35:00 GMT Message-Id: <202311241835.3AOIZ0x4068883@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: 46971d38de33 - main - new-bus: Add comments for resource_*_map_request* List-Id: Commit messages for all branches of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-src-all@freebsd.org X-BeenThere: dev-commits-src-all@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: 46971d38de334a9418e2b66b37cea7d051b6731a Auto-Submitted: auto-generated The branch main has been updated by jhb: URL: https://cgit.FreeBSD.org/src/commit/?id=46971d38de334a9418e2b66b37cea7d051b6731a commit 46971d38de334a9418e2b66b37cea7d051b6731a Author: John Baldwin AuthorDate: 2023-11-24 18:33:57 +0000 Commit: John Baldwin CommitDate: 2023-11-24 18:33:57 +0000 new-bus: Add comments for resource_*_map_request* Requested by: mhorne --- sys/kern/subr_bus.c | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/sys/kern/subr_bus.c b/sys/kern/subr_bus.c index 1c6710dbbb3c..8da99e158f1c 100644 --- a/sys/kern/subr_bus.c +++ b/sys/kern/subr_bus.c @@ -2707,6 +2707,15 @@ device_set_unit(device_t dev, int unit) * Some useful method implementations to make life easier for bus drivers. */ +/** + * @brief Initialize a resource mapping request + * + * This is the internal implementation of the public API + * resource_init_map_request. Callers may be using a different layout + * of struct resource_map_request than the kernel, so callers pass in + * the size of the structure they are using to identify the structure + * layout. + */ void resource_init_map_request_impl(struct resource_map_request *args, size_t sz) { @@ -2715,6 +2724,18 @@ resource_init_map_request_impl(struct resource_map_request *args, size_t sz) args->memattr = VM_MEMATTR_DEVICE; } +/** + * @brief Validate a resource mapping request + * + * Translate a device driver's mapping request (@p in) to a struct + * resource_map_request using the current structure layout (@p out). + * In addition, validate the offset and length from the mapping + * request against the bounds of the resource @p r. If the offset or + * length are invalid, fail with EINVAL. If the offset and length are + * valid, the absolute starting address of the requested mapping is + * returned in @p startp and the length of the requested mapping is + * returned in @p lengthp. + */ int resource_validate_map_request(struct resource *r, struct resource_map_request *in, struct resource_map_request *out,