diff options
author | Sigrid Solveig Haflínudóttir <sigrid@ftrv.se> | 2022-08-21 01:30:03 +0000 |
---|---|---|
committer | Sigrid Solveig Haflínudóttir <sigrid@ftrv.se> | 2022-08-21 01:30:03 +0000 |
commit | a78b71b143240fa1dad019f5c655a03c2d2400d9 (patch) | |
tree | e89536e837fbd4a921542d81e73d7315b4da3ac4 /sys/man | |
parent | 5e15db8fa31dd68fee22f260ae797a38ccaa4070 (diff) |
move and rename MNT Reform 2 support utilies, cat manpages into one
Aux/imx8pm and aux/wm8960 had pretty cryptic names and it made
more sense to use a reform/pm and reform/audio naming, accordingly.
Instead of having special mount points /mnt/pm and /mnt/wm8960,
/dev is used directly, removing the need to do any manual work -
stats(1) will continue showing the CPU temperature, and zuke(1)
will still be able to control the volume, etc.
Brightness controls were changed to a better interface -
/dev/light, where each line contains a "a_thing its_light_value".
This way more parts can be controlled. Right now it's only "lcd",
but later it might be "kbd" and "trackball" as well.
Example of lib/profile:
reform/audio
echo master 80 > /dev/volume
reform/pm
echo lcd 100 > /dev/light
Diffstat (limited to 'sys/man')
-rw-r--r-- | sys/man/1/reform | 115 | ||||
-rw-r--r-- | sys/man/8/imx8pm | 58 | ||||
-rw-r--r-- | sys/man/8/wm8960 | 83 |
3 files changed, 115 insertions, 141 deletions
diff --git a/sys/man/1/reform b/sys/man/1/reform new file mode 100644 index 000000000..4d95ebe48 --- /dev/null +++ b/sys/man/1/reform @@ -0,0 +1,115 @@ +.TH REFORM 1 +.SH NAME +audio, +pm +- MNT Reform 2 support utilities +.SH SYNOPSIS +.B reform/audio +[ +.B -1 +] +[ +.B -D +] +[ +.B -m +.I mountpoint +] +[ +.B -s +.I service +] +.PP +.B reform/pm +[ +.B -D +] +[ +.B -m +.I mountpoint +] +[ +.B -s +.I service +] +.SH DESCRIPTION +These programs provide support for certain functions of MNT Reform 2 +computing device make controlling file systems available under +.BR /dev . +.PP +.SS Audio +.I audio +initializes the DAC (Digital-to-Analog Converter) on the platform and +provides a standard \fIaudio\fR(3) interface to control volume and +other parameters. +With +.I -1 +only the initialization is performed and the program exits +immediately. +.PP +The following files are provided by the program: +.TP +.B audioctl +Shows the current status +.I (on +or +.I off ) +of the three "outputs" - +.BR master , +.BR hp +and +.BR spk . +Each can be enabled, disabled or toggled, by writing a single line to +the same file, consisting of the output name and the desired action - +.I on , +.I off +or +.I toggle , +accordingly. +.IP +DAC can be reinitialized by writing a single +.BR reset . +.TP +.B volume +Provides an interface for volume control (see \fIaudio\fR(3)). For +ease of use, +.B volume +supports relative adjustments by prefixing a number with a sign. +.IP +.IP +Enhanced stereo separation can be enabled by writing +.BR 3d , +followed by desired percentage of the effect. +.SS Power and monitoring +.I pm +presents a file system consisting of the following files: +.TP +.B light +Provides a way to control the backlight of the built-in LCD by +writing \fIlcd [-+]N\fR, +where +.I N +is expressed in percentage, either as an absolute value (0-100) or +relative to the current brightness - by prefixing with a sign. +Reading +.B light +returns the current brightness. +.TP +.B cputemp +Exposes the current temperature reading of the CPU. +.SH SOURCE +.B /sys/src/cmd/reform +.SH SEE ALSO +.IR audio (3) +.SH HISTORY +MNT Reform 2 support first appeared in 9front (August, 2022). +.SH BUGS +Only 44100Hz (default) and 48000Hz sample rates are supported with +.IR audio , +recording is not implemented. +.PP +.I Light +was chosen as a shorter alternative to +.IR brightness . +In the future it might support controlling keyboard and trackball +light levels. diff --git a/sys/man/8/imx8pm b/sys/man/8/imx8pm deleted file mode 100644 index 1c7630658..000000000 --- a/sys/man/8/imx8pm +++ /dev/null @@ -1,58 +0,0 @@ -.TH IMX8PM 8 -.SH NAME -imx8pm \- power management for MNT Reform 2 -.SH SYNOPSIS -.B aux/imx8pm -[ -.B -D -] -[ -.B -m -.I mountpoint -] -[ -.B -s -.I service -] -.nf -.sp 0.3v -.B /mnt/pm/cputemp -.B /mnt/pm/ctl -.fi -.SH DESCRIPTION -.I Aux/imx8pm -presents at -.I mountpoint -(default -.BR /mnt/pm ) -an interface to miscellaneous functions of IMX8MQ. If a -.I service -is specified, the interface will be posted at -.BI /srv/ service -as well. -.PP -.B cputemp -Exposes the current temperature reading of the CPU. -.PP -.B ctl -Provides a way to control the brightness of the built-in LCD by -writing -.IP -.I brightness [-+]N -.PP -.B N -is expressed in percentage, either as an absolute value (0-100) or -relative to the current brightness - by prefixing with a sign. -.PP -Reading -.B ctl -returns the current brightness. -.SH SOURCE -.B /sys/src/cmd/aux/imx8pm.c -.SH SEE ALSO -.IR wm8960 (8) -.SH BUGS -Absolutely yes. -.SH HISTORY -.I Acpi -first appeared in 9front (August, 2022). diff --git a/sys/man/8/wm8960 b/sys/man/8/wm8960 deleted file mode 100644 index 76e9eaf24..000000000 --- a/sys/man/8/wm8960 +++ /dev/null @@ -1,83 +0,0 @@ -.TH WM8960 8 -.SH NAME -wm8960 \- audio controls for MNT Reform 2 -.SH SYNOPSIS -.B aux/wm8960 -[ -.B -D -] -[ -.B -1 -] -[ -.B -m -.I mountpoint -] -[ -.B -s -.I service -] -.nf -.sp 0.3v -.B /mnt/wm8960/audioctl -.B /mnt/wm8960/volume -.fi -.SH DESCRIPTION -.I Aux/imx8pm -presents at -.I mountpoint -(default -.BR /mnt/wm8960 ) -an interface to control the DAC (Digital-to-Analog Converter) found on -MNT Reform 2. If a -.I service -is specified, the interface will be posted at -.BI /srv/ service -as well. In order to initialize the DAC and immediately exit, without -running a file system, option -.I -1 -can be used. -.PP -The directory contains the following files. -.TP -.B audioctl -Shows the current status -.I (on -or -.I off ) -of the three "outputs" - -.BR master , -.BR hp -and -.BR spk . -Each can be enabled, disabled or toggled, by writing a single line -to the same file, consisting of the output name and the desired action - -.I on , -.I off -or -.I toggle , -accordingly. -.IP -DAC can be reinitialized by writing a single -.BR reset . -.TP -.B volume -Provides an interface for volume control (see \fIaudio\fR(3)). For ease of use, -.B volume -supports relative adjustments by prefixing a number with a sign. -.IP -Only -44100Hz (default) and 48000Hz sample rates are supported. -.IP -Enhanced stereo separation can be enabled by writing -.BR 3d , -followed by desired percentage of the effect. -.SH SOURCE -.B /sys/src/cmd/aux/wm8960.c -.SH SEE ALSO -.IR imx8pm (8) -.SH BUGS -Absolutely yes. -.SH HISTORY -.I Wm8960 -first appeared in 9front (August, 2022). |