root/usr.bin/radioctl/radioctl.c
/* $OpenBSD: radioctl.c,v 1.20 2019/06/28 13:35:03 deraadt Exp $ */
/* $RuOBSD: radioctl.c,v 1.4 2001/10/20 18:09:10 pva Exp $ */

/*
 * Copyright (c) 2001 Vladimir Popov <jumbo@narod.ru>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include <sys/ioctl.h>
#include <sys/radioio.h>

#include <dev/ic/bt8xx.h>

#include <err.h>
#include <fcntl.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <ctype.h>

#define RADIO_ENV       "RADIODEVICE"
#define RADIODEVICE     "/dev/radio"

const char *varname[] = {
        "search",
#define OPTION_SEARCH           0x00
        "volume",
#define OPTION_VOLUME           0x01
        "frequency",
#define OPTION_FREQUENCY        0x02
        "mute",
#define OPTION_MUTE             0x03
        "reference",
#define OPTION_REFERENCE        0x04
        "mono",
#define OPTION_MONO             0x05
        "stereo",
#define OPTION_STEREO           0x06
        "sensitivity",
#define OPTION_SENSITIVITY      0x07
        "channel",
#define OPTION_CHANNEL          0x08
        "chnlset"
#define OPTION_CHNLSET          0x09
};

#define OPTION_NONE             ~0u
#define VALUE_NONE              ~0u

struct opt_t {
        char *string;
        int option;
        int sign;
#define SIGN_NONE       0
#define SIGN_PLUS       1
#define SIGN_MINUS      -1
        u_int32_t value;
};

struct chansets {
        int value;
        char *name;
} chansets[] = {
{ CHNLSET_NABCST,       "nabcst",       },
{ CHNLSET_CABLEIRC,     "cableirc",     },
{ CHNLSET_CABLEHRC,     "cablehrc",     },
{ CHNLSET_WEUROPE,      "weurope",      },
{ CHNLSET_JPNBCST,      "jpnbcst",      },
{ CHNLSET_JPNCABLE,     "jpncable",     },
{ CHNLSET_XUSSR,        "xussr",        },
{ CHNLSET_AUSTRALIA,    "australia",    },
{ CHNLSET_FRANCE,       "france",       },
{ 0, NULL }
};

extern char *__progname;
const char *onchar = "on";
#define ONCHAR_LEN      2
const char *offchar = "off";
#define OFFCHAR_LEN     3

struct radio_info ri;
unsigned int i = 0;

int     parse_opt(char *, struct opt_t *);

void    print_vars(int, int);
void    do_ioctls(int, struct opt_t *, int);

void    print_value(int, int);
void    change_value(const struct opt_t);
void    update_value(int, int *, int);

void    warn_unsupported(int);
void    usage(void);

void    show_verbose(const char *, int);
void    show_int_val(int, const char *, char *, int);
void    show_float_val(float, const char *, char *, int);
void    show_char_val(const char *, const char *, int);
int     str_to_opt(const char *);
u_int   str_to_int(char *, int);

/*
 * Control behavior of a FM tuner - set frequency, volume etc
 */
