Skip to content

LordOS — a free, fast and secure GNU/Linux distribution based on Debian, with its own desktop environment: display server and Wayland compositor in C, a React UI engine on QuickJS, and private native apps.

6.9 KB
Raw Blame
/* hw_admin.h — the admin helper's actions for Settings (displays, battery, date and time,
 * Bluetooth). Every action is closed: validated arguments, fixed program paths and config files
 * generated here, never user text passed to a shell. Listed in AGENTS.md and docs/SETTINGS.md.
 *
 *   display-brightness <name> <value>  /sys/class/backlight/<name>/brightness (0..max)     anyone
 *   power-profile <p>                  performance|balanced|power-saver: powerprofilesctl if
 *                                      installed, else the cpufreq governor (and EPP)         anyone
 *   power-suspend                      systemctl suspend                                      anyone
 *   power-buttons <power> <lid> <lidac> /etc/systemd/logind.conf.d/lordos.conf + reload logind admin
 *   time-ntp on|off                    timedatectl set-ntp                                    admin
 *   time-set YYYY-MM-DD HH:MM:SS       timedatectl set-time (automatic time must be off)       admin
 *   bt-unblock                         rfkill: unblock Bluetooth (/dev/rfkill)               anyone
 *   rpi-case none|argon-one-v5         Raspberry Pi 5 only: writes /boot/firmware/lordos-case.txt
 *                                      (fixed text, included from config.txt; takes effect
 *                                      after a restart)                                      admin
 *   rpi-eeprom-status                  (no arguments) BCM2712 boards (Pi 5, 500, CM5) only: runs
 *                                      /usr/bin/rpi-eeprom-update (no options), parses its report
 *                                      strictly and answers "OK <uptodate|available|pending>
 *                                      <current> <latest> <release>"; read-only            anyone
 *   rpi-eeprom-update                  (no arguments) BCM2712 only: /usr/bin/rpi-eeprom-update -A
 *                                      bootloader (the newest bootloader of the configured
 *                                      release; finished by a restart), then the same report admin
 *   hw-firmware-missing                (no arguments) reads the kernel log (/dev/kmsg) and returns
 *                                      only the validated names of firmware files a driver asked
 *                                      for and that are still missing, as "LOG fw <file> <driver>"
 *                                      lines (the Store's suggestions, hwscan.c); read-only        anyone
 *   hw-memory-modules                  (no arguments) the memory modules from the SMBIOS tables
 *                                      (/sys/firmware/dmi/entries/17-<n>/raw, root only), parsed
 *                                      strictly in C (sysreport/smbios.c): one "LOG mem <size_mb>|
 *                                      <type>|<speed>|<configured>|<slot>|<bank>|<maker>" line per slot,
 *                                      never serials, asset tags or part numbers; read-only     anyone
 *   video-optimize <mode> <lower> <vp9> <av1>   auto|always|never, on|off, yes|no, yes|no (the
 *                                      last two: hardware VP9/AV1 decoding found this boot).
 *                                      Writes the browsers' video settings from fixed text:
 *                                      /etc/chromium/policies/managed/lordos-video.json and
 *                                      /etc/firefox-esr/lordos-video.js (docs/VIDEO.md)      anyone
 *   boot-test <n>                      LordBench's boot time test (bench/boottest.h): n restarts
 *                                      in a row, 2..10; writes only the fixed-format state file
 *                                      /var/lib/lordos/boot-test, which lord-sessiond follows at
 *                                      each boot; refused in the live session                  admin
 *   boot-test-cancel                   (no arguments) removes that file: no more restarts      anyone
 */
#ifndef LORD_HW_ADMIN_H
#define LORD_HW_ADMIN_H

#include "../admin.h"

void hw_act_brightness(const AdminReq *r, const char *arg, size_t len);
void hw_act_power_profile(const AdminReq *r, const char *arg, size_t len);
void hw_act_suspend(const AdminReq *r, const char *arg, size_t len);
void hw_act_buttons(const AdminReq *r, const char *arg, size_t len);
void hw_act_ntp(const AdminReq *r, const char *arg, size_t len);
void hw_act_time_set(const AdminReq *r, const char *arg, size_t len);
void hw_act_bt_unblock(const AdminReq *r, const char *arg, size_t len);
void hw_act_rpi_case(const AdminReq *r, const char *arg, size_t len);
void hw_act_firmware_missing(const AdminReq *r, const char *arg, size_t len);
void hw_act_memory_modules(const AdminReq *r, const char *arg, size_t len);
void hw_act_eeprom_status(const AdminReq *r, const char *arg, size_t len);
void hw_act_eeprom_update(const AdminReq *r, const char *arg, size_t len);
/* rpi-eeprom-update's report, parsed (exposed for tests) */
typedef struct {
    long long current, latest;          /* build time stamps (0: current unknown) */
    char release[16];                   /* default, latest… ([a-z]) */
    int update;                         /* the program says an update is available */
} HwEeprom;
int hw_eeprom_parse(const char *out, HwEeprom *e);
int hw_is_bcm2712(const char *compat, size_t n);     /* device tree "compatible" (NUL-separated) */
const char *hw_rpi_case_text(const char *id);   /* fixed file text of a known case, NULL otherwise */
void hw_act_video(const AdminReq *r, const char *arg, size_t len);
void hw_act_boot_test(const AdminReq *r, const char *arg, size_t len);          /* LordBench, bench/boottest.h */
void hw_act_boot_test_cancel(const AdminReq *r, const char *arg, size_t len);
/* The two files video-optimize writes, from its argument; 0 if the argument is valid. */
int hw_video_files(const char *arg, char *chromium, size_t cn, char *firefox, size_t fn);
#define HW_VIDEO_EXT_ID "kadhcpnkalbaminbojfmbmlgoheicmjo"     /* assets/browser/video (manifest "key") */

/* Validators, exposed for tests. */
int hw_button_action_valid(const char *a, int lid);
int hw_time_valid(const char *t);       /* "YYYY-MM-DD HH:MM:SS", a real date from 2000 to 2099 */
int hw_backlight_name_valid(const char *n);

#define HW_ADMIN_ACTIONS \
    { "display-brightness", hw_act_brightness, A_ANYONE }, \
    { "power-profile", hw_act_power_profile, A_ANYONE }, \
    { "power-suspend", hw_act_suspend, A_ANYONE }, \
    { "power-buttons", hw_act_buttons, 0 }, \
    { "time-ntp", hw_act_ntp, 0 }, \
    { "time-set", hw_act_time_set, 0 }, \
    { "bt-unblock", hw_act_bt_unblock, A_ANYONE }, \
    { "rpi-case", hw_act_rpi_case, 0 }, \
    { "hw-firmware-missing", hw_act_firmware_missing, A_ANYONE }, \
    { "hw-memory-modules", hw_act_memory_modules, A_ANYONE }, \
    { "rpi-eeprom-status", hw_act_eeprom_status, A_ANYONE | A_FORK }, \
    { "rpi-eeprom-update", hw_act_eeprom_update, A_FORK }, \
    { "video-optimize", hw_act_video, A_ANYONE }, \
    { "boot-test", hw_act_boot_test, 0 }, \
    { "boot-test-cancel", hw_act_boot_test_cancel, A_ANYONE },

#endif