[J-u-boot.git] / drivers / gpio / pca953x.c

// SPDX-License-Identifier: GPL-2.0
/*
 * Copyright 2008 Extreme Engineering Solutions, Inc.
 */

/*
 * Driver for NXP's 4, 8 and 16 bit I2C gpio expanders (eg pca9537, pca9557,
 * pca9539, etc)
 */

#include <common.h>
#include <command.h>
#include <i2c.h>
#include <pca953x.h>

/* Default to an address that hopefully won't corrupt other i2c devices */
#ifndef CONFIG_SYS_I2C_PCA953X_ADDR
#define CONFIG_SYS_I2C_PCA953X_ADDR	(~0)
#endif

enum {
	PCA953X_CMD_INFO,
	PCA953X_CMD_DEVICE,
	PCA953X_CMD_OUTPUT,
	PCA953X_CMD_INPUT,
	PCA953X_CMD_INVERT,
};

#ifdef CONFIG_SYS_I2C_PCA953X_WIDTH
struct pca953x_chip_ngpio {
	uint8_t chip;
	uint8_t ngpio;
};

static struct pca953x_chip_ngpio pca953x_chip_ngpios[] =
    CONFIG_SYS_I2C_PCA953X_WIDTH;

/*
 * Determine the number of GPIO pins supported. If we don't know we assume
 * 8 pins.
 */
static int pca953x_ngpio(uint8_t chip)
{
	int i;

	for (i = 0; i < ARRAY_SIZE(pca953x_chip_ngpios); i++)
		if (pca953x_chip_ngpios[i].chip == chip)
			return pca953x_chip_ngpios[i].ngpio;

	return 8;
}
#else
static int pca953x_ngpio(uint8_t chip)
{
	return 8;
}
#endif

/*
 * Modify masked bits in register
 */
static int pca953x_reg_write(uint8_t chip, uint addr, uint mask, uint data)
{
	uint8_t valb;
	uint16_t valw;

	if (pca953x_ngpio(chip) <= 8) {
		if (i2c_read(chip, addr, 1, &valb, 1))
			return -1;

		valb &= ~mask;
		valb |= data;

		return i2c_write(chip, addr, 1, &valb, 1);
	} else {
		if (i2c_read(chip, addr << 1, 1, (u8*)&valw, 2))
			return -1;

		valw = le16_to_cpu(valw);
		valw &= ~mask;
		valw |= data;
		valw = cpu_to_le16(valw);

		return i2c_write(chip, addr << 1, 1, (u8*)&valw, 2);
	}
}

static int pca953x_reg_read(uint8_t chip, uint addr, uint *data)
{
	uint8_t valb;
	uint16_t valw;

	if (pca953x_ngpio(chip) <= 8) {
		if (i2c_read(chip, addr, 1, &valb, 1))
			return -1;
		*data = (int)valb;
	} else {
		if (i2c_read(chip, addr << 1, 1, (u8*)&valw, 2))
			return -1;
		*data = (uint)le16_to_cpu(valw);
	}
	return 0;
}

/*
 * Set output value of IO pins in 'mask' to corresponding value in 'data'
 * 0 = low, 1 = high
 */
int pca953x_set_val(uint8_t chip, uint mask, uint data)
{
	return pca953x_reg_write(chip, PCA953X_OUT, mask, data);
}

/*
 * Set read polarity of IO pins in 'mask' to corresponding value in 'data'
 * 0 = read pin value, 1 = read inverted pin value
 */
int pca953x_set_pol(uint8_t chip, uint mask, uint data)
{
	return pca953x_reg_write(chip, PCA953X_POL, mask, data);
}

/*
 * Set direction of IO pins in 'mask' to corresponding value in 'data'
 * 0 = output, 1 = input
 */
int pca953x_set_dir(uint8_t chip, uint mask, uint data)
{
	return pca953x_reg_write(chip, PCA953X_CONF, mask, data);
}

/*
 * Read current logic level of all IO pins
 */
int pca953x_get_val(uint8_t chip)
{
	uint val;

	if (pca953x_reg_read(chip, PCA953X_IN, &val) < 0)
		return -1;

	return (int)val;
}

#if defined(CONFIG_CMD_PCA953X) && !defined(CONFIG_SPL_BUILD)
/*
 * Display pca953x information
 */
