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=-11.8 required=3.0 tests=DKIM_INVALID,DKIM_SIGNED, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI, MENTIONS_GIT_HOSTING,SIGNED_OFF_BY,SPF_PASS,URIBL_BLOCKED autolearn=ham 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 481D6C43441 for ; Thu, 22 Nov 2018 01:33:06 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 07F1D2075B for ; Thu, 22 Nov 2018 01:33:06 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=fail reason="signature verification failed" (2048-bit key) header.d=wdc.com header.i=@wdc.com header.b="SFMRT9Jq" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 07F1D2075B Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=wdc.com Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2391541AbeKVMKD (ORCPT ); Thu, 22 Nov 2018 07:10:03 -0500 Received: from esa4.hgst.iphmx.com ([216.71.154.42]:46922 "EHLO esa4.hgst.iphmx.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1732502AbeKVMKC (ORCPT ); Thu, 22 Nov 2018 07:10:02 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=wdc.com; i=@wdc.com; q=dns/txt; s=dkim.wdc.com; t=1542850384; x=1574386384; h=subject:to:cc:references:from:message-id:date: mime-version:in-reply-to:content-transfer-encoding; bh=oLQT0GYVT35cr6JKZjSsUjHwzJHgOxZfW3U3a4fVL8I=; b=SFMRT9Jqg1KARXF0raxttU6P2LH0jTV9t0IRnge2DeqIM4KGYkiRKKxP CrL974++YNZ69wqvUhJbgz6rjbEbFjtCdwR8fMY70+k7H2cqP1uwkOjoj 3cdajy1m79aVYOm/MdXHSRySPVzcnSWkVA6LFAzu75Fge9CLB8uTEhHbC LYnEKwmaczNokLiU3IQqTtr2R4/Nk6NJfhKRxB9uRRqGxT6n7sxZdLdmZ RGDtN7Gmn33LG64t9ExquL5gt6i47ko9XDMMuqHLBBiQzBkcTzxfQFt4/ hSjIGix5qjoI6fLor4T/AR3BPfFl3V5Tb8iO7C/ovc4Bx8W8l5YeaUPjU g==; X-IronPort-AV: E=Sophos;i="5.56,263,1539619200"; d="scan'208";a="94857728" Received: from uls-op-cesaip01.wdc.com (HELO uls-op-cesaep01.wdc.com) ([199.255.45.14]) by ob1.hgst.iphmx.com with ESMTP; 22 Nov 2018 09:33:04 +0800 Received: from uls-op-cesaip02.wdc.com ([10.248.3.37]) by uls-op-cesaep01.wdc.com with ESMTP; 21 Nov 2018 17:15:48 -0800 Received: from usa005005.ad.shared (HELO [10.86.56.42]) ([10.86.56.42]) by uls-op-cesaip02.wdc.com with ESMTP; 21 Nov 2018 17:33:03 -0800 Subject: Re: [PATCH] dt-bindings: sifive: describe sifive-blocks versioning To: Paul Walmsley , Rob Herring , "devicetree@vger.kernel.org" Cc: Mark Rutland , "paul@pwsan.com" , Megan Wachs , Palmer Dabbelt , "linux-kernel@vger.kernel.org" , Wesley Terpstra , "linux-riscv@lists.infradead.org" References: From: Atish Patra Message-ID: Date: Wed, 21 Nov 2018 17:33:02 -0800 User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.13; rv:60.0) Gecko/20100101 Thunderbird/60.3.0 MIME-Version: 1.0 In-Reply-To: Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-US Content-Transfer-Encoding: 7bit Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On 11/21/18 5:07 PM, Paul Walmsley wrote: > > For IP blocks that are generated from the public, open-source > sifive-blocks repository, describe the version numbering policy > that its maintainers intend to use, upon request from Rob > Herring . > > Cc: Rob Herring > Cc: Palmer Dabbelt > Cc: Megan Wachs > Cc: Wesley Terpstra > Cc: Mark Rutland > Cc: devicetree@vger.kernel.org > Cc: linux-riscv@lists.infradead.org > Cc: linux-kernel@vger.kernel.org > Signed-off-by: Paul Walmsley > Signed-off-by: Paul Walmsley > --- > > Hi Rob, please let me know if this document works with your > requirements, or if some changes are needed. - Paul > > .../sifive/sifive-blocks-ip-versioning.txt | 38 +++++++++++++++++++ > 1 file changed, 38 insertions(+) > create mode 100644 Documentation/devicetree/bindings/sifive/sifive-blocks-ip-versioning.txt > > diff --git a/Documentation/devicetree/bindings/sifive/sifive-blocks-ip-versioning.txt b/Documentation/devicetree/bindings/sifive/sifive-blocks-ip-versioning.txt > new file mode 100644 > index 000000000000..b899e5c6e00c > --- /dev/null > +++ b/Documentation/devicetree/bindings/sifive/sifive-blocks-ip-versioning.txt It should be be under Documentation/devicetree/bindings/riscv/sifive/sifive-blocks-ip-versioning.txt ? > @@ -0,0 +1,38 @@ > +DT compatible string versioning for SiFive open-source IP blocks > + > +This document describes the version specification for DT "compatible" > +strings for open-source SiFive IP blocks. HDL for these IP blocks > +can be found in this public repository: > + > +https://github.com/sifive/sifive-blocks > + > +IP block-specific DT compatible strings are contained within the HDL, > +in the form "sifive,". > + > +An example is "sifive,uart0" from: > + > +https://github.com/sifive/sifive-blocks/blob/master/src/main/scala/devices/uart/UART.scala#L43 > + > +Until these IP blocks (or IP integration) support version > +autodiscovery, the maintainers of these IP blocks intend to increment /s/autodiscovery/auto discovery > +the suffixed number in the compatible string whenever the software > +interface to these IP blocks changes, or when the functionality of the > +underlying IP blocks changes in a way that software should be aware of. > + > +Driver developers can use compatible string "match" values such as > +"sifive,uart0" to indicate that their driver is compatible with the > +register interface and functionality associated with the relevant > +upstream sifive-blocks commits. It is expected that most drivers will > +match on these IP block-specific compatible strings. > + > +DT data authors, when writing data for a particular SoC, should > +continue to specify an SoC-specific compatible string value, such as > +"sifive,fu540-c000-uart". This way, if SoC-specific > +integration-specific bug fixes or workarounds are needed, the kernel > +or other system software can match on this string to apply them. The > +IP block-specific compatible string (such as "sifive,uart0") should > +then be specified as a subsequent value. > + > +An example of this style: > + > + compatible = "sifive,fu540-c000-uart", "sifive,uart0"; > Just for the sake of completion, should this document also specify what should be the style of any possible closed IP as well? Regards, Atish