port.h

Go to the documentation of this file.

/*
 *  Hamlib Interface - Port structure
 *  Copyright (c) 2000-2025 The Hamlib Group
 *  Copyright (c) 2025 George Baltz
 *
 *
 *   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
 *
 */
/* SPDX-License-Identifier: LGPL-2.1-or-later */
 
#ifndef _HL_PORT_H
#define _HL_PORT_H 1
 
 
__BEGIN_DECLS



typedef struct hamlib_port {
    union {
        rig_port_t rig;     
        ptt_type_t ptt;     
        dcd_type_t dcd;     
    } type;                 
 
    int fd;                 
    void *handle;           
 
    int write_delay;        
    int post_write_delay;   
 
    struct {
        int tv_sec, tv_usec;
    } post_write_date;      
 
    int timeout;            
    short retry;            
    short flushx;           
 
    char pathname[HAMLIB_FILPATHLEN];      
 
    union {
        struct {
            int rate;       
            int data_bits;  
            int stop_bits;  
            enum serial_parity_e parity;        
            enum serial_handshake_e handshake;  
            enum serial_control_state_e rts_state;    
            enum serial_control_state_e dtr_state;    
        } serial;           
 
        struct {
            int pin;        
        } parallel;         
 
        struct {
            int ptt_bitnum; 
        } cm108;            
 
        struct {
            int vid;        
            int pid;        
            int conf;       
            int iface;      
            int alt;        
            char *vendor_name;  
            char *product;      
        } usb;              
 
        struct {
            int on_value;   
            int value;      
        } gpio;             
    } parm;                 
    int client_port;        
    RIG *rig;               
    int asyncio;            
#if defined(_WIN32)
    hamlib_async_pipe_t *sync_data_pipe;         
    hamlib_async_pipe_t *sync_data_error_pipe;   
#else
    int fd_sync_write;          
    int fd_sync_read;           
    int fd_sync_error_write;    
    int fd_sync_error_read;     
#endif
    short timeout_retry;    
// DO NOT ADD ANYTHING HERE UNTIL 5.0!!
} hamlib_port_t;
 

typedef struct hamlib_port_deprecated {
    union {
        rig_port_t rig;     
        ptt_type_t ptt;     
        dcd_type_t dcd;     
    } type;                 
 
    int fd;                 
    void *handle;           
 
    int write_delay;        
    int post_write_delay;   
 
    struct {
        int tv_sec, tv_usec;
    } post_write_date;      
 
    int timeout;            
    short retry;            
    short flushx;           
 
    char pathname[HAMLIB_FILPATHLEN];      
 
    union {
        struct {
            int rate;       
            int data_bits;  
            int stop_bits;  
            enum serial_parity_e parity;        
            enum serial_handshake_e handshake;  
            enum serial_control_state_e rts_state;    
            enum serial_control_state_e dtr_state;    
        } serial;           
 
        struct {
            int pin;        
        } parallel;         
 
        struct {
            int ptt_bitnum; 
        } cm108;            
 
        struct {
            int vid;        
            int pid;        
            int conf;       
            int iface;      
            int alt;        
            char *vendor_name;  
            char *product;      
        } usb;              
 
        struct {
            int on_value;   
            int value;      
        } gpio;             
    } parm;                 
    int client_port;      
    RIG *rig;             
} hamlib_port_t_deprecated;
 
#if !defined(__APPLE__) || !defined(__cplusplus)
typedef hamlib_port_t_deprecated port_t_deprecated;

typedef hamlib_port_t port_t;
#endif

#define HAMLIB_RIGPORT(r) ((hamlib_port_t *)rig_data_pointer((r), RIG_PTRX_RIGPORT))
#define HAMLIB_PTTPORT(r) ((hamlib_port_t *)rig_data_pointer((r), RIG_PTRX_PTTPORT))
#define HAMLIB_DCDPORT(r) ((hamlib_port_t *)rig_data_pointer((r), RIG_PTRX_DCDPORT))
#define HAMLIB_AMPPORT(a) ((hamlib_port_t *)amp_data_pointer((a), RIG_PTRX_AMPPORT))
#define HAMLIB_ROTPORT(r) ((hamlib_port_t *)rot_data_pointer((r), RIG_PTRX_ROTPORT))
#define HAMLIB_ROTPORT2(r) ((hamlib_port_t *)rot_data_pointer((r), RIG_PTRX_ROTPORT2))
 
__END_DECLS
 
#endif /* _HL_PORT_H */