[linux-block.git] / include / linux / serdev.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * Copyright (C) 2016-2017 Linaro Ltd., Rob Herring <robh@kernel.org>
 */
#ifndef _LINUX_SERDEV_H
#define _LINUX_SERDEV_H

#include <linux/types.h>
#include <linux/device.h>
#include <linux/termios.h>
#include <linux/delay.h>

struct serdev_controller;
struct serdev_device;

/*
 * serdev device structures
 */

/**
 * struct serdev_device_ops - Callback operations for a serdev device
 * @receive_buf:	Function called with data received from device;
 *			returns number of bytes accepted; may sleep.
 * @write_wakeup:	Function called when ready to transmit more data; must
 *			not sleep.
 */
struct serdev_device_ops {
	int (*receive_buf)(struct serdev_device *, const unsigned char *, size_t);
	void (*write_wakeup)(struct serdev_device *);
};

/**
 * struct serdev_device - Basic representation of an serdev device
 * @dev:	Driver model representation of the device.
 * @nr:		Device number on serdev bus.
 * @ctrl:	serdev controller managing this device.
 * @ops:	Device operations.
 * @write_comp	Completion used by serdev_device_write() internally
 * @write_lock	Lock to serialize access when writing data
 */
struct serdev_device {
	struct device dev;
	int nr;
	struct serdev_controller *ctrl;
	const struct serdev_device_ops *ops;
	struct completion write_comp;
	struct mutex write_lock;
};

static inline struct serdev_device *to_serdev_device(struct device *d)
{
	return container_of(d, struct serdev_device, dev);
}

/**
 * struct serdev_device_driver - serdev slave device driver
 * @driver:	serdev device drivers should initialize name field of this
 *		structure.
 * @probe:	binds this driver to a serdev device.
 * @remove:	unbinds this driver from the serdev device.
 */
struct serdev_device_driver {
	struct device_driver driver;
	int	(*probe)(struct serdev_device *);
	void	(*remove)(struct serdev_device *);
};

static inline struct serdev_device_driver *to_serdev_device_driver(struct device_driver *d)
{
	return container_of(d, struct serdev_device_driver, driver);
}

enum serdev_parity {
	SERDEV_PARITY_NONE,
	SERDEV_PARITY_EVEN,
	SERDEV_PARITY_ODD,
};

/*
 * serdev controller structures
 */
struct serdev_controller_ops {
	int (*write_buf)(struct serdev_controller *, const unsigned char *, size_t);
	void (*write_flush)(struct serdev_controller *);
	int (*write_room)(struct serdev_controller *);
	int (*open)(struct serdev_controller *);
	void (*close)(struct serdev_controller *);
	void (*set_flow_control)(struct serdev_controller *, bool);
	int (*set_parity)(struct serdev_controller *, enum serdev_parity);
	unsigned int (*set_baudrate)(struct serdev_controller *, unsigned int);
	void (*wait_until_sent)(struct serdev_controller *, long);
	int (*get_tiocm)(struct serdev_controller *);
	int (*set_tiocm)(struct serdev_controller *, unsigned int, unsigned int);
};

/**
 * struct serdev_controller - interface to the serdev controller
 * @dev:	Driver model representation of the device.
 * @nr:		number identifier for this controller/bus.
 * @serdev:	Pointer to slave device for this controller.
 * @ops:	Controller operations.
 */
struct serdev_controller {
	struct device		dev;
	unsigned int		nr;
	struct serdev_device	*serdev;
	const struct serdev_controller_ops *ops;
};

static inline struct serdev_controller *to_serdev_controller(struct device *d)
{
	return container_of(d, struct serdev_controller, dev);
}

static inline void *serdev_device_get_drvdata(const struct serdev_device *serdev)
{
	return dev_get_drvdata(&serdev->dev);
}

static inline void serdev_device_set_drvdata(struct serdev_device *serdev, void *data)
{
	dev_set_drvdata(&serdev->dev, data);
}

/**
 * serdev_device_put() - decrement serdev device refcount
 * @serdev	serdev device.
 */
static inline void serdev_device_put(struct serdev_device *serdev)
{
	if (serdev)
		put_device(&serdev->dev);
}

static inline void serdev_device_set_client_ops(struct serdev_device *serdev,
					      const struct serdev_device_ops *ops)
{
	serdev->ops = ops;
}

