linux-kernel - Documentation for Regmap API?

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Message-ID: <l5l7jdkvrwkwo3dtfow55ot4jj4rp7z6nuz5ijlj52vgmqhwth@uvks72vz4lpd>
Date: Fri, 18 Apr 2025 10:13:21 +0330
From: Ali Nasrolahi <a.nasrolahi01@...il.com>
To: Linux Newbies <linux-newbies.vger.kernel.org@...hyr.smtp.subspace.kernel.org>
Cc: Linux Kernel <linux-kernel@...r.kernel.org>
Subject: 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@...nel.org>
   L:  linux-kernel@...r.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