static int pca953x_info(uint8_t chip)
{
	int i;
	uint data;
	int nr_gpio = pca953x_ngpio(chip);
	int msb = nr_gpio - 1;

	printf("pca953x@ 0x%x (%d pins):\n\n", chip, nr_gpio);
	printf("gpio pins: ");
	for (i = msb; i >= 0; i--)
		printf("%x", i);
	printf("\n");
	for (i = 11 + nr_gpio; i > 0; i--)
		printf("-");
	printf("\n");

	if (pca953x_reg_read(chip, PCA953X_CONF, &data) < 0)
		return -1;
	printf("conf:      ");
	for (i = msb; i >= 0; i--)
		printf("%c", data & (1 << i) ? 'i' : 'o');
	printf("\n");

	if (pca953x_reg_read(chip, PCA953X_POL, &data) < 0)
		return -1;
	printf("invert:    ");
	for (i = msb; i >= 0; i--)
		printf("%c", data & (1 << i) ? '1' : '0');
	printf("\n");

	if (pca953x_reg_read(chip, PCA953X_IN, &data) < 0)
		return -1;
	printf("input:     ");
	for (i = msb; i >= 0; i--)
		printf("%c", data & (1 << i) ? '1' : '0');
	printf("\n");

	if (pca953x_reg_read(chip, PCA953X_OUT, &data) < 0)
		return -1;
	printf("output:    ");
	for (i = msb; i >= 0; i--)
		printf("%c", data & (1 << i) ? '1' : '0');
	printf("\n");

	return 0;
}

static struct cmd_tbl cmd_pca953x[] = {
	U_BOOT_CMD_MKENT(device, 3, 0, (void *)PCA953X_CMD_DEVICE, "", ""),
	U_BOOT_CMD_MKENT(output, 4, 0, (void *)PCA953X_CMD_OUTPUT, "", ""),
	U_BOOT_CMD_MKENT(input, 3, 0, (void *)PCA953X_CMD_INPUT, "", ""),
	U_BOOT_CMD_MKENT(invert, 4, 0, (void *)PCA953X_CMD_INVERT, "", ""),
	U_BOOT_CMD_MKENT(info, 2, 0, (void *)PCA953X_CMD_INFO, "", ""),
};

static int do_pca953x(struct cmd_tbl *cmdtp, int flag, int argc,
		      char *const argv[])
{
	static uint8_t chip = CONFIG_SYS_I2C_PCA953X_ADDR;
	int ret = CMD_RET_USAGE, val;
	ulong ul_arg2 = 0;
	ulong ul_arg3 = 0;
	struct cmd_tbl *c;

	c = find_cmd_tbl(argv[1], cmd_pca953x, ARRAY_SIZE(cmd_pca953x));

	/* All commands but "device" require 'maxargs' arguments */
	if (!c || !((argc == (c->maxargs)) ||
		(((long)c->cmd == PCA953X_CMD_DEVICE) &&
		 (argc == (c->maxargs - 1))))) {
		return CMD_RET_USAGE;
	}

	/* arg2 used as chip number or pin number */
	if (argc > 2)
		ul_arg2 = hextoul(argv[2], NULL);

	/* arg3 used as pin or invert value */
	if (argc > 3)
		ul_arg3 = hextoul(argv[3], NULL) & 0x1;

	switch ((long)c->cmd) {
	case PCA953X_CMD_INFO:
		ret = pca953x_info(chip);
		if (ret)
			ret = CMD_RET_FAILURE;
		break;

	case PCA953X_CMD_DEVICE:
		if (argc == 3)
			chip = (uint8_t)ul_arg2;
		printf("Current device address: 0x%x\n", chip);
		ret = CMD_RET_SUCCESS;
		break;

	case PCA953X_CMD_INPUT:
		ret = pca953x_set_dir(chip, (1 << ul_arg2),
				PCA953X_DIR_IN << ul_arg2);
		val = (pca953x_get_val(chip) & (1 << ul_arg2)) != 0;

		if (ret)
			ret = CMD_RET_FAILURE;
		else
			printf("chip 0x%02x, pin 0x%lx = %d\n", chip, ul_arg2,
									val);
		break;

	case PCA953X_CMD_OUTPUT:
		ret = pca953x_set_dir(chip, (1 << ul_arg2),
				(PCA953X_DIR_OUT << ul_arg2));
		if (!ret)
			ret = pca953x_set_val(chip, (1 << ul_arg2),
						(ul_arg3 << ul_arg2));
		if (ret)
			ret = CMD_RET_FAILURE;
		break;

	case PCA953X_CMD_INVERT:
		ret = pca953x_set_pol(chip, (1 << ul_arg2),
					(ul_arg3 << ul_arg2));
		if (ret)
			ret = CMD_RET_FAILURE;
		break;
	}

	if (ret == CMD_RET_FAILURE)
		eprintf("Error talking to chip at 0x%x\n", chip);

	return ret;
}

