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  * data
  60  */
  61 #define usbhs_priv_to_pipeinfo(pr)      (&(pr)->pipe_info)
  62
  63 /*
  64  * usb request
  65  */
  66 void usbhs_usbreq_get_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req);
  67 void usbhs_usbreq_set_val(struct usbhs_priv *priv, struct usb_ctrlrequest *req);
  68
  69 /*
  70  * pipe control
  71  */
  72 struct usbhs_pipe
  73 *usbhs_pipe_malloc(struct usbhs_priv *priv,
  74                    const struct usb_endpoint_descriptor *desc);
  75 int usbhs_pipe_probe(struct usbhs_priv *priv);
  76 void usbhs_pipe_remove(struct usbhs_priv *priv);
  77 int usbhs_pipe_is_dir_in(struct usbhs_pipe *pipe);
  78 int usbhs_pipe_is_dir_host(struct usbhs_pipe *pipe);
  79 void usbhs_pipe_init(struct usbhs_priv *priv);
  80 int usbhs_pipe_get_maxpacket(struct usbhs_pipe *pipe);
  81 void usbhs_pipe_clear_sequence(struct usbhs_pipe *pipe);
  82 int usbhs_pipe_is_accessible(struct usbhs_pipe *pipe);
  83 void usbhs_pipe_enable(struct usbhs_pipe *pipe);
  84 void usbhs_pipe_disable(struct usbhs_pipe *pipe);
  85 void usbhs_pipe_stall(struct usbhs_pipe *pipe);
  86
  87 #define usbhs_pipe_to_priv(p)   ((p)->priv)
  88 #define usbhs_pipe_number(p)    (int)((p) - (p)->priv->pipe_info.pipe)
  89 #define usbhs_pipe_is_dcp(p)    ((p)->priv->pipe_info.pipe == (p))
  90
  91 /*
  92  * dcp control
  93  */
  94 struct usbhs_pipe *usbhs_dcp_malloc(struct usbhs_priv *priv);
  95 void usbhs_dcp_control_transfer_done(struct usbhs_pipe *pipe);
  96
  97 #endif /* RENESAS_USB_PIPE_H */