/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * Structures used by ASPEED clock drivers
 *
 * Copyright 2019 IBM Corp.
 */

#include <linux/clk-provider.h>
#include <linux/kernel.h>
#include <linux/reset-controller.h>
#include <linux/spinlock.h>

struct clk_div_table;
struct regmap;

/**
 * struct aspeed_gate_data - Aspeed gated clocks
 * @clock_idx: bit used to gate this clock in the clock register
 * @reset_idx: bit used to reset this IP in the reset register. -1 if no
 *             reset is required when enabling the clock
 * @name: the clock name
 * @parent_name: the name of the parent clock
 * @flags: standard clock framework flags
 */
struct aspeed_gate_data {
	u8		clock_idx;
	s8		reset_idx;
	const char	*name;
	const char	*parent_name;
	unsigned long	flags;
};

/**
 * struct aspeed_clk_gate - Aspeed specific clk_gate structure
 * @hw:		handle between common and hardware-specific interfaces
 * @reg:	register controlling gate
 * @clock_idx:	bit used to gate this clock in the clock register
 * @reset_idx:	bit used to reset this IP in the reset register. -1 if no
 *		reset is required when enabling the clock
 * @flags:	hardware-specific flags
 * @lock:	register lock
 *
 * Some of the clocks in the Aspeed SoC must be put in reset before enabling.
 * This modified version of clk_gate allows an optional reset bit to be
 * specified.
 */
struct aspeed_clk_gate {
	struct clk_hw	hw;
	struct regmap	*map;
	u8		clock_idx;
	s8		reset_idx;
	u8		flags;
	spinlock_t	*lock;
};

#define to_aspeed_clk_gate(_hw) container_of(_hw, struct aspeed_clk_gate, hw)

/**
 * struct aspeed_reset - Aspeed reset controller
 * @map: regmap to access the containing system controller
 * @rcdev: reset controller device
 */
struct aspeed_reset {
	struct regmap			*map;
	struct reset_controller_dev	rcdev;
};

#define to_aspeed_reset(p) container_of((p), struct aspeed_reset, rcdev)

/**
 * struct aspeed_clk_soc_data - Aspeed SoC specific divisor information
 * @div_table: Common divider lookup table
 * @eclk_div_table: Divider lookup table for ECLK
 * @mac_div_table: Divider lookup table for MAC (Ethernet) clocks
 * @calc_pll: Callback to maculate common PLL settings
 */
