Clock

Clock controller class. More...

Modules
	SF32LB RCC clocks
	Clock controller of the SF32LB52 HPSYS RCC.

Data Structures
struct	pbl_clk_controller_ops
	Clock controller driver operations, called with interrupts locked. More...
struct	pbl_clk_controller
	A clock controller. More...
struct	pbl_clk
	A clock, as used by a consumer. More...

Macros
#define	PBL_CLK_CONTROLLER_STATE_DEFINE(sym, _num_clks)
	Define the class state of clock controller sym, for the driver's define macro.
#define	PBL_CLK_CONTROLLER_INIT(sym, _name, _init, _parent, _ops)
	Initializer for the struct pbl_clk_controller of controller sym.
#define	PBL_CLK(_ctrl, _id)   {.ctrl = (_ctrl), .id = (_id)}
	Initializer for a struct pbl_clk.

Functions
int	pbl_clk_enable (const struct pbl_clk *clk)
	Take a reference on a clock, ungating it for the first user.
int	pbl_clk_disable (const struct pbl_clk *clk)
	Drop a reference on a clock, gating it after the last user.
bool	pbl_clk_is_enabled (const struct pbl_clk *clk)
	Check whether a clock has users.

Detailed Description

Clock controller class.

A clock controller is a struct pbl_clk_controller device providing a set of clocks, each identified by a provider-specific number defined in the controller header. A consumer holds a struct pbl_clk naming the controller and clock, lists the controller among its device dependencies, and enables the clock while it uses the peripheral. Enables are counted per clock, so drivers sharing a clock never gate it under each other, and are safe to call from any context:

static const struct pbl_clk s_clk = PBL_CLK(SF32LB_HPSYS_RCC, SF32LB52_HPSYS_CLK_TRNG);
 
pbl_clk_enable(&s_clk);
// use the peripheral
pbl_clk_disable(&s_clk);

---

Data Structure Documentation

pbl_clk_controller

struct pbl_clk_controller

A clock controller.

Data Fields
struct pbl_device	dev	Device.
uint16_t	num_clks	Number of clocks.
const struct pbl_clk_controller_ops *	ops	Driver operations.
uint8_t *	use_counts	Enable count of each clock.

pbl_clk

struct pbl_clk

A clock, as used by a consumer.

Data Fields
const struct pbl_clk_controller *	ctrl	Controller.
uint32_t	id	Clock number on the controller.

Macro Definition Documentation

PBL_CLK

#define PBL_CLK	(		_ctrl,
			_id
	)		{.ctrl = (_ctrl), .id = (_id)}

Initializer for a struct pbl_clk.

Parameters

_ctrl	Clock controller.
_id	Clock number, from the controller's binding header.

PBL_CLK_CONTROLLER_INIT

#define PBL_CLK_CONTROLLER_INIT	(		sym,
			_name,
			_init,
			_parent,
			_ops
	)

Value:

  {                                                               \
    .dev = PBL_DEVICE_INIT(sym, _name, _init, _parent, nullptr),  \
    .ops = (_ops),                                                \
    .use_counts = sym##_clk_use_counts,                           \
    .num_clks = sizeof(sym##_clk_use_counts),                     \
  }

Initializer for the struct pbl_clk_controller of controller sym.

Parameters

sym	Symbol of the controller instance, with its state defined by PBL_CLK_CONTROLLER_STATE_DEFINE().
_name	Name.
_init	Device init function, or NULL.
_parent	Parent device, or NULL.
_ops	Driver operations.

PBL_CLK_CONTROLLER_STATE_DEFINE

#define PBL_CLK_CONTROLLER_STATE_DEFINE	(		sym,
			_num_clks
	)

Value:

  PBL_DEVICE_STATE_DEFINE(sym);                         \
  static uint8_t sym##_clk_use_counts[_num_clks]

Define the class state of clock controller sym, for the driver's define macro.

Parameters

sym	Symbol of the controller instance.
_num_clks	Number of clocks.

Function Documentation

pbl_clk_disable()

int pbl_clk_disable

(

const struct pbl_clk *

clk

)

Drop a reference on a clock, gating it after the last user.

Must balance a successful pbl_clk_enable().

Parameters

clk

Clock.

Returns

0 or a negative errno.

pbl_clk_enable()

int pbl_clk_enable

(

const struct pbl_clk *

clk

)

Take a reference on a clock, ungating it for the first user.

Parameters

clk

Clock.

Returns

0 or a negative errno.

pbl_clk_is_enabled()

bool pbl_clk_is_enabled

(

const struct pbl_clk *

clk

)

Check whether a clock has users.

Parameters

clk

Clock.

Returns

True if the clock is enabled.