1.\" $NetBSD: ukyopon.4,v 1.7 2005/05/18 15:05:26 wiz Exp $ 2.\" 3.\" Copyright (c) 2005 The NetBSD Foundation, Inc. 4.\" All rights reserved. 5.\" 6.\" This code is derived from software contributed to The NetBSD Foundation 7.\" by ITOH Yasufumi. 8.\" 9.\" Redistribution and use in source and binary forms, with or without 10.\" modification, are permitted provided that the following conditions 11.\" are met: 12.\" 1. Redistributions of source code must retain the above copyright 13.\" notice, this list of conditions and the following disclaimer. 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in the 16.\" documentation and/or other materials provided with the distribution. 17.\" 3. All advertising materials mentioning features or use of this software 18.\" must display the following acknowledgement: 19.\" This product includes software developed by the NetBSD 20.\" Foundation, Inc. and its contributors. 21.\" 4. Neither the name of The NetBSD Foundation nor the names of its 22.\" contributors may be used to endorse or promote products derived 23.\" from this software without specific prior written permission. 24.\" 25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 28.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 29.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 35.\" POSSIBILITY OF SUCH DAMAGE. 36.\" 37.Dd May 18, 2005 38.Dt UKYOPON 4 39.Os 40.Sh NAME 41.Nm ukyopon 42.Nd Kyocera AIR-EDGE PHONE support 43.Sh SYNOPSIS 44.Cd "ukyopon* at uhub?" 45.Cd "ucom* at ukyopon? portno ?" 46.Pp 47.In dev/usb/ukyopon.h 48.Sh DESCRIPTION 49The 50.Nm 51driver provides support for Kyocera AIR-EDGE PHONE AH-K3001V. 52.Pp 53Two units of this driver attach to an AIR-EDGE PHONE: 54the modem port and the data transfer port. 55The modem port is compatible to 56.Xr umodem 4 , 57and can be used for dialup connections. 58The data transfer port is for reading and writing internal storage 59of AIR-EDGE PHONE. 60.Pp 61Both devices are accessed through the 62.Xr ucom 4 63driver which makes them behave like a 64.Xr tty 4 . 65.Pp 66The manipulation of the internal storage is through external programs, 67for example, the 68.Pa pkgsrc/comms/kyopon 69package. 70.Sh IOCTLS 71The following 72.Xr ioctl 2 73calls apply to the 74.Nm 75device: 76.Pp 77.Bl -tag -width XXXXXX 78.It Dv UKYOPON_IDENTIFY Fa struct ukyopon_identify 79Read, from the kernel, the identification information of the device, 80useful to assure that the opened device node is 81a modem or a data transfer port of 82.Nm 83device. 84.Bd -literal 85struct ukyopon_identify { 86 char ui_name[16]; /* driver name */ 87 88 int ui_busno; /* usb bus number */ 89 uint8_t ui_address; /* device address */ 90 91 enum ukyopon_model { 92 UKYOPON_MODEL_UNKNOWN 93 } ui_model; /* possibly future use */ 94 enum ukyopon_port { 95 UKYOPON_PORT_UNKNOWN, 96 UKYOPON_PORT_MODEM, /* modem port */ 97 UKYOPON_PORT_DATA /* data transfer port */ 98 } ui_porttype; /* port type */ 99 int ui_rsvd1, ui_rsvd2; 100}; 101#define UKYOPON_NAME "ukyopon" 102.Ed 103.Pp 104The 105.Va ui_name 106field contains the driver signature, and has the string 107.Dv UKYOPON_NAME . 108.Pp 109The 110.Va ui_busno 111field contains the 112.Xr usb 4 113bus number to which the device is connected; 114the 115.Va ui_address 116field contains the address of the device in the bus. 117These fields are useful to identify the physical device 118from the file descriptor. 119.Pp 120The 121.Va ui_porttype 122field contains the type of device: 123.Dv UKYOPON_PORT_MODEM 124means the device is associated to the modem port, and 125.Dv UKYOPON_PORT_DATA 126means the device is associated to the data transfer port. 127.Pp 128Other fields are reserved for future extension and cleared to zeros. 129.El 130.Pp 131In addition, 132.Nm 133devices accept all 134.Xr ioctl 2 135calls that 136.Xr umodem 4 137accepts. 138.Sh SEE ALSO 139.Xr tty 4 , 140.Xr ucom 4 , 141.Xr umodem 4 , 142.Xr usb 4 , 143.Pa pkgsrc/comms/kyopon 144.Sh HISTORY 145The 146.Nm 147driver 148appeared in 149.Nx 3.0 . 150.Sh NOTES 151.Dq Kyopon 152is a widely-used nickname of Kyocera AIR-EDGE PHONE. 153