STM32F429-DISCO LCD demo target.

[lwext4.git] / ext4.h

diff --git a/ext4.h b/ext4.h
index 11d33bd5277ef55d85367687fb7817b1f2084bc7..06b677430d1f04a28edc21291ee0bcf1d456ff67 100644 (file)
--- a/ext4.h
+++ b/ext4.h
@@ -32,7 +32,7 @@
 /**\r
  * @file  ext4.h\r
  * @brief Ext4 high level operations (files, directories, mountpoints...).\r
- *               Client has to include only this file.\r
+ *        Client has to include only this file.\r
  */\r
 \r
 #ifndef EXT4_H_\r
@@ -75,53 +75,53 @@
 /********************************FILE SEEK FLAGS*****************************/\r
 \r
 #ifndef SEEK_SET\r
-#define SEEK_SET       0\r
+#define SEEK_SET    0\r
 #endif\r
 \r
 #ifndef SEEK_CUR\r
-#define SEEK_CUR       1\r
+#define SEEK_CUR    1\r
 #endif\r
 \r
 #ifndef SEEK_END\r
-#define SEEK_END       2\r
+#define SEEK_END    2\r
 #endif\r
 \r
 /********************************OS LOCK INFERFACE***************************/\r
 \r
-/**@brief      OS dependent lock interface.*/\r
+/**@brief   OS dependent lock interface.*/\r
 struct ext4_lock {\r
 \r
-    /**@brief  Lock access to mountpoint*/\r
+    /**@brief   Lock access to mountpoint*/\r
     void (*lock)(void);\r
 \r
-    /**@brief  Unlock access to mountpoint*/\r
+    /**@brief   Unlock access to mountpoint*/\r
     void (*unlock)(void);\r
 };\r
 \r
 \r
 /********************************FILE DESCRIPTOR*****************************/\r
 \r
-/**@brief      File descriptor*/\r
+/**@brief   File descriptor*/\r
 typedef struct ext4_file {\r
 \r
-    /**@brief  Pountpoint handle.*/\r
+    /**@brief   Pountpoint handle.*/\r
     struct ext4_mountpoint *mp;\r
 \r
-    /**@brief  File inode id*/\r
+    /**@brief   File inode id*/\r
     uint32_t inode;\r
 \r
-    /**@brief  Open flags.*/\r
+    /**@brief   Open flags.*/\r
     uint32_t flags;\r
 \r
-    /**@brief  File size.*/\r
+    /**@brief   File size.*/\r
     uint64_t fsize;\r
 \r
-    /**@brief  File position*/\r
+    /**@brief   File position*/\r
     uint64_t fpos;\r
 }ext4_file;\r
 \r
 /*****************************DIRECTORY DESCRIPTOR***************************/\r
-/**@brief      Directory entry types. Copy from ext4_types.h*/\r
+/**@brief   Directory entry types. Copy from ext4_types.h*/\r
 enum  {\r
     EXT4_DIRENTRY_UNKNOWN = 0,\r
     EXT4_DIRENTRY_REG_FILE,\r
@@ -146,10 +146,10 @@ typedef struct {
 }ext4_direntry;\r
 \r
 typedef struct  {\r
-    /**@brief  File descriptor*/\r
-    ext4_file          f;\r
-    /**@brief  Current direntry.*/\r
-    ext4_direntry      de;\r
+    /**@brief   File descriptor*/\r
+    ext4_file f;\r
+    /**@brief   Current direntry.*/\r
+    ext4_direntry de;\r
 }ext4_dir;\r
 \r
 /********************************MOUNT OPERATIONS****************************/\r
@@ -167,8 +167,8 @@ int ext4_device_register(struct ext4_blockdev *bd, struct ext4_bcache *bc,
         const char *dev_name);\r
 \r
 /**@brief   Mount a block device with EXT4 partition to the mountpoint.\r
- * @param      dev_name block device name (@ref ext4_device_register)\r
- * @param      mount_point pount point, for example\r
+ * @param   dev_name block device name (@ref ext4_device_register)\r
+ * @param   mount_point pount point, for example\r
  *          -   /\r
  *          -   /my_partition/\r
  *          -   /my_second_partition/\r
@@ -177,7 +177,7 @@ int ext4_device_register(struct ext4_blockdev *bd, struct ext4_bcache *bc,
 int ext4_mount(const char * dev_name,  char *mount_point);\r
 \r
 /**@brief   Umount operation.\r
- * @param      mount_point mount name\r
+ * @param   mount_point mount name\r
  * @return  standard error code */\r
 int ext4_umount(char *mount_point);\r
 \r
@@ -212,9 +212,9 @@ int ext4_mount_point_stats(const char *mount_point,
 int ext4_fremove(const char *path);\r
 \r
 /**@brief   File open function.\r
- * @param      filename, (has to start from mountpoint)\r
- *                     /my_partition/my_file\r
- * @param      flags open file flags\r
+ * @param   filename, (has to start from mountpoint)\r
+ *          /my_partition/my_file\r
+ * @param   flags open file flags\r
  *  |---------------------------------------------------------------|\r
  *  |   r or rb                 O_RDONLY                            |\r
  *  |---------------------------------------------------------------|\r
@@ -229,7 +229,7 @@ int ext4_fremove(const char *path);
  *  |   a+ or ab+ or a+b        O_RDWR|O_CREAT|O_APPEND             |\r
  *  |---------------------------------------------------------------|\r
  *\r
- * @return     standard error code*/\r
+ * @return  standard error code*/\r
 int ext4_fopen (ext4_file *f, const char *path, const char *flags);\r
 \r
 /**@brief   File close function.\r