[deliverable/linux.git] / drivers / media / media-device.c

/*
 * Media device
 *
 * Copyright (C) 2010 Nokia Corporation
 *
 * Contacts: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
 *	     Sakari Ailus <sakari.ailus@iki.fi>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#include <linux/compat.h>
#include <linux/export.h>
#include <linux/ioctl.h>
#include <linux/media.h>
#include <linux/types.h>
#include <linux/slab.h>

#include <media/media-device.h>
#include <media/media-devnode.h>
#include <media/media-entity.h>

#ifdef CONFIG_MEDIA_CONTROLLER

/* -----------------------------------------------------------------------------
 * Userspace API
 */

static int media_device_open(struct file *filp)
{
	return 0;
}

static int media_device_close(struct file *filp)
{
	return 0;
}

static int media_device_get_info(struct media_device *dev,
				 struct media_device_info __user *__info)
{
	struct media_device_info info;

	memset(&info, 0, sizeof(info));

	strlcpy(info.driver, dev->dev->driver->name, sizeof(info.driver));
	strlcpy(info.model, dev->model, sizeof(info.model));
	strlcpy(info.serial, dev->serial, sizeof(info.serial));
	strlcpy(info.bus_info, dev->bus_info, sizeof(info.bus_info));

	info.media_version = MEDIA_API_VERSION;
	info.hw_revision = dev->hw_revision;
	info.driver_version = dev->driver_version;

	if (copy_to_user(__info, &info, sizeof(*__info)))
		return -EFAULT;
	return 0;
}

static struct media_entity *find_entity(struct media_device *mdev, u32 id)
{
	struct media_entity *entity;
	int next = id & MEDIA_ENT_ID_FLAG_NEXT;

	id &= ~MEDIA_ENT_ID_FLAG_NEXT;

	spin_lock(&mdev->lock);

	media_device_for_each_entity(entity, mdev) {
		if (((media_entity_id(entity) == id) && !next) ||
		    ((media_entity_id(entity) > id) && next)) {
			spin_unlock(&mdev->lock);
			return entity;
		}
	}

	spin_unlock(&mdev->lock);

	return NULL;
}

static long media_device_enum_entities(struct media_device *mdev,
				       struct media_entity_desc __user *uent)
{
	struct media_entity *ent;
	struct media_entity_desc u_ent;

	memset(&u_ent, 0, sizeof(u_ent));
	if (copy_from_user(&u_ent.id, &uent->id, sizeof(u_ent.id)))
		return -EFAULT;

	ent = find_entity(mdev, u_ent.id);

	if (ent == NULL)
		return -EINVAL;

	u_ent.id = media_entity_id(ent);
	if (ent->name)
		strlcpy(u_ent.name, ent->name, sizeof(u_ent.name));
	u_ent.type = ent->function;
	u_ent.revision = ent->revision;
	u_ent.flags = ent->flags;
	u_ent.group_id = ent->group_id;
	u_ent.pads = ent->num_pads;
	u_ent.links = ent->num_links - ent->num_backlinks;
	memcpy(&u_ent.raw, &ent->info, sizeof(ent->info));
	if (copy_to_user(uent, &u_ent, sizeof(u_ent)))
		return -EFAULT;
	return 0;
}

static void media_device_kpad_to_upad(const struct media_pad *kpad,
				      struct media_pad_desc *upad)
{
	upad->entity = media_entity_id(kpad->entity);
	upad->index = kpad->index;
	upad->flags = kpad->flags;
}

static long __media_device_enum_links(struct media_device *mdev,
				      struct media_links_enum *links)
{
	struct media_entity *entity;

	entity = find_entity(mdev, links->entity);
	if (entity == NULL)
		return -EINVAL;

	if (links->pads) {
		unsigned int p;

		for (p = 0; p < entity->num_pads; p++) {
			struct media_pad_desc pad;

			memset(&pad, 0, sizeof(pad));
			media_device_kpad_to_upad(&entity->pads[p], &pad);
			if (copy_to_user(&links->pads[p], &pad, sizeof(pad)))
				return -EFAULT;
		}
	}

	if (links->links) {
		struct media_link *ent_link;
		struct media_link_desc __user *ulink = links->links;

		list_for_each_entry(ent_link, &entity->links, list) {
			struct media_link_desc link;

			/* Ignore backlinks. */
			if (ent_link->source->entity != entity)
				continue;
			memset(&link, 0, sizeof(link));
			media_device_kpad_to_upad(ent_link->source,
						  &link.source);
			media_device_kpad_to_upad(ent_link->sink,
						  &link.sink);
			link.flags = ent_link->flags;
			if (copy_to_user(ulink, &link, sizeof(*ulink)))
				return -EFAULT;
			ulink++;
		}
	}

	return 0;
}

static long media_device_enum_links(struct media_device *mdev,
				    struct media_links_enum __user *ulinks)
{
	struct media_links_enum links;
	int rval;

	if (copy_from_user(&links, ulinks, sizeof(links)))
		return -EFAULT;

	rval = __media_device_enum_links(mdev, &links);
	if (rval < 0)
		return rval;

	if (copy_to_user(ulinks, &links, sizeof(*ulinks)))
		return -EFAULT;

	return 0;
}

static long media_device_setup_link(struct media_device *mdev,
				    struct media_link_desc __user *_ulink)
{
	struct media_link *link = NULL;
	struct media_link_desc ulink;
	struct media_entity *source;
	struct media_entity *sink;
	int ret;

	if (copy_from_user(&ulink, _ulink, sizeof(ulink)))
		return -EFAULT;

	/* Find the source and sink entities and link.
	 */
	source = find_entity(mdev, ulink.source.entity);
	sink = find_entity(mdev, ulink.sink.entity);

	if (source == NULL || sink == NULL)
		return -EINVAL;

	if (ulink.source.index >= source->num_pads ||
	    ulink.sink.index >= sink->num_pads)
		return -EINVAL;

	link = media_entity_find_link(&source->pads[ulink.source.index],
				      &sink->pads[ulink.sink.index]);
	if (link == NULL)
		return -EINVAL;

