From patchwork Wed Oct 19 09:33:39 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Ilpo_J=C3=A4rvinen?= X-Patchwork-Id: 5002 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:4ac7:0:0:0:0:0 with SMTP id y7csp244140wrs; Wed, 19 Oct 2022 03:32:21 -0700 (PDT) X-Google-Smtp-Source: AMsMyM4FMgQg0TyezmJxBK/n3kn0Px+gMg5SVYsgWBih/waLX9JtoxBBqwTSrk0qkW7V1YQU4/Jg X-Received: by 2002:a17:907:25c1:b0:77b:9966:ccf1 with SMTP id ae1-20020a17090725c100b0077b9966ccf1mr6023119ejc.763.1666175541094; Wed, 19 Oct 2022 03:32:21 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1666175541; cv=none; d=google.com; s=arc-20160816; b=UmTIm0Ql47ac4TcVbwmkBvdjpMS0aTlr1jCD2LYce+4rY6iiNgUFGfRXtlp6ZI7g88 9UutsY7CVIpaH0VPiX+C/dRX92q5r2+KenYzC4SGQQMogq+vC3geOg4u7LGnDbi38iOw EffKlX35enBeJS7TzeUXnoQIinE9kauHh8w4oAS+U1ETnLsEBFl7yTWzacPw20h2qwqv /3BlqH6eZQbO/7EVPSEs5PAno8HiacRpFElLfW0xM7zxrO1HOeG9ZEvXbnV/SuraiVXq kNS0t2jUZpf2l7oZYKtkR232BuN8x33lJ7mM07PaEeDT8gcI6aQPGrEtYahE5KeC2YYK EnOQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=TUxNRJArtk30avp6xe0rxxNsjvuYn65uOiGzRIugLGE=; b=NCRxYcakelJ0CG4QzbSpV7AtVD9L/pFIAP7W6hIpXN1JS3YdP1oqC16GSG30Zk3qD7 jXMW3fNGQQHx1fUYrbjpLnzyWLxgNLlJSYBQsm09/0iumEqJhhBoo1PNy6lz8E3R74lI wD9SgQDmAVHlg/Udqm5sYimBp6Siiq7R3j4Ss4333ATatV1gNsAb42zsSEHeFBqu8/1+ hf44bIYHguE6f61ytQ5Yl9Aw1Ad+YJNcAf7qf2Yi3EOt14H+18rH3UidCftghYAxz31K wtkxtZyDrMFT9yVbPY3dGEXCYKHClXwKd8Cp1P9P2RXF3F7HjrFfP8PmIKNLYblc0lk0 gnUw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@intel.com header.s=Intel header.b=GzqPCj0F; 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=NONE sp=NONE dis=NONE) header.from=intel.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id i7-20020a1709064fc700b0078d6418dcb8si16354536ejw.456.2022.10.19.03.31.53; Wed, 19 Oct 2022 03:32:21 -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=@intel.com header.s=Intel header.b=GzqPCj0F; 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=NONE sp=NONE dis=NONE) header.from=intel.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232231AbiJSJ7n (ORCPT + 99 others); Wed, 19 Oct 2022 05:59:43 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:60216 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234202AbiJSJ6p (ORCPT ); Wed, 19 Oct 2022 05:58:45 -0400 Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 45328115434; Wed, 19 Oct 2022 02:36:20 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1666172181; x=1697708181; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=RHuEA+7prTVcDhDjwV60mJA3TaTL03v6GsnXTKX2krI=; b=GzqPCj0FdnC2k4WjUJPz02F4FN+wO48TyVW5FdAfn7+RvRX11I97K7uU w4xRVrQGtkGssKKqhIz65Zu1u9C5NyZFKU28vgVmlr9Nw3pyUphat4nvm ke3Q3HiRlh18l+46BXpcVg43yL/qSWcWLtcUPYJTpNiej3/QyvXRNPQUs W1HU6V7+lp7F/2Zmr5O3FtojW06yT3WRqP3YAQ72RdaPxQerjav+MDXk3 2RzPrLtET46fGJ4/y2JBTnPFXRlLD2hMu6yxwOFCX8LYw22i5fSWbvPeY ttftqyLz8rZNUjaM09vP6hFJ/MfH+w2NRytXUa7FG6fPYP7HV2QnATmXo g==; X-IronPort-AV: E=McAfee;i="6500,9779,10504"; a="305095395" X-IronPort-AV: E=Sophos;i="5.95,195,1661842800"; d="scan'208";a="305095395" Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by fmsmga104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 19 Oct 2022 02:34:01 -0700 X-IronPort-AV: E=McAfee;i="6500,9779,10504"; a="734127869" X-IronPort-AV: E=Sophos;i="5.95,195,1661842800"; d="scan'208";a="734127869" Received: from sponnura-mobl1.amr.corp.intel.com (HELO ijarvine-MOBL2.ger.corp.intel.com) ([10.251.214.35]) by fmsmga002-auth.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 19 Oct 2022 02:33:58 -0700 From: =?utf-8?q?Ilpo_J=C3=A4rvinen?= To: linux-serial@vger.kernel.org, Greg KH , Jiri Slaby , Andy Shevchenko , Bagas Sanjaya , linux-doc@vger.kernel.org, Jonathan Corbet , linux-kernel@vger.kernel.org Cc: =?utf-8?q?Ilpo_J=C3=A4rvinen?= , Andy Shevchenko Subject: [PATCH v5 1/5] serial: Convert serial_rs485 to kernel doc Date: Wed, 19 Oct 2022 12:33:39 +0300 Message-Id: <20221019093343.9546-2-ilpo.jarvinen@linux.intel.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20221019093343.9546-1-ilpo.jarvinen@linux.intel.com> References: <20221019093343.9546-1-ilpo.jarvinen@linux.intel.com> MIME-Version: 1.0 X-Spam-Status: No, score=-4.6 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_EF,RCVD_IN_DNSWL_MED,SPF_HELO_NONE, SPF_NONE 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?1747111684166846070?= X-GMAIL-MSGID: =?utf-8?q?1747111684166846070?= Convert struct serial_rs485 comments to kernel doc format and include it into documentation. Suggested-by: Andy Shevchenko Reviewed-by: Andy Shevchenko Signed-off-by: Ilpo Järvinen --- .../driver-api/serial/serial-rs485.rst | 13 +++-- include/uapi/linux/serial.h | 55 ++++++++++++------- 2 files changed, 43 insertions(+), 25 deletions(-) diff --git a/Documentation/driver-api/serial/serial-rs485.rst b/Documentation/driver-api/serial/serial-rs485.rst index 6ebad75c74ed..264e4b753713 100644 --- a/Documentation/driver-api/serial/serial-rs485.rst +++ b/Documentation/driver-api/serial/serial-rs485.rst @@ -29,11 +29,11 @@ RS485 Serial Communications 3. Data Structures Already Available in the Kernel ================================================== - The Linux kernel provides the serial_rs485 structure (see [1]) to handle - RS485 communications. This data structure is used to set and configure RS485 + The Linux kernel provides the serial_rs485 structure to handle RS485 + communications. This data structure is used to set and configure RS485 parameters in the platform data and in ioctls. - The device tree can also provide RS485 boot time parameters (see [2] + The device tree can also provide RS485 boot time parameters (see [1] for bindings). The driver is in charge of filling this data structure from the values given by the device tree. @@ -47,6 +47,9 @@ RS485 Serial Communications for the uart_port. TIOCGRS485 ioctl can be used to read back the serial_rs485 structure matching to the current configuration. +.. kernel-doc:: include/uapi/linux/serial.h + :identifiers: serial_rs485 + 4. Usage from user-level ======================== @@ -126,6 +129,4 @@ RS485 Serial Communications 6. References ============= - [1] include/uapi/linux/serial.h - - [2] Documentation/devicetree/bindings/serial/rs485.txt + [1] Documentation/devicetree/bindings/serial/rs485.txt diff --git a/include/uapi/linux/serial.h b/include/uapi/linux/serial.h index cea06924b295..53bc1af67a41 100644 --- a/include/uapi/linux/serial.h +++ b/include/uapi/linux/serial.h @@ -107,33 +107,50 @@ struct serial_icounter_struct { int reserved[9]; }; -/* +/** + * 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 your * platform. The set function returns the new state, with any unsupported bits * reverted appropriately. + * + * The flag 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) - __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; /* The fields below are defined by flags */ union { From patchwork Wed Oct 19 09:33:40 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Ilpo_J=C3=A4rvinen?= X-Patchwork-Id: 5270 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:4ac7:0:0:0:0:0 with SMTP id y7csp275961wrs; Wed, 19 Oct 2022 04:48:43 -0700 (PDT) X-Google-Smtp-Source: AMsMyM40cRgXstgfHqsoXGUaDk7Bb13jR1tPgIKXc12lCachPJUpRCcEIMqsLdXww4rXnCqtQZP4 X-Received: by 2002:a05:6402:e9d:b0:443:7833:3d7b with SMTP id h29-20020a0564020e9d00b0044378333d7bmr6842660eda.151.1666180123761; Wed, 19 Oct 2022 04:48:43 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1666180123; cv=none; d=google.com; s=arc-20160816; b=RKm5jDSDj+A2R140V+jbUauZ0+ged5C7YK8P10a4o9fp5yTYJkByeLYXUOlVNr65ue g8tHTp1cuxX0JNaFAu4Hc+81/4WCZEnMRa1DMT3TxmuZ/HoDDmw+/jQVKYEJPie/0KK4 nb4HN0QeZF8ri+vzfBds9SNyd2PeRtjpzowK9cBmpEkvynoZcwPFop6u0Yujr7+9CbsR ExXqeZ+Qe6LgqmWyviB+W7doojEY191rjp3LZQ/fJRK4+DbkMCjEoBgOveBOT7Iqr0+j 3seitVfRdjv8OUC7tLkaG3X0FZMPvfmB1CyrxlyS1nMT2qj/Od0zGn5nv7iPi9npJDlo becA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=fuWLp/PxPiijOsDIzip+zMtrbg2xk1YjZnqej/C1pFE=; b=WqPMkkYTKqrrJkxWJC3D2iC4IKLvltfa1Mv0KlItQcgjvCS+eq6yVzBAYQgRH49iqz CzuVd5LFmoAqNtBB9gS1zuLfVASasGT83RXSFFmerBajEkw+dpFsLA/bCCE3ozdBsm8K /ceU/R3Wib3TfouXTUJPRUZOLJVL8ZA+RwFv40oQUXNAM6EKCzZbaIpjvszpmXvoc9f7 JGVbNKkbGS6SiMHGuaVx2gsxuAJCPhkKrnaApXzNXTVprQ6z0ecjVTIz95OqHobUa0fM OcHqC0ces7X2vZVikF1zRSmHwLSr3eSQudeSt05tH2XL4jzjqG+57gAg43hhSOPkllL3 VQkQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@intel.com header.s=Intel header.b=m2O2yqAm; 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=NONE sp=NONE dis=NONE) header.from=intel.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id c17-20020a05640227d100b0045d5e3c7f44si11776901ede.180.2022.10.19.04.48.16; Wed, 19 Oct 2022 04:48:43 -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=@intel.com header.s=Intel header.b=m2O2yqAm; 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=NONE sp=NONE dis=NONE) header.from=intel.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231147AbiJSLrD (ORCPT + 99 others); Wed, 19 Oct 2022 07:47:03 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:46748 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230331AbiJSLqb (ORCPT ); Wed, 19 Oct 2022 07:46:31 -0400 Received: from mga05.intel.com (mga05.intel.com [192.55.52.43]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id C89D718F932; Wed, 19 Oct 2022 04:26:08 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1666178769; x=1697714769; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=LbMSsxMcmlMfWsO5riNK7BpBDXgyRdAAcSbOnynbhCA=; b=m2O2yqAmBMChZ+IYtrMxqLV0n3Tf/1oQbzf2VzGj79q0ydpS1I0NJuF5 SB9TpJ56AdFyyzYahFhZeSczcj3Ub3gSJ6EuZGGZEWBqyRyc1qQIYaMO0 gIpldcU+S4gYhWWckMUfcVkITTxBGY87GkaZPkVA4xkltacP2340Z7h84 Kj61nt0wO+NtsIFMSyjeMyGANuM/dvyQZ0NziCuap6InhVLBLHRn9ch3B krDJwBZWoOAW6Y9yhQ6Rfi3leueFe4aRd25gd/CJ+ATvWQKJxR+RhAuMx WyKpaDe1AqbDXytyLtmonxUPDYNpZhzO6bDWHVf0ZEuwj+bseexBmhns6 A==; X-IronPort-AV: E=McAfee;i="6500,9779,10504"; a="392661862" X-IronPort-AV: E=Sophos;i="5.95,195,1661842800"; d="scan'208";a="392661862" Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by fmsmga105.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 19 Oct 2022 02:34:07 -0700 X-IronPort-AV: E=McAfee;i="6500,9779,10504"; a="734127905" X-IronPort-AV: E=Sophos;i="5.95,195,1661842800"; d="scan'208";a="734127905" Received: from sponnura-mobl1.amr.corp.intel.com (HELO ijarvine-MOBL2.ger.corp.intel.com) ([10.251.214.35]) by fmsmga002-auth.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 19 Oct 2022 02:34:02 -0700 From: =?utf-8?q?Ilpo_J=C3=A4rvinen?= To: linux-serial@vger.kernel.org, Greg KH , Jiri Slaby , Andy Shevchenko , Bagas Sanjaya , linux-doc@vger.kernel.org, Jonathan Corbet , linux-kernel@vger.kernel.org Cc: =?utf-8?q?Ilpo_J=C3=A4rvinen?= , Andy Shevchenko Subject: [PATCH v5 2/5] Documentation: rs485: Link reference properly Date: Wed, 19 Oct 2022 12:33:40 +0300 Message-Id: <20221019093343.9546-3-ilpo.jarvinen@linux.intel.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20221019093343.9546-1-ilpo.jarvinen@linux.intel.com> References: <20221019093343.9546-1-ilpo.jarvinen@linux.intel.com> MIME-Version: 1.0 X-Spam-Status: No, score=-4.6 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_EF,RCVD_IN_DNSWL_MED,SPF_HELO_NONE, SPF_NONE 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?1747116489819412307?= X-GMAIL-MSGID: =?utf-8?q?1747116489819412307?= Link DT bindings reference properly. Reviewed-by: Andy Shevchenko Signed-off-by: Ilpo Järvinen --- Documentation/driver-api/serial/serial-rs485.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Documentation/driver-api/serial/serial-rs485.rst b/Documentation/driver-api/serial/serial-rs485.rst index 264e4b753713..513758a702a6 100644 --- a/Documentation/driver-api/serial/serial-rs485.rst +++ b/Documentation/driver-api/serial/serial-rs485.rst @@ -33,9 +33,9 @@ RS485 Serial Communications communications. This data structure is used to set and configure RS485 parameters in the platform data and in ioctls. - The device tree can also provide RS485 boot time parameters (see [1] - for bindings). The driver is in charge of filling this data structure from - the values given by the device tree. + The device tree can also provide RS485 boot time parameters + [#DT-bindings]_. The driver is in charge of filling this data structure + from the values given by the device tree. Any driver for devices capable of working both as RS232 and RS485 should implement the rs485_config callback and provide rs485_supported in the @@ -129,4 +129,4 @@ RS485 Serial Communications 6. References ============= - [1] Documentation/devicetree/bindings/serial/rs485.txt +.. [#DT-bindings] Documentation/devicetree/bindings/serial/rs485.txt From patchwork Wed Oct 19 09:33:41 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Ilpo_J=C3=A4rvinen?= X-Patchwork-Id: 5272 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:4ac7:0:0:0:0:0 with SMTP id y7csp276512wrs; Wed, 19 Oct 2022 04:50:11 -0700 (PDT) X-Google-Smtp-Source: AMsMyM5jDsJ/QYeyQidq7CcTFMCYS40IZOywyvOEXQSicBlXCmYf8XV5Q5g/HuEW5gsGgMn7aei+ X-Received: by 2002:a17:907:3f26:b0:78d:9c30:4529 with SMTP id hq38-20020a1709073f2600b0078d9c304529mr6353297ejc.195.1666180210901; Wed, 19 Oct 2022 04:50:10 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1666180210; cv=none; d=google.com; s=arc-20160816; b=tepJJXDkvcMqzNKS3MJYxdvxzELBV3tZPB797+YuAI10nhwvKlh6fhFDUaUahd1x/K 8+63TXGLWAobwVyeWgtofa74le2eOjvWYa/oj874Q5UUx9RyatDcfWPVBnw4SzOwFRge u+3+NIq224Lqn+NYdNDMs1FGiTc7wi/8Y2F+gfrfBSYoNgkU5C0jLOzrCYZL2Bbgy/0n slb+6RwIHalU04tWuj5m18yhcAd5JOoQYe/dtYfw0GSVAz0cb5QnH3KiwgyTDIN8ExpH +gHIfd9X8Es+wPhIWyUY+HzSuJN1k4hZY81Tu/0FNuynI0BMkCk6a7VCCPUbH7Uo2vd2 SOgQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=6EZYU/swxqEbvNbsFtY4KEd5kUUEjkuxhnEW44Zam/0=; b=SK4vk9uhITpY+8iS9ExLWq1QLOMAh9WnUgD3SCqZmrI3IbNBILammJmk6EdGauThuy WTKQQw73bCutj0f2i35ebAYLVIqCtrO5xxl4DoGgFpRmddtrz44IBK6ribVZo99nf58A xUJH/WG6k0I8czDXP5r44jha0yYptNV6I9Iz2gDamjkYz2kEXAW50G0a3QWckNt7uZF6 ssNQHg0158WmD1JOxNKItrYIHmXXC3GLT62kb2gTf0ua9i/0zoeY8vrnaitVZLHj2sit 7FdFoWxNMnMaoIjBCl9tUD+8HeIOqM2ccTgq/gVfAxMK9bumqVOZoPi6muwRh9oJH2yz nV0A== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@intel.com header.s=Intel header.b=Dq1UtW5u; 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=NONE sp=NONE dis=NONE) header.from=intel.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id gs17-20020a1709072d1100b007807e1f3d9dsi18733545ejc.842.2022.10.19.04.49.45; Wed, 19 Oct 2022 04:50:10 -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=@intel.com header.s=Intel header.b=Dq1UtW5u; 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=NONE sp=NONE dis=NONE) header.from=intel.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231183AbiJSLrO (ORCPT + 99 others); Wed, 19 Oct 2022 07:47:14 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:47668 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230500AbiJSLqd (ORCPT ); Wed, 19 Oct 2022 07:46:33 -0400 Received: from mga05.intel.com (mga05.intel.com [192.55.52.43]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id E456619C233; Wed, 19 Oct 2022 04:26:09 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1666178770; x=1697714770; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=rEYYlDIJLI+0frdDQYe75a4u653dFCn6f4t9c6SSqPc=; b=Dq1UtW5uNhpB82TnSJe0Wwbpi8PiKriBxhl6dylpvrwiLXtoVYdIjjH8 0gPfSBhkV6l7JrE/crBNQtxF6wrLD2WwdLOCXzzNcwiaooHpUYeNqgW93 jfO9MwFIrXmdOhqXebFVzebhcdMhkmIBtFr/7XjsaGvIN579jqfS2gkvr 9DQfAvTttXztfUEC6IWzovYzcQinIodcz9IaLhHdEjOiVNRTdNIzW5GNN 7WkLH8drFR20h9ax0M3z8BUBzsOwkQ7AXNN43Snf4ZT3gk6RqXJB/R0Ip jeUIJPAk8bLyjnR8PuEvjY16sMlSSEWcqAsqP4fHvICcowdhOaz8jatja g==; X-IronPort-AV: E=McAfee;i="6500,9779,10504"; a="392661891" X-IronPort-AV: E=Sophos;i="5.95,195,1661842800"; d="scan'208";a="392661891" Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by fmsmga105.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 19 Oct 2022 02:34:11 -0700 X-IronPort-AV: E=McAfee;i="6500,9779,10504"; a="734127924" X-IronPort-AV: E=Sophos;i="5.95,195,1661842800"; d="scan'208";a="734127924" Received: from sponnura-mobl1.amr.corp.intel.com (HELO ijarvine-MOBL2.ger.corp.intel.com) ([10.251.214.35]) by fmsmga002-auth.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 19 Oct 2022 02:34:08 -0700 From: =?utf-8?q?Ilpo_J=C3=A4rvinen?= To: linux-serial@vger.kernel.org, Greg KH , Jiri Slaby , Andy Shevchenko , Bagas Sanjaya , linux-doc@vger.kernel.org, Jonathan Corbet , linux-kernel@vger.kernel.org Cc: =?utf-8?q?Ilpo_J=C3=A4rvinen?= , Andy Shevchenko Subject: [PATCH v5 3/5] Documentation: rs485: Mention uart_get_rs485_mode() Date: Wed, 19 Oct 2022 12:33:41 +0300 Message-Id: <20221019093343.9546-4-ilpo.jarvinen@linux.intel.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20221019093343.9546-1-ilpo.jarvinen@linux.intel.com> References: <20221019093343.9546-1-ilpo.jarvinen@linux.intel.com> MIME-Version: 1.0 X-Spam-Status: No, score=-4.6 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_EF,RCVD_IN_DNSWL_MED,SPF_HELO_NONE, SPF_NONE 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?1747116580711810410?= X-GMAIL-MSGID: =?utf-8?q?1747116580711810410?= Add to rs485 documentation that serial core prepares the struct serial_rs485 when uart_get_rs485_mode() is called. Remove the wrong claim that the driver must fill it by itself. Reviewed-by: Andy Shevchenko Signed-off-by: Ilpo Järvinen --- Documentation/driver-api/serial/serial-rs485.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/Documentation/driver-api/serial/serial-rs485.rst b/Documentation/driver-api/serial/serial-rs485.rst index 513758a702a6..ee34c8e1e56e 100644 --- a/Documentation/driver-api/serial/serial-rs485.rst +++ b/Documentation/driver-api/serial/serial-rs485.rst @@ -34,8 +34,9 @@ RS485 Serial Communications parameters in the platform data and in ioctls. The device tree can also provide RS485 boot time parameters - [#DT-bindings]_. The driver is in charge of filling this data structure - from the values given by the device tree. + [#DT-bindings]_. The serial core fills the struct serial_rs485 from the + values given by the device tree when the driver calls + uart_get_rs485_mode(). Any driver for devices capable of working both as RS232 and RS485 should implement the rs485_config callback and provide rs485_supported in the @@ -48,7 +49,7 @@ RS485 Serial Communications serial_rs485 structure matching to the current configuration. .. kernel-doc:: include/uapi/linux/serial.h - :identifiers: serial_rs485 + :identifiers: serial_rs485 uart_get_rs485_mode 4. Usage from user-level ======================== From patchwork Wed Oct 19 09:33:42 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Ilpo_J=C3=A4rvinen?= X-Patchwork-Id: 5268 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:4ac7:0:0:0:0:0 with SMTP id y7csp275626wrs; Wed, 19 Oct 2022 04:47:57 -0700 (PDT) X-Google-Smtp-Source: AMsMyM5b9EzqKUv+kx0tAvjP8oj24sBm5uNWrPu77lg5C776PvSqK4G1OuwDKWDYPA3FiUAvHwf9 X-Received: by 2002:a63:1349:0:b0:44b:2240:b311 with SMTP id 9-20020a631349000000b0044b2240b311mr6846302pgt.405.1666180076918; Wed, 19 Oct 2022 04:47:56 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1666180076; cv=none; d=google.com; s=arc-20160816; b=l3ehCXIs+oneoRega8cCm7ZcOCH5qipiapgEhwJ6JfCHtC2S5OGUzXe0QSIBlECmbQ cczS21UIu6FaRe6jOjZXe3wZ9eOm2aNdMdR93TvtR8lvos0Z6KEcUUXRhVAe2iG9WEOF Nv6mWzM7TUC/2IpFQViGTDCigBxBkZbyHf++0MbFzVv1v4zmCKcZftA7AMGFWfSi76ZL v3k0XpHrU8fWMyQQZXZSebqaMKO++Pc/fY+A3za7KLc/uae1R1s/qf0WjzMpJabvrCl+ tqYvgYAKhbsBrY3bKB8M8MaQ4jtx2EjlP1RUgEHMALfKx07ic8LWrk8ofCUAM29c3a2k 4VbA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=0sddpU3TZRbRUDRRW1p74/DBQYzD/1v0toNHKAyMEgw=; b=IyJRUuOKwMwGr5bVoj2f1vCp1jIYrIEjkuk+/RqBIxP9zVpgORXUi70ws3v+EUtFRI ShiXUgkAD2QMhLPiCk9M7EYHfBrY56B3jvMwLi4Cr4ReAK5RSkDibSXfSC177N0RNFLM IZTGBhcwlaoFoAL14//O0vmn7sS3WrZcID2AJK/56v05C0+QB1s9d/+U1zx25z8srbAp sESsKxxKAZzvm5DoZqbB5o1PxXSFnczJSIILcMcLaBTUGQI39A2WDNLkA+y1IGBI08Yt jRDFKnKbvYlbDg4jT6MHBhsBts/lk5GywmDvZlG52Wqy1EFy/CNFCzOXw7wlR3zkcsug TyQw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@intel.com header.s=Intel header.b="Nsg/V9pQ"; 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=NONE sp=NONE dis=NONE) header.from=intel.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id br4-20020a17090b0f0400b001f31c65900dsi21148087pjb.150.2022.10.19.04.47.44; Wed, 19 Oct 2022 04:47:56 -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=@intel.com header.s=Intel header.b="Nsg/V9pQ"; 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=NONE sp=NONE dis=NONE) header.from=intel.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231520AbiJSLqm (ORCPT + 99 others); Wed, 19 Oct 2022 07:46:42 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:47108 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231492AbiJSLqV (ORCPT ); Wed, 19 Oct 2022 07:46:21 -0400 Received: from mga05.intel.com (mga05.intel.com [192.55.52.43]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id ADBDC166980; Wed, 19 Oct 2022 04:26:10 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1666178770; x=1697714770; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=xTfXyABtrWPDgEHj2asTRfYPY8Q87jgv7IqP5hzhfFw=; b=Nsg/V9pQPRvMfW49rVnizPChvP0qw3RJxDDmM6POdjiqzRtAkLK3ehsR kCsirhN+YNNvSm2YmcoDe6sx2VrpRbIWBpmY8ZbXYyw35RkLFsQIstzif JTbhbAHxAf4wLl33y98cz0Fn2VYRCw2ulmMO0ZJLPVuNzGDz15r0EAaTf QCoQo7LZDkuZDytQgBs3nxX9+Pq/rQOAuU3BSvR9np7p3cnnHHTezel+M cM6yDNGZStXxb38zS/privpPtRvB/SR5FH5NNnpku3CJ+wZKQ8AZafKJg XHbKDXop1GklnY3pMHM7fXYNAOc3P7cpeKhbdyg3OkIwTxxepeGl1hEM5 A==; X-IronPort-AV: E=McAfee;i="6500,9779,10504"; a="392661911" X-IronPort-AV: E=Sophos;i="5.95,195,1661842800"; d="scan'208";a="392661911" Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by fmsmga105.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 19 Oct 2022 02:34:16 -0700 X-IronPort-AV: E=McAfee;i="6500,9779,10504"; a="734127951" X-IronPort-AV: E=Sophos;i="5.95,195,1661842800"; d="scan'208";a="734127951" Received: from sponnura-mobl1.amr.corp.intel.com (HELO ijarvine-MOBL2.ger.corp.intel.com) ([10.251.214.35]) by fmsmga002-auth.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 19 Oct 2022 02:34:12 -0700 From: =?utf-8?q?Ilpo_J=C3=A4rvinen?= To: linux-serial@vger.kernel.org, Greg KH , Jiri Slaby , Andy Shevchenko , Bagas Sanjaya , linux-doc@vger.kernel.org, Jonathan Corbet , linux-kernel@vger.kernel.org Cc: =?utf-8?q?Ilpo_J=C3=A4rvinen?= , Andy Shevchenko Subject: [PATCH v5 4/5] Documentation: rs485: Fix struct referencing Date: Wed, 19 Oct 2022 12:33:42 +0300 Message-Id: <20221019093343.9546-5-ilpo.jarvinen@linux.intel.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20221019093343.9546-1-ilpo.jarvinen@linux.intel.com> References: <20221019093343.9546-1-ilpo.jarvinen@linux.intel.com> MIME-Version: 1.0 X-Spam-Status: No, score=-4.6 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_EF,RCVD_IN_DNSWL_MED,SPF_HELO_NONE, SPF_NONE 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?1747116440280045559?= X-GMAIL-MSGID: =?utf-8?q?1747116440280045559?= Use "struct serial_rs485" to get the references properly recognized. Reviewed-by: Andy Shevchenko Signed-off-by: Ilpo Järvinen --- .../driver-api/serial/serial-rs485.rst | 21 ++++++++++--------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/Documentation/driver-api/serial/serial-rs485.rst b/Documentation/driver-api/serial/serial-rs485.rst index ee34c8e1e56e..e53aa291bcd7 100644 --- a/Documentation/driver-api/serial/serial-rs485.rst +++ b/Documentation/driver-api/serial/serial-rs485.rst @@ -29,7 +29,7 @@ RS485 Serial Communications 3. Data Structures Already Available in the Kernel ================================================== - The Linux kernel provides the serial_rs485 structure to handle RS485 + The Linux kernel provides the struct serial_rs485 to handle RS485 communications. This data structure is used to set and configure RS485 parameters in the platform data and in ioctls. @@ -40,13 +40,14 @@ RS485 Serial Communications Any driver for devices capable of working both as RS232 and RS485 should implement the rs485_config callback and provide rs485_supported in the - uart_port structure. The serial core calls rs485_config to do the device - specific part in response to TIOCSRS485 ioctl (see below). The rs485_config - callback receives a pointer to a sanitizated serial_rs485 structure. The - serial_rs485 userspace provides is sanitized before calling rs485_config - using rs485_supported that indicates what RS485 features the driver supports - for the uart_port. TIOCGRS485 ioctl can be used to read back the - serial_rs485 structure matching to the current configuration. + struct uart_port. The serial core calls rs485_config to do the device + specific part in response to TIOCSRS485 ioctl (see below). The + rs485_config callback receives a pointer to a sanitizated struct + serial_rs485. The struct serial_rs485 userspace provides is sanitized + before calling rs485_config using rs485_supported that indicates what + RS485 features the driver supports for the struct uart_port. TIOCGRS485 + ioctl can be used to read back the struct serial_rs485 matching to the + current configuration. .. kernel-doc:: include/uapi/linux/serial.h :identifiers: serial_rs485 uart_get_rs485_mode @@ -108,8 +109,8 @@ RS485 Serial Communications The Linux kernel provides addressing mode for multipoint RS-485 serial communications line. The addressing mode is enabled with SER_RS485_ADDRB - flag in serial_rs485. Struct serial_rs485 has two additional flags and - fields for enabling receive and destination addresses. + flag in struct serial_rs485. The struct serial_rs485 has two additional + flags and fields for enabling receive and destination addresses. Address mode flags: - SER_RS485_ADDRB: Enabled addressing mode (sets also ADDRB in termios). From patchwork Wed Oct 19 09:33:43 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Ilpo_J=C3=A4rvinen?= X-Patchwork-Id: 5273 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:4ac7:0:0:0:0:0 with SMTP id y7csp276514wrs; Wed, 19 Oct 2022 04:50:11 -0700 (PDT) X-Google-Smtp-Source: AMsMyM7O4AXhIvPsgOeabNSPMfxkUj/FexFYCPTziTycuvVaRydlvXu/Rbhe1/eaMtieXomEdzGL X-Received: by 2002:a17:907:1c01:b0:78d:eb6e:3807 with SMTP id nc1-20020a1709071c0100b0078deb6e3807mr6380847ejc.481.1666180211147; Wed, 19 Oct 2022 04:50:11 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1666180211; cv=none; d=google.com; s=arc-20160816; b=M3IdOpKbW0n3lH7CrmsC1XG1+FPpeVN2Hm/SC/PuYAojhoFaNcdAnQMsHmQAEgq/+V 0GhlFxXZK5N+7uqTVLY1AZrQR3le2GFSUYOhnF0kZsamBIZ2fh70wlBGdfTQ7FSA/rpJ Q4V9IkcfVQrNXySnXZByF50ptawXdXMkvpGMIv8WjWWV+kW8LieXrnlHytnGk5lu50da jtH908LGlagg1ekR88OU9ysDLGBOfxvzFi3LzKfrduRsnToCmmXAuhmv/Xv76/pvJDRr np8JFYyCkD5qkHLgnTiL9Zy2ew7bpyH1p94XReDk9K1YMnZE7yndoxca272Odz7N8sCq uYYw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:subject:cc:to:from :dkim-signature; bh=PIjetnrH0Em9ORHYUXIRoMfisMuKlmnfaRtyKhmBGRQ=; b=NClgitDBDBdkqqXETsJLc3hEuBdoe57w3lqvONTAqy5PhHPVrFBJki4/VqBh1boll6 H/9U+WbtV5LW0I/wFQ+YtM2NIqaMEjO61ZapL6Rg2WUekI5gpbnJyaRTsCrZvY5mnbBD 51irMc236GPw29RL+7+RAN4TQKI0hM6w938FX+HYAeUaCS7cr9PnWzTMuoJRMTRNhQrE fb9/TB87s8UYrNQseFUz51M/bpJwJ5dScy1voWBHotGLnOlbx4VNob5Pa03H+lxmHO6M LGT8YbEpttm548M0Prq7vQBYEHveI4QREMaJ03PKwMAv7FNhsYDkMAgVPDK/pCZYDd+P xv3Q== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@intel.com header.s=Intel header.b=huGddRKG; 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=NONE sp=NONE dis=NONE) header.from=intel.com Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id fx26-20020a170906b75a00b0078adad5930esi12458631ejb.255.2022.10.19.04.49.45; Wed, 19 Oct 2022 04:50:11 -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=@intel.com header.s=Intel header.b=huGddRKG; 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=NONE sp=NONE dis=NONE) header.from=intel.com Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231267AbiJSLrT (ORCPT + 99 others); Wed, 19 Oct 2022 07:47:19 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:34756 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231187AbiJSLqh (ORCPT ); Wed, 19 Oct 2022 07:46:37 -0400 Received: from mga05.intel.com (mga05.intel.com [192.55.52.43]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id ADD3619B67B; Wed, 19 Oct 2022 04:26:10 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1666178770; x=1697714770; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=sDkxUdt2JahFUf77AGEqjEY+CeposhXLpl0kIeK4m2o=; b=huGddRKGBlIobxOltBsBk0I4fA+/mfdPkpENu+1+oaqAlzBzsEa2l9WN RThC+67lxIbsTmBay7JfhxQFDPOQWIab09zG9q+sgN+kaf6bgMzYLEXKV OviYbu+MvnFRMOUwAcrOMj14CK5UbU2Bl/Y+vmn7P13hAsVwvhx98e+NC 7FPCQdP9+zTl/+YEtJ4rJRBpclp9F97NK8CzV/f0jY4K0H1HkuMDjcSD/ cBhJ09PtX4ylOozBpEKMwhRLsZsTHGqH/hnOu3Ki2+0MWZ1cSwu+M6jVh 7M+eJI111Kc6946uoUhkm4Mv4keb42VW9khBPBYBqKUAoFdAYsaZ2KUQC Q==; X-IronPort-AV: E=McAfee;i="6500,9779,10504"; a="392661926" X-IronPort-AV: E=Sophos;i="5.95,195,1661842800"; d="scan'208";a="392661926" Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by fmsmga105.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 19 Oct 2022 02:34:20 -0700 X-IronPort-AV: E=McAfee;i="6500,9779,10504"; a="734127975" X-IronPort-AV: E=Sophos;i="5.95,195,1661842800"; d="scan'208";a="734127975" Received: from sponnura-mobl1.amr.corp.intel.com (HELO ijarvine-MOBL2.ger.corp.intel.com) ([10.251.214.35]) by fmsmga002-auth.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 19 Oct 2022 02:34:17 -0700 From: =?utf-8?q?Ilpo_J=C3=A4rvinen?= To: linux-serial@vger.kernel.org, Greg KH , Jiri Slaby , Andy Shevchenko , Bagas Sanjaya , linux-doc@vger.kernel.org, Jonathan Corbet , linux-kernel@vger.kernel.org Cc: =?utf-8?q?Ilpo_J=C3=A4rvinen?= Subject: [PATCH v5 5/5] Documentation: Make formatting consistent for rs485 docs Date: Wed, 19 Oct 2022 12:33:43 +0300 Message-Id: <20221019093343.9546-6-ilpo.jarvinen@linux.intel.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20221019093343.9546-1-ilpo.jarvinen@linux.intel.com> References: <20221019093343.9546-1-ilpo.jarvinen@linux.intel.com> MIME-Version: 1.0 X-Spam-Status: No, score=-4.6 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_EF,RCVD_IN_DNSWL_MED,SPF_HELO_NONE, SPF_NONE 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?1747116581049152970?= X-GMAIL-MSGID: =?utf-8?q?1747116581049152970?= Tweak styling of names that come directly from the code. Suggested-by: Bagas Sanjaya Signed-off-by: Ilpo Järvinen --- .../driver-api/serial/serial-rs485.rst | 37 ++++++++++--------- 1 file changed, 19 insertions(+), 18 deletions(-) diff --git a/Documentation/driver-api/serial/serial-rs485.rst b/Documentation/driver-api/serial/serial-rs485.rst index e53aa291bcd7..dce061ef7647 100644 --- a/Documentation/driver-api/serial/serial-rs485.rst +++ b/Documentation/driver-api/serial/serial-rs485.rst @@ -39,15 +39,15 @@ RS485 Serial Communications uart_get_rs485_mode(). Any driver for devices capable of working both as RS232 and RS485 should - implement the rs485_config callback and provide rs485_supported in the - struct uart_port. The serial core calls rs485_config to do the device - specific part in response to TIOCSRS485 ioctl (see below). The - rs485_config callback receives a pointer to a sanitizated struct + implement the ``rs485_config`` callback and provide ``rs485_supported`` + in the ``struct uart_port``. The serial core calls ``rs485_config`` to do + the device specific part in response to TIOCSRS485 ioctl (see below). The + ``rs485_config`` callback receives a pointer to a sanitizated struct serial_rs485. The struct serial_rs485 userspace provides is sanitized - before calling rs485_config using rs485_supported that indicates what - RS485 features the driver supports for the struct uart_port. TIOCGRS485 - ioctl can be used to read back the struct serial_rs485 matching to the - current configuration. + before calling ``rs485_config`` using ``rs485_supported`` that indicates + what RS485 features the driver supports for the ``struct uart_port``. + TIOCGRS485 ioctl can be used to read back the struct serial_rs485 + matching to the current configuration. .. kernel-doc:: include/uapi/linux/serial.h :identifiers: serial_rs485 uart_get_rs485_mode @@ -108,23 +108,24 @@ RS485 Serial Communications ======================== The Linux kernel provides addressing mode for multipoint RS-485 serial - communications line. The addressing mode is enabled with SER_RS485_ADDRB - flag in struct serial_rs485. The struct serial_rs485 has two additional - flags and fields for enabling receive and destination addresses. + communications line. The addressing mode is enabled with + ``SER_RS485_ADDRB`` flag in struct serial_rs485. The struct serial_rs485 + has two additional flags and fields for enabling receive and destination + addresses. Address mode flags: - - SER_RS485_ADDRB: Enabled addressing mode (sets also ADDRB in termios). - - SER_RS485_ADDR_RECV: Receive (filter) address enabled. - - SER_RS485_ADDR_DEST: Set destination address. + - ``SER_RS485_ADDRB``: Enabled addressing mode (sets also ADDRB in termios). + - ``SER_RS485_ADDR_RECV``: Receive (filter) address enabled. + - ``SER_RS485_ADDR_DEST``: Set destination address. - Address fields (enabled with corresponding SER_RS485_ADDR_* flag): - - addr_recv: Receive address. - - addr_dest: Destination address. + Address fields (enabled with corresponding ``SER_RS485_ADDR_*`` flag): + - ``addr_recv``: Receive address. + - ``addr_dest``: Destination address. Once a receive address is set, the communication can occur only with the particular device and other peers are filtered out. It is left up to the receiver side to enforce the filtering. Receive address will be cleared - if SER_RS485_ADDR_RECV is not set. + if ``SER_RS485_ADDR_RECV`` is not set. Note: not all devices supporting RS485 support multipoint addressing.