Changes between Version 23 and Version 24 of library_mwmr


Ignore:
Timestamp:
Nov 9, 2015, 12:12:52 PM (9 years ago)
Author:
alain
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • library_mwmr

    v23 v24  
    2929
    3030
    31 == __Communication Channel Initialisation__ ==
     31== __Communication Channel Initialisation & Debug__ ==
    3232
    3333=== void '''mwmr_init'''( mwmr_channel_t* mwmr, uint32_t* buffer , uint32_t  width , uint32_t  items ) ===
     
    3838 * '''nitems''' : max number of items in the channel.
    3939It must be called by one single task.
     40
     41=== void '''mwmr_dump'''( mwmr_channel_t* mwmr ) ===
     42This function displays the status and the content of a channel, without modifications.
    4043
    4144== __Communication Channel Blocking Access__ ==
     
    7881 * an output buffer is automatically transferred to the associated MWMR channel when it becomes full.
    7982
    80 == __Bufio Initialization__ ==
     83== __Bufio Initialization and Debug__ ==
    8184
    8285=== void '''mwmr_bufio_init'''( mwmr_bufio_t* bufio , uint8_t* buffer , uint32_t size , uint32_t is_input , mwmr_channel_t* mwmr ) ===
     
    8891 * '''mwmr''' : pointer on the associated MWMR channel descriptor.
    8992
     93=== void '''mwmr_bufio_dump'''( mwmr_bufio_t* bufio ) ===
     94This function displays the status and the content of a BUFIO, without modifications.
    9095
    9196== __Input Bufio Access__ ==
     
    9398=== uint8_t '''mwmr_bufio_read_byte'''( mwmr_bufio_t* bufio ) ===
    9499This blocking function returns one single byte from the <bufio> input buffer.
    95 The bufio is automatically refill from the associated MWMR channel if required.
    96 
    97 === uint16_t '''mwmr_bufio_read_half'''( mwmr_bufio_t* bufio ) ===
    98 This blocking function returns two bytes from the <bufio> input buffer.
    99 The bufio is automatically refill from the associated MWMR channel if required.
    100 
    101 === uint32_t '''mwmr_bufio_read_word'''( mwmr_bufio_t* bufio ) ===
    102 This blocking function returns four bytes from the <bufio> input buffer.
    103 The bufio is automatically refill from the associated MWMR channel if required.
     100The BUFIO is automatically refill from the associated MWMR channel if required.
    104101
    105102=== void '''mwmr_bufio_skip'''( mwmr_bufio_t* bufio , uint32_t length ) ===
    106103This function discard <length> bytes from the <bufio> input buffer.
    107 The bufio is automatically refill from the associated MWMR channel if required.
     104The BUFIO is automatically refill from the associated MWMR channel if required.
    108105
    109106=== void '''mwmr_bufio_align'''( mwmr_bufio_t* bufio ) ===
    110 This function discard as many bytes as required to align the buffo pointer on
    111 the next item boundary.
     107If the BUFIO pointer is not multiple of the item size,this function discard as many bytes as required to align the BUFIO pointer on the next item boundary.
     108
    112109
    113110== __Output Bufio Access__ ==
     
    115112=== void '''mwmr_bufio_write_byte'''( mwmr_bufio_t* bufio , uint8_t value ) ===
    116113This blocking function writes one byte the <bufio> output buffer.
    117 The bufio is automatically flushed to the associated MWMR channel if required.
    118 
    119 === void '''mwmr_bufio_write_half'''( mwmr_bufio_t* bufio , uint16_t value ) ===
    120 This blocking function writes two bytes into the <bufio> output buffer.
    121 The bufio is automatically flushed to the associated MWMR channel if required.
    122 
    123 === void '''mwmr_bufio_write_word'''( mwmr_bufio_t* bufio , uint32_t value ) ===
    124 This blocking function writes four bytes into the <bufio> output buffer.
    125 The bufio is automatically flushed to the associated MWMR channel if required.
     114The BUFIO is automatically flushed to the associated MWMR channel if required.
    126115
    127116=== void '''mwmr_bufio_flush'''( mwmr_bufio_t* bufio ) ===