Hamlib 1.2.12

rig.h

Go to the documentation of this file.
00001 /*
00002  *  Hamlib Interface - API header
00003  *  Copyright (c) 2000-2003 by Frank Singleton
00004  *  Copyright (c) 2000-2009 by Stephane Fillod
00005  *
00006  *      $Id: rig.h,v 1.141 2009-02-20 14:14:30 fillods Exp $
00007  *
00008  *   This library is free software; you can redistribute it and/or modify
00009  *   it under the terms of the GNU Library General Public License as
00010  *   published by the Free Software Foundation; either version 2 of
00011  *   the License, or (at your option) any later version.
00012  *
00013  *   This program is distributed in the hope that it will be useful,
00014  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
00015  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00016  *   GNU Library General Public License for more details.
00017  *
00018  *   You should have received a copy of the GNU Library General Public
00019  *   License along with this library; if not, write to the Free Software
00020  *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
00021  *
00022  */
00023 
00024 
00025 #ifndef _RIG_H
00026 #define _RIG_H 1
00027 
00028 #include <stdio.h>
00029 #include <stdarg.h>
00030 
00031 #include <hamlib/riglist.h>     /* list in another file to not mess up w/ this one */
00032 
00046 /* __BEGIN_DECLS should be used at the beginning of your declarations,
00047  * so that C++ compilers don't mangle their names.  Use __END_DECLS at
00048  * the end of C declarations. */
00049 #undef __BEGIN_DECLS
00050 #undef __END_DECLS
00051 #ifdef __cplusplus
00052 # define __BEGIN_DECLS extern "C" {
00053 # define __END_DECLS }
00054 #else
00055 # define __BEGIN_DECLS          /* empty */
00056 # define __END_DECLS            /* empty */
00057 #endif
00058 
00059 /* HAMLIB_PARAMS is a macro used to wrap function prototypes, so that compilers
00060  * that don't understand ANSI C prototypes still work, and ANSI C
00061  * compilers can issue warnings about type mismatches. */
00062 #undef HAMLIB_PARAMS
00063 #if defined (__STDC__) || defined (_AIX) || (defined (__mips) && defined (_SYSTYPE_SVR4)) || defined(__CYGWIN__) || defined(_WIN32) || defined(__cplusplus)
00064 # define HAMLIB_PARAMS(protos) protos
00065 # define rig_ptr_t     void*
00066 #else
00067 # define HAMLIB_PARAMS(protos) ()
00068 # define rig_ptr_t     char*
00069 #endif
00070 
00071 #include <hamlib/rig_dll.h>
00072 
00073 
00074 __BEGIN_DECLS
00075 
00076 extern HAMLIB_EXPORT_VAR(const char) hamlib_version[];
00077 extern HAMLIB_EXPORT_VAR(const char) hamlib_copyright[];
00078 
00085 enum rig_errcode_e {
00086         RIG_OK=0,               
00087         RIG_EINVAL,             
00088         RIG_ECONF,              
00089         RIG_ENOMEM,             
00090         RIG_ENIMPL,             
00091         RIG_ETIMEOUT,           
00092         RIG_EIO,                
00093         RIG_EINTERNAL,          
00094         RIG_EPROTO,             
00095         RIG_ERJCTED,            
00096         RIG_ETRUNC,             
00097         RIG_ENAVAIL,            
00098         RIG_ENTARGET,           
00099         RIG_BUSERROR,           
00100         RIG_BUSBUSY,            
00101         RIG_EARG,               
00102         RIG_EVFO,               
00103         RIG_EDOM                
00104 };
00105 
00107 #define NETRIGCTL_RET "RPRT "
00108 
00116 enum rig_debug_level_e {
00117   RIG_DEBUG_NONE = 0,           
00118   RIG_DEBUG_BUG,                
00119   RIG_DEBUG_ERR,                
00120   RIG_DEBUG_WARN,               
00121   RIG_DEBUG_VERBOSE,            
00122   RIG_DEBUG_TRACE               
00123 };
00124 
00125 /* --------------- Rig capabilities -----------------*/
00126 
00127 /* Forward struct references */
00128 
00129 struct rig;
00130 struct rig_state;
00131 
00135 typedef struct rig RIG;
00136 
00137 #define RIGNAMSIZ 30
00138 #define RIGVERSIZ 8
00139 #define FILPATHLEN 100
00140 #define FRQRANGESIZ 30
00141 #define MAXCHANDESC 30          /* describe channel eg: "WWV 5Mhz" */
00142 #define TSLSTSIZ 20             /* max tuning step list size, zero ended */
00143 #define FLTLSTSIZ 42            /* max mode/filter list size, zero ended */
00144 #define MAXDBLSTSIZ 8           /* max preamp/att levels supported, zero ended */
00145 #define CHANLSTSIZ 16           /* max mem_list size, zero ended */
00146 #define MAX_CAL_LENGTH 32       /* max calibration plots in cal_table_t */
00147 
00148 
00159 typedef unsigned int tone_t;
00160 
00164 typedef enum rig_port_e {
00165   RIG_PORT_NONE = 0,            
00166   RIG_PORT_SERIAL,              
00167   RIG_PORT_NETWORK,             
00168   RIG_PORT_DEVICE,              
00169   RIG_PORT_PACKET,              
00170   RIG_PORT_DTMF,                
00171   RIG_PORT_ULTRA,               
00172   RIG_PORT_RPC,                 
00173   RIG_PORT_PARALLEL,            
00174   RIG_PORT_USB                  
00175 } rig_port_t;
00176 
00180 enum serial_parity_e {
00181   RIG_PARITY_NONE = 0,          
00182   RIG_PARITY_ODD,               
00183   RIG_PARITY_EVEN               
00184 };
00185 
00189 enum serial_handshake_e {
00190   RIG_HANDSHAKE_NONE = 0,       
00191   RIG_HANDSHAKE_XONXOFF,        
00192   RIG_HANDSHAKE_HARDWARE        
00193 };
00194 
00195 
00199 enum serial_control_state_e {
00200   RIG_SIGNAL_UNSET = 0, 
00201   RIG_SIGNAL_ON,        
00202   RIG_SIGNAL_OFF        
00203 };
00204 
00206 typedef enum {
00207         RIG_FLAG_RECEIVER =     (1<<1),         
00208         RIG_FLAG_TRANSMITTER =  (1<<2),         
00209         RIG_FLAG_SCANNER =      (1<<3),         
00211         RIG_FLAG_MOBILE =       (1<<4),         
00212         RIG_FLAG_HANDHELD =     (1<<5),         
00213         RIG_FLAG_COMPUTER =     (1<<6),         
00214         RIG_FLAG_TRUNKING =     (1<<7),         
00215         RIG_FLAG_APRS =         (1<<8),         
00216         RIG_FLAG_TNC =          (1<<9),         
00217         RIG_FLAG_DXCLUSTER =    (1<<10),        
00218         RIG_FLAG_TUNER =        (1<<11)         
00219 } rig_type_t;
00220 
00221 #define RIG_FLAG_TRANSCEIVER (RIG_FLAG_RECEIVER|RIG_FLAG_TRANSMITTER)
00222 #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)
00223 
00224 #define RIG_TYPE_OTHER          0
00225 #define RIG_TYPE_TRANSCEIVER    RIG_FLAG_TRANSCEIVER
00226 #define RIG_TYPE_HANDHELD       (RIG_FLAG_TRANSCEIVER|RIG_FLAG_HANDHELD)
00227 #define RIG_TYPE_MOBILE         (RIG_FLAG_TRANSCEIVER|RIG_FLAG_MOBILE)
00228 #define RIG_TYPE_RECEIVER       RIG_FLAG_RECEIVER
00229 #define RIG_TYPE_PCRECEIVER     (RIG_FLAG_COMPUTER|RIG_FLAG_RECEIVER)
00230 #define RIG_TYPE_SCANNER        (RIG_FLAG_SCANNER|RIG_FLAG_RECEIVER)
00231 #define RIG_TYPE_TRUNKSCANNER   (RIG_TYPE_SCANNER|RIG_FLAG_TRUNKING)
00232 #define RIG_TYPE_COMPUTER       (RIG_FLAG_TRANSCEIVER|RIG_FLAG_COMPUTER)
00233 #define RIG_TYPE_TUNER          RIG_FLAG_TUNER
00234 
00235 
00239 enum rig_status_e {
00240   RIG_STATUS_ALPHA = 0,         
00241   RIG_STATUS_UNTESTED,          
00242   RIG_STATUS_BETA,              
00243   RIG_STATUS_STABLE,            
00244   RIG_STATUS_BUGGY              
00245 /*  RIG_STATUS_NEW      *       *!< Initial release of code 
00246  *                              !! Use of RIG_STATUS_NEW is deprecated. Do not use it anymore */
00247 };
00248 
00250 #define RIG_STATUS_NEW RIG_STATUS_UNTESTED
00251 
00255 typedef enum {
00256   RIG_RPT_SHIFT_NONE = 0,       
00257   RIG_RPT_SHIFT_MINUS,          
00258   RIG_RPT_SHIFT_PLUS            
00259 } rptr_shift_t;
00260 
00264 typedef enum {
00265   RIG_SPLIT_OFF = 0,            
00266   RIG_SPLIT_ON                  
00267 } split_t;
00268 
00273 typedef double freq_t;
00275 #define PRIfreq "f"
00276 
00277 #define SCNfreq "lf"
00278 #define FREQFMT SCNfreq
00279 
00284 typedef signed long shortfreq_t;
00285 
00286 #define Hz(f)   ((freq_t)(f))
00287 #define kHz(f)  ((freq_t)((f)*(freq_t)1000))
00288 #define MHz(f)  ((freq_t)((f)*(freq_t)1000000))
00289 #define GHz(f)  ((freq_t)((f)*(freq_t)1000000000))
00290 
00291 #define s_Hz(f)         ((shortfreq_t)(f))
00292 #define s_kHz(f)        ((shortfreq_t)((f)*(shortfreq_t)1000))
00293 #define s_MHz(f)        ((shortfreq_t)((f)*(shortfreq_t)1000000))
00294 #define s_GHz(f)        ((shortfreq_t)((f)*(shortfreq_t)1000000000))
00295 
00296 #define RIG_FREQ_NONE Hz(0)
00297 
00298 
00314 typedef int vfo_t;
00315 
00317 #define RIG_VFO_NONE    0
00318 
00319 #define RIG_VFO_TX_FLAG    (1<<30)
00320 
00322 #define RIG_VFO_CURR    (1<<29)
00323 
00325 #define RIG_VFO_MEM     (1<<28)
00326 
00328 #define RIG_VFO_VFO     (1<<27)
00329 
00330 #define RIG_VFO_TX_VFO(v)       ((v)|RIG_VFO_TX_FLAG)
00331 
00333 #define RIG_VFO_TX      RIG_VFO_TX_VFO(RIG_VFO_CURR)
00334 
00336 #define RIG_VFO_RX      RIG_VFO_CURR
00337 
00339 #define RIG_VFO_MAIN    (1<<26)
00340 
00341 #define RIG_VFO_SUB     (1<<25)
00342 
00343 #define RIG_VFO_N(n) (1<<(n))
00344 
00346 #define RIG_VFO_A RIG_VFO_N(0)
00347 
00348 #define RIG_VFO_B RIG_VFO_N(1)
00349 
00350 #define RIG_VFO_C RIG_VFO_N(2)
00351 
00352 
00353 /*
00354  * targetable bitfields, for internal use.
00355  * RIG_TARGETABLE_PURE means a pure targetable radio on every command
00356  */
00357 #define RIG_TARGETABLE_NONE 0
00358 #define RIG_TARGETABLE_FREQ (1<<0)
00359 #define RIG_TARGETABLE_MODE (1<<1)
00360 #define RIG_TARGETABLE_PURE (1<<2)
00361 #define RIG_TARGETABLE_TONE (1<<3)
00362 #define RIG_TARGETABLE_FUNC (1<<4)
00363 #define RIG_TARGETABLE_ALL  0x7fffffff
00364 
00365 
00366 #define RIG_PASSBAND_NORMAL s_Hz(0)
00367 
00371 typedef shortfreq_t pbwidth_t;
00372 
00373 
00377 typedef enum dcd_e {
00378   RIG_DCD_OFF = 0,              
00379   RIG_DCD_ON                    
00380 } dcd_t;
00381 
00386 typedef enum {
00387   RIG_DCD_NONE = 0,             
00388   RIG_DCD_RIG,                  
00389   RIG_DCD_SERIAL_DSR,           
00390   RIG_DCD_SERIAL_CTS,           
00391   RIG_DCD_SERIAL_CAR,           
00392   RIG_DCD_PARALLEL              
00393 } dcd_type_t;
00394 
00395 
00399 typedef enum {
00400   RIG_PTT_OFF = 0,              
00401   RIG_PTT_ON                    
00402 } ptt_t;
00403 
00408 typedef enum {
00409   RIG_PTT_NONE = 0,             
00410   RIG_PTT_RIG,                  
00411   RIG_PTT_SERIAL_DTR,           
00412   RIG_PTT_SERIAL_RTS,           
00413   RIG_PTT_PARALLEL              
00414 } ptt_type_t;
00415 
00419 typedef enum {
00420   RIG_POWER_OFF =       0,              
00421   RIG_POWER_ON =        (1<<0),         
00422   RIG_POWER_STANDBY =   (1<<1)          
00423 } powerstat_t;
00424 
00428 typedef enum {
00429   RIG_RESET_NONE =       0,             
00430   RIG_RESET_SOFT =      (1<<0),         
00431   RIG_RESET_VFO =       (1<<1),         
00432   RIG_RESET_MCALL =     (1<<2),         
00433   RIG_RESET_MASTER =    (1<<3)          
00434 } reset_t;
00435 
00436 
00452 typedef enum {
00453         RIG_OP_NONE =           0,  
00454         RIG_OP_CPY =            (1<<0), 
00455         RIG_OP_XCHG =           (1<<1), 
00456         RIG_OP_FROM_VFO =       (1<<2), 
00457         RIG_OP_TO_VFO =         (1<<3), 
00458         RIG_OP_MCL =            (1<<4), 
00459         RIG_OP_UP =             (1<<5), 
00460         RIG_OP_DOWN =           (1<<6), 
00461         RIG_OP_BAND_UP =        (1<<7), 
00462         RIG_OP_BAND_DOWN =      (1<<8), 
00463         RIG_OP_LEFT =           (1<<9), 
00464         RIG_OP_RIGHT =          (1<<10),
00465         RIG_OP_TUNE =           (1<<11),
00466         RIG_OP_TOGGLE =         (1<<12) 
00467 } vfo_op_t;
00468 
00469 
00478 typedef enum {
00479         RIG_SCAN_NONE =         0,  
00480         RIG_SCAN_STOP =         RIG_SCAN_NONE, 
00481         RIG_SCAN_MEM =          (1<<0), 
00482         RIG_SCAN_SLCT =         (1<<1), 
00483         RIG_SCAN_PRIO =         (1<<2), 
00484         RIG_SCAN_PROG =         (1<<3), 
00485         RIG_SCAN_DELTA =        (1<<4), 
00486         RIG_SCAN_VFO =          (1<<5), 
00487         RIG_SCAN_PLT =          (1<<6)  
00488 } scan_t;
00489 
00493 typedef long token_t;
00494 
00495 #define RIG_CONF_END 0
00496 
00509 /* strongly inspired from soundmodem. Thanks Thomas! */
00510 
00511 enum rig_conf_e {
00512         RIG_CONF_STRING,        
00513         RIG_CONF_COMBO,         
00514         RIG_CONF_NUMERIC,       
00515         RIG_CONF_CHECKBUTTON,   
00516         RIG_CONF_BUTTON         
00517 };
00518 
00519 #define RIG_COMBO_MAX   8
00520 
00524 struct confparams {
00525   token_t token;                
00526   const char *name;             
00527   const char *label;            
00528   const char *tooltip;          
00529   const char *dflt;             
00530   enum rig_conf_e type;         
00531   union {                       
00532         struct {                
00533                 float min;      
00534                 float max;      
00535                 float step;     
00536         } n;                    
00537         struct {                
00538                 const char *combostr[RIG_COMBO_MAX];    
00539         } c;                    
00540   } u;                          
00541 };
00542 
00547 typedef enum {
00548         RIG_ANN_NONE =  0,              
00549         RIG_ANN_OFF =   RIG_ANN_NONE,   
00550         RIG_ANN_FREQ =  (1<<0),         
00551         RIG_ANN_RXMODE = (1<<1),        
00552         RIG_ANN_CW = (1<<2),            
00553         RIG_ANN_ENG = (1<<3),           
00554         RIG_ANN_JAP = (1<<4)            
00555 } ann_t;
00556 
00557 
00561 typedef int ant_t;
00562 
00563 #define RIG_ANT_NONE    0
00564 #define RIG_ANT_N(n)    ((ant_t)1<<(n))
00565 #define RIG_ANT_1       RIG_ANT_N(0)
00566 #define RIG_ANT_2       RIG_ANT_N(1)
00567 #define RIG_ANT_3       RIG_ANT_N(2)
00568 #define RIG_ANT_4       RIG_ANT_N(3)
00569 #define RIG_ANT_5       RIG_ANT_N(4)
00570 
00574 /* TODO: kill me, and replace by real AGC delay */
00575 enum agc_level_e {
00576         RIG_AGC_OFF = 0,
00577         RIG_AGC_SUPERFAST,
00578         RIG_AGC_FAST,
00579         RIG_AGC_SLOW,
00580         RIG_AGC_USER,           
00581         RIG_AGC_MEDIUM,
00582         RIG_AGC_AUTO
00583 };
00584 
00588 enum meter_level_e {
00589   RIG_METER_NONE =      0,              /*< No display meter */
00590   RIG_METER_SWR =       (1<<0),         /*< Stationary Wave Ratio */
00591   RIG_METER_COMP =      (1<<1),         /*< Compression level */
00592   RIG_METER_ALC =       (1<<2),         /*< ALC */
00593   RIG_METER_IC =        (1<<3),         /*< IC */
00594   RIG_METER_DB =        (1<<4),         /*< DB */
00595   RIG_METER_PO =        (1<<5),         /*< Power Out */
00596   RIG_METER_VDD =       (1<<6)          /*< Final Amp Voltage */
00597 };
00598 
00603 typedef union {
00604   signed int i;                 
00605   float f;                      
00606   char *s;                      
00607   const char *cs;               
00608 } value_t;
00609 
00618 enum rig_level_e {
00619         RIG_LEVEL_NONE =        0,      
00620         RIG_LEVEL_PREAMP =      (1<<0), 
00621         RIG_LEVEL_ATT =         (1<<1), 
00622         RIG_LEVEL_VOX =         (1<<2), 
00623         RIG_LEVEL_AF =          (1<<3), 
00624         RIG_LEVEL_RF =          (1<<4), 
00625         RIG_LEVEL_SQL =         (1<<5), 
00626         RIG_LEVEL_IF =          (1<<6), 
00627         RIG_LEVEL_APF =         (1<<7), 
00628         RIG_LEVEL_NR =          (1<<8), 
00629         RIG_LEVEL_PBT_IN =      (1<<9), 
00630         RIG_LEVEL_PBT_OUT =     (1<<10),
00631         RIG_LEVEL_CWPITCH =     (1<<11),
00632         RIG_LEVEL_RFPOWER =     (1<<12),
00633         RIG_LEVEL_MICGAIN =     (1<<13),
00634         RIG_LEVEL_KEYSPD =      (1<<14),
00635         RIG_LEVEL_NOTCHF =      (1<<15),
00636         RIG_LEVEL_COMP =        (1<<16),
00637         RIG_LEVEL_AGC =         (1<<17),
00638         RIG_LEVEL_BKINDL =      (1<<18),
00639         RIG_LEVEL_BALANCE =     (1<<19),
00640         RIG_LEVEL_METER =       (1<<20),
00642         RIG_LEVEL_VOXGAIN =     (1<<21),
00643         RIG_LEVEL_VOXDELAY =  RIG_LEVEL_VOX,    
00644         RIG_LEVEL_ANTIVOX =     (1<<22),
00645         RIG_LEVEL_SLOPE_LOW = (1<<23),
00646         RIG_LEVEL_SLOPE_HIGH = (1<<24),
00647         RIG_LEVEL_BKIN_DLYMS = (1<<25),
00650         RIG_LEVEL_RAWSTR =      (1<<26),
00651         RIG_LEVEL_SQLSTAT =     (1<<27),
00652         RIG_LEVEL_SWR =         (1<<28),
00653         RIG_LEVEL_ALC =         (1<<29),
00654         RIG_LEVEL_STRENGTH =(1<<30) 
00655         /*RIG_LEVEL_BWC =               (1<<31)*/ 
00656 };
00657 
00658 #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)
00659 
00660 #define RIG_LEVEL_READONLY_LIST (RIG_LEVEL_SQLSTAT|RIG_LEVEL_SWR|RIG_LEVEL_ALC|RIG_LEVEL_STRENGTH|RIG_LEVEL_RAWSTR)
00661 
00662 #define RIG_LEVEL_IS_FLOAT(l) ((l)&RIG_LEVEL_FLOAT_LIST)
00663 #define RIG_LEVEL_SET(l) ((l)&~RIG_LEVEL_READONLY_LIST)
00664 
00665 
00674 enum rig_parm_e {
00675         RIG_PARM_NONE =         0,      
00676         RIG_PARM_ANN =          (1<<0), 
00677         RIG_PARM_APO =          (1<<1), 
00678         RIG_PARM_BACKLIGHT =    (1<<2), 
00679         RIG_PARM_BEEP =         (1<<4), 
00680         RIG_PARM_TIME =         (1<<5), 
00681         RIG_PARM_BAT =          (1<<6), 
00682         RIG_PARM_KEYLIGHT =     (1<<7)  
00683 };
00684 
00685 #define RIG_PARM_FLOAT_LIST (RIG_PARM_BACKLIGHT|RIG_PARM_BAT)
00686 #define RIG_PARM_READONLY_LIST (RIG_PARM_BAT)
00687 
00688 #define RIG_PARM_IS_FLOAT(l) ((l)&RIG_PARM_FLOAT_LIST)
00689 #define RIG_PARM_SET(l) ((l)&~RIG_PARM_READONLY_LIST)
00690 
00691 #define RIG_SETTING_MAX 32
00692 
00698 typedef unsigned long setting_t;
00699 
00700 /*
00701  * tranceive mode, ie. the rig notify the host of any event,
00702  * like freq changed, mode changed, etc.
00703  */
00704 #define RIG_TRN_OFF 0
00705 #define RIG_TRN_RIG 1
00706 #define RIG_TRN_POLL 2
00707 
00708 
00717 enum rig_func_e {
00718         RIG_FUNC_NONE =         0,      
00719         RIG_FUNC_FAGC =         (1<<0), 
00720         RIG_FUNC_NB =           (1<<1), 
00721         RIG_FUNC_COMP =         (1<<2), 
00722         RIG_FUNC_VOX =          (1<<3), 
00723         RIG_FUNC_TONE =         (1<<4), 
00724         RIG_FUNC_TSQL =         (1<<5), 
00725         RIG_FUNC_SBKIN =        (1<<6), 
00726         RIG_FUNC_FBKIN =        (1<<7), 
00727         RIG_FUNC_ANF =          (1<<8), 
00728         RIG_FUNC_NR =           (1<<9), 
00729         RIG_FUNC_AIP =          (1<<10),
00730         RIG_FUNC_APF =          (1<<11),
00731         RIG_FUNC_MON =          (1<<12),
00732         RIG_FUNC_MN =           (1<<13),
00733         RIG_FUNC_RF =           (1<<14),
00734         RIG_FUNC_ARO =          (1<<15),
00735         RIG_FUNC_LOCK =         (1<<16),
00736         RIG_FUNC_MUTE =         (1<<17),
00737         RIG_FUNC_VSC =          (1<<18),
00738         RIG_FUNC_REV =          (1<<19),
00739         RIG_FUNC_SQL =          (1<<20),
00740         RIG_FUNC_ABM =          (1<<21),
00741         RIG_FUNC_BC =           (1<<22),
00742         RIG_FUNC_MBC =          (1<<23),
00743         /*                      (1<<24), used to be RIG_FUNC_LMP, see RIG_PARM_BACKLIGHT instead) */
00744         RIG_FUNC_AFC =          (1<<25),
00745         RIG_FUNC_SATMODE =      (1<<26),
00746         RIG_FUNC_SCOPE =        (1<<27),
00747         RIG_FUNC_RESUME =       (1<<28),
00748         RIG_FUNC_TBURST =       (1<<29),
00749         RIG_FUNC_TUNER =        (1<<30) 
00750 };
00751 
00752 /*
00753  * power unit macros, converts to mW
00754  * This is limited to 2MW on 32 bits systems.
00755  */
00756 #define mW(p)    ((int)(p))
00757 #define Watts(p) ((int)((p)*1000))
00758 #define W(p)     Watts(p)
00759 #define kW(p)    ((int)((p)*1000000L))
00760 
00769 typedef enum {
00770         RIG_MODE_NONE =         0,      
00771         RIG_MODE_AM =           (1<<0), 
00772         RIG_MODE_CW =           (1<<1), 
00773         RIG_MODE_USB =          (1<<2), 
00774         RIG_MODE_LSB =          (1<<3), 
00775         RIG_MODE_RTTY =         (1<<4), 
00776         RIG_MODE_FM =           (1<<5), 
00777         RIG_MODE_WFM =          (1<<6), 
00778         RIG_MODE_CWR =          (1<<7), 
00779         RIG_MODE_RTTYR =        (1<<8), 
00780         RIG_MODE_AMS =          (1<<9), 
00781         RIG_MODE_PKTLSB =       (1<<10),
00782         RIG_MODE_PKTUSB =       (1<<11),
00783         RIG_MODE_PKTFM =        (1<<12),
00784         RIG_MODE_ECSSUSB =      (1<<13),
00785         RIG_MODE_ECSSLSB =      (1<<14),
00786         RIG_MODE_FAX =          (1<<15),
00787         RIG_MODE_SAM =          (1<<16),
00788         RIG_MODE_SAL =          (1<<17),
00789         RIG_MODE_SAH =          (1<<18),
00790         RIG_MODE_DSB =                  (1<<19), 
00791     RIG_MODE_TESTS_MAX               
00792 } rmode_t;
00793 
00794 
00796 #define RIG_MODE_SSB    (RIG_MODE_USB|RIG_MODE_LSB)
00797 
00799 #define RIG_MODE_ECSS   (RIG_MODE_ECSSUSB|RIG_MODE_ECSSLSB)
00800 
00801 
00802 #define RIG_DBLST_END 0         /* end marker in a preamp/att level list */
00803 #define RIG_IS_DBLST_END(d) ((d)==0)
00804 
00811 typedef struct freq_range_list {
00812   freq_t start;         
00813   freq_t end;           
00814   rmode_t modes;        
00815   int low_power;        
00816   int high_power;       
00817   vfo_t vfo;            
00818   ant_t ant;            
00819 } freq_range_t;
00820 
00821 #define RIG_FRNG_END     {Hz(0),Hz(0),RIG_MODE_NONE,0,0,RIG_VFO_NONE}
00822 #define RIG_IS_FRNG_END(r) ((r).start == Hz(0) && (r).end == Hz(0))
00823 
00824 #define RIG_ITU_REGION1 1
00825 #define RIG_ITU_REGION2 2
00826 #define RIG_ITU_REGION3 3
00827 
00847 struct tuning_step_list {
00848   rmode_t modes;        
00849   shortfreq_t ts;       
00850 };
00851 
00852 #define RIG_TS_ANY     0
00853 #define RIG_TS_END     {RIG_MODE_NONE,0}
00854 #define RIG_IS_TS_END(t)        ((t).modes == RIG_MODE_NONE && (t).ts == 0)
00855 
00882 struct filter_list {
00883   rmode_t modes;        
00884   pbwidth_t width;      
00885 };
00886 
00887 #define RIG_FLT_ANY     0
00888 #define RIG_FLT_END     {RIG_MODE_NONE,0}
00889 #define RIG_IS_FLT_END(f)       ((f).modes == RIG_MODE_NONE)
00890 
00891 
00893 #define RIG_CHFLAG_NONE 0
00894 
00895 #define RIG_CHFLAG_SKIP (1<<0)
00896 
00897 #define RIG_CHFLAG_DATA (1<<1)
00898 
00903 struct ext_list {
00904   token_t token;        
00905   value_t val;          
00906 };
00907 
00908 #define RIG_EXT_END     {0, {.i=0}}
00909 #define RIG_IS_EXT_END(x)       ((x).token == 0)
00910 
00918 struct channel {
00919   int channel_num;              
00920   int bank_num;                 
00921   vfo_t vfo;                    
00922   int ant;                      
00923   freq_t freq;                  
00924   rmode_t mode;                 
00925   pbwidth_t width;              
00927   freq_t tx_freq;               
00928   rmode_t tx_mode;              
00929   pbwidth_t tx_width;           
00931   split_t split;                
00932   vfo_t tx_vfo;                 
00934   rptr_shift_t rptr_shift;      
00935   shortfreq_t rptr_offs;        
00936   shortfreq_t tuning_step;      
00937   shortfreq_t rit;              
00938   shortfreq_t xit;              
00939   setting_t funcs;              
00940   value_t levels[RIG_SETTING_MAX];      
00941   tone_t ctcss_tone;            
00942   tone_t ctcss_sql;             
00943   tone_t dcs_code;              
00944   tone_t dcs_sql;               
00945   int scan_group;               
00946   int flags;                    
00947   char channel_desc[MAXCHANDESC];       
00948   struct ext_list *ext_levels;  
00949 };
00951 typedef struct channel channel_t;
00952 
00958 struct channel_cap {
00959   unsigned bank_num:1;          
00960   unsigned vfo:1;               
00961   unsigned ant:1;               
00962   unsigned freq:1;              
00963   unsigned mode:1;              
00964   unsigned width:1;             
00966   unsigned tx_freq:1;           
00967   unsigned tx_mode:1;           
00968   unsigned tx_width:1;          
00970   unsigned split:1;             
00971   unsigned tx_vfo:1;            
00972   unsigned rptr_shift:1;        
00973   unsigned rptr_offs:1;         
00974   unsigned tuning_step:1;       
00975   unsigned rit:1;               
00976   unsigned xit:1;               
00977   setting_t funcs;              
00978   setting_t levels;             
00979   unsigned ctcss_tone:1;        
00980   unsigned ctcss_sql:1;         
00981   unsigned dcs_code:1;          
00982   unsigned dcs_sql:1;           
00983   unsigned scan_group:1;        
00984   unsigned flags:1;             
00985   unsigned channel_desc:1;      
00986   unsigned ext_levels:1;        
00987 };
00988 
00990 typedef struct channel_cap channel_cap_t;
00991 
00992 
01003 typedef enum {
01004   RIG_MTYPE_NONE=0,             
01005   RIG_MTYPE_MEM,                
01006   RIG_MTYPE_EDGE,               
01007   RIG_MTYPE_CALL,               
01008   RIG_MTYPE_MEMOPAD,            
01009   RIG_MTYPE_SAT,                
01010   RIG_MTYPE_BAND,               
01011   RIG_MTYPE_PRIO                
01012 } chan_type_t;
01013 
01027 struct chan_list {
01028   int start;                    
01029   int end;                      
01030   chan_type_t type;             
01031   channel_cap_t mem_caps;       
01032 };
01033 
01034 #define RIG_CHAN_END     {0,0,RIG_MTYPE_NONE}
01035 #define RIG_IS_CHAN_END(c)      ((c).type == RIG_MTYPE_NONE)
01036 
01037 #define RIG_MEM_CAPS_ALL -1
01038 
01040 typedef struct chan_list chan_t;
01041 
01053 struct gran {
01054         value_t min;            
01055         value_t max;            
01056         value_t step;           
01057 };
01058 
01060 typedef struct gran gran_t;
01061 
01062 
01064 struct cal_table {
01065         int size;               
01066         struct {
01067                 int raw;        
01068                 int val;        
01069         } table[MAX_CAL_LENGTH];        
01070 };
01071 
01084 typedef struct cal_table cal_table_t;
01085 
01086 #define EMPTY_STR_CAL { 0, { { 0, 0 }, } }
01087 
01088 
01089 typedef int (*chan_cb_t) (RIG *, channel_t**, int, const chan_t*, rig_ptr_t);
01090 typedef int (*confval_cb_t) (RIG *, const struct confparams *, value_t *, rig_ptr_t);
01091 
01110 struct rig_caps {
01111   rig_model_t rig_model;        
01112   const char *model_name;       
01113   const char *mfg_name;         
01114   const char *version;          
01115   const char *copyright;        
01116   enum rig_status_e status;     
01118   int rig_type;                 
01119   ptt_type_t ptt_type;          
01120   dcd_type_t dcd_type;          
01121   rig_port_t port_type;         
01123   int serial_rate_min;          
01124   int serial_rate_max;          
01125   int serial_data_bits;         
01126   int serial_stop_bits;         
01127   enum serial_parity_e serial_parity;           
01128   enum serial_handshake_e serial_handshake;     
01130   int write_delay;              
01131   int post_write_delay;         
01132   int timeout;                  
01133   int retry;                    
01135   setting_t has_get_func;       
01136   setting_t has_set_func;       
01137   setting_t has_get_level;      
01138   setting_t has_set_level;      
01139   setting_t has_get_parm;       
01140   setting_t has_set_parm;       
01142   gran_t level_gran[RIG_SETTING_MAX];   
01143   gran_t parm_gran[RIG_SETTING_MAX];    
01145   const struct confparams *extparms;    
01146   const struct confparams *extlevels;   
01148   const tone_t *ctcss_list;     
01149   const tone_t *dcs_list;       
01151   int preamp[MAXDBLSTSIZ];      
01152   int attenuator[MAXDBLSTSIZ];  
01153   shortfreq_t max_rit;          
01154   shortfreq_t max_xit;          
01155   shortfreq_t max_ifshift;      
01157   ann_t announces;      
01159   vfo_op_t vfo_ops;     
01160   scan_t scan_ops;      
01161   int targetable_vfo;   
01162   int transceive;       
01164   int bank_qty;         
01165   int chan_desc_sz;     
01167   chan_t chan_list[CHANLSTSIZ]; 
01169   freq_range_t rx_range_list1[FRQRANGESIZ];     
01170   freq_range_t tx_range_list1[FRQRANGESIZ];     
01171   freq_range_t rx_range_list2[FRQRANGESIZ];     
01172   freq_range_t tx_range_list2[FRQRANGESIZ];     
01174   struct tuning_step_list tuning_steps[TSLSTSIZ];       
01175   struct filter_list filters[FLTLSTSIZ];                
01177   cal_table_t str_cal;                          
01179   const struct confparams *cfgparams;            
01180   const rig_ptr_t priv;                          
01182         /*
01183          * Rig API
01184          *
01185          */
01186 
01187   int (*rig_init) (RIG * rig);
01188   int (*rig_cleanup) (RIG * rig);
01189   int (*rig_open) (RIG * rig);
01190   int (*rig_close) (RIG * rig);
01191 
01192         /*
01193          *  General API commands, from most primitive to least.. :()
01194          *  List Set/Get functions pairs
01195          */
01196 
01197   int (*set_freq) (RIG * rig, vfo_t vfo, freq_t freq);
01198   int (*get_freq) (RIG * rig, vfo_t vfo, freq_t * freq);
01199 
01200   int (*set_mode) (RIG * rig, vfo_t vfo, rmode_t mode,
01201                          pbwidth_t width);
01202   int (*get_mode) (RIG * rig, vfo_t vfo, rmode_t * mode,
01203                          pbwidth_t * width);
01204 
01205   int (*set_vfo) (RIG * rig, vfo_t vfo);
01206   int (*get_vfo) (RIG * rig, vfo_t * vfo);
01207 
01208   int (*set_ptt) (RIG * rig, vfo_t vfo, ptt_t ptt);
01209   int (*get_ptt) (RIG * rig, vfo_t vfo, ptt_t * ptt);
01210   int (*get_dcd) (RIG * rig, vfo_t vfo, dcd_t * dcd);
01211 
01212   int (*set_rptr_shift) (RIG * rig, vfo_t vfo,
01213                                rptr_shift_t rptr_shift);
01214   int (*get_rptr_shift) (RIG * rig, vfo_t vfo,
01215                                rptr_shift_t * rptr_shift);
01216 
01217   int (*set_rptr_offs) (RIG * rig, vfo_t vfo, shortfreq_t offs);
01218   int (*get_rptr_offs) (RIG * rig, vfo_t vfo, shortfreq_t * offs);
01219 
01220   int (*set_split_freq) (RIG * rig, vfo_t vfo, freq_t tx_freq);
01221   int (*get_split_freq) (RIG * rig, vfo_t vfo, freq_t * tx_freq);
01222   int (*set_split_mode) (RIG * rig, vfo_t vfo, rmode_t tx_mode,
01223                                pbwidth_t tx_width);
01224   int (*get_split_mode) (RIG * rig, vfo_t vfo, rmode_t * tx_mode,
01225                                pbwidth_t * tx_width);
01226 
01227   int (*set_split_vfo) (RIG * rig, vfo_t vfo, split_t split, vfo_t tx_vfo);
01228   int (*get_split_vfo) (RIG * rig, vfo_t vfo, split_t * split, vfo_t *tx_vfo);
01229 
01230   int (*set_rit) (RIG * rig, vfo_t vfo, shortfreq_t rit);
01231   int (*get_rit) (RIG * rig, vfo_t vfo, shortfreq_t * rit);
01232   int (*set_xit) (RIG * rig, vfo_t vfo, shortfreq_t xit);
01233   int (*get_xit) (RIG * rig, vfo_t vfo, shortfreq_t * xit);
01234 
01235   int (*set_ts) (RIG * rig, vfo_t vfo, shortfreq_t ts);
01236   int (*get_ts) (RIG * rig, vfo_t vfo, shortfreq_t * ts);
01237 
01238   int (*set_dcs_code) (RIG * rig, vfo_t vfo, tone_t code);
01239   int (*get_dcs_code) (RIG * rig, vfo_t vfo, tone_t * code);
01240   int (*set_tone) (RIG * rig, vfo_t vfo, tone_t tone);
01241   int (*get_tone) (RIG * rig, vfo_t vfo, tone_t * tone);
01242   int (*set_ctcss_tone) (RIG * rig, vfo_t vfo, tone_t tone);
01243   int (*get_ctcss_tone) (RIG * rig, vfo_t vfo, tone_t * tone);
01244 
01245   int (*set_dcs_sql) (RIG * rig, vfo_t vfo, tone_t code);
01246   int (*get_dcs_sql) (RIG * rig, vfo_t vfo, tone_t * code);
01247   int (*set_tone_sql) (RIG * rig, vfo_t vfo, tone_t tone);
01248   int (*get_tone_sql) (RIG * rig, vfo_t vfo, tone_t * tone);
01249   int (*set_ctcss_sql) (RIG * rig, vfo_t vfo, tone_t tone);
01250   int (*get_ctcss_sql) (RIG * rig, vfo_t vfo, tone_t * tone);
01251 
01252   int (*power2mW) (RIG * rig, unsigned int *mwpower, float power,
01253                          freq_t freq, rmode_t mode);
01254   int (*mW2power) (RIG * rig, float *power, unsigned int mwpower,
01255                          freq_t freq, rmode_t mode);
01256 
01257   int (*set_powerstat) (RIG * rig, powerstat_t status);
01258   int (*get_powerstat) (RIG * rig, powerstat_t * status);
01259   int (*reset) (RIG * rig, reset_t reset);
01260 
01261   int (*set_ant) (RIG * rig, vfo_t vfo, ant_t ant);
01262   int (*get_ant) (RIG * rig, vfo_t vfo, ant_t * ant);
01263 
01264   int (*set_level) (RIG * rig, vfo_t vfo, setting_t level,
01265                           value_t val);
01266   int (*get_level) (RIG * rig, vfo_t vfo, setting_t level,
01267                           value_t * val);
01268 
01269   int (*set_func) (RIG * rig, vfo_t vfo, setting_t func, int status);
01270   int (*get_func) (RIG * rig, vfo_t vfo, setting_t func,
01271                          int *status);
01272 
01273   int (*set_parm) (RIG * rig, setting_t parm, value_t val);
01274   int (*get_parm) (RIG * rig, setting_t parm, value_t * val);
01275 
01276   int (*set_ext_level)(RIG *rig, vfo_t vfo, token_t token, value_t val);
01277   int (*get_ext_level)(RIG *rig, vfo_t vfo, token_t token, value_t *val);
01278 
01279   int (*set_ext_parm)(RIG *rig, token_t token, value_t val);
01280   int (*get_ext_parm)(RIG *rig, token_t token, value_t *val);
01281 
01282   int (*set_conf) (RIG * rig, token_t token, const char *val);
01283   int (*get_conf) (RIG * rig, token_t token, char *val);
01284 
01285   int (*send_dtmf) (RIG * rig, vfo_t vfo, const char *digits);
01286   int (*recv_dtmf) (RIG * rig, vfo_t vfo, char *digits, int *length);
01287   int (*send_morse) (RIG * rig, vfo_t vfo, const char *msg);
01288 
01289   int (*set_bank) (RIG * rig, vfo_t vfo, int bank);
01290   int (*set_mem) (RIG * rig, vfo_t vfo, int ch);
01291   int (*get_mem) (RIG * rig, vfo_t vfo, int *ch);
01292   int (*vfo_op) (RIG * rig, vfo_t vfo, vfo_op_t op);
01293   int (*scan) (RIG * rig, vfo_t vfo, scan_t scan, int ch);
01294 
01295   int (*set_trn) (RIG * rig, int trn);
01296   int (*get_trn) (RIG * rig, int *trn);
01297 
01298   int (*decode_event) (RIG * rig);
01299 
01300   int (*set_channel) (RIG * rig, const channel_t * chan);
01301   int (*get_channel) (RIG * rig, channel_t * chan);
01302 
01303   const char *(*get_info) (RIG * rig);
01304 
01305   int (*set_chan_all_cb) (RIG * rig, chan_cb_t chan_cb, rig_ptr_t);
01306   int (*get_chan_all_cb) (RIG * rig, chan_cb_t chan_cb, rig_ptr_t);
01307 
01308   int (*set_mem_all_cb) (RIG * rig, chan_cb_t chan_cb, confval_cb_t parm_cb, rig_ptr_t);
01309   int (*get_mem_all_cb) (RIG * rig, chan_cb_t chan_cb, confval_cb_t parm_cb, rig_ptr_t);
01310 
01311   const char *clone_combo_set;  
01312   const char *clone_combo_get;  
01313 };
01314 
01320 typedef struct {
01321   union {
01322         rig_port_t rig;         
01323         ptt_type_t ptt;         
01324         dcd_type_t dcd;         
01325   } type;
01326   int fd;                       
01327   void* handle;                 
01329   int write_delay;              
01330   int post_write_delay;         
01331   struct { int tv_sec,tv_usec; } post_write_date;       
01332   int timeout;                  
01333   int retry;                    
01335   char pathname[FILPATHLEN];    
01336   union {
01337         struct {
01338                 int rate;       
01339                 int data_bits;  
01340                 int stop_bits;  
01341                 enum serial_parity_e parity;            
01342                 enum serial_handshake_e handshake;      
01343                 enum serial_control_state_e rts_state;  
01344                 enum serial_control_state_e dtr_state;  
01345         } serial;               
01346         struct {
01347                 int pin;        
01348         } parallel;             
01349         struct {
01350                 int vid;        
01351                 int pid;        
01352                 int conf;       
01353                 int iface;      
01354                 int alt;        
01355         char *vendor_name; 
01356         char *product;     
01357         } usb;                  
01358   } parm;                       
01359 } hamlib_port_t;
01360 
01361 #if !defined(__APPLE__) || !defined(__cplusplus)
01362 typedef hamlib_port_t port_t;
01363 #endif
01364 
01365 
01375 struct rig_state {
01376         /*
01377          * overridable fields
01378          */
01379   hamlib_port_t rigport;        
01380   hamlib_port_t pttport;        
01381   hamlib_port_t dcdport;        
01383   double vfo_comp;      
01385   int itu_region;       
01386   freq_range_t rx_range_list[FRQRANGESIZ];      
01387   freq_range_t tx_range_list[FRQRANGESIZ];      
01389   struct tuning_step_list tuning_steps[TSLSTSIZ];       
01391   struct filter_list filters[FLTLSTSIZ];        
01393   cal_table_t str_cal;                          
01395   chan_t chan_list[CHANLSTSIZ]; 
01397   shortfreq_t max_rit;          
01398   shortfreq_t max_xit;          
01399   shortfreq_t max_ifshift;      
01401   ann_t announces;              
01403   int preamp[MAXDBLSTSIZ];      
01404   int attenuator[MAXDBLSTSIZ];  
01406   setting_t has_get_func;       
01407   setting_t has_set_func;       
01408   setting_t has_get_level;      
01409   setting_t has_set_level;      
01410   setting_t has_get_parm;       
01411   setting_t has_set_parm;       
01413   gran_t level_gran[RIG_SETTING_MAX];   
01414   gran_t parm_gran[RIG_SETTING_MAX];    
01417         /* 
01418          * non overridable fields, internal use
01419          */
01420 
01421   int hold_decode;      
01422   vfo_t current_vfo;    
01423   int vfo_list;         
01424   int comm_state;       
01425   rig_ptr_t priv;       
01426   rig_ptr_t obj;        
01428   int transceive;       
01429   int poll_interval;    
01430   freq_t current_freq;  
01431   rmode_t current_mode; 
01432   pbwidth_t current_width;      
01433   vfo_t tx_vfo;         
01434   int mode_list;                
01436 };
01437 
01438 
01439 typedef int (*vprintf_cb_t) (enum rig_debug_level_e, rig_ptr_t, const char *, va_list);
01440 
01441 typedef int (*freq_cb_t) (RIG *, vfo_t, freq_t, rig_ptr_t);
01442 typedef int (*mode_cb_t) (RIG *, vfo_t, rmode_t, pbwidth_t, rig_ptr_t);
01443 typedef int (*vfo_cb_t) (RIG *, vfo_t, rig_ptr_t);
01444 typedef int (*ptt_cb_t) (RIG *, vfo_t, ptt_t, rig_ptr_t);
01445 typedef int (*dcd_cb_t) (RIG *, vfo_t, dcd_t, rig_ptr_t);
01446 typedef int (*pltune_cb_t) (RIG *, vfo_t, freq_t *, rmode_t *, pbwidth_t *, rig_ptr_t);
01447 
01465 struct rig_callbacks {
01466   freq_cb_t freq_event; 
01467   rig_ptr_t freq_arg;   
01468   mode_cb_t mode_event; 
01469   rig_ptr_t mode_arg;   
01470   vfo_cb_t vfo_event;   
01471   rig_ptr_t vfo_arg;    
01472   ptt_cb_t ptt_event;   
01473   rig_ptr_t ptt_arg;    
01474   dcd_cb_t dcd_event;   
01475   rig_ptr_t dcd_arg;    
01476   pltune_cb_t pltune;   
01477   rig_ptr_t pltune_arg; 
01478   /* etc.. */
01479 };
01480 
01490 struct rig {
01491   struct rig_caps *caps;                
01492   struct rig_state state;               
01493   struct rig_callbacks callbacks;       
01494 };
01495 
01496 
01497 
01498 /* --------------- API function prototypes -----------------*/
01499 
01500 extern HAMLIB_EXPORT(RIG *) rig_init HAMLIB_PARAMS((rig_model_t rig_model));
01501 extern HAMLIB_EXPORT(int) rig_open HAMLIB_PARAMS((RIG *rig));
01502 
01503   /*
01504    *  General API commands, from most primitive to least.. :()
01505    *  List Set/Get functions pairs
01506    */
01507 
01508 extern HAMLIB_EXPORT(int) rig_set_freq HAMLIB_PARAMS((RIG *rig, vfo_t vfo, freq_t freq));
01509 extern HAMLIB_EXPORT(int) rig_get_freq HAMLIB_PARAMS((RIG *rig, vfo_t vfo, freq_t *freq));
01510 
01511 extern HAMLIB_EXPORT(int) rig_set_mode HAMLIB_PARAMS((RIG *rig, vfo_t vfo, rmode_t mode, pbwidth_t width));
01512 extern HAMLIB_EXPORT(int) rig_get_mode HAMLIB_PARAMS((RIG *rig, vfo_t vfo, rmode_t *mode, pbwidth_t *width));
01513 
01514 extern HAMLIB_EXPORT(int) rig_set_vfo HAMLIB_PARAMS((RIG *rig, vfo_t vfo));
01515 extern HAMLIB_EXPORT(int) rig_get_vfo HAMLIB_PARAMS((RIG *rig, vfo_t *vfo));
01516 
01517 extern HAMLIB_EXPORT(int) rig_set_ptt HAMLIB_PARAMS((RIG *rig, vfo_t vfo, ptt_t ptt));
01518 extern HAMLIB_EXPORT(int) rig_get_ptt HAMLIB_PARAMS((RIG *rig, vfo_t vfo, ptt_t *ptt));
01519 
01520 extern HAMLIB_EXPORT(int) rig_get_dcd HAMLIB_PARAMS((RIG *rig, vfo_t vfo, dcd_t *dcd));
01521 
01522 extern HAMLIB_EXPORT(int) rig_set_rptr_shift HAMLIB_PARAMS((RIG *rig, vfo_t vfo, rptr_shift_t rptr_shift));
01523 extern HAMLIB_EXPORT(int) rig_get_rptr_shift HAMLIB_PARAMS((RIG *rig, vfo_t vfo, rptr_shift_t *rptr_shift));
01524 extern HAMLIB_EXPORT(int) rig_set_rptr_offs HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t rptr_offs));
01525 extern HAMLIB_EXPORT(int) rig_get_rptr_offs HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t *rptr_offs));
01526 
01527 extern HAMLIB_EXPORT(int) rig_set_ctcss_tone HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t tone));
01528 extern HAMLIB_EXPORT(int) rig_get_ctcss_tone HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t *tone));
01529 extern HAMLIB_EXPORT(int) rig_set_dcs_code HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t code));
01530 extern HAMLIB_EXPORT(int) rig_get_dcs_code HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t *code));
01531 
01532 extern HAMLIB_EXPORT(int) rig_set_ctcss_sql HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t tone));
01533 extern HAMLIB_EXPORT(int) rig_get_ctcss_sql HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t *tone));
01534 extern HAMLIB_EXPORT(int) rig_set_dcs_sql HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t code));
01535 extern HAMLIB_EXPORT(int) rig_get_dcs_sql HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t *code));
01536 
01537 extern HAMLIB_EXPORT(int) rig_set_split_freq HAMLIB_PARAMS((RIG *rig, vfo_t vfo, freq_t tx_freq));
01538 extern HAMLIB_EXPORT(int) rig_get_split_freq HAMLIB_PARAMS((RIG *rig, vfo_t vfo, freq_t *tx_freq));
01539 extern HAMLIB_EXPORT(int) rig_set_split_mode HAMLIB_PARAMS((RIG *rig, vfo_t vfo, rmode_t tx_mode, pbwidth_t tx_width));
01540 extern HAMLIB_EXPORT(int) rig_get_split_mode HAMLIB_PARAMS((RIG *rig, vfo_t vfo, rmode_t *tx_mode, pbwidth_t *tx_width));
01541 extern HAMLIB_EXPORT(int) rig_set_split_vfo HAMLIB_PARAMS((RIG*, vfo_t rx_vfo, split_t split, vfo_t tx_vfo));
01542 extern HAMLIB_EXPORT(int) rig_get_split_vfo HAMLIB_PARAMS((RIG*, vfo_t rx_vfo, split_t *split, vfo_t *tx_vfo));
01543 #define rig_set_split(r,v,s) rig_set_split_vfo((r),(v),(s),RIG_VFO_CURR)
01544 #define rig_get_split(r,v,s) ({ vfo_t _tx_vfo; rig_get_split_vfo((r),(v),(s),&_tx_vfo); })
01545 
01546 extern HAMLIB_EXPORT(int) rig_set_rit HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t rit));
01547 extern HAMLIB_EXPORT(int) rig_get_rit HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t *rit));
01548 extern HAMLIB_EXPORT(int) rig_set_xit HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t xit));
01549 extern HAMLIB_EXPORT(int) rig_get_xit HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t *xit));
01550 
01551 extern HAMLIB_EXPORT(int) rig_set_ts HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t ts));
01552 extern HAMLIB_EXPORT(int) rig_get_ts HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t *ts));
01553 
01554 extern HAMLIB_EXPORT(int) rig_power2mW HAMLIB_PARAMS((RIG *rig, unsigned int *mwpower, float power, freq_t freq, rmode_t mode));
01555 extern HAMLIB_EXPORT(int) rig_mW2power HAMLIB_PARAMS((RIG *rig, float *power, unsigned int mwpower, freq_t freq, rmode_t mode));
01556 
01557 extern HAMLIB_EXPORT(shortfreq_t) rig_get_resolution HAMLIB_PARAMS((RIG *rig, rmode_t mode));
01558 
01559 extern HAMLIB_EXPORT(int) rig_set_level HAMLIB_PARAMS((RIG *rig, vfo_t vfo, setting_t level, value_t val));
01560 extern HAMLIB_EXPORT(int) rig_get_level HAMLIB_PARAMS((RIG *rig, vfo_t vfo, setting_t level, value_t *val));
01561 
01562 #define rig_get_strength(r,v,s) rig_get_level((r),(v),RIG_LEVEL_STRENGTH, (value_t*)(s))
01563 
01564 extern HAMLIB_EXPORT(int) rig_set_parm HAMLIB_PARAMS((RIG *rig, setting_t parm, value_t val));
01565 extern HAMLIB_EXPORT(int) rig_get_parm HAMLIB_PARAMS((RIG *rig, setting_t parm, value_t *val));
01566 
01567 extern HAMLIB_EXPORT(int) rig_set_conf HAMLIB_PARAMS((RIG *rig, token_t token, const char *val));
01568 extern HAMLIB_EXPORT(int) rig_get_conf HAMLIB_PARAMS((RIG *rig, token_t token, char *val));
01569 
01570 extern HAMLIB_EXPORT(int) rig_set_powerstat HAMLIB_PARAMS((RIG *rig, powerstat_t status));
01571 extern HAMLIB_EXPORT(int) rig_get_powerstat HAMLIB_PARAMS((RIG *rig, powerstat_t *status));
01572 
01573 extern HAMLIB_EXPORT(int) rig_reset HAMLIB_PARAMS((RIG *rig, reset_t reset));   /* dangerous! */
01574 
01575 extern HAMLIB_EXPORT(int) rig_set_ext_level HAMLIB_PARAMS((RIG *rig, vfo_t vfo,
01576                         token_t token, value_t val));
01577 extern HAMLIB_EXPORT(int) rig_get_ext_level HAMLIB_PARAMS((RIG *rig, vfo_t vfo,
01578                         token_t token, value_t *val));
01579 
01580 extern HAMLIB_EXPORT(int) rig_set_ext_parm HAMLIB_PARAMS((RIG *rig, token_t token, value_t val));
01581 extern HAMLIB_EXPORT(int) rig_get_ext_parm HAMLIB_PARAMS((RIG *rig, token_t token, value_t *val));
01582 
01583 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));
01584 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));
01585 extern HAMLIB_EXPORT(const struct confparams*) rig_ext_lookup HAMLIB_PARAMS((RIG *rig, const char *name));
01586 extern HAMLIB_EXPORT(const struct confparams *)  rig_ext_lookup_tok HAMLIB_PARAMS((RIG *rig, token_t token));
01587 extern HAMLIB_EXPORT(token_t) rig_ext_token_lookup HAMLIB_PARAMS((RIG *rig, const char *name));
01588 
01589 
01590 extern HAMLIB_EXPORT(int) rig_token_foreach HAMLIB_PARAMS((RIG *rig, int (*cfunc)(const struct confparams *, rig_ptr_t), rig_ptr_t data));
01591 extern HAMLIB_EXPORT(const struct confparams*) rig_confparam_lookup HAMLIB_PARAMS((RIG *rig, const char *name));
01592 extern HAMLIB_EXPORT(token_t) rig_token_lookup HAMLIB_PARAMS((RIG *rig, const char *name));
01593 
01594 extern HAMLIB_EXPORT(int) rig_close HAMLIB_PARAMS((RIG *rig));
01595 extern HAMLIB_EXPORT(int) rig_cleanup HAMLIB_PARAMS((RIG *rig));
01596 
01597 extern HAMLIB_EXPORT(int) rig_set_ant HAMLIB_PARAMS((RIG *rig, vfo_t vfo, ant_t ant));  /* antenna */
01598 extern HAMLIB_EXPORT(int) rig_get_ant HAMLIB_PARAMS((RIG *rig, vfo_t vfo, ant_t *ant));
01599 
01600 extern HAMLIB_EXPORT(setting_t) rig_has_get_level HAMLIB_PARAMS((RIG *rig, setting_t level));
01601 extern HAMLIB_EXPORT(setting_t) rig_has_set_level HAMLIB_PARAMS((RIG *rig, setting_t level));
01602 
01603 extern HAMLIB_EXPORT(setting_t) rig_has_get_parm HAMLIB_PARAMS((RIG *rig, setting_t parm));
01604 extern HAMLIB_EXPORT(setting_t) rig_has_set_parm HAMLIB_PARAMS((RIG *rig, setting_t parm));
01605 
01606 extern HAMLIB_EXPORT(setting_t) rig_has_get_func HAMLIB_PARAMS((RIG *rig, setting_t func));
01607 extern HAMLIB_EXPORT(setting_t) rig_has_set_func HAMLIB_PARAMS((RIG *rig, setting_t func));
01608 
01609 extern HAMLIB_EXPORT(int) rig_set_func HAMLIB_PARAMS((RIG *rig, vfo_t vfo, setting_t func, int status));
01610 extern HAMLIB_EXPORT(int) rig_get_func HAMLIB_PARAMS((RIG *rig, vfo_t vfo, setting_t func, int *status));
01611 
01612 extern HAMLIB_EXPORT(int) rig_send_dtmf HAMLIB_PARAMS((RIG *rig, vfo_t vfo, const char *digits));
01613 extern HAMLIB_EXPORT(int) rig_recv_dtmf HAMLIB_PARAMS((RIG *rig, vfo_t vfo, char *digits, int *length));
01614 extern HAMLIB_EXPORT(int) rig_send_morse HAMLIB_PARAMS((RIG *rig, vfo_t vfo, const char *msg));
01615 
01616 extern HAMLIB_EXPORT(int) rig_set_bank HAMLIB_PARAMS((RIG *rig, vfo_t vfo, int bank));
01617 extern HAMLIB_EXPORT(int) rig_set_mem HAMLIB_PARAMS((RIG *rig, vfo_t vfo, int ch));
01618 extern HAMLIB_EXPORT(int) rig_get_mem HAMLIB_PARAMS((RIG *rig, vfo_t vfo, int *ch));
01619 extern HAMLIB_EXPORT(int) rig_vfo_op HAMLIB_PARAMS((RIG *rig, vfo_t vfo, vfo_op_t op));
01620 extern HAMLIB_EXPORT(vfo_op_t) rig_has_vfo_op HAMLIB_PARAMS((RIG *rig, vfo_op_t op));
01621 extern HAMLIB_EXPORT(int) rig_scan HAMLIB_PARAMS((RIG *rig, vfo_t vfo, scan_t scan, int ch));
01622 extern HAMLIB_EXPORT(scan_t) rig_has_scan HAMLIB_PARAMS((RIG *rig, scan_t scan));
01623 
01624 extern HAMLIB_EXPORT(int) rig_set_channel HAMLIB_PARAMS((RIG *rig, const channel_t *chan));     /* mem */
01625 extern HAMLIB_EXPORT(int) rig_get_channel HAMLIB_PARAMS((RIG *rig, channel_t *chan));
01626 
01627 extern HAMLIB_EXPORT(int) rig_set_chan_all HAMLIB_PARAMS((RIG *rig, const channel_t chans[]));
01628 extern HAMLIB_EXPORT(int) rig_get_chan_all HAMLIB_PARAMS((RIG *rig, channel_t chans[]));
01629 extern HAMLIB_EXPORT(int) rig_set_chan_all_cb HAMLIB_PARAMS((RIG *rig, chan_cb_t chan_cb, rig_ptr_t));
01630 extern HAMLIB_EXPORT(int) rig_get_chan_all_cb HAMLIB_PARAMS((RIG *rig, chan_cb_t chan_cb, rig_ptr_t));
01631 
01632 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));
01633 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));
01634 extern HAMLIB_EXPORT(int) rig_set_mem_all HAMLIB_PARAMS((RIG *rig, const channel_t *chan, const struct confparams *, const value_t *));
01635 extern HAMLIB_EXPORT(int) rig_get_mem_all HAMLIB_PARAMS((RIG *rig, channel_t *chan, const struct confparams *, value_t *));
01636 extern HAMLIB_EXPORT(const chan_t *) rig_lookup_mem_caps HAMLIB_PARAMS((RIG *rig, int ch));
01637 extern HAMLIB_EXPORT(int) rig_mem_count HAMLIB_PARAMS((RIG *rig));
01638 
01639 
01640 extern HAMLIB_EXPORT(int) rig_set_trn HAMLIB_PARAMS((RIG *rig, int trn));
01641 extern HAMLIB_EXPORT(int) rig_get_trn HAMLIB_PARAMS((RIG *rig, int *trn));
01642 extern HAMLIB_EXPORT(int) rig_set_freq_callback HAMLIB_PARAMS((RIG *, freq_cb_t, rig_ptr_t));
01643 extern HAMLIB_EXPORT(int) rig_set_mode_callback HAMLIB_PARAMS((RIG *, mode_cb_t, rig_ptr_t));
01644 extern HAMLIB_EXPORT(int) rig_set_vfo_callback HAMLIB_PARAMS((RIG *, vfo_cb_t, rig_ptr_t));
01645 extern HAMLIB_EXPORT(int) rig_set_ptt_callback HAMLIB_PARAMS((RIG *, ptt_cb_t, rig_ptr_t));
01646 extern HAMLIB_EXPORT(int) rig_set_dcd_callback HAMLIB_PARAMS((RIG *, dcd_cb_t, rig_ptr_t));
01647 extern HAMLIB_EXPORT(int) rig_set_pltune_callback HAMLIB_PARAMS((RIG *, pltune_cb_t, rig_ptr_t));
01648 
01649 extern HAMLIB_EXPORT(const char *) rig_get_info HAMLIB_PARAMS((RIG *rig));
01650 
01651 extern HAMLIB_EXPORT(const struct rig_caps *) rig_get_caps HAMLIB_PARAMS((rig_model_t rig_model));
01652 extern HAMLIB_EXPORT(const freq_range_t *) rig_get_range HAMLIB_PARAMS((const freq_range_t range_list[], freq_t freq, rmode_t mode));
01653 
01654 extern HAMLIB_EXPORT(pbwidth_t) rig_passband_normal HAMLIB_PARAMS((RIG *rig, rmode_t mode));
01655 extern HAMLIB_EXPORT(pbwidth_t) rig_passband_narrow HAMLIB_PARAMS((RIG *rig, rmode_t mode));
01656 extern HAMLIB_EXPORT(pbwidth_t) rig_passband_wide HAMLIB_PARAMS((RIG *rig, rmode_t mode));
01657 
01658 extern HAMLIB_EXPORT(const char *) rigerror HAMLIB_PARAMS((int errnum));
01659 
01660 extern HAMLIB_EXPORT(int) rig_setting2idx HAMLIB_PARAMS((setting_t s));
01661 #define rig_idx2setting(i) (1UL<<(i))
01662 
01663 /*
01664  * Even if these functions are prefixed with "rig_", they are not rig specific
01665  * Maybe "hamlib_" would have been better. Let me know. --SF
01666  */
01667 extern HAMLIB_EXPORT(void) rig_set_debug HAMLIB_PARAMS((enum rig_debug_level_e debug_level));
01668 #define rig_set_debug_level(level) rig_set_debug(level)
01669 extern HAMLIB_EXPORT(int) rig_need_debug HAMLIB_PARAMS((enum rig_debug_level_e debug_level));
01670 extern HAMLIB_EXPORT(void) rig_debug HAMLIB_PARAMS((enum rig_debug_level_e debug_level, const char *fmt, ...));
01671 extern HAMLIB_EXPORT(vprintf_cb_t) rig_set_debug_callback HAMLIB_PARAMS((vprintf_cb_t cb, rig_ptr_t arg));
01672 extern HAMLIB_EXPORT(FILE*) rig_set_debug_file HAMLIB_PARAMS((FILE *stream));
01673 
01674 extern HAMLIB_EXPORT(int) rig_register HAMLIB_PARAMS((const struct rig_caps *caps));
01675 extern HAMLIB_EXPORT(int) rig_unregister HAMLIB_PARAMS((rig_model_t rig_model));
01676 extern HAMLIB_EXPORT(int) rig_list_foreach HAMLIB_PARAMS((int (*cfunc)(const struct rig_caps*, rig_ptr_t), rig_ptr_t data));
01677 extern HAMLIB_EXPORT(int) rig_load_backend HAMLIB_PARAMS((const char *be_name));
01678 extern HAMLIB_EXPORT(int) rig_check_backend HAMLIB_PARAMS((rig_model_t rig_model));
01679 extern HAMLIB_EXPORT(int) rig_load_all_backends HAMLIB_PARAMS((void));
01680 
01681 typedef int (*rig_probe_func_t)(const hamlib_port_t *, rig_model_t, rig_ptr_t);
01682 extern HAMLIB_EXPORT(int) rig_probe_all HAMLIB_PARAMS((hamlib_port_t *p, rig_probe_func_t, rig_ptr_t));
01683 extern HAMLIB_EXPORT(rig_model_t) rig_probe HAMLIB_PARAMS((hamlib_port_t *p));
01684 
01685 
01686 /* Misc calls */
01687 extern HAMLIB_EXPORT(const char *) rig_strrmode(rmode_t mode);
01688 extern HAMLIB_EXPORT(const char *) rig_strvfo(vfo_t vfo);
01689 extern HAMLIB_EXPORT(const char *) rig_strfunc(setting_t);
01690 extern HAMLIB_EXPORT(const char *) rig_strlevel(setting_t);
01691 extern HAMLIB_EXPORT(const char *) rig_strparm(setting_t);
01692 extern HAMLIB_EXPORT(const char *) rig_strptrshift(rptr_shift_t);
01693 extern HAMLIB_EXPORT(const char *) rig_strvfop(vfo_op_t op);
01694 extern HAMLIB_EXPORT(const char *) rig_strscan(scan_t scan);
01695 extern HAMLIB_EXPORT(const char *) rig_strstatus(enum rig_status_e status);
01696 extern HAMLIB_EXPORT(const char *) rig_strmtype(chan_type_t mtype);
01697 
01698 extern HAMLIB_EXPORT(rmode_t) rig_parse_mode(const char *s);
01699 extern HAMLIB_EXPORT(vfo_t) rig_parse_vfo(const char *s);
01700 extern HAMLIB_EXPORT(setting_t) rig_parse_func(const char *s);
01701 extern HAMLIB_EXPORT(setting_t) rig_parse_level(const char *s);
01702 extern HAMLIB_EXPORT(setting_t) rig_parse_parm(const char *s);
01703 extern HAMLIB_EXPORT(vfo_op_t) rig_parse_vfo_op(const char *s);
01704 extern HAMLIB_EXPORT(scan_t) rig_parse_scan(const char *s);
01705 extern HAMLIB_EXPORT(rptr_shift_t) rig_parse_rptr_shift(const char *s);
01706 extern HAMLIB_EXPORT(chan_type_t) rig_parse_mtype(const char *s);
01707 
01708 
01709 __END_DECLS
01710 
01711 #endif /* _RIG_H */
01712 
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines

Hamlib documentation for version 1.2.12 -- Thu Feb 3 2011 10:54:12
Project page: http://hamlib.org