mirror
/
Hamlib
kopia lustrzana https://github.com/Hamlib/Hamlib
1
0
Forkuj 0
Kod Zgłoszenia Projekty Wydania Wiki Aktywność

Fix some of the documentation

pull/224/head
Michael Black 2020-04-09 17:56:19 -05:00
rodzic 44b835bde5
commit f1f0d7f129
22 zmienionych plików z 391 dodań i 69 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

2
include/hamlib/ampclass.h
Wyświetl plik

@ -26,6 +26,7 @@
//! @cond Doxygen_Suppress
class BACKEND_IMPEXP Amplifier
{
private:
@ -56,6 +57,7 @@ public:
void reset(amp_reset_t reset);
};
//! @endcond

10
include/hamlib/amplifier.h
Wyświetl plik

@ -83,12 +83,14 @@ typedef int tune_value_t;
#define NETAMPCTL_RET "RPRT "
//! @cond Doxygen_Suppress
typedef enum
{
AMP_RESET_MEM, // erase tuner memory
AMP_RESET_FAULT, // reset any fault
AMP_RESET_AMP // for kpa1500
} amp_reset_t;
//! @endcond
/**
* \brief Amplifier type flags
@ -99,6 +101,7 @@ typedef enum
AMP_FLAG_2 = (1 << 2) /*!< TBD */
} amp_type_t;
//! @cond Doxygen_Suppress
// TBD AMP_TYPE
#define AMP_TYPE_MASK (AMP_FLAG_1|AMP_FLAG_2)
@ -106,8 +109,10 @@ typedef enum
#define AMP_TYPE_1 AMP_FLAG_1
#define AMP_TYPE_2 AMP_FLAG_2
#define AMP_TYPE_ALL (AMP_FLAG_1|AMP_FLAG_2)
//! @endcond
//! @cond Doxygen_Suppress
enum amp_level_e
{
AMP_LEVEL_NONE = 0, /*!< '' -- No Level */
@ -120,11 +125,14 @@ enum amp_level_e
AMP_LEVEL_PWR_PEAK = (1 << 6), /*!< \c Power reading peak */
AMP_LEVEL_FAULT = (1 << 7) /*!< \c Fault code */
};
//! @endcond
//! @cond Doxygen_Suppress
#define AMP_LEVEL_FLOAT_LIST (AMP_LEVEL_SWR)
#define AMP_LEVEL_STRING_LIST (AMP_LEVEL_FAULT)
#define AMP_LEVEL_IS_FLOAT(l) ((l)&AMP_LEVEL_FLOAT_LIST)
#define AMP_LEVEL_IS_STRING(l) ((l)&AMP_LEVEL_STRING_LIST)
//! @endcond
/* Basic amp type, can store some useful info about different amplifiers. Each
* lib must be able to populate this structure, so we can make useful
@ -148,6 +156,7 @@ enum amp_level_e
* mdblack98: Don't move fields around and add new fields at end of caps
* Shared libraries depend on constant structure to maintain compatibility
*/
//! @cond Doxygen_Suppress
#define AMP_MODEL(arg) .amp_model=arg,.macro_name=#arg
struct amp_caps
{
@ -221,6 +230,7 @@ struct amp_caps
const char *macro_name; /*!< Macro name. */
};
//! @cond Doxygen_Suppress
/**

4
include/hamlib/amplist.h
Wyświetl plik

@ -24,6 +24,7 @@
#ifndef _AMPLIST_H
#define _AMPLIST_H 1
//! @cond Doxygen_Suppress
#define AMP_MAKE_MODEL(a,b) ((a)*100+(b))
#define AMP_BACKEND_NUM(a) ((a)/100)
@ -34,7 +35,7 @@
*/
/**
* \file rotlist.h
* \file amplist.h
* \brief Hamlib amplifier model definitions.
*
* This file contains amplifier model definitions for the Hamlib amplifier API.
@ -98,6 +99,7 @@
*/
typedef int amp_model_t;
//! @endcond
#endif /* _AMPLIST_H */

265
include/hamlib/rig.h
Wyświetl plik

