1/*-
2 * Copyright 2016 Michal Meloun <mmel@FreeBSD.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 *
26 * $FreeBSD$
27 */
28
29#ifndef _DEV_EXTRES_CLK_DIV_H_
30#define _DEV_EXTRES_CLK_DIV_H_
31
32#include <dev/extres/clk/clk.h>
33
34#define	CLK_DIV_ZERO_BASED	0x0001 /* Zero based divider. */
35#define	CLK_DIV_WITH_TABLE	0x0002 /* Table to lookup the real value */
36
37struct clk_div_table {
38	uint32_t	value;
39	uint32_t	divider;
40};
41
42struct clk_div_def {
43	struct clknode_init_def clkdef;
44	uint32_t		offset;		/* Divider register offset */
45	uint32_t		i_shift;	/* Pos of div bits in reg */
46	uint32_t		i_width;	/* Width of div bit field */
47	uint32_t		f_shift;	/* Fractional divide bits, */
48	uint32_t		f_width;	/* set to 0 for int divider */
49	int			div_flags;	/* Divider-specific flags */
50	struct clk_div_table	*div_table;	/* Divider table */
51};
52
53int clknode_div_register(struct clkdom *clkdom, struct clk_div_def *clkdef);
54
55#endif /*_DEV_EXTRES_CLK_DIV_H_*/
56