Logo Search packages:      
Sourcecode: hamlib version File versions  Download package

rig.c

Go to the documentation of this file.
/*
 *  Hamlib Interface - main file
 *  Copyright (c) 2000-2008 by Stephane Fillod and Frank Singleton
 *
 *    $Id: rig.c,v 1.100 2008/10/31 23:08:59 fillods Exp $
 *
 *   This library is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU Library General Public License as
 *   published by the Free Software Foundation; either version 2 of
 *   the License, or (at your option) any later version.
 *
 *   This program 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 Library General Public License for more details.
 *
 *   You should have received a copy of the GNU Library General Public
 *   License along with this library; if not, write to the Free Software
 *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 */

/**
 * \addtogroup rig
 * @{
 */

/**
 * \file src/rig.c
 * \brief Ham Radio Control Libraries interface
 * \author Stephane Fillod
 * \author Frank Singleton
 * \date 2000-2008
 *
 * Hamlib provides a user-callable API, a set of "front-end" routines that
 * call rig-specific "back-end" routines whichactually communicate with 
 * the physical rig.
 */

/*! \page rig Rig (radio) interface
 *
 * For us, a "rig" is an item of general remote controllable radio equipment.
 * Generally, there are a VFO settings, gain controls, etc.
 */

/**
 * \example ../tests/testrig.c
 */

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <stdio.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>


#include "hamlib/rig.h"
#include "serial.h"
#include "parallel.h"
#include "usb_port.h"
#include "network.h"
#include "event.h"

/**
 * \brief Hamlib release number
 * The version number has the format x.y.z
 */
00074 const char hamlib_version[] = "Hamlib version " PACKAGE_VERSION;

/**
 * \brief Hamlib copyright notice
 */
00079 const char hamlib_copyright[] = 
  "Copyright (C) 2000-2008 Stephane Fillod and Frank Singleton\n"
  "This is free software; see the source for copying conditions.  There is NO\n"
  "warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.";


#ifndef DOC_HIDDEN

#if defined(WIN32) && !defined(__CYGWIN__)
#define DEFAULT_SERIAL_PORT "\\\\.\\COM1"
#elif BSD
#define DEFAULT_SERIAL_PORT "/dev/cuaa0"
#else
#define DEFAULT_SERIAL_PORT "/dev/ttyS0"
#endif

#if defined(WIN32)
#define DEFAULT_PARALLEL_PORT "\\\\.\\$VDMLPT1"
#elif defined(HAVE_DEV_PPBUS_PPI_H)
#define DEFAULT_PARALLEL_PORT "/dev/ppi0"
#else
#define DEFAULT_PARALLEL_PORT "/dev/parport0"
#endif

#define CHECK_RIG_ARG(r) (!(r) || !(r)->caps || !(r)->state.comm_state)

/*
 * Data structure to track the opened rig (by rig_open)
 */
struct opened_rig_l {
            RIG *rig;
            struct opened_rig_l *next;
};
static struct opened_rig_l *opened_rig_list = { NULL };

/*
 * Careful, the order must be the same as their RIG_E* counterpart!
 * TODO: localise the messages..
 */
static const char *rigerror_table[] = {
      "Command completed sucessfully",
      "Invalid parameter",
      "Invalid configuration",
      "Memory shortage",
      "Feature not implemented",
      "Communication timed out",
      "IO error",
      "Internal Hamlib error",
      "Protocol error",
      "Command rejected by the rig",
      "Command performed, but arg truncated, result not guaranteed",
      "Feature not available",
      "Target VFO unaccessible",
      "Communication bus error",
      "Communication bus collision",
      "NULL RIG handle or invalid pointer parameter",
      "Invalid VFO",
      "Argument out of domain of func",
      NULL,
};

#define ERROR_TBL_SZ (sizeof(rigerror_table)/sizeof(char *))

/*
 * track which rig is opened (with rig_open)
 * needed at least for transceive mode
 */
static int add_opened_rig(RIG *rig)
{
      struct opened_rig_l *p;

      p = (struct opened_rig_l *)malloc(sizeof(struct opened_rig_l));
      if (!p)
            return -RIG_ENOMEM;
      p->rig = rig;
      p->next = opened_rig_list;
      opened_rig_list = p;

      return RIG_OK;
}

static int remove_opened_rig(RIG *rig)
{     
      struct opened_rig_l *p,*q;
      q = NULL;

      for (p=opened_rig_list; p; p=p->next) {
            if (p->rig == rig) {
                  if (q == NULL) {
                        opened_rig_list = opened_rig_list->next;
                  } else {
                        q->next = p->next;
                  }
                  free(p);
                  return RIG_OK;
            }
            q = p;
      }
      return -RIG_EINVAL;     /* Not found in list ! */
}

/**
 * \brief execs cfunc() on each opened rig
 * \param cfunc   The function to be executed on each rig
 * \param data    Data pointer to be passed to cfunc() 
 *
 *  Calls cfunc() function for each opened rig. 
 *  The contents of the opened rig table
 *  is processed in random order according to a function
 *  pointed to by \a cfunc, whic is called with two arguments,
 *  the first pointing to the RIG handle, the second
 *  to a data pointer \a data.
 *  If \a data is not needed, then it can be set to NULL.
 *  The processing of the opened rig table is stopped
 *  when cfunc() returns 0.
 * \internal
 *
 * \return always RIG_OK.
 */

00199 int foreach_opened_rig(int (*cfunc)(RIG *, rig_ptr_t), rig_ptr_t data)
{     
      struct opened_rig_l *p;

      for (p=opened_rig_list; p; p=p->next) {
            if ((*cfunc)(p->rig,data) == 0)
                  return RIG_OK;
      }
      return RIG_OK;
}

#endif /* !DOC_HIDDEN */

/**
 * \brief get string describing the error code
 * \param errnum  The error code
 * \return the appropriate description string, ortherwise a NULL pointer 
 * if the error code is unknown.
 *
 * Returns a string describing the error code passed in the argument \a errnum.
 *
 * \todo support gettext/localization
 */
00222 const char * HAMLIB_API rigerror(int errnum)
{
      errnum = abs(errnum);
      if (errnum > ERROR_TBL_SZ)
            return NULL;
      return rigerror_table[errnum];
}

/**
 * \brief allocate a new RIG handle
 * \param rig_model     The rig model for this new handle
 *
 * Allocates a new RIG handle and initializes the associated data 
 * for \a rig_model.
 *
 * \return a pointer to the #RIG handle otherwise NULL if memory allocation
 * failed or \a rig_model is unknown (e.g. backend autoload failed).
 *
 * \sa rig_cleanup(), rig_open()
 */

00243 RIG * HAMLIB_API rig_init(rig_model_t rig_model)
{
      RIG *rig;
      const struct rig_caps *caps;
      struct rig_state *rs;
      int i, retcode;

      rig_debug(RIG_DEBUG_VERBOSE,"rig:rig_init called \n");

      rig_check_backend(rig_model);

      caps = rig_get_caps(rig_model);
      if (!caps)
            return NULL;

      /*
       * okay, we've found it. Allocate some memory and set it to zeros,
       * and especially the initialize the callbacks 
       */ 
      rig = calloc(1, sizeof(RIG));
      if (rig == NULL) {
            /*
             * FIXME: how can the caller know it's a memory shortage,
             *            and not "rig not found" ?
             */
            return NULL;
      }

        /* caps is const, so we need to tell compiler
           that we now what we are doing */
      rig->caps = (struct rig_caps *) caps;

      /*
       * populate the rig->state
       * TODO: read the Preferences here! 
       */

      rs = &rig->state;

      rs->comm_state = 0;
      rs->rigport.type.rig = caps->port_type; /* default from caps */

      switch (caps->port_type) {
      case RIG_PORT_SERIAL:
      strncpy(rs->rigport.pathname, DEFAULT_SERIAL_PORT, FILPATHLEN);
      rs->rigport.parm.serial.rate = caps->serial_rate_max; /* fastest ! */
      rs->rigport.parm.serial.data_bits = caps->serial_data_bits;
      rs->rigport.parm.serial.stop_bits = caps->serial_stop_bits;
      rs->rigport.parm.serial.parity = caps->serial_parity;
      rs->rigport.parm.serial.handshake = caps->serial_handshake;
      break;

      case RIG_PORT_PARALLEL:
      strncpy(rs->rigport.pathname, DEFAULT_PARALLEL_PORT, FILPATHLEN);
      break;

      case RIG_PORT_NETWORK:
      strncpy(rs->rigport.pathname, "localhost:4532", FILPATHLEN);
      break;

      default:
      strncpy(rs->rigport.pathname, "", FILPATHLEN);
      }

      rs->rigport.write_delay = caps->write_delay;
      rs->rigport.post_write_delay = caps->post_write_delay;
      rs->rigport.timeout = caps->timeout;
      rs->rigport.retry = caps->retry;
      rs->pttport.type.ptt = caps->ptt_type;
      rs->dcdport.type.dcd = caps->dcd_type;

      rs->vfo_comp = 0.0;     /* override it with preferences */
      rs->current_vfo = RIG_VFO_CURR;     /* we don't know yet! */
      rs->transceive = RIG_TRN_OFF;
      rs->poll_interval = 500;
      /* should it be a parameter to rig_init ? --SF */
      rs->itu_region = RIG_ITU_REGION2;

      switch(rs->itu_region) {
            case RIG_ITU_REGION1:
                  memcpy(rs->tx_range_list, caps->tx_range_list1, 
                              sizeof(struct freq_range_list)*FRQRANGESIZ);
                  memcpy(rs->rx_range_list, caps->rx_range_list1, 
                              sizeof(struct freq_range_list)*FRQRANGESIZ);
                  break;
            case RIG_ITU_REGION2:
            case RIG_ITU_REGION3:
            default:
                  memcpy(rs->tx_range_list, caps->tx_range_list2, 
                              sizeof(struct freq_range_list)*FRQRANGESIZ);
                  memcpy(rs->rx_range_list, caps->rx_range_list2, 
                              sizeof(struct freq_range_list)*FRQRANGESIZ);
                  break;
      }

      rs->vfo_list = 0;
      for (i=0; i<FRQRANGESIZ && !RIG_IS_FRNG_END(rs->rx_range_list[i]); i++) {
                  rs->vfo_list |= rs->rx_range_list[i].vfo;
      }
      for (i=0; i<FRQRANGESIZ && !RIG_IS_FRNG_END(rs->tx_range_list[i]); i++) {
                  rs->vfo_list |= rs->tx_range_list[i].vfo;
      }

      memcpy(rs->preamp, caps->preamp, sizeof(int)*MAXDBLSTSIZ);
      memcpy(rs->attenuator, caps->attenuator, sizeof(int)*MAXDBLSTSIZ);
      memcpy(rs->tuning_steps, caps->tuning_steps, 
                        sizeof(struct tuning_step_list)*TSLSTSIZ);
      memcpy(rs->filters, caps->filters, 
                        sizeof(struct filter_list)*FLTLSTSIZ);
      memcpy(&rs->str_cal, &caps->str_cal, 
                        sizeof(cal_table_t));

      memcpy(rs->chan_list, caps->chan_list, sizeof(chan_t)*CHANLSTSIZ);

      rs->has_get_func = caps->has_get_func;
      rs->has_set_func = caps->has_set_func;
      rs->has_get_level = caps->has_get_level;
      rs->has_set_level = caps->has_set_level;
      rs->has_get_parm = caps->has_get_parm;
      rs->has_set_parm = caps->has_set_parm;

      /* emulation by frontend */
      if ((caps->has_get_level & RIG_LEVEL_STRENGTH) == 0 &&
            (caps->has_get_level & RIG_LEVEL_RAWSTR) == RIG_LEVEL_RAWSTR)
            rs->has_get_level |= RIG_LEVEL_STRENGTH;

      memcpy(rs->level_gran, caps->level_gran, sizeof(gran_t)*RIG_SETTING_MAX);
      memcpy(rs->parm_gran, caps->parm_gran, sizeof(gran_t)*RIG_SETTING_MAX);

      rs->max_rit = caps->max_rit;
      rs->max_xit = caps->max_xit;
      rs->max_ifshift = caps->max_ifshift;
      rs->announces = caps->announces;

      rs->rigport.fd = rs->pttport.fd = rs->dcdport.fd = -1;

      /* 
       * let the backend a chance to setup his private data
       * This must be done only once defaults are setup,
       * so the backend init can override rig_state.
       */
      if (caps->rig_init != NULL) {
            retcode = caps->rig_init(rig);
            if (retcode != RIG_OK) {
                  rig_debug(RIG_DEBUG_VERBOSE,"rig:backend_init failed!\n");
                  /* cleanup and exit */
                  free(rig);
                  return NULL;
            }
      }

      return rig;
}

