libx52/joytest/x52_test.c

/*
 * Saitek X52 Pro MFD & LED driver
 *
 * Copyright (C) 2012-2026 Nirenjan Krishnan (nirenjan@nirenjan.org)
 *
 * SPDX-License-Identifier: GPL-2.0-only WITH Classpath-exception-2.0
 */

#define _GNU_SOURCE
#include "build-config.h"
#include <stdio.h>
#include <stdlib.h>
#include <signal.h>
#include <string.h>
#include <locale.h>
#include <time.h>

#include <libx52/libx52.h>
#include "x52_test_common.h"
#include "x52_test_args.h"

libx52_device *dev;
int test_exit;
bool nodelay;

void test_cleanup(void)
{
    if (libx52_check_feature(dev, LIBX52_FEATURE_LED) == LIBX52_SUCCESS) {
        /* X52 Pro */
        libx52_set_text(dev, 0, " Saitek X52 Pro ", 16);
        libx52_set_text(dev, 1, "     Flight     ", 16);
        libx52_set_text(dev, 2, " Control System ", 16);

        libx52_set_led_state(dev, LIBX52_LED_FIRE, LIBX52_LED_STATE_ON);
        libx52_set_led_state(dev, LIBX52_LED_THROTTLE, LIBX52_LED_STATE_ON);
        libx52_set_led_state(dev, LIBX52_LED_A, LIBX52_LED_STATE_GREEN);
        libx52_set_led_state(dev, LIBX52_LED_B, LIBX52_LED_STATE_GREEN);
        libx52_set_led_state(dev, LIBX52_LED_D, LIBX52_LED_STATE_GREEN);
        libx52_set_led_state(dev, LIBX52_LED_E, LIBX52_LED_STATE_GREEN);
        libx52_set_led_state(dev, LIBX52_LED_T1, LIBX52_LED_STATE_GREEN);
        libx52_set_led_state(dev, LIBX52_LED_T2, LIBX52_LED_STATE_GREEN);
        libx52_set_led_state(dev, LIBX52_LED_T3, LIBX52_LED_STATE_GREEN);
        libx52_set_led_state(dev, LIBX52_LED_POV, LIBX52_LED_STATE_GREEN);
        libx52_set_led_state(dev, LIBX52_LED_CLUTCH, LIBX52_LED_STATE_GREEN);
    } else {
        libx52_set_text(dev, 0, "     Saitek     ", 16);
        libx52_set_text(dev, 1, "   X52 Flight   ", 16);
        libx52_set_text(dev, 2, " Control System ", 16);
    }

    libx52_set_blink(dev, 0);
    libx52_set_shift(dev, 0);

    libx52_set_clock(dev, time(NULL), 1); // Display local time
    libx52_set_clock_timezone(dev, LIBX52_CLOCK_2, 0); // GMT
    libx52_set_clock_timezone(dev, LIBX52_CLOCK_3, 330); // IST

    libx52_set_clock_format(dev, LIBX52_CLOCK_1, LIBX52_CLOCK_FORMAT_24HR);
    libx52_set_clock_format(dev, LIBX52_CLOCK_2, LIBX52_CLOCK_FORMAT_24HR);
    libx52_set_clock_format(dev, LIBX52_CLOCK_3, LIBX52_CLOCK_FORMAT_24HR);

    libx52_set_date_format(dev, LIBX52_DATE_FORMAT_MMDDYY);

    libx52_set_brightness(dev, 1, 128);
    libx52_set_brightness(dev, 0, 128);

    libx52_update(dev);
}

void print_banner(const char *message)
{
    size_t len = strlen(message);
    size_t i;

    putchar('\n');
    putchar('\t');
    for (i = 0; i < len + 2; i++) {
        putchar('=');
    }
    putchar('\n');

    putchar('\t');
    putchar(' ');
    puts(message);

    putchar('\t');
    for (i = 0; i < len + 2; i++) {
        putchar('=');
    }
    putchar('\n');
}

static void signal_handler(int sig)
{
    test_exit = -sig;
}

