* [PATCH] staging: fbtft: add docs for fbtft_write_spi() @ 2021-09-20 15:26 Zachary Mayhew 2021-09-20 15:38 ` Greg KH 0 siblings, 1 reply; 5+ messages in thread From: Zachary Mayhew @ 2021-09-20 15:26 UTC (permalink / raw) To: gregkh Cc: Zachary Mayhew, dri-devel, linux-fbdev, linux-staging, linux-kernel Subject: [PATCH] staging: fbtft: add docs for fbtft_write_spi() This patch adds documentation for fbtft_write_spi() to make its calling context clear and explain what it does. Signed-off-by: Zachary Mayhew <zacklukem.kernel@gmail.com> --- drivers/staging/fbtft/fbtft-io.c | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/drivers/staging/fbtft/fbtft-io.c b/drivers/staging/fbtft/fbtft-io.c index de1904a443c2..985d7cf8c774 100644 --- a/drivers/staging/fbtft/fbtft-io.c +++ b/drivers/staging/fbtft/fbtft-io.c @@ -5,6 +5,19 @@ #include <linux/spi/spi.h> #include "fbtft.h" +/** + * fbtft_write_spi() - write data to current spi + * @par: Driver data including driver &struct spi_device + * @buf: Buffer to write to spi + * @len: Length of the buffer + * Context: can sleep + * + * Builds an &struct spi_transfer and &struct spi_message object based on the + * given @buf and @len. These are then used in a call to spi_sync() which will + * write to the spi. + * + * Return: zero on success or else a negative error code + */ int fbtft_write_spi(struct fbtft_par *par, void *buf, size_t len) { struct spi_transfer t = { -- 2.33.0 ^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH] staging: fbtft: add docs for fbtft_write_spi() 2021-09-20 15:26 [PATCH] staging: fbtft: add docs for fbtft_write_spi() Zachary Mayhew @ 2021-09-20 15:38 ` Greg KH 2021-09-20 16:07 ` Zachary Mayhew 0 siblings, 1 reply; 5+ messages in thread From: Greg KH @ 2021-09-20 15:38 UTC (permalink / raw) To: Zachary Mayhew; +Cc: dri-devel, linux-fbdev, linux-staging, linux-kernel On Mon, Sep 20, 2021 at 08:26:03AM -0700, Zachary Mayhew wrote: > Subject: [PATCH] staging: fbtft: add docs for fbtft_write_spi() Odd, this shouldn't be in the body of the email :( > > This patch adds documentation for fbtft_write_spi() to make its > calling context clear and explain what it does. > > Signed-off-by: Zachary Mayhew <zacklukem.kernel@gmail.com> > --- > drivers/staging/fbtft/fbtft-io.c | 13 +++++++++++++ > 1 file changed, 13 insertions(+) > > diff --git a/drivers/staging/fbtft/fbtft-io.c b/drivers/staging/fbtft/fbtft-io.c > index de1904a443c2..985d7cf8c774 100644 > --- a/drivers/staging/fbtft/fbtft-io.c > +++ b/drivers/staging/fbtft/fbtft-io.c > @@ -5,6 +5,19 @@ > #include <linux/spi/spi.h> > #include "fbtft.h" > > +/** > + * fbtft_write_spi() - write data to current spi > + * @par: Driver data including driver &struct spi_device > + * @buf: Buffer to write to spi > + * @len: Length of the buffer > + * Context: can sleep > + * > + * Builds an &struct spi_transfer and &struct spi_message object based on the > + * given @buf and @len. These are then used in a call to spi_sync() which will > + * write to the spi. > + * > + * Return: zero on success or else a negative error code > + */ > int fbtft_write_spi(struct fbtft_par *par, void *buf, size_t len) > { > struct spi_transfer t = { > -- > 2.33.0 > > Is this file being imported into the kernel doc tools? If so, great, if not, this isn't going to help out all that much, right? thanks, greg k-h ^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] staging: fbtft: add docs for fbtft_write_spi() 2021-09-20 15:38 ` Greg KH @ 2021-09-20 16:07 ` Zachary Mayhew 2021-09-20 16:18 ` Greg KH 0 siblings, 1 reply; 5+ messages in thread From: Zachary Mayhew @ 2021-09-20 16:07 UTC (permalink / raw) To: Greg KH; +Cc: dri-devel, linux-fbdev, linux-staging, linux-kernel On Mon, Sep 20, 2021 at 05:38:30PM +0200, Greg KH wrote: > On Mon, Sep 20, 2021 at 08:26:03AM -0700, Zachary Mayhew wrote: > > Subject: [PATCH] staging: fbtft: add docs for fbtft_write_spi() > > Odd, this shouldn't be in the body of the email :( > > > > > This patch adds documentation for fbtft_write_spi() to make its > > calling context clear and explain what it does. > > > > Signed-off-by: Zachary Mayhew <zacklukem.kernel@gmail.com> > > --- > > drivers/staging/fbtft/fbtft-io.c | 13 +++++++++++++ > > 1 file changed, 13 insertions(+) > > > > diff --git a/drivers/staging/fbtft/fbtft-io.c b/drivers/staging/fbtft/fbtft-io.c > > index de1904a443c2..985d7cf8c774 100644 > > --- a/drivers/staging/fbtft/fbtft-io.c > > +++ b/drivers/staging/fbtft/fbtft-io.c > > @@ -5,6 +5,19 @@ > > #include <linux/spi/spi.h> > > #include "fbtft.h" > > > > +/** > > + * fbtft_write_spi() - write data to current spi > > + * @par: Driver data including driver &struct spi_device > > + * @buf: Buffer to write to spi > > + * @len: Length of the buffer > > + * Context: can sleep > > + * > > + * Builds an &struct spi_transfer and &struct spi_message object based on the > > + * given @buf and @len. These are then used in a call to spi_sync() which will > > + * write to the spi. > > + * > > + * Return: zero on success or else a negative error code > > + */ > > int fbtft_write_spi(struct fbtft_par *par, void *buf, size_t len) > > { > > struct spi_transfer t = { > > -- > > 2.33.0 > > > > > > Is this file being imported into the kernel doc tools? If so, great, if > not, this isn't going to help out all that much, right? It doesn't appear to be imported at this time, as such it may not be necessary. > > thanks, > > greg k-h Thanks, -Zachary Mayhew ^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] staging: fbtft: add docs for fbtft_write_spi() 2021-09-20 16:07 ` Zachary Mayhew @ 2021-09-20 16:18 ` Greg KH 2021-09-20 16:37 ` Zachary Mayhew 0 siblings, 1 reply; 5+ messages in thread From: Greg KH @ 2021-09-20 16:18 UTC (permalink / raw) To: Zachary Mayhew; +Cc: dri-devel, linux-fbdev, linux-staging, linux-kernel On Mon, Sep 20, 2021 at 09:07:13AM -0700, Zachary Mayhew wrote: > On Mon, Sep 20, 2021 at 05:38:30PM +0200, Greg KH wrote: > > On Mon, Sep 20, 2021 at 08:26:03AM -0700, Zachary Mayhew wrote: > > > Subject: [PATCH] staging: fbtft: add docs for fbtft_write_spi() > > > > Odd, this shouldn't be in the body of the email :( > > > > > > > > This patch adds documentation for fbtft_write_spi() to make its > > > calling context clear and explain what it does. > > > > > > Signed-off-by: Zachary Mayhew <zacklukem.kernel@gmail.com> > > > --- > > > drivers/staging/fbtft/fbtft-io.c | 13 +++++++++++++ > > > 1 file changed, 13 insertions(+) > > > > > > diff --git a/drivers/staging/fbtft/fbtft-io.c b/drivers/staging/fbtft/fbtft-io.c > > > index de1904a443c2..985d7cf8c774 100644 > > > --- a/drivers/staging/fbtft/fbtft-io.c > > > +++ b/drivers/staging/fbtft/fbtft-io.c > > > @@ -5,6 +5,19 @@ > > > #include <linux/spi/spi.h> > > > #include "fbtft.h" > > > > > > +/** > > > + * fbtft_write_spi() - write data to current spi > > > + * @par: Driver data including driver &struct spi_device > > > + * @buf: Buffer to write to spi > > > + * @len: Length of the buffer > > > + * Context: can sleep > > > + * > > > + * Builds an &struct spi_transfer and &struct spi_message object based on the > > > + * given @buf and @len. These are then used in a call to spi_sync() which will > > > + * write to the spi. > > > + * > > > + * Return: zero on success or else a negative error code > > > + */ > > > int fbtft_write_spi(struct fbtft_par *par, void *buf, size_t len) > > > { > > > struct spi_transfer t = { > > > -- > > > 2.33.0 > > > > > > > > > > Is this file being imported into the kernel doc tools? If so, great, if > > not, this isn't going to help out all that much, right? > > It doesn't appear to be imported at this time, as such it may not be > necessary. So is this change needed? thanks, greg k-h ^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] staging: fbtft: add docs for fbtft_write_spi() 2021-09-20 16:18 ` Greg KH @ 2021-09-20 16:37 ` Zachary Mayhew 0 siblings, 0 replies; 5+ messages in thread From: Zachary Mayhew @ 2021-09-20 16:37 UTC (permalink / raw) To: Greg KH; +Cc: dri-devel, linux-fbdev, linux-staging, linux-kernel On Mon, Sep 20, 2021 at 06:18:58PM +0200, Greg KH wrote: > On Mon, Sep 20, 2021 at 09:07:13AM -0700, Zachary Mayhew wrote: > > On Mon, Sep 20, 2021 at 05:38:30PM +0200, Greg KH wrote: > > > On Mon, Sep 20, 2021 at 08:26:03AM -0700, Zachary Mayhew wrote: > > > > Subject: [PATCH] staging: fbtft: add docs for fbtft_write_spi() > > > > > > Odd, this shouldn't be in the body of the email :( > > > > > > > > > > > This patch adds documentation for fbtft_write_spi() to make its > > > > calling context clear and explain what it does. > > > > > > > > Signed-off-by: Zachary Mayhew <zacklukem.kernel@gmail.com> > > > > --- > > > > drivers/staging/fbtft/fbtft-io.c | 13 +++++++++++++ > > > > 1 file changed, 13 insertions(+) > > > > > > > > diff --git a/drivers/staging/fbtft/fbtft-io.c b/drivers/staging/fbtft/fbtft-io.c > > > > index de1904a443c2..985d7cf8c774 100644 > > > > --- a/drivers/staging/fbtft/fbtft-io.c > > > > +++ b/drivers/staging/fbtft/fbtft-io.c > > > > @@ -5,6 +5,19 @@ > > > > #include <linux/spi/spi.h> > > > > #include "fbtft.h" > > > > > > > > +/** > > > > + * fbtft_write_spi() - write data to current spi > > > > + * @par: Driver data including driver &struct spi_device > > > > + * @buf: Buffer to write to spi > > > > + * @len: Length of the buffer > > > > + * Context: can sleep > > > > + * > > > > + * Builds an &struct spi_transfer and &struct spi_message object based on the > > > > + * given @buf and @len. These are then used in a call to spi_sync() which will > > > > + * write to the spi. > > > > + * > > > > + * Return: zero on success or else a negative error code > > > > + */ > > > > int fbtft_write_spi(struct fbtft_par *par, void *buf, size_t len) > > > > { > > > > struct spi_transfer t = { > > > > -- > > > > 2.33.0 > > > > > > > > > > > > > > Is this file being imported into the kernel doc tools? If so, great, if > > > not, this isn't going to help out all that much, right? > > > > It doesn't appear to be imported at this time, as such it may not be > > necessary. > > So is this change needed? No it isn't. Sorry for the trouble :) > > thanks, > > greg k-h Thanks -Zachary Mayhew ^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2021-09-20 16:37 UTC | newest] Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed) -- links below jump to the message on this page -- 2021-09-20 15:26 [PATCH] staging: fbtft: add docs for fbtft_write_spi() Zachary Mayhew 2021-09-20 15:38 ` Greg KH 2021-09-20 16:07 ` Zachary Mayhew 2021-09-20 16:18 ` Greg KH 2021-09-20 16:37 ` Zachary Mayhew
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).