Documentation for Regmap API?
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@kernel.org> L: linux-kernel@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
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@kernel.org> L: linux-kernel@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@kernelnewbies.org https://lists.kernelnewbies.org/mailman/listinfo/kernelnewbies
Thank you for your response, Richard. Yes, I've read the book; however, I was hoping to have an up-to-date in-tree documentation for it. That's the main reason why I proposed my help to write one. -- Ali On 25/04/22 12:16AM, Richard wrote:
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@kernel.org> L: linux-kernel@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@kernelnewbies.org https://lists.kernelnewbies.org/mailman/listinfo/kernelnewbies
_______________________________________________ Kernelnewbies mailing list Kernelnewbies@kernelnewbies.org https://lists.kernelnewbies.org/mailman/listinfo/kernelnewbies
On Mon, 21 Apr 2025 at 18:35, Ali Nasrolahi <a.nasrolahi01@gmail.com> wrote:
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.
You’re welcome to contribute your regmap documentation to: https://en.wikibooks.org/wiki/The_Linux_Kernel/System#regmap Thanks Costa
participants (3)
-
Ali Nasrolahi -
Costa Shulyupin -
Richard