Re: [linux-sunxi] Wiki page to track allwinner datasheets (user manual) errata

2014-10-01 Thread Hans de Goede
Hi,

On 09/30/2014 06:32 PM, jonsm...@gmail.com wrote:
 On Tue, Sep 30, 2014 at 12:21 PM, Hans de Goede hdego...@redhat.com wrote:
 Hi All,

 I think we should start an errata page on the linux-sunxi wiki somewhere,
 specifically targeting errata for the official user manual documents.
 
 Why not issue tracking on the github account Allwinner made?
 https://github.com/allwinner-zh/documents/issues
 
 I'd like to see Allwinner get used to responding to a normal issues
 tracking system.

That is a good idea, feel free to report an issue there with the
errata we're talking about atm:

 The specific case triggering this idea is the lack of documentation
 for bits 10-12 of the GMAC clk register (0x01c20164). I've been in
 contact with allwinner about these 3 bits, and they configure
 the GMAC Transmit Clock Delay Chain (GTXDC), they are the transmit
 equivalent of bits 5-7.

Regards,

Hans

-- 
You received this message because you are subscribed to the Google Groups 
linux-sunxi group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to linux-sunxi+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.


Re: [linux-sunxi] Wiki page to track allwinner datasheets (user manual) errata

2014-10-01 Thread Hans de Goede
Hi,

On 09/30/2014 06:25 PM, Luc Verhaegen wrote:
 On Tue, Sep 30, 2014 at 06:21:18PM +0200, Hans de Goede wrote:
 Hi All,

 I think we should start an errata page on the linux-sunxi wiki somewhere,
 specifically targeting errata for the official user manual documents.

 I know we already have various pages to document specific blocks, the
 idea here would be to have a general errata page. The purpose is to have
 a single place to gather doc fixes for blocks which are adequately
 documented in the user-manual, except for one or two missing bits.

 IMHO it is not worth the trouble / useful to create an entire new page
 for cases where we're talking about just 1-2 bits. But it would be
 useful to gather these little fixes somewhere, hence the suggestion
 to have a generic errata page. For blocks for which we already have
 extensive documentation in the wiki, this generic page can contain
 links to the documentation for these blocks.

 So good or bad idea ?

 And if you believe this is a good idea, any suggestions for a name /
 hierarchy for these pages ?

 ###

 The specific case triggering this idea is the lack of documentation
 for bits 10-12 of the GMAC clk register (0x01c20164). I've been in
 contact with allwinner about these 3 bits, and they configure
 the GMAC Transmit Clock Delay Chain (GTXDC), they are the transmit
 equivalent of bits 5-7.

 Regards,

 Hans
 
 Sounds like a plan.
 
 Let's start out with something like this:
 
 Start with a page called documentation or something.
 
 Then start listing the datasheets, one section per chipset (single =) 
 on that page. 
 
 Have the device pages link to those sections.
 
 Then have a per chipset errata page reachable from each chipset specific 
 section.

Sounds good. Unfortunately I've come to the conclusion that I'm way too
busy lately, and that I've to better prioritize things (and actually
drop low priority items after setting priorities).

I'm afraid this item has been put on the to be dropped list. I'm sorry
(really I am). I hope someone else can pick this up.

Regards,

Hans

-- 
You received this message because you are subscribed to the Google Groups 
linux-sunxi group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to linux-sunxi+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.


Re: [linux-sunxi] Wiki page to track allwinner datasheets (user manual) errata

2014-10-01 Thread Simos Xenitellis
On Tue, Sep 30, 2014 at 7:32 PM, jonsm...@gmail.com jonsm...@gmail.com
wrote:

 On Tue, Sep 30, 2014 at 12:21 PM, Hans de Goede hdego...@redhat.com
 wrote:
  Hi All,
 
  I think we should start an errata page on the linux-sunxi wiki somewhere,
  specifically targeting errata for the official user manual documents.

 Why not issue tracking on the github account Allwinner made?
 https://github.com/allwinner-zh/documents/issues

 I'd like to see Allwinner get used to responding to a normal issues
 tracking system.


Ideally, Allwinner should update the PDF documents once errors/omissions
are found.
I do not know how fast they can attend to such issues, so it is important
to find out.

The second option is to maintain errata files on
https://github.com/allwinner-zh/documents/
for each SoC.
For the current issue for the A20, we create a new file into
https://github.com/allwinner-zh/documents/tree/master/A20
called errata_datasheet.txt/errata_usermanual.txt and add the text that
describes what is changed.
Then we sent a pull request so that Allwinner would merely need to click a
button at github.com to accept the change.
Then, they can take their time to update the original PDF docs. When that
happens, we clear the errata files.