	/* Setup the link on both entities. */
	ret = __media_entity_setup_link(link, ulink.flags);

	if (copy_to_user(_ulink, &ulink, sizeof(ulink)))
		return -EFAULT;

	return ret;
}

static long __media_device_get_topology(struct media_device *mdev,
				      struct media_v2_topology *topo)
{
	struct media_entity *entity;
	struct media_interface *intf;
	struct media_pad *pad;
	struct media_link *link;
	struct media_v2_entity uentity;
	struct media_v2_interface uintf;
	struct media_v2_pad upad;
	struct media_v2_link ulink;
	int ret = 0, i;

	topo->topology_version = mdev->topology_version;

	/* Get entities and number of entities */
	i = 0;
	media_device_for_each_entity(entity, mdev) {
		i++;

		if (ret || !topo->entities)
			continue;

		if (i > topo->num_entities) {
			ret = -ENOSPC;
			continue;
		}

		/* Copy fields to userspace struct if not error */
		memset(&uentity, 0, sizeof(uentity));
		uentity.id = entity->graph_obj.id;
		uentity.function = entity->function;
		strncpy(uentity.name, entity->name,
			sizeof(uentity.name));

		if (copy_to_user(&topo->entities[i - 1], &uentity, sizeof(uentity)))
			ret = -EFAULT;
	}
	topo->num_entities = i;

	/* Get interfaces and number of interfaces */
	i = 0;
	media_device_for_each_intf(intf, mdev) {
		i++;

		if (ret || !topo->interfaces)
			continue;

		if (i > topo->num_interfaces) {
			ret = -ENOSPC;
			continue;
		}

		memset(&uintf, 0, sizeof(uintf));

		/* Copy intf fields to userspace struct */
		uintf.id = intf->graph_obj.id;
		uintf.intf_type = intf->type;
		uintf.flags = intf->flags;

		if (media_type(&intf->graph_obj) == MEDIA_GRAPH_INTF_DEVNODE) {
			struct media_intf_devnode *devnode;

			devnode = intf_to_devnode(intf);

			uintf.devnode.major = devnode->major;
			uintf.devnode.minor = devnode->minor;
		}

		if (copy_to_user(&topo->interfaces[i - 1], &uintf, sizeof(uintf)))
			ret = -EFAULT;
	}
	topo->num_interfaces = i;

	/* Get pads and number of pads */
	i = 0;
	media_device_for_each_pad(pad, mdev) {
		i++;

		if (ret || !topo->pads)
			continue;

		if (i > topo->num_pads) {
			ret = -ENOSPC;
			continue;
		}

		memset(&upad, 0, sizeof(upad));

		/* Copy pad fields to userspace struct */
		upad.id = pad->graph_obj.id;
		upad.entity_id = pad->entity->graph_obj.id;
		upad.flags = pad->flags;

		if (copy_to_user(&topo->pads[i - 1], &upad, sizeof(upad)))
			ret = -EFAULT;
	}
	topo->num_pads = i;

	/* Get links and number of links */
	i = 0;
	media_device_for_each_link(link, mdev) {
		if (link->is_backlink)
			continue;

		i++;

		if (ret || !topo->links)
			continue;

		if (i > topo->num_links) {
			ret = -ENOSPC;
			continue;
		}

		memset(&ulink, 0, sizeof(ulink));

		/* Copy link fields to userspace struct */
		ulink.id = link->graph_obj.id;
		ulink.source_id = link->gobj0->id;
		ulink.sink_id = link->gobj1->id;
		ulink.flags = link->flags;

		if (media_type(link->gobj0) != MEDIA_GRAPH_PAD)
			ulink.flags |= MEDIA_LNK_FL_INTERFACE_LINK;

		if (copy_to_user(&topo->links[i - 1], &ulink, sizeof(ulink)))
			ret = -EFAULT;
	}
	topo->num_links = i;

	return ret;
}

static long media_device_get_topology(struct media_device *mdev,
				      struct media_v2_topology __user *utopo)
{
	struct media_v2_topology ktopo;
	int ret;

	ret = copy_from_user(&ktopo, utopo, sizeof(ktopo));

	if (ret < 0)
		return ret;

	ret = __media_device_get_topology(mdev, &ktopo);
	if (ret < 0)
		return ret;

	ret = copy_to_user(utopo, &ktopo, sizeof(*utopo));

	return ret;
}

static long media_device_ioctl(struct file *filp, unsigned int cmd,
			       unsigned long arg)
{
	struct media_devnode *devnode = media_devnode_data(filp);
	struct media_device *dev = to_media_device(devnode);
	long ret;

	switch (cmd) {
	case MEDIA_IOC_DEVICE_INFO:
		ret = media_device_get_info(dev,
				(struct media_device_info __user *)arg);
		break;

	case MEDIA_IOC_ENUM_ENTITIES:
		ret = media_device_enum_entities(dev,
				(struct media_entity_desc __user *)arg);
		break;

	case MEDIA_IOC_ENUM_LINKS:
		mutex_lock(&dev->graph_mutex);
		ret = media_device_enum_links(dev,
				(struct media_links_enum __user *)arg);
		mutex_unlock(&dev->graph_mutex);
		break;

	case MEDIA_IOC_SETUP_LINK:
		mutex_lock(&dev->graph_mutex);
		ret = media_device_setup_link(dev,
				(struct media_link_desc __user *)arg);
		mutex_unlock(&dev->graph_mutex);
		break;

	case MEDIA_IOC_G_TOPOLOGY:
		mutex_lock(&dev->graph_mutex);
		ret = media_device_get_topology(dev,
				(struct media_v2_topology __user *)arg);
		mutex_unlock(&dev->graph_mutex);
		break;

	default:
		ret = -ENOIOCTLCMD;
	}

	return ret;
}

#ifdef CONFIG_COMPAT

struct media_links_enum32 {
	__u32 entity;
	compat_uptr_t pads; /* struct media_pad_desc * */
	compat_uptr_t links; /* struct media_link_desc * */
	__u32 reserved[4];
};

