Commit 4a8e2b8a authored by Benoit Rat's avatar Benoit Rat

doc: update FAQ

parent 7df566dc
......@@ -488,7 +488,7 @@ To enable the wr-nic you should execute the modprobe[^errmodprobe] command to lo
~~~~~~~~
[^errmodprobe]: We have found a problem in some distribution with `modprobe` command.
You should use `insmod` instead and look at the [Known Bugs sections](#known-bugs).
You should use `insmod` instead and look at the [Frequently Added Questions sections](#frequently-added-questions).
You should expect to obtain two (or one) new interface(s):
......@@ -1736,87 +1736,28 @@ Please refer to *Writing EEPROM and calibration* Section of the [wrpc.pdf] docum
FAQS & Bugs
============
Known Bugs
----------
### Virtual UART
The following command: `sudo tools/spec-vuart -b <dev_id>` does not show anything?
Virtual UART is not enabled on the current release but will be available on the next one.
Until the next release you should stick with the Physical UART: mini-USB cable and minicom.
### No SFP in EEPROM database
When you try to match your SFPs and you obtain an error such as **Could not match to DB** you
need to add your own SFP parameters.
~~~~~{.sh}
## List your actual sfp database
wrc# sfp show
## Erase the actual database if it was corrupted
wrc# sfp erase
## Add the parameters for the SFP provided in the starting kit
wrc# sfp add AXGE-1254-0531 46407 167843 73622176
wrc# sfp add AXGE-3454-0531 46407 167843 -73622176
~~~~~~~~~~~
You can also check the [wrpc.pdf] for extended explanations on how to obtain the parameters for your own SFP
and how to calibrate them.
### Modprobe is not working
If you get and error like the following:
~~~~~~~{.sh}
>:$ sudo modprobe wr-nic
FATAL: Module wr_nic not found.
~~~~~~~~~
Be sure that you have run the `sudo depmod -a` command.
Otherwise you can still load the kernel modules with insmod using the
following commands:
~~~~~~~{.sh}
>:$ sudo insmod kernel/fmc.ko
>:$ sudo insmod kernel/spec.ko
>:$ sudo insmod kernel/wr-nic.ko
~~~~~~~~~~~~~
### The system hangs-up
Unfortunately, in some circumstances the system may hang during or slightly after firmware
loading. We are trying to solve this problem. You can contribute by sending us a log with the following information:
* What is your system & distribution (`uname -a`)
* All the commands executed from login to the crash
* The serial log starting from the login (dmesg)
### Only one wrX interface is brought up
Frequently Added Questions
===========================
On Ubuntu 12.04 (32bits & 64bits), the driver only loads one card.
This might due to some problems with the network manager.
We suggest you to reboot your system and restart the operation to solve this issue.
Online & Updated
-----------------
The FAQ is update on a regular basis on the ohwr.org website so
we strongly recommand you to visit the webpage:
Frequently Added Questions
----------------------------
* <http://www.ohwr.org/projects/wr-starting-kit/wiki/FAQ>
We also recommand the lecture of the online FAQ:
and you might also find information there:
* <http://www.ohwr.org/projects/spec/wiki/FAQ>
* <http://www.ohwr.org/projects/wr-starting-kit/wiki/FAQ>
* <http://www.ohwr.org/projects/wr-cores/wiki/Wrpc_faq>
Resume
------------------
However, you will find resume of the most asked questions below:
### I can't generate a PPS signal or any point in section 5 is not working
......@@ -1834,6 +1775,15 @@ to bring them up. This is explained in the [Bring up the network interface](#bri
To compile you must have at least the 2.6.36 kernel (errors occurs with
2.6.32, 2.6.34). We recommend you to use the latest version of your distribution.
If you think you have the correct setup you can also use our automatic build
script that also generate a report with your system information.
sudo scripts/wr-ssk-get --report
After a few minutes your project should have been installed correctly, if you
still have problems send us the generated `report.log` files in the main folder.
### The starting kit is based on Ubuntu. How can I use it with Scientific Linux?
The commands to execute in order to update the kernel using scientific linux (you need at least the 2.6.36 to compile the starting kit) are:
......@@ -1848,34 +1798,6 @@ You can have more information on how to do this by browsing the (http://elrepo.o
After this you should reboot your PC with the new kernel source and start from [section compile & install](#compile-install)
### I am stuck in calibration!
You have run
~~~~~{.sh}
wrc# calibration force
Enabling ptracker channel: 0
LNK:
PLL: SPLL_Init: running as Slave, 1 ref channels, 2 out channels
~~~~~~~~~~~~~~~
And the calibration is doing an infinite loop.
Calibration is only available for slave and you need to be connected to a **working PTP master** master ([SPEC] in master mode or the switch) to be completed.
To configure your [SPEC] as a working PTP master, just execute in the wrpc shell of the other board:
~~~~~{.sh}
wrc# sfp match
wrc# mode master
wrc# ptp start
~~~~~~~~~~
If you have blocked your two boards in calibration mode and they stay in this mode even after rebooting and reloading firmware/gateware
you might need to format the EEPROM.
### I can't detect any level on my inputs.
You should first try to desactivate the termination resistance that can
......@@ -1884,21 +1806,6 @@ consume most of the current if this one is really low.
Otherwise you should configure the DAC to setup a different threshold, however this option is not actually implemented.
### How can I format the EEPROM?
Generate an empty file of 64kb (the extension must be .bin)
dd count=64 bs=1k if=/dev/zero of=/tmp/zero64k.bin
and use the *fmc-write-eeprom* module from the [spec-sw] project to
flash the EEPROM with zero bytes.
insmod kernel/fmc-write-eeprom.ko file=/tmp/zero64k.bin busid=<busid_SPEC-DIO>
> ***Notes:*** By doing this you will lose all the SFP information and therefore you will
need to recalibrate "correctly" your boards.
### The link is down, but everything is connected
*The SFPs and the optical fiber are plugged but the error message appears `Link down --`
......@@ -1921,6 +1828,59 @@ This warning seems to appear after unnistalling wr-nic driver if PTP has already
After that the device keeps working as was previously specified.
### No SFP in EEPROM database
When you try to match your SFPs and you obtain an error such as **Could not match to DB** you
need to add your own SFP parameters.
~~~~~{.sh}
## List your actual sfp database
wrc# sfp show
## Erase the actual database if it was corrupted
wrc# sfp erase
## Add the parameters for the SFP provided in the starting kit
wrc# sfp add AXGE-1254-0531 46407 167843 73622176
wrc# sfp add AXGE-3454-0531 46407 167843 -73622176
~~~~~~~~~~~
You can also check the [wrpc.pdf] for extended explanations on how to obtain the parameters for your own SFP
and how to calibrate them.
### Modprobe is not working
If you get and error like the following:
~~~~~~~{.sh}
>:$ sudo modprobe wr-nic
FATAL: Module wr_nic not found.
~~~~~~~~~
Be sure that you have run the `sudo depmod -a` command.
Otherwise you can still load the kernel modules with insmod using the
following commands:
~~~~~~~{.sh}
>:$ sudo insmod kernel/fmc.ko
>:$ sudo insmod kernel/spec.ko
>:$ sudo insmod kernel/wr-nic.ko
~~~~~~~~~~~~~
### The system hangs-up
Unfortunately, in some circumstances the system might hang during or
slightly after firmware loading.
Please first check that you were not using the virtual UART while
removing/inserting kernel modules.
Please help us to solve this error by sending us a log with the following information:
* What is your system & distribution (`uname -a`)
* All the commands executed from login to the crash
* The serial log starting from the login (dmesg)
Glossary
===========
......
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