Skip to content

Commit

Permalink
doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
@pschatzmann
pschatzmann committed Feb 17, 2024
1 parent 3096c81 commit dcbab5f
Show file tree
Hide file tree
Showing 37 changed files with 717 additions and 488 deletions.
21 changes: 13 additions & 8 deletions docs/html/classstm32__i2s_1_1_stm32_i2s_class-members.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,10 @@

<p>This is the complete list of members for <a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a>, including all inherited members.</p>
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html#ab2cdf54a05448b66c5aded8b8a632230">begin</a>(I2SSettingsSTM32 settings, bool transmit, bool receive)</td><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html#a0bd110eb19354cfd1317e68b4c74732a">beginReadDMA</a>(I2SSettingsSTM32 settings, void(*writeFromReceive)(uint8_t *buffer, uint16_t byteCount, void *ref)=nullptr)</td><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html#ab5ad88e38c7a426e4c5ab99ee5be6262">beginReadWriteDMA</a>(I2SSettingsSTM32 settings, void(*readToTransmit)(uint8_t *buffer, uint16_t byteCount, void *)=nullptr, void(*writeFromReceive)(uint8_t *buffer, uint16_t byteCount, void *)=nullptr)</td><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html#a184c62a4b0e0b2bfed4c6760aca5b127">beginWriteDMA</a>(I2SSettingsSTM32 settings, void(*readToTransmit)(uint8_t *buffer, uint16_t byteCount, void *ref)=nullptr)</td><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html#ad8d19f61eff465692845d405fd321271">cb_dmaIrqRx</a>()</td><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html#a8f61f957a528292152ac3aa494d6c8f7">cb_dmaIrqTx</a>()</td><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html#a368840768f5316846efbcfc7bfbe72da">cb_HAL_I2S_MspDeInit</a>(I2S_HandleTypeDef *hi2s)</td><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
Expand All @@ -84,6 +88,8 @@
<tr bgcolor="#f0f0f0"><td class="entry"><b>DMA1_Stream5_IRQHandler</b> (defined in <a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a>)</td><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a></td><td class="entry"><span class="mlabel">friend</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>dma_buffer_rx</b> (defined in <a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a>)</td><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>dma_buffer_tx</b> (defined in <a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a>)</td><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>end</b>() (defined in <a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a>)</td><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>getBytes</b>() (defined in <a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a>)</td><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>HAL_I2S_MspDeInit</b> (defined in <a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a>)</td><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a></td><td class="entry"><span class="mlabel">friend</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>HAL_I2S_MspInit</b> (defined in <a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a>)</td><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a></td><td class="entry"><span class="mlabel">friend</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>HAL_I2S_RxCpltCallback</b> (defined in <a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a>)</td><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a></td><td class="entry"><span class="mlabel">friend</span></td></tr>
Expand All @@ -98,14 +104,13 @@
<tr><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html#a920ca6270f2a640e010f9a73f9805fba">MX_DMA_Init</a>(void)</td><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html#a7ea0054cb5a28db73d516bd9f12efe5a">MX_GPIO_Init</a>(void)</td><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></td></tr>
<tr><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html#a0b22eaee894545e639e40215fc411706">MX_I2S3_Init</a>(void)</td><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>readToTransmitCB</b> (defined in <a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a>)</td><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>settings</b> (defined in <a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a>)</td><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html#aca5c1d70fd7e9a3f3aa0388749b6cb44">setupDMA</a>(DMA_HandleTypeDef &amp;dma, DMA_Stream_TypeDef *instance, uint32_t channel, uint32_t direction)</td><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html#afa0743706fbe309e2fca3a8aea2b1a0c">startI2SReceive</a>(I2SSettingsSTM32 settings, void(*writeFromReceive)(uint8_t *buffer, uint16_t byteCount), uint16_t buffer_size)</td><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html#aa6106141afdf1742633d9db276432344">startI2STransmit</a>(I2SSettingsSTM32 settings, void(*readToTransmit)(uint8_t *buffer, uint16_t byteCount), uint16_t buffer_size)</td><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html#a1fb497436e1c2f73b7db59ed65c29d44">startI2STransmitReceive</a>(I2SSettingsSTM32 settings, void(*readToTransmit)(uint8_t *buffer, uint16_t byteCount), void(*writeFromReceive)(uint8_t *buffer, uint16_t byteCount), uint16_t buffer_size)</td><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>stopI2S</b>() (defined in <a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a>)</td><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>writeFromReceiveCB</b> (defined in <a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a>)</td><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr class="even"><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html#a95c8ee5b3e293c9d4f553be2897a6cbb">readBytes</a>(uint8_t *data, size_t bytes)</td><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0"><td class="entry"><b>readToTransmitCB</b> (defined in <a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a>)</td><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>settings</b> (defined in <a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a>)</td><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html#aca5c1d70fd7e9a3f3aa0388749b6cb44">setupDMA</a>(DMA_HandleTypeDef &amp;dma, DMA_Stream_TypeDef *instance, uint32_t channel, uint32_t direction)</td><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>use_dma</b> (defined in <a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a>)</td><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
<tr><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html#a1d8a05bc02fc2d184b9dc22376dc9cc7">write</a>(const uint8_t *data, size_t bytes)</td><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
<tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>writeFromReceiveCB</b> (defined in <a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a>)</td><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html">stm32_i2s::Stm32I2sClass</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
</table></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Expand Down
Loading

0 comments on commit dcbab5f

Please sign in to comment.