static long media_device_enum_links32(struct media_device *mdev,
				      struct media_links_enum32 __user *ulinks)
{
	struct media_links_enum links;
	compat_uptr_t pads_ptr, links_ptr;

	memset(&links, 0, sizeof(links));

	if (get_user(links.entity, &ulinks->entity)
	    || get_user(pads_ptr, &ulinks->pads)
	    || get_user(links_ptr, &ulinks->links))
		return -EFAULT;

	links.pads = compat_ptr(pads_ptr);
	links.links = compat_ptr(links_ptr);

	return __media_device_enum_links(mdev, &links);
}

#define MEDIA_IOC_ENUM_LINKS32		_IOWR('|', 0x02, struct media_links_enum32)

static long media_device_compat_ioctl(struct file *filp, unsigned int cmd,
				      unsigned long arg)
{
	struct media_devnode *devnode = media_devnode_data(filp);
	struct media_device *dev = to_media_device(devnode);
	long ret;

	switch (cmd) {
	case MEDIA_IOC_DEVICE_INFO:
	case MEDIA_IOC_ENUM_ENTITIES:
	case MEDIA_IOC_SETUP_LINK:
	case MEDIA_IOC_G_TOPOLOGY:
		return media_device_ioctl(filp, cmd, arg);

	case MEDIA_IOC_ENUM_LINKS32:
		mutex_lock(&dev->graph_mutex);
		ret = media_device_enum_links32(dev,
				(struct media_links_enum32 __user *)arg);
		mutex_unlock(&dev->graph_mutex);
		break;

	default:
		ret = -ENOIOCTLCMD;
	}

	return ret;
}
#endif /* CONFIG_COMPAT */

static const struct media_file_operations media_device_fops = {
	.owner = THIS_MODULE,
	.open = media_device_open,
	.ioctl = media_device_ioctl,
#ifdef CONFIG_COMPAT
	.compat_ioctl = media_device_compat_ioctl,
#endif /* CONFIG_COMPAT */
	.release = media_device_close,
};

/* -----------------------------------------------------------------------------
 * sysfs
 */

static ssize_t show_model(struct device *cd,
			  struct device_attribute *attr, char *buf)
{
	struct media_device *mdev = to_media_device(to_media_devnode(cd));

	return sprintf(buf, "%.*s\n", (int)sizeof(mdev->model), mdev->model);
}

static DEVICE_ATTR(model, S_IRUGO, show_model, NULL);

/* -----------------------------------------------------------------------------
 * Registration/unregistration
 */

static void media_device_release(struct media_devnode *mdev)
{
	dev_dbg(mdev->parent, "Media device released\n");
}

/**
 * media_device_register - register a media device
 * @mdev:	The media device
 *
 * The caller is responsible for initializing the media device before
 * registration. The following fields must be set:
 *
 * - dev must point to the parent device
 * - model must be filled with the device model name
 */
int __must_check __media_device_register(struct media_device *mdev,
					 struct module *owner)
{
	int ret;

	if (WARN_ON(mdev->dev == NULL || mdev->model[0] == 0))
		return -EINVAL;

	INIT_LIST_HEAD(&mdev->entities);
	INIT_LIST_HEAD(&mdev->interfaces);
	INIT_LIST_HEAD(&mdev->pads);
	INIT_LIST_HEAD(&mdev->links);
	spin_lock_init(&mdev->lock);
	mutex_init(&mdev->graph_mutex);

	/* Register the device node. */
	mdev->devnode.fops = &media_device_fops;
	mdev->devnode.parent = mdev->dev;
	mdev->devnode.release = media_device_release;
	ret = media_devnode_register(&mdev->devnode, owner);
	if (ret < 0)
		return ret;

	ret = device_create_file(&mdev->devnode.dev, &dev_attr_model);
	if (ret < 0) {
		media_devnode_unregister(&mdev->devnode);
		return ret;
	}

	dev_dbg(mdev->dev, "Media device registered\n");

	return 0;
}
EXPORT_SYMBOL_GPL(__media_device_register);

/**
 * media_device_unregister - unregister a media device
 * @mdev:	The media device
 *
 */
void media_device_unregister(struct media_device *mdev)
{
	struct media_entity *entity;
	struct media_entity *next;
	struct media_interface *intf, *tmp_intf;

	/* Remove all entities from the media device */
	list_for_each_entry_safe(entity, next, &mdev->entities, graph_obj.list)
		media_device_unregister_entity(entity);

	/* Remove all interfaces from the media device */
	spin_lock(&mdev->lock);
	list_for_each_entry_safe(intf, tmp_intf, &mdev->interfaces,
				 graph_obj.list) {
		__media_remove_intf_links(intf);
		media_gobj_remove(&intf->graph_obj);
		kfree(intf);
	}
	spin_unlock(&mdev->lock);

	device_remove_file(&mdev->devnode.dev, &dev_attr_model);
	media_devnode_unregister(&mdev->devnode);

	dev_dbg(mdev->dev, "Media device unregistered\n");
}
EXPORT_SYMBOL_GPL(media_device_unregister);

/**
 * media_device_register_entity - Register an entity with a media device
 * @mdev:	The media device
 * @entity:	The entity
 */
int __must_check media_device_register_entity(struct media_device *mdev,
					      struct media_entity *entity)
{
	int i;

	if (entity->function == MEDIA_ENT_F_V4L2_SUBDEV_UNKNOWN ||
	    entity->function == MEDIA_ENT_F_UNKNOWN)
		dev_warn(mdev->dev,
			 "Entity type for entity %s was not initialized!\n",
			 entity->name);

	/* Warn if we apparently re-register an entity */
	WARN_ON(entity->graph_obj.mdev != NULL);
	entity->graph_obj.mdev = mdev;
	INIT_LIST_HEAD(&entity->links);

	spin_lock(&mdev->lock);
	/* Initialize media_gobj embedded at the entity */
	media_gobj_init(mdev, MEDIA_GRAPH_ENTITY, &entity->graph_obj);

	/* Initialize objects at the pads */
	for (i = 0; i < entity->num_pads; i++)
		media_gobj_init(mdev, MEDIA_GRAPH_PAD,
			       &entity->pads[i].graph_obj);

