1a552a966SHans de Goede /* 2a552a966SHans de Goede * QEMU USB packet combining code (for input pipelining) 3a552a966SHans de Goede * 4a552a966SHans de Goede * Copyright(c) 2012 Red Hat, Inc. 5a552a966SHans de Goede * 6a552a966SHans de Goede * Red Hat Authors: 7a552a966SHans de Goede * Hans de Goede <hdegoede@redhat.com> 8a552a966SHans de Goede * 9a552a966SHans de Goede * This library is free software; you can redistribute it and/or 10a552a966SHans de Goede * modify it under the terms of the GNU Lesser General Public 11a552a966SHans de Goede * License as published by the Free Software Foundation; either 1275a49fc6SThomas Huth * version 2.1 of the License, or (at your option) any later version. 13a552a966SHans de Goede * 14a552a966SHans de Goede * This library is distributed in the hope that it will be useful, 15a552a966SHans de Goede * but WITHOUT ANY WARRANTY; without even the implied warranty of 16a552a966SHans de Goede * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 17a552a966SHans de Goede * Lesser General Public License for more details. 18a552a966SHans de Goede * 1975a49fc6SThomas Huth * You should have received a copy of the GNU Lesser General Public License 20a552a966SHans de Goede * along with this program; if not, see <http://www.gnu.org/licenses/>. 21a552a966SHans de Goede */ 22e532b2e0SPeter Maydell #include "qemu/osdep.h" 23246e195bSPhilippe Mathieu-Daudé #include "qemu/units.h" 24a552a966SHans de Goede #include "hw/usb.h" 251de7afc9SPaolo Bonzini #include "qemu/iov.h" 26a552a966SHans de Goede #include "trace.h" 27a552a966SHans de Goede 28a552a966SHans de Goede static void usb_combined_packet_add(USBCombinedPacket *combined, USBPacket *p) 29a552a966SHans de Goede { 30a552a966SHans de Goede qemu_iovec_concat(&combined->iov, &p->iov, 0, p->iov.size); 31a552a966SHans de Goede QTAILQ_INSERT_TAIL(&combined->packets, p, combined_entry); 32a552a966SHans de Goede p->combined = combined; 33a552a966SHans de Goede } 34a552a966SHans de Goede 35ffd8a97fSHans de Goede /* Note will free combined when the last packet gets removed */ 36a552a966SHans de Goede static void usb_combined_packet_remove(USBCombinedPacket *combined, 37a552a966SHans de Goede USBPacket *p) 38a552a966SHans de Goede { 39a552a966SHans de Goede assert(p->combined == combined); 40a552a966SHans de Goede p->combined = NULL; 41a552a966SHans de Goede QTAILQ_REMOVE(&combined->packets, p, combined_entry); 42ffd8a97fSHans de Goede if (QTAILQ_EMPTY(&combined->packets)) { 430ca6db4fSHans de Goede qemu_iovec_destroy(&combined->iov); 44ffd8a97fSHans de Goede g_free(combined); 45ffd8a97fSHans de Goede } 46a552a966SHans de Goede } 47a552a966SHans de Goede 48a552a966SHans de Goede /* Also handles completion of non combined packets for pipelined input eps */ 49a552a966SHans de Goede void usb_combined_input_packet_complete(USBDevice *dev, USBPacket *p) 50a552a966SHans de Goede { 51a552a966SHans de Goede USBCombinedPacket *combined = p->combined; 52a552a966SHans de Goede USBEndpoint *ep = p->ep; 53a552a966SHans de Goede USBPacket *next; 54ffd8a97fSHans de Goede int status, actual_length; 55ffd8a97fSHans de Goede bool short_not_ok, done = false; 56a552a966SHans de Goede 57a552a966SHans de Goede if (combined == NULL) { 58a552a966SHans de Goede usb_packet_complete_one(dev, p); 59a552a966SHans de Goede goto leave; 60a552a966SHans de Goede } 61a552a966SHans de Goede 62a552a966SHans de Goede assert(combined->first == p && p == QTAILQ_FIRST(&combined->packets)); 63a552a966SHans de Goede 649a77a0f5SHans de Goede status = combined->first->status; 659a77a0f5SHans de Goede actual_length = combined->first->actual_length; 66eae3eb3eSPaolo Bonzini short_not_ok = QTAILQ_LAST(&combined->packets)->short_not_ok; 67a552a966SHans de Goede 68a552a966SHans de Goede QTAILQ_FOREACH_SAFE(p, &combined->packets, combined_entry, next) { 69ffd8a97fSHans de Goede if (!done) { 70a552a966SHans de Goede /* Distribute data over uncombined packets */ 719a77a0f5SHans de Goede if (actual_length >= p->iov.size) { 729a77a0f5SHans de Goede p->actual_length = p->iov.size; 73a552a966SHans de Goede } else { 74a552a966SHans de Goede /* Send short or error packet to complete the transfer */ 759a77a0f5SHans de Goede p->actual_length = actual_length; 76ffd8a97fSHans de Goede done = true; 77a552a966SHans de Goede } 789a77a0f5SHans de Goede /* Report status on the last packet */ 79ffd8a97fSHans de Goede if (done || next == NULL) { 809a77a0f5SHans de Goede p->status = status; 819a77a0f5SHans de Goede } else { 829a77a0f5SHans de Goede p->status = USB_RET_SUCCESS; 839a77a0f5SHans de Goede } 84a552a966SHans de Goede p->short_not_ok = short_not_ok; 85ffd8a97fSHans de Goede /* Note will free combined when the last packet gets removed! */ 86a552a966SHans de Goede usb_combined_packet_remove(combined, p); 87a552a966SHans de Goede usb_packet_complete_one(dev, p); 889a77a0f5SHans de Goede actual_length -= p->actual_length; 89a552a966SHans de Goede } else { 90a552a966SHans de Goede /* Remove any leftover packets from the queue */ 919a77a0f5SHans de Goede p->status = USB_RET_REMOVE_FROM_QUEUE; 92ffd8a97fSHans de Goede /* Note will free combined on the last packet! */ 93a552a966SHans de Goede dev->port->ops->complete(dev->port, p); 94a552a966SHans de Goede } 95a552a966SHans de Goede } 96ffd8a97fSHans de Goede /* Do not use combined here, it has been freed! */ 97a552a966SHans de Goede leave: 98a552a966SHans de Goede /* Check if there are packets in the queue waiting for our completion */ 99a552a966SHans de Goede usb_ep_combine_input_packets(ep); 100a552a966SHans de Goede } 101a552a966SHans de Goede 102a552a966SHans de Goede /* May only be called for combined packets! */ 103a552a966SHans de Goede void usb_combined_packet_cancel(USBDevice *dev, USBPacket *p) 104a552a966SHans de Goede { 105a552a966SHans de Goede USBCombinedPacket *combined = p->combined; 106a552a966SHans de Goede assert(combined != NULL); 107ffd8a97fSHans de Goede USBPacket *first = p->combined->first; 108a552a966SHans de Goede 109ffd8a97fSHans de Goede /* Note will free combined on the last packet! */ 110a552a966SHans de Goede usb_combined_packet_remove(combined, p); 111ffd8a97fSHans de Goede if (p == first) { 112a552a966SHans de Goede usb_device_cancel_packet(dev, p); 113a552a966SHans de Goede } 114a552a966SHans de Goede } 115a552a966SHans de Goede 116a552a966SHans de Goede /* 117a552a966SHans de Goede * Large input transfers can get split into multiple input packets, this 118a552a966SHans de Goede * function recombines them, removing the short_not_ok checks which all but 119a552a966SHans de Goede * the last packet of such splits transfers have, thereby allowing input 120a552a966SHans de Goede * transfer pipelining (which we cannot do on short_not_ok transfers) 121a552a966SHans de Goede */ 122a552a966SHans de Goede void usb_ep_combine_input_packets(USBEndpoint *ep) 123a552a966SHans de Goede { 124a552a966SHans de Goede USBPacket *p, *u, *next, *prev = NULL, *first = NULL; 125a552a966SHans de Goede USBPort *port = ep->dev->port; 1269a77a0f5SHans de Goede int totalsize; 127a552a966SHans de Goede 128a552a966SHans de Goede assert(ep->pipeline); 129a552a966SHans de Goede assert(ep->pid == USB_TOKEN_IN); 130a552a966SHans de Goede 131a552a966SHans de Goede QTAILQ_FOREACH_SAFE(p, &ep->queue, queue, next) { 132a552a966SHans de Goede /* Empty the queue on a halt */ 133a552a966SHans de Goede if (ep->halted) { 1349a77a0f5SHans de Goede p->status = USB_RET_REMOVE_FROM_QUEUE; 135a552a966SHans de Goede port->ops->complete(port, p); 136a552a966SHans de Goede continue; 137a552a966SHans de Goede } 138a552a966SHans de Goede 139a552a966SHans de Goede /* Skip packets already submitted to the device */ 140a552a966SHans de Goede if (p->state == USB_PACKET_ASYNC) { 141a552a966SHans de Goede prev = p; 142a552a966SHans de Goede continue; 143a552a966SHans de Goede } 144a552a966SHans de Goede usb_packet_check_state(p, USB_PACKET_QUEUED); 145a552a966SHans de Goede 146a552a966SHans de Goede /* 147a552a966SHans de Goede * If the previous (combined) packet has the short_not_ok flag set 148a552a966SHans de Goede * stop, as we must not submit packets to the device after a transfer 149a552a966SHans de Goede * ending with short_not_ok packet. 150a552a966SHans de Goede */ 151a552a966SHans de Goede if (prev && prev->short_not_ok) { 152a552a966SHans de Goede break; 153a552a966SHans de Goede } 154a552a966SHans de Goede 155a552a966SHans de Goede if (first) { 156a552a966SHans de Goede if (first->combined == NULL) { 157a552a966SHans de Goede USBCombinedPacket *combined = g_new0(USBCombinedPacket, 1); 158a552a966SHans de Goede 159a552a966SHans de Goede combined->first = first; 160a552a966SHans de Goede QTAILQ_INIT(&combined->packets); 161a552a966SHans de Goede qemu_iovec_init(&combined->iov, 2); 162a552a966SHans de Goede usb_combined_packet_add(combined, first); 163a552a966SHans de Goede } 164a552a966SHans de Goede usb_combined_packet_add(first->combined, p); 165a552a966SHans de Goede } else { 166a552a966SHans de Goede first = p; 167a552a966SHans de Goede } 168a552a966SHans de Goede 169a552a966SHans de Goede /* Is this packet the last one of a (combined) transfer? */ 170579967beSHans de Goede totalsize = (p->combined) ? p->combined->iov.size : p->iov.size; 171a552a966SHans de Goede if ((p->iov.size % ep->max_packet_size) != 0 || !p->short_not_ok || 172579967beSHans de Goede next == NULL || 173579967beSHans de Goede /* Work around for Linux usbfs bulk splitting + migration */ 174*05a40b17SGerd Hoffmann (totalsize == (16 * KiB - 36) && p->int_req) || 175*05a40b17SGerd Hoffmann /* Next package may grow combined package over 1MiB */ 176*05a40b17SGerd Hoffmann totalsize > 1 * MiB - ep->max_packet_size) { 1779a77a0f5SHans de Goede usb_device_handle_data(ep->dev, first); 1789a77a0f5SHans de Goede assert(first->status == USB_RET_ASYNC); 179a552a966SHans de Goede if (first->combined) { 180a552a966SHans de Goede QTAILQ_FOREACH(u, &first->combined->packets, combined_entry) { 181a552a966SHans de Goede usb_packet_set_state(u, USB_PACKET_ASYNC); 182a552a966SHans de Goede } 183a552a966SHans de Goede } else { 184a552a966SHans de Goede usb_packet_set_state(first, USB_PACKET_ASYNC); 185a552a966SHans de Goede } 186a552a966SHans de Goede first = NULL; 187a552a966SHans de Goede prev = p; 188a552a966SHans de Goede } 189a552a966SHans de Goede } 190a552a966SHans de Goede } 191