From patchwork Mon Jul 19 22:13:20 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sean Anderson X-Patchwork-Id: 481746 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,DKIM_SIGNED, DKIM_VALID, HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_CR_TRAILER, INCLUDES_PATCH, MAILING_LIST_MULTI, MSGID_FROM_MTA_HEADER, 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 751C8C07E9D for ; Tue, 20 Jul 2021 00:04:22 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 4D2586115B for ; Tue, 20 Jul 2021 00:04:22 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S244087AbhGSXUv (ORCPT ); Mon, 19 Jul 2021 19:20:51 -0400 Received: from mail-eopbgr60063.outbound.protection.outlook.com ([40.107.6.63]:37942 "EHLO EUR04-DB3-obe.outbound.protection.outlook.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1388944AbhGSVdJ (ORCPT ); Mon, 19 Jul 2021 17:33:09 -0400 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=IIxrlV54aPssyetTdvwJCornTf3dLV0eGOEx0qYVeNVrZbUqRcLwr0mc0kY2tfxU4IoD/AgFd8uJ5NNV+qUW3FivOzAo0+joLQBMSUfsRXCE8yjsQe+7uuC2lGP1z/JPjER82NNb7GKU80WRuuyKrFZKum2MACFIdUhxgLKRk9EaKCJQZRJvi8K25sUOJkdmQ+HXT/nu6v9d/MIds6h2S8gMMiv8Hq2blJCO2TBgbCIqtADJ0J8gMLzSafSUYfwuBRrtSjEVcipu2B1eERkxu6wEweCcM6oIRncqDs8TFzEjMdwp8QpiP3TTsH+lYdyjupO7/umwZqPEhJaVnRPGgw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=4sNmb/LY1jza75jmELJzuI/x/FZwey0G5Z+9iTI/CKg=; b=i84O7es3q7twqdiUf2Dz3Yk2ufR4YbuXqc3+gu98qUlEm+2A+FsQBqCT5E5Kt/EAKUH/2w/njHdbSeeyTWP+AJySVrS8HNq3ngn8YXtWeDBRR7Bh90esIGa2EeUbJCkgkCO+ZFeaPRpaXVFSE6ASsyhJ6l+8f9s9MV+gHBYs8BTp2PeYy1ojFWSiEIIyygk8tPPphA2yaAdDZT09gUVk6ZpBFRrDKpolgUeXTOWvyRbqA58xpKEARe1z9ysBmkM/kPUFa5TxWrI9TblPNIV/lOfJiegXmJNK5OG3EW86OX3IVU+gDK0U5+aTRk86Og1EQd1CTRivTD0wDworeYmg5Q== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=seco.com; dmarc=pass action=none header.from=seco.com; dkim=pass header.d=seco.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=secospa.onmicrosoft.com; s=selector2-secospa-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=4sNmb/LY1jza75jmELJzuI/x/FZwey0G5Z+9iTI/CKg=; b=HAUV3iuHd/McJMMX64cwwpIjaP2ArrF4IFsU8bKzn4s3W0+HAUgkIR7UkbkLCRE4RgwMxS1jHokNc4HbPqQNomyNPeuhccl+4NAe0WpDqroTQ7QRSk9UMYxZStFq+MbxSOnwFfnbsmdXsmGOcKtS1JRu1c26BgQnqKo+cDtFmJQ= Authentication-Results: vger.kernel.org; dkim=none (message not signed) header.d=none; vger.kernel.org; dmarc=none action=none header.from=seco.com; Received: from DB7PR03MB4523.eurprd03.prod.outlook.com (2603:10a6:10:19::27) by DB7PR03MB3962.eurprd03.prod.outlook.com (2603:10a6:5:30::19) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4331.29; Mon, 19 Jul 2021 22:13:43 +0000 Received: from DB7PR03MB4523.eurprd03.prod.outlook.com ([fe80::dc6c:815b:2062:d1f1]) by DB7PR03MB4523.eurprd03.prod.outlook.com ([fe80::dc6c:815b:2062:d1f1%7]) with mapi id 15.20.4331.033; Mon, 19 Jul 2021 22:13:42 +0000 From: Sean Anderson To: linux-pwm@vger.kernel.org, devicetree@vger.kernel.org, Thierry Reding Cc: Alvaro Gamez , =?utf-8?q?Uwe_Kleine-K=C3=B6ni?= =?utf-8?q?g?= , michal.simek@xilinx.com, Lee Jones , linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org, Sean Anderson , Rob Herring Subject: [PATCH v5 1/3] dt-bindings: pwm: Add Xilinx AXI Timer Date: Mon, 19 Jul 2021 18:13:20 -0400 Message-Id: <20210719221322.3723009-1-sean.anderson@seco.com> X-Mailer: git-send-email 2.25.1 X-ClientProxiedBy: BLAPR03CA0132.namprd03.prod.outlook.com (2603:10b6:208:32e::17) To DB7PR03MB4523.eurprd03.prod.outlook.com (2603:10a6:10:19::27) MIME-Version: 1.0 X-MS-Exchange-MessageSentRepresentingType: 1 Received: from plantagenet.inhand.com (50.195.82.171) by BLAPR03CA0132.namprd03.prod.outlook.com (2603:10b6:208:32e::17) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4331.21 via Frontend Transport; Mon, 19 Jul 2021 22:13:41 +0000 X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 7a16fb50-aa01-4bfe-e195-08d94b02781e X-MS-TrafficTypeDiagnostic: DB7PR03MB3962: X-MS-Exchange-Transport-Forked: True X-Microsoft-Antispam-PRVS: X-MS-Oob-TLC-OOBClassifiers: OLM:6430; X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: ydmF7oWuhdHVS+/6zaaaPk/xZ1Y7zUibMOIt8MlM+Kn5Caex6CUzeyduUkjCS87K9zlVTX5fedaOzLDFncitEFtR2qiS+0zky7rIJHuNL+qU/tVu3aDqxUAuViP4G615TB8xdLQ7RBxMG/F+7GrMkvHO9wz0K/URgCy2B+SkMDcI6pmuIEikazcsn/PmskzPKBDw5T2qwJMmRk6uoTyTFKEPbEQeneKCd2iuaI7h3EOHLvum1+Pw/qF1VcoVq/NuLKG0xX39KEDuG/yxXw1aU6rz3xn7jJ3TVYg3sx92j4AfySvXENep+oSFvIwfrrC151FfVOYX3aVP/IaFxkuQdNFCNEiCDLLqbwIV2h0QvRY8Tqi79CmkhpUUzdS1bZEcyt2A+f9t2dPVoBwmwmvTutGjSWFZoie0ZkU32RbL5DwfUKPmT5exLheyT0l86HUrco68aFxCsYRtcOCrbMlETUuL3QOSqeZrrjpRqs5Deb9RweAi3aHIlD2A4k+NFUAWsou9WzVZQQ29pbMdsipxc9v692ITchNPQ1G2eMwT96aIT4Nj4gDER+PyeJw4NlNaRANGkrOg5nXYrUh/HoO4Pdu3Bx4I5abiLpj2nTRMGIMRbK7K0P+JBHLWzFrwXeXj/Hr6IWGqCxoTl7oAaNBsCbKdl3JoCQ8fmb4AAIoLDq9Ykb69rKEjMqY0zHIkbxRC+xhgFSDYQY5IOtc6IegrMKlvLMieG7IgrXprtYAeDqGciyC7/XRt6WU1KO1oIowEG1sZay07yKAx3yowg3hfuk0C63cvfGkgVFlYOWIXxYY= X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:DB7PR03MB4523.eurprd03.prod.outlook.com; PTR:; CAT:NONE; SFS:(366004)(1076003)(6916009)(6666004)(38100700002)(38350700002)(83380400001)(52116002)(316002)(44832011)(2616005)(36756003)(956004)(4326008)(54906003)(186003)(6506007)(66946007)(6512007)(66556008)(5660300002)(8676002)(26005)(508600001)(966005)(86362001)(6486002)(7416002)(2906002)(8936002)(66476007); DIR:OUT; SFP:1101; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: Vhlml4TdQ5uZS+ajMp+QGB5+WiggL9isVEC19zqpn5ZPsw64fKI2gyIMgB2me8uhuce9r0ZJxvUpKb6SKSNKa57ikbhgsh9KY4iNrJhaDjF8BbWJnlGVioz44oMU6qqfdOY31+3eYm2kNhz4McOlvZngyyHoKML30sWExe0nHv+MmWYxaeSGP1dG06TuF7etnFAJ5PxoyiKDZJnqtqqkk7g5sWVap49NQoG3jO7VCxzasjW5QL40KCdsiSPwAt5azvuZ99RDnzk0ug8KWzemhtt3jYaF+AiJTGCOkFj4hntD4PQeFcsJD871/DBGh0uhVJaxdhpuSxQ5TEXQnV8Mz7+qbsffc4KtQT2DpO9ilAWUD4RwgIu0b2FBm+6ygzD/5RXCDcX30vcCynolvvGt6EaIqQNbq5/nrXLKY3U3Ytsir5VptgQV9H4APNBebleM0ycbD1XibN45qcXkCdQE/mfuxoYaNBC2gaGsShGuRLKi9GpVdUH+4x3enkR1z2gZy4/B6aIqAWBuqjhoSkZ39fOm+mhQCJB36qtwTEF85F6EMq6y4kdWxhodT/P0CV5jJfRfApRuiKO6+yMfYIdTIm6W/tBEiLPmstVZTKMhNKiMLrkzqw43sVJYQfVLagFHCUNyptvSDK+FEVY5O24+EOR9pC0oGVpU0Xj5/92Q7vFKrexTD+7GlZF4RbzDU1bgvuJegfbmjyp07FoYR2snuxgttoEl6Si6YYRH/vDgChGgQHvnIPOeYl6R8u+dU0x4fSMa52z2Z/ikdXUSNx6FCbErS29jfar7HR1wesQfAg1MBR6WYfNz0Hz3jh4iH8oVY9TVWNBRb1585fEJylQYTomyUJ1r35dWGJS0a+BJCjVVdMAkUerdJF3C83My+WgxQkExa5xysJsXGaUUFeCJYvpMhHLXqiI5XfPXtbXfoVTvzsLJiiAJrstnX4bxNMrBzWDfUnAYimmMd8o917u0LLVDU9PmL7pijPakV1/5fI17/2DuLBQl+sCdxmh4SYFamNrOVfK9fmo1VwYpdp/FwuV9+drXaAQArIr4TrL91o7xv7vSkA2EnAfMWHM44dKJ+wm+VVRBcNCqpw+7gFrjbNR9MXqNcDwDABtzI4WOBY/V/7USV25Eh+zk8SWO87ot/ADHq1v+V6atAU7MvHOYIFkw9sJqaHpRAx2M0W/l6f+SNYi2LTsnDIY1fft9WaQd3xyh4Q6SjSPkvSL4hIyd56cEK+lqLB2YuGTUShS+OrWow8dZ75DejBpBm0ZA6I4ncv13iePIYTXnNUIVTTTh7kunomBSmrk/ptr5aV2mVu7zqffSuPxQcb7710VO7VTm X-OriginatorOrg: seco.com X-MS-Exchange-CrossTenant-Network-Message-Id: 7a16fb50-aa01-4bfe-e195-08d94b02781e X-MS-Exchange-CrossTenant-AuthSource: DB7PR03MB4523.eurprd03.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 19 Jul 2021 22:13:42.8102 (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: 0EzpjYQHxZNoZYQmP8Q5LUBgvObh73bkY9yKHEZJPDT87PakQYa9IKjQDRmMsXptX6RdGfprHp1rUWr64H6gXw== X-MS-Exchange-Transport-CrossTenantHeadersStamped: DB7PR03MB3962 Precedence: bulk List-ID: X-Mailing-List: devicetree@vger.kernel.org This adds a binding for the Xilinx LogiCORE IP AXI Timer. This device is a "soft" block, so it has some parameters which would not be configurable in most hardware. This binding is usually automatically generated by Xilinx's tools, so the names and values of some properties should be kept as they are, if possible. In addition, this binding is already in the kernel at arch/microblaze/boot/dts/system.dts, and in user software such as QEMU. The existing driver uses the clock-frequency property, or alternatively the /cpus/timebase-frequency property as its frequency input. Because these properties are deprecated, they have not been included with this schema. All new bindings should use the clocks/clock-names properties to specify the parent clock. Because we need to init timer devices so early in boot, we determine if we should use the PWM driver or the clocksource/clockevent driver by the presence/absence, respectively, of #pwm-cells. Because both counters are used by the PWM, there is no need for a separate property specifying which counters are to be used for the PWM. Signed-off-by: Sean Anderson --- Changes in v5: - Update commit message to reflect revisions - Fix indentation lint - Add example for timer binding - Remove xlnx,axi-timer-2.0 compatible string - Move schema into the timer directory Changes in v4: - Remove references to generate polarity so this can get merged - Predicate PWM driver on the presence of #pwm-cells - Make some properties optional for clocksource drivers Changes in v3: - Mark all boolean-as-int properties as deprecated - Add xlnx,pwm and xlnx,gen?-active-low properties. - Make newer replacement properties mutually-exclusive with what they replace - Add an example with non-deprecated properties only. Changes in v2: - Use 32-bit addresses for example binding .../bindings/timer/xlnx,xps-timer.yaml | 91 +++++++++++++++++++ 1 file changed, 91 insertions(+) create mode 100644 Documentation/devicetree/bindings/timer/xlnx,xps-timer.yaml diff --git a/Documentation/devicetree/bindings/timer/xlnx,xps-timer.yaml b/Documentation/devicetree/bindings/timer/xlnx,xps-timer.yaml new file mode 100644 index 000000000000..e5439653dc03 --- /dev/null +++ b/Documentation/devicetree/bindings/timer/xlnx,xps-timer.yaml @@ -0,0 +1,91 @@ +# SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/pwm/xlnx,axi-timer.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Xilinx LogiCORE IP AXI Timer Device Tree Binding + +maintainers: + - Sean Anderson + +properties: + compatible: + contains: + const: xlnx,xps-timer-1.00.a + + clocks: + maxItems: 1 + + clock-names: + const: s_axi_aclk + + interrupts: + maxItems: 1 + + reg: + maxItems: 1 + + xlnx,count-width: + $ref: /schemas/types.yaml#/definitions/uint32 + minimum: 8 + maximum: 32 + default: 32 + description: + The width of the counter(s), in bits. + + xlnx,one-timer-only: + $ref: /schemas/types.yaml#/definitions/uint32 + enum: [ 0, 1 ] + description: + Whether only one timer is present in this block. + +required: + - compatible + - reg + - xlnx,one-timer-only + +allOf: + - if: + required: + - '#pwm-cells' + then: + allOf: + - required: + - clocks + - properties: + xlnx,one-timer-only: + const: 0 + else: + required: + - interrupts + - if: + required: + - clocks + then: + required: + - clock-names + +additionalProperties: true + +examples: + - | + timer@800e0000 { + clock-names = "s_axi_aclk"; + clocks = <&zynqmp_clk 71>; + compatible = "xlnx,xps-timer-1.00.a"; + reg = <0x800e0000 0x10000>; + interrupts = <0 39 2>; + xlnx,count-width = <16>; + xlnx,one-timer-only = <0x0>; + }; + + timer@800f0000 { + #pwm-cells = <0>; + clock-names = "s_axi_aclk"; + clocks = <&zynqmp_clk 71>; + compatible = "xlnx,xps-timer-1.00.a"; + reg = <0x800e0000 0x10000>; + xlnx,count-width = <32>; + xlnx,one-timer-only = <0x0>; + }; From patchwork Mon Jul 19 22:13:21 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sean Anderson X-Patchwork-Id: 483570 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,DKIM_SIGNED, DKIM_VALID, HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_CR_TRAILER, INCLUDES_PATCH, MAILING_LIST_MULTI, MSGID_FROM_MTA_HEADER, 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 7EAE3C636C9 for ; Tue, 20 Jul 2021 00:04:22 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 5837A6113C for ; Tue, 20 Jul 2021 00:04:22 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S244459AbhGSXUz (ORCPT ); Mon, 19 Jul 2021 19:20:55 -0400 Received: from mail-eopbgr60056.outbound.protection.outlook.com ([40.107.6.56]:50766 "EHLO EUR04-DB3-obe.outbound.protection.outlook.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1389459AbhGSVdl (ORCPT ); Mon, 19 Jul 2021 17:33:41 -0400 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=BR6ViYaFRKzS7uQXDJsWEtXBNxwD1cFcQIotTHpAKjfP845ZTxzgGIMnE3kcGG6ILOb3teAUJ8ISTg+kbvRgMtDcOoptuytWTznX4qRyTgcmKgPb39cd1zUcmdSv6c/7CNkxkYq6ZuXxLuWdexdW9+e+HTuy60Y7h2urTU7+8gXEgrEkwa0/MsoahZHfupkZwxPbG6sNkjWlkMzvse9FwpIZW2tFJtV79+MKWDJrwtNWJvJZaQSK4QLao7yfXAk3R+dDL1/S0Kp+A++r3i1375Qef5938hZE4boHGQPCqSG6WVm1T4RxbL+r0Ol0SF7pCYlrbiRXxkpVe6DvzTK4nQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=UPS8dCKU4Zvwe+/L/x/P8EW3P6BnHaBs0EopH6uKEXQ=; b=nAD7dTSrLihG9sUaElyUvdWQQ8zJIsRNgomSkRPAlzdRUt7E2xQ1n+v4qH8eM8pYjR39XUGvupQ0ZCIzV/DGB1Bs/1Of1wY6ZNEX9xrJJtMe8NpSQD/wYTB8q+wT0iU2GbHovIYJ9j6JmAmwXHNQejYbqV1t/QaCbFoZZIGgSOSIoLDJcbr18Rm3kLwASG6GJGKpmI0Si5ooiAOXEg0PCoFXnJw3WhFMORNFkI03dsGEukWU9IgOnEHghqGxTJf4fWwImnwlVGcfDsAdEa0VaAsNOJInaisywTjHMeVgyVJGmu5PfnSv3CWjnATh150FjJuh9hKLSxJa9F9AmO4v8g== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=seco.com; dmarc=pass action=none header.from=seco.com; dkim=pass header.d=seco.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=secospa.onmicrosoft.com; s=selector2-secospa-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=UPS8dCKU4Zvwe+/L/x/P8EW3P6BnHaBs0EopH6uKEXQ=; b=dLjWDpQSWni8DTIJwfiBoF5e3GkTyFiX5B+wxa1v2W41FNxwgxWP82e1G6HlDSziQVPX4zflTDquK5PjaW2tc3T4VDS++vfoSv6GvwuWsWLyZvYOYGLjfW8O9hrsSlvWsCG7P3DsZeWahf32QN2LkQS55zd1yhH5G3NA4SwCFv8= Authentication-Results: vger.kernel.org; dkim=none (message not signed) header.d=none; vger.kernel.org; dmarc=none action=none header.from=seco.com; Received: from DB7PR03MB4523.eurprd03.prod.outlook.com (2603:10a6:10:19::27) by DB7PR03MB3962.eurprd03.prod.outlook.com (2603:10a6:5:30::19) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4331.29; Mon, 19 Jul 2021 22:13:45 +0000 Received: from DB7PR03MB4523.eurprd03.prod.outlook.com ([fe80::dc6c:815b:2062:d1f1]) by DB7PR03MB4523.eurprd03.prod.outlook.com ([fe80::dc6c:815b:2062:d1f1%7]) with mapi id 15.20.4331.033; Mon, 19 Jul 2021 22:13:45 +0000 From: Sean Anderson To: linux-pwm@vger.kernel.org, devicetree@vger.kernel.org, Thierry Reding Cc: Alvaro Gamez , =?utf-8?q?Uwe_Kleine-K=C3=B6ni?= =?utf-8?q?g?= , michal.simek@xilinx.com, Lee Jones , linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org, Sean Anderson , Daniel Lezcano , Thomas Gleixner Subject: [PATCH v5 2/3] clocksource: Rewrite Xilinx AXI timer driver Date: Mon, 19 Jul 2021 18:13:21 -0400 Message-Id: <20210719221322.3723009-2-sean.anderson@seco.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20210719221322.3723009-1-sean.anderson@seco.com> References: <20210719221322.3723009-1-sean.anderson@seco.com> X-ClientProxiedBy: BLAPR03CA0132.namprd03.prod.outlook.com (2603:10b6:208:32e::17) To DB7PR03MB4523.eurprd03.prod.outlook.com (2603:10a6:10:19::27) MIME-Version: 1.0 X-MS-Exchange-MessageSentRepresentingType: 1 Received: from plantagenet.inhand.com (50.195.82.171) by BLAPR03CA0132.namprd03.prod.outlook.com (2603:10b6:208:32e::17) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4331.21 via Frontend Transport; Mon, 19 Jul 2021 22:13:43 +0000 X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 9900d295-72c2-4525-dc78-08d94b027926 X-MS-TrafficTypeDiagnostic: DB7PR03MB3962: X-MS-Exchange-Transport-Forked: True X-Microsoft-Antispam-PRVS: X-MS-Oob-TLC-OOBClassifiers: OLM:983; X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: TsRYPaeE9zK4n7tmiZb1I8RnfWXljQKKEkgcZooolh9sQeTgwlegnRUvvwMwVoQFIWbE/msMh20pWOcSq0+TCDeJQZGGqH8NTthsHoPVKwyMDxBodtfQqE10v983/1lH9DH+2LiWIjlYkgyiylj1dr4Yc9GPbgDK4+xBD0mCHSWcK53oG7baICVcR+IueAYsJZi56J6CBT+PH/YO+cnxq5TEd8/dYFbXs14lsj7vojdTB3KoRIQ4UeUmFL+v8pPl5i1100so2adpHsgrsr92u4C7DUzCwNX/xCirkquN7paQlg9X6sYUKy77jRVg0a7HTp/nyHmkFsZ4ELDlz0hmGxTpv7eW6H+nX2HRCrh8A/OyfC3BQhZofxhlBMj6R2n+Z9RHDD/4o26SGF2VYnqz6GWRKjVym0wKnNzi6dyJHrN7D43N6Fyb2ec+kbrYNcdwYFhvyzcv+Qt89+p/mTYon5y7iTV7ywDkkkzbg3E1w9d9AZUMJCLiMqtdSlkqofyWGk1QOXiRdXCmaB8D3ew25r829o6vM9Y6s+YfDpDTv/eyiZjFo2EC4/ubpyrd+4I4xTLWs4vquFcPdnpkzxgZCs4dv4jb1SkWTaflfM6w2HXUzgpYZlJYiAMJLu4irQJGpNr3nOrhVRLCKZz0f0rTLdOJn9cAw74bUwi3mP9g985m8miBag2bh0mn1/sFMRafparMYuvdMADKT172aPW4yBPGQ+bdxpkbHVe+SdPYaVDWPF25wp2qmwnnfb95dfDcYMCvq6Rn7eWlzRk0HT089DKcQ8gILoihYP6YW3VI0r8= X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:DB7PR03MB4523.eurprd03.prod.outlook.com; PTR:; CAT:NONE; SFS:(366004)(1076003)(6916009)(6666004)(38100700002)(38350700002)(83380400001)(52116002)(316002)(44832011)(2616005)(36756003)(956004)(4326008)(54906003)(186003)(6506007)(66946007)(6512007)(66556008)(5660300002)(8676002)(26005)(508600001)(966005)(86362001)(6486002)(7416002)(2906002)(8936002)(30864003)(66476007); DIR:OUT; SFP:1101; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: TF39d74LYVfAn7KDiWT8UIyt/OclBCkYh49bZi2ZGYw2/K1XxCWg32Y4lWp+PHALjQgT2hhPRruyAOJ7ICpfpBw805eqoU6d2ASstS6AFQ4GB5iokhlqC1FIIKvpa+qFFl6NeWsNAAwJxlAEkHqCAgLxiFmWziy1EliaY0XVR0SVRcbj80KGiuFJ4Rnov2VZQlgEwQM8pjkz3sofPk5a8oVlSw6XX0100gLD4EYayBLAvNIael9hff9xGlbckg4jSrYLD8kJAqF+u28aPEu331WjrntyAm2qU2rB/22AdZo7TQPBalDE22FkZ5ATpXGQUG8hHVX/YdpLdlJQzK76S9vpYHpbEHgFY3pUUTMohse0piH76OSi0iUDCMBv1HD69nc8bLmzxvzi48RE59IwyIlB5L3iiFMN/lLcSUXIs/mRPPOCJzKWYKr8xEQej2B0KXW+XGVIEfoKPQkA+6NqA5wdGcJLKOSRO0ri7FkVQfVYPNUqpJ1Bvem8XvA2N3SxoTPNMqQEEJMEPBIyiGe7+YlD/G8S5HtJAhw+y9e5z4QJMrV2sfZw6ikVreZNRj4Kug/cUsfpWRjS8z5sB7NKqsuS+Ox13d+bOuaZHDRbFFTqz0TcWHSwHtfS5kHfCPDhz9l2JbjKzYeAg1rDQubWvJAca0w6wFg+bEy+DDRL/R6O+HJU0z5UotPq1AIOhvorgqmSOWe3ekEkZXG0k1MzGrCI/UaE4pWpf+vL3tI++z7aRntOXNjh42UZvETbJaOAUHF6gLWrEZBvpLy16UOfSuxt2U8UTIcQgP9vWd7oloTFeXRwnvKH/JcrvOI0ksKV56wCXe15yFphHrnfxqZEDS00mPvN9rltgH3azzd/NrIDuzvIg1NvRQ7OyOSL99wga2zIF3i1Jrs4VyecvP5Rs6wODhnhA9NeDq7N0U0xnxEvG0h3Gw4e+qmiHX5vq523+KtCI6QQL3XnSUazzaCjgNrZqPYDmvmBlLopXobOj6T7jCX/6oTwIUfP9AXh73XI6d+LVNCetQk/94B5JexTKyxhTqStuz7NsPkBbt1fVaBGmPEXvNu+LYWrFFN6VSZhJIJ+xHM4I+dL6TykM7bSWW9xeNdz9sL9W8bvhgYcWTwDjgQgffM2P4q5OnwNJKRSMOnWpShAg5a0DvVp/W6OFXcu5G5PRMizXHN5OpOUeIVny4mAtBJ95mEx9f547nog2eiuh87B5DErOZ8oMtj2XRxoRIVqffnWut/QtVGfUQq6n0XYDXxvA9c7rhrO9zR4Q072t02Y0CVeimyQ4nHmsKjX9n1nQ5Va0Hl/iZAOD7SmbLS/PVvqA7D1i+FBlyOp X-OriginatorOrg: seco.com X-MS-Exchange-CrossTenant-Network-Message-Id: 9900d295-72c2-4525-dc78-08d94b027926 X-MS-Exchange-CrossTenant-AuthSource: DB7PR03MB4523.eurprd03.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 19 Jul 2021 22:13:44.6282 (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: zyQg86wT6dwpcnjTntgGpFWL/bMuGnVsKtKDXpN+z8cfi8EC3enyMMFN+S8F9yePyONa3Uvc0LkVNSC3xtRKzg== X-MS-Exchange-Transport-CrossTenantHeadersStamped: DB7PR03MB3962 Precedence: bulk List-ID: X-Mailing-List: devicetree@vger.kernel.org This rewrites the Xilinx AXI timer driver to be more platform agnostic. Some common code has been split off so it can be reused. These routines currently live in drivers/mfd. The largest changes have taken place in the initialization: - We now support any number of timer devices, possibly with only one counter each. The first counter will be used as a clocksource. Every other counter will be used as a clockevent. - We do not use timer_of_init because we need to perform some tasks in between different stages. For example, we must ensure that ->read and ->write are initialized before registering the irq. This can only happen after we have gotten the register base (to detect endianness). We also have a rather unusual clock initialization sequence in order to remain backwards compatible. Due to this, it's ok for the initial clock request to fail, and we do not want other initialization to be undone. Lastly, it is more convenient to do one allocation for xilinx_clockevent_device than to do one for timer_of and one for xilinx_timer_priv. - We now pay attention to xlnx,count-width and handle smaller width timers. The default remains 32. - We access registers using regmap. This automatically deals with endianness issues, so we no longer have to use our own wrappers. It also provides locking for clockevents which have to worry about being interrupted in the middle of a read/modify/write. Note that while the existing timer driver always sets the cpumask to cpu 0, this version sets it to all possible CPUs. I believe this is correct for multiprocessor systems where the timer is not physically wired to a particular CPU's interrupt line. For uniprocessor systems (like most microblaze systems) this makes no difference. Signed-off-by: Sean Anderson --- This has been tested on microblaze qemu. Changes in v5: - Remove duplicate register definitions - Remove xilinx_timer_tlr_period - Require that callers check arguments to xilinx_timer_tlr_cycles - Remove xlnx,axi-timer-2.0 compatible string - Use regmap to deal with endianness issues as suggested by Lee - Fix some overflows when setting the max value for clockevent and sched_clock - Just use clk_register_fixed_rate instead of the "private" version Changes in v4: - Break out clock* drivers into their own file MAINTAINERS | 6 + arch/microblaze/kernel/Makefile | 3 +- arch/microblaze/kernel/timer.c | 326 --------------------- drivers/clocksource/Kconfig | 12 + drivers/clocksource/Makefile | 1 + drivers/clocksource/timer-xilinx-common.c | 67 +++++ drivers/clocksource/timer-xilinx.c | 331 ++++++++++++++++++++++ include/clocksource/timer-xilinx.h | 91 ++++++ 8 files changed, 509 insertions(+), 328 deletions(-) delete mode 100644 arch/microblaze/kernel/timer.c create mode 100644 drivers/clocksource/timer-xilinx-common.c create mode 100644 drivers/clocksource/timer-xilinx.c create mode 100644 include/clocksource/timer-xilinx.h diff --git a/MAINTAINERS b/MAINTAINERS index bd7aff0c120f..252d71addd18 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -20046,6 +20046,12 @@ F: drivers/misc/Makefile F: drivers/misc/xilinx_sdfec.c F: include/uapi/misc/xilinx_sdfec.h +XILINX TIMER/PWM DRIVER +M: Sean Anderson +S: Maintained +F: drivers/clocksource/timer-xilinx* +F: include/clocksource/timer-xilinx.h + XILINX UARTLITE SERIAL DRIVER M: Peter Korsgaard L: linux-serial@vger.kernel.org diff --git a/arch/microblaze/kernel/Makefile b/arch/microblaze/kernel/Makefile index 15a20eb814ce..3b6d725398f8 100644 --- a/arch/microblaze/kernel/Makefile +++ b/arch/microblaze/kernel/Makefile @@ -5,7 +5,6 @@ ifdef CONFIG_FUNCTION_TRACER # Do not trace early boot code and low level code -CFLAGS_REMOVE_timer.o = -pg CFLAGS_REMOVE_intc.o = -pg CFLAGS_REMOVE_early_printk.o = -pg CFLAGS_REMOVE_ftrace.o = -pg @@ -17,7 +16,7 @@ extra-y := head.o vmlinux.lds obj-y += dma.o exceptions.o \ hw_exception_handler.o irq.o \ process.o prom.o ptrace.o \ - reset.o setup.o signal.o sys_microblaze.o timer.o traps.o unwind.o + reset.o setup.o signal.o sys_microblaze.o traps.o unwind.o obj-y += cpu/ diff --git a/arch/microblaze/kernel/timer.c b/arch/microblaze/kernel/timer.c deleted file mode 100644 index f8832cf49384..000000000000 --- a/arch/microblaze/kernel/timer.c +++ /dev/null @@ -1,326 +0,0 @@ -/* - * Copyright (C) 2007-2013 Michal Simek - * Copyright (C) 2012-2013 Xilinx, Inc. - * Copyright (C) 2007-2009 PetaLogix - * Copyright (C) 2006 Atmark Techno, Inc. - * - * This file is subject to the terms and conditions of the GNU General Public - * License. See the file "COPYING" in the main directory of this archive - * for more details. - */ - -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include - -static void __iomem *timer_baseaddr; - -static unsigned int freq_div_hz; -static unsigned int timer_clock_freq; - -#define TCSR0 (0x00) -#define TLR0 (0x04) -#define TCR0 (0x08) -#define TCSR1 (0x10) -#define TLR1 (0x14) -#define TCR1 (0x18) - -#define TCSR_MDT (1<<0) -#define TCSR_UDT (1<<1) -#define TCSR_GENT (1<<2) -#define TCSR_CAPT (1<<3) -#define TCSR_ARHT (1<<4) -#define TCSR_LOAD (1<<5) -#define TCSR_ENIT (1<<6) -#define TCSR_ENT (1<<7) -#define TCSR_TINT (1<<8) -#define TCSR_PWMA (1<<9) -#define TCSR_ENALL (1<<10) - -static unsigned int (*read_fn)(void __iomem *); -static void (*write_fn)(u32, void __iomem *); - -static void timer_write32(u32 val, void __iomem *addr) -{ - iowrite32(val, addr); -} - -static unsigned int timer_read32(void __iomem *addr) -{ - return ioread32(addr); -} - -static void timer_write32_be(u32 val, void __iomem *addr) -{ - iowrite32be(val, addr); -} - -static unsigned int timer_read32_be(void __iomem *addr) -{ - return ioread32be(addr); -} - -static inline void xilinx_timer0_stop(void) -{ - write_fn(read_fn(timer_baseaddr + TCSR0) & ~TCSR_ENT, - timer_baseaddr + TCSR0); -} - -static inline void xilinx_timer0_start_periodic(unsigned long load_val) -{ - if (!load_val) - load_val = 1; - /* loading value to timer reg */ - write_fn(load_val, timer_baseaddr + TLR0); - - /* load the initial value */ - write_fn(TCSR_LOAD, timer_baseaddr + TCSR0); - - /* see timer data sheet for detail - * !ENALL - don't enable 'em all - * !PWMA - disable pwm - * TINT - clear interrupt status - * ENT- enable timer itself - * ENIT - enable interrupt - * !LOAD - clear the bit to let go - * ARHT - auto reload - * !CAPT - no external trigger - * !GENT - no external signal - * UDT - set the timer as down counter - * !MDT0 - generate mode - */ - write_fn(TCSR_TINT|TCSR_ENIT|TCSR_ENT|TCSR_ARHT|TCSR_UDT, - timer_baseaddr + TCSR0); -} - -static inline void xilinx_timer0_start_oneshot(unsigned long load_val) -{ - if (!load_val) - load_val = 1; - /* loading value to timer reg */ - write_fn(load_val, timer_baseaddr + TLR0); - - /* load the initial value */ - write_fn(TCSR_LOAD, timer_baseaddr + TCSR0); - - write_fn(TCSR_TINT|TCSR_ENIT|TCSR_ENT|TCSR_ARHT|TCSR_UDT, - timer_baseaddr + TCSR0); -} - -static int xilinx_timer_set_next_event(unsigned long delta, - struct clock_event_device *dev) -{ - pr_debug("%s: next event, delta %x\n", __func__, (u32)delta); - xilinx_timer0_start_oneshot(delta); - return 0; -} - -static int xilinx_timer_shutdown(struct clock_event_device *evt) -{ - pr_info("%s\n", __func__); - xilinx_timer0_stop(); - return 0; -} - -static int xilinx_timer_set_periodic(struct clock_event_device *evt) -{ - pr_info("%s\n", __func__); - xilinx_timer0_start_periodic(freq_div_hz); - return 0; -} - -static struct clock_event_device clockevent_xilinx_timer = { - .name = "xilinx_clockevent", - .features = CLOCK_EVT_FEAT_ONESHOT | - CLOCK_EVT_FEAT_PERIODIC, - .shift = 8, - .rating = 300, - .set_next_event = xilinx_timer_set_next_event, - .set_state_shutdown = xilinx_timer_shutdown, - .set_state_periodic = xilinx_timer_set_periodic, -}; - -static inline void timer_ack(void) -{ - write_fn(read_fn(timer_baseaddr + TCSR0), timer_baseaddr + TCSR0); -} - -static irqreturn_t timer_interrupt(int irq, void *dev_id) -{ - struct clock_event_device *evt = &clockevent_xilinx_timer; - timer_ack(); - evt->event_handler(evt); - return IRQ_HANDLED; -} - -static __init int xilinx_clockevent_init(void) -{ - clockevent_xilinx_timer.mult = - div_sc(timer_clock_freq, NSEC_PER_SEC, - clockevent_xilinx_timer.shift); - clockevent_xilinx_timer.max_delta_ns = - clockevent_delta2ns((u32)~0, &clockevent_xilinx_timer); - clockevent_xilinx_timer.max_delta_ticks = (u32)~0; - clockevent_xilinx_timer.min_delta_ns = - clockevent_delta2ns(1, &clockevent_xilinx_timer); - clockevent_xilinx_timer.min_delta_ticks = 1; - clockevent_xilinx_timer.cpumask = cpumask_of(0); - clockevents_register_device(&clockevent_xilinx_timer); - - return 0; -} - -static u64 xilinx_clock_read(void) -{ - return read_fn(timer_baseaddr + TCR1); -} - -static u64 xilinx_read(struct clocksource *cs) -{ - /* reading actual value of timer 1 */ - return (u64)xilinx_clock_read(); -} - -static struct timecounter xilinx_tc = { - .cc = NULL, -}; - -static u64 xilinx_cc_read(const struct cyclecounter *cc) -{ - return xilinx_read(NULL); -} - -static struct cyclecounter xilinx_cc = { - .read = xilinx_cc_read, - .mask = CLOCKSOURCE_MASK(32), - .shift = 8, -}; - -static int __init init_xilinx_timecounter(void) -{ - xilinx_cc.mult = div_sc(timer_clock_freq, NSEC_PER_SEC, - xilinx_cc.shift); - - timecounter_init(&xilinx_tc, &xilinx_cc, sched_clock()); - - return 0; -} - -static struct clocksource clocksource_microblaze = { - .name = "xilinx_clocksource", - .rating = 300, - .read = xilinx_read, - .mask = CLOCKSOURCE_MASK(32), - .flags = CLOCK_SOURCE_IS_CONTINUOUS, -}; - -static int __init xilinx_clocksource_init(void) -{ - int ret; - - ret = clocksource_register_hz(&clocksource_microblaze, - timer_clock_freq); - if (ret) { - pr_err("failed to register clocksource"); - return ret; - } - - /* stop timer1 */ - write_fn(read_fn(timer_baseaddr + TCSR1) & ~TCSR_ENT, - timer_baseaddr + TCSR1); - /* start timer1 - up counting without interrupt */ - write_fn(TCSR_TINT|TCSR_ENT|TCSR_ARHT, timer_baseaddr + TCSR1); - - /* register timecounter - for ftrace support */ - return init_xilinx_timecounter(); -} - -static int __init xilinx_timer_init(struct device_node *timer) -{ - struct clk *clk; - static int initialized; - u32 irq; - u32 timer_num = 1; - int ret; - - if (initialized) - return -EINVAL; - - initialized = 1; - - timer_baseaddr = of_iomap(timer, 0); - if (!timer_baseaddr) { - pr_err("ERROR: invalid timer base address\n"); - return -ENXIO; - } - - write_fn = timer_write32; - read_fn = timer_read32; - - write_fn(TCSR_MDT, timer_baseaddr + TCSR0); - if (!(read_fn(timer_baseaddr + TCSR0) & TCSR_MDT)) { - write_fn = timer_write32_be; - read_fn = timer_read32_be; - } - - irq = irq_of_parse_and_map(timer, 0); - if (irq <= 0) { - pr_err("Failed to parse and map irq"); - return -EINVAL; - } - - of_property_read_u32(timer, "xlnx,one-timer-only", &timer_num); - if (timer_num) { - pr_err("Please enable two timers in HW\n"); - return -EINVAL; - } - - pr_info("%pOF: irq=%d\n", timer, irq); - - clk = of_clk_get(timer, 0); - if (IS_ERR(clk)) { - pr_err("ERROR: timer CCF input clock not found\n"); - /* If there is clock-frequency property than use it */ - of_property_read_u32(timer, "clock-frequency", - &timer_clock_freq); - } else { - timer_clock_freq = clk_get_rate(clk); - } - - if (!timer_clock_freq) { - pr_err("ERROR: Using CPU clock frequency\n"); - timer_clock_freq = cpuinfo.cpu_clock_freq; - } - - freq_div_hz = timer_clock_freq / HZ; - - ret = request_irq(irq, timer_interrupt, IRQF_TIMER, "timer", - &clockevent_xilinx_timer); - if (ret) { - pr_err("Failed to setup IRQ"); - return ret; - } - - ret = xilinx_clocksource_init(); - if (ret) - return ret; - - ret = xilinx_clockevent_init(); - if (ret) - return ret; - - sched_clock_register(xilinx_clock_read, 32, timer_clock_freq); - - return 0; -} - -TIMER_OF_DECLARE(xilinx_timer, "xlnx,xps-timer-1.00.a", - xilinx_timer_init); diff --git a/drivers/clocksource/Kconfig b/drivers/clocksource/Kconfig index 39aa21d01e05..daa9d55927ec 100644 --- a/drivers/clocksource/Kconfig +++ b/drivers/clocksource/Kconfig @@ -693,4 +693,16 @@ config MICROCHIP_PIT64B modes and high resolution. It is used as a clocksource and a clockevent. +config XILINX_TIMER + bool "Xilinx AXI Timer support" + depends on COMMON_CLK + select REGMAP_MMIO + default y if MICROBLAZE + help + Clocksource/clockevent driver for Xilinx LogiCORE IP AXI + timers. This timer is typically a soft core which may be + present in Xilinx FPGAs. This device may also be present in + Microblaze soft processors. If you don't have this IP in your + design, choose N. + endmenu diff --git a/drivers/clocksource/Makefile b/drivers/clocksource/Makefile index c17ee32a7151..a7cba6ef5782 100644 --- a/drivers/clocksource/Makefile +++ b/drivers/clocksource/Makefile @@ -88,3 +88,4 @@ obj-$(CONFIG_CSKY_MP_TIMER) += timer-mp-csky.o obj-$(CONFIG_GX6605S_TIMER) += timer-gx6605s.o obj-$(CONFIG_HYPERV_TIMER) += hyperv_timer.o obj-$(CONFIG_MICROCHIP_PIT64B) += timer-microchip-pit64b.o +obj-$(CONFIG_XILINX_TIMER) += timer-xilinx.o timer-xilinx-common.o diff --git a/drivers/clocksource/timer-xilinx-common.c b/drivers/clocksource/timer-xilinx-common.c new file mode 100644 index 000000000000..8873a1429954 --- /dev/null +++ b/drivers/clocksource/timer-xilinx-common.c @@ -0,0 +1,67 @@ +// SPDX-License-Identifier: GPL-2.0+ +/* + * Copyright (C) 2021 Sean Anderson + * + * For Xilinx LogiCORE IP AXI Timer documentation, refer to DS764: + * https://www.xilinx.com/support/documentation/ip_documentation/axi_timer/v1_03_a/axi_timer_ds764.pdf + */ + +#include +#include +#include + +u32 xilinx_timer_tlr_cycles(struct xilinx_timer_priv *priv, u32 tcsr, + u64 cycles) +{ + WARN_ON(cycles < 2 || cycles - 2 > priv->max); + + if (tcsr & TCSR_UDT) + return cycles - 2; + else + return priv->max - cycles + 2; +} + +unsigned int xilinx_timer_get_period(struct xilinx_timer_priv *priv, + u32 tlr, u32 tcsr) +{ + u64 cycles; + + if (tcsr & TCSR_UDT) + cycles = tlr + 2; + else + cycles = (u64)priv->max - tlr + 2; + + /* cycles has a max of 2^32 + 2 */ + return div_u64(cycles * NSEC_PER_SEC, clk_get_rate(priv->clk)); +} + +int xilinx_timer_common_init(struct device_node *np, + struct xilinx_timer_priv *priv, + u32 *one_timer) +{ + int ret; + u32 width; + + ret = of_property_read_u32(np, "xlnx,one-timer-only", one_timer); + if (ret) { + pr_err("%pOF: err %d: xlnx,one-timer-only\n", np, ret); + return ret; + } else if (*one_timer && *one_timer != 1) { + pr_err("%pOF: xlnx,one-timer-only must be 0 or 1\n", np); + return -EINVAL; + } + + ret = of_property_read_u32(np, "xlnx,count-width", &width); + if (ret == -EINVAL) { + width = 32; + } else if (ret) { + pr_err("%pOF: err %d: xlnx,count-width\n", np, ret); + return ret; + } else if (width < 8 || width > 32) { + pr_err("%pOF: invalid counter width\n", np); + return -EINVAL; + } + priv->max = BIT_ULL(width) - 1; + + return 0; +} diff --git a/drivers/clocksource/timer-xilinx.c b/drivers/clocksource/timer-xilinx.c new file mode 100644 index 000000000000..71dafc7b764c --- /dev/null +++ b/drivers/clocksource/timer-xilinx.c @@ -0,0 +1,331 @@ +// SPDX-License-Identifier: GPL-2.0+ +/* + * Copyright (C) 2021 Sean Anderson + * + * Limitations: + * - When in cascade mode we cannot read the full 64-bit counter in one go + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#if IS_ENABLED(CONFIG_MICROBLAZE) +#include +#endif + +struct xilinx_clocksource_device { + struct clocksource cs; + struct xilinx_timer_priv priv; +}; + +static inline struct xilinx_timer_priv +*xilinx_clocksource_to_priv(struct clocksource *cs) +{ + return &container_of(cs, struct xilinx_clocksource_device, cs)->priv; +} + +static u64 xilinx_clocksource_read(struct clocksource *cs) +{ + struct xilinx_timer_priv *priv = xilinx_clocksource_to_priv(cs); + unsigned int ret; + + regmap_read(priv->map, TCR0, &ret); + return ret; +} + +static struct xilinx_clocksource_device xilinx_clocksource = { + .cs = { + .name = "xilinx_clocksource", + .rating = 300, + .read = xilinx_clocksource_read, + .flags = CLOCK_SOURCE_IS_CONTINUOUS, + .owner = THIS_MODULE, + }, +}; + +static u64 xilinx_sched_read(void) +{ + return xilinx_clocksource_read(&xilinx_clocksource.cs); +} + +static int xilinx_clocksource_init(struct device_node *np) +{ + int ret; + struct xilinx_timer_priv *priv = &xilinx_clocksource.priv; + static const struct reg_sequence init[] = { + REG_SEQ0(TLR0, 0), + REG_SEQ0(TCSR0, TCSR_LOAD | TCSR_TINT), + REG_SEQ0(TCSR0, TCSR_ARHT | TCSR_ENT), + }; + + ret = regmap_multi_reg_write(priv->map, init, ARRAY_SIZE(init)); + if (ret) + return ret; + + xilinx_clocksource.cs.mask = priv->max; + ret = clocksource_register_hz(&xilinx_clocksource.cs, + clk_get_rate(priv->clk)); + if (!ret) + sched_clock_register(xilinx_sched_read, + ilog2((u64)priv->max + 1), + clk_get_rate(priv->clk)); + else + pr_err("%pOF: err %d: could not register clocksource\n", + np, ret); + return ret; +} + +struct xilinx_clockevent_device { + struct clock_event_device ce; + struct xilinx_timer_priv priv; +}; + +static inline struct xilinx_timer_priv +*xilinx_clockevent_to_priv(struct clock_event_device *ce) +{ + return &container_of(ce, struct xilinx_clockevent_device, ce)->priv; +} + +static irqreturn_t xilinx_timer_handler(int irq, void *p) +{ + struct xilinx_clockevent_device *dev = p; + + if (regmap_test_bits(dev->priv.map, TCSR0, TCSR_TINT) <= 0) + return IRQ_NONE; + + regmap_clear_bits(dev->priv.map, TCSR0, TCSR_TINT); + dev->ce.event_handler(&dev->ce); + return IRQ_HANDLED; +} + +static int xilinx_clockevent_next_event(unsigned long evt, + struct clock_event_device *ce) +{ + struct xilinx_timer_priv *priv = xilinx_clockevent_to_priv(ce); + struct reg_sequence next[] = { + REG_SEQ0(TLR0, evt - 2), + REG_SEQ0(TCSR0, TCSR_LOAD), + REG_SEQ0(TCSR0, TCSR_ENIT | TCSR_ENT), + }; + + return regmap_multi_reg_write(priv->map, next, ARRAY_SIZE(next)); +} + +static int xilinx_clockevent_state_periodic(struct clock_event_device *ce) +{ + struct xilinx_timer_priv *priv = xilinx_clockevent_to_priv(ce); + struct reg_sequence periodic[] = { + REG_SEQ0(TLR0, 0), + REG_SEQ0(TCSR0, TCSR_LOAD), + REG_SEQ0(TCSR0, TCSR_ARHT | TCSR_ENIT | TCSR_ENT), + }; + unsigned long cycles = clk_get_rate(priv->clk) / HZ; + + if (cycles < 2 || cycles - 2 > priv->max) + return -ERANGE; + periodic[0].def = xilinx_timer_tlr_cycles(priv, 0, cycles); + + return regmap_multi_reg_write(priv->map, periodic, ARRAY_SIZE(periodic)); +} + +static int xilinx_clockevent_shutdown(struct clock_event_device *ce) +{ + struct xilinx_timer_priv *priv = xilinx_clockevent_to_priv(ce); + + return regmap_write(priv->map, TCSR0, 0); +} + +static const struct clock_event_device xilinx_clockevent_base = { + .rating = 300, + .features = CLOCK_EVT_FEAT_PERIODIC | CLOCK_EVT_FEAT_ONESHOT, + .set_next_event = xilinx_clockevent_next_event, + .set_state_periodic = xilinx_clockevent_state_periodic, + .set_state_shutdown = xilinx_clockevent_shutdown, + .cpumask = cpu_possible_mask, + .owner = THIS_MODULE, +}; + +static const struct regmap_config xilinx_pwm_regmap_config = { + /* Actually 5, but I don't think this matters for mmio */ + .reg_bits = 32, + .reg_stride = 4, + .val_bits = 32, + .val_format_endian = REGMAP_ENDIAN_LITTLE, +}; + +static int xilinx_clockevent_init(struct device_node *np, + struct xilinx_clockevent_device *dev) +{ + int irq, ret; + + irq = ret = of_irq_get(np, 0); + if (ret < 0) { + pr_err("%pOF: err %d: could not get irq\n", np, ret); + return ret; + } + + ret = request_irq(irq, xilinx_timer_handler, IRQF_TIMER, + of_node_full_name(np), dev); + if (ret) { + pr_err("%pOF: err %d: could not request irq\n", np, ret); + return ret; + } + + memcpy(&dev->ce, &xilinx_clockevent_base, sizeof(dev->ce)); + dev->ce.name = of_node_full_name(np); + clockevents_config_and_register(&dev->ce, clk_get_rate(dev->priv.clk), 2, + min_t(u64, (u64)dev->priv.max + 2, + ULONG_MAX)); + return 0; +} + +static const struct regmap_config xilinx_timer_regmap_config = { + .reg_bits = 32, + .reg_stride = 4, + .val_bits = 32, + .val_format_endian = REGMAP_ENDIAN_LITTLE, + .max_register = TCR0, +}; + +static bool clocksource_uninitialized = true; + +static int __init xilinx_timer_init(struct device_node *np) +{ + bool artificial_clock = false; + int ret; + struct xilinx_timer_priv *priv; + struct xilinx_clockevent_device *dev; + u32 one_timer; + void __iomem *regs; + + if (of_property_read_bool(np, "#pwm-cells")) + return 0; + + regs = of_iomap(np, 0); + if (IS_ERR(regs)) { + ret = PTR_ERR(regs); + pr_err("%pOF: err %d: failed to map regs\n", np, ret); + return ret; + } + + if (clocksource_uninitialized) { + priv = &xilinx_clocksource.priv; + } else { + dev = kzalloc(sizeof(*dev), GFP_KERNEL); + if (!dev) { + ret = -ENOMEM; + goto err_regs; + } + priv = &dev->priv; + } + + priv->map = regmap_init_mmio(NULL, regs, &xilinx_timer_regmap_config); + if (IS_ERR(priv->map)) { + ret = PTR_ERR(priv->map); + goto err_priv; + } + + ret = xilinx_timer_common_init(np, priv, &one_timer); + if (ret) + goto err_regmap; + + priv->clk = of_clk_get_by_name(np, "s_axi_aclk"); + if (IS_ERR(priv->clk)) { + u32 freq; + + ret = PTR_ERR(priv->clk); + if (ret == -EPROBE_DEFER) + goto err_regs; + + pr_warn("%pOF: missing s_axi_aclk, falling back to clock-frequency\n", + np); + ret = of_property_read_u32(np, "clock-frequency", &freq); + if (ret) { +#if IS_ENABLED(CONFIG_MICROBLAZE) + pr_warn("%pOF: missing clock-frequency, falling back to /cpus/timebase-frequency\n", + np); + freq = cpuinfo.cpu_clock_freq; +#else + goto err_regs; +#endif + } + + priv->clk = clk_register_fixed_rate(NULL, of_node_full_name(np), + NULL, 0, freq); + if (IS_ERR(priv->clk)) { + ret = PTR_ERR(priv->clk); + goto err_regs; + } + artificial_clock = true; + } + + ret = clk_prepare_enable(priv->clk); + if (ret) { + pr_err("%pOF: err %d: clock enable failed\n", np, ret); + goto err_clk_init; + } + clk_rate_exclusive_get(priv->clk); + + if (clocksource_uninitialized) { + ret = xilinx_clocksource_init(np); + if (ret) + goto err_clk_enable; + clocksource_uninitialized = false; + } else { + ret = xilinx_clockevent_init(np, dev); + if (ret) + goto err_clk_enable; + } + of_node_set_flag(np, OF_POPULATED); + + if (!one_timer) { + dev = kzalloc(sizeof(*dev), GFP_KERNEL); + if (!dev) + return -ENOMEM; + + /* + * We don't support removal, so don't bother enabling + * the clock twice. + */ + memcpy(&dev->priv, priv, sizeof(dev->priv)); + dev->priv.map = regmap_init_mmio(NULL, regs + TCSR1, + &xilinx_timer_regmap_config); + if (!IS_ERR(dev->priv.map)) { + ret = xilinx_clockevent_init(np, dev); + if (!ret) + return 0; + regmap_exit(dev->priv.map); + } else { + ret = PTR_ERR(dev->priv.map); + } + kfree(dev); + } + return ret; + +err_clk_enable: + clk_rate_exclusive_put(priv->clk); + clk_disable_unprepare(priv->clk); +err_clk_init: + if (artificial_clock) + clk_unregister_fixed_rate(priv->clk); + else + clk_put(priv->clk); +err_regmap: + regmap_exit(priv->map); +err_priv: + if (!clocksource_uninitialized) + kfree(dev); +err_regs: + iounmap(regs); + return ret; +} + +TIMER_OF_DECLARE(xilinx_xps_timer, "xlnx,xps-timer-1.00.a", xilinx_timer_init); diff --git a/include/clocksource/timer-xilinx.h b/include/clocksource/timer-xilinx.h new file mode 100644 index 000000000000..1f7757b84a5e --- /dev/null +++ b/include/clocksource/timer-xilinx.h @@ -0,0 +1,91 @@ +/* SPDX-License-Identifier: GPL-2.0+ */ +/* + * Copyright (C) 2021 Sean Anderson + */ + +#ifndef XILINX_TIMER_H +#define XILINX_TIMER_H + +#include + +#define TCSR0 0x00 +#define TLR0 0x04 +#define TCR0 0x08 +#define TCSR1 0x10 +#define TLR1 0x14 +#define TCR1 0x18 + +#define TCSR_MDT BIT(0) +#define TCSR_UDT BIT(1) +#define TCSR_GENT BIT(2) +#define TCSR_CAPT BIT(3) +#define TCSR_ARHT BIT(4) +#define TCSR_LOAD BIT(5) +#define TCSR_ENIT BIT(6) +#define TCSR_ENT BIT(7) +#define TCSR_TINT BIT(8) +#define TCSR_PWMA BIT(9) +#define TCSR_ENALL BIT(10) +#define TCSR_CASC BIT(11) + +struct clk; +struct device_node; +struct regmap; + +/** + * struct xilinx_timer_priv - Private data for Xilinx AXI timer drivers + * @map: Regmap of the device, possibly with an offset + * @clk: Parent clock + * @max: Maximum value of the counters + */ +struct xilinx_timer_priv { + struct regmap *map; + struct clk *clk; + u32 max; +}; + +/** + * xilinx_timer_tlr_cycles() - Calculate the TLR for a period specified + * in clock cycles + * @priv: The timer's private data + * @tcsr: The value of the TCSR register for this counter + * @cycles: The number of cycles in this period + * + * Callers of this function MUST ensure that @cycles is representable as + * a TLR. + * + * Return: The calculated value for TLR + */ +u32 xilinx_timer_tlr_cycles(struct xilinx_timer_priv *priv, u32 tcsr, + u64 cycles); + +/** + * xilinx_timer_get_period() - Get the current period of a counter + * @priv: The timer's private data + * @tlr: The value of TLR for this counter + * @tcsr: The value of TCSR for this counter + * + * Return: The period, in ns + */ +unsigned int xilinx_timer_get_period(struct xilinx_timer_priv *priv, + u32 tlr, u32 tcsr); + +/** + * xilinx_timer_common_init() - Perform common initialization for Xilinx + * AXI timer drivers. + * @priv: The timer's private data + * @np: The devicetree node for the timer + * @one_timer: Set to %1 if there is only one timer + * + * This performs common initialization, such as detecting endianness, + * and parsing devicetree properties. @priv->regs must be initialized + * before calling this function. This function initializes @priv->read, + * @priv->write, and @priv->width. + * + * Return: 0, or negative errno + */ +int xilinx_timer_common_init(struct device_node *np, + struct xilinx_timer_priv *priv, + u32 *one_timer); + +#endif /* XILINX_TIMER_H */ From patchwork Mon Jul 19 22:13:22 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sean Anderson X-Patchwork-Id: 480104 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,DKIM_SIGNED, DKIM_VALID, HEADER_FROM_DIFFERENT_DOMAINS, INCLUDES_CR_TRAILER, INCLUDES_PATCH, MAILING_LIST_MULTI, MSGID_FROM_MTA_HEADER, 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 B2E98C07E9D for ; Tue, 20 Jul 2021 00:01:58 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 8843861165 for ; Tue, 20 Jul 2021 00:01:58 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S245004AbhGSXU6 (ORCPT ); Mon, 19 Jul 2021 19:20:58 -0400 Received: from mail-eopbgr60079.outbound.protection.outlook.com ([40.107.6.79]:32659 "EHLO EUR04-DB3-obe.outbound.protection.outlook.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1389472AbhGSVeO (ORCPT ); Mon, 19 Jul 2021 17:34:14 -0400 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=ZOwUDa0JYJR4l2VmE9v6f3fxN7KrE8eDfRqslxdMdY7jjYpcH+GeTd0jjOPQzOaHGpL5qHx+3rAUoJ7QjkjW3HnhUz4P5X1yyeZU/JchdvjZM4YRKbDU/gSxE+fzGGryZqkgVE5Pv1HUpMTaTpju6M2BcxW14MCIDXCqmnFdPsIV8f/qC/ySyiFe4lT3K4sgr+RdcZNiinoLqtFWG9uTc76kdhsCzoZ52zL1fiGmNpswiFm8dPue0G6nKCSgxjiLPjDRVNC/oskqk2eB7D/sSGzVpZvC7inmN7oqZMoTeI0ltsjyrJsP05aPF5KUpC3Z5ZCMxNeJH0geC3sdzAdGxw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=zMJS+QzpuzV7mCcXnMOdygdBgpD1qTCSYyz9uEwFdKI=; b=nQXGuK1LKGXehnvcQ9bEJ2hZYgujOBVBE1E5YPLbNi9DsLjaCLZubdX4m5v/Cw8DSPtAZbC2rjvpggFZTzhYXFCtujp0UmygW3i3q33yABa7pYrXNof7vqh7CaO1K/1IInMq7elznuU3Y2YNgPFGNiah1TY15OGWvoJSBv8cBabyqmmSTeebpCgSmW7ftg/l5wa4NPlQNuaM2eF2IyanTXUnFUAvViA5JenMwQqsTG/Cv6VhjWKUUc3fZ1AmXOShuvy8Hqws6k6mkcTX7v3dD8JnJuqTuIssbGx88uLoaO+6ZWJO6l2nnq9pfWiKDXEU8ZQMOnXe6pkUeNdo/8ySjQ== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=seco.com; dmarc=pass action=none header.from=seco.com; dkim=pass header.d=seco.com; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=secospa.onmicrosoft.com; s=selector2-secospa-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=zMJS+QzpuzV7mCcXnMOdygdBgpD1qTCSYyz9uEwFdKI=; b=BvAFBVUmcPCUu1vYP2DysDOIVPQAd5ZRxGogMvI6t0f4AgoLB9nHnnh39c0gGWpNdICSklTMsPfU8sGrgMbnxESWyUyy9oHTXR36gdlt4B0lxvJ+45Up+B4qFUVJ7OR4Ahxew0lS/ROR+YDdtudU5EPFvu3jhoy4Ge4kWG1kCXk= Authentication-Results: vger.kernel.org; dkim=none (message not signed) header.d=none; vger.kernel.org; dmarc=none action=none header.from=seco.com; Received: from DB7PR03MB4523.eurprd03.prod.outlook.com (2603:10a6:10:19::27) by DB7PR03MB3962.eurprd03.prod.outlook.com (2603:10a6:5:30::19) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4331.29; Mon, 19 Jul 2021 22:13:46 +0000 Received: from DB7PR03MB4523.eurprd03.prod.outlook.com ([fe80::dc6c:815b:2062:d1f1]) by DB7PR03MB4523.eurprd03.prod.outlook.com ([fe80::dc6c:815b:2062:d1f1%7]) with mapi id 15.20.4331.033; Mon, 19 Jul 2021 22:13:46 +0000 From: Sean Anderson To: linux-pwm@vger.kernel.org, devicetree@vger.kernel.org, Thierry Reding Cc: Alvaro Gamez , =?utf-8?q?Uwe_Kleine-K=C3=B6ni?= =?utf-8?q?g?= , michal.simek@xilinx.com, Lee Jones , linux-arm-kernel@lists.infradead.org, linux-kernel@vger.kernel.org, Sean Anderson Subject: [PATCH v5 3/3] pwm: Add support for Xilinx AXI Timer Date: Mon, 19 Jul 2021 18:13:22 -0400 Message-Id: <20210719221322.3723009-3-sean.anderson@seco.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20210719221322.3723009-1-sean.anderson@seco.com> References: <20210719221322.3723009-1-sean.anderson@seco.com> X-ClientProxiedBy: BLAPR03CA0132.namprd03.prod.outlook.com (2603:10b6:208:32e::17) To DB7PR03MB4523.eurprd03.prod.outlook.com (2603:10a6:10:19::27) MIME-Version: 1.0 X-MS-Exchange-MessageSentRepresentingType: 1 Received: from plantagenet.inhand.com (50.195.82.171) by BLAPR03CA0132.namprd03.prod.outlook.com (2603:10b6:208:32e::17) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.4331.21 via Frontend Transport; Mon, 19 Jul 2021 22:13:44 +0000 X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 9855336d-4fad-4238-3c78-08d94b027a1c X-MS-TrafficTypeDiagnostic: DB7PR03MB3962: X-MS-Exchange-Transport-Forked: True X-Microsoft-Antispam-PRVS: X-MS-Oob-TLC-OOBClassifiers: OLM:8273; X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: 4pSKsgMqh4qVgn/bBCtpMPDkBpazrwuGGUUlC/qdWA3DgazFYWT2cH6exxWtpplO6OKyFAda2LY9k1VE0HDYRWOb1ttM60Kd088bhwWac+1eyMoZMskxFtsKiDtEH1jsP1ATiw3VLQWeiQcF+0n8f9wWGm2ZR8qsYMtC7I1ex+dRDRb8fBqOLlo/8+/M19NiSsuPCtDFS0D8YyD9Or34HaYz7Rme4Q2MmiKHwF+GNy6I3wNSg+JSDNiNE7CfrqpBVX/pWZ/anrB2Vkz171+pypXJjb1SgMPZmNq7oqgiUc26PJGd/JNISyXSgw9MpfJygqQnw+2EwlQcxPZezl4YfT0CLTqrD69vpZ91TKDdlJyG0zitoirRXc7Jy68D1At9i81imWHuLiI38R+3F3cs5b5LTQ6XwsX2ED42EJdIHjGRb7ZdYrReZOxdXnxTRrsho4FRW6UzHDVGguRRyKi5RpTVvRFLPG7gpGZx7VdlCLFVIpjjEaegRSvQ0pzPMx5bSMR6ScRWXt5+0Hq8SXS+PmF8ll+TzkEe6xRKjH+VPymdICi13UCJXfLETJD82GMZ2u5FdSpSn7w+4L/rpKl7igmKPB9b8ZdfTaZQLx8IhoI3y1H04uq6ku2SU940p42QfMVyZvpJT5pAwjFF324jkelN3Y3Gg/jXE+7C+P9JU8yWPVYslAATKOzz6IR1fEnv2im177CNCETim5lVW3e1Th83GzxGcpXXpizajfB/kTm3NWu0YeQGOlXSKsYdX0ucjtqDNiCVpGUzbqEvQU/4NrQibHLyi234CauSrGc9bAU= X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:DB7PR03MB4523.eurprd03.prod.outlook.com; PTR:; CAT:NONE; SFS:(366004)(1076003)(6916009)(6666004)(38100700002)(38350700002)(83380400001)(52116002)(316002)(44832011)(2616005)(36756003)(956004)(4326008)(54906003)(186003)(6506007)(66946007)(6512007)(66556008)(5660300002)(8676002)(26005)(508600001)(966005)(86362001)(6486002)(2906002)(8936002)(30864003)(107886003)(66476007); DIR:OUT; SFP:1101; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?q?MOVCm6DqX63ThzkHlSIU7CfAN?= =?utf-8?q?nL35PYBegRfJfwVicwo5FoqX1e6fO4nwYrVU6JZp1MEOM8kuCGb/rcCd?= =?utf-8?q?njwBCi2qqR3Im4KV+V/Omdq/LArKW3l09rgKiPlYLqkZr2Ia4dZh9Xt4?= =?utf-8?q?xWGIIFIDR+YF54bz7cL1Pb44wlYQZcxKKm3BIN5wldedVE+KhObCuCX3?= =?utf-8?q?YNt88y+A6dO8ZnCSlfPDgaPY/4w3leP17ksnumG7KHT3ls2FtO2fKxOo?= =?utf-8?q?UnJgAb2SUzqPU3UHfR379h6v3P6QLgoendscBIocuqoDWslBTWOcJH6C?= =?utf-8?q?8CN8NJ2FVqCtM5TMUEe0/oBWaVMCM3htW+GZNT42aEikfSxfr5vrQzlN?= =?utf-8?q?43OxH+8lzh5FREGSWSOuXXdaoVUGQ0BfGl8AjO2w8aM8ZiL2bUB5e9Yg?= =?utf-8?q?3LAc4HJso/SXsiV7BiMG29ssrCuY5aM5/PZ0OmaU+4R5MOV7eZNNzFsQ?= =?utf-8?q?k3Bw/dENaYU7wjNpTEdUg50xeldQZDbOoNml/ZLbkfGbDPr5N6mJIbgN?= =?utf-8?q?qnmAVae1eBVToWKOKEpVk1pOMCcpRJVCYViDpUQAO5/yaWTcHTxT7lp8?= =?utf-8?q?9jeWvgLEYhI4HepI6pLGcl1RZYUhi8Dh7SWdUEgWicxdNeFVWQMvKFaF?= =?utf-8?q?X7QVsqwLVJrwGsbHVYYqEQGZakkd35PxJvhLIrkl9T3SV1YBtiWkaDoI?= =?utf-8?q?yIHkU1IApSWS4UUsmrRp+gmZCeC3Q2wcHPTnco7lwnLgHdwqZOwZ7TmB?= =?utf-8?q?4ndSFEfDAV/k+euUHYDf6BKxjljRL7ubF3du+IsdzNkeH7kgKmT5ytvL?= =?utf-8?q?r6C3XGT8Os7Hqk6+n4GEN3+TUEDHFHyer6xf6hbcOnOx9nRcQcoBCfmN?= =?utf-8?q?j14oZM5uuaS6D+rKSmll67G/Sq+hCvovNuRllvUenNjBHyRBvdS2ugh/?= =?utf-8?q?WQFm7X7m7tc8q+w8jbnNglz8RNhLugzePyEkGXxAjZ4yziR7lcH8KlZh?= =?utf-8?q?fG8M2rt6dCgTl+HdueAedHw8S0MSgqqsyXpZdiJIgI/+kUzqrnrs0FyX?= =?utf-8?q?X0w+iKJ2C781xczmbaALW1EN95dpPojZ/mGFSeM+VZaEnfXR6l8Afm/R?= =?utf-8?q?3tUAAi2h6mNVYOy0181cmZ1VAXAq3PokyfcItE2VV+XPa72vrIwCnHnz?= =?utf-8?q?/RBtpOJOZdxXjVymCgAEOOFBP9q/fTc34To+VSoZouhfpIXAU16EZtKT?= =?utf-8?q?JIlhgBQaAQl3JMCbnLgFPLjYZtXw9vgDhd/Qzv1QxhA8fFVskyAzN6j7?= =?utf-8?q?XIbcFURzsFzGFAIpWgjTZzXnvXw/ROaAjfIBc0Eomdb6O6dNXI9t9Z03?= =?utf-8?q?StYWDiM/JJhgR8CZJ6dU5RaPjwIT5RS?= X-OriginatorOrg: seco.com X-MS-Exchange-CrossTenant-Network-Message-Id: 9855336d-4fad-4238-3c78-08d94b027a1c X-MS-Exchange-CrossTenant-AuthSource: DB7PR03MB4523.eurprd03.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 19 Jul 2021 22:13:46.1433 (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: o7KtYGsJs8zYp7NXa+mMw6eShrqQlFkM4VTTeylx5zpIBNaa3P7J8j8acXA3iIcyqNGv1GhuyyiFqbUsvg+GAQ== X-MS-Exchange-Transport-CrossTenantHeadersStamped: DB7PR03MB3962 Precedence: bulk List-ID: X-Mailing-List: devicetree@vger.kernel.org This adds PWM support for Xilinx LogiCORE IP AXI soft timers commonly found on Xilinx FPGAs. At the moment clock control is very basic: we just enable the clock during probe and pin the frequency. In the future, someone could add support for disabling the clock when not in use. This driver was written with reference to Xilinx DS764 for v1.03.a [1]. [1] https://www.xilinx.com/support/documentation/ip_documentation/axi_timer/v1_03_a/axi_timer_ds764.pdf Signed-off-by: Sean Anderson Reported-by: kernel test robot --- Uwe, I know we haven't finished our discussion on the previous series wrt what checks/rounding apply_state should do, but I want to get some feedback on the other changes I've made to this series in the meantime. Changes in v5: - Elaborate on limitation section - Rework duty-cycle and period calculations with feedback from Uwe - Use more verbose error messages - Allow non-zero #pwm-cells - Remove xlnx,axi-timer-2.0 compatible string - Correctly set duty_cycle in get_state when TLR0=TLR1 - Perform some additional checks/rounding in apply_state - Switch to regmap to abstract endianness issues Changes in v4: - Remove references to properties which are not good enough for Linux. - Don't use volatile in read/write replacements. Some arches have it and some don't. - Put common timer properties into their own struct to better reuse code. Changes in v3: - Add clockevent and clocksource support - Rewrite probe to only use a device_node, since timers may need to be initialized before we have proper devices. This does bloat the code a bit since we can no longer rely on helpers such as dev_err_probe. We also cannot rely on device resources being free'd on failure, so we must free them manually. - We now access registers through xilinx_timer_(read|write). This allows us to deal with endianness issues, as originally seen in the microblaze driver. CAVEAT EMPTOR: I have not tested this on big-endian! - Remove old microblaze driver Changes in v2: - Don't compile this module by default for arm64 - Add dependencies on COMMON_CLK and HAS_IOMEM - Add comment explaining why we depend on !MICROBLAZE - Add comment describing device - Rename TCSR_(SET|CLEAR) to TCSR_RUN_(SET|CLEAR) - Use NSEC_TO_SEC instead of defining our own - Use TCSR_RUN_MASK to check if the PWM is enabled, as suggested by Uwe - Cast dividends to u64 to avoid overflow - Check for over- and underflow when calculating TLR - Set xilinx_pwm_ops.owner - Don't set pwmchip.base to -1 - Check range of xlnx,count-width - Ensure the clock is always running when the pwm is registered - Remove debugfs file :l - Report errors with dev_error_probe MAINTAINERS | 1 + drivers/clocksource/Makefile | 5 +- drivers/pwm/Kconfig | 13 ++ drivers/pwm/Makefile | 1 + drivers/pwm/pwm-xilinx.c | 268 +++++++++++++++++++++++++++++++++++ 5 files changed, 287 insertions(+), 1 deletion(-) create mode 100644 drivers/pwm/pwm-xilinx.c diff --git a/MAINTAINERS b/MAINTAINERS index 252d71addd18..6adafd3e7a09 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -20050,6 +20050,7 @@ XILINX TIMER/PWM DRIVER M: Sean Anderson S: Maintained F: drivers/clocksource/timer-xilinx* +F: drivers/pwm/pwm-xilinx.c F: include/clocksource/timer-xilinx.h XILINX UARTLITE SERIAL DRIVER diff --git a/drivers/clocksource/Makefile b/drivers/clocksource/Makefile index a7cba6ef5782..dcf434fdb726 100644 --- a/drivers/clocksource/Makefile +++ b/drivers/clocksource/Makefile @@ -88,4 +88,7 @@ obj-$(CONFIG_CSKY_MP_TIMER) += timer-mp-csky.o obj-$(CONFIG_GX6605S_TIMER) += timer-gx6605s.o obj-$(CONFIG_HYPERV_TIMER) += hyperv_timer.o obj-$(CONFIG_MICROCHIP_PIT64B) += timer-microchip-pit64b.o -obj-$(CONFIG_XILINX_TIMER) += timer-xilinx.o timer-xilinx-common.o +obj-$(CONFIG_XILINX_TIMER) += timer-xilinx.o +ifneq ($(CONFIG_XILINX_TIMER$)(CONFIG_PWM_XILINX),) +obj-y += timer-xilinx-common.o +endif diff --git a/drivers/pwm/Kconfig b/drivers/pwm/Kconfig index c76adedd58c9..974774b7c987 100644 --- a/drivers/pwm/Kconfig +++ b/drivers/pwm/Kconfig @@ -637,4 +637,17 @@ config PWM_VT8500 To compile this driver as a module, choose M here: the module will be called pwm-vt8500. +config PWM_XILINX + tristate "Xilinx AXI Timer PWM support" + depends on COMMON_CLK + select REGMAP_MMIO + help + PWM driver for Xilinx LogiCORE IP AXI timers. This timer is + typically a soft core which may be present in Xilinx FPGAs. + This device may also be present in Microblaze soft processors. + If you don't have this IP in your design, choose N. + + To compile this driver as a module, choose M here: the module + will be called pwm-xilinx. + endif diff --git a/drivers/pwm/Makefile b/drivers/pwm/Makefile index 708840b7fba8..ea785480359b 100644 --- a/drivers/pwm/Makefile +++ b/drivers/pwm/Makefile @@ -60,3 +60,4 @@ obj-$(CONFIG_PWM_TWL) += pwm-twl.o obj-$(CONFIG_PWM_TWL_LED) += pwm-twl-led.o obj-$(CONFIG_PWM_VISCONTI) += pwm-visconti.o obj-$(CONFIG_PWM_VT8500) += pwm-vt8500.o +obj-$(CONFIG_PWM_XILINX) += pwm-xilinx.o diff --git a/drivers/pwm/pwm-xilinx.c b/drivers/pwm/pwm-xilinx.c new file mode 100644 index 000000000000..291577be992f --- /dev/null +++ b/drivers/pwm/pwm-xilinx.c @@ -0,0 +1,268 @@ +// SPDX-License-Identifier: GPL-2.0+ +/* + * Copyright (C) 2021 Sean Anderson + * + * Limitations: + * - When changing both duty cycle and period, we may end up with one cycle + * with the old duty cycle and the new period. This is because the counters + * may only be reloaded by first stopping them, or by letting them be + * automatically reloaded at the end of a cycle. If this automatic reload + * happens after we set TLR0 but before we set TLR1 then we will will have a + * bad cycle. This could probably be fixed by reading TCR0 just before + * reprogramming, but I think it would add complexity for little gain. + * - Cannot produce 100% duty cycle by configuring the TLRs. This might be + * possible by stopping the counters at an appropriate point in the cycle, + * but this is not (yet) implemented. + * - Only produces "normal" output. + * - Always produces low output if disabled. + */ + +#include +#include +#include +#include +#include +#include +#include +#include + +/* + * The idea here is to capture whether the PWM is actually running (e.g. + * because we or the bootloader set it up) and we need to be careful to ensure + * we don't cause a glitch. According to the data sheet, to enable the PWM we + * need to + * + * - Set both timers to generate mode (MDT=1) + * - Set both timers to PWM mode (PWMA=1) + * - Enable the generate out signals (GENT=1) + * + * In addition, + * + * - The timer must be running (ENT=1) + * - The timer must auto-reload TLR into TCR (ARHT=1) + * - We must not be in the process of loading TLR into TCR (LOAD=0) + * - Cascade mode must be disabled (CASC=0) + * + * If any of these differ from usual, then the PWM is either disabled, or is + * running in a mode that this driver does not support. + */ +#define TCSR_PWM_SET (TCSR_GENT | TCSR_ARHT | TCSR_ENT | TCSR_PWMA) +#define TCSR_PWM_CLEAR (TCSR_MDT | TCSR_LOAD) +#define TCSR_PWM_MASK (TCSR_PWM_SET | TCSR_PWM_CLEAR) + +struct xilinx_pwm_device { + struct pwm_chip chip; + struct xilinx_timer_priv priv; +}; + +static inline struct xilinx_timer_priv +*xilinx_pwm_chip_to_priv(struct pwm_chip *chip) +{ + return &container_of(chip, struct xilinx_pwm_device, chip)->priv; +} + +static bool xilinx_timer_pwm_enabled(u32 tcsr0, u32 tcsr1) +{ + return ((TCSR_PWM_MASK | TCSR_CASC) & tcsr0) == TCSR_PWM_SET && + (TCSR_PWM_MASK & tcsr1) == TCSR_PWM_SET; +} + +static int xilinx_pwm_apply(struct pwm_chip *chip, struct pwm_device *unused, + const struct pwm_state *state) +{ + bool enabled; + struct xilinx_timer_priv *priv = xilinx_pwm_chip_to_priv(chip); + u32 tlr0, tlr1, tcsr0, tcsr1; + u64 period_cycles, duty_cycles; + unsigned long rate; + + if (state->polarity != PWM_POLARITY_NORMAL) + return -EINVAL; + + /* + * To be representable by TLR, cycles must be between 2 and + * priv->max + 2. To enforce this we can reduce the duty + * cycle, but we may not increase it. + */ + rate = clk_get_rate(priv->clk); + period_cycles = mul_u64_u32_div(state->period, rate, NSEC_PER_SEC); + if (period_cycles - 2 > priv->max || period_cycles < 2) + return -ERANGE; + duty_cycles = mul_u64_u32_div(state->duty_cycle, rate, NSEC_PER_SEC); + + /* + * If we specify 100% duty cycle, we will get 0% instead, so decrease + * the duty cycle count by one. + */ + if (period_cycles == duty_cycles) + duty_cycles--; + + /* Round down to 0% duty cycle for unrepresentable duty cycles */ + if (duty_cycles < 2) + duty_cycles = period_cycles; + + regmap_read(priv->map, TCSR0, &tcsr0); + regmap_read(priv->map, TCSR1, &tcsr1); + tlr0 = xilinx_timer_tlr_cycles(priv, tcsr0, period_cycles); + tlr1 = xilinx_timer_tlr_cycles(priv, tcsr1, duty_cycles); + regmap_write(priv->map, TLR0, tlr0); + regmap_write(priv->map, TLR1, tlr1); + + enabled = xilinx_timer_pwm_enabled(tcsr0, tcsr1); + if (state->enabled) { + /* + * If the PWM is already running, then the counters will be + * reloaded at the end of the current cycle. + */ + if (!enabled) { + /* Load TLR into TCR */ + regmap_write(priv->map, TCSR0, tcsr0 | TCSR_LOAD); + regmap_write(priv->map, TCSR1, tcsr1 | TCSR_LOAD); + /* Enable timers all at once with ENALL */ + tcsr0 = (TCSR_PWM_SET & ~TCSR_ENT) | (tcsr0 & TCSR_UDT); + tcsr1 = TCSR_PWM_SET | TCSR_ENALL | (tcsr1 & TCSR_UDT); + regmap_write(priv->map, TCSR0, tcsr0); + regmap_write(priv->map, TCSR1, tcsr1); + } + } else { + regmap_write(priv->map, TCSR0, 0); + regmap_write(priv->map, TCSR1, 0); + } + + return 0; +} + +static void xilinx_pwm_get_state(struct pwm_chip *chip, + struct pwm_device *unused, + struct pwm_state *state) +{ + struct xilinx_timer_priv *priv = xilinx_pwm_chip_to_priv(chip); + u32 tlr0, tlr1, tcsr0, tcsr1; + + regmap_read(priv->map, TLR0, &tlr0); + regmap_read(priv->map, TLR1, &tlr1); + regmap_read(priv->map, TCSR0, &tcsr0); + regmap_read(priv->map, TCSR1, &tcsr1); + state->period = xilinx_timer_get_period(priv, tlr0, tcsr0); + state->duty_cycle = xilinx_timer_get_period(priv, tlr1, tcsr1); + state->enabled = xilinx_timer_pwm_enabled(tcsr0, tcsr1); + state->polarity = PWM_POLARITY_NORMAL; + + /* 100% duty cycle results in constant low output */ + if (state->period == state->duty_cycle) + state->duty_cycle = 0; +} + +static const struct pwm_ops xilinx_pwm_ops = { + .apply = xilinx_pwm_apply, + .get_state = xilinx_pwm_get_state, + .owner = THIS_MODULE, +}; + +static const struct regmap_config xilinx_pwm_regmap_config = { + .reg_bits = 32, + .reg_stride = 4, + .val_bits = 32, + .val_format_endian = REGMAP_ENDIAN_LITTLE, + .max_register = TCR1, + .disable_locking = true, /* The PWM subsystem handles locking */ +}; + +static int xilinx_timer_probe(struct platform_device *pdev) +{ + int ret; + struct device *dev = &pdev->dev; + struct device_node *np = dev->of_node; + struct xilinx_timer_priv *priv; + struct xilinx_pwm_device *pwm; + u32 pwm_cells, one_timer; + void __iomem *regs; + + ret = of_property_read_u32(np, "#pwm-cells", &pwm_cells); + if (ret == -EINVAL) + return -ENODEV; + else if (ret) + return dev_err_probe(dev, ret, "could not read #pwm-cells\n"); + + pwm = devm_kzalloc(dev, sizeof(*pwm), GFP_KERNEL); + if (!pwm) + return -ENOMEM; + platform_set_drvdata(pdev, pwm); + priv = &pwm->priv; + + regs = devm_platform_ioremap_resource(pdev, 0); + if (IS_ERR(regs)) + return PTR_ERR(regs); + + priv->map = devm_regmap_init_mmio(dev, regs, + &xilinx_pwm_regmap_config); + if (IS_ERR(priv->map)) + return dev_err_probe(dev, PTR_ERR(priv->map), + "could not create regmap\n"); + + ret = xilinx_timer_common_init(np, priv, &one_timer); + if (ret) + return ret; + + if (one_timer) + return dev_err_probe(dev, -EINVAL, + "two timers required for PWM mode\n"); + + /* + * The polarity of the generate outputs must be active high for PWM + * mode to work. We could determine this from the device tree, but + * alas, such properties are not allowed to be used. + */ + + priv->clk = devm_clk_get(dev, "s_axi_aclk"); + if (IS_ERR(priv->clk)) + return dev_err_probe(dev, PTR_ERR(priv->clk), + "could not get clock\n"); + + ret = clk_prepare_enable(priv->clk); + if (ret) + return dev_err_probe(dev, ret, "clock enable failed\n"); + clk_rate_exclusive_get(priv->clk); + + pwm->chip.dev = dev; + pwm->chip.ops = &xilinx_pwm_ops; + pwm->chip.npwm = 1; + ret = pwmchip_add(&pwm->chip); + if (ret) { + clk_rate_exclusive_put(priv->clk); + clk_disable_unprepare(priv->clk); + return dev_err_probe(dev, ret, "could not register pwm chip\n"); + } + + return 0; +} + +static int xilinx_timer_remove(struct platform_device *pdev) +{ + struct xilinx_pwm_device *pwm = platform_get_drvdata(pdev); + + pwmchip_remove(&pwm->chip); + clk_rate_exclusive_put(pwm->priv.clk); + clk_disable_unprepare(pwm->priv.clk); + return 0; +} + +static const struct of_device_id xilinx_timer_of_match[] = { + { .compatible = "xlnx,xps-timer-1.00.a", }, + {}, +}; +MODULE_DEVICE_TABLE(of, xilinx_timer_of_match); + +static struct platform_driver xilinx_timer_driver = { + .probe = xilinx_timer_probe, + .remove = xilinx_timer_remove, + .driver = { + .name = "xilinx-timer", + .of_match_table = of_match_ptr(xilinx_timer_of_match), + }, +}; +module_platform_driver(xilinx_timer_driver); + +MODULE_ALIAS("platform:xilinx-timer"); +MODULE_DESCRIPTION("Xilinx LogiCORE IP AXI Timer driver"); +MODULE_LICENSE("GPL v2");