00001 /* 00002 * Hamlib Interface - API header 00003 * Copyright (c) 2000-2005 by Stephane Fillod and Frank Singleton 00004 * 00005 * $Id: rig.h,v 1.121 2007/02/28 08:52:49 mardigras 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 00303 typedef int vfo_t; 00304 00306 #define RIG_VFO_NONE 0 00307 00308 #define RIG_VFO_TX_FLAG ((vfo_t)(1<<30)) 00309 00311 #define RIG_VFO_CURR ((vfo_t)(1<<29)) 00312 00314 #define RIG_VFO_MEM ((vfo_t)(1<<28)) 00315 00317 #define RIG_VFO_VFO ((vfo_t)(1<<27)) 00318 00319 #define RIG_VFO_TX_VFO(v) ((v)|RIG_VFO_TX_FLAG) 00320 00322 #define RIG_VFO_TX RIG_VFO_TX_VFO(RIG_VFO_CURR) 00323 00325 #define RIG_VFO_RX RIG_VFO_CURR 00326 00328 #define RIG_VFO_MAIN ((vfo_t)(1<<26)) 00329 00330 #define RIG_VFO_SUB ((vfo_t)(1<<25)) 00331 00332 #define RIG_VFO_N(n) ((vfo_t)(1<<(n))) 00333 00335 #define RIG_VFO_A RIG_VFO_N(0) 00336 00337 #define RIG_VFO_B RIG_VFO_N(1) 00338 00339 #define RIG_VFO_C RIG_VFO_N(2) 00340 00341 00342 /* 00343 * targetable bitfields, for internal use. 00344 * RIG_TARGETABLE_PURE means a pure targetable radio on every command 00345 */ 00346 #define RIG_TARGETABLE_NONE 0 00347 #define RIG_TARGETABLE_FREQ (1<<0) 00348 #define RIG_TARGETABLE_MODE (1<<1) 00349 #define RIG_TARGETABLE_PURE (1<<2) 00350 #define RIG_TARGETABLE_ALL 0x7fffffff 00351 00352 00353 #define RIG_PASSBAND_NORMAL s_Hz(0) 00354 00358 typedef shortfreq_t pbwidth_t; 00359 00360 00364 typedef enum dcd_e { 00365 RIG_DCD_OFF = 0, 00366 RIG_DCD_ON 00367 } dcd_t; 00368 00373 typedef enum { 00374 RIG_DCD_NONE = 0, 00375 RIG_DCD_RIG, 00376 RIG_DCD_SERIAL_DSR, 00377 RIG_DCD_SERIAL_CTS, 00378 RIG_DCD_SERIAL_CAR, 00379 RIG_DCD_PARALLEL 00380 } dcd_type_t; 00381 00382 00386 typedef enum { 00387 RIG_PTT_OFF = 0, 00388 RIG_PTT_ON 00389 } ptt_t; 00390 00395 typedef enum { 00396 RIG_PTT_NONE = 0, 00397 RIG_PTT_RIG, 00398 RIG_PTT_SERIAL_DTR, 00399 RIG_PTT_SERIAL_RTS, 00400 RIG_PTT_PARALLEL 00401 } ptt_type_t; 00402 00406 typedef enum { 00407 RIG_POWER_OFF = 0, 00408 RIG_POWER_ON = (1<<0), 00409 RIG_POWER_STANDBY = (1<<1) 00410 } powerstat_t; 00411 00415 typedef enum { 00416 RIG_RESET_NONE = 0, 00417 RIG_RESET_SOFT = (1<<0), 00418 RIG_RESET_VFO = (1<<1), 00419 RIG_RESET_MCALL = (1<<2), 00420 RIG_RESET_MASTER = (1<<3) 00421 } reset_t; 00422 00423 00435 typedef enum { 00436 RIG_OP_NONE = 0, 00437 RIG_OP_CPY = (1<<0), 00438 RIG_OP_XCHG = (1<<1), 00439 RIG_OP_FROM_VFO = (1<<2), 00440 RIG_OP_TO_VFO = (1<<3), 00441 RIG_OP_MCL = (1<<4), 00442 RIG_OP_UP = (1<<5), 00443 RIG_OP_DOWN = (1<<6), 00444 RIG_OP_BAND_UP = (1<<7), 00445 RIG_OP_BAND_DOWN = (1<<8), 00446 RIG_OP_LEFT = (1<<9), 00447 RIG_OP_RIGHT = (1<<10), 00448 RIG_OP_TUNE = (1<<11), 00449 RIG_OP_TOGGLE = (1<<12) 00450 } vfo_op_t; 00451 00452 00456 typedef enum { 00457 RIG_SCAN_NONE = 0, 00458 RIG_SCAN_STOP = RIG_SCAN_NONE, 00459 RIG_SCAN_MEM = (1<<0), 00460 RIG_SCAN_SLCT = (1<<1), 00461 RIG_SCAN_PRIO = (1<<2), 00462 RIG_SCAN_PROG = (1<<3), 00463 RIG_SCAN_DELTA = (1<<4), 00464 RIG_SCAN_VFO = (1<<5), 00465 RIG_SCAN_PLT = (1<<6) 00466 } scan_t; 00467 00471 typedef long token_t; 00472 00473 #define RIG_CONF_END 0 00474 00487 /* strongly inspired from soundmedem. Thanks Thomas! */ 00488 00489 enum rig_conf_e { 00490 RIG_CONF_STRING, 00491 RIG_CONF_COMBO, 00492 RIG_CONF_NUMERIC, 00493 RIG_CONF_CHECKBUTTON 00494 }; 00495 00496 #define RIG_COMBO_MAX 8 00497 00501 struct confparams { 00502 token_t token; 00503 const char *name; 00504 const char *label; 00505 const char *tooltip; 00506 const char *dflt; 00507 enum rig_conf_e type; 00508 union { 00509 struct { 00510 float min; 00511 float max; 00512 float step; 00513 } n; 00514 struct { 00515 const char *combostr[RIG_COMBO_MAX]; 00516 } c; 00517 } u; 00518 }; 00519 00523 typedef enum { 00524 RIG_ANN_NONE = 0, 00525 RIG_ANN_OFF = RIG_ANN_NONE, 00526 RIG_ANN_FREQ = (1<<0), 00527 RIG_ANN_RXMODE = (1<<1), 00528 RIG_ANN_CW = (1<<2), 00529 RIG_ANN_ENG = (1<<3), 00530 RIG_ANN_JAP = (1<<4) 00531 } ann_t; 00532 00533 00534 /* Antenna number */ 00535 typedef int ant_t; 00536 00537 #define RIG_ANT_NONE 0 00538 #define RIG_ANT_N(n) ((ant_t)1<<(n)) 00539 #define RIG_ANT_1 RIG_ANT_N(0) 00540 #define RIG_ANT_2 RIG_ANT_N(1) 00541 #define RIG_ANT_3 RIG_ANT_N(2) 00542 #define RIG_ANT_4 RIG_ANT_N(3) 00543 00547 /* TODO: kill me, and replace by real AGC delay */ 00548 enum agc_level_e { 00549 RIG_AGC_OFF = 0, 00550 RIG_AGC_SUPERFAST, 00551 RIG_AGC_FAST, 00552 RIG_AGC_SLOW, 00553 RIG_AGC_USER, 00554 RIG_AGC_MEDIUM 00555 }; 00556 00560 enum meter_level_e { 00561 RIG_METER_NONE = 0, /*< No display meter */ 00562 RIG_METER_SWR = (1<<0), /*< Stationary Wave Ratio */ 00563 RIG_METER_COMP = (1<<1), /*< Compression level */ 00564 RIG_METER_ALC = (1<<2), /*< ALC */ 00565 RIG_METER_IC = (1<<3), /*< IC */ 00566 RIG_METER_DB = (1<<4) /*< DB */ 00567 }; 00568 00573 typedef union { 00574 signed int i; 00575 float f; 00576 char *s; 00577 const char *cs; 00578 } value_t; 00579 00581 enum rig_level_e { 00582 RIG_LEVEL_NONE = 0, 00583 RIG_LEVEL_PREAMP = (1<<0), 00584 RIG_LEVEL_ATT = (1<<1), 00585 RIG_LEVEL_VOX = (1<<2), 00586 RIG_LEVEL_AF = (1<<3), 00587 RIG_LEVEL_RF = (1<<4), 00588 RIG_LEVEL_SQL = (1<<5), 00589 RIG_LEVEL_IF = (1<<6), 00590 RIG_LEVEL_APF = (1<<7), 00591 RIG_LEVEL_NR = (1<<8), 00592 RIG_LEVEL_PBT_IN = (1<<9), 00593 RIG_LEVEL_PBT_OUT = (1<<10), 00594 RIG_LEVEL_CWPITCH = (1<<11), 00595 RIG_LEVEL_RFPOWER = (1<<12), 00596 RIG_LEVEL_MICGAIN = (1<<13), 00597 RIG_LEVEL_KEYSPD = (1<<14), 00598 RIG_LEVEL_NOTCHF = (1<<15), 00599 RIG_LEVEL_COMP = (1<<16), 00600 RIG_LEVEL_AGC = (1<<17), 00601 RIG_LEVEL_BKINDL = (1<<18), 00602 RIG_LEVEL_BALANCE = (1<<19), 00603 RIG_LEVEL_METER = (1<<20), 00605 RIG_LEVEL_VOXGAIN = (1<<21), 00606 RIG_LEVEL_VOXDELAY = RIG_LEVEL_VOX, 00607 RIG_LEVEL_ANTIVOX = (1<<22), 00608 //RIG_LEVEL_LINEOUT = (1<<23),/*!< Lineout Volume, arg float [0.0 .. 1.0] */ 00609 00611 RIG_LEVEL_RAWSTR = (1<<26), 00612 RIG_LEVEL_SQLSTAT = (1<<27), 00613 RIG_LEVEL_SWR = (1<<28), 00614 RIG_LEVEL_ALC = (1<<29), 00615 RIG_LEVEL_STRENGTH = (1<<30) 00616 /*RIG_LEVEL_BWC = (1<<31)*/ 00617 }; 00618 00619 #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) 00620 00621 #define RIG_LEVEL_READONLY_LIST (RIG_LEVEL_SQLSTAT|RIG_LEVEL_SWR|RIG_LEVEL_ALC|RIG_LEVEL_STRENGTH|RIG_LEVEL_RAWSTR) 00622 00623 #define RIG_LEVEL_IS_FLOAT(l) ((l)&RIG_LEVEL_FLOAT_LIST) 00624 #define RIG_LEVEL_SET(l) ((l)&~RIG_LEVEL_READONLY_LIST) 00625 00626 00631 enum rig_parm_e { 00632 RIG_PARM_NONE = 0, 00633 RIG_PARM_ANN = (1<<0), 00634 RIG_PARM_APO = (1<<1), 00635 RIG_PARM_BACKLIGHT = (1<<2), 00636 RIG_PARM_BEEP = (1<<4), 00637 RIG_PARM_TIME = (1<<5), 00638 RIG_PARM_BAT = (1<<6), 00639 RIG_PARM_KEYLIGHT = (1<<7) 00640 }; 00641 00642 #define RIG_PARM_FLOAT_LIST (RIG_PARM_BACKLIGHT|RIG_PARM_BAT) 00643 #define RIG_PARM_READONLY_LIST (RIG_PARM_BAT) 00644 00645 #define RIG_PARM_IS_FLOAT(l) ((l)&RIG_PARM_FLOAT_LIST) 00646 #define RIG_PARM_SET(l) ((l)&~RIG_PARM_READONLY_LIST) 00647 00648 #define RIG_SETTING_MAX 32 00649 00655 typedef unsigned long setting_t; 00656 00657 /* 00658 * tranceive mode, ie. the rig notify the host of any event, 00659 * like freq changed, mode changed, etc. 00660 */ 00661 #define RIG_TRN_OFF 0 00662 #define RIG_TRN_RIG 1 00663 #define RIG_TRN_POLL 2 00664 00665 00669 enum rig_func_e { 00670 RIG_FUNC_NONE = 0, 00671 RIG_FUNC_FAGC = (1<<0), 00672 RIG_FUNC_NB = (1<<1), 00673 RIG_FUNC_COMP = (1<<2), 00674 RIG_FUNC_VOX = (1<<3), 00675 RIG_FUNC_TONE = (1<<4), 00676 RIG_FUNC_TSQL = (1<<5), 00677 RIG_FUNC_SBKIN = (1<<6), 00678 RIG_FUNC_FBKIN = (1<<7), 00679 RIG_FUNC_ANF = (1<<8), 00680 RIG_FUNC_NR = (1<<9), 00681 RIG_FUNC_AIP = (1<<10), 00682 RIG_FUNC_APF = (1<<11), 00683 RIG_FUNC_MON = (1<<12), 00684 RIG_FUNC_MN = (1<<13), 00685 RIG_FUNC_RF = (1<<14), 00686 RIG_FUNC_ARO = (1<<15), 00687 RIG_FUNC_LOCK = (1<<16), 00688 RIG_FUNC_MUTE = (1<<17), 00689 RIG_FUNC_VSC = (1<<18), 00690 RIG_FUNC_REV = (1<<19), 00691 RIG_FUNC_SQL = (1<<20), 00692 RIG_FUNC_ABM = (1<<21), 00693 RIG_FUNC_BC = (1<<22), 00694 RIG_FUNC_MBC = (1<<23), 00695 /* (1<<24), used to be RIG_FUNC_LMP, see RIG_PARM_BACKLIGHT instead) */ 00696 RIG_FUNC_AFC = (1<<25), 00697 RIG_FUNC_SATMODE = (1<<26), 00698 RIG_FUNC_SCOPE = (1<<27), 00699 RIG_FUNC_RESUME = (1<<28), 00700 RIG_FUNC_TBURST = (1<<29), 00701 RIG_FUNC_TUNER = (1<<30) 00702 }; 00703 00704 /* 00705 * power unit macros, converts to mW 00706 * This is limited to 2MW on 32 bits systems. 00707 */ 00708 #define mW(p) ((int)(p)) 00709 #define Watts(p) ((int)((p)*1000)) 00710 #define W(p) Watts(p) 00711 #define kW(p) ((int)((p)*1000000L)) 00712 00716 typedef enum { 00717 RIG_MODE_NONE = 0, 00718 RIG_MODE_AM = (1<<0), 00719 RIG_MODE_CW = (1<<1), 00720 RIG_MODE_USB = (1<<2), 00721 RIG_MODE_LSB = (1<<3), 00722 RIG_MODE_RTTY = (1<<4), 00723 RIG_MODE_FM = (1<<5), 00724 RIG_MODE_WFM = (1<<6), 00725 RIG_MODE_CWR = (1<<7), 00726 RIG_MODE_RTTYR = (1<<8), 00727 RIG_MODE_AMS = (1<<9), 00728 RIG_MODE_PKTLSB = (1<<10), 00729 RIG_MODE_PKTUSB = (1<<11), 00730 RIG_MODE_PKTFM = (1<<12), 00731 RIG_MODE_ECSSUSB = (1<<13), 00732 RIG_MODE_ECSSLSB = (1<<14), 00733 RIG_MODE_FAX = (1<<15), 00734 RIG_MODE_SAM = (1<<16), 00735 RIG_MODE_SAL = (1<<17), 00736 RIG_MODE_SAH = (1<<18) 00738 } rmode_t; 00739 00741 #define RIG_MODE_SSB (RIG_MODE_USB|RIG_MODE_LSB) 00742 00744 #define RIG_MODE_ECSS (RIG_MODE_ECSSUSB|RIG_MODE_ECSSLSB) 00745 00746 00747 #define RIG_DBLST_END 0 /* end marker in a preamp/att level list */ 00748 #define RIG_IS_DBLST_END(d) ((d)==0) 00749 00756 typedef struct freq_range_list { 00757 freq_t start; 00758 freq_t end; 00759 rmode_t modes; 00760 int low_power; 00761 int high_power; 00762 vfo_t vfo; 00763 ant_t ant; 00764 } freq_range_t; 00765 00766 #define RIG_FRNG_END {Hz(0),Hz(0),RIG_MODE_NONE,0,0,RIG_VFO_NONE} 00767 #define RIG_IS_FRNG_END(r) ((r).start == Hz(0) && (r).end == Hz(0)) 00768 00769 #define RIG_ITU_REGION1 1 00770 #define RIG_ITU_REGION2 2 00771 #define RIG_ITU_REGION3 3 00772 00792 struct tuning_step_list { 00793 rmode_t modes; 00794 shortfreq_t ts; 00795 }; 00796 00797 #define RIG_TS_ANY 0 00798 #define RIG_TS_END {RIG_MODE_NONE,0} 00799 #define RIG_IS_TS_END(t) ((t).modes == RIG_MODE_NONE && (t).ts == 0) 00800 00827 struct filter_list { 00828 rmode_t modes; 00829 pbwidth_t width; 00830 }; 00831 00832 #define RIG_FLT_ANY 0 00833 #define RIG_FLT_END {RIG_MODE_NONE,0} 00834 #define RIG_IS_FLT_END(f) ((f).modes == RIG_MODE_NONE) 00835 00836 00837 /* 00838 * Used in the channel.flags field 00839 */ 00840 #define RIG_CHFLAG_NONE 0 00841 #define RIG_CHFLAG_SKIP (1<<0) 00842 /* DATA port mode flag */ 00843 #define RIG_CHFLAG_DATA (1<<1) 00844 00849 struct ext_list { 00850 token_t token; 00851 value_t val; 00852 }; 00853 00854 #define RIG_EXT_END {0, {.i=0}} 00855 #define RIG_IS_EXT_END(x) ((x).token == 0) 00856 00864 struct channel { 00865 int channel_num; 00866 int bank_num; 00867 vfo_t vfo; 00868 int ant; 00869 freq_t freq; 00870 rmode_t mode; 00871 pbwidth_t width; 00873 freq_t tx_freq; 00874 rmode_t tx_mode; 00875 pbwidth_t tx_width; 00877 split_t split; 00878 vfo_t tx_vfo; 00880 rptr_shift_t rptr_shift; 00881 shortfreq_t rptr_offs; 00882 shortfreq_t tuning_step; 00883 shortfreq_t rit; 00884 shortfreq_t xit; 00885 setting_t funcs; 00886 value_t levels[RIG_SETTING_MAX]; 00887 tone_t ctcss_tone; 00888 tone_t ctcss_sql; 00889 tone_t dcs_code; 00890 tone_t dcs_sql; 00891 int scan_group; 00892 int flags; 00893 char channel_desc[MAXCHANDESC]; 00894 struct ext_list *ext_levels; 00895 }; 00897 typedef struct channel channel_t; 00898 00904 struct channel_cap { 00905 unsigned bank_num:1; 00906 unsigned vfo:1; 00907 unsigned ant:1; 00908 unsigned freq:1; 00909 unsigned mode:1; 00910 unsigned width:1; 00912 unsigned tx_freq:1; 00913 unsigned tx_mode:1; 00914 unsigned tx_width:1; 00916 unsigned split:1; 00917 unsigned tx_vfo:1; 00918 unsigned rptr_shift:1; 00919 unsigned rptr_offs:1; 00920 unsigned tuning_step:1; 00921 unsigned rit:1; 00922 unsigned xit:1; 00923 setting_t funcs; 00924 setting_t levels; 00925 unsigned ctcss_tone:1; 00926 unsigned ctcss_sql:1; 00927 unsigned dcs_code:1; 00928 unsigned dcs_sql:1; 00929 unsigned scan_group:1; 00930 unsigned flags:1; 00931 unsigned channel_desc:1; 00932 unsigned ext_levels:1; 00933 }; 00934 00936 typedef struct channel_cap channel_cap_t; 00937 00938 00949 typedef enum { 00950 RIG_MTYPE_NONE=0, 00951 RIG_MTYPE_MEM, 00952 RIG_MTYPE_EDGE, 00953 RIG_MTYPE_CALL, 00954 RIG_MTYPE_MEMOPAD, 00955 RIG_MTYPE_SAT 00956 } chan_type_t; 00957 00971 struct chan_list { 00972 int start; 00973 int end; 00974 chan_type_t type; 00975 channel_cap_t mem_caps; 00976 }; 00977 00978 #define RIG_CHAN_END {0,0,RIG_MTYPE_NONE} 00979 #define RIG_IS_CHAN_END(c) ((c).type == RIG_MTYPE_NONE) 00980 00982 typedef struct chan_list chan_t; 00983 00995 struct gran { 00996 value_t min; 00997 value_t max; 00998 value_t step; 00999 }; 01000 01002 typedef struct gran gran_t; 01003 01004 01006 struct cal_table { 01007 int size; 01008 struct { 01009 int raw; 01010 int val; 01011 } table[MAX_CAL_LENGTH]; 01012 }; 01013 01026 typedef struct cal_table cal_table_t; 01027 01028 #define EMPTY_STR_CAL { 0, { { 0, 0 }, } } 01029 01030 01031 typedef int (*chan_cb_t) (RIG *, channel_t**, int, const chan_t*, rig_ptr_t); 01032 typedef int (*confval_cb_t) (RIG *, const struct confparams *, value_t *, rig_ptr_t); 01033 01052 struct rig_caps { 01053 rig_model_t rig_model; 01054 const char *model_name; 01055 const char *mfg_name; 01056 const char *version; 01057 const char *copyright; 01058 enum rig_status_e status; 01060 int rig_type; 01061 ptt_type_t ptt_type; 01062 dcd_type_t dcd_type; 01063 rig_port_t port_type; 01065 int serial_rate_min; 01066 int serial_rate_max; 01067 int serial_data_bits; 01068 int serial_stop_bits; 01069 enum serial_parity_e serial_parity; 01070 enum serial_handshake_e serial_handshake; 01072 int write_delay; 01073 int post_write_delay; 01074 int timeout; 01075 int retry; 01077 setting_t has_get_func; 01078 setting_t has_set_func; 01079 setting_t has_get_level; 01080 setting_t has_set_level; 01081 setting_t has_get_parm; 01082 setting_t has_set_parm; 01084 gran_t level_gran[RIG_SETTING_MAX]; 01085 gran_t parm_gran[RIG_SETTING_MAX]; 01087 const struct confparams *extparms; 01088 const struct confparams *extlevels; 01090 const tone_t *ctcss_list; 01091 const tone_t *dcs_list; 01093 int preamp[MAXDBLSTSIZ]; 01094 int attenuator[MAXDBLSTSIZ]; 01095 shortfreq_t max_rit; 01096 shortfreq_t max_xit; 01097 shortfreq_t max_ifshift; 01099 ann_t announces; 01101 vfo_op_t vfo_ops; 01102 scan_t scan_ops; 01103 int targetable_vfo; 01104 int transceive; 01106 int bank_qty; 01107 int chan_desc_sz; 01109 chan_t chan_list[CHANLSTSIZ]; 01111 freq_range_t rx_range_list1[FRQRANGESIZ]; 01112 freq_range_t tx_range_list1[FRQRANGESIZ]; 01113 freq_range_t rx_range_list2[FRQRANGESIZ]; 01114 freq_range_t tx_range_list2[FRQRANGESIZ]; 01116 struct tuning_step_list tuning_steps[TSLSTSIZ]; 01117 struct filter_list filters[FLTLSTSIZ]; 01119 cal_table_t str_cal; 01121 const struct confparams *cfgparams; 01122 const rig_ptr_t priv; 01124 /* 01125 * Rig API 01126 * 01127 */ 01128 01129 int (*rig_init) (RIG * rig); 01130 int (*rig_cleanup) (RIG * rig); 01131 int (*rig_open) (RIG * rig); 01132 int (*rig_close) (RIG * rig); 01133 01134 /* 01135 * General API commands, from most primitive to least.. :() 01136 * List Set/Get functions pairs 01137 */ 01138 01139 int (*set_freq) (RIG * rig, vfo_t vfo, freq_t freq); 01140 int (*get_freq) (RIG * rig, vfo_t vfo, freq_t * freq); 01141 01142 int (*set_mode) (RIG * rig, vfo_t vfo, rmode_t mode, 01143 pbwidth_t width); 01144 int (*get_mode) (RIG * rig, vfo_t vfo, rmode_t * mode, 01145 pbwidth_t * width); 01146 01147 int (*set_vfo) (RIG * rig, vfo_t vfo); 01148 int (*get_vfo) (RIG * rig, vfo_t * vfo); 01149 01150 int (*set_ptt) (RIG * rig, vfo_t vfo, ptt_t ptt); 01151 int (*get_ptt) (RIG * rig, vfo_t vfo, ptt_t * ptt); 01152 int (*get_dcd) (RIG * rig, vfo_t vfo, dcd_t * dcd); 01153 01154 int (*set_rptr_shift) (RIG * rig, vfo_t vfo, 01155 rptr_shift_t rptr_shift); 01156 int (*get_rptr_shift) (RIG * rig, vfo_t vfo, 01157 rptr_shift_t * rptr_shift); 01158 01159 int (*set_rptr_offs) (RIG * rig, vfo_t vfo, shortfreq_t offs); 01160 int (*get_rptr_offs) (RIG * rig, vfo_t vfo, shortfreq_t * offs); 01161 01162 int (*set_split_freq) (RIG * rig, vfo_t vfo, freq_t tx_freq); 01163 int (*get_split_freq) (RIG * rig, vfo_t vfo, freq_t * tx_freq); 01164 int (*set_split_mode) (RIG * rig, vfo_t vfo, rmode_t tx_mode, 01165 pbwidth_t tx_width); 01166 int (*get_split_mode) (RIG * rig, vfo_t vfo, rmode_t * tx_mode, 01167 pbwidth_t * tx_width); 01168 01169 int (*set_split_vfo) (RIG * rig, vfo_t vfo, split_t split, vfo_t tx_vfo); 01170 int (*get_split_vfo) (RIG * rig, vfo_t vfo, split_t * split, vfo_t *tx_vfo); 01171 01172 int (*set_rit) (RIG * rig, vfo_t vfo, shortfreq_t rit); 01173 int (*get_rit) (RIG * rig, vfo_t vfo, shortfreq_t * rit); 01174 int (*set_xit) (RIG * rig, vfo_t vfo, shortfreq_t xit); 01175 int (*get_xit) (RIG * rig, vfo_t vfo, shortfreq_t * xit); 01176 01177 int (*set_ts) (RIG * rig, vfo_t vfo, shortfreq_t ts); 01178 int (*get_ts) (RIG * rig, vfo_t vfo, shortfreq_t * ts); 01179 01180 int (*set_dcs_code) (RIG * rig, vfo_t vfo, tone_t code); 01181 int (*get_dcs_code) (RIG * rig, vfo_t vfo, tone_t * code); 01182 int (*set_tone) (RIG * rig, vfo_t vfo, tone_t tone); 01183 int (*get_tone) (RIG * rig, vfo_t vfo, tone_t * tone); 01184 int (*set_ctcss_tone) (RIG * rig, vfo_t vfo, tone_t tone); 01185 int (*get_ctcss_tone) (RIG * rig, vfo_t vfo, tone_t * tone); 01186 01187 int (*set_dcs_sql) (RIG * rig, vfo_t vfo, tone_t code); 01188 int (*get_dcs_sql) (RIG * rig, vfo_t vfo, tone_t * code); 01189 int (*set_tone_sql) (RIG * rig, vfo_t vfo, tone_t tone); 01190 int (*get_tone_sql) (RIG * rig, vfo_t vfo, tone_t * tone); 01191 int (*set_ctcss_sql) (RIG * rig, vfo_t vfo, tone_t tone); 01192 int (*get_ctcss_sql) (RIG * rig, vfo_t vfo, tone_t * tone); 01193 01194 int (*power2mW) (RIG * rig, unsigned int *mwpower, float power, 01195 freq_t freq, rmode_t mode); 01196 int (*mW2power) (RIG * rig, float *power, unsigned int mwpower, 01197 freq_t freq, rmode_t mode); 01198 01199 int (*set_powerstat) (RIG * rig, powerstat_t status); 01200 int (*get_powerstat) (RIG * rig, powerstat_t * status); 01201 int (*reset) (RIG * rig, reset_t reset); 01202 01203 int (*set_ant) (RIG * rig, vfo_t vfo, ant_t ant); 01204 int (*get_ant) (RIG * rig, vfo_t vfo, ant_t * ant); 01205 01206 int (*set_level) (RIG * rig, vfo_t vfo, setting_t level, 01207 value_t val); 01208 int (*get_level) (RIG * rig, vfo_t vfo, setting_t level, 01209 value_t * val); 01210 01211 int (*set_func) (RIG * rig, vfo_t vfo, setting_t func, int status); 01212 int (*get_func) (RIG * rig, vfo_t vfo, setting_t func, 01213 int *status); 01214 01215 int (*set_parm) (RIG * rig, setting_t parm, value_t val); 01216 int (*get_parm) (RIG * rig, setting_t parm, value_t * val); 01217 01218 int (*set_ext_level)(RIG *rig, vfo_t vfo, token_t token, value_t val); 01219 int (*get_ext_level)(RIG *rig, vfo_t vfo, token_t token, value_t *val); 01220 01221 int (*set_ext_parm)(RIG *rig, token_t token, value_t val); 01222 int (*get_ext_parm)(RIG *rig, token_t token, value_t *val); 01223 01224 int (*set_conf) (RIG * rig, token_t token, const char *val); 01225 int (*get_conf) (RIG * rig, token_t token, char *val); 01226 01227 int (*send_dtmf) (RIG * rig, vfo_t vfo, const char *digits); 01228 int (*recv_dtmf) (RIG * rig, vfo_t vfo, char *digits, int *length); 01229 int (*send_morse) (RIG * rig, vfo_t vfo, const char *msg); 01230 01231 int (*set_bank) (RIG * rig, vfo_t vfo, int bank); 01232 int (*set_mem) (RIG * rig, vfo_t vfo, int ch); 01233 int (*get_mem) (RIG * rig, vfo_t vfo, int *ch); 01234 int (*vfo_op) (RIG * rig, vfo_t vfo, vfo_op_t op); 01235 int (*scan) (RIG * rig, vfo_t vfo, scan_t scan, int ch); 01236 01237 int (*set_trn) (RIG * rig, int trn); 01238 int (*get_trn) (RIG * rig, int *trn); 01239 01240 int (*decode_event) (RIG * rig); 01241 01242 int (*set_channel) (RIG * rig, const channel_t * chan); 01243 int (*get_channel) (RIG * rig, channel_t * chan); 01244 01245 const char *(*get_info) (RIG * rig); 01246 01247 int (*set_chan_all_cb) (RIG * rig, chan_cb_t chan_cb, rig_ptr_t); 01248 int (*get_chan_all_cb) (RIG * rig, chan_cb_t chan_cb, rig_ptr_t); 01249 01250 int (*set_mem_all_cb) (RIG * rig, chan_cb_t chan_cb, confval_cb_t parm_cb, rig_ptr_t); 01251 int (*get_mem_all_cb) (RIG * rig, chan_cb_t chan_cb, confval_cb_t parm_cb, rig_ptr_t); 01252 01253 const char *clone_combo_set; 01254 const char *clone_combo_get; 01255 }; 01256 01262 typedef struct { 01263 union { 01264 rig_port_t rig; 01265 ptt_type_t ptt; 01266 dcd_type_t dcd; 01267 } type; 01268 int fd; 01269 void* handle; 01271 int write_delay; 01272 int post_write_delay; 01273 struct { int tv_sec,tv_usec; } post_write_date; 01274 int timeout; 01275 int retry; 01277 char pathname[FILPATHLEN]; 01278 union { 01279 struct { 01280 int rate; 01281 int data_bits; 01282 int stop_bits; 01283 enum serial_parity_e parity; 01284 enum serial_handshake_e handshake; 01285 enum serial_control_state_e rts_state; 01286 enum serial_control_state_e dtr_state; 01287 } serial; 01288 struct { 01289 int pin; 01290 } parallel; 01291 struct { 01292 int vid; 01293 int pid; 01294 int conf; 01295 int iface; 01296 int alt; 01297 } usb; 01298 } parm; 01299 } hamlib_port_t; 01300 01301 #if !defined(__APPLE__) || !defined(__cplusplus) 01302 typedef hamlib_port_t port_t; 01303 #endif 01304 01305 01315 struct rig_state { 01316 /* 01317 * overridable fields 01318 */ 01319 hamlib_port_t rigport; 01320 hamlib_port_t pttport; 01321 hamlib_port_t dcdport; 01323 double vfo_comp; 01325 int itu_region; 01326 freq_range_t rx_range_list[FRQRANGESIZ]; 01327 freq_range_t tx_range_list[FRQRANGESIZ]; 01329 struct tuning_step_list tuning_steps[TSLSTSIZ]; 01331 struct filter_list filters[FLTLSTSIZ]; 01333 cal_table_t str_cal; 01335 chan_t chan_list[CHANLSTSIZ]; 01337 shortfreq_t max_rit; 01338 shortfreq_t max_xit; 01339 shortfreq_t max_ifshift; 01341 ann_t announces; 01343 int preamp[MAXDBLSTSIZ]; 01344 int attenuator[MAXDBLSTSIZ]; 01346 setting_t has_get_func; 01347 setting_t has_set_func; 01348 setting_t has_get_level; 01349 setting_t has_set_level; 01350 setting_t has_get_parm; 01351 setting_t has_set_parm; 01353 gran_t level_gran[RIG_SETTING_MAX]; 01354 gran_t parm_gran[RIG_SETTING_MAX]; 01357 /* 01358 * non overridable fields, internal use 01359 */ 01360 01361 int hold_decode; 01362 vfo_t current_vfo; 01363 int vfo_list; 01364 int comm_state; 01365 rig_ptr_t priv; 01366 rig_ptr_t obj; 01368 int transceive; 01369 int poll_interval; 01370 freq_t current_freq; 01371 rmode_t current_mode; 01372 pbwidth_t current_width; 01374 }; 01375 01376 01377 typedef int (*vprintf_cb_t) (enum rig_debug_level_e, rig_ptr_t, const char *, va_list); 01378 01379 typedef int (*freq_cb_t) (RIG *, vfo_t, freq_t, rig_ptr_t); 01380 typedef int (*mode_cb_t) (RIG *, vfo_t, rmode_t, pbwidth_t, rig_ptr_t); 01381 typedef int (*vfo_cb_t) (RIG *, vfo_t, rig_ptr_t); 01382 typedef int (*ptt_cb_t) (RIG *, vfo_t, ptt_t, rig_ptr_t); 01383 typedef int (*dcd_cb_t) (RIG *, vfo_t, dcd_t, rig_ptr_t); 01384 typedef int (*pltune_cb_t) (RIG *, vfo_t, freq_t *, rmode_t *, pbwidth_t *, rig_ptr_t); 01385 01403 struct rig_callbacks { 01404 freq_cb_t freq_event; 01405 rig_ptr_t freq_arg; 01406 mode_cb_t mode_event; 01407 rig_ptr_t mode_arg; 01408 vfo_cb_t vfo_event; 01409 rig_ptr_t vfo_arg; 01410 ptt_cb_t ptt_event; 01411 rig_ptr_t ptt_arg; 01412 dcd_cb_t dcd_event; 01413 rig_ptr_t dcd_arg; 01414 pltune_cb_t pltune; 01415 rig_ptr_t pltune_arg; 01416 /* etc.. */ 01417 }; 01418 01428 struct rig { 01429 struct rig_caps *caps; 01430 struct rig_state state; 01431 struct rig_callbacks callbacks; 01432 }; 01433 01434 01435 01436 /* --------------- API function prototypes -----------------*/ 01437 01438 extern HAMLIB_EXPORT(RIG *) rig_init HAMLIB_PARAMS((rig_model_t rig_model)); 01439 extern HAMLIB_EXPORT(int) rig_open HAMLIB_PARAMS((RIG *rig)); 01440 01441 /* 01442 * General API commands, from most primitive to least.. :() 01443 * List Set/Get functions pairs 01444 */ 01445 01446 extern HAMLIB_EXPORT(int) rig_set_freq HAMLIB_PARAMS((RIG *rig, vfo_t vfo, freq_t freq)); 01447 extern HAMLIB_EXPORT(int) rig_get_freq HAMLIB_PARAMS((RIG *rig, vfo_t vfo, freq_t *freq)); 01448 01449 extern HAMLIB_EXPORT(int) rig_set_mode HAMLIB_PARAMS((RIG *rig, vfo_t vfo, rmode_t mode, pbwidth_t width)); 01450 extern HAMLIB_EXPORT(int) rig_get_mode HAMLIB_PARAMS((RIG *rig, vfo_t vfo, rmode_t *mode, pbwidth_t *width)); 01451 01452 extern HAMLIB_EXPORT(int) rig_set_vfo HAMLIB_PARAMS((RIG *rig, vfo_t vfo)); 01453 extern HAMLIB_EXPORT(int) rig_get_vfo HAMLIB_PARAMS((RIG *rig, vfo_t *vfo)); 01454 01455 extern HAMLIB_EXPORT(int) rig_set_ptt HAMLIB_PARAMS((RIG *rig, vfo_t vfo, ptt_t ptt)); 01456 extern HAMLIB_EXPORT(int) rig_get_ptt HAMLIB_PARAMS((RIG *rig, vfo_t vfo, ptt_t *ptt)); 01457 01458 extern HAMLIB_EXPORT(int) rig_get_dcd HAMLIB_PARAMS((RIG *rig, vfo_t vfo, dcd_t *dcd)); 01459 01460 extern HAMLIB_EXPORT(int) rig_set_rptr_shift HAMLIB_PARAMS((RIG *rig, vfo_t vfo, rptr_shift_t rptr_shift)); 01461 extern HAMLIB_EXPORT(int) rig_get_rptr_shift HAMLIB_PARAMS((RIG *rig, vfo_t vfo, rptr_shift_t *rptr_shift)); 01462 extern HAMLIB_EXPORT(int) rig_set_rptr_offs HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t rptr_offs)); 01463 extern HAMLIB_EXPORT(int) rig_get_rptr_offs HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t *rptr_offs)); 01464 01465 extern HAMLIB_EXPORT(int) rig_set_ctcss_tone HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t tone)); 01466 extern HAMLIB_EXPORT(int) rig_get_ctcss_tone HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t *tone)); 01467 extern HAMLIB_EXPORT(int) rig_set_dcs_code HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t code)); 01468 extern HAMLIB_EXPORT(int) rig_get_dcs_code HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t *code)); 01469 01470 extern HAMLIB_EXPORT(int) rig_set_ctcss_sql HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t tone)); 01471 extern HAMLIB_EXPORT(int) rig_get_ctcss_sql HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t *tone)); 01472 extern HAMLIB_EXPORT(int) rig_set_dcs_sql HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t code)); 01473 extern HAMLIB_EXPORT(int) rig_get_dcs_sql HAMLIB_PARAMS((RIG *rig, vfo_t vfo, tone_t *code)); 01474 01475 extern HAMLIB_EXPORT(int) rig_set_split_freq HAMLIB_PARAMS((RIG *rig, vfo_t vfo, freq_t tx_freq)); 01476 extern HAMLIB_EXPORT(int) rig_get_split_freq HAMLIB_PARAMS((RIG *rig, vfo_t vfo, freq_t *tx_freq)); 01477 extern HAMLIB_EXPORT(int) rig_set_split_mode HAMLIB_PARAMS((RIG *rig, vfo_t vfo, rmode_t tx_mode, pbwidth_t tx_width)); 01478 extern HAMLIB_EXPORT(int) rig_get_split_mode HAMLIB_PARAMS((RIG *rig, vfo_t vfo, rmode_t *tx_mode, pbwidth_t *tx_width)); 01479 extern HAMLIB_EXPORT(int) rig_set_split_vfo HAMLIB_PARAMS((RIG*, vfo_t rx_vfo, split_t split, vfo_t tx_vfo)); 01480 extern HAMLIB_EXPORT(int) rig_get_split_vfo HAMLIB_PARAMS((RIG*, vfo_t rx_vfo, split_t *split, vfo_t *tx_vfo)); 01481 #define rig_set_split(r,v,s) rig_set_split_vfo((r),(v),(s),RIG_VFO_CURR) 01482 #define rig_get_split(r,v,s) ({ vfo_t _tx_vfo; rig_get_split_vfo((r),(v),(s),&_tx_vfo); }) 01483 01484 extern HAMLIB_EXPORT(int) rig_set_rit HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t rit)); 01485 extern HAMLIB_EXPORT(int) rig_get_rit HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t *rit)); 01486 extern HAMLIB_EXPORT(int) rig_set_xit HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t xit)); 01487 extern HAMLIB_EXPORT(int) rig_get_xit HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t *xit)); 01488 01489 extern HAMLIB_EXPORT(int) rig_set_ts HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t ts)); 01490 extern HAMLIB_EXPORT(int) rig_get_ts HAMLIB_PARAMS((RIG *rig, vfo_t vfo, shortfreq_t *ts)); 01491 01492 extern HAMLIB_EXPORT(int) rig_power2mW HAMLIB_PARAMS((RIG *rig, unsigned int *mwpower, float power, freq_t freq, rmode_t mode)); 01493 extern HAMLIB_EXPORT(int) rig_mW2power HAMLIB_PARAMS((RIG *rig, float *power, unsigned int mwpower, freq_t freq, rmode_t mode)); 01494 01495 extern HAMLIB_EXPORT(shortfreq_t) rig_get_resolution HAMLIB_PARAMS((RIG *rig, rmode_t mode)); 01496 01497 extern HAMLIB_EXPORT(int) rig_set_level HAMLIB_PARAMS((RIG *rig, vfo_t vfo, setting_t level, value_t val)); 01498 extern HAMLIB_EXPORT(int) rig_get_level HAMLIB_PARAMS((RIG *rig, vfo_t vfo, setting_t level, value_t *val)); 01499 01500 #define rig_get_strength(r,v,s) rig_get_level((r),(v),RIG_LEVEL_STRENGTH, (value_t*)(s)) 01501 01502 extern HAMLIB_EXPORT(int) rig_set_parm HAMLIB_PARAMS((RIG *rig, setting_t parm, value_t val)); 01503 extern HAMLIB_EXPORT(int) rig_get_parm HAMLIB_PARAMS((RIG *rig, setting_t parm, value_t *val)); 01504 01505 extern HAMLIB_EXPORT(int) rig_set_conf HAMLIB_PARAMS((RIG *rig, token_t token, const char *val)); 01506 extern HAMLIB_EXPORT(int) rig_get_conf HAMLIB_PARAMS((RIG *rig, token_t token, char *val)); 01507 01508 extern HAMLIB_EXPORT(int) rig_set_powerstat HAMLIB_PARAMS((RIG *rig, powerstat_t status)); 01509 extern HAMLIB_EXPORT(int) rig_get_powerstat HAMLIB_PARAMS((RIG *rig, powerstat_t *status)); 01510 01511 extern HAMLIB_EXPORT(int) rig_reset HAMLIB_PARAMS((RIG *rig, reset_t reset)); /* dangerous! */ 01512 01513 extern HAMLIB_EXPORT(int) rig_set_ext_level HAMLIB_PARAMS((RIG *rig, vfo_t vfo, 01514 token_t token, value_t val)); 01515 extern HAMLIB_EXPORT(int) rig_get_ext_level HAMLIB_PARAMS((RIG *rig, vfo_t vfo, 01516 token_t token, value_t *val)); 01517 01518 extern HAMLIB_EXPORT(int) rig_set_ext_parm HAMLIB_PARAMS((RIG *rig, token_t token, value_t val)); 01519 extern HAMLIB_EXPORT(int) rig_get_ext_parm HAMLIB_PARAMS((RIG *rig, token_t token, value_t *val)); 01520 01521 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)); 01522 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)); 01523 extern HAMLIB_EXPORT(const struct confparams*) rig_ext_lookup HAMLIB_PARAMS((RIG *rig, const char *name)); 01524 extern HAMLIB_EXPORT(const struct confparams *) rig_ext_lookup_tok HAMLIB_PARAMS((RIG *rig, token_t token)); 01525 extern HAMLIB_EXPORT(token_t) rig_ext_token_lookup HAMLIB_PARAMS((RIG *rig, const char *name)); 01526 01527 01528 extern HAMLIB_EXPORT(int) rig_token_foreach HAMLIB_PARAMS((RIG *rig, int (*cfunc)(const struct confparams *, rig_ptr_t), rig_ptr_t data)); 01529 extern HAMLIB_EXPORT(const struct confparams*) rig_confparam_lookup HAMLIB_PARAMS((RIG *rig, const char *name)); 01530 extern HAMLIB_EXPORT(token_t) rig_token_lookup HAMLIB_PARAMS((RIG *rig, const char *name)); 01531 01532 extern HAMLIB_EXPORT(int) rig_close HAMLIB_PARAMS((RIG *rig)); 01533 extern HAMLIB_EXPORT(int) rig_cleanup HAMLIB_PARAMS((RIG *rig)); 01534 01535 extern HAMLIB_EXPORT(int) rig_set_ant HAMLIB_PARAMS((RIG *rig, vfo_t vfo, ant_t ant)); /* antenna */ 01536 extern HAMLIB_EXPORT(int) rig_get_ant HAMLIB_PARAMS((RIG *rig, vfo_t vfo, ant_t *ant)); 01537 01538 extern HAMLIB_EXPORT(setting_t) rig_has_get_level HAMLIB_PARAMS((RIG *rig, setting_t level)); 01539 extern HAMLIB_EXPORT(setting_t) rig_has_set_level HAMLIB_PARAMS((RIG *rig, setting_t level)); 01540 01541 extern HAMLIB_EXPORT(setting_t) rig_has_get_parm HAMLIB_PARAMS((RIG *rig, setting_t parm)); 01542 extern HAMLIB_EXPORT(setting_t) rig_has_set_parm HAMLIB_PARAMS((RIG *rig, setting_t parm)); 01543 01544 extern HAMLIB_EXPORT(setting_t) rig_has_get_func HAMLIB_PARAMS((RIG *rig, setting_t func)); 01545 extern HAMLIB_EXPORT(setting_t) rig_has_set_func HAMLIB_PARAMS((RIG *rig, setting_t func)); 01546 01547 extern HAMLIB_EXPORT(int) rig_set_func HAMLIB_PARAMS((RIG *rig, vfo_t vfo, setting_t func, int status)); 01548 extern HAMLIB_EXPORT(int) rig_get_func HAMLIB_PARAMS((RIG *rig, vfo_t vfo, setting_t func, int *status)); 01549 01550 extern HAMLIB_EXPORT(int) rig_send_dtmf HAMLIB_PARAMS((RIG *rig, vfo_t vfo, const char *digits)); 01551 extern HAMLIB_EXPORT(int) rig_recv_dtmf HAMLIB_PARAMS((RIG *rig, vfo_t vfo, char *digits, int *length)); 01552 extern HAMLIB_EXPORT(int) rig_send_morse HAMLIB_PARAMS((RIG *rig, vfo_t vfo, const char *msg)); 01553 01554 extern HAMLIB_EXPORT(int) rig_set_bank HAMLIB_PARAMS((RIG *rig, vfo_t vfo, int bank)); 01555 extern HAMLIB_EXPORT(int) rig_set_mem HAMLIB_PARAMS((RIG *rig, vfo_t vfo, int ch)); 01556 extern HAMLIB_EXPORT(int) rig_get_mem HAMLIB_PARAMS((RIG *rig, vfo_t vfo, int *ch)); 01557 extern HAMLIB_EXPORT(int) rig_vfo_op HAMLIB_PARAMS((RIG *rig, vfo_t vfo, vfo_op_t op)); 01558 extern HAMLIB_EXPORT(vfo_op_t) rig_has_vfo_op HAMLIB_PARAMS((RIG *rig, vfo_op_t op)); 01559 extern HAMLIB_EXPORT(int) rig_scan HAMLIB_PARAMS((RIG *rig, vfo_t vfo, scan_t scan, int ch)); 01560 extern HAMLIB_EXPORT(scan_t) rig_has_scan HAMLIB_PARAMS((RIG *rig, scan_t scan)); 01561 01562 extern HAMLIB_EXPORT(int) rig_set_channel HAMLIB_PARAMS((RIG *rig, const channel_t *chan)); /* mem */ 01563 extern HAMLIB_EXPORT(int) rig_get_channel HAMLIB_PARAMS((RIG *rig, channel_t *chan)); 01564 01565 extern HAMLIB_EXPORT(int) rig_set_chan_all HAMLIB_PARAMS((RIG *rig, const channel_t chans[])); 01566 extern HAMLIB_EXPORT(int) rig_get_chan_all HAMLIB_PARAMS((RIG *rig, channel_t chans[])); 01567 extern HAMLIB_EXPORT(int) rig_set_chan_all_cb HAMLIB_PARAMS((RIG *rig, chan_cb_t chan_cb, rig_ptr_t)); 01568 extern HAMLIB_EXPORT(int) rig_get_chan_all_cb HAMLIB_PARAMS((RIG *rig, chan_cb_t chan_cb, rig_ptr_t)); 01569 01570 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)); 01571 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)); 01572 extern HAMLIB_EXPORT(int) rig_set_mem_all HAMLIB_PARAMS((RIG *rig, const channel_t *chan, const struct confparams *, const value_t *)); 01573 extern HAMLIB_EXPORT(int) rig_get_mem_all HAMLIB_PARAMS((RIG *rig, channel_t *chan, const struct confparams *, value_t *)); 01574 01575 extern HAMLIB_EXPORT(int) rig_set_trn HAMLIB_PARAMS((RIG *rig, int trn)); 01576 extern HAMLIB_EXPORT(int) rig_get_trn HAMLIB_PARAMS((RIG *rig, int *trn)); 01577 extern HAMLIB_EXPORT(int) rig_set_freq_callback HAMLIB_PARAMS((RIG *, freq_cb_t, rig_ptr_t)); 01578 extern HAMLIB_EXPORT(int) rig_set_mode_callback HAMLIB_PARAMS((RIG *, mode_cb_t, rig_ptr_t)); 01579 extern HAMLIB_EXPORT(int) rig_set_vfo_callback HAMLIB_PARAMS((RIG *, vfo_cb_t, rig_ptr_t)); 01580 extern HAMLIB_EXPORT(int) rig_set_ptt_callback HAMLIB_PARAMS((RIG *, ptt_cb_t, rig_ptr_t)); 01581 extern HAMLIB_EXPORT(int) rig_set_dcd_callback HAMLIB_PARAMS((RIG *, dcd_cb_t, rig_ptr_t)); 01582 extern HAMLIB_EXPORT(int) rig_set_pltune_callback HAMLIB_PARAMS((RIG *, pltune_cb_t, rig_ptr_t)); 01583 01584 extern HAMLIB_EXPORT(const char *) rig_get_info HAMLIB_PARAMS((RIG *rig)); 01585 01586 extern HAMLIB_EXPORT(const struct rig_caps *) rig_get_caps HAMLIB_PARAMS((rig_model_t rig_model)); 01587 extern HAMLIB_EXPORT(const freq_range_t *) rig_get_range HAMLIB_PARAMS((const freq_range_t range_list[], freq_t freq, rmode_t mode)); 01588 01589 extern HAMLIB_EXPORT(pbwidth_t) rig_passband_normal HAMLIB_PARAMS((RIG *rig, rmode_t mode)); 01590 extern HAMLIB_EXPORT(pbwidth_t) rig_passband_narrow HAMLIB_PARAMS((RIG *rig, rmode_t mode)); 01591 extern HAMLIB_EXPORT(pbwidth_t) rig_passband_wide HAMLIB_PARAMS((RIG *rig, rmode_t mode)); 01592 01593 extern HAMLIB_EXPORT(const char *) rigerror HAMLIB_PARAMS((int errnum)); 01594 01595 extern HAMLIB_EXPORT(int) rig_setting2idx HAMLIB_PARAMS((setting_t s)); 01596 #define rig_idx2setting(i) (1UL<<(i)) 01597 01598 /* 01599 * Even if these functions are prefixed with "rig_", they are not rig specific 01600 * Maybe "hamlib_" would have been better. Let me know. --SF 01601 */ 01602 extern HAMLIB_EXPORT(void) rig_set_debug HAMLIB_PARAMS((enum rig_debug_level_e debug_level)); 01603 #define rig_set_debug_level(level) rig_set_debug(level) 01604 extern HAMLIB_EXPORT(int) rig_need_debug HAMLIB_PARAMS((enum rig_debug_level_e debug_level)); 01605 extern HAMLIB_EXPORT(void) rig_debug HAMLIB_PARAMS((enum rig_debug_level_e debug_level, const char *fmt, ...)); 01606 extern HAMLIB_EXPORT(vprintf_cb_t) rig_set_debug_callback HAMLIB_PARAMS((vprintf_cb_t cb, rig_ptr_t arg)); 01607 extern HAMLIB_EXPORT(FILE*) rig_set_debug_file HAMLIB_PARAMS((FILE *stream)); 01608 01609 extern HAMLIB_EXPORT(int) rig_register HAMLIB_PARAMS((const struct rig_caps *caps)); 01610 extern HAMLIB_EXPORT(int) rig_unregister HAMLIB_PARAMS((rig_model_t rig_model)); 01611 extern HAMLIB_EXPORT(int) rig_list_foreach HAMLIB_PARAMS((int (*cfunc)(const struct rig_caps*, rig_ptr_t), rig_ptr_t data)); 01612 extern HAMLIB_EXPORT(int) rig_load_backend HAMLIB_PARAMS((const char *be_name)); 01613 extern HAMLIB_EXPORT(int) rig_check_backend HAMLIB_PARAMS((rig_model_t rig_model)); 01614 extern HAMLIB_EXPORT(int) rig_load_all_backends HAMLIB_PARAMS((void)); 01615 01616 typedef int (*rig_probe_func_t)(const hamlib_port_t *, rig_model_t, rig_ptr_t); 01617 extern HAMLIB_EXPORT(int) rig_probe_all HAMLIB_PARAMS((hamlib_port_t *p, rig_probe_func_t, rig_ptr_t)); 01618 extern HAMLIB_EXPORT(rig_model_t) rig_probe HAMLIB_PARAMS((hamlib_port_t *p)); 01619 01620 01621 /* Misc calls */ 01622 extern HAMLIB_EXPORT(const char *) rig_strrmode(rmode_t mode); 01623 extern HAMLIB_EXPORT(const char *) rig_strvfo(vfo_t vfo); 01624 extern HAMLIB_EXPORT(const char *) rig_strfunc(setting_t); 01625 extern HAMLIB_EXPORT(const char *) rig_strlevel(setting_t); 01626 extern HAMLIB_EXPORT(const char *) rig_strparm(setting_t); 01627 extern HAMLIB_EXPORT(const char *) rig_strptrshift(rptr_shift_t); 01628 extern HAMLIB_EXPORT(const char *) rig_strvfop(vfo_op_t op); 01629 extern HAMLIB_EXPORT(const char *) rig_strscan(scan_t scan); 01630 extern HAMLIB_EXPORT(const char *) rig_strstatus(enum rig_status_e status); 01631 01632 extern HAMLIB_EXPORT(rmode_t) rig_parse_mode(const char *s); 01633 extern HAMLIB_EXPORT(vfo_t) rig_parse_vfo(const char *s); 01634 extern HAMLIB_EXPORT(setting_t) rig_parse_func(const char *s); 01635 extern HAMLIB_EXPORT(setting_t) rig_parse_level(const char *s); 01636 extern HAMLIB_EXPORT(setting_t) rig_parse_parm(const char *s); 01637 extern HAMLIB_EXPORT(vfo_op_t) rig_parse_vfo_op(const char *s); 01638 extern HAMLIB_EXPORT(scan_t) rig_parse_scan(const char *s); 01639 extern HAMLIB_EXPORT(rptr_shift_t) rig_parse_rptr_shift(const char *s); 01640 01641 01642 __END_DECLS 01643 01644 #endif /* _RIG_H */ 01645
Hamlib documentation for version 1.2.6.2 -- Sun Dec 9 09:34:31 2007
Project page: http://hamlib.org