/**
 * \brief open the communication to the rig
 * \param rig     The #RIG handle of the radio to be opened
 *
 * Opens communication to a radio which \a RIG handle has been passed
 * by argument.
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 * \retval RIG_EINVAL   \a rig is NULL or unconsistent.
 * \retval RIG_ENIMPL   port type communication is not implemented yet.
 *
 * \sa rig_init(), rig_close()
 */

00414 int HAMLIB_API rig_open(RIG *rig)
{
      const struct rig_caps *caps;
      struct rig_state *rs;
      int status;
      int want_state_delay = 0;

      rig_debug(RIG_DEBUG_VERBOSE,"rig:rig_open called \n");

      if (!rig || !rig->caps)
            return -RIG_EINVAL;

      caps = rig->caps;
      rs = &rig->state;

      if (rs->comm_state)
            return -RIG_EINVAL;

      rs->rigport.fd = -1;

      switch(rs->rigport.type.rig) {
      case RIG_PORT_SERIAL:
            status = serial_open(&rs->rigport);
            if (status < 0)
                  return status;
            if (rs->rigport.parm.serial.rts_state != RIG_SIGNAL_UNSET &&
                        rs->rigport.type.ptt != RIG_PTT_SERIAL_RTS &&
                        rs->rigport.parm.serial.handshake != RIG_HANDSHAKE_HARDWARE) {
                  status = ser_set_rts(&rs->rigport, 
                              rs->rigport.parm.serial.rts_state == RIG_SIGNAL_ON);
                  want_state_delay = 1;
            }
            if (status != 0)
                  return status;
            if (rs->rigport.parm.serial.dtr_state != RIG_SIGNAL_UNSET &&
                        rs->rigport.type.ptt != RIG_PTT_SERIAL_DTR) {
                  status = ser_set_dtr(&rs->rigport, 
                              rs->rigport.parm.serial.dtr_state == RIG_SIGNAL_ON);
                  want_state_delay = 1;
            }
            if (status != 0)
                  return status;
            /*
             * Wait whatever electrolytics in the circuit come up to voltage.
             * Is 100ms enough? Too much?
             */
            if (want_state_delay)
                  usleep(100*1000);

            break;

      case RIG_PORT_PARALLEL:
            status = par_open(&rs->rigport);
            if (status < 0)
                  return status;
            break;

      case RIG_PORT_DEVICE:
            status = open(rs->rigport.pathname, O_RDWR, 0);
            if (status < 0)
                  return -RIG_EIO;
            rs->rigport.fd = status;
            break;

      case RIG_PORT_USB:
            status = usb_port_open(&rs->rigport);
            if (status < 0)
                  return status;
            break;

      case RIG_PORT_NONE:
      case RIG_PORT_RPC:
            break;      /* ez :) */

      case RIG_PORT_NETWORK:
            status = network_open(&rs->rigport, 4532);
            if (status < 0)
                  return status;
            break;

      default:
            return -RIG_EINVAL;
      }

      /*
       * FIXME: what to do if PTT open fails or PTT unsupported?
       *                fail rig_open?  remember unallocating..
       */
      switch(rs->pttport.type.ptt) {
      case RIG_PTT_NONE:
      case RIG_PTT_RIG:
            break;
      case RIG_PTT_SERIAL_RTS:
      case RIG_PTT_SERIAL_DTR:
            rs->pttport.fd = ser_open(&rs->pttport);
            if (rs->pttport.fd < 0)
                  rig_debug(RIG_DEBUG_ERR, "Cannot open PTT device \"%s\"\n",
                                    rs->pttport.pathname);
            break;
      case RIG_PTT_PARALLEL:
            rs->pttport.fd = par_open(&rs->pttport);
            if (rs->pttport.fd < 0)
                  rig_debug(RIG_DEBUG_ERR, "Cannot open PTT device \"%s\"\n",
                                    rs->pttport.pathname);
            break;
      default:
            rig_debug(RIG_DEBUG_ERR, "Unsupported PTT type %d\n",
                                    rs->pttport.type.ptt);
      }

      switch(rs->dcdport.type.dcd) {
      case RIG_DCD_NONE:
      case RIG_DCD_RIG:
            break;
      case RIG_DCD_SERIAL_DSR:
      case RIG_DCD_SERIAL_CTS:
      case RIG_DCD_SERIAL_CAR:
            rs->dcdport.fd = ser_open(&rs->dcdport);
            if (rs->dcdport.fd < 0)
                  rig_debug(RIG_DEBUG_ERR, "Cannot open DCD device \"%s\"\n",
                                    rs->dcdport.pathname);
            break;
      case RIG_DCD_PARALLEL:
            rs->dcdport.fd = par_open(&rs->dcdport);
            if (rs->dcdport.fd < 0)
                  rig_debug(RIG_DEBUG_ERR, "Cannot open DCD device \"%s\"\n",
                                    rs->dcdport.pathname);
            break;
      default:
            rig_debug(RIG_DEBUG_ERR, "Unsupported DCD type %d\n",
                                    rs->dcdport.type.dcd);
      }

      add_opened_rig(rig);

      rs->comm_state = 1;

      /* 
       * Maybe the backend has something to initialize
       * In case of failure, just close down and report error code.
       */
      if (caps->rig_open != NULL) {
            status = caps->rig_open(rig); 
            if (status != RIG_OK) {
                  return status;
            }
      }

      /*
       * trigger state->current_vfo first retrieval
       */
        rig_get_vfo(rig, &rs->current_vfo);

#if 0
        /*
         * Check the current tranceive state of the rig
         */
        if (rs->transceive == RIG_TRN_RIG) {
            int retval, trn;
            retval = rig_get_trn(rig, &trn);
            if (retval == RIG_OK && trn == RIG_TRN_RIG)
                add_trn_rig(rig);
        }
#endif
      return RIG_OK;
}

/**
 * \brief close the communication to the rig
 * \param rig     The #RIG handle of the radio to be closed
 *
 * Closes communication to a radio which \a RIG handle has been passed
 * by argument that was previously open with rig_open().
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 * \sa rig_cleanup(), rig_open()
 */

00595 int HAMLIB_API rig_close(RIG *rig)
{
      const struct rig_caps *caps;
      struct rig_state *rs;

      rig_debug(RIG_DEBUG_VERBOSE,"rig:rig_close called \n");

      if (!rig || !rig->caps)
            return -RIG_EINVAL;

      caps = rig->caps;
      rs = &rig->state;

      if (!rs->comm_state)
            return -RIG_EINVAL;

      if (rs->transceive != RIG_TRN_OFF) {
            remove_trn_rig(rig);
      }

      /*
       * Let the backend say 73s to the rig.
       * and ignore the return code.
       */
      if (caps->rig_close)
            caps->rig_close(rig);

      /* 
       * FIXME: what happens if PTT and rig ports are the same?
       *                (eg. ptt_type = RIG_PTT_SERIAL)
       */
      switch(rs->pttport.type.ptt) {
      case RIG_PTT_NONE:
      case RIG_PTT_RIG:
            break;
      case RIG_PTT_SERIAL_RTS:
      case RIG_PTT_SERIAL_DTR:
            ser_close(&rs->pttport);
            break;
      case RIG_PTT_PARALLEL:
            par_close(&rs->pttport);
            break;
      default:
            rig_debug(RIG_DEBUG_ERR, "Unsupported PTT type %d\n",
                                    rs->pttport.type.ptt);
      }

      switch(rs->dcdport.type.dcd) {
      case RIG_DCD_NONE:
      case RIG_DCD_RIG:
            break;
      case RIG_DCD_SERIAL_DSR:
      case RIG_DCD_SERIAL_CTS:
      case RIG_DCD_SERIAL_CAR:
            ser_close(&rs->dcdport);
            break;
      case RIG_DCD_PARALLEL:
            par_close(&rs->dcdport);
            break;
      default:
            rig_debug(RIG_DEBUG_ERR, "Unsupported DCD type %d\n",
                                    rs->dcdport.type.dcd);
      }

      rs->dcdport.fd = rs->pttport.fd = -1;

      if (rs->rigport.fd != -1) {
            switch(rs->rigport.type.rig) {
            case RIG_PORT_SERIAL:
                  ser_close(&rs->rigport);
                  break;
            case RIG_PORT_PARALLEL:
                  par_close(&rs->rigport);
                  break;
            case RIG_PORT_USB:
                  usb_port_close(&rs->rigport);
                  break;

            default:
                  close(rs->rigport.fd);
            }
            rs->rigport.fd = -1;
      }

      remove_opened_rig(rig);

      rs->comm_state = 0;

      return RIG_OK;
}