#define TESTS \
    X(brightness, bri, gettext_noop("Test brightness scale (~ 1m)")) \
    X(leds, led, gettext_noop("Test LED states (~ 45s)")) \
    X(mfd_text, mfd1, gettext_noop("Test MFD string display (~ 30s)")) \
    X(mfd_display, mfd2, gettext_noop("Test MFD displays all characters (~ 2m 15s)")) \
    X(blink_n_shift, blink, gettext_noop("Test the blink and shift commands (< 10s)")) \
    X(clock, clock, gettext_noop("Test the clock commands (~1m)"))

enum {
#define X(en, kw, desc) TEST_BIT_ ## en,
    TESTS
#undef X
};

enum {
#define X(en, kw, desc) TEST_ ## en = (1 << TEST_BIT_ ## en),
    TESTS
#undef X
};

#define X(en, kw, desc) | TEST_ ## en
const int TEST_ALL = 0 TESTS;
#undef X

static int run_tests(int test_set)
{
#define RUN_TEST(tst) if (test_set & TEST_ ## tst) { rc = test_ ## tst (); if (rc) break; }

    int rc = 0;

    puts(_("x52test is a suite of tests to write to the X52 Pro device\n"
           "and test the extra functionality available in the LEDs and MFD\n"));

    if (test_set == TEST_ALL) {
        puts(_("These tests take roughly 6 minutes to run"));
    }
    puts(_("Press Enter to begin the tests, press Ctrl-C to abort anytime"));

    getc(stdin);

    rc = libx52_init(&dev);
    if (rc != LIBX52_SUCCESS) {
        fprintf(stderr, _("Unable to initialize X52 library: %s\n"), libx52_strerror(rc));
        return 1;
    }

    signal(SIGTERM, signal_handler);
    signal(SIGINT, signal_handler);
    test_exit = 0;

    do {
        #define X(en, cmd, desc) RUN_TEST(en)
        TESTS
        #undef X
    } while (0);

    if (rc == LIBX52_SUCCESS) {
        puts(_("All tests completed successfully"));
    } else if (rc > 0) {
        fprintf(stderr, _("Got error %s\n"), libx52_strerror(rc));
    } else {
        fprintf(stderr, _("Received %s signal, quitting...\n"), strsignal(-rc));
    }

    if (rc <= 0) test_cleanup();
    libx52_exit(dev);
    return 0;
}

static void underline(const char *msg) {
    size_t i;
    puts(msg);
    for (i = 0; i < strlen(msg); i++) {
        putchar('=');
    }
    putchar('\n');
}

static void usage(void)
{
    puts(_("These are the available tests with a description and\n"
           "approximate runtime. Not specifying any tests will run\n"
           "all the tests\n"));

    underline(_("List of tests:"));

    #define X(en, cmd, desc) puts("\t" #cmd "\t" desc);
    TESTS
    #undef X

    puts("");
}

const struct x52test_cmd tests[] = {
#define X(en, cmd, desc) { #cmd, TEST_ ##en },
    TESTS
#undef X
    { NULL, 0 }
};

int main(int argc, char **argv)
{
    struct x52test_argv_result parsed;
    int ret = 0;

    /* Initialize gettext */
    #if ENABLE_NLS
    setlocale(LC_ALL, "");
    bindtextdomain(PACKAGE, LOCALEDIR);
    textdomain(PACKAGE);
    #endif

    /* Usage: x52test [list of tests] */
    x52test_parse_argv(argc, argv, tests, TEST_ALL, &parsed);

    if (parsed.status == X52TEST_ARGV_HELP) {
        printf(_("Usage: %s [list of tests]\n\n"), argv[0]);
        usage();
        return 0;
    }

    if (parsed.status == X52TEST_ARGV_UNKNOWN) {
        printf(_("Unrecognized test identifier: %s\n\n"), argv[parsed.bad_arg_index]);
        usage();
        return 1;
    }

    /* Initialize the nodelay variable */
    nodelay = (getenv("LD_PRELOAD") != NULL || getenv("NO_DELAY") != NULL);

    if (parsed.test_bitmap) {
        ret = run_tests(parsed.test_bitmap);
    } else {
        puts(_("Not running any tests"));
    }

    return ret;
}