mirrors/u-boot
0
0
Fork 0
mirror of https://github.com/u-boot/u-boot.git synced 2024-11-24 04:34:22 +08:00
Code Issues Packages Projects Releases Wiki Activity

fs: correct comments for fs_read() and write()

Browse Source 
The existing comments where confusing read and write. The comment for
fs_write() had:
"@addr: The address to read into"

So let's rework the comments and format them in Sphinx style.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
This commit is contained in:
Heinrich Schuchardt 2019-04-25 20:36:39 +02:00 committed by Tom Rini
parent 12df71cd74
commit a0e92cde2a
1 changed files with 21 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
include/fs.h
View File

@ -71,30 +71,33 @@ int fs_exists(const char *filename);
*/
int fs_size(const char *filename, loff_t *size);
/*
* fs_read - Read file from the partition previously set by fs_set_blk_dev()
* Note that not all filesystem types support either/both offset!=0 or len!=0.
/**
* fs_read() - read file from the partition previously set by fs_set_blk_dev()
*
* @filename: Name of file to read from
* @addr: The address to read into
* @offset: The offset in file to read from
* @len: The number of bytes to read. Maybe 0 to read entire file
* @actread: Returns the actual number of bytes read
* @return 0 if ok with valid *actread, -1 on error conditions
* Note that not all filesystem drivers support either or both of offset != 0
* and len != 0.
*
* @filename: full path of the file to read from
* @addr: address of the buffer to write to
* @offset: offset in the file from where to start reading
* @len: the number of bytes to read. Use 0 to read entire file.
* @actread: returns the actual number of bytes read
* Return: 0 if OK with valid *actread, -1 on error conditions
*/
int fs_read(const char *filename, ulong addr, loff_t offset, loff_t len,
loff_t *actread);
/*
* fs_write - Write file to the partition previously set by fs_set_blk_dev()
* Note that not all filesystem types support offset!=0.
/**
* fs_write() - write file to the partition previously set by fs_set_blk_dev()
*
* @filename: Name of file to read from
* @addr: The address to read into
* @offset: The offset in file to read from. Maybe 0 to write to start of file
* @len: The number of bytes to write
* @actwrite: Returns the actual number of bytes written
* @return 0 if ok with valid *actwrite, -1 on error conditions
* Note that not all filesystem drivers support offset != 0.
*
* @filename: full path of the file to write to
* @addr: address of the buffer to read from
* @offset: offset in the file from where to start writing
* @len: the number of bytes to write
* @actwrite: returns the actual number of bytes written
* Return: 0 if OK with valid *actwrite, -1 on error conditions
*/
int fs_write(const char *filename, ulong addr, loff_t offset, loff_t len,
loff_t *actwrite);