Received-SPF: pass (google.com: domain of linux-kernel+bounces-107579-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:45e3:2400::1 as permitted sender) client-ip=2604:1380:45e3:2400::1;
Date: Tue, 19 Mar 2024 09:18:14 -0400 (EDT)
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>
Message-ID: <2023855820.1872598.1710854294497.JavaMail.zimbra@savoirfairelinux.com>
In-Reply-To: <ZfkSf6QG5nIY0zpx@yilunxu-OptiPlex-7050>
References: <20240313225746.489253-1-charles.perry@savoirfairelinux.com> <20240313225746.489253-2-charles.perry@savoirfairelinux.com> <ZfkSf6QG5nIY0zpx@yilunxu-OptiPlex-7050>
Subject: Re: [PATCH v5 1/3] fpga: xilinx-spi: extract a common driver core
Precedence: bulk
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit
Thread-Topic: fpga: xilinx-spi: extract a common driver core
Thread-Index: tkWcNpo3mWp8g/EUE0xd2oh6sbVbuw==


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