Add pluto and m2k pages

university/tools/pluto/help_support tools/pluto/help_support.rst university/tools/pluto/prerequisites tools/pluto/prerequisites.rst university/tools/pluto/devs/usb_otg tools/pluto/devs/usb_otg.rst university/tools/pluto/controlling_the_transceiver_and_transferring_data tools/pluto/transceiver_transferring_data.rst university/tools/pluto/users/antennas tools/pluto/users/antennas.rst university/tools/pluto/devs/reboot tools/pluto-m2k/reboot.rst university/tools/pluto/obtaining_the_sources tools/pluto-m2k/obtaining_the_sources university/tools/pluto/drivers/windows tools/pluto-m2k/drivers university/tools/pluto/users/firmware tools/pluto-m2k/firmware.rst university/tools/pluto/drivers/windows tools/pluto-m2k/drivers.rst university/tools/pluto/drivers/osx tools/pluto-m2k/drivers.rst university/tools/pluto/drivers/linux tools/pluto-m2k/drivers.rst university/tools/uartjtag tools/uartjtag/index.rst university/tools/pluto/building_the_image tools/pluto-m2k/building_the_image.rst university/tools/pluto/usb_otg_host_function_support tools/pluto-m2k/usb_otg_host_function_support.rst university/tools/pluto/hacking/listening_to_yourself tools/pluto/hacking/listening_to_yourself.rst Signed-off-by: Jorge Marques <[email protected]>
analogdevicesinc · Dec 3, 2024 · e31a731 · e31a731
1 parent e479da3
commit e31a731
Show file tree

Hide file tree

Showing 80 changed files with 4,130 additions and 41 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -25,7 +25,7 @@
 
 # -- External docs configuration ----------------------------------------------
 
-interref_repos = ['doctools', 'hdl', 'pyadi-iio']
+interref_repos = ['doctools', 'hdl', 'pyadi-iio', 'scopy', 'no-OS']
 
 # -- Options for HTML output --------------------------------------------------
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,5 +1,5 @@
 System Level Documentation
-===============================================================================
+==========================
 
 .. attention::
 

diff --git a/docs/software/libm2k/calibration.rst b/docs/software/libm2k/calibration.rst
@@ -1,7 +1,7 @@
 .. _libm2k calibration:
 
-Libm2k Calibration
-==================
+Calibration
+===========
 
 Description of the ADALM2000 calibration API in
 :dokuwiki:`libm2k </university/tools/m2k/libm2k/libm2k>`.

diff --git a/docs/software/libm2k/index.rst b/docs/software/libm2k/index.rst
@@ -3,10 +3,10 @@
 Libm2k
 ======
 
-Libm2k is a C++ library for interfacing with the ADALM2000, split into more
+Libm2k is a C++ library for interfacing with the :ref:`m2k`, split into more
 correlated components, interconnected by a context.
 
-These m2k components represent the functionalities of ADALM-2000:
+These m2k components represent the functionalities of ADALM2000:
 
 -  AnalogIn - oscilloscope or voltmeter
 -  AnalogOut - signal generator
@@ -359,7 +359,7 @@ Dependencies
 
 #. Swig
 
-   - Download the SWIG zip from `this page <https://sourceforge.net/projects/swig/files/swigwin/swigwin-4.0.0/swigwin-4.0.0.zip/download`__.
+   - Download the SWIG zip from `this page <https://sourceforge.net/projects/swig/files/swigwin/swigwin-4.0.0/swigwin-4.0.0.zip/download>`__.
    - Choose a location and extract SWIG.
 
 #. Python3

diff --git a/docs/software/libm2k/m2kcli.rst b/docs/software/libm2k/m2kcli.rst
@@ -76,16 +76,16 @@ synopsis
 
 .. code:: bash
 
-    m2kcli analog-in <uri>
-                     [-h | --help]
-                     [-q | --quiet]
-                     [-C | --calibrate]
-                     [-v | --voltage channel=<index>,... raw=<value>]
-                     [-c | --capture channel=<index>,... buffer_size=<size> raw=<value> [nb_samples=<value>] [format=<type>]]
-                     [-g | --get <attribute>...]
-                     [-G | --get-channel channel=<index>,... <attribute>...]
-                     [-s | --set <attribute>=<value>...]
-                     [-S | --set-channel channel=<index> <attribute>=<value>...]
+   m2kcli analog-in <uri>
+                    [-h | --help]
+                    [-q | --quiet]
+                    [-C | --calibrate]
+                    [-v | --voltage channel=<index>,... raw=<value>]
+                    [-c | --capture channel=<index>,... buffer_size=<size> raw=<value> [nb_samples=<value>] [format=<type>]]
+                    [-g | --get <attribute>...]
+                    [-G | --get-channel channel=<index>,... <attribute>...]
+                    [-s | --set <attribute>=<value>...]
+                    [-S | --set-channel channel=<index> <attribute>=<value>...]
 
 
 description
@@ -982,7 +982,7 @@ Requirements:
 
 -  `socat <https://linux.die.net/man/1/socat>`__
 -  :ref:`libiio <libiio build>`
--  :libm2k with :ref:`m2kcli <m2kcli build>`
+-  libm2k with :ref:`m2kcli <m2kcli build>`
 
 It uses the socat command to create two connected
 `PTYs <https://linux.die.net/man/7/pty>`__ and using the m2kcli uart-terminal

