Documentation for Regmap API?

[Richard]

Hi,

The book "Linux Driver Development" by John Madieu has a good 
explanation of how to use the Regmap API

-- Richard

On 21/04/2025 16:59, Ali Nasrolahi wrote:
> Hi,
> 
> I've been exploring the Regmap API and
> was wondering if there’s a dedicated documentation page
> that provides an overview or explanation of the API itself.
> 
> So far, I’ve looked into the following:
> 
> 1. https://docs.kernel.org/driver-api/index.html
> 2. The Documentation/ directory in both the mainline and linux-next trees.
> 3. The regmap tree mentioned in the MAINTAINERS file:
> ---
>     REGISTER MAP ABSTRACTION
>     M:  Mark Brown <broonie at kernel.org>
>     L:  linux-kernel at vger.kernel.org
>     S:  Supported
>     T:  git git://git.kernel.org/pub/scm/linux/kernel/git/broonie/regmap.git
>     F:  Documentation/devicetree/bindings/regmap/
>     F:  drivers/base/regmap/
>     F:  include/linux/regmap.h
> ---
> 
> Despite checking these locations,
> I couldn’t find a dedicated document explaining the Regmap API in detail.
> 
> 1. Is there any such documentation available that I might have missed?
> 
> 2. If not, I’d be happy to contribute and help write one.
> Should I bring this up on the linux-doc mailing list for further guidance on how to proceed?
> 
> Any pointers or suggestions would be greatly appreciated.
> 
> Thanks a lot,
> Ali
> 
> 
> _______________________________________________
> Kernelnewbies mailing list
> Kernelnewbies at kernelnewbies.org
> https://lists.kernelnewbies.org/mailman/listinfo/kernelnewbies