drivers/i2c/chips/twl4030-madc.c

   1 /*
   2  * drivers/i2c/chips/twl4030-madc.c
   3  *
   4  * TWL4030 MADC module driver
   5  *
   6  * Copyright (C) 2008 Nokia Corporation
   7  * Mikko Ylinen <mikko.k.ylinen@nokia.com>
   8  *
   9  * This program is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU General Public License
  11  * version 2 as published by the Free Software Foundation.
  12  *
  13  * This program is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  21  * 02110-1301 USA
  22  *
  23  */
  24
  25 #include <linux/init.h>
  26 #include <linux/interrupt.h>
  27 #include <linux/kernel.h>
  28 #include <linux/types.h>
  29 #include <linux/module.h>
  30 #include <linux/delay.h>
  31 #include <linux/fs.h>
  32 #include <linux/platform_device.h>
  33 #include <linux/miscdevice.h>
  34 #include <linux/i2c/twl4030.h>
  35 #include <linux/i2c/twl4030-madc.h>
  36
  37 #include <asm/uaccess.h>
  38
  39 #define TWL4030_MADC_PFX        "twl4030-madc: "
  40
  41 struct twl4030_madc_data {
  42         struct device           *dev;
  43         struct mutex            lock;
  44         struct work_struct      ws;
  45         struct twl4030_madc_request     requests[TWL4030_MADC_NUM_METHODS];
  46         int imr;
  47         int isr;
  48 };
  49
  50 static struct twl4030_madc_data *the_madc;
  51
  52 static
  53 const struct twl4030_madc_conversion_method twl4030_conversion_methods[] = {
  54         [TWL4030_MADC_RT] = {
  55                 .sel    = TWL4030_MADC_RTSELECT_LSB,
  56                 .avg    = TWL4030_MADC_RTAVERAGE_LSB,
  57                 .rbase  = TWL4030_MADC_RTCH0_LSB,
  58         },
  59         [TWL4030_MADC_SW1] = {
  60                 .sel    = TWL4030_MADC_SW1SELECT_LSB,
  61                 .avg    = TWL4030_MADC_SW1AVERAGE_LSB,
  62                 .rbase  = TWL4030_MADC_GPCH0_LSB,
  63                 .ctrl   = TWL4030_MADC_CTRL_SW1,
  64         },
  65         [TWL4030_MADC_SW2] = {
  66                 .sel    = TWL4030_MADC_SW2SELECT_LSB,
  67                 .avg    = TWL4030_MADC_SW2AVERAGE_LSB,
  68                 .rbase  = TWL4030_MADC_GPCH0_LSB,
  69                 .ctrl   = TWL4030_MADC_CTRL_SW2,
  70         },
  71 };
  72
  73 static int twl4030_madc_read(struct twl4030_madc_data *madc, u8 reg)
  74 {
  75         int ret;
  76         u8 val;
  77
  78         ret = twl4030_i2c_read_u8(TWL4030_MODULE_MADC, &val, reg);
  79         if (ret) {
  80                 dev_dbg(madc->dev, "unable to read register 0x%X\n", reg);
  81                 return ret;
  82         }
  83
  84         return val;
  85 }
  86
  87 static void twl4030_madc_write(struct twl4030_madc_data *madc, u8 reg, u8 val)
  88 {
  89         int ret;
  90
  91         ret = twl4030_i2c_write_u8(TWL4030_MODULE_MADC, val, reg);
  92         if (ret)
  93                 dev_err(madc->dev, "unable to write register 0x%X\n", reg);
  94 }
  95
  96 static int twl4030_madc_channel_raw_read(struct twl4030_madc_data *madc, u8 reg)
  97 {
  98         u8 msb, lsb;
  99
 100         /* For each ADC channel, we have MSB and LSB register pair. MSB address
 101          * is always LSB address+1. reg parameter is the addr of LSB register */
 102         msb = twl4030_madc_read(madc, reg + 1);
 103         lsb = twl4030_madc_read(madc, reg);
 104
 105         return (int)(((msb << 8) | lsb) >> 6);
 106 }
 107
 108 static int twl4030_madc_read_channels(struct twl4030_madc_data *madc,
 109                 u8 reg_base, u16 channels, int *buf)
 110 {
 111         int count = 0;
 112         u8 reg, i;
 113
 114         if (unlikely(!buf))
 115                 return 0;
 116
 117         for (i = 0; i < TWL4030_MADC_MAX_CHANNELS; i++) {
 118                 if (channels & (1<<i)) {
 119                         reg = reg_base + 2*i;
 120                         buf[i] = twl4030_madc_channel_raw_read(madc, reg);
 121                         count++;
 122                 }
 123         }
 124         return count;
 125 }
 126
 127 static void twl4030_madc_enable_irq(struct twl4030_madc_data *madc, int id)
 128 {
 129         u8 val;
 130
 131         val = twl4030_madc_read(madc, madc->imr);
 132         val &= ~(1 << id);
 133         twl4030_madc_write(madc, madc->imr, val);
 134 }
 135
 136 static void twl4030_madc_disable_irq(struct twl4030_madc_data *madc, int id)
 137 {
 138         u8 val;
 139
 140         val = twl4030_madc_read(madc, madc->imr);
 141         val |= (1 << id);
 142         twl4030_madc_write(madc, madc->imr, val);
 143 }
 144
 145 static irqreturn_t twl4030_madc_irq_handler(int irq, void *_madc)
 146 {
 147         struct twl4030_madc_data *madc = _madc;
 148         u8 isr_val, imr_val;
 149         int i;
 150
 151 #ifdef CONFIG_LOCKDEP
 152         /* WORKAROUND for lockdep forcing IRQF_DISABLED on us, which
 153          * we don't want and can't tolerate.  Although it might be
 154          * friendlier not to borrow this thread context...
 155          */
 156         local_irq_enable();
 157 #endif
 158
 159         /* Use COR to ack interrupts since we have no shared IRQs in ISRx */
 160         isr_val = twl4030_madc_read(madc, madc->isr);
 161         imr_val = twl4030_madc_read(madc, madc->imr);
 162
 163         isr_val &= ~imr_val;
 164
 165         for (i = 0; i < TWL4030_MADC_NUM_METHODS; i++) {
 166
 167                 if (!(isr_val & (1<<i)))
 168                         continue;
 169
 170                 twl4030_madc_disable_irq(madc, i);
 171                 madc->requests[i].result_pending = 1;
 172         }
 173
 174         schedule_work(&madc->ws);
 175
 176         return IRQ_HANDLED;
 177 }
 178
 179 static void twl4030_madc_work(struct work_struct *ws)
 180 {
 181         const struct twl4030_madc_conversion_method *method;
 182         struct twl4030_madc_data *madc;
 183         struct twl4030_madc_request *r;
 184         int len, i;
 185
 186         madc = container_of(ws, struct twl4030_madc_data, ws);
 187         mutex_lock(&madc->lock);
 188
 189         for (i = 0; i < TWL4030_MADC_NUM_METHODS; i++) {
 190
 191                 r = &madc->requests[i];
 192
 193                 /* No pending results for this method, move to next one */
 194                 if (!r->result_pending)
 195                         continue;
 196
 197                 method = &twl4030_conversion_methods[r->method];
 198
 199                 /* Read results */
 200                 len = twl4030_madc_read_channels(madc, method->rbase,
 201                                                  r->channels, r->rbuf);
 202
 203                 /* Return results to caller */
 204                 if (r->func_cb != NULL) {
 205                         r->func_cb(len, r->channels, r->rbuf);
 206                         r->func_cb = NULL;
 207                 }
 208
 209                 /* Free request */
 210                 r->result_pending = 0;
 211                 r->active         = 0;
 212         }
 213
 214         mutex_unlock(&madc->lock);
 215 }
 216
 217 static int twl4030_madc_set_irq(struct twl4030_madc_data *madc,
 218                 struct twl4030_madc_request *req)
 219 {
 220         struct twl4030_madc_request *p;
 221
 222         p = &madc->requests[req->method];
 223
 224         memcpy(p, req, sizeof *req);
 225
 226         twl4030_madc_enable_irq(madc, req->method);
 227
 228         return 0;
 229 }
 230
 231 static inline void twl4030_madc_start_conversion(struct twl4030_madc_data *madc,
 232                 int conv_method)
 233 {
 234         const struct twl4030_madc_conversion_method *method;
 235
 236         method = &twl4030_conversion_methods[conv_method];
 237
 238         switch (conv_method) {
 239         case TWL4030_MADC_SW1:
 240         case TWL4030_MADC_SW2:
 241                 twl4030_madc_write(madc, method->ctrl, TWL4030_MADC_SW_START);
 242                 break;
 243         case TWL4030_MADC_RT:
 244         default:
 245                 break;
 246         }
 247 }
 248
 249 static void twl4030_madc_wait_conversion_ready_ms(
 250                 struct twl4030_madc_data *madc,
 251                 u8 *time, u8 status_reg)
 252 {
 253         u8 reg = 0;
 254
 255         do {
 256                 msleep(1);
 257                 (*time)--;
 258                 reg = twl4030_madc_read(madc, status_reg);
 259         } while (((reg & TWL4030_MADC_BUSY) && !(reg & TWL4030_MADC_EOC_SW)) &&
 260                   (*time != 0));
 261 }
 262
 263 int twl4030_madc_conversion(struct twl4030_madc_request *req)
 264 {
 265         const struct twl4030_madc_conversion_method *method;
 266         u8 wait_time, ch_msb, ch_lsb;
 267         int ret;
 268
 269         if (unlikely(!req))
 270                 return -EINVAL;
 271
 272         mutex_lock(&the_madc->lock);
 273
 274         /* Do we have a conversion request ongoing */
 275         if (the_madc->requests[req->method].active) {
 276                 ret = -EBUSY;
 277                 goto out;
 278         }
 279
 280         ch_msb = (req->channels >> 8) & 0xff;
 281         ch_lsb = req->channels & 0xff;
 282
 283         method = &twl4030_conversion_methods[req->method];
 284
 285         /* Select channels to be converted */
 286         twl4030_madc_write(the_madc, method->sel + 1, ch_msb);
 287         twl4030_madc_write(the_madc, method->sel, ch_lsb);
 288
 289         /* Select averaging for all channels if do_avg is set */
 290         if (req->do_avg) {
 291                 twl4030_madc_write(the_madc, method->avg + 1, ch_msb);
 292                 twl4030_madc_write(the_madc, method->avg, ch_lsb);
 293         }
 294
 295         if ((req->type == TWL4030_MADC_IRQ_ONESHOT) && (req->func_cb != NULL)) {
 296                 twl4030_madc_set_irq(the_madc, req);
 297                 twl4030_madc_start_conversion(the_madc, req->method);
 298                 the_madc->requests[req->method].active = 1;
 299                 ret = 0;
 300                 goto out;
 301         }
 302
 303         /* With RT method we should not be here anymore */
 304         if (req->method == TWL4030_MADC_RT) {
 305                 ret = -EINVAL;
 306                 goto out;
 307         }
 308
 309         twl4030_madc_start_conversion(the_madc, req->method);
 310         the_madc->requests[req->method].active = 1;
 311
 312         /* Wait until conversion is ready (ctrl register returns EOC) */
 313         wait_time = 50;
 314         twl4030_madc_wait_conversion_ready_ms(the_madc,
 315                         &wait_time, method->ctrl);
 316         if (wait_time == 0) {
 317                 dev_dbg(the_madc->dev, "conversion timeout!\n");
 318                 ret = -EAGAIN;
 319                 goto out;
 320         }
 321
 322         ret = twl4030_madc_read_channels(the_madc, method->rbase, req->channels,
 323                                          req->rbuf);
 324
 325         the_madc->requests[req->method].active = 0;
 326
 327 out:
 328         mutex_unlock(&the_madc->lock);
 329
 330         return ret;
 331 }
 332 EXPORT_SYMBOL(twl4030_madc_conversion);
 333
 334 static int twl4030_madc_set_current_generator(struct twl4030_madc_data *madc,
 335                 int chan, int on)
 336 {
 337         int ret;
 338         u8 regval;
 339
 340         /* Current generator is only available for ADCIN0 and ADCIN1. NB:
 341          * ADCIN1 current generator only works when AC or VBUS is present */
 342         if (chan > 1)
 343                 return EINVAL;
 344
 345         ret = twl4030_i2c_read_u8(TWL4030_MODULE_MAIN_CHARGE,
 346                                   &regval, TWL4030_BCI_BCICTL1);
 347         if (on)
 348                 regval |= (chan) ? TWL4030_BCI_ITHEN : TWL4030_BCI_TYPEN;
 349         else
 350                 regval &= (chan) ? ~TWL4030_BCI_ITHEN : ~TWL4030_BCI_TYPEN;
 351         ret = twl4030_i2c_write_u8(TWL4030_MODULE_MAIN_CHARGE,
 352                                    regval, TWL4030_BCI_BCICTL1);
 353
 354         return ret;
 355 }
 356
 357 static int twl4030_madc_set_power(struct twl4030_madc_data *madc, int on)
 358 {
 359         u8 regval;
 360
 361         regval = twl4030_madc_read(madc, TWL4030_MADC_CTRL1);
 362         if (on)
 363                 regval |= TWL4030_MADC_MADCON;
 364         else
 365                 regval &= ~TWL4030_MADC_MADCON;
 366         twl4030_madc_write(madc, TWL4030_MADC_CTRL1, regval);
 367
 368         return 0;
 369 }
 370
 371 static long twl4030_madc_ioctl(struct file *filp, unsigned int cmd,
 372                                unsigned long arg)
 373 {
 374         struct twl4030_madc_user_parms par;
 375         int val, ret;
 376
 377         ret = copy_from_user(&par, (void __user *) arg, sizeof(par));
 378         if (ret) {
 379                 dev_dbg(the_madc->dev, "copy_from_user: %d\n", ret);
 380                 return -EACCES;
 381         }
 382
 383         switch (cmd) {
 384         case TWL4030_MADC_IOCX_ADC_RAW_READ: {
 385                 struct twl4030_madc_request req;
 386                 if (par.channel >= TWL4030_MADC_MAX_CHANNELS)
 387                         return -EINVAL;
 388
 389                 req.channels = (1 << par.channel);
 390                 req.do_avg      = par.average;
 391                 req.method      = TWL4030_MADC_SW1;
 392                 req.func_cb     = NULL;
 393
 394                 val = twl4030_madc_conversion(&req);
 395                 if (val <= 0) {
 396                         par.status = -1;
 397                 } else {
 398                         par.status = 0;
 399                         par.result = (u16)req.rbuf[par.channel];
 400                 }
 401                 break;
 402                                              }
 403         default:
 404                 return -EINVAL;
 405         }
 406
 407         ret = copy_to_user((void __user *) arg, &par, sizeof(par));
 408         if (ret) {
 409                 dev_dbg(the_madc->dev, "copy_to_user: %d\n", ret);
 410                 return -EACCES;
 411         }
 412
 413         return 0;
 414 }
 415
 416 static struct file_operations twl4030_madc_fileops = {
 417         .owner = THIS_MODULE,
 418         .unlocked_ioctl = twl4030_madc_ioctl
 419 };
 420
 421 static struct miscdevice twl4030_madc_device = {
 422         .minor = MISC_DYNAMIC_MINOR,
 423         .name = "twl4030-madc",
 424         .fops = &twl4030_madc_fileops
 425 };
 426
 427 static int __init twl4030_madc_probe(struct platform_device *pdev)
 428 {
 429         struct twl4030_madc_data *madc;
 430         struct twl4030_madc_platform_data *pdata = pdev->dev.platform_data;
 431         int ret;
 432         u8 regval;
 433
 434         madc = kzalloc(sizeof *madc, GFP_KERNEL);
 435         if (!madc)
 436                 return -ENOMEM;
 437
 438         if (!pdata) {
 439                 dev_dbg(&pdev->dev, "platform_data not available\n");
 440                 ret = -EINVAL;
 441                 goto err_pdata;
 442         }
 443
 444         madc->imr = (pdata->irq_line == 1) ? TWL4030_MADC_IMR1 : TWL4030_MADC_IMR2;
 445         madc->isr = (pdata->irq_line == 1) ? TWL4030_MADC_ISR1 : TWL4030_MADC_ISR2;
 446
 447         ret = misc_register(&twl4030_madc_device);
 448         if (ret) {
 449                 dev_dbg(&pdev->dev, "could not register misc_device\n");
 450                 goto err_misc;
 451         }
 452         twl4030_madc_set_power(madc, 1);
 453         twl4030_madc_set_current_generator(madc, 0, 1);
 454
 455         ret = twl4030_i2c_read_u8(TWL4030_MODULE_MAIN_CHARGE,
 456                                   &regval, TWL4030_BCI_BCICTL1);
 457
 458         regval |= TWL4030_BCI_MESBAT;
 459
 460         ret = twl4030_i2c_write_u8(TWL4030_MODULE_MAIN_CHARGE,
 461                                    regval, TWL4030_BCI_BCICTL1);
 462
 463         ret = request_irq(platform_get_irq(pdev, 0), twl4030_madc_irq_handler,
 464                           0, "twl4030_madc", madc);
 465         if (ret) {
 466                 dev_dbg(&pdev->dev, "could not request irq\n");
 467                 goto err_irq;
 468         }
 469
 470         platform_set_drvdata(pdev, madc);
 471         mutex_init(&madc->lock);
 472         INIT_WORK(&madc->ws, twl4030_madc_work);
 473
 474         the_madc = madc;
 475
 476         return 0;
 477
 478 err_irq:
 479         misc_deregister(&twl4030_madc_device);
 480
 481 err_misc:
 482 err_pdata:
 483         kfree(madc);
 484
 485         return ret;
 486 }
 487
 488 static int __exit twl4030_madc_remove(struct platform_device *pdev)
 489 {
 490         struct twl4030_madc_data *madc = platform_get_drvdata(pdev);
 491
 492         twl4030_madc_set_power(madc, 0);
 493         twl4030_madc_set_current_generator(madc, 0, 0);
 494         free_irq(platform_get_irq(pdev, 0), madc);
 495         cancel_work_sync(&madc->ws);
 496         misc_deregister(&twl4030_madc_device);
 497
 498         return 0;
 499 }
 500
 501 static struct platform_driver twl4030_madc_driver = {
 502         .probe          = twl4030_madc_probe,
 503         .remove         = __exit_p(twl4030_madc_remove),
 504         .driver         = {
 505                 .name   = "twl4030_madc",
 506                 .owner  = THIS_MODULE,
 507         },
 508 };
 509
 510 static int __init twl4030_madc_init(void)
 511 {
 512         return platform_driver_register(&twl4030_madc_driver);
 513 }
 514 module_init(twl4030_madc_init);
 515
 516 static void __exit twl4030_madc_exit(void)
 517 {
 518         platform_driver_unregister(&twl4030_madc_driver);
 519 }
 520 module_exit(twl4030_madc_exit);
 521
 522 MODULE_ALIAS("platform:twl4030-madc");
 523 MODULE_AUTHOR("Nokia Corporation");
 524 MODULE_DESCRIPTION("twl4030 ADC driver");
 525 MODULE_LICENSE("GPL");
 526