usb_transfer.h revision 193074
1158115Sume/* $FreeBSD: head/sys/dev/usb/usb_transfer.h 193074 2009-05-30 00:22:57Z thompsa $ */ 2158115Sume/*- 3158115Sume * Copyright (c) 2008 Hans Petter Selasky. All rights reserved. 4158115Sume * 5158115Sume * Redistribution and use in source and binary forms, with or without 6158115Sume * modification, are permitted provided that the following conditions 7158115Sume * are met: 8158115Sume * 1. Redistributions of source code must retain the above copyright 9158115Sume * notice, this list of conditions and the following disclaimer. 10158115Sume * 2. Redistributions in binary form must reproduce the above copyright 11158115Sume * notice, this list of conditions and the following disclaimer in the 12158115Sume * documentation and/or other materials provided with the distribution. 13158115Sume * 14158115Sume * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15158115Sume * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16158115Sume * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17158115Sume * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18158115Sume * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19158115Sume * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20158115Sume * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21158115Sume * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22158115Sume * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23158115Sume * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24158115Sume * SUCH DAMAGE. 25158115Sume */ 26158115Sume 27158115Sume#ifndef _USB2_TRANSFER_H_ 28158115Sume#define _USB2_TRANSFER_H_ 29158115Sume 30158115Sume/* 31158115Sume * The following structure defines the messages that is used to signal 32158115Sume * the "done_p" USB process. 33158115Sume */ 34158115Sumestruct usb_done_msg { 35158115Sume struct usb_proc_msg hdr; 36158115Sume struct usb_xfer_root *xroot; 37158115Sume}; 38158115Sume 39158115Sume#define USB_DMATAG_TO_XROOT(dpt) \ 40158115Sume ((struct usb_xfer_root *)( \ 41158115Sume ((uint8_t *)(dpt)) - \ 42158115Sume ((uint8_t *)&((struct usb_xfer_root *)0)->dma_parent_tag))) 43158115Sume 44158115Sume/* 45158115Sume * The following structure is used to keep information about memory 46158115Sume * that should be automatically freed at the moment all USB transfers 47158115Sume * have been freed. 48158115Sume */ 49158115Sumestruct usb_xfer_root { 50158115Sume struct usb_dma_parent_tag dma_parent_tag; 51158115Sume#if USB_HAVE_BUSDMA 52158115Sume struct usb_xfer_queue dma_q; 53158115Sume#endif 54158115Sume struct usb_xfer_queue done_q; 55158115Sume struct usb_done_msg done_m[2]; 56158115Sume struct cv cv_drain; 57158115Sume 58158115Sume struct usb_process *done_p; /* pointer to callback process */ 59158115Sume void *memory_base; 60158115Sume struct mtx *xfer_mtx; /* cannot be changed during operation */ 61158115Sume#if USB_HAVE_BUSDMA 62158115Sume struct usb_page_cache *dma_page_cache_start; 63158115Sume struct usb_page_cache *dma_page_cache_end; 64158115Sume#endif 65158115Sume struct usb_page_cache *xfer_page_cache_start; 66158115Sume struct usb_page_cache *xfer_page_cache_end; 67158115Sume struct usb_bus *bus; /* pointer to USB bus (cached) */ 68158115Sume struct usb_device *udev; /* pointer to USB device */ 69158115Sume 70158115Sume usb_size_t memory_size; 71158115Sume usb_size_t setup_refcount; 72158115Sume#if USB_HAVE_BUSDMA 73158115Sume usb_frcount_t dma_nframes; /* number of page caches to load */ 74158115Sume usb_frcount_t dma_currframe; /* currect page cache number */ 75158115Sume usb_frlength_t dma_frlength_0; /* length of page cache zero */ 76158115Sume uint8_t dma_error; /* set if virtual memory could not be 77158115Sume * loaded */ 78158115Sume#endif 79158115Sume uint8_t done_sleep; /* set if done thread is sleeping */ 80158115Sume}; 81158115Sume 82158115Sume/* 83158115Sume * The following structure is used when setting up an array of USB 84158115Sume * transfers. 85158115Sume */ 86158115Sumestruct usb_setup_params { 87158115Sume struct usb_dma_tag *dma_tag_p; 88158115Sume struct usb_page *dma_page_ptr; 89158115Sume struct usb_page_cache *dma_page_cache_ptr; /* these will be 90158115Sume * auto-freed */ 91158115Sume struct usb_page_cache *xfer_page_cache_ptr; /* these will not be 92158115Sume * auto-freed */ 93158115Sume struct usb_device *udev; 94158115Sume struct usb_xfer *curr_xfer; 95158115Sume const struct usb_config *curr_setup; 96158115Sume const struct usb_pipe_methods *methods; 97158115Sume void *buf; 98158115Sume usb_frlength_t *xfer_length_ptr; 99158115Sume 100158115Sume usb_size_t size[7]; 101158115Sume usb_frlength_t bufsize; 102158115Sume usb_frlength_t bufsize_max; 103158115Sume 104158115Sume uint16_t hc_max_frame_size; 105158115Sume uint16_t hc_max_packet_size; 106158115Sume uint8_t hc_max_packet_count; 107158115Sume enum usb_dev_speed speed; 108158115Sume uint8_t dma_tag_max; 109158115Sume usb_error_t err; 110158115Sume}; 111158115Sume 112158115Sume/* function prototypes */ 113158115Sume 114158115Sumeuint8_t usb2_transfer_setup_sub_malloc(struct usb_setup_params *parm, 115158115Sume struct usb_page_cache **ppc, usb_size_t size, usb_size_t align, 116158115Sume usb_size_t count); 117158115Sumevoid usb2_command_wrapper(struct usb_xfer_queue *pq, 118158115Sume struct usb_xfer *xfer); 119158115Sumevoid usb2_pipe_enter(struct usb_xfer *xfer); 120158115Sumevoid usb2_pipe_start(struct usb_xfer_queue *pq); 121158115Sumevoid usb2_transfer_dequeue(struct usb_xfer *xfer); 122158115Sumevoid usb2_transfer_done(struct usb_xfer *xfer, usb_error_t error); 123158115Sumevoid usb2_transfer_enqueue(struct usb_xfer_queue *pq, 124158115Sume struct usb_xfer *xfer); 125158115Sumevoid usb2_transfer_setup_sub(struct usb_setup_params *parm); 126158115Sumevoid usb2_default_transfer_setup(struct usb_device *udev); 127158115Sumevoid usb2_clear_data_toggle(struct usb_device *udev, 128 struct usb_pipe *pipe); 129void usb2_do_poll(struct usb_xfer **ppxfer, uint16_t max); 130usb_callback_t usb2_do_request_callback; 131usb_callback_t usb2_handle_request_callback; 132usb_callback_t usb2_do_clear_stall_callback; 133void usb2_transfer_timeout_ms(struct usb_xfer *xfer, 134 void (*cb) (void *arg), usb_timeout_t ms); 135usb_timeout_t usb2_get_dma_delay(struct usb_bus *bus); 136void usb2_transfer_power_ref(struct usb_xfer *xfer, int val); 137 138#endif /* _USB2_TRANSFER_H_ */ 139