The Project F display controller makes it easy to add video output to FPGA projects. It's written in Verilog and supports VGA, DVI, and HDMI displays. It includes full configuration for 640x480, 800x600, 1280x720, and 1920x1080, as well as the ability to define custom resolutions. This design and its documentation are licensed under the MIT License.
To get started, take a look at the demos then refer to modules and display parameters for more details.
The design aims to be as generic as possible but does make use of Xilinx Series 7 specific features, such as SerDes. If you want advice on adapting this design to other FPGAs, then take a look at porting.
For further information visit projectf.io.
NB. This repository was renamed in August 2019 to display_controller (with an underscore) to match Verilog's module naming conventions. See Changing a remote's URL if you want to update an existing clone.
- Display Interface Support
- Display Resolution Support
- Demos
- Modules
- Testing
- TMDS Encoder Model
- Resource Utilization
This design supports displays using VGA, DVI, and HDMI.
VGA support is straightforward; you can see an example in the VGA demo. If you're building your own hardware, then Retro Ramblings has a good example of creating a register ladder DAC. If you're looking for a ready-made VGA output, then the VGA Pmod is a good option for around $10.
DVI & HDMI use transition-minimized differential signalling (TMDS) to transmit video over high-speed serial links. HDMI provides extra functionality over DVI, including audio support, but all HDMI displays should accept a standard DVI signal without issue.
The display controller offers two types of TMDS generation:
- Direct generation on FPGA
- Black Mesa Labs DVI Pmod
Direct TMDS generation on FPGA requires high-frequency clocks (742.5 MHz for 720p60) and SerDes but allows full control of the signal including HDMI features. HDMI support is currently via backwards compatibility with DVI: any standard HDMI display should accept DVI signals. However, this display controller lacks support for audio or advanced HDMI features at present.
The Black Mesa Labs (BML) Pmod is based on the Texas Instruments TFP410. The Pmod is restricted to standard DVI features but allows even tiny FPGAs to support DVI signalling. As of February 2019, there is an unresolved issue when using a BML DVI Pmod with HDMI displays: some displays report a signal error and show nothing. This issue isn't confined to Project F but has also been reported by Black Mesa Labs themselves.
The following four display resolutions are tested and included by default (all at 60 Hz refresh rate):
Resolution Ratio Clock
640 x 480 4:3 25.20 MHz [1]
800 x 600 4:3 40.00 MHz
1280 x 720 16:9 74.25 MHz
1920 x 1080 16:9 148.50 MHz [2]
See display parameters for full details of these display resolutions. You can easily add timings for other resolutions; the demos provide a good starting point for this.
[1] The canonical clock for 640x480 60Hz is 25.175 MHz, but 25.2 MHz is within VESA spec and simpler to generate.
[2] The TMDS clock for 1080p60 is 1.485 GHz, which is out of spec for Xilinx 7 series FPGAs. However, 1080p60 does work, even on the slowest Artix speed grade, provided the traces are short, or a TMDS buffer is used. 1080p60 has been successfully tested on the Nexys Video, which uses the TMDS141.
The demo directory includes a demo for each supported interface:
- DVI TMDS Demo - DVI encoded on FPGA
- DVI 3-bit Pmod Demo - DVI generated by BML 3-bit Pmod
- DVI 24-bit Pmod Demo - DVI generated by BML 24-bit Pmod (coming soon)
- VGA Demo - analogue VGA with 12-bit output
You can find the list of required modules for each demo in a comment at the top of its file. You'll also need suitable constraints. The project includes constraints for Digilent Arty and Nexys Video.
There are also three test cards that the demo modules can use:
- Test Card Simple - simple colour bars (1-bit per colour and two shades of grey)
- Test Card Squares - squares and lines of different colours (1-bit per colour)
- Test Card Gradient - colour gradient (8-bit per colour)
You can adjust the demo resolution by changing the parameters for display_clocks, display_timings, and the test card you're using. Comments in the demos provide the parameters you need for the supported resolutions.
There are three modules you need to interface with for full TMDS generation:
- Display Clocks (RTL) - pixel and high-speed clocks for TMDS
- Display Timings (RTL) - generates display timings, including horizontal and vertical sync
- DVI Generator (RTL) - encodes data with TMDS then serializes it to create a DVI signal
If you're generating VGA or using DVI/HDMI hardware that includes its own TMDS encoder you don't need the DVI generator.
You need a top module to operate the display controller; the project includes demo versions for different display interfaces.
Details on module interfaces can be found in the modules doc.
If it isn't tested, it doesn't work. Project F tests its designs in simulation and on real hardware. For the display controller, you can use the included test benches and Python TMDS model to exercise the design.
We haven't formally verified the design yet, but plan to do this for the display timings and TMDS encoder. If you're interested in learning more about formal verification, check out Clifford Wolf's Formal Verification with SymbiYosys and Yosys-SMTBMC.
The display controller includes a simple Python model to help with TMDS encoder development.
There are two steps to TMDS encoding: applying XOR or XNOR to the bits to minimize transitions and keeping the overall number of 1s and 0s similar to ensure DC balance. The first step depends only on the current input value, so it is easy to test. However, balancing depends on the previous values, which makes testing harder; this is where the model is particularly useful.
By default, the Python model encodes all 256 possible 8-bit values in order, but it's easy to change the script to handle other combinations. A0, A1, B0, or B1 show which of the four balancing options was taken: you can see what they do in the Python source or Verilog design.
Sample Python output:
1s B O 76543210 876543210 9876543210
=======================================================
30: XNOR(2, 0, A1) 00011110 -> 010100000 -> 1001011111
31: XNOR(6, 4, B1) 00011111 -> 001011111 -> 1010100000
32: XOR (3, 0, A0) 00100000 -> 111100000 -> 0111100000
Sample output from Verilog TMDS test bench; it should match the middle column of the Python output:
30 010100000 2, 0, A1
31 001011111 6, 4, B1
32 111100000 3, 0, A0
You can also see the full output from the Python model and Verilog implementation for comparison.
The display controller is lightweight, fitting comfortably into even small FPGAs.
The following table shows utilization of the display-controller with the gradient test card at a resolution of 640x480. Utilization is pretty much invariant with resolution.
Artix-7
Interface LUT FF
-----------------------------
DVI on FPGA 282 77
DVI BML 3-bit 86 32
DVI BML 24-bit TBC TBC
VGA 12-bit 92 32
-----------------------------
Synthesized and implemented with Vivado 2019.1 using default options.
For comparison, an Artix A35T has 20,800 LUT6 and 41,600 FF, while the tiny Spartan 7S6 has 3,752 LUT6 and 7,500 FF.
NB. If you drive the "DVI on FPGA" display controller with a few fixed colours, such as the simple test bench, the optimizer removes a significant part of the design, resulting in misleadingly low utilization.