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