From patchwork Mon Apr 24 07:52:45 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "D. Starke" X-Patchwork-Id: 86895 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:b0ea:0:b0:3b6:4342:cba0 with SMTP id b10csp2585746vqo; Mon, 24 Apr 2023 01:26:53 -0700 (PDT) X-Google-Smtp-Source: AKy350ZsprL8DniW26h8V1mrokyyBYNakWqw/AZu2Mxq8wDBSLyZ7y4rZqcOIWqVZHcnYTPrfnLz X-Received: by 2002:a05:6a20:160d:b0:e7:7844:903a with SMTP id l13-20020a056a20160d00b000e77844903amr17597211pzj.53.1682324813335; Mon, 24 Apr 2023 01:26:53 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1682324813; cv=none; d=google.com; s=arc-20160816; b=p225I8ebt95YwDZfTUaMrUk/c5cKkNJ7wq+yot2XLvzKZ9e0ZqygATrOb9D+qIFYW/ a+3m4qG95DHHyojMtGGxphogigyC16ILhnrqm8A9qLBqXAK4Zg114RsPSbdr545AqZkk u0j8J9Lxl5oW9ikSi+Bo7PLL9dE5bMCLKe1Crsf6iHlmDg+pKHP09ppdujz8MlFzgwTZ X7YvzaYR2VXSDUhU0pk5raXDALLO98Qrrng4+MB6yhm++viadjv/J7Zw3tqRipzqc8Lf y26hfOZVpy5vJhfJG1aVCE4dbUVaKK2fUEthFSvCyBiGbazUUhqhAcKJlXgkP9n7xbTo cwxA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:feedback-id:content-transfer-encoding :mime-version:references:in-reply-to:message-id:date:subject:cc:to :from:dkim-signature; bh=cRH4nX3kvz4VCstupXacwcxAHkGzJLXypxwShXAZZ2M=; b=0J2xjIT8FKqiRaI45eFMkTbx3T5a0yKlwlGgd3TNZc4upxF3F9qw/FMPE4WcmCRaZK wtcJHzyJGbZBPbd8W259iD0QcAXZdu20iw7OI231HbHlca1vYcnDAwzXlb5eoM/5rnIq t8dUV/K9XeA9rdaO9j1Fs1C4KzLsgKO0deqwdjhexMp2/U9O6Kh4qu3t2+Wy+slijqez HmMydK3YuO4gfMWtjgUVLVDhSL3VgZAeJJGjZbUIUl2c1KsoZXPmj/5HHO9Hqu2ft2Hh hjVBcmnBnvRjkE/JNYRAvbrFkYCBtY1k6wM5DVawURc4XyOQoAKxm9oyaoD1xs6W3fhW 3xCQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@siemens.com header.s=fm1 header.b=kue6cTzm; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=siemens.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id b12-20020a63930c000000b00520db8892b9si8374073pge.41.2023.04.24.01.26.40; Mon, 24 Apr 2023 01:26:53 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@siemens.com header.s=fm1 header.b=kue6cTzm; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=siemens.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231464AbjDXHyl (ORCPT + 99 others); Mon, 24 Apr 2023 03:54:41 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:38802 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231328AbjDXHyk (ORCPT ); Mon, 24 Apr 2023 03:54:40 -0400 Received: from mta-64-228.siemens.flowmailer.net (mta-64-228.siemens.flowmailer.net [185.136.64.228]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 5AD95E65 for ; Mon, 24 Apr 2023 00:54:36 -0700 (PDT) Received: by mta-64-228.siemens.flowmailer.net with ESMTPSA id 20230424075434f1c1d3583ff7c18645 for ; Mon, 24 Apr 2023 09:54:34 +0200 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; s=fm1; d=siemens.com; i=daniel.starke@siemens.com; h=Date:From:Subject:To:Message-ID:MIME-Version:Content-Type:Content-Transfer-Encoding:Cc:References:In-Reply-To; bh=cRH4nX3kvz4VCstupXacwcxAHkGzJLXypxwShXAZZ2M=; b=kue6cTzmaDbSfYeW6YTZMOGBGGHNT040b0t12m37SYwKO0peb9FAPlTRUFA+WbICtx9wTt h/iR0Xaidy2Vl713gfMVstd6aZkyyyHi3YAp89KQPCWNYJM6A6lCHoc6ZSgeCG/mOGzZ11rW EkP7Ur4tFflpqlYqQCEl0sGqb8Krg=; From: "D. Starke" To: linux-serial@vger.kernel.org, gregkh@linuxfoundation.org, jirislaby@kernel.org, ilpo.jarvinen@linux.intel.com Cc: linux-kernel@vger.kernel.org, Daniel Starke Subject: [PATCH v3 2/8] tty: n_gsm: add missing description to gsm_config Date: Mon, 24 Apr 2023 09:52:45 +0200 Message-Id: <20230424075251.5216-2-daniel.starke@siemens.com> In-Reply-To: <20230424075251.5216-1-daniel.starke@siemens.com> References: <20230424075251.5216-1-daniel.starke@siemens.com> MIME-Version: 1.0 X-Flowmailer-Platform: Siemens Feedback-ID: 519:519-314044:519-21489:flowmailer X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIMWL_WL_MED, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_MSPIKE_H2, SPF_HELO_PASS,SPF_PASS,T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1764045423292116644?= X-GMAIL-MSGID: =?utf-8?q?1764045423292116644?= From: Daniel Starke 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. Converting the other fields to kernel doc format remains an open task for future patches. Link: https://portal.3gpp.org/desktopmodules/Specifications/SpecificationDetails.aspx?specificationId=1516 Signed-off-by: Daniel Starke --- include/uapi/linux/gsmmux.h | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) v2 -> v3: Changed added comments to kernel doc format as remarked in the review. Added remark regarding remaining documentation fields to commit message. Link: https://lore.kernel.org/all/ZEEd_oOvJYranmzN@kroah.com/ diff --git a/include/uapi/linux/gsmmux.h b/include/uapi/linux/gsmmux.h index 33ee7b857c52..d3b9b37a9082 100644 --- a/include/uapi/linux/gsmmux.h +++ b/include/uapi/linux/gsmmux.h @@ -6,6 +6,28 @@ #include #include +/** + * struct gsm_config - n_gsm basic configuration parameters + * + * This structure is used in combination with GSMIOC_GETCONF and GSMIOC_SETCONF + * to retrieve and set the basic parameters of an n_gsm ldisc. + * struct gsm_config_ext can be used to configure extended ldisc parameters. + * + * All timers are in units of 1/100th of a second. + * + * @adaption: Convergence layer type + * @encapsulation: Framing (0 = basic option, 1 = advanced option) + * @initiator: Initiator or responder + * @t1: Acknowledgment timer + * @t2: Response timer for multiplexer control channel + * @t3: Response timer for wake-up procedure + * @n2: Maximum number of retransmissions + * @mru: Maximum incoming frame payload size + * @mtu: Maximum outgoing frame payload size + * @k: Window size + * @i: Frame type (1 = UIH, 2 = UI) + * @unused: Can not be used + */ struct gsm_config { unsigned int adaption; @@ -19,7 +41,7 @@ struct gsm_config unsigned int mtu; unsigned int k; unsigned int i; - unsigned int unused[8]; /* Can not be used */ + unsigned int unused[8]; }; #define GSMIOC_GETCONF _IOR('G', 0, struct gsm_config)