/**
 * \brief release a rig handle and free associated memory
 * \param rig     The #RIG handle of the radio to be closed
 *
 * Releases a rig struct which port has eventualy been closed already 
 * with rig_close().
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 * \sa rig_init(), rig_close()
 */

00700 int HAMLIB_API rig_cleanup(RIG *rig)
{
      rig_debug(RIG_DEBUG_VERBOSE,"rig:rig_cleanup called \n");

      if (!rig || !rig->caps)
            return -RIG_EINVAL;

      /*
       * check if they forgot to close the rig
       */
      if (rig->state.comm_state)
            rig_close(rig);

      /*
       * basically free up the priv struct 
       */
      if (rig->caps->rig_cleanup)
            rig->caps->rig_cleanup(rig);

      free(rig);

      return RIG_OK;
}


/**
 * \brief set the frequency of the target VFO
 * \param rig     The rig handle
 * \param vfo     The target VFO
 * \param freq    The frequency to set to
 *
 * Sets the frequency of the target VFO.
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 * \sa rig_get_freq()
 */

00740 int HAMLIB_API rig_set_freq(RIG *rig, vfo_t vfo, freq_t freq)
{
      const struct rig_caps *caps;
      int retcode;
      vfo_t curr_vfo;

      if (CHECK_RIG_ARG(rig))
            return -RIG_EINVAL;

      caps = rig->caps;

      if (rig->state.vfo_comp != 0.0)
            freq += (freq_t)((double)rig->state.vfo_comp * freq);

      if (caps->set_freq == NULL)
            return -RIG_ENAVAIL;

      if ((caps->targetable_vfo&RIG_TARGETABLE_FREQ) || 
                  vfo == RIG_VFO_CURR || vfo == rig->state.current_vfo) {
            retcode = caps->set_freq(rig, vfo, freq);
      } else {
            if (!caps->set_vfo)
                  return -RIG_ENTARGET;
            curr_vfo = rig->state.current_vfo;
            retcode = caps->set_vfo(rig, vfo);
            if (retcode != RIG_OK)
                  return retcode;

            retcode = caps->set_freq(rig, vfo, freq);
            caps->set_vfo(rig, curr_vfo);
      }
      if (retcode == RIG_OK &&
                  (vfo == RIG_VFO_CURR || vfo == rig->state.current_vfo))
            rig->state.current_freq = freq;

      return retcode;
}

/**
 * \brief get the frequency of the target VFO
 * \param rig     The rig handle
 * \param vfo     The target VFO
 * \param freq    The location where to store the current frequency
 *
 *  Retrieves the frequency of the target VFO.
 *    The value stored at \a freq location equals RIG_FREQ_NONE when the current
 *    frequency of the VFO is not defined (e.g. blank memory).
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 * \sa rig_set_freq()
 */

00795 int HAMLIB_API rig_get_freq(RIG *rig, vfo_t vfo, freq_t *freq)
{
      const struct rig_caps *caps;
      int retcode;
      vfo_t curr_vfo;

      if (CHECK_RIG_ARG(rig) || !freq)
            return -RIG_EINVAL;

      caps = rig->caps;

      if (caps->get_freq == NULL)
            return -RIG_ENAVAIL;

      if ((caps->targetable_vfo&RIG_TARGETABLE_FREQ) || 
                  vfo == RIG_VFO_CURR || vfo == rig->state.current_vfo) {
            retcode = caps->get_freq(rig, vfo, freq);
      } else {
            if (!caps->set_vfo)
                  return -RIG_ENAVAIL;
            curr_vfo = rig->state.current_vfo;
            retcode = caps->set_vfo(rig, vfo);
            if (retcode != RIG_OK)
                  return retcode;
            retcode = caps->get_freq(rig, vfo, freq);
            caps->set_vfo(rig, curr_vfo);
      }
      /* VFO compensation */
      if (rig->state.vfo_comp != 0.0)
            *freq += (freq_t)(rig->state.vfo_comp * (*freq));

      if (retcode == RIG_OK &&
                  (vfo == RIG_VFO_CURR || vfo == rig->state.current_vfo))
            rig->state.current_freq = *freq;

      return retcode;
}


/**
 * \brief set the mode of the target VFO
 * \param rig     The rig handle
 * \param vfo     The target VFO
 * \param mode    The mode to set to
 * \param width   The passband width to set to
 *
 * Sets the mode and associated passband of the target VFO.
 * The passband \a width must be supported by the backend of the rig.
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 * \sa rig_get_mode()
 */

00851 int HAMLIB_API rig_set_mode(RIG *rig, vfo_t vfo, rmode_t mode, pbwidth_t width)
{
      const struct rig_caps *caps;
      int retcode;
      vfo_t curr_vfo;

      if (CHECK_RIG_ARG(rig))
            return -RIG_EINVAL;

      caps = rig->caps;

      if (caps->set_mode == NULL)
            return -RIG_ENAVAIL;

      if ((caps->targetable_vfo&RIG_TARGETABLE_MODE) ||
                  vfo == RIG_VFO_CURR || vfo == rig->state.current_vfo) {
            retcode = caps->set_mode(rig, vfo, mode, width);
      } else {

            if (!caps->set_vfo)
                  return -RIG_ENTARGET;
            curr_vfo = rig->state.current_vfo;
            retcode = caps->set_vfo(rig, vfo);
            if (retcode != RIG_OK)
                  return retcode;

            retcode = caps->set_mode(rig, vfo, mode, width);
            caps->set_vfo(rig, curr_vfo);
      }

      if (retcode == RIG_OK &&
                  (vfo == RIG_VFO_CURR || vfo == rig->state.current_vfo)) {
            rig->state.current_mode = mode;
            rig->state.current_width = width;
      }

      return retcode;
}

/**
 * \brief get the mode of the target VFO
 * \param rig     The rig handle
 * \param vfo     The target VFO
 * \param mode    The location where to store the current mode
 * \param width   The location where to store the current passband width
 *
 *  Retrieves the mode and passband of the target VFO.
 *  If the backend is unable to determine the width, the \a width
 *  will be set to RIG_PASSBAND_NORMAL as a default.
 *    The value stored at \a mode location equals RIG_MODE_NONE when the current
 *    mode of the VFO is not defined (e.g. blank memory).
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 * \sa rig_set_mode()
 */

00910 int HAMLIB_API rig_get_mode(RIG *rig, vfo_t vfo, rmode_t *mode, pbwidth_t *width)
{
      const struct rig_caps *caps;
      int retcode;
      vfo_t curr_vfo;

      if (CHECK_RIG_ARG(rig) || !mode || !width)
            return -RIG_EINVAL;

      caps = rig->caps;

      if (caps->get_mode == NULL)
            return -RIG_ENAVAIL;

      if ((caps->targetable_vfo&RIG_TARGETABLE_MODE) || 
                  vfo == RIG_VFO_CURR || vfo == rig->state.current_vfo) {
            retcode = caps->get_mode(rig, vfo, mode, width);
      } else {

            if (!caps->set_vfo)
                  return -RIG_ENTARGET;
            curr_vfo = rig->state.current_vfo;
            retcode = caps->set_vfo(rig, vfo);
            if (retcode != RIG_OK)
                  return retcode;

            retcode = caps->get_mode(rig, vfo, mode, width);
            caps->set_vfo(rig, curr_vfo);
      }

      if (retcode == RIG_OK &&
                  (vfo == RIG_VFO_CURR || vfo == rig->state.current_vfo)) {
            rig->state.current_mode = *mode;
            rig->state.current_width = *width;
      }

      if (*width == RIG_PASSBAND_NORMAL && *mode != RIG_MODE_NONE)
            *width = rig_passband_normal (rig, *mode);

      return retcode;
}

/**
 * \brief get the normal passband of a mode
 * \param rig     The rig handle
 * \param mode    The mode to get the passband
 *
 *  Returns the normal (default) passband for the given \a mode.
 *
 * \return the passband in Hz if the operation has been sucessful,
 * or a 0 if an error occured (passband not found, whatever).
 *
 * \sa rig_passband_narrow(), rig_passband_wide()
 */

00965 pbwidth_t HAMLIB_API rig_passband_normal(RIG *rig, rmode_t mode)
{
      const struct rig_state *rs;
      int i;

      if (!rig)
            return RIG_PASSBAND_NORMAL;   /* huhu! */

      rs = &rig->state;

      for (i=0; i<FLTLSTSIZ && rs->filters[i].modes; i++) {
            if (rs->filters[i].modes & mode) {
                  return rs->filters[i].width;
            }
      }

      return RIG_PASSBAND_NORMAL;
}

/**
 * \brief get the narrow passband of a mode
 * \param rig     The rig handle
 * \param mode    The mode to get the passband
 *
 *  Returns the narrow (closest) passband for the given \a mode.
 *    EXAMPLE: rig_set_mode(my_rig, RIG_MODE_LSB, 
 *                                        rig_passband_narrow(my_rig, RIG_MODE_LSB) );
 *
 * \return the passband in Hz if the operation has been sucessful,
 * or a 0 if an error occured (passband not found, whatever).
 *
 * \sa rig_passband_normal(), rig_passband_wide()
 */

00999 pbwidth_t HAMLIB_API rig_passband_narrow(RIG *rig, rmode_t mode)
{
      const struct rig_state *rs;
      pbwidth_t normal;
      int i;

      if (!rig)
            return 0;   /* huhu! */

      rs = &rig->state;

      for (i=0; i<FLTLSTSIZ-1 && rs->filters[i].modes; i++) {
            if (rs->filters[i].modes & mode) {
                  normal = rs->filters[i].width;
                  for (i++; i<FLTLSTSIZ && rs->filters[i].modes; i++) {
                        if ((rs->filters[i].modes & mode) &&
                                    (rs->filters[i].width < normal)) {
                              return rs->filters[i].width;
                        }
                  }
                  return 0;
            }
      }

      return 0;
}

/**
 * \brief get the wide passband of a mode
 * \param rig     The rig handle
 * \param mode    The mode to get the passband
 *
 *  Returns the wide (default) passband for the given \a mode.
 *    EXAMPLE: rig_set_mode(my_rig, RIG_MODE_AM, 
 *                                        rig_passband_wide(my_rig, RIG_MODE_AM) );
 *
 * \return the passband in Hz if the operation has been sucessful,
 * or a 0 if an error occured (passband not found, whatever).
 *
 * \sa rig_passband_narrow(), rig_passband_normal()
 */

