From:   Sean Anderson <sean.anderson@seco.com>
Subject: Re: [PATCH v11 2/2] pwm: Add support for Xilinx AXI Timer
To:     Mubin Usman Sayyed <MUBINUSM@xilinx.com>,
        Michal Simek <monstr@monstr.eu>,
        "linux-pwm@vger.kernel.org" <linux-pwm@vger.kernel.org>,
        "devicetree@vger.kernel.org" <devicetree@vger.kernel.org>,
        Thierry Reding <thierry.reding@gmail.com>
Cc:     "linux-arm-kernel@lists.infradead.org" 
        <linux-arm-kernel@lists.infradead.org>,
        Alvaro Gamez <alvaro.gamez@hazent.com>,
        Lee Jones <lee.jones@linaro.org>,
        =?UTF-8?Q?Uwe_Kleine-K=c3=b6nig?= <u.kleine-koenig@pengutronix.de>,
        Michal Simek <michals@xilinx.com>,
        "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>
References: <20211123232536.3909773-1-sean.anderson@seco.com>
 <20211123232536.3909773-2-sean.anderson@seco.com>
 <ce51714f-0a29-6dd5-aba2-4cb790617a12@monstr.eu>
 <BYAPR02MB4278A250C64CEEAED222A785A1759@BYAPR02MB4278.namprd02.prod.outlook.com>
 <91cfadf3-fe9e-398c-e563-c700522bba06@seco.com>
 <BYAPR02MB427839858F255B562062C607A1759@BYAPR02MB4278.namprd02.prod.outlook.com>
Message-ID: <2a5229f4-75cb-3a27-7746-6d9cd097d022@seco.com>
Date:   Tue, 14 Dec 2021 12:54:24 -0500
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101
 Thunderbird/68.10.0
