drivers/dma/qcom/hidma_ll.c

   1 /*
   2  * Qualcomm Technologies HIDMA DMA engine low level code
   3  *
   4  * Copyright (c) 2015-2016, The Linux Foundation. All rights reserved.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 and
   8  * only version 2 as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  */
  15
  16 #include <linux/dmaengine.h>
  17 #include <linux/slab.h>
  18 #include <linux/interrupt.h>
  19 #include <linux/mm.h>
  20 #include <linux/highmem.h>
  21 #include <linux/dma-mapping.h>
  22 #include <linux/delay.h>
  23 #include <linux/atomic.h>
  24 #include <linux/iopoll.h>
  25 #include <linux/kfifo.h>
  26 #include <linux/bitops.h>
  27
  28 #include "hidma.h"
  29
  30 #define HIDMA_EVRE_SIZE                 16      /* each EVRE is 16 bytes */
  31
  32 #define HIDMA_TRCA_CTRLSTS_REG                  0x000
  33 #define HIDMA_TRCA_RING_LOW_REG         0x008
  34 #define HIDMA_TRCA_RING_HIGH_REG                0x00C
  35 #define HIDMA_TRCA_RING_LEN_REG         0x010
  36 #define HIDMA_TRCA_DOORBELL_REG         0x400
  37
  38 #define HIDMA_EVCA_CTRLSTS_REG                  0x000
  39 #define HIDMA_EVCA_INTCTRL_REG                  0x004
  40 #define HIDMA_EVCA_RING_LOW_REG         0x008
  41 #define HIDMA_EVCA_RING_HIGH_REG                0x00C
  42 #define HIDMA_EVCA_RING_LEN_REG         0x010
  43 #define HIDMA_EVCA_WRITE_PTR_REG                0x020
  44 #define HIDMA_EVCA_DOORBELL_REG         0x400
  45
  46 #define HIDMA_EVCA_IRQ_STAT_REG         0x100
  47 #define HIDMA_EVCA_IRQ_CLR_REG                  0x108
  48 #define HIDMA_EVCA_IRQ_EN_REG                   0x110
  49
  50 #define HIDMA_EVRE_CFG_IDX                      0
  51
  52 #define HIDMA_EVRE_ERRINFO_BIT_POS              24
  53 #define HIDMA_EVRE_CODE_BIT_POS         28
  54
  55 #define HIDMA_EVRE_ERRINFO_MASK         GENMASK(3, 0)
  56 #define HIDMA_EVRE_CODE_MASK                    GENMASK(3, 0)
  57
  58 #define HIDMA_CH_CONTROL_MASK                   GENMASK(7, 0)
  59 #define HIDMA_CH_STATE_MASK                     GENMASK(7, 0)
  60 #define HIDMA_CH_STATE_BIT_POS                  0x8
  61
  62 #define HIDMA_IRQ_EV_CH_EOB_IRQ_BIT_POS 0
  63 #define HIDMA_IRQ_EV_CH_WR_RESP_BIT_POS 1
  64 #define HIDMA_IRQ_TR_CH_TRE_RD_RSP_ER_BIT_POS   9
  65 #define HIDMA_IRQ_TR_CH_DATA_RD_ER_BIT_POS      10
  66 #define HIDMA_IRQ_TR_CH_DATA_WR_ER_BIT_POS      11
  67 #define HIDMA_IRQ_TR_CH_INVALID_TRE_BIT_POS     14
  68
  69 #define ENABLE_IRQS (BIT(HIDMA_IRQ_EV_CH_EOB_IRQ_BIT_POS)       | \
  70                      BIT(HIDMA_IRQ_EV_CH_WR_RESP_BIT_POS)       | \
  71                      BIT(HIDMA_IRQ_TR_CH_TRE_RD_RSP_ER_BIT_POS) | \
  72                      BIT(HIDMA_IRQ_TR_CH_DATA_RD_ER_BIT_POS)    | \
  73                      BIT(HIDMA_IRQ_TR_CH_DATA_WR_ER_BIT_POS)    | \
  74                      BIT(HIDMA_IRQ_TR_CH_INVALID_TRE_BIT_POS))
  75
  76 #define HIDMA_INCREMENT_ITERATOR(iter, size, ring_size) \
  77 do {                                                            \
  78         iter += size;                                           \
  79         if (iter >= ring_size)                                  \
  80                 iter -= ring_size;                              \
  81 } while (0)
  82
  83 #define HIDMA_CH_STATE(val)     \
  84         ((val >> HIDMA_CH_STATE_BIT_POS) & HIDMA_CH_STATE_MASK)
  85
  86 #define HIDMA_ERR_INT_MASK                              \
  87         (BIT(HIDMA_IRQ_TR_CH_INVALID_TRE_BIT_POS)   |   \
  88          BIT(HIDMA_IRQ_TR_CH_TRE_RD_RSP_ER_BIT_POS) |   \
  89          BIT(HIDMA_IRQ_EV_CH_WR_RESP_BIT_POS)       |   \
  90          BIT(HIDMA_IRQ_TR_CH_DATA_RD_ER_BIT_POS)    |   \
  91          BIT(HIDMA_IRQ_TR_CH_DATA_WR_ER_BIT_POS))
  92
  93 enum ch_command {
  94         HIDMA_CH_DISABLE = 0,
  95         HIDMA_CH_ENABLE = 1,
  96         HIDMA_CH_SUSPEND = 2,
  97         HIDMA_CH_RESET = 9,
  98 };
  99
 100 enum ch_state {
 101         HIDMA_CH_DISABLED = 0,
 102         HIDMA_CH_ENABLED = 1,
 103         HIDMA_CH_RUNNING = 2,
 104         HIDMA_CH_SUSPENDED = 3,
 105         HIDMA_CH_STOPPED = 4,
 106 };
 107
 108 enum tre_type {
 109         HIDMA_TRE_MEMCPY = 3,
 110 };
 111
 112 enum err_code {
 113         HIDMA_EVRE_STATUS_COMPLETE = 1,
 114         HIDMA_EVRE_STATUS_ERROR = 4,
 115 };
 116
 117 static int hidma_is_chan_enabled(int state)
 118 {
 119         switch (state) {
 120         case HIDMA_CH_ENABLED:
 121         case HIDMA_CH_RUNNING:
 122                 return true;
 123         default:
 124                 return false;
 125         }
 126 }
 127
 128 void hidma_ll_free(struct hidma_lldev *lldev, u32 tre_ch)
 129 {
 130         struct hidma_tre *tre;
 131
 132         if (tre_ch >= lldev->nr_tres) {
 133                 dev_err(lldev->dev, "invalid TRE number in free:%d", tre_ch);
 134                 return;
 135         }
 136
 137         tre = &lldev->trepool[tre_ch];
 138         if (atomic_read(&tre->allocated) != true) {
 139                 dev_err(lldev->dev, "trying to free an unused TRE:%d", tre_ch);
 140                 return;
 141         }
 142
 143         atomic_set(&tre->allocated, 0);
 144 }
 145
 146 int hidma_ll_request(struct hidma_lldev *lldev, u32 sig, const char *dev_name,
 147                      void (*callback)(void *data), void *data, u32 *tre_ch)
 148 {
 149         unsigned int i;
 150         struct hidma_tre *tre;
 151         u32 *tre_local;
 152
 153         if (!tre_ch || !lldev)
 154                 return -EINVAL;
 155
 156         /* need to have at least one empty spot in the queue */
 157         for (i = 0; i < lldev->nr_tres - 1; i++) {
 158                 if (atomic_add_unless(&lldev->trepool[i].allocated, 1, 1))
 159                         break;
 160         }
 161
 162         if (i == (lldev->nr_tres - 1))
 163                 return -ENOMEM;
 164
 165         tre = &lldev->trepool[i];
 166         tre->dma_sig = sig;
 167         tre->dev_name = dev_name;
 168         tre->callback = callback;
 169         tre->data = data;
 170         tre->idx = i;
 171         tre->status = 0;
 172         tre->queued = 0;
 173         tre->err_code = 0;
 174         tre->err_info = 0;
 175         tre->lldev = lldev;
 176         tre_local = &tre->tre_local[0];
 177         tre_local[HIDMA_TRE_CFG_IDX] = HIDMA_TRE_MEMCPY;
 178         tre_local[HIDMA_TRE_CFG_IDX] |= (lldev->chidx & 0xFF) << 8;
 179         tre_local[HIDMA_TRE_CFG_IDX] |= BIT(16);        /* set IEOB */
 180         *tre_ch = i;
 181         if (callback)
 182                 callback(data);
 183         return 0;
 184 }
 185
 186 /*
 187  * Multiple TREs may be queued and waiting in the pending queue.
 188  */
 189 static void hidma_ll_tre_complete(unsigned long arg)
 190 {
 191         struct hidma_lldev *lldev = (struct hidma_lldev *)arg;
 192         struct hidma_tre *tre;
 193
 194         while (kfifo_out(&lldev->handoff_fifo, &tre, 1)) {
 195                 /* call the user if it has been read by the hardware */
 196                 if (tre->callback)
 197                         tre->callback(tre->data);
 198         }
 199 }
 200
 201 static int hidma_post_completed(struct hidma_lldev *lldev, u8 err_info,
 202                                 u8 err_code)
 203 {
 204         struct hidma_tre *tre;
 205         unsigned long flags;
 206         u32 tre_iterator;
 207
 208         spin_lock_irqsave(&lldev->lock, flags);
 209
 210         tre_iterator = lldev->tre_processed_off;
 211         tre = lldev->pending_tre_list[tre_iterator / HIDMA_TRE_SIZE];
 212         if (!tre) {
 213                 spin_unlock_irqrestore(&lldev->lock, flags);
 214                 dev_warn(lldev->dev, "tre_index [%d] and tre out of sync\n",
 215                          tre_iterator / HIDMA_TRE_SIZE);
 216                 return -EINVAL;
 217         }
 218         lldev->pending_tre_list[tre->tre_index] = NULL;
 219
 220         /*
 221          * Keep track of pending TREs that SW is expecting to receive
 222          * from HW. We got one now. Decrement our counter.
 223          */
 224         if (atomic_dec_return(&lldev->pending_tre_count) < 0) {
 225                 dev_warn(lldev->dev, "tre count mismatch on completion");
 226                 atomic_set(&lldev->pending_tre_count, 0);
 227         }
 228
 229         HIDMA_INCREMENT_ITERATOR(tre_iterator, HIDMA_TRE_SIZE,
 230                                  lldev->tre_ring_size);
 231         lldev->tre_processed_off = tre_iterator;
 232         spin_unlock_irqrestore(&lldev->lock, flags);
 233
 234         tre->err_info = err_info;
 235         tre->err_code = err_code;
 236         tre->queued = 0;
 237
 238         kfifo_put(&lldev->handoff_fifo, tre);
 239         tasklet_schedule(&lldev->task);
 240
 241         return 0;
 242 }
 243
 244 /*
 245  * Called to handle the interrupt for the channel.
 246  * Return a positive number if TRE or EVRE were consumed on this run.
 247  * Return a positive number if there are pending TREs or EVREs.
 248  * Return 0 if there is nothing to consume or no pending TREs/EVREs found.
 249  */
 250 static int hidma_handle_tre_completion(struct hidma_lldev *lldev)
 251 {
 252         u32 evre_ring_size = lldev->evre_ring_size;
 253         u32 err_info, err_code, evre_write_off;
 254         u32 evre_iterator;
 255         u32 num_completed = 0;
 256
 257         evre_write_off = readl_relaxed(lldev->evca + HIDMA_EVCA_WRITE_PTR_REG);
 258         evre_iterator = lldev->evre_processed_off;
 259
 260         if ((evre_write_off > evre_ring_size) ||
 261             (evre_write_off % HIDMA_EVRE_SIZE)) {
 262                 dev_err(lldev->dev, "HW reports invalid EVRE write offset\n");
 263                 return 0;
 264         }
 265
 266         /*
 267          * By the time control reaches here the number of EVREs and TREs
 268          * may not match. Only consume the ones that hardware told us.
 269          */
 270         while ((evre_iterator != evre_write_off)) {
 271                 u32 *current_evre = lldev->evre_ring + evre_iterator;
 272                 u32 cfg;
 273
 274                 cfg = current_evre[HIDMA_EVRE_CFG_IDX];
 275                 err_info = cfg >> HIDMA_EVRE_ERRINFO_BIT_POS;
 276                 err_info &= HIDMA_EVRE_ERRINFO_MASK;
 277                 err_code =
 278                     (cfg >> HIDMA_EVRE_CODE_BIT_POS) & HIDMA_EVRE_CODE_MASK;
 279
 280                 if (hidma_post_completed(lldev, err_info, err_code))
 281                         break;
 282
 283                 HIDMA_INCREMENT_ITERATOR(evre_iterator, HIDMA_EVRE_SIZE,
 284                                          evre_ring_size);
 285
 286                 /*
 287                  * Read the new event descriptor written by the HW.
 288                  * As we are processing the delivered events, other events
 289                  * get queued to the SW for processing.
 290                  */
 291                 evre_write_off =
 292                     readl_relaxed(lldev->evca + HIDMA_EVCA_WRITE_PTR_REG);
 293                 num_completed++;
 294
 295                 /*
 296                  * An error interrupt might have arrived while we are processing
 297                  * the completed interrupt.
 298                  */
 299                 if (!hidma_ll_isenabled(lldev))
 300                         break;
 301         }
 302
 303         if (num_completed) {
 304                 u32 evre_read_off = (lldev->evre_processed_off +
 305                                      HIDMA_EVRE_SIZE * num_completed);
 306                 evre_read_off = evre_read_off % evre_ring_size;
 307                 writel(evre_read_off, lldev->evca + HIDMA_EVCA_DOORBELL_REG);
 308
 309                 /* record the last processed tre offset */
 310                 lldev->evre_processed_off = evre_read_off;
 311         }
 312
 313         return num_completed;
 314 }
 315
 316 void hidma_cleanup_pending_tre(struct hidma_lldev *lldev, u8 err_info,
 317                                u8 err_code)
 318 {
 319         while (atomic_read(&lldev->pending_tre_count)) {
 320                 if (hidma_post_completed(lldev, err_info, err_code))
 321                         break;
 322         }
 323 }
 324
 325 static int hidma_ll_reset(struct hidma_lldev *lldev)
 326 {
 327         u32 val;
 328         int ret;
 329
 330         val = readl(lldev->trca + HIDMA_TRCA_CTRLSTS_REG);
 331         val &= ~(HIDMA_CH_CONTROL_MASK << 16);
 332         val |= HIDMA_CH_RESET << 16;
 333         writel(val, lldev->trca + HIDMA_TRCA_CTRLSTS_REG);
 334
 335         /*
 336          * Delay 10ms after reset to allow DMA logic to quiesce.
 337          * Do a polled read up to 1ms and 10ms maximum.
 338          */
 339         ret = readl_poll_timeout(lldev->trca + HIDMA_TRCA_CTRLSTS_REG, val,
 340                                  HIDMA_CH_STATE(val) == HIDMA_CH_DISABLED,
 341                                  1000, 10000);
 342         if (ret) {
 343                 dev_err(lldev->dev, "transfer channel did not reset\n");
 344                 return ret;
 345         }
 346
 347         val = readl(lldev->evca + HIDMA_EVCA_CTRLSTS_REG);
 348         val &= ~(HIDMA_CH_CONTROL_MASK << 16);
 349         val |= HIDMA_CH_RESET << 16;
 350         writel(val, lldev->evca + HIDMA_EVCA_CTRLSTS_REG);
 351
 352         /*
 353          * Delay 10ms after reset to allow DMA logic to quiesce.
 354          * Do a polled read up to 1ms and 10ms maximum.
 355          */
 356         ret = readl_poll_timeout(lldev->evca + HIDMA_EVCA_CTRLSTS_REG, val,
 357                                  HIDMA_CH_STATE(val) == HIDMA_CH_DISABLED,
 358                                  1000, 10000);
 359         if (ret)
 360                 return ret;
 361
 362         lldev->trch_state = HIDMA_CH_DISABLED;
 363         lldev->evch_state = HIDMA_CH_DISABLED;
 364         return 0;
 365 }
 366
 367 /*
 368  * The interrupt handler for HIDMA will try to consume as many pending
 369  * EVRE from the event queue as possible. Each EVRE has an associated
 370  * TRE that holds the user interface parameters. EVRE reports the
 371  * result of the transaction. Hardware guarantees ordering between EVREs
 372  * and TREs. We use last processed offset to figure out which TRE is
 373  * associated with which EVRE. If two TREs are consumed by HW, the EVREs
 374  * are in order in the event ring.
 375  *
 376  * This handler will do a one pass for consuming EVREs. Other EVREs may
 377  * be delivered while we are working. It will try to consume incoming
 378  * EVREs one more time and return.
 379  *
 380  * For unprocessed EVREs, hardware will trigger another interrupt until
 381  * all the interrupt bits are cleared.
 382  *
 383  * Hardware guarantees that by the time interrupt is observed, all data
 384  * transactions in flight are delivered to their respective places and
 385  * are visible to the CPU.
 386  *
 387  * On demand paging for IOMMU is only supported for PCIe via PRI
 388  * (Page Request Interface) not for HIDMA. All other hardware instances
 389  * including HIDMA work on pinned DMA addresses.
 390  *
 391  * HIDMA is not aware of IOMMU presence since it follows the DMA API. All
 392  * IOMMU latency will be built into the data movement time. By the time
 393  * interrupt happens, IOMMU lookups + data movement has already taken place.
 394  *
 395  * While the first read in a typical PCI endpoint ISR flushes all outstanding
 396  * requests traditionally to the destination, this concept does not apply
 397  * here for this HW.
 398  */
 399 static void hidma_ll_int_handler_internal(struct hidma_lldev *lldev, int cause)
 400 {
 401         if (cause & HIDMA_ERR_INT_MASK) {
 402                 dev_err(lldev->dev, "error 0x%x, disabling...\n",
 403                                 cause);
 404
 405                 /* Clear out pending interrupts */
 406                 writel(cause, lldev->evca + HIDMA_EVCA_IRQ_CLR_REG);
 407
 408                 /* No further submissions. */
 409                 hidma_ll_disable(lldev);
 410
 411                 /* Driver completes the txn and intimates the client.*/
 412                 hidma_cleanup_pending_tre(lldev, 0xFF,
 413                                           HIDMA_EVRE_STATUS_ERROR);
 414
 415                 return;
 416         }
 417
 418         /*
 419          * Fine tuned for this HW...
 420          *
 421          * This ISR has been designed for this particular hardware. Relaxed
 422          * read and write accessors are used for performance reasons due to
 423          * interrupt delivery guarantees. Do not copy this code blindly and
 424          * expect that to work.
 425          *
 426          * Try to consume as many EVREs as possible.
 427          */
 428         hidma_handle_tre_completion(lldev);
 429
 430         /* We consumed TREs or there are pending TREs or EVREs. */
 431         writel_relaxed(cause, lldev->evca + HIDMA_EVCA_IRQ_CLR_REG);
 432 }
 433
 434 irqreturn_t hidma_ll_inthandler(int chirq, void *arg)
 435 {
 436         struct hidma_lldev *lldev = arg;
 437         u32 status;
 438         u32 enable;
 439         u32 cause;
 440
 441         status = readl_relaxed(lldev->evca + HIDMA_EVCA_IRQ_STAT_REG);
 442         enable = readl_relaxed(lldev->evca + HIDMA_EVCA_IRQ_EN_REG);
 443         cause = status & enable;
 444
 445         while (cause) {
 446                 hidma_ll_int_handler_internal(lldev, cause);
 447
 448                 /*
 449                  * Another interrupt might have arrived while we are
 450                  * processing this one. Read the new cause.
 451                  */
 452                 status = readl_relaxed(lldev->evca + HIDMA_EVCA_IRQ_STAT_REG);
 453                 enable = readl_relaxed(lldev->evca + HIDMA_EVCA_IRQ_EN_REG);
 454                 cause = status & enable;
 455         }
 456
 457         return IRQ_HANDLED;
 458 }
 459
 460 irqreturn_t hidma_ll_inthandler_msi(int chirq, void *arg, int cause)
 461 {
 462         struct hidma_lldev *lldev = arg;
 463
 464         hidma_ll_int_handler_internal(lldev, cause);
 465         return IRQ_HANDLED;
 466 }
 467
 468 int hidma_ll_enable(struct hidma_lldev *lldev)
 469 {
 470         u32 val;
 471         int ret;
 472
 473         val = readl(lldev->evca + HIDMA_EVCA_CTRLSTS_REG);
 474         val &= ~(HIDMA_CH_CONTROL_MASK << 16);
 475         val |= HIDMA_CH_ENABLE << 16;
 476         writel(val, lldev->evca + HIDMA_EVCA_CTRLSTS_REG);
 477
 478         ret = readl_poll_timeout(lldev->evca + HIDMA_EVCA_CTRLSTS_REG, val,
 479                                  hidma_is_chan_enabled(HIDMA_CH_STATE(val)),
 480                                  1000, 10000);
 481         if (ret) {
 482                 dev_err(lldev->dev, "event channel did not get enabled\n");
 483                 return ret;
 484         }
 485
 486         val = readl(lldev->trca + HIDMA_TRCA_CTRLSTS_REG);
 487         val &= ~(HIDMA_CH_CONTROL_MASK << 16);
 488         val |= HIDMA_CH_ENABLE << 16;
 489         writel(val, lldev->trca + HIDMA_TRCA_CTRLSTS_REG);
 490
 491         ret = readl_poll_timeout(lldev->trca + HIDMA_TRCA_CTRLSTS_REG, val,
 492                                  hidma_is_chan_enabled(HIDMA_CH_STATE(val)),
 493                                  1000, 10000);
 494         if (ret) {
 495                 dev_err(lldev->dev, "transfer channel did not get enabled\n");
 496                 return ret;
 497         }
 498
 499         lldev->trch_state = HIDMA_CH_ENABLED;
 500         lldev->evch_state = HIDMA_CH_ENABLED;
 501
 502         /* enable irqs */
 503         writel(ENABLE_IRQS, lldev->evca + HIDMA_EVCA_IRQ_EN_REG);
 504
 505         return 0;
 506 }
 507
 508 void hidma_ll_start(struct hidma_lldev *lldev)
 509 {
 510         unsigned long irqflags;
 511
 512         spin_lock_irqsave(&lldev->lock, irqflags);
 513         writel(lldev->tre_write_offset, lldev->trca + HIDMA_TRCA_DOORBELL_REG);
 514         spin_unlock_irqrestore(&lldev->lock, irqflags);
 515 }
 516
 517 bool hidma_ll_isenabled(struct hidma_lldev *lldev)
 518 {
 519         u32 val;
 520
 521         val = readl(lldev->trca + HIDMA_TRCA_CTRLSTS_REG);
 522         lldev->trch_state = HIDMA_CH_STATE(val);
 523         val = readl(lldev->evca + HIDMA_EVCA_CTRLSTS_REG);
 524         lldev->evch_state = HIDMA_CH_STATE(val);
 525
 526         /* both channels have to be enabled before calling this function */
 527         if (hidma_is_chan_enabled(lldev->trch_state) &&
 528             hidma_is_chan_enabled(lldev->evch_state))
 529                 return true;
 530
 531         return false;
 532 }
 533
 534 void hidma_ll_queue_request(struct hidma_lldev *lldev, u32 tre_ch)
 535 {
 536         struct hidma_tre *tre;
 537         unsigned long flags;
 538
 539         tre = &lldev->trepool[tre_ch];
 540
 541         /* copy the TRE into its location in the TRE ring */
 542         spin_lock_irqsave(&lldev->lock, flags);
 543         tre->tre_index = lldev->tre_write_offset / HIDMA_TRE_SIZE;
 544         lldev->pending_tre_list[tre->tre_index] = tre;
 545         memcpy(lldev->tre_ring + lldev->tre_write_offset,
 546                         &tre->tre_local[0], HIDMA_TRE_SIZE);
 547         tre->err_code = 0;
 548         tre->err_info = 0;
 549         tre->queued = 1;
 550         atomic_inc(&lldev->pending_tre_count);
 551         lldev->tre_write_offset = (lldev->tre_write_offset + HIDMA_TRE_SIZE)
 552                                         % lldev->tre_ring_size;
 553         spin_unlock_irqrestore(&lldev->lock, flags);
 554 }
 555
 556 /*
 557  * Note that even though we stop this channel if there is a pending transaction
 558  * in flight it will complete and follow the callback. This request will
 559  * prevent further requests to be made.
 560  */
 561 int hidma_ll_disable(struct hidma_lldev *lldev)
 562 {
 563         u32 val;
 564         int ret;
 565
 566         /* The channel needs to be in working state */
 567         if (!hidma_ll_isenabled(lldev))
 568                 return 0;
 569
 570         val = readl(lldev->trca + HIDMA_TRCA_CTRLSTS_REG);
 571         val &= ~(HIDMA_CH_CONTROL_MASK << 16);
 572         val |= HIDMA_CH_SUSPEND << 16;
 573         writel(val, lldev->trca + HIDMA_TRCA_CTRLSTS_REG);
 574
 575         /*
 576          * Start the wait right after the suspend is confirmed.
 577          * Do a polled read up to 1ms and 10ms maximum.
 578          */
 579         ret = readl_poll_timeout(lldev->trca + HIDMA_TRCA_CTRLSTS_REG, val,
 580                                  HIDMA_CH_STATE(val) == HIDMA_CH_SUSPENDED,
 581                                  1000, 10000);
 582         if (ret)
 583                 return ret;
 584
 585         val = readl(lldev->evca + HIDMA_EVCA_CTRLSTS_REG);
 586         val &= ~(HIDMA_CH_CONTROL_MASK << 16);
 587         val |= HIDMA_CH_SUSPEND << 16;
 588         writel(val, lldev->evca + HIDMA_EVCA_CTRLSTS_REG);
 589
 590         /*
 591          * Start the wait right after the suspend is confirmed
 592          * Delay up to 10ms after reset to allow DMA logic to quiesce.
 593          */
 594         ret = readl_poll_timeout(lldev->evca + HIDMA_EVCA_CTRLSTS_REG, val,
 595                                  HIDMA_CH_STATE(val) == HIDMA_CH_SUSPENDED,
 596                                  1000, 10000);
 597         if (ret)
 598                 return ret;
 599
 600         lldev->trch_state = HIDMA_CH_SUSPENDED;
 601         lldev->evch_state = HIDMA_CH_SUSPENDED;
 602
 603         /* disable interrupts */
 604         writel(0, lldev->evca + HIDMA_EVCA_IRQ_EN_REG);
 605         return 0;
 606 }
 607
 608 void hidma_ll_set_transfer_params(struct hidma_lldev *lldev, u32 tre_ch,
 609                                   dma_addr_t src, dma_addr_t dest, u32 len,
 610                                   u32 flags)
 611 {
 612         struct hidma_tre *tre;
 613         u32 *tre_local;
 614
 615         if (tre_ch >= lldev->nr_tres) {
 616                 dev_err(lldev->dev, "invalid TRE number in transfer params:%d",
 617                         tre_ch);
 618                 return;
 619         }
 620
 621         tre = &lldev->trepool[tre_ch];
 622         if (atomic_read(&tre->allocated) != true) {
 623                 dev_err(lldev->dev, "trying to set params on an unused TRE:%d",
 624                         tre_ch);
 625                 return;
 626         }
 627
 628         tre_local = &tre->tre_local[0];
 629         tre_local[HIDMA_TRE_LEN_IDX] = len;
 630         tre_local[HIDMA_TRE_SRC_LOW_IDX] = lower_32_bits(src);
 631         tre_local[HIDMA_TRE_SRC_HI_IDX] = upper_32_bits(src);
 632         tre_local[HIDMA_TRE_DEST_LOW_IDX] = lower_32_bits(dest);
 633         tre_local[HIDMA_TRE_DEST_HI_IDX] = upper_32_bits(dest);
 634         tre->int_flags = flags;
 635 }
 636
 637 /*
 638  * Called during initialization and after an error condition
 639  * to restore hardware state.
 640  */
 641 int hidma_ll_setup(struct hidma_lldev *lldev)
 642 {
 643         int rc;
 644         u64 addr;
 645         u32 val;
 646         u32 nr_tres = lldev->nr_tres;
 647
 648         atomic_set(&lldev->pending_tre_count, 0);
 649         lldev->tre_processed_off = 0;
 650         lldev->evre_processed_off = 0;
 651         lldev->tre_write_offset = 0;
 652
 653         /* disable interrupts */
 654         writel(0, lldev->evca + HIDMA_EVCA_IRQ_EN_REG);
 655
 656         /* clear all pending interrupts */
 657         val = readl(lldev->evca + HIDMA_EVCA_IRQ_STAT_REG);
 658         writel(val, lldev->evca + HIDMA_EVCA_IRQ_CLR_REG);
 659
 660         rc = hidma_ll_reset(lldev);
 661         if (rc)
 662                 return rc;
 663
 664         /*
 665          * Clear all pending interrupts again.
 666          * Otherwise, we observe reset complete interrupts.
 667          */
 668         val = readl(lldev->evca + HIDMA_EVCA_IRQ_STAT_REG);
 669         writel(val, lldev->evca + HIDMA_EVCA_IRQ_CLR_REG);
 670
 671         /* disable interrupts again after reset */
 672         writel(0, lldev->evca + HIDMA_EVCA_IRQ_EN_REG);
 673
 674         addr = lldev->tre_dma;
 675         writel(lower_32_bits(addr), lldev->trca + HIDMA_TRCA_RING_LOW_REG);
 676         writel(upper_32_bits(addr), lldev->trca + HIDMA_TRCA_RING_HIGH_REG);
 677         writel(lldev->tre_ring_size, lldev->trca + HIDMA_TRCA_RING_LEN_REG);
 678
 679         addr = lldev->evre_dma;
 680         writel(lower_32_bits(addr), lldev->evca + HIDMA_EVCA_RING_LOW_REG);
 681         writel(upper_32_bits(addr), lldev->evca + HIDMA_EVCA_RING_HIGH_REG);
 682         writel(HIDMA_EVRE_SIZE * nr_tres,
 683                         lldev->evca + HIDMA_EVCA_RING_LEN_REG);
 684
 685         /* configure interrupts */
 686         hidma_ll_setup_irq(lldev, lldev->msi_support);
 687
 688         rc = hidma_ll_enable(lldev);
 689         if (rc)
 690                 return rc;
 691
 692         return rc;
 693 }
 694
 695 void hidma_ll_setup_irq(struct hidma_lldev *lldev, bool msi)
 696 {
 697         u32 val;
 698
 699         lldev->msi_support = msi;
 700
 701         /* disable interrupts again after reset */
 702         writel(0, lldev->evca + HIDMA_EVCA_IRQ_CLR_REG);
 703         writel(0, lldev->evca + HIDMA_EVCA_IRQ_EN_REG);
 704
 705         /* support IRQ by default */
 706         val = readl(lldev->evca + HIDMA_EVCA_INTCTRL_REG);
 707         val &= ~0xF;
 708         if (!lldev->msi_support)
 709                 val = val | 0x1;
 710         writel(val, lldev->evca + HIDMA_EVCA_INTCTRL_REG);
 711
 712         /* clear all pending interrupts and enable them */
 713         writel(ENABLE_IRQS, lldev->evca + HIDMA_EVCA_IRQ_CLR_REG);
 714         writel(ENABLE_IRQS, lldev->evca + HIDMA_EVCA_IRQ_EN_REG);
 715 }
 716
 717 struct hidma_lldev *hidma_ll_init(struct device *dev, u32 nr_tres,
 718                                   void __iomem *trca, void __iomem *evca,
 719                                   u8 chidx)
 720 {
 721         u32 required_bytes;
 722         struct hidma_lldev *lldev;
 723         int rc;
 724         size_t sz;
 725
 726         if (!trca || !evca || !dev || !nr_tres)
 727                 return NULL;
 728
 729         /* need at least four TREs */
 730         if (nr_tres < 4)
 731                 return NULL;
 732
 733         /* need an extra space */
 734         nr_tres += 1;
 735
 736         lldev = devm_kzalloc(dev, sizeof(struct hidma_lldev), GFP_KERNEL);
 737         if (!lldev)
 738                 return NULL;
 739
 740         lldev->evca = evca;
 741         lldev->trca = trca;
 742         lldev->dev = dev;
 743         sz = sizeof(struct hidma_tre);
 744         lldev->trepool = devm_kcalloc(lldev->dev, nr_tres, sz, GFP_KERNEL);
 745         if (!lldev->trepool)
 746                 return NULL;
 747
 748         required_bytes = sizeof(lldev->pending_tre_list[0]);
 749         lldev->pending_tre_list = devm_kcalloc(dev, nr_tres, required_bytes,
 750                                                GFP_KERNEL);
 751         if (!lldev->pending_tre_list)
 752                 return NULL;
 753
 754         sz = (HIDMA_TRE_SIZE + 1) * nr_tres;
 755         lldev->tre_ring = dmam_alloc_coherent(dev, sz, &lldev->tre_dma,
 756                                               GFP_KERNEL);
 757         if (!lldev->tre_ring)
 758                 return NULL;
 759
 760         memset(lldev->tre_ring, 0, (HIDMA_TRE_SIZE + 1) * nr_tres);
 761         lldev->tre_ring_size = HIDMA_TRE_SIZE * nr_tres;
 762         lldev->nr_tres = nr_tres;
 763
 764         /* the TRE ring has to be TRE_SIZE aligned */
 765         if (!IS_ALIGNED(lldev->tre_dma, HIDMA_TRE_SIZE)) {
 766                 u8 tre_ring_shift;
 767
 768                 tre_ring_shift = lldev->tre_dma % HIDMA_TRE_SIZE;
 769                 tre_ring_shift = HIDMA_TRE_SIZE - tre_ring_shift;
 770                 lldev->tre_dma += tre_ring_shift;
 771                 lldev->tre_ring += tre_ring_shift;
 772         }
 773
 774         sz = (HIDMA_EVRE_SIZE + 1) * nr_tres;
 775         lldev->evre_ring = dmam_alloc_coherent(dev, sz, &lldev->evre_dma,
 776                                                GFP_KERNEL);
 777         if (!lldev->evre_ring)
 778                 return NULL;
 779
 780         memset(lldev->evre_ring, 0, (HIDMA_EVRE_SIZE + 1) * nr_tres);
 781         lldev->evre_ring_size = HIDMA_EVRE_SIZE * nr_tres;
 782
 783         /* the EVRE ring has to be EVRE_SIZE aligned */
 784         if (!IS_ALIGNED(lldev->evre_dma, HIDMA_EVRE_SIZE)) {
 785                 u8 evre_ring_shift;
 786
 787                 evre_ring_shift = lldev->evre_dma % HIDMA_EVRE_SIZE;
 788                 evre_ring_shift = HIDMA_EVRE_SIZE - evre_ring_shift;
 789                 lldev->evre_dma += evre_ring_shift;
 790                 lldev->evre_ring += evre_ring_shift;
 791         }
 792         lldev->nr_tres = nr_tres;
 793         lldev->chidx = chidx;
 794
 795         sz = nr_tres * sizeof(struct hidma_tre *);
 796         rc = kfifo_alloc(&lldev->handoff_fifo, sz, GFP_KERNEL);
 797         if (rc)
 798                 return NULL;
 799
 800         rc = hidma_ll_setup(lldev);
 801         if (rc)
 802                 return NULL;
 803
 804         spin_lock_init(&lldev->lock);
 805         tasklet_init(&lldev->task, hidma_ll_tre_complete, (unsigned long)lldev);
 806         lldev->initialized = 1;
 807         writel(ENABLE_IRQS, lldev->evca + HIDMA_EVCA_IRQ_EN_REG);
 808         return lldev;
 809 }
 810
 811 int hidma_ll_uninit(struct hidma_lldev *lldev)
 812 {
 813         u32 required_bytes;
 814         int rc = 0;
 815         u32 val;
 816
 817         if (!lldev)
 818                 return -ENODEV;
 819
 820         if (!lldev->initialized)
 821                 return 0;
 822
 823         lldev->initialized = 0;
 824
 825         required_bytes = sizeof(struct hidma_tre) * lldev->nr_tres;
 826         tasklet_kill(&lldev->task);
 827         memset(lldev->trepool, 0, required_bytes);
 828         lldev->trepool = NULL;
 829         atomic_set(&lldev->pending_tre_count, 0);
 830         lldev->tre_write_offset = 0;
 831
 832         rc = hidma_ll_reset(lldev);
 833
 834         /*
 835          * Clear all pending interrupts again.
 836          * Otherwise, we observe reset complete interrupts.
 837          */
 838         val = readl(lldev->evca + HIDMA_EVCA_IRQ_STAT_REG);
 839         writel(val, lldev->evca + HIDMA_EVCA_IRQ_CLR_REG);
 840         writel(0, lldev->evca + HIDMA_EVCA_IRQ_EN_REG);
 841         return rc;
 842 }
 843
 844 enum dma_status hidma_ll_status(struct hidma_lldev *lldev, u32 tre_ch)
 845 {
 846         enum dma_status ret = DMA_ERROR;
 847         struct hidma_tre *tre;
 848         unsigned long flags;
 849         u8 err_code;
 850
 851         spin_lock_irqsave(&lldev->lock, flags);
 852
 853         tre = &lldev->trepool[tre_ch];
 854         err_code = tre->err_code;
 855
 856         if (err_code & HIDMA_EVRE_STATUS_COMPLETE)
 857                 ret = DMA_COMPLETE;
 858         else if (err_code & HIDMA_EVRE_STATUS_ERROR)
 859                 ret = DMA_ERROR;
 860         else
 861                 ret = DMA_IN_PROGRESS;
 862         spin_unlock_irqrestore(&lldev->lock, flags);
 863
 864         return ret;
 865 }