@ -48,6 +48,7 @@
/* __BEGIN_DECLS should be used at the beginning of your declarations,
* so that C++ compilers don't mangle their names. Use __END_DECLS at
* the end of C declarations. */
//! @cond Doxygen_Suppress
#undef __BEGIN_DECLS
#undef __END_DECLS
#ifdef __cplusplus
@ -57,10 +58,12 @@
# define __BEGIN_DECLS /* empty */
# define __END_DECLS /* empty */
#endif
//! @endcond
/* HAMLIB_PARAMS is a macro used to wrap function prototypes, so that compilers
* that don't understand ANSI C prototypes still work, and ANSI C
* compilers can issue warnings about type mismatches. */
//! @cond Doxygen_Suppress
#undef HAMLIB_PARAMS
#if defined (__STDC__) \
|| defined (_AIX) \
@ -76,11 +79,14 @@
# define rig_ptr_t char *
# define amp_ptr_t char *
#endif
//! @endcond
#include <hamlib/rig_dll.h>
#ifndef SWIGLUA
//! @cond Doxygen_Suppress
#define CONSTANT_64BIT_FLAG(BIT) (1ull << (BIT))
//! @endcond
#else
/* SWIG's older Lua generator doesn't grok ull due to Lua using a
double-precision floating point type internally for number
@ -97,10 +103,12 @@
__BEGIN_DECLS
//! @cond Doxygen_Suppress
extern HAMLIB_EXPORT_VAR(const char) hamlib_version[];
extern HAMLIB_EXPORT_VAR(const char) hamlib_copyright[];
extern HAMLIB_EXPORT_VAR(const char *) hamlib_version2;
extern HAMLIB_EXPORT_VAR(const char *) hamlib_copyright2;
//! @endcond
/**
* \brief Hamlib error codes
@ -164,6 +172,7 @@ struct rig_state;
*/
typedef struct s_rig RIG;
//! @cond Doxygen_Suppress
#define RIGNAMSIZ 30
#define RIGVERSIZ 8
#define FILPATHLEN 512
@ -174,6 +183,7 @@ typedef struct s_rig RIG;
#define MAXDBLSTSIZ 8 /* max preamp/att levels supported, zero ended */
#define CHANLSTSIZ 16 /* max mem_list size, zero ended */
#define MAX_CAL_LENGTH 32 /* max calibration plots in cal_table_t */
//! @endcond
/**
@ -259,6 +269,7 @@ typedef enum {
RIG_FLAG_TUNER = (1 << 11) /*!< dumb tuner */
} rig_type_t;
//! @cond Doxygen_Suppress
#define RIG_FLAG_TRANSCEIVER (RIG_FLAG_RECEIVER|RIG_FLAG_TRANSMITTER)
#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)
@ -272,6 +283,7 @@ typedef enum {
#define RIG_TYPE_TRUNKSCANNER (RIG_TYPE_SCANNER|RIG_FLAG_TRUNKING)
#define RIG_TYPE_COMPUTER (RIG_FLAG_TRANSCEIVER|RIG_FLAG_COMPUTER)
#define RIG_TYPE_TUNER RIG_FLAG_TUNER
//! @endcond
/**
@ -329,6 +341,9 @@ typedef double freq_t;
* \brief scanf(3) format to be used for freq_t type
*/
#define SCNfreq "lf"
/**
* \brief printf(3) format to be used for freq_t type
*/
#define FREQFMT SCNfreq
@ -339,16 +354,25 @@ typedef double freq_t;
*/
typedef signed long shortfreq_t;
/** \brief \c Macro to return Hz when f=Hz */
#define Hz(f) ((freq_t)(f))
/** \brief \c Macro to return Hz when f=kHz */
#define kHz(f) ((freq_t)((f)*(freq_t)1000))
/** \brief \c Macro to return Hz when f=MHz */
#define MHz(f) ((freq_t)((f)*(freq_t)1000000))
/** \brief \c Macro to return Hz when f=GHz */
#define GHz(f) ((freq_t)((f)*(freq_t)1000000000))
/** \brief \c Macro to return short Hz when f=Hz */
#define s_Hz(f) ((shortfreq_t)(f))
/** \brief \c Macro to return short Hz when f=kHz */
#define s_kHz(f) ((shortfreq_t)((f)*(shortfreq_t)1000))
/** \brief \c Macro to return short Hz when f=MHz */
#define s_MHz(f) ((shortfreq_t)((f)*(shortfreq_t)1000000))
/** \brief \c Macro to return short Hz when f=GHz */
#define s_GHz(f) ((shortfreq_t)((f)*(shortfreq_t)1000000000))
/** \brief \c Frequency none -- used as default value for checking */
#define RIG_FREQ_NONE Hz(0)
@ -372,6 +396,7 @@ typedef unsigned int vfo_t;
#define RIG_VFO_N(n) (1u<<(n))
/** \brief \c VFONone -- vfo unknown */
#define RIG_VFO_NONE 0
/** \brief \c VFOA -- VFO A */
@ -413,11 +438,13 @@ typedef unsigned int vfo_t;
/** \brief \c currVFO -- current "tunable channel"/VFO */
#define RIG_VFO_CURR RIG_VFO_N(29)
/** \brief \c Flag to set if VFO can transmit */
#define RIG_VFO_TX_FLAG RIG_VFO_N(30)
// we and also use RIG_VFO_N(31) if needed
// Misc VFO Macros
/** \brief \c Macro to tell you if VFO can transmit */
#define RIG_VFO_TX_VFO(v) ((v)|RIG_VFO_TX_FLAG)
/** \brief \c TX -- alias for split tx or uplink, of VFO_CURR */
@ -431,6 +458,7 @@ typedef unsigned int vfo_t;
* targetable bitfields, for internal use.
* RIG_TARGETABLE_PURE means a pure targetable radio on every command
*/
//! @cond Doxygen_Suppress
#define RIG_TARGETABLE_NONE 0
#define RIG_TARGETABLE_FREQ (1<<0)
#define RIG_TARGETABLE_MODE (1<<1)
@ -438,12 +466,19 @@ typedef unsigned int vfo_t;
#define RIG_TARGETABLE_TONE (1<<3)
#define RIG_TARGETABLE_FUNC (1<<4)
#define RIG_TARGETABLE_ALL 0x7fffffff
//! @endcond
/**
* \brief Macro for bandpass to be set to normal
* \def RIG_PASSBAND_NORMAL
*/
#define RIG_PASSBAND_NORMAL s_Hz(0)
/**
* \brief Macro for bandpass to be left alone
*/
#define RIG_PASSBAND_NOCHANGE s_Hz(-1)
/**
* \brief Passband width, in Hz
*
* \sa rig_passband_normal(), rig_passband_narrow(), rig_passband_wide()
*/
@ -590,7 +625,9 @@ typedef enum {
typedef long token_t;
//! @cond Doxygen_Suppress
#define RIG_CONF_END 0
//! @endcond
/**
@ -616,8 +653,10 @@ enum rig_conf_e {
RIG_CONF_BINARY /*!< Binary buffer type */
};
//! @cond Doxygen_Suppress
#define RIG_COMBO_MAX 16
#define RIG_BIN_MAX 80
//! @endcond
/**
* \brief Configuration parameter structure.
@ -658,8 +697,51 @@ typedef enum {
} ann_t;
/**
* \brief Antenna typedef
* \typedef ant_t
*/
/**
* \brief Antenna number
* \def RIG_ANT_NONE
* No antenna set yet or unknown
*/
/**
* \brief Antenna conversion macro
* \def RIG_ANT_N
* Convert antenna number to bit mask
*/
/**
* \brief Macro for Ant#1
* \def RIG_ANT_1
*/
/**
* \brief Macro for Ant#2
* \def RIG_ANT_2
*/
/**
* \brief Macro for Ant#3
* \def RIG_ANT_3
*/
/**
* \brief Macro for Ant#4
* \def RIG_ANT_4
*/
/**
* \brief Macro for Ant#5
* \def RIG_ANT_5
*/
/**
* \brief Antenna is on whatever "current" means
* \def RIG_ANT_CURR
*/
/**
* \brief Macro for unknown antenna
* \def RIG_ANT_UNKNOWN
*/
/**
* \brief Maximum antenna#
* \def RIG_ANT_MAX
*/
typedef unsigned int ant_t;
@ -691,7 +773,9 @@ enum agc_level_e {
RIG_AGC_AUTO
};
//! @cond Doxygen_Suppress
#define RIG_AGC_LAST RIG_AGC_AUTO
//! @endcond
/**
* \brief Level display meters
@ -718,10 +802,12 @@ typedef union {
float f; /*!< Single precision float */
char *s; /*!< Pointer to char string */
const char *cs; /*!< Pointer to constant char string */
//! @cond Doxygen_Suppress
struct {
int l; /*!< Length of data */
unsigned char *d; /* Pointer to data buffer */
} b;
//! @endcond
} value_t;
@ -779,12 +865,14 @@ enum rig_level_e {
RIG_LEVEL_NB = CONSTANT_64BIT_FLAG(38), /*!< \c NB -- Noise Blanker level, arg float [0.0 ... 1.0] */
};
//! @cond Doxygen_Suppress
#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|RIG_LEVEL_RFPOWER_METER|RIG_LEVEL_COMP_METER|RIG_LEVEL_VD_METER|RIG_LEVEL_ID_METER|RIG_LEVEL_NOTCHF_RAW|RIG_LEVEL_MONITOR_GAIN|RIG_LEVEL_NB)
#define RIG_LEVEL_READONLY_LIST (RIG_LEVEL_SQLSTAT|RIG_LEVEL_SWR|RIG_LEVEL_ALC|RIG_LEVEL_STRENGTH|RIG_LEVEL_RAWSTR|RIG_LEVEL_RFPOWER_METER|RIG_LEVEL_COMP_METER|RIG_LEVEL_VD_METER|RIG_LEVEL_ID_METER)
#define RIG_LEVEL_IS_FLOAT(l) ((l)&RIG_LEVEL_FLOAT_LIST)
#define RIG_LEVEL_SET(l) ((l)&~RIG_LEVEL_READONLY_LIST)
//! @endcond
/**
@ -807,11 +895,13 @@ enum rig_parm_e {
RIG_PARM_SCREENSAVER = (1 << 8) /*!< \c SCREENSAVER -- rig specific timeouts */
};
//! @cond Doxygen_Suppress
#define RIG_PARM_FLOAT_LIST (RIG_PARM_BACKLIGHT|RIG_PARM_BAT|RIG_PARM_KEYLIGHT)
#define RIG_PARM_READONLY_LIST (RIG_PARM_BAT)
#define RIG_PARM_IS_FLOAT(l) ((l)&RIG_PARM_FLOAT_LIST)
#define RIG_PARM_SET(l) ((l)&~RIG_PARM_READONLY_LIST)
//! @endcond
/**
* \brief Setting
@ -821,13 +911,24 @@ enum rig_parm_e {
*/
typedef uint64_t setting_t;
/**
* \brief Maximum # of rig settings
*
*/
#define RIG_SETTING_MAX 64
/**
* \brief Tranceive mode
*
* The rig notifies the host of any event, like freq changed, mode changed, etc.
* \def RIG_TRN_OFF
* Turn it off
* \brief Tranceive mode
* \def RIG_TRN_RIG
* RIG_TRN_RIG means the rig acts asynchrousnly
* \brief Tranceive mode
* \def RIG_TRN_POLL
* RIG_TRN_POLL means we have to poll the rig
*
*/
#define RIG_TRN_OFF 0
#define RIG_TRN_RIG 1
@ -895,42 +996,63 @@ typedef uint64_t setting_t;
#define RIG_FUNC_DIVERSITY CONSTANT_64BIT_FLAG (38) /*!< \c DIVERSITY -- Diversity receive */
#define RIG_FUNC_DSQL CONSTANT_64BIT_FLAG (39) /*!< \c DSQL -- Digital modes squelch */
#define RIG_FUNC_SCEN CONSTANT_64BIT_FLAG (40) /*!< \c SCEN -- scrambler/encryption */
#define RIG_FUNC_BIT41 CONSTANT_64BIT_FLAG (41) /* available for future RIG_FUNC items */
#define RIG_FUNC_BIT42 CONSTANT_64BIT_FLAG (42) /* available for future RIG_FUNC items */
#define RIG_FUNC_BIT43 CONSTANT_64BIT_FLAG (43) /* available for future RIG_FUNC items */
#define RIG_FUNC_BIT44 CONSTANT_64BIT_FLAG (44) /* available for future RIG_FUNC items */
#define RIG_FUNC_BIT45 CONSTANT_64BIT_FLAG (45) /* available for future RIG_FUNC items */
#define RIG_FUNC_BIT46 CONSTANT_64BIT_FLAG (46) /* available for future RIG_FUNC items */
#define RIG_FUNC_BIT47 CONSTANT_64BIT_FLAG (47) /* available for future RIG_FUNC items */
#define RIG_FUNC_BIT48 CONSTANT_64BIT_FLAG (48) /* available for future RIG_FUNC items */
#define RIG_FUNC_BIT49 CONSTANT_64BIT_FLAG (49) /* available for future RIG_FUNC items */
#define RIG_FUNC_BIT50 CONSTANT_64BIT_FLAG (50) /* available for future RIG_FUNC items */
#define RIG_FUNC_BIT51 CONSTANT_64BIT_FLAG (51) /* available for future RIG_FUNC items */
#define RIG_FUNC_BIT52 CONSTANT_64BIT_FLAG (52) /* available for future RIG_FUNC items */
#define RIG_FUNC_BIT53 CONSTANT_64BIT_FLAG (53) /* available for future RIG_FUNC items */
#define RIG_FUNC_BIT54 CONSTANT_64BIT_FLAG (54) /* available for future RIG_FUNC items */
#define RIG_FUNC_BIT55 CONSTANT_64BIT_FLAG (55) /* available for future RIG_FUNC items */
#define RIG_FUNC_BIT56 CONSTANT_64BIT_FLAG (56) /* available for future RIG_FUNC items */
#define RIG_FUNC_BIT57 CONSTANT_64BIT_FLAG (57) /* available for future RIG_FUNC items */
#define RIG_FUNC_BIT58 CONSTANT_64BIT_FLAG (58) /* available for future RIG_FUNC items */
#define RIG_FUNC_BIT59 CONSTANT_64BIT_FLAG (59) /* available for future RIG_FUNC items */
#define RIG_FUNC_BIT60 CONSTANT_64BIT_FLAG (60) /* available for future RIG_FUNC items */
#define RIG_FUNC_BIT61 CONSTANT_64BIT_FLAG (61) /* available for future RIG_FUNC items */
#define RIG_FUNC_BIT62 CONSTANT_64BIT_FLAG (62) /* available for future RIG_FUNC items */
#define RIG_FUNC_BIT63 CONSTANT_64BIT_FLAG (63) /* available for future RIG_FUNC items */
#define RIG_FUNC_BIT41 CONSTANT_64BIT_FLAG (41) /*!< \c available for future RIG_FUNC items */
#define RIG_FUNC_BIT42 CONSTANT_64BIT_FLAG (42) /*!< \c available for future RIG_FUNC items */
#define RIG_FUNC_BIT43 CONSTANT_64BIT_FLAG (43) /*!< \c available for future RIG_FUNC items */
#define RIG_FUNC_BIT44 CONSTANT_64BIT_FLAG (44) /*!< \c available for future RIG_FUNC items */
#define RIG_FUNC_BIT45 CONSTANT_64BIT_FLAG (45) /*!< \c available for future RIG_FUNC items */
#define RIG_FUNC_BIT46 CONSTANT_64BIT_FLAG (46) /*!< \c available for future RIG_FUNC items */
#define RIG_FUNC_BIT47 CONSTANT_64BIT_FLAG (47) /*!< \c available for future RIG_FUNC items */
#define RIG_FUNC_BIT48 CONSTANT_64BIT_FLAG (48) /*!< \c available for future RIG_FUNC items */
#define RIG_FUNC_BIT49 CONSTANT_64BIT_FLAG (49) /*!< \c available for future RIG_FUNC items */
#define RIG_FUNC_BIT50 CONSTANT_64BIT_FLAG (50) /*!< \c available for future RIG_FUNC items */
#define RIG_FUNC_BIT51 CONSTANT_64BIT_FLAG (51) /*!< \c available for future RIG_FUNC items */
#define RIG_FUNC_BIT52 CONSTANT_64BIT_FLAG (52) /*!< \c available for future RIG_FUNC items */
#define RIG_FUNC_BIT53 CONSTANT_64BIT_FLAG (53) /*!< \c available for future RIG_FUNC items */
#define RIG_FUNC_BIT54 CONSTANT_64BIT_FLAG (54) /*!< \c available for future RIG_FUNC items */
#define RIG_FUNC_BIT55 CONSTANT_64BIT_FLAG (55) /*!< \c available for future RIG_FUNC items */
#define RIG_FUNC_BIT56 CONSTANT_64BIT_FLAG (56) /*!< \c available for future RIG_FUNC items */
#define RIG_FUNC_BIT57 CONSTANT_64BIT_FLAG (57) /*!< \c available for future RIG_FUNC items */
#define RIG_FUNC_BIT58 CONSTANT_64BIT_FLAG (58) /*!< \c available for future RIG_FUNC items */
#define RIG_FUNC_BIT59 CONSTANT_64BIT_FLAG (59) /*!< \c available for future RIG_FUNC items */
#define RIG_FUNC_BIT60 CONSTANT_64BIT_FLAG (60) /*!< \c available for future RIG_FUNC items */
#define RIG_FUNC_BIT61 CONSTANT_64BIT_FLAG (61) /*!< \c available for future RIG_FUNC items */
#define RIG_FUNC_BIT62 CONSTANT_64BIT_FLAG (62) /*!< \c available for future RIG_FUNC items */
#define RIG_FUNC_BIT63 CONSTANT_64BIT_FLAG (63) /*!< \c available for future RIG_FUNC items */
/* 63 is this highest bit number that can be used */
#endif
/**
* \brief power unit macros
*
* \def mW
* Converts a power level integer to milliwatts. This is limited to 2
* Megawatts on 32 bit systems.
* megawatts on 32 bit systems.
*/
#define mW(p) ((int)(p))
/**
* \brief power unit macros
* \def Watts
*
* Converts a power level integer to watts. This is limited to 2
* gigawatts on 32 bit systems.
*/
#define Watts(p) ((int)((p)*1000))
/**
* \brief power unit macros
* \def W
*
* Same as Watts for the person who is too lazy to type Watts :-)
*/
#define W(p) Watts(p)
#if 0 // deprecating kW macro as this doesn't make sense
/**
* \brief power unit macros
* \def kW
*
* Same as Watts for the person who is too lazy to type Watts :-)
*/
#define kW(p) ((int)((p)*1000000L))
#endif
/**
@ -980,35 +1102,35 @@ typedef uint64_t rmode_t;
/* hide the top 32 bits from the Lua binding as they will not work */
#define RIG_MODE_DD CONSTANT_64BIT_FLAG (32) /*!< \c DD Mode IC-9700 */
#define RIG_MODE_C4FM CONSTANT_64BIT_FLAG (33) /*!< \c Yaesu C4FM mode */
#define RIG_MODE_BIT34 CONSTANT_64BIT_FLAG (34) /* reserved for future expansion */
#define RIG_MODE_BIT35 CONSTANT_64BIT_FLAG (35) /* reserved for future expansion */
#define RIG_MODE_BIT36 CONSTANT_64BIT_FLAG (36) /* reserved for future expansion */
#define RIG_MODE_BIT37 CONSTANT_64BIT_FLAG (37) /* reserved for future expansion */
#define RIG_MODE_BIT38 CONSTANT_64BIT_FLAG (38) /* reserved for future expansion */
#define RIG_MODE_BIT39 CONSTANT_64BIT_FLAG (39) /* reserved for future expansion */
#define RIG_MODE_BIT40 CONSTANT_64BIT_FLAG (40) /* reserved for future expansion */
#define RIG_MODE_BIT41 CONSTANT_64BIT_FLAG (41) /* reserved for future expansion */
#define RIG_MODE_BIT42 CONSTANT_64BIT_FLAG (42) /* reserved for future expansion */
#define RIG_MODE_BIT43 CONSTANT_64BIT_FLAG (43) /* reserved for future expansion */
#define RIG_MODE_BIT44 CONSTANT_64BIT_FLAG (44) /* reserved for future expansion */
#define RIG_MODE_BIT45 CONSTANT_64BIT_FLAG (45) /* reserved for future expansion */
#define RIG_MODE_BIT46 CONSTANT_64BIT_FLAG (46) /* reserved for future expansion */
#define RIG_MODE_BIT47 CONSTANT_64BIT_FLAG (47) /* reserved for future expansion */
#define RIG_MODE_BIT48 CONSTANT_64BIT_FLAG (48) /* reserved for future expansion */
#define RIG_MODE_BIT49 CONSTANT_64BIT_FLAG (49) /* reserved for future expansion */
#define RIG_MODE_BIT50 CONSTANT_64BIT_FLAG (50) /* reserved for future expansion */
#define RIG_MODE_BIT51 CONSTANT_64BIT_FLAG (51) /* reserved for future expansion */
#define RIG_MODE_BIT52 CONSTANT_64BIT_FLAG (52) /* reserved for future expansion */
#define RIG_MODE_BIT53 CONSTANT_64BIT_FLAG (53) /* reserved for future expansion */
#define RIG_MODE_BIT54 CONSTANT_64BIT_FLAG (54) /* reserved for future expansion */
#define RIG_MODE_BIT55 CONSTANT_64BIT_FLAG (55) /* reserved for future expansion */
#define RIG_MODE_BIT56 CONSTANT_64BIT_FLAG (56) /* reserved for future expansion */
#define RIG_MODE_BIT57 CONSTANT_64BIT_FLAG (57) /* reserved for future expansion */
#define RIG_MODE_BIT58 CONSTANT_64BIT_FLAG (58) /* reserved for future expansion */
#define RIG_MODE_BIT59 CONSTANT_64BIT_FLAG (59) /* reserved for future expansion */
#define RIG_MODE_BIT60 CONSTANT_64BIT_FLAG (60) /* reserved for future expansion */
#define RIG_MODE_BIT61 CONSTANT_64BIT_FLAG (61) /* reserved for future expansion */
#define RIG_MODE_BIT62 CONSTANT_64BIT_FLAG (62) /* reserved for future expansion */
#define RIG_MODE_BIT34 CONSTANT_64BIT_FLAG (34) /*!< \c reserved for future expansion */
#define RIG_MODE_BIT35 CONSTANT_64BIT_FLAG (35) /*!< \c reserved for future expansion */
#define RIG_MODE_BIT36 CONSTANT_64BIT_FLAG (36) /*!< \c reserved for future expansion */
#define RIG_MODE_BIT37 CONSTANT_64BIT_FLAG (37) /*!< \c reserved for future expansion */
#define RIG_MODE_BIT38 CONSTANT_64BIT_FLAG (38) /*!< \c reserved for future expansion */
#define RIG_MODE_BIT39 CONSTANT_64BIT_FLAG (39) /*!< \c reserved for future expansion */
#define RIG_MODE_BIT40 CONSTANT_64BIT_FLAG (40) /*!< \c reserved for future expansion */
#define RIG_MODE_BIT41 CONSTANT_64BIT_FLAG (41) /*!< \c reserved for future expansion */
#define RIG_MODE_BIT42 CONSTANT_64BIT_FLAG (42) /*!< \c reserved for future expansion */
#define RIG_MODE_BIT43 CONSTANT_64BIT_FLAG (43) /*!< \c reserved for future expansion */
#define RIG_MODE_BIT44 CONSTANT_64BIT_FLAG (44) /*!< \c reserved for future expansion */
#define RIG_MODE_BIT45 CONSTANT_64BIT_FLAG (45) /*!< \c reserved for future expansion */
#define RIG_MODE_BIT46 CONSTANT_64BIT_FLAG (46) /*!< \c reserved for future expansion */
#define RIG_MODE_BIT47 CONSTANT_64BIT_FLAG (47) /*!< \c reserved for future expansion */
#define RIG_MODE_BIT48 CONSTANT_64BIT_FLAG (48) /*!< \c reserved for future expansion */
#define RIG_MODE_BIT49 CONSTANT_64BIT_FLAG (49) /*!< \c reserved for future expansion */
#define RIG_MODE_BIT50 CONSTANT_64BIT_FLAG (50) /*!< \c reserved for future expansion */
#define RIG_MODE_BIT51 CONSTANT_64BIT_FLAG (51) /*!< \c reserved for future expansion */
#define RIG_MODE_BIT52 CONSTANT_64BIT_FLAG (52) /*!< \c reserved for future expansion */
#define RIG_MODE_BIT53 CONSTANT_64BIT_FLAG (53) /*!< \c reserved for future expansion */
#define RIG_MODE_BIT54 CONSTANT_64BIT_FLAG (54) /*!< \c reserved for future expansion */
#define RIG_MODE_BIT55 CONSTANT_64BIT_FLAG (55) /*!< \c reserved for future expansion */
#define RIG_MODE_BIT56 CONSTANT_64BIT_FLAG (56) /*!< \c reserved for future expansion */
#define RIG_MODE_BIT57 CONSTANT_64BIT_FLAG (57) /*!< \c reserved for future expansion */
#define RIG_MODE_BIT58 CONSTANT_64BIT_FLAG (58) /*!< \c reserved for future expansion */
#define RIG_MODE_BIT59 CONSTANT_64BIT_FLAG (59) /*!< \c reserved for future expansion */
#define RIG_MODE_BIT60 CONSTANT_64BIT_FLAG (60) /*!< \c reserved for future expansion */
#define RIG_MODE_BIT61 CONSTANT_64BIT_FLAG (61) /*!< \c reserved for future expansion */
#define RIG_MODE_BIT62 CONSTANT_64BIT_FLAG (62) /*!< \c reserved for future expansion */
#define RIG_MODE_TESTS_MAX CONSTANT_64BIT_FLAG (63) /*!< \c last bit available for 64-bit enum MUST ALWAYS BE LAST, Max Count for dumpcaps.c */
#endif
@ -1022,9 +1144,10 @@ typedef uint64_t rmode_t;
*/
#define RIG_MODE_ECSS (RIG_MODE_ECSSUSB|RIG_MODE_ECSSLSB)
//! @cond Doxygen_Suppress
#define RIG_DBLST_END 0 /* end marker in a preamp/att level list */
#define RIG_IS_DBLST_END(d) ((d)==0)
//! @endcond
/**
@ -1044,8 +1167,10 @@ typedef struct freq_range_list {
char *label; /*!< Label for this range that explains why. e.g. Icom rigs USA, EUR, ITR, TPE, KOR */
} freq_range_t;
//! @cond Doxygen_Suppress
#define RIG_FRNG_END {Hz(0),Hz(0),RIG_MODE_NONE,0,0,RIG_VFO_NONE}
#define RIG_IS_FRNG_END(r) ((r).startf == Hz(0) && (r).endf == Hz(0))
//! @endcond
/**
* \brief Tuning step definition
@ -1068,9 +1193,11 @@ struct tuning_step_list {
shortfreq_t ts; /*!< Tuning step in Hz */
};
//! @cond Doxygen_Suppress
#define RIG_TS_ANY 0
#define RIG_TS_END {RIG_MODE_NONE, 0}
#define RIG_IS_TS_END(t) ((t).modes == RIG_MODE_NONE && (t).ts == 0)
//! @endcond
/**
@ -1100,10 +1227,11 @@ struct filter_list {
rmode_t modes; /*!< Bit field of RIG_MODE's */
pbwidth_t width; /*!< Passband width in Hz */
};
//! @cond Doxygen_Suppress
#define RIG_FLT_ANY 0
#define RIG_FLT_END {RIG_MODE_NONE, 0}
#define RIG_IS_FLT_END(f) ((f).modes == RIG_MODE_NONE)
//! @endcond
/**
@ -1132,8 +1260,10 @@ struct ext_list {
value_t val; /*!< Value */
};
//! @cond Doxygen_Suppress
#define RIG_EXT_END {0, {.i=0}}
#define RIG_IS_EXT_END(x) ((x).token == 0)
//! @endcond
/**
* \brief Channel structure
@ -1266,8 +1396,10 @@ struct chan_list {
mem_caps; /*!< Definition of attributes that can be stored/retrieved */
};
//! @cond Doxygen_Suppress
#define RIG_CHAN_END {0,0,RIG_MTYPE_NONE}
#define RIG_IS_CHAN_END(c) ((c).type == RIG_MTYPE_NONE)
//! @endcond
/**
* \brief Special memory channel value to tell rig_lookup_mem_caps() to retrieve all the ranges
@ -1328,7 +1460,9 @@ struct cal_table {
*/
typedef struct cal_table cal_table_t;
//! @cond Doxygen_Suppress
#define EMPTY_STR_CAL { 0, { { 0, 0 }, } }
//! @endcond Doxygen_Suppress
/**
@ -1356,6 +1490,7 @@ struct cal_table_float {
*/
typedef struct cal_table_float cal_table_float_t;
//! @cond Doxygen_Suppress
#define EMPTY_FLOAT_CAL { 0, { { 0, 0f }, } }
typedef int (* chan_cb_t)(RIG *, channel_t **, int, const chan_t *, rig_ptr_t);
@ -1363,6 +1498,7 @@ typedef int (* confval_cb_t)(RIG *,
const struct confparams *,
value_t *,
rig_ptr_t);
//! @endcond
/**
@ -1384,6 +1520,7 @@ typedef int (* confval_cb_t)(RIG *,
* mdblack: Don't move or add fields around without bumping the version numbers
* DLL or shared library replacement depends on order
*/
//! @cond Doxygen_Suppress
#define RIG_MODEL(arg) .rig_model=arg,.macro_name=#arg
struct rig_caps {
rig_model_t rig_model; /*!< Rig model. */
@ -1645,6 +1782,7 @@ struct rig_caps {
const char *clone_combo_get; /*!< String describing key combination to enter save cloning mode */
const char *macro_name; /*!< Rig model macro name */
};
//! @endcond
/**
@ -1652,6 +1790,7 @@ struct rig_caps {
*
* Of course, looks like OO painstakingly programmed in C, sigh.
*/
//! @cond Doxygen_Suppress
typedef struct hamlib_port {
union {
rig_port_t rig; /*!< Communication port type */
@ -1709,6 +1848,7 @@ typedef struct hamlib_port {
} gpio; /*!< GPIO attributes */
} parm; /*!< Port parameter union */
} hamlib_port_t;
//! @endcond
#if !defined(__APPLE__) || !defined(__cplusplus)
typedef hamlib_port_t port_t;
@ -1792,7 +1932,7 @@ struct rig_state {
int twiddle_timeout; /*!< timeout to resume from twiddling */
};
//! @cond Doxygen_Suppress
typedef int (*vprintf_cb_t)(enum rig_debug_level_e,
rig_ptr_t,
const char *,
@ -1809,6 +1949,7 @@ typedef int (*pltune_cb_t)(RIG *,
pbwidth_t *,
rig_ptr_t);
//! @endcond
/**
* \brief Callback functions and args for rig event.
@ -1863,6 +2004,8 @@ struct s_rig {
/* --------------- API function prototypes -----------------*/
//! @cond Doxygen_Suppress
extern HAMLIB_EXPORT(RIG *) rig_init HAMLIB_PARAMS((rig_model_t rig_model));
extern HAMLIB_EXPORT(int) rig_open HAMLIB_PARAMS((RIG *rig));
@ -2498,6 +2641,8 @@ extern HAMLIB_EXPORT(void) rig_no_restore_ai();
#include <unistd.h>
extern HAMLIB_EXPORT(int) hl_usleep(useconds_t msec);
//! @endcond
__END_DECLS
#endif /* _RIG_H */

5
include/hamlib/rigclass.h
Wyświetl plik

@ -26,6 +26,7 @@
#include <iostream>
//! @cond Doxygen_Suppress
class BACKEND_IMPEXP Rig
{
private:
@ -189,6 +190,7 @@ public:
return RIG_OK;
}
};
//! @endcond
#ifdef __GNUG__
@ -242,8 +244,8 @@ extern "C" void exit(int);
#endif
//! @cond Doxygen_Suppress
// Forward Declarations
class BACKEND_IMPEXP RigException
{
public:
@ -274,6 +276,7 @@ public:
return "Rig";
}
};
//! @endcond
inline void THROW(const RigException *e)

