Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
Subject: Re: [PATCH] pwm: stm32: add comment to better describe breakinput
 feature
To:     =?UTF-8?Q?Uwe_Kleine-K=c3=b6nig?= <u.kleine-koenig@pengutronix.de>
CC:     <thierry.reding@gmail.com>, <alexandre.torgue@st.com>,
        <benjamin.gaignard@st.com>, <linux-pwm@vger.kernel.org>,
        <linux-arm-kernel@lists.infradead.org>,
        <linux-kernel@vger.kernel.org>,
        <linux-stm32@st-md-mailman.stormreply.com>
References: <1570534887-26181-1-git-send-email-fabrice.gasnier@st.com>
 <20191008144531.pjt525xuz7n5a3hq@pengutronix.de>
From:   Fabrice Gasnier <fabrice.gasnier@st.com>
Message-ID: <5c05893b-e938-4db8-e33a-803b1a498f97@st.com>
Date:   Wed, 9 Oct 2019 11:51:05 +0200
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101
 Thunderbird/60.8.0
MIME-Version: 1.0
In-Reply-To: <20191008144531.pjt525xuz7n5a3hq@pengutronix.de>
Content-Type: text/plain; charset="utf-8"
Content-Language: en-US
Content-Transfer-Encoding: 8bit
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

On 10/8/19 4:45 PM, Uwe Kleine-König wrote:
> On Tue, Oct 08, 2019 at 01:41:27PM +0200, Fabrice Gasnier wrote:
>> Add a comment to better describe the purpose of breakinput feature that
>> can be found on some STM32 timer instances. Briefly comment on the
>> characteristics of this input for PWM, and pinmuxing as suggested in [1].
>>
>> [1] https://lkml.org/lkml/2019/10/1/207
>>
>> Signed-off-by: Fabrice Gasnier <fabrice.gasnier@st.com>
>> ---
>>  drivers/pwm/pwm-stm32.c | 8 +++++++-
>>  1 file changed, 7 insertions(+), 1 deletion(-)
>>
>> diff --git a/drivers/pwm/pwm-stm32.c b/drivers/pwm/pwm-stm32.c
>> index 359b085..6406ebb 100644
>> --- a/drivers/pwm/pwm-stm32.c
>> +++ b/drivers/pwm/pwm-stm32.c
>> @@ -522,8 +522,14 @@ static int stm32_pwm_apply_breakinputs(struct stm32_pwm *priv,
>>  					     sizeof(struct stm32_breakinput));
>>  
>>  	/*
>> +	 * Some timer instances can have BRK input pins (e.g. basically a fault
>> +	 * pin from the output power stage). The break feature allows a safe
>> +	 * shut-down of the PWM outputs to a predefined state. Further details
>> +	 * are available in application note AN4277, "Using STM32 device PWM
>> +	 * shut-down features..."
> 
> Without having read the application note I don't understand the purpose.
> Not sure if this should be a show stopper though.

Hi Uwe,

I can rephrase this. Do you think the bellow comment would be more
relevant and easy to understand ?

/*
 * The break feature allows a safe shut-down of the PWM outputs.
 * It's based on the BRK event signal defined in the dt-bindings
 * by <index level filter> values.
 * Because "st,breakinput" parameter is optional do not make probe
 * failed if it doesn't exist.
 */

> 
>>  	 * Because "st,breakinput" parameter is optional do not make probe
>> -	 * failed if it doesn't exist.
>> +	 * failed if it doesn't exist. The pinctrl handle must hold the BRK
>> +	 * pin(s) when using "st,breakinput" property.
> 
> Is this a comment that has a better place in the binding doc?

You're right, this is unneeded here. I'll remove this.

Please advise,
BR,
Fabrice

> 
> Best regards
> Uwe
> 
>