From eb166f16e217c0ec21ea0ed01590f86b9deeff73 Mon Sep 17 00:00:00 2001 From: Nicolas Clauvelin Date: Thu, 27 Jan 2022 13:16:20 -0500 Subject: [PATCH] Update documentation for register memory access This commit adds a mention of the `rw_mem_device` and `ro_mem_device` that provides access to a register memory. Closes #15 --- API.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/API.md b/API.md index 8cf3c7c..aaa2dd7 100644 --- a/API.md +++ b/API.md @@ -232,6 +232,12 @@ pack_loop::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: