1.\" 2.\" Copyright (c) 2014 Kevin Lo 3.\" All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright 9.\" notice, this list of conditions and the following disclaimer. 10.\" 2. Redistributions in binary form must reproduce the above copyright 11.\" notice, this list of conditions and the following disclaimer in the 12.\" documentation and/or other materials provided with the distribution. 13.\" 14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24.\" SUCH DAMAGE. 25.\" 26.\" $FreeBSD$ 27.\" 28.Dd September 5, 2014 29.Dt ULED 4 30.Os 31.Sh NAME 32.Nm uled 33.Nd USB LED driver 34.Sh SYNOPSIS 35To compile this driver into the kernel, place the following lines into 36your kernel configuration file: 37.Bd -ragged -offset indent 38.Cd "device uled" 39.Cd "device usb" 40.Ed 41.Pp 42Alternatively, to load the driver as a module at boot time, 43place the following line in 44.Xr loader.conf 5 : 45.Bd -literal -offset indent 46uled_load="YES" 47.Ed 48.Sh DESCRIPTION 49The 50.Nm 51driver provides support for the Dream Cheeky WebMail Notifier device. 52.Pp 53Subsequently, the 54.Pa /dev/uled0 55device can be used by userland applications. 56.Sh IOCTLS 57The following 58.Xr ioctl 2 59commands can be performed on 60.Pa /dev/uled0 , 61which are defined in 62.In dev/usb/uled_ioctl.h : 63.Bl -tag -width indent 64.It Dv ULED_GET_COLOR 65The command returns LED colors with values for RGB. 66This 67.Xr ioctl 2 68takes the following structure: 69.Bd -literal 70struct uled_color { 71 uint8_t red; 72 uint8_t green; 73 uint8_t blue; 74}; 75.Ed 76.It Dv ULED_SET_COLOR 77The command sets LED colors with values for RGB. 78It uses the same structure as above. 79.El 80.Sh FILES 81.Bl -tag -width ".Pa /dev/uled0" -compact 82.It Pa /dev/uled0 83blocking device node 84.El 85.Sh SEE ALSO 86.Xr ohci 4 , 87.Xr uhci 4 , 88.Xr usb 4 89.Sh AUTHORS 90.An -nosplit 91The 92.Nm 93driver was written by 94.An Kevin Lo Aq Mt kevlo@FreeBSD.org . 95