Changeset 611 for trunk/kernel/mm/mapper.h

Timestamp:

Jan 9, 2019, 3:02:51 PM (5 years ago)

Author:

alain

Message:

Introduce sigificant modifs in VFS to support the <ls> command,
and the . and .. directories entries.

File:

• trunk/kernel/mm/mapper.h (modified) (7 diffs)

trunk/kernel/mm/mapper.h

@@ -1 +1 @@
 /*
- * mapper.h - Kernel cache for FS files or directories definition.
+ * mapper.h - Kernel cache for VFS files/directories definition.
  *
  * Authors   Mohamed Lamine Karaoui (2015)
@@ -195 +195 @@
 
 /*******************************************************************************************
- * This function returns an extended pointer on a mapper page, identified by <page_id>,
- * index in the file. The - possibly remote - mapper is identified by the <mapper_xp>
- * argument.  It can be executed by a thread running in any cluster, as it uses remote
+ * This function returns an extended pointer on a page descriptor.
+ * The - possibly remote - mapper is identified by the <mapper_xp> argument.
+ * The page is identified by <page_id> argument (page index in the file).
+ * It can be executed by a thread running in any cluster, as it uses remote
  * access primitives to scan the mapper.
  * In case of miss, this function takes the mapper lock in WRITE_MODE, and call the 
@@ -205 +206 @@
  * @ mapper_xp  : extended pointer on the mapper.
  * @ page_id    : page index in file
- * @ returns extended pointer on page base if success / return XPTR_NULL if error.
+ * @ returns extended pointer on page descriptor if success / return XPTR_NULL if error.
  ******************************************************************************************/
 xptr_t mapper_remote_get_page( xptr_t    mapper_xp,
@@ -212 +213 @@
 /*******************************************************************************************
  * This function allows to read a single word in a mapper seen as and array of uint32_t.
- * It has bee designed to support remote access tho the FAT mapper of the FATFS. 
+ * It has bee designed to support remote access to the FAT mapper of the FATFS. 
  * It can be called by any thread running in any cluster.
  * In case of miss, it takes the mapper lock in WRITE_MODE, load the missing
@@ -218 +219 @@
  *******************************************************************************************
  * @ mapper_xp  : [in]  extended pointer on the mapper.
- * @ index          : [in]  32 bits word index in file.
+ * @ word_id    : [in]  32 bits word index in file.
  * @ p_value    : [out] local pointer on destination buffer.
  * @ returns 0 if success / return -1 if error.
@@ -234 +235 @@
  *******************************************************************************************
  * @ mapper_xp  : [in]  extended pointer on the mapper.
- * @ index          : [in]  32 bits word index in file.
- * @ p_value    : [in]  value to be written.
+ * @ word_id    : [in]  32 bits word index in file.
+ * @ value      : [in]  value to be written.
  * @ returns 0 if success / return -1 if error.
  ******************************************************************************************/
@@ -242 +243 @@
                               uint32_t   value );
 
+/*******************************************************************************************
+ * This debug function displays the content of a given page of a given mapper.
+ * - the mapper is identified by the <mapper_xp> argument.
+ * - the page is identified by the <page_id> argument.
+ * - the number of bytes to display in page is defined by the <nbytes> argument.
+ * The format is eigth (32 bits) words per line in hexadecimal.
+ * It can be called by any thread running in any cluster.
+ * In case of miss in mapper, it load the missing page from device to mapper.
+ *******************************************************************************************
+ * @ mapper_xp  : [in]  extended pointer on the mapper.
+ * @ page_id    : [in]  page index in file.
+ * @ nbytes     : [in]  value to be written.
+ * @ string     : [in]  string printed in header.
+ * @ returns 0 if success / return -1 if error.
+ ******************************************************************************************/
+error_t mapper_display_page( xptr_t     mapper_xp,
+                             uint32_t   page_id,
+                             uint32_t   nbytes,
+                             char     * string );
+
+
 #endif /* _MAPPER_H_ */