11
include/hamlib/rotator.h
Wyświetl plik

@ -49,7 +49,7 @@ struct rot_state;
/**
* \typedef typedef struct rot ROT
* \typedef typedef struct s_rot ROT
* \brief Rotator structure definition (see rot for details).
*/
typedef struct s_rot ROT;
@ -103,6 +103,7 @@ typedef float azimuth_t;
typedef int rot_reset_t;
//! @cond Doxygen_Suppress
/**
* \brief Rotator type flags
*/
@ -117,6 +118,7 @@ typedef enum {
#define ROT_TYPE_AZIMUTH ROT_FLAG_AZIMUTH
#define ROT_TYPE_ELEVATION ROT_FLAG_ELEVATION
#define ROT_TYPE_AZEL (ROT_FLAG_AZIMUTH|ROT_FLAG_ELEVATION)
//! @endcond
/**
@ -216,6 +218,8 @@ typedef enum {
* mdblack: Careful movinf fields around, as the backends depend on it when
* initializing their caps in shared libraries and dlls.
*/
//! @cond Doxygen_Suppress
#define ROT_MODEL(arg) .rot_model=arg,.macro_name=#arg
struct rot_caps {
rot_model_t rot_model; /*!< Rotator model. */
@ -288,6 +292,7 @@ struct rot_caps {
const char *macro_name; /*!< Macro name. */
/* more to come... */
};
//! @endcond
/**
@ -328,7 +333,7 @@ struct rot_state {
/**
* Rotator structure
* \struct rot
* \struct s_rot
* \brief This is the master data structure,
* acting as a handle for the controlled rotator.
*
@ -344,6 +349,7 @@ struct s_rot {
};
//! @cond Doxygen_Suppress
/* --------------- API function prototypes -----------------*/
extern HAMLIB_EXPORT(ROT *)
@ -487,6 +493,7 @@ dmmm2dec HAMLIB_PARAMS((int degrees,
double minutes,
int sw));
//! @endcond
/**
* \def rot_debug

2
include/hamlib/rotclass.h
Wyświetl plik

@ -26,6 +26,7 @@
//! @cond Doxygen_Suppress
class BACKEND_IMPEXP Rotator
{
private:
@ -59,6 +60,7 @@ public:
void move(int direction, int speed);
};
//! @endcond

62
include/hamlib/rotlist.h
Wyświetl plik

@ -23,8 +23,10 @@
#ifndef _ROTLIST_H
#define _ROTLIST_H 1
//! @cond Doxygen_Suppress
#define ROT_MAKE_MODEL(a,b) ((a)*100+(b))
#define ROT_BACKEND_NUM(a) ((a)/100)
//! @endcond
/**
@ -49,7 +51,12 @@
* whishes to use. It is done with the rot_init() API call.
*/
/**
* \def ROT_MODEL_NONE
* \brief A macro that returns the model number for an unknown model.
*
* The none backend, as the name suggests, does nothing...mainly for internal use
*/
#define ROT_MODEL_NONE 0
@ -69,8 +76,10 @@
* This backend allows use of the rotctld daemon through the normal
* Hamlib API.
*/
//! @cond Doxygen_Suppress
#define ROT_DUMMY 0
#define ROT_BACKEND_DUMMY "dummy"
//! @endcond
#define ROT_MODEL_DUMMY ROT_MAKE_MODEL(ROT_DUMMY, 1)
#define ROT_MODEL_NETROTCTL ROT_MAKE_MODEL(ROT_DUMMY, 2)
@ -93,11 +102,19 @@
* The EasyComm 2 backend can be used with rotators that support the
* EASYCOMM II Standard.
*/
/**
* \def ROT_MODEL_EASYCOMM3
* \brief A macro that returns the model number of the EasyComm 3 backend.
*
* The EasyComm 3 backend can be used with rotators that support the
* EASYCOMM III Standard.
*/
//! @cond Doxygen_Suppress
#define ROT_EASYCOMM 2
#define ROT_BACKEND_EASYCOMM "easycomm"
//! @endcond
#define ROT_MODEL_EASYCOMM1 ROT_MAKE_MODEL(ROT_EASYCOMM, 1)
#define ROT_MODEL_EASYCOMM2 ROT_MAKE_MODEL(ROT_EASYCOMM, 2)
#define ROT_MODEL_TRAKBOX ROT_MAKE_MODEL(ROT_EASYCOMM, 3)
#define ROT_MODEL_EASYCOMM3 ROT_MAKE_MODEL(ROT_EASYCOMM, 4)
@ -108,8 +125,10 @@
* The Fodtrack backend can be used with rotators that support the
* FODTRACK Standard.
*/
//! @cond Doxygen_Suppress
#define ROT_FODTRACK 3
#define ROT_BACKEND_FODTRACK "fodtrack"
//! @endcond
#define ROT_MODEL_FODTRACK ROT_MAKE_MODEL(ROT_FODTRACK, 1)
@ -148,8 +167,10 @@
* The Rotor-EZ backend can be used with rotators that support the DCU
* command set by Green Heron (currently the RT-21).
*/
//! @cond Doxygen_Suppress
#define ROT_ROTOREZ 4
#define ROT_BACKEND_ROTOREZ "rotorez"
//! @endcond
#define ROT_MODEL_ROTOREZ ROT_MAKE_MODEL(ROT_ROTOREZ, 1)
#define ROT_MODEL_ROTORCARD ROT_MAKE_MODEL(ROT_ROTOREZ, 2)
#define ROT_MODEL_DCU ROT_MAKE_MODEL(ROT_ROTOREZ, 3)
@ -164,8 +185,10 @@
* The sartek backend can be used with rotators that support the SARtek
* protocol.
*/
//! @cond Doxygen_Suppress
#define ROT_SARTEK 5
#define ROT_BACKEND_SARTEK "sartek"
//! @endcond
#define ROT_MODEL_SARTEK1 ROT_MAKE_MODEL(ROT_SARTEK, 1)
@ -205,6 +228,13 @@
* GS23 protocol.
*/
/**
* \def ROT_MODEL_GS232
* \brief A macro that returns the model number of the GS232 backend.
*
* The GS232 backend can be used with rotators that support the
* GS232 protocol.
*/
/**
* \def ROT_MODEL_LVB
* \brief A macro that returns the model number of the LVB TRACKER backend.
*
@ -219,8 +249,10 @@
* Fox Delta ST2 GS232 based protocol.
*/
//! @cond Doxygen_Suppress
#define ROT_GS232A 6
#define ROT_BACKEND_GS232A "gs232a"
//! @endcond
#define ROT_MODEL_GS232A ROT_MAKE_MODEL(ROT_GS232A, 1)
#define ROT_MODEL_GS232_GENERIC ROT_MAKE_MODEL(ROT_GS232A, 2) /* GENERIC */
#define ROT_MODEL_GS232B ROT_MAKE_MODEL(ROT_GS232A, 3)
@ -236,8 +268,10 @@
*
* The kit backend can be used with home brewed rotators.
*/
//! @cond Doxygen_Suppress
#define ROT_KIT 7
#define ROT_BACKEND_KIT "kit"
//! @endcond
#define ROT_MODEL_PCROTOR ROT_MAKE_MODEL(ROT_KIT, 1)
@ -245,8 +279,10 @@
* \def ROT_MODEL_HD1780
* \brief A macro that returns the model number of the HD 1780 backend.
*/
//! @cond Doxygen_Suppress
#define ROT_HEATHKIT 8
#define ROT_BACKEND_HEATHKIT "heathkit"
//! @endcond
#define ROT_MODEL_HD1780 ROT_MAKE_MODEL(ROT_HEATHKIT, 1)
@ -268,8 +304,10 @@
*
* The SPID backend can be used with rotators that support the SPID protocol.
*/
//! @cond Doxygen_Suppress
#define ROT_SPID 9
#define ROT_BACKEND_SPID "spid"
//! @endcond
#define ROT_MODEL_SPID_ROT2PROG ROT_MAKE_MODEL(ROT_SPID, 1)
#define ROT_MODEL_SPID_ROT1PROG ROT_MAKE_MODEL(ROT_SPID, 2)
#define ROT_MODEL_SPID_MD01_ROT2PROG ROT_MAKE_MODEL(ROT_SPID, 3)
@ -282,8 +320,10 @@
* The M2 backend can be used with rotators that support the RC2800 protocol
* and alike.
*/
//! @cond Doxygen_Suppress
#define ROT_M2 10
#define ROT_BACKEND_M2 "m2"
//! @endcond
#define ROT_MODEL_RC2800 ROT_MAKE_MODEL(ROT_M2, 1)
@ -299,8 +339,10 @@
*
* The ARS backend can be used with rotators that support the ARS protocol.
*/
//! @cond Doxygen_Suppress
#define ROT_ARS 11
#define ROT_BACKEND_ARS "ars"
//! @endcond
#define ROT_MODEL_RCI_AZEL ROT_MAKE_MODEL(ROT_ARS, 1)
#define ROT_MODEL_RCI_AZ ROT_MAKE_MODEL(ROT_ARS, 2)
@ -312,8 +354,10 @@
* The AMSAT backend can be used with rotators that support, among other, the
* IF-100 interface.
*/
//! @cond Doxygen_Suppress
#define ROT_AMSAT 12
#define ROT_BACKEND_AMSAT "amsat"
//! @endcond
#define ROT_MODEL_IF100 ROT_MAKE_MODEL(ROT_AMSAT, 1)
@ -324,8 +368,10 @@
* The TS-7400 backend supports and embedded ARM board using the TS-7400
* Linux board. More information is at http://www.embeddedarm.com
*/
//! @cond Doxygen_Suppress
#define ROT_TS7400 13
#define ROT_BACKEND_TS7400 "ts7400"
//! @endcond
#define ROT_MODEL_TS7400 ROT_MAKE_MODEL(ROT_TS7400, 1)
@ -336,8 +382,10 @@
* The CELESTRON backend can be used with rotators that support the Celestron
* protocol and alike.
*/
//! @cond Doxygen_Suppress
#define ROT_CELESTRON 14
#define ROT_BACKEND_CELESTRON "celestron"
//! @endcond
#define ROT_MODEL_NEXSTAR ROT_MAKE_MODEL(ROT_CELESTRON, 1)
@ -348,8 +396,10 @@
* The Ether6 backend can be used with rotators that support the Ether6
* protocol and alike.
*/
//! @cond Doxygen_Suppress
#define ROT_ETHER6 15
#define ROT_BACKEND_ETHER6 "ether6"
//! @endcond
#define ROT_MODEL_ETHER6 ROT_MAKE_MODEL(ROT_ETHER6, 1)
@ -360,8 +410,10 @@
* The CNCTRK backend can be used with rotators that support the LinuxCNC
* running Axis GUI interface.
*/
//! @cond Doxygen_Suppress
#define ROT_CNCTRK 16
#define ROT_BACKEND_CNCTRK "cnctrk"
//! @endcond
#define ROT_MODEL_CNCTRK ROT_MAKE_MODEL(ROT_CNCTRK, 1)
@ -370,8 +422,10 @@
* \brief A macro that returns the model number of the PROSISTEL backend.
*
*/
//! @cond Doxygen_Suppress
#define ROT_PROSISTEL 17
#define ROT_BACKEND_PROSISTEL "prosistel"
//! @endcond
#define ROT_MODEL_PROSISTEL ROT_MAKE_MODEL(ROT_PROSISTEL, 1)
@ -382,8 +436,10 @@
* The MEADE backen can be used with Meade telescope rotators like
* DS-2000
*/
//! @cond Doxygen_Suppress
#define ROT_MEADE 18
#define ROT_BACKEND_MEADE "meade"
//! @endcond
#define ROT_MODEL_MEADE ROT_MAKE_MODEL(ROT_MEADE, 1)
/**
@ -392,8 +448,10 @@
*
* The IOPTRON backen can be used with IOPTRON telescope mounts
*/
//! @cond Doxygen_Suppress
#define ROT_IOPTRON 19
#define ROT_BACKEND_IOPTRON "ioptron"
//! @endcond
#define ROT_MODEL_IOPTRON ROT_MAKE_MODEL(ROT_IOPTRON, 1)

2
src/amp_reg.c
Wyświetl plik

@ -103,11 +103,13 @@ static struct
* This struct to keep track of known amp models.
* It is chained, and used in a hash table, see below.
*/
//! @cond Doxygen_Suppress
struct amp_list
{
const struct amp_caps *caps;
struct amp_list *next;
};
//! @endcond
#define AMPLSTHASHSZ 16

15
src/amplifier.c
Wyświetl plik

@ -62,16 +62,20 @@
#include "amp_conf.h"
#include "token.h"
//! @cond Doxygen_Suppress
#define CHECK_AMP_ARG(r) (!(r) || !(r)->caps || !(r)->state.comm_state)
//! @endcond
/*
* Data structure to track the opened amp (by amp_open)
*/
//! @cond Doxygen_Suppress
struct opened_amp_l
{
AMP *amp;
struct opened_amp_l *next;
};
//! @endcond
static struct opened_amp_l *opened_amp_list = { NULL };
@ -558,7 +562,9 @@ int HAMLIB_API amp_reset(AMP *amp, amp_reset_t reset)
return caps->reset(amp, reset);
}
//! @endcond
//! @cond Doxygen_Suppress
int HAMLIB_API amp_get_freq(AMP *amp, freq_t *freq)
{
const struct amp_caps *caps;
@ -579,7 +585,9 @@ int HAMLIB_API amp_get_freq(AMP *amp, freq_t *freq)
return caps->get_freq(amp, freq);
}
//! @endcond
//! @cond Doxygen_Suppress
int HAMLIB_API amp_set_freq(AMP *amp, freq_t freq)
{
const struct amp_caps *caps;
@ -600,6 +608,7 @@ int HAMLIB_API amp_set_freq(AMP *amp, freq_t freq)
return caps->set_freq(amp, freq);
}
//! @endcond
/**
* \brief get general information from the amplifier
@ -629,6 +638,7 @@ const char *HAMLIB_API amp_get_info(AMP *amp)
return amp->caps->get_info(amp);
}
//! @cond Doxygen_Suppress
int HAMLIB_API amp_get_level(AMP *amp, setting_t level, value_t *val)
{
amp_debug(RIG_DEBUG_VERBOSE, "%s called\n", __func__);
@ -645,7 +655,9 @@ int HAMLIB_API amp_get_level(AMP *amp, setting_t level, value_t *val)
return amp->caps->get_level(amp, level, val);
}
//! @endcond
//! @cond Doxygen_Suppress
int HAMLIB_API amp_get_ext_level(AMP *amp, token_t level, value_t *val)
{
amp_debug(RIG_DEBUG_VERBOSE, "%s called\n", __func__);
@ -662,6 +674,7 @@ int HAMLIB_API amp_get_ext_level(AMP *amp, token_t level, value_t *val)
return amp->caps->get_ext_level(amp, level, val);
}
//! @endcond
/**
* \brief turn on/off the amplifier or standby/operate toggle
@ -696,6 +709,7 @@ int HAMLIB_API amp_set_powerstat(AMP *amp, powerstat_t status)
return amp->caps->set_powerstat(amp, status);
}
//! @cond Doxygen_Suppress
int HAMLIB_API amp_get_powerstat(AMP *amp, powerstat_t *status)
{
amp_debug(RIG_DEBUG_VERBOSE, "%s called\n", __func__);
@ -712,6 +726,7 @@ int HAMLIB_API amp_get_powerstat(AMP *amp, powerstat_t *status)
return amp->caps->get_powerstat(amp, status);
}
//! @endcond
/*! @} */

4
src/debug.c
Wyświetl plik

@ -52,7 +52,9 @@
#include <hamlib/rig_dll.h>
#include "misc.h"
//! @cond Doxygen_Suppress
#define DUMP_HEX_WIDTH 16
//! @endcond
static int rig_debug_level = RIG_DEBUG_TRACE;
@ -143,6 +145,7 @@ void HAMLIB_API rig_set_debug_time_stamp(int flag)
}
//! @cond Doxygen_Suppress
char *date_strget(char *buf, int buflen)
{
char tmp[16];
@ -157,6 +160,7 @@ char *date_strget(char *buf, int buflen)
strcat(buf, tmp);
return buf;
}
//! @endcond
/**
* \param debug_level

2
src/iofunc.c
Wyświetl plik

@ -382,8 +382,10 @@ static ssize_t port_read(hamlib_port_t *p, void *buf, size_t count)
}
}
//! @cond Doxygen_Suppress
#define port_write(p,b,c) write((p)->fd,(b),(c))
#define port_select(p,n,r,w,e,t) select((n),(r),(w),(e),(t))
//! @endcond
#endif

14
src/mem.c
Wyświetl plik

@ -1250,6 +1250,20 @@ int HAMLIB_API rig_get_chan_all(RIG *rig, channel_t chans[])
}
/**
* \brief copy channel structure to another channel structure
* \param rig The rig handle
* \param dest The destination location
* \param src The source location
*
* Copies the data associated with one channel structure to another
*
* \return RIG_OK if the operation has been sucessful, otherwise
* a negative value if an error occured (in which case, cause is
* set appropriately).
*
* \sa rig_get_chan_all_cb(), rig_set_chan_all()
*/
int HAMLIB_API rig_copy_channel(RIG *rig,
channel_t *dest,
const channel_t *src)