diff --git a/docs/tools/m2k/devs.rst → docs/tools/m2k/devs/index.rst b/docs/tools/m2k/devs.rst → docs/tools/m2k/devs/index.rst
@@ -1,4 +1,4 @@
-.. _m2k developers:
+.. _m2k devs:
 
 For Developers
 ==============
@@ -19,9 +19,9 @@ can do anything you want.
 Content
 -------
 
-.. todo::
-
-   Coming soon sections
+..
+   TODO Coming soon sections
+   Make sure all things are in ./devs
 
 #. Introduction *(Coming soon)*
 #. Hardware
@@ -57,6 +57,6 @@ Content
    #. :ref:`pluto-m2k obtaining_the_sources`
    #. :ref:`pluto-m2k building_the_image`
 
-#. :ref:`pluto-m2k usb_otg_host_function_support`
+#. :ref:`pluto-m2k usb_otg_host`
 #. :ref:`pluto-m2k firmware dfu_update`
 #. :ref:`pluto-m2k reboot`
diff --git a/docs/tools/m2k/index.rst b/docs/tools/m2k/index.rst
@@ -3,6 +3,13 @@
 ADALM2000
 =========
 
+.. toctree::
+   :hidden:
+   :glob:
+
+   */index
+   *
+
 The :adi:`ADALM2000` (M2K) Active Learning Module is an affordable
 USB-powered data acquisition module that takes the capabilities of the
 :adi:`ADALM1000` (M1K) Active Learning Module to the next level.
@@ -60,7 +67,7 @@ want to go any deeper into the stack. There are 3 main categories of users:
       C++/C#/Python applications that capture and generate data from the host
       PC.
 
-#. :ref:`ADALM2000 Firmware Developers <m2k developers>`:
+#. :ref:`ADALM2000 Firmware Developers <m2k devs>`:
 
    -  normally write custom software or HDL (for the FPGA) that run directly on
       the ADALM2000 device. This may put the ADALM2000 in different modes, and
@@ -75,10 +82,4 @@ improvement, so if you do have a question, please ask at
 :ez:`EngineerZone <community/university-program>`,
 or check the :ref:`help and support <m2k help_support>` page.
 
-Contents
---------
-
-.. toctree::
-   :glob:
-
-   *
+.. esd-warning::
diff --git a/docs/tools/m2k/users.rst → docs/tools/m2k/users/index.rst b/docs/tools/m2k/users.rst → docs/tools/m2k/users/index.rst
@@ -3,32 +3,36 @@
 For End Users
 =============
 
-.. image:: adalm2000.jpg
+.. image:: ../adalm2000.jpg
    :align: right
    :width: 400px
 
 Contents
 --------
 
-#. :dokuwiki:`Introduction to the Hardware </devs/intro>`
+..
+   TODO pluto customizing to pluto-m2k
+   Make sure all things are in ./users
 
-   #. :dokuwiki:`What's with the name? </users/name>` *ADALM2000?*
-   #. :dokuwiki:`Understanding the Internals </users/reference_manual>`
+#. :dokuwiki:`Introduction to the Hardware <university/tools/m2k/devs/intro>`
 
-#. :dokuwiki:`Quick Start </users/quick_start>`
+   #. :dokuwiki:`What's with the name? <university/tools/m2k/users/name>` *ADALM2000?*
+   #. :dokuwiki:`Understanding the Internals <university/tools/m2k/users/reference_manual>`
+
+#. :dokuwiki:`Quick Start <university/tools/m2k/users/quick_start>`
 #. Intro to the Software. Installing Device Drivers on:
 
    #. :dokuwiki:`Windows </university/tools/pluto/drivers/windows>`
    #. :dokuwiki:`Linux </university/tools/pluto/drivers/linux>`
    #. :dokuwiki:`MAC </university/tools/pluto/drivers/osx>`
 
-#. Upgrading the the ADALM2000 :ref:`Firmware <m2k common firmware>`.
+#. Upgrading the the ADALM2000 :ref:`Firmware <pluto-m2k firmware>`.
 #. Common customization: 
 
-   #. :ref:`/university/tools/pluto/users/customizing#multiple_devices>`
-   #. :ref:`/university/tools/pluto/users/customizing##changing_the_root_password_on_the_target>`
-   #. :ref:`/university/tools/pluto/users/customizing#enabling_persistent_ssh_keys>`
-   #. :ref:`/university/tools/pluto/users/customizing#changing_the_usb_ethernet_compatibility_mode>`
+   #. :dokuwiki:`/university/tools/pluto/users/customizing#multiple_devices>`
+   #. :dokuwiki:`/university/tools/pluto/users/customizing#changing_the_root_password_on_the_target>`
+   #. :dokuwiki:`/university/tools/pluto/users/customizing#enabling_persistent_ssh_keys>`
+   #. :dokuwiki:`/university/tools/pluto/users/customizing#changing_the_usb_ethernet_compatibility_mode>`
 
 #. Once the driver are configured and set up, you can interact with the
    :adi:`ADALM2000` Active Learning Module from:

diff --git a/docs/tools/m2k/windows-eject.png b/docs/tools/m2k/windows-eject.png