From patchwork Tue Apr 4 12:24:15 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Matti Vaittinen X-Patchwork-Id: 13199718 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 0427BC761A6 for ; Tue, 4 Apr 2023 12:25:14 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S234165AbjDDMYm (ORCPT ); Tue, 4 Apr 2023 08:24:42 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:33610 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234912AbjDDMYi (ORCPT ); Tue, 4 Apr 2023 08:24:38 -0400 Received: from mail-lf1-x136.google.com (mail-lf1-x136.google.com [IPv6:2a00:1450:4864:20::136]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 13BF790; Tue, 4 Apr 2023 05:24:37 -0700 (PDT) Received: by mail-lf1-x136.google.com with SMTP id h11so35201282lfu.8; Tue, 04 Apr 2023 05:24:36 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; t=1680611075; h=content-disposition:mime-version:message-id:subject:cc:to:from:date :from:to:cc:subject:date:message-id:reply-to; bh=G6R6IiqyFU2ClZaJv5naRJgh7bUp5iz936cMHw9OV+0=; b=CLlVmhsD9W+jDM4H5UF5xrXcP2iOLibhSEpP8evaSx7COsBP0EGRJRtLuyOGoGYJTd AlfMK9/D4bu8DhgOyOxyywI6uak+ilCiTRXP2M6uUodppQEd2zLbIgNSDfq8ong57Exe sR0NJkDgiaEYqWmsbQhWP8zmZS8PT/q++/rDFYL6KcOIxI+SCpMJR0/Fww4/TV14HE++ ZLjjhipZn3hJknDLkLdYN0exBDUnNSXzbvEnFGS7N3abYi3NvaepxxTn2oAU4i2fIMgD B2zn0iofe/xNpM+iUOjid0QotkXcjpJ1ZrV6eLQZUVR7AyCqiRFEqr6Afqy5mr/zSq7R QRYg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; t=1680611075; h=content-disposition:mime-version:message-id:subject:cc:to:from:date :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=G6R6IiqyFU2ClZaJv5naRJgh7bUp5iz936cMHw9OV+0=; b=H+R5WZL/tGKwAUaP2cccxZkys4KNYTH11F47+G+Zurf8L8OwBwH6v/qXFzhvfC1Ui8 U4tnF6zx7UiruW1CORbn9oUEoG3RLNokmiidpIQXKejhlzQg19yqwzwTts2+tLC1wri9 i/ryiIQ7CEsQT+pGke7jc38FhvsLMRMly6ZOwyTK/8orwktVsYb225F4ac2AleMuYhQt duXIr0pFgMWrhwiAhjvo9/IzT8oVBactkFqGTse9h4I+YHuDQxA3paTFHpNrjRCLkxtc SWy+KcBYBHyC6H2/4tAQcxTmNmt0jOmJ8TNIpIzGPV7OtOYMHRa/oC/4Pt+htYQRTYpX +wLQ== X-Gm-Message-State: AAQBX9eXrrgOJODQG5ryh0865/T20tWnkolCttO4qA5GZbiME+KzNu19 Fcl04CtmdONr99KpZQPro9U= X-Google-Smtp-Source: AKy350aV1Ors/g6JzSD268/B3yKR9I6Sc9dTLZtDZeBrLlR0Wcusuyc+EViVufJPdOqwAefBMqE0Jw== X-Received: by 2002:ac2:4daf:0:b0:4dd:9a38:1b9c with SMTP id h15-20020ac24daf000000b004dd9a381b9cmr673660lfe.20.1680611075108; Tue, 04 Apr 2023 05:24:35 -0700 (PDT) Received: from fedora ([213.255.186.46]) by smtp.gmail.com with ESMTPSA id f21-20020ac25335000000b004b40c1f1c70sm2299547lfh.212.2023.04.04.05.24.34 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 04 Apr 2023 05:24:34 -0700 (PDT) Date: Tue, 4 Apr 2023 15:24:15 +0300 From: Matti Vaittinen To: Matti Vaittinen , Matti Vaittinen Cc: Andrea Merello , Matti Vaittinen , Jonathan Cameron , Jonathan Cameron , Lars-Peter Clausen , Andy Shevchenko , linux-iio@vger.kernel.org, linux-kernel@vger.kernel.org, Jagath Jog J Subject: [RESEND PATCH v2 0/3] Improve kernel docs Message-ID: MIME-Version: 1.0 Content-Disposition: inline Precedence: bulk List-ID: X-Mailing-List: linux-iio@vger.kernel.org IIO has very nice facilities for efficiently providing data from a device to user (and probably also vice-versa - but I've not used that direction). Getting started with IIO may not be so simple though - some of the concepts like triggers and buffers are quite unique. This series tries to make it easier for a newcomer to write his/her first IIO driver by adding some documentation to used enums. Series does not provide extensive documentation but just documents those few entries I have become familiar with - but it still aims to be a starting point for others to add missing bits and pieces. This series is marked as v2 because the patch 1 was previously sent as a stan-alone RFC to collect the missing channel units. RFC can be seen here: https://lore.kernel.org/all/10a855f9adc1d710150b7f647500c3c6a769f9ca.1677243698.git.mazziesaccount@gmail.com/ Patches 2 and 3 were added as a result of discussion followed by the RFC. Revision history: v2 resend: - rebased on v6.3-rc2 RFCv1 => v2: - added patches 2 and 3 - added missing channel type docs provided by Jonathan - added @in front of member names and fix typos pointed by Andy - dropped TODOs as Jonathan clarified the units --- Matti Vaittinen (3): iio: Add some kerneldoc for channel types iio: add documentation for iio_chan_info_enum doc: Make sysfs-bus-iio doc more exact Documentation/ABI/testing/sysfs-bus-iio | 11 +- include/linux/iio/types.h | 46 +++++++- include/uapi/linux/iio/types.h | 134 ++++++++++++++++++++++++ 3 files changed, 185 insertions(+), 6 deletions(-) base-commit: eeac8ede17557680855031c6f305ece2378af326