Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
From:   Sean Anderson <sean.anderson@seco.com>
To:     Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
        linux-usb@vger.kernel.org
Cc:     linux-kernel@vger.kernel.org,
        Robert Hancock <robert.hancock@calian.com>,
        Baruch Siach <baruch@tkos.co.il>,
        Felipe Balbi <balbi@kernel.org>,
        Balaji Prakash J <bjagadee@codeaurora.org>,
        Sean Anderson <sean.anderson@seco.com>,
        Rob Herring <robh+dt@kernel.org>, devicetree@vger.kernel.org
Subject: [PATCH 1/6] dt-bindings: usb: dwc3: Deprecate snps,ref-clock-period-ns
Date:   Fri, 14 Jan 2022 18:38:59 -0500
Message-Id: <20220114233904.907918-2-sean.anderson@seco.com>
In-Reply-To: <20220114233904.907918-1-sean.anderson@seco.com>
References: <20220114233904.907918-1-sean.anderson@seco.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?OK1943Tn6mrUxafuh/t6cWC0vA7ywEAXLSmdOLs61q7LXpRMOIv/GHh7gh6q?=
 =?us-ascii?Q?RJ3Wd7z2DKG4yf2QVGEaCNK3pGAMGljouNvGdKAUmTFb0VeIkQ2zl/cU9Ir5?=
 =?us-ascii?Q?B6HsHh+4oRmBF5aW0mJfSkheHV9OPYwqWbTFY3VRzxGLXGhxubJUh9lskEZ2?=
 =?us-ascii?Q?hbC+bYDlB/97mK0oxFB9DaFRzMJ0Rj0jur1UF58oFWFbNim3wXDoZ4qydxXN?=
 =?us-ascii?Q?xVwrZY01kzf5DAeUZKjlKm4/CXDiXKN85cZUWKVJTtQdoKaZr3d1DQKLsF8j?=
 =?us-ascii?Q?t0O77fmHIi0rI4RO0Zwmf3FGpuTJJnVx/vZVgRsQM6Xbi4nLwA7w5TQHQ61J?=
 =?us-ascii?Q?aZa9aV8xK29V/Wk/8BYJ84MS73Th4tvOHoFULSVhonmrLhdmjgdFB76zKKkv?=
 =?us-ascii?Q?Dty6ZMs+IqkpZbhURpVqgV0WexTRgWQR/6SefsQzp1JLoy5ieyG2tuDr61l+?=
 =?us-ascii?Q?Bd3SD02HXNkVN8uERmwU+AWrICpFC8WWnfMWKs1b2K7S4LVCdWZcrw3vzS5p?=
 =?us-ascii?Q?Rg+ZkslWjYJAsm2J7o2hmNrFt23oNPfHYq0oMxKPLy8jnC2X5yTkn1NECG+8?=
 =?us-ascii?Q?34QDbGKxIZN4JwPzGrNBFp6+cuZz65DSKFkb5RJ+n+x2B87rXb2TnamM2hws?=
 =?us-ascii?Q?KvXEekn+pgxhj7sk3vdJ5gq4Gc3ajf79CEceXKtK/AY+Ac8vSjnK1g/FQEwF?=
 =?us-ascii?Q?4CyVmFIY7xtnT5WLojzL2TTU/cPo/DK/hfYpYqQHLm6PN5QbRHyPUms9olfh?=
 =?us-ascii?Q?VPhNS4iVZEYjibiZYI9uQBnAKrIaYvy4HPhbzxqcxb6VgiEZW8VgFE2DGjPQ?=
 =?us-ascii?Q?MTTxbD79N7kS38CIbdGR9iAIntLkySbyloUfaSdAT8Tlxwug0g75gTh3LJkZ?=
 =?us-ascii?Q?JQptom6C953qCypdqiDPTNk7yvtNNpe2aibMqK3V7CNLLFrf1I8cDoGRgNLF?=
 =?us-ascii?Q?y46A/vMEBcoYqDpHTNoXK91zf85704R1VSISpV9mhJCTwK4h02s7uaeLnDi+?=
 =?us-ascii?Q?+CqWXoK29VremmlffH3/vZ5LUCnIPw+sZLmnz/YYjWN5aFbigaRx7pfUpkNY?=
 =?us-ascii?Q?RPn3+8P2fWRaHwd4yxbCjqP/5ausHpetwIb5Fo0lFVNTMWsisOwXylJ3KYEO?=
 =?us-ascii?Q?uooqNaNt+5jOmAyac14XEj9vgmAmpZXT4CryVzP1OSC8NQXYKJmu5wdE7bhL?=
 =?us-ascii?Q?gX58hrpJOPsnrW1x1OdpiAqQnEByF+ZaxvQHhYhv+LWIe5sNFgKm1GqXC9zy?=
 =?us-ascii?Q?LVjc4OIBGuNO1LQshy4vD8NIDOgV9arUIQJj3R+WVr5Ncfdds7vUAeKtGS6b?=
 =?us-ascii?Q?sFvu1LGewcrfF5W+3CKb/FQYGqbv50n32Leh0Qt4hHCMMXKMm0VnaCA84Fty?=
 =?us-ascii?Q?PzwyDwp+W9HsdCMPlnQ+UpI3hbaK+ubfN+AUPGt8UPvA3YYbbVAC9DhQrcUk?=
 =?us-ascii?Q?lZCKUn/yS65VQeLTATFurqPK1XW8IR1jFb5lZAbEpUzIAWYgdo4MVub7x99E?=
 =?us-ascii?Q?8w5L8TqbWOPhGHoxTpNzPejETp+79L6pA38qTCmGaeU3vfXEd/J00fQzNK/Y?=
 =?us-ascii?Q?MNy0v/jjUhjdDNdq+L3GkXNxKsAABwhbHO6e6/RWwQMRVo0/wKx8b1nxpcCo?=
 =?us-ascii?Q?i0ZzRgBO9hVaoME3lb2eif0=3D?=
