Changeset 365e5e08 in mainline

Timestamp:

2011-07-25T19:01:03Z (13 years ago)

Author:

Maurizio Lombardi <m.lombardi85@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

6468072e

Parents:

2eaf655

Message:

Add comments

File:

• uspace/srv/fs/minixfs/mfs_balloc.c (modified) (6 diffs)

uspace/srv/fs/minixfs/mfs_balloc.c

@@ -45 +45 @@
 mfs_alloc_bit(struct mfs_instance *inst, uint32_t *idx, bmap_id_t bid);
 
-
+/**Allocate a new inode.
+ *
+ * @param inst          Pointer to the filesystem instance.
+ * @param inum          Pointer to a 32 bit number where the index of
+ *                      the new inode will be saved.
+ *
+ * @return              EOK on success or a negative error code.
+ */
 int
 mfs_alloc_inode(struct mfs_instance *inst, uint32_t *inum)
@@ -52 +59 @@
 }
 
+/**Free an inode.
+ *
+ * @param inst          Pointer to the filesystem instance.
+ * @param inum          Number of the inode to free.
+ *
+ * @return              EOK on success or a negative error code.
+ */
 int
 mfs_free_inode(struct mfs_instance *inst, uint32_t inum)
@@ -58 +72 @@
 }
 
+/**Allocate a new zone.
+ *
+ * @param inst          Pointer to the filesystem instance.
+ * @param zone          Pointer to a 32 bit number where the index
+ *                      of the zone will be saved.
+ *
+ * @return              EOK on success or a negative error code.
+ */
 int
 mfs_alloc_zone(struct mfs_instance *inst, uint32_t *zone)
@@ -67 +89 @@
 }
 
+/**Free a zone.
+ *
+ * @param inst          Pointer to the filesystem instance.
+ * @param zone          Index of the zone to free.
+ *
+ * @return              EOK on success or a negative error code.
+ */
 int
 mfs_free_zone(struct mfs_instance *inst, uint32_t zone)
@@ -75 +104 @@
 }
 
+/**Clear a bit in a bitmap.
+ *
+ * @param inst          Pointer to the filesystem instance.
+ * @param idx           Index of the bit to clear.
+ * @param bid           BMAP_ZONE if operating on the zone's bitmap,
+ *                      BMAP_INODE if operating on the inode's bitmap.
+ *
+ * @return              EOK on success or a negative error code.
+ */
 static int
 mfs_free_bit(struct mfs_instance *inst, uint32_t idx, bmap_id_t bid)
@@ -127 +165 @@
 }
 
+/**Search a free bit in a bitmap and mark it as used.
+ *
+ * @param inst          Pointer to the filesystem instance.
+ * @param idx           Pointer of a 32 bit number where the index
+ *                      of the found bit will be stored.
+ * @param bid           BMAP_ZONE if operating on the zone's bitmap,
+ *                      BMAP_INODE if operating on the inode's bitmap.
+ *
+ * @return              EOK on success or a negative error code.
+ */
 static int
 mfs_alloc_bit(struct mfs_instance *inst, uint32_t *idx, bmap_id_t bid)