xref: /netbsd-src/share/man/man4/man4.sandpoint/satmgr.4 (revision bddff27ba4bb9be85f0ba5b83bcb271537dfe041)
1.\" $NetBSD: satmgr.4,v 1.6 2023/05/07 11:41:49 andvar Exp $
2.\"
3.\" Copyright (c) 2011-2012 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Tohru Nishimura.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.Dd January 15, 2012
31.Dt SATMGR 4 sandpoint
32.Os
33.Sh NAME
34.Nm satmgr
35.Nd driver for satellite processor, controlling power, front panel LEDs, and buttons
36.Sh SYNOPSIS
37.Cd "satmgr0 at eumb? unit 0"
38.Cd "satmgr0 at eumb? unit 1"
39.Sh DESCRIPTION
40This driver provides an interface to the
41.Tn NAS
42builtin satellite microprocessor which controls the power, front
43panel LEDs, and push buttons.
44Communication is performed through character sequences, whose
45definition and usage depend on the
46.Tn NAS
47product models.
48.Pp
49The device file
50.Pa /dev/satmgr
51can be written to control the satellite processor and the LEDs.
52Reading it will return single characters for button press events.
53This facility was designed to implement a
54.Tn NAS
55control
56.Tn CGI
57program.
58.Pp
59.Nm
60detects a soft power-off condition, which is triggered by holding
61the front panel power button pressed for several seconds.
62This driver can optionally invoke
63.Xr powerd 8
64to get a finer control over the system shutdown procedure.
65It is capable of reporting a power-button-pressed event.
66Refer to the
67.Xr powerd 8
68manual section for more details.
69.Pp
70.Tn NAS
71products supported by
72.Nm :
73.Bl -bullet -compact
74.It
75Buffalo LinkStation
76.It
77Conceptronic CH3WNAS
78.It
79D-Link DSM-G600 (Rev. B)
80.It
81Iomega StorCenter
82.It
83KuroBox
84.It
85LevelOne FNS-5000B
86.It
87QNAP TurboStation
88.It
89Synology DiskStation
90.El
91.Sh SYSCTL VARIABLES
92The following
93.Xr sysctl 3
94variables are available for
95.Tn "Kurobox/Linkstation"
96.Tn NAS
97products:
98.Bl -tag -width indent
99.It machdep.satmgr.hwwdog_enable
100Toggle the system watchdog on (1) or off (0).
101.El
102.Pp
103For the
104.Tn "Iomega StorCenter"
105the following variables have been defined:
106.Bl -tag -width indent
107.It machdep.satmgr.fan_low_temp
108Set the temperature below which the fan is turned off.
109.It machdep.satmgr.fan_high_temp
110Set the temperature above which the fan is turned on.
111.El
112.Sh FILES
113.Bl -tag -width /dev/satmgrX -compact
114.It Pa /dev/satmgr
115communication interface to
116.Nm .
117.It Pa /dev/power
118event notify channel to
119.Xr powerd 8 .
120.El
121.Sh SEE ALSO
122.Xr powerd 8 ,
123.Xr sysctl 8
124.Sh HISTORY
125The
126.Nm
127driver first appeared in
128.Nx 6.0 .
129