1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (C) 2018, STMicroelectronics - All Rights Reserved
5 * Driver for STMicroelectronics Multi-Function eXpander (STMFX) GPIO expander
6 * based on Linux driver : pinctrl/pinctrl-stmfx.c
12 #include <dm/device.h>
13 #include <dm/device-internal.h>
14 #include <dm/device_compat.h>
16 #include <dm/pinctrl.h>
17 #include <linux/bitfield.h>
18 #include <linux/bitops.h>
19 #include <linux/delay.h>
20 #include <power/regulator.h>
22 /* STMFX pins = GPIO[15:0] + aGPIO[7:0] */
23 #define STMFX_MAX_GPIO 16
24 #define STMFX_MAX_AGPIO 8
27 #define STMFX_REG_CHIP_ID 0x00 /* R */
28 #define STMFX_REG_FW_VERSION_MSB 0x01 /* R */
29 #define STMFX_REG_FW_VERSION_LSB 0x02 /* R */
30 #define STMFX_REG_SYS_CTRL 0x40 /* RW */
32 /* MFX boot time is around 10ms, so after reset, we have to wait this delay */
33 #define STMFX_BOOT_TIME_MS 10
36 /* GPIO_STATE1 0x10, GPIO_STATE2 0x11, GPIO_STATE3 0x12 */
37 #define STMFX_REG_GPIO_STATE 0x10 /* R */
38 /* GPIO_DIR1 0x60, GPIO_DIR2 0x61, GPIO_DIR3 0x63 */
39 #define STMFX_REG_GPIO_DIR 0x60 /* RW */
40 /* GPIO_TYPE1 0x64, GPIO_TYPE2 0x65, GPIO_TYPE3 0x66 */
41 #define STMFX_REG_GPIO_TYPE 0x64 /* RW */
42 /* GPIO_PUPD1 0x68, GPIO_PUPD2 0x69, GPIO_PUPD3 0x6A */
43 #define STMFX_REG_GPIO_PUPD 0x68 /* RW */
44 /* GPO_SET1 0x6C, GPO_SET2 0x6D, GPO_SET3 0x6E */
45 #define STMFX_REG_GPO_SET 0x6C /* RW */
46 /* GPO_CLR1 0x70, GPO_CLR2 0x71, GPO_CLR3 0x72 */
47 #define STMFX_REG_GPO_CLR 0x70 /* RW */
49 /* STMFX_REG_CHIP_ID bitfields */
50 #define STMFX_REG_CHIP_ID_MASK GENMASK(7, 0)
52 /* STMFX_REG_SYS_CTRL bitfields */
53 #define STMFX_REG_SYS_CTRL_GPIO_EN BIT(0)
54 #define STMFX_REG_SYS_CTRL_ALTGPIO_EN BIT(3)
55 #define STMFX_REG_SYS_CTRL_SWRST BIT(7)
57 #define NR_GPIO_REGS 3
58 #define NR_GPIOS_PER_REG 8
59 #define get_reg(offset) ((offset) / NR_GPIOS_PER_REG)
60 #define get_shift(offset) ((offset) % NR_GPIOS_PER_REG)
61 #define get_mask(offset) (BIT(get_shift(offset)))
63 struct stmfx_pinctrl {
67 static int stmfx_read(struct udevice *dev, uint offset)
69 return dm_i2c_reg_read(dev_get_parent(dev), offset);
72 static int stmfx_write(struct udevice *dev, uint offset, unsigned int val)
74 return dm_i2c_reg_write(dev_get_parent(dev), offset, val);
77 static int stmfx_gpio_get(struct udevice *dev, unsigned int offset)
79 u32 reg = STMFX_REG_GPIO_STATE + get_reg(offset);
80 u32 mask = get_mask(offset);
83 ret = stmfx_read(dev, reg);
85 return ret < 0 ? ret : !!(ret & mask);
88 static int stmfx_gpio_set(struct udevice *dev, unsigned int offset, int value)
90 u32 reg = value ? STMFX_REG_GPO_SET : STMFX_REG_GPO_CLR;
91 u32 mask = get_mask(offset);
93 return stmfx_write(dev, reg + get_reg(offset), mask);
96 static int stmfx_gpio_get_function(struct udevice *dev, unsigned int offset)
98 u32 reg = STMFX_REG_GPIO_DIR + get_reg(offset);
99 u32 mask = get_mask(offset);
102 ret = stmfx_read(dev, reg);
106 /* On stmfx, gpio pins direction is (0)input, (1)output. */
108 return ret & mask ? GPIOF_OUTPUT : GPIOF_INPUT;
111 static int stmfx_gpio_direction_input(struct udevice *dev, unsigned int offset)
113 u32 reg = STMFX_REG_GPIO_DIR + get_reg(offset);
114 u32 mask = get_mask(offset);
117 ret = stmfx_read(dev, reg);
123 return stmfx_write(dev, reg, ret & ~mask);
126 static int stmfx_gpio_direction_output(struct udevice *dev,
127 unsigned int offset, int value)
129 u32 reg = STMFX_REG_GPIO_DIR + get_reg(offset);
130 u32 mask = get_mask(offset);
133 ret = stmfx_gpio_set(dev, offset, value);
137 ret = stmfx_read(dev, reg);
141 return stmfx_write(dev, reg, ret | mask);
144 static int stmfx_gpio_probe(struct udevice *dev)
146 struct gpio_dev_priv *uc_priv = dev_get_uclass_priv(dev);
147 struct ofnode_phandle_args args;
150 uc_priv->bank_name = "stmfx";
151 uc_priv->gpio_count = STMFX_MAX_GPIO + STMFX_MAX_AGPIO;
152 if (!dev_read_phandle_with_args(dev, "gpio-ranges",
153 NULL, 3, 0, &args)) {
154 uc_priv->gpio_count = args.args[2];
157 /* enable GPIO function */
158 sys_ctrl = STMFX_REG_SYS_CTRL_GPIO_EN;
159 if (uc_priv->gpio_count > STMFX_MAX_GPIO)
160 sys_ctrl |= STMFX_REG_SYS_CTRL_ALTGPIO_EN;
161 stmfx_write(dev, STMFX_REG_SYS_CTRL, sys_ctrl);
166 static const struct dm_gpio_ops stmfx_gpio_ops = {
167 .set_value = stmfx_gpio_set,
168 .get_value = stmfx_gpio_get,
169 .get_function = stmfx_gpio_get_function,
170 .direction_input = stmfx_gpio_direction_input,
171 .direction_output = stmfx_gpio_direction_output,
174 U_BOOT_DRIVER(stmfx_gpio) = {
175 .name = "stmfx-gpio",
177 .probe = stmfx_gpio_probe,
178 .ops = &stmfx_gpio_ops,
181 #if CONFIG_IS_ENABLED(PINCONF)
182 static const struct pinconf_param stmfx_pinctrl_conf_params[] = {
183 { "bias-disable", PIN_CONFIG_BIAS_DISABLE, 0 },
184 { "bias-pull-up", PIN_CONFIG_BIAS_PULL_UP, 0 },
185 { "bias-pull-pin-default", PIN_CONFIG_BIAS_PULL_PIN_DEFAULT, 0 },
186 { "bias-pull-down", PIN_CONFIG_BIAS_PULL_DOWN, 0 },
187 { "drive-open-drain", PIN_CONFIG_DRIVE_OPEN_DRAIN, 0 },
188 { "drive-push-pull", PIN_CONFIG_DRIVE_PUSH_PULL, 0 },
189 { "output-high", PIN_CONFIG_OUTPUT, 1 },
190 { "output-low", PIN_CONFIG_OUTPUT, 0 },
193 static int stmfx_pinctrl_set_pupd(struct udevice *dev,
194 unsigned int pin, u32 pupd)
196 u8 reg = STMFX_REG_GPIO_PUPD + get_reg(pin);
197 u32 mask = get_mask(pin);
200 ret = stmfx_read(dev, reg);
203 ret = (ret & ~mask) | (pupd ? mask : 0);
205 return stmfx_write(dev, reg, ret);
208 static int stmfx_pinctrl_set_type(struct udevice *dev,
209 unsigned int pin, u32 type)
211 u8 reg = STMFX_REG_GPIO_TYPE + get_reg(pin);
212 u32 mask = get_mask(pin);
215 ret = stmfx_read(dev, reg);
218 ret = (ret & ~mask) | (type ? mask : 0);
220 return stmfx_write(dev, reg, ret);
223 static int stmfx_pinctrl_conf_set(struct udevice *dev, unsigned int pin,
224 unsigned int param, unsigned int arg)
227 struct stmfx_pinctrl *plat = dev_get_platdata(dev);
229 dir = stmfx_gpio_get_function(plat->gpio, pin);
235 case PIN_CONFIG_BIAS_PULL_PIN_DEFAULT:
236 case PIN_CONFIG_BIAS_DISABLE:
237 case PIN_CONFIG_DRIVE_PUSH_PULL:
238 ret = stmfx_pinctrl_set_type(dev, pin, 0);
240 case PIN_CONFIG_BIAS_PULL_DOWN:
241 ret = stmfx_pinctrl_set_type(dev, pin, 1);
244 ret = stmfx_pinctrl_set_pupd(dev, pin, 0);
246 case PIN_CONFIG_BIAS_PULL_UP:
247 ret = stmfx_pinctrl_set_type(dev, pin, 1);
250 ret = stmfx_pinctrl_set_pupd(dev, pin, 1);
252 case PIN_CONFIG_DRIVE_OPEN_DRAIN:
253 ret = stmfx_pinctrl_set_type(dev, pin, 1);
255 case PIN_CONFIG_OUTPUT:
256 ret = stmfx_gpio_direction_output(plat->gpio, pin, arg);
266 static int stmfx_pinctrl_get_pins_count(struct udevice *dev)
268 struct stmfx_pinctrl *plat = dev_get_platdata(dev);
269 struct gpio_dev_priv *uc_priv;
271 uc_priv = dev_get_uclass_priv(plat->gpio);
273 return uc_priv->gpio_count;
277 * STMFX pins[15:0] are called "gpio[15:0]"
278 * and STMFX pins[23:16] are called "agpio[7:0]"
280 #define MAX_PIN_NAME_LEN 7
281 static char pin_name[MAX_PIN_NAME_LEN];
282 static const char *stmfx_pinctrl_get_pin_name(struct udevice *dev,
283 unsigned int selector)
285 if (selector < STMFX_MAX_GPIO)
286 snprintf(pin_name, MAX_PIN_NAME_LEN, "gpio%u", selector);
288 snprintf(pin_name, MAX_PIN_NAME_LEN, "agpio%u", selector - 16);
292 static int stmfx_pinctrl_get_pin_muxing(struct udevice *dev,
293 unsigned int selector,
296 struct stmfx_pinctrl *plat = dev_get_platdata(dev);
299 func = stmfx_gpio_get_function(plat->gpio, selector);
303 snprintf(buf, size, "%s", func == GPIOF_INPUT ? "input" : "output");
308 static int stmfx_pinctrl_bind(struct udevice *dev)
310 struct stmfx_pinctrl *plat = dev_get_platdata(dev);
312 return device_bind_driver_to_node(dev->parent,
313 "stmfx-gpio", "stmfx-gpio",
314 dev_ofnode(dev), &plat->gpio);
317 static int stmfx_pinctrl_probe(struct udevice *dev)
319 struct stmfx_pinctrl *plat = dev_get_platdata(dev);
321 return device_probe(plat->gpio);
324 const struct pinctrl_ops stmfx_pinctrl_ops = {
325 .get_pins_count = stmfx_pinctrl_get_pins_count,
326 .get_pin_name = stmfx_pinctrl_get_pin_name,
327 .set_state = pinctrl_generic_set_state,
328 .get_pin_muxing = stmfx_pinctrl_get_pin_muxing,
329 #if CONFIG_IS_ENABLED(PINCONF)
330 .pinconf_set = stmfx_pinctrl_conf_set,
331 .pinconf_num_params = ARRAY_SIZE(stmfx_pinctrl_conf_params),
332 .pinconf_params = stmfx_pinctrl_conf_params,
336 static const struct udevice_id stmfx_pinctrl_match[] = {
337 { .compatible = "st,stmfx-0300-pinctrl", },
340 U_BOOT_DRIVER(stmfx_pinctrl) = {
341 .name = "stmfx-pinctrl",
342 .id = UCLASS_PINCTRL,
343 .of_match = of_match_ptr(stmfx_pinctrl_match),
344 .bind = stmfx_pinctrl_bind,
345 .probe = stmfx_pinctrl_probe,
346 .ops = &stmfx_pinctrl_ops,
347 .platdata_auto_alloc_size = sizeof(struct stmfx_pinctrl),
350 static int stmfx_chip_init(struct udevice *dev)
355 struct dm_i2c_chip *chip = dev_get_parent_platdata(dev);
357 ret = dm_i2c_reg_read(dev, STMFX_REG_CHIP_ID);
359 dev_err(dev, "error reading chip id: %d\n", ret);
364 * Check that ID is the complement of the I2C address:
365 * STMFX I2C address follows the 7-bit format (MSB), that's why
366 * client->addr is shifted.
368 * STMFX_I2C_ADDR| STMFX | Linux
369 * input pin | I2C device address | I2C device address
370 *---------------------------------------------------------
371 * 0 | b: 1000 010x h:0x84 | 0x42
372 * 1 | b: 1000 011x h:0x86 | 0x43
374 if (FIELD_GET(STMFX_REG_CHIP_ID_MASK, ~id) != (chip->chip_addr << 1)) {
375 dev_err(dev, "unknown chip id: %#x\n", id);
379 ret = dm_i2c_read(dev, STMFX_REG_FW_VERSION_MSB,
380 version, sizeof(version));
382 dev_err(dev, "error reading fw version: %d\n", ret);
386 dev_info(dev, "STMFX id: %#x, fw version: %x.%02x\n",
387 id, version[0], version[1]);
389 ret = dm_i2c_reg_read(dev, STMFX_REG_SYS_CTRL);
394 ret = dm_i2c_reg_write(dev, STMFX_REG_SYS_CTRL,
395 ret | STMFX_REG_SYS_CTRL_SWRST);
399 mdelay(STMFX_BOOT_TIME_MS);
404 static int stmfx_probe(struct udevice *dev)
409 ret = device_get_supply_regulator(dev, "vdd-supply", &vdd);
410 if (ret && ret != -ENOENT) {
411 dev_err(dev, "vdd regulator error:%d\n", ret);
415 ret = regulator_set_enable(vdd, true);
417 dev_err(dev, "vdd enable failed: %d\n", ret);
422 return stmfx_chip_init(dev);
425 static const struct udevice_id stmfx_match[] = {
426 { .compatible = "st,stmfx-0300", },
429 U_BOOT_DRIVER(stmfx) = {
431 .id = UCLASS_I2C_GENERIC,
432 .of_match = of_match_ptr(stmfx_match),
433 .probe = stmfx_probe,
434 .bind = dm_scan_fdt_dev,