[Nouveau] [PATCH envytools] nva: Clean up nva tools doc

Martin Peres
Mon, 25 Aug 2014 22:35:43 -0000

On 25/08/2014 20:58, Christian Costa wrote:
> - Sort commands by name for easier update
> - Make more readable
> - Remove no more existing commands
> ---
>   nva/README | 83
+++++++++++++++++++++++++++++++++-----------------------------
>   1 file changed, 44 insertions(+), 39 deletions(-)
>
> diff --git a/nva/README b/nva/README
> index 625ea7c..d4347c5 100644
> --- a/nva/README
> +++ b/nva/README
> @@ -3,7 +3,7 @@ registers.
>
>   WARNING: these tools *can* and *will* hang your machine if you don't
know
>   what you're doing. Hardware destruction is likely also possible,
although
> -no incidents are known to have happened yet. In most cases it's also
not
> +no incident are known to have happened yet. In most cases it's also
not
IIRC, "0" is considered plural in English. I'm sure Ilia or Ben
could
give us
a more definitive answer on this :)
>   recommended to use these tools while a driver is active for a given card.
>
>   All programs except nvalist take an optional -c <card number>
parameter.
> @@ -13,43 +13,48 @@ by the nvalist program.
>
>   The programs are:
>
> -nvalist: prints a list of cards
> -
> -nvapeek [<byte count>]: reads 32-bit MMIO register
at .
> -If byte count is also given, reads all registers in range [address,
address
> -+ byte count).
> -
> -nvapeek8 [<byte count>]: like nvapeek, but does
8-bit MMIO accesses
> -
> -nvapoke <value>: writes a 32-bit <value> to
the MMIO register at
> - .
> -
> -nvapoke8 <value>: like nvapoke, but does 8-bit MMIO
access
> -
> -nvawatch [-t] : reads MMIO register at in a
loop, prints
> -the value every time it changes. If -t is specified, prints a timestamp
> -and diff from the previous timestamp before the value. Never quits, needs
> -to be manually aborted.
> -
> -nvahammer <value>: like nvapoke, but repeats the
write in
> -an infinite loop. Needs to be manually aborted.
> -
> -nvagetbios [-s <extraction method>]: extracts the card's VBIOS
using the
> -method given as parameter and writes it to stdout. Method can be PROM or
> -PRAMIN. If method is not given, defaults to something sensible.
> -
> -nvafuzz [<byte count>]: writes random values to a
register or
> -a register range in an infinite loop. Needs to be manually aborted.
> -
> -nvascan [-as] [<byte count>]: for each register in a
range:
> -read it, write 0xffffffff, read it, write 0, read it, write back the
> -original value. Helpful to see the valid values for registers. If -s
option
> -is passed, does a slow scan - waits and reads PMC.ID register between
scans
> -to recover from errors caused by invalid register accesses. If -a option
> -is passed, does a cross-test on all registers in the range to detect
aliased
> -addresses [not particularly reliable].
> -
> -nvatiming: attempts to measure what frequency various units of the card
are
> -running at by using misc tricks.
> +nvafuzz [<byte count>]
> +    Writes random values to a register or
> +    a register range in an infinite loop. Needs to be manually aborted.
> +
> +nvagetbios [-s <extraction method>]
> +    Extracts the card's VBIOS using the
> +    method given as parameter and writes it to stdout. Method can be PROM
or
> +    PRAMIN. If method is not given, defaults to something sensible.
> +
> +nvahammer <value>
> +    Like nvapoke, but repeats the write in
> +    an infinite loop. Needs to be manually aborted.
> +
> +nvalist
> +    Prints a list of cards
> +
> +nvapeek [<byte count>]
> + Reads 32-bit MMIO register at .
> +    If byte count is also given, reads all registers in range [address,
address
> +    + byte count).
> +
> +nvapoke <value>
> +    Writes a 32-bit <value> to the MMIO register at
> + .
> +
> +nvascan [-as] [<byte count>]
> +    For each register in a range:
> +    read it, write 0xffffffff, read it, write 0, read it, write back the
> +    original value. Helpful to see the valid values for registers. If -s
option
> +    is passed, does a slow scan - waits and reads PMC.ID register between
scans
> +    to recover from errors caused by invalid register accesses. If -a
option
> +    is passed, does a cross-test on all registers in the range to detect
aliased
> +    addresses [not particularly reliable].
> +
> +nvatiming
> +    Attempts to measure what frequency various units of the card are
> +    running at by using misc tricks.
> +
> +nvawatch [-t]
> + Reads MMIO register at in a loop, prints
> +    the value every time it changes. If -t is specified, prints a
timestamp
> +    and diff from the previous timestamp before the value. Never quits,
needs
> +    to be manually aborted.
>
>   [XXX: document the remaining tools]
Did you fix some spelling mistakes in while changing the order? I
already suck at
comparing lines that are one on top of the other, so I don't even want
to try checking!