From 4ffeb79ecdbbbde174910b7c28ad142f4ed54cb1 Mon Sep 17 00:00:00 2001 From: Carles Cufi Date: Tue, 17 Mar 2020 15:13:15 +0100 Subject: [PATCH] doc: reference: Add disk access API Add the disk access API to the doc reference. Signed-off-by: Carles Cufi --- doc/reference/storage/disk/access.rst | 23 +++++++++++++++++++++++ doc/reference/storage/index.rst | 1 + include/disk/disk_access.h | 10 ++++++++++ 3 files changed, 34 insertions(+) create mode 100644 doc/reference/storage/disk/access.rst diff --git a/doc/reference/storage/disk/access.rst b/doc/reference/storage/disk/access.rst new file mode 100644 index 00000000000..ab705ae3adb --- /dev/null +++ b/doc/reference/storage/disk/access.rst @@ -0,0 +1,23 @@ +.. _disk_access_api: + +Disk Access +########### + +Overview +******** + +The disk access API provides access to storage disks, physical or in Flash or +RAM. + +Configuration Options +********************* + +Related configuration options: + +* :option:`CONFIG_DISK_ACCESS` + +API Reference +************* + +.. doxygengroup:: disk_access_interface + :project: Zephyr diff --git a/doc/reference/storage/index.rst b/doc/reference/storage/index.rst index 5bb3d58a11f..c7d92f4729d 100644 --- a/doc/reference/storage/index.rst +++ b/doc/reference/storage/index.rst @@ -7,6 +7,7 @@ Storage :maxdepth: 1 nvs/nvs.rst + disk/access.rst disk/sdhc.rst flash_map/flash_map.rst fcb/fcb.rst diff --git a/include/disk/disk_access.h b/include/disk/disk_access.h index 0fa124e3df2..bf6a45c48a0 100644 --- a/include/disk/disk_access.h +++ b/include/disk/disk_access.h @@ -17,6 +17,12 @@ #ifndef ZEPHYR_INCLUDE_DISK_DISK_ACCESS_H_ #define ZEPHYR_INCLUDE_DISK_DISK_ACCESS_H_ +/** + * @brief Disk Access APIs + * @defgroup disk_access_interface Disk Access Interface + * @{ + */ + #include #include #include @@ -131,4 +137,8 @@ int disk_access_unregister(struct disk_info *disk); } #endif +/** + * @} + */ + #endif /* ZEPHYR_INCLUDE_DISK_DISK_ACCESS_H_ */