	spin_unlock(&mdev->lock);

	return 0;
}
EXPORT_SYMBOL_GPL(media_device_register_entity);

/**
 * media_device_unregister_entity - Unregister an entity
 * @entity:	The entity
 *
 * If the entity has never been registered this function will return
 * immediately.
 */
void media_device_unregister_entity(struct media_entity *entity)
{
	int i;
	struct media_device *mdev = entity->graph_obj.mdev;
	struct media_link *link, *tmp;
	struct media_interface *intf;

	if (mdev == NULL)
		return;

	spin_lock(&mdev->lock);

	/* Remove all interface links pointing to this entity */
	list_for_each_entry(intf, &mdev->interfaces, graph_obj.list) {
		list_for_each_entry_safe(link, tmp, &intf->links, list) {
			if (link->entity == entity)
				__media_remove_intf_link(link);
		}
	}

	/* Remove all data links that belong to this entity */
	__media_entity_remove_links(entity);

	/* Remove all pads that belong to this entity */
	for (i = 0; i < entity->num_pads; i++)
		media_gobj_remove(&entity->pads[i].graph_obj);

	/* Remove the entity */
	media_gobj_remove(&entity->graph_obj);

	spin_unlock(&mdev->lock);
	entity->graph_obj.mdev = NULL;
}
EXPORT_SYMBOL_GPL(media_device_unregister_entity);

static void media_device_release_devres(struct device *dev, void *res)
{
}

/*
 * media_device_get_devres() -	get media device as device resource
 *				creates if one doesn't exist
*/
struct media_device *media_device_get_devres(struct device *dev)
{
	struct media_device *mdev;

	mdev = devres_find(dev, media_device_release_devres, NULL, NULL);
	if (mdev)
		return mdev;

	mdev = devres_alloc(media_device_release_devres,
				sizeof(struct media_device), GFP_KERNEL);
	if (!mdev)
		return NULL;
	return devres_get(dev, mdev, NULL, NULL);
}
EXPORT_SYMBOL_GPL(media_device_get_devres);

/*
 * media_device_find_devres() - find media device as device resource
*/
struct media_device *media_device_find_devres(struct device *dev)
{
	return devres_find(dev, media_device_release_devres, NULL, NULL);
}
EXPORT_SYMBOL_GPL(media_device_find_devres);

#endif /* CONFIG_MEDIA_CONTROLLER */
Commit	Line	Data
176fb0d1 LP	1	/*
	2	* Media device
	3	*
	4	* Copyright (C) 2010 Nokia Corporation
	5	*
	6	* Contacts: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
	7	* Sakari Ailus <sakari.ailus@iki.fi>
	8	*
	9	* This program is free software; you can redistribute it and/or modify
	10	* it under the terms of the GNU General Public License version 2 as
	11	* published by the Free Software Foundation.
	12	*
	13	* This program is distributed in the hope that it will be useful,
	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	* GNU General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU General Public License
	19	* along with this program; if not, write to the Free Software
	20	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	21	*/
	22
b0a1f2a8 SA	23	#include <linux/compat.h>
b0a1f2a8 SA	24	#include <linux/export.h>
176fb0d1	25	#include <linux/ioctl.h>
140d8816	26	#include <linux/media.h>
b0a1f2a8	27	#include <linux/types.h>
57208e5e	28	#include <linux/slab.h>
176fb0d1 LP	29
	30	#include <media/media-device.h>
	31	#include <media/media-devnode.h>
53e269c1	32	#include <media/media-entity.h>
176fb0d1	33
e576d60b SK	34	#ifdef CONFIG_MEDIA_CONTROLLER
e576d60b SK	35
140d8816 LP	36	/* -----------------------------------------------------------------------------
	37	* Userspace API
	38	*/
	39
	40	static int media_device_open(struct file *filp)
	41	{
	42	return 0;
	43	}
	44
	45	static int media_device_close(struct file *filp)
	46	{
	47	return 0;
	48	}
	49
	50	static int media_device_get_info(struct media_device *dev,
	51	struct media_device_info __user *__info)
	52	{
	53	struct media_device_info info;
	54
	55	memset(&info, 0, sizeof(info));
	56
	57	strlcpy(info.driver, dev->dev->driver->name, sizeof(info.driver));
	58	strlcpy(info.model, dev->model, sizeof(info.model));
	59	strlcpy(info.serial, dev->serial, sizeof(info.serial));
	60	strlcpy(info.bus_info, dev->bus_info, sizeof(info.bus_info));
	61
	62	info.media_version = MEDIA_API_VERSION;
	63	info.hw_revision = dev->hw_revision;
	64	info.driver_version = dev->driver_version;
	65
b17d3945 NT	66	if (copy_to_user(__info, &info, sizeof(*__info)))
	67	return -EFAULT;
	68	return 0;
140d8816 LP	69	}
140d8816 LP	70
1651333b LP	71	static struct media_entity find_entity(struct media_device mdev, u32 id)
	72	{
	73	struct media_entity *entity;
	74	int next = id & MEDIA_ENT_ID_FLAG_NEXT;
	75
	76	id &= ~MEDIA_ENT_ID_FLAG_NEXT;
	77
	78	spin_lock(&mdev->lock);
	79
	80	media_device_for_each_entity(entity, mdev) {
fa762394 MCC	81	if (((media_entity_id(entity) == id) && !next) \|\|
fa762394 MCC	82	((media_entity_id(entity) > id) && next)) {
1651333b LP	83	spin_unlock(&mdev->lock);
	84	return entity;
	85	}
	86	}
	87
	88	spin_unlock(&mdev->lock);
	89
	90	return NULL;
	91	}
	92
	93	static long media_device_enum_entities(struct media_device *mdev,
	94	struct media_entity_desc __user *uent)
	95	{
	96	struct media_entity *ent;
	97	struct media_entity_desc u_ent;
	98
e6a62346	99	memset(&u_ent, 0, sizeof(u_ent));
1651333b LP	100	if (copy_from_user(&u_ent.id, &uent->id, sizeof(u_ent.id)))
	101	return -EFAULT;
	102
	103	ent = find_entity(mdev, u_ent.id);
	104
	105	if (ent == NULL)
	106	return -EINVAL;
	107
fa762394	108	u_ent.id = media_entity_id(ent);
de8eae36 LP	109	if (ent->name)
de8eae36 LP	110	strlcpy(u_ent.name, ent->name, sizeof(u_ent.name));
0e576b76	111	u_ent.type = ent->function;
1651333b LP	112	u_ent.revision = ent->revision;
	113	u_ent.flags = ent->flags;
	114	u_ent.group_id = ent->group_id;
	115	u_ent.pads = ent->num_pads;
	116	u_ent.links = ent->num_links - ent->num_backlinks;
fa5034c6	117	memcpy(&u_ent.raw, &ent->info, sizeof(ent->info));
1651333b LP	118	if (copy_to_user(uent, &u_ent, sizeof(u_ent)))
	119	return -EFAULT;
	120	return 0;
	121	}
	122
	123	static void media_device_kpad_to_upad(const struct media_pad *kpad,
	124	struct media_pad_desc *upad)
	125	{
fa762394	126	upad->entity = media_entity_id(kpad->entity);
1651333b LP	127	upad->index = kpad->index;
	128	upad->flags = kpad->flags;
	129	}
	130
