mirrors/cppreg
1
0
Fork 0
mirror of https://github.com/sendyne/cppreg.git synced 2025-05-09 15:14:05 +00:00
Code Issues Releases Wiki Activity

Update documentation for register memory access

Browse Source 
This commit adds a mention of the `rw_mem_device` and `ro_mem_device`
that provides access to a register memory.

Closes #15
This commit is contained in:
Nicolas Clauvelin 2022-01-27 13:16:20 -05:00
parent 263bd8913d
commit eb166f16e2
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
API.md
View File

@ -232,6 +232,12 @@ pack_loop<Channels>::apply([](auto index) {
});
```
### Accessing registers memory ###
The register memory can be accessed directly using the static methods:
- `rw_mem_device()` for read/write access.
- `ro_mem_devices` for read-only access.
## Field interface ##
The `Field` template type provided by `cppreg` (see [Field.h](register/Field.h)) contains the added value of the library in terms of type safety, efficiency and expression of intent. The interface is: