From: Maxime Ripard <maxime.ripard@free-electrons.com>
To: Mike Turquette <mturquette@baylibre.com>,
Stephen Boyd <sboyd@codeaurora.org>, Chen-Yu Tsai <wens@csie.org>
Cc: Hans de Goede <hdegoede@redhat.com>,
Mylene Josserand <mylene.josserand@free-electrons.com>,
linux-clk@vger.kernel.org, devicetree@vger.kernel.org,
linux-arm-kernel@lists.infradead.org,
linux-kernel@vger.kernel.org,
Thomas Petazzoni <thomas.petazzoni@free-electrons.com>,
Maxime Ripard <maxime.ripard@free-electrons.com>
Subject: [PATCH v3 2/8] clk: sunxi-ng: div: Add kerneldoc for the _ccu_div structure
Date: Thu, 8 Sep 2016 11:48:37 +0200 [thread overview]
Message-ID: <20160908094843.14710-3-maxime.ripard@free-electrons.com> (raw)
In-Reply-To: <20160908094843.14710-1-maxime.ripard@free-electrons.com>
The internal _ccu_div structure is meant to be embedded into other
structures to combine the various dividers and to form the clock classes
support.
Start to document those structures by using kerneldoc.
Signed-off-by: Maxime Ripard <maxime.ripard@free-electrons.com>
---
drivers/clk/sunxi-ng/ccu_div.h | 14 ++++++++++++++
1 file changed, 14 insertions(+)
diff --git a/drivers/clk/sunxi-ng/ccu_div.h b/drivers/clk/sunxi-ng/ccu_div.h
index a5c9eaf90e84..e1b1326e68a1 100644
--- a/drivers/clk/sunxi-ng/ccu_div.h
+++ b/drivers/clk/sunxi-ng/ccu_div.h
@@ -19,6 +19,20 @@
#include "ccu_common.h"
#include "ccu_mux.h"
+/**
+ * struct _ccu_div - Internal divider description
+ * @shift: Bit offset of the divider in its register
+ * @width: Width of the divider field in its register
+ * @flags: clk_divider flags to apply on this divider
+ * @table: Divider table pointer (if applicable)
+ *
+ * That structure represents a single divider, and is meant to be
+ * embedded in other structures representing the various clock
+ * classes.
+ *
+ * It is basically a wrapper around the clk_divider functions
+ * arguments.
+ */
struct _ccu_div {
u8 shift;
u8 width;
--
2.9.3
next prev parent reply other threads:[~2016-09-08 9:55 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-09-08 9:48 [PATCH v3 0/8] clk: sunxi-ng: Introduce support for A23 and A33 CCUs Maxime Ripard
2016-09-08 9:48 ` [PATCH v3 1/8] clk: sunxi-ng: div: Add mux table macros Maxime Ripard
2016-09-08 9:48 ` Maxime Ripard [this message]
2016-09-08 9:48 ` [PATCH v3 3/8] clk: sunxi-ng: div: Allow to set a maximum Maxime Ripard
2016-09-08 10:26 ` Chen-Yu Tsai
2016-09-08 9:48 ` [PATCH v3 4/8] clk: sunxi-ng: mux: Add mux table macro Maxime Ripard
2016-09-08 9:48 ` [PATCH v3 5/8] clk: sunxi-ng: Add N-class clocks support Maxime Ripard
2016-09-08 9:48 ` [PATCH v3 6/8] clk: sunxi-ng: Add A33 CCU support Maxime Ripard
2016-09-08 9:48 ` [PATCH v3 7/8] clk: sunxi-ng: Add A23 CCU Maxime Ripard
2016-09-08 13:35 ` Chen-Yu Tsai
2016-09-08 9:48 ` [PATCH v3 8/8] ARM: sun8i: Convert the A23 and A33 to the CCU Maxime Ripard
2016-09-08 20:09 ` [PATCH v3 0/8] clk: sunxi-ng: Introduce support for A23 and A33 CCUs Maxime Ripard
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=20160908094843.14710-3-maxime.ripard@free-electrons.com \
--to=maxime.ripard@free-electrons.com \
--cc=devicetree@vger.kernel.org \
--cc=hdegoede@redhat.com \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-clk@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mturquette@baylibre.com \
--cc=mylene.josserand@free-electrons.com \
--cc=sboyd@codeaurora.org \
--cc=thomas.petazzoni@free-electrons.com \
--cc=wens@csie.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
all inboxes | Powered by JetHome®