01041 pbwidth_t HAMLIB_API rig_passband_wide(RIG *rig, rmode_t mode)
{
      const struct rig_state *rs;
      pbwidth_t normal;
      int i;

      if (!rig)
            return 0;   /* huhu! */

      rs = &rig->state;

      for (i=0; i<FLTLSTSIZ-1 && rs->filters[i].modes; i++) {
            if (rs->filters[i].modes & mode) {
                  normal = rs->filters[i].width;
                  for (i++; i<FLTLSTSIZ && rs->filters[i].modes; i++) {
                        if ((rs->filters[i].modes & mode) &&
                                          (rs->filters[i].width > normal)) {
                              return rs->filters[i].width;
                        }
                  }
                  return 0;
            }
      }

      return 0;
}

/**
 * \brief set the current VFO
 * \param rig     The rig handle
 * \param vfo     The VFO to set to
 *
 *  Sets the current VFO. The VFO can be RIG_VFO_A, RIG_VFO_B, RIG_VFO_C 
 *  for VFOA, VFOB, VFOC respectively or RIG_VFO_MEM for Memory mode.
 *  Supported VFOs depends on rig capabilities.
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 * \sa rig_get_vfo()
 */

01084 int HAMLIB_API rig_set_vfo(RIG *rig, vfo_t vfo)
{
      const struct rig_caps *caps;
      int retcode;

      if (CHECK_RIG_ARG(rig))
            return -RIG_EINVAL;

      caps = rig->caps;

      if (caps->set_vfo == NULL)
            return -RIG_ENAVAIL;

      retcode= caps->set_vfo(rig, vfo);
      if (retcode == RIG_OK)
            rig->state.current_vfo = vfo;
      return retcode;
}

/**
 * \brief get the current VFO
 * \param rig     The rig handle
 * \param vfo     The location where to store the current VFO
 *
 *  Retrieves the current VFO. The VFO can be RIG_VFO_A, RIG_VFO_B, RIG_VFO_C 
 *  for VFOA, VFOB, VFOC respectively or RIG_VFO_MEM for Memory mode.
 *  Supported VFOs depends on rig capabilities.
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 * \sa rig_set_vfo()
 */

01119 int HAMLIB_API rig_get_vfo(RIG *rig, vfo_t *vfo)
{
      const struct rig_caps *caps;
      int retcode;

      if (CHECK_RIG_ARG(rig) || !vfo)
            return -RIG_EINVAL;

      caps = rig->caps;

      if (caps->get_vfo == NULL)
            return -RIG_ENAVAIL;

      retcode= caps->get_vfo(rig, vfo);
      if (retcode == RIG_OK)
            rig->state.current_vfo = *vfo;
      return retcode;
}

/**
 * \brief set PTT on/off
 * \param rig     The rig handle
 * \param vfo     The target VFO
 * \param ptt     The PTT status to set to
 *
 *  Sets "Push-To-Talk" on/off.
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 * \sa rig_get_ptt()
 */
01152 int HAMLIB_API rig_set_ptt(RIG *rig, vfo_t vfo, ptt_t ptt)
{
      const struct rig_caps *caps;
      int retcode;
      vfo_t curr_vfo;

      if (CHECK_RIG_ARG(rig))
            return -RIG_EINVAL;

      caps = rig->caps;

      switch (rig->state.pttport.type.ptt) {
      case RIG_PTT_RIG:
            if (caps->set_ptt == NULL)
            return -RIG_ENIMPL;

            if ((caps->targetable_vfo&RIG_TARGETABLE_PURE) || 
                        vfo == RIG_VFO_CURR || vfo == rig->state.current_vfo)
            return caps->set_ptt(rig, vfo, ptt);
      
            if (!caps->set_vfo)
            return -RIG_ENTARGET;
            curr_vfo = rig->state.current_vfo;
            retcode = caps->set_vfo(rig, vfo);
            if (retcode != RIG_OK)
                  return retcode;
      
            retcode = caps->set_ptt(rig, vfo, ptt);
            caps->set_vfo(rig, curr_vfo);
            return retcode;

            break;

      case RIG_PTT_SERIAL_DTR:
            return ser_set_dtr(&rig->state.pttport, ptt==RIG_PTT_ON);

      case RIG_PTT_SERIAL_RTS:
            return ser_set_rts(&rig->state.pttport, ptt==RIG_PTT_ON);

      case RIG_PTT_PARALLEL:
            return par_ptt_set(&rig->state.pttport, ptt);

      case RIG_PTT_NONE:
            return -RIG_ENAVAIL;    /* not available */
      default:
            return -RIG_EINVAL;
      }

      return RIG_OK;
}

/**
 * \brief get the status of the PTT
 * \param rig     The rig handle
 * \param vfo     The target VFO
 * \param ptt     The location where to store the status of the PTT
 *
 *  Retrieves the status of PTT (are we on the air?).
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 * \sa rig_set_ptt()
 */
01217 int HAMLIB_API rig_get_ptt(RIG *rig, vfo_t vfo, ptt_t *ptt)
{     
      const struct rig_caps *caps;
      int retcode, status;
      vfo_t curr_vfo;

      if (CHECK_RIG_ARG(rig) || !ptt)
            return -RIG_EINVAL;

      caps = rig->caps;

      switch (rig->state.pttport.type.ptt) {
      case RIG_PTT_RIG:
            if (caps->get_ptt == NULL)
                  return -RIG_ENIMPL;

            if ((caps->targetable_vfo&RIG_TARGETABLE_PURE) || 
                        vfo == RIG_VFO_CURR || vfo == rig->state.current_vfo)
                  return caps->get_ptt(rig, vfo, ptt);
      
            if (!caps->set_vfo)
                  return -RIG_ENTARGET;
            curr_vfo = rig->state.current_vfo;
            retcode = caps->set_vfo(rig, vfo);
            if (retcode != RIG_OK)
                  return retcode;
      
            retcode = caps->get_ptt(rig, vfo, ptt);
            caps->set_vfo(rig, curr_vfo);
            return retcode;

            break;

      case RIG_PTT_SERIAL_RTS:
            if (caps->get_ptt)
                  return caps->get_ptt(rig, vfo, ptt);

            retcode = ser_get_rts(&rig->state.pttport, &status);
            *ptt = status ? RIG_PTT_ON : RIG_PTT_OFF;
            return retcode;

      case RIG_PTT_SERIAL_DTR:
            if (caps->get_ptt)
                  return caps->get_ptt(rig, vfo, ptt);

            retcode = ser_get_dtr(&rig->state.pttport, &status);
            *ptt = status ? RIG_PTT_ON : RIG_PTT_OFF;
            return retcode;

      case RIG_PTT_PARALLEL:
            if (caps->get_ptt)
                  return caps->get_ptt(rig, vfo, ptt);

            return par_ptt_get(&rig->state.pttport, ptt);

      case RIG_PTT_NONE:
            return -RIG_ENAVAIL;    /* not available */

      default:
            return -RIG_EINVAL;
      }

      return RIG_OK;
}

/**
 * \brief get the status of the DCD
 * \param rig     The rig handle
 * \param vfo     The target VFO
 * \param dcd     The location where to store the status of the DCD
 *
 *  Retrieves the status of DCD (is squelch open?).
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 */
01295 int HAMLIB_API rig_get_dcd(RIG *rig, vfo_t vfo, dcd_t *dcd)
{     
      const struct rig_caps *caps;
      int retcode, status;
      vfo_t curr_vfo;

      if (CHECK_RIG_ARG(rig) || !dcd)
            return -RIG_EINVAL;

      caps = rig->caps;

      switch (rig->state.dcdport.type.dcd) {
      case RIG_DCD_RIG:
            if (caps->get_dcd == NULL)
                  return -RIG_ENIMPL;

            if ((caps->targetable_vfo&RIG_TARGETABLE_PURE) || 
                        vfo == RIG_VFO_CURR || vfo == rig->state.current_vfo)
                  return caps->get_dcd(rig, vfo, dcd);
      
            if (!caps->set_vfo)
                  return -RIG_ENTARGET;
            curr_vfo = rig->state.current_vfo;
            retcode = caps->set_vfo(rig, vfo);
            if (retcode != RIG_OK)
                  return retcode;
      
            retcode = caps->get_dcd(rig, vfo, dcd);
            caps->set_vfo(rig, curr_vfo);
            return retcode;

            break;

      case RIG_DCD_SERIAL_CTS:
            retcode = ser_get_cts(&rig->state.dcdport, &status);
            *dcd = status ? RIG_DCD_ON : RIG_DCD_OFF;
            return retcode;

      case RIG_DCD_SERIAL_DSR:
            retcode = ser_get_dsr(&rig->state.dcdport, &status);
            *dcd = status ? RIG_DCD_ON : RIG_DCD_OFF;
            return retcode;

      case RIG_DCD_SERIAL_CAR:
            retcode = ser_get_car(&rig->state.dcdport, &status);
            *dcd = status ? RIG_DCD_ON : RIG_DCD_OFF;
            return retcode;

            
      case RIG_DCD_PARALLEL:
            return par_dcd_get(&rig->state.dcdport, dcd);

      case RIG_DCD_NONE:
            return -RIG_ENAVAIL;    /* not available */

      default:
            return -RIG_EINVAL;
      }

      return RIG_OK;
}


/**
 * \brief set the repeater shift
 * \param rig     The rig handle
 * \param vfo     The target VFO
 * \param rptr_shift    The repeater shift to set to
 *
 *  Sets the current repeater shift.
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 * \sa rig_get_rptr_shift()
 */
01372 int HAMLIB_API rig_set_rptr_shift(RIG *rig, vfo_t vfo, rptr_shift_t rptr_shift)
{
      const struct rig_caps *caps;
      int retcode;
      vfo_t curr_vfo;

      if (CHECK_RIG_ARG(rig))
            return -RIG_EINVAL;

      caps = rig->caps;

      if (caps->set_rptr_shift == NULL)
            return -RIG_ENAVAIL;

      if ((caps->targetable_vfo&RIG_TARGETABLE_PURE) || 
                  vfo == RIG_VFO_CURR || vfo == rig->state.current_vfo)
            return caps->set_rptr_shift(rig, vfo, rptr_shift);

      if (!caps->set_vfo)
            return -RIG_ENTARGET;
      curr_vfo = rig->state.current_vfo;
      retcode = caps->set_vfo(rig, vfo);
      if (retcode != RIG_OK)
            return retcode;

      retcode = caps->set_rptr_shift(rig, vfo, rptr_shift);
      caps->set_vfo(rig, curr_vfo);
      return retcode;
}