6
src/misc.c
Wyświetl plik

@ -229,9 +229,11 @@ unsigned long long HAMLIB_API from_bcd_be(const unsigned char bcd_data[],
}
//! @cond Doxygen_Suppress
#ifndef llabs
#define llabs(a) ((a)<0?-(a):(a))
#endif
//! @endcond
/**
@ -1238,14 +1240,18 @@ void HAMLIB_API rig_force_cache_timeout(struct timeval *tv)
}
//! @cond Doxygen_Suppress
int no_restore_ai;
//! @endcond
//! @cond Doxygen_Suppress
void HAMLIB_API rig_no_restore_ai()
{
rig_debug(RIG_DEBUG_VERBOSE, "%s called\n", __func__);
no_restore_ai = -1;
}
//! @endcond
/** @} */

4
src/network.c
Wyświetl plik

@ -76,7 +76,9 @@
static int wsstarted;
#endif
//! @cond Doxygen_Suppress
#define NET_BUFFER_SIZE 64
//! @endcond
static void handle_error(enum rig_debug_level_e lvl, const char *msg)
{
@ -335,6 +337,7 @@ void network_flush(hamlib_port_t *rp)
}
//! @cond Doxygen_Suppress
int network_close(hamlib_port_t *rp)
{
int ret;
@ -354,5 +357,6 @@ int network_close(hamlib_port_t *rp)
#endif
return ret;
}
//! @endcond
/** @} */

