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 #pragma ident	"%Z%%M%	%I%	%E% SMI"
30 
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34 
35 /*
36  * Universal Host Controller Driver(UHCI)
37  *
38  * The UHCI driver is a software driver which interfaces to the Universal
39  * Serial Bus Driver(USBA) and the Host Controller(HC). The interface to
40  * the Host Controller is defined by the UHCI.
41  */
42 int	uhci_hcdi_pipe_open(usba_pipe_handle_data_t *pipe_handle,
43 		    usb_flags_t flags);
44 int	uhci_hcdi_pipe_close(usba_pipe_handle_data_t *pipe_handle,
45 		    usb_flags_t flags);
46 int	uhci_hcdi_pipe_reset(usba_pipe_handle_data_t *pipe_handle,
47 		    usb_flags_t usb_flags);
48 int	uhci_hcdi_pipe_ctrl_xfer(usba_pipe_handle_data_t *,
49 		    usb_ctrl_req_t *, usb_flags_t);
50 int	uhci_hcdi_pipe_bulk_xfer(usba_pipe_handle_data_t *,
51 		    usb_bulk_req_t *, usb_flags_t);
52 int	uhci_hcdi_pipe_isoc_xfer(usba_pipe_handle_data_t *,
53 		    usb_isoc_req_t *, usb_flags_t);
54 int	uhci_hcdi_pipe_intr_xfer(usba_pipe_handle_data_t *,
55 		    usb_intr_req_t *, usb_flags_t);
56 int	uhci_hcdi_bulk_transfer_size(usba_device_t *usba_device,
57 		    size_t  *size);
58 int	uhci_hcdi_pipe_stop_intr_polling(
59 		    usba_pipe_handle_data_t *pipe_handle, usb_flags_t flags);
60 int	uhci_hcdi_pipe_stop_isoc_polling(usba_pipe_handle_data_t *ph,
61 		    usb_flags_t flags);
62 int	uhci_hcdi_get_current_frame_number(usba_device_t *usba_device,
63 		    usb_frame_number_t	*frame_number);
64 int	uhci_hcdi_get_max_isoc_pkts(usba_device_t *usba_device,
65 		    uint_t	*max_isoc_pkts_per_request);
66 
67 /* Root hub prototypes */
68 int	uhci_handle_root_hub_request(
69 		    uhci_state_t		*uhcip,
70 		    usba_pipe_handle_data_t	*pipe_handle,
71 		    usb_ctrl_req_t	*req);
72 
73 void	uhci_handle_ctrl_td(uhci_state_t *uhcip, uhci_td_t *td);
74 int	uhci_insert_bulk_td(uhci_state_t *uhcip,
75 		    usba_pipe_handle_data_t *ph,
76 		    usb_bulk_req_t *req, usb_flags_t flags);
77 void	uhci_handle_intr_td(uhci_state_t *uhcip, uhci_td_t *td);
78 void	uhci_sendup_td_message(uhci_state_t *uhcip, usb_cr_t,
79 		    uhci_trans_wrapper_t *tw);
80 usb_cr_t uhci_parse_td_error(uhci_state_t *uhcip,
81 		    uhci_pipe_private_t *pp, uhci_td_t *td);
82 void	uhci_process_submitted_td_queue(uhci_state_t *uhcip);
83 void	uhci_delete_td(uhci_state_t *uhcip, uhci_td_t *td);
84 
85 /* global HCDI prototypes */
86 usba_hcdi_ops_t	*uhci_alloc_hcdi_ops(uhci_state_t *uhcip);
87 int	uhci_hcdi_polled_input_init(
88 		    usba_pipe_handle_data_t *uhcip,
89 		    uchar_t **polledbuf, usb_console_info_impl_t *info);
90 int	uhci_hcdi_polled_input_enter(usb_console_info_impl_t *info);
91 int	uhci_hcdi_polled_read(usb_console_info_impl_t *info, uint_t *num);
92 int	uhci_hcdi_polled_input_exit(usb_console_info_impl_t *info);
93 int	uhci_hcdi_polled_input_fini(usb_console_info_impl_t *info);
94 void	uhci_hcdi_callback(uhci_state_t *uhcip,
95 		    uhci_pipe_private_t *pp,
96 		    usba_pipe_handle_data_t *ph, uhci_trans_wrapper_t *tw,
97 		    usb_cr_t cr);
98 
99 void	uhci_set_dma_attributes(uhci_state_t *uhcip);
100 void	uhci_remove_qh(uhci_state_t *uhcip, uhci_pipe_private_t *pp);
101 void	uhci_insert_qh(uhci_state_t *uhcip,
102 		    usba_pipe_handle_data_t *pipe_handle);
103 void	uhci_decode_ddi_dma_addr_bind_handle_result(uhci_state_t *uhcip,
104 		    int result);
105 int	uhci_allocate_pools(uhci_state_t *uhcip);
106 void	uhci_free_pools(uhci_state_t *uhcip);
107 int	uhci_init_ctlr(uhci_state_t *uhcip);
108 void	uhci_uninit_ctlr(uhci_state_t *uhcip);
109 int	uhci_map_regs(uhci_state_t *uhcip);
110 void	uhci_unmap_regs(uhci_state_t *uhcip);
111 int	uhci_insert_hc_td(uhci_state_t *uhcip,
112 		    uint32_t buffer_address, size_t hcgtd_length,
113 		    uhci_pipe_private_t	*pp, uhci_trans_wrapper_t *tw,
114 		    uchar_t PID, usb_req_attrs_t attrs);
115 
116 int	uhci_allocate_periodic_in_resource(uhci_state_t *uhcip,
117 		    uhci_pipe_private_t *pp, uhci_trans_wrapper_t *tw,
118 		    usb_flags_t flags);
119 void	uhci_deallocate_periodic_in_resource(uhci_state_t *uhcip,
120 		    uhci_pipe_private_t *pp, uhci_trans_wrapper_t *tw);
121 void	uhci_do_intrs_stats(uhci_state_t *uhcip, int val);
122 void	uhci_do_byte_stats(uhci_state_t *, size_t, uint8_t, uint8_t);
123 void	uhci_deallocate_tw(uhci_state_t *uhcip, uhci_pipe_private_t *pp,
124 		    uhci_trans_wrapper_t *tw);
125 
126 /* other generic global prototypes */
127 uhci_state_t	*uhci_obtain_state(dev_info_t *dip);
128 queue_head_t	*uhci_alloc_queue_head(uhci_state_t *uhcip);
129 int	uhci_state_is_operational(uhci_state_t *uhcip);
130 void	uhci_save_data_toggle(uhci_pipe_private_t *pp);
131 int	uhci_wait_for_sof(uhci_state_t *uhcip);
132 void	uhci_modify_td_active_bits(uhci_state_t *uhcip,
133 	    uhci_pipe_private_t *pp);
134 void	uhci_deallocate_bandwidth(uhci_state_t *uhcip,
135 		usba_pipe_handle_data_t *pipe_handle);
136 int	uhci_allocate_bandwidth(uhci_state_t *uhcip,
137 		    usba_pipe_handle_data_t *pipe_handle, uint_t *node);
138 void	uhci_remove_tds_tws(uhci_state_t *uhcip,
139 		usba_pipe_handle_data_t *ph);
140 void	uhci_free_tw(uhci_state_t *uhcip, uhci_trans_wrapper_t *tw);
141 void	uhci_insert_qh(uhci_state_t *uhcip,
142 		usba_pipe_handle_data_t *pipe_handle);
143 void	uhci_cmd_timeout_hdlr(void *arg);
144 
145 /* Control prototypes */
146 int	uhci_insert_ctrl_td(uhci_state_t *uhcip,
147 		usba_pipe_handle_data_t *pipe_handle,
148 		usb_ctrl_req_t *req, usb_flags_t flags);
149 
150 /* Intr prototypes */
151 int	uhci_insert_intr_td(uhci_state_t *uhcip,
152 		usba_pipe_handle_data_t *pipe_handle,
153 		usb_intr_req_t *req, usb_flags_t flags);
154 
155 /* Bulk prototypes */
156 void	uhci_handle_bulk_td(uhci_state_t *uhcip, uhci_td_t *td);
157 void	uhci_fill_in_bulk_isoc_td(uhci_state_t *uhcip,
158 		uhci_td_t *current_td, uhci_td_t *next_td,
159 		uint32_t next_td_paddr, usba_pipe_handle_data_t *ph,
160 		uint_t offset, uint_t length,
161 		uhci_trans_wrapper_t *tw);
162 void	uhci_remove_bulk_tds_tws(uhci_state_t *uhcip,
163 		uhci_pipe_private_t *pp, int);
164 
165 /* Isoc prototypes */
166 int	uhci_insert_isoc_td(uhci_state_t *uhcip,
167 		usba_pipe_handle_data_t *ph, usb_isoc_req_t *isoc_req,
168 		size_t length, usb_flags_t usb_flags);
169 void	uhci_handle_isoc_td(uhci_state_t *uhcip, uhci_td_t *td);
170 int	uhci_start_isoc_receive_polling(
171 		uhci_state_t *uhcip, usba_pipe_handle_data_t *ph,
172 		usb_isoc_req_t *isoc_req, usb_flags_t usb_flags);
173 void	uhci_remove_isoc_tds_tws(uhci_state_t *uhcip,
174 		uhci_pipe_private_t *ph);
175 uint64_t uhci_get_sw_frame_number(uhci_state_t *uhcip);
176 void	uhci_isoc_update_sw_frame_number(uhci_state_t *uhcip);
177 
178 /* kstat support */
179 void	uhci_create_stats(uhci_state_t *uhcip);
180 void	uhci_destroy_stats(uhci_state_t *uhcip);
181 
182 /* arithmetic goodies */
183 uint_t	pow_2(unsigned int x);
184 uint_t	log_2(unsigned int x);
185 
186 #ifdef __cplusplus
187 }
188 #endif
189 
190 #endif /* _SYS_USB_UHCIUTIL_H */
191