U_BOOT_CMD(
	pca953x,	5,	1,	do_pca953x,
	"pca953x gpio access",
	"device [dev]\n"
	"	- show or set current device address\n"
	"pca953x info\n"
	"	- display info for current chip\n"
	"pca953x output pin 0|1\n"
	"	- set pin as output and drive low or high\n"
	"pca953x invert pin 0|1\n"
	"	- disable/enable polarity inversion for reads\n"
	"pca953x input pin\n"
	"	- set pin as input and read value"
);

#endif /* CONFIG_CMD_PCA953X */
Commit	Line	Data
83d290c5	1	// SPDX-License-Identifier: GPL-2.0
e92739d3 PT	2	/*
e92739d3 PT	3	* Copyright 2008 Extreme Engineering Solutions, Inc.
e92739d3 PT	4	*/
	5
	6	/*
5dec49ca CP	7	* Driver for NXP's 4, 8 and 16 bit I2C gpio expanders (eg pca9537, pca9557,
5dec49ca CP	8	* pca9539, etc)
e92739d3 PT	9	*/
	10
	11	#include <common.h>
09140113	12	#include <command.h>
e92739d3 PT	13	#include <i2c.h>
	14	#include <pca953x.h>
	15
	16	/* Default to an address that hopefully won't corrupt other i2c devices */
	17	#ifndef CONFIG_SYS_I2C_PCA953X_ADDR
	18	#define CONFIG_SYS_I2C_PCA953X_ADDR (~0)
	19	#endif
	20
	21	enum {
	22	PCA953X_CMD_INFO,
	23	PCA953X_CMD_DEVICE,
	24	PCA953X_CMD_OUTPUT,
	25	PCA953X_CMD_INPUT,
	26	PCA953X_CMD_INVERT,
	27	};
	28
5dec49ca CP	29	#ifdef CONFIG_SYS_I2C_PCA953X_WIDTH
	30	struct pca953x_chip_ngpio {
	31	uint8_t chip;
	32	uint8_t ngpio;
	33	};
	34
	35	static struct pca953x_chip_ngpio pca953x_chip_ngpios[] =
	36	CONFIG_SYS_I2C_PCA953X_WIDTH;
	37
5dec49ca CP	38	/*
	39	* Determine the number of GPIO pins supported. If we don't know we assume
	40	* 8 pins.
	41	*/
	42	static int pca953x_ngpio(uint8_t chip)
	43	{
	44	int i;
	45
f2187617	46	for (i = 0; i < ARRAY_SIZE(pca953x_chip_ngpios); i++)
5dec49ca CP	47	if (pca953x_chip_ngpios[i].chip == chip)
	48	return pca953x_chip_ngpios[i].ngpio;
	49
	50	return 8;
	51	}
	52	#else
	53	static int pca953x_ngpio(uint8_t chip)
	54	{
	55	return 8;
	56	}
	57	#endif
	58
e92739d3 PT	59	/*
	60	* Modify masked bits in register
	61	*/
	62	static int pca953x_reg_write(uint8_t chip, uint addr, uint mask, uint data)
	63	{
5dec49ca CP	64	uint8_t valb;
5dec49ca CP	65	uint16_t valw;
e92739d3	66
5dec49ca CP	67	if (pca953x_ngpio(chip) <= 8) {
	68	if (i2c_read(chip, addr, 1, &valb, 1))
	69	return -1;
	70
	71	valb &= ~mask;
	72	valb \|= data;
	73
	74	return i2c_write(chip, addr, 1, &valb, 1);
	75	} else {
	76	if (i2c_read(chip, addr << 1, 1, (u8*)&valw, 2))
	77	return -1;
	78
daa75b34	79	valw = le16_to_cpu(valw);
5dec49ca CP	80	valw &= ~mask;
5dec49ca CP	81	valw \|= data;
daa75b34	82	valw = cpu_to_le16(valw);
e92739d3	83
5dec49ca CP	84	return i2c_write(chip, addr << 1, 1, (u8*)&valw, 2);
	85	}
	86	}
