Changeset 666 for trunk/kernel/libk/remote_buf.h

Timestamp:

Oct 10, 2020, 5:27:12 PM (4 years ago)

Author:

alain

Message:

Cosmetic.

File:

• trunk/kernel/libk/remote_buf.h (modified) (2 diffs)

trunk/kernel/libk/remote_buf.h

@@ -32 +32 @@
  * This structure and the associated access functions define a remotely accessible,
  * kernel buffer, handled as a single-reader & single-writer FIFO. 
- * Each buffer slot contains one byte, and the number of slots is dynamically 
- * defined by an argument of the "remote_buf_create()" function. 
- * The "put()" and "get()" access functions defined below move another buffer,
- * (can be in kernel or in user space) to/from this circular kernel buffer.
+ * This kernel buffer is implementes as an array of bytes, whose size is 
+ * dynamically defined by an argument of the "remote_buf_init()" function. 
+ * The "put()" and "get()" functions defined below move the content of another
+ * buffer (can be in kernel or in user space) to/from this circular kernel buffer.
  * This structure is NOT protected by a lock, as the only shared variable is the 
- * "sts" variable, that is updated by hal_remote_atomic_add() access primitives.
- * It is used by to implement the socket receive buffer.
+ * "sts" variable, that is updated by the hal_remote_atomic_add() primitive.
+ * It is used to implement the three socket buffers (rx_buf / r2tq / crqq).
  * - the "ptw" field defines the first empty slot (for write).
  * - the "ptr" field defines the first non empty slot (for read).
@@ -58 +58 @@
  * argument. It allocates memory for the data, as defined by the <size> argument,
  * and initializes the buffer as empty. It must be called by a local thread.
+ * No memory is allocated if <size> value is 0.
  ************************************************************************************
  * @ buf_xp    : [in] extended pointer on buffer descriptor.
- * @ size      : [in] number of bytes in buffer.
- * @ return  0 if success / return -1 if failure (no memory).
+ * @ size      : [in] number of bytes in buffer / no memory allocated when null.
+ * @ return  0 if success / return -1 if memory failure.
  ***********************************************************************************/
-error_t remote_buf_create( xptr_t   buf_xp,
-                           uint32_t size );
+error_t remote_buf_init( xptr_t   buf_xp,
+                         uint32_t size );
 
 /************************************************************************************