Add the rt linux 4.1.3-rt3 as base
[kvmfornfv.git] / kernel / drivers / usb / renesas_usbhs / fifo.h
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 #ifndef RENESAS_USB_FIFO_H
18 #define RENESAS_USB_FIFO_H
19
20 #include <linux/interrupt.h>
21 #include <linux/sh_dma.h>
22 #include <linux/workqueue.h>
23 #include <asm/dma.h>
24 #include "pipe.h"
25
26 struct usbhs_fifo {
27         char *name;
28         u32 port;       /* xFIFO */
29         u32 sel;        /* xFIFOSEL */
30         u32 ctr;        /* xFIFOCTR */
31
32         struct usbhs_pipe       *pipe;
33
34         struct dma_chan         *tx_chan;
35         struct dma_chan         *rx_chan;
36
37         struct sh_dmae_slave    tx_slave;
38         struct sh_dmae_slave    rx_slave;
39 };
40
41 #define USBHS_MAX_NUM_DFIFO     4
42 struct usbhs_fifo_info {
43         struct usbhs_fifo cfifo;
44         struct usbhs_fifo dfifo[USBHS_MAX_NUM_DFIFO];
45 };
46 #define usbhsf_get_dnfifo(p, n) (&((p)->fifo_info.dfifo[n]))
47 #define usbhs_for_each_dfifo(priv, dfifo, i)                            \
48         for ((i) = 0, dfifo = usbhsf_get_dnfifo(priv, (i));             \
49              ((i) < USBHS_MAX_NUM_DFIFO);                               \
50              (i)++, dfifo = usbhsf_get_dnfifo(priv, (i)))
51
52 struct usbhs_pkt_handle;
53 struct usbhs_pkt {
54         struct list_head node;
55         struct usbhs_pipe *pipe;
56         struct usbhs_pkt_handle *handler;
57         void (*done)(struct usbhs_priv *priv,
58                      struct usbhs_pkt *pkt);
59         struct work_struct work;
60         dma_addr_t dma;
61         dma_cookie_t cookie;
62         void *buf;
63         int length;
64         int trans;
65         int actual;
66         int zero;
67         int sequence;
68 };
69
70 struct usbhs_pkt_handle {
71         int (*prepare)(struct usbhs_pkt *pkt, int *is_done);
72         int (*try_run)(struct usbhs_pkt *pkt, int *is_done);
73         int (*dma_done)(struct usbhs_pkt *pkt, int *is_done);
74 };
75
76 /*
77  * fifo
78  */
79 int usbhs_fifo_probe(struct usbhs_priv *priv);
80 void usbhs_fifo_remove(struct usbhs_priv *priv);
81 void usbhs_fifo_init(struct usbhs_priv *priv);
82 void usbhs_fifo_quit(struct usbhs_priv *priv);
83 void usbhs_fifo_clear_dcp(struct usbhs_pipe *pipe);
84
85 /*
86  * packet info
87  */
88 extern struct usbhs_pkt_handle usbhs_fifo_pio_push_handler;
89 extern struct usbhs_pkt_handle usbhs_fifo_pio_pop_handler;
90 extern struct usbhs_pkt_handle usbhs_ctrl_stage_end_handler;
91
92 extern struct usbhs_pkt_handle usbhs_fifo_dma_push_handler;
93 extern struct usbhs_pkt_handle usbhs_fifo_dma_pop_handler;
94
95 extern struct usbhs_pkt_handle usbhs_dcp_status_stage_in_handler;
96 extern struct usbhs_pkt_handle usbhs_dcp_status_stage_out_handler;
97
98 extern struct usbhs_pkt_handle usbhs_dcp_data_stage_in_handler;
99 extern struct usbhs_pkt_handle usbhs_dcp_data_stage_out_handler;
100
101 void usbhs_pkt_init(struct usbhs_pkt *pkt);
102 void usbhs_pkt_push(struct usbhs_pipe *pipe, struct usbhs_pkt *pkt,
103                     void (*done)(struct usbhs_priv *priv,
104                                  struct usbhs_pkt *pkt),
105                     void *buf, int len, int zero, int sequence);
106 struct usbhs_pkt *usbhs_pkt_pop(struct usbhs_pipe *pipe, struct usbhs_pkt *pkt);
107 void usbhs_pkt_start(struct usbhs_pipe *pipe);
108
109 #endif /* RENESAS_USB_FIFO_H */