/**
 * \brief get the current repeater shift
 * \param rig     The rig handle
 * \param vfo     The target VFO
 * \param rptr_shift    The location where to store the current repeater shift
 *
 *  Retrieves the current repeater shift.
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 * \sa rig_set_rptr_shift()
 */
01416 int HAMLIB_API rig_get_rptr_shift(RIG *rig, vfo_t vfo, rptr_shift_t *rptr_shift)
{
      const struct rig_caps *caps;
      int retcode;
      vfo_t curr_vfo;

      if (CHECK_RIG_ARG(rig) || !rptr_shift)
            return -RIG_EINVAL;

      caps = rig->caps;

      if (caps->get_rptr_shift == NULL)
            return -RIG_ENAVAIL;

      if ((caps->targetable_vfo&RIG_TARGETABLE_PURE) || 
                  vfo == RIG_VFO_CURR || vfo == rig->state.current_vfo)
            return caps->get_rptr_shift(rig, vfo, rptr_shift);

      if (!caps->set_vfo)
            return -RIG_ENTARGET;
      curr_vfo = rig->state.current_vfo;
      retcode = caps->set_vfo(rig, vfo);
      if (retcode != RIG_OK)
            return retcode;

      retcode = caps->get_rptr_shift(rig, vfo, rptr_shift);
      caps->set_vfo(rig, curr_vfo);
      return retcode;
}

/**
 * \brief set the repeater offset
 * \param rig     The rig handle
 * \param vfo     The target VFO
 * \param rptr_offs     The VFO to set to
 *
 *  Sets the current repeater offset.
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 * \sa rig_get_rptr_offs()
 */

01461 int HAMLIB_API rig_set_rptr_offs(RIG *rig, vfo_t vfo, shortfreq_t rptr_offs)
{
      const struct rig_caps *caps;
      int retcode;
      vfo_t curr_vfo;

      if (CHECK_RIG_ARG(rig))
            return -RIG_EINVAL;

      caps = rig->caps;

      if (caps->set_rptr_offs == NULL)
            return -RIG_ENAVAIL;

      if ((caps->targetable_vfo&RIG_TARGETABLE_PURE) || 
                  vfo == RIG_VFO_CURR || vfo == rig->state.current_vfo)
            return caps->set_rptr_offs(rig, vfo, rptr_offs);

      if (!caps->set_vfo)
            return -RIG_ENTARGET;
      curr_vfo = rig->state.current_vfo;
      retcode = caps->set_vfo(rig, vfo);
      if (retcode != RIG_OK)
            return retcode;

      retcode = caps->set_rptr_offs(rig, vfo, rptr_offs);
      caps->set_vfo(rig, curr_vfo);
      return retcode;
}

/**
 * \brief get the current repeater offset
 * \param rig     The rig handle
 * \param vfo     The target VFO
 * \param rptr_offs     The location where to store the current repeater offset
 *
 *  Retrieves the current repeater offset.
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 * \sa rig_set_rptr_offs()
 */

01506 int HAMLIB_API rig_get_rptr_offs(RIG *rig, vfo_t vfo, shortfreq_t *rptr_offs)
{
      const struct rig_caps *caps;
      int retcode;
      vfo_t curr_vfo;

      if (CHECK_RIG_ARG(rig) || !rptr_offs)
            return -RIG_EINVAL;

      caps = rig->caps;

      if (caps->get_rptr_offs == NULL)
            return -RIG_ENAVAIL;

      if ((caps->targetable_vfo&RIG_TARGETABLE_PURE) || 
                  vfo == RIG_VFO_CURR || vfo == rig->state.current_vfo)
            return caps->get_rptr_offs(rig, vfo, rptr_offs);

      if (!caps->set_vfo)
            return -RIG_ENTARGET;
      curr_vfo = rig->state.current_vfo;
      retcode = caps->set_vfo(rig, vfo);
      if (retcode != RIG_OK)
            return retcode;

      retcode = caps->get_rptr_offs(rig, vfo, rptr_offs);
      caps->set_vfo(rig, curr_vfo);
      return retcode;
}


/**
 * \brief set the split frequencies
 * \param rig     The rig handle
 * \param vfo     The target VFO
 * \param tx_freq The transmit split frequency to set to
 *
 *  Sets the split(TX) frequency.
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 * \sa rig_get_split_freq(), rig_set_split_vfo()
 */

01552 int HAMLIB_API rig_set_split_freq(RIG *rig, vfo_t vfo, freq_t tx_freq)
{
      const struct rig_caps *caps;
      int retcode;
      vfo_t curr_vfo;

      if (CHECK_RIG_ARG(rig))
            return -RIG_EINVAL;

      caps = rig->caps;

      if (caps->set_split_freq && 
                  ((caps->targetable_vfo&RIG_TARGETABLE_PURE) || 
                  vfo == RIG_VFO_CURR || vfo == rig->state.current_vfo))
            return caps->set_split_freq(rig, vfo, tx_freq);

      curr_vfo = rig->state.current_vfo;
      if (caps->set_vfo) {
            retcode = caps->set_vfo(rig, vfo);
      } else if (rig_has_vfo_op(rig, RIG_OP_TOGGLE) && caps->vfo_op) {
            retcode = caps->vfo_op(rig, vfo, RIG_OP_TOGGLE);
      } else {
            return -RIG_ENAVAIL;
      }
      if (retcode != RIG_OK)
            return retcode;

      if (caps->set_split_freq)
            retcode = caps->set_split_freq(rig, vfo, tx_freq);
      else
            retcode = caps->set_freq(rig, RIG_VFO_CURR, tx_freq);

      if (caps->set_vfo) {
            caps->set_vfo(rig, curr_vfo);
      } else {
            caps->vfo_op(rig, vfo, RIG_OP_TOGGLE);
      }
      return retcode;
}

/**
 * \brief get the current split frequencies
 * \param rig     The rig handle
 * \param vfo     The target VFO
 * \param tx_freq The location where to store the current transmit split frequency
 *
 *  Retrieves the current split(TX) frequency.
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 * \sa rig_set_split_freq()
 */
01606 int HAMLIB_API rig_get_split_freq(RIG *rig, vfo_t vfo, freq_t *tx_freq)
{
      const struct rig_caps *caps;
      int retcode;
      vfo_t curr_vfo;

      if (CHECK_RIG_ARG(rig) || !tx_freq)
            return -RIG_EINVAL;

      caps = rig->caps;

      if (caps->get_split_freq && 
                  ((caps->targetable_vfo&RIG_TARGETABLE_PURE) || 
                  vfo == RIG_VFO_CURR || vfo == rig->state.current_vfo))
            return caps->get_split_freq(rig, vfo, tx_freq);

      curr_vfo = rig->state.current_vfo;
      if (caps->set_vfo) {
            retcode = caps->set_vfo(rig, vfo);
      } else if (rig_has_vfo_op(rig, RIG_OP_TOGGLE) && caps->vfo_op) {
            retcode = caps->vfo_op(rig, vfo, RIG_OP_TOGGLE);
      } else {
            return -RIG_ENAVAIL;
      }
      if (retcode != RIG_OK)
            return retcode;

      if (caps->get_split_freq)
            retcode = caps->get_split_freq(rig, vfo, tx_freq);
      else
            retcode = caps->get_freq(rig, RIG_VFO_CURR, tx_freq);

      if (caps->set_vfo) {
            caps->set_vfo(rig, curr_vfo);
      } else {
            caps->vfo_op(rig, vfo, RIG_OP_TOGGLE);
      }

      return retcode;
}

/**
 * \brief set the split modes
 * \param rig     The rig handle
 * \param vfo     The target VFO
 * \param tx_mode The transmit split mode to set to
 * \param tx_width      The transmit split width to set to
 *
 *  Sets the split(TX) mode.
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 * \sa rig_get_split_mode()
 */

01663 int HAMLIB_API rig_set_split_mode(RIG *rig, vfo_t vfo, rmode_t tx_mode, pbwidth_t tx_width)
{
      const struct rig_caps *caps;
      int retcode;
      vfo_t curr_vfo;

      if (CHECK_RIG_ARG(rig))
            return -RIG_EINVAL;

      caps = rig->caps;

      if (caps->set_split_mode && 
                  ((caps->targetable_vfo&RIG_TARGETABLE_PURE) || 
                  vfo == RIG_VFO_CURR || vfo == rig->state.current_vfo))
            return caps->set_split_mode(rig, vfo, tx_mode, tx_width);

      curr_vfo = rig->state.current_vfo;
      if (caps->set_vfo) {
            retcode = caps->set_vfo(rig, vfo);
      } else if (rig_has_vfo_op(rig, RIG_OP_TOGGLE) && caps->vfo_op) {
            retcode = caps->vfo_op(rig, vfo, RIG_OP_TOGGLE);
      } else {
            return -RIG_ENAVAIL;
      }
      if (retcode != RIG_OK)
            return retcode;

      if (caps->set_split_mode)
            retcode = caps->set_split_mode(rig, vfo, tx_mode, tx_width);
      else
            retcode = caps->set_mode(rig, RIG_VFO_CURR, tx_mode, tx_width);

      if (caps->set_vfo) {
            caps->set_vfo(rig, curr_vfo);
      } else {
            caps->vfo_op(rig, vfo, RIG_OP_TOGGLE);
      }

      return retcode;
}

/**
 * \brief get the current split modes
 * \param rig     The rig handle
 * \param vfo     The target VFO
 * \param tx_mode The location where to store the current transmit split mode
 * \param tx_width      The location where to store the current transmit split width
 *
 *  Retrieves the current split(TX) mode and passband.
 *  If the backend is unable to determine the width, the \a tx_width
 *  will be set to RIG_PASSBAND_NORMAL as a default.
 *  The value stored at \a tx_mode location equals RIG_MODE_NONE
 *  when the current mode of the VFO is not defined (e.g. blank memory).
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 * \sa rig_set_split_mode()
 */
