Skip to content

Commit

Permalink
README: Document generated files
Browse files Browse the repository at this point in the history
  • Loading branch information
stephan-gh committed Jan 14, 2022
1 parent 7733b33 commit 310f523
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,14 @@ The generator has a couple of command line options that can be used to generate
additional code (e.g. to enable a regulator to power on the panel).
The script will gladly inform you about available options if you pass `--help`.

Currently there are 4 files generated:
- `panel-xyz.c`: The main (full) panel driver for Linux.
- `panel-simple-xyz.c`: A snippet to use for `panel-simple.c` in Linux.
Can be used if the full panel driver is causing problems.
- `panel-xyz.dtsi`: An example for the relevant panel setup in the device tree.
- `lk_panel_xyz.h`: A panel header for Qualcomm's Little Kernel (LK) bootloader.
Can be used to turn the display on for splash screens there.

### Making final edits
In most cases, the driver should work as-is, no changes required.
If you would like to use it permanently, or even upstream it, here are a few
Expand Down

0 comments on commit 310f523

Please sign in to comment.