static inline
void *serdev_controller_get_drvdata(const struct serdev_controller *ctrl)
{
	return ctrl ? dev_get_drvdata(&ctrl->dev) : NULL;
}

static inline void serdev_controller_set_drvdata(struct serdev_controller *ctrl,
					       void *data)
{
	dev_set_drvdata(&ctrl->dev, data);
}

/**
 * serdev_controller_put() - decrement controller refcount
 * @ctrl	serdev controller.
 */
static inline void serdev_controller_put(struct serdev_controller *ctrl)
{
	if (ctrl)
		put_device(&ctrl->dev);
}

struct serdev_device *serdev_device_alloc(struct serdev_controller *);
int serdev_device_add(struct serdev_device *);
void serdev_device_remove(struct serdev_device *);

struct serdev_controller *serdev_controller_alloc(struct device *, size_t);
int serdev_controller_add(struct serdev_controller *);
void serdev_controller_remove(struct serdev_controller *);

static inline void serdev_controller_write_wakeup(struct serdev_controller *ctrl)
{
	struct serdev_device *serdev = ctrl->serdev;

	if (!serdev || !serdev->ops->write_wakeup)
		return;

	serdev->ops->write_wakeup(serdev);
}

static inline int serdev_controller_receive_buf(struct serdev_controller *ctrl,
					      const unsigned char *data,
					      size_t count)
{
	struct serdev_device *serdev = ctrl->serdev;

	if (!serdev || !serdev->ops->receive_buf)
		return 0;

	return serdev->ops->receive_buf(serdev, data, count);
}

#if IS_ENABLED(CONFIG_SERIAL_DEV_BUS)

int serdev_device_open(struct serdev_device *);
void serdev_device_close(struct serdev_device *);
int devm_serdev_device_open(struct device *, struct serdev_device *);
unsigned int serdev_device_set_baudrate(struct serdev_device *, unsigned int);
void serdev_device_set_flow_control(struct serdev_device *, bool);
int serdev_device_write_buf(struct serdev_device *, const unsigned char *, size_t);
void serdev_device_wait_until_sent(struct serdev_device *, long);
int serdev_device_get_tiocm(struct serdev_device *);
int serdev_device_set_tiocm(struct serdev_device *, int, int);
void serdev_device_write_wakeup(struct serdev_device *);
int serdev_device_write(struct serdev_device *, const unsigned char *, size_t, long);
void serdev_device_write_flush(struct serdev_device *);
int serdev_device_write_room(struct serdev_device *);

/*
 * serdev device driver functions
 */
int __serdev_device_driver_register(struct serdev_device_driver *, struct module *);
#define serdev_device_driver_register(sdrv) \
	__serdev_device_driver_register(sdrv, THIS_MODULE)

/**
 * serdev_device_driver_unregister() - unregister an serdev client driver
 * @sdrv:	the driver to unregister
 */
static inline void serdev_device_driver_unregister(struct serdev_device_driver *sdrv)
{
	if (sdrv)
		driver_unregister(&sdrv->driver);
}

#define module_serdev_device_driver(__serdev_device_driver) \
	module_driver(__serdev_device_driver, serdev_device_driver_register, \
			serdev_device_driver_unregister)

#else

static inline int serdev_device_open(struct serdev_device *sdev)
{
	return -ENODEV;
}
static inline void serdev_device_close(struct serdev_device *sdev) {}
static inline unsigned int serdev_device_set_baudrate(struct serdev_device *sdev, unsigned int baudrate)
{
	return 0;
}
static inline void serdev_device_set_flow_control(struct serdev_device *sdev, bool enable) {}
static inline int serdev_device_write_buf(struct serdev_device *serdev,
					  const unsigned char *buf,
					  size_t count)
{
	return -ENODEV;
}
static inline void serdev_device_wait_until_sent(struct serdev_device *sdev, long timeout) {}
static inline int serdev_device_get_tiocm(struct serdev_device *serdev)
{
	return -ENOTSUPP;
}
static inline int serdev_device_set_tiocm(struct serdev_device *serdev, int set, int clear)
{
	return -ENOTSUPP;
}
static inline int serdev_device_write(struct serdev_device *sdev, const unsigned char *buf,
				      size_t count, unsigned long timeout)
{
	return -ENODEV;
}
static inline void serdev_device_write_flush(struct serdev_device *sdev) {}
static inline int serdev_device_write_room(struct serdev_device *sdev)
{
	return 0;
}

