drivers/usb/renesas_usbhs/fifo.c

   1 /*
   2  * Renesas USB driver
   3  *
   4  * Copyright (C) 2011 Renesas Solutions Corp.
   5  * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
   6  *
   7  * This program is distributed in the hope that it will be useful,
   8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
   9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  10  * GNU General Public License for more details.
  11  *
  12  * You should have received a copy of the GNU General Public License
  13  * along with this program; if not, write to the Free Software
  14  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  15  *
  16  */
  17 #include <linux/delay.h>
  18 #include <linux/io.h>
  19 #include <linux/scatterlist.h>
  20 #include "./common.h"
  21 #include "./pipe.h"
  22
  23 #define usbhsf_get_cfifo(p)     (&((p)->fifo_info.cfifo))
  24 #define usbhsf_get_d0fifo(p)    (&((p)->fifo_info.d0fifo))
  25 #define usbhsf_get_d1fifo(p)    (&((p)->fifo_info.d1fifo))
  26
  27 #define usbhsf_fifo_is_busy(f)  ((f)->pipe) /* see usbhs_pipe_select_fifo */
  28
  29 /*
  30  *              packet initialize
  31  */
  32 void usbhs_pkt_init(struct usbhs_pkt *pkt)
  33 {
  34         pkt->dma = DMA_ADDR_INVALID;
  35         INIT_LIST_HEAD(&pkt->node);
  36 }
  37
  38 /*
  39  *              packet control function
  40  */
  41 static int usbhsf_null_handle(struct usbhs_pkt *pkt, int *is_done)
  42 {
  43         struct usbhs_priv *priv = usbhs_pipe_to_priv(pkt->pipe);
  44         struct device *dev = usbhs_priv_to_dev(priv);
  45
  46         dev_err(dev, "null handler\n");
  47
  48         return -EINVAL;
  49 }
  50
  51 static struct usbhs_pkt_handle usbhsf_null_handler = {
  52         .prepare = usbhsf_null_handle,
  53         .try_run = usbhsf_null_handle,
  54 };
  55
  56 void usbhs_pkt_push(struct usbhs_pipe *pipe, struct usbhs_pkt *pkt,
  57                     void (*done)(struct usbhs_priv *priv,
  58                                  struct usbhs_pkt *pkt),
  59                     void *buf, int len, int zero)
  60 {
  61         struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
  62         struct device *dev = usbhs_priv_to_dev(priv);
  63         unsigned long flags;
  64
  65         if (!done) {
  66                 dev_err(dev, "no done function\n");
  67                 return;
  68         }
  69
  70         /********************  spin lock ********************/
  71         usbhs_lock(priv, flags);
  72
  73         if (!pipe->handler) {
  74                 dev_err(dev, "no handler function\n");
  75                 pipe->handler = &usbhsf_null_handler;
  76         }
  77
  78         list_del_init(&pkt->node);
  79         list_add_tail(&pkt->node, &pipe->list);
  80
  81         /*
  82          * each pkt must hold own handler.
  83          * because handler might be changed by its situation.
  84          * dma handler -> pio handler.
  85          */
  86         pkt->pipe       = pipe;
  87         pkt->buf        = buf;
  88         pkt->handler    = pipe->handler;
  89         pkt->length     = len;
  90         pkt->zero       = zero;
  91         pkt->actual     = 0;
  92         pkt->done       = done;
  93
  94         usbhs_unlock(priv, flags);
  95         /********************  spin unlock ******************/
  96 }
  97
  98 static void __usbhsf_pkt_del(struct usbhs_pkt *pkt)
  99 {
 100         list_del_init(&pkt->node);
 101 }
 102
 103 static struct usbhs_pkt *__usbhsf_pkt_get(struct usbhs_pipe *pipe)
 104 {
 105         if (list_empty(&pipe->list))
 106                 return NULL;
 107
 108         return list_entry(pipe->list.next, struct usbhs_pkt, node);
 109 }
 110
 111 struct usbhs_pkt *usbhs_pkt_pop(struct usbhs_pipe *pipe, struct usbhs_pkt *pkt)
 112 {
 113         struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
 114         unsigned long flags;
 115
 116         /********************  spin lock ********************/
 117         usbhs_lock(priv, flags);
 118
 119         if (!pkt)
 120                 pkt = __usbhsf_pkt_get(pipe);
 121
 122         if (pkt)
 123                 __usbhsf_pkt_del(pkt);
 124
 125         usbhs_unlock(priv, flags);
 126         /********************  spin unlock ******************/
 127
 128         return pkt;
 129 }
 130
 131 enum {
 132         USBHSF_PKT_PREPARE,
 133         USBHSF_PKT_TRY_RUN,
 134         USBHSF_PKT_DMA_DONE,
 135 };
 136
 137 static int usbhsf_pkt_handler(struct usbhs_pipe *pipe, int type)
 138 {
 139         struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
 140         struct usbhs_pkt *pkt;
 141         struct device *dev = usbhs_priv_to_dev(priv);
 142         int (*func)(struct usbhs_pkt *pkt, int *is_done);
 143         unsigned long flags;
 144         int ret = 0;
 145         int is_done = 0;
 146
 147         /********************  spin lock ********************/
 148         usbhs_lock(priv, flags);
 149
 150         pkt = __usbhsf_pkt_get(pipe);
 151         if (!pkt)
 152                 goto __usbhs_pkt_handler_end;
 153
 154         switch (type) {
 155         case USBHSF_PKT_PREPARE:
 156                 func = pkt->handler->prepare;
 157                 break;
 158         case USBHSF_PKT_TRY_RUN:
 159                 func = pkt->handler->try_run;
 160                 break;
 161         case USBHSF_PKT_DMA_DONE:
 162                 func = pkt->handler->dma_done;
 163                 break;
 164         default:
 165                 dev_err(dev, "unknown pkt hander\n");
 166                 goto __usbhs_pkt_handler_end;
 167         }
 168
 169         if (likely(func))
 170                 ret = func(pkt, &is_done);
 171
 172         if (is_done)
 173                 __usbhsf_pkt_del(pkt);
 174
 175 __usbhs_pkt_handler_end:
 176         usbhs_unlock(priv, flags);
 177         /********************  spin unlock ******************/
 178
 179         if (is_done) {
 180                 pkt->done(priv, pkt);
 181                 usbhs_pkt_start(pipe);
 182         }
 183
 184         return ret;
 185 }
 186
 187 void usbhs_pkt_start(struct usbhs_pipe *pipe)
 188 {
 189         usbhsf_pkt_handler(pipe, USBHSF_PKT_PREPARE);
 190 }
 191
 192 /*
 193  *              irq enable/disable function
 194  */
 195 #define usbhsf_irq_empty_ctrl(p, e) usbhsf_irq_callback_ctrl(p, bempsts, e)
 196 #define usbhsf_irq_ready_ctrl(p, e) usbhsf_irq_callback_ctrl(p, brdysts, e)
 197 #define usbhsf_irq_callback_ctrl(pipe, status, enable)                  \
 198         ({                                                              \
 199                 struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);     \
 200                 struct usbhs_mod *mod = usbhs_mod_get_current(priv);    \
 201                 u16 status = (1 << usbhs_pipe_number(pipe));            \
 202                 if (!mod)                                               \
 203                         return;                                         \
 204                 if (enable)                                             \
 205                         mod->irq_##status |= status;                    \
 206                 else                                                    \
 207                         mod->irq_##status &= ~status;                   \
 208                 usbhs_irq_callback_update(priv, mod);                   \
 209         })
 210
 211 static void usbhsf_tx_irq_ctrl(struct usbhs_pipe *pipe, int enable)
 212 {
 213         /*
 214          * And DCP pipe can NOT use "ready interrupt" for "send"
 215          * it should use "empty" interrupt.
 216          * see
 217          *   "Operation" - "Interrupt Function" - "BRDY Interrupt"
 218          *
 219          * on the other hand, normal pipe can use "ready interrupt" for "send"
 220          * even though it is single/double buffer
 221          */
 222         if (usbhs_pipe_is_dcp(pipe))
 223                 usbhsf_irq_empty_ctrl(pipe, enable);
 224         else
 225                 usbhsf_irq_ready_ctrl(pipe, enable);
 226 }
 227
 228 static void usbhsf_rx_irq_ctrl(struct usbhs_pipe *pipe, int enable)
 229 {
 230         usbhsf_irq_ready_ctrl(pipe, enable);
 231 }
 232
 233 /*
 234  *              FIFO ctrl
 235  */
 236 static void usbhsf_send_terminator(struct usbhs_pipe *pipe,
 237                                    struct usbhs_fifo *fifo)
 238 {
 239         struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
 240
 241         usbhs_bset(priv, fifo->ctr, BVAL, BVAL);
 242 }
 243
 244 static int usbhsf_fifo_barrier(struct usbhs_priv *priv,
 245                                struct usbhs_fifo *fifo)
 246 {
 247         int timeout = 1024;
 248
 249         do {
 250                 /* The FIFO port is accessible */
 251                 if (usbhs_read(priv, fifo->ctr) & FRDY)
 252                         return 0;
 253
 254                 udelay(10);
 255         } while (timeout--);
 256
 257         return -EBUSY;
 258 }
 259
 260 static void usbhsf_fifo_clear(struct usbhs_pipe *pipe,
 261                               struct usbhs_fifo *fifo)
 262 {
 263         struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
 264
 265         if (!usbhs_pipe_is_dcp(pipe))
 266                 usbhsf_fifo_barrier(priv, fifo);
 267
 268         usbhs_write(priv, fifo->ctr, BCLR);
 269 }
 270
 271 static int usbhsf_fifo_rcv_len(struct usbhs_priv *priv,
 272                                struct usbhs_fifo *fifo)
 273 {
 274         return usbhs_read(priv, fifo->ctr) & DTLN_MASK;
 275 }
 276
 277 static void usbhsf_fifo_unselect(struct usbhs_pipe *pipe,
 278                                  struct usbhs_fifo *fifo)
 279 {
 280         struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
 281
 282         usbhs_pipe_select_fifo(pipe, NULL);
 283         usbhs_write(priv, fifo->sel, 0);
 284 }
 285
 286 static int usbhsf_fifo_select(struct usbhs_pipe *pipe,
 287                               struct usbhs_fifo *fifo,
 288                               int write)
 289 {
 290         struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
 291         struct device *dev = usbhs_priv_to_dev(priv);
 292         int timeout = 1024;
 293         u16 mask = ((1 << 5) | 0xF);            /* mask of ISEL | CURPIPE */
 294         u16 base = usbhs_pipe_number(pipe);     /* CURPIPE */
 295
 296         if (usbhs_pipe_is_busy(pipe) ||
 297             usbhsf_fifo_is_busy(fifo))
 298                 return -EBUSY;
 299
 300         if (usbhs_pipe_is_dcp(pipe)) {
 301                 base |= (1 == write) << 5;      /* ISEL */
 302
 303                 if (usbhs_mod_is_host(priv))
 304                         usbhs_dcp_dir_for_host(pipe, write);
 305         }
 306
 307         /* "base" will be used below  */
 308         usbhs_write(priv, fifo->sel, base | MBW_32);
 309
 310         /* check ISEL and CURPIPE value */
 311         while (timeout--) {
 312                 if (base == (mask & usbhs_read(priv, fifo->sel))) {
 313                         usbhs_pipe_select_fifo(pipe, fifo);
 314                         return 0;
 315                 }
 316                 udelay(10);
 317         }
 318
 319         dev_err(dev, "fifo select error\n");
 320
 321         return -EIO;
 322 }
 323
 324 /*
 325  *              DCP status stage
 326  */
 327 static int usbhs_dcp_dir_switch_to_write(struct usbhs_pkt *pkt, int *is_done)
 328 {
 329         struct usbhs_pipe *pipe = pkt->pipe;
 330         struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
 331         struct usbhs_fifo *fifo = usbhsf_get_cfifo(priv); /* CFIFO */
 332         struct device *dev = usbhs_priv_to_dev(priv);
 333         int ret;
 334
 335         usbhs_pipe_disable(pipe);
 336
 337         ret = usbhsf_fifo_select(pipe, fifo, 1);
 338         if (ret < 0) {
 339                 dev_err(dev, "%s() faile\n", __func__);
 340                 return ret;
 341         }
 342
 343         usbhs_pipe_sequence_data1(pipe); /* DATA1 */
 344
 345         usbhsf_fifo_clear(pipe, fifo);
 346         usbhsf_send_terminator(pipe, fifo);
 347
 348         usbhsf_fifo_unselect(pipe, fifo);
 349
 350         usbhsf_tx_irq_ctrl(pipe, 1);
 351         usbhs_pipe_enable(pipe);
 352
 353         return ret;
 354 }
 355
 356 static int usbhs_dcp_dir_switch_to_read(struct usbhs_pkt *pkt, int *is_done)
 357 {
 358         struct usbhs_pipe *pipe = pkt->pipe;
 359         struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
 360         struct usbhs_fifo *fifo = usbhsf_get_cfifo(priv); /* CFIFO */
 361         struct device *dev = usbhs_priv_to_dev(priv);
 362         int ret;
 363
 364         usbhs_pipe_disable(pipe);
 365
 366         ret = usbhsf_fifo_select(pipe, fifo, 0);
 367         if (ret < 0) {
 368                 dev_err(dev, "%s() fail\n", __func__);
 369                 return ret;
 370         }
 371
 372         usbhs_pipe_sequence_data1(pipe); /* DATA1 */
 373         usbhsf_fifo_clear(pipe, fifo);
 374
 375         usbhsf_fifo_unselect(pipe, fifo);
 376
 377         usbhsf_rx_irq_ctrl(pipe, 1);
 378         usbhs_pipe_enable(pipe);
 379
 380         return ret;
 381
 382 }
 383
 384 static int usbhs_dcp_dir_switch_done(struct usbhs_pkt *pkt, int *is_done)
 385 {
 386         struct usbhs_pipe *pipe = pkt->pipe;
 387
 388         if (pkt->handler == &usbhs_dcp_status_stage_in_handler)
 389                 usbhsf_tx_irq_ctrl(pipe, 0);
 390         else
 391                 usbhsf_rx_irq_ctrl(pipe, 0);
 392
 393         pkt->actual = pkt->length;
 394         *is_done = 1;
 395
 396         return 0;
 397 }
 398
 399 struct usbhs_pkt_handle usbhs_dcp_status_stage_in_handler = {
 400         .prepare = usbhs_dcp_dir_switch_to_write,
 401         .try_run = usbhs_dcp_dir_switch_done,
 402 };
 403
 404 struct usbhs_pkt_handle usbhs_dcp_status_stage_out_handler = {
 405         .prepare = usbhs_dcp_dir_switch_to_read,
 406         .try_run = usbhs_dcp_dir_switch_done,
 407 };
 408
 409 /*
 410  *              DCP data stage (push)
 411  */
 412 static int usbhsf_dcp_data_stage_try_push(struct usbhs_pkt *pkt, int *is_done)
 413 {
 414         struct usbhs_pipe *pipe = pkt->pipe;
 415
 416         usbhs_pipe_sequence_data1(pipe); /* DATA1 */
 417
 418         /*
 419          * change handler to PIO push
 420          */
 421         pkt->handler = &usbhs_fifo_pio_push_handler;
 422
 423         return pkt->handler->prepare(pkt, is_done);
 424 }
 425
 426 struct usbhs_pkt_handle usbhs_dcp_data_stage_out_handler = {
 427         .prepare = usbhsf_dcp_data_stage_try_push,
 428 };
 429
 430 /*
 431  *              DCP data stage (pop)
 432  */
 433 static int usbhsf_dcp_data_stage_prepare_pop(struct usbhs_pkt *pkt,
 434                                              int *is_done)
 435 {
 436         struct usbhs_pipe *pipe = pkt->pipe;
 437         struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
 438         struct usbhs_fifo *fifo = usbhsf_get_cfifo(priv);
 439
 440         if (usbhs_pipe_is_busy(pipe))
 441                 return 0;
 442
 443         /*
 444          * prepare pop for DCP should
 445          *  - change DCP direction,
 446          *  - clear fifo
 447          *  - DATA1
 448          */
 449         usbhs_pipe_disable(pipe);
 450
 451         usbhs_pipe_sequence_data1(pipe); /* DATA1 */
 452
 453         usbhsf_fifo_select(pipe, fifo, 0);
 454         usbhsf_fifo_clear(pipe, fifo);
 455         usbhsf_fifo_unselect(pipe, fifo);
 456
 457         /*
 458          * change handler to PIO pop
 459          */
 460         pkt->handler = &usbhs_fifo_pio_pop_handler;
 461
 462         return pkt->handler->prepare(pkt, is_done);
 463 }
 464
 465 struct usbhs_pkt_handle usbhs_dcp_data_stage_in_handler = {
 466         .prepare = usbhsf_dcp_data_stage_prepare_pop,
 467 };
 468
 469 /*
 470  *              PIO push handler
 471  */
 472 static int usbhsf_pio_try_push(struct usbhs_pkt *pkt, int *is_done)
 473 {
 474         struct usbhs_pipe *pipe = pkt->pipe;
 475         struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
 476         struct device *dev = usbhs_priv_to_dev(priv);
 477         struct usbhs_fifo *fifo = usbhsf_get_cfifo(priv); /* CFIFO */
 478         void __iomem *addr = priv->base + fifo->port;
 479         u8 *buf;
 480         int maxp = usbhs_pipe_get_maxpacket(pipe);
 481         int total_len;
 482         int i, ret, len;
 483         int is_short;
 484
 485         ret = usbhsf_fifo_select(pipe, fifo, 1);
 486         if (ret < 0)
 487                 return 0;
 488
 489         ret = usbhs_pipe_is_accessible(pipe);
 490         if (ret < 0) {
 491                 /* inaccessible pipe is not an error */
 492                 ret = 0;
 493                 goto usbhs_fifo_write_busy;
 494         }
 495
 496         ret = usbhsf_fifo_barrier(priv, fifo);
 497         if (ret < 0)
 498                 goto usbhs_fifo_write_busy;
 499
 500         buf             = pkt->buf    + pkt->actual;
 501         len             = pkt->length - pkt->actual;
 502         len             = min(len, maxp);
 503         total_len       = len;
 504         is_short        = total_len < maxp;
 505
 506         /*
 507          * FIXME
 508          *
 509          * 32-bit access only
 510          */
 511         if (len >= 4 && !((unsigned long)buf & 0x03)) {
 512                 iowrite32_rep(addr, buf, len / 4);
 513                 len %= 4;
 514                 buf += total_len - len;
 515         }
 516
 517         /* the rest operation */
 518         for (i = 0; i < len; i++)
 519                 iowrite8(buf[i], addr + (0x03 - (i & 0x03)));
 520
 521         /*
 522          * variable update
 523          */
 524         pkt->actual += total_len;
 525
 526         if (pkt->actual < pkt->length)
 527                 *is_done = 0;           /* there are remainder data */
 528         else if (is_short)
 529                 *is_done = 1;           /* short packet */
 530         else
 531                 *is_done = !pkt->zero;  /* send zero packet ? */
 532
 533         /*
 534          * pipe/irq handling
 535          */
 536         if (is_short)
 537                 usbhsf_send_terminator(pipe, fifo);
 538
 539         usbhsf_tx_irq_ctrl(pipe, !*is_done);
 540         usbhs_pipe_enable(pipe);
 541
 542         dev_dbg(dev, "  send %d (%d/ %d/ %d/ %d)\n",
 543                 usbhs_pipe_number(pipe),
 544                 pkt->length, pkt->actual, *is_done, pkt->zero);
 545
 546         /*
 547          * Transmission end
 548          */
 549         if (*is_done) {
 550                 if (usbhs_pipe_is_dcp(pipe))
 551                         usbhs_dcp_control_transfer_done(pipe);
 552         }
 553
 554         usbhsf_fifo_unselect(pipe, fifo);
 555
 556         return 0;
 557
 558 usbhs_fifo_write_busy:
 559         usbhsf_fifo_unselect(pipe, fifo);
 560
 561         /*
 562          * pipe is busy.
 563          * retry in interrupt
 564          */
 565         usbhsf_tx_irq_ctrl(pipe, 1);
 566
 567         return ret;
 568 }
 569
 570 struct usbhs_pkt_handle usbhs_fifo_pio_push_handler = {
 571         .prepare = usbhsf_pio_try_push,
 572         .try_run = usbhsf_pio_try_push,
 573 };
 574
 575 /*
 576  *              PIO pop handler
 577  */
 578 static int usbhsf_prepare_pop(struct usbhs_pkt *pkt, int *is_done)
 579 {
 580         struct usbhs_pipe *pipe = pkt->pipe;
 581
 582         if (usbhs_pipe_is_busy(pipe))
 583                 return 0;
 584
 585         /*
 586          * pipe enable to prepare packet receive
 587          */
 588
 589         usbhs_pipe_enable(pipe);
 590         usbhsf_rx_irq_ctrl(pipe, 1);
 591
 592         return 0;
 593 }
 594
 595 static int usbhsf_pio_try_pop(struct usbhs_pkt *pkt, int *is_done)
 596 {
 597         struct usbhs_pipe *pipe = pkt->pipe;
 598         struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
 599         struct device *dev = usbhs_priv_to_dev(priv);
 600         struct usbhs_fifo *fifo = usbhsf_get_cfifo(priv); /* CFIFO */
 601         void __iomem *addr = priv->base + fifo->port;
 602         u8 *buf;
 603         u32 data = 0;
 604         int maxp = usbhs_pipe_get_maxpacket(pipe);
 605         int rcv_len, len;
 606         int i, ret;
 607         int total_len = 0;
 608
 609         ret = usbhsf_fifo_select(pipe, fifo, 0);
 610         if (ret < 0)
 611                 return 0;
 612
 613         ret = usbhsf_fifo_barrier(priv, fifo);
 614         if (ret < 0)
 615                 goto usbhs_fifo_read_busy;
 616
 617         rcv_len = usbhsf_fifo_rcv_len(priv, fifo);
 618
 619         buf             = pkt->buf    + pkt->actual;
 620         len             = pkt->length - pkt->actual;
 621         len             = min(len, rcv_len);
 622         total_len       = len;
 623
 624         /*
 625          * update actual length first here to decide disable pipe.
 626          * if this pipe keeps BUF status and all data were popped,
 627          * then, next interrupt/token will be issued again
 628          */
 629         pkt->actual += total_len;
 630
 631         if ((pkt->actual == pkt->length) ||     /* receive all data */
 632             (total_len < maxp)) {               /* short packet */
 633                 *is_done = 1;
 634                 usbhsf_rx_irq_ctrl(pipe, 0);
 635                 usbhs_pipe_disable(pipe);       /* disable pipe first */
 636         }
 637
 638         /*
 639          * Buffer clear if Zero-Length packet
 640          *
 641          * see
 642          * "Operation" - "FIFO Buffer Memory" - "FIFO Port Function"
 643          */
 644         if (0 == rcv_len) {
 645                 usbhsf_fifo_clear(pipe, fifo);
 646                 goto usbhs_fifo_read_end;
 647         }
 648
 649         /*
 650          * FIXME
 651          *
 652          * 32-bit access only
 653          */
 654         if (len >= 4 && !((unsigned long)buf & 0x03)) {
 655                 ioread32_rep(addr, buf, len / 4);
 656                 len %= 4;
 657                 buf += total_len - len;
 658         }
 659
 660         /* the rest operation */
 661         for (i = 0; i < len; i++) {
 662                 if (!(i & 0x03))
 663                         data = ioread32(addr);
 664
 665                 buf[i] = (data >> ((i & 0x03) * 8)) & 0xff;
 666         }
 667
 668 usbhs_fifo_read_end:
 669         dev_dbg(dev, "  recv %d (%d/ %d/ %d/ %d)\n",
 670                 usbhs_pipe_number(pipe),
 671                 pkt->length, pkt->actual, *is_done, pkt->zero);
 672
 673 usbhs_fifo_read_busy:
 674         usbhsf_fifo_unselect(pipe, fifo);
 675
 676         return ret;
 677 }
 678
 679 struct usbhs_pkt_handle usbhs_fifo_pio_pop_handler = {
 680         .prepare = usbhsf_prepare_pop,
 681         .try_run = usbhsf_pio_try_pop,
 682 };
 683
 684 /*
 685  *              DCP ctrol statge handler
 686  */
 687 static int usbhsf_ctrl_stage_end(struct usbhs_pkt *pkt, int *is_done)
 688 {
 689         usbhs_dcp_control_transfer_done(pkt->pipe);
 690
 691         *is_done = 1;
 692
 693         return 0;
 694 }
 695
 696 struct usbhs_pkt_handle usbhs_ctrl_stage_end_handler = {
 697         .prepare = usbhsf_ctrl_stage_end,
 698         .try_run = usbhsf_ctrl_stage_end,
 699 };
 700
 701 /*
 702  *              DMA fifo functions
 703  */
 704 static struct dma_chan *usbhsf_dma_chan_get(struct usbhs_fifo *fifo,
 705                                             struct usbhs_pkt *pkt)
 706 {
 707         if (&usbhs_fifo_dma_push_handler == pkt->handler)
 708                 return fifo->tx_chan;
 709
 710         if (&usbhs_fifo_dma_pop_handler == pkt->handler)
 711                 return fifo->rx_chan;
 712
 713         return NULL;
 714 }
 715
 716 static struct usbhs_fifo *usbhsf_get_dma_fifo(struct usbhs_priv *priv,
 717                                               struct usbhs_pkt *pkt)
 718 {
 719         struct usbhs_fifo *fifo;
 720
 721         /* DMA :: D0FIFO */
 722         fifo = usbhsf_get_d0fifo(priv);
 723         if (usbhsf_dma_chan_get(fifo, pkt) &&
 724             !usbhsf_fifo_is_busy(fifo))
 725                 return fifo;
 726
 727         /* DMA :: D1FIFO */
 728         fifo = usbhsf_get_d1fifo(priv);
 729         if (usbhsf_dma_chan_get(fifo, pkt) &&
 730             !usbhsf_fifo_is_busy(fifo))
 731                 return fifo;
 732
 733         return NULL;
 734 }
 735
 736 #define usbhsf_dma_start(p, f)  __usbhsf_dma_ctrl(p, f, DREQE)
 737 #define usbhsf_dma_stop(p, f)   __usbhsf_dma_ctrl(p, f, 0)
 738 static void __usbhsf_dma_ctrl(struct usbhs_pipe *pipe,
 739                               struct usbhs_fifo *fifo,
 740                               u16 dreqe)
 741 {
 742         struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
 743
 744         usbhs_bset(priv, fifo->sel, DREQE, dreqe);
 745 }
 746
 747 #define usbhsf_dma_map(p)       __usbhsf_dma_map_ctrl(p, 1)
 748 #define usbhsf_dma_unmap(p)     __usbhsf_dma_map_ctrl(p, 0)
 749 static int __usbhsf_dma_map_ctrl(struct usbhs_pkt *pkt, int map)
 750 {
 751         struct usbhs_pipe *pipe = pkt->pipe;
 752         struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
 753         struct usbhs_pipe_info *info = usbhs_priv_to_pipeinfo(priv);
 754
 755         return info->dma_map_ctrl(pkt, map);
 756 }
 757
 758 static void usbhsf_dma_complete(void *arg);
 759 static void usbhsf_dma_prepare_tasklet(unsigned long data)
 760 {
 761         struct usbhs_pkt *pkt = (struct usbhs_pkt *)data;
 762         struct usbhs_pipe *pipe = pkt->pipe;
 763         struct usbhs_fifo *fifo = usbhs_pipe_to_fifo(pipe);
 764         struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
 765         struct scatterlist sg;
 766         struct dma_async_tx_descriptor *desc;
 767         struct dma_chan *chan = usbhsf_dma_chan_get(fifo, pkt);
 768         struct device *dev = usbhs_priv_to_dev(priv);
 769         enum dma_data_direction dir;
 770         dma_cookie_t cookie;
 771
 772         dir = usbhs_pipe_is_dir_in(pipe) ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
 773
 774         sg_init_table(&sg, 1);
 775         sg_set_page(&sg, virt_to_page(pkt->dma),
 776                     pkt->length, offset_in_page(pkt->dma));
 777         sg_dma_address(&sg) = pkt->dma + pkt->actual;
 778         sg_dma_len(&sg) = pkt->trans;
 779
 780         desc = chan->device->device_prep_slave_sg(chan, &sg, 1, dir,
 781                                                   DMA_PREP_INTERRUPT |
 782                                                   DMA_CTRL_ACK);
 783         if (!desc)
 784                 return;
 785
 786         desc->callback          = usbhsf_dma_complete;
 787         desc->callback_param    = pipe;
 788
 789         cookie = desc->tx_submit(desc);
 790         if (cookie < 0) {
 791                 dev_err(dev, "Failed to submit dma descriptor\n");
 792                 return;
 793         }
 794
 795         dev_dbg(dev, "  %s %d (%d/ %d)\n",
 796                 fifo->name, usbhs_pipe_number(pipe), pkt->length, pkt->zero);
 797
 798         usbhsf_dma_start(pipe, fifo);
 799         dma_async_issue_pending(chan);
 800 }
 801
 802 /*
 803  *              DMA push handler
 804  */
 805 static int usbhsf_dma_prepare_push(struct usbhs_pkt *pkt, int *is_done)
 806 {
 807         struct usbhs_pipe *pipe = pkt->pipe;
 808         struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
 809         struct usbhs_fifo *fifo;
 810         int len = pkt->length - pkt->actual;
 811         int ret;
 812
 813         if (usbhs_pipe_is_busy(pipe))
 814                 return 0;
 815
 816         /* use PIO if packet is less than pio_dma_border or pipe is DCP */
 817         if ((len < usbhs_get_dparam(priv, pio_dma_border)) ||
 818             usbhs_pipe_is_dcp(pipe))
 819                 goto usbhsf_pio_prepare_push;
 820
 821         if (len % 4) /* 32bit alignment */
 822                 goto usbhsf_pio_prepare_push;
 823
 824         if ((uintptr_t)(pkt->buf + pkt->actual) & 0x7) /* 8byte alignment */
 825                 goto usbhsf_pio_prepare_push;
 826
 827         /* get enable DMA fifo */
 828         fifo = usbhsf_get_dma_fifo(priv, pkt);
 829         if (!fifo)
 830                 goto usbhsf_pio_prepare_push;
 831
 832         if (usbhsf_dma_map(pkt) < 0)
 833                 goto usbhsf_pio_prepare_push;
 834
 835         ret = usbhsf_fifo_select(pipe, fifo, 0);
 836         if (ret < 0)
 837                 goto usbhsf_pio_prepare_push_unmap;
 838
 839         pkt->trans = len;
 840
 841         tasklet_init(&fifo->tasklet,
 842                      usbhsf_dma_prepare_tasklet,
 843                      (unsigned long)pkt);
 844
 845         tasklet_schedule(&fifo->tasklet);
 846
 847         return 0;
 848
 849 usbhsf_pio_prepare_push_unmap:
 850         usbhsf_dma_unmap(pkt);
 851 usbhsf_pio_prepare_push:
 852         /*
 853          * change handler to PIO
 854          */
 855         pkt->handler = &usbhs_fifo_pio_push_handler;
 856
 857         return pkt->handler->prepare(pkt, is_done);
 858 }
 859
 860 static int usbhsf_dma_push_done(struct usbhs_pkt *pkt, int *is_done)
 861 {
 862         struct usbhs_pipe *pipe = pkt->pipe;
 863
 864         pkt->actual = pkt->trans;
 865
 866         *is_done = !pkt->zero;  /* send zero packet ? */
 867
 868         usbhsf_dma_stop(pipe, pipe->fifo);
 869         usbhsf_dma_unmap(pkt);
 870         usbhsf_fifo_unselect(pipe, pipe->fifo);
 871
 872         return 0;
 873 }
 874
 875 struct usbhs_pkt_handle usbhs_fifo_dma_push_handler = {
 876         .prepare        = usbhsf_dma_prepare_push,
 877         .dma_done       = usbhsf_dma_push_done,
 878 };
 879
 880 /*
 881  *              DMA pop handler
 882  */
 883 static int usbhsf_dma_try_pop(struct usbhs_pkt *pkt, int *is_done)
 884 {
 885         struct usbhs_pipe *pipe = pkt->pipe;
 886         struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
 887         struct usbhs_fifo *fifo;
 888         int len, ret;
 889
 890         if (usbhs_pipe_is_busy(pipe))
 891                 return 0;
 892
 893         if (usbhs_pipe_is_dcp(pipe))
 894                 goto usbhsf_pio_prepare_pop;
 895
 896         /* get enable DMA fifo */
 897         fifo = usbhsf_get_dma_fifo(priv, pkt);
 898         if (!fifo)
 899                 goto usbhsf_pio_prepare_pop;
 900
 901         if ((uintptr_t)(pkt->buf + pkt->actual) & 0x7) /* 8byte alignment */
 902                 goto usbhsf_pio_prepare_pop;
 903
 904         ret = usbhsf_fifo_select(pipe, fifo, 0);
 905         if (ret < 0)
 906                 goto usbhsf_pio_prepare_pop;
 907
 908         /* use PIO if packet is less than pio_dma_border */
 909         len = usbhsf_fifo_rcv_len(priv, fifo);
 910         len = min(pkt->length - pkt->actual, len);
 911         if (len % 4) /* 32bit alignment */
 912                 goto usbhsf_pio_prepare_pop_unselect;
 913
 914         if (len < usbhs_get_dparam(priv, pio_dma_border))
 915                 goto usbhsf_pio_prepare_pop_unselect;
 916
 917         ret = usbhsf_fifo_barrier(priv, fifo);
 918         if (ret < 0)
 919                 goto usbhsf_pio_prepare_pop_unselect;
 920
 921         if (usbhsf_dma_map(pkt) < 0)
 922                 goto usbhsf_pio_prepare_pop_unselect;
 923
 924         /* DMA */
 925
 926         /*
 927          * usbhs_fifo_dma_pop_handler :: prepare
 928          * enabled irq to come here.
 929          * but it is no longer needed for DMA. disable it.
 930          */
 931         usbhsf_rx_irq_ctrl(pipe, 0);
 932
 933         pkt->trans = len;
 934
 935         usbhsf_tx_irq_ctrl(pipe, 0);
 936         tasklet_init(&fifo->tasklet,
 937                      usbhsf_dma_prepare_tasklet,
 938                      (unsigned long)pkt);
 939
 940         tasklet_schedule(&fifo->tasklet);
 941
 942         return 0;
 943
 944 usbhsf_pio_prepare_pop_unselect:
 945         usbhsf_fifo_unselect(pipe, fifo);
 946 usbhsf_pio_prepare_pop:
 947
 948         /*
 949          * change handler to PIO
 950          */
 951         pkt->handler = &usbhs_fifo_pio_pop_handler;
 952
 953         return pkt->handler->try_run(pkt, is_done);
 954 }
 955
 956 static int usbhsf_dma_pop_done(struct usbhs_pkt *pkt, int *is_done)
 957 {
 958         struct usbhs_pipe *pipe = pkt->pipe;
 959         int maxp = usbhs_pipe_get_maxpacket(pipe);
 960
 961         usbhsf_dma_stop(pipe, pipe->fifo);
 962         usbhsf_dma_unmap(pkt);
 963         usbhsf_fifo_unselect(pipe, pipe->fifo);
 964
 965         pkt->actual += pkt->trans;
 966
 967         if ((pkt->actual == pkt->length) ||     /* receive all data */
 968             (pkt->trans < maxp)) {              /* short packet */
 969                 *is_done = 1;
 970         } else {
 971                 /* re-enable */
 972                 usbhsf_prepare_pop(pkt, is_done);
 973         }
 974
 975         return 0;
 976 }
 977
 978 struct usbhs_pkt_handle usbhs_fifo_dma_pop_handler = {
 979         .prepare        = usbhsf_prepare_pop,
 980         .try_run        = usbhsf_dma_try_pop,
 981         .dma_done       = usbhsf_dma_pop_done
 982 };
 983
 984 /*
 985  *              DMA setting
 986  */
 987 static bool usbhsf_dma_filter(struct dma_chan *chan, void *param)
 988 {
 989         struct sh_dmae_slave *slave = param;
 990
 991         /*
 992          * FIXME
 993          *
 994          * usbhs doesn't recognize id = 0 as valid DMA
 995          */
 996         if (0 == slave->slave_id)
 997                 return false;
 998
 999         chan->private = slave;
1000
1001         return true;
1002 }
1003
1004 static void usbhsf_dma_quit(struct usbhs_priv *priv, struct usbhs_fifo *fifo)
1005 {
1006         if (fifo->tx_chan)
1007                 dma_release_channel(fifo->tx_chan);
1008         if (fifo->rx_chan)
1009                 dma_release_channel(fifo->rx_chan);
1010
1011         fifo->tx_chan = NULL;
1012         fifo->rx_chan = NULL;
1013 }
1014
1015 static void usbhsf_dma_init(struct usbhs_priv *priv,
1016                             struct usbhs_fifo *fifo)
1017 {
1018         struct device *dev = usbhs_priv_to_dev(priv);
1019         dma_cap_mask_t mask;
1020
1021         dma_cap_zero(mask);
1022         dma_cap_set(DMA_SLAVE, mask);
1023         fifo->tx_chan = dma_request_channel(mask, usbhsf_dma_filter,
1024                                             &fifo->tx_slave);
1025
1026         dma_cap_zero(mask);
1027         dma_cap_set(DMA_SLAVE, mask);
1028         fifo->rx_chan = dma_request_channel(mask, usbhsf_dma_filter,
1029                                             &fifo->rx_slave);
1030
1031         if (fifo->tx_chan || fifo->rx_chan)
1032                 dev_dbg(dev, "enable DMAEngine (%s%s%s)\n",
1033                          fifo->name,
1034                          fifo->tx_chan ? "[TX]" : "    ",
1035                          fifo->rx_chan ? "[RX]" : "    ");
1036 }
1037
1038 /*
1039  *              irq functions
1040  */
1041 static int usbhsf_irq_empty(struct usbhs_priv *priv,
1042                             struct usbhs_irq_state *irq_state)
1043 {
1044         struct usbhs_pipe *pipe;
1045         struct device *dev = usbhs_priv_to_dev(priv);
1046         int i, ret;
1047
1048         if (!irq_state->bempsts) {
1049                 dev_err(dev, "debug %s !!\n", __func__);
1050                 return -EIO;
1051         }
1052
1053         dev_dbg(dev, "irq empty [0x%04x]\n", irq_state->bempsts);
1054
1055         /*
1056          * search interrupted "pipe"
1057          * not "uep".
1058          */
1059         usbhs_for_each_pipe_with_dcp(pipe, priv, i) {
1060                 if (!(irq_state->bempsts & (1 << i)))
1061                         continue;
1062
1063                 ret = usbhsf_pkt_handler(pipe, USBHSF_PKT_TRY_RUN);
1064                 if (ret < 0)
1065                         dev_err(dev, "irq_empty run_error %d : %d\n", i, ret);
1066         }
1067
1068         return 0;
1069 }
1070
1071 static int usbhsf_irq_ready(struct usbhs_priv *priv,
1072                             struct usbhs_irq_state *irq_state)
1073 {
1074         struct usbhs_pipe *pipe;
1075         struct device *dev = usbhs_priv_to_dev(priv);
1076         int i, ret;
1077
1078         if (!irq_state->brdysts) {
1079                 dev_err(dev, "debug %s !!\n", __func__);
1080                 return -EIO;
1081         }
1082
1083         dev_dbg(dev, "irq ready [0x%04x]\n", irq_state->brdysts);
1084
1085         /*
1086          * search interrupted "pipe"
1087          * not "uep".
1088          */
1089         usbhs_for_each_pipe_with_dcp(pipe, priv, i) {
1090                 if (!(irq_state->brdysts & (1 << i)))
1091                         continue;
1092
1093                 ret = usbhsf_pkt_handler(pipe, USBHSF_PKT_TRY_RUN);
1094                 if (ret < 0)
1095                         dev_err(dev, "irq_ready run_error %d : %d\n", i, ret);
1096         }
1097
1098         return 0;
1099 }
1100
1101 static void usbhsf_dma_complete(void *arg)
1102 {
1103         struct usbhs_pipe *pipe = arg;
1104         struct usbhs_priv *priv = usbhs_pipe_to_priv(pipe);
1105         struct device *dev = usbhs_priv_to_dev(priv);
1106         int ret;
1107
1108         ret = usbhsf_pkt_handler(pipe, USBHSF_PKT_DMA_DONE);
1109         if (ret < 0)
1110                 dev_err(dev, "dma_complete run_error %d : %d\n",
1111                         usbhs_pipe_number(pipe), ret);
1112 }
1113
1114 /*
1115  *              fifo init
1116  */
1117 void usbhs_fifo_init(struct usbhs_priv *priv)
1118 {
1119         struct usbhs_mod *mod = usbhs_mod_get_current(priv);
1120         struct usbhs_fifo *cfifo = usbhsf_get_cfifo(priv);
1121         struct usbhs_fifo *d0fifo = usbhsf_get_d0fifo(priv);
1122         struct usbhs_fifo *d1fifo = usbhsf_get_d1fifo(priv);
1123
1124         mod->irq_empty          = usbhsf_irq_empty;
1125         mod->irq_ready          = usbhsf_irq_ready;
1126         mod->irq_bempsts        = 0;
1127         mod->irq_brdysts        = 0;
1128
1129         cfifo->pipe     = NULL;
1130         cfifo->tx_chan  = NULL;
1131         cfifo->rx_chan  = NULL;
1132
1133         d0fifo->pipe    = NULL;
1134         d0fifo->tx_chan = NULL;
1135         d0fifo->rx_chan = NULL;
1136
1137         d1fifo->pipe    = NULL;
1138         d1fifo->tx_chan = NULL;
1139         d1fifo->rx_chan = NULL;
1140
1141         usbhsf_dma_init(priv, usbhsf_get_d0fifo(priv));
1142         usbhsf_dma_init(priv, usbhsf_get_d1fifo(priv));
1143 }
1144
1145 void usbhs_fifo_quit(struct usbhs_priv *priv)
1146 {
1147         struct usbhs_mod *mod = usbhs_mod_get_current(priv);
1148
1149         mod->irq_empty          = NULL;
1150         mod->irq_ready          = NULL;
1151         mod->irq_bempsts        = 0;
1152         mod->irq_brdysts        = 0;
1153
1154         usbhsf_dma_quit(priv, usbhsf_get_d0fifo(priv));
1155         usbhsf_dma_quit(priv, usbhsf_get_d1fifo(priv));
1156 }
1157
1158 int usbhs_fifo_probe(struct usbhs_priv *priv)
1159 {
1160         struct usbhs_fifo *fifo;
1161
1162         /* CFIFO */
1163         fifo = usbhsf_get_cfifo(priv);
1164         fifo->name      = "CFIFO";
1165         fifo->port      = CFIFO;
1166         fifo->sel       = CFIFOSEL;
1167         fifo->ctr       = CFIFOCTR;
1168
1169         /* D0FIFO */
1170         fifo = usbhsf_get_d0fifo(priv);
1171         fifo->name      = "D0FIFO";
1172         fifo->port      = D0FIFO;
1173         fifo->sel       = D0FIFOSEL;
1174         fifo->ctr       = D0FIFOCTR;
1175         fifo->tx_slave.slave_id = usbhs_get_dparam(priv, d0_tx_id);
1176         fifo->rx_slave.slave_id = usbhs_get_dparam(priv, d0_rx_id);
1177
1178         /* D1FIFO */
1179         fifo = usbhsf_get_d1fifo(priv);
1180         fifo->name      = "D1FIFO";
1181         fifo->port      = D1FIFO;
1182         fifo->sel       = D1FIFOSEL;
1183         fifo->ctr       = D1FIFOCTR;
1184         fifo->tx_slave.slave_id = usbhs_get_dparam(priv, d1_tx_id);
1185         fifo->rx_slave.slave_id = usbhs_get_dparam(priv, d1_rx_id);
1186
1187         return 0;
1188 }
1189
1190 void usbhs_fifo_remove(struct usbhs_priv *priv)
1191 {
1192 }