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).