xref: /openbmc/linux/drivers/usb/typec/mux/fsa4480.c (revision ef1e29c6)
11dc24632SBjorn Andersson // SPDX-License-Identifier: GPL-2.0
21dc24632SBjorn Andersson /*
31dc24632SBjorn Andersson  * Copyright (C) 2021-2022 Linaro Ltd.
41dc24632SBjorn Andersson  * Copyright (C) 2018-2020 The Linux Foundation
51dc24632SBjorn Andersson  */
61dc24632SBjorn Andersson 
71dc24632SBjorn Andersson #include <linux/bits.h>
81dc24632SBjorn Andersson #include <linux/i2c.h>
91dc24632SBjorn Andersson #include <linux/kernel.h>
101dc24632SBjorn Andersson #include <linux/module.h>
111dc24632SBjorn Andersson #include <linux/mutex.h>
121dc24632SBjorn Andersson #include <linux/regmap.h>
131dc24632SBjorn Andersson #include <linux/usb/typec_dp.h>
141dc24632SBjorn Andersson #include <linux/usb/typec_mux.h>
151dc24632SBjorn Andersson 
161dc24632SBjorn Andersson #define FSA4480_SWITCH_ENABLE	0x04
171dc24632SBjorn Andersson #define FSA4480_SWITCH_SELECT	0x05
181dc24632SBjorn Andersson #define FSA4480_SWITCH_STATUS1	0x07
191dc24632SBjorn Andersson #define FSA4480_SLOW_L		0x08
201dc24632SBjorn Andersson #define FSA4480_SLOW_R		0x09
211dc24632SBjorn Andersson #define FSA4480_SLOW_MIC	0x0a
221dc24632SBjorn Andersson #define FSA4480_SLOW_SENSE	0x0b
231dc24632SBjorn Andersson #define FSA4480_SLOW_GND	0x0c
241dc24632SBjorn Andersson #define FSA4480_DELAY_L_R	0x0d
251dc24632SBjorn Andersson #define FSA4480_DELAY_L_MIC	0x0e
261dc24632SBjorn Andersson #define FSA4480_DELAY_L_SENSE	0x0f
271dc24632SBjorn Andersson #define FSA4480_DELAY_L_AGND	0x10
28*ef1e29c6SNeil Armstrong #define FSA4480_FUNCTION_ENABLE	0x12
291dc24632SBjorn Andersson #define FSA4480_RESET		0x1e
301dc24632SBjorn Andersson #define FSA4480_MAX_REGISTER	0x1f
311dc24632SBjorn Andersson 
321dc24632SBjorn Andersson #define FSA4480_ENABLE_DEVICE	BIT(7)
331dc24632SBjorn Andersson #define FSA4480_ENABLE_SBU	GENMASK(6, 5)
341dc24632SBjorn Andersson #define FSA4480_ENABLE_USB	GENMASK(4, 3)
35*ef1e29c6SNeil Armstrong #define FSA4480_ENABLE_SENSE	BIT(2)
36*ef1e29c6SNeil Armstrong #define FSA4480_ENABLE_MIC	BIT(1)
37*ef1e29c6SNeil Armstrong #define FSA4480_ENABLE_AGND	BIT(0)
381dc24632SBjorn Andersson 
391dc24632SBjorn Andersson #define FSA4480_SEL_SBU_REVERSE	GENMASK(6, 5)
401dc24632SBjorn Andersson #define FSA4480_SEL_USB		GENMASK(4, 3)
41*ef1e29c6SNeil Armstrong #define FSA4480_SEL_SENSE	BIT(2)
42*ef1e29c6SNeil Armstrong #define FSA4480_SEL_MIC		BIT(1)
43*ef1e29c6SNeil Armstrong #define FSA4480_SEL_AGND	BIT(0)
44*ef1e29c6SNeil Armstrong 
45*ef1e29c6SNeil Armstrong #define FSA4480_ENABLE_AUTO_JACK_DETECT	BIT(0)
461dc24632SBjorn Andersson 
471dc24632SBjorn Andersson struct fsa4480 {
481dc24632SBjorn Andersson 	struct i2c_client *client;
491dc24632SBjorn Andersson 
501dc24632SBjorn Andersson 	/* used to serialize concurrent change requests */
511dc24632SBjorn Andersson 	struct mutex lock;
521dc24632SBjorn Andersson 
531dc24632SBjorn Andersson 	struct typec_switch_dev *sw;
541dc24632SBjorn Andersson 	struct typec_mux_dev *mux;
551dc24632SBjorn Andersson 
561dc24632SBjorn Andersson 	struct regmap *regmap;
571dc24632SBjorn Andersson 
58c7054c31SNeil Armstrong 	enum typec_orientation orientation;
59c7054c31SNeil Armstrong 	unsigned long mode;
60c7054c31SNeil Armstrong 	unsigned int svid;
61c7054c31SNeil Armstrong 
621dc24632SBjorn Andersson 	u8 cur_enable;
631dc24632SBjorn Andersson };
641dc24632SBjorn Andersson 
651dc24632SBjorn Andersson static const struct regmap_config fsa4480_regmap_config = {
661dc24632SBjorn Andersson 	.reg_bits = 8,
671dc24632SBjorn Andersson 	.val_bits = 8,
681dc24632SBjorn Andersson 	.max_register = FSA4480_MAX_REGISTER,
691dc24632SBjorn Andersson 	/* Accesses only done under fsa4480->lock */
701dc24632SBjorn Andersson 	.disable_locking = true,
711dc24632SBjorn Andersson };
721dc24632SBjorn Andersson 
fsa4480_set(struct fsa4480 * fsa)73c7054c31SNeil Armstrong static int fsa4480_set(struct fsa4480 *fsa)
741dc24632SBjorn Andersson {
75c7054c31SNeil Armstrong 	bool reverse = (fsa->orientation == TYPEC_ORIENTATION_REVERSE);
76c7054c31SNeil Armstrong 	u8 enable = FSA4480_ENABLE_DEVICE;
77c7054c31SNeil Armstrong 	u8 sel = 0;
781dc24632SBjorn Andersson 
79c7054c31SNeil Armstrong 	/* USB Mode */
80c7054c31SNeil Armstrong 	if (fsa->mode < TYPEC_STATE_MODAL ||
81c7054c31SNeil Armstrong 	    (!fsa->svid && (fsa->mode == TYPEC_MODE_USB2 ||
82c7054c31SNeil Armstrong 			    fsa->mode == TYPEC_MODE_USB3))) {
83c7054c31SNeil Armstrong 		enable |= FSA4480_ENABLE_USB;
84c7054c31SNeil Armstrong 		sel = FSA4480_SEL_USB;
85c7054c31SNeil Armstrong 	} else if (fsa->svid) {
86c7054c31SNeil Armstrong 		switch (fsa->mode) {
87c7054c31SNeil Armstrong 		/* DP Only */
88c7054c31SNeil Armstrong 		case TYPEC_DP_STATE_C:
89c7054c31SNeil Armstrong 		case TYPEC_DP_STATE_E:
90c7054c31SNeil Armstrong 			enable |= FSA4480_ENABLE_SBU;
91c7054c31SNeil Armstrong 			if (reverse)
92c7054c31SNeil Armstrong 				sel = FSA4480_SEL_SBU_REVERSE;
93c7054c31SNeil Armstrong 			break;
941dc24632SBjorn Andersson 
95c7054c31SNeil Armstrong 		/* DP + USB */
96c7054c31SNeil Armstrong 		case TYPEC_DP_STATE_D:
97c7054c31SNeil Armstrong 		case TYPEC_DP_STATE_F:
98c7054c31SNeil Armstrong 			enable |= FSA4480_ENABLE_USB | FSA4480_ENABLE_SBU;
99c7054c31SNeil Armstrong 			sel = FSA4480_SEL_USB;
100c7054c31SNeil Armstrong 			if (reverse)
101c7054c31SNeil Armstrong 				sel |= FSA4480_SEL_SBU_REVERSE;
102c7054c31SNeil Armstrong 			break;
103c7054c31SNeil Armstrong 
104c7054c31SNeil Armstrong 		default:
105c7054c31SNeil Armstrong 			return -EOPNOTSUPP;
106c7054c31SNeil Armstrong 		}
107*ef1e29c6SNeil Armstrong 	} else if (fsa->mode == TYPEC_MODE_AUDIO) {
108*ef1e29c6SNeil Armstrong 		/* Audio Accessory Mode, setup to auto Jack Detection */
109*ef1e29c6SNeil Armstrong 		enable |= FSA4480_ENABLE_USB | FSA4480_ENABLE_AGND;
110c7054c31SNeil Armstrong 	} else
111c7054c31SNeil Armstrong 		return -EOPNOTSUPP;
1121dc24632SBjorn Andersson 
1131dc24632SBjorn Andersson 	if (fsa->cur_enable & FSA4480_ENABLE_SBU) {
1141dc24632SBjorn Andersson 		/* Disable SBU output while re-configuring the switch */
1151dc24632SBjorn Andersson 		regmap_write(fsa->regmap, FSA4480_SWITCH_ENABLE,
1161dc24632SBjorn Andersson 			     fsa->cur_enable & ~FSA4480_ENABLE_SBU);
1171dc24632SBjorn Andersson 
1181dc24632SBjorn Andersson 		/* 35us to allow the SBU switch to turn off */
1191dc24632SBjorn Andersson 		usleep_range(35, 1000);
1201dc24632SBjorn Andersson 	}
1211dc24632SBjorn Andersson 
122c7054c31SNeil Armstrong 	regmap_write(fsa->regmap, FSA4480_SWITCH_SELECT, sel);
123c7054c31SNeil Armstrong 	regmap_write(fsa->regmap, FSA4480_SWITCH_ENABLE, enable);
1241dc24632SBjorn Andersson 
125*ef1e29c6SNeil Armstrong 	/* Start AUDIO JACK DETECTION to setup MIC, AGND & Sense muxes */
126*ef1e29c6SNeil Armstrong 	if (enable & FSA4480_ENABLE_AGND)
127*ef1e29c6SNeil Armstrong 		regmap_write(fsa->regmap, FSA4480_FUNCTION_ENABLE,
128*ef1e29c6SNeil Armstrong 			     FSA4480_ENABLE_AUTO_JACK_DETECT);
129*ef1e29c6SNeil Armstrong 
130c7054c31SNeil Armstrong 	if (enable & FSA4480_ENABLE_SBU) {
1311dc24632SBjorn Andersson 		/* 15us to allow the SBU switch to turn on again */
1321dc24632SBjorn Andersson 		usleep_range(15, 1000);
1331dc24632SBjorn Andersson 	}
1341dc24632SBjorn Andersson 
135c7054c31SNeil Armstrong 	fsa->cur_enable = enable;
1361dc24632SBjorn Andersson 
1371dc24632SBjorn Andersson 	return 0;
1381dc24632SBjorn Andersson }
1391dc24632SBjorn Andersson 
fsa4480_switch_set(struct typec_switch_dev * sw,enum typec_orientation orientation)140c7054c31SNeil Armstrong static int fsa4480_switch_set(struct typec_switch_dev *sw,
141c7054c31SNeil Armstrong 			      enum typec_orientation orientation)
142c7054c31SNeil Armstrong {
143c7054c31SNeil Armstrong 	struct fsa4480 *fsa = typec_switch_get_drvdata(sw);
144c7054c31SNeil Armstrong 	int ret = 0;
145c7054c31SNeil Armstrong 
146c7054c31SNeil Armstrong 	mutex_lock(&fsa->lock);
147c7054c31SNeil Armstrong 
148c7054c31SNeil Armstrong 	if (fsa->orientation != orientation) {
149c7054c31SNeil Armstrong 		fsa->orientation = orientation;
150c7054c31SNeil Armstrong 
151c7054c31SNeil Armstrong 		ret = fsa4480_set(fsa);
152c7054c31SNeil Armstrong 	}
153c7054c31SNeil Armstrong 
154c7054c31SNeil Armstrong 	mutex_unlock(&fsa->lock);
155c7054c31SNeil Armstrong 
156c7054c31SNeil Armstrong 	return ret;
157c7054c31SNeil Armstrong }
158c7054c31SNeil Armstrong 
fsa4480_mux_set(struct typec_mux_dev * mux,struct typec_mux_state * state)1591dc24632SBjorn Andersson static int fsa4480_mux_set(struct typec_mux_dev *mux, struct typec_mux_state *state)
1601dc24632SBjorn Andersson {
1611dc24632SBjorn Andersson 	struct fsa4480 *fsa = typec_mux_get_drvdata(mux);
162c7054c31SNeil Armstrong 	int ret = 0;
1631dc24632SBjorn Andersson 
1641dc24632SBjorn Andersson 	mutex_lock(&fsa->lock);
1651dc24632SBjorn Andersson 
166c7054c31SNeil Armstrong 	if (fsa->mode != state->mode) {
167c7054c31SNeil Armstrong 		fsa->mode = state->mode;
1681dc24632SBjorn Andersson 
169c7054c31SNeil Armstrong 		if (state->alt)
170c7054c31SNeil Armstrong 			fsa->svid = state->alt->svid;
171c7054c31SNeil Armstrong 		else
172c7054c31SNeil Armstrong 			fsa->svid = 0; // No SVID
1731dc24632SBjorn Andersson 
174c7054c31SNeil Armstrong 		ret = fsa4480_set(fsa);
1751dc24632SBjorn Andersson 	}
1761dc24632SBjorn Andersson 
1771dc24632SBjorn Andersson 	mutex_unlock(&fsa->lock);
1781dc24632SBjorn Andersson 
179c7054c31SNeil Armstrong 	return ret;
1801dc24632SBjorn Andersson }
1811dc24632SBjorn Andersson 
fsa4480_probe(struct i2c_client * client)1821dc24632SBjorn Andersson static int fsa4480_probe(struct i2c_client *client)
1831dc24632SBjorn Andersson {
1841dc24632SBjorn Andersson 	struct device *dev = &client->dev;
1851dc24632SBjorn Andersson 	struct typec_switch_desc sw_desc = { };
1861dc24632SBjorn Andersson 	struct typec_mux_desc mux_desc = { };
1871dc24632SBjorn Andersson 	struct fsa4480 *fsa;
1881dc24632SBjorn Andersson 
1891dc24632SBjorn Andersson 	fsa = devm_kzalloc(dev, sizeof(*fsa), GFP_KERNEL);
1901dc24632SBjorn Andersson 	if (!fsa)
1911dc24632SBjorn Andersson 		return -ENOMEM;
1921dc24632SBjorn Andersson 
1931dc24632SBjorn Andersson 	fsa->client = client;
1941dc24632SBjorn Andersson 	mutex_init(&fsa->lock);
1951dc24632SBjorn Andersson 
1961dc24632SBjorn Andersson 	fsa->regmap = devm_regmap_init_i2c(client, &fsa4480_regmap_config);
1971dc24632SBjorn Andersson 	if (IS_ERR(fsa->regmap))
1981dc24632SBjorn Andersson 		return dev_err_probe(dev, PTR_ERR(fsa->regmap), "failed to initialize regmap\n");
1991dc24632SBjorn Andersson 
200c7054c31SNeil Armstrong 	/* Safe mode */
2011dc24632SBjorn Andersson 	fsa->cur_enable = FSA4480_ENABLE_DEVICE | FSA4480_ENABLE_USB;
202c7054c31SNeil Armstrong 	fsa->mode = TYPEC_STATE_SAFE;
203c7054c31SNeil Armstrong 	fsa->orientation = TYPEC_ORIENTATION_NONE;
2041dc24632SBjorn Andersson 
2051dc24632SBjorn Andersson 	/* set default settings */
2061dc24632SBjorn Andersson 	regmap_write(fsa->regmap, FSA4480_SLOW_L, 0x00);
2071dc24632SBjorn Andersson 	regmap_write(fsa->regmap, FSA4480_SLOW_R, 0x00);
2081dc24632SBjorn Andersson 	regmap_write(fsa->regmap, FSA4480_SLOW_MIC, 0x00);
2091dc24632SBjorn Andersson 	regmap_write(fsa->regmap, FSA4480_SLOW_SENSE, 0x00);
2101dc24632SBjorn Andersson 	regmap_write(fsa->regmap, FSA4480_SLOW_GND, 0x00);
2111dc24632SBjorn Andersson 	regmap_write(fsa->regmap, FSA4480_DELAY_L_R, 0x00);
2121dc24632SBjorn Andersson 	regmap_write(fsa->regmap, FSA4480_DELAY_L_MIC, 0x00);
2131dc24632SBjorn Andersson 	regmap_write(fsa->regmap, FSA4480_DELAY_L_SENSE, 0x00);
2141dc24632SBjorn Andersson 	regmap_write(fsa->regmap, FSA4480_DELAY_L_AGND, 0x09);
215c7054c31SNeil Armstrong 	regmap_write(fsa->regmap, FSA4480_SWITCH_SELECT, FSA4480_SEL_USB);
2161dc24632SBjorn Andersson 	regmap_write(fsa->regmap, FSA4480_SWITCH_ENABLE, fsa->cur_enable);
2171dc24632SBjorn Andersson 
2181dc24632SBjorn Andersson 	sw_desc.drvdata = fsa;
2191dc24632SBjorn Andersson 	sw_desc.fwnode = dev_fwnode(dev);
2201dc24632SBjorn Andersson 	sw_desc.set = fsa4480_switch_set;
2211dc24632SBjorn Andersson 
2221dc24632SBjorn Andersson 	fsa->sw = typec_switch_register(dev, &sw_desc);
2231dc24632SBjorn Andersson 	if (IS_ERR(fsa->sw))
2241dc24632SBjorn Andersson 		return dev_err_probe(dev, PTR_ERR(fsa->sw), "failed to register typec switch\n");
2251dc24632SBjorn Andersson 
2261dc24632SBjorn Andersson 	mux_desc.drvdata = fsa;
2271dc24632SBjorn Andersson 	mux_desc.fwnode = dev_fwnode(dev);
2281dc24632SBjorn Andersson 	mux_desc.set = fsa4480_mux_set;
2291dc24632SBjorn Andersson 
2301dc24632SBjorn Andersson 	fsa->mux = typec_mux_register(dev, &mux_desc);
2311dc24632SBjorn Andersson 	if (IS_ERR(fsa->mux)) {
2321dc24632SBjorn Andersson 		typec_switch_unregister(fsa->sw);
2331dc24632SBjorn Andersson 		return dev_err_probe(dev, PTR_ERR(fsa->mux), "failed to register typec mux\n");
2341dc24632SBjorn Andersson 	}
2351dc24632SBjorn Andersson 
2361dc24632SBjorn Andersson 	i2c_set_clientdata(client, fsa);
2371dc24632SBjorn Andersson 	return 0;
2381dc24632SBjorn Andersson }
2391dc24632SBjorn Andersson 
fsa4480_remove(struct i2c_client * client)240ed5c2f5fSUwe Kleine-König static void fsa4480_remove(struct i2c_client *client)
2411dc24632SBjorn Andersson {
2421dc24632SBjorn Andersson 	struct fsa4480 *fsa = i2c_get_clientdata(client);
2431dc24632SBjorn Andersson 
2441dc24632SBjorn Andersson 	typec_mux_unregister(fsa->mux);
2451dc24632SBjorn Andersson 	typec_switch_unregister(fsa->sw);
2461dc24632SBjorn Andersson }
2471dc24632SBjorn Andersson 
2481dc24632SBjorn Andersson static const struct i2c_device_id fsa4480_table[] = {
2491dc24632SBjorn Andersson 	{ "fsa4480" },
2501dc24632SBjorn Andersson 	{ }
2511dc24632SBjorn Andersson };
2521dc24632SBjorn Andersson MODULE_DEVICE_TABLE(i2c, fsa4480_table);
2531dc24632SBjorn Andersson 
2541dc24632SBjorn Andersson static const struct of_device_id fsa4480_of_table[] = {
2551dc24632SBjorn Andersson 	{ .compatible = "fcs,fsa4480" },
2561dc24632SBjorn Andersson 	{ }
2571dc24632SBjorn Andersson };
2581dc24632SBjorn Andersson MODULE_DEVICE_TABLE(of, fsa4480_of_table);
2591dc24632SBjorn Andersson 
2601dc24632SBjorn Andersson static struct i2c_driver fsa4480_driver = {
2611dc24632SBjorn Andersson 	.driver = {
2621dc24632SBjorn Andersson 		.name = "fsa4480",
2631dc24632SBjorn Andersson 		.of_match_table = fsa4480_of_table,
2641dc24632SBjorn Andersson 	},
2657126a2aeSUwe Kleine-König 	.probe		= fsa4480_probe,
2661dc24632SBjorn Andersson 	.remove		= fsa4480_remove,
2671dc24632SBjorn Andersson 	.id_table	= fsa4480_table,
2681dc24632SBjorn Andersson };
2691dc24632SBjorn Andersson module_i2c_driver(fsa4480_driver);
2701dc24632SBjorn Andersson 
2711dc24632SBjorn Andersson MODULE_DESCRIPTION("ON Semiconductor FSA4480 driver");
2721dc24632SBjorn Andersson MODULE_LICENSE("GPL v2");
273