drivers/media/video/gspca/m5602/m5602_s5k83a.c

   1 /*
   2  * Driver for the s5k83a sensor
   3  *
   4  * Copyright (C) 2008 Erik Andrén
   5  * Copyright (C) 2007 Ilyes Gouta. Based on the m5603x Linux Driver Project.
   6  * Copyright (C) 2005 m5603x Linux Driver Project <m5602@x3ng.com.br>
   7  *
   8  * Portions of code to USB interface and ALi driver software,
   9  * Copyright (c) 2006 Willem Duinker
  10  * v4l2 interface modeled after the V4L2 driver
  11  * for SN9C10x PC Camera Controllers
  12  *
  13  * This program is free software; you can redistribute it and/or
  14  * modify it under the terms of the GNU General Public License as
  15  * published by the Free Software Foundation, version 2.
  16  *
  17  */
  18
  19 #include "m5602_s5k83a.h"
  20
  21 static void s5k83a_dump_registers(struct sd *sd);
  22
  23 int s5k83a_probe(struct sd *sd)
  24 {
  25         u8 prod_id = 0, ver_id = 0;
  26         int i, err = 0;
  27
  28         if (force_sensor) {
  29                 if (force_sensor == S5K83A_SENSOR) {
  30                         info("Forcing a %s sensor", s5k83a.name);
  31                         goto sensor_found;
  32                 }
  33                 /* If we want to force another sensor, don't try to probe this
  34                  * one */
  35                 return -ENODEV;
  36         }
  37
  38         info("Probing for a s5k83a sensor");
  39
  40         /* Preinit the sensor */
  41         for (i = 0; i < ARRAY_SIZE(preinit_s5k83a) && !err; i++) {
  42                 u8 data[2] = {preinit_s5k83a[i][2], preinit_s5k83a[i][3]};
  43                 if (preinit_s5k83a[i][0] == SENSOR)
  44                         err = m5602_write_sensor(sd, preinit_s5k83a[i][1],
  45                                 data, 2);
  46                 else
  47                         err = m5602_write_bridge(sd, preinit_s5k83a[i][1],
  48                                 data[0]);
  49         }
  50
  51         /* We don't know what register (if any) that contain the product id
  52          * Just pick the first addresses that seem to produce the same results
  53          * on multiple machines */
  54         if (s5k83a_read_sensor(sd, 0x00, &prod_id, 1))
  55                 return -ENODEV;
  56
  57         if (s5k83a_read_sensor(sd, 0x01, &ver_id, 1))
  58                 return -ENODEV;
  59
  60         if ((prod_id == 0xff) || (ver_id == 0xff))
  61                 return -ENODEV;
  62         else
  63                 info("Detected a s5k83a sensor");
  64
  65 sensor_found:
  66         sd->gspca_dev.cam.cam_mode = s5k83a.modes;
  67         sd->gspca_dev.cam.nmodes = s5k83a.nmodes;
  68         sd->desc->ctrls = s5k83a.ctrls;
  69         sd->desc->nctrls = s5k83a.nctrls;
  70         return 0;
  71 }
  72
  73 int s5k83a_read_sensor(struct sd *sd, const u8 address,
  74                        u8 *i2c_data, const u8 len)
  75 {
  76         int err, i;
  77
  78         do {
  79                 err = m5602_read_bridge(sd, M5602_XB_I2C_STATUS, i2c_data);
  80         } while ((*i2c_data & I2C_BUSY) && !err);
  81         if (err < 0)
  82                 goto out;
  83
  84         err = m5602_write_bridge(sd, M5602_XB_I2C_DEV_ADDR,
  85                                  sd->sensor->i2c_slave_id);
  86         if (err < 0)
  87                 goto out;
  88
  89         err = m5602_write_bridge(sd, M5602_XB_I2C_REG_ADDR, address);
  90         if (err < 0)
  91                 goto out;
  92
  93         err = m5602_write_bridge(sd, M5602_XB_I2C_CTRL, 0x18 + len);
  94
  95         do {
  96                 err = m5602_read_bridge(sd, M5602_XB_I2C_STATUS, i2c_data);
  97         } while ((*i2c_data & I2C_BUSY) && !err);
  98
  99         for (i = 0; i < len && !len; i++) {
 100                 err = m5602_read_bridge(sd, M5602_XB_I2C_DATA, &(i2c_data[i]));
 101
 102                 PDEBUG(D_CONF, "Reading sensor register "
 103                                   "0x%x containing 0x%x ", address, *i2c_data);
 104         }
 105
 106 out:
 107         return err;
 108 }
 109
 110 int s5k83a_write_sensor(struct sd *sd, const u8 address,
 111                         u8 *i2c_data, const u8 len)
 112 {
 113         int err, i;
 114         u8 *p;
 115         struct usb_device *udev = sd->gspca_dev.dev;
 116         __u8 *buf = sd->gspca_dev.usb_buf;
 117
 118         /* No sensor with a data width larger than 16 bits has yet been seen */
 119         if (len > 2 || !len)
 120                 return -EINVAL;
 121
 122         memcpy(buf, sensor_urb_skeleton,
 123                sizeof(sensor_urb_skeleton));
 124
 125         buf[11] = sd->sensor->i2c_slave_id;
 126         buf[15] = address;
 127
 128         /* Special case larger sensor writes */
 129         p = buf + 16;
 130
 131         /* Copy a four byte write sequence for each byte to be written to */
 132         for (i = 0; i < len; i++) {
 133                 memcpy(p, sensor_urb_skeleton + 16, 4);
 134                 p[3] = i2c_data[i];
 135                 p += 4;
 136                 PDEBUG(D_CONF, "Writing sensor register 0x%x with 0x%x",
 137                        address, i2c_data[i]);
 138         }
 139
 140         /* Copy the tailer */
 141         memcpy(p, sensor_urb_skeleton + 20, 4);
 142
 143         /* Set the total length */
 144         p[3] = 0x10 + len;
 145
 146         err = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
 147                               0x04, 0x40, 0x19,
 148                               0x0000, buf,
 149                               20 + len * 4, M5602_URB_MSG_TIMEOUT);
 150
 151         return (err < 0) ? err : 0;
 152 }
 153
 154 int s5k83a_init(struct sd *sd)
 155 {
 156         int i, err = 0;
 157
 158         for (i = 0; i < ARRAY_SIZE(init_s5k83a) && !err; i++) {
 159                 u8 data[2] = {0x00, 0x00};
 160
 161                 switch (init_s5k83a[i][0]) {
 162                 case BRIDGE:
 163                         err = m5602_write_bridge(sd,
 164                                         init_s5k83a[i][1],
 165                                         init_s5k83a[i][2]);
 166                         break;
 167
 168                 case SENSOR:
 169                         data[0] = init_s5k83a[i][2];
 170                         err = m5602_write_sensor(sd,
 171                                 init_s5k83a[i][1], data, 1);
 172                         break;
 173
 174                 case SENSOR_LONG:
 175                         data[0] = init_s5k83a[i][2];
 176                         data[1] = init_s5k83a[i][3];
 177                         err = m5602_write_sensor(sd,
 178                                 init_s5k83a[i][1], data, 2);
 179                         break;
 180                 default:
 181                         info("Invalid stream command, exiting init");
 182                         return -EINVAL;
 183                 }
 184         }
 185
 186         if (dump_sensor)
 187                 s5k83a_dump_registers(sd);
 188
 189         return (err < 0) ? err : 0;
 190 }
 191
 192 int s5k83a_power_down(struct sd *sd)
 193 {
 194         return 0;
 195 }
 196
 197 void s5k83a_dump_registers(struct sd *sd)
 198 {
 199         int address;
 200         u8 page, old_page;
 201         s5k83a_read_sensor(sd, S5K83A_PAGE_MAP, &old_page, 1);
 202
 203         for (page = 0; page < 16; page++) {
 204                 m5602_write_sensor(sd, S5K83A_PAGE_MAP, &page, 1);
 205                 info("Dumping the s5k83a register state for page 0x%x", page);
 206                 for (address = 0; address <= 0xff; address++) {
 207                         u8 val = 0;
 208                         s5k83a_read_sensor(sd, address, &val, 1);
 209                         info("register 0x%x contains 0x%x",
 210                              address, val);
 211                 }
 212         }
 213         info("s5k83a register state dump complete");
 214
 215         for (page = 0; page < 16; page++) {
 216                 m5602_write_sensor(sd, S5K83A_PAGE_MAP, &page, 1);
 217                 info("Probing for which registers that are read/write "
 218                       "for page 0x%x", page);
 219                 for (address = 0; address <= 0xff; address++) {
 220                         u8 old_val, ctrl_val, test_val = 0xff;
 221
 222                         s5k83a_read_sensor(sd, address, &old_val, 1);
 223                         m5602_write_sensor(sd, address, &test_val, 1);
 224                         s5k83a_read_sensor(sd, address, &ctrl_val, 1);
 225
 226                         if (ctrl_val == test_val)
 227                                 info("register 0x%x is writeable", address);
 228                         else
 229                                 info("register 0x%x is read only", address);
 230
 231                         /* Restore original val */
 232                         m5602_write_sensor(sd, address, &old_val, 1);
 233                 }
 234         }
 235         info("Read/write register probing complete");
 236         m5602_write_sensor(sd, S5K83A_PAGE_MAP, &old_page, 1);
 237 }
 238
 239 int s5k83a_get_brightness(struct gspca_dev *gspca_dev, __s32 *val)
 240 {
 241         int err;
 242         u8 data[2];
 243         struct sd *sd = (struct sd *) gspca_dev;
 244
 245         err = s5k83a_read_sensor(sd, S5K83A_BRIGHTNESS, data, 2);
 246         if (err < 0)
 247                 goto out;
 248
 249         data[1] = data[1] << 1;
 250         *val = data[1];
 251
 252 out:
 253         return err;
 254 }
 255
 256 int s5k83a_set_brightness(struct gspca_dev *gspca_dev, __s32 val)
 257 {
 258         int err;
 259         u8 data[2];
 260         struct sd *sd = (struct sd *) gspca_dev;
 261
 262         data[0] = 0x00;
 263         data[1] = 0x20;
 264         err = m5602_write_sensor(sd, 0x14, data, 2);
 265         if (err < 0)
 266                 goto out;
 267
 268         data[0] = 0x01;
 269         data[1] = 0x00;
 270         err = m5602_write_sensor(sd, 0x0d, data, 2);
 271         if (err < 0)
 272                 goto out;
 273
 274         /* FIXME: This is not sane, we need to figure out the composition
 275                   of these registers */
 276         data[0] = val >> 3; /* brightness, high 5 bits */
 277         data[1] = val >> 1; /* brightness, high 7 bits */
 278         err = m5602_write_sensor(sd, S5K83A_BRIGHTNESS, data, 2);
 279
 280 out:
 281         return err;
 282 }
 283
 284 int s5k83a_get_whiteness(struct gspca_dev *gspca_dev, __s32 *val)
 285 {
 286         int err;
 287         u8 data;
 288         struct sd *sd = (struct sd *) gspca_dev;
 289
 290         err = s5k83a_read_sensor(sd, S5K83A_WHITENESS, &data, 1);
 291         if (err < 0)
 292                 goto out;
 293
 294         *val = data;
 295
 296 out:
 297         return err;
 298 }
 299
 300 int s5k83a_set_whiteness(struct gspca_dev *gspca_dev, __s32 val)
 301 {
 302         int err;
 303         u8 data[1];
 304         struct sd *sd = (struct sd *) gspca_dev;
 305
 306         data[0] = val;
 307         err = m5602_write_sensor(sd, S5K83A_WHITENESS, data, 1);
 308
 309         return err;
 310 }
 311
 312 int s5k83a_get_gain(struct gspca_dev *gspca_dev, __s32 *val)
 313 {
 314         int err;
 315         u8 data[2];
 316         struct sd *sd = (struct sd *) gspca_dev;
 317
 318         err = s5k83a_read_sensor(sd, S5K83A_GAIN, data, 2);
 319         if (err < 0)
 320                 goto out;
 321
 322         data[1] = data[1] & 0x3f;
 323         if (data[1] > S5K83A_MAXIMUM_GAIN)
 324                 data[1] = S5K83A_MAXIMUM_GAIN;
 325
 326         *val = data[1];
 327
 328 out:
 329         return err;
 330 }
 331
 332 int s5k83a_set_gain(struct gspca_dev *gspca_dev, __s32 val)
 333 {
 334         int err;
 335         u8 data[2];
 336         struct sd *sd = (struct sd *) gspca_dev;
 337
 338         data[0] = 0;
 339         data[1] = val;
 340         err = m5602_write_sensor(sd, S5K83A_GAIN, data, 2);
 341         return err;
 342 }
 343
 344 int s5k83a_get_vflip(struct gspca_dev *gspca_dev, __s32 *val)
 345 {
 346         int err;
 347         u8 data[1];
 348         struct sd *sd = (struct sd *) gspca_dev;
 349
 350         data[0] = 0x05;
 351         err = m5602_write_sensor(sd, S5K83A_PAGE_MAP, data, 1);
 352         if (err < 0)
 353                 goto out;
 354
 355         err = s5k83a_read_sensor(sd, S5K83A_FLIP, data, 1);
 356         *val = (data[0] | 0x40) ? 1 : 0;
 357
 358 out:
 359         return err;
 360 }
 361
 362 int s5k83a_set_vflip(struct gspca_dev *gspca_dev, __s32 val)
 363 {
 364         int err;
 365         u8 data[1];
 366         struct sd *sd = (struct sd *) gspca_dev;
 367
 368         data[0] = 0x05;
 369         err = m5602_write_sensor(sd, S5K83A_PAGE_MAP, data, 1);
 370         if (err < 0)
 371                 goto out;
 372
 373         err = s5k83a_read_sensor(sd, S5K83A_FLIP, data, 1);
 374         if (err < 0)
 375                 goto out;
 376
 377         /* set or zero six bit, seven is hflip */
 378         data[0] = (val) ? (data[0] & 0x80) | 0x40 | S5K83A_FLIP_MASK
 379                         : (data[0] & 0x80) | S5K83A_FLIP_MASK;
 380         err = m5602_write_sensor(sd, S5K83A_FLIP, data, 1);
 381         if (err < 0)
 382                 goto out;
 383
 384         data[0] = (val) ? 0x0b : 0x0a;
 385         err = m5602_write_sensor(sd, S5K83A_VFLIP_TUNE, data, 1);
 386
 387 out:
 388         return err;
 389 }
 390
 391 int s5k83a_get_hflip(struct gspca_dev *gspca_dev, __s32 *val)
 392 {
 393         int err;
 394         u8 data[1];
 395         struct sd *sd = (struct sd *) gspca_dev;
 396
 397         data[0] = 0x05;
 398         err = m5602_write_sensor(sd, S5K83A_PAGE_MAP, data, 1);
 399         if (err < 0)
 400                 goto out;
 401
 402         err = s5k83a_read_sensor(sd, S5K83A_FLIP, data, 1);
 403         *val = (data[0] | 0x80) ? 1 : 0;
 404
 405 out:
 406         return err;
 407 }
 408
 409 int s5k83a_set_hflip(struct gspca_dev *gspca_dev, __s32 val)
 410 {
 411         int err;
 412         u8 data[1];
 413         struct sd *sd = (struct sd *) gspca_dev;
 414
 415         data[0] = 0x05;
 416         err = m5602_write_sensor(sd, S5K83A_PAGE_MAP, data, 1);
 417         if (err < 0)
 418                 goto out;
 419
 420         err = s5k83a_read_sensor(sd, S5K83A_FLIP, data, 1);
 421         if (err < 0)
 422                 goto out;
 423
 424         /* set or zero seven bit, six is vflip */
 425         data[0] = (val) ? (data[0] & 0x40) | 0x80 | S5K83A_FLIP_MASK
 426                         : (data[0] & 0x40) | S5K83A_FLIP_MASK;
 427         err = m5602_write_sensor(sd, S5K83A_FLIP, data, 1);
 428         if (err < 0)
 429                 goto out;
 430
 431         data[0] = (val) ? 0x0a : 0x0b;
 432         err = m5602_write_sensor(sd, S5K83A_HFLIP_TUNE, data, 1);
 433 out:
 434         return err;
 435 }