e92739d3	87
5dec49ca CP	88	static int pca953x_reg_read(uint8_t chip, uint addr, uint *data)
	89	{
	90	uint8_t valb;
	91	uint16_t valw;
	92
	93	if (pca953x_ngpio(chip) <= 8) {
	94	if (i2c_read(chip, addr, 1, &valb, 1))
	95	return -1;
	96	*data = (int)valb;
	97	} else {
	98	if (i2c_read(chip, addr << 1, 1, (u8*)&valw, 2))
	99	return -1;
daa75b34	100	*data = (uint)le16_to_cpu(valw);
5dec49ca CP	101	}
5dec49ca CP	102	return 0;
e92739d3 PT	103	}
	104
	105	/*
	106	* Set output value of IO pins in 'mask' to corresponding value in 'data'
	107	* 0 = low, 1 = high
	108	*/
	109	int pca953x_set_val(uint8_t chip, uint mask, uint data)
	110	{
	111	return pca953x_reg_write(chip, PCA953X_OUT, mask, data);
	112	}
	113
	114	/*
	115	* Set read polarity of IO pins in 'mask' to corresponding value in 'data'
	116	* 0 = read pin value, 1 = read inverted pin value
	117	*/
	118	int pca953x_set_pol(uint8_t chip, uint mask, uint data)
	119	{
	120	return pca953x_reg_write(chip, PCA953X_POL, mask, data);
	121	}
	122
	123	/*
	124	* Set direction of IO pins in 'mask' to corresponding value in 'data'
	125	* 0 = output, 1 = input
	126	*/
	127	int pca953x_set_dir(uint8_t chip, uint mask, uint data)
	128	{
	129	return pca953x_reg_write(chip, PCA953X_CONF, mask, data);
	130	}
	131
	132	/*
	133	* Read current logic level of all IO pins
	134	*/
	135	int pca953x_get_val(uint8_t chip)
	136	{
5dec49ca	137	uint val;
e92739d3	138
5dec49ca	139	if (pca953x_reg_read(chip, PCA953X_IN, &val) < 0)
e92739d3 PT	140	return -1;
	141
	142	return (int)val;
	143	}
	144
0d097b77	145	#if defined(CONFIG_CMD_PCA953X) && !defined(CONFIG_SPL_BUILD)
e92739d3 PT	146	/*
	147	* Display pca953x information
	148	*/
	149	static int pca953x_info(uint8_t chip)
	150	{
	151	int i;
5dec49ca CP	152	uint data;
	153	int nr_gpio = pca953x_ngpio(chip);
	154	int msb = nr_gpio - 1;
	155
	156	printf("pca953x@ 0x%x (%d pins):\n\n", chip, nr_gpio);
	157	printf("gpio pins: ");
	158	for (i = msb; i >= 0; i--)
	159	printf("%x", i);
	160	printf("\n");
	161	for (i = 11 + nr_gpio; i > 0; i--)
	162	printf("-");
	163	printf("\n");
e92739d3	164
5dec49ca	165	if (pca953x_reg_read(chip, PCA953X_CONF, &data) < 0)
e92739d3 PT	166	return -1;
e92739d3 PT	167	printf("conf: ");
5dec49ca	168	for (i = msb; i >= 0; i--)
e92739d3 PT	169	printf("%c", data & (1 << i) ? 'i' : 'o');
	170	printf("\n");
	171
5dec49ca	172	if (pca953x_reg_read(chip, PCA953X_POL, &data) < 0)
e92739d3 PT	173	return -1;
e92739d3 PT	174	printf("invert: ");
5dec49ca	175	for (i = msb; i >= 0; i--)
e92739d3 PT	176	printf("%c", data & (1 << i) ? '1' : '0');
	177	printf("\n");
	178
5dec49ca	179	if (pca953x_reg_read(chip, PCA953X_IN, &data) < 0)
e92739d3 PT	180	return -1;
e92739d3 PT	181	printf("input: ");
5dec49ca	182	for (i = msb; i >= 0; i--)
e92739d3 PT	183	printf("%c", data & (1 << i) ? '1' : '0');
	184	printf("\n");
	185
5dec49ca	186	if (pca953x_reg_read(chip, PCA953X_OUT, &data) < 0)
e92739d3 PT	187	return -1;
e92739d3 PT	188	printf("output: ");
5dec49ca	189	for (i = msb; i >= 0; i--)
e92739d3 PT	190	printf("%c", data & (1 << i) ? '1' : '0');
	191	printf("\n");
	192
	193	return 0;
	194	}
