From: Mark Brown Date: Tue, 24 Sep 2024 10:08:08 +0000 (+0200) Subject: regcache: Improve documentation of available cache types X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=caf78b0465053c23aa6211b9815dd5433766627d;p=users%2Fjedix%2Flinux-maple.git regcache: Improve documentation of available cache types There is some user confusion about which cache types to choose when which is not helped by the lack of any central documentation providing an overview of what's available. Provide a short overview in the API header to try to help reduce this. Signed-off-by: Mark Brown Link: https://patch.msgid.link/20240924-regcache-document-types-v1-1-e157054e1215@kernel.org Signed-off-by: Mark Brown --- diff --git a/include/linux/regmap.h b/include/linux/regmap.h index f9ccad32fc5cb..da07584284ab3 100644 --- a/include/linux/regmap.h +++ b/include/linux/regmap.h @@ -54,7 +54,14 @@ struct sdw_slave; #define REGMAP_UPSHIFT(s) (-(s)) #define REGMAP_DOWNSHIFT(s) (s) -/* An enum of all the supported cache types */ +/* + * The supported cache types, the default is no cache. Any new caches + * should usually use the maple tree cache unless they specifically + * require that there are never any allocations at runtime and can't + * provide defaults in which case they should use the flat cache. The + * rbtree cache *may* have some performance advantage for very low end + * systems that make heavy use of cache syncs but is mainly legacy. + */ enum regcache_type { REGCACHE_NONE, REGCACHE_RBTREE,