flywithu/ntel-gpu-tools
1
0
Fork 0
mirror of https://github.com/tiagovignatti/intel-gpu-tools.git synced 2025-06-22 07:16:14 +00:00
Code Issues Releases Wiki Activity

man: update intel_reg.rst to be more in line with the others

Browse Source 
Use the definitions and formatting used in other man pages, etc.

Signed-off-by: Jani Nikula <jani.nikula@intel.com>
This commit is contained in:
Jani Nikula 2016-03-01 12:57:25 +02:00
parent cc7387f17c
commit b6b130c5eb
1 changed files with 42 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

106
man/intel_reg.rst
View File

@ -5,18 +5,18 @@ intel_reg
--------------------------------- ---------------------------------
Intel graphics register multitool Intel graphics register multitool
--------------------------------- ---------------------------------
.. include:: defs.rst
:Author: Jani Nikula <jani.nikula@intel.com> :Author: Jani Nikula <jani.nikula@intel.com>
:Date: 2015-04-14 :Date: 2016-03-01
:Version: intel-gpu-tools :Version: |PACKAGE_STRING|
:Copyright: 2015 Intel Corporation :Copyright: 2015-2016 Intel Corporation
:Manual section: 1 :Manual section: |MANUAL_SECTION|
:Manual group: General Commands Manual :Manual group: |MANUAL_GROUP|
SYNOPSIS SYNOPSIS
======== ========
**intel_reg** [*option* ...] *command* **intel_reg** [*OPTIONS*] *COMMAND*
DESCRIPTION DESCRIPTION
=========== ===========
@ -30,50 +30,33 @@ OPTIONS
Some options are global, and some specific to commands. Some options are global, and some specific to commands.
--verbose --verbose
--------- Increase verbosity.
Increase verbosity.
--quiet --quiet
------- Decrease verbosity.
Decrease verbosity.
--count=N --count=N
--------- Read N registers.
Read N registers.
--binary --binary
-------- Output binary values.
Output binary values.
--all --all
----- Decode registers for all known platforms.
Decode registers for all known platforms.
--mmio=FILE --mmio=FILE
----------- Use MMIO bar from FILE.
Use MMIO bar from FILE.
--devid=DEVID --devid=DEVID
------------- Pretend to be PCI ID DEVID. Useful with MMIO bar snapshots from other
machines.
Pretend to be PCI ID DEVID. Useful with MMIO bar snapshots from other machines.
--spec=PATH --spec=PATH
----------- Read register spec from directory or file specified by PATH; see REGISTER
SPEC DEFINITIONS below for details.
Read register spec from directory or file specified by PATH; see REGISTER SPEC
DEFINITIONS below for details.
--help --help
------ Show brief help.
Show brief help.
COMMANDS COMMANDS
======== ========
@ -123,52 +106,42 @@ REGISTER REFERENCES
Registers are defined as [(PORTNAME|PORTNUM|MMIO-OFFSET):](REGNAME|REGADDR). Registers are defined as [(PORTNAME|PORTNUM|MMIO-OFFSET):](REGNAME|REGADDR).
PORTNAME PORTNAME
-------- The register access method, most often MMIO, which is the default. The
methods supported on all platforms are "mmio", "portio-vga", and "mmio-vga".
The register access method, most often MMIO, which is the default. The methods On BYT and CHV, the sideband ports "bunit", "punit", "nc", "dpio",
supported on all platforms are "mmio", "portio-vga", and "mmio-vga". "gpio-nc", "cck", "ccu", "dpio2", and "flisdsi" are also supported.
On BYT and CHV, the sideband ports "bunit", "punit", "nc", "dpio", "gpio-nc",
"cck", "ccu", "dpio2", and "flisdsi" are also supported.
PORTNUM PORTNUM
------- Port number for the sideband ports supported on BYT and CHV. Only numbers
mapped to the supported ports are allowed, arbitrary numbers are not
accepted.
Port number for the sideband ports supported on BYT and CHV. Only numbers mapped Numbers above 0xff are automatically interpreted as MMIO offsets, not port
to the supported ports are allowed, arbitrary numbers are not accepted. numbers.
Numbers above 0xff are automatically interpreted as MMIO offsets, not port
numbers.
MMIO-OFFSET MMIO-OFFSET
----------- Use MMIO, and add this offset to the register address.
Use MMIO, and add this offset to the register address. Numbers equal to or below 0xff are automatically interpreted as port
numbers, not MMIO offsets.
Numbers equal to or below 0xff are automatically interpreted as port numbers,
not MMIO offsets.
REGNAME REGNAME
------- Name of the register as defined in the register spec.
Name of the register as defined in the register spec. If MMIO offset is not specified, it is picked up from the register
spec. However, ports are not; the port is a namespace for the register
If MMIO offset is not specified, it is picked up from the register names.
spec. However, ports are not; the port is a namespace for the register names.
REGADDR REGADDR
------- Register address. The corresponding register name need not be specified in
the register spec.
Register address. The corresponding register name need not be specified in the
register spec.
ENVIRONMENT ENVIRONMENT
=========== ===========
INTEL_REG_SPEC INTEL_REG_SPEC
-------------- Path to a directory or a file containing register spec definitions.
Path to a directory or a file containing register spec definitions.
REGISTER SPEC DEFINITIONS REGISTER SPEC DEFINITIONS
========================= =========================
@ -226,3 +199,8 @@ BUGS
==== ====
Reading some registers may hang the GPU or the machine. Reading some registers may hang the GPU or the machine.
REPORTING BUGS
==============
Report bugs to https://bugs.freedesktop.org.