X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=bertos%2Fio%2Fkfile_block.h;h=f7b9f9bc4c293d0a23dce94158e72b936bd0af1e;hb=9a76f040340e6fd0c42989871173fd0a03ec1f2f;hp=9694ea94c5c97cf4b1b527f66427acca65156068;hpb=0142058531b1f00b0dbe740b43900dfc361656e5;p=bertos.git diff --git a/bertos/io/kfile_block.h b/bertos/io/kfile_block.h index 9694ea94..f7b9f9bc 100644 --- a/bertos/io/kfile_block.h +++ b/bertos/io/kfile_block.h @@ -32,6 +32,9 @@ * * \brief KFile interface over a KBlock. * + * With this module, you can access a KBlock device + * with the handy KFile interface. + * In order to achieve this, the block device must support partial block write. */ #ifndef IO_KFILE_BLOCK_H @@ -41,12 +44,25 @@ #include #include +/** + * KFileBlock context. + */ typedef struct KFileBlock { - KFile fd; - KBlock *b; + KFile fd; ///< KFile context + KBlock *b; ///< KBlock device } KFileBlock; +/** + * Init a KFile over KBlock. + * After this you can access your KBlock device with a handy KFile interface. + * + * \note The block device must support partial block write in order support + * random write access. + * + * \param fb KFileBlock context. + * \param b block device to be accessed with a KFile interface. + */ void kfileblock_init(KFileBlock *fb, KBlock *b); #endif /* IO_KFILE_KBLOCK_H */