Changes between Version 23 and Version 24 of library_mwmr
- Timestamp:
- Nov 9, 2015, 12:12:52 PM (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
library_mwmr
v23 v24 29 29 30 30 31 == __Communication Channel Initialisation __ ==31 == __Communication Channel Initialisation & Debug__ == 32 32 33 33 === void '''mwmr_init'''( mwmr_channel_t* mwmr, uint32_t* buffer , uint32_t width , uint32_t items ) === … … 38 38 * '''nitems''' : max number of items in the channel. 39 39 It must be called by one single task. 40 41 === void '''mwmr_dump'''( mwmr_channel_t* mwmr ) === 42 This function displays the status and the content of a channel, without modifications. 40 43 41 44 == __Communication Channel Blocking Access__ == … … 78 81 * an output buffer is automatically transferred to the associated MWMR channel when it becomes full. 79 82 80 == __Bufio Initialization __ ==83 == __Bufio Initialization and Debug__ == 81 84 82 85 === void '''mwmr_bufio_init'''( mwmr_bufio_t* bufio , uint8_t* buffer , uint32_t size , uint32_t is_input , mwmr_channel_t* mwmr ) === … … 88 91 * '''mwmr''' : pointer on the associated MWMR channel descriptor. 89 92 93 === void '''mwmr_bufio_dump'''( mwmr_bufio_t* bufio ) === 94 This function displays the status and the content of a BUFIO, without modifications. 90 95 91 96 == __Input Bufio Access__ == … … 93 98 === uint8_t '''mwmr_bufio_read_byte'''( mwmr_bufio_t* bufio ) === 94 99 This 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. 100 The BUFIO is automatically refill from the associated MWMR channel if required. 104 101 105 102 === void '''mwmr_bufio_skip'''( mwmr_bufio_t* bufio , uint32_t length ) === 106 103 This function discard <length> bytes from the <bufio> input buffer. 107 The bufiois automatically refill from the associated MWMR channel if required.104 The BUFIO is automatically refill from the associated MWMR channel if required. 108 105 109 106 === 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. 107 If 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 112 109 113 110 == __Output Bufio Access__ == … … 115 112 === void '''mwmr_bufio_write_byte'''( mwmr_bufio_t* bufio , uint8_t value ) === 116 113 This 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. 114 The BUFIO is automatically flushed to the associated MWMR channel if required. 126 115 127 116 === void '''mwmr_bufio_flush'''( mwmr_bufio_t* bufio ) ===