Re: [PATCH v2 3/9] tty: n_gsm: add missing description to gsm_config

[Jiri Slaby]

On 20. 04. 23, 10:50, D. Starke wrote:
> From: Daniel Starke <daniel.starke@xxxxxxxxxxx>
>
> Currently, all available structure fields in gsmmux.h except those
> for gsm_config are commented.
>
> Fix this by adding appropriate comments to the not commented fields.
> Note that 'mru' and 'mtu' refer to the size without basic/advanced option
> mode header and byte stuffing as defined in the standard in chapter 5.7.2.

Maybe you can start documenting them using kernel-doc? And convert the 
others and expose them all to Documentation and finally to:
https://www.kernel.org/doc/html/latest/
?

> Link: https://portal.3gpp.org/desktopmodules/Specifications/SpecificationDetails.aspx?specificationId=1516
> Signed-off-by: Daniel Starke <daniel.starke@xxxxxxxxxxx>
> ---
>   include/uapi/linux/gsmmux.h | 22 +++++++++++-----------
>   1 file changed, 11 insertions(+), 11 deletions(-)
>
> v1 -> v2:
> Added remark regarding the mru/mtu size comment as this was unclear in the
> review.
>
> Link: https://lore.kernel.org/all/AS4PR10MB5895ADDAF211A669CCF7F8C5E0919@xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/
>
> diff --git a/include/uapi/linux/gsmmux.h b/include/uapi/linux/gsmmux.h
> index 33ee7b857c52..422a52e184b3 100644
> --- a/include/uapi/linux/gsmmux.h
> +++ b/include/uapi/linux/gsmmux.h
> @@ -8,17 +8,17 @@
>   
>   struct gsm_config
>   {
> -	unsigned int adaption;
> -	unsigned int encapsulation;
> -	unsigned int initiator;
> -	unsigned int t1;
> -	unsigned int t2;
> -	unsigned int t3;
> -	unsigned int n2;
> -	unsigned int mru;
> -	unsigned int mtu;
> -	unsigned int k;
> -	unsigned int i;
> +	unsigned int adaption;	/* Convergence layer type */
> +	unsigned int encapsulation; /* Framing (0 = basic option, 1 = advanced option) */
> +	unsigned int initiator;	/* Initiator or responder */
> +	unsigned int t1;	/* Acknowledgment timer */
> +	unsigned int t2;	/* Response timer for multiplexer control channel */
> +	unsigned int t3;	/* Response timer for wake-up procedure */
> +	unsigned int n2;	/* Maximum number of retransmissions */
> +	unsigned int mru;	/* Maximum incoming frame payload size */
> +	unsigned int mtu;	/* Maximum outgoing frame payload size */
> +	unsigned int k;		/* Window size */
> +	unsigned int i;		/* Frame type (1 = UIH, 2 = UI) */
>   	unsigned int unused[8];	/* Can not be used */
>   };
>   

--
js
suse labs