static/freebsd/man9/backlight.9 3.html


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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

<table class="head">
  <tr>
    <td class="head-ltitle">BACKLIGHT(9)</td>
    <td class="head-vol">Kernel Developer's Manual</td>
    <td class="head-rtitle">BACKLIGHT(9)</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">backlight</code>,
    <code class="Nm">backlight_register</code>,
    <code class="Nm">backlight_destroy</code>,
    <code class="Nm">BACKLIGHT_GET_STATUS</code>,
    <code class="Nm">BACKLIGHT_SET_STATUS</code> &#x2014;
    <span class="Nd">BACKLIGHT methods</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp"><code class="Cd">device backlight</code>
  <br/>
  <code class="In">#include &lt;<a class="In">backlight_if.h</a>&gt;</code>
  <br/>
  <code class="In">#include
  &lt;<a class="In">sys/sys/backlight.h</a>&gt;</code></p>
<p class="Pp"><var class="Ft">int</var>
  <br/>
  <code class="Fn">BACKLIGHT_GET_STATUS</code>(<var class="Fa" style="white-space: nowrap;">device_t
    bus</var>, <var class="Fa" style="white-space: nowrap;">struct
    backlight_props *props</var>);</p>
<p class="Pp"><var class="Ft">int</var>
  <br/>
  <code class="Fn">BACKLIGHT_SET_STATUS</code>(<var class="Fa" style="white-space: nowrap;">device_t
    bus</var>, <var class="Fa" style="white-space: nowrap;">struct
    backlight_props *props</var>);</p>
<p class="Pp"><var class="Ft">struct cdev *</var>
  <br/>
  <code class="Fn">backlight_register</code>(<var class="Fa" style="white-space: nowrap;">const
    char *name</var>, <var class="Fa" style="white-space: nowrap;">device_t
    dev</var>);</p>
<p class="Pp"><var class="Ft">int</var>
  <br/>
  <code class="Fn">backlight_destroy</code>(<var class="Fa" style="white-space: nowrap;">struct
    cdev *cdev</var>);</p>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The backlight driver provides a generic way for handling a panel
    backlight.</p>
<p class="Pp" id="backlight_register">Drivers for backlight system register
    themselves globally using the
    <a class="permalink" href="#backlight_register"><code class="Fn">backlight_register</code></a>()
    function. They must define two methods,
    <a class="permalink" href="#BACKLIGHT_GET_STATUS"><code class="Fn" id="BACKLIGHT_GET_STATUS">BACKLIGHT_GET_STATUS</code></a>()
    which is used to query the current brightness level and
    <a class="permalink" href="#BACKLIGHT_SET_STATUS"><code class="Fn" id="BACKLIGHT_SET_STATUS">BACKLIGHT_SET_STATUS</code></a>()
    which is used to update it.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="INTERFACE"><a class="permalink" href="#INTERFACE">INTERFACE</a></h1>
<dl class="Bl-tag">
  <dt><code class="Fn">BACKLIGHT_GET_STATUS</code>(<var class="Fa">device_t
    bus</var>, <var class="Fa">struct backlight_props *props</var>)</dt>
  <dd>Driver fills the current brightless level and the optional supported
      levels.</dd>
  <dt><code class="Fn">BACKLIGHT_SET_STATUS</code>(<var class="Fa">device_t
    bus</var>, <var class="Fa">struct backlight_props *props</var>)</dt>
  <dd>Driver update the backlight level based on the brightness member of the
      props struct.</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h1>
<dl class="Bl-tag">
  <dt><span class="Pa">/dev/backlight/*</span></dt>
  <dd style="width: auto;">&#x00A0;</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">backlight(8)</a></p>
</section>
<section class="Sh">
<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
<p class="Pp">The <code class="Nm">backlight</code> interface first appear in
    <span class="Ux">FreeBSD 13.0</span>. The <code class="Nm">backlight</code>
    driver and manual page was written by <span class="An">Emmanuel Vadot</span>
    &lt;<a class="Mt" href="mailto:manu@FreeBSD.org">manu@FreeBSD.org</a>&gt;.</p>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">October 2, 2020</td>
    <td class="foot-os">FreeBSD 15.0</td>
  </tr>
</table>