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.