| Message ID | 1550173514-23573-7-git-send-email-pawell@cadence.com (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | Introduced new Cadence USBSS DRD Driver. | expand |
Pawel, On 14/02/2019 21:45, Pawel Laszczak wrote: > Controller for OUT endpoints has shared on-chip buffers for all incoming > packets, including ep0out. It's FIFO buffer, so packets must be handle > by DMA in correct order. If the first packet in the buffer will not be > handled, then the following packets directed for other endpoints and > functions will be blocked. > > Additionally the packets directed to one endpoint can block entire on-chip > buffers. In this case transfer to other endpoints also will blocked. > > To resolve this issue after raising the descriptor missing interrupt > driver prepares internal usb_request object and use it to arm DMA > transfer. > > The problematic situation was observed in case when endpoint has > been enabled but no usb_request were queued. Driver try detects > such endpoints and will use this workaround only for these endpoint. > > Driver use limited number of buffer. This number can be set by macro > CDNS_WA2_NUM_BUFFERS. > > Such blocking situation was observed on ACM gadget. For this function > host send OUT data packet but ACM function is not prepared for > this packet. It's cause that buffer placed in on chip memory block > transfer to other endpoints. > > It's limitation of controller but maybe this issues should be fixed in > function driver. > > This work around can be disabled/enabled by means of quirk_internal_buffer > module parameter. By default feature is enabled. It can has impact to > transfer performance and in most case this feature can be disabled. How much is the performance impact? You mentioned that the issue was observed only in the ACM case and could be fixed in the function driver? It seems pointless to enable an endpoint and not have any requests queued for it. Isn't fixing the ACM driver (if there is a real issue) a better approach than having a workaround that affects performance of all other use cases? cheers, -roger > > Signed-off-by: Pawel Laszczak <pawell@cadence.com> > --- > drivers/usb/cdns3/gadget.c | 273 ++++++++++++++++++++++++++++++++++++- > drivers/usb/cdns3/gadget.h | 7 + > 2 files changed, 278 insertions(+), 2 deletions(-) > > diff --git a/drivers/usb/cdns3/gadget.c b/drivers/usb/cdns3/gadget.c > index 7f7f24ee3c4b..5dfbe6e1421c 100644 > --- a/drivers/usb/cdns3/gadget.c > +++ b/drivers/usb/cdns3/gadget.c > @@ -27,6 +27,37 @@ > * If (((Dequeue Ptr (i.e. EP_TRADDR) == Enqueue Ptr-1) or > * (Dequeue Ptr (i.e. EP_TRADDR) == Enqueue Ptr)) > * and (DRBL==1 and (not EP0))) > + * > + * Work around 2: > + * Controller for OUT endpoints has shared on-chip buffers for all incoming > + * packets, including ep0out. It's FIFO buffer, so packets must be handle by DMA > + * in correct order. If the first packet in the buffer will not be handled, > + * then the following packets directed for other endpoints and functions > + * will be blocked. > + * Additionally the packets directed to one endpoint can block entire on-chip > + * buffers. In this case transfer to other endpoints also will blocked. > + * > + * To resolve this issue after raising the descriptor missing interrupt > + * driver prepares internal usb_request object and use it to arm DMA transfer. > + * > + * The problematic situation was observed in case when endpoint has been enabled > + * but no usb_request were queued. Driver try detects such endpoints and will > + * use this workaround only for these endpoint. > + * > + * Driver use limited number of buffer. This number can be set by macro > + * CDNS_WA2_NUM_BUFFERS. > + * > + * Such blocking situation was observed on ACM gadget. For this function > + * host send OUT data packet but ACM function is not prepared for this packet. > + * It's cause that buffer placed in on chip memory block transfer to other > + * endpoints. > + * > + * It's limitation of controller but maybe this issues should be fixed in > + * function driver. > + * > + * This work around can be disabled/enabled by means of quirk_internal_buffer > + * module parameter. By default feature is enabled. It can has impact to > + * transfer performance and in most case this feature can be disabled. > */ > > #include <linux/dma-mapping.h> > @@ -42,6 +73,14 @@ static int __cdns3_gadget_ep_queue(struct usb_ep *ep, > struct usb_request *request, > gfp_t gfp_flags); > > +/* > + * Parameter allows to disable/enable handling of work around 2 feature. > + * By default this value is enabled. > + */ > +static bool quirk_internal_buffer = 1; > +module_param(quirk_internal_buffer, bool, 0644); > +MODULE_PARM_DESC(quirk_internal_buffer, "Disable/enable WA2 algorithm"); > + > /** > * cdns3_handshake - spin reading until handshake completes or fails > * @ptr: address of device controller register to be read > @@ -105,6 +144,17 @@ struct usb_request *cdns3_next_request(struct list_head *list) > return list_first_entry_or_null(list, struct usb_request, list); > } > > +/** > + * cdns3_next_priv_request - returns next request from list > + * @list: list containing requests > + * > + * Returns request or NULL if no requests in list > + */ > +struct cdns3_request *cdns3_next_priv_request(struct list_head *list) > +{ > + return list_first_entry_or_null(list, struct cdns3_request, list); > +} > + > /** > * select_ep - selects endpoint > * @priv_dev: extended gadget object > @@ -384,6 +434,53 @@ static int cdns3_start_all_request(struct cdns3_device *priv_dev, > return ret; > } > > +/** > + * cdns3_descmiss_copy_data copy data from internal requests to request queued > + * by class driver. > + * @priv_ep: extended endpoint object > + * @request: request object > + */ > +static void cdns3_descmiss_copy_data(struct cdns3_endpoint *priv_ep, > + struct usb_request *request) > +{ > + struct usb_request *descmiss_req; > + struct cdns3_request *descmiss_priv_req; > + > + while (!list_empty(&priv_ep->descmiss_req_list)) { > + int chunk_end; > + int length; > + > + descmiss_priv_req = > + cdns3_next_priv_request(&priv_ep->descmiss_req_list); > + descmiss_req = &descmiss_priv_req->request; > + > + /* driver can't touch pending request */ > + if (descmiss_priv_req->flags & REQUEST_PENDING) > + break; > + > + chunk_end = descmiss_priv_req->flags & REQUEST_INTERNAL_CH; > + length = request->actual + descmiss_req->actual; > + > + if (length <= request->length) { > + memcpy(&((u8 *)request->buf)[request->actual], > + descmiss_req->buf, > + descmiss_req->actual); > + request->actual = length; > + } else { > + /* It should never occures */ > + request->status = -ENOMEM; > + } > + > + list_del_init(&descmiss_priv_req->list); > + > + kfree(descmiss_req->buf); > + cdns3_gadget_ep_free_request(&priv_ep->endpoint, descmiss_req); > + > + if (!chunk_end) > + break; > + } > +} > + > /** > * cdns3_gadget_giveback - call struct usb_request's ->complete callback > * @priv_ep: The endpoint to whom the request belongs to > @@ -412,6 +509,32 @@ void cdns3_gadget_giveback(struct cdns3_endpoint *priv_ep, > priv_req->flags &= ~REQUEST_PENDING; > trace_cdns3_gadget_giveback(priv_req); > > + /* WA2: */ > + if (priv_ep->flags & EP_QUIRK_EXTRA_BUF_EN && > + priv_req->flags & REQUEST_INTERNAL) { > + struct usb_request *req; > + > + req = cdns3_next_request(&priv_ep->deferred_req_list); > + request = req; > + priv_ep->descmis_req = NULL; > + > + if (!req) > + return; > + > + cdns3_descmiss_copy_data(priv_ep, req); > + if (!(priv_ep->flags & EP_QUIRK_END_TRANSFER) && > + req->length != req->actual) { > + /* wait for next part of transfer */ > + return; > + } > + > + if (req->status == -EINPROGRESS) > + req->status = 0; > + > + list_del_init(&req->list); > + cdns3_start_all_request(priv_dev, priv_ep); > + } > + > /* Start all not pending request */ > if (priv_ep->flags & EP_RING_FULL) > cdns3_start_all_request(priv_dev, priv_ep); > @@ -774,6 +897,59 @@ void cdns3_rearm_transfer(struct cdns3_endpoint *priv_ep, u8 rearm) > } > } > > +/** > + * cdns3_descmissing_packet - handles descriptor missing event. > + * @priv_dev: extended gadget object > + * > + * This function is used only for WA2. For more information see Work around 2 > + * description. > + */ > +static int cdns3_descmissing_packet(struct cdns3_endpoint *priv_ep) > +{ > + struct cdns3_request *priv_req; > + struct usb_request *request; > + > + if (priv_ep->flags & EP_QUIRK_EXTRA_BUF_DET) { > + priv_ep->flags &= ~EP_QUIRK_EXTRA_BUF_DET; > + priv_ep->flags |= EP_QUIRK_EXTRA_BUF_EN; > + } > + > + cdns3_dbg(priv_ep->cdns3_dev, "WA2: Description Missing detected\n"); > + > + request = cdns3_gadget_ep_alloc_request(&priv_ep->endpoint, > + GFP_ATOMIC); > + if (!request) > + return -ENOMEM; > + > + priv_req = to_cdns3_request(request); > + priv_req->flags |= REQUEST_INTERNAL; > + > + /* if this field is still assigned it indicate that transfer related > + * with this request has not been finished yet. Driver in this > + * case simply allocate next request and assign flag REQUEST_INTERNAL_CH > + * flag to previous one. It will indicate that current request is > + * part of the previous one. > + */ > + if (priv_ep->descmis_req) > + priv_ep->descmis_req->flags |= REQUEST_INTERNAL_CH; > + > + priv_req->request.buf = kzalloc(CDNS3_DESCMIS_BUF_SIZE, > + GFP_ATOMIC); > + if (!priv_req) { > + cdns3_gadget_ep_free_request(&priv_ep->endpoint, request); > + return -ENOMEM; > + } > + > + priv_req->request.length = CDNS3_DESCMIS_BUF_SIZE; > + priv_ep->descmis_req = priv_req; > + > + __cdns3_gadget_ep_queue(&priv_ep->endpoint, > + &priv_ep->descmis_req->request, > + GFP_ATOMIC); > + > + return 0; > +} > + > /** > * cdns3_check_ep_interrupt_proceed - Processes interrupt related to endpoint > * @priv_ep: endpoint object > @@ -807,8 +983,31 @@ static int cdns3_check_ep_interrupt_proceed(struct cdns3_endpoint *priv_ep) > cdns3_rearm_transfer(priv_ep, priv_ep->wa1_set); > } > > - if ((ep_sts_reg & EP_STS_IOC) || (ep_sts_reg & EP_STS_ISP)) > + if ((ep_sts_reg & EP_STS_IOC) || (ep_sts_reg & EP_STS_ISP)) { > + if (priv_ep->flags & EP_QUIRK_EXTRA_BUF_EN) { > + if (ep_sts_reg & EP_STS_ISP) > + priv_ep->flags |= EP_QUIRK_END_TRANSFER; > + else > + priv_ep->flags &= ~EP_QUIRK_END_TRANSFER; > + } > + > cdns3_transfer_completed(priv_dev, priv_ep); > + } > + > + /* > + * WA2: this condition should only be meet when > + * priv_ep->flags & EP_QUIRK_EXTRA_BUF_DET or > + * priv_ep->flags & EP_QUIRK_EXTRA_BUF_EN. > + * In other cases this interrupt will be disabled/ > + */ > + if (ep_sts_reg & EP_STS_DESCMIS) { > + int err; > + > + err = cdns3_descmissing_packet(priv_ep); > + if (err) > + dev_err(priv_dev->dev, > + "Failed: No sufficient memory for DESCMIS\n"); > + } > > return 0; > } > @@ -1241,13 +1440,26 @@ static int cdns3_gadget_ep_enable(struct usb_ep *ep, > /* enable interrupt for selected endpoint */ > cdns3_set_register_bit(&priv_dev->regs->ep_ien, > BIT(cdns3_ep_addr_to_index(bEndpointAddress))); > + /* > + * WA2: Set flag for all not ISOC OUT endpoints. If this flag is set > + * driver try to detect whether endpoint need additional internal > + * buffer for unblocking on-chip FIFO buffer. This flag will be cleared > + * if before first DESCMISS interrupt the DMA will be armed. > + */ > + if (quirk_internal_buffer) { > + if (!priv_ep->dir && priv_ep->type != USB_ENDPOINT_XFER_ISOC) { > + priv_ep->flags |= EP_QUIRK_EXTRA_BUF_DET; > + reg |= EP_STS_EN_DESCMISEN; > + } > + } > > writel(reg, &priv_dev->regs->ep_sts_en); > > cdns3_set_register_bit(&priv_dev->regs->ep_cfg, EP_CFG_ENABLE); > > ep->desc = desc; > - priv_ep->flags &= ~(EP_PENDING_REQUEST | EP_STALL); > + priv_ep->flags &= ~(EP_PENDING_REQUEST | EP_STALL | > + EP_QUIRK_EXTRA_BUF_EN); > priv_ep->flags |= EP_ENABLED | EP_UPDATE_EP_TRBADDR; > priv_ep->wa1_set = 0; > priv_ep->enqueue = 0; > @@ -1272,6 +1484,7 @@ static int cdns3_gadget_ep_enable(struct usb_ep *ep, > static int cdns3_gadget_ep_disable(struct usb_ep *ep) > { > struct cdns3_endpoint *priv_ep; > + struct cdns3_request *priv_req; > struct cdns3_device *priv_dev; > struct usb_request *request; > unsigned long flags; > @@ -1308,6 +1521,14 @@ static int cdns3_gadget_ep_disable(struct usb_ep *ep) > -ESHUTDOWN); > } > > + while (!list_empty(&priv_ep->descmiss_req_list)) { > + priv_req = cdns3_next_priv_request(&priv_ep->descmiss_req_list); > + > + kfree(priv_req->request.buf); > + cdns3_gadget_ep_free_request(&priv_ep->endpoint, > + &priv_req->request); > + } > + > while (!list_empty(&priv_ep->deferred_req_list)) { > request = cdns3_next_request(&priv_ep->deferred_req_list); > > @@ -1348,6 +1569,53 @@ static int __cdns3_gadget_ep_queue(struct usb_ep *ep, > priv_req = to_cdns3_request(request); > trace_cdns3_ep_queue(priv_req); > > + /* > + * WA2: if transfer was queued before DESCMISS appear than we > + * can disable handling of DESCMISS interrupt. Driver assumes that it > + * can disable special treatment for this endpoint. > + */ > + if (priv_ep->flags & EP_QUIRK_EXTRA_BUF_DET) { > + u32 reg; > + > + cdns3_select_ep(priv_dev, priv_ep->num | priv_ep->dir); > + priv_ep->flags &= ~EP_QUIRK_EXTRA_BUF_DET; > + reg = readl(&priv_dev->regs->ep_sts_en); > + reg &= ~EP_STS_EN_DESCMISEN; > + writel(reg, &priv_dev->regs->ep_sts_en); > + } > + > + /* WA2 */ > + if (priv_ep->flags & EP_QUIRK_EXTRA_BUF_EN) { > + u8 pending_empty = list_empty(&priv_ep->pending_req_list); > + u8 descmiss_empty = list_empty(&priv_ep->descmiss_req_list); > + > + /* > + * DESCMISS transfer has been finished, so data will be > + * directly copied from internal allocated usb_request > + * objects. > + */ > + if (pending_empty && !descmiss_empty && > + !(priv_req->flags & REQUEST_INTERNAL)) { > + cdns3_descmiss_copy_data(priv_ep, request); > + list_add_tail(&request->list, > + &priv_ep->pending_req_list); > + cdns3_gadget_giveback(priv_ep, priv_req, > + request->status); > + return ret; > + } > + > + /* > + * WA2 driver will wait for completion DESCMISS transfer, > + * before starts new, not DESCMISS transfer. > + */ > + if (!pending_empty && !descmiss_empty) > + deferred = 1; > + > + if (priv_req->flags & REQUEST_INTERNAL) > + list_add_tail(&priv_req->list, > + &priv_ep->descmiss_req_list); > + } > + > ret = usb_gadget_map_request_by_dev(priv_dev->sysdev, request, > usb_endpoint_dir_in(ep->desc)); > if (ret) > @@ -1782,6 +2050,7 @@ static int cdns3_init_eps(struct cdns3_device *priv_dev) > > INIT_LIST_HEAD(&priv_ep->pending_req_list); > INIT_LIST_HEAD(&priv_ep->deferred_req_list); > + INIT_LIST_HEAD(&priv_ep->descmiss_req_list); > } > > return 0; > diff --git a/drivers/usb/cdns3/gadget.h b/drivers/usb/cdns3/gadget.h > index 817f8ae7a4da..8de733b315e9 100644 > --- a/drivers/usb/cdns3/gadget.h > +++ b/drivers/usb/cdns3/gadget.h > @@ -1000,6 +1000,7 @@ struct cdns3_device; > * @endpoint: usb endpoint > * @pending_req_list: list of requests queuing on transfer ring. > * @deferred_req_list: list of requests waiting for queuing on transfer ring. > + * @descmiss_req_list: list of requests internally allocated by driver (WA2). > * @trb_pool: transfer ring - array of transaction buffers > * @trb_pool_dma: dma address of transfer ring > * @cdns3_dev: device associated with this endpoint > @@ -1026,6 +1027,7 @@ struct cdns3_endpoint { > struct usb_ep endpoint; > struct list_head pending_req_list; > struct list_head deferred_req_list; > + struct list_head descmiss_req_list; > > struct cdns3_trb *trb_pool; > dma_addr_t trb_pool_dma; > @@ -1041,6 +1043,9 @@ struct cdns3_endpoint { > #define EP_PENDING_REQUEST BIT(5) > #define EP_RING_FULL BIT(6) > #define EP_CLAIMED BIT(7) > +#define EP_QUIRK_EXTRA_BUF_DET BIT(8) > +#define EP_QUIRK_EXTRA_BUF_EN BIT(9) > +#define EP_QUIRK_END_TRANSFER BIT(10) > > u32 flags; > > @@ -1074,6 +1079,7 @@ struct cdns3_endpoint { > * @start_trb: number of the first TRB in transfer ring > * @end_trb: number of the last TRB in transfer ring > * @flags: flag specifying special usage of request > + * @list: used by internally allocated request to add to descmiss_req_list. > */ > struct cdns3_request { > struct usb_request request; > @@ -1086,6 +1092,7 @@ struct cdns3_request { > #define REQUEST_INTERNAL_CH BIT(2) > #define REQUEST_ZLP BIT(3) > u32 flags; > + struct list_head list; > }; > > #define to_cdns3_request(r) (container_of(r, struct cdns3_request, request)) >
Hi Roger. > >On 14/02/2019 21:45, Pawel Laszczak wrote: >> Controller for OUT endpoints has shared on-chip buffers for all incoming >> packets, including ep0out. It's FIFO buffer, so packets must be handle >> by DMA in correct order. If the first packet in the buffer will not be >> handled, then the following packets directed for other endpoints and >> functions will be blocked. >> >> Additionally the packets directed to one endpoint can block entire on-chip >> buffers. In this case transfer to other endpoints also will blocked. >> >> To resolve this issue after raising the descriptor missing interrupt >> driver prepares internal usb_request object and use it to arm DMA >> transfer. >> >> The problematic situation was observed in case when endpoint has >> been enabled but no usb_request were queued. Driver try detects >> such endpoints and will use this workaround only for these endpoint. >> >> Driver use limited number of buffer. This number can be set by macro >> CDNS_WA2_NUM_BUFFERS. >> >> Such blocking situation was observed on ACM gadget. For this function >> host send OUT data packet but ACM function is not prepared for >> this packet. It's cause that buffer placed in on chip memory block >> transfer to other endpoints. >> >> It's limitation of controller but maybe this issues should be fixed in >> function driver. >> >> This work around can be disabled/enabled by means of quirk_internal_buffer >> module parameter. By default feature is enabled. It can has impact to >> transfer performance and in most case this feature can be disabled. > >How much is the performance impact? I didn't check this, but performance will be decreased because driver has to copy data from internally allocated buffer to usb_request->buff. >You mentioned that the issue was observed only in the ACM case and >could be fixed in the function driver? >It seems pointless to enable an endpoint and not have any requests queued for it. Yes, it’s true. The request in ACM class is send to Controller Driver when user read file associated with ACM gadget. Problem exist because host send data to controller but USB controller has not prepared buffer for this data by ACM class. >Isn't fixing the ACM driver (if there is a real issue) a better approach than having >a workaround that affects performance of all other use cases? Yes it should be better. But what ACM driver should do with unexpected data. I'm not sure if we can simply delete them. The best solution would be to make modification in controller. In such case Controller shouldn't accept packet but should send NAK. One more thing. Workaround has implemented algorithm that decide for which endpoint it should be enabled. e.g for composite device MSC+NCM+ACM it should work only for ACM OUT endpoint. Cheers, Pawel > >> >> Signed-off-by: Pawel Laszczak <pawell@cadence.com> >> --- >> drivers/usb/cdns3/gadget.c | 273 ++++++++++++++++++++++++++++++++++++- >> drivers/usb/cdns3/gadget.h | 7 + >> 2 files changed, 278 insertions(+), 2 deletions(-) >> >> diff --git a/drivers/usb/cdns3/gadget.c b/drivers/usb/cdns3/gadget.c >> index 7f7f24ee3c4b..5dfbe6e1421c 100644 >> --- a/drivers/usb/cdns3/gadget.c >> +++ b/drivers/usb/cdns3/gadget.c >> @@ -27,6 +27,37 @@ >> * If (((Dequeue Ptr (i.e. EP_TRADDR) == Enqueue Ptr-1) or >> * (Dequeue Ptr (i.e. EP_TRADDR) == Enqueue Ptr)) >> * and (DRBL==1 and (not EP0))) >> + * >> + * Work around 2: >> + * Controller for OUT endpoints has shared on-chip buffers for all incoming >> + * packets, including ep0out. It's FIFO buffer, so packets must be handle by DMA >> + * in correct order. If the first packet in the buffer will not be handled, >> + * then the following packets directed for other endpoints and functions >> + * will be blocked. >> + * Additionally the packets directed to one endpoint can block entire on-chip >> + * buffers. In this case transfer to other endpoints also will blocked. >> + * >> + * To resolve this issue after raising the descriptor missing interrupt >> + * driver prepares internal usb_request object and use it to arm DMA transfer. >> + * >> + * The problematic situation was observed in case when endpoint has been enabled >> + * but no usb_request were queued. Driver try detects such endpoints and will >> + * use this workaround only for these endpoint. >> + * >> + * Driver use limited number of buffer. This number can be set by macro >> + * CDNS_WA2_NUM_BUFFERS. >> + * >> + * Such blocking situation was observed on ACM gadget. For this function >> + * host send OUT data packet but ACM function is not prepared for this packet. >> + * It's cause that buffer placed in on chip memory block transfer to other >> + * endpoints. >> + * >> + * It's limitation of controller but maybe this issues should be fixed in >> + * function driver. >> + * >> + * This work around can be disabled/enabled by means of quirk_internal_buffer >> + * module parameter. By default feature is enabled. It can has impact to >> + * transfer performance and in most case this feature can be disabled. >> */ >> >> #include <linux/dma-mapping.h> >> @@ -42,6 +73,14 @@ static int __cdns3_gadget_ep_queue(struct usb_ep *ep, >> struct usb_request *request, >> gfp_t gfp_flags); >> >> +/* >> + * Parameter allows to disable/enable handling of work around 2 feature. >> + * By default this value is enabled. >> + */ >> +static bool quirk_internal_buffer = 1; >> +module_param(quirk_internal_buffer, bool, 0644); >> +MODULE_PARM_DESC(quirk_internal_buffer, "Disable/enable WA2 algorithm"); >> + >> /** >> * cdns3_handshake - spin reading until handshake completes or fails >> * @ptr: address of device controller register to be read >> @@ -105,6 +144,17 @@ struct usb_request *cdns3_next_request(struct list_head *list) >> return list_first_entry_or_null(list, struct usb_request, list); >> } >> >> +/** >> + * cdns3_next_priv_request - returns next request from list >> + * @list: list containing requests >> + * >> + * Returns request or NULL if no requests in list >> + */ >> +struct cdns3_request *cdns3_next_priv_request(struct list_head *list) >> +{ >> + return list_first_entry_or_null(list, struct cdns3_request, list); >> +} >> + >> /** >> * select_ep - selects endpoint >> * @priv_dev: extended gadget object >> @@ -384,6 +434,53 @@ static int cdns3_start_all_request(struct cdns3_device *priv_dev, >> return ret; >> } >> >> +/** >> + * cdns3_descmiss_copy_data copy data from internal requests to request queued >> + * by class driver. >> + * @priv_ep: extended endpoint object >> + * @request: request object >> + */ >> +static void cdns3_descmiss_copy_data(struct cdns3_endpoint *priv_ep, >> + struct usb_request *request) >> +{ >> + struct usb_request *descmiss_req; >> + struct cdns3_request *descmiss_priv_req; >> + >> + while (!list_empty(&priv_ep->descmiss_req_list)) { >> + int chunk_end; >> + int length; >> + >> + descmiss_priv_req = >> + cdns3_next_priv_request(&priv_ep->descmiss_req_list); >> + descmiss_req = &descmiss_priv_req->request; >> + >> + /* driver can't touch pending request */ >> + if (descmiss_priv_req->flags & REQUEST_PENDING) >> + break; >> + >> + chunk_end = descmiss_priv_req->flags & REQUEST_INTERNAL_CH; >> + length = request->actual + descmiss_req->actual; >> + >> + if (length <= request->length) { >> + memcpy(&((u8 *)request->buf)[request->actual], >> + descmiss_req->buf, >> + descmiss_req->actual); >> + request->actual = length; >> + } else { >> + /* It should never occures */ >> + request->status = -ENOMEM; >> + } >> + >> + list_del_init(&descmiss_priv_req->list); >> + >> + kfree(descmiss_req->buf); >> + cdns3_gadget_ep_free_request(&priv_ep->endpoint, descmiss_req); >> + >> + if (!chunk_end) >> + break; >> + } >> +} >> + >> /** >> * cdns3_gadget_giveback - call struct usb_request's ->complete callback >> * @priv_ep: The endpoint to whom the request belongs to >> @@ -412,6 +509,32 @@ void cdns3_gadget_giveback(struct cdns3_endpoint *priv_ep, >> priv_req->flags &= ~REQUEST_PENDING; >> trace_cdns3_gadget_giveback(priv_req); >> >> + /* WA2: */ >> + if (priv_ep->flags & EP_QUIRK_EXTRA_BUF_EN && >> + priv_req->flags & REQUEST_INTERNAL) { >> + struct usb_request *req; >> + >> + req = cdns3_next_request(&priv_ep->deferred_req_list); >> + request = req; >> + priv_ep->descmis_req = NULL; >> + >> + if (!req) >> + return; >> + >> + cdns3_descmiss_copy_data(priv_ep, req); >> + if (!(priv_ep->flags & EP_QUIRK_END_TRANSFER) && >> + req->length != req->actual) { >> + /* wait for next part of transfer */ >> + return; >> + } >> + >> + if (req->status == -EINPROGRESS) >> + req->status = 0; >> + >> + list_del_init(&req->list); >> + cdns3_start_all_request(priv_dev, priv_ep); >> + } >> + >> /* Start all not pending request */ >> if (priv_ep->flags & EP_RING_FULL) >> cdns3_start_all_request(priv_dev, priv_ep); >> @@ -774,6 +897,59 @@ void cdns3_rearm_transfer(struct cdns3_endpoint *priv_ep, u8 rearm) >> } >> } >> >> +/** >> + * cdns3_descmissing_packet - handles descriptor missing event. >> + * @priv_dev: extended gadget object >> + * >> + * This function is used only for WA2. For more information see Work around 2 >> + * description. >> + */ >> +static int cdns3_descmissing_packet(struct cdns3_endpoint *priv_ep) >> +{ >> + struct cdns3_request *priv_req; >> + struct usb_request *request; >> + >> + if (priv_ep->flags & EP_QUIRK_EXTRA_BUF_DET) { >> + priv_ep->flags &= ~EP_QUIRK_EXTRA_BUF_DET; >> + priv_ep->flags |= EP_QUIRK_EXTRA_BUF_EN; >> + } >> + >> + cdns3_dbg(priv_ep->cdns3_dev, "WA2: Description Missing detected\n"); >> + >> + request = cdns3_gadget_ep_alloc_request(&priv_ep->endpoint, >> + GFP_ATOMIC); >> + if (!request) >> + return -ENOMEM; >> + >> + priv_req = to_cdns3_request(request); >> + priv_req->flags |= REQUEST_INTERNAL; >> + >> + /* if this field is still assigned it indicate that transfer related >> + * with this request has not been finished yet. Driver in this >> + * case simply allocate next request and assign flag REQUEST_INTERNAL_CH >> + * flag to previous one. It will indicate that current request is >> + * part of the previous one. >> + */ >> + if (priv_ep->descmis_req) >> + priv_ep->descmis_req->flags |= REQUEST_INTERNAL_CH; >> + >> + priv_req->request.buf = kzalloc(CDNS3_DESCMIS_BUF_SIZE, >> + GFP_ATOMIC); >> + if (!priv_req) { >> + cdns3_gadget_ep_free_request(&priv_ep->endpoint, request); >> + return -ENOMEM; >> + } >> + >> + priv_req->request.length = CDNS3_DESCMIS_BUF_SIZE; >> + priv_ep->descmis_req = priv_req; >> + >> + __cdns3_gadget_ep_queue(&priv_ep->endpoint, >> + &priv_ep->descmis_req->request, >> + GFP_ATOMIC); >> + >> + return 0; >> +} >> + >> /** >> * cdns3_check_ep_interrupt_proceed - Processes interrupt related to endpoint >> * @priv_ep: endpoint object >> @@ -807,8 +983,31 @@ static int cdns3_check_ep_interrupt_proceed(struct cdns3_endpoint *priv_ep) >> cdns3_rearm_transfer(priv_ep, priv_ep->wa1_set); >> } >> >> - if ((ep_sts_reg & EP_STS_IOC) || (ep_sts_reg & EP_STS_ISP)) >> + if ((ep_sts_reg & EP_STS_IOC) || (ep_sts_reg & EP_STS_ISP)) { >> + if (priv_ep->flags & EP_QUIRK_EXTRA_BUF_EN) { >> + if (ep_sts_reg & EP_STS_ISP) >> + priv_ep->flags |= EP_QUIRK_END_TRANSFER; >> + else >> + priv_ep->flags &= ~EP_QUIRK_END_TRANSFER; >> + } >> + >> cdns3_transfer_completed(priv_dev, priv_ep); >> + } >> + >> + /* >> + * WA2: this condition should only be meet when >> + * priv_ep->flags & EP_QUIRK_EXTRA_BUF_DET or >> + * priv_ep->flags & EP_QUIRK_EXTRA_BUF_EN. >> + * In other cases this interrupt will be disabled/ >> + */ >> + if (ep_sts_reg & EP_STS_DESCMIS) { >> + int err; >> + >> + err = cdns3_descmissing_packet(priv_ep); >> + if (err) >> + dev_err(priv_dev->dev, >> + "Failed: No sufficient memory for DESCMIS\n"); >> + } >> >> return 0; >> } >> @@ -1241,13 +1440,26 @@ static int cdns3_gadget_ep_enable(struct usb_ep *ep, >> /* enable interrupt for selected endpoint */ >> cdns3_set_register_bit(&priv_dev->regs->ep_ien, >> BIT(cdns3_ep_addr_to_index(bEndpointAddress))); >> + /* >> + * WA2: Set flag for all not ISOC OUT endpoints. If this flag is set >> + * driver try to detect whether endpoint need additional internal >> + * buffer for unblocking on-chip FIFO buffer. This flag will be cleared >> + * if before first DESCMISS interrupt the DMA will be armed. >> + */ >> + if (quirk_internal_buffer) { >> + if (!priv_ep->dir && priv_ep->type != USB_ENDPOINT_XFER_ISOC) { >> + priv_ep->flags |= EP_QUIRK_EXTRA_BUF_DET; >> + reg |= EP_STS_EN_DESCMISEN; >> + } >> + } >> >> writel(reg, &priv_dev->regs->ep_sts_en); >> >> cdns3_set_register_bit(&priv_dev->regs->ep_cfg, EP_CFG_ENABLE); >> >> ep->desc = desc; >> - priv_ep->flags &= ~(EP_PENDING_REQUEST | EP_STALL); >> + priv_ep->flags &= ~(EP_PENDING_REQUEST | EP_STALL | >> + EP_QUIRK_EXTRA_BUF_EN); >> priv_ep->flags |= EP_ENABLED | EP_UPDATE_EP_TRBADDR; >> priv_ep->wa1_set = 0; >> priv_ep->enqueue = 0; >> @@ -1272,6 +1484,7 @@ static int cdns3_gadget_ep_enable(struct usb_ep *ep, >> static int cdns3_gadget_ep_disable(struct usb_ep *ep) >> { >> struct cdns3_endpoint *priv_ep; >> + struct cdns3_request *priv_req; >> struct cdns3_device *priv_dev; >> struct usb_request *request; >> unsigned long flags; >> @@ -1308,6 +1521,14 @@ static int cdns3_gadget_ep_disable(struct usb_ep *ep) >> -ESHUTDOWN); >> } >> >> + while (!list_empty(&priv_ep->descmiss_req_list)) { >> + priv_req = cdns3_next_priv_request(&priv_ep->descmiss_req_list); >> + >> + kfree(priv_req->request.buf); >> + cdns3_gadget_ep_free_request(&priv_ep->endpoint, >> + &priv_req->request); >> + } >> + >> while (!list_empty(&priv_ep->deferred_req_list)) { >> request = cdns3_next_request(&priv_ep->deferred_req_list); >> >> @@ -1348,6 +1569,53 @@ static int __cdns3_gadget_ep_queue(struct usb_ep *ep, >> priv_req = to_cdns3_request(request); >> trace_cdns3_ep_queue(priv_req); >> >> + /* >> + * WA2: if transfer was queued before DESCMISS appear than we >> + * can disable handling of DESCMISS interrupt. Driver assumes that it >> + * can disable special treatment for this endpoint. >> + */ >> + if (priv_ep->flags & EP_QUIRK_EXTRA_BUF_DET) { >> + u32 reg; >> + >> + cdns3_select_ep(priv_dev, priv_ep->num | priv_ep->dir); >> + priv_ep->flags &= ~EP_QUIRK_EXTRA_BUF_DET; >> + reg = readl(&priv_dev->regs->ep_sts_en); >> + reg &= ~EP_STS_EN_DESCMISEN; >> + writel(reg, &priv_dev->regs->ep_sts_en); >> + } >> + >> + /* WA2 */ >> + if (priv_ep->flags & EP_QUIRK_EXTRA_BUF_EN) { >> + u8 pending_empty = list_empty(&priv_ep->pending_req_list); >> + u8 descmiss_empty = list_empty(&priv_ep->descmiss_req_list); >> + >> + /* >> + * DESCMISS transfer has been finished, so data will be >> + * directly copied from internal allocated usb_request >> + * objects. >> + */ >> + if (pending_empty && !descmiss_empty && >> + !(priv_req->flags & REQUEST_INTERNAL)) { >> + cdns3_descmiss_copy_data(priv_ep, request); >> + list_add_tail(&request->list, >> + &priv_ep->pending_req_list); >> + cdns3_gadget_giveback(priv_ep, priv_req, >> + request->status); >> + return ret; >> + } >> + >> + /* >> + * WA2 driver will wait for completion DESCMISS transfer, >> + * before starts new, not DESCMISS transfer. >> + */ >> + if (!pending_empty && !descmiss_empty) >> + deferred = 1; >> + >> + if (priv_req->flags & REQUEST_INTERNAL) >> + list_add_tail(&priv_req->list, >> + &priv_ep->descmiss_req_list); >> + } >> + >> ret = usb_gadget_map_request_by_dev(priv_dev->sysdev, request, >> usb_endpoint_dir_in(ep->desc)); >> if (ret) >> @@ -1782,6 +2050,7 @@ static int cdns3_init_eps(struct cdns3_device *priv_dev) >> >> INIT_LIST_HEAD(&priv_ep->pending_req_list); >> INIT_LIST_HEAD(&priv_ep->deferred_req_list); >> + INIT_LIST_HEAD(&priv_ep->descmiss_req_list); >> } >> >> return 0; >> diff --git a/drivers/usb/cdns3/gadget.h b/drivers/usb/cdns3/gadget.h >> index 817f8ae7a4da..8de733b315e9 100644 >> --- a/drivers/usb/cdns3/gadget.h >> +++ b/drivers/usb/cdns3/gadget.h >> @@ -1000,6 +1000,7 @@ struct cdns3_device; >> * @endpoint: usb endpoint >> * @pending_req_list: list of requests queuing on transfer ring. >> * @deferred_req_list: list of requests waiting for queuing on transfer ring. >> + * @descmiss_req_list: list of requests internally allocated by driver (WA2). >> * @trb_pool: transfer ring - array of transaction buffers >> * @trb_pool_dma: dma address of transfer ring >> * @cdns3_dev: device associated with this endpoint >> @@ -1026,6 +1027,7 @@ struct cdns3_endpoint { >> struct usb_ep endpoint; >> struct list_head pending_req_list; >> struct list_head deferred_req_list; >> + struct list_head descmiss_req_list; >> >> struct cdns3_trb *trb_pool; >> dma_addr_t trb_pool_dma; >> @@ -1041,6 +1043,9 @@ struct cdns3_endpoint { >> #define EP_PENDING_REQUEST BIT(5) >> #define EP_RING_FULL BIT(6) >> #define EP_CLAIMED BIT(7) >> +#define EP_QUIRK_EXTRA_BUF_DET BIT(8) >> +#define EP_QUIRK_EXTRA_BUF_EN BIT(9) >> +#define EP_QUIRK_END_TRANSFER BIT(10) >> >> u32 flags; >> >> @@ -1074,6 +1079,7 @@ struct cdns3_endpoint { >> * @start_trb: number of the first TRB in transfer ring >> * @end_trb: number of the last TRB in transfer ring >> * @flags: flag specifying special usage of request >> + * @list: used by internally allocated request to add to descmiss_req_list. >> */ >> struct cdns3_request { >> struct usb_request request; >> @@ -1086,6 +1092,7 @@ struct cdns3_request { >> #define REQUEST_INTERNAL_CH BIT(2) >> #define REQUEST_ZLP BIT(3) >> u32 flags; >> + struct list_head list; >> }; >> >> #define to_cdns3_request(r) (container_of(r, struct cdns3_request, request)) >> > >-- >Texas Instruments Finland Oy, Porkkalankatu 22, 00180 Helsinki. >Y-tunnus/Business ID: 0615521-4. Kotipaikka/Domicile: Helsinki
Pawel, On 20/02/2019 13:18, Pawel Laszczak wrote: > Hi Roger. >> >> On 14/02/2019 21:45, Pawel Laszczak wrote: >>> Controller for OUT endpoints has shared on-chip buffers for all incoming >>> packets, including ep0out. It's FIFO buffer, so packets must be handle >>> by DMA in correct order. If the first packet in the buffer will not be >>> handled, then the following packets directed for other endpoints and >>> functions will be blocked. >>> >>> Additionally the packets directed to one endpoint can block entire on-chip >>> buffers. In this case transfer to other endpoints also will blocked. >>> >>> To resolve this issue after raising the descriptor missing interrupt >>> driver prepares internal usb_request object and use it to arm DMA >>> transfer. >>> >>> The problematic situation was observed in case when endpoint has >>> been enabled but no usb_request were queued. Driver try detects >>> such endpoints and will use this workaround only for these endpoint. >>> >>> Driver use limited number of buffer. This number can be set by macro >>> CDNS_WA2_NUM_BUFFERS. >>> >>> Such blocking situation was observed on ACM gadget. For this function >>> host send OUT data packet but ACM function is not prepared for >>> this packet. It's cause that buffer placed in on chip memory block >>> transfer to other endpoints. >>> >>> It's limitation of controller but maybe this issues should be fixed in >>> function driver. >>> >>> This work around can be disabled/enabled by means of quirk_internal_buffer >>> module parameter. By default feature is enabled. It can has impact to >>> transfer performance and in most case this feature can be disabled. >> >> How much is the performance impact? > > I didn't check this, but performance will be decreased because driver has to > copy data from internally allocated buffer to usb_request->buff. > >> You mentioned that the issue was observed only in the ACM case and >> could be fixed in the function driver? >> It seems pointless to enable an endpoint and not have any requests queued for it. > > Yes, it’s true. The request in ACM class is send to Controller Driver when user read file associated > with ACM gadget. Problem exist because host send data to controller but USB controller > has not prepared buffer for this data by ACM class. > >> Isn't fixing the ACM driver (if there is a real issue) a better approach than having >> a workaround that affects performance of all other use cases? > > Yes it should be better. But what ACM driver should do with unexpected data. I'm not sure if we > can simply delete them. > > The best solution would be to make modification in controller. In such case Controller shouldn't accept > packet but should send NAK. Yes, that should be standard behaviour. No? > > One more thing. Workaround has implemented algorithm that decide for which endpoint it should be enabled. > e.g for composite device MSC+NCM+ACM it should work only for ACM OUT endpoint. > If ACM driver didn't queue the request for ACM OUT endpoint, why does the controller accept the data at all? I didn't understand why we need a workaround for this. It should be standard behaviour to NAK data if function driver didn't request for all endpoints. Also I didn't understand why performance should be impacted to just NAK data. cheers, -roger > Cheers, > Pawel >> >>> >>> Signed-off-by: Pawel Laszczak <pawell@cadence.com> >>> --- >>> drivers/usb/cdns3/gadget.c | 273 ++++++++++++++++++++++++++++++++++++- >>> drivers/usb/cdns3/gadget.h | 7 + >>> 2 files changed, 278 insertions(+), 2 deletions(-) >>> >>> diff --git a/drivers/usb/cdns3/gadget.c b/drivers/usb/cdns3/gadget.c >>> index 7f7f24ee3c4b..5dfbe6e1421c 100644 >>> --- a/drivers/usb/cdns3/gadget.c >>> +++ b/drivers/usb/cdns3/gadget.c >>> @@ -27,6 +27,37 @@ >>> * If (((Dequeue Ptr (i.e. EP_TRADDR) == Enqueue Ptr-1) or >>> * (Dequeue Ptr (i.e. EP_TRADDR) == Enqueue Ptr)) >>> * and (DRBL==1 and (not EP0))) >>> + * >>> + * Work around 2: >>> + * Controller for OUT endpoints has shared on-chip buffers for all incoming >>> + * packets, including ep0out. It's FIFO buffer, so packets must be handle by DMA >>> + * in correct order. If the first packet in the buffer will not be handled, >>> + * then the following packets directed for other endpoints and functions >>> + * will be blocked. >>> + * Additionally the packets directed to one endpoint can block entire on-chip >>> + * buffers. In this case transfer to other endpoints also will blocked. >>> + * >>> + * To resolve this issue after raising the descriptor missing interrupt >>> + * driver prepares internal usb_request object and use it to arm DMA transfer. >>> + * >>> + * The problematic situation was observed in case when endpoint has been enabled >>> + * but no usb_request were queued. Driver try detects such endpoints and will >>> + * use this workaround only for these endpoint. >>> + * >>> + * Driver use limited number of buffer. This number can be set by macro >>> + * CDNS_WA2_NUM_BUFFERS. >>> + * >>> + * Such blocking situation was observed on ACM gadget. For this function >>> + * host send OUT data packet but ACM function is not prepared for this packet. >>> + * It's cause that buffer placed in on chip memory block transfer to other >>> + * endpoints. >>> + * >>> + * It's limitation of controller but maybe this issues should be fixed in >>> + * function driver. >>> + * >>> + * This work around can be disabled/enabled by means of quirk_internal_buffer >>> + * module parameter. By default feature is enabled. It can has impact to >>> + * transfer performance and in most case this feature can be disabled. >>> */ >>> >>> #include <linux/dma-mapping.h> >>> @@ -42,6 +73,14 @@ static int __cdns3_gadget_ep_queue(struct usb_ep *ep, >>> struct usb_request *request, >>> gfp_t gfp_flags); >>> >>> +/* >>> + * Parameter allows to disable/enable handling of work around 2 feature. >>> + * By default this value is enabled. >>> + */ >>> +static bool quirk_internal_buffer = 1; >>> +module_param(quirk_internal_buffer, bool, 0644); >>> +MODULE_PARM_DESC(quirk_internal_buffer, "Disable/enable WA2 algorithm"); >>> + >>> /** >>> * cdns3_handshake - spin reading until handshake completes or fails >>> * @ptr: address of device controller register to be read >>> @@ -105,6 +144,17 @@ struct usb_request *cdns3_next_request(struct list_head *list) >>> return list_first_entry_or_null(list, struct usb_request, list); >>> } >>> >>> +/** >>> + * cdns3_next_priv_request - returns next request from list >>> + * @list: list containing requests >>> + * >>> + * Returns request or NULL if no requests in list >>> + */ >>> +struct cdns3_request *cdns3_next_priv_request(struct list_head *list) >>> +{ >>> + return list_first_entry_or_null(list, struct cdns3_request, list); >>> +} >>> + >>> /** >>> * select_ep - selects endpoint >>> * @priv_dev: extended gadget object >>> @@ -384,6 +434,53 @@ static int cdns3_start_all_request(struct cdns3_device *priv_dev, >>> return ret; >>> } >>> >>> +/** >>> + * cdns3_descmiss_copy_data copy data from internal requests to request queued >>> + * by class driver. >>> + * @priv_ep: extended endpoint object >>> + * @request: request object >>> + */ >>> +static void cdns3_descmiss_copy_data(struct cdns3_endpoint *priv_ep, >>> + struct usb_request *request) >>> +{ >>> + struct usb_request *descmiss_req; >>> + struct cdns3_request *descmiss_priv_req; >>> + >>> + while (!list_empty(&priv_ep->descmiss_req_list)) { >>> + int chunk_end; >>> + int length; >>> + >>> + descmiss_priv_req = >>> + cdns3_next_priv_request(&priv_ep->descmiss_req_list); >>> + descmiss_req = &descmiss_priv_req->request; >>> + >>> + /* driver can't touch pending request */ >>> + if (descmiss_priv_req->flags & REQUEST_PENDING) >>> + break; >>> + >>> + chunk_end = descmiss_priv_req->flags & REQUEST_INTERNAL_CH; >>> + length = request->actual + descmiss_req->actual; >>> + >>> + if (length <= request->length) { >>> + memcpy(&((u8 *)request->buf)[request->actual], >>> + descmiss_req->buf, >>> + descmiss_req->actual); >>> + request->actual = length; >>> + } else { >>> + /* It should never occures */ >>> + request->status = -ENOMEM; >>> + } >>> + >>> + list_del_init(&descmiss_priv_req->list); >>> + >>> + kfree(descmiss_req->buf); >>> + cdns3_gadget_ep_free_request(&priv_ep->endpoint, descmiss_req); >>> + >>> + if (!chunk_end) >>> + break; >>> + } >>> +} >>> + >>> /** >>> * cdns3_gadget_giveback - call struct usb_request's ->complete callback >>> * @priv_ep: The endpoint to whom the request belongs to >>> @@ -412,6 +509,32 @@ void cdns3_gadget_giveback(struct cdns3_endpoint *priv_ep, >>> priv_req->flags &= ~REQUEST_PENDING; >>> trace_cdns3_gadget_giveback(priv_req); >>> >>> + /* WA2: */ >>> + if (priv_ep->flags & EP_QUIRK_EXTRA_BUF_EN && >>> + priv_req->flags & REQUEST_INTERNAL) { >>> + struct usb_request *req; >>> + >>> + req = cdns3_next_request(&priv_ep->deferred_req_list); >>> + request = req; >>> + priv_ep->descmis_req = NULL; >>> + >>> + if (!req) >>> + return; >>> + >>> + cdns3_descmiss_copy_data(priv_ep, req); >>> + if (!(priv_ep->flags & EP_QUIRK_END_TRANSFER) && >>> + req->length != req->actual) { >>> + /* wait for next part of transfer */ >>> + return; >>> + } >>> + >>> + if (req->status == -EINPROGRESS) >>> + req->status = 0; >>> + >>> + list_del_init(&req->list); >>> + cdns3_start_all_request(priv_dev, priv_ep); >>> + } >>> + >>> /* Start all not pending request */ >>> if (priv_ep->flags & EP_RING_FULL) >>> cdns3_start_all_request(priv_dev, priv_ep); >>> @@ -774,6 +897,59 @@ void cdns3_rearm_transfer(struct cdns3_endpoint *priv_ep, u8 rearm) >>> } >>> } >>> >>> +/** >>> + * cdns3_descmissing_packet - handles descriptor missing event. >>> + * @priv_dev: extended gadget object >>> + * >>> + * This function is used only for WA2. For more information see Work around 2 >>> + * description. >>> + */ >>> +static int cdns3_descmissing_packet(struct cdns3_endpoint *priv_ep) >>> +{ >>> + struct cdns3_request *priv_req; >>> + struct usb_request *request; >>> + >>> + if (priv_ep->flags & EP_QUIRK_EXTRA_BUF_DET) { >>> + priv_ep->flags &= ~EP_QUIRK_EXTRA_BUF_DET; >>> + priv_ep->flags |= EP_QUIRK_EXTRA_BUF_EN; >>> + } >>> + >>> + cdns3_dbg(priv_ep->cdns3_dev, "WA2: Description Missing detected\n"); >>> + >>> + request = cdns3_gadget_ep_alloc_request(&priv_ep->endpoint, >>> + GFP_ATOMIC); >>> + if (!request) >>> + return -ENOMEM; >>> + >>> + priv_req = to_cdns3_request(request); >>> + priv_req->flags |= REQUEST_INTERNAL; >>> + >>> + /* if this field is still assigned it indicate that transfer related >>> + * with this request has not been finished yet. Driver in this >>> + * case simply allocate next request and assign flag REQUEST_INTERNAL_CH >>> + * flag to previous one. It will indicate that current request is >>> + * part of the previous one. >>> + */ >>> + if (priv_ep->descmis_req) >>> + priv_ep->descmis_req->flags |= REQUEST_INTERNAL_CH; >>> + >>> + priv_req->request.buf = kzalloc(CDNS3_DESCMIS_BUF_SIZE, >>> + GFP_ATOMIC); >>> + if (!priv_req) { >>> + cdns3_gadget_ep_free_request(&priv_ep->endpoint, request); >>> + return -ENOMEM; >>> + } >>> + >>> + priv_req->request.length = CDNS3_DESCMIS_BUF_SIZE; >>> + priv_ep->descmis_req = priv_req; >>> + >>> + __cdns3_gadget_ep_queue(&priv_ep->endpoint, >>> + &priv_ep->descmis_req->request, >>> + GFP_ATOMIC); >>> + >>> + return 0; >>> +} >>> + >>> /** >>> * cdns3_check_ep_interrupt_proceed - Processes interrupt related to endpoint >>> * @priv_ep: endpoint object >>> @@ -807,8 +983,31 @@ static int cdns3_check_ep_interrupt_proceed(struct cdns3_endpoint *priv_ep) >>> cdns3_rearm_transfer(priv_ep, priv_ep->wa1_set); >>> } >>> >>> - if ((ep_sts_reg & EP_STS_IOC) || (ep_sts_reg & EP_STS_ISP)) >>> + if ((ep_sts_reg & EP_STS_IOC) || (ep_sts_reg & EP_STS_ISP)) { >>> + if (priv_ep->flags & EP_QUIRK_EXTRA_BUF_EN) { >>> + if (ep_sts_reg & EP_STS_ISP) >>> + priv_ep->flags |= EP_QUIRK_END_TRANSFER; >>> + else >>> + priv_ep->flags &= ~EP_QUIRK_END_TRANSFER; >>> + } >>> + >>> cdns3_transfer_completed(priv_dev, priv_ep); >>> + } >>> + >>> + /* >>> + * WA2: this condition should only be meet when >>> + * priv_ep->flags & EP_QUIRK_EXTRA_BUF_DET or >>> + * priv_ep->flags & EP_QUIRK_EXTRA_BUF_EN. >>> + * In other cases this interrupt will be disabled/ >>> + */ >>> + if (ep_sts_reg & EP_STS_DESCMIS) { >>> + int err; >>> + >>> + err = cdns3_descmissing_packet(priv_ep); >>> + if (err) >>> + dev_err(priv_dev->dev, >>> + "Failed: No sufficient memory for DESCMIS\n"); >>> + } >>> >>> return 0; >>> } >>> @@ -1241,13 +1440,26 @@ static int cdns3_gadget_ep_enable(struct usb_ep *ep, >>> /* enable interrupt for selected endpoint */ >>> cdns3_set_register_bit(&priv_dev->regs->ep_ien, >>> BIT(cdns3_ep_addr_to_index(bEndpointAddress))); >>> + /* >>> + * WA2: Set flag for all not ISOC OUT endpoints. If this flag is set >>> + * driver try to detect whether endpoint need additional internal >>> + * buffer for unblocking on-chip FIFO buffer. This flag will be cleared >>> + * if before first DESCMISS interrupt the DMA will be armed. >>> + */ >>> + if (quirk_internal_buffer) { >>> + if (!priv_ep->dir && priv_ep->type != USB_ENDPOINT_XFER_ISOC) { >>> + priv_ep->flags |= EP_QUIRK_EXTRA_BUF_DET; >>> + reg |= EP_STS_EN_DESCMISEN; >>> + } >>> + } >>> >>> writel(reg, &priv_dev->regs->ep_sts_en); >>> >>> cdns3_set_register_bit(&priv_dev->regs->ep_cfg, EP_CFG_ENABLE); >>> >>> ep->desc = desc; >>> - priv_ep->flags &= ~(EP_PENDING_REQUEST | EP_STALL); >>> + priv_ep->flags &= ~(EP_PENDING_REQUEST | EP_STALL | >>> + EP_QUIRK_EXTRA_BUF_EN); >>> priv_ep->flags |= EP_ENABLED | EP_UPDATE_EP_TRBADDR; >>> priv_ep->wa1_set = 0; >>> priv_ep->enqueue = 0; >>> @@ -1272,6 +1484,7 @@ static int cdns3_gadget_ep_enable(struct usb_ep *ep, >>> static int cdns3_gadget_ep_disable(struct usb_ep *ep) >>> { >>> struct cdns3_endpoint *priv_ep; >>> + struct cdns3_request *priv_req; >>> struct cdns3_device *priv_dev; >>> struct usb_request *request; >>> unsigned long flags; >>> @@ -1308,6 +1521,14 @@ static int cdns3_gadget_ep_disable(struct usb_ep *ep) >>> -ESHUTDOWN); >>> } >>> >>> + while (!list_empty(&priv_ep->descmiss_req_list)) { >>> + priv_req = cdns3_next_priv_request(&priv_ep->descmiss_req_list); >>> + >>> + kfree(priv_req->request.buf); >>> + cdns3_gadget_ep_free_request(&priv_ep->endpoint, >>> + &priv_req->request); >>> + } >>> + >>> while (!list_empty(&priv_ep->deferred_req_list)) { >>> request = cdns3_next_request(&priv_ep->deferred_req_list); >>> >>> @@ -1348,6 +1569,53 @@ static int __cdns3_gadget_ep_queue(struct usb_ep *ep, >>> priv_req = to_cdns3_request(request); >>> trace_cdns3_ep_queue(priv_req); >>> >>> + /* >>> + * WA2: if transfer was queued before DESCMISS appear than we >>> + * can disable handling of DESCMISS interrupt. Driver assumes that it >>> + * can disable special treatment for this endpoint. >>> + */ >>> + if (priv_ep->flags & EP_QUIRK_EXTRA_BUF_DET) { >>> + u32 reg; >>> + >>> + cdns3_select_ep(priv_dev, priv_ep->num | priv_ep->dir); >>> + priv_ep->flags &= ~EP_QUIRK_EXTRA_BUF_DET; >>> + reg = readl(&priv_dev->regs->ep_sts_en); >>> + reg &= ~EP_STS_EN_DESCMISEN; >>> + writel(reg, &priv_dev->regs->ep_sts_en); >>> + } >>> + >>> + /* WA2 */ >>> + if (priv_ep->flags & EP_QUIRK_EXTRA_BUF_EN) { >>> + u8 pending_empty = list_empty(&priv_ep->pending_req_list); >>> + u8 descmiss_empty = list_empty(&priv_ep->descmiss_req_list); >>> + >>> + /* >>> + * DESCMISS transfer has been finished, so data will be >>> + * directly copied from internal allocated usb_request >>> + * objects. >>> + */ >>> + if (pending_empty && !descmiss_empty && >>> + !(priv_req->flags & REQUEST_INTERNAL)) { >>> + cdns3_descmiss_copy_data(priv_ep, request); >>> + list_add_tail(&request->list, >>> + &priv_ep->pending_req_list); >>> + cdns3_gadget_giveback(priv_ep, priv_req, >>> + request->status); >>> + return ret; >>> + } >>> + >>> + /* >>> + * WA2 driver will wait for completion DESCMISS transfer, >>> + * before starts new, not DESCMISS transfer. >>> + */ >>> + if (!pending_empty && !descmiss_empty) >>> + deferred = 1; >>> + >>> + if (priv_req->flags & REQUEST_INTERNAL) >>> + list_add_tail(&priv_req->list, >>> + &priv_ep->descmiss_req_list); >>> + } >>> + >>> ret = usb_gadget_map_request_by_dev(priv_dev->sysdev, request, >>> usb_endpoint_dir_in(ep->desc)); >>> if (ret) >>> @@ -1782,6 +2050,7 @@ static int cdns3_init_eps(struct cdns3_device *priv_dev) >>> >>> INIT_LIST_HEAD(&priv_ep->pending_req_list); >>> INIT_LIST_HEAD(&priv_ep->deferred_req_list); >>> + INIT_LIST_HEAD(&priv_ep->descmiss_req_list); >>> } >>> >>> return 0; >>> diff --git a/drivers/usb/cdns3/gadget.h b/drivers/usb/cdns3/gadget.h >>> index 817f8ae7a4da..8de733b315e9 100644 >>> --- a/drivers/usb/cdns3/gadget.h >>> +++ b/drivers/usb/cdns3/gadget.h >>> @@ -1000,6 +1000,7 @@ struct cdns3_device; >>> * @endpoint: usb endpoint >>> * @pending_req_list: list of requests queuing on transfer ring. >>> * @deferred_req_list: list of requests waiting for queuing on transfer ring. >>> + * @descmiss_req_list: list of requests internally allocated by driver (WA2). >>> * @trb_pool: transfer ring - array of transaction buffers >>> * @trb_pool_dma: dma address of transfer ring >>> * @cdns3_dev: device associated with this endpoint >>> @@ -1026,6 +1027,7 @@ struct cdns3_endpoint { >>> struct usb_ep endpoint; >>> struct list_head pending_req_list; >>> struct list_head deferred_req_list; >>> + struct list_head descmiss_req_list; >>> >>> struct cdns3_trb *trb_pool; >>> dma_addr_t trb_pool_dma; >>> @@ -1041,6 +1043,9 @@ struct cdns3_endpoint { >>> #define EP_PENDING_REQUEST BIT(5) >>> #define EP_RING_FULL BIT(6) >>> #define EP_CLAIMED BIT(7) >>> +#define EP_QUIRK_EXTRA_BUF_DET BIT(8) >>> +#define EP_QUIRK_EXTRA_BUF_EN BIT(9) >>> +#define EP_QUIRK_END_TRANSFER BIT(10) >>> >>> u32 flags; >>> >>> @@ -1074,6 +1079,7 @@ struct cdns3_endpoint { >>> * @start_trb: number of the first TRB in transfer ring >>> * @end_trb: number of the last TRB in transfer ring >>> * @flags: flag specifying special usage of request >>> + * @list: used by internally allocated request to add to descmiss_req_list. >>> */ >>> struct cdns3_request { >>> struct usb_request request; >>> @@ -1086,6 +1092,7 @@ struct cdns3_request { >>> #define REQUEST_INTERNAL_CH BIT(2) >>> #define REQUEST_ZLP BIT(3) >>> u32 flags; >>> + struct list_head list; >>> }; >>> >>> #define to_cdns3_request(r) (container_of(r, struct cdns3_request, request)) >>> >> >> -- >> Texas Instruments Finland Oy, Porkkalankatu 22, 00180 Helsinki. >> Y-tunnus/Business ID: 0615521-4. Kotipaikka/Domicile: Helsinki
> >On 20/02/2019 13:18, Pawel Laszczak wrote: >> Hi Roger. >>> >>> On 14/02/2019 21:45, Pawel Laszczak wrote: >>>> Controller for OUT endpoints has shared on-chip buffers for all incoming >>>> packets, including ep0out. It's FIFO buffer, so packets must be handle >>>> by DMA in correct order. If the first packet in the buffer will not be >>>> handled, then the following packets directed for other endpoints and >>>> functions will be blocked. >>>> >>>> Additionally the packets directed to one endpoint can block entire on-chip >>>> buffers. In this case transfer to other endpoints also will blocked. >>>> >>>> To resolve this issue after raising the descriptor missing interrupt >>>> driver prepares internal usb_request object and use it to arm DMA >>>> transfer. >>>> >>>> The problematic situation was observed in case when endpoint has >>>> been enabled but no usb_request were queued. Driver try detects >>>> such endpoints and will use this workaround only for these endpoint. >>>> >>>> Driver use limited number of buffer. This number can be set by macro >>>> CDNS_WA2_NUM_BUFFERS. >>>> >>>> Such blocking situation was observed on ACM gadget. For this function >>>> host send OUT data packet but ACM function is not prepared for >>>> this packet. It's cause that buffer placed in on chip memory block >>>> transfer to other endpoints. >>>> >>>> It's limitation of controller but maybe this issues should be fixed in >>>> function driver. >>>> >>>> This work around can be disabled/enabled by means of quirk_internal_buffer >>>> module parameter. By default feature is enabled. It can has impact to >>>> transfer performance and in most case this feature can be disabled. >>> >>> How much is the performance impact? >> >> I didn't check this, but performance will be decreased because driver has to >> copy data from internally allocated buffer to usb_request->buff. >> >>> You mentioned that the issue was observed only in the ACM case and >>> could be fixed in the function driver? >>> It seems pointless to enable an endpoint and not have any requests queued for it. >> >> Yes, it’s true. The request in ACM class is send to Controller Driver when user read file associated >> with ACM gadget. Problem exist because host send data to controller but USB controller >> has not prepared buffer for this data by ACM class. >> >>> Isn't fixing the ACM driver (if there is a real issue) a better approach than having >>> a workaround that affects performance of all other use cases? >> >> Yes it should be better. But what ACM driver should do with unexpected data. I'm not sure if we >> can simply delete them. >> >> The best solution would be to make modification in controller. In such case Controller shouldn't accept >> packet but should send NAK. > >Yes, that should be standard behaviour. No? > >> >> One more thing. Workaround has implemented algorithm that decide for which endpoint it should be enabled. >> e.g for composite device MSC+NCM+ACM it should work only for ACM OUT endpoint. >> > >If ACM driver didn't queue the request for ACM OUT endpoint, why does the controller accept the data at all? >I didn't understand why we need a workaround for this. It should be standard behaviour to NAK data if >function driver didn't request for all endpoints. Yes, I agree with you. Controller shouldn’t accept such packet. As I know this behavior will be fixed in RTL. But I assume that some older version of this controller are one the market, and driver should work correct with them. In the feature this workaround can be limited only to selected controllers. Even now I assume that it can be enabled/disabled by module parameter. > >Also I didn't understand why performance should be impacted to just NAK data. Data waiting in on-chip buffers can be very fast copied to system memory when DMA will be armed. In same case this feature can little increase performance, but it makes many problems under OS. Cheers, Pawel >cheers, >-roger > >> Cheers, >> Pawel >>> >>>> >>>> Signed-off-by: Pawel Laszczak <pawell@cadence.com> >>>> --- >>>> drivers/usb/cdns3/gadget.c | 273 ++++++++++++++++++++++++++++++++++++- >>>> drivers/usb/cdns3/gadget.h | 7 + >>>> 2 files changed, 278 insertions(+), 2 deletions(-) >>>> >>>> diff --git a/drivers/usb/cdns3/gadget.c b/drivers/usb/cdns3/gadget.c >>>> index 7f7f24ee3c4b..5dfbe6e1421c 100644 >>>> --- a/drivers/usb/cdns3/gadget.c >>>> +++ b/drivers/usb/cdns3/gadget.c >>>> @@ -27,6 +27,37 @@ >>>> * If (((Dequeue Ptr (i.e. EP_TRADDR) == Enqueue Ptr-1) or >>>> * (Dequeue Ptr (i.e. EP_TRADDR) == Enqueue Ptr)) >>>> * and (DRBL==1 and (not EP0))) >>>> + * >>>> + * Work around 2: >>>> + * Controller for OUT endpoints has shared on-chip buffers for all incoming >>>> + * packets, including ep0out. It's FIFO buffer, so packets must be handle by DMA >>>> + * in correct order. If the first packet in the buffer will not be handled, >>>> + * then the following packets directed for other endpoints and functions >>>> + * will be blocked. >>>> + * Additionally the packets directed to one endpoint can block entire on-chip >>>> + * buffers. In this case transfer to other endpoints also will blocked. >>>> + * >>>> + * To resolve this issue after raising the descriptor missing interrupt >>>> + * driver prepares internal usb_request object and use it to arm DMA transfer. >>>> + * >>>> + * The problematic situation was observed in case when endpoint has been enabled >>>> + * but no usb_request were queued. Driver try detects such endpoints and will >>>> + * use this workaround only for these endpoint. >>>> + * >>>> + * Driver use limited number of buffer. This number can be set by macro >>>> + * CDNS_WA2_NUM_BUFFERS. >>>> + * >>>> + * Such blocking situation was observed on ACM gadget. For this function >>>> + * host send OUT data packet but ACM function is not prepared for this packet. >>>> + * It's cause that buffer placed in on chip memory block transfer to other >>>> + * endpoints. >>>> + * >>>> + * It's limitation of controller but maybe this issues should be fixed in >>>> + * function driver. >>>> + * >>>> + * This work around can be disabled/enabled by means of quirk_internal_buffer >>>> + * module parameter. By default feature is enabled. It can has impact to >>>> + * transfer performance and in most case this feature can be disabled. >>>> */ >>>> >>>> #include <linux/dma-mapping.h> >>>> @@ -42,6 +73,14 @@ static int __cdns3_gadget_ep_queue(struct usb_ep *ep, >>>> struct usb_request *request, >>>> gfp_t gfp_flags); >>>> >>>> +/* >>>> + * Parameter allows to disable/enable handling of work around 2 feature. >>>> + * By default this value is enabled. >>>> + */ >>>> +static bool quirk_internal_buffer = 1; >>>> +module_param(quirk_internal_buffer, bool, 0644); >>>> +MODULE_PARM_DESC(quirk_internal_buffer, "Disable/enable WA2 algorithm"); >>>> + >>>> /** >>>> * cdns3_handshake - spin reading until handshake completes or fails >>>> * @ptr: address of device controller register to be read >>>> @@ -105,6 +144,17 @@ struct usb_request *cdns3_next_request(struct list_head *list) >>>> return list_first_entry_or_null(list, struct usb_request, list); >>>> } >>>> >>>> +/** >>>> + * cdns3_next_priv_request - returns next request from list >>>> + * @list: list containing requests >>>> + * >>>> + * Returns request or NULL if no requests in list >>>> + */ >>>> +struct cdns3_request *cdns3_next_priv_request(struct list_head *list) >>>> +{ >>>> + return list_first_entry_or_null(list, struct cdns3_request, list); >>>> +} >>>> + >>>> /** >>>> * select_ep - selects endpoint >>>> * @priv_dev: extended gadget object >>>> @@ -384,6 +434,53 @@ static int cdns3_start_all_request(struct cdns3_device *priv_dev, >>>> return ret; >>>> } >>>> >>>> +/** >>>> + * cdns3_descmiss_copy_data copy data from internal requests to request queued >>>> + * by class driver. >>>> + * @priv_ep: extended endpoint object >>>> + * @request: request object >>>> + */ >>>> +static void cdns3_descmiss_copy_data(struct cdns3_endpoint *priv_ep, >>>> + struct usb_request *request) >>>> +{ >>>> + struct usb_request *descmiss_req; >>>> + struct cdns3_request *descmiss_priv_req; >>>> + >>>> + while (!list_empty(&priv_ep->descmiss_req_list)) { >>>> + int chunk_end; >>>> + int length; >>>> + >>>> + descmiss_priv_req = >>>> + cdns3_next_priv_request(&priv_ep->descmiss_req_list); >>>> + descmiss_req = &descmiss_priv_req->request; >>>> + >>>> + /* driver can't touch pending request */ >>>> + if (descmiss_priv_req->flags & REQUEST_PENDING) >>>> + break; >>>> + >>>> + chunk_end = descmiss_priv_req->flags & REQUEST_INTERNAL_CH; >>>> + length = request->actual + descmiss_req->actual; >>>> + >>>> + if (length <= request->length) { >>>> + memcpy(&((u8 *)request->buf)[request->actual], >>>> + descmiss_req->buf, >>>> + descmiss_req->actual); >>>> + request->actual = length; >>>> + } else { >>>> + /* It should never occures */ >>>> + request->status = -ENOMEM; >>>> + } >>>> + >>>> + list_del_init(&descmiss_priv_req->list); >>>> + >>>> + kfree(descmiss_req->buf); >>>> + cdns3_gadget_ep_free_request(&priv_ep->endpoint, descmiss_req); >>>> + >>>> + if (!chunk_end) >>>> + break; >>>> + } >>>> +} >>>> + >>>> /** >>>> * cdns3_gadget_giveback - call struct usb_request's ->complete callback >>>> * @priv_ep: The endpoint to whom the request belongs to >>>> @@ -412,6 +509,32 @@ void cdns3_gadget_giveback(struct cdns3_endpoint *priv_ep, >>>> priv_req->flags &= ~REQUEST_PENDING; >>>> trace_cdns3_gadget_giveback(priv_req); >>>> >>>> + /* WA2: */ >>>> + if (priv_ep->flags & EP_QUIRK_EXTRA_BUF_EN && >>>> + priv_req->flags & REQUEST_INTERNAL) { >>>> + struct usb_request *req; >>>> + >>>> + req = cdns3_next_request(&priv_ep->deferred_req_list); >>>> + request = req; >>>> + priv_ep->descmis_req = NULL; >>>> + >>>> + if (!req) >>>> + return; >>>> + >>>> + cdns3_descmiss_copy_data(priv_ep, req); >>>> + if (!(priv_ep->flags & EP_QUIRK_END_TRANSFER) && >>>> + req->length != req->actual) { >>>> + /* wait for next part of transfer */ >>>> + return; >>>> + } >>>> + >>>> + if (req->status == -EINPROGRESS) >>>> + req->status = 0; >>>> + >>>> + list_del_init(&req->list); >>>> + cdns3_start_all_request(priv_dev, priv_ep); >>>> + } >>>> + >>>> /* Start all not pending request */ >>>> if (priv_ep->flags & EP_RING_FULL) >>>> cdns3_start_all_request(priv_dev, priv_ep); >>>> @@ -774,6 +897,59 @@ void cdns3_rearm_transfer(struct cdns3_endpoint *priv_ep, u8 rearm) >>>> } >>>> } >>>> >>>> +/** >>>> + * cdns3_descmissing_packet - handles descriptor missing event. >>>> + * @priv_dev: extended gadget object >>>> + * >>>> + * This function is used only for WA2. For more information see Work around 2 >>>> + * description. >>>> + */ >>>> +static int cdns3_descmissing_packet(struct cdns3_endpoint *priv_ep) >>>> +{ >>>> + struct cdns3_request *priv_req; >>>> + struct usb_request *request; >>>> + >>>> + if (priv_ep->flags & EP_QUIRK_EXTRA_BUF_DET) { >>>> + priv_ep->flags &= ~EP_QUIRK_EXTRA_BUF_DET; >>>> + priv_ep->flags |= EP_QUIRK_EXTRA_BUF_EN; >>>> + } >>>> + >>>> + cdns3_dbg(priv_ep->cdns3_dev, "WA2: Description Missing detected\n"); >>>> + >>>> + request = cdns3_gadget_ep_alloc_request(&priv_ep->endpoint, >>>> + GFP_ATOMIC); >>>> + if (!request) >>>> + return -ENOMEM; >>>> + >>>> + priv_req = to_cdns3_request(request); >>>> + priv_req->flags |= REQUEST_INTERNAL; >>>> + >>>> + /* if this field is still assigned it indicate that transfer related >>>> + * with this request has not been finished yet. Driver in this >>>> + * case simply allocate next request and assign flag REQUEST_INTERNAL_CH >>>> + * flag to previous one. It will indicate that current request is >>>> + * part of the previous one. >>>> + */ >>>> + if (priv_ep->descmis_req) >>>> + priv_ep->descmis_req->flags |= REQUEST_INTERNAL_CH; >>>> + >>>> + priv_req->request.buf = kzalloc(CDNS3_DESCMIS_BUF_SIZE, >>>> + GFP_ATOMIC); >>>> + if (!priv_req) { >>>> + cdns3_gadget_ep_free_request(&priv_ep->endpoint, request); >>>> + return -ENOMEM; >>>> + } >>>> + >>>> + priv_req->request.length = CDNS3_DESCMIS_BUF_SIZE; >>>> + priv_ep->descmis_req = priv_req; >>>> + >>>> + __cdns3_gadget_ep_queue(&priv_ep->endpoint, >>>> + &priv_ep->descmis_req->request, >>>> + GFP_ATOMIC); >>>> + >>>> + return 0; >>>> +} >>>> + >>>> /** >>>> * cdns3_check_ep_interrupt_proceed - Processes interrupt related to endpoint >>>> * @priv_ep: endpoint object >>>> @@ -807,8 +983,31 @@ static int cdns3_check_ep_interrupt_proceed(struct cdns3_endpoint *priv_ep) >>>> cdns3_rearm_transfer(priv_ep, priv_ep->wa1_set); >>>> } >>>> >>>> - if ((ep_sts_reg & EP_STS_IOC) || (ep_sts_reg & EP_STS_ISP)) >>>> + if ((ep_sts_reg & EP_STS_IOC) || (ep_sts_reg & EP_STS_ISP)) { >>>> + if (priv_ep->flags & EP_QUIRK_EXTRA_BUF_EN) { >>>> + if (ep_sts_reg & EP_STS_ISP) >>>> + priv_ep->flags |= EP_QUIRK_END_TRANSFER; >>>> + else >>>> + priv_ep->flags &= ~EP_QUIRK_END_TRANSFER; >>>> + } >>>> + >>>> cdns3_transfer_completed(priv_dev, priv_ep); >>>> + } >>>> + >>>> + /* >>>> + * WA2: this condition should only be meet when >>>> + * priv_ep->flags & EP_QUIRK_EXTRA_BUF_DET or >>>> + * priv_ep->flags & EP_QUIRK_EXTRA_BUF_EN. >>>> + * In other cases this interrupt will be disabled/ >>>> + */ >>>> + if (ep_sts_reg & EP_STS_DESCMIS) { >>>> + int err; >>>> + >>>> + err = cdns3_descmissing_packet(priv_ep); >>>> + if (err) >>>> + dev_err(priv_dev->dev, >>>> + "Failed: No sufficient memory for DESCMIS\n"); >>>> + } >>>> >>>> return 0; >>>> } >>>> @@ -1241,13 +1440,26 @@ static int cdns3_gadget_ep_enable(struct usb_ep *ep, >>>> /* enable interrupt for selected endpoint */ >>>> cdns3_set_register_bit(&priv_dev->regs->ep_ien, >>>> BIT(cdns3_ep_addr_to_index(bEndpointAddress))); >>>> + /* >>>> + * WA2: Set flag for all not ISOC OUT endpoints. If this flag is set >>>> + * driver try to detect whether endpoint need additional internal >>>> + * buffer for unblocking on-chip FIFO buffer. This flag will be cleared >>>> + * if before first DESCMISS interrupt the DMA will be armed. >>>> + */ >>>> + if (quirk_internal_buffer) { >>>> + if (!priv_ep->dir && priv_ep->type != USB_ENDPOINT_XFER_ISOC) { >>>> + priv_ep->flags |= EP_QUIRK_EXTRA_BUF_DET; >>>> + reg |= EP_STS_EN_DESCMISEN; >>>> + } >>>> + } >>>> >>>> writel(reg, &priv_dev->regs->ep_sts_en); >>>> >>>> cdns3_set_register_bit(&priv_dev->regs->ep_cfg, EP_CFG_ENABLE); >>>> >>>> ep->desc = desc; >>>> - priv_ep->flags &= ~(EP_PENDING_REQUEST | EP_STALL); >>>> + priv_ep->flags &= ~(EP_PENDING_REQUEST | EP_STALL | >>>> + EP_QUIRK_EXTRA_BUF_EN); >>>> priv_ep->flags |= EP_ENABLED | EP_UPDATE_EP_TRBADDR; >>>> priv_ep->wa1_set = 0; >>>> priv_ep->enqueue = 0; >>>> @@ -1272,6 +1484,7 @@ static int cdns3_gadget_ep_enable(struct usb_ep *ep, >>>> static int cdns3_gadget_ep_disable(struct usb_ep *ep) >>>> { >>>> struct cdns3_endpoint *priv_ep; >>>> + struct cdns3_request *priv_req; >>>> struct cdns3_device *priv_dev; >>>> struct usb_request *request; >>>> unsigned long flags; >>>> @@ -1308,6 +1521,14 @@ static int cdns3_gadget_ep_disable(struct usb_ep *ep) >>>> -ESHUTDOWN); >>>> } >>>> >>>> + while (!list_empty(&priv_ep->descmiss_req_list)) { >>>> + priv_req = cdns3_next_priv_request(&priv_ep->descmiss_req_list); >>>> + >>>> + kfree(priv_req->request.buf); >>>> + cdns3_gadget_ep_free_request(&priv_ep->endpoint, >>>> + &priv_req->request); >>>> + } >>>> + >>>> while (!list_empty(&priv_ep->deferred_req_list)) { >>>> request = cdns3_next_request(&priv_ep->deferred_req_list); >>>> >>>> @@ -1348,6 +1569,53 @@ static int __cdns3_gadget_ep_queue(struct usb_ep *ep, >>>> priv_req = to_cdns3_request(request); >>>> trace_cdns3_ep_queue(priv_req); >>>> >>>> + /* >>>> + * WA2: if transfer was queued before DESCMISS appear than we >>>> + * can disable handling of DESCMISS interrupt. Driver assumes that it >>>> + * can disable special treatment for this endpoint. >>>> + */ >>>> + if (priv_ep->flags & EP_QUIRK_EXTRA_BUF_DET) { >>>> + u32 reg; >>>> + >>>> + cdns3_select_ep(priv_dev, priv_ep->num | priv_ep->dir); >>>> + priv_ep->flags &= ~EP_QUIRK_EXTRA_BUF_DET; >>>> + reg = readl(&priv_dev->regs->ep_sts_en); >>>> + reg &= ~EP_STS_EN_DESCMISEN; >>>> + writel(reg, &priv_dev->regs->ep_sts_en); >>>> + } >>>> + >>>> + /* WA2 */ >>>> + if (priv_ep->flags & EP_QUIRK_EXTRA_BUF_EN) { >>>> + u8 pending_empty = list_empty(&priv_ep->pending_req_list); >>>> + u8 descmiss_empty = list_empty(&priv_ep->descmiss_req_list); >>>> + >>>> + /* >>>> + * DESCMISS transfer has been finished, so data will be >>>> + * directly copied from internal allocated usb_request >>>> + * objects. >>>> + */ >>>> + if (pending_empty && !descmiss_empty && >>>> + !(priv_req->flags & REQUEST_INTERNAL)) { >>>> + cdns3_descmiss_copy_data(priv_ep, request); >>>> + list_add_tail(&request->list, >>>> + &priv_ep->pending_req_list); >>>> + cdns3_gadget_giveback(priv_ep, priv_req, >>>> + request->status); >>>> + return ret; >>>> + } >>>> + >>>> + /* >>>> + * WA2 driver will wait for completion DESCMISS transfer, >>>> + * before starts new, not DESCMISS transfer. >>>> + */ >>>> + if (!pending_empty && !descmiss_empty) >>>> + deferred = 1; >>>> + >>>> + if (priv_req->flags & REQUEST_INTERNAL) >>>> + list_add_tail(&priv_req->list, >>>> + &priv_ep->descmiss_req_list); >>>> + } >>>> + >>>> ret = usb_gadget_map_request_by_dev(priv_dev->sysdev, request, >>>> usb_endpoint_dir_in(ep->desc)); >>>> if (ret) >>>> @@ -1782,6 +2050,7 @@ static int cdns3_init_eps(struct cdns3_device *priv_dev) >>>> >>>> INIT_LIST_HEAD(&priv_ep->pending_req_list); >>>> INIT_LIST_HEAD(&priv_ep->deferred_req_list); >>>> + INIT_LIST_HEAD(&priv_ep->descmiss_req_list); >>>> } >>>> >>>> return 0; >>>> diff --git a/drivers/usb/cdns3/gadget.h b/drivers/usb/cdns3/gadget.h >>>> index 817f8ae7a4da..8de733b315e9 100644 >>>> --- a/drivers/usb/cdns3/gadget.h >>>> +++ b/drivers/usb/cdns3/gadget.h >>>> @@ -1000,6 +1000,7 @@ struct cdns3_device; >>>> * @endpoint: usb endpoint >>>> * @pending_req_list: list of requests queuing on transfer ring. >>>> * @deferred_req_list: list of requests waiting for queuing on transfer ring. >>>> + * @descmiss_req_list: list of requests internally allocated by driver (WA2). >>>> * @trb_pool: transfer ring - array of transaction buffers >>>> * @trb_pool_dma: dma address of transfer ring >>>> * @cdns3_dev: device associated with this endpoint >>>> @@ -1026,6 +1027,7 @@ struct cdns3_endpoint { >>>> struct usb_ep endpoint; >>>> struct list_head pending_req_list; >>>> struct list_head deferred_req_list; >>>> + struct list_head descmiss_req_list; >>>> >>>> struct cdns3_trb *trb_pool; >>>> dma_addr_t trb_pool_dma; >>>> @@ -1041,6 +1043,9 @@ struct cdns3_endpoint { >>>> #define EP_PENDING_REQUEST BIT(5) >>>> #define EP_RING_FULL BIT(6) >>>> #define EP_CLAIMED BIT(7) >>>> +#define EP_QUIRK_EXTRA_BUF_DET BIT(8) >>>> +#define EP_QUIRK_EXTRA_BUF_EN BIT(9) >>>> +#define EP_QUIRK_END_TRANSFER BIT(10) >>>> >>>> u32 flags; >>>> >>>> @@ -1074,6 +1079,7 @@ struct cdns3_endpoint { >>>> * @start_trb: number of the first TRB in transfer ring >>>> * @end_trb: number of the last TRB in transfer ring >>>> * @flags: flag specifying special usage of request >>>> + * @list: used by internally allocated request to add to descmiss_req_list. >>>> */ >>>> struct cdns3_request { >>>> struct usb_request request; >>>> @@ -1086,6 +1092,7 @@ struct cdns3_request { >>>> #define REQUEST_INTERNAL_CH BIT(2) >>>> #define REQUEST_ZLP BIT(3) >>>> u32 flags; >>>> + struct list_head list; >>>> }; >>>> >>>> #define to_cdns3_request(r) (container_of(r, struct cdns3_request, request)) >>>> >>> >>> -- >>> Texas Instruments Finland Oy, Porkkalankatu 22, 00180 Helsinki. >>> Y-tunnus/Business ID: 0615521-4. Kotipaikka/Domicile: Helsinki > >-- >Texas Instruments Finland Oy, Porkkalankatu 22, 00180 Helsinki. >Y-tunnus/Business ID: 0615521-4. Kotipaikka/Domicile: Helsinki
Hi, (please break your emails at 80-columns) Pawel Laszczak <pawell@cadence.com> writes: >>> One more thing. Workaround has implemented algorithm that decide for which >>> endpoint it should be enabled. e.g for composite device MSC+NCM+ACM it >>> should work only for ACM OUT endpoint. >>> >> >>If ACM driver didn't queue the request for ACM OUT endpoint, why does the >>controller accept the data at all? >> >>I didn't understand why we need a workaround for this. It should be standard >>behaviour to NAK data if function driver didn't request for all endpoints. > > Yes, I agree with you. Controller shouldn’t accept such packet. As I know this > behavior will be fixed in RTL. > > But I assume that some older version of this controller are one the market, > and driver should work correct with them. > > In the feature this workaround can be limited only to selected controllers. > > Even now I assume that it can be enabled/disabled by module parameter. no module parameters, please. Use revision detection in runtime.
Hi, On 21/02/2019 09:14, Felipe Balbi wrote: > > Hi, > > (please break your emails at 80-columns) > > Pawel Laszczak <pawell@cadence.com> writes: >>>> One more thing. Workaround has implemented algorithm that decide for which >>>> endpoint it should be enabled. e.g for composite device MSC+NCM+ACM it >>>> should work only for ACM OUT endpoint. >>>> >>> >>> If ACM driver didn't queue the request for ACM OUT endpoint, why does the >>> controller accept the data at all? >>> >>> I didn't understand why we need a workaround for this. It should be standard >>> behaviour to NAK data if function driver didn't request for all endpoints. >> >> Yes, I agree with you. Controller shouldn’t accept such packet. As I know this >> behavior will be fixed in RTL. >> >> But I assume that some older version of this controller are one the market, >> and driver should work correct with them. >> >> In the feature this workaround can be limited only to selected controllers. >> >> Even now I assume that it can be enabled/disabled by module parameter. > > no module parameters, please. Use revision detection in runtime. > This is about whether to enable or disable the workaround. By default we don't want this workaround to be enabled. I'm debating whether we should have this workaround at all or not. It has the following problems. 1) It ACKs packets even when gadget end is not ready to accept the transfers. 2) It stores these packets in a temporary buffer and then pushes them to the gadget driver whenever the gadget driver is ready to process the data. 3) Since the gadget driver can become ready at an indefinite time in the future, it poses 2 problems: a) It is sending stale data to the sink. (problematic at next protocol level?) b) If this temporary buffer runs out we still hit the lock up issue. I think the right solution is to make sure that the gadget driver is always reading all the enabled OUT endpoints *or* (keep the OUT endpoints disabled if gadget driver is not ready to process OUT transfers). cheers, -roger
Hi, >Hi, > >On 21/02/2019 09:14, Felipe Balbi wrote: >> >> Hi, >> >> (please break your emails at 80-columns) >> >> Pawel Laszczak <pawell@cadence.com> writes: >>>>> One more thing. Workaround has implemented algorithm that decide for which >>>>> endpoint it should be enabled. e.g for composite device MSC+NCM+ACM it >>>>> should work only for ACM OUT endpoint. >>>>> >>>> >>>> If ACM driver didn't queue the request for ACM OUT endpoint, why does the >>>> controller accept the data at all? >>>> >>>> I didn't understand why we need a workaround for this. It should be standard >>>> behaviour to NAK data if function driver didn't request for all endpoints. >>> >>> Yes, I agree with you. Controller shouldn’t accept such packet. As I know this >>> behavior will be fixed in RTL. >>> >>> But I assume that some older version of this controller are one the market, >>> and driver should work correct with them. >>> >>> In the feature this workaround can be limited only to selected controllers. >>> >>> Even now I assume that it can be enabled/disabled by module parameter. >> >> no module parameters, please. Use revision detection in runtime. >> > >This is about whether to enable or disable the workaround. >By default we don't want this workaround to be enabled. > >I'm debating whether we should have this workaround at all or not. > >It has the following problems. > >1) It ACKs packets even when gadget end is not ready to accept the transfers. >2) It stores these packets in a temporary buffer and then pushes them to the >gadget driver whenever the gadget driver is ready to process the data. >3) Since the gadget driver can become ready at an indefinite time in the >future, it poses 2 problems: > a) It is sending stale data to the sink. (problematic at next protocol level?) > b) If this temporary buffer runs out we still hit the lock up issue. > >I think the right solution is to make sure that the gadget driver is always >reading all the enabled OUT endpoints *or* (keep the OUT endpoints disabled >if gadget driver is not ready to process OUT transfers). If driver disable endpoint then it not answer for packets from host. It will result that host reset the device, so I can't disable such endpoints. Other good solution is to change ACM driver in a way that it sends requests to controller driver after enabling endpoint. The class driver could decide what should do with such not expected packets. It could delete all or e.g keep only few last packets. This issue will be fixed in RTL but maybe driver should be compatible with previous controller’s version. By default, this workaround will be disabled or will depend on controller version. > >cheers, >-roger >-- >Texas Instruments Finland Oy, Porkkalankatu 22, 00180 Helsinki. >Y-tunnus/Business ID: 0615521-4. Kotipaikka/Domicile: Helsinki Cheers, Pawel
On 07/03/2019 09:06, Pawel Laszczak wrote: > Hi, > >> Hi, >> >> On 21/02/2019 09:14, Felipe Balbi wrote: >>> >>> Hi, >>> >>> (please break your emails at 80-columns) >>> >>> Pawel Laszczak <pawell@cadence.com> writes: >>>>>> One more thing. Workaround has implemented algorithm that decide for which >>>>>> endpoint it should be enabled. e.g for composite device MSC+NCM+ACM it >>>>>> should work only for ACM OUT endpoint. >>>>>> >>>>> >>>>> If ACM driver didn't queue the request for ACM OUT endpoint, why does the >>>>> controller accept the data at all? >>>>> >>>>> I didn't understand why we need a workaround for this. It should be standard >>>>> behaviour to NAK data if function driver didn't request for all endpoints. >>>> >>>> Yes, I agree with you. Controller shouldn’t accept such packet. As I know this >>>> behavior will be fixed in RTL. >>>> >>>> But I assume that some older version of this controller are one the market, >>>> and driver should work correct with them. >>>> >>>> In the feature this workaround can be limited only to selected controllers. >>>> >>>> Even now I assume that it can be enabled/disabled by module parameter. >>> >>> no module parameters, please. Use revision detection in runtime. >>> >> >> This is about whether to enable or disable the workaround. >> By default we don't want this workaround to be enabled. >> >> I'm debating whether we should have this workaround at all or not. >> >> It has the following problems. >> >> 1) It ACKs packets even when gadget end is not ready to accept the transfers. >> 2) It stores these packets in a temporary buffer and then pushes them to the >> gadget driver whenever the gadget driver is ready to process the data. >> 3) Since the gadget driver can become ready at an indefinite time in the >> future, it poses 2 problems: >> a) It is sending stale data to the sink. (problematic at next protocol level?) >> b) If this temporary buffer runs out we still hit the lock up issue. >> >> I think the right solution is to make sure that the gadget driver is always >> reading all the enabled OUT endpoints *or* (keep the OUT endpoints disabled >> if gadget driver is not ready to process OUT transfers). > > If driver disable endpoint then it not answer for packets from host. > It will result that host reset the device, so I can't disable such endpoints. > > Other good solution is to change ACM driver in a way that it sends requests > to controller driver after enabling endpoint. The class driver could decide The ACM driver is doing exactly that. However, there is a large delay (depending on when user opens the ttyACM) between endpoint enable and request queue and that's the issue for this controller. The endpoint is enabled whenever the host sends a SET_INTERFACE [acm_set_alt()->gserial_connect()] but the first request is queued only when user opens the ttyACM [gs_open()->gs_start_io()->gs_start_rx()]. I'm don't think this sequence can be changed. What happens if you defer gserial_connect() to be done at gs_open()? > what should do with such not expected packets. It could delete all or e.g > keep only few last packets. > > This issue will be fixed in RTL but maybe driver should be compatible with previous > controller’s version. > > By default, this workaround will be disabled or will depend on controller version. >> > > Cheers, > Pawel >
> > On 07/03/2019 09:06, Pawel Laszczak wrote: > > Hi, > > > >> Hi, > >> > >> On 21/02/2019 09:14, Felipe Balbi wrote: > >>> > >>> Hi, > >>> > >>> (please break your emails at 80-columns) > >>> > >>> Pawel Laszczak <pawell@cadence.com> writes: > >>>>>> One more thing. Workaround has implemented algorithm that decide for which > >>>>>> endpoint it should be enabled. e.g for composite device MSC+NCM+ACM it > >>>>>> should work only for ACM OUT endpoint. > >>>>>> > >>>>> > >>>>> If ACM driver didn't queue the request for ACM OUT endpoint, why does the > >>>>> controller accept the data at all? > >>>>> > >>>>> I didn't understand why we need a workaround for this. It should be standard > >>>>> behaviour to NAK data if function driver didn't request for all endpoints. > >>>> > >>>> Yes, I agree with you. Controller shouldn’t accept such packet. As I know this > >>>> behavior will be fixed in RTL. > >>>> > >>>> But I assume that some older version of this controller are one the market, > >>>> and driver should work correct with them. > >>>> > >>>> In the feature this workaround can be limited only to selected controllers. > >>>> > >>>> Even now I assume that it can be enabled/disabled by module parameter. > >>> > >>> no module parameters, please. Use revision detection in runtime. > >>> > >> > >> This is about whether to enable or disable the workaround. > >> By default we don't want this workaround to be enabled. > >> > >> I'm debating whether we should have this workaround at all or not. > >> > >> It has the following problems. > >> > >> 1) It ACKs packets even when gadget end is not ready to accept the transfers. > >> 2) It stores these packets in a temporary buffer and then pushes them to the > >> gadget driver whenever the gadget driver is ready to process the data. > >> 3) Since the gadget driver can become ready at an indefinite time in the > >> future, it poses 2 problems: > >> a) It is sending stale data to the sink. (problematic at next protocol level?) > >> b) If this temporary buffer runs out we still hit the lock up issue. > >> > >> I think the right solution is to make sure that the gadget driver is always > >> reading all the enabled OUT endpoints *or* (keep the OUT endpoints disabled > >> if gadget driver is not ready to process OUT transfers). > > > > If driver disable endpoint then it not answer for packets from host. > > It will result that host reset the device, so I can't disable such endpoints. > > > > Other good solution is to change ACM driver in a way that it sends requests > > to controller driver after enabling endpoint. The class driver could decide > > The ACM driver is doing exactly that. However, there is a large delay (depending > on when user opens the ttyACM) between endpoint enable and request queue and > that's the issue for this controller. > > The endpoint is enabled whenever the host sends a SET_INTERFACE > [acm_set_alt()->gserial_connect()] > but the first request is queued only when user opens the ttyACM > [gs_open()->gs_start_io()->gs_start_rx()]. > > I'm don't think this sequence can be changed. > What happens if you defer gserial_connect() to be done at gs_open()? > The host controller receives error due to there is no NAK either ACK for endpoint which should have already enabled. The host may send bus reset due to the response timeout for specific endpoint. This issue only affects multiple OUT use case, we run this issue after configuring gadget as ACM + NCM, NCM can't work (always responds NAKs for OUT) due to ACM endpoint receives host's data but the user doesn't receive it, since all OUT endpoints share the same FIFOs. So, if we do not enable this workaround, the multiple OUT endpoints use case may not work well since one OUT endpoint may affect other OUT endpoints due to it occupies the common OUT FIFO. If we enable this workaround, for your below question: > >> It has the following problems. > >> > >> 1) It ACKs packets even when gadget end is not ready to accept the transfers. This can't be controlled by software, HW does it automatically once we enable endpoint. > >> 2) It stores these packets in a temporary buffer and then pushes them to the > >> gadget driver whenever the gadget driver is ready to process the data. > >> 3) Since the gadget driver can become ready at an indefinite time in the > >> future, it poses 2 problems: > >> a) It is sending stale data to the sink. (problematic at next protocol level?) Maybe. The protocol may be recovered after several talks, eg, the device finds the stale data, and let the host re-send. > >> b) If this temporary buffer runs out we still hit the lock up issue. > >> It can be improved, if the temporary buffer is full, we could discard some oldest data. So, if not enable this workaround, the USB function is affected due to physical data can't be received, else, we may receive the stale data for some specific use cases, it only affect its own OUT endpoint, it may be recovered by protocol layer. I prefer enabling it by default if this workaround is well tested. Peter
diff --git a/drivers/usb/cdns3/gadget.c b/drivers/usb/cdns3/gadget.c index 7f7f24ee3c4b..5dfbe6e1421c 100644 --- a/drivers/usb/cdns3/gadget.c +++ b/drivers/usb/cdns3/gadget.c @@ -27,6 +27,37 @@ * If (((Dequeue Ptr (i.e. EP_TRADDR) == Enqueue Ptr-1) or * (Dequeue Ptr (i.e. EP_TRADDR) == Enqueue Ptr)) * and (DRBL==1 and (not EP0))) + * + * Work around 2: + * Controller for OUT endpoints has shared on-chip buffers for all incoming + * packets, including ep0out. It's FIFO buffer, so packets must be handle by DMA + * in correct order. If the first packet in the buffer will not be handled, + * then the following packets directed for other endpoints and functions + * will be blocked. + * Additionally the packets directed to one endpoint can block entire on-chip + * buffers. In this case transfer to other endpoints also will blocked. + * + * To resolve this issue after raising the descriptor missing interrupt + * driver prepares internal usb_request object and use it to arm DMA transfer. + * + * The problematic situation was observed in case when endpoint has been enabled + * but no usb_request were queued. Driver try detects such endpoints and will + * use this workaround only for these endpoint. + * + * Driver use limited number of buffer. This number can be set by macro + * CDNS_WA2_NUM_BUFFERS. + * + * Such blocking situation was observed on ACM gadget. For this function + * host send OUT data packet but ACM function is not prepared for this packet. + * It's cause that buffer placed in on chip memory block transfer to other + * endpoints. + * + * It's limitation of controller but maybe this issues should be fixed in + * function driver. + * + * This work around can be disabled/enabled by means of quirk_internal_buffer + * module parameter. By default feature is enabled. It can has impact to + * transfer performance and in most case this feature can be disabled. */ #include <linux/dma-mapping.h> @@ -42,6 +73,14 @@ static int __cdns3_gadget_ep_queue(struct usb_ep *ep, struct usb_request *request, gfp_t gfp_flags); +/* + * Parameter allows to disable/enable handling of work around 2 feature. + * By default this value is enabled. + */ +static bool quirk_internal_buffer = 1; +module_param(quirk_internal_buffer, bool, 0644); +MODULE_PARM_DESC(quirk_internal_buffer, "Disable/enable WA2 algorithm"); + /** * cdns3_handshake - spin reading until handshake completes or fails * @ptr: address of device controller register to be read @@ -105,6 +144,17 @@ struct usb_request *cdns3_next_request(struct list_head *list) return list_first_entry_or_null(list, struct usb_request, list); } +/** + * cdns3_next_priv_request - returns next request from list + * @list: list containing requests + * + * Returns request or NULL if no requests in list + */ +struct cdns3_request *cdns3_next_priv_request(struct list_head *list) +{ + return list_first_entry_or_null(list, struct cdns3_request, list); +} + /** * select_ep - selects endpoint * @priv_dev: extended gadget object @@ -384,6 +434,53 @@ static int cdns3_start_all_request(struct cdns3_device *priv_dev, return ret; } +/** + * cdns3_descmiss_copy_data copy data from internal requests to request queued + * by class driver. + * @priv_ep: extended endpoint object + * @request: request object + */ +static void cdns3_descmiss_copy_data(struct cdns3_endpoint *priv_ep, + struct usb_request *request) +{ + struct usb_request *descmiss_req; + struct cdns3_request *descmiss_priv_req; + + while (!list_empty(&priv_ep->descmiss_req_list)) { + int chunk_end; + int length; + + descmiss_priv_req = + cdns3_next_priv_request(&priv_ep->descmiss_req_list); + descmiss_req = &descmiss_priv_req->request; + + /* driver can't touch pending request */ + if (descmiss_priv_req->flags & REQUEST_PENDING) + break; + + chunk_end = descmiss_priv_req->flags & REQUEST_INTERNAL_CH; + length = request->actual + descmiss_req->actual; + + if (length <= request->length) { + memcpy(&((u8 *)request->buf)[request->actual], + descmiss_req->buf, + descmiss_req->actual); + request->actual = length; + } else { + /* It should never occures */ + request->status = -ENOMEM; + } + + list_del_init(&descmiss_priv_req->list); + + kfree(descmiss_req->buf); + cdns3_gadget_ep_free_request(&priv_ep->endpoint, descmiss_req); + + if (!chunk_end) + break; + } +} + /** * cdns3_gadget_giveback - call struct usb_request's ->complete callback * @priv_ep: The endpoint to whom the request belongs to @@ -412,6 +509,32 @@ void cdns3_gadget_giveback(struct cdns3_endpoint *priv_ep, priv_req->flags &= ~REQUEST_PENDING; trace_cdns3_gadget_giveback(priv_req); + /* WA2: */ + if (priv_ep->flags & EP_QUIRK_EXTRA_BUF_EN && + priv_req->flags & REQUEST_INTERNAL) { + struct usb_request *req; + + req = cdns3_next_request(&priv_ep->deferred_req_list); + request = req; + priv_ep->descmis_req = NULL; + + if (!req) + return; + + cdns3_descmiss_copy_data(priv_ep, req); + if (!(priv_ep->flags & EP_QUIRK_END_TRANSFER) && + req->length != req->actual) { + /* wait for next part of transfer */ + return; + } + + if (req->status == -EINPROGRESS) + req->status = 0; + + list_del_init(&req->list); + cdns3_start_all_request(priv_dev, priv_ep); + } + /* Start all not pending request */ if (priv_ep->flags & EP_RING_FULL) cdns3_start_all_request(priv_dev, priv_ep); @@ -774,6 +897,59 @@ void cdns3_rearm_transfer(struct cdns3_endpoint *priv_ep, u8 rearm) } } +/** + * cdns3_descmissing_packet - handles descriptor missing event. + * @priv_dev: extended gadget object + * + * This function is used only for WA2. For more information see Work around 2 + * description. + */ +static int cdns3_descmissing_packet(struct cdns3_endpoint *priv_ep) +{ + struct cdns3_request *priv_req; + struct usb_request *request; + + if (priv_ep->flags & EP_QUIRK_EXTRA_BUF_DET) { + priv_ep->flags &= ~EP_QUIRK_EXTRA_BUF_DET; + priv_ep->flags |= EP_QUIRK_EXTRA_BUF_EN; + } + + cdns3_dbg(priv_ep->cdns3_dev, "WA2: Description Missing detected\n"); + + request = cdns3_gadget_ep_alloc_request(&priv_ep->endpoint, + GFP_ATOMIC); + if (!request) + return -ENOMEM; + + priv_req = to_cdns3_request(request); + priv_req->flags |= REQUEST_INTERNAL; + + /* if this field is still assigned it indicate that transfer related + * with this request has not been finished yet. Driver in this + * case simply allocate next request and assign flag REQUEST_INTERNAL_CH + * flag to previous one. It will indicate that current request is + * part of the previous one. + */ + if (priv_ep->descmis_req) + priv_ep->descmis_req->flags |= REQUEST_INTERNAL_CH; + + priv_req->request.buf = kzalloc(CDNS3_DESCMIS_BUF_SIZE, + GFP_ATOMIC); + if (!priv_req) { + cdns3_gadget_ep_free_request(&priv_ep->endpoint, request); + return -ENOMEM; + } + + priv_req->request.length = CDNS3_DESCMIS_BUF_SIZE; + priv_ep->descmis_req = priv_req; + + __cdns3_gadget_ep_queue(&priv_ep->endpoint, + &priv_ep->descmis_req->request, + GFP_ATOMIC); + + return 0; +} + /** * cdns3_check_ep_interrupt_proceed - Processes interrupt related to endpoint * @priv_ep: endpoint object @@ -807,8 +983,31 @@ static int cdns3_check_ep_interrupt_proceed(struct cdns3_endpoint *priv_ep) cdns3_rearm_transfer(priv_ep, priv_ep->wa1_set); } - if ((ep_sts_reg & EP_STS_IOC) || (ep_sts_reg & EP_STS_ISP)) + if ((ep_sts_reg & EP_STS_IOC) || (ep_sts_reg & EP_STS_ISP)) { + if (priv_ep->flags & EP_QUIRK_EXTRA_BUF_EN) { + if (ep_sts_reg & EP_STS_ISP) + priv_ep->flags |= EP_QUIRK_END_TRANSFER; + else + priv_ep->flags &= ~EP_QUIRK_END_TRANSFER; + } + cdns3_transfer_completed(priv_dev, priv_ep); + } + + /* + * WA2: this condition should only be meet when + * priv_ep->flags & EP_QUIRK_EXTRA_BUF_DET or + * priv_ep->flags & EP_QUIRK_EXTRA_BUF_EN. + * In other cases this interrupt will be disabled/ + */ + if (ep_sts_reg & EP_STS_DESCMIS) { + int err; + + err = cdns3_descmissing_packet(priv_ep); + if (err) + dev_err(priv_dev->dev, + "Failed: No sufficient memory for DESCMIS\n"); + } return 0; } @@ -1241,13 +1440,26 @@ static int cdns3_gadget_ep_enable(struct usb_ep *ep, /* enable interrupt for selected endpoint */ cdns3_set_register_bit(&priv_dev->regs->ep_ien, BIT(cdns3_ep_addr_to_index(bEndpointAddress))); + /* + * WA2: Set flag for all not ISOC OUT endpoints. If this flag is set + * driver try to detect whether endpoint need additional internal + * buffer for unblocking on-chip FIFO buffer. This flag will be cleared + * if before first DESCMISS interrupt the DMA will be armed. + */ + if (quirk_internal_buffer) { + if (!priv_ep->dir && priv_ep->type != USB_ENDPOINT_XFER_ISOC) { + priv_ep->flags |= EP_QUIRK_EXTRA_BUF_DET; + reg |= EP_STS_EN_DESCMISEN; + } + } writel(reg, &priv_dev->regs->ep_sts_en); cdns3_set_register_bit(&priv_dev->regs->ep_cfg, EP_CFG_ENABLE); ep->desc = desc; - priv_ep->flags &= ~(EP_PENDING_REQUEST | EP_STALL); + priv_ep->flags &= ~(EP_PENDING_REQUEST | EP_STALL | + EP_QUIRK_EXTRA_BUF_EN); priv_ep->flags |= EP_ENABLED | EP_UPDATE_EP_TRBADDR; priv_ep->wa1_set = 0; priv_ep->enqueue = 0; @@ -1272,6 +1484,7 @@ static int cdns3_gadget_ep_enable(struct usb_ep *ep, static int cdns3_gadget_ep_disable(struct usb_ep *ep) { struct cdns3_endpoint *priv_ep; + struct cdns3_request *priv_req; struct cdns3_device *priv_dev; struct usb_request *request; unsigned long flags; @@ -1308,6 +1521,14 @@ static int cdns3_gadget_ep_disable(struct usb_ep *ep) -ESHUTDOWN); } + while (!list_empty(&priv_ep->descmiss_req_list)) { + priv_req = cdns3_next_priv_request(&priv_ep->descmiss_req_list); + + kfree(priv_req->request.buf); + cdns3_gadget_ep_free_request(&priv_ep->endpoint, + &priv_req->request); + } + while (!list_empty(&priv_ep->deferred_req_list)) { request = cdns3_next_request(&priv_ep->deferred_req_list); @@ -1348,6 +1569,53 @@ static int __cdns3_gadget_ep_queue(struct usb_ep *ep, priv_req = to_cdns3_request(request); trace_cdns3_ep_queue(priv_req); + /* + * WA2: if transfer was queued before DESCMISS appear than we + * can disable handling of DESCMISS interrupt. Driver assumes that it + * can disable special treatment for this endpoint. + */ + if (priv_ep->flags & EP_QUIRK_EXTRA_BUF_DET) { + u32 reg; + + cdns3_select_ep(priv_dev, priv_ep->num | priv_ep->dir); + priv_ep->flags &= ~EP_QUIRK_EXTRA_BUF_DET; + reg = readl(&priv_dev->regs->ep_sts_en); + reg &= ~EP_STS_EN_DESCMISEN; + writel(reg, &priv_dev->regs->ep_sts_en); + } + + /* WA2 */ + if (priv_ep->flags & EP_QUIRK_EXTRA_BUF_EN) { + u8 pending_empty = list_empty(&priv_ep->pending_req_list); + u8 descmiss_empty = list_empty(&priv_ep->descmiss_req_list); + + /* + * DESCMISS transfer has been finished, so data will be + * directly copied from internal allocated usb_request + * objects. + */ + if (pending_empty && !descmiss_empty && + !(priv_req->flags & REQUEST_INTERNAL)) { + cdns3_descmiss_copy_data(priv_ep, request); + list_add_tail(&request->list, + &priv_ep->pending_req_list); + cdns3_gadget_giveback(priv_ep, priv_req, + request->status); + return ret; + } + + /* + * WA2 driver will wait for completion DESCMISS transfer, + * before starts new, not DESCMISS transfer. + */ + if (!pending_empty && !descmiss_empty) + deferred = 1; + + if (priv_req->flags & REQUEST_INTERNAL) + list_add_tail(&priv_req->list, + &priv_ep->descmiss_req_list); + } + ret = usb_gadget_map_request_by_dev(priv_dev->sysdev, request, usb_endpoint_dir_in(ep->desc)); if (ret) @@ -1782,6 +2050,7 @@ static int cdns3_init_eps(struct cdns3_device *priv_dev) INIT_LIST_HEAD(&priv_ep->pending_req_list); INIT_LIST_HEAD(&priv_ep->deferred_req_list); + INIT_LIST_HEAD(&priv_ep->descmiss_req_list); } return 0; diff --git a/drivers/usb/cdns3/gadget.h b/drivers/usb/cdns3/gadget.h index 817f8ae7a4da..8de733b315e9 100644 --- a/drivers/usb/cdns3/gadget.h +++ b/drivers/usb/cdns3/gadget.h @@ -1000,6 +1000,7 @@ struct cdns3_device; * @endpoint: usb endpoint * @pending_req_list: list of requests queuing on transfer ring. * @deferred_req_list: list of requests waiting for queuing on transfer ring. + * @descmiss_req_list: list of requests internally allocated by driver (WA2). * @trb_pool: transfer ring - array of transaction buffers * @trb_pool_dma: dma address of transfer ring * @cdns3_dev: device associated with this endpoint @@ -1026,6 +1027,7 @@ struct cdns3_endpoint { struct usb_ep endpoint; struct list_head pending_req_list; struct list_head deferred_req_list; + struct list_head descmiss_req_list; struct cdns3_trb *trb_pool; dma_addr_t trb_pool_dma; @@ -1041,6 +1043,9 @@ struct cdns3_endpoint { #define EP_PENDING_REQUEST BIT(5) #define EP_RING_FULL BIT(6) #define EP_CLAIMED BIT(7) +#define EP_QUIRK_EXTRA_BUF_DET BIT(8) +#define EP_QUIRK_EXTRA_BUF_EN BIT(9) +#define EP_QUIRK_END_TRANSFER BIT(10) u32 flags; @@ -1074,6 +1079,7 @@ struct cdns3_endpoint { * @start_trb: number of the first TRB in transfer ring * @end_trb: number of the last TRB in transfer ring * @flags: flag specifying special usage of request + * @list: used by internally allocated request to add to descmiss_req_list. */ struct cdns3_request { struct usb_request request; @@ -1086,6 +1092,7 @@ struct cdns3_request { #define REQUEST_INTERNAL_CH BIT(2) #define REQUEST_ZLP BIT(3) u32 flags; + struct list_head list; }; #define to_cdns3_request(r) (container_of(r, struct cdns3_request, request))
Controller for OUT endpoints has shared on-chip buffers for all incoming packets, including ep0out. It's FIFO buffer, so packets must be handle by DMA in correct order. If the first packet in the buffer will not be handled, then the following packets directed for other endpoints and functions will be blocked. Additionally the packets directed to one endpoint can block entire on-chip buffers. In this case transfer to other endpoints also will blocked. To resolve this issue after raising the descriptor missing interrupt driver prepares internal usb_request object and use it to arm DMA transfer. The problematic situation was observed in case when endpoint has been enabled but no usb_request were queued. Driver try detects such endpoints and will use this workaround only for these endpoint. Driver use limited number of buffer. This number can be set by macro CDNS_WA2_NUM_BUFFERS. Such blocking situation was observed on ACM gadget. For this function host send OUT data packet but ACM function is not prepared for this packet. It's cause that buffer placed in on chip memory block transfer to other endpoints. It's limitation of controller but maybe this issues should be fixed in function driver. This work around can be disabled/enabled by means of quirk_internal_buffer module parameter. By default feature is enabled. It can has impact to transfer performance and in most case this feature can be disabled. Signed-off-by: Pawel Laszczak <pawell@cadence.com> --- drivers/usb/cdns3/gadget.c | 273 ++++++++++++++++++++++++++++++++++++- drivers/usb/cdns3/gadget.h | 7 + 2 files changed, 278 insertions(+), 2 deletions(-)