[PATCH i-g-t 17/17] man: update intel_bios_reader man page

Jani Nikula
2016-05-03T14:19:48Z

man/intel_bios_reader.rst | 48 +++++++++++++++++++++++++++++++++++++++--------
1 file changed, 40 insertions(+), 8 deletions(-)

diff --git a/man/intel_bios_reader.rst b/man/intel_bios_reader.rst
index 7024f4ded226..0e935904bcfb 100644
--- a/man/intel_bios_reader.rst
+++ b/man/intel_bios_reader.rst
@@ -2,9 +2,9 @@
intel_bios_reader
=================

---------------------------------------------------
-Parse an Intel BIOS and display many of its tables
---------------------------------------------------
+-----------------------------
+Intel Video BIOS Table parser
+-----------------------------
.. include:: defs.rst
:Author: Intel Graphics for Linux <intel-gfx@lists.freedesktop.org>
:Date: 2016-03-01
@@ -16,15 +16,47 @@ Parse an Intel BIOS and display many of its tables
SYNOPSIS
========

-**intel_bios_reader** *FILENAME*
+**intel_bios_reader** [*OPTIONS*]

DESCRIPTION
===========

-**intel_bios_reader** is a tool to parse the contents of an Intel video BIOS
-file. The file can come from **intel_bios_dumper(1)**. This can be used for
-quick debugging of video bios table handling, which is harder when done inside
-of the kernel graphics driver.
+**intel_bios_reader** is a tool to parse the Intel Video BIOS Tables (VBT) and
+present the information in a human readable format.
+
+The preferred ways of getting the binary VBT to parse are:
+
+1) /sys/kernel/debug/dri/0/i915_vbt (since kernel version 4.5)
+
+2) /sys/kernel/debug/dri/0/i915_opregion
+
+3) Using the **intel_bios_dumper(1)** tool.
+
+The VBT consists of a VBT header, a BIOS Data Block (BDB) header, and a number
+of BIOS Data Blocks.
+
+OPTIONS
+=======
+
+--file=FILE
+ Parse Video BIOS Tables from FILE.
+
+--devid=DEVID
+ Pretend to be PCI ID DEVID. Some details can be parsed more accurately if
+ the platform is known.
+
+--panel-type=N
+ Parse the details for flat panel N. Usually this is retrieved from the Video
+ BIOS Tables, but this can be used to override.
+
+--all-panels
+ Parse the details for all flat panels present in the Video BIOS Tables.
+
+--hexdump
+ Hex dump the blocks.
+
+--block=N
+ Dump only the BIOS Data Block number N.

REPORTING BUGS
==============