.\" $Id: uppc.4,v 1.3 2004/09/12 02:39:44 sam Exp $
.\" Copyright 2004 Sam Lawrance <boris@brooknet.com.au>
.\" Do what you want with it :)
.Dd March 26, 2004
.Dt UPPC 4
.Os
.Sh NAME
.Nm uppc
.Nd USB device driver supporting Windows CE devices
.Sh SYNOPSIS
.Cd kldload uppc
.Cd uppcsetup
.Sh DESCRIPTION
The
.Nm
driver provides generic support for Windows CE devices (such as the handheld
Pocket PC range).
.Pp
The device is accessed through the
.Xr ucom 4
driver which makes it behave like a
.Xr tty 4 .
.Pp
Before setting up manually way try running 'uppcsetup' first. It can do steps 1 through 4 for you.
.Sh CONFIGURATION AND USE
.Bl -enum
.It 
As root, install and load the uppc module by doing
.Bd -literal -offset indent
cp /usr/local/lib/uppc.ko /boot/kernel
kldload uppc
.Ed
.It
Dock your device. If the driver has attached to your device the kernel will display a
.Xr ucom 4
device message containing "<Windows CE Device>". If not it will display a
.Xr ugen 4
device message. In this case set the sysctls hw.usb.uppc.vendor and hw.usb.uppc.product to your device's vendor and product ID and reconnect.
Undock your device.
.It 
Add the following to line to
.Pa /etc/ppp/ppp.conf :
.Bd -literal -offset indent
!include /etc/ppp/ppp-uppc.conf
.Ed
.Pp
Then add the following to
.Pa /etc/ppp/ppp-uppc.conf :
.Bd -literal -offset indent
uppc:
 disable dns
 accept dns
 set login "CLIENT CLIENTSERVER"
 # DEVNAME is set by usbd
 set device /dev/$DEVNAME
 set dial ""
 set ifaddr 192.168.130.102 192.168.130.201
 set speed 115200
 set timeout 300
.Ed
.It
Add the following to
.Pa /etc/usbd.conf ,
substituting your PRODUCT and VENDOR IDs in hexadecimal notation (eg 0x049f):
.Bd -literal -offset indent
# uppcsetup-config-begin-VENDOR-PRODUCT
device "Windows CE Device"
	devname "ucom[0-9]"
	vendor VENDOR
	product PRODUCT
	attach "/usr/sbin/ppp -background uppc"
# uppcsetup-config-end-VENDOR-PRODUCT
.Ed
.Pp
Be sure to include the comments - if you run uppcsetup later on it will be able to identify the section and keep your configuration tidy. Restart 
.Xr usbd 8 :
.Bd -literal -offset indent
/etc/rc.d/usbd restart
.Ed
.Pp
If
.Xr usbd 8 
was not running, you'll probably need to add it to your
.Xr rc.conf 5 .
.It 
Install dccm from ports (palm/dccm) and run it as the regular user you intend to access your device from. It can be started as part of your login.
.It 
Dock your device and see what happens!
.El
.Pp
Once connected, tools such as those from the SynCE project can then be used to access and manipulate the device. These are available from ports/palm.
.Sh BUGS
These devices seem to be quite flakey. Make sure you back up your data.
.Pp
IF YOUR DEVICE APPEARS TO HANG do not soft-reset it (ie. do not push the reset button on the device). In some instances this may cause the device's non volatile memory to be wiped. Try reattaching the device; if that fails reboot your PC and try again. If this fails, cross your fingers and soft-reset as a last resort.
.Pp
While
.Xr ppp 8
is able to use the
.Xr ucom 4
interface presented, it seems that
.Xr pppd 8
can not.
.Pp
All feedback, bugs and otherwise, welcome to
.An Sam Lawrance Aq boris@brooknet.com.au
.Pp
.Sh SEE ALSO
.Xr ppp 8 ,
.Xr rc.conf 5 ,
.Xr sysctl 8 ,
.Xr sysctl.conf 5 ,
.Xr tty 4 ,
.Xr ucom 4 ,
.Xr usb 4 ,
.Xr usbd 8 ,
.Xr usbd.conf 5
.Rs
.%T The SynCE Project
.%O http://synce.sourceforge.net
.Re
.Sh HISTORY
The
.Nm
driver and this manpage was written for FreeBSD by
.An Sam Lawrance Aq boris@brooknet.com.au