share/man/man4/uark.4

   1 .\"     $OpenBSD: uark.4,v 1.3 2006/10/26 19:42:36 jmc Exp $
   2 .\"
   3 .\" Copyright (c) 2006 Jonathan Gray <jsg@openbsd.org>
   4 .\"
   5 .\" Permission to use, copy, modify, and distribute this software for any
   6 .\" purpose with or without fee is hereby granted, provided that the above
   7 .\" copyright notice and this permission notice appear in all copies.
   8 .\"
   9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16 .\"
  17 .\" $FreeBSD$
  18 .\"
  19 .Dd April 26, 2017
  20 .Dt UARK 4
  21 .Os
  22 .Sh NAME
  23 .Nm uark
  24 .Nd Arkmicro Technologies ARK3116 based USB serial adapter
  25 .Sh SYNOPSIS
  26 To compile this driver into the kernel,
  27 place the following lines in your
  28 kernel configuration file:
  29 .Bd -ragged -offset indent
  30 .Cd "device usb"
  31 .Cd "device ucom"
  32 .Cd "device uark"
  33 .Ed
  34 .Pp
  35 Alternatively, to load the driver as a
  36 module at boot time, place the following line in
  37 .Xr loader.conf 5 :
  38 .Bd -literal -offset indent
  39 uark_load="YES"
  40 .Ed
  41 .Sh DESCRIPTION
  42 The
  43 .Nm
  44 driver supports Arkmicro Technologies ARK3116 based serial adapters.
  45 .Sh HARDWARE
  46 The
  47 .Nm
  48 driver supports the following adapters:
  49 .Pp
  50 .Bl -bullet -compact
  51 .It
  52 HL USB-RS232
  53 .It
  54 HugePine USB-UART
  55 .It
  56 KQ-U8A Data Cable
  57 .It
  58 Skymaster USB to RS232
  59 .El
  60 .Sh FILES
  61 .Bl -tag -width "/dev/ttyU*.init" -compact
  62 .It Pa /dev/ttyU*
  63 for callin ports
  64 .It Pa /dev/ttyU*.init
  65 .It Pa /dev/ttyU*.lock
  66 corresponding callin initial-state and lock-state devices
  67 .Pp
  68 .It Pa /dev/cuaU*
  69 for callout ports
  70 .It Pa /dev/cuaU*.init
  71 .It Pa /dev/cuaU*.lock
  72 corresponding callout initial-state and lock-state devices
  73 .El
  74 .Sh SEE ALSO
  75 .Xr tty 4 ,
  76 .Xr ucom 4 ,
  77 .Xr usb 4
  78 .Sh HISTORY
  79 The
  80 .Nm
  81 device driver first appeared in
  82 .Ox 4.0 .
  83 The first
  84 .Fx
  85 release to include it was
  86 .Fx 7.0 .
  87 .Sh AUTHORS
  88 .An -nosplit
  89 The
  90 .Nm
  91 driver was written by
  92 .An Jonathan Gray Aq Mt jsg@openbsd.org .
  93 .Sh CAVEATS
  94 Setting hardware flow control is not currently supported.
  95 It is not yet known how to ask the hardware to send a break.
  96 .Pp
  97 Arkmicro Technologies do not reply to requests of documentation
  98 for their products.