kopia lustrzana https://github.com/Hamlib/Hamlib
659 wiersze
15 KiB
C
659 wiersze
15 KiB
C
/*
|
|
* Hamlib Interface - amplifier configuration interface
|
|
* Copyright (c) 2000-2010 by Stephane Fillod
|
|
*
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2.1 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
*
|
|
*/
|
|
|
|
/**
|
|
* \addtogroup amplifier
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* \brief Amplifier Configuration Interface
|
|
* \file amp_conf.c
|
|
*/
|
|
|
|
#ifdef HAVE_CONFIG_H
|
|
# include "config.h"
|
|
#endif
|
|
|
|
#include <stdlib.h>
|
|
#include <stdarg.h>
|
|
#include <stdio.h> /* Standard input/output definitions */
|
|
#include <string.h> /* String function definitions */
|
|
#include <unistd.h> /* UNIX standard function definitions */
|
|
|
|
#include <hamlib/amplifier.h>
|
|
|
|
#include "amp_conf.h"
|
|
#include "token.h"
|
|
|
|
|
|
/*
|
|
* Configuration options available in the amp->state struct.
|
|
*/
|
|
static const struct confparams ampfrontend_cfg_params[] =
|
|
{
|
|
{
|
|
TOK_PATHNAME, "amp_pathname", "Rig path name",
|
|
"Path name to the device file of the amplifier",
|
|
"/dev/amplifier", RIG_CONF_STRING,
|
|
},
|
|
{
|
|
TOK_WRITE_DELAY, "write_delay", "Write delay",
|
|
"Delay in ms between each byte sent out",
|
|
"0", RIG_CONF_NUMERIC, { .n = { 0, 1000, 1 } }
|
|
},
|
|
{
|
|
TOK_POST_WRITE_DELAY, "post_write_delay", "Post write delay",
|
|
"Delay in ms between each command sent out",
|
|
"0", RIG_CONF_NUMERIC, { .n = { 0, 1000, 1 } }
|
|
},
|
|
{
|
|
TOK_TIMEOUT, "timeout", "Timeout", "Timeout in ms",
|
|
"0", RIG_CONF_NUMERIC, { .n = { 0, 10000, 1 } }
|
|
},
|
|
{
|
|
TOK_RETRY, "retry", "Retry", "Max number of retry",
|
|
"0", RIG_CONF_NUMERIC, { .n = { 0, 10, 1 } }
|
|
},
|
|
|
|
{ RIG_CONF_END, NULL, }
|
|
};
|
|
|
|
|
|
static const struct confparams ampfrontend_serial_cfg_params[] =
|
|
{
|
|
{
|
|
TOK_SERIAL_SPEED, "serial_speed", "Serial speed",
|
|
"Serial port baud rate",
|
|
"0", RIG_CONF_NUMERIC, { .n = { 300, 115200, 1 } }
|
|
},
|
|
{
|
|
TOK_DATA_BITS, "data_bits", "Serial data bits",
|
|
"Serial port data bits",
|
|
"8", RIG_CONF_NUMERIC, { .n = { 5, 8, 1 } }
|
|
},
|
|
{
|
|
TOK_STOP_BITS, "stop_bits", "Serial stop bits",
|
|
"Serial port stop bits",
|
|
"1", RIG_CONF_NUMERIC, { .n = { 0, 3, 1 } }
|
|
},
|
|
{
|
|
TOK_PARITY, "serial_parity", "Serial parity",
|
|
"Serial port parity",
|
|
"None", RIG_CONF_COMBO, { .c = {{ "None", "Odd", "Even", "Mark", "Space", NULL }} }
|
|
},
|
|
{
|
|
TOK_HANDSHAKE, "serial_handshake", "Serial handshake",
|
|
"Serial port handshake",
|
|
"None", RIG_CONF_COMBO, { .c = {{ "None", "XONXOFF", "Hardware", NULL }} }
|
|
},
|
|
|
|
{ RIG_CONF_END, NULL, }
|
|
};
|
|
|
|
|
|
/**
|
|
* \brief Set amplifier state info from alpha input
|
|
* \param amp
|
|
* \param token TOK_... specifying which info to set
|
|
* \param val input
|
|
* \return RIG_OK or < 0 error
|
|
*
|
|
* assumes amp!=NULL, val!=NULL
|
|
*/
|
|
int frontamp_set_conf(AMP *amp, token_t token, const char *val)
|
|
{
|
|
struct amp_state *rs;
|
|
int val_i;
|
|
|
|
rs = &->state;
|
|
|
|
amp_debug(RIG_DEBUG_VERBOSE, "%s called\n", __func__);
|
|
|
|
switch (token)
|
|
{
|
|
case TOK_PATHNAME:
|
|
strncpy(rs->ampport.pathname, val, FILPATHLEN - 1);
|
|
break;
|
|
|
|
case TOK_WRITE_DELAY:
|
|
if (1 != sscanf(val, "%d", &val_i))
|
|
{
|
|
return -RIG_EINVAL;
|
|
}
|
|
|
|
rs->ampport.write_delay = val_i;
|
|
break;
|
|
|
|
case TOK_POST_WRITE_DELAY:
|
|
if (1 != sscanf(val, "%d", &val_i))
|
|
{
|
|
return -RIG_EINVAL;
|
|
}
|
|
|
|
rs->ampport.post_write_delay = val_i;
|
|
break;
|
|
|
|
case TOK_TIMEOUT:
|
|
if (1 != sscanf(val, "%d", &val_i))
|
|
{
|
|
return -RIG_EINVAL;
|
|
}
|
|
|
|
rs->ampport.timeout = val_i;
|
|
break;
|
|
|
|
case TOK_RETRY:
|
|
if (1 != sscanf(val, "%d", &val_i))
|
|
{
|
|
return -RIG_EINVAL;
|
|
}
|
|
|
|
rs->ampport.retry = val_i;
|
|
break;
|
|
|
|
case TOK_SERIAL_SPEED:
|
|
if (rs->ampport.type.rig != RIG_PORT_SERIAL)
|
|
{
|
|
return -RIG_EINVAL;
|
|
}
|
|
|
|
if (1 != sscanf(val, "%d", &val_i))
|
|
{
|
|
return -RIG_EINVAL;
|
|
}
|
|
|
|
rs->ampport.parm.serial.rate = val_i;
|
|
break;
|
|
|
|
case TOK_DATA_BITS:
|
|
if (rs->ampport.type.rig != RIG_PORT_SERIAL)
|
|
{
|
|
return -RIG_EINVAL;
|
|
}
|
|
|
|
if (1 != sscanf(val, "%d", &val_i))
|
|
{
|
|
return -RIG_EINVAL;
|
|
}
|
|
|
|
rs->ampport.parm.serial.data_bits = val_i;
|
|
break;
|
|
|
|
case TOK_STOP_BITS:
|
|
if (rs->ampport.type.rig != RIG_PORT_SERIAL)
|
|
{
|
|
return -RIG_EINVAL;
|
|
}
|
|
|
|
if (1 != sscanf(val, "%d", &val_i))
|
|
{
|
|
return -RIG_EINVAL;
|
|
}
|
|
|
|
rs->ampport.parm.serial.stop_bits = val_i;
|
|
break;
|
|
|
|
case TOK_PARITY:
|
|
if (rs->ampport.type.rig != RIG_PORT_SERIAL)
|
|
{
|
|
return -RIG_EINVAL;
|
|
}
|
|
|
|
if (!strcmp(val, "None"))
|
|
{
|
|
rs->ampport.parm.serial.parity = RIG_PARITY_NONE;
|
|
}
|
|
else if (!strcmp(val, "Odd"))
|
|
{
|
|
rs->ampport.parm.serial.parity = RIG_PARITY_ODD;
|
|
}
|
|
else if (!strcmp(val, "Even"))
|
|
{
|
|
rs->ampport.parm.serial.parity = RIG_PARITY_EVEN;
|
|
}
|
|
else if (!strcmp(val, "Mark"))
|
|
{
|
|
rs->ampport.parm.serial.parity = RIG_PARITY_MARK;
|
|
}
|
|
else if (!strcmp(val, "Space"))
|
|
{
|
|
rs->ampport.parm.serial.parity = RIG_PARITY_SPACE;
|
|
}
|
|
else
|
|
{
|
|
return -RIG_EINVAL;
|
|
}
|
|
|
|
break;
|
|
|
|
case TOK_HANDSHAKE:
|
|
if (rs->ampport.type.rig != RIG_PORT_SERIAL)
|
|
{
|
|
return -RIG_EINVAL;
|
|
}
|
|
|
|
if (!strcmp(val, "None"))
|
|
{
|
|
rs->ampport.parm.serial.handshake = RIG_HANDSHAKE_NONE;
|
|
}
|
|
else if (!strcmp(val, "XONXOFF"))
|
|
{
|
|
rs->ampport.parm.serial.handshake = RIG_HANDSHAKE_XONXOFF;
|
|
}
|
|
else if (!strcmp(val, "Hardware"))
|
|
{
|
|
rs->ampport.parm.serial.handshake = RIG_HANDSHAKE_HARDWARE;
|
|
}
|
|
else
|
|
{
|
|
return -RIG_EINVAL;
|
|
}
|
|
|
|
break;
|
|
|
|
#if 0
|
|
|
|
case TOK_MIN_AZ:
|
|
rs->min_az = atof(val);
|
|
break;
|
|
|
|
case TOK_MAX_AZ:
|
|
rs->max_az = atof(val);
|
|
break;
|
|
|
|
case TOK_MIN_EL:
|
|
rs->min_el = atof(val);
|
|
break;
|
|
|
|
case TOK_MAX_EL:
|
|
rs->max_el = atof(val);
|
|
break;
|
|
#endif
|
|
|
|
default:
|
|
return -RIG_EINVAL;
|
|
}
|
|
|
|
return RIG_OK;
|
|
}
|
|
|
|
|
|
/**
|
|
* \brief Get data from amplifier state in alpha form
|
|
* \param amp non-null
|
|
* \param token TOK_... specifying which data to get
|
|
* \param val result non-null
|
|
* \return RIG_OK or < 0 if error
|
|
*/
|
|
int frontamp_get_conf(AMP *amp, token_t token, char *val)
|
|
{
|
|
struct amp_state *rs;
|
|
const char *s;
|
|
|
|
rs = &->state;
|
|
|
|
amp_debug(RIG_DEBUG_VERBOSE, "%s called\n", __func__);
|
|
|
|
switch (token)
|
|
{
|
|
case TOK_PATHNAME:
|
|
strcpy(val, rs->ampport.pathname);
|
|
break;
|
|
|
|
case TOK_WRITE_DELAY:
|
|
sprintf(val, "%d", rs->ampport.write_delay);
|
|
break;
|
|
|
|
case TOK_POST_WRITE_DELAY:
|
|
sprintf(val, "%d", rs->ampport.post_write_delay);
|
|
break;
|
|
|
|
case TOK_TIMEOUT:
|
|
sprintf(val, "%d", rs->ampport.timeout);
|
|
break;
|
|
|
|
case TOK_RETRY:
|
|
sprintf(val, "%d", rs->ampport.retry);
|
|
break;
|
|
|
|
case TOK_SERIAL_SPEED:
|
|
if (rs->ampport.type.rig != RIG_PORT_SERIAL)
|
|
{
|
|
return -RIG_EINVAL;
|
|
}
|
|
|
|
sprintf(val, "%d", rs->ampport.parm.serial.rate);
|
|
break;
|
|
|
|
case TOK_DATA_BITS:
|
|
if (rs->ampport.type.rig != RIG_PORT_SERIAL)
|
|
{
|
|
return -RIG_EINVAL;
|
|
}
|
|
|
|
sprintf(val, "%d", rs->ampport.parm.serial.data_bits);
|
|
break;
|
|
|
|
case TOK_STOP_BITS:
|
|
if (rs->ampport.type.rig != RIG_PORT_SERIAL)
|
|
{
|
|
return -RIG_EINVAL;
|
|
}
|
|
|
|
sprintf(val, "%d", rs->ampport.parm.serial.stop_bits);
|
|
break;
|
|
|
|
case TOK_PARITY:
|
|
if (rs->ampport.type.rig != RIG_PORT_SERIAL)
|
|
{
|
|
return -RIG_EINVAL;
|
|
}
|
|
|
|
switch (rs->ampport.parm.serial.parity)
|
|
{
|
|
case RIG_PARITY_NONE:
|
|
s = "None";
|
|
break;
|
|
|
|
case RIG_PARITY_ODD:
|
|
s = "Odd";
|
|
break;
|
|
|
|
case RIG_PARITY_EVEN:
|
|
s = "Even";
|
|
break;
|
|
|
|
case RIG_PARITY_MARK:
|
|
s = "Mark";
|
|
break;
|
|
|
|
case RIG_PARITY_SPACE:
|
|
s = "Space";
|
|
break;
|
|
|
|
default:
|
|
return -RIG_EINVAL;
|
|
}
|
|
|
|
strcpy(val, s);
|
|
break;
|
|
|
|
case TOK_HANDSHAKE:
|
|
if (rs->ampport.type.rig != RIG_PORT_SERIAL)
|
|
{
|
|
return -RIG_EINVAL;
|
|
}
|
|
|
|
switch (rs->ampport.parm.serial.handshake)
|
|
{
|
|
case RIG_HANDSHAKE_NONE:
|
|
s = "None";
|
|
break;
|
|
|
|
case RIG_HANDSHAKE_XONXOFF:
|
|
s = "XONXOFF";
|
|
break;
|
|
|
|
case RIG_HANDSHAKE_HARDWARE:
|
|
s = "Hardware";
|
|
break;
|
|
|
|
default:
|
|
return -RIG_EINVAL;
|
|
}
|
|
|
|
strcpy(val, s);
|
|
break;
|
|
|
|
default:
|
|
return -RIG_EINVAL;
|
|
}
|
|
|
|
return RIG_OK;
|
|
}
|
|
|
|
|
|
#ifdef XXREMOVEDXXC
|
|
// Not referenced anywhere
|
|
/**
|
|
* \brief Executes cfunc on all the elements stored in the conf table
|
|
* \param amp non-null
|
|
* \param cfunc function(..)
|
|
* \param data
|
|
*
|
|
* start first with backend conf table, then finish with frontend table
|
|
*/
|
|
int HAMLIB_API amp_token_foreach(AMP *amp,
|
|
int (*cfunc)(const struct confparams *,
|
|
rig_ptr_t),
|
|
rig_ptr_t data)
|
|
{
|
|
const struct confparams *cfp;
|
|
|
|
amp_debug(RIG_DEBUG_VERBOSE, "%s called\n", __func__);
|
|
|
|
if (!amp || !amp->caps || !cfunc)
|
|
{
|
|
return -RIG_EINVAL;
|
|
}
|
|
|
|
for (cfp = ampfrontend_cfg_params; cfp->name; cfp++)
|
|
{
|
|
if ((*cfunc)(cfp, data) == 0)
|
|
{
|
|
return RIG_OK;
|
|
}
|
|
}
|
|
|
|
if (amp->caps->port_type == RIG_PORT_SERIAL)
|
|
{
|
|
for (cfp = ampfrontend_serial_cfg_params; cfp->name; cfp++)
|
|
{
|
|
if ((*cfunc)(cfp, data) == 0)
|
|
{
|
|
return RIG_OK;
|
|
}
|
|
}
|
|
}
|
|
|
|
for (cfp = amp->caps->cfgparams; cfp && cfp->name; cfp++)
|
|
{
|
|
if ((*cfunc)(cfp, data) == 0)
|
|
{
|
|
return RIG_OK;
|
|
}
|
|
}
|
|
|
|
return RIG_OK;
|
|
}
|
|
#endif
|
|
|
|
|
|
/**
|
|
* \brief lookup conf token by its name, return pointer to confparams struct.
|
|
* \param amp
|
|
* \param name
|
|
* \return confparams or NULL
|
|
*
|
|
* lookup backend config table first, then fall back to frontend.
|
|
* TODO: should use Lex to speed it up, strcmp hurts!
|
|
*/
|
|
const struct confparams *HAMLIB_API amp_confparam_lookup(AMP *amp,
|
|
const char *name)
|
|
{
|
|
const struct confparams *cfp;
|
|
token_t token;
|
|
|
|
amp_debug(RIG_DEBUG_VERBOSE, "%s called\n", __func__);
|
|
|
|
if (!amp || !amp->caps)
|
|
{
|
|
return NULL;
|
|
}
|
|
|
|
/* 0 returned for invalid format */
|
|
token = strtol(name, NULL, 0);
|
|
|
|
for (cfp = amp->caps->cfgparams; cfp && cfp->name; cfp++)
|
|
{
|
|
if (!strcmp(cfp->name, name) || token == cfp->token)
|
|
{
|
|
return cfp;
|
|
}
|
|
}
|
|
|
|
for (cfp = ampfrontend_cfg_params; cfp->name; cfp++)
|
|
{
|
|
if (!strcmp(cfp->name, name) || token == cfp->token)
|
|
{
|
|
return cfp;
|
|
}
|
|
}
|
|
|
|
if (amp->caps->port_type == RIG_PORT_SERIAL)
|
|
{
|
|
for (cfp = ampfrontend_serial_cfg_params; cfp->name; cfp++)
|
|
{
|
|
if (!strcmp(cfp->name, name) || token == cfp->token)
|
|
{
|
|
return cfp;
|
|
}
|
|
}
|
|
}
|
|
|
|
return NULL;
|
|
}
|
|
|
|
|
|
/**
|
|
* \brief Simple lookup returning token id associated with name
|
|
* \param amp
|
|
* \param name
|
|
* \return token enum
|
|
*/
|
|
token_t HAMLIB_API amp_token_lookup(AMP *amp, const char *name)
|
|
{
|
|
const struct confparams *cfp;
|
|
|
|
amp_debug(RIG_DEBUG_VERBOSE, "%s called\n", __func__);
|
|
|
|
cfp = amp_confparam_lookup(amp, name);
|
|
|
|
if (!cfp)
|
|
{
|
|
return RIG_CONF_END;
|
|
}
|
|
|
|
return cfp->token;
|
|
}
|
|
|
|
|
|
/**
|
|
* \brief set a amplifier configuration parameter
|
|
* \param amp The amp handle
|
|
* \param token The parameter
|
|
* \param val The value to set the parameter to
|
|
*
|
|
* Sets a configuration parameter.
|
|
*
|
|
* \return RIG_OK if the operation has been successful, otherwise
|
|
* a negative value if an error occurred (in which case, cause is
|
|
* set appropriately).
|
|
*
|
|
* \sa amp_get_conf()
|
|
*/
|
|
int HAMLIB_API amp_set_conf(AMP *amp, token_t token, const char *val)
|
|
{
|
|
amp_debug(RIG_DEBUG_VERBOSE, "%s called\n", __func__);
|
|
|
|
if (!amp || !amp->caps)
|
|
{
|
|
return -RIG_EINVAL;
|
|
}
|
|
|
|
if (rig_need_debug(RIG_DEBUG_VERBOSE))
|
|
{
|
|
const struct confparams *cfp;
|
|
char tokenstr[12];
|
|
sprintf(tokenstr, "%ld", token);
|
|
cfp = amp_confparam_lookup(amp, tokenstr);
|
|
|
|
if (!cfp)
|
|
{
|
|
return -RIG_EINVAL;
|
|
}
|
|
|
|
amp_debug(RIG_DEBUG_VERBOSE, "%s: %s='%s'\n", __func__, cfp->name, val);
|
|
}
|
|
|
|
if (IS_TOKEN_FRONTEND(token))
|
|
{
|
|
return frontamp_set_conf(amp, token, val);
|
|
}
|
|
|
|
if (amp->caps->set_conf == NULL)
|
|
{
|
|
return -RIG_ENAVAIL;
|
|
}
|
|
|
|
return amp->caps->set_conf(amp, token, val);
|
|
}
|
|
|
|
|
|
/**
|
|
* \brief get the value of a configuration parameter
|
|
* \param amp The amp handle
|
|
* \param token The parameter
|
|
* \param val The location where to store the value of config \a token
|
|
*
|
|
* Retrieves the value of a configuration parameter associated with \a token.
|
|
*
|
|
* \return RIG_OK if the operation has been successful, otherwise
|
|
* a negative value if an error occurred (in which case, cause is
|
|
* set appropriately).
|
|
*
|
|
* \sa amp_set_conf()
|
|
*/
|
|
int HAMLIB_API amp_get_conf(AMP *amp, token_t token, char *val)
|
|
{
|
|
rig_debug(RIG_DEBUG_VERBOSE, "%s called\n", __func__);
|
|
|
|
if (!amp || !amp->caps || !val)
|
|
{
|
|
return -RIG_EINVAL;
|
|
}
|
|
|
|
if (IS_TOKEN_FRONTEND(token))
|
|
{
|
|
return frontamp_get_conf(amp, token, val);
|
|
}
|
|
|
|
if (amp->caps->get_conf == NULL)
|
|
{
|
|
return -RIG_ENAVAIL;
|
|
}
|
|
|
|
return amp->caps->get_conf(amp, token, val);
|
|
}
|
|
|
|
/** @} */
|