102ac6454SAndrew Thompson /* $FreeBSD$ */ 202ac6454SAndrew Thompson /*- 302ac6454SAndrew Thompson * Copyright (c) 2008 Hans Petter Selasky. All rights reserved. 402ac6454SAndrew Thompson * 502ac6454SAndrew Thompson * Redistribution and use in source and binary forms, with or without 602ac6454SAndrew Thompson * modification, are permitted provided that the following conditions 702ac6454SAndrew Thompson * are met: 802ac6454SAndrew Thompson * 1. Redistributions of source code must retain the above copyright 902ac6454SAndrew Thompson * notice, this list of conditions and the following disclaimer. 1002ac6454SAndrew Thompson * 2. Redistributions in binary form must reproduce the above copyright 1102ac6454SAndrew Thompson * notice, this list of conditions and the following disclaimer in the 1202ac6454SAndrew Thompson * documentation and/or other materials provided with the distribution. 1302ac6454SAndrew Thompson * 1402ac6454SAndrew Thompson * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 1502ac6454SAndrew Thompson * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1602ac6454SAndrew Thompson * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 1702ac6454SAndrew Thompson * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 1802ac6454SAndrew Thompson * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 1902ac6454SAndrew Thompson * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2002ac6454SAndrew Thompson * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2102ac6454SAndrew Thompson * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2202ac6454SAndrew Thompson * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2302ac6454SAndrew Thompson * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2402ac6454SAndrew Thompson * SUCH DAMAGE. 2502ac6454SAndrew Thompson */ 2602ac6454SAndrew Thompson 2775973647SAndrew Thompson #ifndef _USB_CONTROLLER_H_ 2875973647SAndrew Thompson #define _USB_CONTROLLER_H_ 2902ac6454SAndrew Thompson 3002ac6454SAndrew Thompson /* defines */ 3102ac6454SAndrew Thompson 3202ac6454SAndrew Thompson #define USB_BUS_DMA_TAG_MAX 8 3302ac6454SAndrew Thompson 3402ac6454SAndrew Thompson /* structure prototypes */ 3502ac6454SAndrew Thompson 36760bc48eSAndrew Thompson struct usb_bus; 37760bc48eSAndrew Thompson struct usb_page; 38ae60fdfbSAndrew Thompson struct usb_endpoint; 39760bc48eSAndrew Thompson struct usb_page_cache; 40760bc48eSAndrew Thompson struct usb_setup_params; 41760bc48eSAndrew Thompson struct usb_hw_ep_profile; 42760bc48eSAndrew Thompson struct usb_fs_isoc_schedule; 43760bc48eSAndrew Thompson struct usb_config_descriptor; 44760bc48eSAndrew Thompson struct usb_endpoint_descriptor; 4502ac6454SAndrew Thompson 4602ac6454SAndrew Thompson /* typedefs */ 4702ac6454SAndrew Thompson 48f9cb546cSAndrew Thompson typedef void (usb_bus_mem_sub_cb_t)(struct usb_bus *bus, struct usb_page_cache *pc, struct usb_page *pg, usb_size_t size, usb_size_t align); 49e0a69b51SAndrew Thompson typedef void (usb_bus_mem_cb_t)(struct usb_bus *bus, usb_bus_mem_sub_cb_t *scb); 5002ac6454SAndrew Thompson 5102ac6454SAndrew Thompson /* 5202ac6454SAndrew Thompson * The following structure is used to define all the USB BUS 5302ac6454SAndrew Thompson * callbacks. 5402ac6454SAndrew Thompson */ 55760bc48eSAndrew Thompson struct usb_bus_methods { 5602ac6454SAndrew Thompson 5702ac6454SAndrew Thompson /* USB Device and Host mode - Mandatory */ 5802ac6454SAndrew Thompson 59e0a69b51SAndrew Thompson usb_handle_req_t *roothub_exec; 60459d369eSAndrew Thompson 61ae60fdfbSAndrew Thompson void (*endpoint_init) (struct usb_device *, 62ae60fdfbSAndrew Thompson struct usb_endpoint_descriptor *, struct usb_endpoint *); 63760bc48eSAndrew Thompson void (*xfer_setup) (struct usb_setup_params *); 64760bc48eSAndrew Thompson void (*xfer_unsetup) (struct usb_xfer *); 65760bc48eSAndrew Thompson void (*get_dma_delay) (struct usb_bus *, uint32_t *); 66760bc48eSAndrew Thompson void (*device_suspend) (struct usb_device *); 67760bc48eSAndrew Thompson void (*device_resume) (struct usb_device *); 68760bc48eSAndrew Thompson void (*set_hw_power) (struct usb_bus *); 69459d369eSAndrew Thompson 7002ac6454SAndrew Thompson /* 7102ac6454SAndrew Thompson * The following flag is set if one or more control transfers are 7202ac6454SAndrew Thompson * active: 7302ac6454SAndrew Thompson */ 7402ac6454SAndrew Thompson #define USB_HW_POWER_CONTROL 0x01 7502ac6454SAndrew Thompson /* 7602ac6454SAndrew Thompson * The following flag is set if one or more bulk transfers are 7702ac6454SAndrew Thompson * active: 7802ac6454SAndrew Thompson */ 7902ac6454SAndrew Thompson #define USB_HW_POWER_BULK 0x02 8002ac6454SAndrew Thompson /* 8102ac6454SAndrew Thompson * The following flag is set if one or more interrupt transfers are 8202ac6454SAndrew Thompson * active: 8302ac6454SAndrew Thompson */ 8402ac6454SAndrew Thompson #define USB_HW_POWER_INTERRUPT 0x04 8502ac6454SAndrew Thompson /* 8602ac6454SAndrew Thompson * The following flag is set if one or more isochronous transfers 8702ac6454SAndrew Thompson * are active: 8802ac6454SAndrew Thompson */ 8902ac6454SAndrew Thompson #define USB_HW_POWER_ISOC 0x08 9002ac6454SAndrew Thompson /* 9102ac6454SAndrew Thompson * The following flag is set if one or more non-root-HUB devices 9202ac6454SAndrew Thompson * are present on the given USB bus: 9302ac6454SAndrew Thompson */ 9402ac6454SAndrew Thompson #define USB_HW_POWER_NON_ROOT_HUB 0x10 9502ac6454SAndrew Thompson 9602ac6454SAndrew Thompson /* USB Device mode only - Mandatory */ 9702ac6454SAndrew Thompson 98760bc48eSAndrew Thompson void (*get_hw_ep_profile) (struct usb_device *udev, const struct usb_hw_ep_profile **ppf, uint8_t ep_addr); 9929bd7d7eSAndrew Thompson void (*set_stall) (struct usb_device *udev, struct usb_xfer *xfer, struct usb_endpoint *ep, uint8_t *did_stall); 100ae60fdfbSAndrew Thompson void (*clear_stall) (struct usb_device *udev, struct usb_endpoint *ep); 10102ac6454SAndrew Thompson 102dddb25f9SAlfred Perlstein /* Optional transfer polling support */ 103dddb25f9SAlfred Perlstein 104dddb25f9SAlfred Perlstein void (*xfer_poll) (struct usb_bus *); 10502ac6454SAndrew Thompson }; 10602ac6454SAndrew Thompson 10702ac6454SAndrew Thompson /* 10802ac6454SAndrew Thompson * The following structure is used to define all the USB pipe 10902ac6454SAndrew Thompson * callbacks. 11002ac6454SAndrew Thompson */ 111760bc48eSAndrew Thompson struct usb_pipe_methods { 11202ac6454SAndrew Thompson 11302ac6454SAndrew Thompson /* Mandatory USB Device and Host mode callbacks: */ 11402ac6454SAndrew Thompson 115ed6d949aSAndrew Thompson void (*open)(struct usb_xfer *); 116ed6d949aSAndrew Thompson void (*close)(struct usb_xfer *); 11702ac6454SAndrew Thompson 118ed6d949aSAndrew Thompson void (*enter)(struct usb_xfer *); 119ed6d949aSAndrew Thompson void (*start)(struct usb_xfer *); 12002ac6454SAndrew Thompson 12102ac6454SAndrew Thompson /* Optional */ 12202ac6454SAndrew Thompson 12302ac6454SAndrew Thompson void *info; 12402ac6454SAndrew Thompson }; 12502ac6454SAndrew Thompson 12602ac6454SAndrew Thompson /* 12702ac6454SAndrew Thompson * The following structure keeps information about what a hardware USB 12802ac6454SAndrew Thompson * endpoint supports. 12902ac6454SAndrew Thompson */ 130760bc48eSAndrew Thompson struct usb_hw_ep_profile { 13102ac6454SAndrew Thompson uint16_t max_in_frame_size; /* IN-token direction */ 13202ac6454SAndrew Thompson uint16_t max_out_frame_size; /* OUT-token direction */ 13302ac6454SAndrew Thompson uint8_t is_simplex:1; 13402ac6454SAndrew Thompson uint8_t support_multi_buffer:1; 13502ac6454SAndrew Thompson uint8_t support_bulk:1; 13602ac6454SAndrew Thompson uint8_t support_control:1; 13702ac6454SAndrew Thompson uint8_t support_interrupt:1; 13802ac6454SAndrew Thompson uint8_t support_isochronous:1; 13902ac6454SAndrew Thompson uint8_t support_in:1; /* IN-token is supported */ 14002ac6454SAndrew Thompson uint8_t support_out:1; /* OUT-token is supported */ 14102ac6454SAndrew Thompson }; 14202ac6454SAndrew Thompson 14302ac6454SAndrew Thompson /* 14402ac6454SAndrew Thompson * The following structure is used when trying to allocate hardware 14502ac6454SAndrew Thompson * endpoints for an USB configuration in USB device side mode. 14602ac6454SAndrew Thompson */ 147760bc48eSAndrew Thompson struct usb_hw_ep_scratch_sub { 148760bc48eSAndrew Thompson const struct usb_hw_ep_profile *pf; 14902ac6454SAndrew Thompson uint16_t max_frame_size; 15002ac6454SAndrew Thompson uint8_t hw_endpoint_out; 15102ac6454SAndrew Thompson uint8_t hw_endpoint_in; 15202ac6454SAndrew Thompson uint8_t needs_ep_type; 15302ac6454SAndrew Thompson uint8_t needs_in:1; 15402ac6454SAndrew Thompson uint8_t needs_out:1; 15502ac6454SAndrew Thompson }; 15602ac6454SAndrew Thompson 15702ac6454SAndrew Thompson /* 15802ac6454SAndrew Thompson * The following structure is used when trying to allocate hardware 15902ac6454SAndrew Thompson * endpoints for an USB configuration in USB device side mode. 16002ac6454SAndrew Thompson */ 161760bc48eSAndrew Thompson struct usb_hw_ep_scratch { 162760bc48eSAndrew Thompson struct usb_hw_ep_scratch_sub ep[USB_EP_MAX]; 163760bc48eSAndrew Thompson struct usb_hw_ep_scratch_sub *ep_max; 164760bc48eSAndrew Thompson struct usb_config_descriptor *cd; 165760bc48eSAndrew Thompson struct usb_device *udev; 166760bc48eSAndrew Thompson struct usb_bus_methods *methods; 16702ac6454SAndrew Thompson uint8_t bmOutAlloc[(USB_EP_MAX + 15) / 16]; 16802ac6454SAndrew Thompson uint8_t bmInAlloc[(USB_EP_MAX + 15) / 16]; 16902ac6454SAndrew Thompson }; 17002ac6454SAndrew Thompson 17102ac6454SAndrew Thompson /* 17202ac6454SAndrew Thompson * The following structure is used when generating USB descriptors 17302ac6454SAndrew Thompson * from USB templates. 17402ac6454SAndrew Thompson */ 175760bc48eSAndrew Thompson struct usb_temp_setup { 17602ac6454SAndrew Thompson void *buf; 177f9cb546cSAndrew Thompson usb_size_t size; 1788d2dd5ddSAndrew Thompson enum usb_dev_speed usb_speed; 17902ac6454SAndrew Thompson uint8_t self_powered; 18002ac6454SAndrew Thompson uint8_t bNumEndpoints; 18102ac6454SAndrew Thompson uint8_t bInterfaceNumber; 18202ac6454SAndrew Thompson uint8_t bAlternateSetting; 18302ac6454SAndrew Thompson uint8_t bConfigurationValue; 184e0a69b51SAndrew Thompson usb_error_t err; 18502ac6454SAndrew Thompson }; 18602ac6454SAndrew Thompson 18702ac6454SAndrew Thompson /* prototypes */ 18802ac6454SAndrew Thompson 189a593f6b8SAndrew Thompson void usb_bus_mem_flush_all(struct usb_bus *bus, usb_bus_mem_cb_t *cb); 190a593f6b8SAndrew Thompson uint8_t usb_bus_mem_alloc_all(struct usb_bus *bus, bus_dma_tag_t dmat, usb_bus_mem_cb_t *cb); 191a593f6b8SAndrew Thompson void usb_bus_mem_free_all(struct usb_bus *bus, usb_bus_mem_cb_t *cb); 192a593f6b8SAndrew Thompson uint16_t usb_isoc_time_expand(struct usb_bus *bus, uint16_t isoc_time_curr); 193a593f6b8SAndrew Thompson uint16_t usbd_fs_isoc_schedule_isoc_time_expand(struct usb_device *udev, struct usb_fs_isoc_schedule **pp_start, struct usb_fs_isoc_schedule **pp_end, uint16_t isoc_time); 194a593f6b8SAndrew Thompson uint8_t usbd_fs_isoc_schedule_alloc(struct usb_fs_isoc_schedule *fss, uint8_t *pstart, uint16_t len); 19502ac6454SAndrew Thompson 19675973647SAndrew Thompson #endif /* _USB_CONTROLLER_H_ */ 197