If however Allwinner would prefer the community to do all the work with the
errata files,
then the github.com account for allwinner-zh could be converted into an
organization account,
and then they can add a few of our github user accounts as members of the
documents repository.
This means that we can deal with errata documents completely by ourselves,
and let Allwinner
add those changes into future revisions of the documents.

If the above make sense, we can suggest them to Allwinner.
Are we OK with that?

Simos


 
  I know we already have various pages to document specific blocks, the
  idea here would be to have a general errata page. The purpose is to have
  a single place to gather doc fixes for blocks which are adequately
  documented in the user-manual, except for one or two missing bits.
 
  IMHO it is not worth the trouble / useful to create an entire new page
  for cases where we're talking about just 1-2 bits. But it would be
  useful to gather these little fixes somewhere, hence the suggestion
  to have a generic errata page. For blocks for which we already have
  extensive documentation in the wiki, this generic page can contain
  links to the documentation for these blocks.
 
  So good or bad idea ?
 
  And if you believe this is a good idea, any suggestions for a name /
  hierarchy for these pages ?
 
  ###
 
  The specific case triggering this idea is the lack of documentation
  for bits 10-12 of the GMAC clk register (0x01c20164). I've been in
  contact with allwinner about these 3 bits, and they configure
  the GMAC Transmit Clock Delay Chain (GTXDC), they are the transmit
  equivalent of bits 5-7.
 
  Regards,
 
  Hans
 
  --
  You received this message because you are subscribed to the Google Groups
  linux-sunxi group.
  To unsubscribe from this group and stop receiving emails from it, send an
  email to linux-sunxi+unsubscr...@googlegroups.com.
  For more options, visit https://groups.google.com/d/optout.



 --
 Jon Smirl
 jonsm...@gmail.com

 --
 You received this message because you are subscribed to the Google Groups
 linux-sunxi group.
 To unsubscribe from this group and stop receiving emails from it, send an
 email to linux-sunxi+unsubscr...@googlegroups.com.
 For more options, visit https://groups.google.com/d/optout.


-- 
You received this message because you are subscribed to the Google Groups 
linux-sunxi group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to linux-sunxi+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.


Re: [linux-sunxi] Wiki page to track allwinner datasheets (user manual) errata

2014-10-01 Thread Clement Wong
Hi,

Wouldn’t it be easier if these PDF files are in some kind of markdown format?
Then it will be so much easier to do pull request, review, diff, see commit 
log, etc.
And it’ll be very easy to export as PDF.

