doxygen

Author: pschatzmann

docs/html/annotated.html

@@ -68,7 +68,7 @@
 <div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
 <div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span>]</div><table class="directory">
 <tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><b>stm32_i2s</b></td><td class="desc"></td></tr>
-<tr id="row_0_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structstm32__i2s_1_1_i2_s_pin.html" target="_self">I2SPin</a></td><td class="desc">Define individual Pin. This is used to set up processor specific arrays with all I2S pins </td></tr>
+<tr id="row_0_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structstm32__i2s_1_1_i2_s_pin.html" target="_self">I2SPin</a></td><td class="desc">Define individual Pin. This is used to set up processor specific arrays with all I2S pins and to setup and end the pin definition </td></tr>
 <tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structstm32__i2s_1_1_hardware_config.html" target="_self">HardwareConfig</a></td><td class="desc">Processor specific settings that are needed to set up I2S </td></tr>
 <tr id="row_0_2_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structstm32__i2s_1_1_i2_s_settings_s_t_m32.html" target="_self">I2SSettingsSTM32</a></td><td class="desc">Currently supported parameters </td></tr>
 <tr id="row_0_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html" target="_self">Stm32I2sClass</a></td><td class="desc">I2S API for STM32 </td></tr>

docs/html/classstm32__i2s_1_1_stm32_i2s_class-members.html

@@ -99,14 +99,13 @@
   <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><td class="entry"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html#ae9fde31d71da42c270d145089d50cd40">resetPin</a>(PinName p)</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>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 class="even"><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><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 class="even"><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"><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" 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>
+  <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>
 </table></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>

docs/html/classstm32__i2s_1_1_stm32_i2s_class.html

@@ -130,10 +130,6 @@
 <tr class="memitem:a7ea0054cb5a28db73d516bd9f12efe5a"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html#a7ea0054cb5a28db73d516bd9f12efe5a">MX_GPIO_Init</a> (void)</td></tr>
 <tr class="memdesc:a7ea0054cb5a28db73d516bd9f12efe5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">GPIO Initialization Function for I2S pins.  <a href="classstm32__i2s_1_1_stm32_i2s_class.html#a7ea0054cb5a28db73d516bd9f12efe5a">More...</a><br /></td></tr>
 <tr class="separator:a7ea0054cb5a28db73d516bd9f12efe5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ae9fde31d71da42c270d145089d50cd40"><td class="memItemLeft" align="right" valign="top"><a id="ae9fde31d71da42c270d145089d50cd40"></a>
-void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html#ae9fde31d71da42c270d145089d50cd40">resetPin</a> (PinName p)</td></tr>
-<tr class="memdesc:ae9fde31d71da42c270d145089d50cd40"><td class="mdescLeft">&#160;</td><td class="mdescRight">Undo the current pin function. <br /></td></tr>
-<tr class="separator:ae9fde31d71da42c270d145089d50cd40"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a920ca6270f2a640e010f9a73f9805fba"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html#a920ca6270f2a640e010f9a73f9805fba">MX_DMA_Init</a> (void)</td></tr>
 <tr class="separator:a920ca6270f2a640e010f9a73f9805fba"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a0b22eaee894545e639e40215fc411706"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html#a0b22eaee894545e639e40215fc411706">MX_I2S3_Init</a> (void)</td></tr>

docs/html/functions.html

@@ -86,6 +86,9 @@
 <li>cb_TxRxHalfComplete()
 : <a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html#aa68f9f957ef9dcf6022da95cc999b45d">stm32_i2s::Stm32I2sClass</a>
 </li>
+<li>end()
+: <a class="el" href="structstm32__i2s_1_1_i2_s_pin.html#a74b9ea065dd62de38da823d2959c4a3a">stm32_i2s::I2SPin</a>
+</li>
 <li>i2s_begin()
 : <a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html#abc045de6c4c440593e3bb6ba0cf9921c">stm32_i2s::Stm32I2sClass</a>
 </li>
@@ -98,9 +101,6 @@
 <li>MX_I2S3_Init()
 : <a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html#a0b22eaee894545e639e40215fc411706">stm32_i2s::Stm32I2sClass</a>
 </li>
-<li>resetPin()
-: <a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html#ae9fde31d71da42c270d145089d50cd40">stm32_i2s::Stm32I2sClass</a>
-</li>
 <li>setupDMA()
 : <a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html#aca5c1d70fd7e9a3f3aa0388749b6cb44">stm32_i2s::Stm32I2sClass</a>
 </li>

docs/html/functions_func.html

@@ -86,6 +86,9 @@
 <li>cb_TxRxHalfComplete()
 : <a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html#aa68f9f957ef9dcf6022da95cc999b45d">stm32_i2s::Stm32I2sClass</a>
 </li>
+<li>end()
+: <a class="el" href="structstm32__i2s_1_1_i2_s_pin.html#a74b9ea065dd62de38da823d2959c4a3a">stm32_i2s::I2SPin</a>
+</li>
 <li>i2s_begin()
 : <a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html#abc045de6c4c440593e3bb6ba0cf9921c">stm32_i2s::Stm32I2sClass</a>
 </li>
@@ -98,9 +101,6 @@
 <li>MX_I2S3_Init()
 : <a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html#a0b22eaee894545e639e40215fc411706">stm32_i2s::Stm32I2sClass</a>
 </li>
-<li>resetPin()
-: <a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html#ae9fde31d71da42c270d145089d50cd40">stm32_i2s::Stm32I2sClass</a>
-</li>
 <li>setupDMA()
 : <a class="el" href="classstm32__i2s_1_1_stm32_i2s_class.html#aca5c1d70fd7e9a3f3aa0388749b6cb44">stm32_i2s::Stm32I2sClass</a>
 </li>

