Index: uspace/lib/drv/Makefile =================================================================== --- uspace/lib/drv/Makefile (revision 22027b6e7981eafebc4220c771cc114cfcc00c1f) +++ uspace/lib/drv/Makefile (revision 6fe1ab4654f3d29aa401e00bfbe8206d0dd7a4ca) @@ -29,5 +29,5 @@ USPACE_PREFIX = ../.. -EXTRA_CFLAGS = -Iinclude +EXTRA_CFLAGS = -Iinclude -I$(LIBUSB_PREFIX)/include LIBRARY = libdrv @@ -35,6 +35,8 @@ generic/driver.c \ generic/dev_iface.c \ + generic/remote_char_dev.c \ generic/remote_hw_res.c \ - generic/remote_char_dev.c + generic/remote_usb.c \ + generic/remote_usbhc.c include $(USPACE_PREFIX)/Makefile.common Index: uspace/lib/drv/generic/dev_iface.c =================================================================== --- uspace/lib/drv/generic/dev_iface.c (revision 22027b6e7981eafebc4220c771cc114cfcc00c1f) +++ uspace/lib/drv/generic/dev_iface.c (revision 6fe1ab4654f3d29aa401e00bfbe8206d0dd7a4ca) @@ -41,9 +41,13 @@ #include "remote_hw_res.h" #include "remote_char_dev.h" +#include "remote_usb.h" +#include "remote_usbhc.h" static iface_dipatch_table_t remote_ifaces = { .ifaces = { &remote_hw_res_iface, - &remote_char_dev_iface + &remote_char_dev_iface, + &remote_usb_iface, + &remote_usbhc_iface } }; Index: uspace/lib/drv/generic/driver.c =================================================================== --- uspace/lib/drv/generic/driver.c (revision 22027b6e7981eafebc4220c771cc114cfcc00c1f) +++ uspace/lib/drv/generic/driver.c (revision 6fe1ab4654f3d29aa401e00bfbe8206d0dd7a4ca) @@ -512,5 +512,6 @@ */ int child_device_register_wrapper(device_t *parent, const char *child_name, - const char *child_match_id, int child_match_score) + const char *child_match_id, int child_match_score, + devman_handle_t *child_handle) { device_t *child = NULL; @@ -539,5 +540,9 @@ if (rc != EOK) goto failure; - + + if (child_handle != NULL) { + *child_handle = child->handle; + } + return EOK; Index: uspace/lib/drv/generic/remote_usb.c =================================================================== --- uspace/lib/drv/generic/remote_usb.c (revision 6fe1ab4654f3d29aa401e00bfbe8206d0dd7a4ca) +++ uspace/lib/drv/generic/remote_usb.c (revision 6fe1ab4654f3d29aa401e00bfbe8206d0dd7a4ca) @@ -0,0 +1,83 @@ +/* + * 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" + + +static void remote_usb_get_hc_handle(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_hc_handle +}; + +/** 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 +}; + + +void remote_usb_get_hc_handle(device_t *device, void *iface, + ipc_callid_t callid, ipc_call_t *call) +{ + usb_iface_t *usb_iface = (usb_iface_t *) iface; + + if (usb_iface->get_hc_handle == NULL) { + ipc_answer_0(callid, ENOTSUP); + return; + } + + devman_handle_t handle; + int rc = usb_iface->get_hc_handle(device, &handle); + if (rc != EOK) { + ipc_answer_0(callid, rc); + } + + ipc_answer_1(callid, EOK, (sysarg_t) handle); +} + + + +/** + * @} + */ Index: uspace/lib/drv/generic/remote_usbhc.c =================================================================== --- uspace/lib/drv/generic/remote_usbhc.c (revision 6fe1ab4654f3d29aa401e00bfbe8206d0dd7a4ca) +++ uspace/lib/drv/generic/remote_usbhc.c (revision 6fe1ab4654f3d29aa401e00bfbe8206d0dd7a4ca) @@ -0,0 +1,502 @@ +/* + * 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_address(device_t *, void *, ipc_callid_t, ipc_call_t *); +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_usbhc_control_write_setup(device_t *, void *, ipc_callid_t, ipc_call_t *); +static void remote_usbhc_control_write_data(device_t *, void *, ipc_callid_t, ipc_call_t *); +static void remote_usbhc_control_write_status(device_t *, void *, ipc_callid_t, ipc_call_t *); +static void remote_usbhc_control_read_setup(device_t *, void *, ipc_callid_t, ipc_call_t *); +static void remote_usbhc_control_read_data(device_t *, void *, ipc_callid_t, ipc_call_t *); +static void remote_usbhc_control_read_status(device_t *, void *, ipc_callid_t, ipc_call_t *); +static void remote_usbhc_reserve_default_address(device_t *, void *, ipc_callid_t, ipc_call_t *); +static void remote_usbhc_release_default_address(device_t *, void *, ipc_callid_t, ipc_call_t *); +static void remote_usbhc_request_address(device_t *, void *, ipc_callid_t, ipc_call_t *); +static void remote_usbhc_bind_address(device_t *, void *, ipc_callid_t, ipc_call_t *); +static void remote_usbhc_release_address(device_t *, void *, ipc_callid_t, ipc_call_t *); +//static void remote_usbhc(device_t *, void *, ipc_callid_t, ipc_call_t *); + +/** Remote USB host controller interface operations. */ +static remote_iface_func_ptr_t remote_usbhc_iface_ops [] = { + remote_usbhc_get_address, + + remote_usbhc_get_buffer, + + remote_usbhc_reserve_default_address, + remote_usbhc_release_default_address, + + remote_usbhc_request_address, + remote_usbhc_bind_address, + remote_usbhc_release_address, + + remote_usbhc_interrupt_out, + remote_usbhc_interrupt_in, + + remote_usbhc_control_write_setup, + remote_usbhc_control_write_data, + remote_usbhc_control_write_status, + + remote_usbhc_control_read_setup, + remote_usbhc_control_read_data, + remote_usbhc_control_read_status +}; + +/** Remote USB host controller 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_address(device_t *device, void *iface, + ipc_callid_t callid, ipc_call_t *call) +{ + usbhc_iface_t *usb_iface = (usbhc_iface_t *) iface; + + if (!usb_iface->tell_address) { + ipc_answer_0(callid, ENOTSUP); + return; + } + + devman_handle_t handle = DEV_IPC_GET_ARG1(*call); + + usb_address_t address; + int rc = usb_iface->tell_address(device, handle, &address); + if (rc != EOK) { + ipc_answer_0(callid, rc); + } else { + ipc_answer_1(callid, EOK, address); + } +} + +void remote_usbhc_get_buffer(device_t *device, void *iface, + ipc_callid_t callid, ipc_call_t *call) +{ + sysarg_t buffer_hash = DEV_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(cid, trans->buffer, accepted_size); + + ipc_answer_1(callid, EOK, accepted_size); + + free(trans->buffer); + free(trans); +} + +void remote_usbhc_reserve_default_address(device_t *device, void *iface, + ipc_callid_t callid, ipc_call_t *call) +{ + usbhc_iface_t *usb_iface = (usbhc_iface_t *) iface; + + if (!usb_iface->reserve_default_address) { + ipc_answer_0(callid, ENOTSUP); + return; + } + + int rc = usb_iface->reserve_default_address(device); + + ipc_answer_0(callid, rc); +} + +void remote_usbhc_release_default_address(device_t *device, void *iface, + ipc_callid_t callid, ipc_call_t *call) +{ + usbhc_iface_t *usb_iface = (usbhc_iface_t *) iface; + + if (!usb_iface->release_default_address) { + ipc_answer_0(callid, ENOTSUP); + return; + } + + int rc = usb_iface->release_default_address(device); + + ipc_answer_0(callid, rc); +} + +void remote_usbhc_request_address(device_t *device, void *iface, + ipc_callid_t callid, ipc_call_t *call) +{ + usbhc_iface_t *usb_iface = (usbhc_iface_t *) iface; + + if (!usb_iface->request_address) { + ipc_answer_0(callid, ENOTSUP); + return; + } + + usb_address_t address; + int rc = usb_iface->request_address(device, &address); + if (rc != EOK) { + ipc_answer_0(callid, rc); + } else { + ipc_answer_1(callid, EOK, (sysarg_t) address); + } +} + +void remote_usbhc_bind_address(device_t *device, void *iface, + ipc_callid_t callid, ipc_call_t *call) +{ + usbhc_iface_t *usb_iface = (usbhc_iface_t *) iface; + + if (!usb_iface->bind_address) { + ipc_answer_0(callid, ENOTSUP); + return; + } + + usb_address_t address = (usb_address_t) DEV_IPC_GET_ARG1(*call); + devman_handle_t handle = (devman_handle_t) DEV_IPC_GET_ARG2(*call); + + int rc = usb_iface->bind_address(device, address, handle); + + ipc_answer_0(callid, rc); +} + +void remote_usbhc_release_address(device_t *device, void *iface, + ipc_callid_t callid, ipc_call_t *call) +{ + usbhc_iface_t *usb_iface = (usbhc_iface_t *) iface; + + if (!usb_iface->release_address) { + ipc_answer_0(callid, ENOTSUP); + return; + } + + usb_address_t address = (usb_address_t) DEV_IPC_GET_ARG1(*call); + + int rc = usb_iface->release_address(device, address); + + ipc_answer_0(callid, rc); +} + + +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, (sysarg_t)trans); + + trans->size = actual_size; +} + +/** Process an outgoing transfer (both OUT and SETUP). + * + * @param device Target device. + * @param callid Initiating caller. + * @param call Initiating call. + * @param transfer_func Transfer function (might be NULL). + */ +static void remote_usbhc_out_transfer(device_t *device, + ipc_callid_t callid, ipc_call_t *call, + usbhc_iface_transfer_out_t transfer_func) +{ + if (!transfer_func) { + ipc_answer_0(callid, ENOTSUP); + return; + } + + size_t expected_len = DEV_IPC_GET_ARG3(*call); + usb_target_t target = { + .address = DEV_IPC_GET_ARG1(*call), + .endpoint = DEV_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; + } + } + + async_transaction_t *trans = malloc(sizeof(async_transaction_t)); + trans->caller = callid; + trans->buffer = buffer; + trans->size = len; + + int rc = transfer_func(device, target, buffer, len, + callback_out, trans); + + if (rc != EOK) { + ipc_answer_0(callid, rc); + if (buffer != NULL) { + free(buffer); + } + free(trans); + } +} + +/** Process an incoming transfer. + * + * @param device Target device. + * @param callid Initiating caller. + * @param call Initiating call. + * @param transfer_func Transfer function (might be NULL). + */ +static void remote_usbhc_in_transfer(device_t *device, + ipc_callid_t callid, ipc_call_t *call, + usbhc_iface_transfer_in_t transfer_func) +{ + if (!transfer_func) { + ipc_answer_0(callid, ENOTSUP); + return; + } + + size_t len = DEV_IPC_GET_ARG3(*call); + usb_target_t target = { + .address = DEV_IPC_GET_ARG1(*call), + .endpoint = DEV_IPC_GET_ARG2(*call) + }; + + async_transaction_t *trans = malloc(sizeof(async_transaction_t)); + trans->caller = callid; + trans->buffer = malloc(len); + trans->size = len; + + int rc = transfer_func(device, target, trans->buffer, len, + callback_in, trans); + + if (rc != EOK) { + ipc_answer_0(callid, rc); + free(trans->buffer); + free(trans); + } +} + +/** Process status part of control transfer. + * + * @param device Target device. + * @param callid Initiating caller. + * @param call Initiating call. + * @param direction Transfer direction (read ~ in, write ~ out). + * @param transfer_in_func Transfer function for control read (might be NULL). + * @param transfer_out_func Transfer function for control write (might be NULL). + */ +static void remote_usbhc_status_transfer(device_t *device, + ipc_callid_t callid, ipc_call_t *call, + usb_direction_t direction, + int (*transfer_in_func)(device_t *, usb_target_t, + usbhc_iface_transfer_in_callback_t, void *), + int (*transfer_out_func)(device_t *, usb_target_t, + usbhc_iface_transfer_out_callback_t, void *)) +{ + switch (direction) { + case USB_DIRECTION_IN: + if (!transfer_in_func) { + ipc_answer_0(callid, ENOTSUP); + return; + } + break; + case USB_DIRECTION_OUT: + if (!transfer_out_func) { + ipc_answer_0(callid, ENOTSUP); + return; + } + break; + default: + assert(false && "unreachable code"); + break; + } + + usb_target_t target = { + .address = DEV_IPC_GET_ARG1(*call), + .endpoint = DEV_IPC_GET_ARG2(*call) + }; + + async_transaction_t *trans = malloc(sizeof(async_transaction_t)); + trans->caller = callid; + trans->buffer = NULL; + trans->size = 0; + + int rc; + switch (direction) { + case USB_DIRECTION_IN: + rc = transfer_in_func(device, target, + callback_in, trans); + break; + case USB_DIRECTION_OUT: + rc = transfer_out_func(device, target, + callback_out, trans); + break; + default: + assert(false && "unreachable code"); + break; + } + + if (rc != EOK) { + ipc_answer_0(callid, rc); + free(trans); + } + return; +} + + +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; + assert(usb_iface != NULL); + + return remote_usbhc_out_transfer(device, callid, call, + usb_iface->interrupt_out); +} + +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; + assert(usb_iface != NULL); + + return remote_usbhc_in_transfer(device, callid, call, + usb_iface->interrupt_in); +} + +void remote_usbhc_control_write_setup(device_t *device, void *iface, + ipc_callid_t callid, ipc_call_t *call) +{ + usbhc_iface_t *usb_iface = (usbhc_iface_t *) iface; + assert(usb_iface != NULL); + + return remote_usbhc_out_transfer(device, callid, call, + usb_iface->control_write_setup); +} + +void remote_usbhc_control_write_data(device_t *device, void *iface, + ipc_callid_t callid, ipc_call_t *call) +{ + usbhc_iface_t *usb_iface = (usbhc_iface_t *) iface; + assert(usb_iface != NULL); + + return remote_usbhc_out_transfer(device, callid, call, + usb_iface->control_write_data); +} + +void remote_usbhc_control_write_status(device_t *device, void *iface, + ipc_callid_t callid, ipc_call_t *call) +{ + usbhc_iface_t *usb_iface = (usbhc_iface_t *) iface; + assert(usb_iface != NULL); + + return remote_usbhc_status_transfer(device, callid, call, + USB_DIRECTION_IN, usb_iface->control_write_status, NULL); +} + +void remote_usbhc_control_read_setup(device_t *device, void *iface, + ipc_callid_t callid, ipc_call_t *call) +{ + usbhc_iface_t *usb_iface = (usbhc_iface_t *) iface; + assert(usb_iface != NULL); + + return remote_usbhc_out_transfer(device, callid, call, + usb_iface->control_read_setup); +} + +void remote_usbhc_control_read_data(device_t *device, void *iface, + ipc_callid_t callid, ipc_call_t *call) +{ + usbhc_iface_t *usb_iface = (usbhc_iface_t *) iface; + assert(usb_iface != NULL); + + return remote_usbhc_in_transfer(device, callid, call, + usb_iface->control_read_data); +} + +void remote_usbhc_control_read_status(device_t *device, void *iface, + ipc_callid_t callid, ipc_call_t *call) +{ + usbhc_iface_t *usb_iface = (usbhc_iface_t *) iface; + assert(usb_iface != NULL); + + return remote_usbhc_status_transfer(device, callid, call, + USB_DIRECTION_OUT, NULL, usb_iface->control_read_status); +} + + + +/** + * @} + */ Index: uspace/lib/drv/include/driver.h =================================================================== --- uspace/lib/drv/include/driver.h (revision 22027b6e7981eafebc4220c771cc114cfcc00c1f) +++ uspace/lib/drv/include/driver.h (revision 6fe1ab4654f3d29aa401e00bfbe8206d0dd7a4ca) @@ -146,5 +146,5 @@ extern int child_device_register(device_t *, device_t *); extern int child_device_register_wrapper(device_t *, const char *, const char *, - int); + int, devman_handle_t *); /* Index: uspace/lib/drv/include/remote_usb.h =================================================================== --- uspace/lib/drv/include/remote_usb.h (revision 6fe1ab4654f3d29aa401e00bfbe8206d0dd7a4ca) +++ uspace/lib/drv/include/remote_usb.h (revision 6fe1ab4654f3d29aa401e00bfbe8206d0dd7a4ca) @@ -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_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 6fe1ab4654f3d29aa401e00bfbe8206d0dd7a4ca) +++ uspace/lib/drv/include/remote_usbhc.h (revision 6fe1ab4654f3d29aa401e00bfbe8206d0dd7a4ca) @@ -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 6fe1ab4654f3d29aa401e00bfbe8206d0dd7a4ca) +++ uspace/lib/drv/include/usb_iface.h (revision 6fe1ab4654f3d29aa401e00bfbe8206d0dd7a4ca) @@ -0,0 +1,63 @@ +/* + * 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 +typedef enum { + /** Tell devman handle of device host controller. + * Parameters: + * - none + * Answer: + * - EOK - request processed without errors + * - ENOTSUP - this indicates invalid USB driver + * Parameters of the answer: + * - devman handle of HC caller is physically connected to + */ + IPC_M_USB_GET_HOST_CONTROLLER_HANDLE +} usb_iface_funcs_t; + +/** USB device communication interface. */ +typedef struct { + int (*get_hc_handle)(device_t *, devman_handle_t *); +} usb_iface_t; + + +#endif +/** + * @} + */ Index: uspace/lib/drv/include/usbhc_iface.h =================================================================== --- uspace/lib/drv/include/usbhc_iface.h (revision 6fe1ab4654f3d29aa401e00bfbe8206d0dd7a4ca) +++ uspace/lib/drv/include/usbhc_iface.h (revision 6fe1ab4654f3d29aa401e00bfbe8206d0dd7a4ca) @@ -0,0 +1,256 @@ +/* + * 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 host controller 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 { + /** Tell USB address assigned to device. + * Parameters: + * - devman handle id + * Answer: + * - EINVAL - unknown handle or handle not managed by this driver + * - ENOTSUP - operation not supported by HC (shall not happen) + * - arbitrary error code if returned by remote implementation + * - EOK - handle found, first parameter contains the USB address + */ + IPC_M_USBHC_GET_ADDRESS, + + /** 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, + + + /** Reserve usage of default address. + * This call informs the host controller that the caller will be + * using default USB address. It is duty of the HC driver to ensure + * that only single entity will have it reserved. + * The address is returned via IPC_M_USBHC_RELEASE_DEFAULT_ADDRESS. + * The caller can start using the address after receiving EOK + * answer. + */ + IPC_M_USBHC_RESERVE_DEFAULT_ADDRESS, + + /** Release usage of default address. + * @see IPC_M_USBHC_RESERVE_DEFAULT_ADDRESS + */ + IPC_M_USBHC_RELEASE_DEFAULT_ADDRESS, + + /** Asks for address assignment by host controller. + * Answer: + * - ELIMIT - host controller run out of address + * - EOK - address assigned + * Answer arguments: + * - assigned address + * + * The address must be released by via IPC_M_USBHC_RELEASE_ADDRESS. + */ + IPC_M_USBHC_REQUEST_ADDRESS, + + /** Bind USB address with devman handle. + * Parameters: + * - USB address + * - devman handle + * Answer: + * - EOK - address binded + * - ENOENT - address is not in use + */ + IPC_M_USBHC_BIND_ADDRESS, + + /** Release address in use. + * Arguments: + * - address to be released + * Answer: + * - ENOENT - address not in use + * - EPERM - trying to release default USB address + */ + IPC_M_USBHC_RELEASE_ADDRESS, + + + /** 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 *); + + +/** Out transfer processing function prototype. */ +typedef int (*usbhc_iface_transfer_out_t)(device_t *, usb_target_t, + void *, size_t, + usbhc_iface_transfer_out_callback_t, void *); + +/** Setup transfer processing function prototype. */ +typedef usbhc_iface_transfer_out_t usbhc_iface_transfer_setup_t; + +/** In transfer processing function prototype. */ +typedef int (*usbhc_iface_transfer_in_t)(device_t *, usb_target_t, + void *, size_t, + usbhc_iface_transfer_in_callback_t, void *); + +/** USB host controller communication interface. */ +typedef struct { + int (*tell_address)(device_t *, devman_handle_t, usb_address_t *); + + int (*reserve_default_address)(device_t *); + int (*release_default_address)(device_t *); + int (*request_address)(device_t *, usb_address_t *); + int (*bind_address)(device_t *, usb_address_t, devman_handle_t); + int (*release_address)(device_t *, usb_address_t); + + usbhc_iface_transfer_out_t interrupt_out; + usbhc_iface_transfer_in_t interrupt_in; + + usbhc_iface_transfer_setup_t control_write_setup; + usbhc_iface_transfer_out_t control_write_data; + int (*control_write_status)(device_t *, usb_target_t, + usbhc_iface_transfer_in_callback_t, void *); + + usbhc_iface_transfer_setup_t control_read_setup; + usbhc_iface_transfer_in_t control_read_data; + int (*control_read_status)(device_t *, usb_target_t, + usbhc_iface_transfer_out_callback_t, void *); +} usbhc_iface_t; + + +#endif +/** + * @} + */