1 /* $OpenBSD: uark.c,v 1.1 2006/08/14 08:30:22 jsg Exp $ */
2
3 /*
4 * Copyright (c) 2006 Jonathan Gray <jsg@openbsd.org>
5 *
6 * Permission to use, copy, modify, and distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
9 *
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 *
18 * $FreeBSD$
19 */
20
21 /*
22 * NOTE: all function names beginning like "uark_cfg_" can only
23 * be called from within the config thread function !
24 */
25
26
27 #include <sys/stdint.h>
28 #include <sys/param.h>
29 #include <sys/queue.h>
30 #include <sys/types.h>
31 #include <sys/systm.h>
32 #include <sys/kernel.h>
33 #include <sys/bus.h>
34 #include <sys/module.h>
35 #include <sys/lock.h>
36 #include <sys/condvar.h>
37 #include <sys/sysctl.h>
38 #include <sys/unistd.h>
39 #include <sys/callout.h>
40 #include <sys/malloc.h>
41 #include <sys/caps.h>
42
43 #include <bus/u4b/usb.h>
44 #include <bus/u4b/usbdi.h>
45 #include <bus/u4b/usbdi_util.h>
46 #include <bus/u4b/usbhid.h>
47
48 #include "usbdevs.h"
49
50 #define USB_DEBUG_VAR usb_debug
51 #include <bus/u4b/usb_debug.h>
52 #include <bus/u4b/usb_process.h>
53
54 #include <bus/u4b/serial/usb_serial.h>
55
56 #define UARK_BUF_SIZE 1024 /* bytes */
57
58 #define UARK_SET_DATA_BITS(x) ((x) - 5)
59
60 #define UARK_PARITY_NONE 0x00
61 #define UARK_PARITY_ODD 0x08
62 #define UARK_PARITY_EVEN 0x18
63
64 #define UARK_STOP_BITS_1 0x00
65 #define UARK_STOP_BITS_2 0x04
66
67 #define UARK_BAUD_REF 3000000
68
69 #define UARK_WRITE 0x40
70 #define UARK_READ 0xc0
71
72 #define UARK_REQUEST 0xfe
73
74 #define UARK_CONFIG_INDEX 0
75 #define UARK_IFACE_INDEX 0
76
77 enum {
78 UARK_BULK_DT_WR,
79 UARK_BULK_DT_RD,
80 UARK_N_TRANSFER,
81 };
82
83 struct uark_softc {
84 struct ucom_super_softc sc_super_ucom;
85 struct ucom_softc sc_ucom;
86
87 struct usb_xfer *sc_xfer[UARK_N_TRANSFER];
88 struct usb_device *sc_udev;
89 struct lock sc_lock;
90
91 uint8_t sc_msr;
92 uint8_t sc_lsr;
93 };
94
95 /* prototypes */
96
97 static device_probe_t uark_probe;
98 static device_attach_t uark_attach;
99 static device_detach_t uark_detach;
100
101 static usb_callback_t uark_bulk_write_callback;
102 static usb_callback_t uark_bulk_read_callback;
103
104 static void uark_start_read(struct ucom_softc *);
105 static void uark_stop_read(struct ucom_softc *);
106 static void uark_start_write(struct ucom_softc *);
107 static void uark_stop_write(struct ucom_softc *);
108 static int uark_pre_param(struct ucom_softc *, struct termios *);
109 static void uark_cfg_param(struct ucom_softc *, struct termios *);
110 static void uark_cfg_get_status(struct ucom_softc *, uint8_t *,
111 uint8_t *);
112 static void uark_cfg_set_break(struct ucom_softc *, uint8_t);
113 static void uark_cfg_write(struct uark_softc *, uint16_t, uint16_t);
114 static void uark_poll(struct ucom_softc *ucom);
115
116 static const struct usb_config
117 uark_xfer_config[UARK_N_TRANSFER] = {
118
119 [UARK_BULK_DT_WR] = {
120 .type = UE_BULK,
121 .endpoint = UE_ADDR_ANY,
122 .direction = UE_DIR_OUT,
123 .bufsize = UARK_BUF_SIZE,
124 .flags = {.pipe_bof = 1,.force_short_xfer = 1,},
125 .callback = &uark_bulk_write_callback,
126 },
127
128 [UARK_BULK_DT_RD] = {
129 .type = UE_BULK,
130 .endpoint = UE_ADDR_ANY,
131 .direction = UE_DIR_IN,
132 .bufsize = UARK_BUF_SIZE,
133 .flags = {.pipe_bof = 1,.short_xfer_ok = 1,},
134 .callback = &uark_bulk_read_callback,
135 },
136 };
137
138 static const struct ucom_callback uark_callback = {
139 .ucom_cfg_get_status = &uark_cfg_get_status,
140 .ucom_cfg_set_break = &uark_cfg_set_break,
141 .ucom_cfg_param = &uark_cfg_param,
142 .ucom_pre_param = &uark_pre_param,
143 .ucom_start_read = &uark_start_read,
144 .ucom_stop_read = &uark_stop_read,
145 .ucom_start_write = &uark_start_write,
146 .ucom_stop_write = &uark_stop_write,
147 .ucom_poll = &uark_poll,
148 };
149
150 static device_method_t uark_methods[] = {
151 /* Device methods */
152 DEVMETHOD(device_probe, uark_probe),
153 DEVMETHOD(device_attach, uark_attach),
154 DEVMETHOD(device_detach, uark_detach),
155 DEVMETHOD_END
156 };
157
158 static devclass_t uark_devclass;
159
160 static driver_t uark_driver = {
161 .name = "uark",
162 .methods = uark_methods,
163 .size = sizeof(struct uark_softc),
164 };
165
166 DRIVER_MODULE(uark, uhub, uark_driver, uark_devclass, NULL, NULL);
167 MODULE_DEPEND(uark, ucom, 1, 1, 1);
168 MODULE_DEPEND(uark, usb, 1, 1, 1);
169 MODULE_VERSION(uark, 1);
170
171 static const STRUCT_USB_HOST_ID uark_devs[] = {
172 {USB_VPI(USB_VENDOR_ARKMICRO, USB_PRODUCT_ARKMICRO_ARK3116, 0)},
173 };
174
175 static int
uark_probe(device_t dev)176 uark_probe(device_t dev)
177 {
178 struct usb_attach_arg *uaa = device_get_ivars(dev);
179
180 if (uaa->usb_mode != USB_MODE_HOST) {
181 return (ENXIO);
182 }
183 if (uaa->info.bConfigIndex != 0) {
184 return (ENXIO);
185 }
186 if (uaa->info.bIfaceIndex != UARK_IFACE_INDEX) {
187 return (ENXIO);
188 }
189 return (usbd_lookup_id_by_uaa(uark_devs, sizeof(uark_devs), uaa));
190 }
191
192 static int
uark_attach(device_t dev)193 uark_attach(device_t dev)
194 {
195 struct usb_attach_arg *uaa = device_get_ivars(dev);
196 struct uark_softc *sc = device_get_softc(dev);
197 int32_t error;
198 uint8_t iface_index;
199
200 device_set_usb_desc(dev);
201 lockinit(&sc->sc_lock, "uark", 0, LK_CANRECURSE);
202
203 sc->sc_udev = uaa->device;
204
205 iface_index = UARK_IFACE_INDEX;
206 error = usbd_transfer_setup
207 (uaa->device, &iface_index, sc->sc_xfer,
208 uark_xfer_config, UARK_N_TRANSFER, sc, &sc->sc_lock);
209
210 if (error) {
211 device_printf(dev, "allocating control USB "
212 "transfers failed\n");
213 goto detach;
214 }
215 /* clear stall at first run */
216 lockmgr(&sc->sc_lock, LK_EXCLUSIVE);
217 usbd_xfer_set_stall(sc->sc_xfer[UARK_BULK_DT_WR]);
218 usbd_xfer_set_stall(sc->sc_xfer[UARK_BULK_DT_RD]);
219 lockmgr(&sc->sc_lock, LK_RELEASE);
220
221 error = ucom_attach(&sc->sc_super_ucom, &sc->sc_ucom, 1, sc,
222 &uark_callback, &sc->sc_lock);
223 if (error) {
224 DPRINTF("ucom_attach failed\n");
225 goto detach;
226 }
227 ucom_set_pnpinfo_usb(&sc->sc_super_ucom, dev);
228
229 return (0); /* success */
230
231 detach:
232 uark_detach(dev);
233 return (ENXIO); /* failure */
234 }
235
236 static int
uark_detach(device_t dev)237 uark_detach(device_t dev)
238 {
239 struct uark_softc *sc = device_get_softc(dev);
240
241 ucom_detach(&sc->sc_super_ucom, &sc->sc_ucom);
242 usbd_transfer_unsetup(sc->sc_xfer, UARK_N_TRANSFER);
243 lockuninit(&sc->sc_lock);
244
245 return (0);
246 }
247
248 static void
uark_bulk_write_callback(struct usb_xfer * xfer,usb_error_t error)249 uark_bulk_write_callback(struct usb_xfer *xfer, usb_error_t error)
250 {
251 struct uark_softc *sc = usbd_xfer_softc(xfer);
252 struct usb_page_cache *pc;
253 uint32_t actlen;
254
255 switch (USB_GET_STATE(xfer)) {
256 case USB_ST_SETUP:
257 case USB_ST_TRANSFERRED:
258 tr_setup:
259 pc = usbd_xfer_get_frame(xfer, 0);
260 if (ucom_get_data(&sc->sc_ucom, pc, 0,
261 UARK_BUF_SIZE, &actlen)) {
262 usbd_xfer_set_frame_len(xfer, 0, actlen);
263 usbd_transfer_submit(xfer);
264 }
265 return;
266
267 default: /* Error */
268 if (error != USB_ERR_CANCELLED) {
269 /* try to clear stall first */
270 usbd_xfer_set_stall(xfer);
271 goto tr_setup;
272 }
273 return;
274
275 }
276 }
277
278 static void
uark_bulk_read_callback(struct usb_xfer * xfer,usb_error_t error)279 uark_bulk_read_callback(struct usb_xfer *xfer, usb_error_t error)
280 {
281 struct uark_softc *sc = usbd_xfer_softc(xfer);
282 struct usb_page_cache *pc;
283 int actlen;
284
285 usbd_xfer_status(xfer, &actlen, NULL, NULL, NULL);
286
287 switch (USB_GET_STATE(xfer)) {
288 case USB_ST_TRANSFERRED:
289 pc = usbd_xfer_get_frame(xfer, 0);
290 ucom_put_data(&sc->sc_ucom, pc, 0, actlen);
291
292 case USB_ST_SETUP:
293 tr_setup:
294 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
295 usbd_transfer_submit(xfer);
296 return;
297
298 default: /* Error */
299 if (error != USB_ERR_CANCELLED) {
300 /* try to clear stall first */
301 usbd_xfer_set_stall(xfer);
302 goto tr_setup;
303 }
304 return;
305 }
306 }
307
308 static void
uark_start_read(struct ucom_softc * ucom)309 uark_start_read(struct ucom_softc *ucom)
310 {
311 struct uark_softc *sc = ucom->sc_parent;
312
313 usbd_transfer_start(sc->sc_xfer[UARK_BULK_DT_RD]);
314 }
315
316 static void
uark_stop_read(struct ucom_softc * ucom)317 uark_stop_read(struct ucom_softc *ucom)
318 {
319 struct uark_softc *sc = ucom->sc_parent;
320
321 usbd_transfer_stop(sc->sc_xfer[UARK_BULK_DT_RD]);
322 }
323
324 static void
uark_start_write(struct ucom_softc * ucom)325 uark_start_write(struct ucom_softc *ucom)
326 {
327 struct uark_softc *sc = ucom->sc_parent;
328
329 usbd_transfer_start(sc->sc_xfer[UARK_BULK_DT_WR]);
330 }
331
332 static void
uark_stop_write(struct ucom_softc * ucom)333 uark_stop_write(struct ucom_softc *ucom)
334 {
335 struct uark_softc *sc = ucom->sc_parent;
336
337 usbd_transfer_stop(sc->sc_xfer[UARK_BULK_DT_WR]);
338 }
339
340 static int
uark_pre_param(struct ucom_softc * ucom,struct termios * t)341 uark_pre_param(struct ucom_softc *ucom, struct termios *t)
342 {
343 if ((t->c_ospeed < 300) || (t->c_ospeed > 115200))
344 return (EINVAL);
345 return (0);
346 }
347
348 static void
uark_cfg_param(struct ucom_softc * ucom,struct termios * t)349 uark_cfg_param(struct ucom_softc *ucom, struct termios *t)
350 {
351 struct uark_softc *sc = ucom->sc_parent;
352 uint32_t speed = t->c_ospeed;
353 uint16_t data;
354
355 /*
356 * NOTE: When reverse computing the baud rate from the "data" all
357 * allowed baud rates are within 3% of the initial baud rate.
358 */
359 data = (UARK_BAUD_REF + (speed / 2)) / speed;
360
361 uark_cfg_write(sc, 3, 0x83);
362 uark_cfg_write(sc, 0, data & 0xFF);
363 uark_cfg_write(sc, 1, data >> 8);
364 uark_cfg_write(sc, 3, 0x03);
365
366 if (t->c_cflag & CSTOPB)
367 data = UARK_STOP_BITS_2;
368 else
369 data = UARK_STOP_BITS_1;
370
371 if (t->c_cflag & PARENB) {
372 if (t->c_cflag & PARODD)
373 data |= UARK_PARITY_ODD;
374 else
375 data |= UARK_PARITY_EVEN;
376 } else
377 data |= UARK_PARITY_NONE;
378
379 switch (t->c_cflag & CSIZE) {
380 case CS5:
381 data |= UARK_SET_DATA_BITS(5);
382 break;
383 case CS6:
384 data |= UARK_SET_DATA_BITS(6);
385 break;
386 case CS7:
387 data |= UARK_SET_DATA_BITS(7);
388 break;
389 default:
390 case CS8:
391 data |= UARK_SET_DATA_BITS(8);
392 break;
393 }
394 uark_cfg_write(sc, 3, 0x00);
395 uark_cfg_write(sc, 3, data);
396 }
397
398 static void
uark_cfg_get_status(struct ucom_softc * ucom,uint8_t * lsr,uint8_t * msr)399 uark_cfg_get_status(struct ucom_softc *ucom, uint8_t *lsr, uint8_t *msr)
400 {
401 struct uark_softc *sc = ucom->sc_parent;
402
403 *lsr = sc->sc_lsr;
404 *msr = sc->sc_msr;
405 }
406
407 static void
uark_cfg_set_break(struct ucom_softc * ucom,uint8_t onoff)408 uark_cfg_set_break(struct ucom_softc *ucom, uint8_t onoff)
409 {
410 struct uark_softc *sc = ucom->sc_parent;
411
412 DPRINTF("onoff=%d\n", onoff);
413
414 uark_cfg_write(sc, 4, onoff ? 0x01 : 0x00);
415 }
416
417 static void
uark_cfg_write(struct uark_softc * sc,uint16_t index,uint16_t value)418 uark_cfg_write(struct uark_softc *sc, uint16_t index, uint16_t value)
419 {
420 struct usb_device_request req;
421 usb_error_t err;
422
423 req.bmRequestType = UARK_WRITE;
424 req.bRequest = UARK_REQUEST;
425 USETW(req.wValue, value);
426 USETW(req.wIndex, index);
427 USETW(req.wLength, 0);
428
429 err = ucom_cfg_do_request(sc->sc_udev, &sc->sc_ucom,
430 &req, NULL, 0, 1000);
431 if (err) {
432 DPRINTFN(0, "device request failed, err=%s "
433 "(ignored)\n", usbd_errstr(err));
434 }
435 }
436
437 static void
uark_poll(struct ucom_softc * ucom)438 uark_poll(struct ucom_softc *ucom)
439 {
440 struct uark_softc *sc = ucom->sc_parent;
441 usbd_transfer_poll(sc->sc_xfer, UARK_N_TRANSFER);
442 }
443