b0a1f2a8 SA	131	static long __media_device_enum_links(struct media_device *mdev,
b0a1f2a8 SA	132	struct media_links_enum *links)
1651333b LP	133	{
1651333b LP	134	struct media_entity *entity;
1651333b	135
b0a1f2a8	136	entity = find_entity(mdev, links->entity);
1651333b LP	137	if (entity == NULL)
	138	return -EINVAL;
	139
b0a1f2a8	140	if (links->pads) {
1651333b LP	141	unsigned int p;
	142
	143	for (p = 0; p < entity->num_pads; p++) {
	144	struct media_pad_desc pad;
c88e739b DC	145
c88e739b DC	146	memset(&pad, 0, sizeof(pad));
1651333b	147	media_device_kpad_to_upad(&entity->pads[p], &pad);
b0a1f2a8	148	if (copy_to_user(&links->pads[p], &pad, sizeof(pad)))
1651333b LP	149	return -EFAULT;
	150	}
	151	}
	152
b0a1f2a8	153	if (links->links) {
57208e5e MCC	154	struct media_link *ent_link;
57208e5e MCC	155	struct media_link_desc __user *ulink = links->links;
1651333b	156
57208e5e	157	list_for_each_entry(ent_link, &entity->links, list) {
1651333b LP	158	struct media_link_desc link;
	159
	160	/* Ignore backlinks. */
57208e5e	161	if (ent_link->source->entity != entity)
1651333b	162	continue;
c88e739b	163	memset(&link, 0, sizeof(link));
57208e5e	164	media_device_kpad_to_upad(ent_link->source,
1651333b	165	&link.source);
57208e5e	166	media_device_kpad_to_upad(ent_link->sink,
1651333b	167	&link.sink);
57208e5e	168	link.flags = ent_link->flags;
1651333b LP	169	if (copy_to_user(ulink, &link, sizeof(*ulink)))
	170	return -EFAULT;
	171	ulink++;
	172	}
	173	}
b0a1f2a8 SA	174
	175	return 0;
	176	}
	177
	178	static long media_device_enum_links(struct media_device *mdev,
	179	struct media_links_enum __user *ulinks)
	180	{
	181	struct media_links_enum links;
	182	int rval;
	183
	184	if (copy_from_user(&links, ulinks, sizeof(links)))
	185	return -EFAULT;
	186
	187	rval = __media_device_enum_links(mdev, &links);
	188	if (rval < 0)
	189	return rval;
	190
1651333b LP	191	if (copy_to_user(ulinks, &links, sizeof(*ulinks)))
1651333b LP	192	return -EFAULT;
b0a1f2a8	193
1651333b LP	194	return 0;
	195	}
	196
97548ed4 LP	197	static long media_device_setup_link(struct media_device *mdev,
	198	struct media_link_desc __user *_ulink)
	199	{
	200	struct media_link *link = NULL;
	201	struct media_link_desc ulink;
	202	struct media_entity *source;
	203	struct media_entity *sink;
	204	int ret;
	205
	206	if (copy_from_user(&ulink, _ulink, sizeof(ulink)))
	207	return -EFAULT;
	208
	209	/* Find the source and sink entities and link.
	210	*/
	211	source = find_entity(mdev, ulink.source.entity);
	212	sink = find_entity(mdev, ulink.sink.entity);
	213
	214	if (source == NULL \|\| sink == NULL)
	215	return -EINVAL;
	216
	217	if (ulink.source.index >= source->num_pads \|\|
	218	ulink.sink.index >= sink->num_pads)
	219	return -EINVAL;
	220
	221	link = media_entity_find_link(&source->pads[ulink.source.index],
	222	&sink->pads[ulink.sink.index]);
	223	if (link == NULL)
	224	return -EINVAL;
	225
	226	/* Setup the link on both entities. */
	227	ret = __media_entity_setup_link(link, ulink.flags);
	228
	229	if (copy_to_user(_ulink, &ulink, sizeof(ulink)))
	230	return -EFAULT;
	231
	232	return ret;
	233	}
	234
