xref: /OK3568_Linux_fs/kernel/include/linux/ulpi/driver.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun #ifndef __LINUX_ULPI_DRIVER_H
3*4882a593Smuzhiyun #define __LINUX_ULPI_DRIVER_H
4*4882a593Smuzhiyun 
5*4882a593Smuzhiyun #include <linux/mod_devicetable.h>
6*4882a593Smuzhiyun 
7*4882a593Smuzhiyun #include <linux/device.h>
8*4882a593Smuzhiyun 
9*4882a593Smuzhiyun struct ulpi_ops;
10*4882a593Smuzhiyun 
11*4882a593Smuzhiyun /**
12*4882a593Smuzhiyun  * struct ulpi - describes ULPI PHY device
13*4882a593Smuzhiyun  * @id: vendor and product ids for ULPI device
14*4882a593Smuzhiyun  * @ops: I/O access
15*4882a593Smuzhiyun  * @dev: device interface
16*4882a593Smuzhiyun  */
17*4882a593Smuzhiyun struct ulpi {
18*4882a593Smuzhiyun 	struct ulpi_device_id id;
19*4882a593Smuzhiyun 	const struct ulpi_ops *ops;
20*4882a593Smuzhiyun 	struct device dev;
21*4882a593Smuzhiyun };
22*4882a593Smuzhiyun 
23*4882a593Smuzhiyun #define to_ulpi_dev(d) container_of(d, struct ulpi, dev)
24*4882a593Smuzhiyun 
ulpi_set_drvdata(struct ulpi * ulpi,void * data)25*4882a593Smuzhiyun static inline void ulpi_set_drvdata(struct ulpi *ulpi, void *data)
26*4882a593Smuzhiyun {
27*4882a593Smuzhiyun 	dev_set_drvdata(&ulpi->dev, data);
28*4882a593Smuzhiyun }
29*4882a593Smuzhiyun 
ulpi_get_drvdata(struct ulpi * ulpi)30*4882a593Smuzhiyun static inline void *ulpi_get_drvdata(struct ulpi *ulpi)
31*4882a593Smuzhiyun {
32*4882a593Smuzhiyun 	return dev_get_drvdata(&ulpi->dev);
33*4882a593Smuzhiyun }
34*4882a593Smuzhiyun 
35*4882a593Smuzhiyun /**
36*4882a593Smuzhiyun  * struct ulpi_driver - describes a ULPI PHY driver
37*4882a593Smuzhiyun  * @id_table: array of device identifiers supported by this driver
38*4882a593Smuzhiyun  * @probe: binds this driver to ULPI device
39*4882a593Smuzhiyun  * @remove: unbinds this driver from ULPI device
40*4882a593Smuzhiyun  * @driver: the name and owner members must be initialized by the drivers
41*4882a593Smuzhiyun  */
42*4882a593Smuzhiyun struct ulpi_driver {
43*4882a593Smuzhiyun 	const struct ulpi_device_id *id_table;
44*4882a593Smuzhiyun 	int (*probe)(struct ulpi *ulpi);
45*4882a593Smuzhiyun 	void (*remove)(struct ulpi *ulpi);
46*4882a593Smuzhiyun 	struct device_driver driver;
47*4882a593Smuzhiyun };
48*4882a593Smuzhiyun 
49*4882a593Smuzhiyun #define to_ulpi_driver(d) container_of(d, struct ulpi_driver, driver)
50*4882a593Smuzhiyun 
51*4882a593Smuzhiyun /*
52*4882a593Smuzhiyun  * use a macro to avoid include chaining to get THIS_MODULE
53*4882a593Smuzhiyun  */
54*4882a593Smuzhiyun #define ulpi_register_driver(drv) __ulpi_register_driver(drv, THIS_MODULE)
55*4882a593Smuzhiyun int __ulpi_register_driver(struct ulpi_driver *drv, struct module *module);
56*4882a593Smuzhiyun void ulpi_unregister_driver(struct ulpi_driver *drv);
57*4882a593Smuzhiyun 
58*4882a593Smuzhiyun #define module_ulpi_driver(__ulpi_driver) \
59*4882a593Smuzhiyun 	module_driver(__ulpi_driver, ulpi_register_driver, \
60*4882a593Smuzhiyun 		      ulpi_unregister_driver)
61*4882a593Smuzhiyun 
62*4882a593Smuzhiyun int ulpi_read(struct ulpi *ulpi, u8 addr);
63*4882a593Smuzhiyun int ulpi_write(struct ulpi *ulpi, u8 addr, u8 val);
64*4882a593Smuzhiyun 
65*4882a593Smuzhiyun #endif /* __LINUX_ULPI_DRIVER_H */
66