Takashi Iwai f6bf63
From 46dd6078dbc7e363a8bb01209da67015a1538929 Mon Sep 17 00:00:00 2001
Takashi Iwai f6bf63
From: Randy Dunlap <rdunlap@infradead.org>
Takashi Iwai f6bf63
Date: Sun, 23 Apr 2023 06:48:45 +0100
Takashi Iwai f6bf63
Subject: [PATCH] ARM: 9296/1: HP Jornada 7XX: fix kernel-doc warnings
Takashi Iwai f6bf63
Git-commit: 46dd6078dbc7e363a8bb01209da67015a1538929
Takashi Iwai f6bf63
Patch-mainline: v6.4-rc2
Takashi Iwai f6bf63
References: git-fixes
Takashi Iwai f6bf63
Takashi Iwai f6bf63
Fix kernel-doc warnings from the kernel test robot:
Takashi Iwai f6bf63
Takashi Iwai f6bf63
jornada720_ssp.c:24: warning: Function parameter or member 'jornada_ssp_lock' not described in 'DEFINE_SPINLOCK'
Takashi Iwai f6bf63
jornada720_ssp.c:24: warning: expecting prototype for arch/arm/mac(). Prototype was for DEFINE_SPINLOCK() instead
Takashi Iwai f6bf63
jornada720_ssp.c:34: warning: Function parameter or member 'byte' not described in 'jornada_ssp_reverse'
Takashi Iwai f6bf63
jornada720_ssp.c:57: warning: Function parameter or member 'byte' not described in 'jornada_ssp_byte'
Takashi Iwai f6bf63
jornada720_ssp.c:85: warning: Function parameter or member 'byte' not described in 'jornada_ssp_inout'
Takashi Iwai f6bf63
Takashi Iwai f6bf63
Link: lore.kernel.org/r/202304210535.tWby3jWF-lkp@intel.com
Takashi Iwai f6bf63
Takashi Iwai f6bf63
Fixes: 69ebb22277a5 ("[ARM] 4506/1: HP Jornada 7XX: Addition of SSP Platform Driver")
Takashi Iwai f6bf63
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Takashi Iwai f6bf63
Reported-by: kernel test robot <lkp@intel.com>
Takashi Iwai f6bf63
Cc: Arnd Bergmann <arnd@arndb.de>
Takashi Iwai f6bf63
Cc: Kristoffer Ericson <Kristoffer.ericson@gmail.com>
Takashi Iwai f6bf63
Cc: patches@armlinux.org.uk
Takashi Iwai f6bf63
Signed-off-by: Russell King (Oracle) <rmk+kernel@armlinux.org.uk>
Takashi Iwai f6bf63
Acked-by: Takashi Iwai <tiwai@suse.de>
Takashi Iwai f6bf63
Takashi Iwai f6bf63
---
Takashi Iwai f6bf63
 arch/arm/mach-sa1100/jornada720_ssp.c | 5 ++++-
Takashi Iwai f6bf63
 1 file changed, 4 insertions(+), 1 deletion(-)
Takashi Iwai f6bf63
Takashi Iwai f6bf63
diff --git a/arch/arm/mach-sa1100/jornada720_ssp.c b/arch/arm/mach-sa1100/jornada720_ssp.c
Takashi Iwai f6bf63
index 1dbe98948ce3..9627c4cf3e41 100644
Takashi Iwai f6bf63
--- a/arch/arm/mach-sa1100/jornada720_ssp.c
Takashi Iwai f6bf63
+++ b/arch/arm/mach-sa1100/jornada720_ssp.c
Takashi Iwai f6bf63
@@ -1,5 +1,5 @@
Takashi Iwai f6bf63
 // SPDX-License-Identifier: GPL-2.0-only
Takashi Iwai f6bf63
-/**
Takashi Iwai f6bf63
+/*
Takashi Iwai f6bf63
  *  arch/arm/mac-sa1100/jornada720_ssp.c
Takashi Iwai f6bf63
  *
Takashi Iwai f6bf63
  *  Copyright (C) 2006/2007 Kristoffer Ericson <Kristoffer.Ericson@gmail.com>
Takashi Iwai f6bf63
@@ -26,6 +26,7 @@ static unsigned long jornada_ssp_flags;
Takashi Iwai f6bf63
 
Takashi Iwai f6bf63
 /**
Takashi Iwai f6bf63
  * jornada_ssp_reverse - reverses input byte
Takashi Iwai f6bf63
+ * @byte: input byte to reverse
Takashi Iwai f6bf63
  *
Takashi Iwai f6bf63
  * we need to reverse all data we receive from the mcu due to its physical location
Takashi Iwai f6bf63
  * returns : 01110111 -> 11101110
Takashi Iwai f6bf63
@@ -46,6 +47,7 @@ EXPORT_SYMBOL(jornada_ssp_reverse);
Takashi Iwai f6bf63
 
Takashi Iwai f6bf63
 /**
Takashi Iwai f6bf63
  * jornada_ssp_byte - waits for ready ssp bus and sends byte
Takashi Iwai f6bf63
+ * @byte: input byte to transmit
Takashi Iwai f6bf63
  *
Takashi Iwai f6bf63
  * waits for fifo buffer to clear and then transmits, if it doesn't then we will
Takashi Iwai f6bf63
  * timeout after <timeout> rounds. Needs mcu running before its called.
Takashi Iwai f6bf63
@@ -77,6 +79,7 @@ EXPORT_SYMBOL(jornada_ssp_byte);
Takashi Iwai f6bf63
 
Takashi Iwai f6bf63
 /**
Takashi Iwai f6bf63
  * jornada_ssp_inout - decide if input is command or trading byte
Takashi Iwai f6bf63
+ * @byte: input byte to send (may be %TXDUMMY)
Takashi Iwai f6bf63
  *
Takashi Iwai f6bf63
  * returns : (jornada_ssp_byte(byte)) on success
Takashi Iwai f6bf63
  *         : %-ETIMEDOUT on timeout failure
Takashi Iwai f6bf63
-- 
Takashi Iwai f6bf63
2.35.3
Takashi Iwai f6bf63