From: Zachary Mayhew <zacklukem.kernel@gmail.com>
To: gregkh@linuxfoundation.org
Cc: Zachary Mayhew <zacklukem.kernel@gmail.com>,
dri-devel@lists.freedesktop.org, linux-fbdev@lists.kernel.org,
linux-staging@lists.linux.dev, linux-kernel@vger.kernel.org
Subject: [PATCH] staging: fbtft: add docs for fbtft_write_spi()
Date: Mon, 20 Sep 2021 08:26:03 -0700 [thread overview]
Message-ID: <20210920152601.170453-1-zacklukem.kernel@gmail.com> (raw)
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
next reply other threads:[~2021-09-20 15:30 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-09-20 15:26 Zachary Mayhew [this message]
2021-09-20 15:38 ` [PATCH] staging: fbtft: add docs for fbtft_write_spi() Greg KH
2021-09-20 16:07 ` Zachary Mayhew
2021-09-20 16:18 ` Greg KH
2021-09-20 16:37 ` Zachary Mayhew
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=20210920152601.170453-1-zacklukem.kernel@gmail.com \
--to=zacklukem.kernel@gmail.com \
--cc=dri-devel@lists.freedesktop.org \
--cc=gregkh@linuxfoundation.org \
--cc=linux-fbdev@lists.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-staging@lists.linux.dev \
/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).