Skip to content

Commit 310f523

Browse files
committed
README: Document generated files
1 parent 7733b33 commit 310f523

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,14 @@ The generator has a couple of command line options that can be used to generate
7373
additional code (e.g. to enable a regulator to power on the panel).
7474
The script will gladly inform you about available options if you pass `--help`.
7575

76+
Currently there are 4 files generated:
77+
- `panel-xyz.c`: The main (full) panel driver for Linux.
78+
- `panel-simple-xyz.c`: A snippet to use for `panel-simple.c` in Linux.
79+
Can be used if the full panel driver is causing problems.
80+
- `panel-xyz.dtsi`: An example for the relevant panel setup in the device tree.
81+
- `lk_panel_xyz.h`: A panel header for Qualcomm's Little Kernel (LK) bootloader.
82+
Can be used to turn the display on for splash screens there.
83+
7684
### Making final edits
7785
In most cases, the driver should work as-is, no changes required.
7886
If you would like to use it permanently, or even upstream it, here are a few

0 commit comments

Comments
 (0)