int
main(int argc, char **argv)
{
        struct opt_t opt;
        char **avp;

        char *radiodev = NULL;
        int rd = -1;
        int optchar;
        int show_vars = 0;
        int show_choices = 0;
        int silent = 0;
        int mode = O_RDONLY;

        radiodev = getenv(RADIO_ENV);
        if (radiodev == NULL)
                radiodev = RADIODEVICE;

        while ((optchar = getopt(argc, argv, "af:nvw")) != -1) {
                switch (optchar) {
                case 'a':
                        show_vars = 1;
                        break;
                case 'f':
                        radiodev = optarg;
                        break;
                case 'n':
                        silent = 1;
                        break;
                case 'v':
                        show_choices = 1;
                        break;
                case 'w':
                        /* backwards compatibility */
                        break;
                default:
                        usage();
                        /* NOTREACHED */
                }
        }

        argc -= optind;
        argv += optind;

        if (argc == 0)
                show_vars = 1;

        /*
         * Scan the options for `name=value` so the
         * device can be opened in the proper mode.
         */
        for (avp = argv; *avp != NULL; avp++)
                if (strchr(*avp, '=') != NULL) {
                        mode = O_RDWR;
                        break;
                }

        rd = open(radiodev, mode);
        if (rd == -1)
                err(1, "%s open error", radiodev);

        if (ioctl(rd, RIOCGINFO, &ri) == -1)
                err(1, "RIOCGINFO");

        if (!argc && show_vars)
                print_vars(silent, show_choices);
        else if (argc > 0 && !show_vars) {
                if (mode == O_RDWR) {
                        for (; argc--; argv++)
                                if (parse_opt(*argv, &opt))
                                        do_ioctls(rd, &opt, silent);
                } else {
                        for (; argc--; argv++)
                                if (parse_opt(*argv, &opt)) {
                                        show_verbose(varname[opt.option],
                                            silent);
                                        print_value(opt.option, show_choices);
                                        free(opt.string);
                                        putchar('\n');
                                }
                }
        }

        if (close(rd) == -1)
                warn("%s close error", radiodev);

        return 0;
}

void
usage(void)
{
        fprintf(stderr,
            "usage: %s [-anv] [-f file]\n"
            "       %s [-nv] [-f file] name\n"
            "       %s [-n] [-f file] name=value\n",
            __progname, __progname, __progname);
        exit(1);
}

void
show_verbose(const char *nick, int silent)
{
        if (!silent)
                printf("%s=", nick);
}

void
warn_unsupported(int optval)
{
        warnx("driver does not support `%s'", varname[optval]);
}

void
do_ioctls(int fd, struct opt_t *o, int silent)
{
        int oval;

        if (fd < 0 || o == NULL)
                return;

        if (o->option == OPTION_SEARCH && !(ri.caps & RADIO_CAPS_HW_SEARCH)) {
                warn_unsupported(o->option);
                return;
        }

        oval = o->option == OPTION_SEARCH ? OPTION_FREQUENCY : o->option;
        if (!silent)
                printf("%s: ", varname[oval]);

        print_value(o->option, 0);
        printf(" -> ");

        if (o->option == OPTION_SEARCH) {

                if (ioctl(fd, RIOCSSRCH, &o->value) == -1) {
                        warn("RIOCSSRCH");
                        return;
                }

        } else {

                change_value(*o);
                if (ioctl(fd, RIOCSINFO, &ri) == -1) {
                        warn("RIOCSINFO");
                        return;
                }

        }

        if (ioctl(fd, RIOCGINFO, &ri) == -1) {
                warn("RIOCGINFO");
                return;
        }

        print_value(o->option, 0);
        putchar('\n');
}

void
change_value(const struct opt_t o)
{
        int unsupported = 0;

        if (o.value == VALUE_NONE)
                return;

        switch (o.option) {
        case OPTION_VOLUME:
                update_value(o.sign, &ri.volume, o.value);
                break;
        case OPTION_FREQUENCY:
                ri.tuner_mode = RADIO_TUNER_MODE_RADIO;
                update_value(o.sign, &ri.freq, o.value);
                break;
        case OPTION_REFERENCE:
                if (ri.caps & RADIO_CAPS_REFERENCE_FREQ)
                        update_value(o.sign, &ri.rfreq, o.value);
                else
                        unsupported++;
                break;
        case OPTION_MONO:
                /* FALLTHROUGH */
        case OPTION_STEREO:
                if (ri.caps & RADIO_CAPS_SET_MONO)
                        ri.stereo = o.option == OPTION_MONO ? !o.value : o.value;
                else
                        unsupported++;
                break;
        case OPTION_SENSITIVITY:
                if (ri.caps & RADIO_CAPS_LOCK_SENSITIVITY)
                        update_value(o.sign, &ri.lock, o.value);
                else
                        unsupported++;
                break;
        case OPTION_MUTE:
                ri.mute = o.value;
                break;
        case OPTION_CHANNEL:
                ri.tuner_mode = RADIO_TUNER_MODE_TV;
                update_value(o.sign, &ri.chan, o.value);
                break;
        case OPTION_CHNLSET:
                ri.chnlset = o.value;
                break;
        }

        if (unsupported)
                warn_unsupported(o.option);
}

