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