1 // SPDX-License-Identifier: GPL-2.0
3 * ulpi.c - USB ULPI PHY bus
5 * Copyright (C) 2015 Intel Corporation
7 * Author: Heikki Krogerus <heikki.krogerus@linux.intel.com>
10 #include <linux/ulpi/interface.h>
11 #include <linux/ulpi/driver.h>
12 #include <linux/ulpi/regs.h>
13 #include <linux/module.h>
14 #include <linux/slab.h>
15 #include <linux/acpi.h>
17 #include <linux/of_device.h>
18 #include <linux/clk/clk-conf.h>
20 /* -------------------------------------------------------------------------- */
22 int ulpi_read(struct ulpi *ulpi, u8 addr)
24 return ulpi->ops->read(ulpi->dev.parent, addr);
26 EXPORT_SYMBOL_GPL(ulpi_read);
28 int ulpi_write(struct ulpi *ulpi, u8 addr, u8 val)
30 return ulpi->ops->write(ulpi->dev.parent, addr, val);
32 EXPORT_SYMBOL_GPL(ulpi_write);
34 /* -------------------------------------------------------------------------- */
36 static int ulpi_match(struct device *dev, struct device_driver *driver)
38 struct ulpi_driver *drv = to_ulpi_driver(driver);
39 struct ulpi *ulpi = to_ulpi_dev(dev);
40 const struct ulpi_device_id *id;
42 /* Some ULPI devices don't have a vendor id so rely on OF match */
43 if (ulpi->id.vendor == 0)
44 return of_driver_match_device(dev, driver);
46 for (id = drv->id_table; id->vendor; id++)
47 if (id->vendor == ulpi->id.vendor &&
48 id->product == ulpi->id.product)
54 static int ulpi_uevent(struct device *dev, struct kobj_uevent_env *env)
56 struct ulpi *ulpi = to_ulpi_dev(dev);
59 ret = of_device_uevent_modalias(dev, env);
63 if (add_uevent_var(env, "MODALIAS=ulpi:v%04xp%04x",
64 ulpi->id.vendor, ulpi->id.product))
69 static int ulpi_probe(struct device *dev)
71 struct ulpi_driver *drv = to_ulpi_driver(dev->driver);
74 ret = of_clk_set_defaults(dev->of_node, false);
78 return drv->probe(to_ulpi_dev(dev));
81 static void ulpi_remove(struct device *dev)
83 struct ulpi_driver *drv = to_ulpi_driver(dev->driver);
86 drv->remove(to_ulpi_dev(dev));
89 static struct bus_type ulpi_bus = {
92 .uevent = ulpi_uevent,
94 .remove = ulpi_remove,
97 /* -------------------------------------------------------------------------- */
99 static ssize_t modalias_show(struct device *dev, struct device_attribute *attr,
103 struct ulpi *ulpi = to_ulpi_dev(dev);
105 len = of_device_modalias(dev, buf, PAGE_SIZE);
109 return sprintf(buf, "ulpi:v%04xp%04x\n",
110 ulpi->id.vendor, ulpi->id.product);
112 static DEVICE_ATTR_RO(modalias);
114 static struct attribute *ulpi_dev_attrs[] = {
115 &dev_attr_modalias.attr,
119 static const struct attribute_group ulpi_dev_attr_group = {
120 .attrs = ulpi_dev_attrs,
123 static const struct attribute_group *ulpi_dev_attr_groups[] = {
124 &ulpi_dev_attr_group,
128 static void ulpi_dev_release(struct device *dev)
130 kfree(to_ulpi_dev(dev));
133 static const struct device_type ulpi_dev_type = {
134 .name = "ulpi_device",
135 .groups = ulpi_dev_attr_groups,
136 .release = ulpi_dev_release,
139 /* -------------------------------------------------------------------------- */
142 * __ulpi_register_driver - register a driver with the ULPI bus
143 * @drv: driver being registered
144 * @module: ends up being THIS_MODULE
146 * Registers a driver with the ULPI bus.
148 int __ulpi_register_driver(struct ulpi_driver *drv, struct module *module)
153 drv->driver.owner = module;
154 drv->driver.bus = &ulpi_bus;
156 return driver_register(&drv->driver);
158 EXPORT_SYMBOL_GPL(__ulpi_register_driver);
161 * ulpi_unregister_driver - unregister a driver with the ULPI bus
162 * @drv: driver to unregister
164 * Unregisters a driver with the ULPI bus.
166 void ulpi_unregister_driver(struct ulpi_driver *drv)
168 driver_unregister(&drv->driver);
170 EXPORT_SYMBOL_GPL(ulpi_unregister_driver);
172 /* -------------------------------------------------------------------------- */
174 static int ulpi_of_register(struct ulpi *ulpi)
176 struct device_node *np = NULL, *child;
177 struct device *parent;
179 /* Find a ulpi bus underneath the parent or the grandparent */
180 parent = ulpi->dev.parent;
182 np = of_get_child_by_name(parent->of_node, "ulpi");
183 else if (parent->parent && parent->parent->of_node)
184 np = of_get_child_by_name(parent->parent->of_node, "ulpi");
188 child = of_get_next_available_child(np, NULL);
193 ulpi->dev.of_node = child;
198 static int ulpi_read_id(struct ulpi *ulpi)
202 /* Test the interface */
203 ret = ulpi_write(ulpi, ULPI_SCRATCH, 0xaa);
207 ret = ulpi_read(ulpi, ULPI_SCRATCH);
214 ulpi->id.vendor = ulpi_read(ulpi, ULPI_VENDOR_ID_LOW);
215 ulpi->id.vendor |= ulpi_read(ulpi, ULPI_VENDOR_ID_HIGH) << 8;
217 ulpi->id.product = ulpi_read(ulpi, ULPI_PRODUCT_ID_LOW);
218 ulpi->id.product |= ulpi_read(ulpi, ULPI_PRODUCT_ID_HIGH) << 8;
220 /* Some ULPI devices don't have a vendor id so rely on OF match */
221 if (ulpi->id.vendor == 0)
224 request_module("ulpi:v%04xp%04x", ulpi->id.vendor, ulpi->id.product);
227 of_device_request_module(&ulpi->dev);
231 static int ulpi_register(struct device *dev, struct ulpi *ulpi)
235 ulpi->dev.parent = dev; /* needed early for ops */
236 ulpi->dev.bus = &ulpi_bus;
237 ulpi->dev.type = &ulpi_dev_type;
238 dev_set_name(&ulpi->dev, "%s.ulpi", dev_name(dev));
240 ACPI_COMPANION_SET(&ulpi->dev, ACPI_COMPANION(dev));
242 ret = ulpi_of_register(ulpi);
246 ret = ulpi_read_id(ulpi);
250 ret = device_register(&ulpi->dev);
254 dev_dbg(&ulpi->dev, "registered ULPI PHY: vendor %04x, product %04x\n",
255 ulpi->id.vendor, ulpi->id.product);
261 * ulpi_register_interface - instantiate new ULPI device
262 * @dev: USB controller's device interface
263 * @ops: ULPI register access
265 * Allocates and registers a ULPI device and an interface for it. Called from
266 * the USB controller that provides the ULPI interface.
268 struct ulpi *ulpi_register_interface(struct device *dev,
269 const struct ulpi_ops *ops)
274 ulpi = kzalloc(sizeof(*ulpi), GFP_KERNEL);
276 return ERR_PTR(-ENOMEM);
280 ret = ulpi_register(dev, ulpi);
288 EXPORT_SYMBOL_GPL(ulpi_register_interface);
291 * ulpi_unregister_interface - unregister ULPI interface
292 * @ulpi: struct ulpi_interface
294 * Unregisters a ULPI device and it's interface that was created with
295 * ulpi_create_interface().
297 void ulpi_unregister_interface(struct ulpi *ulpi)
299 of_node_put(ulpi->dev.of_node);
300 device_unregister(&ulpi->dev);
302 EXPORT_SYMBOL_GPL(ulpi_unregister_interface);
304 /* -------------------------------------------------------------------------- */
306 static int __init ulpi_init(void)
308 return bus_register(&ulpi_bus);
310 subsys_initcall(ulpi_init);
312 static void __exit ulpi_exit(void)
314 bus_unregister(&ulpi_bus);
316 module_exit(ulpi_exit);
318 MODULE_AUTHOR("Intel Corporation");
319 MODULE_LICENSE("GPL v2");
320 MODULE_DESCRIPTION("USB ULPI PHY bus");