8309f47c MCC	235	static long __media_device_get_topology(struct media_device *mdev,
	236	struct media_v2_topology *topo)
	237	{
	238	struct media_entity *entity;
	239	struct media_interface *intf;
	240	struct media_pad *pad;
	241	struct media_link *link;
	242	struct media_v2_entity uentity;
	243	struct media_v2_interface uintf;
	244	struct media_v2_pad upad;
	245	struct media_v2_link ulink;
	246	int ret = 0, i;
	247
	248	topo->topology_version = mdev->topology_version;
	249
	250	/* Get entities and number of entities */
	251	i = 0;
	252	media_device_for_each_entity(entity, mdev) {
	253	i++;
	254
	255	if (ret \|\| !topo->entities)
	256	continue;
	257
	258	if (i > topo->num_entities) {
	259	ret = -ENOSPC;
	260	continue;
	261	}
	262
	263	/* Copy fields to userspace struct if not error */
	264	memset(&uentity, 0, sizeof(uentity));
	265	uentity.id = entity->graph_obj.id;
d87cdb88	266	uentity.function = entity->function;
8309f47c MCC	267	strncpy(uentity.name, entity->name,
	268	sizeof(uentity.name));
	269
	270	if (copy_to_user(&topo->entities[i - 1], &uentity, sizeof(uentity)))
	271	ret = -EFAULT;
	272	}
	273	topo->num_entities = i;
	274
	275	/* Get interfaces and number of interfaces */
	276	i = 0;
	277	media_device_for_each_intf(intf, mdev) {
	278	i++;
	279
	280	if (ret \|\| !topo->interfaces)
	281	continue;
	282
	283	if (i > topo->num_interfaces) {
	284	ret = -ENOSPC;
	285	continue;
	286	}
	287
	288	memset(&uintf, 0, sizeof(uintf));
	289
	290	/* Copy intf fields to userspace struct */
	291	uintf.id = intf->graph_obj.id;
	292	uintf.intf_type = intf->type;
	293	uintf.flags = intf->flags;
	294
	295	if (media_type(&intf->graph_obj) == MEDIA_GRAPH_INTF_DEVNODE) {
	296	struct media_intf_devnode *devnode;
	297
	298	devnode = intf_to_devnode(intf);
	299
	300	uintf.devnode.major = devnode->major;
	301	uintf.devnode.minor = devnode->minor;
	302	}
	303
	304	if (copy_to_user(&topo->interfaces[i - 1], &uintf, sizeof(uintf)))
	305	ret = -EFAULT;
	306	}
	307	topo->num_interfaces = i;
	308
	309	/* Get pads and number of pads */
	310	i = 0;
	311	media_device_for_each_pad(pad, mdev) {
	312	i++;
	313
	314	if (ret \|\| !topo->pads)
	315	continue;
	316
	317	if (i > topo->num_pads) {
	318	ret = -ENOSPC;
	319	continue;
	320	}
	321
	322	memset(&upad, 0, sizeof(upad));
	323
	324	/* Copy pad fields to userspace struct */
	325	upad.id = pad->graph_obj.id;
	326	upad.entity_id = pad->entity->graph_obj.id;
	327	upad.flags = pad->flags;
	328
	329	if (copy_to_user(&topo->pads[i - 1], &upad, sizeof(upad)))
	330	ret = -EFAULT;
331	}
332	topo->num_pads = i;
333
334	/* Get links and number of links */
335	i = 0;
336	media_device_for_each_link(link, mdev) {
39d1ebc6 MCC	337	if (link->is_backlink)
	338	continue;
	339
8309f47c MCC	340	i++;
	341
	342	if (ret \|\| !topo->links)
	343	continue;
	344
	345	if (i > topo->num_links) {
	346	ret = -ENOSPC;
	347	continue;
	348	}
	349
	350	memset(&ulink, 0, sizeof(ulink));
	351
	352	/* Copy link fields to userspace struct */
	353	ulink.id = link->graph_obj.id;
	354	ulink.source_id = link->gobj0->id;
	355	ulink.sink_id = link->gobj1->id;
	356	ulink.flags = link->flags;
	357
	358	if (media_type(link->gobj0) != MEDIA_GRAPH_PAD)
	359	ulink.flags \|= MEDIA_LNK_FL_INTERFACE_LINK;
	360
	361	if (copy_to_user(&topo->links[i - 1], &ulink, sizeof(ulink)))
	362	ret = -EFAULT;
	363	}
	364	topo->num_links = i;
	365
	366	return ret;
	367	}
	368
	369	static long media_device_get_topology(struct media_device *mdev,
	370	struct media_v2_topology __user *utopo)
	371	{
	372	struct media_v2_topology ktopo;
	373	int ret;
	374
	375	ret = copy_from_user(&ktopo, utopo, sizeof(ktopo));
	376
	377	if (ret < 0)
	378	return ret;
	379
	380	ret = __media_device_get_topology(mdev, &ktopo);
	381	if (ret < 0)
	382	return ret;
	383
	384	ret = copy_to_user(utopo, &ktopo, sizeof(*utopo));
	385
	386	return ret;
	387	}
	388
140d8816 LP	389	static long media_device_ioctl(struct file *filp, unsigned int cmd,
	390	unsigned long arg)
	391	{
	392	struct media_devnode *devnode = media_devnode_data(filp);
	393	struct media_device *dev = to_media_device(devnode);
	394	long ret;
	395
	396	switch (cmd) {
	397	case MEDIA_IOC_DEVICE_INFO:
	398	ret = media_device_get_info(dev,
	399	(struct media_device_info __user *)arg);
	400	break;
	401
1651333b LP	402	case MEDIA_IOC_ENUM_ENTITIES:
	403	ret = media_device_enum_entities(dev,
	404	(struct media_entity_desc __user *)arg);
	405	break;
	406
	407	case MEDIA_IOC_ENUM_LINKS:
	408	mutex_lock(&dev->graph_mutex);
	409	ret = media_device_enum_links(dev,
	410	(struct media_links_enum __user *)arg);
	411	mutex_unlock(&dev->graph_mutex);
	412	break;
	413
97548ed4 LP	414	case MEDIA_IOC_SETUP_LINK:
	415	mutex_lock(&dev->graph_mutex);
	416	ret = media_device_setup_link(dev,
	417	(struct media_link_desc __user *)arg);
	418	mutex_unlock(&dev->graph_mutex);
	419	break;
	420
8309f47c MCC	421	case MEDIA_IOC_G_TOPOLOGY:
	422	mutex_lock(&dev->graph_mutex);
	423	ret = media_device_get_topology(dev,
	424	(struct media_v2_topology __user *)arg);
	425	mutex_unlock(&dev->graph_mutex);
	426	break;
	427
140d8816 LP	428	default:
	429	ret = -ENOIOCTLCMD;
	430	}
	431
	432	return ret;
	433	}
	434
