1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun * Copyright (C) 2015 Pengutronix, Uwe Kleine-König <kernel@pengutronix.de>
4*4882a593Smuzhiyun */
5*4882a593Smuzhiyun
6*4882a593Smuzhiyun #include <linux/device.h>
7*4882a593Smuzhiyun
8*4882a593Smuzhiyun #define to_siox_device(_dev) container_of((_dev), struct siox_device, dev)
9*4882a593Smuzhiyun struct siox_device {
10*4882a593Smuzhiyun struct list_head node; /* node in smaster->devices */
11*4882a593Smuzhiyun struct siox_master *smaster;
12*4882a593Smuzhiyun struct device dev;
13*4882a593Smuzhiyun
14*4882a593Smuzhiyun const char *type;
15*4882a593Smuzhiyun size_t inbytes;
16*4882a593Smuzhiyun size_t outbytes;
17*4882a593Smuzhiyun u8 statustype;
18*4882a593Smuzhiyun
19*4882a593Smuzhiyun u8 status_read_clean;
20*4882a593Smuzhiyun u8 status_written;
21*4882a593Smuzhiyun u8 status_written_lastcycle;
22*4882a593Smuzhiyun bool connected;
23*4882a593Smuzhiyun
24*4882a593Smuzhiyun /* statistics */
25*4882a593Smuzhiyun unsigned int watchdog_errors;
26*4882a593Smuzhiyun unsigned int status_errors;
27*4882a593Smuzhiyun
28*4882a593Smuzhiyun struct kernfs_node *status_errors_kn;
29*4882a593Smuzhiyun struct kernfs_node *watchdog_kn;
30*4882a593Smuzhiyun struct kernfs_node *watchdog_errors_kn;
31*4882a593Smuzhiyun struct kernfs_node *connected_kn;
32*4882a593Smuzhiyun };
33*4882a593Smuzhiyun
34*4882a593Smuzhiyun bool siox_device_synced(struct siox_device *sdevice);
35*4882a593Smuzhiyun bool siox_device_connected(struct siox_device *sdevice);
36*4882a593Smuzhiyun
37*4882a593Smuzhiyun struct siox_driver {
38*4882a593Smuzhiyun int (*probe)(struct siox_device *sdevice);
39*4882a593Smuzhiyun int (*remove)(struct siox_device *sdevice);
40*4882a593Smuzhiyun void (*shutdown)(struct siox_device *sdevice);
41*4882a593Smuzhiyun
42*4882a593Smuzhiyun /*
43*4882a593Smuzhiyun * buf is big enough to hold sdev->inbytes - 1 bytes, the status byte
44*4882a593Smuzhiyun * is in the scope of the framework.
45*4882a593Smuzhiyun */
46*4882a593Smuzhiyun int (*set_data)(struct siox_device *sdevice, u8 status, u8 buf[]);
47*4882a593Smuzhiyun /*
48*4882a593Smuzhiyun * buf is big enough to hold sdev->outbytes - 1 bytes, the status byte
49*4882a593Smuzhiyun * is in the scope of the framework
50*4882a593Smuzhiyun */
51*4882a593Smuzhiyun int (*get_data)(struct siox_device *sdevice, const u8 buf[]);
52*4882a593Smuzhiyun
53*4882a593Smuzhiyun struct device_driver driver;
54*4882a593Smuzhiyun };
55*4882a593Smuzhiyun
to_siox_driver(struct device_driver * driver)56*4882a593Smuzhiyun static inline struct siox_driver *to_siox_driver(struct device_driver *driver)
57*4882a593Smuzhiyun {
58*4882a593Smuzhiyun if (driver)
59*4882a593Smuzhiyun return container_of(driver, struct siox_driver, driver);
60*4882a593Smuzhiyun else
61*4882a593Smuzhiyun return NULL;
62*4882a593Smuzhiyun }
63*4882a593Smuzhiyun
64*4882a593Smuzhiyun int __siox_driver_register(struct siox_driver *sdriver, struct module *owner);
65*4882a593Smuzhiyun
siox_driver_register(struct siox_driver * sdriver)66*4882a593Smuzhiyun static inline int siox_driver_register(struct siox_driver *sdriver)
67*4882a593Smuzhiyun {
68*4882a593Smuzhiyun return __siox_driver_register(sdriver, THIS_MODULE);
69*4882a593Smuzhiyun }
70*4882a593Smuzhiyun
siox_driver_unregister(struct siox_driver * sdriver)71*4882a593Smuzhiyun static inline void siox_driver_unregister(struct siox_driver *sdriver)
72*4882a593Smuzhiyun {
73*4882a593Smuzhiyun return driver_unregister(&sdriver->driver);
74*4882a593Smuzhiyun }
75*4882a593Smuzhiyun
76*4882a593Smuzhiyun /*
77*4882a593Smuzhiyun * module_siox_driver() - Helper macro for drivers that don't do
78*4882a593Smuzhiyun * anything special in module init/exit. This eliminates a lot of
79*4882a593Smuzhiyun * boilerplate. Each module may only use this macro once, and
80*4882a593Smuzhiyun * calling it replaces module_init() and module_exit()
81*4882a593Smuzhiyun */
82*4882a593Smuzhiyun #define module_siox_driver(__siox_driver) \
83*4882a593Smuzhiyun module_driver(__siox_driver, siox_driver_register, \
84*4882a593Smuzhiyun siox_driver_unregister)
85