From nobody Sat May 18 07:08:58 2024 Received: from mail-yw1-f169.google.com (mail-yw1-f169.google.com [209.85.128.169]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id F0F8B15ADA6 for ; Wed, 24 Apr 2024 12:58:54 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.128.169 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1713963536; cv=none; b=sxXitchYu02n4ZObf8iOdfXn2pWVndtceozgcZDdi9fjy6kV+fRqRFp53CpQ8STTQuDaBJtkf3448M9ur45r5G+FGCam9Z6UvDJ+033tKS/+U8jvOQA6v5jwguvCRacmBglQyBUbUiS3Hu0nM+HN9vf9wFfxdKRquDFNe3lykbk= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1713963536; c=relaxed/simple; bh=T8lLPOkWXbFH7sg12jo67en/77SFP/tup9Kzi/vq+14=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:Content-Type; b=QzfcICtYHUZ8ObQ3ZFKHk5XGm0R54lw35RYqCCYj+YfJp5JhJjcAojnowj1WNh1fNREIR09VPp+mOFcgbazva8oY1eOUakrMShOwBFXZrF7a82q+PxcEBuiFN4mA0tADVVYuO9TggB3DmEHYDnRecdk5C/LfULal8Ag7FlAX+DM= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=baylibre.com; spf=pass smtp.mailfrom=baylibre.com; dkim=pass (2048-bit key) header.d=baylibre-com.20230601.gappssmtp.com header.i=@baylibre-com.20230601.gappssmtp.com header.b=b4ZKGQYH; arc=none smtp.client-ip=209.85.128.169 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=baylibre.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=baylibre.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=baylibre-com.20230601.gappssmtp.com header.i=@baylibre-com.20230601.gappssmtp.com header.b="b4ZKGQYH" Received: by mail-yw1-f169.google.com with SMTP id 00721157ae682-6164d7a02d2so79108717b3.3 for ; Wed, 24 Apr 2024 05:58:54 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=baylibre-com.20230601.gappssmtp.com; s=20230601; t=1713963534; x=1714568334; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=D6/gcqb0M9BBcfqCyY9UV1SBtUrd6nOAQzyn6kSwMpc=; b=b4ZKGQYH2rm4UKLDPmoAMjffphcqNwoInzlsOnE10QL6PNgOu/WFkyGSe8EjbntG69 SjFjFpPkuI3lZxc6pb24UwO796ZBQp447sH/UTdXxzB2jN/KjlplzuOxKyUmiVDcZZop 861C6Ncro8w7VcsTXhoX6TTbh3q5ugFJ7Oq4MUy7KzIsdQXZTmBSjAnE7mKSeMbIQ0eL dR7Yr+iVoQsD7ou7+PNJOzw2jynAV+cPgOFq5v6STHt7RDY3d3t0m4Ud3O1z0x3nwtrt DOFDRzcRRlmcnbpi1PuUuUEex0aMWqahQLHs3Dv+yJWnysrajxZBs6mTa/zcUAT10+Y3 hICw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1713963534; x=1714568334; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=D6/gcqb0M9BBcfqCyY9UV1SBtUrd6nOAQzyn6kSwMpc=; b=J1UjYDWdau7VgWSvyk8RtUkpwVd14bl/KJ6VAnFza/pyQ1HxunDVKWb8f68REfKJFb oNVJ41bDlXdn823PkIXMvb28umLV+Bq+HIny5xCzkJZ+Hpk/sm9MELhwLcNTHWqbpJRt PbNQi+fHK3gnRZFUsF/64u3yOXAMu+G7sltXbwYPYhPCHsBswnVWxXiWQfqQ7u8G/0/D zmfKX+hpO6MsDLigbp691Nnogn/U+6HXOCP9GLRF8+sKLA1UNqcVMCY9kXt3BCiYNStI Gc/3B0LFqXq0jXx+IPR2qmvE/D0DEoP9IVx7Qg3X909SrJ2suxWJeSHAAcAcUr6jWUNw Z8jA== X-Gm-Message-State: AOJu0Yzmmh65P/MtBiqwbTXj+Zs1Mj5r0xtaNTK9eiy8X/JLyUNYgert yMDjIhh7FCV7od/Pl/Bva6lAaQr+PKVr2Fp6CaIs2oS4sspW5+ufSYAJBrEeoAU= X-Google-Smtp-Source: AGHT+IFZkgGJhB2y9pkhaWJT1sXfkpt1OOKspaR+8y+y3E79ioRpknJzl3WvHQ/I4U86brhszVuRHA== X-Received: by 2002:a05:690c:67c5:b0:61a:d86d:fad with SMTP id ic5-20020a05690c67c500b0061ad86d0fadmr2166628ywb.51.1713963533965; Wed, 24 Apr 2024 05:58:53 -0700 (PDT) Received: from megalith.oryx-coho.ts.net (d24-150-219-207.home.cgocable.net. [24.150.219.207]) by smtp.gmail.com with ESMTPSA id ki16-20020a05622a771000b00439c3072d24sm2399995qtb.15.2024.04.24.05.58.53 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 24 Apr 2024 05:58:53 -0700 (PDT) From: Trevor Gamblin To: linux-pwm@vger.kernel.org Cc: linux-kernel@vger.kernel.org, u.kleine-koenig@pengutronix.de, michael.hennerich@analog.com, nuno.sa@analog.com, tgamblin@baylibre.com, dlechner@baylibre.com, devicetree@vger.kernel.org, krzysztof.kozlowski+dt@linaro.org, conor+dt@kernel.org Subject: [PATCH 1/2 v5] dt-bindings: pwm: Add AXI PWM generator Date: Wed, 24 Apr 2024 08:58:47 -0400 Message-ID: <20240424125850.4189116-2-tgamblin@baylibre.com> X-Mailer: git-send-email 2.44.0 In-Reply-To: <20240424125850.4189116-1-tgamblin@baylibre.com> References: <20240424125850.4189116-1-tgamblin@baylibre.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable From: Drew Fustini Add Analog Devices AXI PWM generator. Link: https://wiki.analog.com/resources/fpga/docs/axi_pwm_gen Signed-off-by: Drew Fustini Reviewed-by: Krzysztof Kozlowski Co-developed-by: Trevor Gamblin Signed-off-by: Trevor Gamblin Acked-by: Michael Hennerich Acked-by: Nuno Sa --- v5 changes: * Modify to list only the supported axi-pwmgen-2.00.a version v4 changes: None (rebased, added maintainer's previous Reviewed-by) v3 changes: None (rebased, added maintainer's previous Reviewed-by) v2 changes: * Address feedback for driver and device tree in v1: * Relocate "unevaluatedProperties" in device tree binding * Remove redundant "bindings for" in description --- .../bindings/pwm/adi,axi-pwmgen.yaml | 48 +++++++++++++++++++ MAINTAINERS | 8 ++++ 2 files changed, 56 insertions(+) create mode 100644 Documentation/devicetree/bindings/pwm/adi,axi-pwmgen.ya= ml diff --git a/Documentation/devicetree/bindings/pwm/adi,axi-pwmgen.yaml b/Do= cumentation/devicetree/bindings/pwm/adi,axi-pwmgen.yaml new file mode 100644 index 000000000000..ec6115d3796b --- /dev/null +++ b/Documentation/devicetree/bindings/pwm/adi,axi-pwmgen.yaml @@ -0,0 +1,48 @@ +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/pwm/adi,axi-pwmgen.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: Analog Devices AXI PWM generator + +maintainers: + - Michael Hennerich + - Nuno S=C3=A1 + +description: + The Analog Devices AXI PWM generator can generate PWM signals + with variable pulse width and period. + + https://wiki.analog.com/resources/fpga/docs/axi_pwm_gen + +allOf: + - $ref: pwm.yaml# + +properties: + compatible: + const: adi,axi-pwmgen-2.00.a + + reg: + maxItems: 1 + + "#pwm-cells": + const: 2 + + clocks: + maxItems: 1 + +required: + - reg + - clocks + +unevaluatedProperties: false + +examples: + - | + pwm@44b00000 { + compatible =3D "adi,axi-pwmgen-2.00.a"; + reg =3D <0x44b00000 0x1000>; + clocks =3D <&spi_clk>; + #pwm-cells =3D <2>; + }; diff --git a/MAINTAINERS b/MAINTAINERS index ebf03f5f0619..d02ece54ccf6 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -3465,6 +3465,14 @@ W: https://ez.analog.com/linux-software-drivers F: Documentation/devicetree/bindings/spi/adi,axi-spi-engine.yaml F: drivers/spi/spi-axi-spi-engine.c =20 +AXI PWM GENERATOR +M: Michael Hennerich +M: Nuno S=C3=A1 +L: linux-pwm@vger.kernel.org +S: Supported +W: https://ez.analog.com/linux-software-drivers +F: Documentation/devicetree/bindings/pwm/adi,axi-pwmgen.yaml + AXXIA I2C CONTROLLER M: Krzysztof Adamski L: linux-i2c@vger.kernel.org --=20 2.44.0 From nobody Sat May 18 07:08:58 2024 Received: from mail-qt1-f176.google.com (mail-qt1-f176.google.com [209.85.160.176]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 2C66E15ADB8 for ; Wed, 24 Apr 2024 12:58:55 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.160.176 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1713963538; cv=none; b=WAkwswqn4KRFe+vCtCwrECky5jpz2YjlVbN9AJ6yXEFbhBclmHA41ychU+dHHiN5QNUZt3C8PyfkCVHTQTubFTb9H0ac7aF1dzzl2v33TVDv2FKvbMr/5Kwf25Ple8NiIUeRD+3zyA9s5sMo7n7S5fptSXAcA9rHw2zyqJ2smKE= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1713963538; c=relaxed/simple; bh=t88GPfXVaV5tSahOmqLi02YTMAV1ig+FOQdzIBohZ7Q=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=knxtggtrZ8tyCSwoPuzlmuUqjkfHbGQlAVNg780hJK4twq+n4win1ETKyvKvy5hJvI4ZwrOM9CAX4DjfH6STGiZC/AJK5nwF13BqvYbh0stSR2Z/nA+zkAWz4MigwNMuzKDdfd3/J9j4XQslrvdlYhKhvyK1WwZFinn0A8F3fG8= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=baylibre.com; spf=pass smtp.mailfrom=baylibre.com; dkim=pass (2048-bit key) header.d=baylibre-com.20230601.gappssmtp.com header.i=@baylibre-com.20230601.gappssmtp.com header.b=hflikc0s; arc=none smtp.client-ip=209.85.160.176 Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=baylibre.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=baylibre.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=baylibre-com.20230601.gappssmtp.com header.i=@baylibre-com.20230601.gappssmtp.com header.b="hflikc0s" Received: by mail-qt1-f176.google.com with SMTP id d75a77b69052e-434b7ab085fso6669311cf.1 for ; Wed, 24 Apr 2024 05:58:55 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=baylibre-com.20230601.gappssmtp.com; s=20230601; t=1713963535; x=1714568335; darn=vger.kernel.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=NHi7Hnvu0W08HA6Kwdt8/hs0TiGDjcdW4J//1QssoGs=; b=hflikc0s9BMPJNId1QEHjlfGWO0x+q6gqu41EBSUGiqWtduZiankpRzmzHFwsTEP40 ugDftsyLSAvJ0TBIbuqXxOVUTw4bYAzxwRuAYQb3VXig99jqeW/VqV+N4ZqMsZTDtDLq Zj4RV+j/ZAxb4SjAIDk9rtASqD/zWeIpz6hAG5cLm8Ytw6L0vrkwZuFiuGSBcNs5aepE ZUG6Fbvu8QqNUy0VmwUsZcDxUFgdXOWUUI7d0UUOwuG81k0xmEwS4H1zp9le44YOPsUp z1kHjrCb+MKyOuh6XUOoR7CtIRvRZOIMPqS9zukZXoC3fkgBxTTaBtS1byR9sWO/8Pg9 XgEg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1713963535; x=1714568335; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=NHi7Hnvu0W08HA6Kwdt8/hs0TiGDjcdW4J//1QssoGs=; b=lG6jDUVwNRZnxtZw0hin4pqB7KR1XBCxTm3g+8UXwUXD2WSyN1vW73kUvrG9r/kQ4T lLP3ssofXzDTstLixm3MrW8hiaMFOlimOeMUomflGn13NAw0gBzYubFNQrKT39HHUHr6 3D2m7WnTkpZ5kw0jI+sPEeE0BUL3kvIGBrJrtRVAXjEIxbbRfukBUzt+iu1WbKi+aQxp MqvpEOr5otPpm/MTrKVUZuYgcp2l9K8waI2uRKqMieAWSAKH2NXYcEMWK72ZE4xz+JJa Qh0szTgiOBBg40AkOw5EJehZSWynHD3sx6QlVVA4vl2zcPT8IpJ7yvPMBJfPt7vpPC/C lOsw== X-Gm-Message-State: AOJu0Yy5ZfXZTiMQv3JW4PgdnlecOeT54eyRm5fQFb8Yo87b+UBpvXAL mVMwaoEmTJlxqCeftUlaVnvgd9hD0GY85J7qYFmwRPZ5ydJKpZ3n82335zHklp8= X-Google-Smtp-Source: AGHT+IEpZ6wsBMwz+LaxVLqVPmitDDLN4khq62DNepb6n5WHfPUHWRAtX/25nN2pysYg7THqtf79bA== X-Received: by 2002:a05:622a:4e9a:b0:437:a0fc:8aaa with SMTP id dj26-20020a05622a4e9a00b00437a0fc8aaamr9217276qtb.23.1713963535092; Wed, 24 Apr 2024 05:58:55 -0700 (PDT) Received: from megalith.oryx-coho.ts.net (d24-150-219-207.home.cgocable.net. [24.150.219.207]) by smtp.gmail.com with ESMTPSA id ki16-20020a05622a771000b00439c3072d24sm2399995qtb.15.2024.04.24.05.58.54 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 24 Apr 2024 05:58:54 -0700 (PDT) From: Trevor Gamblin To: linux-pwm@vger.kernel.org Cc: linux-kernel@vger.kernel.org, u.kleine-koenig@pengutronix.de, michael.hennerich@analog.com, nuno.sa@analog.com, tgamblin@baylibre.com, dlechner@baylibre.com, devicetree@vger.kernel.org, krzysztof.kozlowski+dt@linaro.org, conor+dt@kernel.org Subject: [PATCH 2/2 v5] pwm: Add driver for AXI PWM generator Date: Wed, 24 Apr 2024 08:58:48 -0400 Message-ID: <20240424125850.4189116-3-tgamblin@baylibre.com> X-Mailer: git-send-email 2.44.0 In-Reply-To: <20240424125850.4189116-1-tgamblin@baylibre.com> References: <20240424125850.4189116-1-tgamblin@baylibre.com> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" From: Drew Fustini Add support for the Analog Devices AXI PWM Generator. This device is an FPGA-implemented peripheral used as PWM signal generator and can be interfaced with AXI4. The register map of this peripheral makes it possible to configure the period and duty cycle of the output signal. Link: https://wiki.analog.com/resources/fpga/docs/axi_pwm_gen Co-developed-by: Sergiu Cuciurean Signed-off-by: Sergiu Cuciurean Co-developed-by: David Lechner Signed-off-by: David Lechner Signed-off-by: Drew Fustini Acked-by: Nuno Sa Co-developed-by: Trevor Gamblin Signed-off-by: Trevor Gamblin --- v5 changes: * Address feedback for driver in v5: * Clarify device behavior in frontmatter * Include register name in bitfield definitions * Use devm_clk_rate_exclusive_get() and handle error * Squash v2 IP support from: https://lore.kernel.org/linux-pwm/202403142047= 22.1291993-1-tgamblin@baylibre.com/ * Refactor driver code to support only v2 IP * Issues were identified with v1 IP implementation, so only v2 will be supported * Remove axi_pwm_variant struct and usage * Version check in axi_pwmgen_setup() left as-is to limit usage to * only v2 IP v4 changes: * Address feedback for driver in v3: * Update to use devm_pwmchip_alloc() function * Simplify use of dev symbol in axi_pwmgen_probe * Remove unnecessary axi_pwmgen_from_chip function and use pwmchip_get_drvdata directly v3 changes: * Address feedback for driver in v2: * Remove unnecessary blank line in axi_pwmgen_apply * Use macros already defined in for version checking v2 changes: * Address feedback for driver and device tree in v1: * Use more reasonable Kconfig approach * Use common prefixes for all functions * Rename axi_pwmgen struct to axi_pwmgen_ddata * Change use of "pwm" to "ddata" * Set and check state->polarity * Multiply safely with mul_u64_u64_div_u64() * Improve handling of max and zero periods * Error if clk_rate_hz > NSEC_PER_SEC * Add "Limitations" section at top of pwm-axi-pwmgen.c * Don't disable outputs by default * Remove unnecessary macros for period, duty, offset * Fix axi_pwmgen_ddata alignment * Don't artificially limit npwm to four * Use clk_rate_exclusive_get(), balance with clk_rate_exclusive_put() * Cache clk rate in axi_pwmgen_ddata * Don't assign pwm->chip.base, do assign pwm->chip.atomic * Remove redundant calls to clk_get_rate * Test contents of AXI_PWMGEN_REG_CORE_MAGIC instead of arbitrary AXI_PWMGEN_TEST_DATA in AXI_PWMGEN_REG_SCRATCHPAD * Remove redundant clk struct from axi_pwmgen_ddata * Add self as module author * Add major version check for IP core --- MAINTAINERS | 1 + drivers/pwm/Kconfig | 13 ++ drivers/pwm/Makefile | 1 + drivers/pwm/pwm-axi-pwmgen.c | 248 +++++++++++++++++++++++++++++++++++ 4 files changed, 263 insertions(+) create mode 100644 drivers/pwm/pwm-axi-pwmgen.c diff --git a/MAINTAINERS b/MAINTAINERS index d02ece54ccf6..0281ed059718 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -3472,6 +3472,7 @@ L: linux-pwm@vger.kernel.org S: Supported W: https://ez.analog.com/linux-software-drivers F: Documentation/devicetree/bindings/pwm/adi,axi-pwmgen.yaml +F: drivers/pwm/pwm-axi-pwmgen.c =20 AXXIA I2C CONTROLLER M: Krzysztof Adamski diff --git a/drivers/pwm/Kconfig b/drivers/pwm/Kconfig index 1dd7921194f5..00a543de8f82 100644 --- a/drivers/pwm/Kconfig +++ b/drivers/pwm/Kconfig @@ -94,6 +94,19 @@ config PWM_ATMEL_TCB To compile this driver as a module, choose M here: the module will be called pwm-atmel-tcb. =20 +config PWM_AXI_PWMGEN + tristate "Analog Devices AXI PWM generator" + depends on MICROBLAZE || NIOS2 || ARCH_ZYNQ || ARCH_ZYNQMP || ARCH_INTEL_= SOCFPGA || COMPILE_TEST + select REGMAP_MMIO + help + This enables support for the Analog Devices AXI PWM generator. + + This is a configurable PWM generator with variable pulse width and + period. + + To compile this driver as a module, choose M here: the module will be + called pwm-axi-pwmgen. + config PWM_BCM_IPROC tristate "iProc PWM support" depends on ARCH_BCM_IPROC || COMPILE_TEST diff --git a/drivers/pwm/Makefile b/drivers/pwm/Makefile index 90913519f11a..6964ba45c795 100644 --- a/drivers/pwm/Makefile +++ b/drivers/pwm/Makefile @@ -5,6 +5,7 @@ obj-$(CONFIG_PWM_APPLE) +=3D pwm-apple.o obj-$(CONFIG_PWM_ATMEL) +=3D pwm-atmel.o obj-$(CONFIG_PWM_ATMEL_HLCDC_PWM) +=3D pwm-atmel-hlcdc.o obj-$(CONFIG_PWM_ATMEL_TCB) +=3D pwm-atmel-tcb.o +obj-$(CONFIG_PWM_AXI_PWMGEN) +=3D pwm-axi-pwmgen.o obj-$(CONFIG_PWM_BCM_IPROC) +=3D pwm-bcm-iproc.o obj-$(CONFIG_PWM_BCM_KONA) +=3D pwm-bcm-kona.o obj-$(CONFIG_PWM_BCM2835) +=3D pwm-bcm2835.o diff --git a/drivers/pwm/pwm-axi-pwmgen.c b/drivers/pwm/pwm-axi-pwmgen.c new file mode 100644 index 000000000000..e0bf90cc2ba3 --- /dev/null +++ b/drivers/pwm/pwm-axi-pwmgen.c @@ -0,0 +1,248 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Analog Devices AXI PWM generator + * + * Copyright 2024 Analog Devices Inc. + * Copyright 2024 Baylibre SAS + * + * Limitations: + * - The writes to registers for period and duty are shadowed until + * LOAD_CONFIG is written to AXI_PWMGEN_REG_CONFIG, at which point + * they take effect. + * - Reconfiguring a channel doesn't complete the currently running + * period and resets the counters of all other channels, and so very + * likely introduces glitches on these unrelated outputs. + * - Supports normal polarity. Does not support changing polarity. + * - On disable, the PWM output becomes low (inactive). + */ +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#define AXI_PWMGEN_REG_CORE_VERSION 0x00 +#define AXI_PWMGEN_REG_ID 0x04 +#define AXI_PWMGEN_REG_SCRATCHPAD 0x08 +#define AXI_PWMGEN_REG_CORE_MAGIC 0x0C +#define AXI_PWMGEN_REG_CONFIG 0x10 +#define AXI_PWMGEN_REG_NPWM 0x14 +#define AXI_PWMGEN_CHX_PERIOD(ch) (0x40 + (4 * (ch))) +#define AXI_PWMGEN_CHX_DUTY(ch) (0x80 + (4 * (ch))) +#define AXI_PWMGEN_CHX_OFFSET(ch) (0xC0 + (4 * (ch))) +#define AXI_PWMGEN_REG_CORE_MAGIC_VAL 0x601A3471 /* Identification number = to test during setup */ +#define AXI_PWMGEN_LOAD_CONFIG BIT(1) +#define AXI_PWMGEN_REG_CONFIG_RESET BIT(0) + +struct axi_pwmgen_ddata { + struct regmap *regmap; + unsigned long clk_rate_hz; +}; + +static const struct regmap_config axi_pwmgen_regmap_config =3D { + .reg_bits =3D 32, + .reg_stride =3D 4, + .val_bits =3D 32, +}; + +static int axi_pwmgen_apply(struct pwm_chip *chip, struct pwm_device *pwm, + const struct pwm_state *state) +{ + struct axi_pwmgen_ddata *ddata =3D pwmchip_get_drvdata(chip); + unsigned int ch =3D pwm->hwpwm; + struct regmap *regmap =3D ddata->regmap; + u64 period_cnt, duty_cnt; + int ret; + + if (state->polarity !=3D PWM_POLARITY_NORMAL) + return -EINVAL; + + if (state->enabled) { + period_cnt =3D mul_u64_u64_div_u64(state->period, ddata->clk_rate_hz, NS= EC_PER_SEC); + if (period_cnt > UINT_MAX) + period_cnt =3D UINT_MAX; + + if (period_cnt =3D=3D 0) + return -EINVAL; + + ret =3D regmap_write(regmap, AXI_PWMGEN_CHX_PERIOD(ch), period_cnt); + if (ret) + return ret; + + duty_cnt =3D mul_u64_u64_div_u64(state->duty_cycle, ddata->clk_rate_hz, = NSEC_PER_SEC); + if (duty_cnt > UINT_MAX) + duty_cnt =3D UINT_MAX; + + ret =3D regmap_write(regmap, AXI_PWMGEN_CHX_DUTY(ch), duty_cnt); + if (ret) + return ret; + } else { + ret =3D regmap_write(regmap, AXI_PWMGEN_CHX_PERIOD(ch), 0); + if (ret) + return ret; + + ret =3D regmap_write(regmap, AXI_PWMGEN_CHX_DUTY(ch), 0); + if (ret) + return ret; + } + + return regmap_write(regmap, AXI_PWMGEN_REG_CONFIG, AXI_PWMGEN_LOAD_CONFIG= ); +} + +static int axi_pwmgen_get_state(struct pwm_chip *chip, struct pwm_device *= pwm, + struct pwm_state *state) +{ + struct axi_pwmgen_ddata *ddata =3D pwmchip_get_drvdata(chip); + struct regmap *regmap =3D ddata->regmap; + unsigned int ch =3D pwm->hwpwm; + u32 cnt; + int ret; + + ret =3D regmap_read(regmap, AXI_PWMGEN_CHX_PERIOD(ch), &cnt); + if (ret) + return ret; + + state->enabled =3D cnt !=3D 0; + + state->period =3D DIV_ROUND_UP_ULL((u64)cnt * NSEC_PER_SEC, ddata->clk_ra= te_hz); + + ret =3D regmap_read(regmap, AXI_PWMGEN_CHX_DUTY(ch), &cnt); + if (ret) + return ret; + + state->duty_cycle =3D DIV_ROUND_UP_ULL((u64)cnt * NSEC_PER_SEC, ddata->cl= k_rate_hz); + + state->polarity =3D PWM_POLARITY_NORMAL; + + return 0; +} + +static const struct pwm_ops axi_pwmgen_pwm_ops =3D { + .apply =3D axi_pwmgen_apply, + .get_state =3D axi_pwmgen_get_state, +}; + +static int axi_pwmgen_setup(struct regmap *regmap, struct device *dev) +{ + int ret; + u32 val; + + ret =3D regmap_read(regmap, AXI_PWMGEN_REG_CORE_MAGIC, &val); + if (ret) + return ret; + + if (val !=3D AXI_PWMGEN_REG_CORE_MAGIC_VAL) + return dev_err_probe(dev, -ENODEV, + "failed to read expected value from register: got %08x, expected %08x\n= ", + val, + AXI_PWMGEN_REG_CORE_MAGIC_VAL); + + ret =3D regmap_read(regmap, AXI_PWMGEN_REG_CORE_VERSION, &val); + if (ret) + return ret; + + if (ADI_AXI_PCORE_VER_MAJOR(val) !=3D 2) { + return dev_err_probe(dev, -ENODEV, "Unsupported peripheral version %u.%u= .%u\n", + ADI_AXI_PCORE_VER_MAJOR(val), + ADI_AXI_PCORE_VER_MINOR(val), + ADI_AXI_PCORE_VER_PATCH(val)); + } + + /* Enable the core */ + ret =3D regmap_update_bits(regmap, AXI_PWMGEN_REG_CONFIG, AXI_PWMGEN_REG_= CONFIG_RESET, 0); + if (ret) + return ret; + + ret =3D regmap_read(regmap, AXI_PWMGEN_REG_NPWM, &val); + if (ret) + return ret; + + /* Return the number of PWMs */ + return val; +} + +static void axi_pwmgen_clk_rate_exclusive_put(void *data) +{ + clk_rate_exclusive_put(data); +} + +static int axi_pwmgen_probe(struct platform_device *pdev) +{ + struct device *dev =3D &pdev->dev; + struct regmap *regmap; + struct pwm_chip *chip; + struct axi_pwmgen_ddata *ddata; + struct clk *clk; + void __iomem *io_base; + int ret; + + io_base =3D devm_platform_ioremap_resource(pdev, 0); + if (IS_ERR(io_base)) + return PTR_ERR(io_base); + + regmap =3D devm_regmap_init_mmio(dev, io_base, &axi_pwmgen_regmap_config); + if (IS_ERR(regmap)) + return dev_err_probe(dev, PTR_ERR(regmap), + "failed to init register map\n"); + + ret =3D axi_pwmgen_setup(regmap, dev); + if (ret < 0) + return ret; + + chip =3D devm_pwmchip_alloc(dev, ret, sizeof(*ddata)); + if (IS_ERR(chip)) + return PTR_ERR(chip); + ddata =3D pwmchip_get_drvdata(chip); + ddata->regmap =3D regmap; + + clk =3D devm_clk_get_enabled(dev, NULL); + if (IS_ERR(clk)) + return dev_err_probe(dev, PTR_ERR(clk), "failed to get clock\n"); + + ret =3D devm_clk_rate_exclusive_get(dev, clk); + if (ret) + return dev_err_probe(dev, ret, "failed to get exclusive rate\n"); + + ret =3D devm_add_action_or_reset(dev, axi_pwmgen_clk_rate_exclusive_put, = clk); + if (ret) + return ret; + + ddata->clk_rate_hz =3D clk_get_rate(clk); + if (!ddata->clk_rate_hz || ddata->clk_rate_hz > NSEC_PER_SEC) + return dev_err_probe(dev, -EINVAL, + "Invalid clock rate: %lu\n", ddata->clk_rate_hz); + + chip->ops =3D &axi_pwmgen_pwm_ops; + chip->atomic =3D true; + + ret =3D devm_pwmchip_add(dev, chip); + if (ret) + return dev_err_probe(dev, ret, "could not add PWM chip\n"); + + return 0; +} + +static const struct of_device_id axi_pwmgen_ids[] =3D { + { .compatible =3D "adi,axi-pwmgen-2.00.a" }, + { } +}; +MODULE_DEVICE_TABLE(of, axi_pwmgen_ids); + +static struct platform_driver axi_pwmgen_driver =3D { + .driver =3D { + .name =3D "axi-pwmgen", + .of_match_table =3D axi_pwmgen_ids, + }, + .probe =3D axi_pwmgen_probe, +}; +module_platform_driver(axi_pwmgen_driver); + +MODULE_LICENSE("GPL"); +MODULE_AUTHOR("Sergiu Cuciurean "); +MODULE_AUTHOR("Trevor Gamblin "); +MODULE_DESCRIPTION("Driver for the Analog Devices AXI PWM generator"); --=20 2.44.0