b0a1f2a8 SA	435	#ifdef CONFIG_COMPAT
	436
	437	struct media_links_enum32 {
	438	__u32 entity;
	439	compat_uptr_t pads; /* struct media_pad_desc * */
	440	compat_uptr_t links; /* struct media_link_desc * */
	441	__u32 reserved[4];
	442	};
	443
	444	static long media_device_enum_links32(struct media_device *mdev,
	445	struct media_links_enum32 __user *ulinks)
	446	{
	447	struct media_links_enum links;
	448	compat_uptr_t pads_ptr, links_ptr;
	449
	450	memset(&links, 0, sizeof(links));
	451
	452	if (get_user(links.entity, &ulinks->entity)
	453	\|\| get_user(pads_ptr, &ulinks->pads)
	454	\|\| get_user(links_ptr, &ulinks->links))
	455	return -EFAULT;
	456
	457	links.pads = compat_ptr(pads_ptr);
	458	links.links = compat_ptr(links_ptr);
	459
	460	return __media_device_enum_links(mdev, &links);
	461	}
	462
	463	#define MEDIA_IOC_ENUM_LINKS32 _IOWR('\|', 0x02, struct media_links_enum32)
	464
	465	static long media_device_compat_ioctl(struct file *filp, unsigned int cmd,
	466	unsigned long arg)
	467	{
	468	struct media_devnode *devnode = media_devnode_data(filp);
	469	struct media_device *dev = to_media_device(devnode);
	470	long ret;
	471
	472	switch (cmd) {
	473	case MEDIA_IOC_DEVICE_INFO:
	474	case MEDIA_IOC_ENUM_ENTITIES:
	475	case MEDIA_IOC_SETUP_LINK:
8309f47c	476	case MEDIA_IOC_G_TOPOLOGY:
b0a1f2a8 SA	477	return media_device_ioctl(filp, cmd, arg);
	478
	479	case MEDIA_IOC_ENUM_LINKS32:
	480	mutex_lock(&dev->graph_mutex);
	481	ret = media_device_enum_links32(dev,
	482	(struct media_links_enum32 __user *)arg);
	483	mutex_unlock(&dev->graph_mutex);
	484	break;
	485
	486	default:
	487	ret = -ENOIOCTLCMD;
	488	}
	489
	490	return ret;
	491	}
	492	#endif /* CONFIG_COMPAT */
	493
176fb0d1 LP	494	static const struct media_file_operations media_device_fops = {
176fb0d1 LP	495	.owner = THIS_MODULE,
140d8816 LP	496	.open = media_device_open,
140d8816 LP	497	.ioctl = media_device_ioctl,
b0a1f2a8 SA	498	#ifdef CONFIG_COMPAT
	499	.compat_ioctl = media_device_compat_ioctl,
	500	#endif /* CONFIG_COMPAT */
140d8816	501	.release = media_device_close,
176fb0d1 LP	502	};
	503
	504	/* -----------------------------------------------------------------------------
	505	* sysfs
	506	*/
	507
	508	static ssize_t show_model(struct device *cd,
	509	struct device_attribute attr, char buf)
	510	{
	511	struct media_device *mdev = to_media_device(to_media_devnode(cd));
	512
	513	return sprintf(buf, "%.*s\n", (int)sizeof(mdev->model), mdev->model);
	514	}
	515
	516	static DEVICE_ATTR(model, S_IRUGO, show_model, NULL);
	517
	518	/* -----------------------------------------------------------------------------
	519	* Registration/unregistration
	520	*/
	521
	522	static void media_device_release(struct media_devnode *mdev)
	523	{
8f5a3188	524	dev_dbg(mdev->parent, "Media device released\n");
176fb0d1 LP	525	}
	526
	527	/**
	528	* media_device_register - register a media device
	529	* @mdev: The media device
	530	*
	531	* The caller is responsible for initializing the media device before
	532	* registration. The following fields must be set:
	533	*
	534	* - dev must point to the parent device
	535	* - model must be filled with the device model name
	536	*/