In-Reply-To: <BYAPR02MB427839858F255B562062C607A1759@BYAPR02MB4278.namprd02.prod.outlook.com>
Content-Type: text/plain; charset=utf-8; format=flowed
Content-Language: en-US
Content-Transfer-Encoding: 8bit
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?utf-8?B?bWk2Sy90ZlVLUFQrUUEvT1psRjlJODlRQUxCRy9BZEVybnVSVGtCTGlMMG5s?=
 =?utf-8?B?ZnY0anFRSGVRUm1YK3Q2MnBBaW5XbENtanFOeGVNTlMvdFZ4TEt6cFErcUd4?=
 =?utf-8?B?SnZaeitBNG5ZVGxOcnpaYXdMZW9pa2FiSHZ0MTBwMnB2QXM2MXBXdGxxRS9T?=
 =?utf-8?B?ZzNVSDdZUW1ia1JoaHlQZno4TFhQeCszR0FuVzVYUWRGWUhBQ21qcHA3clRx?=
 =?utf-8?B?U2JtazRXSUl4VmdORHozQXZseEdVYXo2c0NsQ1BEdlFpaitPT3hYRWNCRjJR?=
 =?utf-8?B?NkJxOFN5SWdxMWYxMkwwa2J0Vmh2bDdhdTZ4bzdIZ2tSWXc2enVQWGJCVEpy?=
 =?utf-8?B?empYOWN1T25wZkdNRnJnTFl6cWJsVXdVYUxlWUpTOUpkMmVmT2R2R1dWYU5R?=
 =?utf-8?B?aVhkdElBWHNaeWtyUlkyNWxyelVpWUh1b095Ulk0cFAzclJ3aHhFelVJMXN2?=
 =?utf-8?B?Z2JDc281L2tYZTRoUWJMYUFOcWJHN1JOVjRlSEt3Y1dRQTlFcnRWYnVXN0dL?=
 =?utf-8?B?cjAvdUE4dExQNWhFdUlsdHllUmdOck1wNm9Xd1liWXdGM2QrNmtzdnJoOTd2?=
 =?utf-8?B?Z2ZZWVc2SFdjQlNRbWV5QzBnZ01yVmhUSzZBckdxbmlkSXFmQW1qUnI3M1JH?=
 =?utf-8?B?V3B0S1Q3c0x4Ty9sMFlWN3NMRVRxcWZYUUJ3N2kydGVYcUZMdEk2NDFwb0Nv?=
 =?utf-8?B?Z3lyTTRZd1g2Z1g5aUdmVWpURnc1UXNlamZ0VEtpQ2Z3dzRRYWp3VGZxOGI2?=
 =?utf-8?B?Nm1BcEJYU2dIKzc4UkNrbjR6RDluM1NPVy9wcjZzK0ZaUUJ3UU5jQ3k0Sm5K?=
 =?utf-8?B?WDNWbVJpZzhveUtzZTZ6YkEwcWVyLzBEN0locGIyU0RnY1d5SlEvVjZUdVBG?=
 =?utf-8?B?dTgvZkU5ZFBFeHMxZURQdVJCWDFsZzMvNHprWHl3WWRhZERzOGxMTVJzM3M1?=
 =?utf-8?B?aGlJU081T1lScngzRjQxTm5YaUFNUkxZWWJCQkdhdTFtbkFvN2lEWDNUZWVF?=
 =?utf-8?B?VW4zUExmQm5JK2o3MkVRUmR2cXNZUVg5MDlVcXlRaGUrdWRtL24wSzFqai9m?=
 =?utf-8?B?S3IyTjhvZUhiS1VvL01udmFzVjFqSzZBVUZYM1ZIVkZrUW1OamQ0NXFuSGtD?=
 =?utf-8?B?cDlCallRYXNHeWEza3Q3UUhyM2FWcWNUYXhEMXRwaThRVU9NYzhxZG1SZmFw?=
 =?utf-8?B?UzR3aTdROUNUNm1qQnZrRksyMUVBUEdZQXducDFOWVpNdVZ0MmVxR0JkcTVN?=
 =?utf-8?B?RWRVTGtoSWV3dmtvWDU0M3VONDIwUXRxdHR1Sy9NVUliZEpPYVFjcnJNTmMw?=
 =?utf-8?B?eFlNOFhwa1dQeUNPVldpTUpxanlHMTRxQlMxU3A4Sjg0bnRySnpZNDVSWFFH?=
 =?utf-8?B?bVlDbk5Na1Q4cVJYN1lHZytIN0psZ0JBN25DZUZLcHY2WFkwN1RadzBCT05i?=
 =?utf-8?B?S1ZYdnl3RlBGd0lsR3pSU2tEWG5Mbit5cnJ5MWEwMGxTNUJQYXgvZ3h5SWky?=
 =?utf-8?B?YkgvRHd3RUVEL1E4bWt6aDF3djVLSHdWU3VTSVRlRzJVZi92VXhSajBpVjkr?=
 =?utf-8?B?eFpodEU3UDg3MGpmZHQzOThicDI0SU9Xb2h2anQ3QzgyZTI4MFNFZ1ZzUjMr?=
 =?utf-8?B?c1RlNmFuQkMvUDRNWHQrTlhqSGFGYXIrS1BGK1dsd2dJQ2tFbnY5VUZJeE1M?=
 =?utf-8?B?WElheFc3cHpYUmd0WXZ1SHhYdHpBK0JReWtGcXdwbzRmZWFBcytoVTdTQjJt?=
 =?utf-8?B?SHh5TjZlUHZkdjZSTy9GNFZwa1VUdS8vOUFuR2pZVzczcW9QOHdmZG9lTDB2?=
 =?utf-8?B?RnBYR24xMi9DM0kraEQ1bjhWTVdYRnJUbHhIa0pQb1FyK3pPZXhWa21LUDJW?=
 =?utf-8?B?LytzN3lEOVpOM0Frb002VmVUek1taUxET2t2azVKU2UwU001VFlQUlZ3Ynp3?=
 =?utf-8?B?ajJFTVJjWG11VnlPWThLVzVyUXBZQmZSUnM1UFc5MFBGWVZLVXM5bHh1Rmd5?=
 =?utf-8?B?QkRXQ3hWNWgrU294TFdWLzRIOUJvUm1SeXZob3F0WnN1N09IUmRtQ3VSNkdK?=
 =?utf-8?B?MVYyb0ZWeWNGTEdjY3p5T2VvMm81QkUzMUMrb0p0Vkt1UE13cndQUWFDZ0NL?=
 =?utf-8?B?WWZtdGI1VjFUTWlydnJUenVkdGdJZlNuNE9QOE91aXlSWUpDaUxqWmErbjd4?=
 =?utf-8?Q?piy4qiL1+L6uT8yRpAgLf2s=3D?=
