drivers/usb/renesas_usbhs/pipe.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_PIPE_H
  18 #define RENESAS_USB_PIPE_H
  19
  20 #include "./common.h"
  21
  22 /*
  23  *      struct
  24  */
  25 struct usbhs_pipe {
  26         u32 pipe_type;  /* USB_ENDPOINT_XFER_xxx */
  27
  28         struct usbhs_priv *priv;
  29
  30         u32 flags;
  31 #define USBHS_PIPE_FLAGS_IS_USED                (1 << 0)
  32 #define USBHS_PIPE_FLAGS_IS_DIR_IN              (1 << 1)
  33 #define USBHS_PIPE_FLAGS_IS_DIR_HOST            (1 << 2)
  34
  35         void *mod_private;
  36 };
  37
  38 struct usbhs_pipe_info {
  39         struct usbhs_pipe *pipe;
  40         int size;       /* array size of "pipe" */
  41         int bufnmb_last;        /* FIXME : driver needs good allocator */
  42 };
  43
  44 /*
  45  * pipe list
  46  */
  47 #define __usbhs_for_each_pipe(start, pos, info, i)      \
  48         for (i = start, pos = (info)->pipe;             \
  49              i < (info)->size;                          \
  50              i++, pos = (info)->pipe + i)
  51
  52 #define usbhs_for_each_pipe(pos, priv, i)                       \
  53         __usbhs_for_each_pipe(1, pos, &((priv)->pipe_info), i)
  54
  55 #define usbhs_for_each_pipe_with_dcp(pos, priv, i)              \
  56         __usbhs_for_each_pipe(0, pos, &((priv)->pipe_info), i)
  57
  58 /*
  59  * pipe module probe / remove
  60  */
  61 int usbhs_pipe_probe(struct usbhs_priv *priv);
  62 void usbhs_pipe_remove(struct usbhs_priv *priv);
  63
  64 /*
  65  * cfifo
  66  */
  67 int usbhs_fifo_write(struct usbhs_pipe *pipe, u8 *buf, int len);
  68 int usbhs_fifo_read(struct usbhs_pipe *pipe, u8 *buf, int len);
  69 int usbhs_fifo_prepare_write(struct usbhs_pipe *pipe);
  70 int usbhs_fifo_prepare_read(struct usbhs_pipe *pipe);
  71
  72 void usbhs_fifo_enable(struct usbhs_pipe *pipe);
  73 void usbhs_fifo_disable(struct usbhs_pipe *pipe);
  74 void usbhs_fifo_stall(struct usbhs_pipe *pipe);
  75
  76 void usbhs_fifo_send_terminator(struct usbhs_pipe *pipe);
  77
  78
  79 /*
  80  * usb request
  81  */
  82 void usbhs_usbreq_get_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req);
  83 void usbhs_usbreq_set_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req);
  84
  85 /*
  86  * pipe control
  87  */
  88 struct usbhs_pipe
  89 *usbhs_pipe_malloc(struct usbhs_priv *priv,
  90                    const struct usb_endpoint_descriptor *desc);
  91
  92 int usbhs_pipe_is_dir_in(struct usbhs_pipe *pipe);
  93 int usbhs_pipe_is_dir_host(struct usbhs_pipe *pipe);
  94 void usbhs_pipe_init(struct usbhs_priv *priv);
  95 int usbhs_pipe_get_maxpacket(struct usbhs_pipe *pipe);
  96 void usbhs_pipe_clear_sequence(struct usbhs_pipe *pipe);
  97
  98 #define usbhs_pipe_number(p)    (int)((p) - (p)->priv->pipe_info.pipe)
  99
 100 /*
 101  * dcp control
 102  */
 103 struct usbhs_pipe *usbhs_dcp_malloc(struct usbhs_priv *priv);
 104 void usbhs_dcp_control_transfer_done(struct usbhs_pipe *pipe);
 105
 106 #endif /* RENESAS_USB_PIPE_H */