tty: n_gsm: add missing description to structs in gsmmux.h
authorDaniel Starke <daniel.starke@siemens.com>
Thu, 17 Aug 2023 09:32:24 +0000 (11:32 +0200)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Tue, 22 Aug 2023 13:21:24 +0000 (15:21 +0200)
commit901de5ac0ea92c63c4cd7be60f9ccbbacd623a3c
tree911b9cba324a01e529a2ee3cf4be63ff7511ba1a
parenta031c77dfce4f201cf94d6704cca5535ef44cb04
tty: n_gsm: add missing description to structs in gsmmux.h

Currently, all available structure fields in gsmmux.h except those
for gsm_config are commented. Furthermore, no kernel doc comments are used.

Fix this by adding appropriate comments to the not commented fields of
gsm_config. Convert the comments of the other structs to kernel doc format.

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.

Link: https://portal.3gpp.org/desktopmodules/Specifications/SpecificationDetails.aspx?specificationId=1516
Signed-off-by: Daniel Starke <daniel.starke@siemens.com>
Link: https://lore.kernel.org/r/20230817093231.2317-2-daniel.starke@siemens.com
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
include/uapi/linux/gsmmux.h