Clement

 On Oct 1, 2014, at 9:14 AM, Simos Xenitellis simos.li...@googlemail.com 
 wrote:
 
 
 On Tue, Sep 30, 2014 at 7:32 PM, jonsm...@gmail.com 
 mailto:jonsm...@gmail.com jonsm...@gmail.com mailto:jonsm...@gmail.com 
 wrote:
 On Tue, Sep 30, 2014 at 12:21 PM, Hans de Goede hdego...@redhat.com 
 mailto:hdego...@redhat.com wrote:
  Hi All,
 
  I think we should start an errata page on the linux-sunxi wiki somewhere,
  specifically targeting errata for the official user manual documents.
 
 Why not issue tracking on the github account Allwinner made?
 https://github.com/allwinner-zh/documents/issues 
 https://github.com/allwinner-zh/documents/issues
 
 I'd like to see Allwinner get used to responding to a normal issues
 tracking system.
 
 
 Ideally, Allwinner should update the PDF documents once errors/omissions are 
 found.
 I do not know how fast they can attend to such issues, so it is important to 
 find out.
 
 The second option is to maintain errata files on 
 https://github.com/allwinner-zh/documents/ 
 https://github.com/allwinner-zh/documents/
 for each SoC. 
 For the current issue for the A20, we create a new file into 
 https://github.com/allwinner-zh/documents/tree/master/A20 
 https://github.com/allwinner-zh/documents/tree/master/A20
 called errata_datasheet.txt/errata_usermanual.txt and add the text that 
 describes what is changed.
 Then we sent a pull request so that Allwinner would merely need to click a 
 button at github.com http://github.com/ to accept the change.
 Then, they can take their time to update the original PDF docs. When that 
 happens, we clear the errata files.
 
 If however Allwinner would prefer the community to do all the work with the 
 errata files,
 then the github.com http://github.com/ account for allwinner-zh could be 
 converted into an organization account,
 and then they can add a few of our github user accounts as members of the 
 documents repository.
 This means that we can deal with errata documents completely by ourselves, 
 and let Allwinner
 add those changes into future revisions of the documents.
 
 If the above make sense, we can suggest them to Allwinner. 
 Are we OK with that?
 
 Simos
 
 
 
  I know we already have various pages to document specific blocks, the
  idea here would be to have a general errata page. The purpose is to have
  a single place to gather doc fixes for blocks which are adequately
  documented in the user-manual, except for one or two missing bits.
 
  IMHO it is not worth the trouble / useful to create an entire new page
  for cases where we're talking about just 1-2 bits. But it would be
  useful to gather these little fixes somewhere, hence the suggestion
  to have a generic errata page. For blocks for which we already have
  extensive documentation in the wiki, this generic page can contain
  links to the documentation for these blocks.
 
  So good or bad idea ?
 
  And if you believe this is a good idea, any suggestions for a name /
  hierarchy for these pages ?
 
  ###
 
  The specific case triggering this idea is the lack of documentation
  for bits 10-12 of the GMAC clk register (0x01c20164). I've been in
  contact with allwinner about these 3 bits, and they configure
  the GMAC Transmit Clock Delay Chain (GTXDC), they are the transmit
  equivalent of bits 5-7.
 
  Regards,
 
  Hans
 
  --
  You received this message because you are subscribed to the Google Groups
  linux-sunxi group.
  To unsubscribe from this group and stop receiving emails from it, send an
  email to linux-sunxi+unsubscr...@googlegroups.com 
  mailto:linux-sunxi%2bunsubscr...@googlegroups.com.
  For more options, visit https://groups.google.com/d/optout 
  https://groups.google.com/d/optout.
 
 
 
 --
 Jon Smirl
 jonsm...@gmail.com mailto:jonsm...@gmail.com
 
 --
 You received this message because you are subscribed to the Google Groups 
 linux-sunxi group.
 To unsubscribe from this group and stop receiving emails from it, send an 
 email to linux-sunxi+unsubscr...@googlegroups.com 
 mailto:linux-sunxi%2bunsubscr...@googlegroups.com.
 For more options, visit https://groups.google.com/d/optout 
 https://groups.google.com/d/optout.
 
 
 -- 
 You received this message because you are subscribed to the Google Groups 
 linux-sunxi group.
 To unsubscribe from this group and stop receiving emails from it, send an 
 email to linux-sunxi+unsubscr...@googlegroups.com 
 mailto:linux-sunxi+unsubscr...@googlegroups.com.
 For more options, visit https://groups.google.com/d/optout 
 https://groups.google.com/d/optout.

-- 
You received this message because you are subscribed to the Google Groups 
linux-sunxi group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to linux-sunxi+unsubscr...@googlegroups.com.
For more 

Re: [linux-sunxi] Wiki page to track allwinner datasheets (user manual) errata

2014-10-01 Thread Luc Verhaegen
On Wed, Oct 01, 2014 at 09:04:36AM +0200, Hans de Goede wrote:
 Hi,
 
 Sounds good. Unfortunately I've come to the conclusion that I'm way too
 busy lately, and that I've to better prioritize things (and actually
 drop low priority items after setting priorities).
 
 I'm afraid this item has been put on the to be dropped list. I'm sorry
 (really I am). I hope someone else can pick this up.
 
 Regards,
 
 Hans

I already found it, let's call it, out of place, when you offered to 
work the wiki.

Luc Verhaegen.

-- 
You received this message because you are subscribed to the Google Groups 
linux-sunxi group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to linux-sunxi+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.


[linux-sunxi] Wiki page to track allwinner datasheets (user manual) errata

2014-09-30 Thread Hans de Goede

Hi All,

I think we should start an errata page on the linux-sunxi wiki somewhere,
specifically targeting errata for the official user manual documents.

I know we already have various pages to document specific blocks, the
idea here would be to have a general errata page. The purpose is to have
a single place to gather doc fixes for blocks which are adequately
documented in the user-manual, except for one or two missing bits.

IMHO it is not worth the trouble / useful to create an entire new page
for cases where we're talking about just 1-2 bits. But it would be
useful to gather these little fixes somewhere, hence the suggestion
to have a generic errata page. For blocks for which we already have
extensive documentation in the wiki, this generic page can contain
links to the documentation for these blocks.

