Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Date:   Sun, 2 Apr 2023 19:18:13 -0700
From:   Ira Weiny <ira.weiny@intel.com>
To:     Dan Carpenter <error27@gmail.com>,
        Khadija Kamran <kamrankhadijadj@gmail.com>
CC:     <outreachy@lists.linux.dev>, <hvaibhav.linux@gmail.com>,
        <johan@kernel.org>, <elder@kernel.org>,
        <gregkh@linuxfoundation.org>, <greybus-dev@lists.linaro.org>,
        <linux-staging@lists.linux.dev>, <linux-kernel@vger.kernel.org>,
        Alison Schofield <alison.schofield@intel.com>
Subject: Re: [PATCH 2/2] staging: greybus: refactor arche_platform_wd_irq()
Message-ID: <642a376532b26_394c3829466@iweiny-mobl.notmuch>
References: <cover.1680185025.git.kamrankhadijadj@gmail.com>
 <96d04a4ff3d4a46293355f5afae3a8ece65f2c5b.1680185025.git.kamrankhadijadj@gmail.com>
 <6ce8aa34-e600-4d6a-adad-ead8255342e5@kili.mountain>
Content-Type: text/plain; charset="us-ascii"
Content-Disposition: inline
In-Reply-To: <6ce8aa34-e600-4d6a-adad-ead8255342e5@kili.mountain>
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?X+8m1uP5slzLKVKxc9JLxnIl30BysJHZ+voEIvyHjw4VMvIeVVHRNCLPg6N+?=
 =?us-ascii?Q?Chy0VLgGVRX75UUquwBNMUyLrjmzXmAy96mJUl0nfc5RbYbILIOxNlo+EREB?=
 =?us-ascii?Q?aReeafPq288dY5zkK9u1jYHMak60wBgMS/QKAJaorZjBr/mcNA8ySVc8axEy?=
 =?us-ascii?Q?I4rscvo1nxS27BFC1azAHUxvabEI5FA8XZ7uyukifoGd7JVSOUNaJMfRCsK6?=
 =?us-ascii?Q?WwmeTmv47ceGMY2PhjpeKDgcSzWkZRhCxvyqllZwdC/9HiBTZNL/Ki7k5Ae2?=
 =?us-ascii?Q?tNppfkSsOZ270dJQtAzC3ujqehbG1ibgkr2C1MTSvVTSWFpA2Yuo3x+gEz5n?=
 =?us-ascii?Q?EzHBFxVR61AQppoh5W7mMeE3UNrNV3ZbImZteIDE4bMcpZ9Jiu8uZc5pe7Ra?=
 =?us-ascii?Q?hp1xS0huk+op/o1RyEJwmSHoeoMWMr9frN8jL31fWXbKJE4IXmcp1DVyzIZq?=
 =?us-ascii?Q?LkHj5Q2z7LkeusgWRVfqpC7y+NGKajuuZ/RciwYAZHq/KNLPofsfxftAdjF6?=
 =?us-ascii?Q?IbYVOemZt467F9bINdB71hyYnnpFFeHiolOwPT7RIzsX0qAxkR1Ehe1XJ21e?=
 =?us-ascii?Q?PZxq+kaYpRdrJthvQismDSCQ6EWCTZuFkINmQZkMLa0Uxcdn8r6GbqJ/f+Zh?=
 =?us-ascii?Q?teZ7+dI+o8LGqXlg+S1TfKEpB2O0CTeVGMPLTrzzur4f1C1SilPTy2wNCTxC?=
 =?us-ascii?Q?JKKqiw1H0XDxrVZVJpjU//oLtcfK4VcC73FIw2PR6Ixo6nalfRqWuilxsoU5?=
 =?us-ascii?Q?kAQZRrJTD6wPOb6VfNQ0sNBVdKPc1dovJ1bjxdkHNOaQeeH/kexJpL3h4SUC?=
 =?us-ascii?Q?2T1TskUUaRanS9sT7G3xQkuybKgx2YgloU7T9VVrp4yRZsdA+LTGr7DLL3qO?=
 =?us-ascii?Q?q6bTYVRYh2agwC+eS3ChHPC2IqwLTB+LGhjaRwAUMqh6dChlxegY7I/i/ACO?=
 =?us-ascii?Q?jzUJBT31yHlPc0ClLhdBScH7eyx9wZ+CevsP4fwQ/QhpSctm0WGp1j2Htx7q?=
 =?us-ascii?Q?OFgnELOsSbmvseQMq5M7ODXd+b+TKLzlRQeDkchkKHl9Syokaktp7erPub7a?=
 =?us-ascii?Q?egbdzAo4nnV1amRF0HUt2dqmBTFcIA2GI8eM5ySWHnSs2qqJf2SClvPvewzO?=
 =?us-ascii?Q?6XLm2Z9kd4OGzIedjSPHrwvxsZ17Z4OwoN8FloT7btX+zAgJ8zDa+d4NejiZ?=
 =?us-ascii?Q?GN6Ij63qryr6sQKBJjt+691cb90BuCOT/WCiuRnklGL0+QxjMoKj29K05e5y?=
 =?us-ascii?Q?sk7rrvuLeMGNQKrHG7gVUFDKosXXjXV42v4IcafGcKAZoPTNrexOIzbn7pvF?=
 =?us-ascii?Q?mZWd3uSpTN3mS4cotLcUfrqEXcayMuWnX9J3wrejP+FTIpA65yc/zpKDjonR?=
 =?us-ascii?Q?/XNZG+aIzJrog4lnVxT6INaZ1KF40L8wFr2VCc/QHO73nD2klZidgPx5dZUC?=
 =?us-ascii?Q?mqzSRY0Cgb+AZhFQrP1vc0wyG0B3SvcJ/iW+lRyqhz1Ew3oqaEV/f4KPtlch?=
 =?us-ascii?Q?utOJuHbhnEHCcMZrZiJS4ClCBNSWYvaDwInz3fdezUxblXYMYO8z90izW5Mm?=
 =?us-ascii?Q?qOc4mmR1uOm2wLquQHq0N/Dg2Foax2vFNcsj66tO?=
