xref: /OK3568_Linux_fs/kernel/drivers/i2c/muxes/i2c-mux-pinctrl.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0-only
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * I2C multiplexer using pinctrl API
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Copyright (c) 2012, NVIDIA CORPORATION.  All rights reserved.
6*4882a593Smuzhiyun  */
7*4882a593Smuzhiyun 
8*4882a593Smuzhiyun #include <linux/i2c.h>
9*4882a593Smuzhiyun #include <linux/i2c-mux.h>
10*4882a593Smuzhiyun #include <linux/module.h>
11*4882a593Smuzhiyun #include <linux/pinctrl/consumer.h>
12*4882a593Smuzhiyun #include <linux/platform_device.h>
13*4882a593Smuzhiyun #include <linux/slab.h>
14*4882a593Smuzhiyun #include <linux/of.h>
15*4882a593Smuzhiyun #include "../../pinctrl/core.h"
16*4882a593Smuzhiyun 
17*4882a593Smuzhiyun struct i2c_mux_pinctrl {
18*4882a593Smuzhiyun 	struct pinctrl *pinctrl;
19*4882a593Smuzhiyun 	struct pinctrl_state *states[];
20*4882a593Smuzhiyun };
21*4882a593Smuzhiyun 
i2c_mux_pinctrl_select(struct i2c_mux_core * muxc,u32 chan)22*4882a593Smuzhiyun static int i2c_mux_pinctrl_select(struct i2c_mux_core *muxc, u32 chan)
23*4882a593Smuzhiyun {
24*4882a593Smuzhiyun 	struct i2c_mux_pinctrl *mux = i2c_mux_priv(muxc);
25*4882a593Smuzhiyun 
26*4882a593Smuzhiyun 	return pinctrl_select_state(mux->pinctrl, mux->states[chan]);
27*4882a593Smuzhiyun }
28*4882a593Smuzhiyun 
i2c_mux_pinctrl_deselect(struct i2c_mux_core * muxc,u32 chan)29*4882a593Smuzhiyun static int i2c_mux_pinctrl_deselect(struct i2c_mux_core *muxc, u32 chan)
30*4882a593Smuzhiyun {
31*4882a593Smuzhiyun 	return i2c_mux_pinctrl_select(muxc, muxc->num_adapters);
32*4882a593Smuzhiyun }
33*4882a593Smuzhiyun 
i2c_mux_pinctrl_root_adapter(struct pinctrl_state * state)34*4882a593Smuzhiyun static struct i2c_adapter *i2c_mux_pinctrl_root_adapter(
35*4882a593Smuzhiyun 	struct pinctrl_state *state)
36*4882a593Smuzhiyun {
37*4882a593Smuzhiyun 	struct i2c_adapter *root = NULL;
38*4882a593Smuzhiyun 	struct pinctrl_setting *setting;
39*4882a593Smuzhiyun 	struct i2c_adapter *pin_root;
40*4882a593Smuzhiyun 
41*4882a593Smuzhiyun 	list_for_each_entry(setting, &state->settings, node) {
42*4882a593Smuzhiyun 		pin_root = i2c_root_adapter(setting->pctldev->dev);
43*4882a593Smuzhiyun 		if (!pin_root)
44*4882a593Smuzhiyun 			return NULL;
45*4882a593Smuzhiyun 		if (!root)
46*4882a593Smuzhiyun 			root = pin_root;
47*4882a593Smuzhiyun 		else if (root != pin_root)
48*4882a593Smuzhiyun 			return NULL;
49*4882a593Smuzhiyun 	}
50*4882a593Smuzhiyun 
51*4882a593Smuzhiyun 	return root;
52*4882a593Smuzhiyun }
53*4882a593Smuzhiyun 
i2c_mux_pinctrl_parent_adapter(struct device * dev)54*4882a593Smuzhiyun static struct i2c_adapter *i2c_mux_pinctrl_parent_adapter(struct device *dev)
55*4882a593Smuzhiyun {
56*4882a593Smuzhiyun 	struct device_node *np = dev->of_node;
57*4882a593Smuzhiyun 	struct device_node *parent_np;
58*4882a593Smuzhiyun 	struct i2c_adapter *parent;
59*4882a593Smuzhiyun 
60*4882a593Smuzhiyun 	parent_np = of_parse_phandle(np, "i2c-parent", 0);
61*4882a593Smuzhiyun 	if (!parent_np) {
62*4882a593Smuzhiyun 		dev_err(dev, "Cannot parse i2c-parent\n");
63*4882a593Smuzhiyun 		return ERR_PTR(-ENODEV);
64*4882a593Smuzhiyun 	}
65*4882a593Smuzhiyun 	parent = of_find_i2c_adapter_by_node(parent_np);
66*4882a593Smuzhiyun 	of_node_put(parent_np);
67*4882a593Smuzhiyun 	if (!parent)
68*4882a593Smuzhiyun 		return ERR_PTR(-EPROBE_DEFER);
69*4882a593Smuzhiyun 
70*4882a593Smuzhiyun 	return parent;
71*4882a593Smuzhiyun }
72*4882a593Smuzhiyun 
i2c_mux_pinctrl_probe(struct platform_device * pdev)73*4882a593Smuzhiyun static int i2c_mux_pinctrl_probe(struct platform_device *pdev)
74*4882a593Smuzhiyun {
75*4882a593Smuzhiyun 	struct device *dev = &pdev->dev;
76*4882a593Smuzhiyun 	struct device_node *np = dev->of_node;
77*4882a593Smuzhiyun 	struct i2c_mux_core *muxc;
78*4882a593Smuzhiyun 	struct i2c_mux_pinctrl *mux;
79*4882a593Smuzhiyun 	struct i2c_adapter *parent;
80*4882a593Smuzhiyun 	struct i2c_adapter *root;
81*4882a593Smuzhiyun 	int num_names, i, ret;
82*4882a593Smuzhiyun 	const char *name;
83*4882a593Smuzhiyun 
84*4882a593Smuzhiyun 	num_names = of_property_count_strings(np, "pinctrl-names");
85*4882a593Smuzhiyun 	if (num_names < 0) {
86*4882a593Smuzhiyun 		dev_err(dev, "Cannot parse pinctrl-names: %d\n",
87*4882a593Smuzhiyun 			num_names);
88*4882a593Smuzhiyun 		return num_names;
89*4882a593Smuzhiyun 	}
90*4882a593Smuzhiyun 
91*4882a593Smuzhiyun 	parent = i2c_mux_pinctrl_parent_adapter(dev);
92*4882a593Smuzhiyun 	if (IS_ERR(parent))
93*4882a593Smuzhiyun 		return PTR_ERR(parent);
94*4882a593Smuzhiyun 
95*4882a593Smuzhiyun 	muxc = i2c_mux_alloc(parent, dev, num_names,
96*4882a593Smuzhiyun 			     struct_size(mux, states, num_names),
97*4882a593Smuzhiyun 			     0, i2c_mux_pinctrl_select, NULL);
98*4882a593Smuzhiyun 	if (!muxc) {
99*4882a593Smuzhiyun 		ret = -ENOMEM;
100*4882a593Smuzhiyun 		goto err_put_parent;
101*4882a593Smuzhiyun 	}
102*4882a593Smuzhiyun 	mux = i2c_mux_priv(muxc);
103*4882a593Smuzhiyun 
104*4882a593Smuzhiyun 	platform_set_drvdata(pdev, muxc);
105*4882a593Smuzhiyun 
106*4882a593Smuzhiyun 	mux->pinctrl = devm_pinctrl_get(dev);
107*4882a593Smuzhiyun 	if (IS_ERR(mux->pinctrl)) {
108*4882a593Smuzhiyun 		ret = PTR_ERR(mux->pinctrl);
109*4882a593Smuzhiyun 		dev_err(dev, "Cannot get pinctrl: %d\n", ret);
110*4882a593Smuzhiyun 		goto err_put_parent;
111*4882a593Smuzhiyun 	}
112*4882a593Smuzhiyun 
113*4882a593Smuzhiyun 	for (i = 0; i < num_names; i++) {
114*4882a593Smuzhiyun 		ret = of_property_read_string_index(np, "pinctrl-names", i,
115*4882a593Smuzhiyun 						    &name);
116*4882a593Smuzhiyun 		if (ret < 0) {
117*4882a593Smuzhiyun 			dev_err(dev, "Cannot parse pinctrl-names: %d\n", ret);
118*4882a593Smuzhiyun 			goto err_put_parent;
119*4882a593Smuzhiyun 		}
120*4882a593Smuzhiyun 
121*4882a593Smuzhiyun 		mux->states[i] = pinctrl_lookup_state(mux->pinctrl, name);
122*4882a593Smuzhiyun 		if (IS_ERR(mux->states[i])) {
123*4882a593Smuzhiyun 			ret = PTR_ERR(mux->states[i]);
124*4882a593Smuzhiyun 			dev_err(dev, "Cannot look up pinctrl state %s: %d\n",
125*4882a593Smuzhiyun 				name, ret);
126*4882a593Smuzhiyun 			goto err_put_parent;
127*4882a593Smuzhiyun 		}
128*4882a593Smuzhiyun 
129*4882a593Smuzhiyun 		if (strcmp(name, "idle"))
130*4882a593Smuzhiyun 			continue;
131*4882a593Smuzhiyun 
132*4882a593Smuzhiyun 		if (i != num_names - 1) {
133*4882a593Smuzhiyun 			dev_err(dev, "idle state must be last\n");
134*4882a593Smuzhiyun 			ret = -EINVAL;
135*4882a593Smuzhiyun 			goto err_put_parent;
136*4882a593Smuzhiyun 		}
137*4882a593Smuzhiyun 		muxc->deselect = i2c_mux_pinctrl_deselect;
138*4882a593Smuzhiyun 	}
139*4882a593Smuzhiyun 
140*4882a593Smuzhiyun 	root = i2c_root_adapter(&muxc->parent->dev);
141*4882a593Smuzhiyun 
142*4882a593Smuzhiyun 	muxc->mux_locked = true;
143*4882a593Smuzhiyun 	for (i = 0; i < num_names; i++) {
144*4882a593Smuzhiyun 		if (root != i2c_mux_pinctrl_root_adapter(mux->states[i])) {
145*4882a593Smuzhiyun 			muxc->mux_locked = false;
146*4882a593Smuzhiyun 			break;
147*4882a593Smuzhiyun 		}
148*4882a593Smuzhiyun 	}
149*4882a593Smuzhiyun 	if (muxc->mux_locked)
150*4882a593Smuzhiyun 		dev_info(dev, "mux-locked i2c mux\n");
151*4882a593Smuzhiyun 
152*4882a593Smuzhiyun 	/* Do not add any adapter for the idle state (if it's there at all). */
153*4882a593Smuzhiyun 	for (i = 0; i < num_names - !!muxc->deselect; i++) {
154*4882a593Smuzhiyun 		ret = i2c_mux_add_adapter(muxc, 0, i, 0);
155*4882a593Smuzhiyun 		if (ret)
156*4882a593Smuzhiyun 			goto err_del_adapter;
157*4882a593Smuzhiyun 	}
158*4882a593Smuzhiyun 
159*4882a593Smuzhiyun 	return 0;
160*4882a593Smuzhiyun 
161*4882a593Smuzhiyun err_del_adapter:
162*4882a593Smuzhiyun 	i2c_mux_del_adapters(muxc);
163*4882a593Smuzhiyun err_put_parent:
164*4882a593Smuzhiyun 	i2c_put_adapter(parent);
165*4882a593Smuzhiyun 
166*4882a593Smuzhiyun 	return ret;
167*4882a593Smuzhiyun }
168*4882a593Smuzhiyun 
i2c_mux_pinctrl_remove(struct platform_device * pdev)169*4882a593Smuzhiyun static int i2c_mux_pinctrl_remove(struct platform_device *pdev)
170*4882a593Smuzhiyun {
171*4882a593Smuzhiyun 	struct i2c_mux_core *muxc = platform_get_drvdata(pdev);
172*4882a593Smuzhiyun 
173*4882a593Smuzhiyun 	i2c_mux_del_adapters(muxc);
174*4882a593Smuzhiyun 	i2c_put_adapter(muxc->parent);
175*4882a593Smuzhiyun 
176*4882a593Smuzhiyun 	return 0;
177*4882a593Smuzhiyun }
178*4882a593Smuzhiyun 
179*4882a593Smuzhiyun static const struct of_device_id i2c_mux_pinctrl_of_match[] = {
180*4882a593Smuzhiyun 	{ .compatible = "i2c-mux-pinctrl", },
181*4882a593Smuzhiyun 	{},
182*4882a593Smuzhiyun };
183*4882a593Smuzhiyun MODULE_DEVICE_TABLE(of, i2c_mux_pinctrl_of_match);
184*4882a593Smuzhiyun 
185*4882a593Smuzhiyun static struct platform_driver i2c_mux_pinctrl_driver = {
186*4882a593Smuzhiyun 	.driver	= {
187*4882a593Smuzhiyun 		.name	= "i2c-mux-pinctrl",
188*4882a593Smuzhiyun 		.of_match_table = of_match_ptr(i2c_mux_pinctrl_of_match),
189*4882a593Smuzhiyun 	},
190*4882a593Smuzhiyun 	.probe	= i2c_mux_pinctrl_probe,
191*4882a593Smuzhiyun 	.remove	= i2c_mux_pinctrl_remove,
192*4882a593Smuzhiyun };
193*4882a593Smuzhiyun module_platform_driver(i2c_mux_pinctrl_driver);
194*4882a593Smuzhiyun 
195*4882a593Smuzhiyun MODULE_DESCRIPTION("pinctrl-based I2C multiplexer driver");
196*4882a593Smuzhiyun MODULE_AUTHOR("Stephen Warren <swarren@nvidia.com>");
197*4882a593Smuzhiyun MODULE_LICENSE("GPL v2");
198*4882a593Smuzhiyun MODULE_ALIAS("platform:i2c-mux-pinctrl");
199