include files moved again

git-svn-id: https://hamlib.svn.sourceforge.net/svnroot/hamlib/trunk@182 7ae35d74-ebe9-4afe-98af-79ac388436b8
Hamlib-1.1.0
Stéphane Fillod, F8CFE 2000-10-08 21:15:28 +00:00
rodzic c41989c229
commit fe1452a35a
2 zmienionych plików z 657 dodań i 0 usunięć

Wyświetl plik

@ -0,0 +1,548 @@
/* hamlib - (C) Frank Singleton 2000 (vk3fcs@ix.netcom.com)
*
* rig.h - Copyright (C) 2000 Frank Singleton and Stephane Fillod
* This program defines the Hamlib API and rig capabilities structures that
* will be used for obtaining rig capabilities.
*
*
* $Id: rig.h,v 1.1 2000-10-08 21:15:28 f4cfe Exp $ *
*
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
*/
#ifndef _RIG_H
#define _RIG_H 1
#include <hamlib/riglist.h> /* list in another file to not mess up w/ this one */
#include <stdio.h> /* required for FILE definition */
/*
* Error codes that can be returned by the Hamlib functions
*/
#define RIG_OK 0 /* completed sucessfully */
#define RIG_EINVAL 1 /* invalid parameter */
#define RIG_ECONF 2 /* invalid configuration (serial,..) */
#define RIG_ENOMEM 3 /* memory shortage */
#define RIG_ENIMPL 4 /* function not implemented, but will be */
#define RIG_ETIMEOUT 5 /* communication timed out */
#define RIG_EIO 6 /* IO error, including open failed */
#define RIG_EINTERNAL 7 /* Internal Hamlib error, huh! */
#define RIG_EPROTO 8 /* Protocol error */
#define RIG_ERJCTED 9 /* Command rejected by the rig */
#define RIG_ETRUNC 10 /* Command performed, but arg truncated */
#define RIG_ENAVAIL 11 /* function not available */
/* Forward struct references */
struct rig;
struct rig_state;
typedef struct rig RIG;
/*
* REM: Numeric order matters for debug level
*/
enum rig_debug_level_e {
RIG_DEBUG_NONE = 0,
RIG_DEBUG_ERR,
RIG_DEBUG_VERBOSE,
RIG_DEBUG_TRACE
};
/*
* Rig capabilities
*
* Basic rig type, can store some useful
* info about different radios. Each lib must
* be able to populate this structure, so we can make
* useful enquiries about capablilities.
*/
enum rig_port_e {
RIG_PORT_SERIAL = 0,
RIG_PORT_NETWORK,
RIG_PORT_DEVICE, /* Device driver, like for the WinRADIO */
RIG_PORT_ULTRA /* IrDA Ultra protocol */
};
enum serial_parity_e {
RIG_PARITY_NONE = 0,
RIG_PARITY_ODD,
RIG_PARITY_EVEN
};
enum serial_handshake_e {
RIG_HANDSHAKE_NONE = 0,
RIG_HANDSHAKE_XONXOFF,
RIG_HANDSHAKE_HARDWARE
};
enum rig_type_e {
RIG_TYPE_TRANSCEIVER = 0, /* aka base station */
RIG_TYPE_HANDHELD,
RIG_TYPE_MOBILE,
RIG_TYPE_RECEIVER,
RIG_TYPE_SCANNER,
RIG_TYPE_COMPUTER, /* eg. Pegasus */
/* etc. */
RIG_TYPE_OTHER
};
/*
* Development status of the backend
*/
enum rig_status_e {
RIG_STATUS_ALPHA = 0,
RIG_STATUS_UNTESTED, /* written from specs, rig unavailable for test, feedback most wanted! */
RIG_STATUS_BETA,
RIG_STATUS_STABLE,
RIG_STATUS_BUGGY, /* was stable, but something broke it! */
RIG_STATUS_NEW
};
enum rptr_shift_e {
RIG_RPT_SHIFT_NONE = 0,
RIG_RPT_SHIFT_MINUS,
RIG_RPT_SHIFT_PLUS
};
typedef enum rptr_shift_e rptr_shift_t;
enum vfo_e {
RIG_VFO_MAIN = 0,
RIG_VFO_RX,
RIG_VFO_TX,
RIG_VFO_SUB,
RIG_VFO_SAT_RX,
RIG_VFO_SAT_TX,
RIG_VFO_A,
RIG_VFO_B,
RIG_VFO_C
};
typedef enum vfo_e vfo_t;
enum ptt_e {
RIG_PTT_OFF = 0,
RIG_PTT_ON
};
typedef enum ptt_e ptt_t;
enum ptt_type_e {
RIG_PTT_RIG = 0, /* PTT controlable through the rig interface */
RIG_PTT_SERIAL, /* PTT accessed through CTS/RTS */
RIG_PTT_PARALLEL, /* PTT accessed through DATA0 */
RIG_PTT_NONE /* not available */
};
typedef enum ptt_type_e ptt_type_t;
/*
* tranceive mode, ie. the rig notify the host of any event,
* like freq changed, mode changed, etc.
*/
#define RIG_TRN_OFF 0
#define RIG_TRN_ON 1
/*
* These are activated functions.
*/
#define RIG_FUNC_FAGC (1<<0) /* Fast AGC */
#define RIG_FUNC_NB (1<<1) /* Noise Blanker */
#define RIG_FUNC_COMP (1<<2) /* Compression */
#define RIG_FUNC_VOX (1<<3) /* VOX */
#define RIG_FUNC_TONE (1<<4) /* Tone */
#define RIG_FUNC_TSQL (1<<5) /* may require a tone field */
#define RIG_FUNC_SBKIN (1<<6) /* Semi Break-in (is it the rigth name?) */
#define RIG_FUNC_FBKIN (1<<7) /* Full Break-in, for CW mode */
#define RIG_FUNC_ANF (1<<8) /* Automatic Notch Filter (DSP) */
#define RIG_FUNC_NR (1<<9) /* Noise Reduction (DSP) */
/*
* frequency type in Hz, must be >32bits for SHF!
*/
typedef long long freq_t;
#define Hz(f) ((freq_t)(f))
#define KHz(f) ((freq_t)((f)*1000))
#define MHz(f) ((freq_t)((f)*1000000))
#define GHz(f) ((freq_t)((f)*1000000000))
/*
* power unit macros, converts to mW
*/
#define mW(p) ((int)(p))
#define Watts(p) ((int)((p)*1000))
#define KW(p) ((int)((p)*1000000))
typedef unsigned int rmode_t; /* radio mode */
/* Do not use an enum since this will be used w/ rig_mode_t bit fields */
#define RIG_MODE_AM (1<<0)
#define RIG_MODE_CW (1<<1)
#define RIG_MODE_USB (1<<2) /* select somewhere else the filters ? */
#define RIG_MODE_LSB (1<<3)
#define RIG_MODE_RTTY (1<<4)
#define RIG_MODE_FM (1<<5)
#define RIG_MODE_NFM (1<<6) /* should we distinguish modes w/ filers? */
#define RIG_MODE_WFM (1<<7)
#define RIG_MODE_NAM (1<<8) /* Narrow AM */
#define RIG_MODE_WAM (1<<9) /* Wide AM */
#define RIG_MODE_NCW (1<<10)
#define RIG_MODE_WCW (1<<11)
#define RIG_MODE_CWR (1<<12) /* Reverse CW */
#define RIG_MODE_NUSB (1<<13)
#define RIG_MODE_WUSB (1<<14)
#define RIG_MODE_NLSB (1<<15)
#define RIG_MODE_WLSB (1<<16)
#define RIG_MODE_NRTTY (1<<17)
#define RIG_MODE_WRTTY (1<<18)
#define RIGNAMSIZ 30
#define RIGVERSIZ 8
#define FILPATHLEN 100
#define FRQRANGESIZ 30
#define MAXCHANDESC 30 /* describe channel eg: "WWV 5Mhz" */
#define TSLSTSIZ 20 /* max tuning step list size, zero ended */
/*
* Put together a bunch of this struct in an array to define
* what your rig have access to
*/
struct freq_range_list {
freq_t start;
freq_t end;
unsigned long modes; /* bitwise OR'ed RIG_MODE_* */
int low_power; /* in mW, -1 for no power (ie. rx list) */
int high_power; /* in mW, -1 for no power (ie. rx list) */
};
typedef struct freq_range_list freq_range_t;
/*
* Lists the tuning steps available for each mode
*/
struct tuning_step_list {
rmode_t modes; /* bitwise OR'ed RIG_MODE_* */
unsigned long ts; /* tuning step in Hz */
};
/*
* Convenience struct, describes a freq/vfo/mode combo
* Also useful for memory handling -- FS
*
*/
struct channel {
int channel_num;
freq_t freq;
rmode_t mode;
vfo_t vfo;
int power; /* in mW */
signed int preamp; /* in dB, if < 0, this is attenuator */
unsigned long tuning_step; /* */
unsigned char channel_desc[MAXCHANDESC];
};
typedef struct channel channel_t;
/* Basic rig type, can store some useful
* info about different radios. Each lib must
* be able to populate this structure, so we can make
* useful enquiries about capablilities.
*/
/*
* The main idea of this struct is that it will be defined by the backend
* rig driver, and will remain readonly for the application.
* Fields that need to be modifiable by the application are
* copied into the struct rig_state, which is a kind of private
* of the RIG instance.
* This way, you can have several rigs running within the same application,
* sharing the struct rig_caps of the backend, while keeping their own
* customized data.
*/
struct rig_caps {
rig_model_t rig_model; /* eg. RIG_MODEL_FT847 */
unsigned char model_name[RIGNAMSIZ]; /* eg "ft847" */
unsigned char mfg_name[RIGNAMSIZ]; /* eg "Yeasu" */
char version[RIGVERSIZ]; /* driver version, eg "0.5" */
enum rig_status_e status; /* among ALPHA, BETA, STABLE, NEW */
enum rig_type_e rig_type;
enum ptt_type_e ptt_type; /* how we will key the rig */
int serial_rate_min; /* eg 4800 */
int serial_rate_max; /* eg 9600 */
int serial_data_bits; /* eg 8 */
int serial_stop_bits; /* eg 2 */
enum serial_parity_e serial_parity; /* */
enum serial_handshake_e serial_handshake; /* */
int write_delay; /* delay in ms between each byte sent out */
int timeout; /* in ms */
int retry; /* maximum number of retries, 0 to disable */
unsigned long has_func; /* bitwise OR'ed RIG_FUNC_FAGC, NG, etc. */
int chan_qty; /* number of channels */
int transceive; /* the rig is able to generate events, to be used by callbacks */
freq_range_t rx_range_list[FRQRANGESIZ];
freq_range_t tx_range_list[FRQRANGESIZ];
struct tuning_step_list tuning_steps[TSLSTSIZ];
/*
* Rig Admin API
*
*/
int (*rig_init)(RIG *rig); /* setup *priv */
int (*rig_cleanup)(RIG *rig);
int (*rig_open)(RIG *rig); /* called when port just opened */
int (*rig_close)(RIG *rig); /* called before port is to close */
int (*rig_probe)(RIG *rig); /* Experimental: may work.. */
/*
* General API commands, from most primitive to least.. :()
* List Set/Get functions pairs
*/
int (*set_freq)(RIG *rig, freq_t freq); /* select freq */
int (*get_freq)(RIG *rig, freq_t *freq); /* get freq */
int (*set_mode)(RIG *rig, rmode_t mode); /* select mode */
int (*get_mode)(RIG *rig, rmode_t *mode); /* get mode */
int (*set_vfo)(RIG *rig, vfo_t vfo); /* select vfo (A,B, etc.) */
int (*get_vfo)(RIG *rig, vfo_t *vfo); /* get vfo */
int (*set_ptt)(RIG *rig, ptt_t ptt); /* ptt on/off */
int (*get_ptt)(RIG *rig, ptt_t *ptt); /* get ptt status */
int (*set_rpt_shift)(RIG *rig, rptr_shift_t rptr_shift ); /* set repeater shift */
int (*get_rpt_shift)(RIG *rig, rptr_shift_t *rptr_shift); /* get repeater shift */
int (*set_ts)(RIG *rig, unsigned long ts); /* set tuning step */
int (*get_ts)(RIG *rig, unsigned long *ts); /* get tuning step */
int (*set_tone)(RIG *rig, unsigned int tone); /* set tone */
int (*get_tone)(RIG *rig, unsigned int *tone); /* get tone */
int (*set_tonesq)(RIG *rig, unsigned int tone); /* set tone squelch */
int (*get_tonesq)(RIG *rig, unsigned int *tone); /* get tone squelch */
/*
* It'd be nice to have a power2mW and mW2power functions
* that could tell at what power (watts) the rig is running.
* Unfortunately, on most rigs, the formula is not the same
* on all bands/modes. Have to work this out.. --SF
*/
int (*set_power)(RIG *rig, float power); /* set TX power [0.0 .. 1.0] */
int (*get_power)(RIG *rig, float *power);
int (*power2mW)(RIG *rig, unsigned int *mwpower, float power, freq_t freq, rmode_t mode);
int (*mW2power)(RIG *rig, float *power, unsigned int mwpower, freq_t freq, rmode_t mode);
int (*set_volume)(RIG *rig, float vol); /* select vol from 0.0 and 1.0 */
int (*get_volume)(RIG *rig, float *vol); /* get volume */
int (*set_squelch)(RIG *rig, float sql); /* set squelch */
int (*get_squelch)(RIG *rig, float *sql); /* set squelch */
int (*get_strength)(RIG *rig, int *strength); /* get signal strength */
int (*set_poweron)(RIG *rig);
int (*set_poweroff)(RIG *rig);
int (*set_func)(RIG *rig, unsigned long func); /* activate the function(s) */
int (*get_func)(RIG *rig, unsigned long *func); /* get the setting from rig */
int (*set_mem)(RIG *rig, int ch);
int (*get_mem)(RIG *rig, int *ch);
int (*mem_clear)(RIG *rig);
int (*mem_to_vfo)(RIG *rig);
int (*vfo_to_mem)(RIG *rig); /* memory write */
/* also VFO A=B, and Switch VFO A and B, set to VFO mode, set to MEM mode */
int (*decode_event)(RIG *rig); /* When transceive on, find out which callback to call, and call it */
/*
* Convenience Functions
*/
int (*set_channel)(RIG *rig, const channel_t *chan);
int (*get_channel)(RIG *rig, channel_t *chan);
/* more to come... */
};
/*
* example of 3.5MHz -> 3.8MHz, 100W transmit range
* tx_range_list = {{3500000,3800000,RIG_MODE_AM|RIG_MODE_CW,100000},0}
*
*/
/*
* Rig state
*/
struct rig_state {
enum rig_port_e port_type; /* serial, network, etc. */
int serial_rate;
int serial_data_bits; /* eg 8 */
int serial_stop_bits; /* eg 2 */
enum serial_parity_e serial_parity; /* */
enum serial_handshake_e serial_handshake; /* */
int write_delay; /* delay in ms between each byte sent out */
int timeout; /* in ms */
int retry; /* maximum number of retries, 0 to disable */
enum ptt_type_e ptt_type; /* how we will key the rig */
char ptt_path[FILPATHLEN]; /* path to the keying device (serial,//) */
double vfo_comp; /* VFO compensation in PPM, 0.0 to disable */
char rig_path[FILPATHLEN]; /* serial port/network path(host:port) */
int fd; /* serial port/socket file handle */
FILE *stream; /* serial port/socket (buffered) stream handle */
int transceive; /* wether the transceive mode is on */
int hold_decode;/* set to 1 to hold the event decoder (async) otherwise 0 */
/*
* Pointer to private data
* tuff like CI_V_address for Icom goes in this *priv 51 area
*/
void *priv; /* pointer to private data */
/* etc... */
};
/*
* Rig callbacks
* ie., the rig notify the host computer someone changed
* the freq/mode from the panel, depressed a button, etc.
* In order to achieve this, the hamlib would have to run
* an internal thread listening the rig with a select(),
* or poll regularly...
*
* Event based programming, really appropriate in a GUI.
* So far, Icoms are able to do that in Transceive mode, and PCR-1000 too.
*/
struct rig_callbacks {
int (*freq_event)(RIG *rig, freq_t freq);
int (*mode_event)(RIG *rig, rmode_t mode);
int (*vfo_event)(RIG *rig, vfo_t vfo);
int (*ptt_event)(RIG *rig, ptt_t mode);
/* etc.. */
};
/*
* struct rig is the master data structure,
* acting as a handle for the controlled rig.
*/
struct rig {
const struct rig_caps *caps;
struct rig_state state;
struct rig_callbacks callbacks;
};
/* --------------- API function prototypes -----------------*/
extern RIG *rig_init(rig_model_t rig_model);
extern int rig_open(RIG *rig);
/*
* General API commands, from most primitive to least.. :()
* List Set/Get functions pairs
*/
extern int rig_set_freq(RIG *rig, freq_t freq); /* select freq */
extern int rig_get_freq(RIG *rig, freq_t *freq); /* get freq */
extern int rig_set_mode(RIG *rig, rmode_t mode); /* select mode */
extern int rig_get_mode(RIG *rig, rmode_t *mode); /* get mode */
extern int rig_set_vfo(RIG *rig, vfo_t vfo); /* select vfo */
extern int rig_get_vfo(RIG *rig, vfo_t *vfo); /* get vfo */
extern int rig_set_ptt(RIG *rig, ptt_t ptt); /* ptt on/off */
extern int rig_get_ptt(RIG *rig, ptt_t *ptt); /* get ptt status */
extern int rig_set_rpt_shift(RIG *rig, rptr_shift_t rptr_shift); /* set repeater shift */
extern int rig_get_rpt_shift(RIG *rig, rptr_shift_t *rptr_shift); /* get repeater shift */
extern int rig_set_ts(RIG *rig, unsigned long ts); /* set tuning step */
extern int rig_get_ts(RIG *rig, unsigned long *ts); /* get tuning step */
extern int rig_set_power(RIG *rig, float power);
extern int rig_get_power(RIG *rig, float *power);
extern int rig_power2mW(RIG *rig, unsigned int *mwpower, float power, freq_t freq, rmode_t mode);
extern int rig_mW2power(RIG *rig, float *power, unsigned int mwpower, freq_t freq, rmode_t mode);
extern int rig_set_volume(RIG *rig, float vol);
extern int rig_get_volume(RIG *rig, float *vol);
extern int rig_set_squelch(RIG *rig, float sql);
extern int rig_get_squelch(RIG *rig, float *sql);
extern int rig_set_tonesq(RIG *rig, unsigned int tone);
extern int rig_get_tonesq(RIG *rig, unsigned int *tone);
extern int rig_set_tone(RIG *rig, unsigned int tone);
extern int rig_get_tone(RIG *rig, unsigned int *tone);
extern int rig_get_strength(RIG *rig, int *strength);
extern int rig_set_poweron(RIG *rig);
extern int rig_set_poweroff(RIG *rig);
/* more to come -- FS */
extern int rig_close(RIG *rig);
extern int rig_cleanup(RIG *rig);
extern RIG *rig_probe(const char *rig_path);
extern int rig_has_func(RIG *rig, unsigned long func); /* is part of capabilities? */
extern int rig_set_func(RIG *rig, unsigned long func); /* activate the function(s) */
extern int rig_get_func(RIG *rig, unsigned long *func); /* get the setting from rig */
extern int rig_set_trn(RIG *rig, int trn); /* activate the transceive mode */
extern const struct rig_caps *rig_get_caps(rig_model_t rig_model);
const freq_range_t *rig_get_range(const freq_range_t range_list[], freq_t freq, unsigned long mode);
extern const char *rigerror(int errnum);
/*
* Even if these functions are prefixed with "rig_", they are not rig specific
* Maybe "hamlib_" would have been better. Let me know. --SF
*/
void rig_set_debug(enum rig_debug_level_e debug_level);
int rig_need_debug(enum rig_debug_level_e debug_level);
void rig_debug(enum rig_debug_level_e debug_level, const char *fmt, ...);
int rig_register(const struct rig_caps *caps);
int rig_unregister(rig_model_t rig_model);
int rig_list_foreach(int (*cfunc)(const struct rig_caps*,void*),void *data);
int rig_load_backend(const char *be_name);
#endif /* _RIG_H */

