xref: /OK3568_Linux_fs/kernel/drivers/gnss/serial.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Generic serial GNSS receiver driver
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Copyright (C) 2018 Johan Hovold <johan@kernel.org>
6*4882a593Smuzhiyun  */
7*4882a593Smuzhiyun 
8*4882a593Smuzhiyun #ifndef _LINUX_GNSS_SERIAL_H
9*4882a593Smuzhiyun #define _LINUX_GNSS_SERIAL_H
10*4882a593Smuzhiyun 
11*4882a593Smuzhiyun #include <asm/termbits.h>
12*4882a593Smuzhiyun #include <linux/pm.h>
13*4882a593Smuzhiyun 
14*4882a593Smuzhiyun struct gnss_serial {
15*4882a593Smuzhiyun 	struct serdev_device *serdev;
16*4882a593Smuzhiyun 	struct gnss_device *gdev;
17*4882a593Smuzhiyun 	speed_t	speed;
18*4882a593Smuzhiyun 	const struct gnss_serial_ops *ops;
19*4882a593Smuzhiyun 	unsigned long drvdata[];
20*4882a593Smuzhiyun };
21*4882a593Smuzhiyun 
22*4882a593Smuzhiyun enum gnss_serial_pm_state {
23*4882a593Smuzhiyun 	GNSS_SERIAL_OFF,
24*4882a593Smuzhiyun 	GNSS_SERIAL_ACTIVE,
25*4882a593Smuzhiyun 	GNSS_SERIAL_STANDBY,
26*4882a593Smuzhiyun };
27*4882a593Smuzhiyun 
28*4882a593Smuzhiyun struct gnss_serial_ops {
29*4882a593Smuzhiyun 	int (*set_power)(struct gnss_serial *gserial,
30*4882a593Smuzhiyun 				enum gnss_serial_pm_state state);
31*4882a593Smuzhiyun };
32*4882a593Smuzhiyun 
33*4882a593Smuzhiyun extern const struct dev_pm_ops gnss_serial_pm_ops;
34*4882a593Smuzhiyun 
35*4882a593Smuzhiyun struct gnss_serial *gnss_serial_allocate(struct serdev_device *gserial,
36*4882a593Smuzhiyun 						size_t data_size);
37*4882a593Smuzhiyun void gnss_serial_free(struct gnss_serial *gserial);
38*4882a593Smuzhiyun 
39*4882a593Smuzhiyun int gnss_serial_register(struct gnss_serial *gserial);
40*4882a593Smuzhiyun void gnss_serial_deregister(struct gnss_serial *gserial);
41*4882a593Smuzhiyun 
gnss_serial_get_drvdata(struct gnss_serial * gserial)42*4882a593Smuzhiyun static inline void *gnss_serial_get_drvdata(struct gnss_serial *gserial)
43*4882a593Smuzhiyun {
44*4882a593Smuzhiyun 	return gserial->drvdata;
45*4882a593Smuzhiyun }
46*4882a593Smuzhiyun 
47*4882a593Smuzhiyun #endif /* _LINUX_GNSS_SERIAL_H */
48