drivers/media/video/saa711x.c

   1 /*
   2  * saa711x - Philips SAA711x video decoder driver version 0.0.1
   3  *
   4  * To do: Now, it handles only saa7113/7114. Should be improved to
   5  * handle all Philips saa711x devices.
   6  *
   7  * Based on saa7113 driver from Dave Perks <dperks@ibm.net>
   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 as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  22  */
  23
  24 #include <linux/module.h>
  25 #include <linux/init.h>
  26 #include <linux/delay.h>
  27 #include <linux/errno.h>
  28 #include <linux/fs.h>
  29 #include <linux/kernel.h>
  30 #include <linux/major.h>
  31 #include <linux/slab.h>
  32 #include <linux/mm.h>
  33 #include <linux/pci.h>
  34 #include <linux/signal.h>
  35 #include <asm/io.h>
  36 #include <asm/pgtable.h>
  37 #include <asm/page.h>
  38 #include <linux/types.h>
  39 #include <asm/uaccess.h>
  40 #include <linux/videodev.h>
  41
  42 MODULE_DESCRIPTION("Philips SAA711x video decoder driver");
  43 MODULE_AUTHOR("Dave Perks, Jose Ignacio Gijon, Joerg Heckenbach, Mark McClelland, Dwaine Garden");
  44 MODULE_LICENSE("GPL");
  45
  46 #include <linux/i2c.h>
  47
  48 #define I2C_NAME(s) (s)->name
  49
  50 #include <linux/video_decoder.h>
  51
  52 static int debug = 0;
  53 module_param(debug, int, 0644);
  54 MODULE_PARM_DESC(debug, " Set the default Debug level.  Default: 0 (Off) - (0-1)");
  55
  56
  57 #define dprintk(num, format, args...) \
  58         do { \
  59                 if (debug >= num) \
  60                         printk(format, ##args); \
  61         } while (0)
  62
  63 /* ----------------------------------------------------------------------- */
  64
  65 struct saa711x {
  66         unsigned char reg[32];
  67
  68         int norm;
  69         int input;
  70         int enable;
  71         int bright;
  72         int contrast;
  73         int hue;
  74         int sat;
  75 };
  76
  77 #define   I2C_SAA7113        0x4A
  78 #define   I2C_SAA7114        0x42
  79
  80 /* ----------------------------------------------------------------------- */
  81
  82 static inline int
  83 saa711x_write (struct i2c_client *client,
  84                u8                 reg,
  85                u8                 value)
  86 {
  87         struct saa711x *decoder = i2c_get_clientdata(client);
  88
  89         decoder->reg[reg] = value;
  90         return i2c_smbus_write_byte_data(client, reg, value);
  91 }
  92
  93 static int
  94 saa711x_write_block (struct i2c_client *client,
  95                      const u8          *data,
  96                      unsigned int       len)
  97 {
  98         int ret = -1;
  99         u8 reg;
 100
 101         /* the saa711x has an autoincrement function, use it if
 102          * the adapter understands raw I2C */
 103         if (i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) {
 104                 /* do raw I2C, not smbus compatible */
 105                 struct saa711x *decoder = i2c_get_clientdata(client);
 106                 struct i2c_msg msg;
 107                 u8 block_data[32];
 108
 109                 msg.addr = client->addr;
 110                 msg.flags = 0;
 111                 while (len >= 2) {
 112                         msg.buf = (char *) block_data;
 113                         msg.len = 0;
 114                         block_data[msg.len++] = reg = data[0];
 115                         do {
 116                                 block_data[msg.len++] =
 117                                     decoder->reg[reg++] = data[1];
 118                                 len -= 2;
 119                                 data += 2;
 120                         } while (len >= 2 && data[0] == reg &&
 121                                  msg.len < 32);
 122                         if ((ret = i2c_transfer(client->adapter,
 123                                                 &msg, 1)) < 0)
 124                                 break;
 125                 }
 126         } else {
 127                 /* do some slow I2C emulation kind of thing */
 128                 while (len >= 2) {
 129                         reg = *data++;
 130                         if ((ret = saa711x_write(client, reg,
 131                                                  *data++)) < 0)
 132                                 break;
 133                         len -= 2;
 134                 }
 135         }
 136
 137         return ret;
 138 }
 139
 140 static int
 141 saa711x_init_decoder (struct i2c_client *client,
 142               struct video_decoder_init *init)
 143 {
 144         return saa711x_write_block(client, init->data, init->len);
 145 }
 146
 147 static inline int
 148 saa711x_read (struct i2c_client *client,
 149               u8                 reg)
 150 {
 151         return i2c_smbus_read_byte_data(client, reg);
 152 }
 153
 154 /* ----------------------------------------------------------------------- */
 155
 156 static const unsigned char saa711x_i2c_init[] = {
 157         0x00, 0x00,     /* PH711x_CHIP_VERSION 00 - ID byte */
 158         0x01, 0x08,     /* PH711x_INCREMENT_DELAY - (1) (1) (1) (1) IDEL3 IDEL2 IDELL1 IDEL0 */
 159         0x02, 0xc0,     /* PH711x_ANALOG_INPUT_CONTR_1 - FUSE1 FUSE0 GUDL1 GUDL0 MODE3 MODE2 MODE1 MODE0 */
 160         0x03, 0x23,     /* PH711x_ANALOG_INPUT_CONTR_2 - (1) HLNRS VBSL WPOFF HOLDG GAFIX GAI28 GAI18 */
 161         0x04, 0x00,     /* PH711x_ANALOG_INPUT_CONTR_3 - GAI17 GAI16 GAI15 GAI14 GAI13 GAI12 GAI11 GAI10 */
 162         0x05, 0x00,     /* PH711x_ANALOG_INPUT_CONTR_4 - GAI27 GAI26 GAI25 GAI24 GAI23 GAI22 GAI21 GAI20 */
 163         0x06, 0xeb,     /* PH711x_HORIZONTAL_SYNC_START - HSB7 HSB6 HSB5 HSB4 HSB3 HSB2 HSB1 HSB0 */
 164         0x07, 0xe0,     /* PH711x_HORIZONTAL_SYNC_STOP - HSS7 HSS6 HSS5 HSS4 HSS3 HSS2 HSS1 HSS0 */
 165         0x08, 0x88,     /* PH711x_SYNC_CONTROL - AUFD FSEL FOET HTC1 HTC0 HPLL VNOI1 VNOI0 */
 166         0x09, 0x00,     /* PH711x_LUMINANCE_CONTROL - BYPS PREF BPSS1 BPSS0 VBLB UPTCV APER1 APER0 */
 167         0x0a, 0x80,     /* PH711x_LUMINANCE_BRIGHTNESS - BRIG7 BRIG6 BRIG5 BRIG4 BRIG3 BRIG2 BRIG1 BRIG0 */
 168         0x0b, 0x47,     /* PH711x_LUMINANCE_CONTRAST - CONT7 CONT6 CONT5 CONT4 CONT3 CONT2 CONT1 CONT0 */
 169         0x0c, 0x40,     /* PH711x_CHROMA_SATURATION - SATN7 SATN6 SATN5 SATN4 SATN3 SATN2 SATN1 SATN0 */
 170         0x0d, 0x00,     /* PH711x_CHROMA_HUE_CONTROL - HUEC7 HUEC6 HUEC5 HUEC4 HUEC3 HUEC2 HUEC1 HUEC0 */
 171         0x0e, 0x01,     /* PH711x_CHROMA_CONTROL - CDTO CSTD2 CSTD1 CSTD0 DCCF FCTC CHBW1 CHBW0 */
 172         0x0f, 0xaa,     /* PH711x_CHROMA_GAIN_CONTROL - ACGC CGAIN6 CGAIN5 CGAIN4 CGAIN3 CGAIN2 CGAIN1 CGAIN0 */
 173         0x10, 0x00,     /* PH711x_FORMAT_DELAY_CONTROL - OFTS1 OFTS0 HDEL1 HDEL0 VRLN YDEL2 YDEL1 YDEL0 */
 174         0x11, 0x1C,     /* PH711x_OUTPUT_CONTROL_1 - GPSW1 CM99 GPSW0 HLSEL OEYC OERT VIPB COLO */
 175         0x12, 0x01,     /* PH711x_OUTPUT_CONTROL_2 - RTSE13 RTSE12 RTSE11 RTSE10 RTSE03 RTSE02 RTSE01 RTSE00 */
 176         0x13, 0x00,     /* PH711x_OUTPUT_CONTROL_3 - ADLSB (1) (1) OLDSB FIDP (1) AOSL1 AOSL0 */
 177         0x14, 0x00,     /* RESERVED 14 - (1) (1) (1) (1) (1) (1) (1) (1) */
 178         0x15, 0x00,     /* PH711x_V_GATE1_START - VSTA7 VSTA6 VSTA5 VSTA4 VSTA3 VSTA2 VSTA1 VSTA0 */
 179         0x16, 0x00,     /* PH711x_V_GATE1_STOP - VSTO7 VSTO6 VSTO5 VSTO4 VSTO3 VSTO2 VSTO1 VSTO0 */
 180         0x17, 0x00,     /* PH711x_V_GATE1_MSB - (1) (1) (1) (1) (1) (1) VSTO8 VSTA8 */
 181 };
 182
 183 static int
 184 saa711x_command (struct i2c_client *client,
 185                  unsigned int       cmd,
 186                  void              *arg)
 187 {
 188         struct saa711x *decoder = i2c_get_clientdata(client);
 189
 190         switch (cmd) {
 191
 192         case 0:
 193         case DECODER_INIT:
 194         {
 195                 struct video_decoder_init *init = arg;
 196                 if (NULL != init)
 197                         return saa711x_init_decoder(client, init);
 198                 else {
 199                         struct video_decoder_init vdi;
 200                         vdi.data = saa711x_i2c_init;
 201                         vdi.len = sizeof(saa711x_i2c_init);
 202                         return saa711x_init_decoder(client, &vdi);
 203                 }
 204         }
 205
 206         case DECODER_DUMP:
 207         {
 208                 int i;
 209
 210                 for (i = 0; i < 32; i += 16) {
 211                         int j;
 212
 213                         printk(KERN_DEBUG "%s: %03x", I2C_NAME(client), i);
 214                         for (j = 0; j < 16; ++j) {
 215                                 printk(" %02x",
 216                                        saa711x_read(client, i + j));
 217                         }
 218                         printk("\n");
 219                 }
 220         }
 221                 break;
 222
 223         case DECODER_GET_CAPABILITIES:
 224         {
 225                 struct video_decoder_capability *cap = arg;
 226
 227                 cap->flags = VIDEO_DECODER_PAL |
 228                              VIDEO_DECODER_NTSC |
 229                              VIDEO_DECODER_SECAM |
 230                              VIDEO_DECODER_AUTO |
 231                              VIDEO_DECODER_CCIR;
 232                 cap->inputs = 8;
 233                 cap->outputs = 1;
 234         }
 235                 break;
 236
 237         case DECODER_GET_STATUS:
 238         {
 239                 int *iarg = arg;
 240                 int status;
 241                 int res;
 242
 243                 status = saa711x_read(client, 0x1f);
 244                 dprintk(1, KERN_DEBUG "%s status: 0x%02x\n", I2C_NAME(client),
 245                         status);
 246                 res = 0;
 247                 if ((status & (1 << 6)) == 0) {
 248                         res |= DECODER_STATUS_GOOD;
 249                 }
 250                 switch (decoder->norm) {
 251                 case VIDEO_MODE_NTSC:
 252                         res |= DECODER_STATUS_NTSC;
 253                         break;
 254                 case VIDEO_MODE_PAL:
 255                         res |= DECODER_STATUS_PAL;
 256                         break;
 257                 case VIDEO_MODE_SECAM:
 258                         res |= DECODER_STATUS_SECAM;
 259                         break;
 260                 default:
 261                 case VIDEO_MODE_AUTO:
 262                         if ((status & (1 << 5)) != 0) {
 263                                 res |= DECODER_STATUS_NTSC;
 264                         } else {
 265                                 res |= DECODER_STATUS_PAL;
 266                         }
 267                         break;
 268                 }
 269                 if ((status & (1 << 0)) != 0) {
 270                         res |= DECODER_STATUS_COLOR;
 271                 }
 272                 *iarg = res;
 273         }
 274                 break;
 275
 276         case DECODER_SET_GPIO:
 277         {
 278                 int *iarg = arg;
 279                 if (0 != *iarg) {
 280                         saa711x_write(client, 0x11,
 281                                 (decoder->reg[0x11] | 0x80));
 282                 } else {
 283                         saa711x_write(client, 0x11,
 284                                 (decoder->reg[0x11] & 0x7f));
 285                 }
 286                 break;
 287         }
 288
 289         case DECODER_SET_VBI_BYPASS:
 290         {
 291                 int *iarg = arg;
 292                 if (0 != *iarg) {
 293                         saa711x_write(client, 0x13,
 294                                 (decoder->reg[0x13] & 0xf0) | 0x0a);
 295                 } else {
 296                         saa711x_write(client, 0x13,
 297                                 (decoder->reg[0x13] & 0xf0));
 298                 }
 299                 break;
 300         }
 301
 302         case DECODER_SET_NORM:
 303         {
 304                 int *iarg = arg;
 305
 306                 switch (*iarg) {
 307
 308                 case VIDEO_MODE_NTSC:
 309                         saa711x_write(client, 0x08,
 310                                       (decoder->reg[0x08] & 0x3f) | 0x40);
 311                         saa711x_write(client, 0x0e,
 312                                       (decoder->reg[0x0e] & 0x8f));
 313                         break;
 314
 315                 case VIDEO_MODE_PAL:
 316                         saa711x_write(client, 0x08,
 317                                       (decoder->reg[0x08] & 0x3f) | 0x00);
 318                         saa711x_write(client, 0x0e,
 319                                       (decoder->reg[0x0e] & 0x8f));
 320                         break;
 321
 322                 case VIDEO_MODE_SECAM:
 323                         saa711x_write(client, 0x08,
 324                                       (decoder->reg[0x08] & 0x3f) | 0x00);
 325                         saa711x_write(client, 0x0e,
 326                                       (decoder->reg[0x0e] & 0x8f) | 0x50);
 327                         break;
 328
 329                 case VIDEO_MODE_AUTO:
 330                         saa711x_write(client, 0x08,
 331                                       (decoder->reg[0x08] & 0x3f) | 0x80);
 332                         saa711x_write(client, 0x0e,
 333                                       (decoder->reg[0x0e] & 0x8f));
 334                         break;
 335
 336                 default:
 337                         return -EINVAL;
 338
 339                 }
 340                 decoder->norm = *iarg;
 341         }
 342                 break;
 343
 344         case DECODER_SET_INPUT:
 345         {
 346                 int *iarg = arg;
 347                 if (*iarg < 0 || *iarg > 9) {
 348                         return -EINVAL;
 349                 }
 350                 if (decoder->input != *iarg) {
 351                         decoder->input = *iarg;
 352                         /* select mode */
 353                         saa711x_write(client, 0x02,
 354                                       (decoder->reg[0x02] & 0xf0) | decoder->input);
 355                         /* bypass chrominance trap for modes 4..7 */
 356                         saa711x_write(client, 0x09,
 357                                       (decoder->reg[0x09] & 0x7f) | ((decoder->input > 3) ? 0x80 : 0));
 358                 }
 359         }
 360                 break;
 361
 362         case DECODER_SET_OUTPUT:
 363         {
 364                 int *iarg = arg;
 365
 366                 /* not much choice of outputs */
 367                 if (*iarg != 0) {
 368                         return -EINVAL;
 369                 }
 370         }
 371                 break;
 372
 373         case DECODER_ENABLE_OUTPUT:
 374         {
 375                 int *iarg = arg;
 376                 int enable = (*iarg != 0);
 377
 378                 if (decoder->enable != enable) {
 379                         decoder->enable = enable;
 380
 381                         /* RJ: If output should be disabled (for
 382                          * playing videos), we also need a open PLL.
 383                          * The input is set to 0 (where no input
 384                          * source is connected), although this
 385                          * is not necessary.
 386                          *
 387                          * If output should be enabled, we have to
 388                          * reverse the above.
 389                          */
 390
 391                         if (decoder->enable) {
 392                                 saa711x_write(client, 0x02,
 393                                               (decoder->
 394                                                reg[0x02] & 0xf8) |
 395                                               decoder->input);
 396                                 saa711x_write(client, 0x08,
 397                                               (decoder->reg[0x08] & 0xfb));
 398                                 saa711x_write(client, 0x11,
 399                                               (decoder->
 400                                                reg[0x11] & 0xf3) | 0x0c);
 401                         } else {
 402                                 saa711x_write(client, 0x02,
 403                                               (decoder->reg[0x02] & 0xf8));
 404                                 saa711x_write(client, 0x08,
 405                                               (decoder->
 406                                                reg[0x08] & 0xfb) | 0x04);
 407                                 saa711x_write(client, 0x11,
 408                                               (decoder->reg[0x11] & 0xf3));
 409                         }
 410                 }
 411         }
 412                 break;
 413
 414         case DECODER_SET_PICTURE:
 415         {
 416                 struct video_picture *pic = arg;
 417
 418                 if (decoder->bright != pic->brightness) {
 419                         /* We want 0 to 255 we get 0-65535 */
 420                         decoder->bright = pic->brightness;
 421                         saa711x_write(client, 0x0a, decoder->bright >> 8);
 422                 }
 423                 if (decoder->contrast != pic->contrast) {
 424                         /* We want 0 to 127 we get 0-65535 */
 425                         decoder->contrast = pic->contrast;
 426                         saa711x_write(client, 0x0b,
 427                                       decoder->contrast >> 9);
 428                 }
 429                 if (decoder->sat != pic->colour) {
 430                         /* We want 0 to 127 we get 0-65535 */
 431                         decoder->sat = pic->colour;
 432                         saa711x_write(client, 0x0c, decoder->sat >> 9);
 433                 }
 434                 if (decoder->hue != pic->hue) {
 435                         /* We want -128 to 127 we get 0-65535 */
 436                         decoder->hue = pic->hue;
 437                         saa711x_write(client, 0x0d,
 438                                       (decoder->hue - 32768) >> 8);
 439                 }
 440         }
 441                 break;
 442
 443         default:
 444                 return -EINVAL;
 445         }
 446
 447         return 0;
 448 }
 449
 450 /* ----------------------------------------------------------------------- */
 451
 452 /*
 453  * Generic i2c probe
 454  * concerning the addresses: i2c wants 7 bit (without the r/w bit), so '>>1'
 455  */
 456
 457 /* standard i2c insmod options */
 458 static unsigned short normal_i2c[] = {
 459         I2C_SAA7113>>1,         /* saa7113 */
 460         I2C_SAA7114>>1,         /* saa7114 */
 461         I2C_CLIENT_END
 462 };
 463
 464 I2C_CLIENT_INSMOD;
 465
 466
 467 static struct i2c_driver i2c_driver_saa711x;
 468
 469 static int
 470 saa711x_detect_client (struct i2c_adapter *adapter,
 471                        int                 address,
 472                        int                 kind)
 473 {
 474         int i;
 475         struct i2c_client *client;
 476         struct saa711x *decoder;
 477         struct video_decoder_init vdi;
 478
 479         dprintk(1,
 480                 KERN_INFO
 481                 "saa711x.c: detecting saa711x client on address 0x%x\n",
 482                 address << 1);
 483
 484         /* Check if the adapter supports the needed features */
 485         if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_BYTE_DATA))
 486                 return 0;
 487
 488         client = kzalloc(sizeof(struct i2c_client), GFP_KERNEL);
 489         if (client == 0)
 490                 return -ENOMEM;
 491         client->addr = address;
 492         client->adapter = adapter;
 493         client->driver = &i2c_driver_saa711x;
 494         strlcpy(I2C_NAME(client), "saa711x", sizeof(I2C_NAME(client)));
 495         decoder = kzalloc(sizeof(struct saa711x), GFP_KERNEL);
 496         if (decoder == NULL) {
 497                 kfree(client);
 498                 return -ENOMEM;
 499         }
 500         decoder->norm = VIDEO_MODE_NTSC;
 501         decoder->input = 0;
 502         decoder->enable = 1;
 503         decoder->bright = 32768;
 504         decoder->contrast = 32768;
 505         decoder->hue = 32768;
 506         decoder->sat = 32768;
 507         i2c_set_clientdata(client, decoder);
 508
 509         i = i2c_attach_client(client);
 510         if (i) {
 511                 kfree(client);
 512                 kfree(decoder);
 513                 return i;
 514         }
 515
 516         vdi.data = saa711x_i2c_init;
 517         vdi.len = sizeof(saa711x_i2c_init);
 518         i = saa711x_init_decoder(client, &vdi);
 519         if (i < 0) {
 520                 dprintk(1, KERN_ERR "%s_attach error: init status %d\n",
 521                         I2C_NAME(client), i);
 522         } else {
 523                 dprintk(1,
 524                         KERN_INFO
 525                         "%s_attach: chip version %x at address 0x%x\n",
 526                         I2C_NAME(client), saa711x_read(client, 0x00) >> 4,
 527                         client->addr << 1);
 528         }
 529
 530         return 0;
 531 }
 532
 533 static int
 534 saa711x_attach_adapter (struct i2c_adapter *adapter)
 535 {
 536         dprintk(1,
 537                 KERN_INFO
 538                 "saa711x.c: starting probe for adapter %s (0x%x)\n",
 539                 I2C_NAME(adapter), adapter->id);
 540         return i2c_probe(adapter, &addr_data, &saa711x_detect_client);
 541 }
 542
 543 static int
 544 saa711x_detach_client (struct i2c_client *client)
 545 {
 546         struct saa711x *decoder = i2c_get_clientdata(client);
 547         int err;
 548
 549         err = i2c_detach_client(client);
 550         if (err) {
 551                 return err;
 552         }
 553
 554         kfree(decoder);
 555         kfree(client);
 556
 557         return 0;
 558 }
 559
 560 /* ----------------------------------------------------------------------- */
 561
 562 static struct i2c_driver i2c_driver_saa711x = {
 563         .driver = {
 564                 .name = "saa711x",
 565         },
 566         .id = I2C_DRIVERID_SAA711X,
 567         .attach_adapter = saa711x_attach_adapter,
 568         .detach_client = saa711x_detach_client,
 569         .command = saa711x_command,
 570 };
 571
 572 static int __init
 573 saa711x_init (void)
 574 {
 575         return i2c_add_driver(&i2c_driver_saa711x);
 576 }
 577
 578 static void __exit
 579 saa711x_exit (void)
 580 {
 581         i2c_del_driver(&i2c_driver_saa711x);
 582 }
 583
 584 module_init(saa711x_init);
 585 module_exit(saa711x_exit);