Skip to content

S
Simple VME FMC Carrier SVEC
Commit 32e6ce94 authored by Federico Vaga's avatar Federico Vaga
Browse files
Options

doc: clarify installation procedure 

Signed-off-by: Federico Vaga's avatarFederico Vaga <federico.vaga@cern.ch>
parent 5c8b5729
Hide whitespace changes
Inline Side-by-side
Showing with 11 additions and 2 deletions
doc/sw-driver.rst
View file @ 32e6ce94
...@@ -22,6 +22,10 @@ SVEC FMC Carrier ...@@ -22,6 +22,10 @@ SVEC FMC Carrier
that all components cooperate correctly. It also provides the support that all components cooperate correctly. It also provides the support
for FPGA programming through the `FPGA manager interface`_. for FPGA programming through the `FPGA manager interface`_.
.. note::
At CERN we use CentOS 7 and its kernel does not provide the FPGA manager. To
solve the problem we provide an `FPGA manager backport`_
If the SVEC based application is using the :ref:`SVEC If the SVEC based application is using the :ref:`SVEC
base<svec_hdl_svec_base>` component then it can profit from the base<svec_hdl_svec_base>` component then it can profit from the
following driver. They are not all mandatory, it depends on the following driver. They are not all mandatory, it depends on the
...@@ -51,6 +55,7 @@ VIC ...@@ -51,6 +55,7 @@ VIC
.. _`SVEC project`: https://ohwr.org/project/svec .. _`SVEC project`: https://ohwr.org/project/svec
.. _`FMC`: https://www.ohwr.org/projects/fmc-sw .. _`FMC`: https://www.ohwr.org/projects/fmc-sw
.. _`FPGA manager interface`: https://www.kernel.org/doc/html/latest/driver-api/fpga/index.html .. _`FPGA manager interface`: https://www.kernel.org/doc/html/latest/driver-api/fpga/index.html
.. _`FPGA manager backport`: https://gitlab.cern.ch/coht/fpga-manager
.. _`DMA Engine`: https://www.kernel.org/doc/html/latest/driver-api/dmaengine/index.html .. _`DMA Engine`: https://www.kernel.org/doc/html/latest/driver-api/dmaengine/index.html
.. _`general cores`: https://www.ohwr.org/projects/general-cores .. _`general cores`: https://www.ohwr.org/projects/general-cores
...@@ -69,6 +74,10 @@ variable ``CHEBY``. Following an example on how to build the driver.:: ...@@ -69,6 +74,10 @@ variable ``CHEBY``. Following an example on how to build the driver.::
# define CHEBY only if it is not installed # define CHEBY only if it is not installed
export CHEBY=/path/to/cheby/proto/cheby.py export CHEBY=/path/to/cheby/proto/cheby.py
export FMC=/path/to/fmc-sw
export FPGA_MGR=/path/to/fpga-mgr
export SPI=/path/to/general-cores/software/spi-ocores
export I2C=/path/to/general-cores/software/i2c-ocores
cd /path/to/svec/ cd /path/to/svec/
make -C software/kernel modules make -C software/kernel modules
make -C software/kernel modules_install make -C software/kernel modules_install
...@@ -82,10 +91,10 @@ This will build and install 1 driver: ...@@ -82,10 +91,10 @@ This will build and install 1 driver:
find software -name "*.ko" find software -name "*.ko"
software/kernel/svec-fmc-carrier.ko software/kernel/svec-fmc-carrier.ko
Please note that this will not install all soft dependencies which are Please note that this will not install all dependencies which are
distributed separately (:ref:`I2C OpenCore<i2c_ocore>`, distributed separately (:ref:`I2C OpenCore<i2c_ocore>`,
:ref:`SPI OpenCore<spi_ocore>`, :ref:`HT Vector Interrupt Controller<vic>`, :ref:`SPI OpenCore<spi_ocore>`, :ref:`HT Vector Interrupt Controller<vic>`,
`FMC`_). `FMC`_, `FPGA manager backport`_).
.. _`cheby`: https://gitlab.cern.ch/cohtdrivers/cheby .. _`cheby`: https://gitlab.cern.ch/cohtdrivers/cheby
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment