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 26 struct 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) << 0) 32 #define DWC3_DEPCFG_XFER_COMPLETE_EN (1 << 8) 33 #define DWC3_DEPCFG_XFER_IN_PROGRESS_EN (1 << 9) 34 #define DWC3_DEPCFG_XFER_NOT_READY_EN (1 << 10) 35 #define DWC3_DEPCFG_FIFO_ERROR_EN (1 << 11) 36 #define DWC3_DEPCFG_STREAM_EVENT_EN (1 << 13) 37 #define DWC3_DEPCFG_BINTERVAL_M1(n) ((n) << 16) 38 #define DWC3_DEPCFG_STREAM_CAPABLE (1 << 24) 39 #define DWC3_DEPCFG_EP_NUMBER(n) ((n) << 25) 40 #define DWC3_DEPCFG_BULK_BASED (1 << 30) 41 #define DWC3_DEPCFG_FIFO_BASED (1 << 31) 42 43 /* DEPCFG parameter 0 */ 44 #define DWC3_DEPCFG_EP_TYPE(n) ((n) << 1) 45 #define DWC3_DEPCFG_MAX_PACKET_SIZE(n) ((n) << 3) 46 #define DWC3_DEPCFG_FIFO_NUMBER(n) ((n) << 17) 47 #define DWC3_DEPCFG_BURST_SIZE(n) ((n) << 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 (1 << 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 (1 << 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 static inline struct dwc3_request *next_request(struct list_head *list) 64 { 65 if (list_empty(list)) 66 return NULL; 67 68 return list_first_entry(list, struct dwc3_request, list); 69 } 70 71 static inline void dwc3_gadget_move_request_queued(struct dwc3_request *req) 72 { 73 struct dwc3_ep *dep = req->dep; 74 75 req->queued = true; 76 list_move_tail(&req->list, &dep->req_queued); 77 } 78 79 void dwc3_gadget_giveback(struct dwc3_ep *dep, struct dwc3_request *req, 80 int status); 81 82 void dwc3_ep0_interrupt(struct dwc3 *dwc, 83 const struct dwc3_event_depevt *event); 84 void dwc3_ep0_out_start(struct dwc3 *dwc); 85 int dwc3_gadget_ep0_set_halt(struct usb_ep *ep, int value); 86 int dwc3_gadget_ep0_queue(struct usb_ep *ep, struct usb_request *request, 87 gfp_t gfp_flags); 88 int __dwc3_gadget_ep_set_halt(struct dwc3_ep *dep, int value); 89 90 /** 91 * dwc3_gadget_ep_get_transfer_index - Gets transfer index from HW 92 * @dwc: DesignWare USB3 Pointer 93 * @number: DWC endpoint number 94 * 95 * Caller should take care of locking 96 */ 97 static inline u32 dwc3_gadget_ep_get_transfer_index(struct dwc3 *dwc, u8 number) 98 { 99 u32 res_id; 100 101 res_id = dwc3_readl(dwc->regs, DWC3_DEPCMD(number)); 102 103 return DWC3_DEPCMD_GET_RSC_IDX(res_id); 104 } 105 106 /** 107 * dwc3_gadget_event_string - returns event name 108 * @event: the event code 109 */ 110 static inline const char *dwc3_gadget_event_string(u8 event) 111 { 112 switch (event) { 113 case DWC3_DEVICE_EVENT_DISCONNECT: 114 return "Disconnect"; 115 case DWC3_DEVICE_EVENT_RESET: 116 return "Reset"; 117 case DWC3_DEVICE_EVENT_CONNECT_DONE: 118 return "Connection Done"; 119 case DWC3_DEVICE_EVENT_LINK_STATUS_CHANGE: 120 return "Link Status Change"; 121 case DWC3_DEVICE_EVENT_WAKEUP: 122 return "WakeUp"; 123 case DWC3_DEVICE_EVENT_EOPF: 124 return "End-Of-Frame"; 125 case DWC3_DEVICE_EVENT_SOF: 126 return "Start-Of-Frame"; 127 case DWC3_DEVICE_EVENT_ERRATIC_ERROR: 128 return "Erratic Error"; 129 case DWC3_DEVICE_EVENT_CMD_CMPL: 130 return "Command Complete"; 131 case DWC3_DEVICE_EVENT_OVERFLOW: 132 return "Overflow"; 133 } 134 135 return "UNKNOWN"; 136 } 137 138 /** 139 * dwc3_ep_event_string - returns event name 140 * @event: then event code 141 */ 142 static inline const char *dwc3_ep_event_string(u8 event) 143 { 144 switch (event) { 145 case DWC3_DEPEVT_XFERCOMPLETE: 146 return "Transfer Complete"; 147 case DWC3_DEPEVT_XFERINPROGRESS: 148 return "Transfer In-Progress"; 149 case DWC3_DEPEVT_XFERNOTREADY: 150 return "Transfer Not Ready"; 151 case DWC3_DEPEVT_RXTXFIFOEVT: 152 return "FIFO"; 153 case DWC3_DEPEVT_STREAMEVT: 154 return "Stream"; 155 case DWC3_DEPEVT_EPCMDCMPLT: 156 return "Endpoint Command Complete"; 157 } 158 159 return "UNKNOWN"; 160 } 161 162 #endif /* __DRIVERS_USB_DWC3_GADGET_H */ 163