Changes between Version 14 and Version 15 of library_mwmr

Timestamp:

Oct 30, 2015, 10:04:52 AM (10 years ago)

Author:

alain

Comment:

--

library_mwmr

@@ -84 +84 @@
  * '''mwmr''' : pointer on the associated MWMR channel descriptor.
  
-== Private Buffer Access ==
+== Private Input Buffer Access ==
                    
 === uint8_t '''mwmr_bufio_read_byte'''( mwmr_bufio_t* bufio ) ===
-This blocking function uses the mwmr_read() function, and returns one single byte from the MWMR channel associated to the <bufio> input buffer.
+This blocking function returns one single byte from the MWMR channel associated to the <bufio> input buffer.
 
 === uint16_t '''mwmr_bufio_read_half'''( mwmr_bufio_t* bufio ) ===
-This blocking function uses the mwmr_read() function, and returns two bytes from the MWMR channel associated to the <bufio> input buffer.
+This blocking function returns two bytes from the MWMR channel associated to the <bufio> input buffer.
 
 === uint32_t '''mwmr_bufio_read_word'''( mwmr_bufio_t* bufio ) ===
-This blocking function uses the mwmr_read() function, and returns four bytes from the MWMR channel associated to the <bufio> input buffer.
+This blocking function returns four bytes from the MWMR channel associated to the <bufio> input buffer.
+
+=== void '''mwmr_bufio_skip'''( mwmr_bufio_t* bufio , uint32_t length ) ===
+This function discard <length> bytes from the MWMR channel associated to the <bufio> input buffer.
+
+== Private Output Buffer Access ==
 
 === void '''mwmr_bufio_write_byte'''( mwmr_bufio_t* bufio , uint8_t value ) ===
+This blocking function writes one byte into the MWMR channel associated to the <bufio> output buffer.
 
 === void '''mwmr_bufio_write_half'''( mwmr_bufio_t* bufio , uint16_t value ) ===
+This blocking function writes two bytes into the MWMR channel associated to the <bufio> output buffer.
 
 === void '''mwmr_bufio_write_word'''( mwmr_bufio_t* bufio , uint32_t value ) ===
+This blocking function writes four bytes into the MWMR channel associated to the <bufio> output buffer.
 
 === void '''mwmr_bufio_flush'''( mwmr_bufio_t* bufio ) ===
+This function transfer the current content of  the <bufio> output buffer to the associated MWMR channel when it is non empty.
 
-=== void '''mwmr_bufio_skip'''( mwmr_bufio_t* bufio , uint32_t length ) ===
-