michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: reference: Add disk access API

Browse source 
Add the disk access API to the doc reference.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
This commit is contained in:
Carles Cufi 2020-03-17 15:13:15 +01:00 • committed by Carles Cufí
commit 4ffeb79ecd
3 changed files with 34 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

23
doc/reference/storage/disk/access.rst Normal file
View file

@ -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

1
doc/reference/storage/index.rst
View file

@ -7,6 +7,7 @@ Storage
:maxdepth: 1 :maxdepth: 1
nvs/nvs.rst nvs/nvs.rst
disk/access.rst
disk/sdhc.rst disk/sdhc.rst
flash_map/flash_map.rst flash_map/flash_map.rst
fcb/fcb.rst fcb/fcb.rst

10
include/disk/disk_access.h
View file

@ -17,6 +17,12 @@
#ifndef ZEPHYR_INCLUDE_DISK_DISK_ACCESS_H_ #ifndef ZEPHYR_INCLUDE_DISK_DISK_ACCESS_H_
#define 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 <kernel.h> #include <kernel.h>
#include <zephyr/types.h> #include <zephyr/types.h>
#include <sys/dlist.h> #include <sys/dlist.h>
@ -131,4 +137,8 @@ int disk_access_unregister(struct disk_info *disk);
} }
#endif #endif
/**
* @}
*/
#endif /* ZEPHYR_INCLUDE_DISK_DISK_ACCESS_H_ */ #endif /* ZEPHYR_INCLUDE_DISK_DISK_ACCESS_H_ */