From: Charles Perry <charles.perry@savoirfairelinux.com>
To: Xu Yilun <yilun.xu@linux.intel.com>
Cc: mdf <mdf@kernel.org>, Allen VANDIVER <avandiver@markem-imaje.com>,
Brian CODY <bcody@markem-imaje.com>, hao wu <hao.wu@intel.com>,
yilun xu <yilun.xu@intel.com>, Tom Rix <trix@redhat.com>,
Rob Herring <robh+dt@kernel.org>,
krzysztof kozlowski+dt <krzysztof.kozlowski+dt@linaro.org>,
Conor Dooley <conor+dt@kernel.org>,
Michal Simek <michal.simek@amd.com>,
linux-fpga <linux-fpga@vger.kernel.org>,
devicetree <devicetree@vger.kernel.org>,
linux-kernel <linux-kernel@vger.kernel.org>,
linux-arm-kernel <linux-arm-kernel@lists.infradead.org>
Subject: Re: [PATCH v5 1/3] fpga: xilinx-spi: extract a common driver core
Date: Tue, 19 Mar 2024 09:18:14 -0400 (EDT) [thread overview]
Message-ID: <2023855820.1872598.1710854294497.JavaMail.zimbra@savoirfairelinux.com> (raw)
In-Reply-To: <ZfkSf6QG5nIY0zpx@yilunxu-OptiPlex-7050>
On Mar 19, 2024, at 12:20 AM, Xu Yilun yilun.xu@linux.intel.com wrote:
>> +/**
>> + * struct xilinx_fpga_core - interface between the driver and the core manager
>> + * of Xilinx 7 Series FPGA manager
>> + * @dev: device node
>> + * @write: write callback of the driver
>> + * @prog_b: PROGRAM_B gpio descriptor
>> + * @init_b: INIT_B gpio descriptor
>> + * @done: DONE gpio descriptor
>
> Please re-check the Documentation again:
> "Structure fields that are inside a private: area are not listed in the
> generated output documentation"
>
I did generate the documentation for that struct and saw that the
private fields are indeed removed. This hinted me into thinking that
I should keep the private kernel-doc, because it's the generator job
to remove those. Looking again at the kernel-doc.rst example on that
topic, I understand that this is not the case, will fix.
>> + */
>> +struct xilinx_fpga_core {
>> +/* public: */
>> + struct device *dev;
>> + int (*write)(struct xilinx_fpga_core *core, const char *buf,
>> + size_t count);
>> +/* private: handled by xilinx-core */
>> + struct gpio_desc *prog_b;
>> + struct gpio_desc *init_b;
>> + struct gpio_desc *done;
>> +};
>> +
> [...]
>> -
>> static int xilinx_spi_probe(struct spi_device *spi)
>> {
>> - struct xilinx_spi_conf *conf;
>> - struct fpga_manager *mgr;
>> + struct xilinx_fpga_core *conf;
>
> Why do you name it conf? Maybe "core" is better?
>
> Thanks,
> Yilun
Yes, I changed the type but not the name.
Thank you for the review,
Charles
next prev parent reply other threads:[~2024-03-19 13:18 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-13 22:57 [PATCH v5 0/3] fpga: xilinx-selectmap: add new driver Charles Perry
2024-03-13 22:57 ` [PATCH v5 1/3] fpga: xilinx-spi: extract a common driver core Charles Perry
2024-03-19 4:20 ` Xu Yilun
2024-03-19 13:18 ` Charles Perry [this message]
2024-03-13 22:57 ` [PATCH v5 2/3] dt-bindings: fpga: xlnx,fpga-selectmap: add DT schema Charles Perry
2024-03-14 7:02 ` Krzysztof Kozlowski
2024-03-13 22:57 ` [PATCH v5 3/3] fpga: xilinx-selectmap: add new driver Charles Perry
2024-03-19 6:35 ` Xu Yilun
2024-03-19 13:05 ` Charles Perry
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=2023855820.1872598.1710854294497.JavaMail.zimbra@savoirfairelinux.com \
--to=charles.perry@savoirfairelinux.com \
--cc=avandiver@markem-imaje.com \
--cc=bcody@markem-imaje.com \
--cc=conor+dt@kernel.org \
--cc=devicetree@vger.kernel.org \
--cc=hao.wu@intel.com \
--cc=krzysztof.kozlowski+dt@linaro.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-fpga@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mdf@kernel.org \
--cc=michal.simek@amd.com \
--cc=robh+dt@kernel.org \
--cc=trix@redhat.com \
--cc=yilun.xu@intel.com \
--cc=yilun.xu@linux.intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).