X-OriginatorOrg: seco.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 7a601351-1a85-4208-2b8f-08d9d7b715df
X-MS-Exchange-CrossTenant-AuthSource: DB7PR03MB4523.eurprd03.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 14 Jan 2022 23:39:20.2913
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: bebe97c3-6438-442e-ade3-ff17aa50e733
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: 5HCcYmVaclbs+PDZayj1q6JX5cqcc7aYEDAN89qF5OGGQn79Ty38TTaHUv9V70FLnC4vuZdi7HjdrT0+ke3/MQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: VI1PR03MB4336
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

This property is redundant because we can determine the correct value for
REFCLKPER based on the "ref" clock. Deprecate it, and encourage users to
provide a clock instead. This also restricts the minimum and maximum to the
values documented in the register reference [1].

[1] https://www.xilinx.com/html_docs/registers/ug1087/usb3_xhci___guctl.html

Signed-off-by: Sean Anderson <sean.anderson@seco.com>
---

 Documentation/devicetree/bindings/usb/snps,dwc3.yaml | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/Documentation/devicetree/bindings/usb/snps,dwc3.yaml b/Documentation/devicetree/bindings/usb/snps,dwc3.yaml
index d29ffcd27472..4f2b0913ad9f 100644
--- a/Documentation/devicetree/bindings/usb/snps,dwc3.yaml
+++ b/Documentation/devicetree/bindings/usb/snps,dwc3.yaml
@@ -263,8 +263,11 @@ properties:
       Value for REFCLKPER field of GUCTL register for reference clock period in
       nanoseconds, when the hardware set default does not match the actual
       clock.
-    minimum: 1
-    maximum: 0x3ff
+
+      This binding is deprecated. Instead, provide an appropriate reference clock.
+    minimum: 8
+    maximum: 62
+    deprecated: true
 
   snps,rx-thr-num-pkt-prd:
     description:
-- 
2.25.1