s3e: fix build break
[calu.git] / README
1 == ISA ==
2 - befindet sich in 2_isa/
3 - requirements: latex und perl
4 - build: cd 2_isa; make
5
6 == ASM ==
7 - befindet sich in 3a_asm/
8 - requirements: ghc und zsh
9 - build: cd 3a_asm; make
10
11 == SIM ==
12 - befindet sich in 3b_sim/
13 - requirements: gcc/g++ > 4.4.0, boost > 1.37, readline
14 - build: cd 3b_sim; make
15 - remark: es koennte sein das die librarynamen in 3b_sim/Makefile.flags
16   angepasst werden muessen
17
18 == DTPROG ==
19 - was: programmer ueber UART mittels BootROM
20 - befindet sich in tools/
21 - requirements: python2
22
23 == PROGS ==
24 - befindet sich in progs/
25 - mit "make build" kann man ASM und SIM builden
26 - "make name.dthex" ruft den ASM mit "name.s" auf. Das Ergebnis befindet sich in
27   "name.dthex".
28 - "make name.sim" ruft den SIM mit dem Programm auf ("help" im SIM fuer
29   Erklaerung)
30 - "make name.prog" flasht das Programm per DTPROG auf die CPU
31 - ACHTUNG: Baudrate und Device muss ggf. im progs/Makefile angepasst werden!
32   Beim Quartus Projekt (siehe unten) ist eine Baudrate von 9600 eingestellt.
33
34 == HARDWARE DESIGN ==
35 - source befindet sich in cpu/src/
36 - passendes Quartus Projekt fuer die Cyclons im TILAB in dt/
37 - Image muss mit USBRunner auf das FPGA geladen werden
38 - Hinweis: fertiges Image liegt bereits im Rootverzeichnis
39   ("tilab_bootrom_abgabe.rbf").
40 - Hinweis: Nach dem Flashen der CPU sollte die LED leuchten. LED an bedeutet,
41   die CPU befindet sich im BootROM.
42 - Hinweis: Linker Button ist der "Hard-Reset" (return to BootROM)
43 - Hinweis: Rechter Button ist der "Soft-Reset" (Springe zum Start des Programms
44   im Instruktion-RAM)
45 - generelles naming (außer UART): <name>_b.vhd ist behavior, <name>.vhd
46   ist entity, <name>_pkg.vhd ist package. Mehrere Components sind oft 
47   in einem Package zusammengefasst (Beispiel: core_pkg.vhd enthält alle
48   pipeline components). Die Adressen für die Extension-Module findest du
49   in extension_pkg.vhd.
50
51
52 == BOOTROM ==
53 - befindet sich in 2_isa/src/bootrom.s
54 - nach aenderungen mit ASM dthex file erstellen, mithilfe von tools/dthex2vhdl
55    in vhdl "umwandeln" und in cpu/src/rom_b.vhd eintragen
56
57 Bei Fragen/Unklarheiten/Feedback/whatever kannst du uns gerne kontaktieren!
58
59 So long, and thanks for all the fish.