1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * gadget.h - DesignWare USB3 DRD Gadget Header 4 * 5 * Copyright (C) 2010-2011 Texas Instruments Incorporated - https://www.ti.com 6 * 7 * Authors: Felipe Balbi <balbi@ti.com>, 8 * Sebastian Andrzej Siewior <bigeasy@linutronix.de> 9 */ 10 11 #ifndef __DRIVERS_USB_DWC3_GADGET_H 12 #define __DRIVERS_USB_DWC3_GADGET_H 13 14 #include <linux/list.h> 15 #include <linux/usb/gadget.h> 16 #include "io.h" 17 18 struct dwc3; 19 #define to_dwc3_ep(ep) (container_of(ep, struct dwc3_ep, endpoint)) 20 #define gadget_to_dwc(g) (dev_get_platdata(&g->dev)) 21 22 /* DEPCFG parameter 1 */ 23 #define DWC3_DEPCFG_INT_NUM(n) (((n) & 0x1f) << 0) 24 #define DWC3_DEPCFG_XFER_COMPLETE_EN BIT(8) 25 #define DWC3_DEPCFG_XFER_IN_PROGRESS_EN BIT(9) 26 #define DWC3_DEPCFG_XFER_NOT_READY_EN BIT(10) 27 #define DWC3_DEPCFG_FIFO_ERROR_EN BIT(11) 28 #define DWC3_DEPCFG_STREAM_EVENT_EN BIT(13) 29 #define DWC3_DEPCFG_EBC_HWO_NOWB BIT(14) 30 #define DWC3_DEPCFG_USE_EBC BIT(15) 31 #define DWC3_DEPCFG_BINTERVAL_M1(n) (((n) & 0xff) << 16) 32 #define DWC3_DEPCFG_STREAM_CAPABLE BIT(24) 33 #define DWC3_DEPCFG_EP_NUMBER(n) (((n) & 0x1f) << 25) 34 #define DWC3_DEPCFG_BULK_BASED BIT(30) 35 #define DWC3_DEPCFG_FIFO_BASED BIT(31) 36 37 /* DEPCFG parameter 0 */ 38 #define DWC3_DEPCFG_EP_TYPE(n) (((n) & 0x3) << 1) 39 #define DWC3_DEPCFG_MAX_PACKET_SIZE(n) (((n) & 0x7ff) << 3) 40 #define DWC3_DEPCFG_FIFO_NUMBER(n) (((n) & 0x1f) << 17) 41 #define DWC3_DEPCFG_BURST_SIZE(n) (((n) & 0xf) << 22) 42 #define DWC3_DEPCFG_DATA_SEQ_NUM(n) ((n) << 26) 43 /* This applies for core versions earlier than 1.94a */ 44 #define DWC3_DEPCFG_IGN_SEQ_NUM BIT(31) 45 /* These apply for core versions 1.94a and later */ 46 #define DWC3_DEPCFG_ACTION_INIT (0 << 30) 47 #define DWC3_DEPCFG_ACTION_RESTORE BIT(30) 48 #define DWC3_DEPCFG_ACTION_MODIFY (2 << 30) 49 50 /* DEPXFERCFG parameter 0 */ 51 #define DWC3_DEPXFERCFG_NUM_XFER_RES(n) ((n) & 0xffff) 52 53 /* U1 Device exit Latency */ 54 #define DWC3_DEFAULT_U1_DEV_EXIT_LAT 0x0A /* Less then 10 microsec */ 55 56 /* U2 Device exit Latency */ 57 #define DWC3_DEFAULT_U2_DEV_EXIT_LAT 0x1FF /* Less then 511 microsec */ 58 59 /* Frame/Microframe Number Mask */ 60 #define DWC3_FRNUMBER_MASK 0x3fff 61 /* -------------------------------------------------------------------------- */ 62 63 #define to_dwc3_request(r) (container_of(r, struct dwc3_request, request)) 64 65 /** 66 * next_request - gets the next request on the given list 67 * @list: the request list to operate on 68 * 69 * Caller should take care of locking. This function return %NULL or the first 70 * request available on @list. 71 */ 72 static inline struct dwc3_request *next_request(struct list_head *list) 73 { 74 return list_first_entry_or_null(list, struct dwc3_request, list); 75 } 76 77 /** 78 * dwc3_gadget_move_started_request - move @req to the started_list 79 * @req: the request to be moved 80 * 81 * Caller should take care of locking. This function will move @req from its 82 * current list to the endpoint's started_list. 83 */ 84 static inline void dwc3_gadget_move_started_request(struct dwc3_request *req) 85 { 86 struct dwc3_ep *dep = req->dep; 87 88 req->status = DWC3_REQUEST_STATUS_STARTED; 89 list_move_tail(&req->list, &dep->started_list); 90 } 91 92 /** 93 * dwc3_gadget_move_cancelled_request - move @req to the cancelled_list 94 * @req: the request to be moved 95 * @reason: cancelled reason for the dwc3 request 96 * 97 * Caller should take care of locking. This function will move @req from its 98 * current list to the endpoint's cancelled_list. 99 */ 100 static inline void dwc3_gadget_move_cancelled_request(struct dwc3_request *req, 101 unsigned int reason) 102 { 103 struct dwc3_ep *dep = req->dep; 104 105 req->status = reason; 106 list_move_tail(&req->list, &dep->cancelled_list); 107 } 108 109 void dwc3_gadget_giveback(struct dwc3_ep *dep, struct dwc3_request *req, 110 int status); 111 112 void dwc3_ep0_interrupt(struct dwc3 *dwc, 113 const struct dwc3_event_depevt *event); 114 void dwc3_ep0_out_start(struct dwc3 *dwc); 115 void dwc3_ep0_end_control_data(struct dwc3 *dwc, struct dwc3_ep *dep); 116 void dwc3_ep0_stall_and_restart(struct dwc3 *dwc); 117 int __dwc3_gadget_ep0_set_halt(struct usb_ep *ep, int value); 118 int dwc3_gadget_ep0_set_halt(struct usb_ep *ep, int value); 119 int dwc3_gadget_ep0_queue(struct usb_ep *ep, struct usb_request *request, 120 gfp_t gfp_flags); 121 int __dwc3_gadget_ep_set_halt(struct dwc3_ep *dep, int value, int protocol); 122 void dwc3_ep0_send_delayed_status(struct dwc3 *dwc); 123 void dwc3_stop_active_transfer(struct dwc3_ep *dep, bool force, bool interrupt); 124 125 /** 126 * dwc3_gadget_ep_get_transfer_index - Gets transfer index from HW 127 * @dep: dwc3 endpoint 128 * 129 * Caller should take care of locking. Returns the transfer resource 130 * index for a given endpoint. 131 */ 132 static inline void dwc3_gadget_ep_get_transfer_index(struct dwc3_ep *dep) 133 { 134 u32 res_id; 135 136 res_id = dwc3_readl(dep->regs, DWC3_DEPCMD); 137 dep->resource_index = DWC3_DEPCMD_GET_RSC_IDX(res_id); 138 } 139 140 /** 141 * dwc3_gadget_dctl_write_safe - write to DCTL safe from link state change 142 * @dwc: pointer to our context structure 143 * @value: value to write to DCTL 144 * 145 * Use this function when doing read-modify-write to DCTL. It will not 146 * send link state change request. 147 */ 148 static inline void dwc3_gadget_dctl_write_safe(struct dwc3 *dwc, u32 value) 149 { 150 value &= ~DWC3_DCTL_ULSTCHNGREQ_MASK; 151 dwc3_writel(dwc->regs, DWC3_DCTL, value); 152 } 153 154 #endif /* __DRIVERS_USB_DWC3_GADGET_H */ 155