/*
   * 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
   */
  
  #ifndef _MEDIA_DEVICE_H
  #define _MEDIA_DEVICE_H
  
  #include <linux/list.h>
  #include <linux/mutex.h>
  #include <linux/spinlock.h>
  
  #include <media/media-devnode.h>
  #include <media/media-entity.h>
  
  struct device;
  
  /**
   * struct media_device - Media device
   * @dev:	Parent device
   * @devnode:	Media device node
   * @model:	Device model name
   * @serial:	Device serial number (optional)
   * @bus_info:	Unique and stable device location identifier
   * @hw_revision: Hardware device revision
   * @driver_version: Device driver version
   * @entity_id:	ID of the next entity to be registered
   * @entities:	List of registered entities
   * @lock:	Entities list lock
   * @graph_mutex: Entities graph operation lock
   * @link_notify: Link state change notification callback
   *
   * This structure represents an abstract high-level media device. It allows easy
   * access to entities and provides basic media device-level support. The
   * structure can be allocated directly or embedded in a larger structure.
   *
   * The parent @dev is a physical device. It must be set before registering the
   * media device.
   *
   * @model is a descriptive model name exported through sysfs. It doesn't have to
   * be unique.
   */
  struct media_device {
  	/* dev->driver_data points to this struct. */
  	struct device *dev;
  	struct media_devnode devnode;
  
  	char model[32];
  	char serial[40];
  	char bus_info[32];
  	u32 hw_revision;
  	u32 driver_version;
  
  	u32 entity_id;
  	struct list_head entities;
  
  	/* Protects the entities list */
  	spinlock_t lock;
  	/* Serializes graph operations. */
  	struct mutex graph_mutex;
  
  	int (*link_notify)(struct media_link *link, u32 flags,
  			   unsigned int notification);
  };
  
  /* Supported link_notify @notification values. */
  #define MEDIA_DEV_NOTIFY_PRE_LINK_CH	0
  #define MEDIA_DEV_NOTIFY_POST_LINK_CH	1
  
  /* media_devnode to media_device */
  #define to_media_device(node) container_of(node, struct media_device, devnode)
  
  int __must_check media_device_register(struct media_device *mdev);
  void media_device_unregister(struct media_device *mdev);
  
  int __must_check media_device_register_entity(struct media_device *mdev,
  					      struct media_entity *entity);
  void media_device_unregister_entity(struct media_entity *entity);
  
  /* Iterate over all entities. */
  #define media_device_for_each_entity(entity, mdev)			\
  	list_for_each_entry(entity, &(mdev)->entities, list)
  
  #endif