drivers/usb/renesas_usbhs/fifo.h

   1 // SPDX-License-Identifier: GPL-1.0+
   2 /*
   3  * Renesas USB driver
   4  *
   5  * Copyright (C) 2011 Renesas Solutions Corp.
   6  * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program; if not, write to the Free Software
  15  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  16  *
  17  */
  18 #ifndef RENESAS_USB_FIFO_H
  19 #define RENESAS_USB_FIFO_H
  20
  21 #include <linux/interrupt.h>
  22 #include <linux/sh_dma.h>
  23 #include <linux/workqueue.h>
  24 #include <asm/dma.h>
  25 #include "pipe.h"
  26
  27 struct usbhs_fifo {
  28         char *name;
  29         u32 port;       /* xFIFO */
  30         u32 sel;        /* xFIFOSEL */
  31         u32 ctr;        /* xFIFOCTR */
  32
  33         struct usbhs_pipe       *pipe;
  34
  35         struct dma_chan         *tx_chan;
  36         struct dma_chan         *rx_chan;
  37
  38         struct sh_dmae_slave    tx_slave;
  39         struct sh_dmae_slave    rx_slave;
  40 };
  41
  42 #define USBHS_MAX_NUM_DFIFO     4
  43 struct usbhs_fifo_info {
  44         struct usbhs_fifo cfifo;
  45         struct usbhs_fifo dfifo[USBHS_MAX_NUM_DFIFO];
  46 };
  47 #define usbhsf_get_dnfifo(p, n) (&((p)->fifo_info.dfifo[n]))
  48 #define usbhs_for_each_dfifo(priv, dfifo, i)                    \
  49         for ((i) = 0;                                           \
  50              ((i) < USBHS_MAX_NUM_DFIFO) &&                     \
  51                      ((dfifo) = usbhsf_get_dnfifo(priv, (i)));  \
  52              (i)++)
  53
  54 struct usbhs_pkt_handle;
  55 struct usbhs_pkt {
  56         struct list_head node;
  57         struct usbhs_pipe *pipe;
  58         const struct usbhs_pkt_handle *handler;
  59         void (*done)(struct usbhs_priv *priv,
  60                      struct usbhs_pkt *pkt);
  61         struct work_struct work;
  62         dma_addr_t dma;
  63         dma_cookie_t cookie;
  64         void *buf;
  65         int length;
  66         int trans;
  67         int actual;
  68         int zero;
  69         int sequence;
  70 };
  71
  72 struct usbhs_pkt_handle {
  73         int (*prepare)(struct usbhs_pkt *pkt, int *is_done);
  74         int (*try_run)(struct usbhs_pkt *pkt, int *is_done);
  75         int (*dma_done)(struct usbhs_pkt *pkt, int *is_done);
  76 };
  77
  78 /*
  79  * fifo
  80  */
  81 int usbhs_fifo_probe(struct usbhs_priv *priv);
  82 void usbhs_fifo_remove(struct usbhs_priv *priv);
  83 void usbhs_fifo_init(struct usbhs_priv *priv);
  84 void usbhs_fifo_quit(struct usbhs_priv *priv);
  85 void usbhs_fifo_clear_dcp(struct usbhs_pipe *pipe);
  86
  87 /*
  88  * packet info
  89  */
  90 extern const struct usbhs_pkt_handle usbhs_fifo_pio_push_handler;
  91 extern const struct usbhs_pkt_handle usbhs_fifo_pio_pop_handler;
  92 extern const struct usbhs_pkt_handle usbhs_ctrl_stage_end_handler;
  93
  94 extern const struct usbhs_pkt_handle usbhs_fifo_dma_push_handler;
  95 extern const struct usbhs_pkt_handle usbhs_fifo_dma_pop_handler;
  96
  97 extern const struct usbhs_pkt_handle usbhs_dcp_status_stage_in_handler;
  98 extern const struct usbhs_pkt_handle usbhs_dcp_status_stage_out_handler;
  99
 100 extern const struct usbhs_pkt_handle usbhs_dcp_data_stage_in_handler;
 101 extern const struct usbhs_pkt_handle usbhs_dcp_data_stage_out_handler;
 102
 103 void usbhs_pkt_init(struct usbhs_pkt *pkt);
 104 void usbhs_pkt_push(struct usbhs_pipe *pipe, struct usbhs_pkt *pkt,
 105                     void (*done)(struct usbhs_priv *priv,
 106                                  struct usbhs_pkt *pkt),
 107                     void *buf, int len, int zero, int sequence);
 108 struct usbhs_pkt *usbhs_pkt_pop(struct usbhs_pipe *pipe, struct usbhs_pkt *pkt);
 109 void usbhs_pkt_start(struct usbhs_pipe *pipe);
 110
 111 #endif /* RENESAS_USB_FIFO_H */