Return-Path: <linux-kernel-owner@vger.kernel.org>
Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand
	id S1753495AbbGXMnQ (ORCPT <rfc822;w@1wt.eu>);
	Fri, 24 Jul 2015 08:43:16 -0400
Received: from atrey.karlin.mff.cuni.cz ([195.113.26.193]:58231 "EHLO
	atrey.karlin.mff.cuni.cz" rhost-flags-OK-OK-OK-OK) by vger.kernel.org
	with ESMTP id S1752127AbbGXMnM (ORCPT
	<rfc822;linux-kernel@vger.kernel.org>);
	Fri, 24 Jul 2015 08:43:12 -0400
Date: Fri, 24 Jul 2015 14:43:09 +0200
From: Pavel Machek <pavel@denx.de>
To: atull <atull@opensource.altera.com>
Cc: gregkh@linuxfoundation.org, jgunthorpe@obsidianresearch.com, hpa@zytor.com,
        monstr@monstr.eu, michal.simek@xilinx.com, rdunlap@infradead.org,
        linux-kernel@vger.kernel.org, devicetree@vger.kernel.org,
        pantelis.antoniou@konsulko.com, robh+dt@kernel.org,
        grant.likely@linaro.org, iws@ovro.caltech.edu,
        linux-doc@vger.kernel.org, broonie@kernel.org, philip@balister.org,
        rubini@gnudd.com, s.trumtrar@pengutronix.de, jason@lakedaemon.net,
        kyle.teske@ni.com, nico@linaro.org, balbi@ti.com, m.chehab@samsung.com,
        davidb@codeaurora.org, rob@landley.net, davem@davemloft.net,
        cesarb@cesarb.net, sameo@linux.intel.com, akpm@linux-foundation.org,
        linus.walleij@linaro.org, pawel.moll@arm.com, mark.rutland@arm.com,
        ijc+devicetree@hellion.org.uk, galak@codeaurora.org,
        devel@driverdev.osuosl.org, Petr Cvek <petr.cvek@tul.cz>,
        delicious.quinoa@gmail.com, dinguyen@opensource.altera.com
Subject: Re: [PATCH v9 4/7] staging: fpga manager: add sysfs interface
 document
Message-ID: <20150724124309.GA23493@amd>
References: <1437148277-5405-1-git-send-email-atull@opensource.altera.com>
 <1437148277-5405-5-git-send-email-atull@opensource.altera.com>
 <20150724081829.GA16790@amd>
 <alpine.DEB.2.10.1507240726320.2562@atull-730U3E-740U3E>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <alpine.DEB.2.10.1507240726320.2562@atull-730U3E-740U3E>
User-Agent: Mutt/1.5.23 (2014-03-12)
Sender: linux-kernel-owner@vger.kernel.org
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org
Content-Length: 2894
Lines: 76

On Fri 2015-07-24 07:39:15, atull wrote:
> On Fri, 24 Jul 2015, Pavel Machek wrote:
> 
> Hi Pavel,
> 
> Thanks for your your feedback in cleaning up these docs.
> 
> > Hi!
> > 
> > > +What:		/sys/class/fpga_manager/<fpga>/state
> > > +Date:		July 2015
> > > +KernelVersion:	4.2
> > > +Contact:	Alan Tull <atull@opensource.altera.com>
> > > +Description:	Read fpga manager state as a string.
> > 
> > fpga->FPGA.
> 
> Yep
> 
> > 
> > > +		Valid states may vary by manufacturer; superset is:
> > > +		* unknown		= can't determine state
> > > +		* power off		= FPGA power is off
> > > +		* power up		= FPGA reports power is up
> > > +		* reset			= FPGA held in reset state
> > > +		* firmware request	= firmware class request in progress
> > > +		* firmware request error = firmware request failed
> > > +		* write init		= FPGA being prepared for programming
> > > +		* write init error	= Error while preparing FPGA for
> > > +					  programming
> > > +		* write			= FPGA ready to receive image data
> > > +		* write error		= Error while programming
> > > +		* write complete	= Doing post programming steps
> > > +		* write complete error	= Error while doing post programming
> > > +		* operating		= FPGA is programmed and operating
> > 
> 
> If I can make my intent clear, maybe we can figure out what will be most
> useful here.  
> 
> The intent is to provide enough detail that if something goes wrong with
> the FPGA programming (something that the driver can't take care of) then 
> userspace can know that.  Such as if the firmware request fails, that 
> could be due to not being able to find the firmware file.
> 
> > This will need some more details. "firmware request" is hardly a
> > hardware state, does it belong here? 
> 
> This is a superset of FPGA states and fpga manager driver states as the
> fpga manager driver is walking through the steps to get the FPGA into
> a known operating state.  So it's a sequence, though some steps may get
> skipped. If there is an error, then userspace can know what step failed.
> 
> Maybe this should be separated into fpga_state for hardware state and
> fpga_mgr_status (to report what step of progress the fpga manager driver
> is at during programming).  I want this to be useful and still not be 
> device (FPGA) specific.
> 
> > Is power off or on while firmware
> > is being requested? 
> 
> On.  It's a sequence.

Aha. Ok, so maybe noting that states normally go in the sequence (with
exception of various errors) would be enough?

Thanks,
									Pavel
-- 
(english) http://www.livejournal.com/~pavelmachek
(cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/