Main Page | Data Structures | Directories | File List | Data Fields | Globals | Related Pages | Examples

rig.h

Go to the documentation of this file.
00001 /*
00002  *  Hamlib Interface - API header
00003  *  Copyright (c) 2000-2005 by Stephane Fillod and Frank Singleton
00004  *
00005  *      $Id: rig.h,v 1.110 2006/01/15 14:23:16 fillods Exp $
00006  *
00007  *   This library is free software; you can redistribute it and/or modify
00008  *   it under the terms of the GNU Library General Public License as
00009  *   published by the Free Software Foundation; either version 2 of
00010  *   the License, or (at your option) any later version.
00011  *
00012  *   This program is distributed in the hope that it will be useful,
00013  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  *   GNU Library General Public License for more details.
00016  *
00017  *   You should have received a copy of the GNU Library General Public
00018  *   License along with this library; if not, write to the Free Software
00019  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
00020  *
00021  */
00022 
00023 #ifndef _RIG_H
00024 #define _RIG_H 1
00025 
00026 #include <stdio.h>
00027 #include <stdarg.h>
00028 
00029 #include <hamlib/riglist.h>     /* list in another file to not mess up w/ this one */
00030 
00040 /* __BEGIN_DECLS should be used at the beginning of your declarations,
00041  * so that C++ compilers don't mangle their names.  Use __END_DECLS at
00042  * the end of C declarations. */
00043 #undef __BEGIN_DECLS
00044 #undef __END_DECLS
00045 #ifdef __cplusplus
00046 # define __BEGIN_DECLS extern "C" {
00047 # define __END_DECLS }
00048 #else
00049 # define __BEGIN_DECLS          /* empty */
00050 # define __END_DECLS            /* empty */
00051 #endif
00052 
00053 /* HAMLIB_PARAMS is a macro used to wrap function prototypes, so that compilers
00054  * that don't understand ANSI C prototypes still work, and ANSI C
00055  * compilers can issue warnings about type mismatches. */
00056 #undef HAMLIB_PARAMS
00057 #if defined (__STDC__) || defined (_AIX) || (defined (__mips) && defined (_SYSTYPE_SVR4)) || defined(__CYGWIN__) || defined(_WIN32) || defined(__cplusplus)
00058 # define HAMLIB_PARAMS(protos) protos
00059 # define rig_ptr_t     void*
00060 #else
00061 # define HAMLIB_PARAMS(protos) ()
00062 # define rig_ptr_t     char*
00063 #endif
00064 
00065 #include <hamlib/rig_dll.h>
00066 
00067 
00068 __BEGIN_DECLS
00069 
00070 extern HAMLIB_EXPORT_VAR(const char) hamlib_version[];
00071 extern HAMLIB_EXPORT_VAR(const char) hamlib_copyright[];
00072 
00077 enum rig_errcode_e {
00078         RIG_OK=0,               /*<! No error, operation completed sucessfully */
00079         RIG_EINVAL,             /*<! invalid parameter */
00080         RIG_ECONF,              /*<! invalid configuration (serial,..) */
00081         RIG_ENOMEM,             /*<! memory shortage */
00082         RIG_ENIMPL,             /*<! function not implemented, but will be */
00083         RIG_ETIMEOUT,           /*<! communication timed out */
00084         RIG_EIO,                /*<! IO error, including open failed */
00085         RIG_EINTERNAL,          /*<! Internal Hamlib error, huh! */
00086         RIG_EPROTO,             /*<! Protocol error */
00087         RIG_ERJCTED,            /*<! Command rejected by the rig */
00088         RIG_ETRUNC,             /*<! Command performed, but arg truncated */
00089         RIG_ENAVAIL,            /*<! function not available */
00090         RIG_ENTARGET,           /*<! VFO not targetable */
00091         RIG_BUSERROR,           /*<! Error talking on the bus */
00092         RIG_BUSBUSY,            /*<! Collision on the bus */
00093         RIG_EARG,               /*<! NULL RIG handle or any invalid pointer parameter in get arg */
00094         RIG_EVFO,               /*<! Invalid VFO */
00095         RIG_EDOM                /*<! Argument out of domain of func */
00096 };
00097 
00105 enum rig_debug_level_e {
00106   RIG_DEBUG_NONE = 0,           /*<! no bug reporting */
00107   RIG_DEBUG_BUG,                /*<! serious bug */
00108   RIG_DEBUG_ERR,                /*<! error case (e.g. protocol, memory allocation) */
00109   RIG_DEBUG_WARN,               /*<! warning */
00110   RIG_DEBUG_VERBOSE,            /*<! verbose */
00111   RIG_DEBUG_TRACE               /*<! tracing */
00112 };
00113 
00114 /* --------------- Rig capabilities -----------------*/
00115 
00116 /* Forward struct references */
00117 
00118 struct rig;
00119 struct rig_state;
00120 
00124 typedef struct rig RIG;
00125 
00126 #define RIGNAMSIZ 30
00127 #define RIGVERSIZ 8
00128 #define FILPATHLEN 100
00129 #define FRQRANGESIZ 30
00130 #define MAXCHANDESC 30          /* describe channel eg: "WWV 5Mhz" */
00131 #define TSLSTSIZ 20             /* max tuning step list size, zero ended */
00132 #define FLTLSTSIZ 42            /* max mode/filter list size, zero ended */
00133 #define MAXDBLSTSIZ 8           /* max preamp/att levels supported, zero ended */
00134 #define CHANLSTSIZ 16           /* max mem_list size, zero ended */
00135 #define MAX_CAL_LENGTH 32       /* max calibration plots in cal_table_t */
00136 
00137 
00148 typedef unsigned int tone_t;
00149 
00153 typedef enum rig_port_e {
00154   RIG_PORT_NONE = 0,            
00155   RIG_PORT_SERIAL,              
00156   RIG_PORT_NETWORK,             
00157   RIG_PORT_DEVICE,              
00158   RIG_PORT_PACKET,              
00159   RIG_PORT_DTMF,                
00160   RIG_PORT_ULTRA,               
00161   RIG_PORT_RPC,                 
00162   RIG_PORT_PARALLEL,            
00163   RIG_PORT_USB                  
00164 } rig_port_t;
00165 
00169 enum serial_parity_e {
00170   RIG_PARITY_NONE = 0,          
00171   RIG_PARITY_ODD,               
00172   RIG_PARITY_EVEN               
00173 };
00174 
00178 enum serial_handshake_e {
00179   RIG_HANDSHAKE_NONE = 0,       
00180   RIG_HANDSHAKE_XONXOFF,        
00181   RIG_HANDSHAKE_HARDWARE        
00182 };
00183 
00184 
00188 enum serial_control_state_e {
00189   RIG_SIGNAL_UNSET = 0, 
00190   RIG_SIGNAL_ON,        
00191   RIG_SIGNAL_OFF        
00192 };
00193 
00195 typedef enum {
00196         RIG_FLAG_RECEIVER =     (1<<1),         
00197         RIG_FLAG_TRANSMITTER =  (1<<2),         
00198         RIG_FLAG_SCANNER =      (1<<3),         
00200         RIG_FLAG_MOBILE =       (1<<4),         
00201         RIG_FLAG_HANDHELD =     (1<<5),         
00202         RIG_FLAG_COMPUTER =     (1<<6),         
00203         RIG_FLAG_TRUNKING =     (1<<7),         
00204         RIG_FLAG_APRS =         (1<<8),         
00205         RIG_FLAG_TNC =          (1<<9),         
00206         RIG_FLAG_DXCLUSTER =    (1<<10),        
00207         RIG_FLAG_TUNER =        (1<<11)         
00208 } rig_type_t;
00209 
00210 #define RIG_FLAG_TRANSCEIVER (RIG_FLAG_RECEIVER|RIG_FLAG_TRANSMITTER)
00211 #define RIG_TYPE_MASK (RIG_FLAG_TRANSCEIVER|RIG_FLAG_SCANNER|RIG_FLAG_MOBILE|RIG_FLAG_HANDHELD|RIG_FLAG_COMPUTER|RIG_FLAG_TRUNKING|RIG_FLAG_TUNER)
00212 
00213 #define RIG_TYPE_OTHER          0
00214 #define RIG_TYPE_TRANSCEIVER    RIG_FLAG_TRANSCEIVER
00215 #define RIG_TYPE_HANDHELD       (RIG_FLAG_TRANSCEIVER|RIG_FLAG_HANDHELD)
00216 #define RIG_TYPE_MOBILE         (RIG_FLAG_TRANSCEIVER|RIG_FLAG_MOBILE)
00217 #define RIG_TYPE_RECEIVER       RIG_FLAG_RECEIVER
00218 #define RIG_TYPE_PCRECEIVER     (RIG_FLAG_COMPUTER|RIG_FLAG_RECEIVER)
00219 #define RIG_TYPE_SCANNER        (RIG_FLAG_SCANNER|RIG_FLAG_RECEIVER)
00220 #define RIG_TYPE_TRUNKSCANNER   (RIG_TYPE_SCANNER|RIG_FLAG_TRUNKING)
00221 #define RIG_TYPE_COMPUTER       (RIG_FLAG_TRANSCEIVER|RIG_FLAG_COMPUTER)
00222 #define RIG_TYPE_TUNER          RIG_FLAG_TUNER
00223 
00224 
00228 enum rig_status_e {
00229   RIG_STATUS_ALPHA = 0,         
00230   RIG_STATUS_UNTESTED,          
00231   RIG_STATUS_BETA,              
00232   RIG_STATUS_STABLE,            
00233   RIG_STATUS_BUGGY,             
00234   RIG_STATUS_NEW                
00235 };
00236 
00240 typedef enum {
00241   RIG_RPT_SHIFT_NONE = 0,       
00242   RIG_RPT_SHIFT_MINUS,          
00243   RIG_RPT_SHIFT_PLUS            
00244 } rptr_shift_t;
00245 
00249 typedef enum {
00250   RIG_SPLIT_OFF = 0,            
00251   RIG_SPLIT_ON                  
00252 } split_t;
00253 
00258 typedef double freq_t;
00260 #define PRIfreq "f"
00261 
00262 #define SCNfreq "lf"
00263 #define FREQFMT SCNfreq
00264 
00269 typedef signed long shortfreq_t;
00270 
00271 #define Hz(f)   ((freq_t)(f))
00272 #define kHz(f)  ((freq_t)((f)*(freq_t)1000))
00273 #define MHz(f)  ((freq_t)((f)*(freq_t)1000000))
00274 #define GHz(f)  ((freq_t)((f)*(freq_t)1000000000))
00275 
00276 #define s_Hz(f)         ((shortfreq_t)(f))
00277 #define s_kHz(f)        ((shortfreq_t)((f)*(shortfreq_t)1000))
00278 #define s_MHz(f)        ((shortfreq_t)((f)*(shortfreq_t)1000000))
00279 #define s_GHz(f)        ((shortfreq_t)((f)*(shortfreq_t)1000000000))
00280 
00281 #define RIG_FREQ_NONE Hz(0)
00282 
00283 
00298 typedef int vfo_t;
00299 
00301 #define RIG_VFO_NONE    0
00302 
00303 #define RIG_VFO_TX_FLAG    ((vfo_t)(1<<30))
00304 
00306 #define RIG_VFO_CURR    ((vfo_t)(1<<29))
00307 
00309 #define RIG_VFO_MEM     ((vfo_t)(1<<28))
00310 
00312 #define RIG_VFO_VFO     ((vfo_t)(1<<27))
00313 
00314 #define RIG_VFO_TX_VFO(v)       ((v)|RIG_VFO_TX_FLAG)
00315 
00317 #define RIG_VFO_TX      RIG_VFO_TX_VFO(RIG_VFO_CURR)
00318 
00320 #define RIG_VFO_RX      RIG_VFO_CURR
00321 
00323 #define RIG_VFO_MAIN    ((vfo_t)(1<<26))
00324 
00325 #define RIG_VFO_SUB     ((vfo_t)(1<<25))
00326 
00327 #define RIG_VFO_N(n) ((vfo_t)(1<<(n)))
00328 
00330 #define RIG_VFO_A RIG_VFO_N(0)
00331 
00332 #define RIG_VFO_B RIG_VFO_N(1)
00333 
00334 #define RIG_VFO_C RIG_VFO_N(2)
00335 
00336 
00337 /*
00338  * targetable bitfields, for internal use.
00339  * RIG_TARGETABLE_PURE means a pure targetable radio on every command
00340  */
00341 #define RIG_TARGETABLE_NONE 0
00342 #define RIG_TARGETABLE_FREQ (1<<0)
00343 #define RIG_TARGETABLE_MODE (1<<1)
00344 #define RIG_TARGETABLE_PURE (1<<2)
00345 #define RIG_TARGETABLE_ALL  0x7fffffff
00346 
00347 
00348 #define RIG_PASSBAND_NORMAL s_Hz(0)
00349 
00353 typedef shortfreq_t pbwidth_t;
00354 
00355 
00359 typedef enum dcd_e {
00360   RIG_DCD_OFF = 0,              
00361   RIG_DCD_ON                    
00362 } dcd_t;
00363 
00368 typedef enum {
00369   RIG_DCD_NONE = 0,             
00370   RIG_DCD_RIG,                  
00371   RIG_DCD_SERIAL_DSR,           
00372   RIG_DCD_SERIAL_CTS,           
00373   RIG_DCD_SERIAL_CAR,           
00374   RIG_DCD_PARALLEL              
00375 } dcd_type_t;
00376 
00377 
00381 typedef enum {
00382   RIG_PTT_OFF = 0,              
00383   RIG_PTT_ON                    
00384 } ptt_t;
00385 
00390 typedef enum {
00391   RIG_PTT_NONE = 0,             
00392   RIG_PTT_RIG,                  
00393   RIG_PTT_SERIAL_DTR,           
00394   RIG_PTT_SERIAL_RTS,           
00395   RIG_PTT_PARALLEL              
00396 } ptt_type_t;
00397 
00401 typedef enum {
00402   RIG_POWER_OFF =       0,              
00403   RIG_POWER_ON =        (1<<0),         
00404   RIG_POWER_STANDBY =   (1<<1)          
00405 } powerstat_t;
00406 
00410 typedef enum {
00411   RIG_RESET_NONE =       0,             
00412   RIG_RESET_SOFT =      (1<<0),         
00413   RIG_RESET_VFO =       (1<<1),         
00414   RIG_RESET_MCALL =     (1<<2),         
00415   RIG_RESET_MASTER =    (1<<3)          
00416 } reset_t;
00417 
00418 
00430 typedef enum {
00431         RIG_OP_NONE =           0,
00432         RIG_OP_CPY =            (1<<0), 
00433         RIG_OP_XCHG =           (1<<1), 
00434         RIG_OP_FROM_VFO =       (1<<2), 
00435         RIG_OP_TO_VFO =         (1<<3), 
00436         RIG_OP_MCL =            (1<<4), 
00437         RIG_OP_UP =             (1<<5), 
00438         RIG_OP_DOWN =           (1<<6), 
00439         RIG_OP_BAND_UP =        (1<<7), 
00440         RIG_OP_BAND_DOWN =      (1<<8), 
00441         RIG_OP_LEFT =           (1<<9), 
00442         RIG_OP_RIGHT =          (1<<10),
00443         RIG_OP_TUNE =           (1<<11),
00444         RIG_OP_TOGGLE =         (1<<12) 
00445 } vfo_op_t;
00446 
00447 
00451 typedef enum {
00452         RIG_SCAN_NONE =         0,
00453         RIG_SCAN_STOP =         RIG_SCAN_NONE, 
00454         RIG_SCAN_MEM =          (1<<0), 
00455         RIG_SCAN_SLCT =         (1<<1), 
00456         RIG_SCAN_PRIO =         (1<<2), 
00457         RIG_SCAN_PROG =         (1<<3), 
00458         RIG_SCAN_DELTA =        (1<<4), 
00459         RIG_SCAN_VFO =          (1<<5), 
00460         RIG_SCAN_PLT =          (1<<6)  
00461 } scan_t;
00462 
00466 typedef long token_t;
00467 
00468 #define RIG_CONF_END 0
00469 
00470 /*
00471  * strongly inspired from soundmedem. Thanks Thomas!
00472  */
00473 enum rig_conf_e {
00474         RIG_CONF_STRING,        
00475         RIG_CONF_COMBO,         
00476         RIG_CONF_NUMERIC,       
00477         RIG_CONF_CHECKBUTTON    
00478 };
00479 
00480 #define RIG_COMBO_MAX   8
00481 
00485 struct confparams {
00486   token_t token;                
00487   const char *name;             
00488   const char *label;            
00489   const char *tooltip;          
00490   const char *dflt;             
00491   enum rig_conf_e type;         
00492   union {                       
00493         struct {                
00494                 float min;      
00495                 float max;      
00496                 float step;     
00497         } n;                    
00498         struct {                
00499                 const char *combostr[RIG_COMBO_MAX];    
00500         } c;                    
00501   } u;                          
00502 };
00503 
00507 typedef enum {
00508         RIG_ANN_NONE =  0,              
00509         RIG_ANN_OFF =   RIG_ANN_NONE,   
00510         RIG_ANN_FREQ =  (1<<0),         
00511         RIG_ANN_RXMODE = (1<<1),        
00512         RIG_ANN_CW = (1<<2),            
00513         RIG_ANN_ENG = (1<<3),           
00514         RIG_ANN_JAP = (1<<4)            
00515 } ann_t;
00516 
00517 
00518 /* Antenna number */
00519 typedef int ant_t;
00520 
00521 #define RIG_ANT_NONE    0
00522 #define RIG_ANT_N(n)    ((ant_t)1<<(n))
00523 #define RIG_ANT_1       RIG_ANT_N(0)
00524 #define RIG_ANT_2       RIG_ANT_N(1)
00525 #define RIG_ANT_3       RIG_ANT_N(2)
00526 #define RIG_ANT_4       RIG_ANT_N(3)
00527 
00528 
00529 /* TODO: kill me, and replace by real AGC delay */
00530 enum agc_level_e {
00531         RIG_AGC_OFF = 0,
00532         RIG_AGC_SUPERFAST,
00533         RIG_AGC_FAST,
00534         RIG_AGC_SLOW,
00535         RIG_AGC_USER,           
00536         RIG_AGC_MEDIUM
00537 };
00538 
00542 enum meter_level_e {
00543   RIG_METER_NONE =      0,              /*< No display meter */
00544   RIG_METER_SWR =       (1<<0),         /*< Stationary Wave Ratio */
00545   RIG_METER_COMP =      (1<<1),         /*< Compression level */
00546   RIG_METER_ALC =       (1<<2),         /*< ALC */
00547   RIG_METER_IC =        (1<<3),         /*< IC */
00548   RIG_METER_DB =        (1<<4)          /*< DB */
00549 };
00550 
00555 typedef union {
00556   signed int i;                 
00557   float f;                      
00558   char *s;                      
00559   const char *cs;               
00560 } value_t;
00561 
00563 enum rig_level_e {
00564         RIG_LEVEL_NONE =        0,      
00565         RIG_LEVEL_PREAMP =      (1<<0), 
00566         RIG_LEVEL_ATT =         (1<<1), 
00567         RIG_LEVEL_VOX =         (1<<2), 
00568         RIG_LEVEL_AF =          (1<<3), 
00569         RIG_LEVEL_RF =          (1<<4), 
00570         RIG_LEVEL_SQL =         (1<<5), 
00571         RIG_LEVEL_IF =          (1<<6), 
00572         RIG_LEVEL_APF =         (1<<7), 
00573         RIG_LEVEL_NR =          (1<<8), 
00574         RIG_LEVEL_PBT_IN =      (1<<9), 
00575         RIG_LEVEL_PBT_OUT =     (1<<10),
00576         RIG_LEVEL_CWPITCH =     (1<<11),
00577         RIG_LEVEL_RFPOWER =     (1<<12),
00578         RIG_LEVEL_MICGAIN =     (1<<13),
00579         RIG_LEVEL_KEYSPD =      (1<<14),
00580         RIG_LEVEL_NOTCHF =      (1<<15),
00581         RIG_LEVEL_COMP =        (1<<16),
00582         RIG_LEVEL_AGC =         (1<<17),
00583         RIG_LEVEL_BKINDL =      (1<<18),
00584         RIG_LEVEL_BALANCE =     (1<<19),
00585         RIG_LEVEL_METER =       (1<<20),
00587         RIG_LEVEL_VOXGAIN =     (1<<21),
00588         RIG_LEVEL_VOXDELAY =  RIG_LEVEL_VOX,    
00589         RIG_LEVEL_ANTIVOX =     (1<<22),
00590         //RIG_LEVEL_LINEOUT =   (1<<23),/*!< Lineout Volume, arg float [0.0 .. 1.0] */
00591 
00593         RIG_LEVEL_RAWSTR =      (1<<26),
00594         RIG_LEVEL_SQLSTAT =     (1<<27),
00595         RIG_LEVEL_SWR =         (1<<28),
00596         RIG_LEVEL_ALC =         (1<<29),
00597         RIG_LEVEL_STRENGTH =    (1<<30) 
00598         /*RIG_LEVEL_BWC =               (1<<31)*/ 
00599 };
00600 
00601 #define RIG_LEVEL_FLOAT_LIST (RIG_LEVEL_AF|RIG_LEVEL_RF|RIG_LEVEL_SQL|RIG_LEVEL_APF|RIG_LEVEL_NR|RIG_LEVEL_PBT_IN|RIG_LEVEL_PBT_OUT|RIG_LEVEL_RFPOWER|RIG_LEVEL_MICGAIN|RIG_LEVEL_COMP|RIG_LEVEL_BALANCE|RIG_LEVEL_SWR|RIG_LEVEL_ALC|RIG_LEVEL_VOXGAIN|RIG_LEVEL_ANTIVOX)
00602 
00603 #define RIG_LEVEL_READONLY_LIST (RIG_LEVEL_SQLSTAT|RIG_LEVEL_SWR|RIG_LEVEL_ALC|RIG_LEVEL_STRENGTH|RIG_LEVEL_RAWSTR)
00604 
00605 #define RIG_LEVEL_IS_FLOAT(l) ((l)&RIG_LEVEL_FLOAT_LIST)
00606 #define RIG_LEVEL_SET(l) ((l)&~RIG_LEVEL_READONLY_LIST)
00607 
00608 
00613 enum rig_parm_e {
00614         RIG_PARM_NONE =         0,      
00615         RIG_PARM_ANN =          (1<<0), 
00616         RIG_PARM_APO =          (1<<1), 
00617         RIG_PARM_BACKLIGHT =    (1<<2), 
00618         RIG_PARM_BEEP =         (1<<4), 
00619         RIG_PARM_TIME =         (1<<5), 
00620         RIG_PARM_BAT =          (1<<6), 
00621         RIG_PARM_KEYLIGHT =     (1<<7)  
00622 };
00623 
00624 #define RIG_PARM_FLOAT_LIST (RIG_PARM_BACKLIGHT|RIG_PARM_BAT)
00625 #define RIG_PARM_READONLY_LIST (RIG_PARM_BAT)
00626 
00627 #define RIG_PARM_IS_FLOAT(l) ((l)&RIG_PARM_FLOAT_LIST)
00628 #define RIG_PARM_SET(l) ((l)&~RIG_PARM_READONLY_LIST)
00629 
00630 #define RIG_SETTING_MAX 64
00631 
00637 typedef unsigned long setting_t;
00638 
00639 /*
00640  * tranceive mode, ie. the rig notify the host of any event,
00641  * like freq changed, mode changed, etc.
00642  */
00643 #define RIG_TRN_OFF 0
00644 #define RIG_TRN_RIG 1
00645 #define RIG_TRN_POLL 2
00646 
00647 
00651 enum rig_func_e {
00652         RIG_FUNC_NONE =         0,      
00653         RIG_FUNC_FAGC =         (1<<0), 
00654         RIG_FUNC_NB =           (1<<1), 
00655         RIG_FUNC_COMP =         (1<<2), 
00656         RIG_FUNC_VOX =          (1<<3), 
00657         RIG_FUNC_TONE =         (1<<4), 
00658         RIG_FUNC_TSQL =         (1<<5), 
00659         RIG_FUNC_SBKIN =        (1<<6), 
00660         RIG_FUNC_FBKIN =        (1<<7), 
00661         RIG_FUNC_ANF =          (1<<8), 
00662         RIG_FUNC_NR =           (1<<9), 
00663         RIG_FUNC_AIP =          (1<<10),
00664         RIG_FUNC_APF =          (1<<11),
00665         RIG_FUNC_MON =          (1<<12),
00666         RIG_FUNC_MN =           (1<<13),
00667         RIG_FUNC_RNF =          (1<<14),
00668         RIG_FUNC_ARO =          (1<<15),
00669         RIG_FUNC_LOCK =         (1<<16),
00670         RIG_FUNC_MUTE =         (1<<17),
00671         RIG_FUNC_VSC =          (1<<18),
00672         RIG_FUNC_REV =          (1<<19),
00673         RIG_FUNC_SQL =          (1<<20),
00674         RIG_FUNC_ABM =          (1<<21),
00675         RIG_FUNC_BC =           (1<<22),
00676         RIG_FUNC_MBC =          (1<<23),
00677         /*                      (1<<24), used to be RIG_FUNC_LMP, see RIG_PARM_BACKLIGHT instead) */
00678         RIG_FUNC_AFC =          (1<<25),
00679         RIG_FUNC_SATMODE =      (1<<26),
00680         RIG_FUNC_SCOPE =        (1<<27),
00681         RIG_FUNC_RESUME =       (1<<28),
00682         RIG_FUNC_TBURST =       (1<<29),
00683         RIG_FUNC_TUNER =        (1<<30) 
00684 };
00685 
00686 /*
00687  * power unit macros, converts to mW
00688  * This is limited to 2MW on 32 bits systems.
00689  */
00690 #define mW(p)    ((int)(p))
00691 #define Watts(p) ((int)((p)*1000))
00692 #define W(p)     Watts(p)
00693 #define kW(p)    ((int)((p)*1000000L))
00694 
00698 typedef enum {
00699         RIG_MODE_NONE =         0,      
00700         RIG_MODE_AM =           (1<<0), 
00701         RIG_MODE_CW =           (1<<1), 
00702         RIG_MODE_USB =          (1<<2), 
00703         RIG_MODE_LSB =          (1<<3), 
00704         RIG_MODE_RTTY =         (1<<4), 
00705         RIG_MODE_FM =           (1<<5), 
00706         RIG_MODE_WFM =          (1<<6), 
00707         RIG_MODE_CWR =          (1<<7), 
00708         RIG_MODE_RTTYR =        (1<<8), 
00709         RIG_MODE_AMS =          (1<<9), 
00710         RIG_MODE_PKTLSB =       (1<<10),
00711         RIG_MODE_PKTUSB =       (1<<11),
00712         RIG_MODE_PKTFM =        (1<<12),
00713         RIG_MODE_ECSSUSB =      (1<<13),
00714         RIG_MODE_ECSSLSB =      (1<<14),
00715         RIG_MODE_FAX =          (1<<15) 
00717 } rmode_t;
00718 
00720 #define RIG_MODE_SSB    (RIG_MODE_USB|RIG_MODE_LSB)
00721 
00723 #define RIG_MODE_ECSS   (RIG_MODE_ECSSUSB|RIG_MODE_ECSSLSB)
00724 
00725 
00726 #define RIG_DBLST_END 0         /* end marker in a preamp/att level list */
00727 #define RIG_IS_DBLST_END(d) ((d)==0)
00728 
00735 typedef struct freq_range_list {
00736   freq_t start;         
00737   freq_t end;           
00738   rmode_t modes;        
00739   int low_power;        
00740   int high_power;       
00741   vfo_t vfo;            
00742   ant_t ant;            
00743 } freq_range_t;
00744 
00745 #define RIG_FRNG_END     {Hz(0),Hz(0),RIG_MODE_NONE,0,0,RIG_VFO_NONE}
00746 #define RIG_IS_FRNG_END(r) ((r).start == Hz(0) && (r).end == Hz(0))
00747 
00748 #define RIG_ITU_REGION1 1
00749 #define RIG_ITU_REGION2 2
00750 #define RIG_ITU_REGION3 3
00751 
00771 struct tuning_step_list {
00772   rmode_t modes;        
00773   shortfreq_t ts;       
00774 };
00775 
00776 #define RIG_TS_ANY     0
00777 #define RIG_TS_END     {RIG_MODE_NONE,0}
00778 #define RIG_IS_TS_END(t)        ((t).modes == RIG_MODE_NONE && (t).ts == 0)
00779 
00806 struct filter_list {
00807   rmode_t modes;        
00808   pbwidth_t width;      
00809 };
00810 
00811 #define RIG_FLT_ANY     0
00812 #define RIG_FLT_END     {RIG_MODE_NONE,0}
00813 #define RIG_IS_FLT_END(f)       ((f).modes == RIG_MODE_NONE)
00814 
00815 
00816 /*
00817  * Used in the channel.flags field
00818  */
00819 #define RIG_CHFLAG_NONE 0
00820 #define RIG_CHFLAG_SKIP (1<<0)
00821 
00826 struct ext_list {
00827   token_t token;        
00828   value_t val;          
00829 };
00830 
00831 #define RIG_EXT_END     {0, {.i=0}}
00832 #define RIG_IS_EXT_END(x)       ((x).token == 0)
00833 
00841 struct channel {
00842   int channel_num;              
00843   int bank_num;                 
00844   vfo_t vfo;                    
00845   int ant;                      
00846   freq_t freq;                  
00847   rmode_t mode;                 
00848   pbwidth_t width;              
00850   freq_t tx_freq;               
00851   rmode_t tx_mode;              
00852   pbwidth_t tx_width;           
00854   split_t split;                
00855   vfo_t tx_vfo;                 
00857   rptr_shift_t rptr_shift;      
00858   shortfreq_t rptr_offs;        
00859   shortfreq_t tuning_step;      
00860   shortfreq_t rit;              
00861   shortfreq_t xit;              
00862   setting_t funcs;              
00863   value_t levels[RIG_SETTING_MAX];      
00864   tone_t ctcss_tone;            
00865   tone_t ctcss_sql;             
00866   tone_t dcs_code;              
00867   tone_t dcs_sql;               
00868   int scan_group;               
00869   int flags;                    
00870   char channel_desc[MAXCHANDESC];       
00871   struct ext_list *ext_levels;  
00872 };
00874 typedef struct channel channel_t;
00875 
00881 struct channel_cap {
00882   unsigned bank_num:1;          
00883   unsigned vfo:1;               
00884   unsigned ant:1;               
00885   unsigned freq:1;              
00886   unsigned mode:1;              
00887   unsigned width:1;             
00889   unsigned tx_freq:1;           
00890   unsigned tx_mode:1;           
00891   unsigned tx_width:1;          
00893   unsigned split:1;             
00894   unsigned tx_vfo:1;            
00895   unsigned rptr_shift:1;        
00896   unsigned rptr_offs:1;         
00897   unsigned tuning_step:1;       
00898   unsigned rit:1;               
00899   unsigned xit:1;               
00900   setting_t funcs;              
00901   setting_t levels;             
00902   unsigned ctcss_tone:1;        
00903   unsigned ctcss_sql:1;         
00904   unsigned dcs_code:1;          
00905   unsigned dcs_sql:1;           
00906   unsigned scan_group:1;        
00907   unsigned flags:1;             
00908   unsigned channel_desc:1;      
00909   unsigned ext_levels:1;        
00910 };
00911 
00913 typedef struct channel_cap channel_cap_t;
00914 
00915 
00926 typedef enum {
00927   RIG_MTYPE_NONE=0,             
00928   RIG_MTYPE_MEM,                
00929   RIG_MTYPE_EDGE,               
00930   RIG_MTYPE_CALL,               
00931   RIG_MTYPE_MEMOPAD,            
00932   RIG_MTYPE_SAT                 
00933 } chan_type_t;
00934 
00948 struct chan_list {
00949   int start;                    
00950   int end;                      
00951   chan_type_t type;             
00952   channel_cap_t mem_caps;       
00953 };
00954 
00955 #define RIG_CHAN_END     {0,0,RIG_MTYPE_NONE}
00956 #define RIG_IS_CHAN_END(c)      ((c).type == RIG_MTYPE_NONE)
00957 
00959 typedef struct chan_list chan_t;
00960 
00972 struct gran {
00973         value_t min;            
00974         value_t max;            
00975         value_t step;           
00976 };
00977 
00979 typedef struct gran gran_t;
00980 
00981 
00983 struct cal_table {
00984         int size;       
00985         struct {
00986                 int raw;        
00987                 int val;        
00988         } table[MAX_CAL_LENGTH];        
00989 };
00990 
01003 typedef struct cal_table cal_table_t;
01004 
01005 #define EMPTY_STR_CAL { 0, { { 0, 0 }, } }
01006 
01007 
01008 typedef int (*chan_cb_t) (RIG *, channel_t**, int, const chan_t*, rig_ptr_t);
01009 typedef int (*confval_cb_t) (RIG *, const struct confparams *, value_t *, rig_ptr_t);
01010 
01029 struct rig_caps {
01030   rig_model_t rig_model;        
01031   const char *model_name;       
01032   const char *mfg_name;         
01033   const char *version;          
01034   const char *copyright;        
01035   enum rig_status_e status;     
01037   int rig_type;                 
01038   ptt_type_t ptt_type;          
01039   dcd_type_t dcd_type;          
01040   rig_port_t port_type;         
01042   int serial_rate_min;          
01043   int serial_rate_max;          
01044   int serial_data_bits;         
01045   int serial_stop_bits;         
01046   enum serial_parity_e serial_parity;           
01047   enum serial_handshake_e serial_handshake;     
01049   int write_delay;              
01050   int post_write_delay;         
01051   int timeout;                  
01052   int retry;                    
01054   setting_t has_get_func;       
01055   setting_t has_set_func;       
01056   setting_t has_get_level;      
01057   setting_t has_set_level;      
01058   setting_t has_get_parm;       
01059   setting_t has_set_parm;       
01061   gran_t level_gran[RIG_SETTING_MAX];   
01062   gran_t parm_gran[RIG_SETTING_MAX];    
01064   const struct confparams *extparms;    
01065   const struct confparams *extlevels;   
01067   const tone_t *ctcss_list;     
01068   const tone_t *dcs_list;       
01070   int preamp[MAXDBLSTSIZ];      
01071   int attenuator[MAXDBLSTSIZ];  
01072   shortfreq_t max_rit;          
01073   shortfreq_t max_xit;          
01074   shortfreq_t max_ifshift;      
01076   ann_t announces;      
01078   vfo_op_t vfo_ops;     
01079   scan_t scan_ops;      
01080   int targetable_vfo;   
01081   int transceive;       
01083   int bank_qty;         
01084   int chan_desc_sz;     
01086   chan_t chan_list[CHANLSTSIZ]; 
01088   freq_range_t rx_range_list1[FRQRANGESIZ];     
01089   freq_range_t tx_range_list1[FRQRANGESIZ];     
01090   freq_range_t rx_range_list2[FRQRANGESIZ];     
01091   freq_range_t tx_range_list2[FRQRANGESIZ];     
01093   struct tuning_step_list tuning_steps[TSLSTSIZ];       
01094   struct filter_list filters[FLTLSTSIZ];                
01096   cal_table_t str_cal;                          
01098   const struct confparams *cfgparams;            
01099   const rig_ptr_t priv;                          
01101         /*
01102          * Rig API
01103          *
01104          */
01105 
01106   int (*rig_init) (RIG * rig);
01107   int (*rig_cleanup) (RIG * rig);
01108   int (*rig_open) (RIG * rig);
01109   int (*rig_close) (RIG * rig);
01110 
01111         /*
01112          *  General API commands, from most primitive to least.. :()
01113          *  List Set/Get functions pairs
01114          */
01115 
01116   int (*set_freq) (RIG * rig, vfo_t vfo, freq_t freq);
01117   int (*get_freq) (RIG * rig, vfo_t vfo, freq_t * freq);
01118 
01119   int (*set_mode) (RIG * rig, vfo_t vfo, rmode_t mode,
01120                          pbwidth_t width);
01121   int (*get_mode) (RIG * rig, vfo_t vfo, rmode_t * mode,
01122                          pbwidth_t * width);
01123 
01124   int (*set_vfo) (RIG * rig, vfo_t vfo);
01125   int (*get_vfo) (RIG * rig, vfo_t * vfo);
01126 
01127   int (*set_ptt) (RIG * rig, vfo_t vfo, ptt_t ptt);
01128   int (*get_ptt) (RIG * rig, vfo_t vfo, ptt_t * ptt);
01129   int (*get_dcd) (RIG * rig, vfo_t vfo, dcd_t * dcd);
01130 
01131   int (*set_rptr_shift) (RIG * rig, vfo_t vfo,
01132                                rptr_shift_t rptr_shift);
01133   int (*get_rptr_shift) (RIG * rig, vfo_t vfo,
01134                                rptr_shift_t * rptr_shift);
01135 
01136   int (*set_rptr_offs) (RIG * rig, vfo_t vfo, shortfreq_t offs);
01137   int (*get_rptr_offs) (RIG * rig, vfo_t vfo, shortfreq_t * offs);
01138 
01139   int (*set_split_freq) (RIG * rig, vfo_t vfo, freq_t tx_freq);
01140   int (*get_split_freq) (RIG * rig, vfo_t vfo, freq_t * tx_freq);
01141   int (*set_split_mode) (RIG * rig, vfo_t vfo, rmode_t tx_mode,
01142                                pbwidth_t tx_width);
01143   int (*get_split_mode) (RIG * rig, vfo_t vfo, rmode_t * tx_mode,
01144                                pbwidth_t * tx_width);
01145 
01146   int (*set_split_vfo) (RIG * rig, vfo_t vfo, split_t split, vfo_t tx_vfo);
01147   int (*get_split_vfo) (RIG * rig, vfo_t vfo, split_t * split, vfo_t *tx_vfo);
01148 
01149   int (*set_rit) (RIG * rig, vfo_t vfo, shortfreq_t rit);
01150   int (*get_rit) (RIG * rig, vfo_t vfo, shortfreq_t * rit);
01151   int (*set_xit) (RIG * rig, vfo_t vfo, shortfreq_t xit);
01152   int (*get_xit) (RIG * rig, vfo_t vfo, shortfreq_t * xit);
01153 
01154   int (*set_ts) (RIG * rig, vfo_t vfo, shortfreq_t ts);
01155   int (*get_ts) (RIG * rig, vfo_t vfo, shortfreq_t * ts);
01156 
01157   int (*set_dcs_code) (RIG * rig, vfo_t vfo, tone_t code);
01158   int (*get_dcs_code) (RIG * rig, vfo_t vfo, tone_t * code);
01159   int (*set_tone) (RIG * rig, vfo_t vfo, tone_t tone);
01160   int (*get_tone) (RIG * rig, vfo_t vfo, tone_t * tone);
01161   int (*set_ctcss_tone) (RIG * rig, vfo_t vfo, tone_t tone);
01162   int (*get_ctcss_tone) (RIG * rig, vfo_t vfo, tone_t * tone);
01163 
01164   int (*set_dcs_sql) (RIG * rig, vfo_t vfo, tone_t code);
01165   int (*get_dcs_sql) (RIG * rig, vfo_t vfo, tone_t * code);
01166   int (*set_tone_sql) (RIG * rig, vfo_t vfo, tone_t tone);
01167   int (*get_tone_sql) (RIG * rig, vfo_t vfo, tone_t * tone);
01168   int (*set_ctcss_sql) (RIG * rig, vfo_t vfo, tone_t tone);
01169   int (*get_ctcss_sql) (RIG * rig, vfo_t vfo, tone_t * tone);
01170 
01171   int (*power2mW) (RIG * rig, unsigned int *mwpower, float power,
01172                          freq_t freq, rmode_t mode);
01173   int (*mW2power) (RIG * rig, float *power, unsigned int mwpower,
01174                          freq_t freq, rmode_t mode);
01175 
01176   int (*set_powerstat) (RIG * rig, powerstat_t status);
01177   int (*get_powerstat) (RIG * rig, powerstat_t * status);
01178   int (*reset) (RIG * rig, reset_t reset);
01179 
01180   int (*set_ant) (RIG * rig, vfo_t vfo, ant_t ant);
01181   int (*get_ant) (RIG * rig, vfo_t vfo, ant_t * ant);
01182 
01183   int (*set_level) (RIG * rig, vfo_t vfo, setting_t level,
01184                           value_t val);
01185   int (*get_level) (RIG * rig, vfo_t vfo, setting_t level,
01186                           value_t * val);
01187 
01188   int (*set_func) (RIG * rig, vfo_t vfo, setting_t func, int status);
01189   int (*get_func) (RIG * rig, vfo_t vfo, setting_t func,
01190                          int *status);
01191 
01192   int (*set_parm) (RIG * rig, setting_t parm, value_t val);
01193   int (*get_parm) (RIG * rig, setting_t parm, value_t * val);
01194 
01195   int (*set_ext_level)(RIG *rig, vfo_t vfo, token_t token, value_t val);
01196   int (*get_ext_level)(RIG *rig, vfo_t vfo, token_t token, value_t *val);
01197 
01198   int (*set_ext_parm)(RIG *rig, token_t token, value_t val);
01199   int (*get_ext_parm)(RIG *rig, token_t token, value_t *val);
01200 
01201   int (*set_conf) (RIG * rig, token_t token, const char *val);
01202   int (*get_conf) (RIG * rig, token_t token, char *val);
01203 
01204   int (*send_dtmf) (RIG * rig, vfo_t vfo, const char *digits);
01205   int (*recv_dtmf) (RIG * rig, vfo_t vfo, char *digits, int *length);
01206   int (*send_morse) (RIG * rig, vfo_t vfo, const char *msg);
01207 
01208   int (*set_bank) (RIG * rig, vfo_t vfo, int bank);
01209   int (*set_mem) (RIG * rig, vfo_t vfo, int ch);
01210   int (*get_mem) (RIG * rig, vfo_t vfo, int *ch);
01211   int (*vfo_op) (RIG * rig, vfo_t vfo, vfo_op_t op);
01212   int (*scan) (RIG * rig, vfo_t vfo, scan_t scan, int ch);
01213 
01214   int (*set_trn) (RIG * rig, int trn);
01215   int (*get_trn) (RIG * rig, int *trn);
01216 
01217   int (*decode_event) (RIG * rig);
01218 
01219   int (*set_channel) (RIG * rig, const channel_t * chan);
01220   int (*get_channel) (RIG * rig, channel_t * chan);
01221 
01222   const char *(*get_info) (RIG * rig);
01223 
01224   int (*set_chan_all_cb) (RIG * rig, chan_cb_t chan_cb, rig_ptr_t);
01225   int (*get_chan_all_cb) (RIG * rig, chan_cb_t chan_cb, rig_ptr_t);
01226 
01227   int (*set_mem_all_cb) (RIG * rig, chan_cb_t chan_cb, confval_cb_t parm_cb, rig_ptr_t);
01228   int (*get_mem_all_cb) (RIG * rig, chan_cb_t chan_cb, confval_cb_t parm_cb, rig_ptr_t);
01229 
01230   const char *clone_combo_set;  /*<! String describing key combination to enter load cloning mode */
01231   const char *clone_combo_get;  /*<! String describing key combination to enter save cloning mode */
01232 };
01233 
01239 typedef struct {
01240   union {
01241         rig_port_t rig;         
01242         ptt_type_t ptt;         
01243         dcd_type_t dcd;         
01244   } type;
01245   int fd;                       
01246   void* handle;                 
01248   int write_delay;              
01249   int post_write_delay;         
01250   struct { int tv_sec,tv_usec; } post_write_date;       
01251   int timeout;                  
01252   int retry;                    
01254   char pathname[FILPATHLEN];    
01255   union {
01256         struct {
01257                 int rate;       
01258                 int data_bits;  
01259                 int stop_bits;  
01260                 enum serial_parity_e parity;            
01261                 enum serial_handshake_e handshake;      
01262                 enum serial_control_state_e rts_state;  
01263                 enum serial_control_state_e dtr_state;  
01264         } serial;               
01265         struct {
01266                 int pin;        
01267         } parallel;             
01268         struct {
01269                 int vid;        
01270                 int pid;        
01271                 int conf;       
01272                 int iface;      
01273                 int alt;        
01274         } usb;                  
01275   } parm;                       
01276 } hamlib_port_t;
01277 
01278 #if !defined(__APPLE__) || !defined(__cplusplus)
01279 typedef hamlib_port_t port_t;
01280 #endif
01281 
01282 
01292 struct rig_state {
01293         /*
01294          * overridable fields
01295          */
01296   hamlib_port_t rigport;        
01297   hamlib_port_t pttport;        
01298   hamlib_port_t dcdport;        
01300   double vfo_comp;      
01302   int itu_region;       
01303   freq_range_t rx_range_list[FRQRANGESIZ];      
01304   freq_range_t tx_range_list[FRQRANGESIZ];      
01306   struct tuning_step_list tuning_steps[TSLSTSIZ];       
01308   struct filter_list filters[FLTLSTSIZ];        
01310   cal_table_t str_cal;                          
01312   chan_t chan_list[CHANLSTSIZ]; 
01314   shortfreq_t max_rit;          
01315   shortfreq_t max_xit;          
01316   shortfreq_t max_ifshift;      
01318   ann_t announces;              
01320   int preamp[MAXDBLSTSIZ];      
01321   int attenuator[MAXDBLSTSIZ];  
01323   setting_t has_get_func;       
01324   setting_t has_set_func;       
01325   setting_t has_get_level;      
01326   setting_t has_set_level;      
01327   setting_t has_get_parm;       
01328   setting_t has_set_parm;       
01330   gran_t level_gran[RIG_SETTING_MAX];   
01331   gran_t parm_gran[RIG_SETTING_MAX];    
01334         /* 
01335          * non overridable fields, internal use
01336          */
01337 
01338   int hold_decode;      
01339   vfo_t current_vfo;    
01340   int vfo_list;         
01341   int comm_state;       
01342   rig_ptr_t priv;       
01343   rig_ptr_t obj;        
01345   int transceive;       
01346   int poll_interval;    
01347   freq_t current_freq;  
01348   rmode_t current_mode; 
01349   pbwidth_t current_width;      
01351 };
01352 
01353 
01354 typedef int (*vprintf_cb_t) (enum rig_debug_level_e, rig_ptr_t, const char *, va_list);
01355 
01356 typedef int (*freq_cb_t) (RIG *, vfo_t, freq_t, rig_ptr_t);
01357 typedef int (*mode_cb_t) (RIG *, vfo_t, rmode_t, pbwidth_t, rig_ptr_t);
01358 typedef int (*vfo_cb_t) (RIG *, vfo_t, rig_ptr_t);
01359 typedef int (*ptt_cb_t) (RIG *, vfo_t, ptt_t, rig_ptr_t);
01360 typedef int (*dcd_cb_t) (RIG *, vfo_t, dcd_t, rig_ptr_t);
01361 typedef int (*pltune_cb_t) (RIG *, vfo_t, freq_t *, rmode_t *, pbwidth_t *, rig_ptr_t);
01362 
01380 struct rig_callbacks {
01381   freq_cb_t freq_event; 
01382   rig_ptr_t freq_arg;   
01383   mode_cb_t mode_event; 
01384   rig_ptr_t mode_arg;   
01385   vfo_cb_t vfo_event;   
01386   rig_ptr_t vfo_arg;    
01387   ptt_cb_t ptt_event;   
01388   rig_ptr_t ptt_arg;    
01389   dcd_cb_t dcd_event;   
01390   rig_ptr_t dcd_arg;    
01391   pltune_cb_t pltune;   
01392   rig_ptr_t pltune_arg; 
01393   /* etc.. */
01394 };
01395 
01405 struct rig {
01406   struct rig_caps *caps;                
01407   struct rig_state state;               
01408   struct rig_callbacks callbacks;       
01409 };
01410 
01411 
01412 
01413 /* --------------- API function prototypes -----------------*/
01414 
01415 extern HAMLIB_EXPORT(RIG *) rig_init HAMLIB_PARAMS((rig_model_t rig_model));
01416 extern HAMLIB_EXPORT(int) rig_open HAMLIB_PARAMS((RIG *rig));
01417 
01418   /*
01419    *  General API commands, from most primitive to least.. :()
01420    *  List Set/Get functions pairs
01421    */
01422 
01423 extern HAMLIB_EXPORT(int) rig_set_freq HAMLIB_PARAMS((RIG *rig, vfo_t vfo, freq_t freq));
01424 extern HAMLIB_EXPORT(int) rig_get_freq HAMLIB_PARAMS((RIG *rig, vfo_t vfo, freq_t *freq));
01425 
01426 extern HAMLIB_EXPORT(int) rig_set_mode HAMLIB_PARAMS((RIG *rig, vfo_t vfo, rmode_t mode, pbwidth_t width));
01427 extern HAMLIB_EXPORT(int) rig_get_mode HAMLIB_PARAMS((RIG *rig, vfo_t vfo, rmode_t *mode, pbwidth_t *width));
01428 
01429 extern HAMLIB_EXPORT(int) rig_set_vfo HAMLIB_PARAMS((RIG *rig, vfo_t vfo));
01430 extern HAMLIB_EXPORT(int) rig_get_vfo HAMLIB_PARAMS((RIG *rig, vfo_t *vfo));
01431 
01432 extern HAMLIB_EXPORT(int) rig_set_ptt HAMLIB_PARAMS((RIG *rig, vfo_t vfo, ptt_t ptt));
01433 extern HAMLIB_EXPORT(int) rig_get_ptt HAMLIB_PARAMS((RIG *rig, vfo_t vfo, ptt_t *ptt));
01434 
01435 extern HAMLIB_EXPORT(int) rig_get_dcd HAMLIB_PARAMS((RIG *rig, vfo_t vfo, dcd_t *dcd));
01436 
01437 extern HAMLIB_EXPORT(int) rig_set_rptr_shift HAMLIB_PARAMS((RIG *rig, vfo_t vfo, rptr_shift_t rptr_shift));
01438 extern HAMLIB_EXPORT(int) rig_get_rptr_shift HAMLIB_PARAMS((RIG *rig, vfo_t vfo, rptr_shift_t *rptr_shift));
01439 extern HAMLIB_EXPORT(int) rig_set_rptr_offs HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t rptr_offs));
01440 extern HAMLIB_EXPORT(int) rig_get_rptr_offs HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t *rptr_offs));
01441 
01442 extern HAMLIB_EXPORT(int) rig_set_ctcss_tone HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t tone));
01443 extern HAMLIB_EXPORT(int) rig_get_ctcss_tone HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t *tone));
01444 extern HAMLIB_EXPORT(int) rig_set_dcs_code HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t code));
01445 extern HAMLIB_EXPORT(int) rig_get_dcs_code HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t *code));
01446 
01447 extern HAMLIB_EXPORT(int) rig_set_ctcss_sql HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t tone));
01448 extern HAMLIB_EXPORT(int) rig_get_ctcss_sql HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t *tone));
01449 extern HAMLIB_EXPORT(int) rig_set_dcs_sql HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t code));
01450 extern HAMLIB_EXPORT(int) rig_get_dcs_sql HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t *code));
01451 
01452 extern HAMLIB_EXPORT(int) rig_set_split_freq HAMLIB_PARAMS((RIG *rig, vfo_t vfo, freq_t tx_freq));
01453 extern HAMLIB_EXPORT(int) rig_get_split_freq HAMLIB_PARAMS((RIG *rig, vfo_t vfo, freq_t *tx_freq));
01454 extern HAMLIB_EXPORT(int) rig_set_split_mode HAMLIB_PARAMS((RIG *rig, vfo_t vfo, rmode_t tx_mode, pbwidth_t tx_width));
01455 extern HAMLIB_EXPORT(int) rig_get_split_mode HAMLIB_PARAMS((RIG *rig, vfo_t vfo, rmode_t *tx_mode, pbwidth_t *tx_width));
01456 extern HAMLIB_EXPORT(int) rig_set_split_vfo HAMLIB_PARAMS((RIG*, vfo_t rx_vfo, split_t split, vfo_t tx_vfo));
01457 extern HAMLIB_EXPORT(int) rig_get_split_vfo HAMLIB_PARAMS((RIG*, vfo_t rx_vfo, split_t *split, vfo_t *tx_vfo));
01458 #define rig_set_split(r,v,s) rig_set_split_vfo((r),(v),(s),RIG_VFO_CURR)
01459 #define rig_get_split(r,v,s) ({ vfo_t _tx_vfo; rig_get_split_vfo((r),(v),(s),&_tx_vfo); })
01460 
01461 extern HAMLIB_EXPORT(int) rig_set_rit HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t rit));
01462 extern HAMLIB_EXPORT(int) rig_get_rit HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t *rit));
01463 extern HAMLIB_EXPORT(int) rig_set_xit HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t xit));
01464 extern HAMLIB_EXPORT(int) rig_get_xit HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t *xit));
01465 
01466 extern HAMLIB_EXPORT(int) rig_set_ts HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t ts));
01467 extern HAMLIB_EXPORT(int) rig_get_ts HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t *ts));
01468 
01469 extern HAMLIB_EXPORT(int) rig_power2mW HAMLIB_PARAMS((RIG *rig, unsigned int *mwpower, float power, freq_t freq, rmode_t mode));
01470 extern HAMLIB_EXPORT(int) rig_mW2power HAMLIB_PARAMS((RIG *rig, float *power, unsigned int mwpower, freq_t freq, rmode_t mode));
01471 
01472 extern HAMLIB_EXPORT(shortfreq_t) rig_get_resolution HAMLIB_PARAMS((RIG *rig, rmode_t mode));
01473 
01474 extern HAMLIB_EXPORT(int) rig_set_level HAMLIB_PARAMS((RIG *rig, vfo_t vfo, setting_t level, value_t val));
01475 extern HAMLIB_EXPORT(int) rig_get_level HAMLIB_PARAMS((RIG *rig, vfo_t vfo, setting_t level, value_t *val));
01476 
01477 #define rig_get_strength(r,v,s) rig_get_level((r),(v),RIG_LEVEL_STRENGTH, (value_t*)(s))
01478 
01479 extern HAMLIB_EXPORT(int) rig_set_parm HAMLIB_PARAMS((RIG *rig, setting_t parm, value_t val));
01480 extern HAMLIB_EXPORT(int) rig_get_parm HAMLIB_PARAMS((RIG *rig, setting_t parm, value_t *val));
01481 
01482 extern HAMLIB_EXPORT(int) rig_set_conf HAMLIB_PARAMS((RIG *rig, token_t token, const char *val));
01483 extern HAMLIB_EXPORT(int) rig_get_conf HAMLIB_PARAMS((RIG *rig, token_t token, char *val));
01484 
01485 extern HAMLIB_EXPORT(int) rig_set_powerstat HAMLIB_PARAMS((RIG *rig, powerstat_t status));
01486 extern HAMLIB_EXPORT(int) rig_get_powerstat HAMLIB_PARAMS((RIG *rig, powerstat_t *status));
01487 
01488 extern HAMLIB_EXPORT(int) rig_reset HAMLIB_PARAMS((RIG *rig, reset_t reset));   /* dangerous! */
01489 
01490 extern HAMLIB_EXPORT(int) rig_set_ext_level HAMLIB_PARAMS((RIG *rig, vfo_t vfo,
01491                         token_t token, value_t val));
01492 extern HAMLIB_EXPORT(int) rig_get_ext_level HAMLIB_PARAMS((RIG *rig, vfo_t vfo,
01493                         token_t token, value_t *val));
01494 
01495 extern HAMLIB_EXPORT(int) rig_set_ext_parm HAMLIB_PARAMS((RIG *rig, token_t token, value_t val));
01496 extern HAMLIB_EXPORT(int) rig_get_ext_parm HAMLIB_PARAMS((RIG *rig, token_t token, value_t *val));
01497 
01498 extern HAMLIB_EXPORT(int) rig_ext_level_foreach HAMLIB_PARAMS((RIG *rig, int (*cfunc)(RIG*, const struct confparams *, rig_ptr_t), rig_ptr_t data));
01499 extern HAMLIB_EXPORT(int) rig_ext_parm_foreach HAMLIB_PARAMS((RIG *rig, int (*cfunc)(RIG*, const struct confparams *, rig_ptr_t), rig_ptr_t data));
01500 extern HAMLIB_EXPORT(const struct confparams*) rig_ext_lookup HAMLIB_PARAMS((RIG *rig, const char *name));
01501 extern HAMLIB_EXPORT(token_t) rig_ext_token_lookup HAMLIB_PARAMS((RIG *rig, const char *name));
01502 
01503 
01504 extern HAMLIB_EXPORT(int) rig_token_foreach HAMLIB_PARAMS((RIG *rig, int (*cfunc)(const struct confparams *, rig_ptr_t), rig_ptr_t data));
01505 extern HAMLIB_EXPORT(const struct confparams*) rig_confparam_lookup HAMLIB_PARAMS((RIG *rig, const char *name));
01506 extern HAMLIB_EXPORT(token_t) rig_token_lookup HAMLIB_PARAMS((RIG *rig, const char *name));
01507 
01508 extern HAMLIB_EXPORT(int) rig_close HAMLIB_PARAMS((RIG *rig));
01509 extern HAMLIB_EXPORT(int) rig_cleanup HAMLIB_PARAMS((RIG *rig));
01510 
01511 extern HAMLIB_EXPORT(int) rig_set_ant HAMLIB_PARAMS((RIG *rig, vfo_t vfo, ant_t ant));  /* antenna */
01512 extern HAMLIB_EXPORT(int) rig_get_ant HAMLIB_PARAMS((RIG *rig, vfo_t vfo, ant_t *ant));
01513 
01514 extern HAMLIB_EXPORT(setting_t) rig_has_get_level HAMLIB_PARAMS((RIG *rig, setting_t level));
01515 extern HAMLIB_EXPORT(setting_t) rig_has_set_level HAMLIB_PARAMS((RIG *rig, setting_t level));
01516 
01517 extern HAMLIB_EXPORT(setting_t) rig_has_get_parm HAMLIB_PARAMS((RIG *rig, setting_t parm));
01518 extern HAMLIB_EXPORT(setting_t) rig_has_set_parm HAMLIB_PARAMS((RIG *rig, setting_t parm));
01519 
01520 extern HAMLIB_EXPORT(setting_t) rig_has_get_func HAMLIB_PARAMS((RIG *rig, setting_t func));
01521 extern HAMLIB_EXPORT(setting_t) rig_has_set_func HAMLIB_PARAMS((RIG *rig, setting_t func));
01522 
01523 extern HAMLIB_EXPORT(int) rig_set_func HAMLIB_PARAMS((RIG *rig, vfo_t vfo, setting_t func, int status));
01524 extern HAMLIB_EXPORT(int) rig_get_func HAMLIB_PARAMS((RIG *rig, vfo_t vfo, setting_t func, int *status));
01525 
01526 extern HAMLIB_EXPORT(int) rig_send_dtmf HAMLIB_PARAMS((RIG *rig, vfo_t vfo, const char *digits));
01527 extern HAMLIB_EXPORT(int) rig_recv_dtmf HAMLIB_PARAMS((RIG *rig, vfo_t vfo, char *digits, int *length));
01528 extern HAMLIB_EXPORT(int) rig_send_morse HAMLIB_PARAMS((RIG *rig, vfo_t vfo, const char *msg));
01529 
01530 extern HAMLIB_EXPORT(int) rig_set_bank HAMLIB_PARAMS((RIG *rig, vfo_t vfo, int bank));
01531 extern HAMLIB_EXPORT(int) rig_set_mem HAMLIB_PARAMS((RIG *rig, vfo_t vfo, int ch));
01532 extern HAMLIB_EXPORT(int) rig_get_mem HAMLIB_PARAMS((RIG *rig, vfo_t vfo, int *ch));
01533 extern HAMLIB_EXPORT(int) rig_vfo_op HAMLIB_PARAMS((RIG *rig, vfo_t vfo, vfo_op_t op));
01534 extern HAMLIB_EXPORT(vfo_op_t) rig_has_vfo_op HAMLIB_PARAMS((RIG *rig, vfo_op_t op));
01535 extern HAMLIB_EXPORT(int) rig_scan HAMLIB_PARAMS((RIG *rig, vfo_t vfo, scan_t scan, int ch));
01536 extern HAMLIB_EXPORT(scan_t) rig_has_scan HAMLIB_PARAMS((RIG *rig, scan_t scan));
01537 
01538 extern HAMLIB_EXPORT(int) rig_set_channel HAMLIB_PARAMS((RIG *rig, const channel_t *chan));     /* mem */
01539 extern HAMLIB_EXPORT(int) rig_get_channel HAMLIB_PARAMS((RIG *rig, channel_t *chan));
01540 
01541 extern HAMLIB_EXPORT(int) rig_set_chan_all HAMLIB_PARAMS((RIG *rig, const channel_t chans[]));
01542 extern HAMLIB_EXPORT(int) rig_get_chan_all HAMLIB_PARAMS((RIG *rig, channel_t chans[]));
01543 extern HAMLIB_EXPORT(int) rig_set_chan_all_cb HAMLIB_PARAMS((RIG *rig, chan_cb_t chan_cb, rig_ptr_t));
01544 extern HAMLIB_EXPORT(int) rig_get_chan_all_cb HAMLIB_PARAMS((RIG *rig, chan_cb_t chan_cb, rig_ptr_t));
01545 
01546 extern HAMLIB_EXPORT(int) rig_set_mem_all_cb HAMLIB_PARAMS((RIG *rig, chan_cb_t chan_cb, confval_cb_t parm_cb, rig_ptr_t));
01547 extern HAMLIB_EXPORT(int) rig_get_mem_all_cb HAMLIB_PARAMS((RIG *rig, chan_cb_t chan_cb, confval_cb_t parm_cb, rig_ptr_t));
01548 extern HAMLIB_EXPORT(int) rig_set_mem_all HAMLIB_PARAMS((RIG *rig, const channel_t *chan, const struct confparams *, const value_t *));
01549 extern HAMLIB_EXPORT(int) rig_get_mem_all HAMLIB_PARAMS((RIG *rig, channel_t *chan, const struct confparams *, value_t *));
01550 
01551 extern HAMLIB_EXPORT(int) rig_set_trn HAMLIB_PARAMS((RIG *rig, int trn));
01552 extern HAMLIB_EXPORT(int) rig_get_trn HAMLIB_PARAMS((RIG *rig, int *trn));
01553 extern HAMLIB_EXPORT(int) rig_set_freq_callback HAMLIB_PARAMS((RIG *, freq_cb_t, rig_ptr_t));
01554 extern HAMLIB_EXPORT(int) rig_set_mode_callback HAMLIB_PARAMS((RIG *, mode_cb_t, rig_ptr_t));
01555 extern HAMLIB_EXPORT(int) rig_set_vfo_callback HAMLIB_PARAMS((RIG *, vfo_cb_t, rig_ptr_t));
01556 extern HAMLIB_EXPORT(int) rig_set_ptt_callback HAMLIB_PARAMS((RIG *, ptt_cb_t, rig_ptr_t));
01557 extern HAMLIB_EXPORT(int) rig_set_dcd_callback HAMLIB_PARAMS((RIG *, dcd_cb_t, rig_ptr_t));
01558 extern HAMLIB_EXPORT(int) rig_set_pltune_callback HAMLIB_PARAMS((RIG *, pltune_cb_t, rig_ptr_t));
01559 
01560 extern HAMLIB_EXPORT(const char *) rig_get_info HAMLIB_PARAMS((RIG *rig));
01561 
01562 extern HAMLIB_EXPORT(const struct rig_caps *) rig_get_caps HAMLIB_PARAMS((rig_model_t rig_model));
01563 extern HAMLIB_EXPORT(const freq_range_t *) rig_get_range HAMLIB_PARAMS((const freq_range_t range_list[], freq_t freq, rmode_t mode));
01564 
01565 extern HAMLIB_EXPORT(pbwidth_t) rig_passband_normal HAMLIB_PARAMS((RIG *rig, rmode_t mode));
01566 extern HAMLIB_EXPORT(pbwidth_t) rig_passband_narrow HAMLIB_PARAMS((RIG *rig, rmode_t mode));
01567 extern HAMLIB_EXPORT(pbwidth_t) rig_passband_wide HAMLIB_PARAMS((RIG *rig, rmode_t mode));
01568 
01569 extern HAMLIB_EXPORT(const char *) rigerror HAMLIB_PARAMS((int errnum));
01570 
01571 extern HAMLIB_EXPORT(int) rig_setting2idx HAMLIB_PARAMS((setting_t s));
01572 #define rig_idx2setting(i) (1UL<<(i))
01573 
01574 /*
01575  * Even if these functions are prefixed with "rig_", they are not rig specific
01576  * Maybe "hamlib_" would have been better. Let me know. --SF
01577  */
01578 extern HAMLIB_EXPORT(void) rig_set_debug HAMLIB_PARAMS((enum rig_debug_level_e debug_level));
01579 #define rig_set_debug_level(level) rig_set_debug(level)
01580 extern HAMLIB_EXPORT(int) rig_need_debug HAMLIB_PARAMS((enum rig_debug_level_e debug_level));
01581 extern HAMLIB_EXPORT(void) rig_debug HAMLIB_PARAMS((enum rig_debug_level_e debug_level, const char *fmt, ...));
01582 extern HAMLIB_EXPORT(vprintf_cb_t) rig_set_debug_callback HAMLIB_PARAMS((vprintf_cb_t cb, rig_ptr_t arg));
01583 extern HAMLIB_EXPORT(FILE*) rig_set_debug_file HAMLIB_PARAMS((FILE *stream));
01584 
01585 extern HAMLIB_EXPORT(int) rig_register HAMLIB_PARAMS((const struct rig_caps *caps));
01586 extern HAMLIB_EXPORT(int) rig_unregister HAMLIB_PARAMS((rig_model_t rig_model));
01587 extern HAMLIB_EXPORT(int) rig_list_foreach HAMLIB_PARAMS((int (*cfunc)(const struct rig_caps*, rig_ptr_t), rig_ptr_t data));
01588 extern HAMLIB_EXPORT(int) rig_load_backend HAMLIB_PARAMS((const char *be_name));
01589 extern HAMLIB_EXPORT(int) rig_check_backend HAMLIB_PARAMS((rig_model_t rig_model));
01590 extern HAMLIB_EXPORT(int) rig_load_all_backends HAMLIB_PARAMS((void));
01591 
01592 typedef int (*rig_probe_func_t)(const hamlib_port_t *, rig_model_t, rig_ptr_t);
01593 extern HAMLIB_EXPORT(int) rig_probe_all HAMLIB_PARAMS((hamlib_port_t *p, rig_probe_func_t, rig_ptr_t));
01594 extern HAMLIB_EXPORT(rig_model_t) rig_probe HAMLIB_PARAMS((hamlib_port_t *p));
01595 
01596 
01597 /* Misc calls */
01598 extern HAMLIB_EXPORT(const char *) rig_strrmode(rmode_t mode);
01599 extern HAMLIB_EXPORT(const char *) rig_strvfo(vfo_t vfo);
01600 extern HAMLIB_EXPORT(const char *) rig_strfunc(setting_t);
01601 extern HAMLIB_EXPORT(const char *) rig_strlevel(setting_t);
01602 extern HAMLIB_EXPORT(const char *) rig_strparm(setting_t);
01603 extern HAMLIB_EXPORT(const char *) rig_strptrshift(rptr_shift_t);
01604 extern HAMLIB_EXPORT(const char *) rig_strvfop(vfo_op_t op);
01605 extern HAMLIB_EXPORT(const char *) rig_strscan(scan_t scan);
01606 extern HAMLIB_EXPORT(const char *) rig_strstatus(enum rig_status_e status);
01607 
01608 extern HAMLIB_EXPORT(rmode_t) rig_parse_mode(const char *s);
01609 extern HAMLIB_EXPORT(vfo_t) rig_parse_vfo(const char *s);
01610 extern HAMLIB_EXPORT(setting_t) rig_parse_func(const char *s);
01611 extern HAMLIB_EXPORT(setting_t) rig_parse_level(const char *s);
01612 extern HAMLIB_EXPORT(setting_t) rig_parse_parm(const char *s);
01613 extern HAMLIB_EXPORT(vfo_op_t) rig_parse_vfo_op(const char *s);
01614 extern HAMLIB_EXPORT(scan_t) rig_parse_scan(const char *s);
01615 extern HAMLIB_EXPORT(rptr_shift_t) rig_parse_rptr_shift(const char *s);
01616 
01617 
01618 __END_DECLS
01619 
01620 #endif /* _RIG_H */

Generated on Sat Sep 30 15:49:37 2006 for Hamlib - the C library reference by  doxygen 1.4.4