From: "Ilpo Järvinen" <ilpo.jarvinen@linux.intel.com>
To: linux-pci@vger.kernel.org, "Bjorn Helgaas" <bhelgaas@google.com>,
"Lorenzo Pieralisi" <lorenzo.pieralisi@arm.com>,
"Rob Herring" <robh@kernel.org>,
"Krzysztof Wilczyński" <kw@linux.com>,
"Igor Mammedov" <imammedo@redhat.com>,
"Mika Westerberg" <mika.westerberg@linux.intel.com>,
"Andy Shevchenko" <andriy.shevchenko@intel.com>,
"Rafael J . Wysocki" <rafael@kernel.org>,
"Jonathan Cameron" <Jonathan.Cameron@huawei.com>,
linux-kernel@vger.kernel.org
Cc: "Ilpo Järvinen" <ilpo.jarvinen@linux.intel.com>,
"Lidong Wang" <lidong.wang@intel.com>,
"Andy Shevchenko" <andriy.shevchenko@linux.intel.com>
Subject: [PATCH v3 3/8] resource: Document find_resource_space() and resource_constraint
Date: Tue, 7 May 2024 13:25:18 +0300 [thread overview]
Message-ID: <20240507102523.57320-4-ilpo.jarvinen@linux.intel.com> (raw)
In-Reply-To: <20240507102523.57320-1-ilpo.jarvinen@linux.intel.com>
Document find_resource_space() and the struct resource_constraint as
they are going to be exposed outside of resource.c.
Tested-by: Lidong Wang <lidong.wang@intel.com>
Signed-off-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Reviewed-by: Mika Westerberg <mika.westerberg@linux.intel.com>
---
kernel/resource.c | 29 ++++++++++++++++++++++++++---
1 file changed, 26 insertions(+), 3 deletions(-)
diff --git a/kernel/resource.c b/kernel/resource.c
index e163e0a8f2f8..3f15a32d9c42 100644
--- a/kernel/resource.c
+++ b/kernel/resource.c
@@ -48,7 +48,19 @@ struct resource iomem_resource = {
};
EXPORT_SYMBOL(iomem_resource);
-/* constraints to be met while allocating resources */
+/**
+ * struct resource_constraint - constraints to be met while searching empty
+ * resource space
+ * @min: The minimum address for the memory range
+ * @max: The maximum address for the memory range
+ * @align: Alignment for the start address of the empty space
+ * @alignf: Additional alignment constraints callback
+ * @alignf_data: Data provided for @alignf callback
+ *
+ * Contains the range and alignment constraints that have to be met during
+ * find_resource_space(). @alignf can be NULL indicating no alignment beyond
+ * @align is necessary.
+ */
struct resource_constraint {
resource_size_t min, max, align;
resource_size_t (*alignf)(void *, const struct resource *,
@@ -686,8 +698,19 @@ next: if (!this || this->end == root->end)
return -EBUSY;
}
-/*
- * Find empty space in the resource tree given range and alignment.
+/**
+ * find_resource_space - Find empty space in the resource tree
+ * @root: Root resource descriptor
+ * @new: Resource descriptor awaiting an empty resource space
+ * @size: The minimum size of the empty space
+ * @constraint: The range and alignment constraints to be met
+ *
+ * Finds an empty space under @root in the resource tree satisfying range and
+ * alignment @constraints.
+ *
+ * Return:
+ * * %0 - if successful, @new members start, end, and flags are altered.
+ * * %-EBUSY - if no empty space was found.
*/
static int find_resource_space(struct resource *root, struct resource *new,
resource_size_t size,
--
2.39.2
next prev parent reply other threads:[~2024-05-07 10:26 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-05-07 10:25 [PATCH v3 0/8] PCI: Solve two bridge window sizing issues Ilpo Järvinen
2024-05-07 10:25 ` [PATCH v3 1/8] PCI: Fix resource double counting on remove & rescan Ilpo Järvinen
2024-05-07 10:25 ` [PATCH v3 2/8] resource: Rename find_resource() to find_resource_space() Ilpo Järvinen
2024-05-07 10:25 ` Ilpo Järvinen [this message]
2024-05-07 10:25 ` [PATCH v3 4/8] resource: Use typedef for alignf callback Ilpo Järvinen
2024-05-07 10:25 ` [PATCH v3 5/8] resource: Handle simple alignment inside __find_resource_space() Ilpo Järvinen
2024-05-07 10:25 ` [PATCH v3 6/8] resource: Export find_resource_space() Ilpo Järvinen
2024-05-07 10:25 ` [PATCH v3 7/8] PCI: Make minimum bridge window alignment reference more obvious Ilpo Järvinen
2024-05-07 10:36 ` Mika Westerberg
2024-05-07 10:50 ` Ilpo Järvinen
2024-05-07 14:01 ` Andy Shevchenko
2024-05-07 10:25 ` [PATCH v3 8/8] PCI: Relax bridge window tail sizing rules Ilpo Järvinen
2024-05-07 13:49 ` Andy Shevchenko
2024-05-28 13:10 ` [PATCH v3 0/8] PCI: Solve two bridge window sizing issues Ilpo Järvinen
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240507102523.57320-4-ilpo.jarvinen@linux.intel.com \
--to=ilpo.jarvinen@linux.intel.com \
--cc=Jonathan.Cameron@huawei.com \
--cc=andriy.shevchenko@intel.com \
--cc=andriy.shevchenko@linux.intel.com \
--cc=bhelgaas@google.com \
--cc=imammedo@redhat.com \
--cc=kw@linux.com \
--cc=lidong.wang@intel.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-pci@vger.kernel.org \
--cc=lorenzo.pieralisi@arm.com \
--cc=mika.westerberg@linux.intel.com \
--cc=rafael@kernel.org \
--cc=robh@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).