The following changes are made to the clock API: * The concept of "clocks" and "peripheral clocks" are unified; each clock provider now implements a single set of clocks. This provides a simpler conceptual interface to clients, and better aligns with device tree clock bindings. * Clocks are now identified with a single "struct clk", rather than requiring clients to store the clock provider device and clock identity values separately. For simple clock consumers, this isolates clients from internal details of the clock API. * clk.h is split so it only contains the client/consumer API, whereas clk-uclass.h contains the provider API. This aligns with the recently added reset and mailbox APIs. * clk_ops .of_xlate(), .request(), and .free() are added so providers can customize these operations if needed. This also aligns with the recently added reset and mailbox APIs. * clk_disable() is added. * All users of the current clock APIs are updated. * Sandbox clock tests are updated to exercise clock lookup via DT, and clock enable/disable. * rkclk_get_clk() is removed and replaced with standard APIs. Buildman shows no clock-related errors for any board for which buildman can download a toolchain. test/py passes for sandbox (which invokes the dm clk test amongst others). Signed-off-by: Stephen Warren <swarren@nvidia.com> Acked-by: Simon Glass <sjg@chromium.org>master
parent
4581b717b1
commit
135aa95002
@ -0,0 +1,111 @@ |
|||||||
|
/*
|
||||||
|
* Copyright (c) 2016, NVIDIA CORPORATION. |
||||||
|
* |
||||||
|
* SPDX-License-Identifier: GPL-2.0 |
||||||
|
*/ |
||||||
|
|
||||||
|
#ifndef __SANDBOX_CLK_H |
||||||
|
#define __SANDBOX_CLK_H |
||||||
|
|
||||||
|
#include <common.h> |
||||||
|
|
||||||
|
struct udevice; |
||||||
|
|
||||||
|
/**
|
||||||
|
* enum sandbox_clk_id - Identity of clocks implemented by the sandbox clock |
||||||
|
* provider. |
||||||
|
* |
||||||
|
* These IDs are within/relative-to the clock provider. |
||||||
|
*/ |
||||||
|
enum sandbox_clk_id { |
||||||
|
SANDBOX_CLK_ID_SPI, |
||||||
|
SANDBOX_CLK_ID_I2C, |
||||||
|
|
||||||
|
SANDBOX_CLK_ID_COUNT, |
||||||
|
}; |
||||||
|
|
||||||
|
/**
|
||||||
|
* enum sandbox_clk_test_id - Identity of the clocks consumed by the sandbox |
||||||
|
* clock test device. |
||||||
|
* |
||||||
|
* These are the IDs the clock consumer knows the clocks as. |
||||||
|
*/ |
||||||
|
enum sandbox_clk_test_id { |
||||||
|
SANDBOX_CLK_TEST_ID_FIXED, |
||||||
|
SANDBOX_CLK_TEST_ID_SPI, |
||||||
|
SANDBOX_CLK_TEST_ID_I2C, |
||||||
|
|
||||||
|
SANDBOX_CLK_TEST_ID_COUNT, |
||||||
|
}; |
||||||
|
|
||||||
|
/**
|
||||||
|
* sandbox_clk_query_rate - Query the current rate of a sandbox clock. |
||||||
|
* |
||||||
|
* @dev: The sandbox clock provider device. |
||||||
|
* @id: The clock to query. |
||||||
|
* @return: The rate of the clock. |
||||||
|
*/ |
||||||
|
ulong sandbox_clk_query_rate(struct udevice *dev, int id); |
||||||
|
/**
|
||||||
|
* sandbox_clk_query_enable - Query the enable state of a sandbox clock. |
||||||
|
* |
||||||
|
* @dev: The sandbox clock provider device. |
||||||
|
* @id: The clock to query. |
||||||
|
* @return: The rate of the clock. |
||||||
|
*/ |
||||||
|
int sandbox_clk_query_enable(struct udevice *dev, int id); |
||||||
|
|
||||||
|
/**
|
||||||
|
* sandbox_clk_test_get - Ask the sandbox clock test device to request its |
||||||
|
* clocks. |
||||||
|
* |
||||||
|
* @dev: The sandbox clock test (client) devivce. |
||||||
|
* @return: 0 if OK, or a negative error code. |
||||||
|
*/ |
||||||
|
int sandbox_clk_test_get(struct udevice *dev); |
||||||
|
/**
|
||||||
|
* sandbox_clk_test_get_rate - Ask the sandbox clock test device to query a |
||||||
|
* clock's rate. |
||||||
|
* |
||||||
|
* @dev: The sandbox clock test (client) devivce. |
||||||
|
* @id: The test device's clock ID to query. |
||||||
|
* @return: The rate of the clock. |
||||||
|
*/ |
||||||
|
ulong sandbox_clk_test_get_rate(struct udevice *dev, int id); |
||||||
|
/**
|
||||||
|
* sandbox_clk_test_set_rate - Ask the sandbox clock test device to set a |
||||||
|
* clock's rate. |
||||||
|
* |
||||||
|
* @dev: The sandbox clock test (client) devivce. |
||||||
|
* @id: The test device's clock ID to configure. |
||||||
|
* @return: The new rate of the clock. |
||||||
|
*/ |
||||||
|
ulong sandbox_clk_test_set_rate(struct udevice *dev, int id, ulong rate); |
||||||
|
/**
|
||||||
|
* sandbox_clk_test_enable - Ask the sandbox clock test device to enable a |
||||||
|
* clock. |
||||||
|
* |
||||||
|
* @dev: The sandbox clock test (client) devivce. |
||||||
|
* @id: The test device's clock ID to configure. |
||||||
|
* @return: 0 if OK, or a negative error code. |
||||||
|
*/ |
||||||
|
int sandbox_clk_test_enable(struct udevice *dev, int id); |
||||||
|
/**
|
||||||
|
* sandbox_clk_test_disable - Ask the sandbox clock test device to disable a |
||||||
|
* clock. |
||||||
|
* |
||||||
|
* @dev: The sandbox clock test (client) devivce. |
||||||
|
* @id: The test device's clock ID to configure. |
||||||
|
* @return: 0 if OK, or a negative error code. |
||||||
|
*/ |
||||||
|
int sandbox_clk_test_disable(struct udevice *dev, int id); |
||||||
|
/**
|
||||||
|
* sandbox_clk_test_free - Ask the sandbox clock test device to free its |
||||||
|
* clocks. |
||||||
|
* |
||||||
|
* @dev: The sandbox clock test (client) devivce. |
||||||
|
* @return: 0 if OK, or a negative error code. |
||||||
|
*/ |
||||||
|
int sandbox_clk_test_free(struct udevice *dev); |
||||||
|
|
||||||
|
#endif |
@ -0,0 +1,101 @@ |
|||||||
|
/*
|
||||||
|
* Copyright (c) 2016, NVIDIA CORPORATION. |
||||||
|
* |
||||||
|
* SPDX-License-Identifier: GPL-2.0 |
||||||
|
*/ |
||||||
|
|
||||||
|
#include <common.h> |
||||||
|
#include <dm.h> |
||||||
|
#include <clk.h> |
||||||
|
#include <asm/clk.h> |
||||||
|
|
||||||
|
struct sandbox_clk_test { |
||||||
|
struct clk clks[SANDBOX_CLK_TEST_ID_COUNT]; |
||||||
|
}; |
||||||
|
|
||||||
|
static const char * const sandbox_clk_test_names[] = { |
||||||
|
[SANDBOX_CLK_TEST_ID_FIXED] = "fixed", |
||||||
|
[SANDBOX_CLK_TEST_ID_SPI] = "spi", |
||||||
|
[SANDBOX_CLK_TEST_ID_I2C] = "i2c", |
||||||
|
}; |
||||||
|
|
||||||
|
int sandbox_clk_test_get(struct udevice *dev) |
||||||
|
{ |
||||||
|
struct sandbox_clk_test *sbct = dev_get_priv(dev); |
||||||
|
int i, ret; |
||||||
|
|
||||||
|
for (i = 0; i < SANDBOX_CLK_TEST_ID_COUNT; i++) { |
||||||
|
ret = clk_get_by_name(dev, sandbox_clk_test_names[i], |
||||||
|
&sbct->clks[i]); |
||||||
|
if (ret) |
||||||
|
return ret; |
||||||
|
} |
||||||
|
|
||||||
|
return 0; |
||||||
|
} |
||||||
|
|
||||||
|
ulong sandbox_clk_test_get_rate(struct udevice *dev, int id) |
||||||
|
{ |
||||||
|
struct sandbox_clk_test *sbct = dev_get_priv(dev); |
||||||
|
|
||||||
|
if (id < 0 || id >= SANDBOX_CLK_TEST_ID_COUNT) |
||||||
|
return -EINVAL; |
||||||
|
|
||||||
|
return clk_get_rate(&sbct->clks[id]); |
||||||
|
} |
||||||
|
|
||||||
|
ulong sandbox_clk_test_set_rate(struct udevice *dev, int id, ulong rate) |
||||||
|
{ |
||||||
|
struct sandbox_clk_test *sbct = dev_get_priv(dev); |
||||||
|
|
||||||
|
if (id < 0 || id >= SANDBOX_CLK_TEST_ID_COUNT) |
||||||
|
return -EINVAL; |
||||||
|
|
||||||
|
return clk_set_rate(&sbct->clks[id], rate); |
||||||
|
} |
||||||
|
|
||||||
|
int sandbox_clk_test_enable(struct udevice *dev, int id) |
||||||
|
{ |
||||||
|
struct sandbox_clk_test *sbct = dev_get_priv(dev); |
||||||
|
|
||||||
|
if (id < 0 || id >= SANDBOX_CLK_TEST_ID_COUNT) |
||||||
|
return -EINVAL; |
||||||
|
|
||||||
|
return clk_enable(&sbct->clks[id]); |
||||||
|
} |
||||||
|
|
||||||
|
int sandbox_clk_test_disable(struct udevice *dev, int id) |
||||||
|
{ |
||||||
|
struct sandbox_clk_test *sbct = dev_get_priv(dev); |
||||||
|
|
||||||
|
if (id < 0 || id >= SANDBOX_CLK_TEST_ID_COUNT) |
||||||
|
return -EINVAL; |
||||||
|
|
||||||
|
return clk_disable(&sbct->clks[id]); |
||||||
|
} |
||||||
|
|
||||||
|
int sandbox_clk_test_free(struct udevice *dev) |
||||||
|
{ |
||||||
|
struct sandbox_clk_test *sbct = dev_get_priv(dev); |
||||||
|
int i, ret; |
||||||
|
|
||||||
|
for (i = 0; i < SANDBOX_CLK_TEST_ID_COUNT; i++) { |
||||||
|
ret = clk_free(&sbct->clks[i]); |
||||||
|
if (ret) |
||||||
|
return ret; |
||||||
|
} |
||||||
|
|
||||||
|
return 0; |
||||||
|
} |
||||||
|
|
||||||
|
static const struct udevice_id sandbox_clk_test_ids[] = { |
||||||
|
{ .compatible = "sandbox,clk-test" }, |
||||||
|
{ } |
||||||
|
}; |
||||||
|
|
||||||
|
U_BOOT_DRIVER(sandbox_clk_test) = { |
||||||
|
.name = "sandbox_clk_test", |
||||||
|
.id = UCLASS_MISC, |
||||||
|
.of_match = sandbox_clk_test_ids, |
||||||
|
.priv_auto_alloc_size = sizeof(struct sandbox_clk_test), |
||||||
|
}; |
@ -0,0 +1,95 @@ |
|||||||
|
/*
|
||||||
|
* Copyright (c) 2015 Google, Inc |
||||||
|
* Written by Simon Glass <sjg@chromium.org> |
||||||
|
* Copyright (c) 2016, NVIDIA CORPORATION. |
||||||
|
* |
||||||
|
* SPDX-License-Identifier: GPL-2.0+ |
||||||
|
*/ |
||||||
|
|
||||||
|
#ifndef _CLK_UCLASS_H |
||||||
|
#define _CLK_UCLASS_H |
||||||
|
|
||||||
|
/* See clk.h for background documentation. */ |
||||||
|
|
||||||
|
#include <clk.h> |
||||||
|
#include <fdtdec.h> |
||||||
|
|
||||||
|
/**
|
||||||
|
* struct clk_ops - The functions that a clock driver must implement. |
||||||
|
*/ |
||||||
|
struct clk_ops { |
||||||
|
/**
|
||||||
|
* of_xlate - Translate a client's device-tree (OF) clock specifier. |
||||||
|
* |
||||||
|
* The clock core calls this function as the first step in implementing |
||||||
|
* a client's clk_get_by_*() call. |
||||||
|
* |
||||||
|
* If this function pointer is set to NULL, the clock core will use a |
||||||
|
* default implementation, which assumes #clock-cells = <1>, and that |
||||||
|
* the DT cell contains a simple integer clock ID. |
||||||
|
* |
||||||
|
* At present, the clock API solely supports device-tree. If this |
||||||
|
* changes, other xxx_xlate() functions may be added to support those |
||||||
|
* other mechanisms. |
||||||
|
* |
||||||
|
* @clock: The clock struct to hold the translation result. |
||||||
|
* @args: The clock specifier values from device tree. |
||||||
|
* @return 0 if OK, or a negative error code. |
||||||
|
*/ |
||||||
|
int (*of_xlate)(struct clk *clock, |
||||||
|
struct fdtdec_phandle_args *args); |
||||||
|
/**
|
||||||
|
* request - Request a translated clock. |
||||||
|
* |
||||||
|
* The clock core calls this function as the second step in |
||||||
|
* implementing a client's clk_get_by_*() call, following a successful |
||||||
|
* xxx_xlate() call, or as the only step in implementing a client's |
||||||
|
* clk_request() call. |
||||||
|
* |
||||||
|
* @clock: The clock struct to request; this has been fille in by |
||||||
|
* a previoux xxx_xlate() function call, or by the caller |
||||||
|
* of clk_request(). |
||||||
|
* @return 0 if OK, or a negative error code. |
||||||
|
*/ |
||||||
|
int (*request)(struct clk *clock); |
||||||
|
/**
|
||||||
|
* free - Free a previously requested clock. |
||||||
|
* |
||||||
|
* This is the implementation of the client clk_free() API. |
||||||
|
* |
||||||
|
* @clock: The clock to free. |
||||||
|
* @return 0 if OK, or a negative error code. |
||||||
|
*/ |
||||||
|
int (*free)(struct clk *clock); |
||||||
|
/**
|
||||||
|
* get_rate() - Get current clock rate. |
||||||
|
* |
||||||
|
* @clk: The clock to query. |
||||||
|
* @return clock rate in Hz, or -ve error code |
||||||
|
*/ |
||||||
|
ulong (*get_rate)(struct clk *clk); |
||||||
|
/**
|
||||||
|
* set_rate() - Set current clock rate. |
||||||
|
* |
||||||
|
* @clk: The clock to manipulate. |
||||||
|
* @rate: New clock rate in Hz. |
||||||
|
* @return new rate, or -ve error code. |
||||||
|
*/ |
||||||
|
ulong (*set_rate)(struct clk *clk, ulong rate); |
||||||
|
/**
|
||||||
|
* enable() - Enable a clock. |
||||||
|
* |
||||||
|
* @clk: The clock to manipulate. |
||||||
|
* @return zero on success, or -ve error code. |
||||||
|
*/ |
||||||
|
int (*enable)(struct clk *clk); |
||||||
|
/**
|
||||||
|
* disable() - Disable a clock. |
||||||
|
* |
||||||
|
* @clk: The clock to manipulate. |
||||||
|
* @return zero on success, or -ve error code. |
||||||
|
*/ |
||||||
|
int (*disable)(struct clk *clk); |
||||||
|
}; |
||||||
|
|
||||||
|
#endif |
Loading…
Reference in new issue