struct aspeed_clk_soc_data {
	const struct clk_div_table *div_table;
	const struct clk_div_table *eclk_div_table;
	const struct clk_div_table *mac_div_table;
	struct clk_hw *(*calc_pll)(const char *name, u32 val);
};
ef='/drm-tip/log/.mailmap?id=e5dc9a7055c98bcd7b03f9735d5f2ec2b7f0d897'>.mailmap</a></div><div class='content'><table class='list nowrap'><tr class='nohover'><th class='left'>Age</th><th class='left'>Commit message (<a href='/drm-tip/log/.mailmap?id=e5dc9a7055c98bcd7b03f9735d5f2ec2b7f0d897&amp;showmsg=1'>Expand</a>)</th><th class='left'>Author</th><th class='left'>Files</th><th class='left'>Lines</th></tr>
<tr><td><span title='2017-05-12 12:02:21 -0700'>2017-05-12</span></td><td><a href='/drm-tip/commit/.mailmap?id=6b402bdfdbafce241cb6789ae38d94f45641078c'>Merge tag 'for-v4.12-2' of git://git.kernel.org/pub/scm/linux/kernel/git/sre/...</a></td><td>Linus Torvalds</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+2</span></td></tr>
<tr><td><span title='2017-05-05 18:16:23 -0700'>2017-05-05</span></td><td><a href='/drm-tip/commit/.mailmap?id=c6a677c6f37bb7abc85ba7e3465e82b9f7eb1d91'>Merge tag 'staging-4.12-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git...</a></td><td>Linus Torvalds</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+1</span></td></tr>
<tr><td><span title='2017-05-01 13:55:33 +0200'>2017-05-01</span></td><td><a href='/drm-tip/commit/.mailmap?id=cad87f097ca2d56093145c4becd487f5c186a612'>mailmap: add Sebastian Reichel</a></td><td>Sebastian Reichel</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+2</span></td></tr>
<tr><td><span title='2017-04-13 18:24:21 -0700'>2017-04-13</span></td><td><a href='/drm-tip/commit/.mailmap?id=5714320d316ae6e830bfc463bfdaf288695f6b62'>mailmap: add Martin Kepplinger's email</a></td><td>Martin Kepplinger</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+2</span></td></tr>
<tr><td><span title='2017-04-10 15:21:55 +0200'>2017-04-10</span></td><td><a href='/drm-tip/commit/.mailmap?id=f78a8236c6502760705399dfa42e22ab11aa1e6b'>Merge 4.11-rc6 into staging-next</a></td><td>Greg Kroah-Hartman</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+1</span></td></tr>
<tr><td><span title='2017-04-08 00:47:49 -0700'>2017-04-08</span></td><td><a href='/drm-tip/commit/.mailmap?id=cdcf4330d5660998d06fcd899b443693ab3d652f'>mailmap: update Yakir Yang email address</a></td><td>Jeffy Chen</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+1</span></td></tr>
<tr><td><span title='2017-03-06 13:17:21 +0100'>2017-03-06</span></td><td><a href='/drm-tip/commit/.mailmap?id=34ff6c2fe366f389dbe45badb5d100bd3aa02bea'>Merge tag 'iio-for-4.12a' of git://git.kernel.org/pub/scm/linux/kernel/git/ji...</a></td><td>Greg Kroah-Hartman</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+1</span></td></tr>
<tr><td><span title='2017-02-04 11:43:35 +0000'>2017-02-04</span></td><td><a href='/drm-tip/commit/.mailmap?id=7c8e818f6e264f978f0f0d6c45daf209870e60fc'>mailmap: Change email to new Konsulko email</a></td><td>Matt Ranostay</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+1</span></td></tr>
<tr><td><span title='2017-01-10 18:31:55 -0800'>2017-01-10</span></td><td><a href='/drm-tip/commit/.mailmap?id=9ebf73b275f06b114586af27cda3fd72e149d5ba'>mailmap: add codeaurora.org names for nameless email commits</a></td><td>Stephen Boyd</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+4</span></td></tr>
<tr><td><span title='2016-10-15 09:26:12 -0700'>2016-10-15</span></td><td><a href='/drm-tip/commit/.mailmap?id=133d970e0dadf7b413db19893acc5b26664bf4a1'>Merge branch 'upstream' of git://git.linux-mips.org/pub/scm/ralf/upstream-linus</a></td><td>Linus Torvalds</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+1</span></td></tr>
<tr><td><span title='2016-10-07 18:46:30 -0700'>2016-10-07</span></td><td><a href='/drm-tip/commit/.mailmap?id=69474afb042337f5f189cd15de5eb49923ce20dc'>mailmap: add Johan Hovold</a></td><td>Johan Hovold</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+2</span></td></tr>
<tr><td><span title='2016-10-05 14:50:51 -0700'>2016-10-05</span></td><td><a href='/drm-tip/commit/.mailmap?id=41844e36206be90cd4d962ea49b0abc3612a99d0'>Merge tag 'staging-4.9-rc1' of git://git.kernel.org/pub/scm/linux/kernel/git/...</a></td><td>Linus Torvalds</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+1</span></td></tr>
<tr><td><span title='2016-10-05 01:31:20 +0200'>2016-10-05</span></td><td><a href='/drm-tip/commit/.mailmap?id=74abd4e9b100d68a9114c845c6c5b70aa8e4e52e'>mailmap: Canonicalize to Qais' current email address.</a></td><td>Ralf Baechle</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+1</span></td></tr>
<tr><td><span title='2016-09-30 10:45:11 -0700'>2016-09-30</span></td><td><a href='/drm-tip/commit/.mailmap?id=9a2172a8d52cf14ce44e9cadd8c9df84cf832d75'>MAINTAINERS: Switch to kernel.org email address for Javi Merino</a></td><td>Javi Merino</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+1</span></td></tr>
<tr><td><span title='2016-09-14 20:42:03 +0200'>2016-09-14</span></td><td><a href='/drm-tip/commit/.mailmap?id=552edf8d79096c7458cdc2a7b1f9936e7925e2aa'>Merge tag 'iio-for-4.9b' of git://git.kernel.org/pub/scm/linux/kernel/git/jic...</a></td><td>Greg Kroah-Hartman</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+1</span></td></tr>
<tr><td><span title='2016-09-08 12:05:15 -0700'>2016-09-08</span></td><td><a href='/drm-tip/commit/.mailmap?id=e8b3b45de89117729cdc1a6b29da85500e4af7db'>Merge tag 'armsoc-fixes' of git://git.kernel.org/pub/scm/linux/kernel/git/arm...</a></td><td>Linus Torvalds</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+1</span></td></tr>
<tr><td><span title='2016-09-01 17:52:02 -0700'>2016-09-01</span></td><td><a href='/drm-tip/commit/.mailmap?id=c4e297386bd1621b83f6f7d58a729fb770597a91'>MAINTAINERS: Vladimir has moved</a></td><td>Vladimir Davydov</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+2</span></td></tr>
<tr><td><span title='2016-08-29 20:16:03 +0100'>2016-08-29</span></td><td><a href='/drm-tip/commit/.mailmap?id=2d6d840a5a93c9493554d36cacabac797b441972'>mailmap: update Vlad Dogaru email address</a></td><td>Vlad Dogaru</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+1</span></td></tr>
<tr><td><span title='2016-08-17 17:54:56 +0200'>2016-08-17</span></td><td><a href='/drm-tip/commit/.mailmap?id=326dce0734b63c3b82b6a88e5645eab8b54c6692'>MAINTAINERS: Switch to kernel.org account for Krzysztof Kozlowski</a></td><td>Krzysztof Kozlowski</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+1</span></td></tr>
<tr><td><span title='2016-08-06 09:44:14 -0400'>2016-08-06</span></td><td><a href='/drm-tip/commit/.mailmap?id=ce804bf598b59427a2c930e5c1f5fe2e51f1b517'>Merge tag 'media/v4.8-6' of git://git.kernel.org/pub/scm/linux/kernel/git/mch...</a></td><td>Linus Torvalds</td><td>1</td><td><span class='deletions'>-2</span>/<span class='insertions'>+11</span></td></tr>
<tr><td><span title='2016-08-04 21:35:41 -0300'>2016-08-04</span></td><td><a href='/drm-tip/commit/.mailmap?id=5055610e3d30ed90de77525cf240d0066ac616e4'>.mailmap: Correct entries for Mauro Carvalho Chehab and Shuah Khan</a></td><td>Joe Perches</td><td>1</td><td><span class='deletions'>-2</span>/<span class='insertions'>+11</span></td></tr>
<tr><td><span title='2016-08-02 19:34:14 -0400'>2016-08-02</span></td><td><a href='/drm-tip/commit/.mailmap?id=bd804ba12525c13a096f64f305a169c654a706e7'>mailmap: add Linus Lüssing</a></td><td>Linus Lüssing</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+2</span></td></tr>
<tr><td><span title='2016-07-04 08:15:03 -0700'>2016-07-04</span></td><td><a href='/drm-tip/commit/.mailmap?id=7813029a509c0c92a5b16d846defaa50a2d3d7f1'>Merge 4.7-rc6 into staging-next</a></td><td>Greg Kroah-Hartman</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+4</span></td></tr>
<tr><td><span title='2016-06-29 15:35:01 -0700'>2016-06-29</span></td><td><a href='/drm-tip/commit/.mailmap?id=3c9a6793bde1feb368cd6ef113c08a40a37f7517'>Merge tag 'iio-for-4.8b' of git://git.kernel.org/pub/scm/linux/kernel/git/jic...</a></td><td>Greg Kroah-Hartman</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+3</span></td></tr>
<tr><td><span title='2016-06-24 17:23:52 -0700'>2016-06-24</span></td><td><a href='/drm-tip/commit/.mailmap?id=1f08fe266560fc2d1383fd9c8c08fdd432ea302b'>mailmap: add Boris Brezillon's email</a></td><td>Antoine Tenart</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+3</span></td></tr>
<tr><td><span title='2016-06-24 17:23:52 -0700'>2016-06-24</span></td><td><a href='/drm-tip/commit/.mailmap?id=a8a47ff53462c3043778c04b3ba7230a39c476bf'>mailmap: add Antoine Tenart's email</a></td><td>Antoine Tenart</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+1</span></td></tr>
<tr><td><span title='2016-06-15 15:35:37 -1000'>2016-06-15</span></td><td><a href='/drm-tip/commit/.mailmap?id=90effdcd2b8a39927aace655c72088a62911e8e1'>Update email addresses in MAINTAINERS and .mailmap</a></td><td>Shuah Khan</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+1</span></td></tr>
<tr><td><span title='2016-06-15 15:35:37 -1000'>2016-06-15</span></td><td><a href='/drm-tip/commit/.mailmap?id=5dc8a864be0820677e7fce85d2832d4387c7bb88'>Update my main e-mails at the Kernel tree</a></td><td>Mauro Carvalho Chehab</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+1</span></td></tr>
<tr><td><span title='2016-06-11 17:36:34 +0100'>2016-06-11</span></td><td><a href='/drm-tip/commit/.mailmap?id=b9155073ff5de8ca6f1c40b64abca702a237c4d1'>mailmap: update Matt Ranostay email address</a></td><td>Matt Ranostay</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+2</span></td></tr>
<tr><td><span title='2016-06-11 17:34:36 +0100'>2016-06-11</span></td><td><a href='/drm-tip/commit/.mailmap?id=6c55c418f071dc7df2dfeb66398d009139cc5ef1'>mailmap: update Adriana Reus email address</a></td><td>Adriana Reus</td><td>1</td><td><span class='deletions'>-0</span>/<span class='insertions'>+1</span></td></tr>
<tr><td><span title='2016-05-05 20:07:14 -0700'>2016-05-05</span></td><td><a href='/drm-tip/commit/.mailmap?id=43a3e837e22818c2c79dad95745a6b54d4e232f7'>mailmap: add John Paul Adrian Glaubitz</a></td><td>Linus Torvalds