1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 /* 22 * Copyright 2008 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 26 #ifndef _SYS_USB_UHCIUTIL_H 27 #define _SYS_USB_UHCIUTIL_H 28 29 30 #ifdef __cplusplus 31 extern "C" { 32 #endif 33 34 /* 35 * Universal Host Controller Driver(UHCI) 36 * 37 * The UHCI driver is a software driver which interfaces to the Universal 38 * Serial Bus Driver(USBA) and the Host Controller(HC). The interface to 39 * the Host Controller is defined by the UHCI. 40 */ 41 int uhci_hcdi_pipe_open(usba_pipe_handle_data_t *pipe_handle, 42 usb_flags_t flags); 43 int uhci_hcdi_pipe_close(usba_pipe_handle_data_t *pipe_handle, 44 usb_flags_t flags); 45 int uhci_hcdi_pipe_reset(usba_pipe_handle_data_t *pipe_handle, 46 usb_flags_t usb_flags); 47 int uhci_hcdi_pipe_ctrl_xfer(usba_pipe_handle_data_t *, 48 usb_ctrl_req_t *, usb_flags_t); 49 int uhci_hcdi_pipe_bulk_xfer(usba_pipe_handle_data_t *, 50 usb_bulk_req_t *, usb_flags_t); 51 int uhci_hcdi_pipe_isoc_xfer(usba_pipe_handle_data_t *, 52 usb_isoc_req_t *, usb_flags_t); 53 int uhci_hcdi_pipe_intr_xfer(usba_pipe_handle_data_t *, 54 usb_intr_req_t *, usb_flags_t); 55 int uhci_hcdi_bulk_transfer_size(usba_device_t *usba_device, 56 size_t *size); 57 int uhci_hcdi_pipe_stop_intr_polling( 58 usba_pipe_handle_data_t *pipe_handle, usb_flags_t flags); 59 int uhci_hcdi_pipe_stop_isoc_polling(usba_pipe_handle_data_t *ph, 60 usb_flags_t flags); 61 int uhci_hcdi_get_current_frame_number(usba_device_t *usba_device, 62 usb_frame_number_t *frame_number); 63 int uhci_hcdi_get_max_isoc_pkts(usba_device_t *usba_device, 64 uint_t *max_isoc_pkts_per_request); 65 66 /* Root hub prototypes */ 67 int uhci_handle_root_hub_request( 68 uhci_state_t *uhcip, 69 usba_pipe_handle_data_t *pipe_handle, 70 usb_ctrl_req_t *req); 71 72 void uhci_handle_ctrl_td(uhci_state_t *uhcip, uhci_td_t *td); 73 int uhci_insert_bulk_td(uhci_state_t *uhcip, 74 usba_pipe_handle_data_t *ph, 75 usb_bulk_req_t *req, usb_flags_t flags); 76 void uhci_handle_intr_td(uhci_state_t *uhcip, uhci_td_t *td); 77 void uhci_sendup_td_message(uhci_state_t *uhcip, usb_cr_t, 78 uhci_trans_wrapper_t *tw); 79 usb_cr_t uhci_parse_td_error(uhci_state_t *uhcip, 80 uhci_pipe_private_t *pp, uhci_td_t *td); 81 void uhci_process_submitted_td_queue(uhci_state_t *uhcip); 82 void uhci_delete_td(uhci_state_t *uhcip, uhci_td_t *td); 83 84 /* global HCDI prototypes */ 85 usba_hcdi_ops_t *uhci_alloc_hcdi_ops(uhci_state_t *uhcip); 86 int uhci_hcdi_polled_input_init( 87 usba_pipe_handle_data_t *uhcip, 88 uchar_t **polledbuf, usb_console_info_impl_t *info); 89 int uhci_hcdi_polled_input_enter(usb_console_info_impl_t *info); 90 int uhci_hcdi_polled_read(usb_console_info_impl_t *info, uint_t *num); 91 int uhci_hcdi_polled_input_exit(usb_console_info_impl_t *info); 92 int uhci_hcdi_polled_input_fini(usb_console_info_impl_t *info); 93 void uhci_hcdi_callback(uhci_state_t *uhcip, 94 uhci_pipe_private_t *pp, 95 usba_pipe_handle_data_t *ph, uhci_trans_wrapper_t *tw, 96 usb_cr_t cr); 97 98 void uhci_set_dma_attributes(uhci_state_t *uhcip); 99 void uhci_remove_qh(uhci_state_t *uhcip, uhci_pipe_private_t *pp); 100 void uhci_insert_qh(uhci_state_t *uhcip, 101 usba_pipe_handle_data_t *pipe_handle); 102 void uhci_decode_ddi_dma_addr_bind_handle_result(uhci_state_t *uhcip, 103 int result); 104 int uhci_allocate_pools(uhci_state_t *uhcip); 105 void uhci_free_pools(uhci_state_t *uhcip); 106 int uhci_init_ctlr(uhci_state_t *uhcip); 107 void uhci_uninit_ctlr(uhci_state_t *uhcip); 108 int uhci_map_regs(uhci_state_t *uhcip); 109 void uhci_unmap_regs(uhci_state_t *uhcip); 110 int uhci_insert_hc_td(uhci_state_t *uhcip, 111 uint32_t buffer_address, size_t hcgtd_length, 112 uhci_pipe_private_t *pp, uhci_trans_wrapper_t *tw, 113 uchar_t PID, usb_req_attrs_t attrs); 114 115 int uhci_allocate_periodic_in_resource(uhci_state_t *uhcip, 116 uhci_pipe_private_t *pp, uhci_trans_wrapper_t *tw, 117 usb_flags_t flags); 118 void uhci_deallocate_periodic_in_resource(uhci_state_t *uhcip, 119 uhci_pipe_private_t *pp, uhci_trans_wrapper_t *tw); 120 void uhci_do_intrs_stats(uhci_state_t *uhcip, int val); 121 void uhci_do_byte_stats(uhci_state_t *, size_t, uint8_t, uint8_t); 122 void uhci_deallocate_tw(uhci_state_t *uhcip, uhci_pipe_private_t *pp, 123 uhci_trans_wrapper_t *tw); 124 125 /* other generic global prototypes */ 126 uhci_state_t *uhci_obtain_state(dev_info_t *dip); 127 queue_head_t *uhci_alloc_queue_head(uhci_state_t *uhcip); 128 int uhci_state_is_operational(uhci_state_t *uhcip); 129 void uhci_save_data_toggle(uhci_pipe_private_t *pp); 130 int uhci_wait_for_sof(uhci_state_t *uhcip); 131 void uhci_modify_td_active_bits(uhci_state_t *uhcip, 132 uhci_pipe_private_t *pp); 133 void uhci_deallocate_bandwidth(uhci_state_t *uhcip, 134 usba_pipe_handle_data_t *pipe_handle); 135 int uhci_allocate_bandwidth(uhci_state_t *uhcip, 136 usba_pipe_handle_data_t *pipe_handle, uint_t *node); 137 void uhci_remove_tds_tws(uhci_state_t *uhcip, 138 usba_pipe_handle_data_t *ph); 139 void uhci_free_tw(uhci_state_t *uhcip, uhci_trans_wrapper_t *tw); 140 void uhci_insert_qh(uhci_state_t *uhcip, 141 usba_pipe_handle_data_t *pipe_handle); 142 void uhci_cmd_timeout_hdlr(void *arg); 143 144 /* Control prototypes */ 145 int uhci_insert_ctrl_td(uhci_state_t *uhcip, 146 usba_pipe_handle_data_t *pipe_handle, 147 usb_ctrl_req_t *req, usb_flags_t flags); 148 149 /* Intr prototypes */ 150 int uhci_insert_intr_td(uhci_state_t *uhcip, 151 usba_pipe_handle_data_t *pipe_handle, 152 usb_intr_req_t *req, usb_flags_t flags); 153 154 /* Bulk prototypes */ 155 void uhci_handle_bulk_td(uhci_state_t *uhcip, uhci_td_t *td); 156 void uhci_fill_in_bulk_isoc_td(uhci_state_t *uhcip, 157 uhci_td_t *current_td, uhci_td_t *next_td, 158 uint32_t next_td_paddr, usba_pipe_handle_data_t *ph, 159 uint_t offset, uint_t length, 160 uhci_trans_wrapper_t *tw); 161 void uhci_remove_bulk_tds_tws(uhci_state_t *uhcip, 162 uhci_pipe_private_t *pp, int); 163 164 /* Isoc prototypes */ 165 int uhci_insert_isoc_td(uhci_state_t *uhcip, 166 usba_pipe_handle_data_t *ph, usb_isoc_req_t *isoc_req, 167 size_t length, usb_flags_t usb_flags); 168 void uhci_handle_isoc_td(uhci_state_t *uhcip, uhci_td_t *td); 169 int uhci_start_isoc_receive_polling( 170 uhci_state_t *uhcip, usba_pipe_handle_data_t *ph, 171 usb_isoc_req_t *isoc_req, usb_flags_t usb_flags); 172 void uhci_remove_isoc_tds_tws(uhci_state_t *uhcip, 173 uhci_pipe_private_t *ph); 174 uint64_t uhci_get_sw_frame_number(uhci_state_t *uhcip); 175 void uhci_isoc_update_sw_frame_number(uhci_state_t *uhcip); 176 177 /* kstat support */ 178 void uhci_create_stats(uhci_state_t *uhcip); 179 void uhci_destroy_stats(uhci_state_t *uhcip); 180 181 /* arithmetic goodies */ 182 uint_t pow_2(unsigned int x); 183 uint_t log_2(unsigned int x); 184 185 #ifdef __cplusplus 186 } 187 #endif 188 189 #endif /* _SYS_USB_UHCIUTIL_H */ 190