LXR linux/drivers/usb/renesas

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