Re: [PATCH v9 4/5] PCI: rcar-gen4: Add support for r8a779g0

["Krzysztof Wilczyński" <kw@linux.com>]

> > > +/*
> > > + * The attached firmware file "104_PCIe_fw_addr_data_ver1.05.txt" in
> > > + * the datasheet is a text file. But, Renesas is not able to distribute
> > > + * the firmware freely. So, we require converting the text file
> > > + * to a binary before the driver runs by using the following script:
> > > + *
> > > + * $ awk '/^\s*0x[0-9A-Fa-f]{4}\s+0x[0-9A-Fa-f]{4}/ \
> > > + *      { print substr($2,5,2) substr($2,3,2) }' \
> > > + *      104_PCIe_fw_addr_data_ver1.05.txt | xxd -p -r > \
> > > + *      rcar_gen4_pcie.bin
> > > + *    $ sha1sum rcar_gen4_pcie.bin
> > > + *      1d0bd4b189b4eb009f5d564b1f93a79112994945  rcar_gen4_pcie.bin
> > > + */
> > 
> > I moved this comment to the top of the file, since it serves as more of
> > a documentation bit for the controller itself, and is not specific to the
> > function it was attached to, strictly speaking.
> 
> I got it. Thank you.

I decided to drop this comment.  See below.

> > That said, I wonder if we should include this at all?  The file name might
> > and most likely will eventually change, as the datasheet gets updated to
> > include new revisions and erratas, etc.
> > 
> > So, I wonder if this is simply better to be included in the datasheet
> > itself, or some product guide and such, where Renesas can keep this up to
> > date and the users appraised of what they need to do to convert the
> > firmware correctly.
> 
> I understood it. I'll consider it somehow...

After thinking about this a little more, I believe that it might be better
to follow what some other drivers have done, and simply add this guide as
a text file under a dedicated ../Documentation/admin-guide directory.

We can then mention, or not, at the top of the file that there is a guide
available at this location for people to read on how to obtain and prepare
the firmware.

Thoughts?

	Krzysztof