From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-16.7 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_GIT autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id EC58FC433DB for ; Fri, 12 Feb 2021 22:28:34 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id B76C264E92 for ; Fri, 12 Feb 2021 22:28:34 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S232035AbhBLW2R (ORCPT ); Fri, 12 Feb 2021 17:28:17 -0500 Received: from mga03.intel.com ([134.134.136.65]:60271 "EHLO mga03.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S231394AbhBLWY5 (ORCPT ); Fri, 12 Feb 2021 17:24:57 -0500 IronPort-SDR: 4I637Pr5KS5ONDKPPd43Lp3HUgck0txoyKCcJ+b7fLU+4yAaO/An56rJ/L12/9XYe2gOSvonob siSutWZ7uEYQ== X-IronPort-AV: E=McAfee;i="6000,8403,9893"; a="182555233" X-IronPort-AV: E=Sophos;i="5.81,174,1610438400"; d="scan'208";a="182555233" Received: from orsmga003.jf.intel.com ([10.7.209.27]) by orsmga103.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 12 Feb 2021 14:23:09 -0800 IronPort-SDR: uGl1TIc7eeI9aEP+MrrK5ifyuS0+uGxLNFKvhVLKOQVeVmUlXFq1weKdgOHhCIQkyHGl7vIdxN G7Ct5XG4ltRQ== X-IronPort-AV: E=Sophos;i="5.81,174,1610438400"; d="scan'208";a="360580349" Received: from smtp.ostc.intel.com ([10.54.29.231]) by orsmga003-auth.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 12 Feb 2021 14:23:09 -0800 Received: from mtg-dev.jf.intel.com (mtg-dev.jf.intel.com [10.54.74.10]) by smtp.ostc.intel.com (Postfix) with ESMTP id 2A4AC6368; Fri, 12 Feb 2021 14:23:09 -0800 (PST) Received: by mtg-dev.jf.intel.com (Postfix, from userid 1000) id 22F4036370E; Fri, 12 Feb 2021 14:23:09 -0800 (PST) From: mgross@linux.intel.com To: markgross@kernel.org, mgross@linux.intel.com, arnd@arndb.de, bp@suse.de, damien.lemoal@wdc.com, dragan.cvetic@xilinx.com, gregkh@linuxfoundation.org, corbet@lwn.net, palmerdabbelt@google.com, paul.walmsley@sifive.com, peng.fan@nxp.com, robh+dt@kernel.org, shawnguo@kernel.org, jassisinghbrar@gmail.com Cc: linux-kernel@vger.kernel.org, "C, Udhayakumar" , devicetree@vger.kernel.org Subject: [PATCH v6 32/34] dt-bindings: misc: hddl_dev: Add hddl device management documentation Date: Fri, 12 Feb 2021 14:23:02 -0800 Message-Id: <20210212222304.110194-33-mgross@linux.intel.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20210212222304.110194-1-mgross@linux.intel.com> References: <20210212222304.110194-1-mgross@linux.intel.com> Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org From: "C, Udhayakumar" Add hddl device management documentation The HDDL client driver acts as an software RTC to sync with network time. It abstracts xlink protocol to communicate with remote IA host. This driver exports the details about sensors available in the platform to remote IA host as xlink packets. This driver also handles device connect/disconnect events and identifies board id and soc id using gpio's based on platform configuration. Cc: Rob Herring Cc: devicetree@vger.kernel.org Signed-off-by: C Udhayakumar Signed-off-by: Mark Gross --- .../bindings/misc/intel,hddl-client.yaml | 117 ++++++++++++++++++ 1 file changed, 117 insertions(+) create mode 100644 Documentation/devicetree/bindings/misc/intel,hddl-client.yaml diff --git a/Documentation/devicetree/bindings/misc/intel,hddl-client.yaml b/Documentation/devicetree/bindings/misc/intel,hddl-client.yaml new file mode 100644 index 000000000000..522b461663b5 --- /dev/null +++ b/Documentation/devicetree/bindings/misc/intel,hddl-client.yaml @@ -0,0 +1,117 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: "http://devicetree.org/schemas/misc/intel,hddl-client.yaml#" +$schema: "http://devicetree.org/meta-schemas/core.yaml#" + +title: Intel hddl client device to handle platform management in Bay series + +maintainers: + - Udhayakumar C + +description: | + The HDDL client driver acts as an software RTC to sync with network time. + It abstracts xlink protocol to communicate with remote host. This driver + exports the details about sensors available in the platform to remote + host as xlink packets. + This driver also handles device connect/disconnect events and identifies + board id and soc id using gpio's based on platform configuration. + +select: false + +properties: + compatible: + items: + - const: intel,hddl-client + + reg: + minItems: 4 + maxItems: 4 + + xlink_chan: + minItems: 1 + maxItems: 1 + description: xlink channel number used for communication + with remote host for time sync and sharing sensor + details available in platform. + + i2c_xlink_chan: + minItems: 1 + maxItems: 1 + description: xlink channel number used for communication + with remote host for xlink i2c smbus. + + sensor_name: + type: object + description: + Details about sensors and its configuration on local host and remote + host. + + properties: + compatible: + items: + - const: intel_tsens + + reg: + description: i2c slave address for sensor. + + local-host: + minItems: 1 + maxItems: 1 + description: enable bit 0 to register sensor as i2c slave + in local host (normal i2c client) + enable bit 1 to mimic sensor as i2c slave + in local host (onchip sensors as i2c slave) + enable bit 2 to register i2c slave as xlink smbus slave + in local host. + remote-host: + minItems: 1 + maxItems: 1 + description: enable bit 0 to register sensor as i2c slave + in remote host (normal i2c client) + enable bit 1 to mimic sensor as i2c slave + in remote host (onchip sensors as i2c slave) + enable bit 2 to register i2c slave as xlink smbus slave + in remote host. + + bus: + minItems: 1 + maxItems: 1 + description: i2c bus number for the i2c client device. + + required: + - compatible + - reg + - local-host + - remote-host + - bus + +required: + - compatible + - reg + - xlink_chan + - i2c_xlink_chan + +additionalProperties: false + +examples: + - | + hddl_dev{ + #address-cells = <2>; + #size-cells = <2>; + + hddl@20320000 { + compatible = "intel,hddl-client"; + status = "disabled"; + reg = <0x0 0x20320000 0x0 0x800>; + xlink_chan = <1080>; + i2c_xlink_chan = <1081>; + kmb_xlink_tj { + status = "okay"; + compatible = "intel_tsens"; + local-host = <0x3>; + remote-host = <0x3>; + bus = <0x1>; + }; + }; + }; -- 2.17.1