2
src/parallel.c
Wyświetl plik

@ -76,6 +76,7 @@
# include <dev/ppbus/ppbconf.h>
#endif
//! @cond Doxygen_Suppress
/*
* These control port bits are active low.
* We toggle them so that this weirdness doesn't get propagated
@ -89,6 +90,7 @@
* through our interface.
*/
#define SP_ACTIVE_LOW_BITS 0x80
//! @endcond
/*
Pinout table of parallel port from http://en.wikipedia.org/wiki/Parallel_port#Pinouts

2
src/register.c
Wyświetl plik

@ -149,11 +149,13 @@ static struct
* This struct to keep track of known rig models.
* It is chained, and used in a hash table, see below.
*/
//! @cond Doxygen_Suppress
struct rig_list
{
const struct rig_caps *caps;
struct rig_list *next;
};
//! @endcond
// This size has to be > than the max# of rigs for any manufacturer

26
src/rig.c
Wyświetl plik

@ -82,8 +82,10 @@
* dynamic loader.
*/
const char *hamlib_license = "LGPL";
//! @cond Doxygen_Suppress
const char hamlib_version[21] = "Hamlib " PACKAGE_VERSION;
const char *hamlib_version2 = "Hamlib " PACKAGE_VERSION;
//! @endcond
/**
* \brief Hamlib copyright notice
@ -93,11 +95,13 @@ const char *hamlib_copyright2 =
"Copyright (C) 2000-2003 Frank Singleton\n"
"This is free software; see the source for copying conditions. There is NO\n"
"warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.";
//! @cond Doxygen_Suppress
const char hamlib_copyright[231] = /* hamlib 1.2 ABI specifies 231 bytes */
"Copyright (C) 2000-2012 Stephane Fillod\n"
"Copyright (C) 2000-2003 Frank Singleton\n"
"This is free software; see the source for copying conditions. There is NO\n"
"warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.";
//! @endcond
#ifndef DOC_HIDDEN
@ -1088,7 +1092,6 @@ int HAMLIB_API rig_cleanup(RIG *rig)
*
* timeout seconds to stop rigctld when VFO is manually changed
* turns on/off the radio.
* See \rig_set_twiddle
*
* \return RIG_OK if the operation has been sucessful, ortherwise
* a negative value if an error occured (in which case, cause is
@ -1119,7 +1122,7 @@ int HAMLIB_API rig_set_twiddle(RIG *rig, int seconds)
* a negative value if an error occured (in which case, cause is
* set appropriately).
*
* \sa rig_set_powerstat()
* \sa rig_set_twiddle()
*/
int HAMLIB_API rig_get_twiddle(RIG *rig, int *seconds)
{
@ -3643,6 +3646,7 @@ int HAMLIB_API rig_get_ts(RIG *rig, vfo_t vfo, shortfreq_t *ts)
* \param rig The rig handle
* \param vfo The target VFO
* \param ant The anntena to select
* \param option An optoin that the ant command for the rig recognizes
*
* Select the antenna connector.
\code
@ -3715,6 +3719,10 @@ int HAMLIB_API rig_set_ant(RIG *rig, vfo_t vfo, ant_t ant, value_t option)
* \param rig The rig handle
* \param vfo The target VFO
* \param ant The location where to store the current antenna
* \param option The option value for the antenna
* \param ant_curr The currently selected antenna
* \param ant_tx The currently selected TX antenna
* \param ant_rx The currently selected RX antenna
*
* Retrieves the current antenna.
*
@ -4039,11 +4047,13 @@ int HAMLIB_API rig_reset(RIG *rig, reset_t reset)
}
//! @cond Doxygen_Suppress
extern int rig_probe_first(hamlib_port_t *p);
extern int rig_probe_all_backends(hamlib_port_t *p,
rig_probe_func_t cfunc,
rig_ptr_t data);
//! @endcond
/**
@ -4645,18 +4655,30 @@ const char *HAMLIB_API rig_get_info(RIG *rig)
}
/**
* \brief get the Hamlib license
*
*/
const char *HAMLIB_API rig_license()
{
return hamlib_license;
}
/**
* \brief get the Hamlib version
*
*/
const char *HAMLIB_API rig_version()
{
return hamlib_version2;
}
/**
* \brief get the Hamlib copyright
*
*/
const char *HAMLIB_API rig_copyright()
{
return hamlib_copyright2;

2
src/rot_reg.c
Wyświetl plik

@ -137,11 +137,13 @@ static struct
* This struct to keep track of known rot models.
* It is chained, and used in a hash table, see below.
*/
//! @cond Doxygen_Suppress
struct rot_list
{
const struct rot_caps *caps;
struct rot_list *next;
};
//! @endcond
#define ROTLSTHASHSZ 16

6
src/serial.c
Wyświetl plik

@ -67,6 +67,7 @@
# endif
#endif
//! @cond Doxygen_Suppress
#if defined(WIN32) && !defined(HAVE_TERMIOS_H)
# include "win32termios.h"
# define HAVE_TERMIOS_H 1 /* we have replacement */
@ -75,6 +76,7 @@
# define CLOSE close
# define IOCTL ioctl
#endif
//! @endcond
#include <hamlib/rig.h>
#include "serial.h"
@ -89,6 +91,7 @@
static int uh_ptt_fd = -1;
static int uh_radio_fd = -1;
//! @cond Doxygen_Suppress
typedef struct term_options_backup
{
int fd;
@ -101,6 +104,7 @@ typedef struct term_options_backup
#endif
struct term_options_backup *next;
} term_options_backup_t;
//! @endcond
static term_options_backup_t *term_options_backup_head = NULL;
@ -111,6 +115,7 @@ static term_options_backup_t *term_options_backup_head = NULL;
* This function is only used in the WIN32 case and implements access "from
* outside" to uh_radio_fd.
*/
//! @cond Doxygen_Suppress
int is_uh_radio_fd(int fd)
{
if (uh_radio_fd >= 0 && uh_radio_fd == fd)
@ -122,6 +127,7 @@ int is_uh_radio_fd(int fd)
return 0;
}
}
//! @endcond
/**

10
src/sleep.c
Wyświetl plik

@ -66,6 +66,10 @@ int hl_usleep(useconds_t usec)
}
#ifdef HAVE_NANOSLEEP
/**
* \brief sleep
* \param secs is seconds to sleep
*/
unsigned int sleep(unsigned int secs)
{
int retval;
@ -81,7 +85,11 @@ unsigned int sleep(unsigned int secs)
}
// Does not have the same 1000000 limit as usleep
/**
* \brief microsecond sleep
* \param usec is microseconds to sleep
* This does not have the same 1000000 limit as POSIX usleep
*/
int usleep(useconds_t usec)
{
int retval;

4
src/usb_port.c
Wyświetl plik

@ -391,20 +391,24 @@ int usb_port_close(hamlib_port_t *port)
#else
//! @cond Doxygen_Suppress
int usb_port_open(hamlib_port_t *port)
{
rig_debug(RIG_DEBUG_VERBOSE, "%s called\n", __func__);
return -RIG_ENAVAIL;
}
//! @endcond
//! @cond Doxygen_Suppress
int usb_port_close(hamlib_port_t *port)
{
rig_debug(RIG_DEBUG_VERBOSE, "%s called\n", __func__);
return -RIG_ENAVAIL;
}
//! @endcond
#endif /* defined(HAVE_LIBUSB) && defined(HAVE_LIBUSB_H) */