linux/drivers/pinctrl/sophgo/pinctrl-cv18xx.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * Copyright (C) 2024 Inochi Amaoto <inochiama@outlook.com>
 */

#ifndef _PINCTRL_SOPHGO_CV18XX_H
#define _PINCTRL_SOPHGO_CV18XX_H

#include <linux/bits.h>
#include <linux/bitfield.h>
#include <linux/device.h>
#include <linux/mutex.h>
#include <linux/spinlock.h>
#include <linux/platform_device.h>
#include <linux/pinctrl/pinctrl.h>
#include <linux/pinctrl/pinconf.h>

enum cv1800_pin_io_type {
	IO_TYPE_1V8_ONLY = 0,
	IO_TYPE_1V8_OR_3V3 = 1,
	IO_TYPE_AUDIO = 2,
	IO_TYPE_ETH = 3
};

#define CV1800_PINCONF_AREA_SYS		0
#define CV1800_PINCONF_AREA_RTC		1

struct cv1800_pinmux {
	u16	offset;
	u8	area;
	u8	max;
};

struct cv1800_pinmux2 {
	u16	offset;
	u8	area;
	u8	max;
	u8	pfunc;
};

struct cv1800_pinconf {
	u16	offset;
	u8	area;
};

#define	CV1800_PIN_HAVE_MUX2		BIT(0)
#define CV1800_PIN_IO_TYPE		GENMASK(2, 1)

#define CV1800_PIN_FLAG_IO_TYPE(type)		\
	FIELD_PREP_CONST(CV1800_PIN_IO_TYPE, type)
struct cv1800_pin {
	u16				pin;
	u16				flags;
	u8				power_domain;
	struct cv1800_pinmux		mux;
	struct cv1800_pinmux2		mux2;
	struct cv1800_pinconf		conf;
};

#define PIN_POWER_STATE_1V8		1800
#define PIN_POWER_STATE_3V3		3300

/**
 * struct cv1800_vddio_cfg_ops - pin vddio operations
 *
 * @get_pull_up: get resistor for pull up;
 * @get_pull_down: get resistor for pull down.
 * @get_oc_map: get mapping for typical low level output current value to
 *	register value map.
 * @get_schmitt_map: get mapping for register value to typical schmitt
 *	threshold.
 */
struct cv1800_vddio_cfg_ops {
	int (*get_pull_up)(struct cv1800_pin *pin, const u32 *psmap);
	int (*get_pull_down)(struct cv1800_pin *pin, const u32 *psmap);
	int (*get_oc_map)(struct cv1800_pin *pin, const u32 *psmap,
			  const u32 **map);
	int (*get_schmitt_map)(struct cv1800_pin *pin, const u32 *psmap,
			       const u32 **map);
};

struct cv1800_pinctrl_data {
	const struct pinctrl_pin_desc		*pins;
	const struct cv1800_pin			*pindata;
	const char				* const *pdnames;
	const struct cv1800_vddio_cfg_ops	*vddio_ops;
	u16					npins;
	u16					npd;
};

static inline enum cv1800_pin_io_type cv1800_pin_io_type(struct cv1800_pin *pin)
{
	return FIELD_GET(CV1800_PIN_IO_TYPE, pin->flags);
};

int cv1800_pinctrl_probe(struct platform_device *pdev);

#define CV1800_FUNC_PIN(_id, _power_domain, _type,			\
			_mux_area, _mux_offset, _mux_func_max)		\
	{								\
		.pin = (_id),						\
		.power_domain = (_power_domain),			\
		.flags = CV1800_PIN_FLAG_IO_TYPE(_type),		\
		.mux = {						\
			.area = (_mux_area),				\
			.offset = (_mux_offset),			\
			.max = (_mux_func_max),				\
		},							\
	}

#define CV1800_GENERAL_PIN(_id, _power_domain, _type,			\
			   _mux_area, _mux_offset, _mux_func_max,	\
			   _conf_area, _conf_offset)			\
	{								\
		.pin = (_id),						\
		.power_domain = (_power_domain),			\
		.flags = CV1800_PIN_FLAG_IO_TYPE(_type),		\
		.mux = {						\
			.area = (_mux_area),				\
			.offset = (_mux_offset),			\
			.max = (_mux_func_max),				\
		},							\
		.conf = {						\
			.area = (_conf_area),				\
			.offset = (_conf_offset),			\
		},							\
	}

#define CV1800_GENERATE_PIN_MUX2(_id, _power_domain, _type,		\
				 _mux_area, _mux_offset, _mux_func_max,	\
				 _mux2_area, _mux2_offset,		\
				 _mux2_func_max,			\
				 _conf_area, _conf_offset)		\
	{								\
		.pin = (_id),						\
		.power_domain = (_power_domain),			\
		.flags = CV1800_PIN_FLAG_IO_TYPE(_type) |		\
				CV1800_PIN_HAVE_MUX2,			\
		.mux = {						\
			.area = (_mux_area),				\
			.offset = (_mux_offset),			\
			.max = (_mux_func_max),				\
		},							\
		.mux2 = {						\
			.area = (_mux2_area),				\
			.offset = (_mux2_offset),			\
			.max = (_mux2_func_max),			\
		},							\
		.conf = {						\
			.area = (_conf_area),				\
			.offset = (_conf_offset),			\
		},							\
	}

#endif