u-boot/include/clk.h
Masahiro Yamada 8bdf9cfda0 clk: fix comments in include/clk.h
The comment about get_periph_rate() is the same as that of
set_periph_rate().

I am fixing typos here and there while I am in this file.

Signed-off-by: Masahiro Yamada <yamada.masahiro@socionext.com>
Acked-by: Simon Glass <sjg@chromium.org>
2016-01-20 19:06:23 -07:00

87 lines
2.0 KiB
C

/*
* Copyright (c) 2015 Google, Inc
* Written by Simon Glass <sjg@chromium.org>
*
* SPDX-License-Identifier: GPL-2.0+
*/
#ifndef _CLK_H_
#define _CLK_H_
int soc_clk_dump(void);
struct clk_ops {
/**
* get_rate() - Get current clock rate
*
* @dev: Device to check (UCLASS_CLK)
* @return clock rate in Hz, or -ve error code
*/
ulong (*get_rate)(struct udevice *dev);
/**
* set_rate() - Set current clock rate
*
* @dev: Device to adjust
* @rate: New clock rate in Hz
* @return new rate, or -ve error code
*/
ulong (*set_rate)(struct udevice *dev, ulong rate);
/**
* get_periph_rate() - Get clock rate for a peripheral
*
* @dev: Device to check (UCLASS_CLK)
* @periph: Peripheral ID to check
* @return clock rate in Hz, or -ve error code
*/
ulong (*get_periph_rate)(struct udevice *dev, int periph);
/**
* set_periph_rate() - Set current clock rate for a peripheral
*
* @dev: Device to update (UCLASS_CLK)
* @periph: Peripheral ID to update
* @return new clock rate in Hz, or -ve error code
*/
ulong (*set_periph_rate)(struct udevice *dev, int periph, ulong rate);
};
#define clk_get_ops(dev) ((struct clk_ops *)(dev)->driver->ops)
/**
* clk_get_rate() - Get current clock rate
*
* @dev: Device to check (UCLASS_CLK)
* @return clock rate in Hz, or -ve error code
*/
ulong clk_get_rate(struct udevice *dev);
/**
* clk_set_rate() - Set current clock rate
*
* @dev: Device to adjust
* @rate: New clock rate in Hz
* @return new rate, or -ve error code
*/
ulong clk_set_rate(struct udevice *dev, ulong rate);
/**
* clk_get_periph_rate() - Get current clock rate for a peripheral
*
* @dev: Device to check (UCLASS_CLK)
* @return clock rate in Hz, -ve error code
*/
ulong clk_get_periph_rate(struct udevice *dev, int periph);
/**
* clk_set_periph_rate() - Set current clock rate for a peripheral
*
* @dev: Device to update (UCLASS_CLK)
* @periph: Peripheral ID to update
* @return new clock rate in Hz, or -ve error code
*/
ulong clk_set_periph_rate(struct udevice *dev, int periph, ulong rate);
#endif /* _CLK_H_ */