00001 /* 00002 * Hamlib Interface - API header 00003 * Copyright (c) 2000-2005 by Stephane Fillod and Frank Singleton 00004 * 00005 * $Id: rig.h,v 1.124 2007/11/26 20:54:11 n0nb 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 00024 #ifndef _RIG_H 00025 #define _RIG_H 1 00026 00027 #include <stdio.h> 00028 #include <stdarg.h> 00029 00030 #include <hamlib/riglist.h> /* list in another file to not mess up w/ this one */ 00031 00045 /* __BEGIN_DECLS should be used at the beginning of your declarations, 00046 * so that C++ compilers don't mangle their names. Use __END_DECLS at 00047 * the end of C declarations. */ 00048 #undef __BEGIN_DECLS 00049 #undef __END_DECLS 00050 #ifdef __cplusplus 00051 # define __BEGIN_DECLS extern "C" { 00052 # define __END_DECLS } 00053 #else 00054 # define __BEGIN_DECLS /* empty */ 00055 # define __END_DECLS /* empty */ 00056 #endif 00057 00058 /* HAMLIB_PARAMS is a macro used to wrap function prototypes, so that compilers 00059 * that don't understand ANSI C prototypes still work, and ANSI C 00060 * compilers can issue warnings about type mismatches. */ 00061 #undef HAMLIB_PARAMS 00062 #if defined (__STDC__) || defined (_AIX) || (defined (__mips) && defined (_SYSTYPE_SVR4)) || defined(__CYGWIN__) || defined(_WIN32) || defined(__cplusplus) 00063 # define HAMLIB_PARAMS(protos) protos 00064 # define rig_ptr_t void* 00065 #else 00066 # define HAMLIB_PARAMS(protos) () 00067 # define rig_ptr_t char* 00068 #endif 00069 00070 #include <hamlib/rig_dll.h> 00071 00072 00073 __BEGIN_DECLS 00074 00075 extern HAMLIB_EXPORT_VAR(const char) hamlib_version[]; 00076 extern HAMLIB_EXPORT_VAR(const char) hamlib_copyright[]; 00077 00082 enum rig_errcode_e { 00083 RIG_OK=0, 00084 RIG_EINVAL, 00085 RIG_ECONF, 00086 RIG_ENOMEM, 00087 RIG_ENIMPL, 00088 RIG_ETIMEOUT, 00089 RIG_EIO, 00090 RIG_EINTERNAL, 00091 RIG_EPROTO, 00092 RIG_ERJCTED, 00093 RIG_ETRUNC, 00094 RIG_ENAVAIL, 00095 RIG_ENTARGET, 00096 RIG_BUSERROR, 00097 RIG_BUSBUSY, 00098 RIG_EARG, 00099 RIG_EVFO, 00100 RIG_EDOM 00101 }; 00102 00110 enum rig_debug_level_e { 00111 RIG_DEBUG_NONE = 0, 00112 RIG_DEBUG_BUG, 00113 RIG_DEBUG_ERR, 00114 RIG_DEBUG_WARN, 00115 RIG_DEBUG_VERBOSE, 00116 RIG_DEBUG_TRACE 00117 }; 00118 00119 /* --------------- Rig capabilities -----------------*/ 00120 00121 /* Forward struct references */ 00122 00123 struct rig; 00124 struct rig_state; 00125 00129 typedef struct rig RIG; 00130 00131 #define RIGNAMSIZ 30 00132 #define RIGVERSIZ 8 00133 #define FILPATHLEN 100 00134 #define FRQRANGESIZ 30 00135 #define MAXCHANDESC 30 /* describe channel eg: "WWV 5Mhz" */ 00136 #define TSLSTSIZ 20 /* max tuning step list size, zero ended */ 00137 #define FLTLSTSIZ 42 /* max mode/filter list size, zero ended */ 00138 #define MAXDBLSTSIZ 8 /* max preamp/att levels supported, zero ended */ 00139 #define CHANLSTSIZ 16 /* max mem_list size, zero ended */ 00140 #define MAX_CAL_LENGTH 32 /* max calibration plots in cal_table_t */ 00141 00142 00153 typedef unsigned int tone_t; 00154 00158 typedef enum rig_port_e { 00159 RIG_PORT_NONE = 0, 00160 RIG_PORT_SERIAL, 00161 RIG_PORT_NETWORK, 00162 RIG_PORT_DEVICE, 00163 RIG_PORT_PACKET, 00164 RIG_PORT_DTMF, 00165 RIG_PORT_ULTRA, 00166 RIG_PORT_RPC, 00167 RIG_PORT_PARALLEL, 00168 RIG_PORT_USB 00169 } rig_port_t; 00170 00174 enum serial_parity_e { 00175 RIG_PARITY_NONE = 0, 00176 RIG_PARITY_ODD, 00177 RIG_PARITY_EVEN 00178 }; 00179 00183 enum serial_handshake_e { 00184 RIG_HANDSHAKE_NONE = 0, 00185 RIG_HANDSHAKE_XONXOFF, 00186 RIG_HANDSHAKE_HARDWARE 00187 }; 00188 00189 00193 enum serial_control_state_e { 00194 RIG_SIGNAL_UNSET = 0, 00195 RIG_SIGNAL_ON, 00196 RIG_SIGNAL_OFF 00197 }; 00198 00200 typedef enum { 00201 RIG_FLAG_RECEIVER = (1<<1), 00202 RIG_FLAG_TRANSMITTER = (1<<2), 00203 RIG_FLAG_SCANNER = (1<<3), 00205 RIG_FLAG_MOBILE = (1<<4), 00206 RIG_FLAG_HANDHELD = (1<<5), 00207 RIG_FLAG_COMPUTER = (1<<6), 00208 RIG_FLAG_TRUNKING = (1<<7), 00209 RIG_FLAG_APRS = (1<<8), 00210 RIG_FLAG_TNC = (1<<9), 00211 RIG_FLAG_DXCLUSTER = (1<<10), 00212 RIG_FLAG_TUNER = (1<<11) 00213 } rig_type_t; 00214 00215 #define RIG_FLAG_TRANSCEIVER (RIG_FLAG_RECEIVER|RIG_FLAG_TRANSMITTER) 00216 #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) 00217 00218 #define RIG_TYPE_OTHER 0 00219 #define RIG_TYPE_TRANSCEIVER RIG_FLAG_TRANSCEIVER 00220 #define RIG_TYPE_HANDHELD (RIG_FLAG_TRANSCEIVER|RIG_FLAG_HANDHELD) 00221 #define RIG_TYPE_MOBILE (RIG_FLAG_TRANSCEIVER|RIG_FLAG_MOBILE) 00222 #define RIG_TYPE_RECEIVER RIG_FLAG_RECEIVER 00223 #define RIG_TYPE_PCRECEIVER (RIG_FLAG_COMPUTER|RIG_FLAG_RECEIVER) 00224 #define RIG_TYPE_SCANNER (RIG_FLAG_SCANNER|RIG_FLAG_RECEIVER) 00225 #define RIG_TYPE_TRUNKSCANNER (RIG_TYPE_SCANNER|RIG_FLAG_TRUNKING) 00226 #define RIG_TYPE_COMPUTER (RIG_FLAG_TRANSCEIVER|RIG_FLAG_COMPUTER) 00227 #define RIG_TYPE_TUNER RIG_FLAG_TUNER 00228 00229 00233 enum rig_status_e { 00234 RIG_STATUS_ALPHA = 0, 00235 RIG_STATUS_UNTESTED, 00236 RIG_STATUS_BETA, 00237 RIG_STATUS_STABLE, 00238 RIG_STATUS_BUGGY, 00239 RIG_STATUS_NEW 00240 }; 00241 00245 typedef enum { 00246 RIG_RPT_SHIFT_NONE = 0, 00247 RIG_RPT_SHIFT_MINUS, 00248 RIG_RPT_SHIFT_PLUS 00249 } rptr_shift_t; 00250 00254 typedef enum { 00255 RIG_SPLIT_OFF = 0, 00256 RIG_SPLIT_ON 00257 } split_t; 00258 00263 typedef double freq_t; 00265 #define PRIfreq "f" 00266 00267 #define SCNfreq "lf" 00268 #define FREQFMT SCNfreq 00269 00274 typedef signed long shortfreq_t; 00275 00276 #define Hz(f) ((freq_t)(f)) 00277 #define kHz(f) ((freq_t)((f)*(freq_t)1000)) 00278 #define MHz(f) ((freq_t)((f)*(freq_t)1000000)) 00279 #define GHz(f) ((freq_t)((f)*(freq_t)1000000000)) 00280 00281 #define s_Hz(f) ((shortfreq_t)(f)) 00282 #define s_kHz(f) ((shortfreq_t)((f)*(shortfreq_t)1000)) 00283 #define s_MHz(f) ((shortfreq_t)((f)*(shortfreq_t)1000000)) 00284 #define s_GHz(f) ((shortfreq_t)((f)*(shortfreq_t)1000000000)) 00285 00286 #define RIG_FREQ_NONE Hz(0) 00287 00288 00304 typedef int vfo_t; 00305 00307 #define RIG_VFO_NONE 0 00308 00309 #define RIG_VFO_TX_FLAG ((vfo_t)(1<<30)) 00310 00312 #define RIG_VFO_CURR ((vfo_t)(1<<29)) 00313 00315 #define RIG_VFO_MEM ((vfo_t)(1<<28)) 00316 00318 #define RIG_VFO_VFO ((vfo_t)(1<<27)) 00319 00320 #define RIG_VFO_TX_VFO(v) ((v)|RIG_VFO_TX_FLAG) 00321 00323 #define RIG_VFO_TX RIG_VFO_TX_VFO(RIG_VFO_CURR) 00324 00326 #define RIG_VFO_RX RIG_VFO_CURR 00327 00329 #define RIG_VFO_MAIN ((vfo_t)(1<<26)) 00330 00331 #define RIG_VFO_SUB ((vfo_t)(1<<25)) 00332 00333 #define RIG_VFO_N(n) ((vfo_t)(1<<(n))) 00334 00336 #define RIG_VFO_A RIG_VFO_N(0) 00337 00338 #define RIG_VFO_B RIG_VFO_N(1) 00339 00340 #define RIG_VFO_C RIG_VFO_N(2) 00341 00342 00343 /* 00344 * targetable bitfields, for internal use. 00345 * RIG_TARGETABLE_PURE means a pure targetable radio on every command 00346 */ 00347 #define RIG_TARGETABLE_NONE 0 00348 #define RIG_TARGETABLE_FREQ (1<<0) 00349 #define RIG_TARGETABLE_MODE (1<<1) 00350 #define RIG_TARGETABLE_PURE (1<<2) 00351 #define RIG_TARGETABLE_ALL 0x7fffffff 00352 00353 00354 #define RIG_PASSBAND_NORMAL s_Hz(0) 00355 00359 typedef shortfreq_t pbwidth_t; 00360 00361 00365 typedef enum dcd_e { 00366 RIG_DCD_OFF = 0, 00367 RIG_DCD_ON 00368 } dcd_t; 00369 00374 typedef enum { 00375 RIG_DCD_NONE = 0, 00376 RIG_DCD_RIG, 00377 RIG_DCD_SERIAL_DSR, 00378 RIG_DCD_SERIAL_CTS, 00379 RIG_DCD_SERIAL_CAR, 00380 RIG_DCD_PARALLEL 00381 } dcd_type_t; 00382 00383 00387 typedef enum { 00388 RIG_PTT_OFF = 0, 00389 RIG_PTT_ON 00390 } ptt_t; 00391 00396 typedef enum { 00397 RIG_PTT_NONE = 0, 00398 RIG_PTT_RIG, 00399 RIG_PTT_SERIAL_DTR, 00400 RIG_PTT_SERIAL_RTS, 00401 RIG_PTT_PARALLEL 00402 } ptt_type_t; 00403 00407 typedef enum { 00408 RIG_POWER_OFF = 0, 00409 RIG_POWER_ON = (1<<0), 00410 RIG_POWER_STANDBY = (1<<1) 00411 } powerstat_t; 00412 00416 typedef enum { 00417 RIG_RESET_NONE = 0, 00418 RIG_RESET_SOFT = (1<<0), 00419 RIG_RESET_VFO = (1<<1), 00420 RIG_RESET_MCALL = (1<<2), 00421 RIG_RESET_MASTER = (1<<3) 00422 } reset_t; 00423 00424 00440 typedef enum { 00441 RIG_OP_NONE = 0, 00442 RIG_OP_CPY = (1<<0), 00443 RIG_OP_XCHG = (1<<1), 00444 RIG_OP_FROM_VFO = (1<<2), 00445 RIG_OP_TO_VFO = (1<<3), 00446 RIG_OP_MCL = (1<<4), 00447 RIG_OP_UP = (1<<5), 00448 RIG_OP_DOWN = (1<<6), 00449 RIG_OP_BAND_UP = (1<<7), 00450 RIG_OP_BAND_DOWN = (1<<8), 00451 RIG_OP_LEFT = (1<<9), 00452 RIG_OP_RIGHT = (1<<10), 00453 RIG_OP_TUNE = (1<<11), 00454 RIG_OP_TOGGLE = (1<<12) 00455 } vfo_op_t; 00456 00457 00466 typedef enum { 00467 RIG_SCAN_NONE = 0, 00468 RIG_SCAN_STOP = RIG_SCAN_NONE, 00469 RIG_SCAN_MEM = (1<<0), 00470 RIG_SCAN_SLCT = (1<<1), 00471 RIG_SCAN_PRIO = (1<<2), 00472 RIG_SCAN_PROG = (1<<3), 00473 RIG_SCAN_DELTA = (1<<4), 00474 RIG_SCAN_VFO = (1<<5), 00475 RIG_SCAN_PLT = (1<<6) 00476 } scan_t; 00477 00481 typedef long token_t; 00482 00483 #define RIG_CONF_END 0 00484 00497 /* strongly inspired from soundmodem. Thanks Thomas! */ 00498 00499 enum rig_conf_e { 00500 RIG_CONF_STRING, 00501 RIG_CONF_COMBO, 00502 RIG_CONF_NUMERIC, 00503 RIG_CONF_CHECKBUTTON 00504 }; 00505 00506 #define RIG_COMBO_MAX 8 00507 00511 struct confparams { 00512 token_t token; 00513 const char *name; 00514 const char *label; 00515 const char *tooltip; 00516 const char *dflt; 00517 enum rig_conf_e type; 00518 union { 00519 struct { 00520 float min; 00521 float max; 00522 float step; 00523 } n; 00524 struct { 00525 const char *combostr[RIG_COMBO_MAX]; 00526 } c; 00527 } u; 00528 }; 00529 00534 typedef enum { 00535 RIG_ANN_NONE = 0, 00536 RIG_ANN_OFF = RIG_ANN_NONE, 00537 RIG_ANN_FREQ = (1<<0), 00538 RIG_ANN_RXMODE = (1<<1), 00539 RIG_ANN_CW = (1<<2), 00540 RIG_ANN_ENG = (1<<3), 00541 RIG_ANN_JAP = (1<<4) 00542 } ann_t; 00543 00544 00548 typedef int ant_t; 00549 00550 #define RIG_ANT_NONE 0 00551 #define RIG_ANT_N(n) ((ant_t)1<<(n)) 00552 #define RIG_ANT_1 RIG_ANT_N(0) 00553 #define RIG_ANT_2 RIG_ANT_N(1) 00554 #define RIG_ANT_3 RIG_ANT_N(2) 00555 #define RIG_ANT_4 RIG_ANT_N(3) 00556 00560 /* TODO: kill me, and replace by real AGC delay */ 00561 enum agc_level_e { 00562 RIG_AGC_OFF = 0, 00563 RIG_AGC_SUPERFAST, 00564 RIG_AGC_FAST, 00565 RIG_AGC_SLOW, 00566 RIG_AGC_USER, 00567 RIG_AGC_MEDIUM 00568 }; 00569 00573 enum meter_level_e { 00574 RIG_METER_NONE = 0, /*< No display meter */ 00575 RIG_METER_SWR = (1<<0), /*< Stationary Wave Ratio */ 00576 RIG_METER_COMP = (1<<1), /*< Compression level */ 00577 RIG_METER_ALC = (1<<2), /*< ALC */ 00578 RIG_METER_IC = (1<<3), /*< IC */ 00579 RIG_METER_DB = (1<<4) /*< DB */ 00580 }; 00581 00586 typedef union { 00587 signed int i; 00588 float f; 00589 char *s; 00590 const char *cs; 00591 } value_t; 00592 00601 enum rig_level_e { 00602 RIG_LEVEL_NONE = 0, 00603 RIG_LEVEL_PREAMP = (1<<0), 00604 RIG_LEVEL_ATT = (1<<1), 00605 RIG_LEVEL_VOX = (1<<2), 00606 RIG_LEVEL_AF = (1<<3), 00607 RIG_LEVEL_RF = (1<<4), 00608 RIG_LEVEL_SQL = (1<<5), 00609 RIG_LEVEL_IF = (1<<6), 00610 RIG_LEVEL_APF = (1<<7), 00611 RIG_LEVEL_NR = (1<<8), 00612 RIG_LEVEL_PBT_IN = (1<<9), 00613 RIG_LEVEL_PBT_OUT = (1<<10), 00614 RIG_LEVEL_CWPITCH = (1<<11), 00615 RIG_LEVEL_RFPOWER = (1<<12), 00616 RIG_LEVEL_MICGAIN = (1<<13), 00617 RIG_LEVEL_KEYSPD = (1<<14), 00618 RIG_LEVEL_NOTCHF = (1<<15), 00619 RIG_LEVEL_COMP = (1<<16), 00620 RIG_LEVEL_AGC = (1<<17), 00621 RIG_LEVEL_BKINDL = (1<<18), 00622 RIG_LEVEL_BALANCE = (1<<19), 00623 RIG_LEVEL_METER = (1<<20), 00625 RIG_LEVEL_VOXGAIN = (1<<21), 00626 RIG_LEVEL_VOXDELAY = RIG_LEVEL_VOX, 00627 RIG_LEVEL_ANTIVOX = (1<<22), 00628 RIG_LEVEL_SLOPE_LOW = (1<<23), 00629 RIG_LEVEL_SLOPE_HIGH = (1<<24), 00630 //RIG_LEVEL_LINEOUT = (1<<23),/*!< Lineout Volume, arg float [0.0 ... 1.0] */ 00631 00633 RIG_LEVEL_RAWSTR = (1<<26), 00634 RIG_LEVEL_SQLSTAT = (1<<27), 00635 RIG_LEVEL_SWR = (1<<28), 00636 RIG_LEVEL_ALC = (1<<29), 00637 RIG_LEVEL_STRENGTH =(1<<30) 00638 /*RIG_LEVEL_BWC = (1<<31)*/ 00639 }; 00640 00641 #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) 00642 00643 #define RIG_LEVEL_READONLY_LIST (RIG_LEVEL_SQLSTAT|RIG_LEVEL_SWR|RIG_LEVEL_ALC|RIG_LEVEL_STRENGTH|RIG_LEVEL_RAWSTR) 00644 00645 #define RIG_LEVEL_IS_FLOAT(l) ((l)&RIG_LEVEL_FLOAT_LIST) 00646 #define RIG_LEVEL_SET(l) ((l)&~RIG_LEVEL_READONLY_LIST) 00647 00648 00657 enum rig_parm_e { 00658 RIG_PARM_NONE = 0, 00659 RIG_PARM_ANN = (1<<0), 00660 RIG_PARM_APO = (1<<1), 00661 RIG_PARM_BACKLIGHT = (1<<2), 00662 RIG_PARM_BEEP = (1<<4), 00663 RIG_PARM_TIME = (1<<5), 00664 RIG_PARM_BAT = (1<<6), 00665 RIG_PARM_KEYLIGHT = (1<<7) 00666 }; 00667 00668 #define RIG_PARM_FLOAT_LIST (RIG_PARM_BACKLIGHT|RIG_PARM_BAT) 00669 #define RIG_PARM_READONLY_LIST (RIG_PARM_BAT) 00670 00671 #define RIG_PARM_IS_FLOAT(l) ((l)&RIG_PARM_FLOAT_LIST) 00672 #define RIG_PARM_SET(l) ((l)&~RIG_PARM_READONLY_LIST) 00673 00674 #define RIG_SETTING_MAX 32 00675 00681 typedef unsigned long setting_t; 00682 00683 /* 00684 * tranceive mode, ie. the rig notify the host of any event, 00685 * like freq changed, mode changed, etc. 00686 */ 00687 #define RIG_TRN_OFF 0 00688 #define RIG_TRN_RIG 1 00689 #define RIG_TRN_POLL 2 00690 00691 00700 enum rig_func_e { 00701 RIG_FUNC_NONE = 0, 00702 RIG_FUNC_FAGC = (1<<0), 00703 RIG_FUNC_NB = (1<<1), 00704 RIG_FUNC_COMP = (1<<2), 00705 RIG_FUNC_VOX = (1<<3), 00706 RIG_FUNC_TONE = (1<<4), 00707 RIG_FUNC_TSQL = (1<<5), 00708 RIG_FUNC_SBKIN = (1<<6), 00709 RIG_FUNC_FBKIN = (1<<7), 00710 RIG_FUNC_ANF = (1<<8), 00711 RIG_FUNC_NR = (1<<9), 00712 RIG_FUNC_AIP = (1<<10), 00713 RIG_FUNC_APF = (1<<11), 00714 RIG_FUNC_MON = (1<<12), 00715 RIG_FUNC_MN = (1<<13), 00716 RIG_FUNC_RF = (1<<14), 00717 RIG_FUNC_ARO = (1<<15), 00718 RIG_FUNC_LOCK = (1<<16), 00719 RIG_FUNC_MUTE = (1<<17), 00720 RIG_FUNC_VSC = (1<<18), 00721 RIG_FUNC_REV = (1<<19), 00722 RIG_FUNC_SQL = (1<<20), 00723 RIG_FUNC_ABM = (1<<21), 00724 RIG_FUNC_BC = (1<<22), 00725 RIG_FUNC_MBC = (1<<23), 00726 /* (1<<24), used to be RIG_FUNC_LMP, see RIG_PARM_BACKLIGHT instead) */ 00727 RIG_FUNC_AFC = (1<<25), 00728 RIG_FUNC_SATMODE = (1<<26), 00729 RIG_FUNC_SCOPE = (1<<27), 00730 RIG_FUNC_RESUME = (1<<28), 00731 RIG_FUNC_TBURST = (1<<29), 00732 RIG_FUNC_TUNER = (1<<30) 00733 }; 00734 00735 /* 00736 * power unit macros, converts to mW 00737 * This is limited to 2MW on 32 bits systems. 00738 */ 00739 #define mW(p) ((int)(p)) 00740 #define Watts(p) ((int)((p)*1000)) 00741 #define W(p) Watts(p) 00742 #define kW(p) ((int)((p)*1000000L)) 00743 00752 typedef enum { 00753 RIG_MODE_NONE = 0, 00754 RIG_MODE_AM = (1<<0), 00755 RIG_MODE_CW = (1<<1), 00756 RIG_MODE_USB = (1<<2), 00757 RIG_MODE_LSB = (1<<3), 00758 RIG_MODE_RTTY = (1<<4), 00759 RIG_MODE_FM = (1<<5), 00760 RIG_MODE_WFM = (1<<6), 00761 RIG_MODE_CWR = (1<<7), 00762 RIG_MODE_RTTYR = (1<<8), 00763 RIG_MODE_AMS = (1<<9), 00764 RIG_MODE_PKTLSB = (1<<10), 00765 RIG_MODE_PKTUSB = (1<<11), 00766 RIG_MODE_PKTFM = (1<<12), 00767 RIG_MODE_ECSSUSB = (1<<13), 00768 RIG_MODE_ECSSLSB = (1<<14), 00769 RIG_MODE_FAX = (1<<15), 00770 RIG_MODE_SAM = (1<<16), 00771 RIG_MODE_SAL = (1<<17), 00772 RIG_MODE_SAH = (1<<18), 00773 RIG_MODE_DSB = (1<<19) 00774 } rmode_t; 00775 00777 #define RIG_MODE_SSB (RIG_MODE_USB|RIG_MODE_LSB) 00778 00780 #define RIG_MODE_ECSS (RIG_MODE_ECSSUSB|RIG_MODE_ECSSLSB) 00781 00782 00783 #define RIG_DBLST_END 0 /* end marker in a preamp/att level list */ 00784 #define RIG_IS_DBLST_END(d) ((d)==0) 00785 00792 typedef struct freq_range_list { 00793 freq_t start; 00794 freq_t end; 00795 rmode_t modes; 00796 int low_power; 00797 int high_power; 00798 vfo_t vfo; 00799 ant_t ant; 00800 } freq_range_t; 00801 00802 #define RIG_FRNG_END {Hz(0),Hz(0),RIG_MODE_NONE,0,0,RIG_VFO_NONE} 00803 #define RIG_IS_FRNG_END(r) ((r).start == Hz(0) && (r).end == Hz(0)) 00804 00805 #define RIG_ITU_REGION1 1 00806 #define RIG_ITU_REGION2 2 00807 #define RIG_ITU_REGION3 3 00808 00828 struct tuning_step_list { 00829 rmode_t modes; 00830 shortfreq_t ts; 00831 }; 00832 00833 #define RIG_TS_ANY 0 00834 #define RIG_TS_END {RIG_MODE_NONE,0} 00835 #define RIG_IS_TS_END(t) ((t).modes == RIG_MODE_NONE && (t).ts == 0) 00836 00863 struct filter_list { 00864 rmode_t modes; 00865 pbwidth_t width; 00866 }; 00867 00868 #define RIG_FLT_ANY 0 00869 #define RIG_FLT_END {RIG_MODE_NONE,0} 00870 #define RIG_IS_FLT_END(f) ((f).modes == RIG_MODE_NONE) 00871 00872 00873 /* 00874 * Used in the channel.flags field 00875 */ 00876 #define RIG_CHFLAG_NONE 0 00877 #define RIG_CHFLAG_SKIP (1<<0) 00878 /* DATA port mode flag */ 00879 #define RIG_CHFLAG_DATA (1<<1) 00880 00885 struct ext_list { 00886 token_t token; 00887 value_t val; 00888 }; 00889 00890 #define RIG_EXT_END {0, {.i=0}} 00891 #define RIG_IS_EXT_END(x) ((x).token == 0) 00892 00900 struct channel { 00901 int channel_num; 00902 int bank_num; 00903 vfo_t vfo; 00904 int ant; 00905 freq_t freq; 00906 rmode_t mode; 00907 pbwidth_t width; 00909 freq_t tx_freq; 00910 rmode_t tx_mode; 00911 pbwidth_t tx_width; 00913 split_t split; 00914 vfo_t tx_vfo; 00916 rptr_shift_t rptr_shift; 00917 shortfreq_t rptr_offs; 00918 shortfreq_t tuning_step; 00919 shortfreq_t rit; 00920 shortfreq_t xit; 00921 setting_t funcs; 00922 value_t levels[RIG_SETTING_MAX]; 00923 tone_t ctcss_tone; 00924 tone_t ctcss_sql; 00925 tone_t dcs_code; 00926 tone_t dcs_sql; 00927 int scan_group; 00928 int flags; 00929 char channel_desc[MAXCHANDESC]; 00930 struct ext_list *ext_levels; 00931 }; 00933 typedef struct channel channel_t; 00934 00940 struct channel_cap { 00941 unsigned bank_num:1; 00942 unsigned vfo:1; 00943 unsigned ant:1; 00944 unsigned freq:1; 00945 unsigned mode:1; 00946 unsigned width:1; 00948 unsigned tx_freq:1; 00949 unsigned tx_mode:1; 00950 unsigned tx_width:1; 00952 unsigned split:1; 00953 unsigned tx_vfo:1; 00954 unsigned rptr_shift:1; 00955 unsigned rptr_offs:1; 00956 unsigned tuning_step:1; 00957 unsigned rit:1; 00958 unsigned xit:1; 00959 setting_t funcs; 00960 setting_t levels; 00961 unsigned ctcss_tone:1; 00962 unsigned ctcss_sql:1; 00963 unsigned dcs_code:1; 00964 unsigned dcs_sql:1; 00965 unsigned scan_group:1; 00966 unsigned flags:1; 00967 unsigned channel_desc:1; 00968 unsigned ext_levels:1; 00969 }; 00970 00972 typedef struct channel_cap channel_cap_t; 00973 00974 00985 typedef enum { 00986 RIG_MTYPE_NONE=0, 00987 RIG_MTYPE_MEM, 00988 RIG_MTYPE_EDGE, 00989 RIG_MTYPE_CALL, 00990 RIG_MTYPE_MEMOPAD, 00991 RIG_MTYPE_SAT 00992 } chan_type_t; 00993 01007 struct chan_list { 01008 int start; 01009 int end; 01010 chan_type_t type; 01011 channel_cap_t mem_caps; 01012 }; 01013 01014 #define RIG_CHAN_END {0,0,RIG_MTYPE_NONE} 01015 #define RIG_IS_CHAN_END(c) ((c).type == RIG_MTYPE_NONE) 01016 01018 typedef struct chan_list chan_t; 01019 01031 struct gran { 01032 value_t min; 01033 value_t max; 01034 value_t step; 01035 }; 01036 01038 typedef struct gran gran_t; 01039 01040 01042 struct cal_table { 01043 int size; 01044 struct { 01045 int raw; 01046 int val; 01047 } table[MAX_CAL_LENGTH]; 01048 }; 01049 01062 typedef struct cal_table cal_table_t; 01063 01064 #define EMPTY_STR_CAL { 0, { { 0, 0 }, } } 01065 01066 01067 typedef int (*chan_cb_t) (RIG *, channel_t**, int, const chan_t*, rig_ptr_t); 01068 typedef int (*confval_cb_t) (RIG *, const struct confparams *, value_t *, rig_ptr_t); 01069 01088 struct rig_caps { 01089 rig_model_t rig_model; 01090 const char *model_name; 01091 const char *mfg_name; 01092 const char *version; 01093 const char *copyright; 01094 enum rig_status_e status; 01096 int rig_type; 01097 ptt_type_t ptt_type; 01098 dcd_type_t dcd_type; 01099 rig_port_t port_type; 01101 int serial_rate_min; 01102 int serial_rate_max; 01103 int serial_data_bits; 01104 int serial_stop_bits; 01105 enum serial_parity_e serial_parity; 01106 enum serial_handshake_e serial_handshake; 01108 int write_delay; 01109 int post_write_delay; 01110 int timeout; 01111 int retry; 01113 setting_t has_get_func; 01114 setting_t has_set_func; 01115 setting_t has_get_level; 01116 setting_t has_set_level; 01117 setting_t has_get_parm; 01118 setting_t has_set_parm; 01120 gran_t level_gran[RIG_SETTING_MAX]; 01121 gran_t parm_gran[RIG_SETTING_MAX]; 01123 const struct confparams *extparms; 01124 const struct confparams *extlevels; 01126 const tone_t *ctcss_list; 01127 const tone_t *dcs_list; 01129 int preamp[MAXDBLSTSIZ]; 01130 int attenuator[MAXDBLSTSIZ]; 01131 shortfreq_t max_rit; 01132 shortfreq_t max_xit; 01133 shortfreq_t max_ifshift; 01135 ann_t announces; 01137 vfo_op_t vfo_ops; 01138 scan_t scan_ops; 01139 int targetable_vfo; 01140 int transceive; 01142 int bank_qty; 01143 int chan_desc_sz; 01145 chan_t chan_list[CHANLSTSIZ]; 01147 freq_range_t rx_range_list1[FRQRANGESIZ]; 01148 freq_range_t tx_range_list1[FRQRANGESIZ]; 01149 freq_range_t rx_range_list2[FRQRANGESIZ]; 01150 freq_range_t tx_range_list2[FRQRANGESIZ]; 01152 struct tuning_step_list tuning_steps[TSLSTSIZ]; 01153 struct filter_list filters[FLTLSTSIZ]; 01155 cal_table_t str_cal; 01157 const struct confparams *cfgparams; 01158 const rig_ptr_t priv; 01160 /* 01161 * Rig API 01162 * 01163 */ 01164 01165 int (*rig_init) (RIG * rig); 01166 int (*rig_cleanup) (RIG * rig); 01167 int (*rig_open) (RIG * rig); 01168 int (*rig_close) (RIG * rig); 01169 01170 /* 01171 * General API commands, from most primitive to least.. :() 01172 * List Set/Get functions pairs 01173 */ 01174 01175 int (*set_freq) (RIG * rig, vfo_t vfo, freq_t freq); 01176 int (*get_freq) (RIG * rig, vfo_t vfo, freq_t * freq); 01177 01178 int (*set_mode) (RIG * rig, vfo_t vfo, rmode_t mode, 01179 pbwidth_t width); 01180 int (*get_mode) (RIG * rig, vfo_t vfo, rmode_t * mode, 01181 pbwidth_t * width); 01182 01183 int (*set_vfo) (RIG * rig, vfo_t vfo); 01184 int (*get_vfo) (RIG * rig, vfo_t * vfo); 01185 01186 int (*set_ptt) (RIG * rig, vfo_t vfo, ptt_t ptt); 01187 int (*get_ptt) (RIG * rig, vfo_t vfo, ptt_t * ptt); 01188 int (*get_dcd) (RIG * rig, vfo_t vfo, dcd_t * dcd); 01189 01190 int (*set_rptr_shift) (RIG * rig, vfo_t vfo, 01191 rptr_shift_t rptr_shift); 01192 int (*get_rptr_shift) (RIG * rig, vfo_t vfo, 01193 rptr_shift_t * rptr_shift); 01194 01195 int (*set_rptr_offs) (RIG * rig, vfo_t vfo, shortfreq_t offs); 01196 int (*get_rptr_offs) (RIG * rig, vfo_t vfo, shortfreq_t * offs); 01197 01198 int (*set_split_freq) (RIG * rig, vfo_t vfo, freq_t tx_freq); 01199 int (*get_split_freq) (RIG * rig, vfo_t vfo, freq_t * tx_freq); 01200 int (*set_split_mode) (RIG * rig, vfo_t vfo, rmode_t tx_mode, 01201 pbwidth_t tx_width); 01202 int (*get_split_mode) (RIG * rig, vfo_t vfo, rmode_t * tx_mode, 01203 pbwidth_t * tx_width); 01204 01205 int (*set_split_vfo) (RIG * rig, vfo_t vfo, split_t split, vfo_t tx_vfo); 01206 int (*get_split_vfo) (RIG * rig, vfo_t vfo, split_t * split, vfo_t *tx_vfo); 01207 01208 int (*set_rit) (RIG * rig, vfo_t vfo, shortfreq_t rit); 01209 int (*get_rit) (RIG * rig, vfo_t vfo, shortfreq_t * rit); 01210 int (*set_xit) (RIG * rig, vfo_t vfo, shortfreq_t xit); 01211 int (*get_xit) (RIG * rig, vfo_t vfo, shortfreq_t * xit); 01212 01213 int (*set_ts) (RIG * rig, vfo_t vfo, shortfreq_t ts); 01214 int (*get_ts) (RIG * rig, vfo_t vfo, shortfreq_t * ts); 01215 01216 int (*set_dcs_code) (RIG * rig, vfo_t vfo, tone_t code); 01217 int (*get_dcs_code) (RIG * rig, vfo_t vfo, tone_t * code); 01218 int (*set_tone) (RIG * rig, vfo_t vfo, tone_t tone); 01219 int (*get_tone) (RIG * rig, vfo_t vfo, tone_t * tone); 01220 int (*set_ctcss_tone) (RIG * rig, vfo_t vfo, tone_t tone); 01221 int (*get_ctcss_tone) (RIG * rig, vfo_t vfo, tone_t * tone); 01222 01223 int (*set_dcs_sql) (RIG * rig, vfo_t vfo, tone_t code); 01224 int (*get_dcs_sql) (RIG * rig, vfo_t vfo, tone_t * code); 01225 int (*set_tone_sql) (RIG * rig, vfo_t vfo, tone_t tone); 01226 int (*get_tone_sql) (RIG * rig, vfo_t vfo, tone_t * tone); 01227 int (*set_ctcss_sql) (RIG * rig, vfo_t vfo, tone_t tone); 01228 int (*get_ctcss_sql) (RIG * rig, vfo_t vfo, tone_t * tone); 01229 01230 int (*power2mW) (RIG * rig, unsigned int *mwpower, float power, 01231 freq_t freq, rmode_t mode); 01232 int (*mW2power) (RIG * rig, float *power, unsigned int mwpower, 01233 freq_t freq, rmode_t mode); 01234 01235 int (*set_powerstat) (RIG * rig, powerstat_t status); 01236 int (*get_powerstat) (RIG * rig, powerstat_t * status); 01237 int (*reset) (RIG * rig, reset_t reset); 01238 01239 int (*set_ant) (RIG * rig, vfo_t vfo, ant_t ant); 01240 int (*get_ant) (RIG * rig, vfo_t vfo, ant_t * ant); 01241 01242 int (*set_level) (RIG * rig, vfo_t vfo, setting_t level, 01243 value_t val); 01244 int (*get_level) (RIG * rig, vfo_t vfo, setting_t level, 01245 value_t * val); 01246 01247 int (*set_func) (RIG * rig, vfo_t vfo, setting_t func, int status); 01248 int (*get_func) (RIG * rig, vfo_t vfo, setting_t func, 01249 int *status); 01250 01251 int (*set_parm) (RIG * rig, setting_t parm, value_t val); 01252 int (*get_parm) (RIG * rig, setting_t parm, value_t * val); 01253 01254 int (*set_ext_level)(RIG *rig, vfo_t vfo, token_t token, value_t val); 01255 int (*get_ext_level)(RIG *rig, vfo_t vfo, token_t token, value_t *val); 01256 01257 int (*set_ext_parm)(RIG *rig, token_t token, value_t val); 01258 int (*get_ext_parm)(RIG *rig, token_t token, value_t *val); 01259 01260 int (*set_conf) (RIG * rig, token_t token, const char *val); 01261 int (*get_conf) (RIG * rig, token_t token, char *val); 01262 01263 int (*send_dtmf) (RIG * rig, vfo_t vfo, const char *digits); 01264 int (*recv_dtmf) (RIG * rig, vfo_t vfo, char *digits, int *length); 01265 int (*send_morse) (RIG * rig, vfo_t vfo, const char *msg); 01266 01267 int (*set_bank) (RIG * rig, vfo_t vfo, int bank); 01268 int (*set_mem) (RIG * rig, vfo_t vfo, int ch); 01269 int (*get_mem) (RIG * rig, vfo_t vfo, int *ch); 01270 int (*vfo_op) (RIG * rig, vfo_t vfo, vfo_op_t op); 01271 int (*scan) (RIG * rig, vfo_t vfo, scan_t scan, int ch); 01272 01273 int (*set_trn) (RIG * rig, int trn); 01274 int (*get_trn) (RIG * rig, int *trn); 01275 01276 int (*decode_event) (RIG * rig); 01277 01278 int (*set_channel) (RIG * rig, const channel_t * chan); 01279 int (*get_channel) (RIG * rig, channel_t * chan); 01280 01281 const char *(*get_info) (RIG * rig); 01282 01283 int (*set_chan_all_cb) (RIG * rig, chan_cb_t chan_cb, rig_ptr_t); 01284 int (*get_chan_all_cb) (RIG * rig, chan_cb_t chan_cb, rig_ptr_t); 01285 01286 int (*set_mem_all_cb) (RIG * rig, chan_cb_t chan_cb, confval_cb_t parm_cb, rig_ptr_t); 01287 int (*get_mem_all_cb) (RIG * rig, chan_cb_t chan_cb, confval_cb_t parm_cb, rig_ptr_t); 01288 01289 const char *clone_combo_set; 01290 const char *clone_combo_get; 01291 }; 01292 01298 typedef struct { 01299 union { 01300 rig_port_t rig; 01301 ptt_type_t ptt; 01302 dcd_type_t dcd; 01303 } type; 01304 int fd; 01305 void* handle; 01307 int write_delay; 01308 int post_write_delay; 01309 struct { int tv_sec,tv_usec; } post_write_date; 01310 int timeout; 01311 int retry; 01313 char pathname[FILPATHLEN]; 01314 union { 01315 struct { 01316 int rate; 01317 int data_bits; 01318 int stop_bits; 01319 enum serial_parity_e parity; 01320 enum serial_handshake_e handshake; 01321 enum serial_control_state_e rts_state; 01322 enum serial_control_state_e dtr_state; 01323 } serial; 01324 struct { 01325 int pin; 01326 } parallel; 01327 struct { 01328 int vid; 01329 int pid; 01330 int conf; 01331 int iface; 01332 int alt; 01333 } usb; 01334 } parm; 01335 } hamlib_port_t; 01336 01337 #if !defined(__APPLE__) || !defined(__cplusplus) 01338 typedef hamlib_port_t port_t; 01339 #endif 01340 01341 01351 struct rig_state { 01352 /* 01353 * overridable fields 01354 */ 01355 hamlib_port_t rigport; 01356 hamlib_port_t pttport; 01357 hamlib_port_t dcdport; 01359 double vfo_comp; 01361 int itu_region; 01362 freq_range_t rx_range_list[FRQRANGESIZ]; 01363 freq_range_t tx_range_list[FRQRANGESIZ]; 01365 struct tuning_step_list tuning_steps[TSLSTSIZ]; 01367 struct filter_list filters[FLTLSTSIZ]; 01369 cal_table_t str_cal; 01371 chan_t chan_list[CHANLSTSIZ]; 01373 shortfreq_t max_rit; 01374 shortfreq_t max_xit; 01375 shortfreq_t max_ifshift; 01377 ann_t announces; 01379 int preamp[MAXDBLSTSIZ]; 01380 int attenuator[MAXDBLSTSIZ]; 01382 setting_t has_get_func; 01383 setting_t has_set_func; 01384 setting_t has_get_level; 01385 setting_t has_set_level; 01386 setting_t has_get_parm; 01387 setting_t has_set_parm; 01389 gran_t level_gran[RIG_SETTING_MAX]; 01390 gran_t parm_gran[RIG_SETTING_MAX]; 01393 /* 01394 * non overridable fields, internal use 01395 */ 01396 01397 int hold_decode; 01398 vfo_t current_vfo; 01399 int vfo_list; 01400 int comm_state; 01401 rig_ptr_t priv; 01402 rig_ptr_t obj; 01404 int transceive; 01405 int poll_interval; 01406 freq_t current_freq; 01407 rmode_t current_mode; 01408 pbwidth_t current_width; 01410 }; 01411 01412 01413 typedef int (*vprintf_cb_t) (enum rig_debug_level_e, rig_ptr_t, const char *, va_list); 01414 01415 typedef int (*freq_cb_t) (RIG *, vfo_t, freq_t, rig_ptr_t); 01416 typedef int (*mode_cb_t) (RIG *, vfo_t, rmode_t, pbwidth_t, rig_ptr_t); 01417 typedef int (*vfo_cb_t) (RIG *, vfo_t, rig_ptr_t); 01418 typedef int (*ptt_cb_t) (RIG *, vfo_t, ptt_t, rig_ptr_t); 01419 typedef int (*dcd_cb_t) (RIG *, vfo_t, dcd_t, rig_ptr_t); 01420 typedef int (*pltune_cb_t) (RIG *, vfo_t, freq_t *, rmode_t *, pbwidth_t *, rig_ptr_t); 01421 01439 struct rig_callbacks { 01440 freq_cb_t freq_event; 01441 rig_ptr_t freq_arg; 01442 mode_cb_t mode_event; 01443 rig_ptr_t mode_arg; 01444 vfo_cb_t vfo_event; 01445 rig_ptr_t vfo_arg; 01446 ptt_cb_t ptt_event; 01447 rig_ptr_t ptt_arg; 01448 dcd_cb_t dcd_event; 01449 rig_ptr_t dcd_arg; 01450 pltune_cb_t pltune; 01451 rig_ptr_t pltune_arg; 01452 /* etc.. */ 01453 }; 01454 01464 struct rig { 01465 struct rig_caps *caps; 01466 struct rig_state state; 01467 struct rig_callbacks callbacks; 01468 }; 01469 01470 01471 01472 /* --------------- API function prototypes -----------------*/ 01473 01474 extern HAMLIB_EXPORT(RIG *) rig_init HAMLIB_PARAMS((rig_model_t rig_model)); 01475 extern HAMLIB_EXPORT(int) rig_open HAMLIB_PARAMS((RIG *rig)); 01476 01477 /* 01478 * General API commands, from most primitive to least.. :() 01479 * List Set/Get functions pairs 01480 */ 01481 01482 extern HAMLIB_EXPORT(int) rig_set_freq HAMLIB_PARAMS((RIG *rig, vfo_t vfo, freq_t freq)); 01483 extern HAMLIB_EXPORT(int) rig_get_freq HAMLIB_PARAMS((RIG *rig, vfo_t vfo, freq_t *freq)); 01484 01485 extern HAMLIB_EXPORT(int) rig_set_mode HAMLIB_PARAMS((RIG *rig, vfo_t vfo, rmode_t mode, pbwidth_t width)); 01486 extern HAMLIB_EXPORT(int) rig_get_mode HAMLIB_PARAMS((RIG *rig, vfo_t vfo, rmode_t *mode, pbwidth_t *width)); 01487 01488 extern HAMLIB_EXPORT(int) rig_set_vfo HAMLIB_PARAMS((RIG *rig, vfo_t vfo)); 01489 extern HAMLIB_EXPORT(int) rig_get_vfo HAMLIB_PARAMS((RIG *rig, vfo_t *vfo)); 01490 01491 extern HAMLIB_EXPORT(int) rig_set_ptt HAMLIB_PARAMS((RIG *rig, vfo_t vfo, ptt_t ptt)); 01492 extern HAMLIB_EXPORT(int) rig_get_ptt HAMLIB_PARAMS((RIG *rig, vfo_t vfo, ptt_t *ptt)); 01493 01494 extern HAMLIB_EXPORT(int) rig_get_dcd HAMLIB_PARAMS((RIG *rig, vfo_t vfo, dcd_t *dcd)); 01495 01496 extern HAMLIB_EXPORT(int) rig_set_rptr_shift HAMLIB_PARAMS((RIG *rig, vfo_t vfo, rptr_shift_t rptr_shift)); 01497 extern HAMLIB_EXPORT(int) rig_get_rptr_shift HAMLIB_PARAMS((RIG *rig, vfo_t vfo, rptr_shift_t *rptr_shift)); 01498 extern HAMLIB_EXPORT(int) rig_set_rptr_offs HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t rptr_offs)); 01499 extern HAMLIB_EXPORT(int) rig_get_rptr_offs HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t *rptr_offs)); 01500 01501 extern HAMLIB_EXPORT(int) rig_set_ctcss_tone HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t tone)); 01502 extern HAMLIB_EXPORT(int) rig_get_ctcss_tone HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t *tone)); 01503 extern HAMLIB_EXPORT(int) rig_set_dcs_code HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t code)); 01504 extern HAMLIB_EXPORT(int) rig_get_dcs_code HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t *code)); 01505 01506 extern HAMLIB_EXPORT(int) rig_set_ctcss_sql HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t tone)); 01507 extern HAMLIB_EXPORT(int) rig_get_ctcss_sql HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t *tone)); 01508 extern HAMLIB_EXPORT(int) rig_set_dcs_sql HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t code)); 01509 extern HAMLIB_EXPORT(int) rig_get_dcs_sql HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t *code)); 01510 01511 extern HAMLIB_EXPORT(int) rig_set_split_freq HAMLIB_PARAMS((RIG *rig, vfo_t vfo, freq_t tx_freq)); 01512 extern HAMLIB_EXPORT(int) rig_get_split_freq HAMLIB_PARAMS((RIG *rig, vfo_t vfo, freq_t *tx_freq)); 01513 extern HAMLIB_EXPORT(int) rig_set_split_mode HAMLIB_PARAMS((RIG *rig, vfo_t vfo, rmode_t tx_mode, pbwidth_t tx_width)); 01514 extern HAMLIB_EXPORT(int) rig_get_split_mode HAMLIB_PARAMS((RIG *rig, vfo_t vfo, rmode_t *tx_mode, pbwidth_t *tx_width)); 01515 extern HAMLIB_EXPORT(int) rig_set_split_vfo HAMLIB_PARAMS((RIG*, vfo_t rx_vfo, split_t split, vfo_t tx_vfo)); 01516 extern HAMLIB_EXPORT(int) rig_get_split_vfo HAMLIB_PARAMS((RIG*, vfo_t rx_vfo, split_t *split, vfo_t *tx_vfo)); 01517 #define rig_set_split(r,v,s) rig_set_split_vfo((r),(v),(s),RIG_VFO_CURR) 01518 #define rig_get_split(r,v,s) ({ vfo_t _tx_vfo; rig_get_split_vfo((r),(v),(s),&_tx_vfo); }) 01519 01520 extern HAMLIB_EXPORT(int) rig_set_rit HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t rit)); 01521 extern HAMLIB_EXPORT(int) rig_get_rit HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t *rit)); 01522 extern HAMLIB_EXPORT(int) rig_set_xit HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t xit)); 01523 extern HAMLIB_EXPORT(int) rig_get_xit HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t *xit)); 01524 01525 extern HAMLIB_EXPORT(int) rig_set_ts HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t ts)); 01526 extern HAMLIB_EXPORT(int) rig_get_ts HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t *ts)); 01527 01528 extern HAMLIB_EXPORT(int) rig_power2mW HAMLIB_PARAMS((RIG *rig, unsigned int *mwpower, float power, freq_t freq, rmode_t mode)); 01529 extern HAMLIB_EXPORT(int) rig_mW2power HAMLIB_PARAMS((RIG *rig, float *power, unsigned int mwpower, freq_t freq, rmode_t mode)); 01530 01531 extern HAMLIB_EXPORT(shortfreq_t) rig_get_resolution HAMLIB_PARAMS((RIG *rig, rmode_t mode)); 01532 01533 extern HAMLIB_EXPORT(int) rig_set_level HAMLIB_PARAMS((RIG *rig, vfo_t vfo, setting_t level, value_t val)); 01534 extern HAMLIB_EXPORT(int) rig_get_level HAMLIB_PARAMS((RIG *rig, vfo_t vfo, setting_t level, value_t *val)); 01535 01536 #define rig_get_strength(r,v,s) rig_get_level((r),(v),RIG_LEVEL_STRENGTH, (value_t*)(s)) 01537 01538 extern HAMLIB_EXPORT(int) rig_set_parm HAMLIB_PARAMS((RIG *rig, setting_t parm, value_t val)); 01539 extern HAMLIB_EXPORT(int) rig_get_parm HAMLIB_PARAMS((RIG *rig, setting_t parm, value_t *val)); 01540 01541 extern HAMLIB_EXPORT(int) rig_set_conf HAMLIB_PARAMS((RIG *rig, token_t token, const char *val)); 01542 extern HAMLIB_EXPORT(int) rig_get_conf HAMLIB_PARAMS((RIG *rig, token_t token, char *val)); 01543 01544 extern HAMLIB_EXPORT(int) rig_set_powerstat HAMLIB_PARAMS((RIG *rig, powerstat_t status)); 01545 extern HAMLIB_EXPORT(int) rig_get_powerstat HAMLIB_PARAMS((RIG *rig, powerstat_t *status)); 01546 01547 extern HAMLIB_EXPORT(int) rig_reset HAMLIB_PARAMS((RIG *rig, reset_t reset)); /* dangerous! */ 01548 01549 extern HAMLIB_EXPORT(int) rig_set_ext_level HAMLIB_PARAMS((RIG *rig, vfo_t vfo, 01550 token_t token, value_t val)); 01551 extern HAMLIB_EXPORT(int) rig_get_ext_level HAMLIB_PARAMS((RIG *rig, vfo_t vfo, 01552 token_t token, value_t *val)); 01553 01554 extern HAMLIB_EXPORT(int) rig_set_ext_parm HAMLIB_PARAMS((RIG *rig, token_t token, value_t val)); 01555 extern HAMLIB_EXPORT(int) rig_get_ext_parm HAMLIB_PARAMS((RIG *rig, token_t token, value_t *val)); 01556 01557 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)); 01558 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)); 01559 extern HAMLIB_EXPORT(const struct confparams*) rig_ext_lookup HAMLIB_PARAMS((RIG *rig, const char *name)); 01560 extern HAMLIB_EXPORT(const struct confparams *) rig_ext_lookup_tok HAMLIB_PARAMS((RIG *rig, token_t token)); 01561 extern HAMLIB_EXPORT(token_t) rig_ext_token_lookup HAMLIB_PARAMS((RIG *rig, const char *name)); 01562 01563 01564 extern HAMLIB_EXPORT(int) rig_token_foreach HAMLIB_PARAMS((RIG *rig, int (*cfunc)(const struct confparams *, rig_ptr_t), rig_ptr_t data)); 01565 extern HAMLIB_EXPORT(const struct confparams*) rig_confparam_lookup HAMLIB_PARAMS((RIG *rig, const char *name)); 01566 extern HAMLIB_EXPORT(token_t) rig_token_lookup HAMLIB_PARAMS((RIG *rig, const char *name)); 01567 01568 extern HAMLIB_EXPORT(int) rig_close HAMLIB_PARAMS((RIG *rig)); 01569 extern HAMLIB_EXPORT(int) rig_cleanup HAMLIB_PARAMS((RIG *rig)); 01570 01571 extern HAMLIB_EXPORT(int) rig_set_ant HAMLIB_PARAMS((RIG *rig, vfo_t vfo, ant_t ant)); /* antenna */ 01572 extern HAMLIB_EXPORT(int) rig_get_ant HAMLIB_PARAMS((RIG *rig, vfo_t vfo, ant_t *ant)); 01573 01574 extern HAMLIB_EXPORT(setting_t) rig_has_get_level HAMLIB_PARAMS((RIG *rig, setting_t level)); 01575 extern HAMLIB_EXPORT(setting_t) rig_has_set_level HAMLIB_PARAMS((RIG *rig, setting_t level)); 01576 01577 extern HAMLIB_EXPORT(setting_t) rig_has_get_parm HAMLIB_PARAMS((RIG *rig, setting_t parm)); 01578 extern HAMLIB_EXPORT(setting_t) rig_has_set_parm HAMLIB_PARAMS((RIG *rig, setting_t parm)); 01579 01580 extern HAMLIB_EXPORT(setting_t) rig_has_get_func HAMLIB_PARAMS((RIG *rig, setting_t func)); 01581 extern HAMLIB_EXPORT(setting_t) rig_has_set_func HAMLIB_PARAMS((RIG *rig, setting_t func)); 01582 01583 extern HAMLIB_EXPORT(int) rig_set_func HAMLIB_PARAMS((RIG *rig, vfo_t vfo, setting_t func, int status)); 01584 extern HAMLIB_EXPORT(int) rig_get_func HAMLIB_PARAMS((RIG *rig, vfo_t vfo, setting_t func, int *status)); 01585 01586 extern HAMLIB_EXPORT(int) rig_send_dtmf HAMLIB_PARAMS((RIG *rig, vfo_t vfo, const char *digits)); 01587 extern HAMLIB_EXPORT(int) rig_recv_dtmf HAMLIB_PARAMS((RIG *rig, vfo_t vfo, char *digits, int *length)); 01588 extern HAMLIB_EXPORT(int) rig_send_morse HAMLIB_PARAMS((RIG *rig, vfo_t vfo, const char *msg)); 01589 01590 extern HAMLIB_EXPORT(int) rig_set_bank HAMLIB_PARAMS((RIG *rig, vfo_t vfo, int bank)); 01591 extern HAMLIB_EXPORT(int) rig_set_mem HAMLIB_PARAMS((RIG *rig, vfo_t vfo, int ch)); 01592 extern HAMLIB_EXPORT(int) rig_get_mem HAMLIB_PARAMS((RIG *rig, vfo_t vfo, int *ch)); 01593 extern HAMLIB_EXPORT(int) rig_vfo_op HAMLIB_PARAMS((RIG *rig, vfo_t vfo, vfo_op_t op)); 01594 extern HAMLIB_EXPORT(vfo_op_t) rig_has_vfo_op HAMLIB_PARAMS((RIG *rig, vfo_op_t op)); 01595 extern HAMLIB_EXPORT(int) rig_scan HAMLIB_PARAMS((RIG *rig, vfo_t vfo, scan_t scan, int ch)); 01596 extern HAMLIB_EXPORT(scan_t) rig_has_scan HAMLIB_PARAMS((RIG *rig, scan_t scan)); 01597 01598 extern HAMLIB_EXPORT(int) rig_set_channel HAMLIB_PARAMS((RIG *rig, const channel_t *chan)); /* mem */ 01599 extern HAMLIB_EXPORT(int) rig_get_channel HAMLIB_PARAMS((RIG *rig, channel_t *chan)); 01600 01601 extern HAMLIB_EXPORT(int) rig_set_chan_all HAMLIB_PARAMS((RIG *rig, const channel_t chans[])); 01602 extern HAMLIB_EXPORT(int) rig_get_chan_all HAMLIB_PARAMS((RIG *rig, channel_t chans[])); 01603 extern HAMLIB_EXPORT(int) rig_set_chan_all_cb HAMLIB_PARAMS((RIG *rig, chan_cb_t chan_cb, rig_ptr_t)); 01604 extern HAMLIB_EXPORT(int) rig_get_chan_all_cb HAMLIB_PARAMS((RIG *rig, chan_cb_t chan_cb, rig_ptr_t)); 01605 01606 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)); 01607 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)); 01608 extern HAMLIB_EXPORT(int) rig_set_mem_all HAMLIB_PARAMS((RIG *rig, const channel_t *chan, const struct confparams *, const value_t *)); 01609 extern HAMLIB_EXPORT(int) rig_get_mem_all HAMLIB_PARAMS((RIG *rig, channel_t *chan, const struct confparams *, value_t *)); 01610 01611 extern HAMLIB_EXPORT(int) rig_set_trn HAMLIB_PARAMS((RIG *rig, int trn)); 01612 extern HAMLIB_EXPORT(int) rig_get_trn HAMLIB_PARAMS((RIG *rig, int *trn)); 01613 extern HAMLIB_EXPORT(int) rig_set_freq_callback HAMLIB_PARAMS((RIG *, freq_cb_t, rig_ptr_t)); 01614 extern HAMLIB_EXPORT(int) rig_set_mode_callback HAMLIB_PARAMS((RIG *, mode_cb_t, rig_ptr_t)); 01615 extern HAMLIB_EXPORT(int) rig_set_vfo_callback HAMLIB_PARAMS((RIG *, vfo_cb_t, rig_ptr_t)); 01616 extern HAMLIB_EXPORT(int) rig_set_ptt_callback HAMLIB_PARAMS((RIG *, ptt_cb_t, rig_ptr_t)); 01617 extern HAMLIB_EXPORT(int) rig_set_dcd_callback HAMLIB_PARAMS((RIG *, dcd_cb_t, rig_ptr_t)); 01618 extern HAMLIB_EXPORT(int) rig_set_pltune_callback HAMLIB_PARAMS((RIG *, pltune_cb_t, rig_ptr_t)); 01619 01620 extern HAMLIB_EXPORT(const char *) rig_get_info HAMLIB_PARAMS((RIG *rig)); 01621 01622 extern HAMLIB_EXPORT(const struct rig_caps *) rig_get_caps HAMLIB_PARAMS((rig_model_t rig_model)); 01623 extern HAMLIB_EXPORT(const freq_range_t *) rig_get_range HAMLIB_PARAMS((const freq_range_t range_list[], freq_t freq, rmode_t mode)); 01624 01625 extern HAMLIB_EXPORT(pbwidth_t) rig_passband_normal HAMLIB_PARAMS((RIG *rig, rmode_t mode)); 01626 extern HAMLIB_EXPORT(pbwidth_t) rig_passband_narrow HAMLIB_PARAMS((RIG *rig, rmode_t mode)); 01627 extern HAMLIB_EXPORT(pbwidth_t) rig_passband_wide HAMLIB_PARAMS((RIG *rig, rmode_t mode)); 01628 01629 extern HAMLIB_EXPORT(const char *) rigerror HAMLIB_PARAMS((int errnum)); 01630 01631 extern HAMLIB_EXPORT(int) rig_setting2idx HAMLIB_PARAMS((setting_t s)); 01632 #define rig_idx2setting(i) (1UL<<(i)) 01633 01634 /* 01635 * Even if these functions are prefixed with "rig_", they are not rig specific 01636 * Maybe "hamlib_" would have been better. Let me know. --SF 01637 */ 01638 extern HAMLIB_EXPORT(void) rig_set_debug HAMLIB_PARAMS((enum rig_debug_level_e debug_level)); 01639 #define rig_set_debug_level(level) rig_set_debug(level) 01640 extern HAMLIB_EXPORT(int) rig_need_debug HAMLIB_PARAMS((enum rig_debug_level_e debug_level)); 01641 extern HAMLIB_EXPORT(void) rig_debug HAMLIB_PARAMS((enum rig_debug_level_e debug_level, const char *fmt, ...)); 01642 extern HAMLIB_EXPORT(vprintf_cb_t) rig_set_debug_callback HAMLIB_PARAMS((vprintf_cb_t cb, rig_ptr_t arg)); 01643 extern HAMLIB_EXPORT(FILE*) rig_set_debug_file HAMLIB_PARAMS((FILE *stream)); 01644 01645 extern HAMLIB_EXPORT(int) rig_register HAMLIB_PARAMS((const struct rig_caps *caps)); 01646 extern HAMLIB_EXPORT(int) rig_unregister HAMLIB_PARAMS((rig_model_t rig_model)); 01647 extern HAMLIB_EXPORT(int) rig_list_foreach HAMLIB_PARAMS((int (*cfunc)(const struct rig_caps*, rig_ptr_t), rig_ptr_t data)); 01648 extern HAMLIB_EXPORT(int) rig_load_backend HAMLIB_PARAMS((const char *be_name)); 01649 extern HAMLIB_EXPORT(int) rig_check_backend HAMLIB_PARAMS((rig_model_t rig_model)); 01650 extern HAMLIB_EXPORT(int) rig_load_all_backends HAMLIB_PARAMS((void)); 01651 01652 typedef int (*rig_probe_func_t)(const hamlib_port_t *, rig_model_t, rig_ptr_t); 01653 extern HAMLIB_EXPORT(int) rig_probe_all HAMLIB_PARAMS((hamlib_port_t *p, rig_probe_func_t, rig_ptr_t)); 01654 extern HAMLIB_EXPORT(rig_model_t) rig_probe HAMLIB_PARAMS((hamlib_port_t *p)); 01655 01656 01657 /* Misc calls */ 01658 extern HAMLIB_EXPORT(const char *) rig_strrmode(rmode_t mode); 01659 extern HAMLIB_EXPORT(const char *) rig_strvfo(vfo_t vfo); 01660 extern HAMLIB_EXPORT(const char *) rig_strfunc(setting_t); 01661 extern HAMLIB_EXPORT(const char *) rig_strlevel(setting_t); 01662 extern HAMLIB_EXPORT(const char *) rig_strparm(setting_t); 01663 extern HAMLIB_EXPORT(const char *) rig_strptrshift(rptr_shift_t); 01664 extern HAMLIB_EXPORT(const char *) rig_strvfop(vfo_op_t op); 01665 extern HAMLIB_EXPORT(const char *) rig_strscan(scan_t scan); 01666 extern HAMLIB_EXPORT(const char *) rig_strstatus(enum rig_status_e status); 01667 01668 extern HAMLIB_EXPORT(rmode_t) rig_parse_mode(const char *s); 01669 extern HAMLIB_EXPORT(vfo_t) rig_parse_vfo(const char *s); 01670 extern HAMLIB_EXPORT(setting_t) rig_parse_func(const char *s); 01671 extern HAMLIB_EXPORT(setting_t) rig_parse_level(const char *s); 01672 extern HAMLIB_EXPORT(setting_t) rig_parse_parm(const char *s); 01673 extern HAMLIB_EXPORT(vfo_op_t) rig_parse_vfo_op(const char *s); 01674 extern HAMLIB_EXPORT(scan_t) rig_parse_scan(const char *s); 01675 extern HAMLIB_EXPORT(rptr_shift_t) rig_parse_rptr_shift(const char *s); 01676 01677 01678 __END_DECLS 01679 01680 #endif /* _RIG_H */ 01681
Hamlib documentation for version 1.2.7 -- Tue Aug 26 21:43:29 2008
Project page: http://hamlib.org