blob: 3d80c7b1fd1b4ba15133e2ffcd3c5db7be2e9933 [file] [log] [blame]
Kuninori Morimotof1407d52011-04-04 13:44:59 +09001/*
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_PIPE_H
18#define RENESAS_USB_PIPE_H
19
Paul Bollecc502bb2012-06-03 18:39:13 +020020#include "common.h"
21#include "fifo.h"
Kuninori Morimotof1407d52011-04-04 13:44:59 +090022
23/*
24 * struct
25 */
26struct usbhs_pipe {
27 u32 pipe_type; /* USB_ENDPOINT_XFER_xxx */
28
29 struct usbhs_priv *priv;
Kuninori Morimotod77e3f42011-06-06 14:18:50 +090030 struct usbhs_fifo *fifo;
Kuninori Morimoto6acb95d2011-06-06 14:18:16 +090031 struct list_head list;
Kuninori Morimotof1407d52011-04-04 13:44:59 +090032
Kuninori Morimoto7fd097e2011-10-10 22:00:42 -070033 int maxp;
34
Kuninori Morimotof1407d52011-04-04 13:44:59 +090035 u32 flags;
36#define USBHS_PIPE_FLAGS_IS_USED (1 << 0)
37#define USBHS_PIPE_FLAGS_IS_DIR_IN (1 << 1)
Kuninori Morimotoad6f2a82011-06-06 14:17:56 +090038#define USBHS_PIPE_FLAGS_IS_DIR_HOST (1 << 2)
Kuninori Morimotof1407d52011-04-04 13:44:59 +090039
Kuninori Morimoto0c6ef982011-10-10 22:00:59 -070040 struct usbhs_pkt_handle *handler;
41
Kuninori Morimotof1407d52011-04-04 13:44:59 +090042 void *mod_private;
43};
44
45struct usbhs_pipe_info {
46 struct usbhs_pipe *pipe;
47 int size; /* array size of "pipe" */
48 int bufnmb_last; /* FIXME : driver needs good allocator */
Kuninori Morimoto4bd04812011-06-06 14:18:07 +090049
Kuninori Morimotoe73a9892011-06-06 14:19:03 +090050 int (*dma_map_ctrl)(struct usbhs_pkt *pkt, int map);
Kuninori Morimotof1407d52011-04-04 13:44:59 +090051};
52
53/*
54 * pipe list
55 */
56#define __usbhs_for_each_pipe(start, pos, info, i) \
Kuninori Morimotoc2fa3ed2012-10-15 23:24:55 -070057 for (i = start, pos = (info)->pipe + i; \
Kuninori Morimotof1407d52011-04-04 13:44:59 +090058 i < (info)->size; \
59 i++, pos = (info)->pipe + i)
60
61#define usbhs_for_each_pipe(pos, priv, i) \
62 __usbhs_for_each_pipe(1, pos, &((priv)->pipe_info), i)
63
64#define usbhs_for_each_pipe_with_dcp(pos, priv, i) \
65 __usbhs_for_each_pipe(0, pos, &((priv)->pipe_info), i)
66
67/*
Kuninori Morimotoe8d548d2011-06-06 14:18:03 +090068 * data
Kuninori Morimotof1407d52011-04-04 13:44:59 +090069 */
Kuninori Morimotoe8d548d2011-06-06 14:18:03 +090070#define usbhs_priv_to_pipeinfo(pr) (&(pr)->pipe_info)
Kuninori Morimotof1407d52011-04-04 13:44:59 +090071
72/*
Kuninori Morimotof1407d52011-04-04 13:44:59 +090073 * pipe control
74 */
Kuninori Morimoto3cf8ed12011-10-10 22:04:23 -070075char *usbhs_pipe_name(struct usbhs_pipe *pipe);
Kuninori Morimotof1407d52011-04-04 13:44:59 +090076struct usbhs_pipe
Kuninori Morimotof5aa8892011-10-10 21:59:46 -070077*usbhs_pipe_malloc(struct usbhs_priv *priv, int endpoint_type, int dir_in);
Kuninori Morimotoe8d548d2011-06-06 14:18:03 +090078int usbhs_pipe_probe(struct usbhs_priv *priv);
79void usbhs_pipe_remove(struct usbhs_priv *priv);
Kuninori Morimotof1407d52011-04-04 13:44:59 +090080int usbhs_pipe_is_dir_in(struct usbhs_pipe *pipe);
Kuninori Morimotoad6f2a82011-06-06 14:17:56 +090081int usbhs_pipe_is_dir_host(struct usbhs_pipe *pipe);
Kuninori Morimoto4bd04812011-06-06 14:18:07 +090082void usbhs_pipe_init(struct usbhs_priv *priv,
Kuninori Morimotoe73a9892011-06-06 14:19:03 +090083 int (*dma_map_ctrl)(struct usbhs_pkt *pkt, int map));
Kuninori Morimotof1407d52011-04-04 13:44:59 +090084int usbhs_pipe_get_maxpacket(struct usbhs_pipe *pipe);
Kuninori Morimoto08e6c612011-06-09 16:48:25 +090085void usbhs_pipe_clear(struct usbhs_pipe *pipe);
Kuninori Morimotoe8d548d2011-06-06 14:18:03 +090086int usbhs_pipe_is_accessible(struct usbhs_pipe *pipe);
87void usbhs_pipe_enable(struct usbhs_pipe *pipe);
88void usbhs_pipe_disable(struct usbhs_pipe *pipe);
89void usbhs_pipe_stall(struct usbhs_pipe *pipe);
Kuninori Morimoto9cf1b062011-11-24 17:27:32 -080090int usbhs_pipe_is_stall(struct usbhs_pipe *pipe);
Kuninori Morimotod77e3f42011-06-06 14:18:50 +090091void usbhs_pipe_select_fifo(struct usbhs_pipe *pipe, struct usbhs_fifo *fifo);
Kuninori Morimotobc6fbf52011-10-10 22:04:00 -070092void usbhs_pipe_config_update(struct usbhs_pipe *pipe, u16 devsel,
93 u16 epnum, u16 maxp);
Kuninori Morimotof1407d52011-04-04 13:44:59 +090094
Kuninori Morimoto6e6db822011-10-10 22:05:30 -070095#define usbhs_pipe_sequence_data0(pipe) usbhs_pipe_data_sequence(pipe, 0)
96#define usbhs_pipe_sequence_data1(pipe) usbhs_pipe_data_sequence(pipe, 1)
97void usbhs_pipe_data_sequence(struct usbhs_pipe *pipe, int data);
98
Kuninori Morimotoe8d548d2011-06-06 14:18:03 +090099#define usbhs_pipe_to_priv(p) ((p)->priv)
Kuninori Morimotoc89d2612011-04-14 13:57:06 +0900100#define usbhs_pipe_number(p) (int)((p) - (p)->priv->pipe_info.pipe)
Kuninori Morimotoe8d548d2011-06-06 14:18:03 +0900101#define usbhs_pipe_is_dcp(p) ((p)->priv->pipe_info.pipe == (p))
Kuninori Morimotod77e3f42011-06-06 14:18:50 +0900102#define usbhs_pipe_to_fifo(p) ((p)->fifo)
103#define usbhs_pipe_is_busy(p) usbhs_pipe_to_fifo(p)
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900104
Kuninori Morimoto356db7e2011-10-10 22:02:21 -0700105#define usbhs_pipe_type(p) ((p)->pipe_type)
106#define usbhs_pipe_type_is(p, t) ((p)->pipe_type == t)
107
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900108/*
109 * dcp control
110 */
111struct usbhs_pipe *usbhs_dcp_malloc(struct usbhs_priv *priv);
112void usbhs_dcp_control_transfer_done(struct usbhs_pipe *pipe);
Kuninori Morimoto92352072011-10-10 22:02:57 -0700113void usbhs_dcp_dir_for_host(struct usbhs_pipe *pipe, int dir_out);
Kuninori Morimotof1407d52011-04-04 13:44:59 +0900114
115#endif /* RENESAS_USB_PIPE_H */