This patch series fixes the coding style and kernel-doc issues
exists in the fpga framework, zynq and ZynqMP drivers.
Nava kishore Manne (5):
fpga: zynq: Fix incorrect variable type
fpga: fix for coding style issues
fpga: fpga-mgr: fix kernel-doc warnings
fpga: Use tab instead of space indentation
fpga: fpga-region: fix kernel-doc formatting issues
drivers/fpga/Makefile | 6 +++---
drivers/fpga/fpga-mgr.c | 13 +++++++++----
drivers/fpga/fpga-region.c | 6 +++---
drivers/fpga/of-fpga-region.c | 22 ++++++++++++----------
drivers/fpga/zynq-fpga.c | 2 +-
include/linux/fpga/fpga-region.h | 6 +++---
6 files changed, 31 insertions(+), 24 deletions(-)
--
2.25.1
zynq_fpga_has_sync () API is expecting "u8 *" but the
formal parameter that was passed is of type "const char *".
fix this issue by changing the buf type to "const char *"
Signed-off-by: Nava kishore Manne <[email protected]>
Acked-by: Xu Yilun <[email protected]>
---
Changes for v2:
-None.
Changes for v3:
- Changed arg buf type to "const char *" as suggested by Tom.
- update zynq_fpga_has_sync () API description to align with API
functionality.
Changes for v4:
- None.
Changes for v5:
- Dropped the irrelevant doc update changes.
Changes for v6:
- None.
drivers/fpga/zynq-fpga.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/drivers/fpga/zynq-fpga.c b/drivers/fpga/zynq-fpga.c
index 426aa34c6a0d..6beaba9dfe97 100644
--- a/drivers/fpga/zynq-fpga.c
+++ b/drivers/fpga/zynq-fpga.c
@@ -239,7 +239,7 @@ static irqreturn_t zynq_fpga_isr(int irq, void *data)
* the correct byte order, and be dword aligned. The input is a Xilinx .bin
* file with every 32 bit quantity swapped.
*/
-static bool zynq_fpga_has_sync(const u8 *buf, size_t count)
+static bool zynq_fpga_has_sync(const char *buf, size_t count)
{
for (; count >= 4; buf += 4, count -= 4)
if (buf[0] == 0x66 && buf[1] == 0x55 && buf[2] == 0x99 &&
--
2.25.1
warnings: No description found for return value of 'xxx'
In-order to fix the above kernel-doc warnings added the
'Return' description for 'devm_fpga_mgr_register_full()'
and 'devm_fpga_mgr_register()' APIs.
Signed-off-by: Nava kishore Manne <[email protected]>
Acked-by: Xu Yilun <[email protected]>
---
Changes for v2:
-Replaced s/@return:/Return:/
Changes for v3:
-Updated commit description.
Changes for v4:
-Updated commit description.
Changes for v5:
-Updated commit description.
Changes for v6:
-None.
drivers/fpga/fpga-mgr.c | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/drivers/fpga/fpga-mgr.c b/drivers/fpga/fpga-mgr.c
index 24dee27c7897..a3595ecc3f79 100644
--- a/drivers/fpga/fpga-mgr.c
+++ b/drivers/fpga/fpga-mgr.c
@@ -731,6 +731,8 @@ static void devm_fpga_mgr_unregister(struct device *dev, void *res)
* @parent: fpga manager device from pdev
* @info: parameters for fpga manager
*
+ * Return: fpga manager pointer on success, negative error code otherwise.
+ *
* This is the devres variant of fpga_mgr_register_full() for which the unregister
* function will be called automatically when the managing device is detached.
*/
@@ -764,6 +766,8 @@ EXPORT_SYMBOL_GPL(devm_fpga_mgr_register_full);
* @mops: pointer to structure of fpga manager ops
* @priv: fpga manager private data
*
+ * Return: fpga manager pointer on success, negative error code otherwise.
+ *
* This is the devres variant of fpga_mgr_register() for which the
* unregister function will be called automatically when the managing
* device is detached.
--
2.25.1
In FPGA Makefile has both space and tab indentation, to
make them align use tab instead of space indentation.
Signed-off-by: Nava kishore Manne <[email protected]>
Acked-by: Xu Yilun <[email protected]>
---
Changes for v2:
-None.
Changes for v3:
-Updated commit description.
Changes for v4:
-None.
Changes for v5:
-Updated commit description.
Changes for v6:
-None.
drivers/fpga/Makefile | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/drivers/fpga/Makefile b/drivers/fpga/Makefile
index 0bff783d1b61..5935b3d0abd5 100644
--- a/drivers/fpga/Makefile
+++ b/drivers/fpga/Makefile
@@ -18,9 +18,9 @@ obj-$(CONFIG_FPGA_MGR_TS73XX) += ts73xx-fpga.o
obj-$(CONFIG_FPGA_MGR_XILINX_SPI) += xilinx-spi.o
obj-$(CONFIG_FPGA_MGR_ZYNQ_FPGA) += zynq-fpga.o
obj-$(CONFIG_FPGA_MGR_ZYNQMP_FPGA) += zynqmp-fpga.o
-obj-$(CONFIG_FPGA_MGR_VERSAL_FPGA) += versal-fpga.o
-obj-$(CONFIG_ALTERA_PR_IP_CORE) += altera-pr-ip-core.o
-obj-$(CONFIG_ALTERA_PR_IP_CORE_PLAT) += altera-pr-ip-core-plat.o
+obj-$(CONFIG_FPGA_MGR_VERSAL_FPGA) += versal-fpga.o
+obj-$(CONFIG_ALTERA_PR_IP_CORE) += altera-pr-ip-core.o
+obj-$(CONFIG_ALTERA_PR_IP_CORE_PLAT) += altera-pr-ip-core-plat.o
# FPGA Bridge Drivers
obj-$(CONFIG_FPGA_BRIDGE) += fpga-bridge.o
--
2.25.1
fixes the below checks reported by checkpatch.pl:
- Lines should not end with a '('
- Alignment should match open parenthesis
Signed-off-by: Nava kishore Manne <[email protected]>
---
Changes for v2:
-None.
Changes for v3:
-Fixed similar issue exists in "drivers/fpga/*".
Changes for v4:
-None.
Changes for v5:
- Reduced the length of the 'fpga_mgr_write_init(...)' API
as suggested by Joe.
- To align Include declaration and definition of APIs updated
the FPGA-region.h file as suggested by joe.
- Fixed similar issue exists with of_fpga_region_parse_ov() API.
Changes for v6:
- Align the declaration and definition of APIs as suggested by
Yilun and Joe.
- Move the 'count' handling logic into 'else' block as suggested
by Yilun.
drivers/fpga/fpga-mgr.c | 9 +++++----
drivers/fpga/fpga-region.c | 6 +++---
drivers/fpga/of-fpga-region.c | 6 +++---
include/linux/fpga/fpga-region.h | 6 +++---
4 files changed, 14 insertions(+), 13 deletions(-)
diff --git a/drivers/fpga/fpga-mgr.c b/drivers/fpga/fpga-mgr.c
index d49a9ce34568..24dee27c7897 100644
--- a/drivers/fpga/fpga-mgr.c
+++ b/drivers/fpga/fpga-mgr.c
@@ -148,11 +148,12 @@ static int fpga_mgr_write_init_buf(struct fpga_manager *mgr,
int ret;
mgr->state = FPGA_MGR_STATE_WRITE_INIT;
- if (!mgr->mops->initial_header_size)
+ if (!mgr->mops->initial_header_size) {
ret = fpga_mgr_write_init(mgr, info, NULL, 0);
- else
- ret = fpga_mgr_write_init(
- mgr, info, buf, min(mgr->mops->initial_header_size, count));
+ } else {
+ count = min(mgr->mops->initial_header_size, count);
+ ret = fpga_mgr_write_init(mgr, info, buf, count);
+ }
if (ret) {
dev_err(&mgr->dev, "Error preparing FPGA for writing\n");
diff --git a/drivers/fpga/fpga-region.c b/drivers/fpga/fpga-region.c
index b0ac18de4885..485948e3c0db 100644
--- a/drivers/fpga/fpga-region.c
+++ b/drivers/fpga/fpga-region.c
@@ -18,9 +18,9 @@
static DEFINE_IDA(fpga_region_ida);
static struct class *fpga_region_class;
-struct fpga_region *fpga_region_class_find(
- struct device *start, const void *data,
- int (*match)(struct device *, const void *))
+struct fpga_region *
+fpga_region_class_find(struct device *start, const void *data,
+ int (*match)(struct device *, const void *))
{
struct device *dev;
diff --git a/drivers/fpga/of-fpga-region.c b/drivers/fpga/of-fpga-region.c
index 50b83057c048..a598d03626af 100644
--- a/drivers/fpga/of-fpga-region.c
+++ b/drivers/fpga/of-fpga-region.c
@@ -189,9 +189,9 @@ static int child_regions_with_firmware(struct device_node *overlay)
* fpga_image_info struct if there is an image to program.
* error code for invalid overlay.
*/
-static struct fpga_image_info *of_fpga_region_parse_ov(
- struct fpga_region *region,
- struct device_node *overlay)
+static struct fpga_image_info *
+of_fpga_region_parse_ov(struct fpga_region *region,
+ struct device_node *overlay)
{
struct device *dev = ®ion->dev;
struct fpga_image_info *info;
diff --git a/include/linux/fpga/fpga-region.h b/include/linux/fpga/fpga-region.h
index 3b87f232425c..9d4d32909340 100644
--- a/include/linux/fpga/fpga-region.h
+++ b/include/linux/fpga/fpga-region.h
@@ -52,9 +52,9 @@ struct fpga_region {
#define to_fpga_region(d) container_of(d, struct fpga_region, dev)
-struct fpga_region *fpga_region_class_find(
- struct device *start, const void *data,
- int (*match)(struct device *, const void *));
+struct fpga_region *
+fpga_region_class_find(struct device *start, const void *data,
+ int (*match)(struct device *, const void *));
int fpga_region_program_fpga(struct fpga_region *region);
--
2.25.1
On Sat, Apr 23, 2022 at 10:32:32PM +0530, Nava kishore Manne wrote:
> fixes the below checks reported by checkpatch.pl:
> - Lines should not end with a '('
> - Alignment should match open parenthesis
>
> Signed-off-by: Nava kishore Manne <[email protected]>
Acked-by: Xu Yilun <[email protected]>
> ---
> Changes for v2:
> -None.
> Changes for v3:
> -Fixed similar issue exists in "drivers/fpga/*".
> Changes for v4:
> -None.
> Changes for v5:
> - Reduced the length of the 'fpga_mgr_write_init(...)' API
> as suggested by Joe.
> - To align Include declaration and definition of APIs updated
> the FPGA-region.h file as suggested by joe.
> - Fixed similar issue exists with of_fpga_region_parse_ov() API.
>
> Changes for v6:
> - Align the declaration and definition of APIs as suggested by
> Yilun and Joe.
> - Move the 'count' handling logic into 'else' block as suggested
> by Yilun.
>
> drivers/fpga/fpga-mgr.c | 9 +++++----
> drivers/fpga/fpga-region.c | 6 +++---
> drivers/fpga/of-fpga-region.c | 6 +++---
> include/linux/fpga/fpga-region.h | 6 +++---
> 4 files changed, 14 insertions(+), 13 deletions(-)
>
> diff --git a/drivers/fpga/fpga-mgr.c b/drivers/fpga/fpga-mgr.c
> index d49a9ce34568..24dee27c7897 100644
> --- a/drivers/fpga/fpga-mgr.c
> +++ b/drivers/fpga/fpga-mgr.c
> @@ -148,11 +148,12 @@ static int fpga_mgr_write_init_buf(struct fpga_manager *mgr,
> int ret;
>
> mgr->state = FPGA_MGR_STATE_WRITE_INIT;
> - if (!mgr->mops->initial_header_size)
> + if (!mgr->mops->initial_header_size) {
> ret = fpga_mgr_write_init(mgr, info, NULL, 0);
> - else
> - ret = fpga_mgr_write_init(
> - mgr, info, buf, min(mgr->mops->initial_header_size, count));
> + } else {
> + count = min(mgr->mops->initial_header_size, count);
> + ret = fpga_mgr_write_init(mgr, info, buf, count);
> + }
>
> if (ret) {
> dev_err(&mgr->dev, "Error preparing FPGA for writing\n");
> diff --git a/drivers/fpga/fpga-region.c b/drivers/fpga/fpga-region.c
> index b0ac18de4885..485948e3c0db 100644
> --- a/drivers/fpga/fpga-region.c
> +++ b/drivers/fpga/fpga-region.c
> @@ -18,9 +18,9 @@
> static DEFINE_IDA(fpga_region_ida);
> static struct class *fpga_region_class;
>
> -struct fpga_region *fpga_region_class_find(
> - struct device *start, const void *data,
> - int (*match)(struct device *, const void *))
> +struct fpga_region *
> +fpga_region_class_find(struct device *start, const void *data,
> + int (*match)(struct device *, const void *))
> {
> struct device *dev;
>
> diff --git a/drivers/fpga/of-fpga-region.c b/drivers/fpga/of-fpga-region.c
> index 50b83057c048..a598d03626af 100644
> --- a/drivers/fpga/of-fpga-region.c
> +++ b/drivers/fpga/of-fpga-region.c
> @@ -189,9 +189,9 @@ static int child_regions_with_firmware(struct device_node *overlay)
> * fpga_image_info struct if there is an image to program.
> * error code for invalid overlay.
> */
> -static struct fpga_image_info *of_fpga_region_parse_ov(
> - struct fpga_region *region,
> - struct device_node *overlay)
> +static struct fpga_image_info *
> +of_fpga_region_parse_ov(struct fpga_region *region,
> + struct device_node *overlay)
> {
> struct device *dev = ®ion->dev;
> struct fpga_image_info *info;
> diff --git a/include/linux/fpga/fpga-region.h b/include/linux/fpga/fpga-region.h
> index 3b87f232425c..9d4d32909340 100644
> --- a/include/linux/fpga/fpga-region.h
> +++ b/include/linux/fpga/fpga-region.h
> @@ -52,9 +52,9 @@ struct fpga_region {
>
> #define to_fpga_region(d) container_of(d, struct fpga_region, dev)
>
> -struct fpga_region *fpga_region_class_find(
> - struct device *start, const void *data,
> - int (*match)(struct device *, const void *));
> +struct fpga_region *
> +fpga_region_class_find(struct device *start, const void *data,
> + int (*match)(struct device *, const void *));
>
> int fpga_region_program_fpga(struct fpga_region *region);
>
> --
> 2.25.1
On Sat, Apr 23, 2022 at 10:32:31PM +0530, Nava kishore Manne wrote:
> zynq_fpga_has_sync () API is expecting "u8 *" but the
> formal parameter that was passed is of type "const char *".
> fix this issue by changing the buf type to "const char *"
>
> Signed-off-by: Nava kishore Manne <[email protected]>
> Acked-by: Xu Yilun <[email protected]>
Hi Nava:
There is a lkp bug report yet to be fixed. Please fix it.
Thanks,
Yilun
> ---
> Changes for v2:
> -None.
> Changes for v3:
> - Changed arg buf type to "const char *" as suggested by Tom.
> - update zynq_fpga_has_sync () API description to align with API
> functionality.
> Changes for v4:
> - None.
>
> Changes for v5:
> - Dropped the irrelevant doc update changes.
> Changes for v6:
> - None.
>
> drivers/fpga/zynq-fpga.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/fpga/zynq-fpga.c b/drivers/fpga/zynq-fpga.c
> index 426aa34c6a0d..6beaba9dfe97 100644
> --- a/drivers/fpga/zynq-fpga.c
> +++ b/drivers/fpga/zynq-fpga.c
> @@ -239,7 +239,7 @@ static irqreturn_t zynq_fpga_isr(int irq, void *data)
> * the correct byte order, and be dword aligned. The input is a Xilinx .bin
> * file with every 32 bit quantity swapped.
> */
> -static bool zynq_fpga_has_sync(const u8 *buf, size_t count)
> +static bool zynq_fpga_has_sync(const char *buf, size_t count)
> {
> for (; count >= 4; buf += 4, count -= 4)
> if (buf[0] == 0x66 && buf[1] == 0x55 && buf[2] == 0x99 &&
> --
> 2.25.1