01723 int HAMLIB_API rig_get_split_mode(RIG *rig, vfo_t vfo, rmode_t *tx_mode, pbwidth_t *tx_width)
{
      const struct rig_caps *caps;
      int retcode;
      vfo_t curr_vfo;

      if (CHECK_RIG_ARG(rig) || !tx_mode || !tx_width)
            return -RIG_EINVAL;

      caps = rig->caps;

      if (caps->get_split_mode && 
                   ((caps->targetable_vfo&RIG_TARGETABLE_PURE) || 
                  vfo == RIG_VFO_CURR || vfo == rig->state.current_vfo))
            return caps->get_split_mode(rig, vfo, tx_mode, tx_width);

      curr_vfo = rig->state.current_vfo;
      if (caps->set_vfo) {
            retcode = caps->set_vfo(rig, vfo);
      } else if (rig_has_vfo_op(rig, RIG_OP_TOGGLE) && caps->vfo_op) {
            retcode = caps->vfo_op(rig, vfo, RIG_OP_TOGGLE);
      } else {
            return -RIG_ENAVAIL;
      }
      if (retcode != RIG_OK)
            return retcode;

      if (caps->get_split_mode)
            retcode = caps->get_split_mode(rig, vfo, tx_mode, tx_width);
      else
            retcode = caps->get_mode(rig, RIG_VFO_CURR, tx_mode, tx_width);

      if (caps->set_vfo) {
            caps->set_vfo(rig, curr_vfo);
      } else {
            caps->vfo_op(rig, vfo, RIG_OP_TOGGLE);
      }

      if (*tx_width == RIG_PASSBAND_NORMAL && *tx_mode != RIG_MODE_NONE)
            *tx_width = rig_passband_normal (rig, *tx_mode);

      return retcode;
}


/**
 * \brief set the split mode
 * \param rig     The rig handle
 * \param vfo     The target VFO
 * \param split   The split mode to set to
 * \param tx_vfo  The transmit VFO
 *
 *  Sets the current split mode.
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 * \sa rig_get_split_vfo()
 */
01783 int HAMLIB_API rig_set_split_vfo(RIG *rig, vfo_t vfo, split_t split, vfo_t tx_vfo)
{
      const struct rig_caps *caps;
      int retcode;
      vfo_t curr_vfo;

      if (CHECK_RIG_ARG(rig))
            return -RIG_EINVAL;

      caps = rig->caps;

      if (caps->set_split_vfo == NULL)
            return -RIG_ENAVAIL;

      if ((caps->targetable_vfo&RIG_TARGETABLE_PURE) || 
                  vfo == RIG_VFO_CURR || vfo == rig->state.current_vfo)
            return caps->set_split_vfo(rig, vfo, split, tx_vfo);

      if (!caps->set_vfo)
            return -RIG_ENTARGET;
      curr_vfo = rig->state.current_vfo;
      retcode = caps->set_vfo(rig, vfo);
      if (retcode != RIG_OK)
            return retcode;

      retcode = caps->set_split_vfo(rig, vfo, split, tx_vfo);
      caps->set_vfo(rig, curr_vfo);
      return retcode;
}

/**
 * \brief get the current split mode
 * \param rig     The rig handle
 * \param vfo     The target VFO
 * \param split   The location where to store the current split mode
 * \param tx_vfo  The transmit VFO
 *
 *  Retrieves the current split mode.
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 * \sa rig_set_split_vfo()
 */
01828 int HAMLIB_API rig_get_split_vfo(RIG *rig, vfo_t vfo, split_t *split, vfo_t *tx_vfo)
{
      const struct rig_caps *caps;
      int retcode;
      vfo_t curr_vfo;

      if (CHECK_RIG_ARG(rig) || !split)
            return -RIG_EINVAL;

      caps = rig->caps;

      if (caps->get_split_vfo == NULL)
            return -RIG_ENAVAIL;

      if ((caps->targetable_vfo&RIG_TARGETABLE_PURE) || 
                  vfo == RIG_VFO_CURR || vfo == rig->state.current_vfo)
            return caps->get_split_vfo(rig, vfo, split, tx_vfo);

      if (!caps->set_vfo)
            return -RIG_ENTARGET;
      curr_vfo = rig->state.current_vfo;
      retcode = caps->set_vfo(rig, vfo);
      if (retcode != RIG_OK)
            return retcode;

      retcode = caps->get_split_vfo(rig, vfo, split, tx_vfo);
      caps->set_vfo(rig, curr_vfo);
      return retcode;
}

/**
 * \brief set the RIT
 * \param rig     The rig handle
 * \param vfo     The target VFO
 * \param rit     The RIT offset to adjust to
 *
 *  Sets the current RIT offset. A value of 0 for \a rit disables RIT.
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 * \sa rig_get_rit()
 */

01873 int HAMLIB_API rig_set_rit(RIG *rig, vfo_t vfo, shortfreq_t rit)
{
      const struct rig_caps *caps;
      int retcode;
      vfo_t curr_vfo;

      if (CHECK_RIG_ARG(rig))
            return -RIG_EINVAL;

      caps = rig->caps;

      if (caps->set_rit == NULL)
            return -RIG_ENAVAIL;

      if ((caps->targetable_vfo&RIG_TARGETABLE_PURE) || 
                  vfo == RIG_VFO_CURR || vfo == rig->state.current_vfo)
            return caps->set_rit(rig, vfo, rit);

      if (!caps->set_vfo)
            return -RIG_ENTARGET;
      curr_vfo = rig->state.current_vfo;
      retcode = caps->set_vfo(rig, vfo);
      if (retcode != RIG_OK)
            return retcode;

      retcode = caps->set_rit(rig, vfo, rit);
      caps->set_vfo(rig, curr_vfo);
      return retcode;
}

/**
 * \brief get the current RIT offset
 * \param rig     The rig handle
 * \param vfo     The target VFO
 * \param rit     The location where to store the current RIT offset
 *
 *  Retrieves the current RIT offset.
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 * \sa rig_set_rit()
 */

01918 int HAMLIB_API rig_get_rit(RIG *rig, vfo_t vfo, shortfreq_t *rit)
{
      const struct rig_caps *caps;
      int retcode;
      vfo_t curr_vfo;

      if (CHECK_RIG_ARG(rig) || !rit)
            return -RIG_EINVAL;

      caps = rig->caps;

      if (caps->get_rit == NULL)
            return -RIG_ENAVAIL;

      if ((caps->targetable_vfo&RIG_TARGETABLE_PURE) || 
                  vfo == RIG_VFO_CURR || vfo == rig->state.current_vfo)
            return caps->get_rit(rig, vfo, rit);

      if (!caps->set_vfo)
            return -RIG_ENTARGET;
      curr_vfo = rig->state.current_vfo;
      retcode = caps->set_vfo(rig, vfo);
      if (retcode != RIG_OK)
            return retcode;

      retcode = caps->get_rit(rig, vfo, rit);
      caps->set_vfo(rig, curr_vfo);
      return retcode;
}

/**
 * \brief set the XIT
 * \param rig     The rig handle
 * \param vfo     The target VFO
 * \param xit     The XIT offset to adjust to
 *
 *  Sets the current XIT offset. A value of 0 for \a xit disables XIT.
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 * \sa rig_get_xit()
 */

01963 int HAMLIB_API rig_set_xit(RIG *rig, vfo_t vfo, shortfreq_t xit)
{
      const struct rig_caps *caps;
      int retcode;
      vfo_t curr_vfo;

      if (CHECK_RIG_ARG(rig))
            return -RIG_EINVAL;

      caps = rig->caps;

      if (caps->set_xit == NULL)
            return -RIG_ENAVAIL;

      if ((caps->targetable_vfo&RIG_TARGETABLE_PURE) || 
                  vfo == RIG_VFO_CURR || vfo == rig->state.current_vfo)
            return caps->set_xit(rig, vfo, xit);

      if (!caps->set_vfo)
            return -RIG_ENTARGET;
      curr_vfo = rig->state.current_vfo;
      retcode = caps->set_vfo(rig, vfo);
      if (retcode != RIG_OK)
            return retcode;

      retcode = caps->set_xit(rig, vfo, xit);
      caps->set_vfo(rig, curr_vfo);
      return retcode;
}

/**
 * \brief get the current XIT offset
 * \param rig     The rig handle
 * \param vfo     The target VFO
 * \param xit     The location where to store the current XIT offset
 *
 *  Retrieves the current XIT offset.
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 * \sa rig_set_xit()
 */

02008 int HAMLIB_API rig_get_xit(RIG *rig, vfo_t vfo, shortfreq_t *xit)
{
      const struct rig_caps *caps;
      int retcode;
      vfo_t curr_vfo;

      if (CHECK_RIG_ARG(rig) || !xit)
            return -RIG_EINVAL;

      caps = rig->caps;

      if (caps->get_xit == NULL)
            return -RIG_ENAVAIL;

      if ((caps->targetable_vfo&RIG_TARGETABLE_PURE) || 
                  vfo == RIG_VFO_CURR || vfo == rig->state.current_vfo)
            return caps->get_xit(rig, vfo, xit);

      if (!caps->set_vfo)
            return -RIG_ENTARGET;
      curr_vfo = rig->state.current_vfo;
      retcode = caps->set_vfo(rig, vfo);
      if (retcode != RIG_OK)
            return retcode;

      retcode = caps->get_xit(rig, vfo, xit);
      caps->set_vfo(rig, curr_vfo);
      return retcode;
}



/**
 * \brief set the Tuning Step
 * \param rig     The rig handle
 * \param vfo     The target VFO
 * \param ts      The tuning step to set to
 *
 *  Sets the Tuning Step.
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 * \sa rig_get_ts()
 */

02055 int HAMLIB_API rig_set_ts(RIG *rig, vfo_t vfo, shortfreq_t ts)
{
      const struct rig_caps *caps;
      int retcode;
      vfo_t curr_vfo;

      if (CHECK_RIG_ARG(rig))
            return -RIG_EINVAL;

      caps = rig->caps;

      if (caps->set_ts == NULL)
            return -RIG_ENAVAIL;

      if ((caps->targetable_vfo&RIG_TARGETABLE_PURE) || 
                  vfo == RIG_VFO_CURR || vfo == rig->state.current_vfo)
            return caps->set_ts(rig, vfo, ts);

      if (!caps->set_vfo)
            return -RIG_ENTARGET;
      curr_vfo = rig->state.current_vfo;
      retcode = caps->set_vfo(rig, vfo);
      if (retcode != RIG_OK)
            return retcode;

      retcode = caps->set_ts(rig, vfo, ts);
      caps->set_vfo(rig, curr_vfo);
      return retcode;
}

/**
 * \brief get the current Tuning Step
 * \param rig     The rig handle
 * \param vfo     The target VFO
 * \param ts      The location where to store the current tuning step
 *
 *  Retrieves the current tuning step.
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 * \sa rig_set_ts()
 */

