Clock Control (SF32LB specifics)

Clock Control (SF32LB specifics) More...

Data Structures
struct	sf32lb_clock_dt_spec
	SF32LB Clock DT spec. More...

Macros
#define	SF32LB_CLOCK_DT_SPEC_GET(node_id)
	Initialize a sf32lb_clock_dt_spec structure from a DT node.
#define	SF32LB_CLOCK_DT_SPEC_GET_OR(node_id, default_spec)
	Same as SF32LB_CLOCK_DT_SPEC_GET but with a default value.
#define	SF32LB_CLOCK_DT_INST_SPEC_GET(index)   SF32LB_CLOCK_DT_SPEC_GET(DT_DRV_INST(index))
	Initialize a sf32lb_clock_dt_spec structure from a DT instance.
#define	SF32LB_CLOCK_DT_INST_SPEC_GET_OR(index, default_spec)    SF32LB_CLOCK_DT_SPEC_GET_OR(DT_DRV_INST(index), default_spec)
	Same as SF32LB_CLOCK_DT_INST_SPEC_GET but with a default value.

Functions
static bool	sf32lb_clock_is_ready_dt (const struct sf32lb_clock_dt_spec *spec)
	Check if the clock device is ready.
static int	sf32lb_clock_control_on_dt (const struct sf32lb_clock_dt_spec *spec)
	Turn on a clock using a sf32lb_clock_dt_spec structure.
static int	sf32lb_clock_control_off_dt (const struct sf32lb_clock_dt_spec *spec)
	Turn off a clock using a sf32lb_clock_dt_spec structure.

Detailed Description

Clock Control (SF32LB specifics)

Macro Definition Documentation

SF32LB_CLOCK_DT_INST_SPEC_GET

#define SF32LB_CLOCK_DT_INST_SPEC_GET

(

index

)

SF32LB_CLOCK_DT_SPEC_GET(DT_DRV_INST(index))

#include <include/zephyr/drivers/clock_control/sf32lb.h>

Initialize a sf32lb_clock_dt_spec structure from a DT instance.

Parameters

index

DT instance index

SF32LB_CLOCK_DT_INST_SPEC_GET_OR

#define SF32LB_CLOCK_DT_INST_SPEC_GET_OR	(		index,
			default_spec
	)		SF32LB_CLOCK_DT_SPEC_GET_OR(DT_DRV_INST(index), default_spec)

#include <include/zephyr/drivers/clock_control/sf32lb.h>

Same as SF32LB_CLOCK_DT_INST_SPEC_GET but with a default value.

Parameters

index	DT instance index
default_spec	Default value to be used if the node has no clocks property.

SF32LB_CLOCK_DT_SPEC_GET

#define SF32LB_CLOCK_DT_SPEC_GET

(

node_id

)

#include <include/zephyr/drivers/clock_control/sf32lb.h>

Value:

        {                                                                                          \
                .dev = DEVICE_DT_GET(DT_CLOCKS_CTLR(node_id)),                                     \
                .id = DT_CLOCKS_CELL(node_id, id),                                                 \
        }

Initialize a sf32lb_clock_dt_spec structure from a DT node.

Parameters

node_id

DT node identifier

SF32LB_CLOCK_DT_SPEC_GET_OR

#define SF32LB_CLOCK_DT_SPEC_GET_OR	(		node_id,
			default_spec
	)

#include <include/zephyr/drivers/clock_control/sf32lb.h>

Value:

        COND_CODE_1(DT_CLOCKS_HAS_IDX(node_id, 0),                                                 \
                    (SF32LB_CLOCK_DT_SPEC_GET(node_id)), (default_spec))

Same as SF32LB_CLOCK_DT_SPEC_GET but with a default value.

Parameters

node_id	DT node identifier
default_spec	Default value to be used if the node has no clocks property.

Function Documentation

sf32lb_clock_control_off_dt()

static int sf32lb_clock_control_off_dt ( const struct sf32lb_clock_dt_spec *  spec )

inlinestatic

#include <include/zephyr/drivers/clock_control/sf32lb.h>

Turn off a clock using a sf32lb_clock_dt_spec structure.

Parameters

spec	SF32LB clock DT spec

Returns

See clock_control_off().

sf32lb_clock_control_on_dt()

static int sf32lb_clock_control_on_dt ( const struct sf32lb_clock_dt_spec *  spec )

inlinestatic

#include <include/zephyr/drivers/clock_control/sf32lb.h>

Turn on a clock using a sf32lb_clock_dt_spec structure.

Parameters

spec	SF32LB clock DT spec

Returns

See clock_control_on().

sf32lb_clock_is_ready_dt()

static bool sf32lb_clock_is_ready_dt ( const struct sf32lb_clock_dt_spec *  spec )

inlinestatic

#include <include/zephyr/drivers/clock_control/sf32lb.h>

Check if the clock device is ready.

Parameters

spec	SF32LB clock DT spec

Returns

true If the clock device is ready.

false If the clock device is not ready.