xref: /dflybsd-src/share/man/man9/backlight.9 (revision 500c9ec621dcfe7b7d604b70483809f9e4d26b97)
1*500c9ec6SAntonio Huete Jimenez.\" Copyright (c) 2020 Emmanuel Vadot <manu@freebsd.org>
2*500c9ec6SAntonio Huete Jimenez.\"
3*500c9ec6SAntonio Huete Jimenez.\" Redistribution and use in source and binary forms, with or without
4*500c9ec6SAntonio Huete Jimenez.\" modification, are permitted provided that the following conditions
5*500c9ec6SAntonio Huete Jimenez.\" are met:
6*500c9ec6SAntonio Huete Jimenez.\" 1. Redistributions of source code must retain the above copyright
7*500c9ec6SAntonio Huete Jimenez.\"    notice, this list of conditions and the following disclaimer.
8*500c9ec6SAntonio Huete Jimenez.\" 2. Redistributions in binary form must reproduce the above copyright
9*500c9ec6SAntonio Huete Jimenez.\"    notice, this list of conditions and the following disclaimer in the
10*500c9ec6SAntonio Huete Jimenez.\"    documentation and/or other materials provided with the distribution.
11*500c9ec6SAntonio Huete Jimenez.\"
12*500c9ec6SAntonio Huete Jimenez.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
13*500c9ec6SAntonio Huete Jimenez.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
14*500c9ec6SAntonio Huete Jimenez.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
15*500c9ec6SAntonio Huete Jimenez.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
16*500c9ec6SAntonio Huete Jimenez.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
17*500c9ec6SAntonio Huete Jimenez.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
18*500c9ec6SAntonio Huete Jimenez.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
19*500c9ec6SAntonio Huete Jimenez.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
20*500c9ec6SAntonio Huete Jimenez.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
21*500c9ec6SAntonio Huete Jimenez.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
22*500c9ec6SAntonio Huete Jimenez.\"
23*500c9ec6SAntonio Huete Jimenez.\" $FreeBSD$
24*500c9ec6SAntonio Huete Jimenez.\"
25*500c9ec6SAntonio Huete Jimenez.Dd March 13, 2023
26*500c9ec6SAntonio Huete Jimenez.Dt BACKLIGHT 9
27*500c9ec6SAntonio Huete Jimenez.Os
28*500c9ec6SAntonio Huete Jimenez.Sh NAME
29*500c9ec6SAntonio Huete Jimenez.Nm backlight ,
30*500c9ec6SAntonio Huete Jimenez.Nm backlight_register ,
31*500c9ec6SAntonio Huete Jimenez.Nm backlight_destroy ,
32*500c9ec6SAntonio Huete Jimenez.Nm BACKLIGHT_GET_STATUS ,
33*500c9ec6SAntonio Huete Jimenez.Nm BACKLIGHT_SET_STATUS
34*500c9ec6SAntonio Huete Jimenez.Nd BACKLIGHT methods
35*500c9ec6SAntonio Huete Jimenez.Sh SYNOPSIS
36*500c9ec6SAntonio Huete Jimenez.Cd "device backlight"
37*500c9ec6SAntonio Huete Jimenez.In "backlight_if.h"
38*500c9ec6SAntonio Huete Jimenez.In "sys/sys/backlight.h"
39*500c9ec6SAntonio Huete Jimenez.Ft int
40*500c9ec6SAntonio Huete Jimenez.Fn BACKLIGHT_GET_STATUS "device_t bus" "struct backlight_props *props"
41*500c9ec6SAntonio Huete Jimenez.Ft int
42*500c9ec6SAntonio Huete Jimenez.Fn BACKLIGHT_SET_STATUS "device_t bus" "struct backlight_props *props"
43*500c9ec6SAntonio Huete Jimenez.Ft struct cdev *
44*500c9ec6SAntonio Huete Jimenez.Fn backlight_register "const char *name" "device_t dev"
45*500c9ec6SAntonio Huete Jimenez.Ft int
46*500c9ec6SAntonio Huete Jimenez.Fn backlight_destroy "struct cdev *cdev"
47*500c9ec6SAntonio Huete Jimenez.Sh DESCRIPTION
48*500c9ec6SAntonio Huete JimenezThe backlight driver provides a generic way for handling a panel backlight.
49*500c9ec6SAntonio Huete Jimenez.Pp
50*500c9ec6SAntonio Huete JimenezDrivers for backlight system register themselves globally using the
51*500c9ec6SAntonio Huete Jimenez.Fn backlight_register
52*500c9ec6SAntonio Huete Jimenezfunction.
53*500c9ec6SAntonio Huete JimenezThey must define two methods,
54*500c9ec6SAntonio Huete Jimenez.Fn BACKLIGHT_GET_STATUS
55*500c9ec6SAntonio Huete Jimenezwhich is used to query the current brightness level and
56*500c9ec6SAntonio Huete Jimenez.Fn BACKLIGHT_SET_STATUS
57*500c9ec6SAntonio Huete Jimenezwhich is used to update it.
58*500c9ec6SAntonio Huete Jimenez.Sh INTERFACE
59*500c9ec6SAntonio Huete Jimenez.Bl -tag -width indent
60*500c9ec6SAntonio Huete Jimenez.It Fn BACKLIGHT_GET_STATUS "device_t bus" "struct backlight_props *props"
61*500c9ec6SAntonio Huete JimenezDriver fills the current brightless level and the optional supported levels.
62*500c9ec6SAntonio Huete Jimenez.It Fn BACKLIGHT_SET_STATUS "device_t bus" "struct backlight_props *props"
63*500c9ec6SAntonio Huete JimenezDriver update the backlight level based on the brightness member of the props
64*500c9ec6SAntonio Huete Jimenezstruct.
65*500c9ec6SAntonio Huete Jimenez.El
66*500c9ec6SAntonio Huete Jimenez.Sh FILES
67*500c9ec6SAntonio Huete Jimenez.Bl -tag -width "/dev/backlight/*"
68*500c9ec6SAntonio Huete Jimenez.It Pa /dev/backlight/*
69*500c9ec6SAntonio Huete Jimenez.El
70*500c9ec6SAntonio Huete Jimenez.Sh HISTORY
71*500c9ec6SAntonio Huete JimenezThe
72*500c9ec6SAntonio Huete Jimenez.Nm backlight
73*500c9ec6SAntonio Huete Jimenezinterface first appear in
74*500c9ec6SAntonio Huete Jimenez.Fx 13.0 .
75*500c9ec6SAntonio Huete JimenezThe
76*500c9ec6SAntonio Huete Jimenez.Nm backlight
77*500c9ec6SAntonio Huete Jimenezdriver and manual page was written by
78*500c9ec6SAntonio Huete Jimenez.An Emmanuel Vadot Aq Mt manu@FreeBSD.org .
79