From: Moritz Fischer <mdf@kernel.org>
To: Alan Tull <atull@kernel.org>
Cc: Moritz Fischer <mdf@kernel.org>, Jonathan Corbet <corbet@lwn.net>,
Randy Dunlap <rdunlap@infradead.org>,
linux-kernel@vger.kernel.org, linux-fpga@vger.kernel.org,
linux-doc@vger.kernel.org
Subject: Re: [PATCH 7/8] docs: fpga: document fpga manager flags
Date: Thu, 16 Aug 2018 12:02:52 -0700 [thread overview]
Message-ID: <20180816190252.GB3932@archbook> (raw)
In-Reply-To: <20180814191526.3247-8-atull@kernel.org>
Hi Alan,
On Tue, Aug 14, 2018 at 02:15:25PM -0500, Alan Tull wrote:
> Add flags #defines to kerneldoc documentation in a
> useful place.
>
> Signed-off-by: Alan Tull <atull@kernel.org>
> ---
> Documentation/driver-api/fpga/fpga-mgr.rst | 5 +++++
> include/linux/fpga/fpga-mgr.h | 18 ++++++++++++------
> 2 files changed, 17 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..777c502 100644
> --- a/include/linux/fpga/fpga-mgr.h
> +++ b/include/linux/fpga/fpga-mgr.h
> @@ -53,12 +53,18 @@ 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
We are actually missing the ENCRYPTED flag here, can you add that while
we're at it? I must've forgotten to add that back then ... derp.
> - * 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_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,
Moritz
next prev parent reply other threads:[~2018-08-16 19:02 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-08-14 19:15 [PATCH 0/8] fpga: Add managed create in FPGA API Alan Tull
2018-08-14 19:15 ` [PATCH 1/8] fpga: do not access region struct after fpga_region_unregister Alan Tull
2018-08-14 19:15 ` [PATCH 2/8] fpga: mgr: add devm_fpga_mgr_create Alan Tull
2018-08-14 19:15 ` [PATCH 3/8] fpga: bridge: add devm_fpga_bridge_create Alan Tull
2018-08-14 19:15 ` [PATCH 4/8] fpga: add devm_fpga_region_create Alan Tull
2018-08-14 19:15 ` [PATCH 5/8] dt-bindings: fpga: fix freeze controller compatible in region doc Alan Tull
2018-08-14 19:15 ` [PATCH 6/8] fpga: bridge: fix obvious function documentation error Alan Tull
2018-08-14 19:15 ` [PATCH 7/8] docs: fpga: document fpga manager flags Alan Tull
2018-08-16 19:02 ` Moritz Fischer [this message]
2018-08-16 20:20 ` Alan Tull
2018-08-16 22:01 ` Moritz Fischer
2018-08-14 19:15 ` [PATCH 8/8] docs: fpga: document programming fpgas using regions Alan Tull
2018-08-15 2:40 ` Randy Dunlap
2018-08-15 16:31 ` Alan Tull
2018-08-14 21:44 ` [PATCH 0/8] fpga: Add managed create in FPGA API Federico Vaga
2018-08-14 23:45 ` Alan Tull
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20180816190252.GB3932@archbook \
--to=mdf@kernel.org \
--cc=atull@kernel.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-fpga@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=rdunlap@infradead.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).