1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
|
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License (the "License").
* You may not use this file except in compliance with the License.
*
* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
* or http://www.opensolaris.org/os/licensing.
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/
/*
* Copyright 2008 Sun Microsystems, Inc. All rights reserved.
* Use is subject to license terms.
* Copyright 2019, Joyent, Inc.
*/
/*
* USBA: Solaris USB Architecture support
*
* ISSUES:
*/
#define USBA_FRAMEWORK
#include <sys/usb/usba.h>
#include <sys/usb/usba/hcdi.h>
#include <sys/usb/usba/genconsole.h>
#include <sys/usb/usba/usba_types.h>
#include <sys/usb/usba/usba_impl.h>
/*
* Initialize USB polled support. This routine calls down to the lower
* layers to initialize any state information.
*/
int
usb_console_input_init(dev_info_t *dip, usb_pipe_handle_t pipe_handle,
uchar_t **state_buf, usb_console_info_t *console_input_info)
{
int ret;
usba_device_t *usba_device;
usba_pipe_handle_data_t *ph_data;
usb_console_info_impl_t *usb_console_input;
if (dip == NULL) {
return (USB_INVALID_ARGS);
}
if (DEVI_IS_DEVICE_REMOVED(dip)) {
return (USB_FAILURE);
}
usb_console_input = kmem_zalloc(
sizeof (struct usb_console_info_impl), KM_SLEEP);
/*
* Save the dip
*/
usb_console_input->uci_dip = dip;
/*
* Translate the dip into a device.
*/
usba_device = usba_get_usba_device(dip);
/*
* Get ph_data from pipe handle and hold the data
*/
if ((ph_data = usba_hold_ph_data(pipe_handle)) == NULL) {
kmem_free(usb_console_input,
sizeof (struct usb_console_info_impl));
return (USB_INVALID_PIPE);
}
/*
* Call the lower layer to initialize any state information
*/
ret = usba_device->usb_hcdi_ops->usba_hcdi_console_input_init(
ph_data, state_buf, usb_console_input);
if (ret != USB_SUCCESS) {
kmem_free(usb_console_input,
sizeof (struct usb_console_info_impl));
} else {
*console_input_info = (usb_console_info_t)usb_console_input;
}
usba_release_ph_data((usba_ph_impl_t *)pipe_handle);
return (ret);
}
/*
* Free up any resources that we allocated in the above initialization
* routine.
*/
int
usb_console_input_fini(usb_console_info_t console_input_info)
{
usb_console_info_impl_t *usb_console_input;
usba_device_t *usba_device;
int ret;
usb_console_input = (usb_console_info_impl_t *)console_input_info;
/*
* Translate the dip into a device.
*/
usba_device = usba_get_usba_device(usb_console_input->uci_dip);
/*
* Call the lower layer to free any state information.
*/
ret = usba_device->usb_hcdi_ops->usba_hcdi_console_input_fini(
usb_console_input);
if (ret == USB_FAILURE) {
return (ret);
}
/*
* We won't be needing this information anymore.
*/
kmem_free(usb_console_input, sizeof (struct usb_console_info_impl));
return (USB_SUCCESS);
}
/*
* This is the routine that OBP calls to save the USB state information
* before using the USB keyboard as an input device. This routine,
* and all of the routines that it calls, are responsible for saving
* any state information so that it can be restored when OBP mode is
* over. At this layer, this code is mainly just a pass through.
*
* Warning: this code runs in polled mode.
*/
int
usb_console_input_enter(usb_console_info_t console_input_info)
{
usba_device_t *usba_device;
usb_console_info_impl_t *usb_console_input;
usb_console_input = (usb_console_info_impl_t *)console_input_info;
/*
* Translate the dip into a device.
* Do this by directly looking at the dip, do not call
* usba_get_usba_device() because this function calls into the DDI.
* The ddi then tries to acquire a mutex and the machine hard hangs.
*/
usba_device = usba_polled_get_usba_device(usb_console_input->uci_dip);
/*
* Call the lower layer to save state information.
*/
return (usba_device->usb_hcdi_ops->usba_hcdi_console_input_enter(
usb_console_input));
}
/*
* This is the routine that OBP calls when it wants to read a character.
* We will call to the lower layers to see if there is any input data
* available. At this layer, this code is mainly just a pass through.
*
* Warning: This code runs in polled mode.
*/
int
usb_console_read(usb_console_info_t console_input_info, uint_t *num_characters)
{
usba_device_t *usba_device;
usb_console_info_impl_t *usb_console_input;
usb_console_input = (usb_console_info_impl_t *)console_input_info;
/*
* Translate the dip into a device.
* Do this by directly looking at the dip, do not call
* usba_get_usba_device() because this function calls into the DDI.
* The ddi then tries to acquire a mutex and the machine hard hangs.
*/
usba_device = usba_polled_get_usba_device(usb_console_input->uci_dip);
/*
* Call the lower layer to get a a character. Return the number
* of characters read into the buffer.
*/
return (usba_device->usb_hcdi_ops->usba_hcdi_console_read(
usb_console_input, num_characters));
}
/*
* This is the routine that OBP calls when it is giving up control of the
* USB keyboard. This routine, and the lower layer routines that it calls,
* are responsible for restoring the controller state to the state it was
* in before OBP took control. At this layer, this code is mainly just a
* pass through.
*
* Warning: This code runs in polled mode.
*/
int
usb_console_input_exit(usb_console_info_t console_input_info)
{
usba_device_t *usba_device;
usb_console_info_impl_t *usb_console_input;
usb_console_input = (usb_console_info_impl_t *)console_input_info;
/*
* Translate the dip into a device.
* Do this by directly looking at the dip, do not call
* usba_get_usba_device() because this function calls into the DDI.
* The ddi then tries to acquire a mutex and the machine hard hangs.
*/
usba_device = usba_polled_get_usba_device(usb_console_input->uci_dip);
/*
* Restore the state information.
*/
return (usba_device->usb_hcdi_ops->usba_hcdi_console_input_exit(
usb_console_input));
}
/*
* Initialize USB OBP support. This routine calls down to the lower
* layers to initialize any state information.
*/
int
usb_console_output_init(
dev_info_t *dip,
usb_pipe_handle_t pipe_handle,
usb_console_info_t *console_output_info)
{
usba_device_t *usb_device;
usb_console_info_impl_t *usb_console_output;
int ret;
/* Translate the dip into a device and check hcdi ops */
usb_device = usba_get_usba_device(dip);
if (usb_device->usb_hcdi_ops->usba_hcdi_ops_version <
HCDI_OPS_VERSION_1 ||
usb_device->usb_hcdi_ops->usba_hcdi_console_output_init == NULL)
return (USB_FAILURE);
usb_console_output = kmem_zalloc(sizeof (struct usb_console_info_impl),
KM_SLEEP);
usb_console_output->uci_dip = dip;
/*
* Call the lower layer to initialize any state information
*/
ret = usb_device->usb_hcdi_ops->usba_hcdi_console_output_init(
usba_get_ph_data(pipe_handle), usb_console_output);
if (ret == USB_FAILURE) {
kmem_free(usb_console_output,
sizeof (struct usb_console_info_impl));
return (ret);
}
*console_output_info = (usb_console_info_t)usb_console_output;
return (USB_SUCCESS);
}
/*
* Free up any resources that we allocated in the above initialization
* routine.
*/
int
usb_console_output_fini(usb_console_info_t console_output_info)
{
usb_console_info_impl_t *usb_console_output;
usba_device_t *usb_device;
int ret;
usb_console_output = (usb_console_info_impl_t *)console_output_info;
/*
* Translate the dip into a device.
*/
usb_device = usba_polled_get_usba_device(usb_console_output->uci_dip);
/*
* Call the lower layer to free any state information.
*/
ret = usb_device->usb_hcdi_ops->usba_hcdi_console_output_fini(
usb_console_output);
if (ret == USB_FAILURE) {
return (ret);
}
/*
* We won't be needing this information anymore.
*/
kmem_free(usb_console_output, sizeof (struct usb_console_info_impl));
return (USB_SUCCESS);
}
/*
* This is the routine that OBP calls to save the USB state information
* before using the USB device as an output device. This routine,
* and all of the routines that it calls, are responsible for saving
* any state information so that it can be restored when OBP mode is
* over. At this layer, this code is mainly just a pass through.
*/
int
usb_console_output_enter(usb_console_info_t console_output_info)
{
usba_device_t *usb_device;
usb_console_info_impl_t *usb_console_output;
usb_console_output = (usb_console_info_impl_t *)console_output_info;
/*
* Translate the dip into a device.
*/
usb_device = usba_polled_get_usba_device(usb_console_output->uci_dip);
/*
* Call the lower layer to save state information.
*/
return (usb_device->usb_hcdi_ops->usba_hcdi_console_output_enter(
usb_console_output));
}
/*
* This is the routine that OBP calls when it wants to write a character.
* We will call to the lower layers to write any data
* At this layer, this code is mainly just a pass through.
*/
int
usb_console_write(usb_console_info_t console_output_info,
uchar_t *buf, uint_t num_characters, uint_t *num_characters_written)
{
usba_device_t *usb_device;
usb_console_info_impl_t *usb_console_output;
usb_console_output = (usb_console_info_impl_t *)console_output_info;
/*
* Translate the dip into a device.
*/
usb_device = usba_polled_get_usba_device(usb_console_output->uci_dip);
/*
* Call the lower layer to get a a character. Return the number
* of characters read into the buffer.
*/
return (usb_device->usb_hcdi_ops->usba_hcdi_console_write(
usb_console_output, buf, num_characters,
num_characters_written));
}
/*
* This is the routine that OBP calls when it is giving up control of the
* USB output device. This routine, and the lower layer routines that it
* calls, are responsible for restoring the controller state to the state
* it was in before OBP took control. At this layer, this code is mainly
* just a pass through.
*/
int
usb_console_output_exit(usb_console_info_t console_output_info)
{
usba_device_t *usb_device;
usb_console_info_impl_t *usb_console_output;
usb_console_output = (usb_console_info_impl_t *)console_output_info;
/*
* Translate the dip into a device.
*/
usb_device = usba_polled_get_usba_device(usb_console_output->uci_dip);
/*
* Restore the state information.
*/
return (usb_device->usb_hcdi_ops->usba_hcdi_console_output_exit(
usb_console_output));
}
|
