From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.1 (2015-04-28) on archive.lwn.net X-Spam-Level: X-Spam-Status: No, score=-6.0 required=5.0 tests=MAILING_LIST_MULTI, RCVD_IN_DNSWL_HI autolearn=unavailable autolearn_force=no version=3.4.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by archive.lwn.net (Postfix) with ESMTP id BF30E7D584 for ; Thu, 6 Sep 2018 18:42:17 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1729160AbeIFXS5 (ORCPT ); Thu, 6 Sep 2018 19:18:57 -0400 Received: from mail-pg1-f193.google.com ([209.85.215.193]:36383 "EHLO mail-pg1-f193.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1728848AbeIFXS5 (ORCPT ); Thu, 6 Sep 2018 19:18:57 -0400 Received: by mail-pg1-f193.google.com with SMTP id d1-v6so5680037pgo.3 for ; Thu, 06 Sep 2018 11:42:12 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to:user-agent; bh=xTC0Oyy855old/gbdOWMYBwmjd/ysI2FD60FSB36zZ0=; b=aZE35UM1cVtJR7aqCYLDuMJHJ7Ynqu7I8dJylphFGzF7NN5fROPqcNQt19irUqi2mA h+W8Segf6NvmJngYoAc1gR0uF3dZ2y3FTUY5HQfqSN8UfUjTCH/A6B84Ps2P0uEF80Kv PxH7pX0EqCuh9p43c9IkUG6IBhqIY5nB+GWOZXNV2COgxG+YQd+HPopxgJkJqpruCWCe bf5apmIoVA9G99UNblsFeLoe4dUc+sEDrVw7JiparGUK9Rhj3iKCXMEhoEmAEtjHgYyX FdGIxEfF4sLHA9qwFK4Yjv/8VS6/txolnNHOUPbwdsAQ+njYHiFFq/VJsxNWmFVRUDW0 Onrg== X-Gm-Message-State: APzg51BUnpIwozHGHYCyJVs0stREF0oEkZJarz6rqVry28+NkK0TYjQy UctU3HA+BVO8xOqcnl8NEun2ew== X-Google-Smtp-Source: ANB0VdZphvFmQc0QTy2mIBzER2yTqJsRWFly/Q6rpBnWf7csdC2Bubh8fEKvtRj/vEnhJ1WY4I5X+Q== X-Received: by 2002:aa7:818f:: with SMTP id g15-v6mr4312573pfi.71.1536259331681; Thu, 06 Sep 2018 11:42:11 -0700 (PDT) Received: from localhost ([207.114.172.147]) by smtp.gmail.com with ESMTPSA id a16-v6sm6311797pgv.29.2018.09.06.11.42.10 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Thu, 06 Sep 2018 11:42:11 -0700 (PDT) Date: Thu, 6 Sep 2018 11:42:10 -0700 From: Moritz Fischer To: Alan Tull Cc: Moritz Fischer , Jonathan Corbet , Randy Dunlap , linux-kernel@vger.kernel.org, linux-fpga@vger.kernel.org, linux-doc@vger.kernel.org Subject: Re: [PATCH v2 7/8] docs: fpga: document fpga manager flags Message-ID: <20180906184210.GC20419@archbook> References: <20180904212237.3078-1-atull@kernel.org> <20180904212237.3078-8-atull@kernel.org> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20180904212237.3078-8-atull@kernel.org> User-Agent: Mutt/1.10.1 (2018-07-13) Sender: linux-doc-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org On Tue, Sep 04, 2018 at 04:22:36PM -0500, Alan Tull wrote: > Add flags #defines to kerneldoc documentation in a > useful place. > > Signed-off-by: Alan Tull Acked-by: Moritz Fischer > --- > v2: add description for FPGA_MGR_ENCRYPTED_BITSTREAM > --- > Documentation/driver-api/fpga/fpga-mgr.rst | 5 +++++ > include/linux/fpga/fpga-mgr.h | 20 ++++++++++++++------ > 2 files changed, 19 insertions(+), 6 deletions(-) > > diff --git a/Documentation/driver-api/fpga/fpga-mgr.rst b/Documentation/driver-api/fpga/fpga-mgr.rst > index 431556d..db8885e 100644 > --- a/Documentation/driver-api/fpga/fpga-mgr.rst > +++ b/Documentation/driver-api/fpga/fpga-mgr.rst > @@ -183,6 +183,11 @@ API for implementing a new FPGA Manager driver > API for programming an FPGA > --------------------------- > > +FPGA Manager flags > + > +.. kernel-doc:: include/linux/fpga/fpga-mgr.h > + :doc: FPGA Manager flags > + > .. kernel-doc:: include/linux/fpga/fpga-mgr.h > :functions: fpga_image_info > > diff --git a/include/linux/fpga/fpga-mgr.h b/include/linux/fpga/fpga-mgr.h > index 1ca02ce..e8ca62b 100644 > --- a/include/linux/fpga/fpga-mgr.h > +++ b/include/linux/fpga/fpga-mgr.h > @@ -53,12 +53,20 @@ enum fpga_mgr_states { > FPGA_MGR_STATE_OPERATING, > }; > > -/* > - * FPGA Manager flags > - * FPGA_MGR_PARTIAL_RECONFIG: do partial reconfiguration if supported > - * FPGA_MGR_EXTERNAL_CONFIG: FPGA has been configured prior to Linux booting > - * FPGA_MGR_BITSTREAM_LSB_FIRST: SPI bitstream bit order is LSB first > - * FPGA_MGR_COMPRESSED_BITSTREAM: FPGA bitstream is compressed > +/** > + * DOC: FPGA Manager flags > + * > + * Flags used in the &fpga_image_info->flags field > + * > + * %FPGA_MGR_PARTIAL_RECONFIG: do partial reconfiguration if supported > + * > + * %FPGA_MGR_EXTERNAL_CONFIG: FPGA has been configured prior to Linux booting > + * > + * %FPGA_MGR_ENCRYPTED_BITSTREAM: indicates bitstream is encrypted > + * > + * %FPGA_MGR_BITSTREAM_LSB_FIRST: SPI bitstream bit order is LSB first > + * > + * %FPGA_MGR_COMPRESSED_BITSTREAM: FPGA bitstream is compressed > */ > #define FPGA_MGR_PARTIAL_RECONFIG BIT(0) > #define FPGA_MGR_EXTERNAL_CONFIG BIT(1) > -- > 2.7.4 > Thanks for doing this, Moritz