github/ocf
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix ocf_volume_ops documentation

Browse Source 
Signed-off-by: Robert Baldyga <robert.baldyga@intel.com>
This commit is contained in:
Robert Baldyga 2019-07-31 15:48:31 +02:00
parent 7f7e8bcdf5
commit 721fb68d6e
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
inc/ocf_volume.h
View File

@ -89,6 +89,8 @@ struct ocf_volume_ops {
* *
* @param[in] volume Volume * @param[in] volume Volume
* @param[in] volume_params optional volume parameters, opaque to OCF * @param[in] volume_params optional volume parameters, opaque to OCF
*
* @return Zero on success, otherwise error code
*/ */
int (*open)(ocf_volume_t volume, void *volume_params); int (*open)(ocf_volume_t volume, void *volume_params);
@ -100,16 +102,20 @@ struct ocf_volume_ops {
void (*close)(ocf_volume_t volume); void (*close)(ocf_volume_t volume);
/** /**
* @brief Close volume * @brief Get maximum io size
* *
* @param[in] volume Volume * @param[in] volume Volume
*
* @return Maximum io size in bytes
*/ */
unsigned int (*get_max_io_size)(ocf_volume_t volume); unsigned int (*get_max_io_size)(ocf_volume_t volume);
/** /**
* @brief Close volume * @brief Get volume length
* *
* @param[in] volume Volume * @param[in] volume Volume
*
* @return Volume lenght in bytes
*/ */
uint64_t (*get_length)(ocf_volume_t volume); uint64_t (*get_length)(ocf_volume_t volume);
}; };