doxygen

Author: pschatzmann

ArduinoCore-Linux/cores/rasperry_pi/HardwareGPIO_RPI.h

@@ -7,10 +7,17 @@ namespace arduino {
 
 /**
  * @class HardwareGPIO_RPI
- * @brief GPIO hardware abstraction for Raspberry Pi.
+ * @brief GPIO hardware abstraction for Raspberry Pi in the Arduino emulator.
  *
- * Provides methods to control and read GPIO pins, analog and PWM functions, and timing on Raspberry Pi.
- * Inherits from HardwareGPIO and implements all required Arduino-style GPIO functions for the emulator.
+ * This class implements the Arduino-style GPIO interface for Raspberry Pi platforms, allowing
+ * digital and analog I/O, PWM, and timing functions to be used in a manner compatible with Arduino code.
+ * It provides methods to configure pin modes, read and write digital/analog values, generate PWM signals,
+ * and perform timing operations such as pulse measurement and tone generation.
+ *
+ * The class inherits from HardwareGPIO and is intended for use within the emulator when running on
+ * Raspberry Pi hardware. It manages pin state, analog reference, and PWM frequency settings for supported pins.
+ *
+ * @note This class is only available when USE_RPI is defined.
  */
 class HardwareGPIO_RPI : public HardwareGPIO {
  public:

ArduinoCore-Linux/cores/rasperry_pi/HardwareI2C_RPI.h

@@ -10,6 +10,16 @@
 
 namespace arduino {
 
+/**
+ * @class HardwareI2C_RPI
+ * @brief Implementation of I2C communication for Raspberry Pi using Linux I2C device interface.
+ *
+ * This class provides an interface to the I2C bus on Raspberry Pi platforms by accessing
+ * the Linux device (e.g., /dev/i2c-1). It inherits from HardwareI2C and implements all
+ * required methods for I2C communication, including transmission, reception, and configuration.
+ *
+ * @note This class is only available when USE_RPI is defined.
+ */
 class HardwareI2C_RPI : public HardwareI2C {
  public:
   HardwareI2C_RPI(const char* device = "/dev/i2c-1") {

ArduinoCore-Linux/cores/rasperry_pi/HardwareSPI_RPI.h

@@ -8,6 +8,16 @@
 
 namespace arduino {
 
+/**
+ * @class HardwareSPI_RPI
+ * @brief Implementation of SPI communication for Raspberry Pi using Linux SPI device interface.
+ *
+ * This class provides an interface to the SPI bus on Raspberry Pi platforms by accessing
+ * the Linux device (e.g., /dev/spidev0.0). It inherits from HardwareSPI and implements all
+ * required methods for SPI communication, including data transfer, transaction management, and configuration.
+ *
+ * @note This class is only available when USE_RPI is defined.
+ */
 class HardwareSPI_RPI : public HardwareSPI {
  public:
   HardwareSPI_RPI(const char* device = "/dev/spidev0.0");

docs/html/_ard_file_stream_8h_source.html

@@ -93,23 +93,23 @@
 <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="classarduino_1_1_file_stream.html">   14</a></span><span class="keyword">class </span><a class="code hl_class" href="classarduino_1_1_file_stream.html">FileStream</a> : <span class="keyword">public</span> <a class="code hl_class" href="classarduino_1_1_stream.html">Stream</a> {</div>
 <div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span>  <span class="keyword">public</span>:</div>
 <div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span>    </div>
-<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span>    <a class="code hl_class" href="classarduino_1_1_file_stream.html">FileStream</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code hl_struct" href="structarduino_1_1____container____.html">outDevice</a>=<span class="stringliteral">&quot;/dev/stdout&quot;</span>, <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code hl_struct" href="structarduino_1_1____container____.html">inDevice</a>=<span class="stringliteral">&quot;/dev/stdin&quot;</span>){</div>
-<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span>        open(<a class="code hl_struct" href="structarduino_1_1____container____.html">outDevice</a>, <a class="code hl_struct" href="structarduino_1_1____container____.html">inDevice</a>);</div>
+<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span>    <a class="code hl_class" href="classarduino_1_1_file_stream.html">FileStream</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code hl_class" href="classarduino_1_1_d_m_a_buffer.html">outDevice</a>=<span class="stringliteral">&quot;/dev/stdout&quot;</span>, <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code hl_class" href="classarduino_1_1_d_m_a_buffer.html">inDevice</a>=<span class="stringliteral">&quot;/dev/stdin&quot;</span>){</div>
+<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span>        open(<a class="code hl_class" href="classarduino_1_1_d_m_a_buffer.html">outDevice</a>, <a class="code hl_class" href="classarduino_1_1_d_m_a_buffer.html">inDevice</a>);</div>
 <div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span>    }</div>
 <div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
 <div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span>    <a class="code hl_class" href="classarduino_1_1_file_stream.html">~FileStream</a>(){</div>
 <div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span>        in.close();</div>
 <div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span>        out.close();</div>
 <div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span>    }</div>
 <div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span>    </div>
-<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span>    <span class="keywordtype">void</span> open(<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code hl_struct" href="structarduino_1_1____container____.html">outDevice</a>, <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code hl_struct" href="structarduino_1_1____container____.html">inDevice</a>){</div>
-<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span>        <span class="keywordflow">if</span> (<a class="code hl_struct" href="structarduino_1_1____container____.html">outDevice</a>!=<span class="keyword">nullptr</span>)</div>
-<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span>            out.open(<a class="code hl_struct" href="structarduino_1_1____container____.html">outDevice</a>,std::ios::out); </div>
-<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span>        <span class="keywordflow">if</span> (<a class="code hl_struct" href="structarduino_1_1____container____.html">inDevice</a>!=<span class="keyword">nullptr</span>)</div>
-<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span>            in.open(<a class="code hl_struct" href="structarduino_1_1____container____.html">inDevice</a>,std::ios::in); </div>
+<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span>    <span class="keywordtype">void</span> open(<span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code hl_class" href="classarduino_1_1_d_m_a_buffer.html">outDevice</a>, <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code hl_class" href="classarduino_1_1_d_m_a_buffer.html">inDevice</a>){</div>
+<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span>        <span class="keywordflow">if</span> (<a class="code hl_class" href="classarduino_1_1_d_m_a_buffer.html">outDevice</a>!=<span class="keyword">nullptr</span>)</div>
+<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span>            out.open(<a class="code hl_class" href="classarduino_1_1_d_m_a_buffer.html">outDevice</a>,std::ios::out); </div>
+<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span>        <span class="keywordflow">if</span> (<a class="code hl_class" href="classarduino_1_1_d_m_a_buffer.html">inDevice</a>!=<span class="keyword">nullptr</span>)</div>
+<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span>            in.open(<a class="code hl_class" href="classarduino_1_1_d_m_a_buffer.html">inDevice</a>,std::ios::in); </div>
 <div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span>    }</div>
 <div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span>    </div>
-<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span>    <span class="keyword">virtual</span> <span class="keywordtype">void</span> begin(<span class="keywordtype">int</span> <a class="code hl_struct" href="structarduino_1_1____container____.html">speed</a>){</div>
+<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span>    <span class="keyword">virtual</span> <span class="keywordtype">void</span> begin(<span class="keywordtype">int</span> <a class="code hl_class" href="classarduino_1_1_d_m_a_buffer.html">speed</a>){</div>
 <div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span>        <span class="comment">// nothing to be done</span></div>
 <div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span>    }</div>
 <div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span>    </div>
@@ -141,17 +141,17 @@
 <div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span>        out.write(str, len);</div>
 <div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span>    }</div>
 <div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span> </div>
-<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span>    <span class="keyword">virtual</span> <span class="keywordtype">void</span> write(<a class="code hl_struct" href="structarduino_1_1____container____.html">uint8_t</a>* str, <span class="keywordtype">int</span> len) {</div>
+<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span>    <span class="keyword">virtual</span> <span class="keywordtype">void</span> write(<a class="code hl_class" href="classarduino_1_1_d_m_a_buffer.html">uint8_t</a>* str, <span class="keywordtype">int</span> len) {</div>
 <div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span>        out.write((<span class="keyword">const</span> <span class="keywordtype">char</span>*)str, len);</div>
 <div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span>    }</div>
 <div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span>    </div>
-<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span>    <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> write(<a class="code hl_struct" href="structarduino_1_1____container____.html">int32_t</a> value){</div>
-<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span>        out.put(value);</div>
+<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span>    <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> write(<a class="code hl_class" href="classarduino_1_1_d_m_a_buffer.html">int32_t</a> <a class="code hl_class" href="classarduino_1_1_d_m_a_buffer.html">value</a>){</div>
+<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span>        out.put(<a class="code hl_class" href="classarduino_1_1_d_m_a_buffer.html">value</a>);</div>
 <div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span>        <span class="keywordflow">return</span> 1;</div>
 <div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span>    }</div>
 <div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span>    </div>
-<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span>    <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> write(<a class="code hl_struct" href="structarduino_1_1____container____.html">uint8_t</a> value){</div>
-<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span>        out.put(value);    </div>
+<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span>    <span class="keyword">virtual</span> <span class="keywordtype">size_t</span> write(<a class="code hl_class" href="classarduino_1_1_d_m_a_buffer.html">uint8_t</a> <a class="code hl_class" href="classarduino_1_1_d_m_a_buffer.html">value</a>){</div>
+<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span>        out.put(<a class="code hl_class" href="classarduino_1_1_d_m_a_buffer.html">value</a>);    </div>
 <div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span>        <span class="keywordflow">return</span> 1;</div>
 <div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span>    }</div>
 <div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span>    </div>
@@ -176,10 +176,10 @@
 <div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span>    </div>
 <div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span>}</div>
 <div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span> </div>
+<div class="ttc" id="aclassarduino_1_1_d_m_a_buffer_html"><div class="ttname"><a href="classarduino_1_1_d_m_a_buffer.html">arduino::DMABuffer</a></div><div class="ttdef"><b>Definition</b> DMAPool.h:103</div></div>
 <div class="ttc" id="aclassarduino_1_1_file_stream_html"><div class="ttname"><a href="classarduino_1_1_file_stream.html">arduino::FileStream</a></div><div class="ttdoc">We use the SerialDef class to be able to provide Serail, Serial1 and Serial2 outside of the Arduino e...</div><div class="ttdef"><b>Definition</b> ArdFileStream.h:14</div></div>
 <div class="ttc" id="aclassarduino_1_1_stream_html"><div class="ttname"><a href="classarduino_1_1_stream.html">arduino::Stream</a></div><div class="ttdef"><b>Definition</b> Stream.h:51</div></div>
-<div class="ttc" id="anamespacearduino_html"><div class="ttname"><a href="namespacearduino.html">arduino</a></div><div class="ttdoc">We provide the WiFi class to simulate the Arduino WIFI. In in Linux we can expect that networking is ...</div><div class="ttdef"><b>Definition</b> Client.h:25</div></div>
-<div class="ttc" id="astructarduino_1_1____container_____html"><div class="ttname"><a href="structarduino_1_1____container____.html">arduino::__container__</a></div><div class="ttdef"><b>Definition</b> Interrupts.h:15</div></div>
+<div class="ttc" id="anamespacearduino_html"><div class="ttname"><a href="namespacearduino.html">arduino</a></div><div class="ttdoc">We provide the WiFi class to simulate the Arduino WIFI. In in Linux we can expect that networking is ...</div><div class="ttdef"><b>Definition</b> CanMsg.cpp:31</div></div>
 </div><!-- fragment --></div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>