Updated docs to v262 (#137)

Author: ashutosh-d-shukla

Control/PROG_init.html

@@ -93,7 +93,7 @@
 <pre class="literal-block">function main( ... )
  <a class="reference internal" href="api.html#ctl-init-args-t"><span class="std std-ref">ctl_init_args_t</span></a> CtlInitArgs;
  ctl_api_handle_t hAPIHandle;
-    if (<a class="reference internal" href="api.html#ctlinit"><span class="std std-ref">ctlInit</span></a>(CtlInitArgs, &amp;hAPIHandle) != <a class="reference internal" href="api.html#ctl-result-t"><span class="std std-ref">CTL_RESULT_SUCCESS</span></a>)
+    if (<a class="reference internal" href="api.html#ctlinit"><span class="std std-ref">ctlInit</span></a>(&amp;CtlInitArgs, &amp;hAPIHandle) != <a class="reference internal" href="api.html#ctl-result-t"><span class="std std-ref">CTL_RESULT_SUCCESS</span></a>)
         output(&quot;Can't initialize the API&quot;)
     else
         # Enumerate all adapters

Control/api.html

@@ -4618,7 +4618,7 @@ <h3>Display Functions<a class="headerlink" href="#display-functions" title="Link
 <span id="_CPPv312ctlI2CAccess27ctl_display_output_handle_tP21ctl_i2c_access_args_t"></span><span id="_CPPv212ctlI2CAccess27ctl_display_output_handle_tP21ctl_i2c_access_args_t"></span><span id="ctlI2CAccess__ctl_display_output_handle_t.ctl_i2c_access_args_tP"></span><span class="target" id="igcl__api_8h_1ae4c111668b07bb7987e2747e9bce19e4"></span><span class="pre">CTL_APIEXPORT</span><span class="w"> </span><a class="reference internal" href="#_CPPv412ctl_result_t" title="ctl_result_t"><span class="n"><span class="pre">ctl_result_t</span></span></a><span class="w"> </span><span class="pre">CTL_APICALL</span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ctlI2CAccess</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">ctl_display_output_handle_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">hDisplayOutput</span></span>, <a class="reference internal" href="#_CPPv421ctl_i2c_access_args_t" title="ctl_i2c_access_args_t"><span class="n"><span class="pre">ctl_i2c_access_args_t</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">pI2cAccessArgs</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv412ctlI2CAccess27ctl_display_output_handle_tP21ctl_i2c_access_args_t" title="Link to this definition"></a><br /></dt>
 <dd><p>I2C Access. </p>
 <p><ul class="simple">
-<li><p>Interface to access I2C using display handle as identifier.</p></li>
+<li><p>Interface to access I2C using display handle as identifier. I2C driver override flags are supported only for HDMI displays.</p></li>
 </ul>
 </p>
 <dl class="field-list simple">
@@ -6631,6 +6631,30 @@ <h3>Display Enums<a class="headerlink" href="#display-enums" title="Link to this
 <dd><p>Uses Slower access using SW bit bashing method. If no Speed Flag is set, defaults to Best Option possible. </p>
 </dd></dl>
 
+<dl class="cpp enumerator">
+<dt class="sig sig-object cpp" id="_CPPv4N14ctl_i2c_flag_t28CTL_I2C_FLAG_DRIVER_OVERRIDEE">
+<span id="_CPPv3N14ctl_i2c_flag_t28CTL_I2C_FLAG_DRIVER_OVERRIDEE"></span><span id="_CPPv2N14ctl_i2c_flag_t28CTL_I2C_FLAG_DRIVER_OVERRIDEE"></span><span class="target" id="igcl__api_8h_1ac17565ccd5893214c6e102cf7b42f40aa5493ba83e4a52db29ec4ce6bdb039fd3"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CTL_I2C_FLAG_DRIVER_OVERRIDE</span></span></span><a class="headerlink" href="#_CPPv4N14ctl_i2c_flag_t28CTL_I2C_FLAG_DRIVER_OVERRIDEE" title="Link to this definition"></a><br /></dt>
+<dd><p>If set, overrides the driver I2C flags with those provided by IGCL. </p>
+</dd></dl>
+
+<dl class="cpp enumerator">
+<dt class="sig sig-object cpp" id="_CPPv4N14ctl_i2c_flag_t18CTL_I2C_FLAG_STARTE">
+<span id="_CPPv3N14ctl_i2c_flag_t18CTL_I2C_FLAG_STARTE"></span><span id="_CPPv2N14ctl_i2c_flag_t18CTL_I2C_FLAG_STARTE"></span><span class="target" id="igcl__api_8h_1ac17565ccd5893214c6e102cf7b42f40aa5ddb7a1cfd48fad09850d7ffefe50d60"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CTL_I2C_FLAG_START</span></span></span><a class="headerlink" href="#_CPPv4N14ctl_i2c_flag_t18CTL_I2C_FLAG_STARTE" title="Link to this definition"></a><br /></dt>
+<dd><p>I2C Start driver override flag. </p>
+</dd></dl>
+
+<dl class="cpp enumerator">
+<dt class="sig sig-object cpp" id="_CPPv4N14ctl_i2c_flag_t17CTL_I2C_FLAG_STOPE">
+<span id="_CPPv3N14ctl_i2c_flag_t17CTL_I2C_FLAG_STOPE"></span><span id="_CPPv2N14ctl_i2c_flag_t17CTL_I2C_FLAG_STOPE"></span><span class="target" id="igcl__api_8h_1ac17565ccd5893214c6e102cf7b42f40aa2d87c2ca38d60009c05a2f6c71f600d3"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CTL_I2C_FLAG_STOP</span></span></span><a class="headerlink" href="#_CPPv4N14ctl_i2c_flag_t17CTL_I2C_FLAG_STOPE" title="Link to this definition"></a><br /></dt>
+<dd><p>I2C Stop driver override flags. </p>
+</dd></dl>
+
+<dl class="cpp enumerator">
+<dt class="sig sig-object cpp" id="_CPPv4N14ctl_i2c_flag_t20CTL_I2C_FLAG_RESTARTE">
+<span id="_CPPv3N14ctl_i2c_flag_t20CTL_I2C_FLAG_RESTARTE"></span><span id="_CPPv2N14ctl_i2c_flag_t20CTL_I2C_FLAG_RESTARTE"></span><span class="target" id="igcl__api_8h_1ac17565ccd5893214c6e102cf7b42f40aaee9100942a81239df3adcd770d4ead16"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CTL_I2C_FLAG_RESTART</span></span></span><a class="headerlink" href="#_CPPv4N14ctl_i2c_flag_t20CTL_I2C_FLAG_RESTARTE" title="Link to this definition"></a><br /></dt>
+<dd><p>I2C Restart driver override flag. </p>
+</dd></dl>
+
 <dl class="cpp enumerator">
 <dt class="sig sig-object cpp" id="_CPPv4N14ctl_i2c_flag_t16CTL_I2C_FLAG_MAXE">
 <span id="_CPPv3N14ctl_i2c_flag_t16CTL_I2C_FLAG_MAXE"></span><span id="_CPPv2N14ctl_i2c_flag_t16CTL_I2C_FLAG_MAXE"></span><span class="target" id="igcl__api_8h_1ac17565ccd5893214c6e102cf7b42f40aafb4512519f67396edc49d8a8bbf24ffe"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CTL_I2C_FLAG_MAX</span></span></span><a class="headerlink" href="#_CPPv4N14ctl_i2c_flag_t16CTL_I2C_FLAG_MAXE" title="Link to this definition"></a><br /></dt>

_sources/Control/PROG_init.rst.txt

@@ -17,7 +17,7 @@ The pseudo code below shows how to initialize the IGCL library and enumerate the
    function main( ... )
     :ref:`ctl-init-args-t` CtlInitArgs;
     ctl_api_handle_t hAPIHandle;
-       if (:ref:`ctlInit`\(CtlInitArgs, &hAPIHandle) != :ref:`CTL_RESULT_SUCCESS <ctl-result-t>`\)
+       if (:ref:`ctlInit`\(&CtlInitArgs, &hAPIHandle) != :ref:`CTL_RESULT_SUCCESS <ctl-result-t>`\)
            output("Can't initialize the API")
        else
            # Enumerate all adapters

api.html

@@ -1332,6 +1332,10 @@ <h1>API Documentation<a class="headerlink" href="#api-documentation" title="Link
 <li class="toctree-l6"><a class="reference internal" href="Control/api.html#_CPPv4N14ctl_i2c_flag_t23CTL_I2C_FLAG_SPEED_SLOWE"><code class="docutils literal notranslate"><span class="pre">CTL_I2C_FLAG_SPEED_SLOW</span></code></a></li>
 <li class="toctree-l6"><a class="reference internal" href="Control/api.html#_CPPv4N14ctl_i2c_flag_t23CTL_I2C_FLAG_SPEED_FASTE"><code class="docutils literal notranslate"><span class="pre">CTL_I2C_FLAG_SPEED_FAST</span></code></a></li>
 <li class="toctree-l6"><a class="reference internal" href="Control/api.html#_CPPv4N14ctl_i2c_flag_t27CTL_I2C_FLAG_SPEED_BIT_BASHE"><code class="docutils literal notranslate"><span class="pre">CTL_I2C_FLAG_SPEED_BIT_BASH</span></code></a></li>
+<li class="toctree-l6"><a class="reference internal" href="Control/api.html#_CPPv4N14ctl_i2c_flag_t28CTL_I2C_FLAG_DRIVER_OVERRIDEE"><code class="docutils literal notranslate"><span class="pre">CTL_I2C_FLAG_DRIVER_OVERRIDE</span></code></a></li>
+<li class="toctree-l6"><a class="reference internal" href="Control/api.html#_CPPv4N14ctl_i2c_flag_t18CTL_I2C_FLAG_STARTE"><code class="docutils literal notranslate"><span class="pre">CTL_I2C_FLAG_START</span></code></a></li>
+<li class="toctree-l6"><a class="reference internal" href="Control/api.html#_CPPv4N14ctl_i2c_flag_t17CTL_I2C_FLAG_STOPE"><code class="docutils literal notranslate"><span class="pre">CTL_I2C_FLAG_STOP</span></code></a></li>
+<li class="toctree-l6"><a class="reference internal" href="Control/api.html#_CPPv4N14ctl_i2c_flag_t20CTL_I2C_FLAG_RESTARTE"><code class="docutils literal notranslate"><span class="pre">CTL_I2C_FLAG_RESTART</span></code></a></li>
 <li class="toctree-l6"><a class="reference internal" href="Control/api.html#_CPPv4N14ctl_i2c_flag_t16CTL_I2C_FLAG_MAXE"><code class="docutils literal notranslate"><span class="pre">CTL_I2C_FLAG_MAX</span></code></a></li>
 </ul>
 </li>

genindex.html

@@ -1458,14 +1458,22 @@ <h2 id="C">C</h2>
       <li><a href="Control/api.html#_CPPv4N14ctl_i2c_flag_t24CTL_I2C_FLAG_4BYTE_INDEXE">ctl_i2c_flag_t::CTL_I2C_FLAG_4BYTE_INDEX (C++ enumerator)</a>
 </li>
       <li><a href="Control/api.html#_CPPv4N14ctl_i2c_flag_t22CTL_I2C_FLAG_ATOMICI2CE">ctl_i2c_flag_t::CTL_I2C_FLAG_ATOMICI2C (C++ enumerator)</a>
+</li>
+      <li><a href="Control/api.html#_CPPv4N14ctl_i2c_flag_t28CTL_I2C_FLAG_DRIVER_OVERRIDEE">ctl_i2c_flag_t::CTL_I2C_FLAG_DRIVER_OVERRIDE (C++ enumerator)</a>
 </li>
       <li><a href="Control/api.html#_CPPv4N14ctl_i2c_flag_t16CTL_I2C_FLAG_MAXE">ctl_i2c_flag_t::CTL_I2C_FLAG_MAX (C++ enumerator)</a>
+</li>
+      <li><a href="Control/api.html#_CPPv4N14ctl_i2c_flag_t20CTL_I2C_FLAG_RESTARTE">ctl_i2c_flag_t::CTL_I2C_FLAG_RESTART (C++ enumerator)</a>
 </li>
       <li><a href="Control/api.html#_CPPv4N14ctl_i2c_flag_t27CTL_I2C_FLAG_SPEED_BIT_BASHE">ctl_i2c_flag_t::CTL_I2C_FLAG_SPEED_BIT_BASH (C++ enumerator)</a>
 </li>
       <li><a href="Control/api.html#_CPPv4N14ctl_i2c_flag_t23CTL_I2C_FLAG_SPEED_FASTE">ctl_i2c_flag_t::CTL_I2C_FLAG_SPEED_FAST (C++ enumerator)</a>
 </li>
       <li><a href="Control/api.html#_CPPv4N14ctl_i2c_flag_t23CTL_I2C_FLAG_SPEED_SLOWE">ctl_i2c_flag_t::CTL_I2C_FLAG_SPEED_SLOW (C++ enumerator)</a>
+</li>
+      <li><a href="Control/api.html#_CPPv4N14ctl_i2c_flag_t18CTL_I2C_FLAG_STARTE">ctl_i2c_flag_t::CTL_I2C_FLAG_START (C++ enumerator)</a>
+</li>
+      <li><a href="Control/api.html#_CPPv4N14ctl_i2c_flag_t17CTL_I2C_FLAG_STOPE">ctl_i2c_flag_t::CTL_I2C_FLAG_STOP (C++ enumerator)</a>
 </li>
       <li><a href="Control/api.html#_CPPv422ctl_i2c_pinpair_flag_t">ctl_i2c_pinpair_flag_t (C++ enum)</a>
 </li>
@@ -1887,12 +1895,12 @@ <h2 id="C">C</h2>
 </li>
       <li><a href="Control/api.html#_CPPv417ctl_pci_address_t">ctl_pci_address_t (C++ struct)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="Control/api.html#_CPPv4N17ctl_pci_address_t3busE">ctl_pci_address_t::bus (C++ member)</a>
 </li>
       <li><a href="Control/api.html#_CPPv4N17ctl_pci_address_t6deviceE">ctl_pci_address_t::device (C++ member)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="Control/api.html#_CPPv4N17ctl_pci_address_t6domainE">ctl_pci_address_t::domain (C++ member)</a>
 </li>
       <li><a href="Control/api.html#_CPPv4N17ctl_pci_address_t8functionE">ctl_pci_address_t::function (C++ member)</a>

index.html

@@ -1373,6 +1373,10 @@
 <li class="toctree-l7"><a class="reference internal" href="Control/api.html#_CPPv4N14ctl_i2c_flag_t23CTL_I2C_FLAG_SPEED_SLOWE"><code class="docutils literal notranslate"><span class="pre">CTL_I2C_FLAG_SPEED_SLOW</span></code></a></li>
 <li class="toctree-l7"><a class="reference internal" href="Control/api.html#_CPPv4N14ctl_i2c_flag_t23CTL_I2C_FLAG_SPEED_FASTE"><code class="docutils literal notranslate"><span class="pre">CTL_I2C_FLAG_SPEED_FAST</span></code></a></li>
 <li class="toctree-l7"><a class="reference internal" href="Control/api.html#_CPPv4N14ctl_i2c_flag_t27CTL_I2C_FLAG_SPEED_BIT_BASHE"><code class="docutils literal notranslate"><span class="pre">CTL_I2C_FLAG_SPEED_BIT_BASH</span></code></a></li>
+<li class="toctree-l7"><a class="reference internal" href="Control/api.html#_CPPv4N14ctl_i2c_flag_t28CTL_I2C_FLAG_DRIVER_OVERRIDEE"><code class="docutils literal notranslate"><span class="pre">CTL_I2C_FLAG_DRIVER_OVERRIDE</span></code></a></li>
+<li class="toctree-l7"><a class="reference internal" href="Control/api.html#_CPPv4N14ctl_i2c_flag_t18CTL_I2C_FLAG_STARTE"><code class="docutils literal notranslate"><span class="pre">CTL_I2C_FLAG_START</span></code></a></li>
+<li class="toctree-l7"><a class="reference internal" href="Control/api.html#_CPPv4N14ctl_i2c_flag_t17CTL_I2C_FLAG_STOPE"><code class="docutils literal notranslate"><span class="pre">CTL_I2C_FLAG_STOP</span></code></a></li>
+<li class="toctree-l7"><a class="reference internal" href="Control/api.html#_CPPv4N14ctl_i2c_flag_t20CTL_I2C_FLAG_RESTARTE"><code class="docutils literal notranslate"><span class="pre">CTL_I2C_FLAG_RESTART</span></code></a></li>
 <li class="toctree-l7"><a class="reference internal" href="Control/api.html#_CPPv4N14ctl_i2c_flag_t16CTL_I2C_FLAG_MAXE"><code class="docutils literal notranslate"><span class="pre">CTL_I2C_FLAG_MAX</span></code></a></li>
 </ul>
 </li>