Docs. Change ecosystem doc

AndreasJochum · Oct 22, 2020 · 710e9d0 · 710e9d0
1 parent 7326607
commit 710e9d0
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 13 deletions.
diff --git a/doc/developerGuide/ecosystem/ecosystem.rst b/doc/developerGuide/ecosystem/ecosystem.rst
@@ -71,9 +71,11 @@ different places one would expect.
 Supported platforms
 -------------------
 
-Red Pitaya is developed on Linux (64bit Ubuntu 16.04),
+Red Pitaya is developed on Linux (64bit Ubuntu 18.04),
 so Linux is also the only platform we support.
 
+.. _sys-req-label:
+
 ---------------------
 Software requirements
 ---------------------
@@ -105,15 +107,15 @@ You will need the following to build the Red Pitaya components:
       sudo pip3 install meson
       sudo apt-get install ninja-build
 
-3. Xilinx `Vivado 2017.2 <http://www.xilinx.com/support/download.html>`_ FPGA development tools.
+3. Xilinx `Vivado 2020.1 <http://www.xilinx.com/support/download.html>`_ FPGA development tools.
    The SDK (bare metal toolchain) must also be installed, be careful during the install process to select it.
    Preferably use the default install location.
 
     1. If you want to run Vivado from virtual machine and Vivado is installed on host shared
        folder, than we suggest you to use VirtualBox, since VMware has a bug in vmware-tools
        for Ubuntu guest and can not mount vmhgfs shared file system type.
 
-       Then install Ubuntu 16.04 in VirtualBox (NOTE: don't use encrypt installation, 
+       Then install Ubuntu 18.04 in VirtualBox (NOTE: don't use encrypt installation, 
        since it blocks some Red Pitaya build procedures).
 
        After successfully installation, change settings for Ubuntu virtual machine.
@@ -140,6 +142,8 @@ You will need the following to build the Red Pitaya components:
 
       $ sudo ln -s /usr/bin/make /usr/bin/gmake
 
+.. _build-proc-label:
+
 =============
 Build process
 =============
@@ -159,12 +163,27 @@ The choice of specific branches or tags is up to the user.
 .. note:: 
 
    You can run a script that builds the ecosystem from the build_scripts folder
-
+   To build an ecosystem for board 125-14:
+
    .. code-block:: shell-session
    
       cd ./RedPitaya/build_scripts
       sudo ./build_Z10.sh
 
+   To build an ecosystem for board 122-16:
+
+   .. code-block:: shell-session
+   
+      cd ./RedPitaya/build_scripts
+      sudo ./build_Z20.sh
+
+   To build an ecosystem for board 250-12:
+
+   .. code-block:: shell-session
+   
+      cd ./RedPitaya/build_scripts
+      sudo ./build_Z250_12.sh   
+
    or follow the steps of the instructions and build yourself
 
 
@@ -238,16 +257,27 @@ Replace user names with a comma separated list of users whom should be able to c
    EOL_CHROOT
    make -f Makefile.x86 zip
 
-**7.** If you want build for RP122-16 based on Z7020 xilinx, you must pass parameter FPGA MODEL=Z20 in makefile
+**7.** If you want build for 122-16 based on Z7020 xilinx, you must pass parameter FPGA MODEL=Z20 in makefile
 This parameter defines how to create projects and should be transferred to all makefiles.
 
 .. code-block:: shell-session
 
-   make -f Makefile.x86 FPGA MODEL=Z20
+   make -f Makefile.x86 MODEL=Z20
    schroot -c red-pitaya-ubuntu <<- EOL_CHROOT
-   make FPGA MODEL=Z20
+   make MODEL=Z20
    EOL_CHROOT
-   make -f Makefile.x86 zip FPGA MODEL=Z20
+   make -f Makefile.x86 zip MODEL=Z20
+
+**8.** If you want build for 250-12 based on Z7020 xilinx, you must pass parameter FPGA MODEL=Z20_250_12 in makefile
+This parameter defines how to create projects and should be transferred to all makefiles.
+
+.. code-block:: shell-session
+
+   make -f Makefile.x86 MODEL=Z20_250_12
+   schroot -c red-pitaya-ubuntu <<- EOL_CHROOT
+   make MODEL=Z20_250_12
+   EOL_CHROOT
+   make -f Makefile.x86 zip MODEL=Z20_250_12
 
 To get an interactive ARM shell do.
 
@@ -261,7 +291,7 @@ Partial rebuild process
 =======================
 
 The next components can be built separately.
-By default, the project is built for RP125-14 (Z7010), if necessary build for the Z7020, use the parameter FPGA_MODEL=Z20
+By default, the project is built for RedPitaya 125-14 (Z7010), if necessary build for the (RedPitaya 122-16) Z7020, use the parameter MODEL=Z20 and parameter MODEL=Z20_250_12 for RedPitaya (250-12) Z7020.
 
 * FPGA + device tree
 * u-Boot
@@ -284,7 +314,7 @@ To be able to compile FPGA and cross compile *base system* software, it is neces
 
    $ . settings.sh
 
-On some systems (including Ubuntu 16.04) the library setup provided by Vivado conflicts with default system libraries.
+On some systems (including Ubuntu 18.04) the library setup provided by Vivado conflicts with default system libraries.
 To avoid this, disable library overrides specified by Vivado.
 
 
@@ -375,7 +405,7 @@ Linux user space
 Debian/Ubuntu OS
 ~~~~~~~~~~~~~~~~
 
-`Debian/Ubuntu OS instructions <OS/debian/README.md>`_ are detailed elsewhere.
+`Debian/Ubuntu OS instructions <https://github.com/RedPitaya/RedPitaya/tree/master/OS/debian>`_ are detailed elsewhere.
 
 ~~~
 API
@@ -405,7 +435,7 @@ To compile the server run:
 
 .. code-block:: shell-session
 
-   make api
+   make scpi MODEL=Z10
 
 The compiled executable is ``scpi-server/scpi-server``.
 You can install it on Red Pitaya by copying it there:

diff --git a/doc/developerGuide/fpga.rst b/doc/developerGuide/fpga.rst
@@ -3,7 +3,7 @@ FPGA
 ####
 The following build instructions were tested on Ubuntu 18.04.
 
-Before trying to build the FPGA project, please refer to 3.2.3: Ecosystem Guide; subchapters 3.2.3.1.2. Software requirements and 3.2.3.2: Building process.
+Before trying to build the FPGA project, please refer to :ref:`Ecosystem Guide <ecosystem>`, :ref:`Software requirements <sys-req-label>` and :ref:`Building process <build-proc-label>`.
 In addition to running settings64.sh, it might be also necessary to add SDK bin folder to ``$PATH`` environment variable.
 
 .. code-block:: shell-session