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 - http://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) (container_of(g, struct dwc3, gadget)) 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_BINTERVAL_M1(n) (((n) & 0xff) << 16) 30 #define DWC3_DEPCFG_STREAM_CAPABLE BIT(24) 31 #define DWC3_DEPCFG_EP_NUMBER(n) (((n) & 0x1f) << 25) 32 #define DWC3_DEPCFG_BULK_BASED BIT(30) 33 #define DWC3_DEPCFG_FIFO_BASED BIT(31) 34 35 /* DEPCFG parameter 0 */ 36 #define DWC3_DEPCFG_EP_TYPE(n) (((n) & 0x3) << 1) 37 #define DWC3_DEPCFG_MAX_PACKET_SIZE(n) (((n) & 0x7ff) << 3) 38 #define DWC3_DEPCFG_FIFO_NUMBER(n) (((n) & 0x1f) << 17) 39 #define DWC3_DEPCFG_BURST_SIZE(n) (((n) & 0xf) << 22) 40 #define DWC3_DEPCFG_DATA_SEQ_NUM(n) ((n) << 26) 41 /* This applies for core versions earlier than 1.94a */ 42 #define DWC3_DEPCFG_IGN_SEQ_NUM BIT(31) 43 /* These apply for core versions 1.94a and later */ 44 #define DWC3_DEPCFG_ACTION_INIT (0 << 30) 45 #define DWC3_DEPCFG_ACTION_RESTORE BIT(30) 46 #define DWC3_DEPCFG_ACTION_MODIFY (2 << 30) 47 48 /* DEPXFERCFG parameter 0 */ 49 #define DWC3_DEPXFERCFG_NUM_XFER_RES(n) ((n) & 0xffff) 50 51 /* -------------------------------------------------------------------------- */ 52 53 #define to_dwc3_request(r) (container_of(r, struct dwc3_request, request)) 54 55 /** 56 * next_request - gets the next request on the given list 57 * @list: the request list to operate on 58 * 59 * Caller should take care of locking. This function return %NULL or the first 60 * request available on @list. 61 */ 62 static inline struct dwc3_request *next_request(struct list_head *list) 63 { 64 return list_first_entry_or_null(list, struct dwc3_request, list); 65 } 66 67 /** 68 * dwc3_gadget_move_started_request - move @req to the started_list 69 * @req: the request to be moved 70 * 71 * Caller should take care of locking. This function will move @req from its 72 * current list to the endpoint's started_list. 73 */ 74 static inline void dwc3_gadget_move_started_request(struct dwc3_request *req) 75 { 76 struct dwc3_ep *dep = req->dep; 77 78 req->status = DWC3_REQUEST_STATUS_STARTED; 79 list_move_tail(&req->list, &dep->started_list); 80 } 81 82 /** 83 * dwc3_gadget_move_cancelled_request - move @req to the cancelled_list 84 * @req: the request to be moved 85 * 86 * Caller should take care of locking. This function will move @req from its 87 * current list to the endpoint's cancelled_list. 88 */ 89 static inline void dwc3_gadget_move_cancelled_request(struct dwc3_request *req) 90 { 91 struct dwc3_ep *dep = req->dep; 92 93 req->status = DWC3_REQUEST_STATUS_CANCELLED; 94 list_move_tail(&req->list, &dep->cancelled_list); 95 } 96 97 void dwc3_gadget_giveback(struct dwc3_ep *dep, struct dwc3_request *req, 98 int status); 99 100 void dwc3_ep0_interrupt(struct dwc3 *dwc, 101 const struct dwc3_event_depevt *event); 102 void dwc3_ep0_out_start(struct dwc3 *dwc); 103 int __dwc3_gadget_ep0_set_halt(struct usb_ep *ep, int value); 104 int dwc3_gadget_ep0_set_halt(struct usb_ep *ep, int value); 105 int dwc3_gadget_ep0_queue(struct usb_ep *ep, struct usb_request *request, 106 gfp_t gfp_flags); 107 int __dwc3_gadget_ep_set_halt(struct dwc3_ep *dep, int value, int protocol); 108 109 /** 110 * dwc3_gadget_ep_get_transfer_index - Gets transfer index from HW 111 * @dep: dwc3 endpoint 112 * 113 * Caller should take care of locking. Returns the transfer resource 114 * index for a given endpoint. 115 */ 116 static inline void dwc3_gadget_ep_get_transfer_index(struct dwc3_ep *dep) 117 { 118 u32 res_id; 119 120 res_id = dwc3_readl(dep->regs, DWC3_DEPCMD); 121 dep->resource_index = DWC3_DEPCMD_GET_RSC_IDX(res_id); 122 } 123 124 #endif /* __DRIVERS_USB_DWC3_GADGET_H */ 125