From patchwork Thu Sep 21 14:19:29 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: David Lechner X-Patchwork-Id: 142851 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:612c:172:b0:3f2:4152:657d with SMTP id h50csp5079521vqi; Thu, 21 Sep 2023 12:14:51 -0700 (PDT) X-Google-Smtp-Source: AGHT+IESQKR/k8Bkks2mo+KGxIf95ozNGC8LQKGeI7ZbAqfSu8a5DobH/lsQvULFcgeHwkXhn0jT X-Received: by 2002:a17:902:7e8f:b0:1c4:4c0f:8d91 with SMTP id z15-20020a1709027e8f00b001c44c0f8d91mr5402464pla.69.1695323690739; Thu, 21 Sep 2023 12:14:50 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1695323690; cv=none; d=google.com; s=arc-20160816; b=rdeZGxUCG8Pi4SaJiTZP4qhRONdqwthmLC2urMNaBRueWE6WNwE/8wk5+AzstPd+Vi z1XdvXiMoQaVdi0nsk9SxXM7oYOkSci9FLVnF9cHIBoJg9aE3VFKh1ymauaqaxzA45GF 6fCc0uxfkXa/zLwIlHKK1W5H12rPrmw01vJTHMzMsfDyQLDpHqhyMpxw1N6HlJJT7LPl n3ZnU8k9RRmV0k/Fe1S/47kqcd/xwQhRjcmC937Y+YUNKMtKP3vKlAKniwFPhwawuq+w bq/+4/KkuwxtdvRR84Dy2RT4MCeC4o/xCGC3dcGnyY4Dw0QNbYk5okosC+NX1iv6f1Wd rbnw== 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=dOWL8UFN0vGXrTIparX6s/KCVRR+pmZ6D/qH1lVsdWQ=; fh=rOC7q8UJisRayejF6PsoKdRfRTtXVZOwgDCXOG0B/ws=; b=uiXg9a7xJG4EMNEYfV9Zk481XMSdwJYawraiyQCEDNNnqBjsl3YwbV06kHIBuhIJEo Yo13brCzsAQma6A8IwKQTlZlX3ySyEo1eaix1uBdSA9CEUEIFujDasoKqB+jhGXI2nTM L5AW0WVL5sVgEuHnXOiXaWJdDd7s1ctA4rE32JH2oo+91p2SAjPjgNuv1XKaZLzYAwOs HUmZpyP0rMM2tAwe9JrP11bahV1Zjh/fGdw9sEZhnOrLM/w3uEiQyZr/2tpHzCSFYaOu Cg5m4cKYlcIE17pFzxJ+gsDM8yGV7TZsqAJQM9g5Z/i1YU3flwbshGZJsyBTNo8BO24y YfAQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@baylibre-com.20230601.gappssmtp.com header.s=20230601 header.b=SKFFvN3k; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.34 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from howler.vger.email (howler.vger.email. [23.128.96.34]) by mx.google.com with ESMTPS id c1-20020a170903234100b001c4401a7e18si2121487plh.382.2023.09.21.12.14.50 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 21 Sep 2023 12:14:50 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.34 as permitted sender) client-ip=23.128.96.34; Authentication-Results: mx.google.com; dkim=pass header.i=@baylibre-com.20230601.gappssmtp.com header.s=20230601 header.b=SKFFvN3k; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.34 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: from out1.vger.email (depot.vger.email [IPv6:2620:137:e000::3:0]) by howler.vger.email (Postfix) with ESMTP id 434E68226AF5; Thu, 21 Sep 2023 10:24:30 -0700 (PDT) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.10 at howler.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229875AbjIURYX (ORCPT + 29 others); Thu, 21 Sep 2023 13:24:23 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:40224 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229534AbjIURYA (ORCPT ); Thu, 21 Sep 2023 13:24:00 -0400 Received: from mail-lf1-x142.google.com (mail-lf1-x142.google.com [IPv6:2a00:1450:4864:20::142]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 156AD86B1 for ; Thu, 21 Sep 2023 10:05:31 -0700 (PDT) Received: by mail-lf1-x142.google.com with SMTP id 2adb3069b0e04-50309daf971so2068626e87.3 for ; Thu, 21 Sep 2023 10:05:31 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=baylibre-com.20230601.gappssmtp.com; s=20230601; t=1695315930; x=1695920730; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=dOWL8UFN0vGXrTIparX6s/KCVRR+pmZ6D/qH1lVsdWQ=; b=SKFFvN3kCENMePMcKKC9HCfjrzdwz6Js7iC7W5L/c+u2OpF6a5ZQOHqA1uI3swvAGw Ae1b3mtQgo0S9fdd2TvFe2fzSASXKEeT9gU21B1BeFH5rWCwaQM4vy8Pa32aM0I26JQ1 Mj2AbmrKPjdYdXv4oq4Lvxbc4eOvf1DZgbOdmQDIOcZKYy1KbK0HJBy1Vh1XmNEyHGfA 79V7B70F09zL4T5ileYyz9nUnIpj7h9BT9c5HeC8YHW3chkA3FMOjOSYWq9yRuGBHukJ dWviIgDOlXibw/BZFii4DZWrLie3x0rImYHbkRU+Yqhnxm7KE58hbLL12/ZUPJJLB8OP QVbg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1695315930; x=1695920730; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=dOWL8UFN0vGXrTIparX6s/KCVRR+pmZ6D/qH1lVsdWQ=; b=gAU5lu31GNjoC2fgsE4MTbzlt5QXlPa4gw+OU8gHiR0gLjbIoCRANSj7eO2L6f/gD0 toM4PRBUxAEi4ooyJhonCENqOjY5uewOkbdzpj8zBWnvEw/qv8XyGqZMc57NvpZmX+ws wCjPp1JjNmQtky1E+sjj9gsuBlZEggOZXlU2cSG3zsQTvzCjNzcqdaHD0l8KcAaNI99P MrcCeBFvc3ed9NwwXvGq3zcHyuzlEDcFhbfelAnC4PR6d+fyedfuwF5kYXUuhBs2QtJ0 7AEKV+qYa/4yxiQGYCIIY9yKKNHikklI/dQYGCUlFchrybqzKnJVHMINYoYZJSSXE0ek gbTw== X-Gm-Message-State: AOJu0YwAHVOmmSh7DE8YOLcuKLgMzRLd0Sbo/khiq29b+O2Q1CMQy/rO MS9SKGTeFWZpuVPk9yKVe390N0WeqliM1M1ovlrV5QC8Yv8= X-Received: by 2002:a5d:6405:0:b0:319:6ec3:79c7 with SMTP id z5-20020a5d6405000000b003196ec379c7mr5205794wru.36.1695306152763; Thu, 21 Sep 2023 07:22:32 -0700 (PDT) Received: from localhost.localdomain (abordeaux-655-1-129-86.w90-5.abo.wanadoo.fr. [90.5.10.86]) by smtp.gmail.com with ESMTPSA id n11-20020a5d4c4b000000b0031fbbe347ebsm1901426wrt.22.2023.09.21.07.22.32 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 21 Sep 2023 07:22:32 -0700 (PDT) From: David Lechner To: linux-iio@vger.kernel.org, devicetree@vger.kernel.org, linux-staging@lists.linux.dev Cc: linux-kernel@vger.kernel.org, Jonathan Cameron , Rob Herring , Krzysztof Kozlowski , Conor Dooley , Michael Hennerich , =?utf-8?q?Nuno_S=C3=A1?= , Axel Haslam , Philip Molloy , David Lechner Subject: [v2 02/19] staging: iio: Documentation: document IIO resolver AD2S1210 sysfs attributes Date: Thu, 21 Sep 2023 09:19:29 -0500 Message-Id: <20230921141947.57784-4-dlechner@baylibre.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20230921141947.57784-1-dlechner@baylibre.com> References: <20230921141947.57784-1-dlechner@baylibre.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (howler.vger.email [0.0.0.0]); Thu, 21 Sep 2023 10:24:30 -0700 (PDT) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1777675734350058438 X-GMAIL-MSGID: 1777675734350058438 This adds documentation for the device-specific sysfs attributes of the iio/resolver/ad2s1210 driver. Signed-off-by: David Lechner --- .../sysfs-bus-iio-resolver-ad2s1210 | 109 ++++++++++++++++++ 1 file changed, 109 insertions(+) create mode 100644 drivers/staging/iio/Documentation/sysfs-bus-iio-resolver-ad2s1210 diff --git a/drivers/staging/iio/Documentation/sysfs-bus-iio-resolver-ad2s1210 b/drivers/staging/iio/Documentation/sysfs-bus-iio-resolver-ad2s1210 new file mode 100644 index 000000000000..32890c85168e --- /dev/null +++ b/drivers/staging/iio/Documentation/sysfs-bus-iio-resolver-ad2s1210 @@ -0,0 +1,109 @@ +What: /sys/bus/iio/devices/iio:deviceX/dos_mis_thrd +KernelVersion: 6.7 +Contact: linux-iio@vger.kernel.org +Description: + Reading returns the current Degradation of Signal Mismatch + Threshold value. Writing sets the value. Valid values are 0 (0V) + to 127 (4.826V). To convert the value to volts, multiply by + 0.038. + +What: /sys/bus/iio/devices/iio:deviceX/dos_ovr_thrd +KernelVersion: 6.7 +Contact: linux-iio@vger.kernel.org +Description: + Reading returns the current Degradation of Signal Overrange + Threshold value. Writing sets the value. Valid values are 0 (0V) + to 127 (4.826V). To convert the value to volts, multiply by + 0.038. + +What: /sys/bus/iio/devices/iio:deviceX/dos_rst_max_thrd +KernelVersion: 6.7 +Contact: linux-iio@vger.kernel.org +Description: + Reading returns the current Degradation of Signal Reset Maximum + Threshold value. Writing sets the value. Valid values are 0 (0V) + to 127 (4.826V). To convert the value to volts, multiply by + 0.038. + +What: /sys/bus/iio/devices/iio:deviceX/dos_rst_min_thrd +KernelVersion: 6.7 +Contact: linux-iio@vger.kernel.org +Description: + Reading returns the current Degradation of Signal Reset Minimum + Threshold value. Writing sets the value. Valid values are 0 (0V) + to 127 (4.826V). To convert the value to volts, multiply by + 0.038. + +What: /sys/bus/iio/devices/iio:deviceX/fault +KernelVersion: 6.7 +Contact: linux-iio@vger.kernel.org +Description: + Reading returns a hex value containing the fault bit flags. + + Bit Description + --- ----------- + D7 Sine/cosine inputs clipped + D6 Sine/cosine inputs below LOS threshold + D5 Sine/cosine inputs exceed DOS overrange threshold + D4 Sine/cosine inputs exceed DOS mismatch threshold + D3 Tracking error exceeds LOT threshold + D2 Velocity exceeds maximum tracking rate + D1 Phase error exceeds phase lock range + D0 Configuration parity error + + Writing any value will clear any fault conditions. + +What: /sys/bus/iio/devices/iio:deviceX/excitation_frequency +KernelVersion: 6.7 +Contact: linux-iio@vger.kernel.org +Description: + Reading returns the current Excitation Frequency in Hz. Writing + sets the Excitation Frequency and performs a software reset on + the device to apply the change. Valid values are 2000 (2kHz) to + 20000 (20kHz). + +What: /sys/bus/iio/devices/iio:deviceX/los_thrd +KernelVersion: 6.7 +Contact: linux-iio@vger.kernel.org +Description: + Reading returns the current Loss of Signal Reset Threshold + value. Writing sets the value. Valid values are 0 (0V) to + 127 (4.826V). To convert the value to volts, multiply by 0.038. + +What: /sys/bus/iio/devices/iio:deviceX/lot_high_thrd +KernelVersion: 6.7 +Contact: linux-iio@vger.kernel.org +Description: + Reading returns the current Loss of Position Tracking Detection + High Threshold value. Writing sets the value. Valid values are + 0 (0 deg) to 127 (9/18/45 deg). The interpretation of the value + depends on the selected resolution. To convert the value to + degrees, multiply by 0.35 for 10-bit resolution, multiply by + 0.14 for 12-bit resolution or multiply by 0.09 for 14 and 16-bit + resolution. + +What: /sys/bus/iio/devices/iio:deviceX/lot_low_thrd +KernelVersion: 6.7 +Contact: linux-iio@vger.kernel.org +Description: + Reading returns the current Loss of Position Tracking Detection + Low Threshold value. Writing sets the value. Valid values are + 0 (0 deg) to 127 (9/18/45 deg). The interpretation of the value + depends on the selected resolution. To convert the value to + degrees, multiply by 0.35 for 10-bit resolution, multiply by + 0.14 for 12-bit resolution or multiply by 0.09 for 14 and 16-bit + resolution. + +What: /sys/bus/iio/devices/iio:deviceX/phase_lock_range +KernelVersion: 6.7 +Contact: linux-iio@vger.kernel.org +Description: + Reading returns the current Phase lock range in degrees. Writing + sets the value in the configuration register. + +What: /sys/bus/iio/devices/iio:deviceX/phase_lock_range_available +KernelVersion: 6.7 +Contact: linux-iio@vger.kernel.org +Description: + Reading returns the possible values for the phase_lock_range + attribute, namely 44 and 360.