e92739d3	195
09140113	196	static struct cmd_tbl cmd_pca953x[] = {
e92739d3 PT	197	U_BOOT_CMD_MKENT(device, 3, 0, (void *)PCA953X_CMD_DEVICE, "", ""),
	198	U_BOOT_CMD_MKENT(output, 4, 0, (void *)PCA953X_CMD_OUTPUT, "", ""),
	199	U_BOOT_CMD_MKENT(input, 3, 0, (void *)PCA953X_CMD_INPUT, "", ""),
	200	U_BOOT_CMD_MKENT(invert, 4, 0, (void *)PCA953X_CMD_INVERT, "", ""),
e92739d3	201	U_BOOT_CMD_MKENT(info, 2, 0, (void *)PCA953X_CMD_INFO, "", ""),
e92739d3 PT	202	};
e92739d3 PT	203
09140113 SG	204	static int do_pca953x(struct cmd_tbl *cmdtp, int flag, int argc,
09140113 SG	205	char *const argv[])
e92739d3 PT	206	{
e92739d3 PT	207	static uint8_t chip = CONFIG_SYS_I2C_PCA953X_ADDR;
633efe9c	208	int ret = CMD_RET_USAGE, val;
e92739d3 PT	209	ulong ul_arg2 = 0;
e92739d3 PT	210	ulong ul_arg3 = 0;
09140113	211	struct cmd_tbl *c;
e92739d3 PT	212
	213	c = find_cmd_tbl(argv[1], cmd_pca953x, ARRAY_SIZE(cmd_pca953x));
	214
	215	/* All commands but "device" require 'maxargs' arguments */
	216	if (!c \|\| !((argc == (c->maxargs)) \|\|
01b2a699	217	(((long)c->cmd == PCA953X_CMD_DEVICE) &&
e92739d3	218	(argc == (c->maxargs - 1))))) {
633efe9c	219	return CMD_RET_USAGE;
e92739d3 PT	220	}
	221
	222	/* arg2 used as chip number or pin number */
	223	if (argc > 2)
7e5f460e	224	ul_arg2 = hextoul(argv[2], NULL);
e92739d3 PT	225
	226	/* arg3 used as pin or invert value */
	227	if (argc > 3)
7e5f460e	228	ul_arg3 = hextoul(argv[3], NULL) & 0x1;
e92739d3	229
01b2a699	230	switch ((long)c->cmd) {
e92739d3	231	case PCA953X_CMD_INFO:
633efe9c LW	232	ret = pca953x_info(chip);
	233	if (ret)
	234	ret = CMD_RET_FAILURE;
	235	break;
633efe9c	236
e92739d3 PT	237	case PCA953X_CMD_DEVICE:
	238	if (argc == 3)
	239	chip = (uint8_t)ul_arg2;
	240	printf("Current device address: 0x%x\n", chip);
633efe9c LW	241	ret = CMD_RET_SUCCESS;
	242	break;
	243
e92739d3	244	case PCA953X_CMD_INPUT:
633efe9c	245	ret = pca953x_set_dir(chip, (1 << ul_arg2),
e92739d3 PT	246	PCA953X_DIR_IN << ul_arg2);
	247	val = (pca953x_get_val(chip) & (1 << ul_arg2)) != 0;
	248
633efe9c LW	249	if (ret)
	250	ret = CMD_RET_FAILURE;
	251	else
	252	printf("chip 0x%02x, pin 0x%lx = %d\n", chip, ul_arg2,
	253	val);
	254	break;
	255
e92739d3	256	case PCA953X_CMD_OUTPUT:
633efe9c	257	ret = pca953x_set_dir(chip, (1 << ul_arg2),
e92739d3	258	(PCA953X_DIR_OUT << ul_arg2));
633efe9c LW	259	if (!ret)
	260	ret = pca953x_set_val(chip, (1 << ul_arg2),
	261	(ul_arg3 << ul_arg2));
	262	if (ret)
	263	ret = CMD_RET_FAILURE;
	264	break;
	265
e92739d3	266	case PCA953X_CMD_INVERT:
633efe9c	267	ret = pca953x_set_pol(chip, (1 << ul_arg2),
e92739d3	268	(ul_arg3 << ul_arg2));
633efe9c LW	269	if (ret)
	270	ret = CMD_RET_FAILURE;
	271	break;
e92739d3	272	}
633efe9c LW	273
	274	if (ret == CMD_RET_FAILURE)
	275	eprintf("Error talking to chip at 0x%x\n", chip);
	276
	277	return ret;
e92739d3 PT	278	}
	279
	280	U_BOOT_CMD(
	281	pca953x, 5, 1, do_pca953x,
2fb2604d	282	"pca953x gpio access",
e92739d3 PT	283	"device [dev]\n"
e92739d3 PT	284	" - show or set current device address\n"
e92739d3 PT	285	"pca953x info\n"
e92739d3 PT	286	" - display info for current chip\n"
e92739d3 PT	287	"pca953x output pin 0\|1\n"
	288	" - set pin as output and drive low or high\n"
	289	"pca953x invert pin 0\|1\n"
	290	" - disable/enable polarity inversion for reads\n"
d75bc03f	291	"pca953x input pin\n"
a89c33db	292	" - set pin as input and read value"
e92739d3 PT	293	);
	294
	295	#endif /* CONFIG_CMD_PCA953X */