text: /*
   * Copyright (C) 2011 - 2012 Samsung Electronics Co., Ltd.
   *
   * 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.
   */
  
  #ifndef FIMC_MDEVICE_H_
  #define FIMC_MDEVICE_H_
  
  #include <linux/clk.h>
  #include <linux/platform_device.h>
  #include <linux/mutex.h>
  #include <linux/of.h>
  #include <linux/pinctrl/consumer.h>
  #include <media/media-device.h>
  #include <media/media-entity.h>
  #include <media/v4l2-device.h>
  #include <media/v4l2-subdev.h>
  
  #include "fimc-core.h"
  #include "fimc-lite.h"
  #include "mipi-csis.h"
  
  #define FIMC_OF_NODE_NAME	"fimc"
  #define FIMC_LITE_OF_NODE_NAME	"fimc-lite"
  #define FIMC_IS_OF_NODE_NAME	"fimc-is"
  #define CSIS_OF_NODE_NAME	"csis"
  
  #define PINCTRL_STATE_IDLE	"idle"
  
  #define FIMC_MAX_SENSORS	8
  #define FIMC_MAX_CAMCLKS	2
  
  /* LCD/ISP Writeback clocks (PIXELASYNCMx) */
  enum {
  	CLK_IDX_WB_A,
  	CLK_IDX_WB_B,
  	FIMC_MAX_WBCLKS
  };
  
  struct fimc_csis_info {
  	struct v4l2_subdev *sd;
  	int id;
  };
  
  struct fimc_camclk_info {
  	struct clk *clock;
  	int use_count;
  	unsigned long frequency;
  };
  
  /**
   * struct fimc_sensor_info - image data source subdev information
   * @pdata: sensor's atrributes passed as media device's platform data
   * @subdev: image sensor v4l2 subdev
   * @host: fimc device the sensor is currently linked to
   *
   * This data structure applies to image sensor and the writeback subdevs.
   */
  struct fimc_sensor_info {
  	struct fimc_source_info pdata;
  	struct v4l2_subdev *subdev;
  	struct fimc_dev *host;
  };
  
  /**
   * struct fimc_md - fimc media device information
   * @csis: MIPI CSIS subdevs data
   * @sensor: array of registered sensor subdevs
   * @num_sensors: actual number of registered sensors
   * @camclk: external sensor clock information
   * @fimc: array of registered fimc devices
   * @fimc_is: fimc-is data structure
   * @use_isp: set to true when FIMC-IS subsystem is used
   * @pmf: handle to the CAMCLK clock control FIMC helper device
   * @media_dev: top level media device
   * @v4l2_dev: top level v4l2_device holding up the subdevs
   * @pdev: platform device this media device is hooked up into
   * @pinctrl: camera port pinctrl handle
   * @state_default: pinctrl default state handle
   * @state_idle: pinctrl idle state handle
   * @user_subdev_api: true if subdevs are not configured by the host driver
   * @slock: spinlock protecting @sensor array
   */
  struct fimc_md {
  	struct fimc_csis_info csis[CSIS_MAX_ENTITIES];
  	struct fimc_sensor_info sensor[FIMC_MAX_SENSORS];
  	int num_sensors;
  	struct fimc_camclk_info camclk[FIMC_MAX_CAMCLKS];
  	struct clk *wbclk[FIMC_MAX_WBCLKS];
  	struct fimc_lite *fimc_lite[FIMC_LITE_MAX_DEVS];
  	struct fimc_dev *fimc[FIMC_MAX_DEVS];
  	struct fimc_is *fimc_is;
  	bool use_isp;
  	struct device *pmf;
  	struct media_device media_dev;
  	struct v4l2_device v4l2_dev;
  	struct platform_device *pdev;
  	struct fimc_pinctrl {
  		struct pinctrl *pinctrl;
  		struct pinctrl_state *state_default;
  		struct pinctrl_state *state_idle;
  	} pinctl;
  	bool user_subdev_api;
  	spinlock_t slock;
  };
  
  #define is_subdev_pad(pad) (pad == NULL || \
  	media_entity_type(pad->entity) == MEDIA_ENT_T_V4L2_SUBDEV)
  
  #define me_subtype(me) \
  	((me->type) & (MEDIA_ENT_TYPE_MASK | MEDIA_ENT_SUBTYPE_MASK))
  
  #define subdev_has_devnode(__sd) (__sd->flags & V4L2_SUBDEV_FL_HAS_DEVNODE)
  
  static inline
  struct fimc_sensor_info *source_to_sensor_info(struct fimc_source_info *si)
  {
  	return container_of(si, struct fimc_sensor_info, pdata);
  }
  
  static inline struct fimc_md *entity_to_fimc_mdev(struct media_entity *me)
  {
  	return me->parent == NULL ? NULL :
  		container_of(me->parent, struct fimc_md, media_dev);
  }
  
  static inline void fimc_md_graph_lock(struct fimc_dev *fimc)
  {
  	mutex_lock(&fimc->vid_cap.vfd.entity.parent->graph_mutex);
  }
  
  static inline void fimc_md_graph_unlock(struct fimc_dev *fimc)
  {
  	mutex_unlock(&fimc->vid_cap.vfd.entity.parent->graph_mutex);
  }
  
  int fimc_md_set_camclk(struct v4l2_subdev *sd, bool on);
  
  #ifdef CONFIG_OF
  static inline bool fimc_md_is_isp_available(struct device_node *node)
  {
  	node = of_get_child_by_name(node, FIMC_IS_OF_NODE_NAME);
  	return node ? of_device_is_available(node) : false;
  }
  #else
  #define fimc_md_is_isp_available(node) (false)
  #endif /* CONFIG_OF */
  
  #endif
  