00001 /* 00002 * Hamlib Interface - API header 00003 * Copyright (c) 2000-2008 by Stephane Fillod and Frank Singleton 00004 * 00005 * $Id: rig.h,v 1.130 2008/11/01 20:35:16 fillods Exp $ 00006 * 00007 * This library is free software; you can redistribute it and/or modify 00008 * it under the terms of the GNU Library General Public License as 00009 * published by the Free Software Foundation; either version 2 of 00010 * the License, or (at your option) any later version. 00011 * 00012 * This program is distributed in the hope that it will be useful, 00013 * but WITHOUT ANY WARRANTY; without even the implied warranty of 00014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00015 * GNU Library General Public License for more details. 00016 * 00017 * You should have received a copy of the GNU Library General Public 00018 * License along with this library; if not, write to the Free Software 00019 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 00020 * 00021 */ 00022 00023 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 00104 #define NETRIGCTL_RET "RPRT " 00105 00113 enum rig_debug_level_e { 00114 RIG_DEBUG_NONE = 0, 00115 RIG_DEBUG_BUG, 00116 RIG_DEBUG_ERR, 00117 RIG_DEBUG_WARN, 00118 RIG_DEBUG_VERBOSE, 00119 RIG_DEBUG_TRACE 00120 }; 00121 00122 /* --------------- Rig capabilities -----------------*/ 00123 00124 /* Forward struct references */ 00125 00126 struct rig; 00127 struct rig_state; 00128 00132 typedef struct rig RIG; 00133 00134 #define RIGNAMSIZ 30 00135 #define RIGVERSIZ 8 00136 #define FILPATHLEN 100 00137 #define FRQRANGESIZ 30 00138 #define MAXCHANDESC 30 /* describe channel eg: "WWV 5Mhz" */ 00139 #define TSLSTSIZ 20 /* max tuning step list size, zero ended */ 00140 #define FLTLSTSIZ 42 /* max mode/filter list size, zero ended */ 00141 #define MAXDBLSTSIZ 8 /* max preamp/att levels supported, zero ended */ 00142 #define CHANLSTSIZ 16 /* max mem_list size, zero ended */ 00143 #define MAX_CAL_LENGTH 32 /* max calibration plots in cal_table_t */ 00144 00145 00156 typedef unsigned int tone_t; 00157 00161 typedef enum rig_port_e { 00162 RIG_PORT_NONE = 0, 00163 RIG_PORT_SERIAL, 00164 RIG_PORT_NETWORK, 00165 RIG_PORT_DEVICE, 00166 RIG_PORT_PACKET, 00167 RIG_PORT_DTMF, 00168 RIG_PORT_ULTRA, 00169 RIG_PORT_RPC, 00170 RIG_PORT_PARALLEL, 00171 RIG_PORT_USB 00172 } rig_port_t; 00173 00177 enum serial_parity_e { 00178 RIG_PARITY_NONE = 0, 00179 RIG_PARITY_ODD, 00180 RIG_PARITY_EVEN 00181 }; 00182 00186 enum serial_handshake_e { 00187 RIG_HANDSHAKE_NONE = 0, 00188 RIG_HANDSHAKE_XONXOFF, 00189 RIG_HANDSHAKE_HARDWARE 00190 }; 00191 00192 00196 enum serial_control_state_e { 00197 RIG_SIGNAL_UNSET = 0, 00198 RIG_SIGNAL_ON, 00199 RIG_SIGNAL_OFF 00200 }; 00201 00203 typedef enum { 00204 RIG_FLAG_RECEIVER = (1<<1), 00205 RIG_FLAG_TRANSMITTER = (1<<2), 00206 RIG_FLAG_SCANNER = (1<<3), 00208 RIG_FLAG_MOBILE = (1<<4), 00209 RIG_FLAG_HANDHELD = (1<<5), 00210 RIG_FLAG_COMPUTER = (1<<6), 00211 RIG_FLAG_TRUNKING = (1<<7), 00212 RIG_FLAG_APRS = (1<<8), 00213 RIG_FLAG_TNC = (1<<9), 00214 RIG_FLAG_DXCLUSTER = (1<<10), 00215 RIG_FLAG_TUNER = (1<<11) 00216 } rig_type_t; 00217 00218 #define RIG_FLAG_TRANSCEIVER (RIG_FLAG_RECEIVER|RIG_FLAG_TRANSMITTER) 00219 #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) 00220 00221 #define RIG_TYPE_OTHER 0 00222 #define RIG_TYPE_TRANSCEIVER RIG_FLAG_TRANSCEIVER 00223 #define RIG_TYPE_HANDHELD (RIG_FLAG_TRANSCEIVER|RIG_FLAG_HANDHELD) 00224 #define RIG_TYPE_MOBILE (RIG_FLAG_TRANSCEIVER|RIG_FLAG_MOBILE) 00225 #define RIG_TYPE_RECEIVER RIG_FLAG_RECEIVER 00226 #define RIG_TYPE_PCRECEIVER (RIG_FLAG_COMPUTER|RIG_FLAG_RECEIVER) 00227 #define RIG_TYPE_SCANNER (RIG_FLAG_SCANNER|RIG_FLAG_RECEIVER) 00228 #define RIG_TYPE_TRUNKSCANNER (RIG_TYPE_SCANNER|RIG_FLAG_TRUNKING) 00229 #define RIG_TYPE_COMPUTER (RIG_FLAG_TRANSCEIVER|RIG_FLAG_COMPUTER) 00230 #define RIG_TYPE_TUNER RIG_FLAG_TUNER 00231 00232 00236 enum rig_status_e { 00237 RIG_STATUS_ALPHA = 0, 00238 RIG_STATUS_UNTESTED, 00239 RIG_STATUS_BETA, 00240 RIG_STATUS_STABLE, 00241 RIG_STATUS_BUGGY, 00242 /* RIG_STATUS_NEW * *!< Initial release of code 00243 * !! Use of RIG_STATUS_NEW is deprecated. Do not use it anymore */ 00244 }; 00245 00247 #define RIG_STATUS_NEW RIG_STATUS_UNTESTED 00248 00252 typedef enum { 00253 RIG_RPT_SHIFT_NONE = 0, 00254 RIG_RPT_SHIFT_MINUS, 00255 RIG_RPT_SHIFT_PLUS 00256 } rptr_shift_t; 00257 00261 typedef enum { 00262 RIG_SPLIT_OFF = 0, 00263 RIG_SPLIT_ON 00264 } split_t; 00265 00270 typedef double freq_t; 00272 #define PRIfreq "f" 00273 00274 #define SCNfreq "lf" 00275 #define FREQFMT SCNfreq 00276 00281 typedef signed long shortfreq_t; 00282 00283 #define Hz(f) ((freq_t)(f)) 00284 #define kHz(f) ((freq_t)((f)*(freq_t)1000)) 00285 #define MHz(f) ((freq_t)((f)*(freq_t)1000000)) 00286 #define GHz(f) ((freq_t)((f)*(freq_t)1000000000)) 00287 00288 #define s_Hz(f) ((shortfreq_t)(f)) 00289 #define s_kHz(f) ((shortfreq_t)((f)*(shortfreq_t)1000)) 00290 #define s_MHz(f) ((shortfreq_t)((f)*(shortfreq_t)1000000)) 00291 #define s_GHz(f) ((shortfreq_t)((f)*(shortfreq_t)1000000000)) 00292 00293 #define RIG_FREQ_NONE Hz(0) 00294 00295 00311 typedef int vfo_t; 00312 00314 #define RIG_VFO_NONE 0 00315 00316 #define RIG_VFO_TX_FLAG (1<<30) 00317 00319 #define RIG_VFO_CURR (1<<29) 00320 00322 #define RIG_VFO_MEM (1<<28) 00323 00325 #define RIG_VFO_VFO (1<<27) 00326 00327 #define RIG_VFO_TX_VFO(v) ((v)|RIG_VFO_TX_FLAG) 00328 00330 #define RIG_VFO_TX RIG_VFO_TX_VFO(RIG_VFO_CURR) 00331 00333 #define RIG_VFO_RX RIG_VFO_CURR 00334 00336 #define RIG_VFO_MAIN (1<<26) 00337 00338 #define RIG_VFO_SUB (1<<25) 00339 00340 #define RIG_VFO_N(n) (1<<(n)) 00341 00343 #define RIG_VFO_A RIG_VFO_N(0) 00344 00345 #define RIG_VFO_B RIG_VFO_N(1) 00346 00347 #define RIG_VFO_C RIG_VFO_N(2) 00348 00349 00350 /* 00351 * targetable bitfields, for internal use. 00352 * RIG_TARGETABLE_PURE means a pure targetable radio on every command 00353 */ 00354 #define RIG_TARGETABLE_NONE 0 00355 #define RIG_TARGETABLE_FREQ (1<<0) 00356 #define RIG_TARGETABLE_MODE (1<<1) 00357 #define RIG_TARGETABLE_PURE (1<<2) 00358 #define RIG_TARGETABLE_ALL 0x7fffffff 00359 00360 00361 #define RIG_PASSBAND_NORMAL s_Hz(0) 00362 00366 typedef shortfreq_t pbwidth_t; 00367 00368 00372 typedef enum dcd_e { 00373 RIG_DCD_OFF = 0, 00374 RIG_DCD_ON 00375 } dcd_t; 00376 00381 typedef enum { 00382 RIG_DCD_NONE = 0, 00383 RIG_DCD_RIG, 00384 RIG_DCD_SERIAL_DSR, 00385 RIG_DCD_SERIAL_CTS, 00386 RIG_DCD_SERIAL_CAR, 00387 RIG_DCD_PARALLEL 00388 } dcd_type_t; 00389 00390 00394 typedef enum { 00395 RIG_PTT_OFF = 0, 00396 RIG_PTT_ON 00397 } ptt_t; 00398 00403 typedef enum { 00404 RIG_PTT_NONE = 0, 00405 RIG_PTT_RIG, 00406 RIG_PTT_SERIAL_DTR, 00407 RIG_PTT_SERIAL_RTS, 00408 RIG_PTT_PARALLEL 00409 } ptt_type_t; 00410 00414 typedef enum { 00415 RIG_POWER_OFF = 0, 00416 RIG_POWER_ON = (1<<0), 00417 RIG_POWER_STANDBY = (1<<1) 00418 } powerstat_t; 00419 00423 typedef enum { 00424 RIG_RESET_NONE = 0, 00425 RIG_RESET_SOFT = (1<<0), 00426 RIG_RESET_VFO = (1<<1), 00427 RIG_RESET_MCALL = (1<<2), 00428 RIG_RESET_MASTER = (1<<3) 00429 } reset_t; 00430 00431 00447 typedef enum { 00448 RIG_OP_NONE = 0, 00449 RIG_OP_CPY = (1<<0), 00450 RIG_OP_XCHG = (1<<1), 00451 RIG_OP_FROM_VFO = (1<<2), 00452 RIG_OP_TO_VFO = (1<<3), 00453 RIG_OP_MCL = (1<<4), 00454 RIG_OP_UP = (1<<5), 00455 RIG_OP_DOWN = (1<<6), 00456 RIG_OP_BAND_UP = (1<<7), 00457 RIG_OP_BAND_DOWN = (1<<8), 00458 RIG_OP_LEFT = (1<<9), 00459 RIG_OP_RIGHT = (1<<10), 00460 RIG_OP_TUNE = (1<<11), 00461 RIG_OP_TOGGLE = (1<<12) 00462 } vfo_op_t; 00463 00464 00473 typedef enum { 00474 RIG_SCAN_NONE = 0, 00475 RIG_SCAN_STOP = RIG_SCAN_NONE, 00476 RIG_SCAN_MEM = (1<<0), 00477 RIG_SCAN_SLCT = (1<<1), 00478 RIG_SCAN_PRIO = (1<<2), 00479 RIG_SCAN_PROG = (1<<3), 00480 RIG_SCAN_DELTA = (1<<4), 00481 RIG_SCAN_VFO = (1<<5), 00482 RIG_SCAN_PLT = (1<<6) 00483 } scan_t; 00484 00488 typedef long token_t; 00489 00490 #define RIG_CONF_END 0 00491 00504 /* strongly inspired from soundmodem. Thanks Thomas! */ 00505 00506 enum rig_conf_e { 00507 RIG_CONF_STRING, 00508 RIG_CONF_COMBO, 00509 RIG_CONF_NUMERIC, 00510 RIG_CONF_CHECKBUTTON 00511 }; 00512 00513 #define RIG_COMBO_MAX 8 00514 00518 struct confparams { 00519 token_t token; 00520 const char *name; 00521 const char *label; 00522 const char *tooltip; 00523 const char *dflt; 00524 enum rig_conf_e type; 00525 union { 00526 struct { 00527 float min; 00528 float max; 00529 float step; 00530 } n; 00531 struct { 00532 const char *combostr[RIG_COMBO_MAX]; 00533 } c; 00534 } u; 00535 }; 00536 00541 typedef enum { 00542 RIG_ANN_NONE = 0, 00543 RIG_ANN_OFF = RIG_ANN_NONE, 00544 RIG_ANN_FREQ = (1<<0), 00545 RIG_ANN_RXMODE = (1<<1), 00546 RIG_ANN_CW = (1<<2), 00547 RIG_ANN_ENG = (1<<3), 00548 RIG_ANN_JAP = (1<<4) 00549 } ann_t; 00550 00551 00555 typedef int ant_t; 00556 00557 #define RIG_ANT_NONE 0 00558 #define RIG_ANT_N(n) ((ant_t)1<<(n)) 00559 #define RIG_ANT_1 RIG_ANT_N(0) 00560 #define RIG_ANT_2 RIG_ANT_N(1) 00561 #define RIG_ANT_3 RIG_ANT_N(2) 00562 #define RIG_ANT_4 RIG_ANT_N(3) 00563 00567 /* TODO: kill me, and replace by real AGC delay */ 00568 enum agc_level_e { 00569 RIG_AGC_OFF = 0, 00570 RIG_AGC_SUPERFAST, 00571 RIG_AGC_FAST, 00572 RIG_AGC_SLOW, 00573 RIG_AGC_USER, 00574 RIG_AGC_MEDIUM 00575 }; 00576 00580 enum meter_level_e { 00581 RIG_METER_NONE = 0, /*< No display meter */ 00582 RIG_METER_SWR = (1<<0), /*< Stationary Wave Ratio */ 00583 RIG_METER_COMP = (1<<1), /*< Compression level */ 00584 RIG_METER_ALC = (1<<2), /*< ALC */ 00585 RIG_METER_IC = (1<<3), /*< IC */ 00586 RIG_METER_DB = (1<<4), /*< DB */ 00587 RIG_METER_PO = (1<<5) /*< Power Out */ 00588 }; 00589 00594 typedef union { 00595 signed int i; 00596 float f; 00597 char *s; 00598 const char *cs; 00599 } value_t; 00600 00609 enum rig_level_e { 00610 RIG_LEVEL_NONE = 0, 00611 RIG_LEVEL_PREAMP = (1<<0), 00612 RIG_LEVEL_ATT = (1<<1), 00613 RIG_LEVEL_VOX = (1<<2), 00614 RIG_LEVEL_AF = (1<<3), 00615 RIG_LEVEL_RF = (1<<4), 00616 RIG_LEVEL_SQL = (1<<5), 00617 RIG_LEVEL_IF = (1<<6), 00618 RIG_LEVEL_APF = (1<<7), 00619 RIG_LEVEL_NR = (1<<8), 00620 RIG_LEVEL_PBT_IN = (1<<9), 00621 RIG_LEVEL_PBT_OUT = (1<<10), 00622 RIG_LEVEL_CWPITCH = (1<<11), 00623 RIG_LEVEL_RFPOWER = (1<<12), 00624 RIG_LEVEL_MICGAIN = (1<<13), 00625 RIG_LEVEL_KEYSPD = (1<<14), 00626 RIG_LEVEL_NOTCHF = (1<<15), 00627 RIG_LEVEL_COMP = (1<<16), 00628 RIG_LEVEL_AGC = (1<<17), 00629 RIG_LEVEL_BKINDL = (1<<18), 00630 RIG_LEVEL_BALANCE = (1<<19), 00631 RIG_LEVEL_METER = (1<<20), 00633 RIG_LEVEL_VOXGAIN = (1<<21), 00634 RIG_LEVEL_VOXDELAY = RIG_LEVEL_VOX, 00635 RIG_LEVEL_ANTIVOX = (1<<22), 00636 RIG_LEVEL_SLOPE_LOW = (1<<23), 00637 RIG_LEVEL_SLOPE_HIGH = (1<<24), 00638 //RIG_LEVEL_LINEOUT = (1<<23),/*!< Lineout Volume, arg float [0.0 ... 1.0] */ 00639 00641 RIG_LEVEL_RAWSTR = (1<<26), 00642 RIG_LEVEL_SQLSTAT = (1<<27), 00643 RIG_LEVEL_SWR = (1<<28), 00644 RIG_LEVEL_ALC = (1<<29), 00645 RIG_LEVEL_STRENGTH =(1<<30) 00646 /*RIG_LEVEL_BWC = (1<<31)*/ 00647 }; 00648 00649 #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) 00650 00651 #define RIG_LEVEL_READONLY_LIST (RIG_LEVEL_SQLSTAT|RIG_LEVEL_SWR|RIG_LEVEL_ALC|RIG_LEVEL_STRENGTH|RIG_LEVEL_RAWSTR) 00652 00653 #define RIG_LEVEL_IS_FLOAT(l) ((l)&RIG_LEVEL_FLOAT_LIST) 00654 #define RIG_LEVEL_SET(l) ((l)&~RIG_LEVEL_READONLY_LIST) 00655 00656 00665 enum rig_parm_e { 00666 RIG_PARM_NONE = 0, 00667 RIG_PARM_ANN = (1<<0), 00668 RIG_PARM_APO = (1<<1), 00669 RIG_PARM_BACKLIGHT = (1<<2), 00670 RIG_PARM_BEEP = (1<<4), 00671 RIG_PARM_TIME = (1<<5), 00672 RIG_PARM_BAT = (1<<6), 00673 RIG_PARM_KEYLIGHT = (1<<7) 00674 }; 00675 00676 #define RIG_PARM_FLOAT_LIST (RIG_PARM_BACKLIGHT|RIG_PARM_BAT) 00677 #define RIG_PARM_READONLY_LIST (RIG_PARM_BAT) 00678 00679 #define RIG_PARM_IS_FLOAT(l) ((l)&RIG_PARM_FLOAT_LIST) 00680 #define RIG_PARM_SET(l) ((l)&~RIG_PARM_READONLY_LIST) 00681 00682 #define RIG_SETTING_MAX 32 00683 00689 typedef unsigned long setting_t; 00690 00691 /* 00692 * tranceive mode, ie. the rig notify the host of any event, 00693 * like freq changed, mode changed, etc. 00694 */ 00695 #define RIG_TRN_OFF 0 00696 #define RIG_TRN_RIG 1 00697 #define RIG_TRN_POLL 2 00698 00699 00708 enum rig_func_e { 00709 RIG_FUNC_NONE = 0, 00710 RIG_FUNC_FAGC = (1<<0), 00711 RIG_FUNC_NB = (1<<1), 00712 RIG_FUNC_COMP = (1<<2), 00713 RIG_FUNC_VOX = (1<<3), 00714 RIG_FUNC_TONE = (1<<4), 00715 RIG_FUNC_TSQL = (1<<5), 00716 RIG_FUNC_SBKIN = (1<<6), 00717 RIG_FUNC_FBKIN = (1<<7), 00718 RIG_FUNC_ANF = (1<<8), 00719 RIG_FUNC_NR = (1<<9), 00720 RIG_FUNC_AIP = (1<<10), 00721 RIG_FUNC_APF = (1<<11), 00722 RIG_FUNC_MON = (1<<12), 00723 RIG_FUNC_MN = (1<<13), 00724 RIG_FUNC_RF = (1<<14), 00725 RIG_FUNC_ARO = (1<<15), 00726 RIG_FUNC_LOCK = (1<<16), 00727 RIG_FUNC_MUTE = (1<<17), 00728 RIG_FUNC_VSC = (1<<18), 00729 RIG_FUNC_REV = (1<<19), 00730 RIG_FUNC_SQL = (1<<20), 00731 RIG_FUNC_ABM = (1<<21), 00732 RIG_FUNC_BC = (1<<22), 00733 RIG_FUNC_MBC = (1<<23), 00734 /* (1<<24), used to be RIG_FUNC_LMP, see RIG_PARM_BACKLIGHT instead) */ 00735 RIG_FUNC_AFC = (1<<25), 00736 RIG_FUNC_SATMODE = (1<<26), 00737 RIG_FUNC_SCOPE = (1<<27), 00738 RIG_FUNC_RESUME = (1<<28), 00739 RIG_FUNC_TBURST = (1<<29), 00740 RIG_FUNC_TUNER = (1<<30) 00741 }; 00742 00743 /* 00744 * power unit macros, converts to mW 00745 * This is limited to 2MW on 32 bits systems. 00746 */ 00747 #define mW(p) ((int)(p)) 00748 #define Watts(p) ((int)((p)*1000)) 00749 #define W(p) Watts(p) 00750 #define kW(p) ((int)((p)*1000000L)) 00751 00760 typedef enum { 00761 RIG_MODE_NONE = 0, 00762 RIG_MODE_AM = (1<<0), 00763 RIG_MODE_CW = (1<<1), 00764 RIG_MODE_USB = (1<<2), 00765 RIG_MODE_LSB = (1<<3), 00766 RIG_MODE_RTTY = (1<<4), 00767 RIG_MODE_FM = (1<<5), 00768 RIG_MODE_WFM = (1<<6), 00769 RIG_MODE_CWR = (1<<7), 00770 RIG_MODE_RTTYR = (1<<8), 00771 RIG_MODE_AMS = (1<<9), 00772 RIG_MODE_PKTLSB = (1<<10), 00773 RIG_MODE_PKTUSB = (1<<11), 00774 RIG_MODE_PKTFM = (1<<12), 00775 RIG_MODE_ECSSUSB = (1<<13), 00776 RIG_MODE_ECSSLSB = (1<<14), 00777 RIG_MODE_FAX = (1<<15), 00778 RIG_MODE_SAM = (1<<16), 00779 RIG_MODE_SAL = (1<<17), 00780 RIG_MODE_SAH = (1<<18), 00781 RIG_MODE_DSB = (1<<19) 00782 } rmode_t; 00783 00785 #define RIG_MODE_SSB (RIG_MODE_USB|RIG_MODE_LSB) 00786 00788 #define RIG_MODE_ECSS (RIG_MODE_ECSSUSB|RIG_MODE_ECSSLSB) 00789 00790 00791 #define RIG_DBLST_END 0 /* end marker in a preamp/att level list */ 00792 #define RIG_IS_DBLST_END(d) ((d)==0) 00793 00800 typedef struct freq_range_list { 00801 freq_t start; 00802 freq_t end; 00803 rmode_t modes; 00804 int low_power; 00805 int high_power; 00806 vfo_t vfo; 00807 ant_t ant; 00808 } freq_range_t; 00809 00810 #define RIG_FRNG_END {Hz(0),Hz(0),RIG_MODE_NONE,0,0,RIG_VFO_NONE} 00811 #define RIG_IS_FRNG_END(r) ((r).start == Hz(0) && (r).end == Hz(0)) 00812 00813 #define RIG_ITU_REGION1 1 00814 #define RIG_ITU_REGION2 2 00815 #define RIG_ITU_REGION3 3 00816 00836 struct tuning_step_list { 00837 rmode_t modes; 00838 shortfreq_t ts; 00839 }; 00840 00841 #define RIG_TS_ANY 0 00842 #define RIG_TS_END {RIG_MODE_NONE,0} 00843 #define RIG_IS_TS_END(t) ((t).modes == RIG_MODE_NONE && (t).ts == 0) 00844 00871 struct filter_list { 00872 rmode_t modes; 00873 pbwidth_t width; 00874 }; 00875 00876 #define RIG_FLT_ANY 0 00877 #define RIG_FLT_END {RIG_MODE_NONE,0} 00878 #define RIG_IS_FLT_END(f) ((f).modes == RIG_MODE_NONE) 00879 00880 00882 #define RIG_CHFLAG_NONE 0 00883 00884 #define RIG_CHFLAG_SKIP (1<<0) 00885 00886 #define RIG_CHFLAG_DATA (1<<1) 00887 00892 struct ext_list { 00893 token_t token; 00894 value_t val; 00895 }; 00896 00897 #define RIG_EXT_END {0, {.i=0}} 00898 #define RIG_IS_EXT_END(x) ((x).token == 0) 00899 00907 struct channel { 00908 int channel_num; 00909 int bank_num; 00910 vfo_t vfo; 00911 int ant; 00912 freq_t freq; 00913 rmode_t mode; 00914 pbwidth_t width; 00916 freq_t tx_freq; 00917 rmode_t tx_mode; 00918 pbwidth_t tx_width; 00920 split_t split; 00921 vfo_t tx_vfo; 00923 rptr_shift_t rptr_shift; 00924 shortfreq_t rptr_offs; 00925 shortfreq_t tuning_step; 00926 shortfreq_t rit; 00927 shortfreq_t xit; 00928 setting_t funcs; 00929 value_t levels[RIG_SETTING_MAX]; 00930 tone_t ctcss_tone; 00931 tone_t ctcss_sql; 00932 tone_t dcs_code; 00933 tone_t dcs_sql; 00934 int scan_group; 00935 int flags; 00936 char channel_desc[MAXCHANDESC]; 00937 struct ext_list *ext_levels; 00938 }; 00940 typedef struct channel channel_t; 00941 00947 struct channel_cap { 00948 unsigned bank_num:1; 00949 unsigned vfo:1; 00950 unsigned ant:1; 00951 unsigned freq:1; 00952 unsigned mode:1; 00953 unsigned width:1; 00955 unsigned tx_freq:1; 00956 unsigned tx_mode:1; 00957 unsigned tx_width:1; 00959 unsigned split:1; 00960 unsigned tx_vfo:1; 00961 unsigned rptr_shift:1; 00962 unsigned rptr_offs:1; 00963 unsigned tuning_step:1; 00964 unsigned rit:1; 00965 unsigned xit:1; 00966 setting_t funcs; 00967 setting_t levels; 00968 unsigned ctcss_tone:1; 00969 unsigned ctcss_sql:1; 00970 unsigned dcs_code:1; 00971 unsigned dcs_sql:1; 00972 unsigned scan_group:1; 00973 unsigned flags:1; 00974 unsigned channel_desc:1; 00975 unsigned ext_levels:1; 00976 }; 00977 00979 typedef struct channel_cap channel_cap_t; 00980 00981 00992 typedef enum { 00993 RIG_MTYPE_NONE=0, 00994 RIG_MTYPE_MEM, 00995 RIG_MTYPE_EDGE, 00996 RIG_MTYPE_CALL, 00997 RIG_MTYPE_MEMOPAD, 00998 RIG_MTYPE_SAT, 00999 RIG_MTYPE_BAND, 01000 RIG_MTYPE_PRIO 01001 } chan_type_t; 01002 01016 struct chan_list { 01017 int start; 01018 int end; 01019 chan_type_t type; 01020 channel_cap_t mem_caps; 01021 }; 01022 01023 #define RIG_CHAN_END {0,0,RIG_MTYPE_NONE} 01024 #define RIG_IS_CHAN_END(c) ((c).type == RIG_MTYPE_NONE) 01025 01026 #define RIG_MEM_CAPS_ALL -1 01027 01029 typedef struct chan_list chan_t; 01030 01042 struct gran { 01043 value_t min; 01044 value_t max; 01045 value_t step; 01046 }; 01047 01049 typedef struct gran gran_t; 01050 01051 01053 struct cal_table { 01054 int size; 01055 struct { 01056 int raw; 01057 int val; 01058 } table[MAX_CAL_LENGTH]; 01059 }; 01060 01073 typedef struct cal_table cal_table_t; 01074 01075 #define EMPTY_STR_CAL { 0, { { 0, 0 }, } } 01076 01077 01078 typedef int (*chan_cb_t) (RIG *, channel_t**, int, const chan_t*, rig_ptr_t); 01079 typedef int (*confval_cb_t) (RIG *, const struct confparams *, value_t *, rig_ptr_t); 01080 01099 struct rig_caps { 01100 rig_model_t rig_model; 01101 const char *model_name; 01102 const char *mfg_name; 01103 const char *version; 01104 const char *copyright; 01105 enum rig_status_e status; 01107 int rig_type; 01108 ptt_type_t ptt_type; 01109 dcd_type_t dcd_type; 01110 rig_port_t port_type; 01112 int serial_rate_min; 01113 int serial_rate_max; 01114 int serial_data_bits; 01115 int serial_stop_bits; 01116 enum serial_parity_e serial_parity; 01117 enum serial_handshake_e serial_handshake; 01119 int write_delay; 01120 int post_write_delay; 01121 int timeout; 01122 int retry; 01124 setting_t has_get_func; 01125 setting_t has_set_func; 01126 setting_t has_get_level; 01127 setting_t has_set_level; 01128 setting_t has_get_parm; 01129 setting_t has_set_parm; 01131 gran_t level_gran[RIG_SETTING_MAX]; 01132 gran_t parm_gran[RIG_SETTING_MAX]; 01134 const struct confparams *extparms; 01135 const struct confparams *extlevels; 01137 const tone_t *ctcss_list; 01138 const tone_t *dcs_list; 01140 int preamp[MAXDBLSTSIZ]; 01141 int attenuator[MAXDBLSTSIZ]; 01142 shortfreq_t max_rit; 01143 shortfreq_t max_xit; 01144 shortfreq_t max_ifshift; 01146 ann_t announces; 01148 vfo_op_t vfo_ops; 01149 scan_t scan_ops; 01150 int targetable_vfo; 01151 int transceive; 01153 int bank_qty; 01154 int chan_desc_sz; 01156 chan_t chan_list[CHANLSTSIZ]; 01158 freq_range_t rx_range_list1[FRQRANGESIZ]; 01159 freq_range_t tx_range_list1[FRQRANGESIZ]; 01160 freq_range_t rx_range_list2[FRQRANGESIZ]; 01161 freq_range_t tx_range_list2[FRQRANGESIZ]; 01163 struct tuning_step_list tuning_steps[TSLSTSIZ]; 01164 struct filter_list filters[FLTLSTSIZ]; 01166 cal_table_t str_cal; 01168 const struct confparams *cfgparams; 01169 const rig_ptr_t priv; 01171 /* 01172 * Rig API 01173 * 01174 */ 01175 01176 int (*rig_init) (RIG * rig); 01177 int (*rig_cleanup) (RIG * rig); 01178 int (*rig_open) (RIG * rig); 01179 int (*rig_close) (RIG * rig); 01180 01181 /* 01182 * General API commands, from most primitive to least.. :() 01183 * List Set/Get functions pairs 01184 */ 01185 01186 int (*set_freq) (RIG * rig, vfo_t vfo, freq_t freq); 01187 int (*get_freq) (RIG * rig, vfo_t vfo, freq_t * freq); 01188 01189 int (*set_mode) (RIG * rig, vfo_t vfo, rmode_t mode, 01190 pbwidth_t width); 01191 int (*get_mode) (RIG * rig, vfo_t vfo, rmode_t * mode, 01192 pbwidth_t * width); 01193 01194 int (*set_vfo) (RIG * rig, vfo_t vfo); 01195 int (*get_vfo) (RIG * rig, vfo_t * vfo); 01196 01197 int (*set_ptt) (RIG * rig, vfo_t vfo, ptt_t ptt); 01198 int (*get_ptt) (RIG * rig, vfo_t vfo, ptt_t * ptt); 01199 int (*get_dcd) (RIG * rig, vfo_t vfo, dcd_t * dcd); 01200 01201 int (*set_rptr_shift) (RIG * rig, vfo_t vfo, 01202 rptr_shift_t rptr_shift); 01203 int (*get_rptr_shift) (RIG * rig, vfo_t vfo, 01204 rptr_shift_t * rptr_shift); 01205 01206 int (*set_rptr_offs) (RIG * rig, vfo_t vfo, shortfreq_t offs); 01207 int (*get_rptr_offs) (RIG * rig, vfo_t vfo, shortfreq_t * offs); 01208 01209 int (*set_split_freq) (RIG * rig, vfo_t vfo, freq_t tx_freq); 01210 int (*get_split_freq) (RIG * rig, vfo_t vfo, freq_t * tx_freq); 01211 int (*set_split_mode) (RIG * rig, vfo_t vfo, rmode_t tx_mode, 01212 pbwidth_t tx_width); 01213 int (*get_split_mode) (RIG * rig, vfo_t vfo, rmode_t * tx_mode, 01214 pbwidth_t * tx_width); 01215 01216 int (*set_split_vfo) (RIG * rig, vfo_t vfo, split_t split, vfo_t tx_vfo); 01217 int (*get_split_vfo) (RIG * rig, vfo_t vfo, split_t * split, vfo_t *tx_vfo); 01218 01219 int (*set_rit) (RIG * rig, vfo_t vfo, shortfreq_t rit); 01220 int (*get_rit) (RIG * rig, vfo_t vfo, shortfreq_t * rit); 01221 int (*set_xit) (RIG * rig, vfo_t vfo, shortfreq_t xit); 01222 int (*get_xit) (RIG * rig, vfo_t vfo, shortfreq_t * xit); 01223 01224 int (*set_ts) (RIG * rig, vfo_t vfo, shortfreq_t ts); 01225 int (*get_ts) (RIG * rig, vfo_t vfo, shortfreq_t * ts); 01226 01227 int (*set_dcs_code) (RIG * rig, vfo_t vfo, tone_t code); 01228 int (*get_dcs_code) (RIG * rig, vfo_t vfo, tone_t * code); 01229 int (*set_tone) (RIG * rig, vfo_t vfo, tone_t tone); 01230 int (*get_tone) (RIG * rig, vfo_t vfo, tone_t * tone); 01231 int (*set_ctcss_tone) (RIG * rig, vfo_t vfo, tone_t tone); 01232 int (*get_ctcss_tone) (RIG * rig, vfo_t vfo, tone_t * tone); 01233 01234 int (*set_dcs_sql) (RIG * rig, vfo_t vfo, tone_t code); 01235 int (*get_dcs_sql) (RIG * rig, vfo_t vfo, tone_t * code); 01236 int (*set_tone_sql) (RIG * rig, vfo_t vfo, tone_t tone); 01237 int (*get_tone_sql) (RIG * rig, vfo_t vfo, tone_t * tone); 01238 int (*set_ctcss_sql) (RIG * rig, vfo_t vfo, tone_t tone); 01239 int (*get_ctcss_sql) (RIG * rig, vfo_t vfo, tone_t * tone); 01240 01241 int (*power2mW) (RIG * rig, unsigned int *mwpower, float power, 01242 freq_t freq, rmode_t mode); 01243 int (*mW2power) (RIG * rig, float *power, unsigned int mwpower, 01244 freq_t freq, rmode_t mode); 01245 01246 int (*set_powerstat) (RIG * rig, powerstat_t status); 01247 int (*get_powerstat) (RIG * rig, powerstat_t * status); 01248 int (*reset) (RIG * rig, reset_t reset); 01249 01250 int (*set_ant) (RIG * rig, vfo_t vfo, ant_t ant); 01251 int (*get_ant) (RIG * rig, vfo_t vfo, ant_t * ant); 01252 01253 int (*set_level) (RIG * rig, vfo_t vfo, setting_t level, 01254 value_t val); 01255 int (*get_level) (RIG * rig, vfo_t vfo, setting_t level, 01256 value_t * val); 01257 01258 int (*set_func) (RIG * rig, vfo_t vfo, setting_t func, int status); 01259 int (*get_func) (RIG * rig, vfo_t vfo, setting_t func, 01260 int *status); 01261 01262 int (*set_parm) (RIG * rig, setting_t parm, value_t val); 01263 int (*get_parm) (RIG * rig, setting_t parm, value_t * val); 01264 01265 int (*set_ext_level)(RIG *rig, vfo_t vfo, token_t token, value_t val); 01266 int (*get_ext_level)(RIG *rig, vfo_t vfo, token_t token, value_t *val); 01267 01268 int (*set_ext_parm)(RIG *rig, token_t token, value_t val); 01269 int (*get_ext_parm)(RIG *rig, token_t token, value_t *val); 01270 01271 int (*set_conf) (RIG * rig, token_t token, const char *val); 01272 int (*get_conf) (RIG * rig, token_t token, char *val); 01273 01274 int (*send_dtmf) (RIG * rig, vfo_t vfo, const char *digits); 01275 int (*recv_dtmf) (RIG * rig, vfo_t vfo, char *digits, int *length); 01276 int (*send_morse) (RIG * rig, vfo_t vfo, const char *msg); 01277 01278 int (*set_bank) (RIG * rig, vfo_t vfo, int bank); 01279 int (*set_mem) (RIG * rig, vfo_t vfo, int ch); 01280 int (*get_mem) (RIG * rig, vfo_t vfo, int *ch); 01281 int (*vfo_op) (RIG * rig, vfo_t vfo, vfo_op_t op); 01282 int (*scan) (RIG * rig, vfo_t vfo, scan_t scan, int ch); 01283 01284 int (*set_trn) (RIG * rig, int trn); 01285 int (*get_trn) (RIG * rig, int *trn); 01286 01287 int (*decode_event) (RIG * rig); 01288 01289 int (*set_channel) (RIG * rig, const channel_t * chan); 01290 int (*get_channel) (RIG * rig, channel_t * chan); 01291 01292 const char *(*get_info) (RIG * rig); 01293 01294 int (*set_chan_all_cb) (RIG * rig, chan_cb_t chan_cb, rig_ptr_t); 01295 int (*get_chan_all_cb) (RIG * rig, chan_cb_t chan_cb, rig_ptr_t); 01296 01297 int (*set_mem_all_cb) (RIG * rig, chan_cb_t chan_cb, confval_cb_t parm_cb, rig_ptr_t); 01298 int (*get_mem_all_cb) (RIG * rig, chan_cb_t chan_cb, confval_cb_t parm_cb, rig_ptr_t); 01299 01300 const char *clone_combo_set; 01301 const char *clone_combo_get; 01302 }; 01303 01309 typedef struct { 01310 union { 01311 rig_port_t rig; 01312 ptt_type_t ptt; 01313 dcd_type_t dcd; 01314 } type; 01315 int fd; 01316 void* handle; 01318 int write_delay; 01319 int post_write_delay; 01320 struct { int tv_sec,tv_usec; } post_write_date; 01321 int timeout; 01322 int retry; 01324 char pathname[FILPATHLEN]; 01325 union { 01326 struct { 01327 int rate; 01328 int data_bits; 01329 int stop_bits; 01330 enum serial_parity_e parity; 01331 enum serial_handshake_e handshake; 01332 enum serial_control_state_e rts_state; 01333 enum serial_control_state_e dtr_state; 01334 } serial; 01335 struct { 01336 int pin; 01337 } parallel; 01338 struct { 01339 int vid; 01340 int pid; 01341 int conf; 01342 int iface; 01343 int alt; 01344 } usb; 01345 } parm; 01346 } hamlib_port_t; 01347 01348 #if !defined(__APPLE__) || !defined(__cplusplus) 01349 typedef hamlib_port_t port_t; 01350 #endif 01351 01352 01362 struct rig_state { 01363 /* 01364 * overridable fields 01365 */ 01366 hamlib_port_t rigport; 01367 hamlib_port_t pttport; 01368 hamlib_port_t dcdport; 01370 double vfo_comp; 01372 int itu_region; 01373 freq_range_t rx_range_list[FRQRANGESIZ]; 01374 freq_range_t tx_range_list[FRQRANGESIZ]; 01376 struct tuning_step_list tuning_steps[TSLSTSIZ]; 01378 struct filter_list filters[FLTLSTSIZ]; 01380 cal_table_t str_cal; 01382 chan_t chan_list[CHANLSTSIZ]; 01384 shortfreq_t max_rit; 01385 shortfreq_t max_xit; 01386 shortfreq_t max_ifshift; 01388 ann_t announces; 01390 int preamp[MAXDBLSTSIZ]; 01391 int attenuator[MAXDBLSTSIZ]; 01393 setting_t has_get_func; 01394 setting_t has_set_func; 01395 setting_t has_get_level; 01396 setting_t has_set_level; 01397 setting_t has_get_parm; 01398 setting_t has_set_parm; 01400 gran_t level_gran[RIG_SETTING_MAX]; 01401 gran_t parm_gran[RIG_SETTING_MAX]; 01404 /* 01405 * non overridable fields, internal use 01406 */ 01407 01408 int hold_decode; 01409 vfo_t current_vfo; 01410 int vfo_list; 01411 int comm_state; 01412 rig_ptr_t priv; 01413 rig_ptr_t obj; 01415 int transceive; 01416 int poll_interval; 01417 freq_t current_freq; 01418 rmode_t current_mode; 01419 pbwidth_t current_width; 01421 }; 01422 01423 01424 typedef int (*vprintf_cb_t) (enum rig_debug_level_e, rig_ptr_t, const char *, va_list); 01425 01426 typedef int (*freq_cb_t) (RIG *, vfo_t, freq_t, rig_ptr_t); 01427 typedef int (*mode_cb_t) (RIG *, vfo_t, rmode_t, pbwidth_t, rig_ptr_t); 01428 typedef int (*vfo_cb_t) (RIG *, vfo_t, rig_ptr_t); 01429 typedef int (*ptt_cb_t) (RIG *, vfo_t, ptt_t, rig_ptr_t); 01430 typedef int (*dcd_cb_t) (RIG *, vfo_t, dcd_t, rig_ptr_t); 01431 typedef int (*pltune_cb_t) (RIG *, vfo_t, freq_t *, rmode_t *, pbwidth_t *, rig_ptr_t); 01432 01450 struct rig_callbacks { 01451 freq_cb_t freq_event; 01452 rig_ptr_t freq_arg; 01453 mode_cb_t mode_event; 01454 rig_ptr_t mode_arg; 01455 vfo_cb_t vfo_event; 01456 rig_ptr_t vfo_arg; 01457 ptt_cb_t ptt_event; 01458 rig_ptr_t ptt_arg; 01459 dcd_cb_t dcd_event; 01460 rig_ptr_t dcd_arg; 01461 pltune_cb_t pltune; 01462 rig_ptr_t pltune_arg; 01463 /* etc.. */ 01464 }; 01465 01475 struct rig { 01476 struct rig_caps *caps; 01477 struct rig_state state; 01478 struct rig_callbacks callbacks; 01479 }; 01480 01481 01482 01483 /* --------------- API function prototypes -----------------*/ 01484 01485 extern HAMLIB_EXPORT(RIG *) rig_init HAMLIB_PARAMS((rig_model_t rig_model)); 01486 extern HAMLIB_EXPORT(int) rig_open HAMLIB_PARAMS((RIG *rig)); 01487 01488 /* 01489 * General API commands, from most primitive to least.. :() 01490 * List Set/Get functions pairs 01491 */ 01492 01493 extern HAMLIB_EXPORT(int) rig_set_freq HAMLIB_PARAMS((RIG *rig, vfo_t vfo, freq_t freq)); 01494 extern HAMLIB_EXPORT(int) rig_get_freq HAMLIB_PARAMS((RIG *rig, vfo_t vfo, freq_t *freq)); 01495 01496 extern HAMLIB_EXPORT(int) rig_set_mode HAMLIB_PARAMS((RIG *rig, vfo_t vfo, rmode_t mode, pbwidth_t width)); 01497 extern HAMLIB_EXPORT(int) rig_get_mode HAMLIB_PARAMS((RIG *rig, vfo_t vfo, rmode_t *mode, pbwidth_t *width)); 01498 01499 extern HAMLIB_EXPORT(int) rig_set_vfo HAMLIB_PARAMS((RIG *rig, vfo_t vfo)); 01500 extern HAMLIB_EXPORT(int) rig_get_vfo HAMLIB_PARAMS((RIG *rig, vfo_t *vfo)); 01501 01502 extern HAMLIB_EXPORT(int) rig_set_ptt HAMLIB_PARAMS((RIG *rig, vfo_t vfo, ptt_t ptt)); 01503 extern HAMLIB_EXPORT(int) rig_get_ptt HAMLIB_PARAMS((RIG *rig, vfo_t vfo, ptt_t *ptt)); 01504 01505 extern HAMLIB_EXPORT(int) rig_get_dcd HAMLIB_PARAMS((RIG *rig, vfo_t vfo, dcd_t *dcd)); 01506 01507 extern HAMLIB_EXPORT(int) rig_set_rptr_shift HAMLIB_PARAMS((RIG *rig, vfo_t vfo, rptr_shift_t rptr_shift)); 01508 extern HAMLIB_EXPORT(int) rig_get_rptr_shift HAMLIB_PARAMS((RIG *rig, vfo_t vfo, rptr_shift_t *rptr_shift)); 01509 extern HAMLIB_EXPORT(int) rig_set_rptr_offs HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t rptr_offs)); 01510 extern HAMLIB_EXPORT(int) rig_get_rptr_offs HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t *rptr_offs)); 01511 01512 extern HAMLIB_EXPORT(int) rig_set_ctcss_tone HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t tone)); 01513 extern HAMLIB_EXPORT(int) rig_get_ctcss_tone HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t *tone)); 01514 extern HAMLIB_EXPORT(int) rig_set_dcs_code HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t code)); 01515 extern HAMLIB_EXPORT(int) rig_get_dcs_code HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t *code)); 01516 01517 extern HAMLIB_EXPORT(int) rig_set_ctcss_sql HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t tone)); 01518 extern HAMLIB_EXPORT(int) rig_get_ctcss_sql HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t *tone)); 01519 extern HAMLIB_EXPORT(int) rig_set_dcs_sql HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t code)); 01520 extern HAMLIB_EXPORT(int) rig_get_dcs_sql HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t *code)); 01521 01522 extern HAMLIB_EXPORT(int) rig_set_split_freq HAMLIB_PARAMS((RIG *rig, vfo_t vfo, freq_t tx_freq)); 01523 extern HAMLIB_EXPORT(int) rig_get_split_freq HAMLIB_PARAMS((RIG *rig, vfo_t vfo, freq_t *tx_freq)); 01524 extern HAMLIB_EXPORT(int) rig_set_split_mode HAMLIB_PARAMS((RIG *rig, vfo_t vfo, rmode_t tx_mode, pbwidth_t tx_width)); 01525 extern HAMLIB_EXPORT(int) rig_get_split_mode HAMLIB_PARAMS((RIG *rig, vfo_t vfo, rmode_t *tx_mode, pbwidth_t *tx_width)); 01526 extern HAMLIB_EXPORT(int) rig_set_split_vfo HAMLIB_PARAMS((RIG*, vfo_t rx_vfo, split_t split, vfo_t tx_vfo)); 01527 extern HAMLIB_EXPORT(int) rig_get_split_vfo HAMLIB_PARAMS((RIG*, vfo_t rx_vfo, split_t *split, vfo_t *tx_vfo)); 01528 #define rig_set_split(r,v,s) rig_set_split_vfo((r),(v),(s),RIG_VFO_CURR) 01529 #define rig_get_split(r,v,s) ({ vfo_t _tx_vfo; rig_get_split_vfo((r),(v),(s),&_tx_vfo); }) 01530 01531 extern HAMLIB_EXPORT(int) rig_set_rit HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t rit)); 01532 extern HAMLIB_EXPORT(int) rig_get_rit HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t *rit)); 01533 extern HAMLIB_EXPORT(int) rig_set_xit HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t xit)); 01534 extern HAMLIB_EXPORT(int) rig_get_xit HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t *xit)); 01535 01536 extern HAMLIB_EXPORT(int) rig_set_ts HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t ts)); 01537 extern HAMLIB_EXPORT(int) rig_get_ts HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t *ts)); 01538 01539 extern HAMLIB_EXPORT(int) rig_power2mW HAMLIB_PARAMS((RIG *rig, unsigned int *mwpower, float power, freq_t freq, rmode_t mode)); 01540 extern HAMLIB_EXPORT(int) rig_mW2power HAMLIB_PARAMS((RIG *rig, float *power, unsigned int mwpower, freq_t freq, rmode_t mode)); 01541 01542 extern HAMLIB_EXPORT(shortfreq_t) rig_get_resolution HAMLIB_PARAMS((RIG *rig, rmode_t mode)); 01543 01544 extern HAMLIB_EXPORT(int) rig_set_level HAMLIB_PARAMS((RIG *rig, vfo_t vfo, setting_t level, value_t val)); 01545 extern HAMLIB_EXPORT(int) rig_get_level HAMLIB_PARAMS((RIG *rig, vfo_t vfo, setting_t level, value_t *val)); 01546 01547 #define rig_get_strength(r,v,s) rig_get_level((r),(v),RIG_LEVEL_STRENGTH, (value_t*)(s)) 01548 01549 extern HAMLIB_EXPORT(int) rig_set_parm HAMLIB_PARAMS((RIG *rig, setting_t parm, value_t val)); 01550 extern HAMLIB_EXPORT(int) rig_get_parm HAMLIB_PARAMS((RIG *rig, setting_t parm, value_t *val)); 01551 01552 extern HAMLIB_EXPORT(int) rig_set_conf HAMLIB_PARAMS((RIG *rig, token_t token, const char *val)); 01553 extern HAMLIB_EXPORT(int) rig_get_conf HAMLIB_PARAMS((RIG *rig, token_t token, char *val)); 01554 01555 extern HAMLIB_EXPORT(int) rig_set_powerstat HAMLIB_PARAMS((RIG *rig, powerstat_t status)); 01556 extern HAMLIB_EXPORT(int) rig_get_powerstat HAMLIB_PARAMS((RIG *rig, powerstat_t *status)); 01557 01558 extern HAMLIB_EXPORT(int) rig_reset HAMLIB_PARAMS((RIG *rig, reset_t reset)); /* dangerous! */ 01559 01560 extern HAMLIB_EXPORT(int) rig_set_ext_level HAMLIB_PARAMS((RIG *rig, vfo_t vfo, 01561 token_t token, value_t val)); 01562 extern HAMLIB_EXPORT(int) rig_get_ext_level HAMLIB_PARAMS((RIG *rig, vfo_t vfo, 01563 token_t token, value_t *val)); 01564 01565 extern HAMLIB_EXPORT(int) rig_set_ext_parm HAMLIB_PARAMS((RIG *rig, token_t token, value_t val)); 01566 extern HAMLIB_EXPORT(int) rig_get_ext_parm HAMLIB_PARAMS((RIG *rig, token_t token, value_t *val)); 01567 01568 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)); 01569 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)); 01570 extern HAMLIB_EXPORT(const struct confparams*) rig_ext_lookup HAMLIB_PARAMS((RIG *rig, const char *name)); 01571 extern HAMLIB_EXPORT(const struct confparams *) rig_ext_lookup_tok HAMLIB_PARAMS((RIG *rig, token_t token)); 01572 extern HAMLIB_EXPORT(token_t) rig_ext_token_lookup HAMLIB_PARAMS((RIG *rig, const char *name)); 01573 01574 01575 extern HAMLIB_EXPORT(int) rig_token_foreach HAMLIB_PARAMS((RIG *rig, int (*cfunc)(const struct confparams *, rig_ptr_t), rig_ptr_t data)); 01576 extern HAMLIB_EXPORT(const struct confparams*) rig_confparam_lookup HAMLIB_PARAMS((RIG *rig, const char *name)); 01577 extern HAMLIB_EXPORT(token_t) rig_token_lookup HAMLIB_PARAMS((RIG *rig, const char *name)); 01578 01579 extern HAMLIB_EXPORT(int) rig_close HAMLIB_PARAMS((RIG *rig)); 01580 extern HAMLIB_EXPORT(int) rig_cleanup HAMLIB_PARAMS((RIG *rig)); 01581 01582 extern HAMLIB_EXPORT(int) rig_set_ant HAMLIB_PARAMS((RIG *rig, vfo_t vfo, ant_t ant)); /* antenna */ 01583 extern HAMLIB_EXPORT(int) rig_get_ant HAMLIB_PARAMS((RIG *rig, vfo_t vfo, ant_t *ant)); 01584 01585 extern HAMLIB_EXPORT(setting_t) rig_has_get_level HAMLIB_PARAMS((RIG *rig, setting_t level)); 01586 extern HAMLIB_EXPORT(setting_t) rig_has_set_level HAMLIB_PARAMS((RIG *rig, setting_t level)); 01587 01588 extern HAMLIB_EXPORT(setting_t) rig_has_get_parm HAMLIB_PARAMS((RIG *rig, setting_t parm)); 01589 extern HAMLIB_EXPORT(setting_t) rig_has_set_parm HAMLIB_PARAMS((RIG *rig, setting_t parm)); 01590 01591 extern HAMLIB_EXPORT(setting_t) rig_has_get_func HAMLIB_PARAMS((RIG *rig, setting_t func)); 01592 extern HAMLIB_EXPORT(setting_t) rig_has_set_func HAMLIB_PARAMS((RIG *rig, setting_t func)); 01593 01594 extern HAMLIB_EXPORT(int) rig_set_func HAMLIB_PARAMS((RIG *rig, vfo_t vfo, setting_t func, int status)); 01595 extern HAMLIB_EXPORT(int) rig_get_func HAMLIB_PARAMS((RIG *rig, vfo_t vfo, setting_t func, int *status)); 01596 01597 extern HAMLIB_EXPORT(int) rig_send_dtmf HAMLIB_PARAMS((RIG *rig, vfo_t vfo, const char *digits)); 01598 extern HAMLIB_EXPORT(int) rig_recv_dtmf HAMLIB_PARAMS((RIG *rig, vfo_t vfo, char *digits, int *length)); 01599 extern HAMLIB_EXPORT(int) rig_send_morse HAMLIB_PARAMS((RIG *rig, vfo_t vfo, const char *msg)); 01600 01601 extern HAMLIB_EXPORT(int) rig_set_bank HAMLIB_PARAMS((RIG *rig, vfo_t vfo, int bank)); 01602 extern HAMLIB_EXPORT(int) rig_set_mem HAMLIB_PARAMS((RIG *rig, vfo_t vfo, int ch)); 01603 extern HAMLIB_EXPORT(int) rig_get_mem HAMLIB_PARAMS((RIG *rig, vfo_t vfo, int *ch)); 01604 extern HAMLIB_EXPORT(int) rig_vfo_op HAMLIB_PARAMS((RIG *rig, vfo_t vfo, vfo_op_t op)); 01605 extern HAMLIB_EXPORT(vfo_op_t) rig_has_vfo_op HAMLIB_PARAMS((RIG *rig, vfo_op_t op)); 01606 extern HAMLIB_EXPORT(int) rig_scan HAMLIB_PARAMS((RIG *rig, vfo_t vfo, scan_t scan, int ch)); 01607 extern HAMLIB_EXPORT(scan_t) rig_has_scan HAMLIB_PARAMS((RIG *rig, scan_t scan)); 01608 01609 extern HAMLIB_EXPORT(int) rig_set_channel HAMLIB_PARAMS((RIG *rig, const channel_t *chan)); /* mem */ 01610 extern HAMLIB_EXPORT(int) rig_get_channel HAMLIB_PARAMS((RIG *rig, channel_t *chan)); 01611 01612 extern HAMLIB_EXPORT(int) rig_set_chan_all HAMLIB_PARAMS((RIG *rig, const channel_t chans[])); 01613 extern HAMLIB_EXPORT(int) rig_get_chan_all HAMLIB_PARAMS((RIG *rig, channel_t chans[])); 01614 extern HAMLIB_EXPORT(int) rig_set_chan_all_cb HAMLIB_PARAMS((RIG *rig, chan_cb_t chan_cb, rig_ptr_t)); 01615 extern HAMLIB_EXPORT(int) rig_get_chan_all_cb HAMLIB_PARAMS((RIG *rig, chan_cb_t chan_cb, rig_ptr_t)); 01616 01617 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)); 01618 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)); 01619 extern HAMLIB_EXPORT(int) rig_set_mem_all HAMLIB_PARAMS((RIG *rig, const channel_t *chan, const struct confparams *, const value_t *)); 01620 extern HAMLIB_EXPORT(int) rig_get_mem_all HAMLIB_PARAMS((RIG *rig, channel_t *chan, const struct confparams *, value_t *)); 01621 extern HAMLIB_EXPORT(const chan_t *) rig_lookup_mem_caps HAMLIB_PARAMS((RIG *rig, int ch)); 01622 extern HAMLIB_EXPORT(int) rig_mem_count HAMLIB_PARAMS((RIG *rig)); 01623 01624 01625 extern HAMLIB_EXPORT(int) rig_set_trn HAMLIB_PARAMS((RIG *rig, int trn)); 01626 extern HAMLIB_EXPORT(int) rig_get_trn HAMLIB_PARAMS((RIG *rig, int *trn)); 01627 extern HAMLIB_EXPORT(int) rig_set_freq_callback HAMLIB_PARAMS((RIG *, freq_cb_t, rig_ptr_t)); 01628 extern HAMLIB_EXPORT(int) rig_set_mode_callback HAMLIB_PARAMS((RIG *, mode_cb_t, rig_ptr_t)); 01629 extern HAMLIB_EXPORT(int) rig_set_vfo_callback HAMLIB_PARAMS((RIG *, vfo_cb_t, rig_ptr_t)); 01630 extern HAMLIB_EXPORT(int) rig_set_ptt_callback HAMLIB_PARAMS((RIG *, ptt_cb_t, rig_ptr_t)); 01631 extern HAMLIB_EXPORT(int) rig_set_dcd_callback HAMLIB_PARAMS((RIG *, dcd_cb_t, rig_ptr_t)); 01632 extern HAMLIB_EXPORT(int) rig_set_pltune_callback HAMLIB_PARAMS((RIG *, pltune_cb_t, rig_ptr_t)); 01633 01634 extern HAMLIB_EXPORT(const char *) rig_get_info HAMLIB_PARAMS((RIG *rig)); 01635 01636 extern HAMLIB_EXPORT(const struct rig_caps *) rig_get_caps HAMLIB_PARAMS((rig_model_t rig_model)); 01637 extern HAMLIB_EXPORT(const freq_range_t *) rig_get_range HAMLIB_PARAMS((const freq_range_t range_list[], freq_t freq, rmode_t mode)); 01638 01639 extern HAMLIB_EXPORT(pbwidth_t) rig_passband_normal HAMLIB_PARAMS((RIG *rig, rmode_t mode)); 01640 extern HAMLIB_EXPORT(pbwidth_t) rig_passband_narrow HAMLIB_PARAMS((RIG *rig, rmode_t mode)); 01641 extern HAMLIB_EXPORT(pbwidth_t) rig_passband_wide HAMLIB_PARAMS((RIG *rig, rmode_t mode)); 01642 01643 extern HAMLIB_EXPORT(const char *) rigerror HAMLIB_PARAMS((int errnum)); 01644 01645 extern HAMLIB_EXPORT(int) rig_setting2idx HAMLIB_PARAMS((setting_t s)); 01646 #define rig_idx2setting(i) (1UL<<(i)) 01647 01648 /* 01649 * Even if these functions are prefixed with "rig_", they are not rig specific 01650 * Maybe "hamlib_" would have been better. Let me know. --SF 01651 */ 01652 extern HAMLIB_EXPORT(void) rig_set_debug HAMLIB_PARAMS((enum rig_debug_level_e debug_level)); 01653 #define rig_set_debug_level(level) rig_set_debug(level) 01654 extern HAMLIB_EXPORT(int) rig_need_debug HAMLIB_PARAMS((enum rig_debug_level_e debug_level)); 01655 extern HAMLIB_EXPORT(void) rig_debug HAMLIB_PARAMS((enum rig_debug_level_e debug_level, const char *fmt, ...)); 01656 extern HAMLIB_EXPORT(vprintf_cb_t) rig_set_debug_callback HAMLIB_PARAMS((vprintf_cb_t cb, rig_ptr_t arg)); 01657 extern HAMLIB_EXPORT(FILE*) rig_set_debug_file HAMLIB_PARAMS((FILE *stream)); 01658 01659 extern HAMLIB_EXPORT(int) rig_register HAMLIB_PARAMS((const struct rig_caps *caps)); 01660 extern HAMLIB_EXPORT(int) rig_unregister HAMLIB_PARAMS((rig_model_t rig_model)); 01661 extern HAMLIB_EXPORT(int) rig_list_foreach HAMLIB_PARAMS((int (*cfunc)(const struct rig_caps*, rig_ptr_t), rig_ptr_t data)); 01662 extern HAMLIB_EXPORT(int) rig_load_backend HAMLIB_PARAMS((const char *be_name)); 01663 extern HAMLIB_EXPORT(int) rig_check_backend HAMLIB_PARAMS((rig_model_t rig_model)); 01664 extern HAMLIB_EXPORT(int) rig_load_all_backends HAMLIB_PARAMS((void)); 01665 01666 typedef int (*rig_probe_func_t)(const hamlib_port_t *, rig_model_t, rig_ptr_t); 01667 extern HAMLIB_EXPORT(int) rig_probe_all HAMLIB_PARAMS((hamlib_port_t *p, rig_probe_func_t, rig_ptr_t)); 01668 extern HAMLIB_EXPORT(rig_model_t) rig_probe HAMLIB_PARAMS((hamlib_port_t *p)); 01669 01670 01671 /* Misc calls */ 01672 extern HAMLIB_EXPORT(const char *) rig_strrmode(rmode_t mode); 01673 extern HAMLIB_EXPORT(const char *) rig_strvfo(vfo_t vfo); 01674 extern HAMLIB_EXPORT(const char *) rig_strfunc(setting_t); 01675 extern HAMLIB_EXPORT(const char *) rig_strlevel(setting_t); 01676 extern HAMLIB_EXPORT(const char *) rig_strparm(setting_t); 01677 extern HAMLIB_EXPORT(const char *) rig_strptrshift(rptr_shift_t); 01678 extern HAMLIB_EXPORT(const char *) rig_strvfop(vfo_op_t op); 01679 extern HAMLIB_EXPORT(const char *) rig_strscan(scan_t scan); 01680 extern HAMLIB_EXPORT(const char *) rig_strstatus(enum rig_status_e status); 01681 extern HAMLIB_EXPORT(const char *) rig_strmtype(chan_type_t mtype); 01682 01683 extern HAMLIB_EXPORT(rmode_t) rig_parse_mode(const char *s); 01684 extern HAMLIB_EXPORT(vfo_t) rig_parse_vfo(const char *s); 01685 extern HAMLIB_EXPORT(setting_t) rig_parse_func(const char *s); 01686 extern HAMLIB_EXPORT(setting_t) rig_parse_level(const char *s); 01687 extern HAMLIB_EXPORT(setting_t) rig_parse_parm(const char *s); 01688 extern HAMLIB_EXPORT(vfo_op_t) rig_parse_vfo_op(const char *s); 01689 extern HAMLIB_EXPORT(scan_t) rig_parse_scan(const char *s); 01690 extern HAMLIB_EXPORT(rptr_shift_t) rig_parse_rptr_shift(const char *s); 01691 extern HAMLIB_EXPORT(chan_type_t) rig_parse_mtype(const char *s); 01692 01693 01694 __END_DECLS 01695 01696 #endif /* _RIG_H */ 01697
Hamlib documentation for version 1.2.8 -- Mon Dec 15 18:03:30 2008
Project page: http://hamlib.org