Index: uspace/lib/usbvirt/src/ctrltransfer.c =================================================================== --- uspace/lib/usbvirt/src/ctrltransfer.c (revision e31b5c191ea0f11dc7765ce32f4e11cce68f6620) +++ uspace/lib/usbvirt/src/ctrltransfer.c (revision dc06caa563afa95e8dd424ec2cee7abef3a78d47) @@ -1,2 +1,36 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusbvirt + * @{ + */ +/** @file + * Control transfer handling. + */ #include "private.h" #include @@ -5,4 +39,14 @@ #include +/** Find and execute control transfer handler for virtual USB device. + * + * @param dev Target virtual device. + * @param control_handlers Array of control request handlers. + * @param setup Setup packet. + * @param data Extra data. + * @param data_sent_size Size of extra data in bytes. + * @return Error code. + * @retval EFORWARD No suitable handler found. + */ int process_control_transfer(usbvirt_device_t *dev, usbvirt_control_request_handler_t *control_handlers, @@ -52,2 +96,7 @@ return EFORWARD; } + + +/** + * @} + */ Index: uspace/lib/usbvirt/src/ipc.c =================================================================== --- uspace/lib/usbvirt/src/ipc.c (revision e31b5c191ea0f11dc7765ce32f4e11cce68f6620) +++ uspace/lib/usbvirt/src/ipc.c (revision dc06caa563afa95e8dd424ec2cee7abef3a78d47) @@ -273,4 +273,10 @@ } +/** Connect the device to the virtual host controller. + * + * @param dev The virtual device to be (virtually) plugged in. + * @param vhc_path Devman path to the virtual host controller. + * @return Error code. + */ int usbvirt_device_plug(usbvirt_device_t *dev, const char *vhc_path) { Index: uspace/lib/usbvirt/src/private.h =================================================================== --- uspace/lib/usbvirt/src/private.h (revision e31b5c191ea0f11dc7765ce32f4e11cce68f6620) +++ uspace/lib/usbvirt/src/private.h (revision dc06caa563afa95e8dd424ec2cee7abef3a78d47) @@ -1,2 +1,39 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusbvirt + * @{ + */ +/** @file + * Private definitions. + */ +#ifndef USBVIRT_PRIVATE_H_ +#define USBVIRT_PRIVATE_H_ + #include @@ -7,2 +44,7 @@ extern usbvirt_control_request_handler_t library_handlers[]; + +#endif +/** + * @} + */ Index: uspace/lib/usbvirt/src/stdreq.c =================================================================== --- uspace/lib/usbvirt/src/stdreq.c (revision e31b5c191ea0f11dc7765ce32f4e11cce68f6620) +++ uspace/lib/usbvirt/src/stdreq.c (revision dc06caa563afa95e8dd424ec2cee7abef3a78d47) @@ -1,2 +1,36 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusbvirt + * @{ + */ +/** @file + * Standard control request handlers. + */ #include "private.h" #include @@ -4,4 +38,15 @@ #include +/** Helper for replying to control read transfer from virtual USB device. + * + * This function takes care of copying data to answer buffer taking care + * of buffer sizes properly. + * + * @param setup_packet The setup packet. + * @param data Data buffer to write to. + * @param act_size Where to write actual size of returned data. + * @param actual_data Data to be returned. + * @param actual_data_size Size of answer data (@p actual_data) in bytes. + */ void usbvirt_control_reply_helper(const usb_device_request_setup_packet_t *setup_packet, uint8_t *data, size_t *act_size, @@ -144,4 +189,5 @@ } +/** Standard request handlers. */ usbvirt_control_request_handler_t library_handlers[] = { { @@ -173,2 +219,5 @@ }; +/** + * @} + */ Index: uspace/lib/usbvirt/src/transfer.c =================================================================== --- uspace/lib/usbvirt/src/transfer.c (revision e31b5c191ea0f11dc7765ce32f4e11cce68f6620) +++ uspace/lib/usbvirt/src/transfer.c (revision dc06caa563afa95e8dd424ec2cee7abef3a78d47) @@ -31,5 +31,5 @@ */ /** @file - * + * Transfer handling. */ #include @@ -39,4 +39,15 @@ #include "private.h" +/** Process a control transfer to the virtual USB device. + * + * @param dev Target device. + * @param setup Setup packet data. + * @param setup_size Size of setup packet. + * @param data Extra data (DATA stage). + * @param data_size Size of extra data in bytes. + * @param data_size_sent Number of actually send bytes during the transfer + * (only used for READ transfers). + * @return Error code. + */ static int usbvirt_control_transfer(usbvirt_device_t *dev, void *setup, size_t setup_size, @@ -78,4 +89,15 @@ } +/** Issue a control write transfer to virtual USB device. + * + * @see usbvirt_control_transfer + * + * @param dev Target virtual device. + * @param setup Setup data. + * @param setup_size Size of setup packet. + * @param data Extra data (DATA stage). + * @param data_size Size of extra data buffer in bytes. + * @return Error code. + */ int usbvirt_control_write(usbvirt_device_t *dev, void *setup, size_t setup_size, void *data, size_t data_size) @@ -85,4 +107,16 @@ } +/** Issue a control read transfer to virtual USB device. + * + * @see usbvirt_control_transfer + * + * @param dev Target virtual device. + * @param setup Setup data. + * @param setup_size Size of setup packet. + * @param data Extra data (DATA stage). + * @param data_size Size of extra data buffer in bytes. + * @param data_size_sent Number of actually send bytes during the transfer. + * @return Error code. + */ int usbvirt_control_read(usbvirt_device_t *dev, void *setup, size_t setup_size, void *data, size_t data_size, size_t *data_size_sent) @@ -92,4 +126,13 @@ } +/** Send data to virtual USB device. + * + * @param dev Target virtual device. + * @param transf_type Transfer type (interrupt, bulk). + * @param endpoint Endpoint number. + * @param data Data sent from the driver to the device. + * @param data_size Size of the @p data buffer in bytes. + * @return Error code. + */ int usbvirt_data_out(usbvirt_device_t *dev, usb_transfer_type_t transf_type, usb_endpoint_t endpoint, void *data, size_t data_size) @@ -108,4 +151,14 @@ } +/** Request data from virtual USB device. + * + * @param dev Target virtual device. + * @param transf_type Transfer type (interrupt, bulk). + * @param endpoint Endpoint number. + * @param data Where to stored data the device returns to the driver. + * @param data_size Size of the @p data buffer in bytes. + * @param data_size_sent Number of actually written bytes. + * @return Error code. + */ int usbvirt_data_in(usbvirt_device_t *dev, usb_transfer_type_t transf_type, usb_endpoint_t endpoint, void *data, size_t data_size, size_t *data_size_sent)