xref: /OK3568_Linux_fs/kernel/drivers/reset/reset-simple.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0-or-later
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Simple Reset Controller Driver
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Copyright (C) 2017 Pengutronix, Philipp Zabel <kernel@pengutronix.de>
6*4882a593Smuzhiyun  *
7*4882a593Smuzhiyun  * Based on Allwinner SoCs Reset Controller driver
8*4882a593Smuzhiyun  *
9*4882a593Smuzhiyun  * Copyright 2013 Maxime Ripard
10*4882a593Smuzhiyun  *
11*4882a593Smuzhiyun  * Maxime Ripard <maxime.ripard@free-electrons.com>
12*4882a593Smuzhiyun  */
13*4882a593Smuzhiyun 
14*4882a593Smuzhiyun #include <linux/delay.h>
15*4882a593Smuzhiyun #include <linux/device.h>
16*4882a593Smuzhiyun #include <linux/err.h>
17*4882a593Smuzhiyun #include <linux/io.h>
18*4882a593Smuzhiyun #include <linux/of.h>
19*4882a593Smuzhiyun #include <linux/of_device.h>
20*4882a593Smuzhiyun #include <linux/platform_device.h>
21*4882a593Smuzhiyun #include <linux/reset-controller.h>
22*4882a593Smuzhiyun #include <linux/reset/reset-simple.h>
23*4882a593Smuzhiyun #include <linux/spinlock.h>
24*4882a593Smuzhiyun 
25*4882a593Smuzhiyun static inline struct reset_simple_data *
to_reset_simple_data(struct reset_controller_dev * rcdev)26*4882a593Smuzhiyun to_reset_simple_data(struct reset_controller_dev *rcdev)
27*4882a593Smuzhiyun {
28*4882a593Smuzhiyun 	return container_of(rcdev, struct reset_simple_data, rcdev);
29*4882a593Smuzhiyun }
30*4882a593Smuzhiyun 
reset_simple_update(struct reset_controller_dev * rcdev,unsigned long id,bool assert)31*4882a593Smuzhiyun static int reset_simple_update(struct reset_controller_dev *rcdev,
32*4882a593Smuzhiyun 			       unsigned long id, bool assert)
33*4882a593Smuzhiyun {
34*4882a593Smuzhiyun 	struct reset_simple_data *data = to_reset_simple_data(rcdev);
35*4882a593Smuzhiyun 	int reg_width = sizeof(u32);
36*4882a593Smuzhiyun 	int bank = id / (reg_width * BITS_PER_BYTE);
37*4882a593Smuzhiyun 	int offset = id % (reg_width * BITS_PER_BYTE);
38*4882a593Smuzhiyun 	unsigned long flags;
39*4882a593Smuzhiyun 	u32 reg;
40*4882a593Smuzhiyun 
41*4882a593Smuzhiyun 	spin_lock_irqsave(&data->lock, flags);
42*4882a593Smuzhiyun 
43*4882a593Smuzhiyun 	reg = readl(data->membase + (bank * reg_width));
44*4882a593Smuzhiyun 	if (assert ^ data->active_low)
45*4882a593Smuzhiyun 		reg |= BIT(offset);
46*4882a593Smuzhiyun 	else
47*4882a593Smuzhiyun 		reg &= ~BIT(offset);
48*4882a593Smuzhiyun 	writel(reg, data->membase + (bank * reg_width));
49*4882a593Smuzhiyun 
50*4882a593Smuzhiyun 	spin_unlock_irqrestore(&data->lock, flags);
51*4882a593Smuzhiyun 
52*4882a593Smuzhiyun 	return 0;
53*4882a593Smuzhiyun }
54*4882a593Smuzhiyun 
reset_simple_assert(struct reset_controller_dev * rcdev,unsigned long id)55*4882a593Smuzhiyun static int reset_simple_assert(struct reset_controller_dev *rcdev,
56*4882a593Smuzhiyun 			       unsigned long id)
57*4882a593Smuzhiyun {
58*4882a593Smuzhiyun 	return reset_simple_update(rcdev, id, true);
59*4882a593Smuzhiyun }
60*4882a593Smuzhiyun 
reset_simple_deassert(struct reset_controller_dev * rcdev,unsigned long id)61*4882a593Smuzhiyun static int reset_simple_deassert(struct reset_controller_dev *rcdev,
62*4882a593Smuzhiyun 				 unsigned long id)
63*4882a593Smuzhiyun {
64*4882a593Smuzhiyun 	return reset_simple_update(rcdev, id, false);
65*4882a593Smuzhiyun }
66*4882a593Smuzhiyun 
reset_simple_reset(struct reset_controller_dev * rcdev,unsigned long id)67*4882a593Smuzhiyun static int reset_simple_reset(struct reset_controller_dev *rcdev,
68*4882a593Smuzhiyun 			      unsigned long id)
69*4882a593Smuzhiyun {
70*4882a593Smuzhiyun 	struct reset_simple_data *data = to_reset_simple_data(rcdev);
71*4882a593Smuzhiyun 	int ret;
72*4882a593Smuzhiyun 
73*4882a593Smuzhiyun 	if (!data->reset_us)
74*4882a593Smuzhiyun 		return -ENOTSUPP;
75*4882a593Smuzhiyun 
76*4882a593Smuzhiyun 	ret = reset_simple_assert(rcdev, id);
77*4882a593Smuzhiyun 	if (ret)
78*4882a593Smuzhiyun 		return ret;
79*4882a593Smuzhiyun 
80*4882a593Smuzhiyun 	usleep_range(data->reset_us, data->reset_us * 2);
81*4882a593Smuzhiyun 
82*4882a593Smuzhiyun 	return reset_simple_deassert(rcdev, id);
83*4882a593Smuzhiyun }
84*4882a593Smuzhiyun 
reset_simple_status(struct reset_controller_dev * rcdev,unsigned long id)85*4882a593Smuzhiyun static int reset_simple_status(struct reset_controller_dev *rcdev,
86*4882a593Smuzhiyun 			       unsigned long id)
87*4882a593Smuzhiyun {
88*4882a593Smuzhiyun 	struct reset_simple_data *data = to_reset_simple_data(rcdev);
89*4882a593Smuzhiyun 	int reg_width = sizeof(u32);
90*4882a593Smuzhiyun 	int bank = id / (reg_width * BITS_PER_BYTE);
91*4882a593Smuzhiyun 	int offset = id % (reg_width * BITS_PER_BYTE);
92*4882a593Smuzhiyun 	u32 reg;
93*4882a593Smuzhiyun 
94*4882a593Smuzhiyun 	reg = readl(data->membase + (bank * reg_width));
95*4882a593Smuzhiyun 
96*4882a593Smuzhiyun 	return !(reg & BIT(offset)) ^ !data->status_active_low;
97*4882a593Smuzhiyun }
98*4882a593Smuzhiyun 
99*4882a593Smuzhiyun const struct reset_control_ops reset_simple_ops = {
100*4882a593Smuzhiyun 	.assert		= reset_simple_assert,
101*4882a593Smuzhiyun 	.deassert	= reset_simple_deassert,
102*4882a593Smuzhiyun 	.reset		= reset_simple_reset,
103*4882a593Smuzhiyun 	.status		= reset_simple_status,
104*4882a593Smuzhiyun };
105*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(reset_simple_ops);
106*4882a593Smuzhiyun 
107*4882a593Smuzhiyun /**
108*4882a593Smuzhiyun  * struct reset_simple_devdata - simple reset controller properties
109*4882a593Smuzhiyun  * @reg_offset: offset between base address and first reset register.
110*4882a593Smuzhiyun  * @nr_resets: number of resets. If not set, default to resource size in bits.
111*4882a593Smuzhiyun  * @active_low: if true, bits are cleared to assert the reset. Otherwise, bits
112*4882a593Smuzhiyun  *              are set to assert the reset.
113*4882a593Smuzhiyun  * @status_active_low: if true, bits read back as cleared while the reset is
114*4882a593Smuzhiyun  *                     asserted. Otherwise, bits read back as set while the
115*4882a593Smuzhiyun  *                     reset is asserted.
116*4882a593Smuzhiyun  */
117*4882a593Smuzhiyun struct reset_simple_devdata {
118*4882a593Smuzhiyun 	u32 reg_offset;
119*4882a593Smuzhiyun 	u32 nr_resets;
120*4882a593Smuzhiyun 	bool active_low;
121*4882a593Smuzhiyun 	bool status_active_low;
122*4882a593Smuzhiyun };
123*4882a593Smuzhiyun 
124*4882a593Smuzhiyun #define SOCFPGA_NR_BANKS	8
125*4882a593Smuzhiyun 
126*4882a593Smuzhiyun static const struct reset_simple_devdata reset_simple_socfpga = {
127*4882a593Smuzhiyun 	.reg_offset = 0x20,
128*4882a593Smuzhiyun 	.nr_resets = SOCFPGA_NR_BANKS * 32,
129*4882a593Smuzhiyun 	.status_active_low = true,
130*4882a593Smuzhiyun };
131*4882a593Smuzhiyun 
132*4882a593Smuzhiyun static const struct reset_simple_devdata reset_simple_active_low = {
133*4882a593Smuzhiyun 	.active_low = true,
134*4882a593Smuzhiyun 	.status_active_low = true,
135*4882a593Smuzhiyun };
136*4882a593Smuzhiyun 
137*4882a593Smuzhiyun static const struct of_device_id reset_simple_dt_ids[] = {
138*4882a593Smuzhiyun 	{ .compatible = "altr,stratix10-rst-mgr",
139*4882a593Smuzhiyun 		.data = &reset_simple_socfpga },
140*4882a593Smuzhiyun 	{ .compatible = "st,stm32-rcc", },
141*4882a593Smuzhiyun 	{ .compatible = "allwinner,sun6i-a31-clock-reset",
142*4882a593Smuzhiyun 		.data = &reset_simple_active_low },
143*4882a593Smuzhiyun 	{ .compatible = "zte,zx296718-reset",
144*4882a593Smuzhiyun 		.data = &reset_simple_active_low },
145*4882a593Smuzhiyun 	{ .compatible = "aspeed,ast2400-lpc-reset" },
146*4882a593Smuzhiyun 	{ .compatible = "aspeed,ast2500-lpc-reset" },
147*4882a593Smuzhiyun 	{ .compatible = "bitmain,bm1880-reset",
148*4882a593Smuzhiyun 		.data = &reset_simple_active_low },
149*4882a593Smuzhiyun 	{ .compatible = "snps,dw-high-reset" },
150*4882a593Smuzhiyun 	{ .compatible = "snps,dw-low-reset",
151*4882a593Smuzhiyun 		.data = &reset_simple_active_low },
152*4882a593Smuzhiyun 	{ /* sentinel */ },
153*4882a593Smuzhiyun };
154*4882a593Smuzhiyun 
reset_simple_probe(struct platform_device * pdev)155*4882a593Smuzhiyun static int reset_simple_probe(struct platform_device *pdev)
156*4882a593Smuzhiyun {
157*4882a593Smuzhiyun 	struct device *dev = &pdev->dev;
158*4882a593Smuzhiyun 	const struct reset_simple_devdata *devdata;
159*4882a593Smuzhiyun 	struct reset_simple_data *data;
160*4882a593Smuzhiyun 	void __iomem *membase;
161*4882a593Smuzhiyun 	struct resource *res;
162*4882a593Smuzhiyun 	u32 reg_offset = 0;
163*4882a593Smuzhiyun 
164*4882a593Smuzhiyun 	devdata = of_device_get_match_data(dev);
165*4882a593Smuzhiyun 
166*4882a593Smuzhiyun 	data = devm_kzalloc(dev, sizeof(*data), GFP_KERNEL);
167*4882a593Smuzhiyun 	if (!data)
168*4882a593Smuzhiyun 		return -ENOMEM;
169*4882a593Smuzhiyun 
170*4882a593Smuzhiyun 	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
171*4882a593Smuzhiyun 	membase = devm_ioremap_resource(dev, res);
172*4882a593Smuzhiyun 	if (IS_ERR(membase))
173*4882a593Smuzhiyun 		return PTR_ERR(membase);
174*4882a593Smuzhiyun 
175*4882a593Smuzhiyun 	spin_lock_init(&data->lock);
176*4882a593Smuzhiyun 	data->membase = membase;
177*4882a593Smuzhiyun 	data->rcdev.owner = THIS_MODULE;
178*4882a593Smuzhiyun 	data->rcdev.nr_resets = resource_size(res) * BITS_PER_BYTE;
179*4882a593Smuzhiyun 	data->rcdev.ops = &reset_simple_ops;
180*4882a593Smuzhiyun 	data->rcdev.of_node = dev->of_node;
181*4882a593Smuzhiyun 
182*4882a593Smuzhiyun 	if (devdata) {
183*4882a593Smuzhiyun 		reg_offset = devdata->reg_offset;
184*4882a593Smuzhiyun 		if (devdata->nr_resets)
185*4882a593Smuzhiyun 			data->rcdev.nr_resets = devdata->nr_resets;
186*4882a593Smuzhiyun 		data->active_low = devdata->active_low;
187*4882a593Smuzhiyun 		data->status_active_low = devdata->status_active_low;
188*4882a593Smuzhiyun 	}
189*4882a593Smuzhiyun 
190*4882a593Smuzhiyun 	data->membase += reg_offset;
191*4882a593Smuzhiyun 
192*4882a593Smuzhiyun 	return devm_reset_controller_register(dev, &data->rcdev);
193*4882a593Smuzhiyun }
194*4882a593Smuzhiyun 
195*4882a593Smuzhiyun static struct platform_driver reset_simple_driver = {
196*4882a593Smuzhiyun 	.probe	= reset_simple_probe,
197*4882a593Smuzhiyun 	.driver = {
198*4882a593Smuzhiyun 		.name		= "simple-reset",
199*4882a593Smuzhiyun 		.of_match_table	= reset_simple_dt_ids,
200*4882a593Smuzhiyun 	},
201*4882a593Smuzhiyun };
202*4882a593Smuzhiyun builtin_platform_driver(reset_simple_driver);
203