blob: a22f1a5d8489c9ad817ace812c52b2c69482d68a [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Stephen Warren135aa952016-06-17 09:44:00 -06002/*
3 * Copyright (c) 2015 Google, Inc
4 * Written by Simon Glass <sjg@chromium.org>
5 * Copyright (c) 2016, NVIDIA CORPORATION.
Stephen Warren135aa952016-06-17 09:44:00 -06006 */
7
8#ifndef _CLK_UCLASS_H
9#define _CLK_UCLASS_H
10
11/* See clk.h for background documentation. */
12
13#include <clk.h>
Simon Glassa4e0ef52017-05-18 20:09:40 -060014
15struct ofnode_phandle_args;
Stephen Warren135aa952016-06-17 09:44:00 -060016
17/**
18 * struct clk_ops - The functions that a clock driver must implement.
Sean Andersona0abea82021-12-22 12:11:13 -050019 * @of_xlate: Translate a client's device-tree (OF) clock specifier.
20 * @request: Request a translated clock.
21 * @rfree: Free a previously requested clock.
22 * @round_rate: Adjust a rate to the exact rate a clock can provide.
23 * @get_rate: Get current clock rate.
24 * @set_rate: Set current clock rate.
25 * @set_parent: Set current clock parent
26 * @enable: Enable a clock.
27 * @disable: Disable a clock.
28 *
29 * The individual methods are described more fully below.
Stephen Warren135aa952016-06-17 09:44:00 -060030 */
31struct clk_ops {
Stephen Warren135aa952016-06-17 09:44:00 -060032 int (*of_xlate)(struct clk *clock,
Simon Glassa4e0ef52017-05-18 20:09:40 -060033 struct ofnode_phandle_args *args);
Stephen Warren135aa952016-06-17 09:44:00 -060034 int (*request)(struct clk *clock);
Sean Anderson276d4462022-01-15 17:24:58 -050035 void (*rfree)(struct clk *clock);
Dario Binacchi2983ad52020-12-30 00:06:31 +010036 ulong (*round_rate)(struct clk *clk, ulong rate);
Stephen Warren135aa952016-06-17 09:44:00 -060037 ulong (*get_rate)(struct clk *clk);
Stephen Warren135aa952016-06-17 09:44:00 -060038 ulong (*set_rate)(struct clk *clk, ulong rate);
Philipp Tomsichf7d10462018-01-08 11:15:08 +010039 int (*set_parent)(struct clk *clk, struct clk *parent);
Stephen Warren135aa952016-06-17 09:44:00 -060040 int (*enable)(struct clk *clk);
Stephen Warren135aa952016-06-17 09:44:00 -060041 int (*disable)(struct clk *clk);
42};
43
Sean Andersona0abea82021-12-22 12:11:13 -050044#if 0 /* For documentation only */
45/**
46 * of_xlate() - Translate a client's device-tree (OF) clock specifier.
47 * @clock: The clock struct to hold the translation result.
48 * @args: The clock specifier values from device tree.
49 *
50 * The clock core calls this function as the first step in implementing
51 * a client's clk_get_by_*() call.
52 *
53 * If this function pointer is set to NULL, the clock core will use a
54 * default implementation, which assumes #clock-cells = <1>, and that
55 * the DT cell contains a simple integer clock ID.
56 *
57 * At present, the clock API solely supports device-tree. If this
58 * changes, other xxx_xlate() functions may be added to support those
59 * other mechanisms.
60 *
61 * Return: 0 if OK, or a negative error code.
62 */
63int of_xlate(struct clk *clock, struct ofnode_phandle_args *args);
64
65/**
66 * request() - Request a translated clock.
Paul Barker52029b72023-08-14 20:13:34 +010067 * @clock: The clock struct to request; this has been filled in by
Sean Andersona0abea82021-12-22 12:11:13 -050068 * a previoux xxx_xlate() function call, or by the caller
69 * of clk_request().
70 *
71 * The clock core calls this function as the second step in
72 * implementing a client's clk_get_by_*() call, following a successful
73 * xxx_xlate() call, or as the only step in implementing a client's
74 * clk_request() call.
75 *
76 * Return: 0 if OK, or a negative error code.
77 */
78int request(struct clk *clock);
79
80/**
81 * rfree() - Free a previously requested clock.
82 * @clock: The clock to free.
83 *
Sean Anderson276d4462022-01-15 17:24:58 -050084 * Free any resources allocated in request().
Sean Andersona0abea82021-12-22 12:11:13 -050085 */
Sean Anderson276d4462022-01-15 17:24:58 -050086void rfree(struct clk *clock);
Sean Andersona0abea82021-12-22 12:11:13 -050087
88/**
89 * round_rate() - Adjust a rate to the exact rate a clock can provide.
90 * @clk: The clock to manipulate.
91 * @rate: Desidered clock rate in Hz.
92 *
93 * Return: rounded rate in Hz, or -ve error code.
94 */
95ulong round_rate(struct clk *clk, ulong rate);
96
97/**
98 * get_rate() - Get current clock rate.
99 * @clk: The clock to query.
100 *
101 * Return: clock rate in Hz, or -ve error code
102 */
103ulong get_rate(struct clk *clk);
104
105/**
106 * set_rate() - Set current clock rate.
107 * @clk: The clock to manipulate.
108 * @rate: New clock rate in Hz.
109 *
110 * Return: new rate, or -ve error code.
111 */
112ulong set_rate(struct clk *clk, ulong rate);
113
114/**
115 * set_parent() - Set current clock parent
116 * @clk: The clock to manipulate.
117 * @parent: New clock parent.
118 *
119 * Return: zero on success, or -ve error code.
120 */
121int set_parent(struct clk *clk, struct clk *parent);
122
123/**
124 * enable() - Enable a clock.
125 * @clk: The clock to manipulate.
126 *
127 * Return: zero on success, or -ve error code.
128 */
129int enable(struct clk *clk);
130
131/**
132 * disable() - Disable a clock.
133 * @clk: The clock to manipulate.
134 *
135 * Return: zero on success, or -ve error code.
136 */
137int disable(struct clk *clk);
138#endif
139
Stephen Warren135aa952016-06-17 09:44:00 -0600140#endif