Files

=============================================
   KM3NeT CLB v2 Embedded Software Package
=============================================
 * 2nd of December 2014, Vincent van Beveren

Building
========
There are three builds which can be made: runtime, golden and sim.

runtime - The normal runtime image
golden  - The golden image, a subset of the runtime, which is loaded at start up
sim     - A DOM simulator, still in incubator stage

The runtime and golden image can be build with sort-of the same options.
 
 Enter the build/runtime for building the runtime
 Enter the build/golden to build the golden image

To build the image, use

 make TARGET=<target>
 
Where target may be:
  CLBV2_PROTO       - CLB v2 proto
  CLBV2_2           - CLB v2.2 proto
  CLBV2_2_1         - CLB v2.2.1
  CLBV2_PRES1       - CLB v2.2.1 preserie1
  CLBV2X_PROTO      - CLB v2 proto with 325T (Nikhef Internal)
  KC705_SFP         - KC705 with ethernet over SPF (no white rabbit)
  KC705_SPLL        - KC705 with ethernet over softPLL
  KC705_UART        - KC705 with UART ethernet bridge (no white rabbit)

Please keep in mind that KC705_UART is not well supported anymoe.

Optionally an additional make target can be supplied:

 * make TARGET=CLBV2_2_1 upload
   Will upload the build to a connected CLB or KC705
 
 * make TARGET=CLBV2_2_1 update
   Will generate a .bin and .mcs file. The .bin file can be used to update the CLB using the
   Test GUI.
 

Simulator
=========
The DOM simulator is the code of the 2nd LM32 running on Windows, and in the future also Linux. 
It runs almost the same code as the actual DOM and can therefore be used to test the CLB code.
However, since it does not have hardware, it does not actually do anything, or produce TDC/AES or
monitoring data. Of course this may change in the future.

Reference
=========
Please refer to doc/clbv2app.pdf for more information. Currently this documentation is somewhat
outdated.