#define serdev_device_driver_register(x)
#define serdev_device_driver_unregister(x)

#endif /* CONFIG_SERIAL_DEV_BUS */

static inline bool serdev_device_get_cts(struct serdev_device *serdev)
{
	int status = serdev_device_get_tiocm(serdev);
	return !!(status & TIOCM_CTS);
}

static inline int serdev_device_wait_for_cts(struct serdev_device *serdev, bool state, int timeout_ms)
{
	unsigned long timeout;
	bool signal;

	timeout = jiffies + msecs_to_jiffies(timeout_ms);
	while (time_is_after_jiffies(timeout)) {
		signal = serdev_device_get_cts(serdev);
		if (signal == state)
			return 0;
		usleep_range(1000, 2000);
	}

	return -ETIMEDOUT;
}

static inline int serdev_device_set_rts(struct serdev_device *serdev, bool enable)
{
	if (enable)
		return serdev_device_set_tiocm(serdev, TIOCM_RTS, 0);
	else
		return serdev_device_set_tiocm(serdev, 0, TIOCM_RTS);
}

int serdev_device_set_parity(struct serdev_device *serdev,
			     enum serdev_parity parity);

/*
 * serdev hooks into TTY core
 */
struct tty_port;
struct tty_driver;

#ifdef CONFIG_SERIAL_DEV_CTRL_TTYPORT
struct device *serdev_tty_port_register(struct tty_port *port,
					struct device *parent,
					struct tty_driver *drv, int idx);
int serdev_tty_port_unregister(struct tty_port *port);
#else
static inline struct device *serdev_tty_port_register(struct tty_port *port,
					   struct device *parent,
					   struct tty_driver *drv, int idx)
{
	return ERR_PTR(-ENODEV);
}
static inline int serdev_tty_port_unregister(struct tty_port *port)
{
	return -ENODEV;
}
#endif /* CONFIG_SERIAL_DEV_CTRL_TTYPORT */

struct acpi_resource;
struct acpi_resource_uart_serialbus;

#ifdef CONFIG_ACPI
bool serdev_acpi_get_uart_resource(struct acpi_resource *ares,
				   struct acpi_resource_uart_serialbus **uart);
#else
static inline bool serdev_acpi_get_uart_resource(struct acpi_resource *ares,
						 struct acpi_resource_uart_serialbus **uart)
{
	return false;
}
#endif /* CONFIG_ACPI */

#endif /*_LINUX_SERDEV_H */
Commit	Line	Data
97fb5e8d	1	/* SPDX-License-Identifier: GPL-2.0-only */
cd6484e1 RH	2	/*
cd6484e1 RH	3	* Copyright (C) 2016-2017 Linaro Ltd., Rob Herring <robh@kernel.org>
cd6484e1 RH	4	*/
	5	#ifndef _LINUX_SERDEV_H
	6	#define _LINUX_SERDEV_H
	7
	8	#include <linux/types.h>
	9	#include <linux/device.h>