02100 int HAMLIB_API rig_get_ts(RIG *rig, vfo_t vfo, shortfreq_t *ts)
{
      const struct rig_caps *caps;
      int retcode;
      vfo_t curr_vfo;

      if (CHECK_RIG_ARG(rig) || !ts)
            return -RIG_EINVAL;

      caps = rig->caps;

      if (caps->get_ts == NULL)
            return -RIG_ENAVAIL;

      if ((caps->targetable_vfo&RIG_TARGETABLE_PURE) || 
                  vfo == RIG_VFO_CURR || vfo == rig->state.current_vfo)
            return caps->get_ts(rig, vfo, ts);

      if (!caps->set_vfo)
            return -RIG_ENTARGET;
      curr_vfo = rig->state.current_vfo;
      retcode = caps->set_vfo(rig, vfo);
      if (retcode != RIG_OK)
            return retcode;

      retcode = caps->get_ts(rig, vfo, ts);
      caps->set_vfo(rig, curr_vfo);
      return retcode;
}

/**
 * \brief set the antenna
 * \param rig     The rig handle
 * \param vfo     The target VFO
 * \param ant     The anntena to select
 *
 *  Select the antenna connector.
\code
      rig_set_ant(rig, RIG_VFO_CURR, RIG_ANT_1);  // apply to both TX&RX
      rig_set_ant(rig, RIG_VFO_RX, RIG_ANT_2);
\endcode
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 * \sa rig_get_ant()
 */

02149 int HAMLIB_API rig_set_ant(RIG *rig, vfo_t vfo, ant_t ant)
{
      const struct rig_caps *caps;
      int retcode;
      vfo_t curr_vfo;

      if (CHECK_RIG_ARG(rig))
            return -RIG_EINVAL;

      caps = rig->caps;

      if (caps->set_ant == NULL)
            return -RIG_ENAVAIL;

      if ((caps->targetable_vfo&RIG_TARGETABLE_PURE) || 
                  vfo == RIG_VFO_CURR || vfo == rig->state.current_vfo)
            return caps->set_ant(rig, vfo, ant);

      if (!caps->set_vfo)
            return -RIG_ENTARGET;
      curr_vfo = rig->state.current_vfo;
      retcode = caps->set_vfo(rig, vfo);
      if (retcode != RIG_OK)
            return retcode;

      retcode = caps->set_ant(rig, vfo, ant);
      caps->set_vfo(rig, curr_vfo);
      return retcode;
}

/**
 * \brief get the current antenna
 * \param rig     The rig handle
 * \param vfo     The target VFO
 * \param ant     The location where to store the current antenna
 *
 *  Retrieves the current antenna.
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 * \sa rig_set_ant()
 */

02194 int HAMLIB_API rig_get_ant(RIG *rig, vfo_t vfo, ant_t *ant)
{
      const struct rig_caps *caps;
      int retcode;
      vfo_t curr_vfo;

      if (CHECK_RIG_ARG(rig) || !ant)
            return -RIG_EINVAL;

      caps = rig->caps;

      if (caps->get_ant == NULL)
            return -RIG_ENAVAIL;

      if ((caps->targetable_vfo&RIG_TARGETABLE_PURE) || 
                  vfo == RIG_VFO_CURR || vfo == rig->state.current_vfo)
            return caps->get_ant(rig, vfo, ant);

      if (!caps->set_vfo)
            return -RIG_ENTARGET;
      curr_vfo = rig->state.current_vfo;
      retcode = caps->set_vfo(rig, vfo);
      if (retcode != RIG_OK)
            return retcode;

      retcode = caps->get_ant(rig, vfo, ant);
      caps->set_vfo(rig, curr_vfo);
      return retcode;
}



/**
 * \brief conversion utility from relative range to absolute in mW
 * \param rig     The rig handle
 * \param mwpower The location where to store the converted power in mW
 * \param power   The relative power
 * \param freq    The frequency where the conversion should take place
 * \param mode    The mode where the conversion should take place
 *
 *  Converts a power value expressed in a range on a [0.0 .. 1.0] relative 
 *  scale to the real transmit power in milli Watts the radio would emit.
 *  The \a freq and \a mode where the conversion should take place must be
 *  also provided since the relative power is peculiar to a specific
 *  freq and mode range of the radio.
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 * \sa rig_mW2power()
 */
02246 int HAMLIB_API rig_power2mW(RIG *rig, unsigned int *mwpower, float power, freq_t freq, rmode_t mode)
{
      const freq_range_t *txrange;

      if (!rig || !rig->caps || !mwpower || power<0.0 || power>1.0)
            return -RIG_EINVAL;

      if (rig->caps->power2mW != NULL)
            return rig->caps->power2mW(rig, mwpower, power, freq, mode);

      txrange = rig_get_range(rig->state.tx_range_list, freq, mode);
      if (!txrange) {
            /*
             * freq is not on the tx range!
             */
            return -RIG_ECONF; /* could be RIG_EINVAL ? */
      }
      *mwpower = (unsigned int)(power * txrange->high_power);
      return RIG_OK;
}

/**
 * \brief conversion utility from absolute in mW to relative range
 * \param rig     The rig handle
 * \param power   The location where to store the converted relative power
 * \param mwpower The power in mW
 * \param freq    The frequency where the conversion should take place
 * \param mode    The mode where the conversion should take place
 *
 * Converts a power value expressed in the real transmit power in milli Watts
 * the radio would emit to a range on a [0.0 .. 1.0] relative scale.
 * The \a freq and \a mode where the conversion should take place must be
 * also provided since the relative power is peculiar to a specific
 * freq and mode range of the radio.
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 * \sa rig_power2mW()
 */
02287 int HAMLIB_API rig_mW2power(RIG *rig, float *power, unsigned int mwpower, freq_t freq, rmode_t mode)
{
      const freq_range_t *txrange;

      if (!rig || !rig->caps || !power || mwpower==0)
            return -RIG_EINVAL;

      if (rig->caps->mW2power != NULL)
            return rig->caps->mW2power(rig, power, mwpower, freq, mode);

      txrange = rig_get_range(rig->state.tx_range_list, freq, mode);
      if (!txrange) {
            /*
             * freq is not on the tx range!
             */
            return -RIG_ECONF; /* could be RIG_EINVAL ? */
      }
      if (txrange->high_power == 0) {
            *power = 0.0;
            return RIG_OK;
      }
      *power = (float)mwpower / txrange->high_power;
      if (*power > 1.0)
            *power = 1.0;
      return (mwpower>txrange->high_power? RIG_OK : RIG_ETRUNC);
}

/**
 * \brief get the best frequency resolution of the rig
 * \param rig     The rig handle
 * \param mode    The mode where the conversion should take place
 *
 *  Returns the best frequency resolution of the rig, for a given \a mode.
 *
 * \return the frequency resolution in Hertz if the operation h
 * has been sucessful, otherwise a negative value if an error occured.
 *
 */
02325 shortfreq_t HAMLIB_API rig_get_resolution(RIG *rig, rmode_t mode)
{
      const struct rig_state *rs;
      int i;

      if (!rig || !rig->caps || !mode)
            return -RIG_EINVAL;

      rs = &rig->state;

      for (i=0; i<TSLSTSIZ && rs->tuning_steps[i].ts; i++) {
            if (rs->tuning_steps[i].modes & mode)
                  return rs->tuning_steps[i].ts;
      }

      return -RIG_EINVAL;
}


/**
 * \brief turn on/off the radio
 * \param rig     The rig handle
 * \param status  The status to set to
 *
 * turns on/off the radio.
 * See #RIG_POWER_ON, #RIG_POWER_OFF and #RIG_POWER_STANDBY defines
 * for the \a status.
 *
 * \return RIG_OK if the operation has been sucessful, ortherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 * \sa rig_get_powerstat()
 */

02360 int HAMLIB_API rig_set_powerstat(RIG *rig, powerstat_t status)
{
      if (CHECK_RIG_ARG(rig))
            return -RIG_EINVAL;

      if (rig->caps->set_powerstat == NULL)
            return -RIG_ENAVAIL;

      return rig->caps->set_powerstat(rig, status);
}

/**
 * \brief get the on/off status of the radio
 * \param rig     The rig handle
 * \param status  The locatation where to store the current status
 *
 *  Retrieve the status of the radio. See RIG_POWER_ON, RIG_POWER_OFF and 
 *  RIG_POWER_STANDBY defines for the \a status.
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 * \sa rig_set_powerstat()
 */

02386 int HAMLIB_API rig_get_powerstat(RIG *rig, powerstat_t *status)
{
      if (CHECK_RIG_ARG(rig) || !status)
            return -RIG_EINVAL;

      if (rig->caps->get_powerstat == NULL)
            return -RIG_ENAVAIL;

      return rig->caps->get_powerstat(rig, status);
}

/**
 * \brief reset the radio
 * \param rig     The rig handle
 * \param reset   The reset operation to perform
 *
 *  Resets the radio.
 *  See RIG_RESET_NONE, RIG_RESET_SOFT and RIG_RESET_MCALL defines
 *  for the \a reset.
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 */

02412 int HAMLIB_API rig_reset(RIG *rig, reset_t reset)
{
      if (CHECK_RIG_ARG(rig))
            return -RIG_EINVAL;

      if (rig->caps->reset == NULL)
            return -RIG_ENAVAIL;

      return rig->caps->reset(rig, reset);
}

extern int rig_probe_first(hamlib_port_t *p);
extern int rig_probe_all_backends(hamlib_port_t *p, rig_probe_func_t cfunc, rig_ptr_t data);
/**
 * \brief try to guess a rig
 * \param port          A pointer describing a port linking the host to the rig
 *
 *  Try to guess what is the model of the first rig attached to the port. 
 *  It can be very buggy, and mess up the radio at the other end.
 *  (but fun if it works!)
 *
 * \warning this is really Experimental, It has been tested only
 * with IC-706MkIIG. any feedback welcome! --SF
 *
 * \return the rig model id according to the rig_model_t type if found, 
 * otherwise RIG_MODEL_NONE if unable to determine rig model.
 */
02439 rig_model_t HAMLIB_API rig_probe(hamlib_port_t *port)
{
      if (!port)
            return RIG_MODEL_NONE;

      return rig_probe_first(port);
}