Wyświetl plik

@ -0,0 +1,109 @@
/* hamlib - Copyright (C) 2000 Frank Singleton
*
* riglist.h - Copyrith (C) 2000 Stephane Fillod
* This program defines the list of supported rigs.
*
*
* $Id: riglist.h,v 1.1 2000-10-08 21:15:28 f4cfe Exp $ *
*
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
*/
#ifndef _RIGLIST_H
#define _RIGLIST_H 1
enum rig_model_e {
RIG_MODEL_FT847 = 0,
RIG_MODEL_FT1000,
RIG_MODEL_FT1000D,
RIG_MODEL_FT747,
RIG_MODEL_FT840,
RIG_MODEL_FT920,
RIG_MODEL_TS570D,
RIG_MODEL_TS870S,
RIG_MODEL_TS950,
RIG_MODEL_IC1271,
RIG_MODEL_IC1275,
RIG_MODEL_IC271,
RIG_MODEL_IC275,
RIG_MODEL_IC375,
RIG_MODEL_IC471,
RIG_MODEL_IC475,
RIG_MODEL_IC575,
RIG_MODEL_IC706,
RIG_MODEL_IC706MKII,
RIG_MODEL_IC706MKIIG,
RIG_MODEL_IC707,
RIG_MODEL_IC718,
RIG_MODEL_IC725,
RIG_MODEL_IC726,
RIG_MODEL_IC728,
RIG_MODEL_IC729,
RIG_MODEL_IC731,
RIG_MODEL_IC735,
RIG_MODEL_IC736,
RIG_MODEL_IC737,
RIG_MODEL_IC738,
RIG_MODEL_IC746,
RIG_MODEL_IC751,
RIG_MODEL_IC751A,
RIG_MODEL_IC756,
RIG_MODEL_IC756PRO,
RIG_MODEL_IC761,
RIG_MODEL_IC765,
RIG_MODEL_IC775,
RIG_MODEL_IC781,
RIG_MODEL_IC820,
RIG_MODEL_IC821,
RIG_MODEL_IC821H,
RIG_MODEL_IC970,
RIG_MODEL_ICR71,
RIG_MODEL_ICR72,
RIG_MODEL_ICR7000,
RIG_MODEL_ICR7100,
RIG_MODEL_ICR8500,
RIG_MODEL_ICR9000
/* etc. */
};
typedef enum rig_model_e rig_model_t;
/*
* It would be nice to have an automatic way of referencing all the backends
* supported by hamlib. Maybe this array should be placed in a separate file..
*/
#if 0
extern const struct rig_caps ft747_caps;
extern const struct rig_caps ft847_caps;
extern const struct rig_caps ic706_caps;
extern const struct rig_caps ic706mkiig_caps;
extern const struct rig_caps ft747_caps;
#endif
/* etc. */
#endif /* _RIGLIST_H */