5659dab2	10	#include <linux/termios.h>
756db778	11	#include <linux/delay.h>
cd6484e1 RH	12
	13	struct serdev_controller;
	14	struct serdev_device;
	15
	16	/*
	17	* serdev device structures
	18	*/
	19
	20	/**
	21	* struct serdev_device_ops - Callback operations for a serdev device
10f9e033 JH	22	* @receive_buf: Function called with data received from device;
	23	* returns number of bytes accepted; may sleep.
	24	* @write_wakeup: Function called when ready to transmit more data; must
	25	* not sleep.
cd6484e1 RH	26	*/
	27	struct serdev_device_ops {
	28	int (receive_buf)(struct serdev_device , const unsigned char *, size_t);
	29	void (write_wakeup)(struct serdev_device );
	30	};
	31
	32	/**
	33	* struct serdev_device - Basic representation of an serdev device
	34	* @dev: Driver model representation of the device.
	35	* @nr: Device number on serdev bus.
	36	* @ctrl: serdev controller managing this device.
	37	* @ops: Device operations.
6fe729c4 AS	38	* @write_comp Completion used by serdev_device_write() internally
6fe729c4 AS	39	* @write_lock Lock to serialize access when writing data
cd6484e1 RH	40	*/
	41	struct serdev_device {
	42	struct device dev;
	43	int nr;
	44	struct serdev_controller *ctrl;
	45	const struct serdev_device_ops *ops;
6fe729c4 AS	46	struct completion write_comp;
6fe729c4 AS	47	struct mutex write_lock;
cd6484e1 RH	48	};
	49
	50	static inline struct serdev_device to_serdev_device(struct device d)
	51	{
	52	return container_of(d, struct serdev_device, dev);
	53	}
	54
	55	/**
	56	* struct serdev_device_driver - serdev slave device driver
	57	* @driver: serdev device drivers should initialize name field of this
	58	* structure.
	59	* @probe: binds this driver to a serdev device.
	60	* @remove: unbinds this driver from the serdev device.
	61	*/
	62	struct serdev_device_driver {
	63	struct device_driver driver;
	64	int (probe)(struct serdev_device );
	65	void (remove)(struct serdev_device );
	66	};
	67
	68	static inline struct serdev_device_driver to_serdev_device_driver(struct device_driver d)
	69	{
	70	return container_of(d, struct serdev_device_driver, driver);
	71	}
	72
3a19cfcc UH	73	enum serdev_parity {
	74	SERDEV_PARITY_NONE,
	75	SERDEV_PARITY_EVEN,
	76	SERDEV_PARITY_ODD,
	77	};
	78
cd6484e1 RH	79	/*
	80	* serdev controller structures
	81	*/
	82	struct serdev_controller_ops {
	83	int (write_buf)(struct serdev_controller , const unsigned char *, size_t);
	84	void (write_flush)(struct serdev_controller );
	85	int (write_room)(struct serdev_controller );
	86	int (open)(struct serdev_controller );
	87	void (close)(struct serdev_controller );
	88	void (set_flow_control)(struct serdev_controller , bool);
3a19cfcc	89	int (set_parity)(struct serdev_controller , enum serdev_parity);
cd6484e1	90	unsigned int (set_baudrate)(struct serdev_controller , unsigned int);
b3f80c8f	91	void (wait_until_sent)(struct serdev_controller , long);
5659dab2 SR	92	int (get_tiocm)(struct serdev_controller );
5659dab2 SR	93	int (set_tiocm)(struct serdev_controller , unsigned int, unsigned int);
cd6484e1 RH	94	};
	95
	96	/**
	97	* struct serdev_controller - interface to the serdev controller
	98	* @dev: Driver model representation of the device.
	99	* @nr: number identifier for this controller/bus.
	100	* @serdev: Pointer to slave device for this controller.
	101	* @ops: Controller operations.
	102	*/
	103	struct serdev_controller {
	104	struct device dev;
	105	unsigned int nr;
	106	struct serdev_device *serdev;
	107	const struct serdev_controller_ops *ops;
	108	};
	109
	110	static inline struct serdev_controller to_serdev_controller(struct device d)
	111	{
	112	return container_of(d, struct serdev_controller, dev);
	113	}
	114
	115	static inline void serdev_device_get_drvdata(const struct serdev_device serdev)
	116	{
	117	return dev_get_drvdata(&serdev->dev);
	118	}
	119
	120	static inline void serdev_device_set_drvdata(struct serdev_device serdev, void data)
	121	{
	122	dev_set_drvdata(&serdev->dev, data);
	123	}
	124
	125	/**
	126	* serdev_device_put() - decrement serdev device refcount
	127	* @serdev serdev device.
	128	*/
	129	static inline void serdev_device_put(struct serdev_device *serdev)
	130	{
	131	if (serdev)
	132	put_device(&serdev->dev);
	133	}
	134
	135	static inline void serdev_device_set_client_ops(struct serdev_device *serdev,
	136	const struct serdev_device_ops *ops)
	137	{
	138	serdev->ops = ops;
	139	}
	140
	141	static inline
	142	void serdev_controller_get_drvdata(const struct serdev_controller ctrl)
	143	{
	144	return ctrl ? dev_get_drvdata(&ctrl->dev) : NULL;
	145	}
	146
	147	static inline void serdev_controller_set_drvdata(struct serdev_controller *ctrl,
	148	void *data)
	149	{
	150	dev_set_drvdata(&ctrl->dev, data);
	151	}
	152
	153	/**
	154	* serdev_controller_put() - decrement controller refcount
	155	* @ctrl serdev controller.
	156	*/
	157	static inline void serdev_controller_put(struct serdev_controller *ctrl)