85de721c SA	537	int __must_check __media_device_register(struct media_device *mdev,
85de721c SA	538	struct module *owner)
176fb0d1 LP	539	{
	540	int ret;
	541
	542	if (WARN_ON(mdev->dev == NULL \|\| mdev->model[0] == 0))
	543	return -EINVAL;
	544
53e269c1	545	INIT_LIST_HEAD(&mdev->entities);
57cf79b7	546	INIT_LIST_HEAD(&mdev->interfaces);
9155d859 MCC	547	INIT_LIST_HEAD(&mdev->pads);
9155d859 MCC	548	INIT_LIST_HEAD(&mdev->links);
53e269c1	549	spin_lock_init(&mdev->lock);
503c3d82	550	mutex_init(&mdev->graph_mutex);
53e269c1	551
176fb0d1 LP	552	/* Register the device node. */
	553	mdev->devnode.fops = &media_device_fops;
	554	mdev->devnode.parent = mdev->dev;
	555	mdev->devnode.release = media_device_release;
85de721c	556	ret = media_devnode_register(&mdev->devnode, owner);
176fb0d1 LP	557	if (ret < 0)
	558	return ret;
	559
	560	ret = device_create_file(&mdev->devnode.dev, &dev_attr_model);
	561	if (ret < 0) {
	562	media_devnode_unregister(&mdev->devnode);
	563	return ret;
	564	}
	565
8f5a3188 MCC	566	dev_dbg(mdev->dev, "Media device registered\n");
8f5a3188 MCC	567
176fb0d1 LP	568	return 0;
176fb0d1 LP	569	}
85de721c	570	EXPORT_SYMBOL_GPL(__media_device_register);
176fb0d1 LP	571
	572	/**
	573	* media_device_unregister - unregister a media device
	574	* @mdev: The media device
	575	*
	576	*/
	577	void media_device_unregister(struct media_device *mdev)
	578	{
53e269c1 LP	579	struct media_entity *entity;
53e269c1 LP	580	struct media_entity *next;
d47109fa MCC	581	struct media_interface intf, tmp_intf;
d47109fa MCC	582
f50d5166 MCC	583	/* Remove all entities from the media device */
	584	list_for_each_entry_safe(entity, next, &mdev->entities, graph_obj.list)
	585	media_device_unregister_entity(entity);
	586
d47109fa MCC	587	/* Remove all interfaces from the media device */
	588	spin_lock(&mdev->lock);
	589	list_for_each_entry_safe(intf, tmp_intf, &mdev->interfaces,
	590	graph_obj.list) {
	591	__media_remove_intf_links(intf);
	592	media_gobj_remove(&intf->graph_obj);
	593	kfree(intf);
	594	}
	595	spin_unlock(&mdev->lock);
53e269c1	596
176fb0d1 LP	597	device_remove_file(&mdev->devnode.dev, &dev_attr_model);
176fb0d1 LP	598	media_devnode_unregister(&mdev->devnode);
8f5a3188 MCC	599
8f5a3188 MCC	600	dev_dbg(mdev->dev, "Media device unregistered\n");
176fb0d1 LP	601	}
176fb0d1 LP	602	EXPORT_SYMBOL_GPL(media_device_unregister);
53e269c1 LP	603
	604	/**
	605	* media_device_register_entity - Register an entity with a media device
	606	* @mdev: The media device
	607	* @entity: The entity
	608	*/
	609	int __must_check media_device_register_entity(struct media_device *mdev,
	610	struct media_entity *entity)
	611	{
18710dc6 MCC	612	int i;
18710dc6 MCC	613
4ca72efa MCC	614	if (entity->function == MEDIA_ENT_F_V4L2_SUBDEV_UNKNOWN \|\|
4ca72efa MCC	615	entity->function == MEDIA_ENT_F_UNKNOWN)
b50bde4e MCC	616	dev_warn(mdev->dev,
	617	"Entity type for entity %s was not initialized!\n",
	618	entity->name);
	619
53e269c1	620	/* Warn if we apparently re-register an entity */
d10c9894 JMC	621	WARN_ON(entity->graph_obj.mdev != NULL);
d10c9894 JMC	622	entity->graph_obj.mdev = mdev;
57208e5e	623	INIT_LIST_HEAD(&entity->links);
53e269c1 LP	624
53e269c1 LP	625	spin_lock(&mdev->lock);
bfab2aac MCC	626	/* Initialize media_gobj embedded at the entity */
bfab2aac MCC	627	media_gobj_init(mdev, MEDIA_GRAPH_ENTITY, &entity->graph_obj);
18710dc6 MCC	628
	629	/* Initialize objects at the pads */
	630	for (i = 0; i < entity->num_pads; i++)
	631	media_gobj_init(mdev, MEDIA_GRAPH_PAD,
	632	&entity->pads[i].graph_obj);
	633
53e269c1 LP	634	spin_unlock(&mdev->lock);
	635
	636	return 0;
	637	}
	638	EXPORT_SYMBOL_GPL(media_device_register_entity);
	639
	640	/**
	641	* media_device_unregister_entity - Unregister an entity
	642	* @entity: The entity
	643	*
	644	* If the entity has never been registered this function will return
	645	* immediately.
	646	*/
	647	void media_device_unregister_entity(struct media_entity *entity)
	648	{
18710dc6	649	int i;
d10c9894	650	struct media_device *mdev = entity->graph_obj.mdev;
57208e5e	651	struct media_link link, tmp;
d47109fa	652	struct media_interface *intf;
53e269c1 LP	653
	654	if (mdev == NULL)
	655	return;
	656
	657	spin_lock(&mdev->lock);
a28971ad	658
d47109fa MCC	659	/* Remove all interface links pointing to this entity */
	660	list_for_each_entry(intf, &mdev->interfaces, graph_obj.list) {
	661	list_for_each_entry_safe(link, tmp, &intf->links, list) {
f50d5166	662	if (link->entity == entity)
d47109fa	663	__media_remove_intf_link(link);
a28971ad MCC	664	}
	665	}
	666
	667	/* Remove all data links that belong to this entity */
d47109fa	668	__media_entity_remove_links(entity);
a28971ad MCC	669
a28971ad MCC	670	/* Remove all pads that belong to this entity */
18710dc6 MCC	671	for (i = 0; i < entity->num_pads; i++)
18710dc6 MCC	672	media_gobj_remove(&entity->pads[i].graph_obj);
a28971ad MCC	673
a28971ad MCC	674	/* Remove the entity */
bfab2aac	675	media_gobj_remove(&entity->graph_obj);
a28971ad	676
53e269c1	677	spin_unlock(&mdev->lock);
d10c9894	678	entity->graph_obj.mdev = NULL;
53e269c1 LP	679	}
53e269c1 LP	680	EXPORT_SYMBOL_GPL(media_device_unregister_entity);
d062f911 SK	681
	682	static void media_device_release_devres(struct device dev, void res)
	683	{
	684	}
	685
	686	/*
	687	* media_device_get_devres() - get media device as device resource
	688	* creates if one doesn't exist
	689	*/
	690	struct media_device media_device_get_devres(struct device dev)
	691	{
	692	struct media_device *mdev;
	693
	694	mdev = devres_find(dev, media_device_release_devres, NULL, NULL);
	695	if (mdev)
	696	return mdev;
	697
	698	mdev = devres_alloc(media_device_release_devres,
	699	sizeof(struct media_device), GFP_KERNEL);
	700	if (!mdev)
	701	return NULL;
	702	return devres_get(dev, mdev, NULL, NULL);
	703	}
	704	EXPORT_SYMBOL_GPL(media_device_get_devres);
	705
	706	/*
	707	* media_device_find_devres() - find media device as device resource
	708	*/
	709	struct media_device media_device_find_devres(struct device dev)
	710	{
	711	return devres_find(dev, media_device_release_devres, NULL, NULL);
	712	}
	713	EXPORT_SYMBOL_GPL(media_device_find_devres);
e576d60b SK	714
e576d60b SK	715	#endif /* CONFIG_MEDIA_CONTROLLER */