Re: [PATCH v5 1/3] fpga: xilinx-spi: extract a common driver core

From: Xu Yilun <yilun.xu@linux.intel.com>
To: Charles Perry <charles.perry@savoirfairelinux.com>
Cc: mdf@kernel.org, avandiver@markem-imaje.com,
	bcody@markem-imaje.com, Wu Hao <hao.wu@intel.com>,
	Xu Yilun <yilun.xu@intel.com>, Tom Rix <trix@redhat.com>,
	Rob Herring <robh+dt@kernel.org>,
	Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
	Conor Dooley <conor+dt@kernel.org>,
	Michal Simek <michal.simek@amd.com>,
	linux-fpga@vger.kernel.org, devicetree@vger.kernel.org,
	linux-kernel@vger.kernel.org,
	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 12:20:15 +0800	[thread overview]
Message-ID: <ZfkSf6QG5nIY0zpx@yilunxu-OptiPlex-7050> (raw)
In-Reply-To: <20240313225746.489253-2-charles.perry@savoirfairelinux.com>

> +/**
> + * 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"

> + */
> +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