From mboxrd@z Thu Jan 1 00:00:00 1970 From: Martin Peres Subject: Re: [PATCH envytools] nva: Clean up nva tools doc Date: Tue, 26 Aug 2014 00:35:43 +0200 Message-ID: <53FBBA3F.50405@free.fr> References: <1408993096-18883-1-git-send-email-titan.costa@gmail.com> <1408993096-18883-3-git-send-email-titan.costa@gmail.com> Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii"; Format="flowed" Content-Transfer-Encoding: 7bit Return-path: In-Reply-To: <1408993096-18883-3-git-send-email-titan.costa-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: nouveau-bounces-PD4FTy7X32lNgt0PjOBp9y5qC8QIuHrW@public.gmane.org Sender: "Nouveau" To: nouveau-PD4FTy7X32lNgt0PjOBp9y5qC8QIuHrW@public.gmane.org List-Id: nouveau.vger.kernel.org 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 parameter. > @@ -13,43 +13,48 @@ by the nvalist program. > > The programs are: > > -nvalist: prints a list of cards > - > -nvapeek
[]: reads 32-bit MMIO register at
. > -If byte count is also given, reads all registers in range [address, address > -+ byte count). > - > -nvapeek8
[]: like nvapeek, but does 8-bit MMIO accesses > - > -nvapoke
: writes a 32-bit to the MMIO register at > -
. > - > -nvapoke8
: 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
: like nvapoke, but repeats the write in > -an infinite loop. Needs to be manually aborted. > - > -nvagetbios [-s ]: 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
[]: writes random values to a register or > -a register range in an infinite loop. Needs to be manually aborted. > - > -nvascan [-as]
[]: 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
[] > + Writes random values to a register or > + a register range in an infinite loop. Needs to be manually aborted. > + > +nvagetbios [-s ] > + 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
> + Like nvapoke, but repeats the write in > + an infinite loop. Needs to be manually aborted. > + > +nvalist > + Prints a list of cards > + > +nvapeek
[] > + Reads 32-bit MMIO register at
. > + If byte count is also given, reads all registers in range [address, address > + + byte count). > + > +nvapoke
> + Writes a 32-bit to the MMIO register at > +
. > + > +nvascan [-as]
[] > + 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!