libusb/sync.c

   1 /*
   2  * Synchronous I/O functions for libusb
   3  * Copyright © 2007-2008 Daniel Drake <dsd@gentoo.org>
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  18  */
  19
  20 #include <config.h>
  21
  22 #include <errno.h>
  23 #include <stdint.h>
  24 #include <stdlib.h>
  25 #include <string.h>
  26
  27 #include "libusbi.h"
  28
  29 /**
  30  * @defgroup syncio Synchronous device I/O
  31  *
  32  * This page documents libusb's synchronous (blocking) API for USB device I/O.
  33  * This interface is easy to use but has some limitations. More advanced users
  34  * may wish to consider using the \ref asyncio "asynchronous I/O API" instead.
  35  */
  36
  37 static void LIBUSB_CALL sync_transfer_cb(struct libusb_transfer *transfer)
  38 {
  39         int *completed = transfer->user_data;
  40         *completed = 1;
  41         usbi_dbg("actual_length=%d", transfer->actual_length);
  42         /* caller interprets result and frees transfer */
  43 }
  44
  45 static void sync_transfer_wait_for_completion(struct libusb_transfer *transfer)
  46 {
  47         int r, *completed = transfer->user_data;
  48         struct libusb_context *ctx = HANDLE_CTX(transfer->dev_handle);
  49
  50         while (!*completed) {
  51                 r = libusb_handle_events_completed(ctx, completed);
  52                 if (r < 0) {
  53                         if (r == LIBUSB_ERROR_INTERRUPTED)
  54                                 continue;
  55                         usbi_err(ctx, "libusb_handle_events failed: %s, cancelling transfer and retrying",
  56                                  libusb_error_name(r));
  57                         libusb_cancel_transfer(transfer);
  58                         continue;
  59                 }
  60         }
  61 }
  62
  63 /** \ingroup syncio
  64  * Perform a USB control transfer.
  65  *
  66  * The direction of the transfer is inferred from the bmRequestType field of
  67  * the setup packet.
  68  *
  69  * The wValue, wIndex and wLength fields values should be given in host-endian
  70  * byte order.
  71  *
  72  * \param dev_handle a handle for the device to communicate with
  73  * \param bmRequestType the request type field for the setup packet
  74  * \param bRequest the request field for the setup packet
  75  * \param wValue the value field for the setup packet
  76  * \param wIndex the index field for the setup packet
  77  * \param data a suitably-sized data buffer for either input or output
  78  * (depending on direction bits within bmRequestType)
  79  * \param wLength the length field for the setup packet. The data buffer should
  80  * be at least this size.
  81  * \param timeout timeout (in millseconds) that this function should wait
  82  * before giving up due to no response being received. For an unlimited
  83  * timeout, use value 0.
  84  * \returns on success, the number of bytes actually transferred
  85  * \returns LIBUSB_ERROR_TIMEOUT if the transfer timed out
  86  * \returns LIBUSB_ERROR_PIPE if the control request was not supported by the
  87  * device
  88  * \returns LIBUSB_ERROR_NO_DEVICE if the device has been disconnected
  89  * \returns LIBUSB_ERROR_BUSY if called from event handling context
  90  * \returns another LIBUSB_ERROR code on other failures
  91  */
  92 int API_EXPORTED libusb_control_transfer(libusb_device_handle *dev_handle,
  93         uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex,
  94         unsigned char *data, uint16_t wLength, unsigned int timeout)
  95 {
  96         struct libusb_transfer *transfer;
  97         unsigned char *buffer;
  98         int completed = 0;
  99         int r;
 100
 101         if (usbi_handling_events(HANDLE_CTX(dev_handle)))
 102                 return LIBUSB_ERROR_BUSY;
 103
 104         transfer = libusb_alloc_transfer(0);
 105         if (!transfer)
 106                 return LIBUSB_ERROR_NO_MEM;
 107
 108         buffer = (unsigned char*) malloc(LIBUSB_CONTROL_SETUP_SIZE + wLength);
 109         if (!buffer) {
 110                 libusb_free_transfer(transfer);
 111                 return LIBUSB_ERROR_NO_MEM;
 112         }
 113
 114         libusb_fill_control_setup(buffer, bmRequestType, bRequest, wValue, wIndex,
 115                 wLength);
 116         if ((bmRequestType & LIBUSB_ENDPOINT_DIR_MASK) == LIBUSB_ENDPOINT_OUT)
 117                 memcpy(buffer + LIBUSB_CONTROL_SETUP_SIZE, data, wLength);
 118
 119         libusb_fill_control_transfer(transfer, dev_handle, buffer,
 120                 sync_transfer_cb, &completed, timeout);
 121         transfer->flags = LIBUSB_TRANSFER_FREE_BUFFER;
 122         r = libusb_submit_transfer(transfer);
 123         if (r < 0) {
 124                 libusb_free_transfer(transfer);
 125                 return r;
 126         }
 127
 128         sync_transfer_wait_for_completion(transfer);
 129
 130         if ((bmRequestType & LIBUSB_ENDPOINT_DIR_MASK) == LIBUSB_ENDPOINT_IN)
 131                 memcpy(data, libusb_control_transfer_get_data(transfer),
 132                         transfer->actual_length);
 133
 134         switch (transfer->status) {
 135         case LIBUSB_TRANSFER_COMPLETED:
 136                 r = transfer->actual_length;
 137                 break;
 138         case LIBUSB_TRANSFER_TIMED_OUT:
 139                 r = LIBUSB_ERROR_TIMEOUT;
 140                 break;
 141         case LIBUSB_TRANSFER_STALL:
 142                 r = LIBUSB_ERROR_PIPE;
 143                 break;
 144         case LIBUSB_TRANSFER_NO_DEVICE:
 145                 r = LIBUSB_ERROR_NO_DEVICE;
 146                 break;
 147         case LIBUSB_TRANSFER_OVERFLOW:
 148                 r = LIBUSB_ERROR_OVERFLOW;
 149                 break;
 150         case LIBUSB_TRANSFER_ERROR:
 151         case LIBUSB_TRANSFER_CANCELLED:
 152                 r = LIBUSB_ERROR_IO;
 153                 break;
 154         default:
 155                 usbi_warn(HANDLE_CTX(dev_handle),
 156                         "unrecognised status code %d", transfer->status);
 157                 r = LIBUSB_ERROR_OTHER;
 158         }
 159
 160         libusb_free_transfer(transfer);
 161         return r;
 162 }
 163
 164 static int do_sync_bulk_transfer(struct libusb_device_handle *dev_handle,
 165         unsigned char endpoint, unsigned char *buffer, int length,
 166         int *transferred, unsigned int timeout, unsigned char type)
 167 {
 168         struct libusb_transfer *transfer;
 169         int completed = 0;
 170         int r;
 171
 172         if (usbi_handling_events(HANDLE_CTX(dev_handle)))
 173                 return LIBUSB_ERROR_BUSY;
 174
 175         transfer = libusb_alloc_transfer(0);
 176         if (!transfer)
 177                 return LIBUSB_ERROR_NO_MEM;
 178
 179         libusb_fill_bulk_transfer(transfer, dev_handle, endpoint, buffer, length,
 180                 sync_transfer_cb, &completed, timeout);
 181         transfer->type = type;
 182
 183         r = libusb_submit_transfer(transfer);
 184         if (r < 0) {
 185                 libusb_free_transfer(transfer);
 186                 return r;
 187         }
 188
 189         sync_transfer_wait_for_completion(transfer);
 190
 191         *transferred = transfer->actual_length;
 192         switch (transfer->status) {
 193         case LIBUSB_TRANSFER_COMPLETED:
 194                 r = 0;
 195                 break;
 196         case LIBUSB_TRANSFER_TIMED_OUT:
 197                 r = LIBUSB_ERROR_TIMEOUT;
 198                 break;
 199         case LIBUSB_TRANSFER_STALL:
 200                 r = LIBUSB_ERROR_PIPE;
 201                 break;
 202         case LIBUSB_TRANSFER_OVERFLOW:
 203                 r = LIBUSB_ERROR_OVERFLOW;
 204                 break;
 205         case LIBUSB_TRANSFER_NO_DEVICE:
 206                 r = LIBUSB_ERROR_NO_DEVICE;
 207                 break;
 208         case LIBUSB_TRANSFER_ERROR:
 209         case LIBUSB_TRANSFER_CANCELLED:
 210                 r = LIBUSB_ERROR_IO;
 211                 break;
 212         default:
 213                 usbi_warn(HANDLE_CTX(dev_handle),
 214                         "unrecognised status code %d", transfer->status);
 215                 r = LIBUSB_ERROR_OTHER;
 216         }
 217
 218         libusb_free_transfer(transfer);
 219         return r;
 220 }
 221
 222 /** \ingroup syncio
 223  * Perform a USB bulk transfer. The direction of the transfer is inferred from
 224  * the direction bits of the endpoint address.
 225  *
 226  * For bulk reads, the <tt>length</tt> field indicates the maximum length of
 227  * data you are expecting to receive. If less data arrives than expected,
 228  * this function will return that data, so be sure to check the
 229  * <tt>transferred</tt> output parameter.
 230  *
 231  * You should also check the <tt>transferred</tt> parameter for bulk writes.
 232  * Not all of the data may have been written.
 233  *
 234  * Also check <tt>transferred</tt> when dealing with a timeout error code.
 235  * libusb may have to split your transfer into a number of chunks to satisfy
 236  * underlying O/S requirements, meaning that the timeout may expire after
 237  * the first few chunks have completed. libusb is careful not to lose any data
 238  * that may have been transferred; do not assume that timeout conditions
 239  * indicate a complete lack of I/O.
 240  *
 241  * \param dev_handle a handle for the device to communicate with
 242  * \param endpoint the address of a valid endpoint to communicate with
 243  * \param data a suitably-sized data buffer for either input or output
 244  * (depending on endpoint)
 245  * \param length for bulk writes, the number of bytes from data to be sent. for
 246  * bulk reads, the maximum number of bytes to receive into the data buffer.
 247  * \param transferred output location for the number of bytes actually
 248  * transferred.
 249  * \param timeout timeout (in millseconds) that this function should wait
 250  * before giving up due to no response being received. For an unlimited
 251  * timeout, use value 0.
 252  *
 253  * \returns 0 on success (and populates <tt>transferred</tt>)
 254  * \returns LIBUSB_ERROR_TIMEOUT if the transfer timed out (and populates
 255  * <tt>transferred</tt>)
 256  * \returns LIBUSB_ERROR_PIPE if the endpoint halted
 257  * \returns LIBUSB_ERROR_OVERFLOW if the device offered more data, see
 258  * \ref packetoverflow
 259  * \returns LIBUSB_ERROR_NO_DEVICE if the device has been disconnected
 260  * \returns LIBUSB_ERROR_BUSY if called from event handling context
 261  * \returns another LIBUSB_ERROR code on other failures
 262  */
 263 int API_EXPORTED libusb_bulk_transfer(struct libusb_device_handle *dev_handle,
 264         unsigned char endpoint, unsigned char *data, int length, int *transferred,
 265         unsigned int timeout)
 266 {
 267         return do_sync_bulk_transfer(dev_handle, endpoint, data, length,
 268                 transferred, timeout, LIBUSB_TRANSFER_TYPE_BULK);
 269 }
 270
 271 /** \ingroup syncio
 272  * Perform a USB interrupt transfer. The direction of the transfer is inferred
 273  * from the direction bits of the endpoint address.
 274  *
 275  * For interrupt reads, the <tt>length</tt> field indicates the maximum length
 276  * of data you are expecting to receive. If less data arrives than expected,
 277  * this function will return that data, so be sure to check the
 278  * <tt>transferred</tt> output parameter.
 279  *
 280  * You should also check the <tt>transferred</tt> parameter for interrupt
 281  * writes. Not all of the data may have been written.
 282  *
 283  * Also check <tt>transferred</tt> when dealing with a timeout error code.
 284  * libusb may have to split your transfer into a number of chunks to satisfy
 285  * underlying O/S requirements, meaning that the timeout may expire after
 286  * the first few chunks have completed. libusb is careful not to lose any data
 287  * that may have been transferred; do not assume that timeout conditions
 288  * indicate a complete lack of I/O.
 289  *
 290  * The default endpoint bInterval value is used as the polling interval.
 291  *
 292  * \param dev_handle a handle for the device to communicate with
 293  * \param endpoint the address of a valid endpoint to communicate with
 294  * \param data a suitably-sized data buffer for either input or output
 295  * (depending on endpoint)
 296  * \param length for bulk writes, the number of bytes from data to be sent. for
 297  * bulk reads, the maximum number of bytes to receive into the data buffer.
 298  * \param transferred output location for the number of bytes actually
 299  * transferred.
 300  * \param timeout timeout (in millseconds) that this function should wait
 301  * before giving up due to no response being received. For an unlimited
 302  * timeout, use value 0.
 303  *
 304  * \returns 0 on success (and populates <tt>transferred</tt>)
 305  * \returns LIBUSB_ERROR_TIMEOUT if the transfer timed out
 306  * \returns LIBUSB_ERROR_PIPE if the endpoint halted
 307  * \returns LIBUSB_ERROR_OVERFLOW if the device offered more data, see
 308  * \ref packetoverflow
 309  * \returns LIBUSB_ERROR_NO_DEVICE if the device has been disconnected
 310  * \returns LIBUSB_ERROR_BUSY if called from event handling context
 311  * \returns another LIBUSB_ERROR code on other error
 312  */
 313 int API_EXPORTED libusb_interrupt_transfer(
 314         struct libusb_device_handle *dev_handle, unsigned char endpoint,
 315         unsigned char *data, int length, int *transferred, unsigned int timeout)
 316 {
 317         return do_sync_bulk_transfer(dev_handle, endpoint, data, length,
 318                 transferred, timeout, LIBUSB_TRANSFER_TYPE_INTERRUPT);
 319 }