/*
 * Convert string to integer representation of a parameter
 */
int
str_to_opt(const char *topt)
{
        int res, toptlen, varlen, len, varsize;

        if (topt == NULL || *topt == '\0')
                return OPTION_NONE;

        varsize = sizeof(varname) / sizeof(varname[0]);
        toptlen = strlen(topt);

        for (res = 0; res < varsize; res++) {
                varlen = strlen(varname[res]);
                len = toptlen > varlen ? toptlen : varlen;
                if (strncmp(topt, varname[res], len) == 0)
                        return res;
        }

        warnx("bad name `%s'", topt);
        return OPTION_NONE;
}

void
update_value(int sign, int *value, int update)
{
        switch (sign) {
        case SIGN_NONE:
                *value  = update;
                break;
        case SIGN_PLUS:
                *value += update;
                break;
        case SIGN_MINUS:
                *value -= update;
                break;
        }
}

/*
 * Convert string to unsigned integer
 */
u_int
str_to_int(char *str, int optval)
{
        int val;

        if (str == NULL || *str == '\0')
                return VALUE_NONE;

        if (optval == OPTION_FREQUENCY)
                val = (int)(1000 * atof(str));
        else
                val = (int)strtol(str, (char **)NULL, 10);

        return val;
}

/*
 * parse string s into struct opt_t
 * return true on success, false on failure
 */
int
parse_opt(char *s, struct opt_t *o) {
        static const char badvalue[] = "bad value `%s'";
        char *topt = NULL;
        int slen, optlen;
        
        if (s == NULL || *s == '\0' || o == NULL)
                return 0;

        o->string = NULL;
        o->option = OPTION_NONE;
        o->value = VALUE_NONE;
        o->sign = SIGN_NONE;

        slen = strlen(s);
        optlen = strcspn(s, "=");

        /* Set only o->optval, the rest is missing */
        if (slen == optlen) {
                o->option = str_to_opt(s);
                return o->option == OPTION_NONE ? 0 : 1;
        }

        if (optlen > slen - 2) {
                warnx(badvalue, s);
                return 0;
        }

        slen -= ++optlen;

        if ((topt = malloc(optlen)) == NULL) {
                warn("memory allocation error");
                return 0;
        }
        strlcpy(topt, s, optlen);

        if ((o->option = str_to_opt(topt)) == OPTION_NONE) {
                free(topt);
                return 0;
        }
        o->string = topt;

        topt = &s[optlen];
        
        if (strcmp(o->string, "chnlset") == 0) {
                for (i = 0; chansets[i].name; i++)
                        if (strncmp(chansets[i].name, topt,
                                strlen(chansets[i].name)) == 0)
                                        break;
                if (chansets[i].name != NULL) {
                        o->value = chansets[i].value;
                        return 1;
                } else {
                        warnx(badvalue, topt);
                        return 0;
                }
        }

        switch (*topt) {
        case '+':
        case '-':
                o->sign = (*topt == '+') ? SIGN_PLUS : SIGN_MINUS;
                o->value = str_to_int(&topt[1], o->option);
                break;
        case 'o':
                if (strncmp(topt, offchar,
                    slen > OFFCHAR_LEN ? slen : OFFCHAR_LEN) == 0)
                        o->value = 0;
                else if (strncmp(topt, onchar,
                    slen > ONCHAR_LEN ? slen : ONCHAR_LEN) == 0)
                        o->value = 1;
                break;
        case 'u':
                if (strncmp(topt, "up", slen > 2 ? slen : 2) == 0)
                        o->value = 1;
                break;
        case 'd':
                if (strncmp(topt, "down", slen > 4 ? slen : 4) == 0)
                        o->value = 0;
                break;
        default:
                if (isdigit((unsigned char)*topt))
                        o->value = str_to_int(topt, o->option);
                break;
        }

        if (o->value == VALUE_NONE) {
                warnx(badvalue, topt);
                return 0;
        }

        return 1;
}