So good or bad idea ?

And if you believe this is a good idea, any suggestions for a name /
hierarchy for these pages ?

###

The specific case triggering this idea is the lack of documentation
for bits 10-12 of the GMAC clk register (0x01c20164). I've been in
contact with allwinner about these 3 bits, and they configure
the GMAC Transmit Clock Delay Chain (GTXDC), they are the transmit
equivalent of bits 5-7.

Regards,

Hans

--
You received this message because you are subscribed to the Google Groups 
linux-sunxi group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to linux-sunxi+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.


Re: [linux-sunxi] Wiki page to track allwinner datasheets (user manual) errata

2014-09-30 Thread Luc Verhaegen
On Tue, Sep 30, 2014 at 06:21:18PM +0200, Hans de Goede wrote:
 Hi All,

 I think we should start an errata page on the linux-sunxi wiki somewhere,
 specifically targeting errata for the official user manual documents.

 I know we already have various pages to document specific blocks, the
 idea here would be to have a general errata page. The purpose is to have
 a single place to gather doc fixes for blocks which are adequately
 documented in the user-manual, except for one or two missing bits.

 IMHO it is not worth the trouble / useful to create an entire new page
 for cases where we're talking about just 1-2 bits. But it would be
 useful to gather these little fixes somewhere, hence the suggestion
 to have a generic errata page. For blocks for which we already have
 extensive documentation in the wiki, this generic page can contain
 links to the documentation for these blocks.

 So good or bad idea ?

 And if you believe this is a good idea, any suggestions for a name /
 hierarchy for these pages ?

 ###

 The specific case triggering this idea is the lack of documentation
 for bits 10-12 of the GMAC clk register (0x01c20164). I've been in
 contact with allwinner about these 3 bits, and they configure
 the GMAC Transmit Clock Delay Chain (GTXDC), they are the transmit
 equivalent of bits 5-7.

 Regards,

 Hans

Sounds like a plan.

Let's start out with something like this:

Start with a page called documentation or something.

Then start listing the datasheets, one section per chipset (single =) 
on that page. 

Have the device pages link to those sections.

Then have a per chipset errata page reachable from each chipset specific 
section.

We will see where to go from there.

Luc Verhaegen.

-- 
You received this message because you are subscribed to the Google Groups 
linux-sunxi group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to linux-sunxi+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.


Re: [linux-sunxi] Wiki page to track allwinner datasheets (user manual) errata

2014-09-30 Thread jonsm...@gmail.com
On Tue, Sep 30, 2014 at 12:21 PM, Hans de Goede hdego...@redhat.com wrote:
 Hi All,

 I think we should start an errata page on the linux-sunxi wiki somewhere,
 specifically targeting errata for the official user manual documents.

Why not issue tracking on the github account Allwinner made?
https://github.com/allwinner-zh/documents/issues

I'd like to see Allwinner get used to responding to a normal issues
tracking system.



 I know we already have various pages to document specific blocks, the
 idea here would be to have a general errata page. The purpose is to have
 a single place to gather doc fixes for blocks which are adequately
 documented in the user-manual, except for one or two missing bits.

 IMHO it is not worth the trouble / useful to create an entire new page
 for cases where we're talking about just 1-2 bits. But it would be
 useful to gather these little fixes somewhere, hence the suggestion
 to have a generic errata page. For blocks for which we already have
 extensive documentation in the wiki, this generic page can contain
 links to the documentation for these blocks.

 So good or bad idea ?

 And if you believe this is a good idea, any suggestions for a name /
 hierarchy for these pages ?

 ###

 The specific case triggering this idea is the lack of documentation
 for bits 10-12 of the GMAC clk register (0x01c20164). I've been in
 contact with allwinner about these 3 bits, and they configure
 the GMAC Transmit Clock Delay Chain (GTXDC), they are the transmit
 equivalent of bits 5-7.

 Regards,

 Hans

 --
 You received this message because you are subscribed to the Google Groups
 linux-sunxi group.
 To unsubscribe from this group and stop receiving emails from it, send an
 email to linux-sunxi+unsubscr...@googlegroups.com.
 For more options, visit https://groups.google.com/d/optout.



-- 
Jon Smirl
jonsm...@gmail.com

-- 
You received this message because you are subscribed to the Google Groups 
linux-sunxi group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to linux-sunxi+unsubscr...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.