Changes between Version 21 and Version 22 of library_mwmr


Ignore:
Timestamp:
Nov 6, 2015, 1:34:00 PM (10 years ago)
Author:
alain
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • library_mwmr

    v21 v22  
    8888 * '''mwmr''' : pointer on the associated MWMR channel descriptor.
    8989
    90 === void '''mwmr_bufio_reset'''( mwmr_bufio_t*  bufio ) ===
    91 This function reset the BUFIO byte pointer, to discard all bytes contained in the BUFIO.
    9290
    93 
    94 == __Private Input Buffer Access__ ==
     91== __Input Bufio Access__ ==
    9592                   
    9693=== uint8_t '''mwmr_bufio_read_byte'''( mwmr_bufio_t* bufio ) ===
    97 This blocking function returns one single byte from the MWMR channel associated to the <bufio> input buffer.
     94This blocking function returns one single byte from the <bufio> input buffer.
     95The bufio is automatically refill from the associated MWMR channel if required.
    9896
    9997=== uint16_t '''mwmr_bufio_read_half'''( mwmr_bufio_t* bufio ) ===
    100 This blocking function returns two bytes from the MWMR channel associated to the <bufio> input buffer.
     98This blocking function returns two bytes from the <bufio> input buffer.
     99The bufio is automatically refill from the associated MWMR channel if required.
    101100
    102101=== uint32_t '''mwmr_bufio_read_word'''( mwmr_bufio_t* bufio ) ===
    103 This blocking function returns four bytes from the MWMR channel associated to the <bufio> input buffer.
     102This blocking function returns four bytes from the <bufio> input buffer.
     103The bufio is automatically refill from the associated MWMR channel if required.
    104104
    105105=== void '''mwmr_bufio_skip'''( mwmr_bufio_t* bufio , uint32_t length ) ===
    106 This function discard <length> bytes from the MWMR channel associated to the <bufio> input buffer.
     106This function discard <length> bytes from the <bufio> input buffer.
     107The bufio is automatically refill from the associated MWMR channel if required.
    107108
    108 == __Private Output Buffer Access__ ==
     109=== void '''mwmr_bufio_align'''( mwmr_bufio_t* bufio ) ===
     110This function discard as many bytes as required to align the buffo pointer on
     111the next item boundary.
     112
     113== __ Output Bufio Access__ ==
    109114
    110115=== void '''mwmr_bufio_write_byte'''( mwmr_bufio_t* bufio , uint8_t value ) ===
    111 This blocking function writes one byte into the MWMR channel associated to the <bufio> output buffer.
     116This blocking function writes one byte the <bufio> output buffer.
     117The bufio is automatically flushed to the associated MWMR channel if required.
    112118
    113119=== void '''mwmr_bufio_write_half'''( mwmr_bufio_t* bufio , uint16_t value ) ===
    114 This blocking function writes two bytes into the MWMR channel associated to the <bufio> output buffer.
     120This blocking function writes two bytes into the <bufio> output buffer.
     121The bufio is automatically flushed to the associated MWMR channel if required.
    115122
    116123=== void '''mwmr_bufio_write_word'''( mwmr_bufio_t* bufio , uint32_t value ) ===
    117 This blocking function writes four bytes into the MWMR channel associated to the <bufio> output buffer.
     124This blocking function writes four bytes into the <bufio> output buffer.
     125The bufio is automatically flushed to the associated MWMR channel if required.
    118126
    119127=== void '''mwmr_bufio_flush'''( mwmr_bufio_t* bufio ) ===