Commit e9c959a6 authored by Maxime Ripard's avatar Maxime Ripard

clk: sunxi-ng: div: Add kerneldoc for the _ccu_div structure

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: default avatarMaxime Ripard <maxime.ripard@free-electrons.com>
parent 6f91c601
...@@ -19,6 +19,20 @@ ...@@ -19,6 +19,20 @@
#include "ccu_common.h" #include "ccu_common.h"
#include "ccu_mux.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 { struct _ccu_div {
u8 shift; u8 shift;
u8 width; u8 width;
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment