amplifier.h

Go to the documentation of this file.

/*
 *  Hamlib Interface - Amplifier API header
 *  Copyright (c) 2000-2005 by Stephane Fillod
 *
 *
 *   This library is free software; you can redistribute it and/or
 *   modify it under the terms of the GNU Lesser General Public
 *   License as published by the Free Software Foundation; either
 *   version 2.1 of the License, or (at your option) any later version.
 *
 *   This library 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
 *   Lesser General Public License for more details.
 *
 *   You should have received a copy of the GNU Lesser General Public
 *   License along with this library; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */
 
#ifndef _AMPLIFIER_H
#define _AMPLIFIER_H 1
 
#include <hamlib/rig.h>
#include <hamlib/amplist.h>
 
__BEGIN_DECLS
 
/* Forward struct references */
 
struct amp;
struct amp_state;
 
 
typedef struct amp AMP;
 
 
typedef float swr_t;
 
 
typedef int tune_value_t;
 
 
#define NETAMPCTL_RET "RPRT "
 
 
typedef enum
{
  AMP_RESET_MEM, // erase tuner memory
  AMP_RESET_FAULT, // reset any fault
  AMP_RESET_AMP  // for kpa1500
} amp_reset_t;
 
typedef enum
{
  AMP_FLAG_1 = (1 << 1),      
  AMP_FLAG_2 = (1 << 2)       
} amp_type_t;
 
// TBD AMP_TYPE
#define AMP_TYPE_MASK (AMP_FLAG_1|AMP_FLAG_2)
 
#define AMP_TYPE_OTHER 0
#define AMP_TYPE_1     AMP_FLAG_1
#define AMP_TYPE_2     AMP_FLAG_2
#define AMP_TYPE_ALL       (AMP_FLAG_1|AMP_FLAG_2)
 
 
enum amp_level_e
{
  AMP_LEVEL_NONE          = 0,        
  AMP_LEVEL_SWR           = (1 << 0), 
  AMP_LEVEL_NH            = (1 << 1), 
  AMP_LEVEL_PF            = (1 << 2), 
  AMP_LEVEL_PWR_INPUT     = (1 << 3), 
  AMP_LEVEL_PWR_FWD       = (1 << 4), 
  AMP_LEVEL_PWR_REFLECTED = (1 << 5), 
  AMP_LEVEL_PWR_PEAK      = (1 << 6), 
  AMP_LEVEL_FAULT         = (1 << 7)  
};
 
#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)
 
/* 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
 * enquiries about capabilities.
 */
 
#define AMP_MODEL(arg) .amp_model=arg,.macro_name=#arg
struct amp_caps
{
  amp_model_t amp_model;                      
  const char *model_name;                     
  const char *mfg_name;                       
  const char *version;                        
  const char *copyright;                      
  enum rig_status_e status;                   
  int amp_type;                               
  enum rig_port_e port_type;                  
  int serial_rate_min;                        
  int serial_rate_max;                        
  int serial_data_bits;                       
  int serial_stop_bits;                       
  enum serial_parity_e serial_parity;         
  enum serial_handshake_e serial_handshake;   
  int write_delay;                            
  int post_write_delay;                       
  int timeout;                                
  int retry;                                  
  const struct confparams *cfgparams;         
  const rig_ptr_t priv;                       
  const char *amp_model_macro_name;           
  setting_t has_get_level;
  setting_t has_set_level;
 
  gran_t level_gran[RIG_SETTING_MAX]; 
  gran_t parm_gran[RIG_SETTING_MAX]; 
  /*
   * Amp Admin API
   *
   */
 
  int (*amp_init)(AMP *amp);
  int (*amp_cleanup)(AMP *amp);
  int (*amp_open)(AMP *amp);
  int (*amp_close)(AMP *amp);
 
  int (*set_freq)(AMP *amp, freq_t val);
  int (*get_freq)(AMP *amp, freq_t *val);
 
  int (*set_conf)(AMP *amp, token_t token, const char *val);
  int (*get_conf)(AMP *amp, token_t token, char *val);
 
  /*
   *  General API commands, from most primitive to least.. :()
   *  List Set/Get functions pairs
   */
 
  int (*reset)(AMP *amp, amp_reset_t reset);
  int (*get_level)(AMP *amp, setting_t level, value_t *val);
  int (*get_ext_level)(AMP *amp, token_t level, value_t *val);
  int (*set_powerstat)(AMP *amp, powerstat_t status);
  int (*get_powerstat)(AMP *amp, powerstat_t *status);
 
 
  /* get firmware info, etc. */
  const char *(*get_info)(AMP *amp);
 
  setting_t levels;
  unsigned ext_levels;
  const struct confparams *extlevels;
  const struct confparams *extparms;
 
  const char *macro_name;                     
};
 
 
struct amp_state
{
  /*
   * overridable fields
   */
 
  /*
   * non overridable fields, internal use
   */
  hamlib_port_t ampport;  
  int comm_state;         
  rig_ptr_t priv;         
  rig_ptr_t obj;          
  setting_t has_get_level;
 
  gran_t level_gran[RIG_SETTING_MAX]; 
  gran_t parm_gran[RIG_SETTING_MAX]; 
};
 
 
struct amp
{
  struct amp_caps *caps;      
  struct amp_state state;     
};
 
 
/* --------------- API function prototypes -----------------*/
 
extern HAMLIB_EXPORT(AMP *)
amp_init HAMLIB_PARAMS((amp_model_t amp_model));
 
extern HAMLIB_EXPORT(int)
amp_open HAMLIB_PARAMS((AMP *amp));
 
extern HAMLIB_EXPORT(int)
amp_close HAMLIB_PARAMS((AMP *amp));
 
extern HAMLIB_EXPORT(int)
amp_cleanup HAMLIB_PARAMS((AMP *amp));
 
extern HAMLIB_EXPORT(int)
amp_set_conf HAMLIB_PARAMS((AMP *amp,
                            token_t token,
                            const char *val));
extern HAMLIB_EXPORT(int)
amp_get_conf HAMLIB_PARAMS((AMP *amp,
                            token_t token,
                            char *val));
extern HAMLIB_EXPORT(int)
amp_set_powerstat HAMLIB_PARAMS((AMP *amp,
                                 powerstat_t status));
extern HAMLIB_EXPORT(int)
amp_get_powerstat HAMLIB_PARAMS((AMP *amp,
                                 powerstat_t *status));
 
 
/*
 *  General API commands, from most primitive to least.. )
 *  List Set/Get functions pairs
 */
extern HAMLIB_EXPORT(int)
amp_get_freq HAMLIB_PARAMS((AMP *amp,
                            freq_t *freq));
extern HAMLIB_EXPORT(int)
amp_set_freq HAMLIB_PARAMS((AMP *amp,
                            freq_t freq));
 
extern HAMLIB_EXPORT(int)
amp_reset HAMLIB_PARAMS((AMP *amp,
                         amp_reset_t reset));
 
extern HAMLIB_EXPORT(const char *)
amp_get_info HAMLIB_PARAMS((AMP *amp));
 
extern HAMLIB_EXPORT(int)
amp_get_level HAMLIB_PARAMS((AMP *amp, setting_t level, value_t *val));
 
extern HAMLIB_EXPORT(int)
amp_register HAMLIB_PARAMS((const struct amp_caps *caps));
 
extern HAMLIB_EXPORT(int)
amp_unregister HAMLIB_PARAMS((amp_model_t amp_model));
 
extern HAMLIB_EXPORT(int)
amp_list_foreach HAMLIB_PARAMS((int (*cfunc)(const struct amp_caps *,
                                rig_ptr_t),
                                rig_ptr_t data));
 
extern HAMLIB_EXPORT(int)
amp_load_backend HAMLIB_PARAMS((const char *be_name));
 
extern HAMLIB_EXPORT(int)
amp_check_backend HAMLIB_PARAMS((amp_model_t amp_model));
 
extern HAMLIB_EXPORT(int)
amp_load_all_backends HAMLIB_PARAMS((void));
 
extern HAMLIB_EXPORT(amp_model_t)
amp_probe_all HAMLIB_PARAMS((hamlib_port_t *p));
 
extern HAMLIB_EXPORT(int)
amp_token_foreach HAMLIB_PARAMS((AMP *amp,
                                 int (*cfunc)(const struct confparams *,
                                     rig_ptr_t),
                                 rig_ptr_t data));
 
extern HAMLIB_EXPORT(const struct confparams *)
amp_confparam_lookup HAMLIB_PARAMS((AMP *amp,
                                    const char *name));
 
extern HAMLIB_EXPORT(token_t)
amp_token_lookup HAMLIB_PARAMS((AMP *amp,
                                const char *name));
 
extern HAMLIB_EXPORT(const struct amp_caps *)
amp_get_caps HAMLIB_PARAMS((amp_model_t amp_model));
 
extern HAMLIB_EXPORT(setting_t)
amp_has_get_level HAMLIB_PARAMS((AMP *amp,
                                 setting_t level));
 
extern HAMLIB_EXPORT(const struct confparams *)
amp_ext_lookup HAMLIB_PARAMS((AMP *amp,
                              const char *name));
 
extern HAMLIB_EXPORT(int)
amp_get_ext_level HAMLIB_PARAMS((AMP *amp,
                                 token_t token,
                                 value_t *val));
 
extern HAMLIB_EXPORT(const char *) amp_strlevel(setting_t);
 
extern HAMLIB_EXPORT(const struct confparams *)
rig_ext_lookup HAMLIB_PARAMS((RIG *rig,
                              const char *name));
 
extern HAMLIB_EXPORT(setting_t) amp_parse_level(const char *s);
extern HAMLIB_EXPORT(const char *) amp_strlevel(setting_t);
 
 
 
#define amp_debug rig_debug
 
__END_DECLS
 
#endif /* _AMPLIFIER_H */