summaryrefslogtreecommitdiff
path: root/static/netbsd/man4/ukyopon.4 4.html
blob: d6fea39d8ed78e814ca0fd0df4ea1cc2f3e00937 (plain)
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
<table class="head">
  <tr>
    <td class="head-ltitle">UKYOPON(4)</td>
    <td class="head-vol">Device Drivers Manual</td>
    <td class="head-rtitle">UKYOPON(4)</td>
  </tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><code class="Nm">ukyopon</code> &#x2014; <span class="Nd">Kyocera
    AIR-EDGE PHONE support</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp"><code class="Cd">ukyopon* at uhub?</code>
  <br/>
  <code class="Cd">ucom* at ukyopon? portno ?</code></p>
<p class="Pp">
  <br/>
  <code class="In">#include
  &lt;<a class="In">dev/usb/ukyopon.h</a>&gt;</code></p>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The <code class="Nm">ukyopon</code> driver provides support for
    Kyocera AIR-EDGE PHONE AH-K3001V.</p>
<p class="Pp">Two units of this driver attach to an AIR-EDGE PHONE: the modem
    port and the data transfer port. The modem port is compatible to
    <a class="Xr">umodem(4)</a>, and can be used for dialup connections. The
    data transfer port is for reading and writing internal storage of AIR-EDGE
    PHONE.</p>
<p class="Pp">Both devices are accessed through the <a class="Xr">ucom(4)</a>
    driver which makes them behave like a <a class="Xr">tty(4)</a>.</p>
<p class="Pp">The manipulation of the internal storage is through external
    programs, for example, the <span class="Pa">pkgsrc/comms/kyopon</span>
    package.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="IOCTLS"><a class="permalink" href="#IOCTLS">IOCTLS</a></h1>
<p class="Pp">The following <a class="Xr">ioctl(2)</a> calls apply to the
    <code class="Nm">ukyopon</code> device:</p>
<dl class="Bl-tag">
  <dt id="UKYOPON_IDENTIFY"><a class="permalink" href="#UKYOPON_IDENTIFY"><code class="Dv">UKYOPON_IDENTIFY</code></a>
    <var class="Fa">struct ukyopon_identify</var></dt>
  <dd>Read, from the kernel, the identification information of the device,
      useful to assure that the opened device node is a modem or a data transfer
      port of <code class="Nm">ukyopon</code> device.
    <div class="Bd Pp Li">
    <pre>struct ukyopon_identify {
	char	ui_name[16];		/* driver name */

	int	ui_busno;		/* usb bus number */
	uint8_t	ui_address;		/* device address */

	enum ukyopon_model {
		UKYOPON_MODEL_UNKNOWN
	} ui_model;			/* possibly future use */
	enum ukyopon_port {
		UKYOPON_PORT_UNKNOWN,
		UKYOPON_PORT_MODEM,	/* modem port */
		UKYOPON_PORT_DATA	/* data transfer port */
	} ui_porttype;			/* port type */
	int	ui_rsvd1, ui_rsvd2;
};
#define UKYOPON_NAME		&quot;ukyopon&quot;</pre>
    </div>
    <p class="Pp">The <var class="Va">ui_name</var> field contains the driver
        signature, and has the string <code class="Dv">UKYOPON_NAME</code>.</p>
    <p class="Pp">The <var class="Va">ui_busno</var> field contains the
        <a class="Xr">usb(4)</a> bus number to which the device is connected;
        the <var class="Va">ui_address</var> field contains the address of the
        device in the bus. These fields are useful to identify the physical
        device from the file descriptor.</p>
    <p class="Pp">The <var class="Va">ui_porttype</var> field contains the type
        of device: <code class="Dv">UKYOPON_PORT_MODEM</code> means the device
        is associated to the modem port, and
        <code class="Dv">UKYOPON_PORT_DATA</code> means the device is associated
        to the data transfer port.</p>
    <p class="Pp">Other fields are reserved for future extension and cleared to
        zeros.</p>
  </dd>
</dl>
<p class="Pp">In addition, <code class="Nm">ukyopon</code> devices accept all
    <a class="Xr">ioctl(2)</a> calls that <a class="Xr">umodem(4)</a>
  accepts.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
  ALSO</a></h1>
<p class="Pp"><a class="Xr">tty(4)</a>, <a class="Xr">ucom(4)</a>,
    <a class="Xr">umodem(4)</a>, <a class="Xr">usb(4)</a>,
    <span class="Pa">pkgsrc/comms/kyopon</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
<p class="Pp">The <code class="Nm">ukyopon</code> driver appeared in
    <span class="Ux">NetBSD 3.0</span>.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="NOTES"><a class="permalink" href="#NOTES">NOTES</a></h1>
<p class="Pp">&#x201C;Kyopon&#x201D; is a widely-used nickname of Kyocera
    AIR-EDGE PHONE.</p>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">May 18, 2005</td>
    <td class="foot-os">NetBSD 10.1</td>
  </tr>
</table>