| Message ID | 20200523100108.7494-1-xypron.glpk@gmx.de |
|---|---|
| State | Accepted |
| Commit | f39c8454b500a42a1baa65a2bdefbaa21f413003 |
| Headers | show |
| Series | [1/1] doc: dfu: add DFU to HTML documentation | expand |
On Sat, 23 May 2020 12:01:08 +0200 Heinrich Schuchardt <xypron.glpk at gmx.de> wrote: > Add the device firmware update functions to the generated HTML > documentation. > > Signed-off-by: Heinrich Schuchardt <xypron.glpk at gmx.de> > --- > doc/api/dfu.rst | 7 +++++++ > doc/api/index.rst | 1 + > include/dfu.h | 40 ++++++++++++++++++++-------------------- > 3 files changed, 28 insertions(+), 20 deletions(-) > create mode 100644 doc/api/dfu.rst > > diff --git a/doc/api/dfu.rst b/doc/api/dfu.rst > new file mode 100644 > index 0000000000..5bd9e292a5 > --- /dev/null > +++ b/doc/api/dfu.rst > @@ -0,0 +1,7 @@ > +.. SPDX-License-Identifier: GPL-2.0+ > + > +Device firmware update > +====================== > + > +.. kernel-doc:: include/dfu.h > + :internal: > diff --git a/doc/api/index.rst b/doc/api/index.rst > index 2578abd40e..fd3b5bdc82 100644 > --- a/doc/api/index.rst > +++ b/doc/api/index.rst > @@ -6,6 +6,7 @@ U-Boot API documentation > .. toctree:: > :maxdepth: 2 > > + dfu > efi > linker_lists > serial > diff --git a/include/dfu.h b/include/dfu.h > index 2f0e335ec0..00e1543944 100644 > --- a/include/dfu.h > +++ b/include/dfu.h > @@ -188,23 +188,23 @@ int dfu_write(struct dfu_entity *de, void *buf, > int size, int blk_seq_num); int dfu_flush(struct dfu_entity *de, void > *buf, int size, int blk_seq_num); > > /** > - * dfu_initiated_callback - weak callback called on DFU transaction > start > + * dfu_initiated_callback() - weak callback called on DFU > transaction start * > * It is a callback function called by DFU stack when a DFU > transaction is > * initiated. This function allows to manage some board specific > behavior on > * DFU targets. > * > - * @param dfu - pointer to the dfu_entity, which should be > initialized > + * @dfu: pointer to the dfu_entity, which should be > initialized * > */ > void dfu_initiated_callback(struct dfu_entity *dfu); > /** > - * dfu_flush_callback - weak callback called at the end of the DFU > write > + * dfu_flush_callback() - weak callback called at the end of the DFU > write * > * It is a callback function called by DFU stack after DFU > manifestation. > * This function allows to manage some board specific behavior on > DFU targets * > - * @param dfu - pointer to the dfu_entity, which should be flushed > + * @dfu: pointer to the dfu_entity, which should be flushed > * > */ > void dfu_flush_callback(struct dfu_entity *dfu); > @@ -218,9 +218,9 @@ void dfu_transaction_cleanup(struct dfu_entity > *dfu); */ > extern struct dfu_entity *dfu_defer_flush; > /** > - * dfu_get_defer_flush - get current value of dfu_defer_flush pointer > + * dfu_get_defer_flush() - get current value of dfu_defer_flush > pointer * > - * @return - value of the dfu_defer_flush pointer > + * Return: value of the dfu_defer_flush pointer > */ > static inline struct dfu_entity *dfu_get_defer_flush(void) > { > @@ -228,9 +228,9 @@ static inline struct dfu_entity > *dfu_get_defer_flush(void) } > > /** > - * dfu_set_defer_flush - set the dfu_defer_flush pointer > + * dfu_set_defer_flush() - set the dfu_defer_flush pointer > * > - * @param dfu - pointer to the dfu_entity, which should be written > + * @dfu: pointer to the dfu_entity, which should be written > */ > static inline void dfu_set_defer_flush(struct dfu_entity *dfu) > { > @@ -238,16 +238,16 @@ static inline void dfu_set_defer_flush(struct > dfu_entity *dfu) } > > /** > - * dfu_write_from_mem_addr - write data from memory to DFU managed > medium > + * dfu_write_from_mem_addr() - write data from memory to DFU managed > medium * > * This function adds support for writing data starting from fixed > memory > * address (like $loadaddr) to dfu managed medium (e.g. NAND, MMC, > file system) * > - * @param dfu - dfu entity to which we want to store data > - * @param buf - fixed memory addres from where data starts > - * @param size - number of bytes to write > + * @dfu: dfu entity to which we want to store data > + * @buf: fixed memory addres from where data starts > + * @size: number of bytes to write > * > - * @return - 0 on success, other value on failure > + * Return: 0 on success, other value on failure > */ > int dfu_write_from_mem_addr(struct dfu_entity *dfu, void *buf, int > size); > > @@ -324,17 +324,17 @@ static inline int dfu_fill_entity_virt(struct > dfu_entity *dfu, char *devstr, #endif > > /** > - * dfu_tftp_write - Write TFTP data to DFU medium > + * dfu_tftp_write() - write TFTP data to DFU medium > * > * This function is storing data received via TFTP on DFU supported > medium. * > - * @param dfu_entity_name - name of DFU entity to write > - * @param addr - address of data buffer to write > - * @param len - number of bytes > - * @param interface - destination DFU medium (e.g. "mmc") > - * @param devstring - instance number of destination DFU medium > (e.g. "1") > + * @dfu_entity_name: name of DFU entity to write > + * @addr: address of data buffer to write > + * @len: number of bytes > + * @interface: destination DFU medium (e.g. "mmc") > + * @devstring: instance number of destination DFU > medium (e.g. "1") * > - * @return 0 on success, otherwise error code > + * Return: 0 on success, otherwise error code > */ > #if CONFIG_IS_ENABLED(DFU_TFTP) > int dfu_tftp_write(char *dfu_entity_name, unsigned int addr, > unsigned int len, -- > 2.26.2 > Acked-by: Lukasz Majewski <lukma at denx.de> Best regards, Lukasz Majewski -- DENX Software Engineering GmbH, Managing Director: Wolfgang Denk HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany Phone: (+49)-8142-66989-59 Fax: (+49)-8142-66989-80 Email: lukma at denx.de -------------- next part -------------- A non-text attachment was scrubbed... Name: not available Type: application/pgp-signature Size: 488 bytes Desc: OpenPGP digital signature URL: <https://lists.denx.de/pipermail/u-boot/attachments/20200524/d100e60b/attachment.sig>
On Sat, May 23, 2020 at 12:01:08PM +0200, Heinrich Schuchardt wrote: > Add the device firmware update functions to the generated HTML > documentation. > > Signed-off-by: Heinrich Schuchardt <xypron.glpk at gmx.de> > Acked-by: Lukasz Majewski <lukma at denx.de> Applied to u-boot/master, thanks!
diff --git a/doc/api/dfu.rst b/doc/api/dfu.rst new file mode 100644 index 0000000000..5bd9e292a5 --- /dev/null +++ b/doc/api/dfu.rst @@ -0,0 +1,7 @@ +.. SPDX-License-Identifier: GPL-2.0+ + +Device firmware update +====================== + +.. kernel-doc:: include/dfu.h + :internal: diff --git a/doc/api/index.rst b/doc/api/index.rst index 2578abd40e..fd3b5bdc82 100644 --- a/doc/api/index.rst +++ b/doc/api/index.rst @@ -6,6 +6,7 @@ U-Boot API documentation .. toctree:: :maxdepth: 2 + dfu efi linker_lists serial diff --git a/include/dfu.h b/include/dfu.h index 2f0e335ec0..00e1543944 100644 --- a/include/dfu.h +++ b/include/dfu.h @@ -188,23 +188,23 @@ int dfu_write(struct dfu_entity *de, void *buf, int size, int blk_seq_num); int dfu_flush(struct dfu_entity *de, void *buf, int size, int blk_seq_num); /** - * dfu_initiated_callback - weak callback called on DFU transaction start + * dfu_initiated_callback() - weak callback called on DFU transaction start * * It is a callback function called by DFU stack when a DFU transaction is * initiated. This function allows to manage some board specific behavior on * DFU targets. * - * @param dfu - pointer to the dfu_entity, which should be initialized + * @dfu: pointer to the dfu_entity, which should be initialized * */ void dfu_initiated_callback(struct dfu_entity *dfu); /** - * dfu_flush_callback - weak callback called at the end of the DFU write + * dfu_flush_callback() - weak callback called at the end of the DFU write * * It is a callback function called by DFU stack after DFU manifestation. * This function allows to manage some board specific behavior on DFU targets * - * @param dfu - pointer to the dfu_entity, which should be flushed + * @dfu: pointer to the dfu_entity, which should be flushed * */ void dfu_flush_callback(struct dfu_entity *dfu); @@ -218,9 +218,9 @@ void dfu_transaction_cleanup(struct dfu_entity *dfu); */ extern struct dfu_entity *dfu_defer_flush; /** - * dfu_get_defer_flush - get current value of dfu_defer_flush pointer + * dfu_get_defer_flush() - get current value of dfu_defer_flush pointer * - * @return - value of the dfu_defer_flush pointer + * Return: value of the dfu_defer_flush pointer */ static inline struct dfu_entity *dfu_get_defer_flush(void) { @@ -228,9 +228,9 @@ static inline struct dfu_entity *dfu_get_defer_flush(void) } /** - * dfu_set_defer_flush - set the dfu_defer_flush pointer + * dfu_set_defer_flush() - set the dfu_defer_flush pointer * - * @param dfu - pointer to the dfu_entity, which should be written + * @dfu: pointer to the dfu_entity, which should be written */ static inline void dfu_set_defer_flush(struct dfu_entity *dfu) { @@ -238,16 +238,16 @@ static inline void dfu_set_defer_flush(struct dfu_entity *dfu) } /** - * dfu_write_from_mem_addr - write data from memory to DFU managed medium + * dfu_write_from_mem_addr() - write data from memory to DFU managed medium * * This function adds support for writing data starting from fixed memory * address (like $loadaddr) to dfu managed medium (e.g. NAND, MMC, file system) * - * @param dfu - dfu entity to which we want to store data - * @param buf - fixed memory addres from where data starts - * @param size - number of bytes to write + * @dfu: dfu entity to which we want to store data + * @buf: fixed memory addres from where data starts + * @size: number of bytes to write * - * @return - 0 on success, other value on failure + * Return: 0 on success, other value on failure */ int dfu_write_from_mem_addr(struct dfu_entity *dfu, void *buf, int size); @@ -324,17 +324,17 @@ static inline int dfu_fill_entity_virt(struct dfu_entity *dfu, char *devstr, #endif /** - * dfu_tftp_write - Write TFTP data to DFU medium + * dfu_tftp_write() - write TFTP data to DFU medium * * This function is storing data received via TFTP on DFU supported medium. * - * @param dfu_entity_name - name of DFU entity to write - * @param addr - address of data buffer to write - * @param len - number of bytes - * @param interface - destination DFU medium (e.g. "mmc") - * @param devstring - instance number of destination DFU medium (e.g. "1") + * @dfu_entity_name: name of DFU entity to write + * @addr: address of data buffer to write + * @len: number of bytes + * @interface: destination DFU medium (e.g. "mmc") + * @devstring: instance number of destination DFU medium (e.g. "1") * - * @return 0 on success, otherwise error code + * Return: 0 on success, otherwise error code */ #if CONFIG_IS_ENABLED(DFU_TFTP) int dfu_tftp_write(char *dfu_entity_name, unsigned int addr, unsigned int len,
Add the device firmware update functions to the generated HTML documentation. Signed-off-by: Heinrich Schuchardt <xypron.glpk at gmx.de> --- doc/api/dfu.rst | 7 +++++++ doc/api/index.rst | 1 + include/dfu.h | 40 ++++++++++++++++++++-------------------- 3 files changed, 28 insertions(+), 20 deletions(-) create mode 100644 doc/api/dfu.rst -- 2.26.2