LXR linux/drivers/usb/dwc3/gadget.h

   1/*
   2 * gadget.h - DesignWare USB3 DRD Gadget Header
   3 *
   4 * Copyright (C) 2010-2011 Texas Instruments Incorporated - http://www.ti.com
   5 *
   6 * Authors: Felipe Balbi <balbi@ti.com>,
   7 *          Sebastian Andrzej Siewior <bigeasy@linutronix.de>
   8 *
   9 * This program is free software: you can redistribute it and/or modify
  10 * it under the terms of the GNU General Public License version 2  of
  11 * the License as published by the Free Software Foundation.
  12 *
  13 * This program is distributed in the hope that it will be useful,
  14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 * GNU General Public License for more details.
  17 */
  18
  19#ifndef __DRIVERS_USB_DWC3_GADGET_H
  20#define __DRIVERS_USB_DWC3_GADGET_H
  21
  22#include <linux/list.h>
  23#include <linux/usb/gadget.h>
  24#include "io.h"
  25
  26struct dwc3;
  27#define to_dwc3_ep(ep)          (container_of(ep, struct dwc3_ep, endpoint))
  28#define gadget_to_dwc(g)        (container_of(g, struct dwc3, gadget))
  29
  30/* DEPCFG parameter 1 */
  31#define DWC3_DEPCFG_INT_NUM(n)          (((n) & 0x1f) << 0)
  32#define DWC3_DEPCFG_XFER_COMPLETE_EN    BIT(8)
  33#define DWC3_DEPCFG_XFER_IN_PROGRESS_EN BIT(9)
  34#define DWC3_DEPCFG_XFER_NOT_READY_EN   BIT(10)
  35#define DWC3_DEPCFG_FIFO_ERROR_EN       BIT(11)
  36#define DWC3_DEPCFG_STREAM_EVENT_EN     BIT(12)
  37#define DWC3_DEPCFG_BINTERVAL_M1(n)     (((n) & 0xff) << 16)
  38#define DWC3_DEPCFG_STREAM_CAPABLE      BIT(24)
  39#define DWC3_DEPCFG_EP_NUMBER(n)        (((n) & 0x1f) << 25)
  40#define DWC3_DEPCFG_BULK_BASED          BIT(30)
  41#define DWC3_DEPCFG_FIFO_BASED          BIT(31)
  42
  43/* DEPCFG parameter 0 */
  44#define DWC3_DEPCFG_EP_TYPE(n)          (((n) & 0x3) << 1)
  45#define DWC3_DEPCFG_MAX_PACKET_SIZE(n)  (((n) & 0x7ff) << 3)
  46#define DWC3_DEPCFG_FIFO_NUMBER(n)      (((n) & 0x1f) << 17)
  47#define DWC3_DEPCFG_BURST_SIZE(n)       (((n) & 0xf) << 22)
  48#define DWC3_DEPCFG_DATA_SEQ_NUM(n)     ((n) << 26)
  49/* This applies for core versions earlier than 1.94a */
  50#define DWC3_DEPCFG_IGN_SEQ_NUM         BIT(31)
  51/* These apply for core versions 1.94a and later */
  52#define DWC3_DEPCFG_ACTION_INIT         (0 << 30)
  53#define DWC3_DEPCFG_ACTION_RESTORE      BIT(30)
  54#define DWC3_DEPCFG_ACTION_MODIFY       (2 << 30)
  55
  56/* DEPXFERCFG parameter 0 */
  57#define DWC3_DEPXFERCFG_NUM_XFER_RES(n) ((n) & 0xffff)
  58
  59/* -------------------------------------------------------------------------- */
  60
  61#define to_dwc3_request(r)      (container_of(r, struct dwc3_request, request))
  62
  63/**
  64 * next_request - gets the next request on the given list
  65 * @list: the request list to operate on
  66 *
  67 * Caller should take care of locking. This function return %NULL or the first
  68 * request available on @list.
  69 */
  70static inline struct dwc3_request *next_request(struct list_head *list)
  71{
  72        return list_first_entry_or_null(list, struct dwc3_request, list);
  73}
  74
  75/**
  76 * dwc3_gadget_move_started_request - move @req to the started_list
  77 * @req: the request to be moved
  78 *
  79 * Caller should take care of locking. This function will move @req from its
  80 * current list to the endpoint's started_list.
  81 */
  82static inline void dwc3_gadget_move_started_request(struct dwc3_request *req)
  83{
  84        struct dwc3_ep          *dep = req->dep;
  85
  86        req->started = true;
  87        list_move_tail(&req->list, &dep->started_list);
  88}
  89
  90void dwc3_gadget_giveback(struct dwc3_ep *dep, struct dwc3_request *req,
  91                int status);
  92
  93void dwc3_ep0_interrupt(struct dwc3 *dwc,
  94                const struct dwc3_event_depevt *event);
  95void dwc3_ep0_out_start(struct dwc3 *dwc);
  96int __dwc3_gadget_ep0_set_halt(struct usb_ep *ep, int value);
  97int dwc3_gadget_ep0_set_halt(struct usb_ep *ep, int value);
  98int dwc3_gadget_ep0_queue(struct usb_ep *ep, struct usb_request *request,
  99                gfp_t gfp_flags);
 100int __dwc3_gadget_ep_set_halt(struct dwc3_ep *dep, int value, int protocol);
 101
 102/**
 103 * dwc3_gadget_ep_get_transfer_index - Gets transfer index from HW
 104 * @dep: dwc3 endpoint
 105 *
 106 * Caller should take care of locking. Returns the transfer resource
 107 * index for a given endpoint.
 108 */
 109static inline u32 dwc3_gadget_ep_get_transfer_index(struct dwc3_ep *dep)
 110{
 111        u32                     res_id;
 112
 113        res_id = dwc3_readl(dep->regs, DWC3_DEPCMD);
 114
 115        return DWC3_DEPCMD_GET_RSC_IDX(res_id);
 116}
 117
 118#endif /* __DRIVERS_USB_DWC3_GADGET_H */
 119