linux/drivers/counter/ti-eqep.c
<<
>>
Prefs
   1// SPDX-License-Identifier: GPL-2.0-only
   2/*
   3 * Copyright (C) 2019 David Lechner <david@lechnology.com>
   4 *
   5 * Counter driver for Texas Instruments Enhanced Quadrature Encoder Pulse (eQEP)
   6 */
   7
   8#include <linux/bitops.h>
   9#include <linux/counter.h>
  10#include <linux/kernel.h>
  11#include <linux/mod_devicetable.h>
  12#include <linux/module.h>
  13#include <linux/platform_device.h>
  14#include <linux/pm_runtime.h>
  15#include <linux/regmap.h>
  16
  17/* 32-bit registers */
  18#define QPOSCNT         0x0
  19#define QPOSINIT        0x4
  20#define QPOSMAX         0x8
  21#define QPOSCMP         0xc
  22#define QPOSILAT        0x10
  23#define QPOSSLAT        0x14
  24#define QPOSLAT         0x18
  25#define QUTMR           0x1c
  26#define QUPRD           0x20
  27
  28/* 16-bit registers */
  29#define QWDTMR          0x0     /* 0x24 */
  30#define QWDPRD          0x2     /* 0x26 */
  31#define QDECCTL         0x4     /* 0x28 */
  32#define QEPCTL          0x6     /* 0x2a */
  33#define QCAPCTL         0x8     /* 0x2c */
  34#define QPOSCTL         0xa     /* 0x2e */
  35#define QEINT           0xc     /* 0x30 */
  36#define QFLG            0xe     /* 0x32 */
  37#define QCLR            0x10    /* 0x34 */
  38#define QFRC            0x12    /* 0x36 */
  39#define QEPSTS          0x14    /* 0x38 */
  40#define QCTMR           0x16    /* 0x3a */
  41#define QCPRD           0x18    /* 0x3c */
  42#define QCTMRLAT        0x1a    /* 0x3e */
  43#define QCPRDLAT        0x1c    /* 0x40 */
  44
  45#define QDECCTL_QSRC_SHIFT      14
  46#define QDECCTL_QSRC            GENMASK(15, 14)
  47#define QDECCTL_SOEN            BIT(13)
  48#define QDECCTL_SPSEL           BIT(12)
  49#define QDECCTL_XCR             BIT(11)
  50#define QDECCTL_SWAP            BIT(10)
  51#define QDECCTL_IGATE           BIT(9)
  52#define QDECCTL_QAP             BIT(8)
  53#define QDECCTL_QBP             BIT(7)
  54#define QDECCTL_QIP             BIT(6)
  55#define QDECCTL_QSP             BIT(5)
  56
  57#define QEPCTL_FREE_SOFT        GENMASK(15, 14)
  58#define QEPCTL_PCRM             GENMASK(13, 12)
  59#define QEPCTL_SEI              GENMASK(11, 10)
  60#define QEPCTL_IEI              GENMASK(9, 8)
  61#define QEPCTL_SWI              BIT(7)
  62#define QEPCTL_SEL              BIT(6)
  63#define QEPCTL_IEL              GENMASK(5, 4)
  64#define QEPCTL_PHEN             BIT(3)
  65#define QEPCTL_QCLM             BIT(2)
  66#define QEPCTL_UTE              BIT(1)
  67#define QEPCTL_WDE              BIT(0)
  68
  69/* EQEP Inputs */
  70enum {
  71        TI_EQEP_SIGNAL_QEPA,    /* QEPA/XCLK */
  72        TI_EQEP_SIGNAL_QEPB,    /* QEPB/XDIR */
  73};
  74
  75/* Position Counter Input Modes */
  76enum {
  77        TI_EQEP_COUNT_FUNC_QUAD_COUNT,
  78        TI_EQEP_COUNT_FUNC_DIR_COUNT,
  79        TI_EQEP_COUNT_FUNC_UP_COUNT,
  80        TI_EQEP_COUNT_FUNC_DOWN_COUNT,
  81};
  82
  83enum {
  84        TI_EQEP_SYNAPSE_ACTION_BOTH_EDGES,
  85        TI_EQEP_SYNAPSE_ACTION_RISING_EDGE,
  86        TI_EQEP_SYNAPSE_ACTION_NONE,
  87};
  88
  89struct ti_eqep_cnt {
  90        struct counter_device counter;
  91        struct regmap *regmap32;
  92        struct regmap *regmap16;
  93};
  94
  95static int ti_eqep_count_read(struct counter_device *counter,
  96                              struct counter_count *count, unsigned long *val)
  97{
  98        struct ti_eqep_cnt *priv = counter->priv;
  99        u32 cnt;
 100
 101        regmap_read(priv->regmap32, QPOSCNT, &cnt);
 102        *val = cnt;
 103
 104        return 0;
 105}
 106
 107static int ti_eqep_count_write(struct counter_device *counter,
 108                               struct counter_count *count, unsigned long val)
 109{
 110        struct ti_eqep_cnt *priv = counter->priv;
 111        u32 max;
 112
 113        regmap_read(priv->regmap32, QPOSMAX, &max);
 114        if (val > max)
 115                return -EINVAL;
 116
 117        return regmap_write(priv->regmap32, QPOSCNT, val);
 118}
 119
 120static int ti_eqep_function_get(struct counter_device *counter,
 121                                struct counter_count *count, size_t *function)
 122{
 123        struct ti_eqep_cnt *priv = counter->priv;
 124        u32 qdecctl;
 125
 126        regmap_read(priv->regmap16, QDECCTL, &qdecctl);
 127        *function = (qdecctl & QDECCTL_QSRC) >> QDECCTL_QSRC_SHIFT;
 128
 129        return 0;
 130}
 131
 132static int ti_eqep_function_set(struct counter_device *counter,
 133                                struct counter_count *count, size_t function)
 134{
 135        struct ti_eqep_cnt *priv = counter->priv;
 136
 137        return regmap_write_bits(priv->regmap16, QDECCTL, QDECCTL_QSRC,
 138                                 function << QDECCTL_QSRC_SHIFT);
 139}
 140
 141static int ti_eqep_action_get(struct counter_device *counter,
 142                              struct counter_count *count,
 143                              struct counter_synapse *synapse, size_t *action)
 144{
 145        struct ti_eqep_cnt *priv = counter->priv;
 146        size_t function;
 147        u32 qdecctl;
 148        int err;
 149
 150        err = ti_eqep_function_get(counter, count, &function);
 151        if (err)
 152                return err;
 153
 154        switch (function) {
 155        case TI_EQEP_COUNT_FUNC_QUAD_COUNT:
 156                /* In quadrature mode, the rising and falling edge of both
 157                 * QEPA and QEPB trigger QCLK.
 158                 */
 159                *action = TI_EQEP_SYNAPSE_ACTION_BOTH_EDGES;
 160                break;
 161        case TI_EQEP_COUNT_FUNC_DIR_COUNT:
 162                /* In direction-count mode only rising edge of QEPA is counted
 163                 * and QEPB gives direction.
 164                 */
 165                switch (synapse->signal->id) {
 166                case TI_EQEP_SIGNAL_QEPA:
 167                        *action = TI_EQEP_SYNAPSE_ACTION_RISING_EDGE;
 168                        break;
 169                default:
 170                        *action = TI_EQEP_SYNAPSE_ACTION_NONE;
 171                        break;
 172                }
 173                break;
 174        case TI_EQEP_COUNT_FUNC_UP_COUNT:
 175        case TI_EQEP_COUNT_FUNC_DOWN_COUNT:
 176                /* In up/down-count modes only QEPA is counted and QEPB is not
 177                 * used.
 178                 */
 179                switch (synapse->signal->id) {
 180                case TI_EQEP_SIGNAL_QEPA:
 181                        err = regmap_read(priv->regmap16, QDECCTL, &qdecctl);
 182                        if (err)
 183                                return err;
 184
 185                        if (qdecctl & QDECCTL_XCR)
 186                                *action = TI_EQEP_SYNAPSE_ACTION_BOTH_EDGES;
 187                        else
 188                                *action = TI_EQEP_SYNAPSE_ACTION_RISING_EDGE;
 189                        break;
 190                default:
 191                        *action = TI_EQEP_SYNAPSE_ACTION_NONE;
 192                        break;
 193                }
 194                break;
 195        }
 196
 197        return 0;
 198}
 199
 200static const struct counter_ops ti_eqep_counter_ops = {
 201        .count_read     = ti_eqep_count_read,
 202        .count_write    = ti_eqep_count_write,
 203        .function_get   = ti_eqep_function_get,
 204        .function_set   = ti_eqep_function_set,
 205        .action_get     = ti_eqep_action_get,
 206};
 207
 208static ssize_t ti_eqep_position_ceiling_read(struct counter_device *counter,
 209                                             struct counter_count *count,
 210                                             void *ext_priv, char *buf)
 211{
 212        struct ti_eqep_cnt *priv = counter->priv;
 213        u32 qposmax;
 214
 215        regmap_read(priv->regmap32, QPOSMAX, &qposmax);
 216
 217        return sprintf(buf, "%u\n", qposmax);
 218}
 219
 220static ssize_t ti_eqep_position_ceiling_write(struct counter_device *counter,
 221                                              struct counter_count *count,
 222                                              void *ext_priv, const char *buf,
 223                                              size_t len)
 224{
 225        struct ti_eqep_cnt *priv = counter->priv;
 226        int err;
 227        u32 res;
 228
 229        err = kstrtouint(buf, 0, &res);
 230        if (err < 0)
 231                return err;
 232
 233        regmap_write(priv->regmap32, QPOSMAX, res);
 234
 235        return len;
 236}
 237
 238static ssize_t ti_eqep_position_enable_read(struct counter_device *counter,
 239                                            struct counter_count *count,
 240                                            void *ext_priv, char *buf)
 241{
 242        struct ti_eqep_cnt *priv = counter->priv;
 243        u32 qepctl;
 244
 245        regmap_read(priv->regmap16, QEPCTL, &qepctl);
 246
 247        return sprintf(buf, "%u\n", !!(qepctl & QEPCTL_PHEN));
 248}
 249
 250static ssize_t ti_eqep_position_enable_write(struct counter_device *counter,
 251                                             struct counter_count *count,
 252                                             void *ext_priv, const char *buf,
 253                                             size_t len)
 254{
 255        struct ti_eqep_cnt *priv = counter->priv;
 256        int err;
 257        bool res;
 258
 259        err = kstrtobool(buf, &res);
 260        if (err < 0)
 261                return err;
 262
 263        regmap_write_bits(priv->regmap16, QEPCTL, QEPCTL_PHEN, res ? -1 : 0);
 264
 265        return len;
 266}
 267
 268static struct counter_count_ext ti_eqep_position_ext[] = {
 269        {
 270                .name   = "ceiling",
 271                .read   = ti_eqep_position_ceiling_read,
 272                .write  = ti_eqep_position_ceiling_write,
 273        },
 274        {
 275                .name   = "enable",
 276                .read   = ti_eqep_position_enable_read,
 277                .write  = ti_eqep_position_enable_write,
 278        },
 279};
 280
 281static struct counter_signal ti_eqep_signals[] = {
 282        [TI_EQEP_SIGNAL_QEPA] = {
 283                .id = TI_EQEP_SIGNAL_QEPA,
 284                .name = "QEPA"
 285        },
 286        [TI_EQEP_SIGNAL_QEPB] = {
 287                .id = TI_EQEP_SIGNAL_QEPB,
 288                .name = "QEPB"
 289        },
 290};
 291
 292static const enum counter_count_function ti_eqep_position_functions[] = {
 293        [TI_EQEP_COUNT_FUNC_QUAD_COUNT] = COUNTER_COUNT_FUNCTION_QUADRATURE_X4,
 294        [TI_EQEP_COUNT_FUNC_DIR_COUNT]  = COUNTER_COUNT_FUNCTION_PULSE_DIRECTION,
 295        [TI_EQEP_COUNT_FUNC_UP_COUNT]   = COUNTER_COUNT_FUNCTION_INCREASE,
 296        [TI_EQEP_COUNT_FUNC_DOWN_COUNT] = COUNTER_COUNT_FUNCTION_DECREASE,
 297};
 298
 299static const enum counter_synapse_action ti_eqep_position_synapse_actions[] = {
 300        [TI_EQEP_SYNAPSE_ACTION_BOTH_EDGES]     = COUNTER_SYNAPSE_ACTION_BOTH_EDGES,
 301        [TI_EQEP_SYNAPSE_ACTION_RISING_EDGE]    = COUNTER_SYNAPSE_ACTION_RISING_EDGE,
 302        [TI_EQEP_SYNAPSE_ACTION_NONE]           = COUNTER_SYNAPSE_ACTION_NONE,
 303};
 304
 305static struct counter_synapse ti_eqep_position_synapses[] = {
 306        {
 307                .actions_list   = ti_eqep_position_synapse_actions,
 308                .num_actions    = ARRAY_SIZE(ti_eqep_position_synapse_actions),
 309                .signal         = &ti_eqep_signals[TI_EQEP_SIGNAL_QEPA],
 310        },
 311        {
 312                .actions_list   = ti_eqep_position_synapse_actions,
 313                .num_actions    = ARRAY_SIZE(ti_eqep_position_synapse_actions),
 314                .signal         = &ti_eqep_signals[TI_EQEP_SIGNAL_QEPB],
 315        },
 316};
 317
 318static struct counter_count ti_eqep_counts[] = {
 319        {
 320                .id             = 0,
 321                .name           = "QPOSCNT",
 322                .functions_list = ti_eqep_position_functions,
 323                .num_functions  = ARRAY_SIZE(ti_eqep_position_functions),
 324                .synapses       = ti_eqep_position_synapses,
 325                .num_synapses   = ARRAY_SIZE(ti_eqep_position_synapses),
 326                .ext            = ti_eqep_position_ext,
 327                .num_ext        = ARRAY_SIZE(ti_eqep_position_ext),
 328        },
 329};
 330
 331static const struct regmap_config ti_eqep_regmap32_config = {
 332        .name = "32-bit",
 333        .reg_bits = 32,
 334        .val_bits = 32,
 335        .reg_stride = 4,
 336        .max_register = QUPRD,
 337};
 338
 339static const struct regmap_config ti_eqep_regmap16_config = {
 340        .name = "16-bit",
 341        .reg_bits = 16,
 342        .val_bits = 16,
 343        .reg_stride = 2,
 344        .max_register = QCPRDLAT,
 345};
 346
 347static int ti_eqep_probe(struct platform_device *pdev)
 348{
 349        struct device *dev = &pdev->dev;
 350        struct ti_eqep_cnt *priv;
 351        void __iomem *base;
 352        int err;
 353
 354        priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
 355        if (!priv)
 356                return -ENOMEM;
 357
 358        base = devm_platform_ioremap_resource(pdev, 0);
 359        if (IS_ERR(base))
 360                return PTR_ERR(base);
 361
 362        priv->regmap32 = devm_regmap_init_mmio(dev, base,
 363                                               &ti_eqep_regmap32_config);
 364        if (IS_ERR(priv->regmap32))
 365                return PTR_ERR(priv->regmap32);
 366
 367        priv->regmap16 = devm_regmap_init_mmio(dev, base + 0x24,
 368                                               &ti_eqep_regmap16_config);
 369        if (IS_ERR(priv->regmap16))
 370                return PTR_ERR(priv->regmap16);
 371
 372        priv->counter.name = dev_name(dev);
 373        priv->counter.parent = dev;
 374        priv->counter.ops = &ti_eqep_counter_ops;
 375        priv->counter.counts = ti_eqep_counts;
 376        priv->counter.num_counts = ARRAY_SIZE(ti_eqep_counts);
 377        priv->counter.signals = ti_eqep_signals;
 378        priv->counter.num_signals = ARRAY_SIZE(ti_eqep_signals);
 379        priv->counter.priv = priv;
 380
 381        platform_set_drvdata(pdev, priv);
 382
 383        /*
 384         * Need to make sure power is turned on. On AM33xx, this comes from the
 385         * parent PWMSS bus driver. On AM17xx, this comes from the PSC power
 386         * domain.
 387         */
 388        pm_runtime_enable(dev);
 389        pm_runtime_get_sync(dev);
 390
 391        err = counter_register(&priv->counter);
 392        if (err < 0) {
 393                pm_runtime_put_sync(dev);
 394                pm_runtime_disable(dev);
 395                return err;
 396        }
 397
 398        return 0;
 399}
 400
 401static int ti_eqep_remove(struct platform_device *pdev)
 402{
 403        struct ti_eqep_cnt *priv = platform_get_drvdata(pdev);
 404        struct device *dev = &pdev->dev;
 405
 406        counter_unregister(&priv->counter);
 407        pm_runtime_put_sync(dev);
 408        pm_runtime_disable(dev);
 409
 410        return 0;
 411}
 412
 413static const struct of_device_id ti_eqep_of_match[] = {
 414        { .compatible = "ti,am3352-eqep", },
 415        { },
 416};
 417MODULE_DEVICE_TABLE(of, ti_eqep_of_match);
 418
 419static struct platform_driver ti_eqep_driver = {
 420        .probe = ti_eqep_probe,
 421        .remove = ti_eqep_remove,
 422        .driver = {
 423                .name = "ti-eqep-cnt",
 424                .of_match_table = ti_eqep_of_match,
 425        },
 426};
 427module_platform_driver(ti_eqep_driver);
 428
 429MODULE_AUTHOR("David Lechner <david@lechnology.com>");
 430MODULE_DESCRIPTION("TI eQEP counter driver");
 431MODULE_LICENSE("GPL v2");
 432