Changeset 61bc901 in mainline for uspace/lib/libfs/libfs.c

Timestamp:

2008-08-07T21:20:54Z (16 years ago)

Author:

Jakub Jermar <jakub@…>

Branches:

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

Children:

a61d1fc3

Parents:

d2c1fd5

Message:

Add a comment to libfs_blockread() and change type from size_t to off_t at
various places.

File:

• uspace/lib/libfs/libfs.c (modified) (3 diffs)

uspace/lib/libfs/libfs.c

@@ -334 +334 @@
 #define RD_READ_BLOCK   (RD_BASE + 1)
 
-bool libfs_blockread(int phone, void *buffer, size_t *bufpos, size_t *buflen,
-    size_t *pos, void *dst, size_t size, size_t block_size)
+/** Read data from a block device.
+ *
+ * @param phone         Phone to be used to communicate with the device.
+ * @param buffer        Communication buffer shared with the device.
+ * @param bufpos        Pointer to the first unread valid offset within the
+ *                      communication buffer.
+ * @param buflen        Pointer to the number of unread bytes that are ready in
+ *                      the communication buffer.
+ * @param pos           Device position to be read.
+ * @param dst           Destination buffer.
+ * @param size          Size of the destination buffer.
+ * @param block_size    Block size to be used for the transfer.
+ *
+ * @return              True on success, false on failure.
+ */
+bool libfs_blockread(int phone, void *buffer, off_t *bufpos, size_t *buflen,
+    off_t *pos, void *dst, size_t size, size_t block_size)
 {
-        size_t offset = 0;
+        off_t offset = 0;
         size_t left = size;
         
@@ -349 +364 @@
                 
                 if (rd > 0) {
+                        /*
+                         * Copy the contents of the communication buffer to the
+                         * destination buffer.
+                         */
                         memcpy(dst + offset, buffer + *bufpos, rd);
                         offset += rd;
@@ -357 +376 @@
                 
                 if (*bufpos == *buflen) {
+                        /* Refill the communication buffer with a new block. */
                         ipcarg_t retval;
                         int rc = async_req_2_1(phone, RD_READ_BLOCK,