/**
 * \brief try to guess rigs
 * \param port    A pointer describing a port linking the host to the rigs
 * \param cfunc   Function to be called each time a rig is found
 * \param data    Arbitrary data passed to cfunc
 *
 *  Try to guess what are the model of all rigs attached to the port. 
 *  It can be very buggy, and mess up the radio at the other end.
 *  (but fun if it works!)
 *
 * \warning this is really Experimental, It has been tested only
 * with IC-706MkIIG. any feedback welcome! --SF
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 */
02464 int HAMLIB_API rig_probe_all(hamlib_port_t *port, rig_probe_func_t cfunc, rig_ptr_t data)
{
      if (!port)
            return -RIG_EINVAL;

      return rig_probe_all_backends(port, cfunc, data);
}

/**
 * \brief check retrieval ability of VFO operations
 * \param rig     The rig handle
 * \param op      The VFO op
 *
 *  Checks if a rig is capable of executing a VFO operation. 
 *  Since the \a op is an OR'ed bitmap argument, more than
 *  one op can be checked at the same time.
 *
 *    EXAMPLE: if (rig_has_vfo_op(my_rig, RIG_OP_CPY)) disp_VFOcpy_btn();
 *
 * \return a bit map mask of supported op settings that can be retrieved,
 * otherwise 0 if none supported.
 *
 * \sa rig_vfo_op()
 */
02488 vfo_op_t HAMLIB_API rig_has_vfo_op(RIG *rig, vfo_op_t op)
{
      if (!rig || !rig->caps)
            return 0;

      return (rig->caps->vfo_ops & op);
}

/**
 * \brief perform Memory/VFO operations
 * \param rig     The rig handle
 * \param vfo     The target VFO
 * \param op      The Memory/VFO operation to perform
 *
 *  Performs Memory/VFO operation.
 *  See #vfo_op_t for more information.
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 * \sa rig_has_vfo_op()
 */

02512 int HAMLIB_API rig_vfo_op(RIG *rig, vfo_t vfo, vfo_op_t op)
{
      const struct rig_caps *caps;
      int retcode;
      vfo_t curr_vfo;

      if (CHECK_RIG_ARG(rig))
            return -RIG_EINVAL;

      caps = rig->caps;

      if (caps->vfo_op == NULL || !rig_has_vfo_op(rig,op))
            return -RIG_ENAVAIL;

      if ((caps->targetable_vfo&RIG_TARGETABLE_PURE) ||
                  vfo == RIG_VFO_CURR || vfo == rig->state.current_vfo)
            return caps->vfo_op(rig, vfo, op);

      if (!caps->set_vfo)
            return -RIG_ENTARGET;
      curr_vfo = rig->state.current_vfo;
      retcode = caps->set_vfo(rig, vfo);
      if (retcode != RIG_OK)
            return retcode;

      retcode = caps->vfo_op(rig, vfo, op);
      caps->set_vfo(rig, curr_vfo);
      return retcode;
}

/**
 * \brief check availability of scaning functions
 * \param rig     The rig handle
 * \param scan    The scan op
 *
 *  Checks if a rig is capable of performing a scan operation. 
 *  Since the \a scan parameter is an OR'ed bitmap argument, more than
 *  one op can be checked at the same time.
 *
 *    EXAMPLE: if (rig_has_scan(my_rig, RIG_SCAN_PRIO)) disp_SCANprio_btn();
 *
 * \return a bit map of supported scan settings that can be retrieved,
 * otherwise 0 if none supported.
 *
 * \sa rig_scan()
 */
02558 scan_t HAMLIB_API rig_has_scan(RIG *rig, scan_t scan)
{
      if (!rig || !rig->caps)
            return 0;

      return (rig->caps->scan_ops & scan);
}

/**
 * \brief perform Memory/VFO operations
 * \param rig     The rig handle
 * \param vfo     The target VFO
 * \param scan    The scanning operation to perform
 * \param ch      Optional channel argument used for the scan.
 *
 *  Performs scanning operation.
 *  See #scan_t for more information.
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 * \sa rig_has_scan()
 */

02583 int HAMLIB_API rig_scan(RIG *rig, vfo_t vfo, scan_t scan, int ch)
{
      const struct rig_caps *caps;
      int retcode;
      vfo_t curr_vfo;

      if (CHECK_RIG_ARG(rig))
            return -RIG_EINVAL;

      caps = rig->caps;

      if (caps->scan == NULL || 
                  (scan!=RIG_SCAN_STOP && !rig_has_scan(rig, scan)))
            return -RIG_ENAVAIL;

      if ((caps->targetable_vfo&RIG_TARGETABLE_PURE) ||
                  vfo == RIG_VFO_CURR || vfo == rig->state.current_vfo)
            return caps->scan(rig, vfo, scan, ch);

      if (!caps->set_vfo)
            return -RIG_ENTARGET;
      curr_vfo = rig->state.current_vfo;
      retcode = caps->set_vfo(rig, vfo);
      if (retcode != RIG_OK)
            return retcode;

      retcode = caps->scan(rig, vfo, scan, ch);
      caps->set_vfo(rig, curr_vfo);
      return retcode;
}

/**
 * \brief send DTMF digits
 * \param rig     The rig handle
 * \param vfo     The target VFO
 * \param digits  Digits to be send
 *
 *  Sends DTMF digits.
 *  See DTMF change speed, etc. (TODO).
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 */

02629 int HAMLIB_API rig_send_dtmf(RIG *rig, vfo_t vfo, const char *digits)
{
      const struct rig_caps *caps;
      int retcode;
      vfo_t curr_vfo;

      if (CHECK_RIG_ARG(rig) || !digits)
            return -RIG_EINVAL;

      caps = rig->caps;

      if (caps->send_dtmf == NULL)
            return -RIG_ENAVAIL;

      if ((caps->targetable_vfo&RIG_TARGETABLE_PURE) ||
                  vfo == RIG_VFO_CURR || vfo == rig->state.current_vfo)
            return caps->send_dtmf(rig, vfo, digits);

      if (!caps->set_vfo)
            return -RIG_ENTARGET;
      curr_vfo = rig->state.current_vfo;
      retcode = caps->set_vfo(rig, vfo);
      if (retcode != RIG_OK)
            return retcode;

      retcode = caps->send_dtmf(rig, vfo, digits);
      caps->set_vfo(rig, curr_vfo);
      return retcode;
}

/**
 * \brief receive DTMF digits
 * \param rig     The rig handle
 * \param vfo     The target VFO
 * \param digits  Location where the digits are to be stored 
 * \param length  in: max length of buffer, out: number really read.
 *
 *  Receives DTMF digits (not blocking).
 *  See DTMF change speed, etc. (TODO).
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 */

02675 int HAMLIB_API rig_recv_dtmf(RIG *rig, vfo_t vfo, char *digits, int *length)
{
      const struct rig_caps *caps;
      int retcode;
      vfo_t curr_vfo;

      if (CHECK_RIG_ARG(rig) || !digits || !length)
            return -RIG_EINVAL;

      caps = rig->caps;

      if (caps->recv_dtmf == NULL)
            return -RIG_ENAVAIL;

      if ((caps->targetable_vfo&RIG_TARGETABLE_PURE) ||
                  vfo == RIG_VFO_CURR || vfo == rig->state.current_vfo)
            return caps->recv_dtmf(rig, vfo, digits, length);

      if (!caps->set_vfo)
            return -RIG_ENTARGET;
      curr_vfo = rig->state.current_vfo;
      retcode = caps->set_vfo(rig, vfo);
      if (retcode != RIG_OK)
            return retcode;

      retcode = caps->recv_dtmf(rig, vfo, digits, length);
      caps->set_vfo(rig, curr_vfo);
      return retcode;
}

/**
 * \brief send morse code
 * \param rig     The rig handle
 * \param vfo     The target VFO
 * \param msg     Message to be sent
 *
 *  Sends morse message.
 *  See keyer change speed, etc. (TODO).
 *
 * \return RIG_OK if the operation has been sucessful, otherwise 
 * a negative value if an error occured (in which case, cause is 
 * set appropriately).
 *
 */

02720 int HAMLIB_API rig_send_morse(RIG *rig, vfo_t vfo, const char *msg)
{
      const struct rig_caps *caps;
      int retcode;
      vfo_t curr_vfo;

      if (CHECK_RIG_ARG(rig) || !msg)
            return -RIG_EINVAL;

      caps = rig->caps;

      if (caps->send_morse == NULL)
            return -RIG_ENAVAIL;

      if ((caps->targetable_vfo&RIG_TARGETABLE_PURE) ||
                  vfo == RIG_VFO_CURR || vfo == rig->state.current_vfo)
            return caps->send_morse(rig, vfo, msg);

      if (!caps->set_vfo)
            return -RIG_ENTARGET;
      curr_vfo = rig->state.current_vfo;
      retcode = caps->set_vfo(rig, vfo);
      if (retcode != RIG_OK)
            return retcode;

      retcode = caps->send_morse(rig, vfo, msg);
      caps->set_vfo(rig, curr_vfo);
      return retcode;
}


/**
 * \brief find the freq_range of freq/mode
 * \param range_list    The range list to search from
 * \param freq    The frequency that will be part of this range
 * \param mode    The mode that will be part of this range
 *
 *  Returns a pointer to the #freq_range_t including \a freq and \a mode.
 *  Works for rx and tx range list as well.
 *
 * \return the location of the #freq_range_t if found,
 * otherwise NULL if not found or if \a range_list is invalid.
 *
 */
const freq_range_t *
02765 HAMLIB_API rig_get_range(const freq_range_t range_list[], freq_t freq, rmode_t mode)
{
      int i;

      for (i=0; i<FRQRANGESIZ; i++) {
            if (range_list[i].start == 0 && range_list[i].end == 0) {
                  return NULL;
            }
            if (freq >= range_list[i].start && freq <= range_list[i].end &&
                        (range_list[i].modes & mode)) {
                  return &range_list[i];
            }
      }
      return NULL;
}


/**
 * \brief get general information from the radio
 * \param rig     The rig handle
 *
 * Retrieves some general information from the radio.
 * This can include firmware revision, exact model name, or just nothing. 
 *
 * \return a pointer to freshly allocated memory containing the ASCIIZ string 
 * if the operation has been sucessful, otherwise NULL if an error occured
 * or get_info not part of capabilities.
 */
02793 const char* HAMLIB_API rig_get_info(RIG *rig)
{
      if (CHECK_RIG_ARG(rig))
            return NULL;

      if (rig->caps->get_info == NULL)
            return NULL;

      return rig->caps->get_info(rig);
}

/*! @} */

Generated by  Doxygen 1.6.0   Back to index