2 * Copyright (C) 2012 Avionic Design GmbH
3 * Copyright (C) 2012-2013, NVIDIA Corporation
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms and conditions of the GNU General Public License,
7 * version 2, as published by the Free Software Foundation.
9 * This program is distributed in the hope it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 #include <linux/host1x.h>
20 #include <linux/slab.h>
21 #include <linux/of_device.h>
26 static DEFINE_MUTEX(clients_lock);
27 static LIST_HEAD(clients);
29 static DEFINE_MUTEX(drivers_lock);
30 static LIST_HEAD(drivers);
32 static DEFINE_MUTEX(devices_lock);
33 static LIST_HEAD(devices);
35 struct host1x_subdev {
36 struct host1x_client *client;
37 struct device_node *np;
38 struct list_head list;
42 * host1x_subdev_add() - add a new subdevice with an associated device node
43 * @device: host1x device to add the subdevice to
46 static int host1x_subdev_add(struct host1x_device *device,
47 struct host1x_driver *driver,
48 struct device_node *np)
50 struct host1x_subdev *subdev;
51 struct device_node *child;
54 subdev = kzalloc(sizeof(*subdev), GFP_KERNEL);
58 INIT_LIST_HEAD(&subdev->list);
59 subdev->np = of_node_get(np);
61 mutex_lock(&device->subdevs_lock);
62 list_add_tail(&subdev->list, &device->subdevs);
63 mutex_unlock(&device->subdevs_lock);
65 /* recursively add children */
66 for_each_child_of_node(np, child) {
67 if (of_match_node(driver->subdevs, child) &&
68 of_device_is_available(child)) {
69 err = host1x_subdev_add(device, driver, child);
82 * host1x_subdev_del() - remove subdevice
83 * @subdev: subdevice to remove
85 static void host1x_subdev_del(struct host1x_subdev *subdev)
87 list_del(&subdev->list);
88 of_node_put(subdev->np);
93 * host1x_device_parse_dt() - scan device tree and add matching subdevices
94 * @device: host1x logical device
95 * @driver: host1x driver
97 static int host1x_device_parse_dt(struct host1x_device *device,
98 struct host1x_driver *driver)
100 struct device_node *np;
103 for_each_child_of_node(device->dev.parent->of_node, np) {
104 if (of_match_node(driver->subdevs, np) &&
105 of_device_is_available(np)) {
106 err = host1x_subdev_add(device, driver, np);
117 static void host1x_subdev_register(struct host1x_device *device,
118 struct host1x_subdev *subdev,
119 struct host1x_client *client)
124 * Move the subdevice to the list of active (registered) subdevices
125 * and associate it with a client. At the same time, associate the
126 * client with its parent device.
128 mutex_lock(&device->subdevs_lock);
129 mutex_lock(&device->clients_lock);
130 list_move_tail(&client->list, &device->clients);
131 list_move_tail(&subdev->list, &device->active);
132 client->parent = &device->dev;
133 subdev->client = client;
134 mutex_unlock(&device->clients_lock);
135 mutex_unlock(&device->subdevs_lock);
137 if (list_empty(&device->subdevs)) {
138 err = device_add(&device->dev);
140 dev_err(&device->dev, "failed to add: %d\n", err);
142 device->registered = true;
146 static void __host1x_subdev_unregister(struct host1x_device *device,
147 struct host1x_subdev *subdev)
149 struct host1x_client *client = subdev->client;
152 * If all subdevices have been activated, we're about to remove the
153 * first active subdevice, so unload the driver first.
155 if (list_empty(&device->subdevs)) {
156 if (device->registered) {
157 device->registered = false;
158 device_del(&device->dev);
163 * Move the subdevice back to the list of idle subdevices and remove
164 * it from list of clients.
166 mutex_lock(&device->clients_lock);
167 subdev->client = NULL;
168 client->parent = NULL;
169 list_move_tail(&subdev->list, &device->subdevs);
171 * XXX: Perhaps don't do this here, but rather explicitly remove it
172 * when the device is about to be deleted.
174 * This is somewhat complicated by the fact that this function is
175 * used to remove the subdevice when a client is unregistered but
176 * also when the composite device is about to be removed.
178 list_del_init(&client->list);
179 mutex_unlock(&device->clients_lock);
182 static void host1x_subdev_unregister(struct host1x_device *device,
183 struct host1x_subdev *subdev)
185 mutex_lock(&device->subdevs_lock);
186 __host1x_subdev_unregister(device, subdev);
187 mutex_unlock(&device->subdevs_lock);
191 * host1x_device_init() - initialize a host1x logical device
192 * @device: host1x logical device
194 * The driver for the host1x logical device can call this during execution of
195 * its &host1x_driver.probe implementation to initialize each of its clients.
196 * The client drivers access the subsystem specific driver data using the
197 * &host1x_client.parent field and driver data associated with it (usually by
198 * calling dev_get_drvdata()).
200 int host1x_device_init(struct host1x_device *device)
202 struct host1x_client *client;
205 mutex_lock(&device->clients_lock);
207 list_for_each_entry(client, &device->clients, list) {
208 if (client->ops && client->ops->init) {
209 err = client->ops->init(client);
211 dev_err(&device->dev,
212 "failed to initialize %s: %d\n",
213 dev_name(client->dev), err);
214 mutex_unlock(&device->clients_lock);
220 mutex_unlock(&device->clients_lock);
224 EXPORT_SYMBOL(host1x_device_init);
227 * host1x_device_exit() - uninitialize host1x logical device
228 * @device: host1x logical device
230 * When the driver for a host1x logical device is unloaded, it can call this
231 * function to tear down each of its clients. Typically this is done after a
232 * subsystem-specific data structure is removed and the functionality can no
235 int host1x_device_exit(struct host1x_device *device)
237 struct host1x_client *client;
240 mutex_lock(&device->clients_lock);
242 list_for_each_entry_reverse(client, &device->clients, list) {
243 if (client->ops && client->ops->exit) {
244 err = client->ops->exit(client);
246 dev_err(&device->dev,
247 "failed to cleanup %s: %d\n",
248 dev_name(client->dev), err);
249 mutex_unlock(&device->clients_lock);
255 mutex_unlock(&device->clients_lock);
259 EXPORT_SYMBOL(host1x_device_exit);
261 static int host1x_add_client(struct host1x *host1x,
262 struct host1x_client *client)
264 struct host1x_device *device;
265 struct host1x_subdev *subdev;
267 mutex_lock(&host1x->devices_lock);
269 list_for_each_entry(device, &host1x->devices, list) {
270 list_for_each_entry(subdev, &device->subdevs, list) {
271 if (subdev->np == client->dev->of_node) {
272 host1x_subdev_register(device, subdev, client);
273 mutex_unlock(&host1x->devices_lock);
279 mutex_unlock(&host1x->devices_lock);
283 static int host1x_del_client(struct host1x *host1x,
284 struct host1x_client *client)
286 struct host1x_device *device, *dt;
287 struct host1x_subdev *subdev;
289 mutex_lock(&host1x->devices_lock);
291 list_for_each_entry_safe(device, dt, &host1x->devices, list) {
292 list_for_each_entry(subdev, &device->active, list) {
293 if (subdev->client == client) {
294 host1x_subdev_unregister(device, subdev);
295 mutex_unlock(&host1x->devices_lock);
301 mutex_unlock(&host1x->devices_lock);
305 static int host1x_device_match(struct device *dev, struct device_driver *drv)
307 return strcmp(dev_name(dev), drv->name) == 0;
310 static const struct dev_pm_ops host1x_device_pm_ops = {
311 .suspend = pm_generic_suspend,
312 .resume = pm_generic_resume,
313 .freeze = pm_generic_freeze,
314 .thaw = pm_generic_thaw,
315 .poweroff = pm_generic_poweroff,
316 .restore = pm_generic_restore,
319 struct bus_type host1x_bus_type = {
321 .match = host1x_device_match,
322 .pm = &host1x_device_pm_ops,
325 static void __host1x_device_del(struct host1x_device *device)
327 struct host1x_subdev *subdev, *sd;
328 struct host1x_client *client, *cl;
330 mutex_lock(&device->subdevs_lock);
332 /* unregister subdevices */
333 list_for_each_entry_safe(subdev, sd, &device->active, list) {
335 * host1x_subdev_unregister() will remove the client from
336 * any lists, so we'll need to manually add it back to the
337 * list of idle clients.
339 * XXX: Alternatively, perhaps don't remove the client from
340 * any lists in host1x_subdev_unregister() and instead do
341 * that explicitly from host1x_unregister_client()?
343 client = subdev->client;
345 __host1x_subdev_unregister(device, subdev);
347 /* add the client to the list of idle clients */
348 mutex_lock(&clients_lock);
349 list_add_tail(&client->list, &clients);
350 mutex_unlock(&clients_lock);
353 /* remove subdevices */
354 list_for_each_entry_safe(subdev, sd, &device->subdevs, list)
355 host1x_subdev_del(subdev);
357 mutex_unlock(&device->subdevs_lock);
359 /* move clients to idle list */
360 mutex_lock(&clients_lock);
361 mutex_lock(&device->clients_lock);
363 list_for_each_entry_safe(client, cl, &device->clients, list)
364 list_move_tail(&client->list, &clients);
366 mutex_unlock(&device->clients_lock);
367 mutex_unlock(&clients_lock);
369 /* finally remove the device */
370 list_del_init(&device->list);
373 static void host1x_device_release(struct device *dev)
375 struct host1x_device *device = to_host1x_device(dev);
377 __host1x_device_del(device);
381 static int host1x_device_add(struct host1x *host1x,
382 struct host1x_driver *driver)
384 struct host1x_client *client, *tmp;
385 struct host1x_subdev *subdev;
386 struct host1x_device *device;
389 device = kzalloc(sizeof(*device), GFP_KERNEL);
393 device_initialize(&device->dev);
395 mutex_init(&device->subdevs_lock);
396 INIT_LIST_HEAD(&device->subdevs);
397 INIT_LIST_HEAD(&device->active);
398 mutex_init(&device->clients_lock);
399 INIT_LIST_HEAD(&device->clients);
400 INIT_LIST_HEAD(&device->list);
401 device->driver = driver;
403 device->dev.coherent_dma_mask = host1x->dev->coherent_dma_mask;
404 device->dev.dma_mask = &device->dev.coherent_dma_mask;
405 dev_set_name(&device->dev, "%s", driver->driver.name);
406 of_dma_configure(&device->dev, host1x->dev->of_node);
407 device->dev.release = host1x_device_release;
408 device->dev.of_node = host1x->dev->of_node;
409 device->dev.bus = &host1x_bus_type;
410 device->dev.parent = host1x->dev;
412 err = host1x_device_parse_dt(device, driver);
418 list_add_tail(&device->list, &host1x->devices);
420 mutex_lock(&clients_lock);
422 list_for_each_entry_safe(client, tmp, &clients, list) {
423 list_for_each_entry(subdev, &device->subdevs, list) {
424 if (subdev->np == client->dev->of_node) {
425 host1x_subdev_register(device, subdev, client);
431 mutex_unlock(&clients_lock);
437 * Removes a device by first unregistering any subdevices and then removing
438 * itself from the list of devices.
440 * This function must be called with the host1x->devices_lock held.
442 static void host1x_device_del(struct host1x *host1x,
443 struct host1x_device *device)
445 if (device->registered) {
446 device->registered = false;
447 device_del(&device->dev);
450 put_device(&device->dev);
453 static void host1x_attach_driver(struct host1x *host1x,
454 struct host1x_driver *driver)
456 struct host1x_device *device;
459 mutex_lock(&host1x->devices_lock);
461 list_for_each_entry(device, &host1x->devices, list) {
462 if (device->driver == driver) {
463 mutex_unlock(&host1x->devices_lock);
468 err = host1x_device_add(host1x, driver);
470 dev_err(host1x->dev, "failed to allocate device: %d\n", err);
472 mutex_unlock(&host1x->devices_lock);
475 static void host1x_detach_driver(struct host1x *host1x,
476 struct host1x_driver *driver)
478 struct host1x_device *device, *tmp;
480 mutex_lock(&host1x->devices_lock);
482 list_for_each_entry_safe(device, tmp, &host1x->devices, list)
483 if (device->driver == driver)
484 host1x_device_del(host1x, device);
486 mutex_unlock(&host1x->devices_lock);
490 * host1x_register() - register a host1x controller
491 * @host1x: host1x controller
493 * The host1x controller driver uses this to register a host1x controller with
494 * the infrastructure. Note that all Tegra SoC generations have only ever come
495 * with a single host1x instance, so this function is somewhat academic.
497 int host1x_register(struct host1x *host1x)
499 struct host1x_driver *driver;
501 mutex_lock(&devices_lock);
502 list_add_tail(&host1x->list, &devices);
503 mutex_unlock(&devices_lock);
505 mutex_lock(&drivers_lock);
507 list_for_each_entry(driver, &drivers, list)
508 host1x_attach_driver(host1x, driver);
510 mutex_unlock(&drivers_lock);
516 * host1x_unregister() - unregister a host1x controller
517 * @host1x: host1x controller
519 * The host1x controller driver uses this to remove a host1x controller from
520 * the infrastructure.
522 int host1x_unregister(struct host1x *host1x)
524 struct host1x_driver *driver;
526 mutex_lock(&drivers_lock);
528 list_for_each_entry(driver, &drivers, list)
529 host1x_detach_driver(host1x, driver);
531 mutex_unlock(&drivers_lock);
533 mutex_lock(&devices_lock);
534 list_del_init(&host1x->list);
535 mutex_unlock(&devices_lock);
540 static int host1x_device_probe(struct device *dev)
542 struct host1x_driver *driver = to_host1x_driver(dev->driver);
543 struct host1x_device *device = to_host1x_device(dev);
546 return driver->probe(device);
551 static int host1x_device_remove(struct device *dev)
553 struct host1x_driver *driver = to_host1x_driver(dev->driver);
554 struct host1x_device *device = to_host1x_device(dev);
557 return driver->remove(device);
562 static void host1x_device_shutdown(struct device *dev)
564 struct host1x_driver *driver = to_host1x_driver(dev->driver);
565 struct host1x_device *device = to_host1x_device(dev);
567 if (driver->shutdown)
568 driver->shutdown(device);
572 * host1x_driver_register_full() - register a host1x driver
573 * @driver: host1x driver
574 * @owner: owner module
576 * Drivers for host1x logical devices call this function to register a driver
577 * with the infrastructure. Note that since these drive logical devices, the
578 * registration of the driver actually triggers tho logical device creation.
579 * A logical device will be created for each host1x instance.
581 int host1x_driver_register_full(struct host1x_driver *driver,
582 struct module *owner)
584 struct host1x *host1x;
586 INIT_LIST_HEAD(&driver->list);
588 mutex_lock(&drivers_lock);
589 list_add_tail(&driver->list, &drivers);
590 mutex_unlock(&drivers_lock);
592 mutex_lock(&devices_lock);
594 list_for_each_entry(host1x, &devices, list)
595 host1x_attach_driver(host1x, driver);
597 mutex_unlock(&devices_lock);
599 driver->driver.bus = &host1x_bus_type;
600 driver->driver.owner = owner;
601 driver->driver.probe = host1x_device_probe;
602 driver->driver.remove = host1x_device_remove;
603 driver->driver.shutdown = host1x_device_shutdown;
605 return driver_register(&driver->driver);
607 EXPORT_SYMBOL(host1x_driver_register_full);
610 * host1x_driver_unregister() - unregister a host1x driver
611 * @driver: host1x driver
613 * Unbinds the driver from each of the host1x logical devices that it is
614 * bound to, effectively removing the subsystem devices that they represent.
616 void host1x_driver_unregister(struct host1x_driver *driver)
618 struct host1x *host1x;
620 driver_unregister(&driver->driver);
622 mutex_lock(&devices_lock);
624 list_for_each_entry(host1x, &devices, list)
625 host1x_detach_driver(host1x, driver);
627 mutex_unlock(&devices_lock);
629 mutex_lock(&drivers_lock);
630 list_del_init(&driver->list);
631 mutex_unlock(&drivers_lock);
633 EXPORT_SYMBOL(host1x_driver_unregister);
636 * host1x_client_register() - register a host1x client
637 * @client: host1x client
639 * Registers a host1x client with each host1x controller instance. Note that
640 * each client will only match their parent host1x controller and will only be
641 * associated with that instance. Once all clients have been registered with
642 * their parent host1x controller, the infrastructure will set up the logical
643 * device and call host1x_device_init(), which will in turn call each client's
644 * &host1x_client_ops.init implementation.
646 int host1x_client_register(struct host1x_client *client)
648 struct host1x *host1x;
651 mutex_lock(&devices_lock);
653 list_for_each_entry(host1x, &devices, list) {
654 err = host1x_add_client(host1x, client);
656 mutex_unlock(&devices_lock);
661 mutex_unlock(&devices_lock);
663 mutex_lock(&clients_lock);
664 list_add_tail(&client->list, &clients);
665 mutex_unlock(&clients_lock);
669 EXPORT_SYMBOL(host1x_client_register);
672 * host1x_client_unregister() - unregister a host1x client
673 * @client: host1x client
675 * Removes a host1x client from its host1x controller instance. If a logical
676 * device has already been initialized, it will be torn down.
678 int host1x_client_unregister(struct host1x_client *client)
680 struct host1x_client *c;
681 struct host1x *host1x;
684 mutex_lock(&devices_lock);
686 list_for_each_entry(host1x, &devices, list) {
687 err = host1x_del_client(host1x, client);
689 mutex_unlock(&devices_lock);
694 mutex_unlock(&devices_lock);
695 mutex_lock(&clients_lock);
697 list_for_each_entry(c, &clients, list) {
699 list_del_init(&c->list);
704 mutex_unlock(&clients_lock);
708 EXPORT_SYMBOL(host1x_client_unregister);