197fb5e8dSThomas Gleixner /* SPDX-License-Identifier: GPL-2.0-only */
2cd6484e1SRob Herring /*
3cd6484e1SRob Herring * Copyright (C) 2016-2017 Linaro Ltd., Rob Herring <robh@kernel.org>
4cd6484e1SRob Herring */
5cd6484e1SRob Herring #ifndef _LINUX_SERDEV_H
6cd6484e1SRob Herring #define _LINUX_SERDEV_H
7cd6484e1SRob Herring
8cd6484e1SRob Herring #include <linux/types.h>
9cd6484e1SRob Herring #include <linux/device.h>
1096e82989SAndy Shevchenko #include <linux/iopoll.h>
1189bbeb7eSAl Viro #include <linux/uaccess.h>
125659dab2SSebastian Reichel #include <linux/termios.h>
13756db778SSebastian Reichel #include <linux/delay.h>
14cd6484e1SRob Herring
15cd6484e1SRob Herring struct serdev_controller;
16cd6484e1SRob Herring struct serdev_device;
17cd6484e1SRob Herring
18cd6484e1SRob Herring /*
19cd6484e1SRob Herring * serdev device structures
20cd6484e1SRob Herring */
21cd6484e1SRob Herring
22cd6484e1SRob Herring /**
23cd6484e1SRob Herring * struct serdev_device_ops - Callback operations for a serdev device
2410f9e033SJohan Hovold * @receive_buf: Function called with data received from device;
2510f9e033SJohan Hovold * returns number of bytes accepted; may sleep.
2610f9e033SJohan Hovold * @write_wakeup: Function called when ready to transmit more data; must
2710f9e033SJohan Hovold * not sleep.
28cd6484e1SRob Herring */
29cd6484e1SRob Herring struct serdev_device_ops {
30cd6484e1SRob Herring int (*receive_buf)(struct serdev_device *, const unsigned char *, size_t);
31cd6484e1SRob Herring void (*write_wakeup)(struct serdev_device *);
32cd6484e1SRob Herring };
33cd6484e1SRob Herring
34cd6484e1SRob Herring /**
35cd6484e1SRob Herring * struct serdev_device - Basic representation of an serdev device
36cd6484e1SRob Herring * @dev: Driver model representation of the device.
37cd6484e1SRob Herring * @nr: Device number on serdev bus.
38cd6484e1SRob Herring * @ctrl: serdev controller managing this device.
39cd6484e1SRob Herring * @ops: Device operations.
406fe729c4SAndrey Smirnov * @write_comp Completion used by serdev_device_write() internally
416fe729c4SAndrey Smirnov * @write_lock Lock to serialize access when writing data
42cd6484e1SRob Herring */
43cd6484e1SRob Herring struct serdev_device {
44cd6484e1SRob Herring struct device dev;
45cd6484e1SRob Herring int nr;
46cd6484e1SRob Herring struct serdev_controller *ctrl;
47cd6484e1SRob Herring const struct serdev_device_ops *ops;
486fe729c4SAndrey Smirnov struct completion write_comp;
496fe729c4SAndrey Smirnov struct mutex write_lock;
50cd6484e1SRob Herring };
51cd6484e1SRob Herring
to_serdev_device(struct device * d)52cd6484e1SRob Herring static inline struct serdev_device *to_serdev_device(struct device *d)
53cd6484e1SRob Herring {
54cd6484e1SRob Herring return container_of(d, struct serdev_device, dev);
55cd6484e1SRob Herring }
56cd6484e1SRob Herring
57cd6484e1SRob Herring /**
58cd6484e1SRob Herring * struct serdev_device_driver - serdev slave device driver
59cd6484e1SRob Herring * @driver: serdev device drivers should initialize name field of this
60cd6484e1SRob Herring * structure.
61cd6484e1SRob Herring * @probe: binds this driver to a serdev device.
62cd6484e1SRob Herring * @remove: unbinds this driver from the serdev device.
63cd6484e1SRob Herring */
64cd6484e1SRob Herring struct serdev_device_driver {
65cd6484e1SRob Herring struct device_driver driver;
66cd6484e1SRob Herring int (*probe)(struct serdev_device *);
67cd6484e1SRob Herring void (*remove)(struct serdev_device *);
68cd6484e1SRob Herring };
69cd6484e1SRob Herring
to_serdev_device_driver(struct device_driver * d)70cd6484e1SRob Herring static inline struct serdev_device_driver *to_serdev_device_driver(struct device_driver *d)
71cd6484e1SRob Herring {
72cd6484e1SRob Herring return container_of(d, struct serdev_device_driver, driver);
73cd6484e1SRob Herring }
74cd6484e1SRob Herring
753a19cfccSUlrich Hecht enum serdev_parity {
763a19cfccSUlrich Hecht SERDEV_PARITY_NONE,
773a19cfccSUlrich Hecht SERDEV_PARITY_EVEN,
783a19cfccSUlrich Hecht SERDEV_PARITY_ODD,
793a19cfccSUlrich Hecht };
803a19cfccSUlrich Hecht
81cd6484e1SRob Herring /*
82cd6484e1SRob Herring * serdev controller structures
83cd6484e1SRob Herring */
84cd6484e1SRob Herring struct serdev_controller_ops {
85cd6484e1SRob Herring int (*write_buf)(struct serdev_controller *, const unsigned char *, size_t);
86cd6484e1SRob Herring void (*write_flush)(struct serdev_controller *);
87cd6484e1SRob Herring int (*write_room)(struct serdev_controller *);
88cd6484e1SRob Herring int (*open)(struct serdev_controller *);
89cd6484e1SRob Herring void (*close)(struct serdev_controller *);
90cd6484e1SRob Herring void (*set_flow_control)(struct serdev_controller *, bool);
913a19cfccSUlrich Hecht int (*set_parity)(struct serdev_controller *, enum serdev_parity);
92cd6484e1SRob Herring unsigned int (*set_baudrate)(struct serdev_controller *, unsigned int);
93b3f80c8fSSebastian Reichel void (*wait_until_sent)(struct serdev_controller *, long);
945659dab2SSebastian Reichel int (*get_tiocm)(struct serdev_controller *);
955659dab2SSebastian Reichel int (*set_tiocm)(struct serdev_controller *, unsigned int, unsigned int);
96*8eaf839eSNeeraj Sanjay Kale int (*break_ctl)(struct serdev_controller *ctrl, unsigned int break_state);
97cd6484e1SRob Herring };
98cd6484e1SRob Herring
99cd6484e1SRob Herring /**
100cd6484e1SRob Herring * struct serdev_controller - interface to the serdev controller
101cd6484e1SRob Herring * @dev: Driver model representation of the device.
102cd6484e1SRob Herring * @nr: number identifier for this controller/bus.
103cd6484e1SRob Herring * @serdev: Pointer to slave device for this controller.
104cd6484e1SRob Herring * @ops: Controller operations.
105cd6484e1SRob Herring */
106cd6484e1SRob Herring struct serdev_controller {
107cd6484e1SRob Herring struct device dev;
108cd6484e1SRob Herring unsigned int nr;
109cd6484e1SRob Herring struct serdev_device *serdev;
110cd6484e1SRob Herring const struct serdev_controller_ops *ops;
111cd6484e1SRob Herring };
112cd6484e1SRob Herring
to_serdev_controller(struct device * d)113cd6484e1SRob Herring static inline struct serdev_controller *to_serdev_controller(struct device *d)
114cd6484e1SRob Herring {
115cd6484e1SRob Herring return container_of(d, struct serdev_controller, dev);
116cd6484e1SRob Herring }
117cd6484e1SRob Herring
serdev_device_get_drvdata(const struct serdev_device * serdev)118cd6484e1SRob Herring static inline void *serdev_device_get_drvdata(const struct serdev_device *serdev)
119cd6484e1SRob Herring {
120cd6484e1SRob Herring return dev_get_drvdata(&serdev->dev);
121cd6484e1SRob Herring }
122cd6484e1SRob Herring
serdev_device_set_drvdata(struct serdev_device * serdev,void * data)123cd6484e1SRob Herring static inline void serdev_device_set_drvdata(struct serdev_device *serdev, void *data)
124cd6484e1SRob Herring {
125cd6484e1SRob Herring dev_set_drvdata(&serdev->dev, data);
126cd6484e1SRob Herring }
127cd6484e1SRob Herring
128cd6484e1SRob Herring /**
129cd6484e1SRob Herring * serdev_device_put() - decrement serdev device refcount
130cd6484e1SRob Herring * @serdev serdev device.
131cd6484e1SRob Herring */
serdev_device_put(struct serdev_device * serdev)132cd6484e1SRob Herring static inline void serdev_device_put(struct serdev_device *serdev)
133cd6484e1SRob Herring {
134cd6484e1SRob Herring if (serdev)
135cd6484e1SRob Herring put_device(&serdev->dev);
136cd6484e1SRob Herring }
137cd6484e1SRob Herring
serdev_device_set_client_ops(struct serdev_device * serdev,const struct serdev_device_ops * ops)138cd6484e1SRob Herring static inline void serdev_device_set_client_ops(struct serdev_device *serdev,
139cd6484e1SRob Herring const struct serdev_device_ops *ops)
140cd6484e1SRob Herring {
141cd6484e1SRob Herring serdev->ops = ops;
142cd6484e1SRob Herring }
143cd6484e1SRob Herring
144cd6484e1SRob Herring static inline
serdev_controller_get_drvdata(const struct serdev_controller * ctrl)145cd6484e1SRob Herring void *serdev_controller_get_drvdata(const struct serdev_controller *ctrl)
146cd6484e1SRob Herring {
147cd6484e1SRob Herring return ctrl ? dev_get_drvdata(&ctrl->dev) : NULL;
148cd6484e1SRob Herring }
149cd6484e1SRob Herring
serdev_controller_set_drvdata(struct serdev_controller * ctrl,void * data)150cd6484e1SRob Herring static inline void serdev_controller_set_drvdata(struct serdev_controller *ctrl,
151cd6484e1SRob Herring void *data)
152cd6484e1SRob Herring {
153cd6484e1SRob Herring dev_set_drvdata(&ctrl->dev, data);
154cd6484e1SRob Herring }
155cd6484e1SRob Herring
156cd6484e1SRob Herring /**
157cd6484e1SRob Herring * serdev_controller_put() - decrement controller refcount
158cd6484e1SRob Herring * @ctrl serdev controller.
159cd6484e1SRob Herring */
serdev_controller_put(struct serdev_controller * ctrl)160cd6484e1SRob Herring static inline void serdev_controller_put(struct serdev_controller *ctrl)
161cd6484e1SRob Herring {
162cd6484e1SRob Herring if (ctrl)
163cd6484e1SRob Herring put_device(&ctrl->dev);
164cd6484e1SRob Herring }
165cd6484e1SRob Herring
166cd6484e1SRob Herring struct serdev_device *serdev_device_alloc(struct serdev_controller *);
167cd6484e1SRob Herring int serdev_device_add(struct serdev_device *);
168cd6484e1SRob Herring void serdev_device_remove(struct serdev_device *);
169cd6484e1SRob Herring
170cd6484e1SRob Herring struct serdev_controller *serdev_controller_alloc(struct device *, size_t);
171cd6484e1SRob Herring int serdev_controller_add(struct serdev_controller *);
172cd6484e1SRob Herring void serdev_controller_remove(struct serdev_controller *);
173cd6484e1SRob Herring
serdev_controller_write_wakeup(struct serdev_controller * ctrl)174cd6484e1SRob Herring static inline void serdev_controller_write_wakeup(struct serdev_controller *ctrl)
175cd6484e1SRob Herring {
176cd6484e1SRob Herring struct serdev_device *serdev = ctrl->serdev;
177cd6484e1SRob Herring
178cd6484e1SRob Herring if (!serdev || !serdev->ops->write_wakeup)
179cd6484e1SRob Herring return;
180cd6484e1SRob Herring
1819d1d994dSAndrey Smirnov serdev->ops->write_wakeup(serdev);
182cd6484e1SRob Herring }
183cd6484e1SRob Herring
serdev_controller_receive_buf(struct serdev_controller * ctrl,const unsigned char * data,size_t count)184cd6484e1SRob Herring static inline int serdev_controller_receive_buf(struct serdev_controller *ctrl,
185cd6484e1SRob Herring const unsigned char *data,
186cd6484e1SRob Herring size_t count)
187cd6484e1SRob Herring {
188cd6484e1SRob Herring struct serdev_device *serdev = ctrl->serdev;
189cd6484e1SRob Herring
190cd6484e1SRob Herring if (!serdev || !serdev->ops->receive_buf)
191fd00cf81SJohan Hovold return 0;
192cd6484e1SRob Herring
1939d1d994dSAndrey Smirnov return serdev->ops->receive_buf(serdev, data, count);
194cd6484e1SRob Herring }
195cd6484e1SRob Herring
196cd6484e1SRob Herring #if IS_ENABLED(CONFIG_SERIAL_DEV_BUS)
197cd6484e1SRob Herring
198cd6484e1SRob Herring int serdev_device_open(struct serdev_device *);
199cd6484e1SRob Herring void serdev_device_close(struct serdev_device *);
2002cb67d20SAndrey Smirnov int devm_serdev_device_open(struct device *, struct serdev_device *);
201cd6484e1SRob Herring unsigned int serdev_device_set_baudrate(struct serdev_device *, unsigned int);
202cd6484e1SRob Herring void serdev_device_set_flow_control(struct serdev_device *, bool);
2036bdc00d0SStefan Wahren int serdev_device_write_buf(struct serdev_device *, const unsigned char *, size_t);
204b3f80c8fSSebastian Reichel void serdev_device_wait_until_sent(struct serdev_device *, long);
2055659dab2SSebastian Reichel int serdev_device_get_tiocm(struct serdev_device *);
2065659dab2SSebastian Reichel int serdev_device_set_tiocm(struct serdev_device *, int, int);
207*8eaf839eSNeeraj Sanjay Kale int serdev_device_break_ctl(struct serdev_device *serdev, int break_state);
2086fe729c4SAndrey Smirnov void serdev_device_write_wakeup(struct serdev_device *);
20970d18804SJohan Hovold int serdev_device_write(struct serdev_device *, const unsigned char *, size_t, long);
210cd6484e1SRob Herring void serdev_device_write_flush(struct serdev_device *);
211cd6484e1SRob Herring int serdev_device_write_room(struct serdev_device *);
212cd6484e1SRob Herring
213cd6484e1SRob Herring /*
214cd6484e1SRob Herring * serdev device driver functions
215cd6484e1SRob Herring */
216cd6484e1SRob Herring int __serdev_device_driver_register(struct serdev_device_driver *, struct module *);
217cd6484e1SRob Herring #define serdev_device_driver_register(sdrv) \
218cd6484e1SRob Herring __serdev_device_driver_register(sdrv, THIS_MODULE)
219cd6484e1SRob Herring
220cd6484e1SRob Herring /**
221cd6484e1SRob Herring * serdev_device_driver_unregister() - unregister an serdev client driver
222cd6484e1SRob Herring * @sdrv: the driver to unregister
223cd6484e1SRob Herring */
serdev_device_driver_unregister(struct serdev_device_driver * sdrv)224cd6484e1SRob Herring static inline void serdev_device_driver_unregister(struct serdev_device_driver *sdrv)
225cd6484e1SRob Herring {
226cd6484e1SRob Herring if (sdrv)
227cd6484e1SRob Herring driver_unregister(&sdrv->driver);
228cd6484e1SRob Herring }
229cd6484e1SRob Herring
230cd6484e1SRob Herring #define module_serdev_device_driver(__serdev_device_driver) \
231cd6484e1SRob Herring module_driver(__serdev_device_driver, serdev_device_driver_register, \
232cd6484e1SRob Herring serdev_device_driver_unregister)
233cd6484e1SRob Herring
234cd6484e1SRob Herring #else
235cd6484e1SRob Herring
serdev_device_open(struct serdev_device * sdev)236cd6484e1SRob Herring static inline int serdev_device_open(struct serdev_device *sdev)
237cd6484e1SRob Herring {
238cd6484e1SRob Herring return -ENODEV;
239cd6484e1SRob Herring }
serdev_device_close(struct serdev_device * sdev)240cd6484e1SRob Herring static inline void serdev_device_close(struct serdev_device *sdev) {}
serdev_device_set_baudrate(struct serdev_device * sdev,unsigned int baudrate)241cd6484e1SRob Herring static inline unsigned int serdev_device_set_baudrate(struct serdev_device *sdev, unsigned int baudrate)
242cd6484e1SRob Herring {
243cd6484e1SRob Herring return 0;
244cd6484e1SRob Herring }
serdev_device_set_flow_control(struct serdev_device * sdev,bool enable)245cd6484e1SRob Herring static inline void serdev_device_set_flow_control(struct serdev_device *sdev, bool enable) {}
serdev_device_write_buf(struct serdev_device * serdev,const unsigned char * buf,size_t count)2466bdc00d0SStefan Wahren static inline int serdev_device_write_buf(struct serdev_device *serdev,
2476bdc00d0SStefan Wahren const unsigned char *buf,
2486bdc00d0SStefan Wahren size_t count)
2496bdc00d0SStefan Wahren {
2506bdc00d0SStefan Wahren return -ENODEV;
2516bdc00d0SStefan Wahren }
serdev_device_wait_until_sent(struct serdev_device * sdev,long timeout)252b3f80c8fSSebastian Reichel static inline void serdev_device_wait_until_sent(struct serdev_device *sdev, long timeout) {}
serdev_device_get_tiocm(struct serdev_device * serdev)2535659dab2SSebastian Reichel static inline int serdev_device_get_tiocm(struct serdev_device *serdev)
2545659dab2SSebastian Reichel {
25529f93a68SNeeraj Sanjay Kale return -EOPNOTSUPP;
2565659dab2SSebastian Reichel }
serdev_device_set_tiocm(struct serdev_device * serdev,int set,int clear)2575659dab2SSebastian Reichel static inline int serdev_device_set_tiocm(struct serdev_device *serdev, int set, int clear)
2585659dab2SSebastian Reichel {
25929f93a68SNeeraj Sanjay Kale return -EOPNOTSUPP;
2605659dab2SSebastian Reichel }
serdev_device_break_ctl(struct serdev_device * serdev,int break_state)261*8eaf839eSNeeraj Sanjay Kale static inline int serdev_device_break_ctl(struct serdev_device *serdev, int break_state)
262*8eaf839eSNeeraj Sanjay Kale {
263*8eaf839eSNeeraj Sanjay Kale return -EOPNOTSUPP;
264*8eaf839eSNeeraj Sanjay Kale }
serdev_device_write(struct serdev_device * sdev,const unsigned char * buf,size_t count,unsigned long timeout)2656fe729c4SAndrey Smirnov static inline int serdev_device_write(struct serdev_device *sdev, const unsigned char *buf,
2666fe729c4SAndrey Smirnov size_t count, unsigned long timeout)
267cd6484e1SRob Herring {
268cd6484e1SRob Herring return -ENODEV;
269cd6484e1SRob Herring }
serdev_device_write_flush(struct serdev_device * sdev)270cd6484e1SRob Herring static inline void serdev_device_write_flush(struct serdev_device *sdev) {}
serdev_device_write_room(struct serdev_device * sdev)271cd6484e1SRob Herring static inline int serdev_device_write_room(struct serdev_device *sdev)
272cd6484e1SRob Herring {
273cd6484e1SRob Herring return 0;
274cd6484e1SRob Herring }
275cd6484e1SRob Herring
276cd6484e1SRob Herring #define serdev_device_driver_register(x)
277cd6484e1SRob Herring #define serdev_device_driver_unregister(x)
278cd6484e1SRob Herring
279cd6484e1SRob Herring #endif /* CONFIG_SERIAL_DEV_BUS */
280cd6484e1SRob Herring
serdev_device_get_cts(struct serdev_device * serdev)281756db778SSebastian Reichel static inline bool serdev_device_get_cts(struct serdev_device *serdev)
282756db778SSebastian Reichel {
283756db778SSebastian Reichel int status = serdev_device_get_tiocm(serdev);
284756db778SSebastian Reichel return !!(status & TIOCM_CTS);
285756db778SSebastian Reichel }
286756db778SSebastian Reichel
serdev_device_wait_for_cts(struct serdev_device * serdev,bool state,int timeout_ms)287756db778SSebastian Reichel static inline int serdev_device_wait_for_cts(struct serdev_device *serdev, bool state, int timeout_ms)
288756db778SSebastian Reichel {
289756db778SSebastian Reichel bool signal;
290756db778SSebastian Reichel
29196e82989SAndy Shevchenko return readx_poll_timeout(serdev_device_get_cts, serdev, signal, signal == state,
29296e82989SAndy Shevchenko 2000, timeout_ms * 1000);
293756db778SSebastian Reichel }
294756db778SSebastian Reichel
serdev_device_set_rts(struct serdev_device * serdev,bool enable)295756db778SSebastian Reichel static inline int serdev_device_set_rts(struct serdev_device *serdev, bool enable)
296756db778SSebastian Reichel {
297756db778SSebastian Reichel if (enable)
298756db778SSebastian Reichel return serdev_device_set_tiocm(serdev, TIOCM_RTS, 0);
299756db778SSebastian Reichel else
300756db778SSebastian Reichel return serdev_device_set_tiocm(serdev, 0, TIOCM_RTS);
301756db778SSebastian Reichel }
302756db778SSebastian Reichel
3033a19cfccSUlrich Hecht int serdev_device_set_parity(struct serdev_device *serdev,
3043a19cfccSUlrich Hecht enum serdev_parity parity);
3053a19cfccSUlrich Hecht
306bed35c6dSRob Herring /*
307bed35c6dSRob Herring * serdev hooks into TTY core
308bed35c6dSRob Herring */
309bed35c6dSRob Herring struct tty_port;
310bed35c6dSRob Herring struct tty_driver;
311bed35c6dSRob Herring
312bed35c6dSRob Herring #ifdef CONFIG_SERIAL_DEV_CTRL_TTYPORT
313bed35c6dSRob Herring struct device *serdev_tty_port_register(struct tty_port *port,
314bed35c6dSRob Herring struct device *parent,
315bed35c6dSRob Herring struct tty_driver *drv, int idx);
3168cde11b2SJohan Hovold int serdev_tty_port_unregister(struct tty_port *port);
317bed35c6dSRob Herring #else
serdev_tty_port_register(struct tty_port * port,struct device * parent,struct tty_driver * drv,int idx)318bed35c6dSRob Herring static inline struct device *serdev_tty_port_register(struct tty_port *port,
319bed35c6dSRob Herring struct device *parent,
320bed35c6dSRob Herring struct tty_driver *drv, int idx)
321bed35c6dSRob Herring {
322bed35c6dSRob Herring return ERR_PTR(-ENODEV);
323bed35c6dSRob Herring }
serdev_tty_port_unregister(struct tty_port * port)3248cde11b2SJohan Hovold static inline int serdev_tty_port_unregister(struct tty_port *port)
3258cde11b2SJohan Hovold {
3268cde11b2SJohan Hovold return -ENODEV;
3278cde11b2SJohan Hovold }
328bed35c6dSRob Herring #endif /* CONFIG_SERIAL_DEV_CTRL_TTYPORT */
329bed35c6dSRob Herring
3300a732d7dSAndy Shevchenko struct acpi_resource;
3310a732d7dSAndy Shevchenko struct acpi_resource_uart_serialbus;
3320a732d7dSAndy Shevchenko
3330a732d7dSAndy Shevchenko #ifdef CONFIG_ACPI
3340a732d7dSAndy Shevchenko bool serdev_acpi_get_uart_resource(struct acpi_resource *ares,
3350a732d7dSAndy Shevchenko struct acpi_resource_uart_serialbus **uart);
3360a732d7dSAndy Shevchenko #else
serdev_acpi_get_uart_resource(struct acpi_resource * ares,struct acpi_resource_uart_serialbus ** uart)3370a732d7dSAndy Shevchenko static inline bool serdev_acpi_get_uart_resource(struct acpi_resource *ares,
3380a732d7dSAndy Shevchenko struct acpi_resource_uart_serialbus **uart)
3390a732d7dSAndy Shevchenko {
3400a732d7dSAndy Shevchenko return false;
3410a732d7dSAndy Shevchenko }
3420a732d7dSAndy Shevchenko #endif /* CONFIG_ACPI */
3430a732d7dSAndy Shevchenko
344cd6484e1SRob Herring #endif /*_LINUX_SERDEV_H */
345