158	{
159	if (ctrl)
160	put_device(&ctrl->dev);
161	}
162
163	struct serdev_device serdev_device_alloc(struct serdev_controller );
164	int serdev_device_add(struct serdev_device *);
165	void serdev_device_remove(struct serdev_device *);
166
167	struct serdev_controller serdev_controller_alloc(struct device , size_t);
168	int serdev_controller_add(struct serdev_controller *);
169	void serdev_controller_remove(struct serdev_controller *);
170
171	static inline void serdev_controller_write_wakeup(struct serdev_controller *ctrl)
172	{
173	struct serdev_device *serdev = ctrl->serdev;
174
175	if (!serdev \|\| !serdev->ops->write_wakeup)
176	return;
177
9d1d994d	178	serdev->ops->write_wakeup(serdev);
cd6484e1 RH	179	}
	180
	181	static inline int serdev_controller_receive_buf(struct serdev_controller *ctrl,
	182	const unsigned char *data,
	183	size_t count)
	184	{
	185	struct serdev_device *serdev = ctrl->serdev;
	186
	187	if (!serdev \|\| !serdev->ops->receive_buf)
fd00cf81	188	return 0;
cd6484e1	189
9d1d994d	190	return serdev->ops->receive_buf(serdev, data, count);
cd6484e1 RH	191	}
	192
	193	#if IS_ENABLED(CONFIG_SERIAL_DEV_BUS)
	194
	195	int serdev_device_open(struct serdev_device *);
	196	void serdev_device_close(struct serdev_device *);
2cb67d20	197	int devm_serdev_device_open(struct device , struct serdev_device );
cd6484e1 RH	198	unsigned int serdev_device_set_baudrate(struct serdev_device *, unsigned int);
cd6484e1 RH	199	void serdev_device_set_flow_control(struct serdev_device *, bool);
6bdc00d0	200	int serdev_device_write_buf(struct serdev_device , const unsigned char , size_t);
b3f80c8f	201	void serdev_device_wait_until_sent(struct serdev_device *, long);
5659dab2 SR	202	int serdev_device_get_tiocm(struct serdev_device *);
5659dab2 SR	203	int serdev_device_set_tiocm(struct serdev_device *, int, int);
6fe729c4	204	void serdev_device_write_wakeup(struct serdev_device *);
70d18804	205	int serdev_device_write(struct serdev_device , const unsigned char , size_t, long);
cd6484e1 RH	206	void serdev_device_write_flush(struct serdev_device *);
	207	int serdev_device_write_room(struct serdev_device *);
	208
	209	/*
	210	* serdev device driver functions
	211	*/
	212	int __serdev_device_driver_register(struct serdev_device_driver , struct module );
	213	#define serdev_device_driver_register(sdrv) \
	214	__serdev_device_driver_register(sdrv, THIS_MODULE)
	215
	216	/**
	217	* serdev_device_driver_unregister() - unregister an serdev client driver
	218	* @sdrv: the driver to unregister
	219	*/
	220	static inline void serdev_device_driver_unregister(struct serdev_device_driver *sdrv)
	221	{
	222	if (sdrv)
	223	driver_unregister(&sdrv->driver);
	224	}
	225
	226	#define module_serdev_device_driver(__serdev_device_driver) \
	227	module_driver(__serdev_device_driver, serdev_device_driver_register, \
	228	serdev_device_driver_unregister)
	229
	230	#else
	231
	232	static inline int serdev_device_open(struct serdev_device *sdev)
	233	{
	234	return -ENODEV;
	235	}
	236	static inline void serdev_device_close(struct serdev_device *sdev) {}
	237	static inline unsigned int serdev_device_set_baudrate(struct serdev_device *sdev, unsigned int baudrate)
	238	{
	239	return 0;
	240	}
	241	static inline void serdev_device_set_flow_control(struct serdev_device *sdev, bool enable) {}
