xref: /openbmc/linux/drivers/usb/renesas_usbhs/pipe.h (revision 7edd9cba)
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 #ifndef RENESAS_USB_PIPE_H
9 #define RENESAS_USB_PIPE_H
10 
11 #include "common.h"
12 #include "fifo.h"
13 
14 /*
15  *	struct
16  */
17 struct usbhs_pipe {
18 	u32 pipe_type;	/* USB_ENDPOINT_XFER_xxx */
19 
20 	struct usbhs_priv *priv;
21 	struct usbhs_fifo *fifo;
22 	struct list_head list;
23 
24 	int maxp;
25 
26 	u32 flags;
27 #define USBHS_PIPE_FLAGS_IS_USED		(1 << 0)
28 #define USBHS_PIPE_FLAGS_IS_DIR_IN		(1 << 1)
29 #define USBHS_PIPE_FLAGS_IS_DIR_HOST		(1 << 2)
30 #define USBHS_PIPE_FLAGS_IS_RUNNING		(1 << 3)
31 
32 	const struct usbhs_pkt_handle *handler;
33 
34 	void *mod_private;
35 };
36 
37 struct usbhs_pipe_info {
38 	struct usbhs_pipe *pipe;
39 	int size;	/* array size of "pipe" */
40 
41 	int (*dma_map_ctrl)(struct device *dma_dev, struct usbhs_pkt *pkt,
42 			    int map);
43 };
44 
45 /*
46  * pipe list
47  */
48 #define __usbhs_for_each_pipe(start, pos, info, i)	\
49 	for ((i) = start;						\
50 	     ((i) < (info)->size) && ((pos) = (info)->pipe + (i));	\
51 	     (i)++)
52 
53 #define usbhs_for_each_pipe(pos, priv, i)			\
54 	__usbhs_for_each_pipe(1, pos, &((priv)->pipe_info), i)
55 
56 #define usbhs_for_each_pipe_with_dcp(pos, priv, i)		\
57 	__usbhs_for_each_pipe(0, pos, &((priv)->pipe_info), i)
58 
59 /*
60  * data
61  */
62 #define usbhs_priv_to_pipeinfo(pr)	(&(pr)->pipe_info)
63 
64 /*
65  * pipe control
66  */
67 char *usbhs_pipe_name(struct usbhs_pipe *pipe);
68 struct usbhs_pipe
69 *usbhs_pipe_malloc(struct usbhs_priv *priv, int endpoint_type, int dir_in);
70 void usbhs_pipe_free(struct usbhs_pipe *pipe);
71 int usbhs_pipe_probe(struct usbhs_priv *priv);
72 void usbhs_pipe_remove(struct usbhs_priv *priv);
73 int usbhs_pipe_is_dir_in(struct usbhs_pipe *pipe);
74 int usbhs_pipe_is_dir_host(struct usbhs_pipe *pipe);
75 int usbhs_pipe_is_running(struct usbhs_pipe *pipe);
76 void usbhs_pipe_running(struct usbhs_pipe *pipe, int running);
77 
78 void usbhs_pipe_init(struct usbhs_priv *priv,
79 		     int (*dma_map_ctrl)(struct device *dma_dev,
80 					 struct usbhs_pkt *pkt, int map));
81 int usbhs_pipe_get_maxpacket(struct usbhs_pipe *pipe);
82 void usbhs_pipe_clear(struct usbhs_pipe *pipe);
83 void usbhs_pipe_clear_without_sequence(struct usbhs_pipe *pipe,
84 				       int needs_bfre, int bfre_enable);
85 int usbhs_pipe_is_accessible(struct usbhs_pipe *pipe);
86 bool usbhs_pipe_contains_transmittable_data(struct usbhs_pipe *pipe);
87 void usbhs_pipe_enable(struct usbhs_pipe *pipe);
88 void usbhs_pipe_disable(struct usbhs_pipe *pipe);
89 void usbhs_pipe_stall(struct usbhs_pipe *pipe);
90 int usbhs_pipe_is_stall(struct usbhs_pipe *pipe);
91 void usbhs_pipe_set_trans_count_if_bulk(struct usbhs_pipe *pipe, int len);
92 void usbhs_pipe_select_fifo(struct usbhs_pipe *pipe, struct usbhs_fifo *fifo);
93 void usbhs_pipe_config_update(struct usbhs_pipe *pipe, u16 devsel,
94 			      u16 epnum, u16 maxp);
95 void usbhs_pipe_config_change_bfre(struct usbhs_pipe *pipe, int enable);
96 
97 #define usbhs_pipe_sequence_data0(pipe)	usbhs_pipe_data_sequence(pipe, 0)
98 #define usbhs_pipe_sequence_data1(pipe)	usbhs_pipe_data_sequence(pipe, 1)
99 void usbhs_pipe_data_sequence(struct usbhs_pipe *pipe, int data);
100 
101 #define usbhs_pipe_to_priv(p)	((p)->priv)
102 #define usbhs_pipe_number(p)	(int)((p) - (p)->priv->pipe_info.pipe)
103 #define usbhs_pipe_is_dcp(p)	((p)->priv->pipe_info.pipe == (p))
104 #define usbhs_pipe_to_fifo(p)	((p)->fifo)
105 #define usbhs_pipe_is_busy(p)	usbhs_pipe_to_fifo(p)
106 
107 #define usbhs_pipe_type(p)		((p)->pipe_type)
108 #define usbhs_pipe_type_is(p, t)	((p)->pipe_type == t)
109 
110 /*
111  * dcp control
112  */
113 struct usbhs_pipe *usbhs_dcp_malloc(struct usbhs_priv *priv);
114 void usbhs_dcp_control_transfer_done(struct usbhs_pipe *pipe);
115 void usbhs_dcp_dir_for_host(struct usbhs_pipe *pipe, int dir_out);
116 
117 #endif /* RENESAS_USB_PIPE_H */
118