blob: aba838b70d409c33baf0e5f47b6e95465353e2b9 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
<table class="head">
<tr>
<td class="head-ltitle">ULED(4)</td>
<td class="head-vol">Device Drivers Manual</td>
<td class="head-rtitle">ULED(4)</td>
</tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><code class="Nm">uled</code> — <span class="Nd">USB LED
driver</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp">To compile this driver into the kernel, place the following lines
into your kernel configuration file:</p>
<div class="Bd Pp Bd-indent"><code class="Cd">device uled</code>
<br/>
<code class="Cd">device usb</code></div>
<p class="Pp">Alternatively, to load the driver as a module at boot time, place
the following line in <a class="Xr">loader.conf(5)</a>:</p>
<div class="Bd Pp Bd-indent Li">
<pre>uled_load="YES"</pre>
</div>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The <code class="Nm">uled</code> driver provides support for Dream
Cheeky WebMail Notifier and ThingM blink(1) notification LED.</p>
<p class="Pp">Subsequently, the <span class="Pa">/dev/uled0</span> device can be
used by userland applications.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="IOCTLS"><a class="permalink" href="#IOCTLS">IOCTLS</a></h1>
<p class="Pp">The following <a class="Xr">ioctl(2)</a> commands can be performed
on <span class="Pa">/dev/uled0</span>, which are defined in
<code class="In"><<a class="In">dev/usb/uled_ioctl.h</a>></code>:</p>
<dl class="Bl-tag">
<dt id="ULED_GET_COLOR"><a class="permalink" href="#ULED_GET_COLOR"><code class="Dv">ULED_GET_COLOR</code></a></dt>
<dd>The command returns LED colors with values for RGB. This
<a class="Xr">ioctl(2)</a> takes the following structure:
<div class="Bd Pp Li">
<pre>struct uled_color {
uint8_t red;
uint8_t green;
uint8_t blue;
};</pre>
</div>
</dd>
<dt id="ULED_SET_COLOR"><a class="permalink" href="#ULED_SET_COLOR"><code class="Dv">ULED_SET_COLOR</code></a></dt>
<dd>The command sets LED colors with values for RGB. It uses the same
structure as above.</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h1>
<dl class="Bl-tag Bl-compact">
<dt><span class="Pa">/dev/uled0</span></dt>
<dd>blocking device node</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
ALSO</a></h1>
<p class="Pp"><a class="Xr">ohci(4)</a>, <a class="Xr">uhci(4)</a>,
<a class="Xr">usb(4)</a></p>
</section>
<section class="Sh">
<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
<p class="Pp">The <code class="Nm">uled</code> driver was written by
<span class="An">Kevin Lo</span>
<<a class="Mt" href="mailto:kevlo@FreeBSD.org">kevlo@FreeBSD.org</a>>.</p>
</section>
</div>
<table class="foot">
<tr>
<td class="foot-date">March 31, 2017</td>
<td class="foot-os">FreeBSD 15.0</td>
</tr>
</table>
|
