From nobody Thu Apr 9 12:31:28 2026 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id B3ED0ECAAD8 for ; Tue, 30 Aug 2022 07:30:41 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230521AbiH3Hak (ORCPT ); Tue, 30 Aug 2022 03:30:40 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:44056 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230220AbiH3HaW (ORCPT ); Tue, 30 Aug 2022 03:30:22 -0400 Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 5024E61D7B; Tue, 30 Aug 2022 00:30:17 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1661844617; x=1693380617; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=t4eCnXahTX8n0XguQ3D2JBczcMticRL80qO7oPnW6AM=; b=SqKtlQABEm1hHn0/yfIZgIwzTduaO7a0qQYU+/CKqe+VY5qD4hZLVez6 6j4TnvnM9Q5oUz0dW9RRAVI48bh0YlqwfBPEtnefVtrsu9CEmOFatM+k+ fqQHv872R746B4rLy7e143lrAEBry+x2aNSZRx3n6heNQbzN96c5Tnpm3 3pHp4fVlcs7YKkyUkdD4mv84x0hEtrIMff4mbI6MWqLyVBYu10r+FQnOM UKj0iQ/KFsH8XiokKItj9X2txkOKBoVYhHwOeyf7kv7HHEPeL+PRGWS2q /3qdDp6NqXDnZUM2HRS0fo94fSIUGYdOUA7VL77qSN72w+zvoCoiqAG7S g==; X-IronPort-AV: E=McAfee;i="6500,9779,10454"; a="282077245" X-IronPort-AV: E=Sophos;i="5.93,274,1654585200"; d="scan'208";a="282077245" Received: from orsmga008.jf.intel.com ([10.7.209.65]) by orsmga101.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 30 Aug 2022 00:30:15 -0700 X-IronPort-AV: E=Sophos;i="5.93,274,1654585200"; d="scan'208";a="641262684" Received: from arnesgom-mobl.ger.corp.intel.com (HELO ijarvine-MOBL2.ger.corp.intel.com) ([10.252.54.235]) by orsmga008-auth.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 30 Aug 2022 00:30:13 -0700 From: =?UTF-8?q?Ilpo=20J=C3=A4rvinen?= To: Greg Kroah-Hartman , Jiri Slaby , linux-serial@vger.kernel.org, Andy Shevchenko , linux-kernel@vger.kernel.org Cc: Lino Sanfilippo , =?UTF-8?q?Ilpo=20J=C3=A4rvinen?= Subject: [PATCH v2 3/4] serial: Convert serial_rs485 to kernel doc Date: Tue, 30 Aug 2022 10:29:55 +0300 Message-Id: <20220830072956.3630-4-ilpo.jarvinen@linux.intel.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20220830072956.3630-1-ilpo.jarvinen@linux.intel.com> References: <20220830072956.3630-1-ilpo.jarvinen@linux.intel.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Convert struct serial_rs485 comments to kernel doc format. Signed-off-by: Ilpo J=C3=A4rvinen --- include/uapi/linux/serial.h | 61 ++++++++++++++++++++++++------------- 1 file changed, 40 insertions(+), 21 deletions(-) diff --git a/include/uapi/linux/serial.h b/include/uapi/linux/serial.h index cea06924b295..dbdc7865abdc 100644 --- a/include/uapi/linux/serial.h +++ b/include/uapi/linux/serial.h @@ -107,37 +107,56 @@ struct serial_icounter_struct { int reserved[9]; }; =20 -/* +/** + * struct serial_rs485 - serial interface for controlling RS485 settings. + * @flags: RS485 feature flags + * @delay_rts_before_send: Delay before send (milliseconds) + * @delay_rts_after_send: Delay after send (milliseconds) + * @addr_recv: Receive filter for RS485 addressing mode + * (used only when %SER_RS485_ADDR_RECV is set). + * @addr_dest: Destination address for RS485 addressing mode + * (used only when %SER_RS485_ADDR_DEST is set). + * @padding0: Padding (set to zero). + * @padding1: Padding (set to zero). + * @padding: Deprecated, use @padding0 and @padding1 instead. + * Do not use with @addr_recv and @addr_dest (due to + * overlap). + * * Serial interface for controlling RS485 settings on chips with suitable * support. Set with TIOCSRS485 and get with TIOCGRS485 if supported by yo= ur * platform. The set function returns the new state, with any unsupported = bits * reverted appropriately. + * + * serial_rs485::flags bits are: + * * %SER_RS485_ENABLED - RS485 enabled + * * %SER_RS485_RTS_ON_SEND - Logical level for RTS pin when sending + * * %SER_RS485_RTS_AFTER_SEND - Logical level for RTS pin after sent + * * %SER_RS485_RX_DURING_TX - Full-duplex RS485 line + * * %SER_RS485_TERMINATE_BUS - Enable bus termination (if supported) + * * %SER_RS485_ADDRB - Enable RS485 addressing mode + * * %SER_RS485_ADDR_RECV - Receive address filter (enables @addr_recv). + * Requires %SER_RS485_ADDRB. + * * %SER_RS485_ADDR_DEST - Destination address (enables @addr_dest). + * Requires %SER_RS485_ADDRB. */ - struct serial_rs485 { - __u32 flags; /* RS485 feature flags */ -#define SER_RS485_ENABLED (1 << 0) /* If enabled */ -#define SER_RS485_RTS_ON_SEND (1 << 1) /* Logical level for - RTS pin when - sending */ -#define SER_RS485_RTS_AFTER_SEND (1 << 2) /* Logical level for - RTS pin after sent*/ + __u32 flags; +#define SER_RS485_ENABLED (1 << 0) +#define SER_RS485_RTS_ON_SEND (1 << 1) +#define SER_RS485_RTS_AFTER_SEND (1 << 2) #define SER_RS485_RX_DURING_TX (1 << 4) -#define SER_RS485_TERMINATE_BUS (1 << 5) /* Enable bus - termination - (if supported) */ - -/* RS-485 addressing mode */ -#define SER_RS485_ADDRB (1 << 6) /* Enable addressing mode */ -#define SER_RS485_ADDR_RECV (1 << 7) /* Receive address filter */ -#define SER_RS485_ADDR_DEST (1 << 8) /* Destination address */ +#define SER_RS485_TERMINATE_BUS (1 << 5) +#define SER_RS485_ADDRB (1 << 6) +#define SER_RS485_ADDR_RECV (1 << 7) +#define SER_RS485_ADDR_DEST (1 << 8) =20 - __u32 delay_rts_before_send; /* Delay before send (milliseconds) */ - __u32 delay_rts_after_send; /* Delay after send (milliseconds) */ + __u32 delay_rts_before_send; + __u32 delay_rts_after_send; =20 - /* The fields below are defined by flags */ + /* private: The fields below are defined by flags */ union { - __u32 padding[5]; /* Memory is cheap, new structs are a pain */ + /* private: Memory is cheap, new structs are a pain. */ + __u32 padding[5]; =20 struct { __u8 addr_recv; --=20 2.30.2