X-MS-Exchange-CrossTenant-Network-Message-Id: d100e2b1-9a98-4e47-a6fb-08db33e9afde
X-MS-Exchange-CrossTenant-AuthSource: SA1PR11MB6733.namprd11.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 03 Apr 2023 02:18:17.6079
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 46c98d88-e344-4ed4-8496-4ed7712e255d
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: LBikX3iQuT8b2ORRnE3iTuxBG+YUBI9RIPSHlmTPj/TBdGUwBfWwVxF52VJ61GCDrK5Hw4E6tqU6hxsMIeDLJg==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: CO1PR11MB4772
X-OriginatorOrg: intel.com
X-Spam-Status: No, score=-2.5 required=5.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_MED,SPF_HELO_PASS,
        SPF_NONE autolearn=unavailable autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

Dan Carpenter wrote:
> On Thu, Mar 30, 2023 at 07:11:25PM +0500, Khadija Kamran wrote:
> > Linux kernel coding-style suggests to fix your program if it needs more
> > than 3 levels of indentation. Due to indentation, line length also
> > exceeds 100 columns, resulting in issues reported by checkpatch.
> > 
> > Refactor the arche_platform_wd_irq() function and reduce the indentation
> > with the help of goto statement.
> > 
> > Suggested-by: Alison Schofield <alison.schofield@intel.com>
> > Signed-off-by: Khadija Kamran <kamrankhadijadj@gmail.com>
> > ---
> >  drivers/staging/greybus/arche-platform.c | 79 ++++++++++++------------
> >  1 file changed, 41 insertions(+), 38 deletions(-)
> > 
> > diff --git a/drivers/staging/greybus/arche-platform.c b/drivers/staging/greybus/arche-platform.c
> > index a64c1af091b0..dde30c8da1a1 100644
> > --- a/drivers/staging/greybus/arche-platform.c
> > +++ b/drivers/staging/greybus/arche-platform.c
> > @@ -158,49 +158,52 @@ static irqreturn_t arche_platform_wd_irq(int irq, void *devid)
> >  
> >  	spin_lock_irqsave(&arche_pdata->wake_lock, flags);
> >  
> > -	if (gpiod_get_value(arche_pdata->wake_detect)) {
> > -		/* wake/detect rising */
> > +	if (!gpiod_get_value(arche_pdata->wake_detect))
> > +		goto falling;

I don't like this negative logic here.  Can't this be handled with
positive logic?

> >  
> > +	/* wake/detect rising */
> > +
> > +	/*
> > +	 * If wake/detect line goes high after low, within less than
> > +	 * 30msec, then standby boot sequence is initiated, which is not
> > +	 * supported/implemented as of now. So ignore it.
> > +	 */
> > +	if (arche_pdata->wake_detect_state != WD_STATE_BOOT_INIT)
> > +		goto out;
> 
> This checks that we are in WD_STATE_BOOT_INIT state.

Doesn't this check we are _not_ in WD_STATE_BOOT_INIT?

> 
> > +
> > +	if (time_before(jiffies,
> > +			arche_pdata->wake_detect_start +
> > +			msecs_to_jiffies(WD_COLDBOOT_PULSE_WIDTH_MS))) {
> > +		arche_platform_set_wake_detect_state(arche_pdata,
> > +						     WD_STATE_IDLE);
> > +		got out;
> > +	}
> > +
> > +	/* Check we are not in middle of irq thread already */
> > +	if (arche_pdata->wake_detect_state !=
> > +			WD_STATE_COLDBOOT_START) {
> 
> This checks that we are not in WD_STATE_COLDBOOT_START state.  How are
> we going to be in COLDBOOT if we are in INIT?  Is this changing in the
> background?  Can this check be removed?  This might be took tricky to
> answer but it's important that we understand this before we continue.
> 
> 
> > +		arche_platform_set_wake_detect_state(arche_pdata,
> > +						     WD_STATE_COLDBOOT_TRIG);
> > +		rc = IRQ_WAKE_THREAD;
> > +		goto out;
> > +	}
> 
> Let's assume the above check cannot be removed.
> 
> In the original code if gpiod_get_value(arche_pdata->wake_detect)
> returned true and arche_pdata->wake_detect_state == WD_STATE_IDLE then
> it just returned without doing anything, but now we fall through to the
> falling: label below.

I don't believe we do.  But I think the proposed logic does make this
difficult to detect.

Ira

> 
> So this patch seems like it introduces a bug, but actually it might just
> have a dead code problem.
> 
> regards,
> dan carpenter
> 
> > +
> > +falling:
> > +	/* wake/detect falling */
> > +	if (arche_pdata->wake_detect_state == WD_STATE_IDLE) {
> > +		arche_pdata->wake_detect_start = jiffies;
> >  		/*
> > -		 * If wake/detect line goes high after low, within less than
> > -		 * 30msec, then standby boot sequence is initiated, which is not
> > -		 * supported/implemented as of now. So ignore it.
> > +		 * In the beginning, when wake/detect goes low
> > +		 * (first time), we assume it is meant for coldboot
> > +		 * and set the flag. If wake/detect line stays low
> > +		 * beyond 30msec, then it is coldboot else fallback
> > +		 * to standby boot.
> >  		 */
> > -		if (arche_pdata->wake_detect_state == WD_STATE_BOOT_INIT) {
> > -			if (time_before(jiffies,
> > -					arche_pdata->wake_detect_start +
> > -					msecs_to_jiffies(WD_COLDBOOT_PULSE_WIDTH_MS))) {
> > -				arche_platform_set_wake_detect_state(arche_pdata,
> > -								     WD_STATE_IDLE);
> > -			} else {
> > -				/*
> > -				 * Check we are not in middle of irq thread
> > -				 * already
> > -				 */
> > -				if (arche_pdata->wake_detect_state !=
> > -						WD_STATE_COLDBOOT_START) {
> > -					arche_platform_set_wake_detect_state(arche_pdata,
> > -									     WD_STATE_COLDBOOT_TRIG);
> > -					rc = IRQ_WAKE_THREAD;
> > -				}
> > -			}
> > -		}
> > -	} else {
> > -		/* wake/detect falling */
> > -		if (arche_pdata->wake_detect_state == WD_STATE_IDLE) {
> > -			arche_pdata->wake_detect_start = jiffies;
> > -			/*
> > -			 * In the beginning, when wake/detect goes low
> > -			 * (first time), we assume it is meant for coldboot
> > -			 * and set the flag. If wake/detect line stays low
> > -			 * beyond 30msec, then it is coldboot else fallback
> > -			 * to standby boot.
> > -			 */
> > -			arche_platform_set_wake_detect_state(arche_pdata,
> > -							     WD_STATE_BOOT_INIT);
> > -		}
> > +		arche_platform_set_wake_detect_state(arche_pdata,
> > +						     WD_STATE_BOOT_INIT);
> >  	}
> >  
> > +out:
> >  	spin_unlock_irqrestore(&arche_pdata->wake_lock, flags);
> >  
> >  	return rc;
> > -- 
> > 2.34.1
> > 
>