/*
      hexium_gemini.c - v4l2 driver for Hexium Gemini frame grabber cards

      Visit http://www.mihu.de/linux/saa7146/ and follow the link
      to "hexium" for further details about this card.

      Copyright (C) 2003 Michael Hunold <michael@mihu.de>
  
      This program is free software; you can redistribute it and/or modify
      it under the terms of the GNU General Public License as published by
      the Free Software Foundation; either version 2 of the License, or
      (at your option) any later version.
  
      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., 675 Mass Ave, Cambridge, MA 02139, USA.
  */

  #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt

  #define DEBUG_VARIABLE debug
  
  #include <media/saa7146_vv.h>

  #include <linux/module.h>

  static int debug;

  module_param(debug, int, 0);
  MODULE_PARM_DESC(debug, "debug verbosity");
  
  /* global variables */

  static int hexium_num;

  
  #define HEXIUM_GEMINI			4
  #define HEXIUM_GEMINI_DUAL		5
  
  #define HEXIUM_INPUTS	9
  static struct v4l2_input hexium_inputs[HEXIUM_INPUTS] = {

  	{ 0, "CVBS 1",	V4L2_INPUT_TYPE_CAMERA,	2, 0, V4L2_STD_PAL_BG|V4L2_STD_NTSC_M, 0, V4L2_IN_CAP_STD },
  	{ 1, "CVBS 2",	V4L2_INPUT_TYPE_CAMERA,	2, 0, V4L2_STD_PAL_BG|V4L2_STD_NTSC_M, 0, V4L2_IN_CAP_STD },
  	{ 2, "CVBS 3",	V4L2_INPUT_TYPE_CAMERA,	2, 0, V4L2_STD_PAL_BG|V4L2_STD_NTSC_M, 0, V4L2_IN_CAP_STD },
  	{ 3, "CVBS 4",	V4L2_INPUT_TYPE_CAMERA,	2, 0, V4L2_STD_PAL_BG|V4L2_STD_NTSC_M, 0, V4L2_IN_CAP_STD },
  	{ 4, "CVBS 5",	V4L2_INPUT_TYPE_CAMERA,	2, 0, V4L2_STD_PAL_BG|V4L2_STD_NTSC_M, 0, V4L2_IN_CAP_STD },
  	{ 5, "CVBS 6",	V4L2_INPUT_TYPE_CAMERA,	2, 0, V4L2_STD_PAL_BG|V4L2_STD_NTSC_M, 0, V4L2_IN_CAP_STD },
  	{ 6, "Y/C 1",	V4L2_INPUT_TYPE_CAMERA,	2, 0, V4L2_STD_PAL_BG|V4L2_STD_NTSC_M, 0, V4L2_IN_CAP_STD },
  	{ 7, "Y/C 2",	V4L2_INPUT_TYPE_CAMERA,	2, 0, V4L2_STD_PAL_BG|V4L2_STD_NTSC_M, 0, V4L2_IN_CAP_STD },
  	{ 8, "Y/C 3",	V4L2_INPUT_TYPE_CAMERA,	2, 0, V4L2_STD_PAL_BG|V4L2_STD_NTSC_M, 0, V4L2_IN_CAP_STD },

  };
  
  #define HEXIUM_AUDIOS	0
  
  struct hexium_data
  {
  	s8 adr;
  	u8 byte;
  };

  #define HEXIUM_CONTROLS	1
  static struct v4l2_queryctrl hexium_controls[] = {
  	{ V4L2_CID_PRIVATE_BASE, V4L2_CTRL_TYPE_BOOLEAN, "B/W", 0, 1, 1, 0, 0 },
  };
  
  #define HEXIUM_GEMINI_V_1_0		1
  #define HEXIUM_GEMINI_DUAL_V_1_0	2
  
  struct hexium
  {
  	int type;
  
  	struct video_device	*video_dev;
  	struct i2c_adapter	i2c_adapter;

  	int 		cur_input;	/* current input */
  	v4l2_std_id 	cur_std;	/* current standard */
  	int		cur_bw;		/* current black/white status */
  };
  
  /* Samsung KS0127B decoder default registers */
  static u8 hexium_ks0127b[0x100]={
  /*00*/ 0x00,0x52,0x30,0x40,0x01,0x0C,0x2A,0x10,
  /*08*/ 0x00,0x00,0x00,0x60,0x00,0x00,0x0F,0x06,
  /*10*/ 0x00,0x00,0xE4,0xC0,0x00,0x00,0x00,0x00,
  /*18*/ 0x14,0x9B,0xFE,0xFF,0xFC,0xFF,0x03,0x22,
  /*20*/ 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
  /*28*/ 0x00,0x00,0x00,0x00,0x00,0x2C,0x9B,0x00,
  /*30*/ 0x00,0x00,0x10,0x80,0x80,0x10,0x80,0x80,
  /*38*/ 0x01,0x04,0x00,0x00,0x00,0x29,0xC0,0x00,
  /*40*/ 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
  /*48*/ 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
  /*50*/ 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
  /*58*/ 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
  /*60*/ 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
  /*68*/ 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
  /*70*/ 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
  /*78*/ 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
  /*80*/ 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
  /*88*/ 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
  /*90*/ 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
  /*98*/ 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
  /*A0*/ 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
  /*A8*/ 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
  /*B0*/ 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
  /*B8*/ 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
  /*C0*/ 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
  /*C8*/ 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
  /*D0*/ 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
  /*D8*/ 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
  /*E0*/ 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
  /*E8*/ 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
  /*F0*/ 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00,
  /*F8*/ 0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00
  };
  
  static struct hexium_data hexium_pal[] = {
  	{ 0x01, 0x52 }, { 0x12, 0x64 }, { 0x2D, 0x2C }, { 0x2E, 0x9B }, { -1 , 0xFF }
  };
  
  static struct hexium_data hexium_pal_bw[] = {
  	{ 0x01, 0x52 },	{ 0x12, 0x64 },	{ 0x2D, 0x2C },	{ 0x2E, 0x9B },	{ -1 , 0xFF }
  };
  
  static struct hexium_data hexium_ntsc[] = {
  	{ 0x01, 0x53 }, { 0x12, 0x04 }, { 0x2D, 0x23 }, { 0x2E, 0x81 }, { -1 , 0xFF }
  };
  
  static struct hexium_data hexium_ntsc_bw[] = {
  	{ 0x01, 0x53 }, { 0x12, 0x04 }, { 0x2D, 0x23 }, { 0x2E, 0x81 }, { -1 , 0xFF }
  };
  
  static struct hexium_data hexium_secam[] = {
  	{ 0x01, 0x52 }, { 0x12, 0x64 }, { 0x2D, 0x2C }, { 0x2E, 0x9B }, { -1 , 0xFF }
  };
  
  static struct hexium_data hexium_input_select[] = {
  	{ 0x02, 0x60 },
  	{ 0x02, 0x64 },
  	{ 0x02, 0x61 },
  	{ 0x02, 0x65 },
  	{ 0x02, 0x62 },
  	{ 0x02, 0x66 },
  	{ 0x02, 0x68 },
  	{ 0x02, 0x69 },
  	{ 0x02, 0x6A },
  };
  
  /* fixme: h_offset = 0 for Hexium Gemini *Dual*, which
     are currently *not* supported*/
  static struct saa7146_standard hexium_standards[] = {
  	{
  		.name	= "PAL", 	.id	= V4L2_STD_PAL,
  		.v_offset	= 28,	.v_field 	= 288,
  		.h_offset	= 1,	.h_pixels 	= 680,
  		.v_max_out	= 576,	.h_max_out	= 768,
  	}, {
  		.name	= "NTSC", 	.id	= V4L2_STD_NTSC,
  		.v_offset	= 28,	.v_field 	= 240,
  		.h_offset	= 1,	.h_pixels 	= 640,
  		.v_max_out	= 480,	.h_max_out	= 640,
  	}, {
  		.name	= "SECAM", 	.id	= V4L2_STD_SECAM,
  		.v_offset	= 28,	.v_field 	= 288,
  		.h_offset	= 1,	.h_pixels 	= 720,
  		.v_max_out	= 576,	.h_max_out	= 768,
  	}

  };

  
  /* bring hardware to a sane state. this has to be done, just in case someone
     wants to capture from this device before it has been properly initialized.
     the capture engine would badly fail, because no valid signal arrives on the
     saa7146, thus leading to timeouts and stuff. */
  static int hexium_init_done(struct saa7146_dev *dev)
  {
  	struct hexium *hexium = (struct hexium *) dev->ext_priv;
  	union i2c_smbus_data data;
  	int i = 0;

  	DEB_D("hexium_init_done called
  ");

  
  	/* initialize the helper ics to useful values */
  	for (i = 0; i < sizeof(hexium_ks0127b); i++) {
  		data.byte = hexium_ks0127b[i];
  		if (0 != i2c_smbus_xfer(&hexium->i2c_adapter, 0x6c, 0, I2C_SMBUS_WRITE, i, I2C_SMBUS_BYTE_DATA, &data)) {

  			pr_err("hexium_init_done() failed for address 0x%02x
  ",
  			       i);

  		}
  	}
  
  	return 0;
  }
  
  static int hexium_set_input(struct hexium *hexium, int input)
  {
  	union i2c_smbus_data data;

  	DEB_D("
  ");

  
  	data.byte = hexium_input_select[input].byte;
  	if (0 != i2c_smbus_xfer(&hexium->i2c_adapter, 0x6c, 0, I2C_SMBUS_WRITE, hexium_input_select[input].adr, I2C_SMBUS_BYTE_DATA, &data)) {
  		return -1;
  	}
  
  	return 0;
  }
  
  static int hexium_set_standard(struct hexium *hexium, struct hexium_data *vdec)
  {
  	union i2c_smbus_data data;
  	int i = 0;

  	DEB_D("
  ");

  
  	while (vdec[i].adr != -1) {
  		data.byte = vdec[i].byte;
  		if (0 != i2c_smbus_xfer(&hexium->i2c_adapter, 0x6c, 0, I2C_SMBUS_WRITE, vdec[i].adr, I2C_SMBUS_BYTE_DATA, &data)) {

  			pr_err("hexium_init_done: hexium_set_standard() failed for address 0x%02x
  ",
  			       i);

  			return -1;
  		}
  		i++;
  	}
  	return 0;
  }

  static int vidioc_enum_input(struct file *file, void *fh, struct v4l2_input *i)
  {

  	DEB_EE("VIDIOC_ENUMINPUT %d
  ", i->index);

  	if (i->index >= HEXIUM_INPUTS)

  		return -EINVAL;
  
  	memcpy(i, &hexium_inputs[i->index], sizeof(struct v4l2_input));

  	DEB_D("v4l2_ioctl: VIDIOC_ENUMINPUT %d
  ", i->index);

  	return 0;
  }
  
  static int vidioc_g_input(struct file *file, void *fh, unsigned int *input)
  {
  	struct saa7146_dev *dev = ((struct saa7146_fh *)fh)->dev;
  	struct hexium *hexium = (struct hexium *) dev->ext_priv;
  
  	*input = hexium->cur_input;

  	DEB_D("VIDIOC_G_INPUT: %d
  ", *input);

  	return 0;
  }
  
  static int vidioc_s_input(struct file *file, void *fh, unsigned int input)
  {
  	struct saa7146_dev *dev = ((struct saa7146_fh *)fh)->dev;
  	struct hexium *hexium = (struct hexium *) dev->ext_priv;

  	DEB_EE("VIDIOC_S_INPUT %d
  ", input);

  	if (input >= HEXIUM_INPUTS)

  		return -EINVAL;
  
  	hexium->cur_input = input;
  	hexium_set_input(hexium, input);
  	return 0;
  }
  
  /* the saa7146 provides some controls (brightness, contrast, saturation)
     which gets registered *after* this function. because of this we have

     to return with a value != 0 even if the function succeeded.. */

  static int vidioc_queryctrl(struct file *file, void *fh, struct v4l2_queryctrl *qc)
  {
  	struct saa7146_dev *dev = ((struct saa7146_fh *)fh)->dev;
  	int i;
  
  	for (i = HEXIUM_CONTROLS - 1; i >= 0; i--) {
  		if (hexium_controls[i].id == qc->id) {
  			*qc = hexium_controls[i];

  			DEB_D("VIDIOC_QUERYCTRL %d
  ", qc->id);

  			return 0;
  		}
  	}
  	return dev->ext_vv_data->core_ops->vidioc_queryctrl(file, fh, qc);
  }
  
  static int vidioc_g_ctrl(struct file *file, void *fh, struct v4l2_control *vc)
  {
  	struct saa7146_dev *dev = ((struct saa7146_fh *)fh)->dev;
  	struct hexium *hexium = (struct hexium *) dev->ext_priv;
  	int i;
  
  	for (i = HEXIUM_CONTROLS - 1; i >= 0; i--) {
  		if (hexium_controls[i].id == vc->id)
  			break;
  	}
  
  	if (i < 0)
  		return dev->ext_vv_data->core_ops->vidioc_g_ctrl(file, fh, vc);
  
  	if (vc->id == V4L2_CID_PRIVATE_BASE) {
  		vc->value = hexium->cur_bw;

  		DEB_D("VIDIOC_G_CTRL BW:%d
  ", vc->value);

  		return 0;
  	}
  	return -EINVAL;
  }
  
  static int vidioc_s_ctrl(struct file *file, void *fh, struct v4l2_control *vc)
  {
  	struct saa7146_dev *dev = ((struct saa7146_fh *)fh)->dev;
  	struct hexium *hexium = (struct hexium *) dev->ext_priv;
  	int i = 0;
  
  	for (i = HEXIUM_CONTROLS - 1; i >= 0; i--) {
  		if (hexium_controls[i].id == vc->id)
  			break;
  	}
  
  	if (i < 0)
  		return dev->ext_vv_data->core_ops->vidioc_s_ctrl(file, fh, vc);
  
  	if (vc->id == V4L2_CID_PRIVATE_BASE)
  		hexium->cur_bw = vc->value;

  	DEB_D("VIDIOC_S_CTRL BW:%d
  ", hexium->cur_bw);

  
  	if (0 == hexium->cur_bw && V4L2_STD_PAL == hexium->cur_std) {
  		hexium_set_standard(hexium, hexium_pal);
  		return 0;
  	}
  	if (0 == hexium->cur_bw && V4L2_STD_NTSC == hexium->cur_std) {
  		hexium_set_standard(hexium, hexium_ntsc);
  		return 0;
  	}
  	if (0 == hexium->cur_bw && V4L2_STD_SECAM == hexium->cur_std) {
  		hexium_set_standard(hexium, hexium_secam);
  		return 0;
  	}
  	if (1 == hexium->cur_bw && V4L2_STD_PAL == hexium->cur_std) {
  		hexium_set_standard(hexium, hexium_pal_bw);
  		return 0;
  	}
  	if (1 == hexium->cur_bw && V4L2_STD_NTSC == hexium->cur_std) {
  		hexium_set_standard(hexium, hexium_ntsc_bw);
  		return 0;
  	}
  	if (1 == hexium->cur_bw && V4L2_STD_SECAM == hexium->cur_std)
  		/* fixme: is there no bw secam mode? */
  		return -EINVAL;
  
  	return -EINVAL;
  }

  static struct saa7146_ext_vv vv_data;
  
  /* this function only gets called when the probing was successful */
  static int hexium_attach(struct saa7146_dev *dev, struct saa7146_pci_extension_data *info)
  {

  	struct hexium *hexium;

  	int ret;

  	DEB_EE("
  ");

  	hexium = kzalloc(sizeof(struct hexium), GFP_KERNEL);

  	if (NULL == hexium) {

  		pr_err("not enough kernel memory in hexium_attach()
  ");

  		return -ENOMEM;
  	}

  	dev->ext_priv = hexium;
  
  	/* enable i2c-port pins */
  	saa7146_write(dev, MC1, (MASK_08 | MASK_24 | MASK_10 | MASK_26));
  
  	hexium->i2c_adapter = (struct i2c_adapter) {

  		.name = "hexium gemini",
  	};
  	saa7146_i2c_adapter_prepare(dev, &hexium->i2c_adapter, SAA7146_I2C_BUS_BIT_RATE_480);
  	if (i2c_add_adapter(&hexium->i2c_adapter) < 0) {

  		DEB_S("cannot register i2c-device. skipping.
  ");

  		kfree(hexium);
  		return -EFAULT;
  	}
  
  	/*  set HWControl GPIO number 2 */
  	saa7146_setgpio(dev, 2, SAA7146_GPIO_OUTHI);
  
  	saa7146_write(dev, DD1_INIT, 0x07000700);
  	saa7146_write(dev, DD1_STREAM_B, 0x00000000);
  	saa7146_write(dev, MC2, (MASK_09 | MASK_25 | MASK_10 | MASK_26));
  
  	/* the rest */
  	hexium->cur_input = 0;
  	hexium_init_done(dev);
  
  	hexium_set_standard(hexium, hexium_pal);
  	hexium->cur_std = V4L2_STD_PAL;
  
  	hexium_set_input(hexium, 0);
  	hexium->cur_input = 0;
  
  	saa7146_vv_init(dev, &vv_data);

  	vv_data.ops.vidioc_queryctrl = vidioc_queryctrl;
  	vv_data.ops.vidioc_g_ctrl = vidioc_g_ctrl;
  	vv_data.ops.vidioc_s_ctrl = vidioc_s_ctrl;
  	vv_data.ops.vidioc_enum_input = vidioc_enum_input;
  	vv_data.ops.vidioc_g_input = vidioc_g_input;
  	vv_data.ops.vidioc_s_input = vidioc_s_input;

  	ret = saa7146_register_device(&hexium->video_dev, dev, "hexium gemini", VFL_TYPE_GRABBER);
  	if (ret < 0) {

  		pr_err("cannot register capture v4l2 device. skipping.
  ");

  		return ret;

  	}

  	pr_info("found 'hexium gemini' frame grabber-%d
  ", hexium_num);

  	hexium_num++;
  
  	return 0;
  }
  
  static int hexium_detach(struct saa7146_dev *dev)
  {
  	struct hexium *hexium = (struct hexium *) dev->ext_priv;

  	DEB_EE("dev:%p
  ", dev);

  
  	saa7146_unregister_device(&hexium->video_dev, dev);
  	saa7146_vv_release(dev);
  
  	hexium_num--;
  
  	i2c_del_adapter(&hexium->i2c_adapter);
  	kfree(hexium);
  	return 0;
  }

  static int std_callback(struct saa7146_dev *dev, struct saa7146_standard *std)
  {
  	struct hexium *hexium = (struct hexium *) dev->ext_priv;
  
  	if (V4L2_STD_PAL == std->id) {
  		hexium_set_standard(hexium, hexium_pal);
  		hexium->cur_std = V4L2_STD_PAL;
  		return 0;
  	} else if (V4L2_STD_NTSC == std->id) {
  		hexium_set_standard(hexium, hexium_ntsc);
  		hexium->cur_std = V4L2_STD_NTSC;
  		return 0;
  	} else if (V4L2_STD_SECAM == std->id) {
  		hexium_set_standard(hexium, hexium_secam);
  		hexium->cur_std = V4L2_STD_SECAM;
  		return 0;
  	}
  
  	return -1;
  }
  
  static struct saa7146_extension hexium_extension;
  
  static struct saa7146_pci_extension_data hexium_gemini_4bnc = {
  	.ext_priv = "Hexium Gemini (4 BNC)",
  	.ext = &hexium_extension,
  };
  
  static struct saa7146_pci_extension_data hexium_gemini_dual_4bnc = {
  	.ext_priv = "Hexium Gemini Dual (4 BNC)",
  	.ext = &hexium_extension,
  };
  
  static struct pci_device_id pci_tbl[] = {
  	{
  	 .vendor = PCI_VENDOR_ID_PHILIPS,
  	 .device = PCI_DEVICE_ID_PHILIPS_SAA7146,
  	 .subvendor = 0x17c8,
  	 .subdevice = 0x2401,
  	 .driver_data = (unsigned long) &hexium_gemini_4bnc,
  	 },
  	{
  	 .vendor = PCI_VENDOR_ID_PHILIPS,
  	 .device = PCI_DEVICE_ID_PHILIPS_SAA7146,
  	 .subvendor = 0x17c8,
  	 .subdevice = 0x2402,
  	 .driver_data = (unsigned long) &hexium_gemini_dual_4bnc,
  	 },
  	{
  	 .vendor = 0,
  	 }
  };
  
  MODULE_DEVICE_TABLE(pci, pci_tbl);
  
  static struct saa7146_ext_vv vv_data = {
  	.inputs = HEXIUM_INPUTS,
  	.capabilities = 0,
  	.stds = &hexium_standards[0],
  	.num_stds = sizeof(hexium_standards) / sizeof(struct saa7146_standard),
  	.std_callback = &std_callback,

  };
  
  static struct saa7146_extension hexium_extension = {
  	.name = "hexium gemini",
  	.flags = SAA7146_USE_I2C_IRQ,
  
  	.pci_tbl = &pci_tbl[0],
  	.module = THIS_MODULE,
  
  	.attach = hexium_attach,
  	.detach = hexium_detach,
  
  	.irq_mask = 0,
  	.irq_func = NULL,
  };
  
  static int __init hexium_init_module(void)
  {
  	if (0 != saa7146_register_extension(&hexium_extension)) {

  		DEB_S("failed to register extension
  ");

  		return -ENODEV;
  	}
  
  	return 0;
  }
  
  static void __exit hexium_cleanup_module(void)
  {
  	saa7146_unregister_extension(&hexium_extension);
  }
  
  module_init(hexium_init_module);
  module_exit(hexium_cleanup_module);
  
  MODULE_DESCRIPTION("video4linux-2 driver for Hexium Gemini frame grabber cards");
  MODULE_AUTHOR("Michael Hunold <michael@mihu.de>");
  MODULE_LICENSE("GPL");