| Message ID | 20180904212237.3078-8-atull@kernel.org (mailing list archive) |
|---|---|
| State | Superseded, archived |
| Headers | show |
| Series | fpga: add devm managed create APIs | expand |
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 <atull@kernel.org> Acked-by: Moritz Fischer <mdf@kernel.org> > --- > 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
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)
Add flags #defines to kerneldoc documentation in a useful place. Signed-off-by: Alan Tull <atull@kernel.org> --- 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(-)