Index: uspace/lib/drv/Makefile =================================================================== --- uspace/lib/drv/Makefile (revision 1b22bd45ebc7f42217757e90fa6e5b57f6ed5d1d) +++ uspace/lib/drv/Makefile (revision 8cd1aa5eb727edb7e57c0b5429631ef51ff14d2e) @@ -36,5 +36,5 @@ generic/dev_iface.c \ generic/remote_res.c \ - generic/remote_usb.c \ + generic/remote_usbhc.c \ generic/remote_char.c Index: uspace/lib/drv/generic/dev_iface.c =================================================================== --- uspace/lib/drv/generic/dev_iface.c (revision 1b22bd45ebc7f42217757e90fa6e5b57f6ed5d1d) +++ uspace/lib/drv/generic/dev_iface.c (revision 8cd1aa5eb727edb7e57c0b5429631ef51ff14d2e) @@ -39,5 +39,5 @@ #include "remote_res.h" #include "remote_char.h" -#include "remote_usb.h" +#include "remote_usbhc.h" static iface_dipatch_table_t remote_ifaces = { @@ -45,5 +45,5 @@ &remote_res_iface, &remote_char_iface, - &remote_usb_iface + &remote_usbhc_iface } }; Index: uspace/lib/drv/generic/remote_usb.c =================================================================== --- uspace/lib/drv/generic/remote_usb.c (revision 1b22bd45ebc7f42217757e90fa6e5b57f6ed5d1d) +++ (revision ) @@ -1,204 +1,0 @@ -/* - * Copyright (c) 2010 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 libdrv - * @{ - */ -/** @file - */ - -#include -#include -#include - -#include "usb_iface.h" -#include "driver.h" - -#define USB_MAX_PAYLOAD_SIZE 1020 - -static void remote_usb_get_buffer(device_t *, void *, ipc_callid_t, ipc_call_t *); -static void remote_usb_interrupt_out(device_t *, void *, ipc_callid_t, ipc_call_t *); -static void remote_usb_interrupt_in(device_t *, void *, ipc_callid_t, ipc_call_t *); -//static void remote_usb(device_t *, void *, ipc_callid_t, ipc_call_t *); - -/** Remote USB interface operations. */ -static remote_iface_func_ptr_t remote_usb_iface_ops [] = { - &remote_usb_get_buffer, - &remote_usb_interrupt_out, - &remote_usb_interrupt_in -}; - -/** Remote USB interface structure. - */ -remote_iface_t remote_usb_iface = { - .method_count = sizeof(remote_usb_iface_ops) / - sizeof(remote_usb_iface_ops[0]), - .methods = remote_usb_iface_ops -}; - -typedef struct { - ipc_callid_t caller; - void *buffer; - size_t size; -} async_transaction_t; - - -void remote_usb_get_buffer(device_t *device, void *iface, - ipc_callid_t callid, ipc_call_t *call) -{ - ipcarg_t buffer_hash = IPC_GET_ARG1(*call); - async_transaction_t * trans = (async_transaction_t *)buffer_hash; - if (trans == NULL) { - ipc_answer_0(callid, ENOENT); - return; - } - if (trans->buffer == NULL) { - ipc_answer_0(callid, EINVAL); - free(trans); - return; - } - - ipc_callid_t cid; - size_t accepted_size; - if (!async_data_read_receive(&cid, &accepted_size)) { - ipc_answer_0(callid, EINVAL); - return; - } - - if (accepted_size > trans->size) { - accepted_size = trans->size; - } - async_data_read_finalize(callid, trans->buffer, accepted_size); - - ipc_answer_1(callid, EOK, accepted_size); - - free(trans->buffer); - free(trans); -} - - -static void callback_out(device_t *device, - usb_transaction_outcome_t outcome, void *arg) -{ - async_transaction_t *trans = (async_transaction_t *)arg; - - // FIXME - answer according to outcome - ipc_answer_0(trans->caller, EOK); - - free(trans); -} - -static void callback_in(device_t *device, - usb_transaction_outcome_t outcome, size_t actual_size, void *arg) -{ - async_transaction_t *trans = (async_transaction_t *)arg; - - // FIXME - answer according to outcome - ipc_answer_1(trans->caller, EOK, (ipcarg_t)trans); - - trans->size = actual_size; -} - -void remote_usb_interrupt_out(device_t *device, void *iface, - ipc_callid_t callid, ipc_call_t *call) -{ - usb_iface_t *usb_iface = (usb_iface_t *) iface; - - size_t expected_len = IPC_GET_ARG3(*call); - usb_target_t target = { - .address = IPC_GET_ARG1(*call), - .endpoint = IPC_GET_ARG2(*call) - }; - - size_t len = 0; - void *buffer = NULL; - if (expected_len > 0) { - int rc = async_data_write_accept(&buffer, false, - 1, USB_MAX_PAYLOAD_SIZE, - 0, &len); - - if (rc != EOK) { - ipc_answer_0(callid, rc); - return; - } - } - - if (!usb_iface->interrupt_out) { - ipc_answer_0(callid, ENOTSUP); - return; - } - - async_transaction_t *trans = malloc(sizeof(async_transaction_t)); - trans->caller = callid; - trans->buffer = NULL; - trans->size = 0; - - int rc = usb_iface->interrupt_out(device, target, buffer, len, - callback_out, trans); - - if (rc != EOK) { - ipc_answer_0(callid, rc); - free(trans); - } -} - -void remote_usb_interrupt_in(device_t *device, void *iface, - ipc_callid_t callid, ipc_call_t *call) -{ - usb_iface_t *usb_iface = (usb_iface_t *) iface; - - size_t len = IPC_GET_ARG3(*call); - usb_target_t target = { - .address = IPC_GET_ARG1(*call), - .endpoint = IPC_GET_ARG2(*call) - }; - - if (!usb_iface->interrupt_in) { - ipc_answer_0(callid, ENOTSUP); - return; - } - - async_transaction_t *trans = malloc(sizeof(async_transaction_t)); - trans->caller = callid; - trans->buffer = malloc(len); - trans->size = len; - - int rc = usb_iface->interrupt_in(device, target, trans->buffer, len, - callback_in, trans); - - if (rc != EOK) { - ipc_answer_0(callid, rc); - free(trans->buffer); - free(trans); - } -} - - -/** - * @} - */ Index: uspace/lib/drv/generic/remote_usbhc.c =================================================================== --- uspace/lib/drv/generic/remote_usbhc.c (revision 8cd1aa5eb727edb7e57c0b5429631ef51ff14d2e) +++ uspace/lib/drv/generic/remote_usbhc.c (revision 8cd1aa5eb727edb7e57c0b5429631ef51ff14d2e) @@ -0,0 +1,204 @@ +/* + * Copyright (c) 2010 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 libdrv + * @{ + */ +/** @file + */ + +#include +#include +#include + +#include "usbhc_iface.h" +#include "driver.h" + +#define USB_MAX_PAYLOAD_SIZE 1020 + +static void remote_usbhc_get_buffer(device_t *, void *, ipc_callid_t, ipc_call_t *); +static void remote_usbhc_interrupt_out(device_t *, void *, ipc_callid_t, ipc_call_t *); +static void remote_usbhc_interrupt_in(device_t *, void *, ipc_callid_t, ipc_call_t *); +//static void remote_usb(device_t *, void *, ipc_callid_t, ipc_call_t *); + +/** Remote USB interface operations. */ +static remote_iface_func_ptr_t remote_usbhc_iface_ops [] = { + &remote_usbhc_get_buffer, + &remote_usbhc_interrupt_out, + &remote_usbhc_interrupt_in +}; + +/** Remote USB interface structure. + */ +remote_iface_t remote_usbhc_iface = { + .method_count = sizeof(remote_usbhc_iface_ops) / + sizeof(remote_usbhc_iface_ops[0]), + .methods = remote_usbhc_iface_ops +}; + +typedef struct { + ipc_callid_t caller; + void *buffer; + size_t size; +} async_transaction_t; + + +void remote_usbhc_get_buffer(device_t *device, void *iface, + ipc_callid_t callid, ipc_call_t *call) +{ + ipcarg_t buffer_hash = IPC_GET_ARG1(*call); + async_transaction_t * trans = (async_transaction_t *)buffer_hash; + if (trans == NULL) { + ipc_answer_0(callid, ENOENT); + return; + } + if (trans->buffer == NULL) { + ipc_answer_0(callid, EINVAL); + free(trans); + return; + } + + ipc_callid_t cid; + size_t accepted_size; + if (!async_data_read_receive(&cid, &accepted_size)) { + ipc_answer_0(callid, EINVAL); + return; + } + + if (accepted_size > trans->size) { + accepted_size = trans->size; + } + async_data_read_finalize(callid, trans->buffer, accepted_size); + + ipc_answer_1(callid, EOK, accepted_size); + + free(trans->buffer); + free(trans); +} + + +static void callback_out(device_t *device, + usb_transaction_outcome_t outcome, void *arg) +{ + async_transaction_t *trans = (async_transaction_t *)arg; + + // FIXME - answer according to outcome + ipc_answer_0(trans->caller, EOK); + + free(trans); +} + +static void callback_in(device_t *device, + usb_transaction_outcome_t outcome, size_t actual_size, void *arg) +{ + async_transaction_t *trans = (async_transaction_t *)arg; + + // FIXME - answer according to outcome + ipc_answer_1(trans->caller, EOK, (ipcarg_t)trans); + + trans->size = actual_size; +} + +void remote_usbhc_interrupt_out(device_t *device, void *iface, + ipc_callid_t callid, ipc_call_t *call) +{ + usbhc_iface_t *usb_iface = (usbhc_iface_t *) iface; + + size_t expected_len = IPC_GET_ARG3(*call); + usb_target_t target = { + .address = IPC_GET_ARG1(*call), + .endpoint = IPC_GET_ARG2(*call) + }; + + size_t len = 0; + void *buffer = NULL; + if (expected_len > 0) { + int rc = async_data_write_accept(&buffer, false, + 1, USB_MAX_PAYLOAD_SIZE, + 0, &len); + + if (rc != EOK) { + ipc_answer_0(callid, rc); + return; + } + } + + if (!usb_iface->interrupt_out) { + ipc_answer_0(callid, ENOTSUP); + return; + } + + async_transaction_t *trans = malloc(sizeof(async_transaction_t)); + trans->caller = callid; + trans->buffer = NULL; + trans->size = 0; + + int rc = usb_iface->interrupt_out(device, target, buffer, len, + callback_out, trans); + + if (rc != EOK) { + ipc_answer_0(callid, rc); + free(trans); + } +} + +void remote_usbhc_interrupt_in(device_t *device, void *iface, + ipc_callid_t callid, ipc_call_t *call) +{ + usbhc_iface_t *usb_iface = (usbhc_iface_t *) iface; + + size_t len = IPC_GET_ARG3(*call); + usb_target_t target = { + .address = IPC_GET_ARG1(*call), + .endpoint = IPC_GET_ARG2(*call) + }; + + if (!usb_iface->interrupt_in) { + ipc_answer_0(callid, ENOTSUP); + return; + } + + async_transaction_t *trans = malloc(sizeof(async_transaction_t)); + trans->caller = callid; + trans->buffer = malloc(len); + trans->size = len; + + int rc = usb_iface->interrupt_in(device, target, trans->buffer, len, + callback_in, trans); + + if (rc != EOK) { + ipc_answer_0(callid, rc); + free(trans->buffer); + free(trans); + } +} + + +/** + * @} + */ Index: uspace/lib/drv/include/remote_usb.h =================================================================== --- uspace/lib/drv/include/remote_usb.h (revision 1b22bd45ebc7f42217757e90fa6e5b57f6ed5d1d) +++ (revision ) @@ -1,44 +1,0 @@ -/* - * Copyright (c) 2010 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 libdrv - * @{ - */ -/** @file - */ - -#ifndef LIBDRV_REMOTE_USB_H_ -#define LIBDRV_REMOTE_USB_H_ - -remote_iface_t remote_usb_iface; - -#endif - -/** - * @} - */ Index: uspace/lib/drv/include/remote_usbhc.h =================================================================== --- uspace/lib/drv/include/remote_usbhc.h (revision 8cd1aa5eb727edb7e57c0b5429631ef51ff14d2e) +++ uspace/lib/drv/include/remote_usbhc.h (revision 8cd1aa5eb727edb7e57c0b5429631ef51ff14d2e) @@ -0,0 +1,44 @@ +/* + * Copyright (c) 2010 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 libdrv + * @{ + */ +/** @file + */ + +#ifndef LIBDRV_REMOTE_USBHC_H_ +#define LIBDRV_REMOTE_USBHC_H_ + +remote_iface_t remote_usbhc_iface; + +#endif + +/** + * @} + */ Index: uspace/lib/drv/include/usb_iface.h =================================================================== --- uspace/lib/drv/include/usb_iface.h (revision 1b22bd45ebc7f42217757e90fa6e5b57f6ed5d1d) +++ (revision ) @@ -1,171 +1,0 @@ -/* - * Copyright (c) 2010 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 libdrv usb - * @{ - */ -/** @file - * @brief USB interface definition. - */ - -#ifndef LIBDRV_USB_IFACE_H_ -#define LIBDRV_USB_IFACE_H_ - -#include "driver.h" -#include - - -/** IPC methods for communication with HC through DDF interface. - * - * Notes for async methods: - * - * Methods for sending data to device (OUT transactions) - * - e.g. IPC_M_USB_INTERRUPT_OUT - - * always use the same semantics: - * - first, IPC call with given method is made - * - argument #1 is target address - * - argument #2 is target endpoint - * - argument #3 is buffer size - * - this call is immediately followed by IPC data write (from caller) - * - the initial call (and the whole transaction) is answer after the - * transaction is scheduled by the HC and acknowledged by the device - * or immediately after error is detected - * - the answer carries only the error code - * - * Methods for retrieving data from device (IN transactions) - * - e.g. IPC_M_USB_INTERRUPT_IN - - * also use the same semantics: - * - first, IPC call with given method is made - * - argument #1 is target address - * - argument #2 is target endpoint - * - argument #3 is buffer size - * - the call is not answered until the device returns some data (or until - * error occurs) - * - if the call is answered with EOK, first argument of the answer is buffer - * hash that could be used to retrieve the actual data - * - * Some special methods (NO-DATA transactions) do not send any data. These - * might behave as both OUT or IN transactions because communication parts - * where actual buffers are exchanged are omitted. - * - * The mentioned data retrieval can be done any time after receiving EOK - * answer to IN method. - * This retrieval is done using the IPC_M_USB_GET_BUFFER where - * the first argument is buffer hash from call answer. - * This call must be immediately followed by data read-in and after the - * data are transferred, the initial call (IPC_M_USB_GET_BUFFER) - * is answered. Each buffer can be retrieved only once. - * - * For all these methods, wrap functions exists. Important rule: functions - * for IN transactions have (as parameters) buffers where retrieved data - * will be stored. These buffers must be already allocated and shall not be - * touch until the transaction is completed - * (e.g. not before calling usb_wait_for() with appropriate handle). - * OUT transactions buffers can be freed immediately after call is dispatched - * (i.e. after return from wrapping function). - * - */ -typedef enum { - /** Asks for data buffer. - * See explanation at usb_iface_funcs_t. - * This function does not have counter part in functional interface - * as it is handled by the remote part itself. - */ - IPC_M_USB_GET_BUFFER, - - - /** Send interrupt data to device. - * See explanation at usb_iface_funcs_t (OUT transaction). - */ - IPC_M_USB_INTERRUPT_OUT, - - /** Get interrupt data from device. - * See explanation at usb_iface_funcs_t (IN transaction). - */ - IPC_M_USB_INTERRUPT_IN, - - - /** Start WRITE control transfer. - * See explanation at usb_iface_funcs_t (OUT transaction). - */ - IPC_M_USB_CONTROL_WRITE_SETUP, - - /** Send control-transfer data to device. - * See explanation at usb_iface_funcs_t (OUT transaction). - */ - IPC_M_USB_CONTROL_WRITE_DATA, - - /** Terminate WRITE control transfer. - * See explanation at usb_iface_funcs_t (NO-DATA transaction). - */ - IPC_M_USB_CONTROL_WRITE_STATUS, - - - - /** Start READ control transfer. - * See explanation at usb_iface_funcs_t (OUT transaction). - */ - IPC_M_USB_CONTROL_READ_SETUP, - - /** Get control-transfer data from device. - * See explanation at usb_iface_funcs_t (IN transaction). - */ - IPC_M_USB_CONTROL_READ_DATA, - - /** Terminate READ control transfer. - * See explanation at usb_iface_funcs_t (NO-DATA transaction). - */ - IPC_M_USB_CONTROL_READ_STATUS, - - - /* IPC_M_USB_ */ -} usb_iface_funcs_t; - -/** Callback for outgoing transfer. */ -typedef void (*usb_iface_transfer_out_callback_t)(device_t *, - usb_transaction_outcome_t, void *); - -/** Callback for incoming transfer. */ -typedef void (*usb_iface_transfer_in_callback_t)(device_t *, - usb_transaction_outcome_t, size_t, void *); - -/** USB devices communication interface. */ -typedef struct { - int (*interrupt_out)(device_t *, usb_target_t, - void *, size_t, - usb_iface_transfer_out_callback_t, void *); - int (*interrupt_in)(device_t *, usb_target_t, - void *, size_t, - usb_iface_transfer_in_callback_t, void *); -} usb_iface_t; - - -#endif -/** - * @} - */ Index: uspace/lib/drv/include/usbhc_iface.h =================================================================== --- uspace/lib/drv/include/usbhc_iface.h (revision 8cd1aa5eb727edb7e57c0b5429631ef51ff14d2e) +++ uspace/lib/drv/include/usbhc_iface.h (revision 8cd1aa5eb727edb7e57c0b5429631ef51ff14d2e) @@ -0,0 +1,171 @@ +/* + * Copyright (c) 2010 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 libdrv usb + * @{ + */ +/** @file + * @brief USB interface definition. + */ + +#ifndef LIBDRV_USBHC_IFACE_H_ +#define LIBDRV_USBHC_IFACE_H_ + +#include "driver.h" +#include + + +/** IPC methods for communication with HC through DDF interface. + * + * Notes for async methods: + * + * Methods for sending data to device (OUT transactions) + * - e.g. IPC_M_USBHC_INTERRUPT_OUT - + * always use the same semantics: + * - first, IPC call with given method is made + * - argument #1 is target address + * - argument #2 is target endpoint + * - argument #3 is buffer size + * - this call is immediately followed by IPC data write (from caller) + * - the initial call (and the whole transaction) is answer after the + * transaction is scheduled by the HC and acknowledged by the device + * or immediately after error is detected + * - the answer carries only the error code + * + * Methods for retrieving data from device (IN transactions) + * - e.g. IPC_M_USBHC_INTERRUPT_IN - + * also use the same semantics: + * - first, IPC call with given method is made + * - argument #1 is target address + * - argument #2 is target endpoint + * - argument #3 is buffer size + * - the call is not answered until the device returns some data (or until + * error occurs) + * - if the call is answered with EOK, first argument of the answer is buffer + * hash that could be used to retrieve the actual data + * + * Some special methods (NO-DATA transactions) do not send any data. These + * might behave as both OUT or IN transactions because communication parts + * where actual buffers are exchanged are omitted. + * + * The mentioned data retrieval can be done any time after receiving EOK + * answer to IN method. + * This retrieval is done using the IPC_M_USBHC_GET_BUFFER where + * the first argument is buffer hash from call answer. + * This call must be immediately followed by data read-in and after the + * data are transferred, the initial call (IPC_M_USBHC_GET_BUFFER) + * is answered. Each buffer can be retrieved only once. + * + * For all these methods, wrap functions exists. Important rule: functions + * for IN transactions have (as parameters) buffers where retrieved data + * will be stored. These buffers must be already allocated and shall not be + * touch until the transaction is completed + * (e.g. not before calling usb_wait_for() with appropriate handle). + * OUT transactions buffers can be freed immediately after call is dispatched + * (i.e. after return from wrapping function). + * + */ +typedef enum { + /** Asks for data buffer. + * See explanation at usb_iface_funcs_t. + * This function does not have counter part in functional interface + * as it is handled by the remote part itself. + */ + IPC_M_USBHC_GET_BUFFER, + + + /** Send interrupt data to device. + * See explanation at usb_iface_funcs_t (OUT transaction). + */ + IPC_M_USBHC_INTERRUPT_OUT, + + /** Get interrupt data from device. + * See explanation at usb_iface_funcs_t (IN transaction). + */ + IPC_M_USBHC_INTERRUPT_IN, + + + /** Start WRITE control transfer. + * See explanation at usb_iface_funcs_t (OUT transaction). + */ + IPC_M_USBHC_CONTROL_WRITE_SETUP, + + /** Send control-transfer data to device. + * See explanation at usb_iface_funcs_t (OUT transaction). + */ + IPC_M_USBHC_CONTROL_WRITE_DATA, + + /** Terminate WRITE control transfer. + * See explanation at usb_iface_funcs_t (NO-DATA transaction). + */ + IPC_M_USBHC_CONTROL_WRITE_STATUS, + + + + /** Start READ control transfer. + * See explanation at usb_iface_funcs_t (OUT transaction). + */ + IPC_M_USBHC_CONTROL_READ_SETUP, + + /** Get control-transfer data from device. + * See explanation at usb_iface_funcs_t (IN transaction). + */ + IPC_M_USBHC_CONTROL_READ_DATA, + + /** Terminate READ control transfer. + * See explanation at usb_iface_funcs_t (NO-DATA transaction). + */ + IPC_M_USBHC_CONTROL_READ_STATUS, + + + /* IPC_M_USB_ */ +} usbhc_iface_funcs_t; + +/** Callback for outgoing transfer. */ +typedef void (*usbhc_iface_transfer_out_callback_t)(device_t *, + usb_transaction_outcome_t, void *); + +/** Callback for incoming transfer. */ +typedef void (*usbhc_iface_transfer_in_callback_t)(device_t *, + usb_transaction_outcome_t, size_t, void *); + +/** USB devices communication interface. */ +typedef struct { + int (*interrupt_out)(device_t *, usb_target_t, + void *, size_t, + usbhc_iface_transfer_out_callback_t, void *); + int (*interrupt_in)(device_t *, usb_target_t, + void *, size_t, + usbhc_iface_transfer_in_callback_t, void *); +} usbhc_iface_t; + + +#endif +/** + * @} + */