Date:   Fri, 17 Feb 2023 10:49:09 +0100
From:   Greg KH <gregkh@linuxfoundation.org>
To:     Florian Eckert <fe@dev.tdt.de>
Cc:     u.kleine-koenig@pengutronix.de, jirislaby@kernel.org, pavel@ucw.cz,
        lee@kernel.org, linux-kernel@vger.kernel.org,
        linux-leds@vger.kernel.org, Eckert.Florian@googlemail.com
Subject: Re: [PATCH v2 1/2] tty: new helper function tty_get_mget
Message-ID: <Y+9Nldv99/YoMK8Y@kroah.com>
References: <20230217094403.1574468-1-fe@dev.tdt.de>
 <20230217094403.1574468-2-fe@dev.tdt.de>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <20230217094403.1574468-2-fe@dev.tdt.de>
Precedence: bulk

On Fri, Feb 17, 2023 at 10:44:02AM +0100, Florian Eckert wrote:
> For a given struct tty_struct, this provides the appropriate tty line
> state flags needed to add more modes to the ledtrig-tty trigger.
> 
> The new function is then used to get via tty_tiocmget() the different tty
> line states.
> 
> Signed-off-by: Florian Eckert <fe@dev.tdt.de>
> ---
>  drivers/tty/tty_io.c | 30 +++++++++++++++++++++++-------
>  include/linux/tty.h  |  1 +
>  2 files changed, 24 insertions(+), 7 deletions(-)
> 
> diff --git a/drivers/tty/tty_io.c b/drivers/tty/tty_io.c
> index 3149114bf130..f049ab8b3362 100644
> --- a/drivers/tty/tty_io.c
> +++ b/drivers/tty/tty_io.c
> @@ -2493,26 +2493,42 @@ static int send_break(struct tty_struct *tty, unsigned int duration)
>  	return retval;
>  }
>  
> +/*
> + * tty_get_mget		-	get modem status
> + * @tty: tty device
> + *
> + * Obtain the modem status bits from the tty driver if the feature
> + * is supported. Return -ENOTTY if it is not available.

Please make this proper kernel doc, the first comment line has to be /**

And you didn't mark -ENOTTY properly here either :(

> + */
> +int tty_get_mget(struct tty_struct *tty)
> +{
> +	int retval = -ENOTTY;
> +
> +	if (tty->ops->tiocmget)
> +		retval = tty->ops->tiocmget(tty);
> +
> +	return retval;
> +}
> +EXPORT_SYMBOL_GPL(tty_get_mget);
> +
>  /**
>   * tty_tiocmget		-	get modem status
>   * @tty: tty device
>   * @p: pointer to result
>   *
>   * Obtain the modem status bits from the tty driver if the feature is
> - * supported. Return -%ENOTTY if it is not available.
> + * supported.

Why did you remove the return value statement from the documentation
here?  It's still true, right?

thanks,

greg k-h