arch/arm/plat-samsung/adc.c

   1 /* arch/arm/plat-samsung/adc.c
   2  *
   3  * Copyright (c) 2008 Simtec Electronics
   4  *      http://armlinux.simtec.co.uk/
   5  *      Ben Dooks <ben@simtec.co.uk>, <ben-linux@fluff.org>
   6  *
   7  * Samsung ADC device core
   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.
  12 */
  13
  14 #include <linux/module.h>
  15 #include <linux/kernel.h>
  16 #include <linux/platform_device.h>
  17 #include <linux/sched.h>
  18 #include <linux/list.h>
  19 #include <linux/slab.h>
  20 #include <linux/err.h>
  21 #include <linux/clk.h>
  22 #include <linux/interrupt.h>
  23 #include <linux/io.h>
  24
  25 #include <plat/regs-adc.h>
  26 #include <plat/adc.h>
  27
  28 /* This driver is designed to control the usage of the ADC block between
  29  * the touchscreen and any other drivers that may need to use it, such as
  30  * the hwmon driver.
  31  *
  32  * Priority will be given to the touchscreen driver, but as this itself is
  33  * rate limited it should not starve other requests which are processed in
  34  * order that they are received.
  35  *
  36  * Each user registers to get a client block which uniquely identifies it
  37  * and stores information such as the necessary functions to callback when
  38  * action is required.
  39  */
  40
  41 enum s3c_cpu_type {
  42         TYPE_S3C24XX,
  43         TYPE_S3C64XX,
  44         TYPE_S5PV210
  45 };
  46
  47 struct s3c_adc_client {
  48         struct platform_device  *pdev;
  49         struct list_head         pend;
  50         wait_queue_head_t       *wait;
  51
  52         unsigned int             nr_samples;
  53         int                      result;
  54         unsigned char            is_ts;
  55         unsigned char            channel;
  56
  57         void    (*select_cb)(struct s3c_adc_client *c, unsigned selected);
  58         void    (*convert_cb)(struct s3c_adc_client *c,
  59                               unsigned val1, unsigned val2,
  60                               unsigned *samples_left);
  61 };
  62
  63 struct adc_device {
  64         struct platform_device  *pdev;
  65         struct platform_device  *owner;
  66         struct clk              *clk;
  67         struct s3c_adc_client   *cur;
  68         struct s3c_adc_client   *ts_pend;
  69         void __iomem            *regs;
  70         enum s3c_cpu_type        cputype;
  71         spinlock_t               lock;
  72
  73         unsigned int             prescale;
  74
  75         int                      irq;
  76 };
  77
  78 static struct adc_device *adc_dev;
  79
  80 static LIST_HEAD(adc_pending);  /* protected by adc_device.lock */
  81
  82 #define adc_dbg(_adc, msg...) dev_dbg(&(_adc)->pdev->dev, msg)
  83
  84 static inline void s3c_adc_convert(struct adc_device *adc)
  85 {
  86         unsigned con = readl(adc->regs + S3C2410_ADCCON);
  87
  88         con |= S3C2410_ADCCON_ENABLE_START;
  89         writel(con, adc->regs + S3C2410_ADCCON);
  90 }
  91
  92 static inline void s3c_adc_select(struct adc_device *adc,
  93                                   struct s3c_adc_client *client)
  94 {
  95         unsigned con = readl(adc->regs + S3C2410_ADCCON);
  96
  97         client->select_cb(client, 1);
  98
  99         con &= ~S3C2410_ADCCON_MUXMASK;
 100         con &= ~S3C2410_ADCCON_STDBM;
 101         con &= ~S3C2410_ADCCON_STARTMASK;
 102         con |=  S3C2410_ADCCON_PRSCEN;
 103
 104         if (!client->is_ts) {
 105                 if (adc->cputype == TYPE_S5PV210)
 106                         writel(S5PV210_ADCCON_SELMUX(client->channel),
 107                                                 adc->regs + S5PV210_ADCMUX);
 108                 else
 109                         con |= S3C2410_ADCCON_SELMUX(client->channel);
 110         }
 111
 112         writel(con, adc->regs + S3C2410_ADCCON);
 113 }
 114
 115 static void s3c_adc_dbgshow(struct adc_device *adc)
 116 {
 117         adc_dbg(adc, "CON=%08x, TSC=%08x, DLY=%08x\n",
 118                 readl(adc->regs + S3C2410_ADCCON),
 119                 readl(adc->regs + S3C2410_ADCTSC),
 120                 readl(adc->regs + S3C2410_ADCDLY));
 121 }
 122
 123 static void s3c_adc_try(struct adc_device *adc)
 124 {
 125         struct s3c_adc_client *next = adc->ts_pend;
 126         unsigned int con = readl(adc->regs + S3C2410_ADCCON);
 127
 128         if (!next && !list_empty(&adc_pending)) {
 129                 next = list_first_entry(&adc_pending,
 130                                         struct s3c_adc_client, pend);
 131                 list_del(&next->pend);
 132         } else
 133                 adc->ts_pend = NULL;
 134
 135         if (next) {
 136                 adc_dbg(adc, "new client is %p\n", next);
 137                 adc->cur = next;
 138                 s3c_adc_select(adc, next);
 139                 s3c_adc_convert(adc);
 140                 s3c_adc_dbgshow(adc);
 141         } else {
 142                 con &= ~S3C2410_ADCCON_PRSCEN;
 143                 con |=  S3C2410_ADCCON_STDBM;
 144                 writel(con, adc->regs + S3C2410_ADCCON);
 145         }
 146 }
 147
 148 int s3c_adc_start(struct s3c_adc_client *client,
 149                   unsigned int channel, unsigned int nr_samples)
 150 {
 151         struct adc_device *adc = adc_dev;
 152         unsigned long flags;
 153
 154         if (!adc) {
 155                 printk(KERN_ERR "%s: failed to find adc\n", __func__);
 156                 return -EINVAL;
 157         }
 158
 159         if (client->is_ts && adc->ts_pend)
 160                 return -EAGAIN;
 161
 162         spin_lock_irqsave(&adc->lock, flags);
 163
 164         client->channel = channel;
 165         client->nr_samples = nr_samples;
 166
 167         if (client->is_ts)
 168                 adc->ts_pend = client;
 169         else
 170                 list_add_tail(&client->pend, &adc_pending);
 171
 172         if (!adc->cur)
 173                 s3c_adc_try(adc);
 174
 175         spin_unlock_irqrestore(&adc->lock, flags);
 176
 177         return 0;
 178 }
 179 EXPORT_SYMBOL_GPL(s3c_adc_start);
 180
 181 static void s3c_convert_done(struct s3c_adc_client *client,
 182                              unsigned v, unsigned u, unsigned *left)
 183 {
 184         client->result = v;
 185         wake_up(client->wait);
 186 }
 187
 188 int s3c_adc_read(struct s3c_adc_client *client, unsigned int ch)
 189 {
 190         DECLARE_WAIT_QUEUE_HEAD_ONSTACK(wake);
 191         int ret;
 192
 193         client->convert_cb = s3c_convert_done;
 194         client->wait = &wake;
 195         client->result = -1;
 196
 197         ret = s3c_adc_start(client, ch, 1);
 198         if (ret < 0)
 199                 goto err;
 200
 201         ret = wait_event_timeout(wake, client->result >= 0, HZ / 2);
 202         if (client->result < 0) {
 203                 ret = -ETIMEDOUT;
 204                 goto err;
 205         }
 206
 207         client->convert_cb = NULL;
 208         return client->result;
 209
 210 err:
 211         return ret;
 212 }
 213 EXPORT_SYMBOL_GPL(s3c_adc_read);
 214
 215 static void s3c_adc_default_select(struct s3c_adc_client *client,
 216                                    unsigned select)
 217 {
 218 }
 219
 220 struct s3c_adc_client *s3c_adc_register(struct platform_device *pdev,
 221                                         void (*select)(struct s3c_adc_client *client,
 222                                                        unsigned int selected),
 223                                         void (*conv)(struct s3c_adc_client *client,
 224                                                      unsigned d0, unsigned d1,
 225                                                      unsigned *samples_left),
 226                                         unsigned int is_ts)
 227 {
 228         struct s3c_adc_client *client;
 229
 230         WARN_ON(!pdev);
 231
 232         if (!select)
 233                 select = s3c_adc_default_select;
 234
 235         if (!pdev)
 236                 return ERR_PTR(-EINVAL);
 237
 238         client = kzalloc(sizeof(struct s3c_adc_client), GFP_KERNEL);
 239         if (!client) {
 240                 dev_err(&pdev->dev, "no memory for adc client\n");
 241                 return ERR_PTR(-ENOMEM);
 242         }
 243
 244         client->pdev = pdev;
 245         client->is_ts = is_ts;
 246         client->select_cb = select;
 247         client->convert_cb = conv;
 248
 249         return client;
 250 }
 251 EXPORT_SYMBOL_GPL(s3c_adc_register);
 252
 253 void s3c_adc_release(struct s3c_adc_client *client)
 254 {
 255         unsigned long flags;
 256
 257         spin_lock_irqsave(&adc_dev->lock, flags);
 258
 259         /* We should really check that nothing is in progress. */
 260         if (adc_dev->cur == client)
 261                 adc_dev->cur = NULL;
 262         if (adc_dev->ts_pend == client)
 263                 adc_dev->ts_pend = NULL;
 264         else {
 265                 struct list_head *p, *n;
 266                 struct s3c_adc_client *tmp;
 267
 268                 list_for_each_safe(p, n, &adc_pending) {
 269                         tmp = list_entry(p, struct s3c_adc_client, pend);
 270                         if (tmp == client)
 271                                 list_del(&tmp->pend);
 272                 }
 273         }
 274
 275         if (adc_dev->cur == NULL)
 276                 s3c_adc_try(adc_dev);
 277
 278         spin_unlock_irqrestore(&adc_dev->lock, flags);
 279         kfree(client);
 280 }
 281 EXPORT_SYMBOL_GPL(s3c_adc_release);
 282
 283 static irqreturn_t s3c_adc_irq(int irq, void *pw)
 284 {
 285         struct adc_device *adc = pw;
 286         struct s3c_adc_client *client = adc->cur;
 287         unsigned data0, data1;
 288
 289         if (!client) {
 290                 dev_warn(&adc->pdev->dev, "%s: no adc pending\n", __func__);
 291                 goto exit;
 292         }
 293
 294         data0 = readl(adc->regs + S3C2410_ADCDAT0);
 295         data1 = readl(adc->regs + S3C2410_ADCDAT1);
 296         adc_dbg(adc, "read %d: 0x%04x, 0x%04x\n", client->nr_samples, data0, data1);
 297
 298         if (client->nr_samples > 0)
 299                 client->nr_samples--;
 300
 301         if ((adc->cputype == TYPE_S3C64XX) || (adc->cputype == TYPE_S5PV210)) {
 302                 /* S3C64XX ADC resolution is 12-bit */
 303                 data0 &= 0xfff;
 304                 data1 &= 0xfff;
 305         } else {
 306                 data0 &= 0x3ff;
 307                 data1 &= 0x3ff;
 308         }
 309
 310         if (client->convert_cb)
 311                 (client->convert_cb)(client, data0, data1, &client->nr_samples);
 312
 313         if (client->nr_samples > 0) {
 314                 /* fire another conversion for this */
 315
 316                 client->select_cb(client, 1);
 317                 s3c_adc_convert(adc);
 318         } else {
 319                 spin_lock(&adc->lock);
 320                 (client->select_cb)(client, 0);
 321                 adc->cur = NULL;
 322
 323                 s3c_adc_try(adc);
 324                 spin_unlock(&adc->lock);
 325         }
 326
 327 exit:
 328         if ((adc->cputype == TYPE_S3C64XX) || (adc->cputype == TYPE_S5PV210)) {
 329                 /* Clear ADC interrupt */
 330                 writel(0, adc->regs + S3C64XX_ADCCLRINT);
 331         }
 332         return IRQ_HANDLED;
 333 }
 334
 335 static int s3c_adc_probe(struct platform_device *pdev)
 336 {
 337         struct device *dev = &pdev->dev;
 338         struct adc_device *adc;
 339         struct resource *regs;
 340         int ret;
 341         unsigned tmp;
 342
 343         adc = kzalloc(sizeof(struct adc_device), GFP_KERNEL);
 344         if (adc == NULL) {
 345                 dev_err(dev, "failed to allocate adc_device\n");
 346                 return -ENOMEM;
 347         }
 348
 349         spin_lock_init(&adc->lock);
 350
 351         adc->pdev = pdev;
 352         adc->prescale = S3C2410_ADCCON_PRSCVL(49);
 353         adc->cputype = platform_get_device_id(adc->pdev)->driver_data;
 354
 355         adc->irq = platform_get_irq(pdev, 1);
 356         if (adc->irq <= 0) {
 357                 dev_err(dev, "failed to get adc irq\n");
 358                 ret = -ENOENT;
 359                 goto err_alloc;
 360         }
 361
 362         ret = request_irq(adc->irq, s3c_adc_irq, 0, dev_name(dev), adc);
 363         if (ret < 0) {
 364                 dev_err(dev, "failed to attach adc irq\n");
 365                 goto err_alloc;
 366         }
 367
 368         adc->clk = clk_get(dev, "adc");
 369         if (IS_ERR(adc->clk)) {
 370                 dev_err(dev, "failed to get adc clock\n");
 371                 ret = PTR_ERR(adc->clk);
 372                 goto err_irq;
 373         }
 374
 375         regs = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 376         if (!regs) {
 377                 dev_err(dev, "failed to find registers\n");
 378                 ret = -ENXIO;
 379                 goto err_clk;
 380         }
 381
 382         adc->regs = ioremap(regs->start, resource_size(regs));
 383         if (!adc->regs) {
 384                 dev_err(dev, "failed to map registers\n");
 385                 ret = -ENXIO;
 386                 goto err_clk;
 387         }
 388
 389         clk_enable(adc->clk);
 390
 391 #if defined(CONFIG_S3C_DEV_ADC1)
 392         tmp = readl(adc->regs + S3C2410_ADCCON);
 393         tmp |= S3C64XX_ADCCON_TSSEL;
 394         writel(tmp, adc->regs + S3C2410_ADCCON);
 395         adc->regs += 0x1000;
 396 #endif
 397
 398         tmp = adc->prescale | S3C2410_ADCCON_PRSCEN;
 399         if ((adc->cputype == TYPE_S3C64XX) || (adc->cputype == TYPE_S5PV210)){
 400                 /* Enable 12-bit ADC resolution */
 401                 tmp |= S3C64XX_ADCCON_RESSEL;
 402         }
 403         tmp |= S3C2410_ADCCON_STDBM;
 404         writel(tmp, adc->regs + S3C2410_ADCCON);
 405
 406         dev_info(dev, "attached adc driver\n");
 407
 408         platform_set_drvdata(pdev, adc);
 409         adc_dev = adc;
 410
 411         return 0;
 412
 413  err_clk:
 414         clk_put(adc->clk);
 415
 416  err_irq:
 417         free_irq(adc->irq, adc);
 418
 419  err_alloc:
 420         kfree(adc);
 421         return ret;
 422 }
 423
 424 static int __devexit s3c_adc_remove(struct platform_device *pdev)
 425 {
 426         struct adc_device *adc = platform_get_drvdata(pdev);
 427
 428         iounmap(adc->regs);
 429         free_irq(adc->irq, adc);
 430         clk_disable(adc->clk);
 431         clk_put(adc->clk);
 432         kfree(adc);
 433
 434         return 0;
 435 }
 436
 437 #ifdef CONFIG_PM
 438 static int s3c_adc_suspend(struct platform_device *pdev, pm_message_t state)
 439 {
 440         struct adc_device *adc = platform_get_drvdata(pdev);
 441         unsigned long flags;
 442         u32 con;
 443
 444         spin_lock_irqsave(&adc->lock, flags);
 445
 446         con = readl(adc->regs + S3C2410_ADCCON);
 447         con |= S3C2410_ADCCON_STDBM;
 448         writel(con, adc->regs + S3C2410_ADCCON);
 449
 450         disable_irq(adc->irq);
 451         spin_unlock_irqrestore(&adc->lock, flags);
 452         clk_disable(adc->clk);
 453
 454         return 0;
 455 }
 456
 457 static int s3c_adc_resume(struct platform_device *pdev)
 458 {
 459         struct adc_device *adc = platform_get_drvdata(pdev);
 460
 461         clk_enable(adc->clk);
 462         enable_irq(adc->irq);
 463
 464         writel(adc->prescale | S3C2410_ADCCON_PRSCEN,
 465                adc->regs + S3C2410_ADCCON);
 466
 467         return 0;
 468 }
 469
 470 #else
 471 #define s3c_adc_suspend NULL
 472 #define s3c_adc_resume NULL
 473 #endif
 474
 475 static struct platform_device_id s3c_adc_driver_ids[] = {
 476         {
 477                 .name           = "s3c24xx-adc",
 478                 .driver_data    = TYPE_S3C24XX,
 479         }, {
 480                 .name           = "s3c64xx-adc",
 481                 .driver_data    = TYPE_S3C64XX,
 482         }, {
 483                 .name           = "s5pv210-adc",
 484                 .driver_data    = TYPE_S5PV210,
 485         },
 486         { }
 487 };
 488 MODULE_DEVICE_TABLE(platform, s3c_adc_driver_ids);
 489
 490 static struct platform_driver s3c_adc_driver = {
 491         .id_table       = s3c_adc_driver_ids,
 492         .driver         = {
 493                 .name   = "s3c-adc",
 494                 .owner  = THIS_MODULE,
 495         },
 496         .probe          = s3c_adc_probe,
 497         .remove         = __devexit_p(s3c_adc_remove),
 498         .suspend        = s3c_adc_suspend,
 499         .resume         = s3c_adc_resume,
 500 };
 501
 502 static int __init adc_init(void)
 503 {
 504         int ret;
 505
 506         ret = platform_driver_register(&s3c_adc_driver);
 507         if (ret)
 508                 printk(KERN_ERR "%s: failed to add adc driver\n", __func__);
 509
 510         return ret;
 511 }
 512
 513 arch_initcall(adc_init);