fixup! sys/storage/vfs: initial import

RIOT-OS · Jun 1, 2022 · 5da7eea · 5da7eea
1 parent 3f0ab9f
commit 5da7eea
Showing 1 changed file with 15 additions and 1 deletion.
diff --git a/sys/include/suit/storage/vfs.h b/sys/include/suit/storage/vfs.h
@@ -10,7 +10,21 @@
  * @ingroup     sys_suit_storage
  * @brief       SUIT riotboot firmware storage backend
  *
- * @{
+ * VFS storage can service different files mounted on the filesystem. Serviceable
+ * FILES must be registered:
+ *
+ * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ {.c}
+ * #include "suit/storage/vfs.h"
+ * #include "xfa.h"
+ *
+ * XFA_USE(char*, suit_storage_files_reg);
+ * XFA(suit_storage_files_reg, 0) char* _firmware_0 = VFS_DEFAULT_DATA "/FW0.TXT";
+ * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ *
+ * Once registered its content may be securely updated via SUIT by specifying the
+ * "install-id" as the filepath.
+ *
+ *  @{
  *
  * @brief       riotboot vfs storage backend functions for SUIT manifests
  * @author      Koen Zandberg <koen@bergzand.net>