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.Dd March 31, 2017 27.Dt ULED 4 28.Os 29.Sh NAME 30.Nm uled 31.Nd USB LED driver 32.Sh SYNOPSIS 33To compile this driver into the kernel, place the following lines into 34your kernel configuration file: 35.Bd -ragged -offset indent 36.Cd "device uled" 37.Cd "device usb" 38.Ed 39.Pp 40Alternatively, to load the driver as a module at boot time, 41place the following line in 42.Xr loader.conf 5 : 43.Bd -literal -offset indent 44uled_load="YES" 45.Ed 46.Sh DESCRIPTION 47The 48.Nm 49driver provides support for Dream Cheeky WebMail Notifier and 50ThingM blink(1) notification LED. 51.Pp 52Subsequently, the 53.Pa /dev/uled0 54device can be used by userland applications. 55.Sh IOCTLS 56The following 57.Xr ioctl 2 58commands can be performed on 59.Pa /dev/uled0 , 60which are defined in 61.In dev/usb/uled_ioctl.h : 62.Bl -tag -width indent 63.It Dv ULED_GET_COLOR 64The command returns LED colors with values for RGB. 65This 66.Xr ioctl 2 67takes the following structure: 68.Bd -literal 69struct uled_color { 70 uint8_t red; 71 uint8_t green; 72 uint8_t blue; 73}; 74.Ed 75.It Dv ULED_SET_COLOR 76The command sets LED colors with values for RGB. 77It uses the same structure as above. 78.El 79.Sh FILES 80.Bl -tag -width ".Pa /dev/uled0" -compact 81.It Pa /dev/uled0 82blocking device node 83.El 84.Sh SEE ALSO 85.Xr ohci 4 , 86.Xr uhci 4 , 87.Xr usb 4 88.Sh AUTHORS 89.An -nosplit 90The 91.Nm 92driver was written by 93.An Kevin Lo Aq Mt kevlo@FreeBSD.org . 94