/*
 * Print current value of the parameter.
 */
void
print_value(int optval, int show_choices)
{
        if (optval == OPTION_NONE)
                return;

        switch (optval) {
        case OPTION_SEARCH:
                /* FALLTHROUGH */
        case OPTION_FREQUENCY:
                printf("%.2fMHz", (float)ri.freq / 1000.);
                break;
        case OPTION_REFERENCE:
                printf("%ukHz", ri.rfreq);
                break;
        case OPTION_SENSITIVITY:
                printf("%umkV", ri.lock);
                break;
        case OPTION_MUTE:
                printf("%s", ri.mute ? onchar : offchar);
                break;
        case OPTION_MONO:
                printf("%s", ri.stereo ? offchar : onchar);
                break;
        case OPTION_STEREO:
                printf("%s", ri.stereo ? onchar : offchar);
                break;
        case OPTION_CHANNEL:
                printf("%u", ri.chan);
                break;
        case OPTION_CHNLSET:
                for (i = 0; chansets[i].name; i++) {
                        if (chansets[i].value == ri.chnlset)
                                printf("%s", chansets[i].name);
                }
                if (show_choices) {
                        printf("\n\t[");
                        for (i = 0; chansets[i].name; i++)
                                printf("%s ", chansets[i].name);
                        printf("]");
                }
                break;
        case OPTION_VOLUME:
        default:
                printf("%u", ri.volume);
                break;
        }
}

void
show_int_val(int val, const char *nick, char *append, int silent)
{
        show_verbose(nick, silent);
        printf("%u%s\n", val, append);
}

void
show_float_val(float val, const char *nick, char *append, int silent)
{
        show_verbose(nick, silent);
        printf("%.2f%s\n", val, append);
}

void
show_char_val(const char *val, const char *nick, int silent)
{
        show_verbose(nick, silent);
        printf("%s\n", val);
}

/*
 * Print all available parameters
 */
void
print_vars(int silent, int show_choices)
{
        show_int_val(ri.volume, varname[OPTION_VOLUME], "", silent);
        show_int_val(ri.chan, varname[OPTION_CHANNEL], "", silent);
        for (i = 0; chansets[i].name; i++) {
                if (chansets[i].value == ri.chnlset)
                        show_char_val(chansets[i].name, varname[OPTION_CHNLSET], silent);
        }
        if (show_choices) {
                printf("\t[ ");
                for (i = 0; chansets[i].name; i++)
                        printf("%s ", chansets[i].name);
                printf("]\n");
        }
        show_float_val((float)ri.freq / 1000., varname[OPTION_FREQUENCY],
            "MHz", silent);
        show_char_val(ri.mute ? onchar : offchar, varname[OPTION_MUTE], silent);

        if (ri.caps & RADIO_CAPS_REFERENCE_FREQ)
                show_int_val(ri.rfreq, varname[OPTION_REFERENCE], "kHz", silent);
        if (ri.caps & RADIO_CAPS_LOCK_SENSITIVITY)
                show_int_val(ri.lock, varname[OPTION_SENSITIVITY], "mkV", silent);

        if (ri.caps & RADIO_CAPS_DETECT_SIGNAL) {
                show_verbose("signal", silent);
                printf("%s\n", ri.info & RADIO_INFO_SIGNAL ? onchar : offchar);
        }
        if (ri.caps & RADIO_CAPS_DETECT_STEREO) {
                show_verbose(varname[OPTION_STEREO], silent);
                printf("%s\n", ri.info & RADIO_INFO_STEREO ? onchar : offchar);
        }

        if (!silent) {
                printf("mode: %s\n",
                    ri.tuner_mode == RADIO_TUNER_MODE_TV ? "TV" : "radio");

                puts("card capabilities:");
        }

        if (ri.caps & RADIO_CAPS_SET_MONO)
                puts("\tmanageable mono/stereo");
        if (ri.caps & RADIO_CAPS_HW_SEARCH)
                puts("\thardware search");
        if (ri.caps & RADIO_CAPS_HW_AFC)
                puts("\thardware AFC");
}