https://github.com/Harry-Chen/fpga-virtual-console

VT220-compatible console on Cyclone IV EP4CE55F23I7
https://github.com/Harry-Chen/fpga-virtual-console

console fpga keyboard systemverilog terminal terminal-emulator vt100 vt102 vt200 vt220 xterm-256color

Last synced: about 2 months ago
JSON representation

VT220-compatible console on Cyclone IV EP4CE55F23I7

• Host: GitHub
• URL: https://github.com/Harry-Chen/fpga-virtual-console
• Owner: Harry-Chen
• License: gpl-3.0
• Created: 2018-06-05T09:42:24.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-06-28T15:26:12.000Z (about 6 years ago)
• Last Synced: 2024-06-15T22:37:14.805Z (3 months ago)
• Topics: console, fpga, keyboard, systemverilog, terminal, terminal-emulator, vt100, vt102, vt200, vt220, xterm-256color
• Language: SystemVerilog
• Homepage:
• Size: 4.21 MB
• Stars: 39
• Watchers: 6
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# FPGA Console

This project implements a VT220-compatible console with extra color support on Cyclone IV EP4CE55F23I7. The experimental board has PS/2 keyboard input and HDMI video output, with UART transceiver to communicate with a computer.

The project is developed under Quartus Prime Lite 18.0, we do not provide any warranty for successful compilation on any other software.

## Usage (Arch Linux as example)

1. Compile the project and program the FPGA board.

2. Connect the keyboard and monitor.

3. Connect the FPGA board with PC via a USB-UART cable.

4. Start a serial tty on PC, such as: `systemctl start [email protected]`.

5. Login, and run `stty cols 100 rows 50` to set display area. Alternatively, you can run `demo/set_vt220.sh` or `demo/set_xterm.sh` to setup necessary environment for VT220 or XTerm-256color mode, respectively.

6. Enjoy it!

## Demonstration

There are some fancy commands. For example,

1. Run `demo/asciicam.sh` to display colored video captured from your camera.

2. Run `demo/video.sh [video_path]` to play video from `video_path`.

3. Run `bb` to show an ASCII-art demo.

4. Run `cacafire` to show the colored fire.

Some other demos are in the `demo` folder, you can also explore for more possibilities!

## Notice

1. The default baud is 3M, which is not a standard baud. You might need to modify the configuration of `getty` to make it communicate normally with the FPGA. Or you can slow it down (for example, 115200) in `src/DataType.svh`, which will lead to bad experiences such as slow refreshing rate.

2. There might be some timing issue with the VGA signal. You can adjust your monitor manually if it doesn't display image as expected.

3. When `TERM=vt220`, there is no color support but everything will work well. When `TERM=xterm-256color`, there is color support, but there might be some strange behaviors for we have not implemented all instructions in that mode.

4. `src/storage` contains some `mif` files that we have designed as the content of initial screen of the console. The default used is `TextRamLogBig.mif`, the others are all in `80*40` chars so cannot fill the whole screen.

## Test and Simulation

There are some test benches in folder `testbench`. You can use ModelSim to run simulation with source file properly attached. We also provide a debug probe in the top module with some signal linked to it. The two 7-segment LEDs on board can also show the internal status of the console, or the `CommandsParser`, to be precise.

## Documentation

You can refer to `doc/report.pdf` for a detailed explanation, or `doc/presentation.pdf` for a quick view of this project . `doc/reference` contains some details and specifications of console that we have implemented.

The source code is __not__ very well documented, we sincerely apologize for the consequential inconvenience.

## License

This project is released under GPLv3, see `LICENSE` for legal text.