Changeset 658 for trunk/hal/generic/hal_uspace.h

Timestamp:

Oct 10, 2020, 3:48:50 PM (4 years ago)

Author:

alain

Message:

Improve the TSAR NIC driver.

File:

• trunk/hal/generic/hal_uspace.h (modified) (3 diffs)

trunk/hal/generic/hal_uspace.h

@@ -30 +30 @@
 //           User space access API (implementation in hal_uspace.c)
 //
+// For sake of portability, user/kernel data transfers must use the following API.
+//
 // When moving data between user space and kernel space, the user address is always
-// a virtual address, but the kernel address is an extended pointer.
-// For sake of portability, user/kernel data transfers must use the following API.
+// a virtual address, and the kernel address is an extended pointer.
+// Therefore, each of these buffers can be located in any cluster.
+//
+// WARNING: these function must be executed by an user thread (i.e. PID > 0),
+//          to handle a possible page fault when accessing the user buffer.
 //////////////////////////////////////////////////////////////////////////////////////////
 
 
 /*****************************************************************************************
- * This function tranfers a data buffer in user space to a kernel buffer
- * that can be located in any cluster.
+ * This function moves <size> bytes from a source buffer in user virtual space,
+ * defined by the <u_src_ptr> argument, to a destination kernel buffer, defined by the
+ * <k_dst_xp> argument.
  *****************************************************************************************
  * @ k_dst_xp  : extended pointer on kernel destination buffer.
@@ -49 +55 @@
 
 /*****************************************************************************************
- * This function tranfers a kernel buffer that can be located in any cluster
- * to a data buffer in the user space.
+ * This function moves <size> bytes from a source kernel buffer, defined by the
+ * <k_src_xp> argument, to a destination buffer in user virtual space, defined by 
+ * the <u_dst_ptr> argument.
  *****************************************************************************************
  * @ u_dst_ptr : destination buffer address in user space.
@@ -87 +94 @@
 
 /*****************************************************************************************
- * This function computes the length of a string in user space.
+ * This function returns the length of a string located in user space.
  *****************************************************************************************
  * @ string     : string in user space.