andreika-git
/
ChibiOS
mirror of https://github.com/andreika-git/ChibiOS.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@3902 35acf78f-673a-0410-8e92-d51de3d6d3f4

This commit is contained in:
gdisirio 2012-02-01 19:43:05 +00:00
parent faeafd8a6c
commit aef4a4f4a8
1 changed files with 20 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
os/kernel/include/chfiles.h
View File

@ -39,10 +39,15 @@
#ifndef _CHFILES_H_ #ifndef _CHFILES_H_
#define _CHFILES_H_ #define _CHFILES_H_
/**
* @brief No error return code.
*/
#define FILE_OK 0
/** /**
* @brief Error code from the file stream methods. * @brief Error code from the file stream methods.
*/ */
#define FILE_ERROR 0xFFFFFFFFUL #define FILE_ERROR 0xFFFFFFFFUL
/** /**
* @brief File offset type. * @brief File offset type.
@ -63,7 +68,7 @@ typedef uint32_t fileoffset_t;
/* File get current position method.*/ \ /* File get current position method.*/ \
fileoffset_t (*getposition)(void *instance); \ fileoffset_t (*getposition)(void *instance); \
/* File seek method.*/ \ /* File seek method.*/ \
fileoffset_t (*lseek)(void *instance, fileoffset_t offset); uint32_t (*lseek)(void *instance, fileoffset_t offset);
/** /**
* @brief @p BaseFileStream specific data. * @brief @p BaseFileStream specific data.
@ -103,6 +108,9 @@ typedef struct {
* @details The function closes a file stream. * @details The function closes a file stream.
* *
* @param[in] ip pointer to a @p BaseFileStream or derived class * @param[in] ip pointer to a @p BaseFileStream or derived class
* @return The operation status.
* @retval FILE_OK no error.
* @retval FILE_ERROR operation failed.
* *
* @api * @api
*/ */
@ -112,38 +120,44 @@ typedef struct {
* @brief Returns an implementation dependent error code. * @brief Returns an implementation dependent error code.
* *
* @param[in] ip pointer to a @p BaseFileStream or derived class * @param[in] ip pointer to a @p BaseFileStream or derived class
* @return Implementation dependent error code.
* *
* @api * @api
*/ */
#define chFileStreamGetError ((ip)->vmt->geterror(ip)) #define chFileStreamGetError(ip) ((ip)->vmt->geterror(ip))
/** /**
* @brief Returns the current file size. * @brief Returns the current file size.
* *
* @param[in] ip pointer to a @p BaseFileStream or derived class * @param[in] ip pointer to a @p BaseFileStream or derived class
* @return The file size.
* *
* @api * @api
*/ */
#define chFileStreamGetSize ((ip)->vmt->getposition(ip)) #define chFileStreamGetSize(ip) ((ip)->vmt->getposition(ip))
/** /**
* @brief Returns the current file pointer position. * @brief Returns the current file pointer position.
* *
* @param[in] ip pointer to a @p BaseFileStream or derived class * @param[in] ip pointer to a @p BaseFileStream or derived class
* @return The current position inside the file.
* *
* @api * @api
*/ */
#define chFileStreamGetPosition ((ip)->vmt->getposition(ip)) #define chFileStreamGetPosition(ip) ((ip)->vmt->getposition(ip))
/** /**
* @brief Moves the file current pointer to an absolute position. * @brief Moves the file current pointer to an absolute position.
* *
* @param[in] ip pointer to a @p BaseFileStream or derived class * @param[in] ip pointer to a @p BaseFileStream or derived class
* @param[in] offset new absolute position * @param[in] offset new absolute position
* @return The operation status.
* @retval FILE_OK no error.
* @retval FILE_ERROR operation failed.
* *
* @api * @api
*/ */
#define chFileStreamSeek ((ip)->vmt->lseek(ip, offset)) #define chFileStreamSeek(ip) ((ip)->vmt->lseek(ip, offset))
/** @} */ /** @} */
#endif /* _CHFILES_H_ */ #endif /* _CHFILES_H_ */