[81dce9f] | 1 | /*
|
---|
| 2 | * Copyright (c) 2011 Jan Vesely
|
---|
| 3 | * All rights reserved.
|
---|
| 4 | *
|
---|
| 5 | * Redistribution and use in source and binary forms, with or without
|
---|
| 6 | * modification, are permitted provided that the following conditions
|
---|
| 7 | * are met:
|
---|
| 8 | *
|
---|
| 9 | * - Redistributions of source code must retain the above copyright
|
---|
| 10 | * notice, this list of conditions and the following disclaimer.
|
---|
| 11 | * - Redistributions in binary form must reproduce the above copyright
|
---|
| 12 | * notice, this list of conditions and the following disclaimer in the
|
---|
| 13 | * documentation and/or other materials provided with the distribution.
|
---|
| 14 | * - The name of the author may not be used to endorse or promote products
|
---|
| 15 | * derived from this software without specific prior written permission.
|
---|
| 16 | *
|
---|
| 17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
|
---|
| 18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
---|
| 19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
---|
| 20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
---|
| 21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
---|
| 22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
---|
| 23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
---|
| 24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
---|
| 25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
---|
| 26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
---|
| 27 | */
|
---|
[160b75e] | 28 | /** @addtogroup libusbhost
|
---|
[81dce9f] | 29 | * @{
|
---|
| 30 | */
|
---|
| 31 | /** @file
|
---|
[c92c13f] | 32 | * USB transfer transaction structures (implementation).
|
---|
[81dce9f] | 33 | */
|
---|
| 34 | #include <errno.h>
|
---|
[3f162ab] | 35 | #include <macros.h>
|
---|
[81dce9f] | 36 |
|
---|
| 37 | #include <usb/usb.h>
|
---|
| 38 | #include <usb/debug.h>
|
---|
[549ff23] | 39 |
|
---|
[f58ef61] | 40 | #include <usb/host/usb_transfer_batch.h>
|
---|
[df8f3fa] | 41 | #include <usb/host/hcd.h>
|
---|
[81dce9f] | 42 |
|
---|
[549ff23] | 43 | /** Allocate and initialize usb_transfer_batch structure.
|
---|
| 44 | * @param ep endpoint used by the transfer batch.
|
---|
| 45 | * @param buffer data to send/recieve.
|
---|
| 46 | * @param buffer_size Size of data buffer.
|
---|
| 47 | * @param setup_buffer Data to send in SETUP stage of control transfer.
|
---|
| 48 | * @param func_in callback on IN transfer completion.
|
---|
| 49 | * @param func_out callback on OUT transfer completion.
|
---|
[cbd568b] | 50 | * @param fun DDF function (passed to callback function).
|
---|
[549ff23] | 51 | * @param arg Argument to pass to the callback function.
|
---|
| 52 | * @param private_data driver specific per batch data.
|
---|
| 53 | * @param private_data_dtor Function to properly destroy private_data.
|
---|
| 54 | * @return Pointer to valid usb_transfer_batch_t structure, NULL on failure.
|
---|
| 55 | */
|
---|
| 56 | usb_transfer_batch_t * usb_transfer_batch_create(
|
---|
[2cc6e97] | 57 | endpoint_t *ep,
|
---|
[81dce9f] | 58 | char *buffer,
|
---|
| 59 | size_t buffer_size,
|
---|
[a837544] | 60 | uint64_t setup_buffer,
|
---|
[81dce9f] | 61 | usbhc_iface_transfer_in_callback_t func_in,
|
---|
| 62 | usbhc_iface_transfer_out_callback_t func_out,
|
---|
[3c4663e] | 63 | void *arg
|
---|
[81dce9f] | 64 | )
|
---|
| 65 | {
|
---|
[549ff23] | 66 | if (func_in == NULL && func_out == NULL)
|
---|
| 67 | return NULL;
|
---|
| 68 | if (func_in != NULL && func_out != NULL)
|
---|
| 69 | return NULL;
|
---|
| 70 |
|
---|
[70fb822] | 71 | usb_transfer_batch_t *instance = malloc(sizeof(usb_transfer_batch_t));
|
---|
| 72 | if (instance) {
|
---|
| 73 | instance->ep = ep;
|
---|
| 74 | instance->callback_in = func_in;
|
---|
| 75 | instance->callback_out = func_out;
|
---|
| 76 | instance->arg = arg;
|
---|
| 77 | instance->buffer = buffer;
|
---|
| 78 | instance->buffer_size = buffer_size;
|
---|
[a00ac07] | 79 | instance->setup_size = 0;
|
---|
[70fb822] | 80 | instance->transfered_size = 0;
|
---|
| 81 | instance->error = EOK;
|
---|
[a00ac07] | 82 | if (ep && ep->transfer_type == USB_TRANSFER_CONTROL) {
|
---|
[a837544] | 83 | memcpy(instance->setup_buffer, &setup_buffer,
|
---|
[a00ac07] | 84 | USB_SETUP_PACKET_SIZE);
|
---|
| 85 | instance->setup_size = USB_SETUP_PACKET_SIZE;
|
---|
| 86 | }
|
---|
[70fb822] | 87 | if (instance->ep)
|
---|
| 88 | endpoint_use(instance->ep);
|
---|
| 89 | }
|
---|
| 90 | return instance;
|
---|
[2cc6e97] | 91 | }
|
---|
[a76b01b4] | 92 |
|
---|
[2cc6e97] | 93 | /** Correctly dispose all used data structures.
|
---|
| 94 | *
|
---|
| 95 | * @param[in] instance Batch structure to use.
|
---|
| 96 | */
|
---|
[549ff23] | 97 | void usb_transfer_batch_destroy(const usb_transfer_batch_t *instance)
|
---|
[2cc6e97] | 98 | {
|
---|
[96e2d01] | 99 | if (!instance)
|
---|
| 100 | return;
|
---|
[c4fb5ecd] | 101 | usb_log_debug2("Batch %p " USB_TRANSFER_BATCH_FMT " disposing.\n",
|
---|
| 102 | instance, USB_TRANSFER_BATCH_ARGS(*instance));
|
---|
[70fb822] | 103 | if (instance->ep) {
|
---|
| 104 | endpoint_release(instance->ep);
|
---|
| 105 | }
|
---|
[2cc6e97] | 106 | free(instance);
|
---|
| 107 | }
|
---|
[a76b01b4] | 108 |
|
---|
[549ff23] | 109 | /** Prepare data and call the right callback.
|
---|
| 110 | *
|
---|
| 111 | * @param[in] instance Batch structure to use.
|
---|
| 112 | * @param[in] data Data to copy to the output buffer.
|
---|
| 113 | * @param[in] size Size of @p data.
|
---|
[f167f55b] | 114 | * @param[in] error Error value to use.
|
---|
[549ff23] | 115 | */
|
---|
[f167f55b] | 116 | void usb_transfer_batch_finish_error(const usb_transfer_batch_t *instance,
|
---|
| 117 | const void *data, size_t size, int error)
|
---|
[549ff23] | 118 | {
|
---|
| 119 | assert(instance);
|
---|
| 120 | usb_log_debug2("Batch %p " USB_TRANSFER_BATCH_FMT " finishing.\n",
|
---|
| 121 | instance, USB_TRANSFER_BATCH_ARGS(*instance));
|
---|
| 122 |
|
---|
| 123 | /* NOTE: Only one of these pointers should be set. */
|
---|
| 124 | if (instance->callback_out) {
|
---|
[8f68913f] | 125 | instance->callback_out(error, instance->arg);
|
---|
[549ff23] | 126 | }
|
---|
| 127 |
|
---|
| 128 | if (instance->callback_in) {
|
---|
| 129 | /* We care about the data and there are some to copy */
|
---|
[2582d8f] | 130 | const size_t safe_size = min(size, instance->buffer_size);
|
---|
[549ff23] | 131 | if (data) {
|
---|
[2582d8f] | 132 | memcpy(instance->buffer, data, safe_size);
|
---|
[549ff23] | 133 | }
|
---|
[8f68913f] | 134 | instance->callback_in(error, safe_size, instance->arg);
|
---|
[549ff23] | 135 | }
|
---|
| 136 | }
|
---|
[81dce9f] | 137 | /**
|
---|
| 138 | * @}
|
---|
| 139 | */
|
---|