docs/html/index.html

@@ -165,7 +165,7 @@ <h2><a class="anchor" id="autotoc_md4"></a>
 <div class="line">}</div>
 </div><!-- fragment --><h1><a class="anchor" id="autotoc_md6"></a>
 Documentation</h1>
-<p>Here is the link to the <a href="https://pschatzmann.github.io/stm32f411-i2s/html/modules.html">actual documentation</a>.</p>
+<p>Here is the link to the <a href="https://pschatzmann.github.io/stm32f411-i2s/html/classstm32__i2s_1_1_stm32_i2s_class.html">actual documentation</a>.</p>
 <p>You might also find further information in <a href="https://www.pschatzmann.ch/tags/stm32">my Blogs</a></p>
 <h1><a class="anchor" id="autotoc_md7"></a>
 Installation in Arduino</h1>

docs/html/search/all_2.js

@@ -1,5 +1,4 @@
 var searchData=
 [
-  ['hal_5fconf_5fextra_2eh_9',['hal_conf_extra.h',['../hal__conf__extra_8h.html',1,'']]],
-  ['hardwareconfig_10',['HardwareConfig',['../structstm32__i2s_1_1_hardware_config.html',1,'stm32_i2s']]]
+  ['end_9',['end',['../structstm32__i2s_1_1_i2_s_pin.html#a74b9ea065dd62de38da823d2959c4a3a',1,'stm32_i2s::I2SPin']]]
 ];

docs/html/search/all_3.js

@@ -1,7 +1,5 @@
 var searchData=
 [
-  ['i2s_5fbegin_11',['i2s_begin',['../classstm32__i2s_1_1_stm32_i2s_class.html#abc045de6c4c440593e3bb6ba0cf9921c',1,'stm32_i2s::Stm32I2sClass']]],
-  ['i2spin_12',['I2SPin',['../structstm32__i2s_1_1_i2_s_pin.html',1,'stm32_i2s']]],
-  ['i2spinfunction_13',['I2SPinFunction',['../stm32-i2s_8h.html#a44498895f4b65c359a7e5846c7c16053',1,'stm32_i2s']]],
-  ['i2ssettingsstm32_14',['I2SSettingsSTM32',['../structstm32__i2s_1_1_i2_s_settings_s_t_m32.html',1,'stm32_i2s']]]
+  ['hal_5fconf_5fextra_2eh_10',['hal_conf_extra.h',['../hal__conf__extra_8h.html',1,'']]],
+  ['hardwareconfig_11',['HardwareConfig',['../structstm32__i2s_1_1_hardware_config.html',1,'stm32_i2s']]]
 ];

docs/html/search/all_4.js

@@ -1,6 +1,7 @@
 var searchData=
 [
-  ['mx_5fdma_5finit_15',['MX_DMA_Init',['../classstm32__i2s_1_1_stm32_i2s_class.html#a920ca6270f2a640e010f9a73f9805fba',1,'stm32_i2s::Stm32I2sClass']]],
-  ['mx_5fgpio_5finit_16',['MX_GPIO_Init',['../classstm32__i2s_1_1_stm32_i2s_class.html#a7ea0054cb5a28db73d516bd9f12efe5a',1,'stm32_i2s::Stm32I2sClass']]],
-  ['mx_5fi2s3_5finit_17',['MX_I2S3_Init',['../classstm32__i2s_1_1_stm32_i2s_class.html#a0b22eaee894545e639e40215fc411706',1,'stm32_i2s::Stm32I2sClass']]]
+  ['i2s_5fbegin_12',['i2s_begin',['../classstm32__i2s_1_1_stm32_i2s_class.html#abc045de6c4c440593e3bb6ba0cf9921c',1,'stm32_i2s::Stm32I2sClass']]],
+  ['i2spin_13',['I2SPin',['../structstm32__i2s_1_1_i2_s_pin.html',1,'stm32_i2s']]],
+  ['i2spinfunction_14',['I2SPinFunction',['../stm32-i2s_8h.html#a44498895f4b65c359a7e5846c7c16053',1,'stm32_i2s']]],
+  ['i2ssettingsstm32_15',['I2SSettingsSTM32',['../structstm32__i2s_1_1_i2_s_settings_s_t_m32.html',1,'stm32_i2s']]]
 ];

docs/html/search/all_5.js

@@ -1,4 +1,6 @@
 var searchData=
 [
-  ['resetpin_18',['resetPin',['../classstm32__i2s_1_1_stm32_i2s_class.html#ae9fde31d71da42c270d145089d50cd40',1,'stm32_i2s::Stm32I2sClass']]]
+  ['mx_5fdma_5finit_16',['MX_DMA_Init',['../classstm32__i2s_1_1_stm32_i2s_class.html#a920ca6270f2a640e010f9a73f9805fba',1,'stm32_i2s::Stm32I2sClass']]],
+  ['mx_5fgpio_5finit_17',['MX_GPIO_Init',['../classstm32__i2s_1_1_stm32_i2s_class.html#a7ea0054cb5a28db73d516bd9f12efe5a',1,'stm32_i2s::Stm32I2sClass']]],
+  ['mx_5fi2s3_5finit_18',['MX_I2S3_Init',['../classstm32__i2s_1_1_stm32_i2s_class.html#a0b22eaee894545e639e40215fc411706',1,'stm32_i2s::Stm32I2sClass']]]
 ];