X-OriginatorOrg: seco.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 669793af-727b-4863-18db-08d9bf2ac6a6
X-MS-Exchange-CrossTenant-AuthSource: DB7PR03MB4523.eurprd03.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 14 Dec 2021 17:54:29.3440
 (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: O/3GM7k40VBRiAIxqynN18+YJ9JalZpVbN3eIGtfRClsKthYKP13T/zElVDUoU//6+nCgoFBRwNGioQ5X4UGUQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DB7PR03MB4857
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

On 12/14/21 12:39 PM, Mubin Usman Sayyed wrote:
> Hi Sean,
>
>> -----Original Message-----
>> From: Sean Anderson <sean.anderson@seco.com>
>> Sent: Tuesday, December 14, 2021 9:16 PM
>> To: Mubin Usman Sayyed <MUBINUSM@xilinx.com>; Michal Simek
>> <monstr@monstr.eu>; linux-pwm@vger.kernel.org;
>> devicetree@vger.kernel.org; Thierry Reding <thierry.reding@gmail.com>
>> Cc: linux-arm-kernel@lists.infradead.org; Alvaro Gamez
>> <alvaro.gamez@hazent.com>; Lee Jones <lee.jones@linaro.org>; Uwe
>> Kleine-König <u.kleine-koenig@pengutronix.de>; Michal Simek
>> <michals@xilinx.com>; linux-kernel@vger.kernel.org
>> Subject: Re: [PATCH v11 2/2] pwm: Add support for Xilinx AXI Timer
>>
>>
>>
>> On 12/14/21 4:08 AM, Mubin Usman Sayyed wrote:
>> > Hi Sean,
>> >
>> >> -----Original Message-----
>> >> From: Michal Simek <monstr@monstr.eu>
>> >> Sent: Tuesday, December 14, 2021 1:38 PM
>> >> To: Sean Anderson <sean.anderson@seco.com>; linux-
>> >> pwm@vger.kernel.org; devicetree@vger.kernel.org; Thierry Reding
>> >> <thierry.reding@gmail.com>
>> >> Cc: linux-arm-kernel@lists.infradead.org; Alvaro Gamez
>> >> <alvaro.gamez@hazent.com>; Lee Jones <lee.jones@linaro.org>; Uwe
>> >> Kleine-König <u.kleine-koenig@pengutronix.de>; Michal Simek
>> >> <michals@xilinx.com>; linux-kernel@vger.kernel.org; Mubin Usman
>> >> Sayyed <MUBINUSM@xilinx.com>
>> >> Subject: Re: [PATCH v11 2/2] pwm: Add support for Xilinx AXI Timer
>> >>
>> >> +Mubin
>> >>
>> >> On 11/24/21 00:25, Sean Anderson wrote:
>> >> > 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.
>> >> >
>> >> > Some common code has been specially demarcated. While currently
>> >> > only used by the PWM driver, it is anticipated that it may be split
>> >> > off in the future to be used by the timer driver as well.
>> >> >
>> >> > This driver was written with reference to Xilinx DS764 for v1.03.a [1].
>> >> >
>> >> > [1]
>> >> >
>> >>
>> https://www.xilinx.com/support/documentation/ip_documentation/axi_tim
>> >> e
>> >> > r/v1_03_a/axi_timer_ds764.pdf
>> >> >
>> >> > Signed-off-by: Sean Anderson <sean.anderson@seco.com>
>> >> > Acked-by: Michal Simek <michal.simek@xilinx.com>
>> >> > ---
>> >> >
>> >> > Changes in v11:
>> >> > - Add comment about why we test for #pwm-cells
>> >> > - Clarify comment on generate out signal
>> >> > - Rename pwm variables to xilinx_pwm
>> >> > - Round like Uwe wants...
>> >> > - s/xilinx_timer/xilinx_pwm/ for non-common functions
>> >> >
>> >> > Changes in v10:
>> >> > - Fix compilation error in timer driver
>> >> >
>> >> > Changes in v9:
>> >> > - Refactor "if { return } else if { }" to "if { return } if { }"
>> >> > - Remove drivers/clocksource/timer-xilinx-common.c from
>> MAINTAINERS
>> >> > - Remove xilinx_timer_common_init and integrate it into
>> >> > xilinx_timer_probe
>> >> >
>> >> > Changes in v8:
>> >> > - Drop new timer driver; it has been deferred for future series
>> >> >
>> >> > Changes in v7:
>> >> > - Add dependency on OF_ADDRESS
>> >> > - Fix period_cycles calculation
>> >> > - Fix typo in limitations
>> >> >
>> >> > Changes in v6:
>> >> > - Capitalize error messages
>> >> > - Don't disable regmap locking to allow inspection of registers via
>> >> >    debugfs
>> >> > - Prevent overflow when calculating period_cycles
>> >> > - Remove enabled variable from xilinx_pwm_apply
>> >> > - Swap order of period_cycle range comparisons
>> >> >
>> >> > Changes in v5:
>> >> > - Allow non-zero #pwm-cells
>> >> > - Correctly set duty_cycle in get_state when TLR0=TLR1
>> >> > - Elaborate on limitation section
>> >> > - Perform some additional checks/rounding in apply_state
>> >> > - Remove xlnx,axi-timer-2.0 compatible string
>> >> > - Rework duty-cycle and period calculations with feedback from Uwe
>> >> > - Switch to regmap to abstract endianness issues
>> >> > - Use more verbose error messages
>> >> >
>> >> > Changes in v4:
>> >> > - 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.
>> >> > - Remove references to properties which are not good enough for
>> Linux.
>> >> >
>> >> > Changes in v3:
>> >> > - Add clockevent and clocksource support
>> >> > - Remove old microblaze driver
>> >> > - 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!
>> >> >
>> >> > Changes in v2:
>> >> > - Add comment describing device
>> >> > - Add comment explaining why we depend on !MICROBLAZE
>> >> > - Add dependencies on COMMON_CLK and HAS_IOMEM
>> >> > - Cast dividends to u64 to avoid overflow
>> >> > - Check for over- and underflow when calculating TLR
>> >> > - Check range of xlnx,count-width
>> >> > - Don't compile this module by default for arm64
>> >> > - Don't set pwmchip.base to -1
>> >> > - Ensure the clock is always running when the pwm is registered
>> >> > - Remove debugfs file :l
>> >> > - Rename TCSR_(SET|CLEAR) to TCSR_RUN_(SET|CLEAR)
>> >> > - Report errors with dev_error_probe
>> >> > - Set xilinx_pwm_ops.owner
>> >> > - Use NSEC_TO_SEC instead of defining our own
>> >> > - Use TCSR_RUN_MASK to check if the PWM is enabled, as suggested
>> by
>> >> > Uwe
>> >> >
>> >> >   MAINTAINERS                        |   6 +
>> >> >   arch/microblaze/kernel/timer.c     |   3 +
>> >> >   drivers/pwm/Kconfig                |  14 ++
>> >> >   drivers/pwm/Makefile               |   1 +
>> >> >   drivers/pwm/pwm-xilinx.c           | 318
>> +++++++++++++++++++++++++++++
>> >> >   include/clocksource/timer-xilinx.h |  91 +++++++++
>> >> >   6 files changed, 433 insertions(+)
>> >> >   create mode 100644 drivers/pwm/pwm-xilinx.c
>> >> >   create mode 100644 include/clocksource/timer-xilinx.h
>> >> >
>> >> > diff --git a/MAINTAINERS b/MAINTAINERS index
>> >> > 5250298d2817..b2b3ce106e99 100644
>> >> > --- a/MAINTAINERS
>> >> > +++ b/MAINTAINERS
>> >> > @@ -20897,6 +20897,12 @@ F:	drivers/misc/Makefile
>> >> >   F:	drivers/misc/xilinx_sdfec.c
>> >> >   F:	include/uapi/misc/xilinx_sdfec.h
>> >> >
>> >> > +XILINX PWM DRIVER
>> >> > +M:	Sean Anderson <sean.anderson@seco.com>
>> >> > +S:	Maintained
>> >> > +F:	drivers/pwm/pwm-xilinx.c
>> >> > +F:	include/clocksource/timer-xilinx.h
>> >> > +
>> >> >   XILINX UARTLITE SERIAL DRIVER
>> >> >   M:	Peter Korsgaard <jacmet@sunsite.dk>
>> >> >   L:	linux-serial@vger.kernel.org
>> >> > diff --git a/arch/microblaze/kernel/timer.c
>> >> > b/arch/microblaze/kernel/timer.c index f8832cf49384..dea34a3d4aa4
>> >> > 100644
>> >> > --- a/arch/microblaze/kernel/timer.c
>> >> > +++ b/arch/microblaze/kernel/timer.c
>> >> > @@ -251,6 +251,9 @@ static int __init xilinx_timer_init(struct
>> >> > device_node
>> >> *timer)
>> >> >   	u32 timer_num = 1;
>> >> >   	int ret;
>> >> >
>> >> > +	if (of_property_read_bool(timer, "#pwm-cells"))
>> >> > +		return 0;
>> > [Mubin]:  Can you please return  -ENODEV here,  PWM driver would not be
>> probed if return value is 0.
>>
>> This needs to return 0 so that timer_probe doesn't spuriously announce the
>> "error".
> [Mubin]: I am trying similar implementation for cadence TTC timer. I observed that, pwm driver is not getting probed, if 0 is returned from clocksource driver (based on pwm-cells property).

I believe that is because the ttc is not used as the primary
clocksource, and so is probed by usual methods (e.g.
call_driver_probe). TIMER_OF_DECLARE drivers get set up before the rest
of the driver model is set up, and timer_probe probes them manually.

--Sean