gma pcode: Move and revise mailbox handling

Unify the PCODE mailbox implementations (Linux' i915 uses the same
implementation since Sandy Bridge, too) and add `Wait` and `Success`
parameters so we can act correctly if something failed. This adds
a lot of boilerplate. But we keep it contained in the new package
`PCode` and the code outside it looks cleaner and handles errors
more gracefully.

In GNATprove, we track state of the mailbox' readiness in a ghost
variable `Mailbox_Ready`. This allows us to skip the initial wait
loop if we know that we already waited at the end of a previous
call. The first call to a mailbox procedure has to be made with
`Wait_Ready => True`.

Also, start to experiment with a `use` clause for the `Register`
package. It allows us to write a little more condensed code, with-
out sacrificing much (in this program we can expect that `Read`/
`Write` means register access?) So far it looks good?

Change-Id: I5daa3effb7ab774e4a35bd8794b0f67f57e4caa4
Signed-off-by: Nico Huber <nico.h@gmx.de>
Reviewed-on: https://review.coreboot.org/c/libgfxinit/+/35710
Reviewed-by: Angel Pons <th3fanbus@gmail.com>
8 files changed
tree: b9797382071153359c87386163f70bdfbd074da0
  1. common/
  2. configs/
  3. gfxtest/
  4. .gitignore
  5. COPYING
  6. Makefile
  7. Makefile.inc
  8. README.md
  9. TODO
README.md

libgfxinit

libgfxinit is a graphics initialization (aka modesetting) library for embedded environments. It currently supports only Intel hardware, more specifically the Intel Core processor line.

It can query and set up most kinds of displays based on their EDID information. You can, however, also specify particular mode lines.

libgfxinit is written in SPARK, an Ada subset with formal verifica- tion aspects. Absence of runtime errors can be proved automatically with SPARK GPL 2016.

Building on Linux

Prerequisites

For compilation, the GNAT Ada compiler is required. Usual package names in Linux distributions are gcc-ada and gnat.

Grab the Sources

You'll need libhwbase and libgfxinit. Best is to clone the reposi- tories into a common parent directory (this way libgfxinit will know where to find libhwbase).

$ mkdir gfxfun && cd gfxfun
$ git clone https://review.coreboot.org/p/libhwbase.git
$ git clone https://review.coreboot.org/p/libgfxinit.git

Configure and Install libhwbase

Both libraries are currently configured by hand-written config files. You can either write your own .config, link one of the shipped files in configs/, e.g.:

$ ln -s configs/linux libhwbase/.config

or overwrite the config filename by specifying cnf=<configfile> on the make command line.

By default most debug messages won't be compiled into the binary. To include them into the build, set DEBUG=1 on the command line or in your .config.

Let's install libhwbase. We'll need configs/linux to build regular Linux executables:

$ cd libhwbase
$ make DEBUG=1 cnf=configs/linux install

By default this installs into a new subdirectory dest. You can however overwrite this decision by specifying DESTDIR=.

Build libgfxinit/gfx_test

libgfxinit is configured and installed in the same manner as de- scribed above. You will have to select a configuration matching your hardware.

The makefile knows an additional target gfx_test to build a small Linux test application:

$ cd ../libgfxinit
$ make DEBUG=1 cnf=configs/sandybridge gfx_test

The resulting binary is build/gfx_test.

Testing libgfxinit on Linux

gfx_test sets up its own framebuffer in the stolen memory. It backs any current framebuffer mapping and contents up first and re- stores it before exiting. This works somehow even while the i915 driver is running. A wrapper script gfxtest/gfx_test.sh is pro- vided to help with the setup. It switches to a text console first and tries to unload the i915 driver. But ignores failures to do so (it won't work if you still have any application running that uses the gfx driver, e.g. an X server).

# gfxtest/gfx_test.sh

If you chose the right config above, you should be presented with a nice test image. But please be prepared that your console might be stuck in that state afterwards. You can try to run it with i915 deactivated then (e.g. when booting with nomodeset in the kernel command line or with i915 blacklisted) and loading it afterwards.