1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun * Allwinner Reduced Serial Bus Driver
3*4882a593Smuzhiyun *
4*4882a593Smuzhiyun * Copyright (c) 2015 Chen-Yu Tsai
5*4882a593Smuzhiyun *
6*4882a593Smuzhiyun * Author: Chen-Yu Tsai <wens@csie.org>
7*4882a593Smuzhiyun *
8*4882a593Smuzhiyun * This file is licensed under the terms of the GNU General Public
9*4882a593Smuzhiyun * License version 2. This program is licensed "as is" without any
10*4882a593Smuzhiyun * warranty of any kind, whether express or implied.
11*4882a593Smuzhiyun */
12*4882a593Smuzhiyun #ifndef _SUNXI_RSB_H
13*4882a593Smuzhiyun #define _SUNXI_RSB_H
14*4882a593Smuzhiyun
15*4882a593Smuzhiyun #include <linux/device.h>
16*4882a593Smuzhiyun #include <linux/regmap.h>
17*4882a593Smuzhiyun #include <linux/types.h>
18*4882a593Smuzhiyun
19*4882a593Smuzhiyun struct sunxi_rsb;
20*4882a593Smuzhiyun
21*4882a593Smuzhiyun /**
22*4882a593Smuzhiyun * struct sunxi_rsb_device - Basic representation of an RSB device
23*4882a593Smuzhiyun * @dev: Driver model representation of the device.
24*4882a593Smuzhiyun * @ctrl: RSB controller managing the bus hosting this device.
25*4882a593Smuzhiyun * @rtaddr: This device's runtime address
26*4882a593Smuzhiyun * @hwaddr: This device's hardware address
27*4882a593Smuzhiyun */
28*4882a593Smuzhiyun struct sunxi_rsb_device {
29*4882a593Smuzhiyun struct device dev;
30*4882a593Smuzhiyun struct sunxi_rsb *rsb;
31*4882a593Smuzhiyun int irq;
32*4882a593Smuzhiyun u8 rtaddr;
33*4882a593Smuzhiyun u16 hwaddr;
34*4882a593Smuzhiyun };
35*4882a593Smuzhiyun
to_sunxi_rsb_device(struct device * d)36*4882a593Smuzhiyun static inline struct sunxi_rsb_device *to_sunxi_rsb_device(struct device *d)
37*4882a593Smuzhiyun {
38*4882a593Smuzhiyun return container_of(d, struct sunxi_rsb_device, dev);
39*4882a593Smuzhiyun }
40*4882a593Smuzhiyun
sunxi_rsb_device_get_drvdata(const struct sunxi_rsb_device * rdev)41*4882a593Smuzhiyun static inline void *sunxi_rsb_device_get_drvdata(const struct sunxi_rsb_device *rdev)
42*4882a593Smuzhiyun {
43*4882a593Smuzhiyun return dev_get_drvdata(&rdev->dev);
44*4882a593Smuzhiyun }
45*4882a593Smuzhiyun
sunxi_rsb_device_set_drvdata(struct sunxi_rsb_device * rdev,void * data)46*4882a593Smuzhiyun static inline void sunxi_rsb_device_set_drvdata(struct sunxi_rsb_device *rdev,
47*4882a593Smuzhiyun void *data)
48*4882a593Smuzhiyun {
49*4882a593Smuzhiyun dev_set_drvdata(&rdev->dev, data);
50*4882a593Smuzhiyun }
51*4882a593Smuzhiyun
52*4882a593Smuzhiyun /**
53*4882a593Smuzhiyun * struct sunxi_rsb_driver - RSB slave device driver
54*4882a593Smuzhiyun * @driver: RSB device drivers should initialize name and owner field of
55*4882a593Smuzhiyun * this structure.
56*4882a593Smuzhiyun * @probe: binds this driver to a RSB device.
57*4882a593Smuzhiyun * @remove: unbinds this driver from the RSB device.
58*4882a593Smuzhiyun */
59*4882a593Smuzhiyun struct sunxi_rsb_driver {
60*4882a593Smuzhiyun struct device_driver driver;
61*4882a593Smuzhiyun int (*probe)(struct sunxi_rsb_device *rdev);
62*4882a593Smuzhiyun int (*remove)(struct sunxi_rsb_device *rdev);
63*4882a593Smuzhiyun };
64*4882a593Smuzhiyun
to_sunxi_rsb_driver(struct device_driver * d)65*4882a593Smuzhiyun static inline struct sunxi_rsb_driver *to_sunxi_rsb_driver(struct device_driver *d)
66*4882a593Smuzhiyun {
67*4882a593Smuzhiyun return container_of(d, struct sunxi_rsb_driver, driver);
68*4882a593Smuzhiyun }
69*4882a593Smuzhiyun
70*4882a593Smuzhiyun int sunxi_rsb_driver_register(struct sunxi_rsb_driver *rdrv);
71*4882a593Smuzhiyun
72*4882a593Smuzhiyun /**
73*4882a593Smuzhiyun * sunxi_rsb_driver_unregister() - unregister an RSB client driver
74*4882a593Smuzhiyun * @rdrv: the driver to unregister
75*4882a593Smuzhiyun */
sunxi_rsb_driver_unregister(struct sunxi_rsb_driver * rdrv)76*4882a593Smuzhiyun static inline void sunxi_rsb_driver_unregister(struct sunxi_rsb_driver *rdrv)
77*4882a593Smuzhiyun {
78*4882a593Smuzhiyun if (rdrv)
79*4882a593Smuzhiyun driver_unregister(&rdrv->driver);
80*4882a593Smuzhiyun }
81*4882a593Smuzhiyun
82*4882a593Smuzhiyun #define module_sunxi_rsb_driver(__sunxi_rsb_driver) \
83*4882a593Smuzhiyun module_driver(__sunxi_rsb_driver, sunxi_rsb_driver_register, \
84*4882a593Smuzhiyun sunxi_rsb_driver_unregister)
85*4882a593Smuzhiyun
86*4882a593Smuzhiyun struct regmap *__devm_regmap_init_sunxi_rsb(struct sunxi_rsb_device *rdev,
87*4882a593Smuzhiyun const struct regmap_config *config,
88*4882a593Smuzhiyun struct lock_class_key *lock_key,
89*4882a593Smuzhiyun const char *lock_name);
90*4882a593Smuzhiyun
91*4882a593Smuzhiyun /**
92*4882a593Smuzhiyun * devm_regmap_init_sunxi_rsb(): Initialise managed register map
93*4882a593Smuzhiyun *
94*4882a593Smuzhiyun * @rdev: Device that will be interacted with
95*4882a593Smuzhiyun * @config: Configuration for register map
96*4882a593Smuzhiyun *
97*4882a593Smuzhiyun * The return value will be an ERR_PTR() on error or a valid pointer
98*4882a593Smuzhiyun * to a struct regmap. The regmap will be automatically freed by the
99*4882a593Smuzhiyun * device management code.
100*4882a593Smuzhiyun */
101*4882a593Smuzhiyun #define devm_regmap_init_sunxi_rsb(rdev, config) \
102*4882a593Smuzhiyun __regmap_lockdep_wrapper(__devm_regmap_init_sunxi_rsb, #config, \
103*4882a593Smuzhiyun rdev, config)
104*4882a593Smuzhiyun
105*4882a593Smuzhiyun #endif /* _SUNXI_RSB_H */
106