6bdc00d0 SW	242	static inline int serdev_device_write_buf(struct serdev_device *serdev,
	243	const unsigned char *buf,
	244	size_t count)
	245	{
	246	return -ENODEV;
	247	}
b3f80c8f	248	static inline void serdev_device_wait_until_sent(struct serdev_device *sdev, long timeout) {}
5659dab2 SR	249	static inline int serdev_device_get_tiocm(struct serdev_device *serdev)
	250	{
	251	return -ENOTSUPP;
	252	}
	253	static inline int serdev_device_set_tiocm(struct serdev_device *serdev, int set, int clear)
	254	{
	255	return -ENOTSUPP;
	256	}
6fe729c4 AS	257	static inline int serdev_device_write(struct serdev_device sdev, const unsigned char buf,
6fe729c4 AS	258	size_t count, unsigned long timeout)
cd6484e1 RH	259	{
	260	return -ENODEV;
	261	}
	262	static inline void serdev_device_write_flush(struct serdev_device *sdev) {}
	263	static inline int serdev_device_write_room(struct serdev_device *sdev)
	264	{
	265	return 0;
	266	}
	267
	268	#define serdev_device_driver_register(x)
	269	#define serdev_device_driver_unregister(x)
	270
	271	#endif /* CONFIG_SERIAL_DEV_BUS */
	272
756db778 SR	273	static inline bool serdev_device_get_cts(struct serdev_device *serdev)
	274	{
	275	int status = serdev_device_get_tiocm(serdev);
	276	return !!(status & TIOCM_CTS);
	277	}
	278
	279	static inline int serdev_device_wait_for_cts(struct serdev_device *serdev, bool state, int timeout_ms)
	280	{
	281	unsigned long timeout;
	282	bool signal;
	283
	284	timeout = jiffies + msecs_to_jiffies(timeout_ms);
	285	while (time_is_after_jiffies(timeout)) {
	286	signal = serdev_device_get_cts(serdev);
	287	if (signal == state)
	288	return 0;
	289	usleep_range(1000, 2000);
	290	}
	291
	292	return -ETIMEDOUT;
	293	}
	294
	295	static inline int serdev_device_set_rts(struct serdev_device *serdev, bool enable)
	296	{
	297	if (enable)
	298	return serdev_device_set_tiocm(serdev, TIOCM_RTS, 0);
	299	else
	300	return serdev_device_set_tiocm(serdev, 0, TIOCM_RTS);
	301	}
	302
3a19cfcc UH	303	int serdev_device_set_parity(struct serdev_device *serdev,
	304	enum serdev_parity parity);
	305
bed35c6d RH	306	/*
	307	* serdev hooks into TTY core
	308	*/
	309	struct tty_port;
	310	struct tty_driver;
	311
	312	#ifdef CONFIG_SERIAL_DEV_CTRL_TTYPORT
	313	struct device serdev_tty_port_register(struct tty_port port,
	314	struct device *parent,
	315	struct tty_driver *drv, int idx);
8cde11b2	316	int serdev_tty_port_unregister(struct tty_port *port);
bed35c6d RH	317	#else
	318	static inline struct device serdev_tty_port_register(struct tty_port port,
	319	struct device *parent,
	320	struct tty_driver *drv, int idx)
	321	{
	322	return ERR_PTR(-ENODEV);
	323	}
8cde11b2 JH	324	static inline int serdev_tty_port_unregister(struct tty_port *port)
	325	{
	326	return -ENODEV;
	327	}
bed35c6d RH	328	#endif /* CONFIG_SERIAL_DEV_CTRL_TTYPORT */
bed35c6d RH	329
0a732d7d AS	330	struct acpi_resource;
	331	struct acpi_resource_uart_serialbus;
	332
	333	#ifdef CONFIG_ACPI
	334	bool serdev_acpi_get_uart_resource(struct acpi_resource *ares,
	335	struct acpi_resource_uart_serialbus **uart);
	336	#else
	337	static inline bool serdev_acpi_get_uart_resource(struct acpi_resource *ares,
	338	struct acpi_resource_uart_serialbus **uart)
	339	{
	340	return false;
	341	}
	342	#endif /* CONFIG_ACPI */
	343
cd6484e1	344	#endif /_LINUX_SERDEV_H /