xref: /OK3568_Linux_fs/kernel/drivers/usb/renesas_usbhs/fifo.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-1.0+ */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Renesas USB driver
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Copyright (C) 2011 Renesas Solutions Corp.
6*4882a593Smuzhiyun  * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
7*4882a593Smuzhiyun  */
8*4882a593Smuzhiyun #ifndef RENESAS_USB_FIFO_H
9*4882a593Smuzhiyun #define RENESAS_USB_FIFO_H
10*4882a593Smuzhiyun 
11*4882a593Smuzhiyun #include <linux/interrupt.h>
12*4882a593Smuzhiyun #include <linux/sh_dma.h>
13*4882a593Smuzhiyun #include <linux/workqueue.h>
14*4882a593Smuzhiyun #include <asm/dma.h>
15*4882a593Smuzhiyun #include "pipe.h"
16*4882a593Smuzhiyun 
17*4882a593Smuzhiyun struct usbhs_fifo {
18*4882a593Smuzhiyun 	char *name;
19*4882a593Smuzhiyun 	u32 port;	/* xFIFO */
20*4882a593Smuzhiyun 	u32 sel;	/* xFIFOSEL */
21*4882a593Smuzhiyun 	u32 ctr;	/* xFIFOCTR */
22*4882a593Smuzhiyun 
23*4882a593Smuzhiyun 	struct usbhs_pipe	*pipe;
24*4882a593Smuzhiyun 
25*4882a593Smuzhiyun 	struct dma_chan		*tx_chan;
26*4882a593Smuzhiyun 	struct dma_chan		*rx_chan;
27*4882a593Smuzhiyun 
28*4882a593Smuzhiyun 	struct sh_dmae_slave	tx_slave;
29*4882a593Smuzhiyun 	struct sh_dmae_slave	rx_slave;
30*4882a593Smuzhiyun };
31*4882a593Smuzhiyun 
32*4882a593Smuzhiyun #define USBHS_MAX_NUM_DFIFO	4
33*4882a593Smuzhiyun struct usbhs_fifo_info {
34*4882a593Smuzhiyun 	struct usbhs_fifo cfifo;
35*4882a593Smuzhiyun 	struct usbhs_fifo dfifo[USBHS_MAX_NUM_DFIFO];
36*4882a593Smuzhiyun };
37*4882a593Smuzhiyun #define usbhsf_get_dnfifo(p, n)	(&((p)->fifo_info.dfifo[n]))
38*4882a593Smuzhiyun #define usbhs_for_each_dfifo(priv, dfifo, i)			\
39*4882a593Smuzhiyun 	for ((i) = 0;						\
40*4882a593Smuzhiyun 	     ((i) < USBHS_MAX_NUM_DFIFO) &&			\
41*4882a593Smuzhiyun 		     ((dfifo) = usbhsf_get_dnfifo(priv, (i)));	\
42*4882a593Smuzhiyun 	     (i)++)
43*4882a593Smuzhiyun 
44*4882a593Smuzhiyun struct usbhs_pkt_handle;
45*4882a593Smuzhiyun struct usbhs_pkt {
46*4882a593Smuzhiyun 	struct list_head node;
47*4882a593Smuzhiyun 	struct usbhs_pipe *pipe;
48*4882a593Smuzhiyun 	const struct usbhs_pkt_handle *handler;
49*4882a593Smuzhiyun 	void (*done)(struct usbhs_priv *priv,
50*4882a593Smuzhiyun 		     struct usbhs_pkt *pkt);
51*4882a593Smuzhiyun 	struct work_struct work;
52*4882a593Smuzhiyun 	dma_addr_t dma;
53*4882a593Smuzhiyun 	const struct dmaengine_result *dma_result;
54*4882a593Smuzhiyun 	void *buf;
55*4882a593Smuzhiyun 	int length;
56*4882a593Smuzhiyun 	int trans;
57*4882a593Smuzhiyun 	int actual;
58*4882a593Smuzhiyun 	int zero;
59*4882a593Smuzhiyun 	int sequence;
60*4882a593Smuzhiyun };
61*4882a593Smuzhiyun 
62*4882a593Smuzhiyun struct usbhs_pkt_handle {
63*4882a593Smuzhiyun 	int (*prepare)(struct usbhs_pkt *pkt, int *is_done);
64*4882a593Smuzhiyun 	int (*try_run)(struct usbhs_pkt *pkt, int *is_done);
65*4882a593Smuzhiyun 	int (*dma_done)(struct usbhs_pkt *pkt, int *is_done);
66*4882a593Smuzhiyun };
67*4882a593Smuzhiyun 
68*4882a593Smuzhiyun /*
69*4882a593Smuzhiyun  * fifo
70*4882a593Smuzhiyun  */
71*4882a593Smuzhiyun int usbhs_fifo_probe(struct usbhs_priv *priv);
72*4882a593Smuzhiyun void usbhs_fifo_remove(struct usbhs_priv *priv);
73*4882a593Smuzhiyun void usbhs_fifo_init(struct usbhs_priv *priv);
74*4882a593Smuzhiyun void usbhs_fifo_quit(struct usbhs_priv *priv);
75*4882a593Smuzhiyun void usbhs_fifo_clear_dcp(struct usbhs_pipe *pipe);
76*4882a593Smuzhiyun 
77*4882a593Smuzhiyun /*
78*4882a593Smuzhiyun  * packet info
79*4882a593Smuzhiyun  */
80*4882a593Smuzhiyun extern const struct usbhs_pkt_handle usbhs_fifo_pio_push_handler;
81*4882a593Smuzhiyun extern const struct usbhs_pkt_handle usbhs_fifo_pio_pop_handler;
82*4882a593Smuzhiyun extern const struct usbhs_pkt_handle usbhs_ctrl_stage_end_handler;
83*4882a593Smuzhiyun 
84*4882a593Smuzhiyun extern const struct usbhs_pkt_handle usbhs_fifo_dma_push_handler;
85*4882a593Smuzhiyun extern const struct usbhs_pkt_handle usbhs_fifo_dma_pop_handler;
86*4882a593Smuzhiyun 
87*4882a593Smuzhiyun extern const struct usbhs_pkt_handle usbhs_dcp_status_stage_in_handler;
88*4882a593Smuzhiyun extern const struct usbhs_pkt_handle usbhs_dcp_status_stage_out_handler;
89*4882a593Smuzhiyun 
90*4882a593Smuzhiyun extern const struct usbhs_pkt_handle usbhs_dcp_data_stage_in_handler;
91*4882a593Smuzhiyun extern const struct usbhs_pkt_handle usbhs_dcp_data_stage_out_handler;
92*4882a593Smuzhiyun 
93*4882a593Smuzhiyun void usbhs_pkt_init(struct usbhs_pkt *pkt);
94*4882a593Smuzhiyun void usbhs_pkt_push(struct usbhs_pipe *pipe, struct usbhs_pkt *pkt,
95*4882a593Smuzhiyun 		    void (*done)(struct usbhs_priv *priv,
96*4882a593Smuzhiyun 				 struct usbhs_pkt *pkt),
97*4882a593Smuzhiyun 		    void *buf, int len, int zero, int sequence);
98*4882a593Smuzhiyun struct usbhs_pkt *usbhs_pkt_pop(struct usbhs_pipe *pipe, struct usbhs_pkt *pkt);
99*4882a593Smuzhiyun void usbhs_pkt_start(struct usbhs_pipe *pipe);
100*4882a593Smuzhiyun struct usbhs_pkt *__usbhsf_pkt_get(struct usbhs_pipe *pipe);
101*4882a593Smuzhiyun 
102*4882a593Smuzhiyun #endif /* RENESAS_USB_FIFO_H */
103