rs232.c

/*
*    XC Quantum correlators driver library
*    Copyright (C) 2015-2023  Ilia Platone <info@iliaplatone.com>
*
*    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 3 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, see <https://www.gnu.org/licenses/>.
*/

#ifdef __cplusplus
extern "C" {
#endif

#include <stdio.h>
#include <string.h>
#include <unistd.h>
#include <errno.h>
#include <fcntl.h>

#if defined(__linux__) || defined(__linux) || defined(linux) || defined(__gnu_linux__)
    #define LINUX
#elif defined(__APPLE__) && defined(__MACH__)
    #define MACOS
#elif defined(_WIN32) || defined(_WIN64)
    #define WINDOWS
#endif

#ifndef WINDOWS

#include <termios.h>
#include <sys/ioctl.h>
#include <sys/stat.h>
#include <limits.h>
#include <sys/file.h>
#include <sys/socket.h>
#include <arpa/inet.h>
#include <netinet/in.h>

#else
#undef UNICODE
#undef _UNICODE
#include <winsock2.h>
#include <windows.h>
#include <ws2tcpip.h>
#include <winsock.h>
#endif
#include <pthread.h>

#ifdef AHP_DEBUG
static int ahp_debug = 0;
static char* ahp_app_name = NULL;
static FILE *out = NULL;
static FILE *err = NULL;
/**
* \brief log a message to the error or output streams
* \param x The log level
* \param str The string to print
*/
extern void ahp_print(int x, char* str);

void ahp_set_stdout(FILE *f)
{
    out = f;
}

void ahp_set_stderr(FILE *f)
{
    err = f;
}

void ahp_set_debug_level(int value)
{
    ahp_debug = value;
}

void ahp_set_app_name(char* name)
{
    ahp_app_name = name;
}

int ahp_get_debug_level()
{
    return ahp_debug;
}

char* ahp_get_app_name()
{
    return ahp_app_name;
}

void ahp_print(int x, char* str)
{
    if(x == 0 && out != NULL)
        fprintf(out, "%s", str);
    else if(x <= ahp_get_debug_level() && err != NULL)
        fprintf(err, "%s", str);
}

#define pdbg(x, ...) ({ \
char str[500]; \
struct timespec ts; \
time_t t = time(NULL); \
struct tm tm = *localtime(&t); \
clock_gettime(CLOCK_REALTIME, &ts); \
sprintf(str, "[%04d-%02d-%02dT%02d:%02d:%02d.%03ld ", tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday, tm.tm_hour, tm.tm_min, tm.tm_sec, ts.tv_nsec/1000000); \
switch(x) { \
    case AHP_DEBUG_ERROR: \
    sprintf(&str[strlen(str)], "ERRO]"); \
        break; \
    case AHP_DEBUG_WARNING: \
    sprintf(&str[strlen(str)], "WARN]"); \
        break; \
    case AHP_DEBUG_DEBUG: \
    sprintf(&str[strlen(str)], "DEBG]"); \
        break; \
    default: \
    sprintf(&str[strlen(str)], "INFO]"); \
        break; \
} \
if(ahp_get_app_name() != NULL) \
    sprintf(&str[strlen(str)], "[%s]", ahp_get_app_name()); \
sprintf(&str[strlen(str)], " "); \
sprintf(&str[strlen(str)], __VA_ARGS__); \
ahp_print(x, str); \
})
#define pinfo(...) pdbg(AHP_DEBUG_INFO, __VA_ARGS__)
#define perr(...) pdbg(AHP_DEBUG_ERROR, __VA_ARGS__)
#define pwarn(...) pdbg(AHP_DEBUG_WARNING, __VA_ARGS__)
#define pgarb(...) pdbg(AHP_DEBUG_DEBUG, __VA_ARGS__)
#define pfunc pgarb("%s\n", __func__)
#define start_gettime
#define end_gettime
#endif

static pthread_mutexattr_t ahp_serial_mutex_attr;
static pthread_mutex_t ahp_serial_mutex;
static int ahp_serial_mutexes_initialized = 0;
static int ahp_serial_baudrate = 230400;
static char ahp_serial_mode[4] = { 0, 0, 0, 0 };
static int ahp_serial_flowctrl = -1;
static int ahp_serial_fd = -1;

#ifndef WINDOWS
static int ahp_serial_error = 0;

static struct termios ahp_serial_new_port_settings, ahp_serial_old_port_settings;

static int ahp_serial_SetupPort(int bauds, const char *m, int fc)
{
    strcpy(ahp_serial_mode, m);
    ahp_serial_flowctrl = fc;
    ahp_serial_baudrate = bauds;
    int baudr, status;
    switch(ahp_serial_baudrate)
    {
    case      50 : baudr = B50;
                   break;
    case      75 : baudr = B75;
                   break;
    case     110 : baudr = B110;
                   break;
    case     134 : baudr = B134;
                   break;
    case     150 : baudr = B150;
                   break;
    case     200 : baudr = B200;
                   break;
    case     300 : baudr = B300;
                   break;
    case     600 : baudr = B600;
                   break;
    case    1200 : baudr = B1200;
                   break;
    case    1800 : baudr = B1800;
                   break;
    case    2400 : baudr = B2400;
                   break;
    case    4800 : baudr = B4800;
                   break;
    case    9600 : baudr = B9600;
                   break;
    case   19200 : baudr = B19200;
                   break;
    case   38400 : baudr = B38400;
                   break;
    case   57600 : baudr = B57600;
                   break;
    case  115200 : baudr = B115200;
                   break;
    case  230400 : baudr = B230400;
                   break;
#if defined(__linux__)
    case  460800 : baudr = B460800;
                   break;
    case  500000 : baudr = B500000;
                   break;
    case  576000 : baudr = B576000;
                   break;
    case  921600 : baudr = B921600;
                   break;
    case 1000000 : baudr = B1000000;
                   break;
    case 1152000 : baudr = B1152000;
                   break;
    case 1500000 : baudr = B1500000;
                   break;
    case 2000000 : baudr = B2000000;
                   break;
    case 2500000 : baudr = B2500000;
                   break;
    case 3000000 : baudr = B3000000;
                   break;
    case 3500000 : baudr = B3500000;
                   break;
    case 4000000 : baudr = B4000000;
                   break;
#endif
    default      : printf("invalid ahp_serial_baudrate\n");
                   return 1;
  }

  int cbits=CS8,  cpar=0, ipar=IGNPAR, bstop=0;

    if(strlen(ahp_serial_mode) != 3)
    {
        printf("invalid ahp_serial_mode \"%s\"\n", ahp_serial_mode);
        return 1;
    }

    switch(ahp_serial_mode[0])
    {
    case '8': cbits = CS8;
              break;
    case '7': cbits = CS7;
              break;
    case '6': cbits = CS6;
              break;
    case '5': cbits = CS5;
              break;
    default : printf("invalid number of data-bits '%c'\n", ahp_serial_mode[0]);
              return 1;
    }

    switch(ahp_serial_mode[1])
    {
    case 'N':
    case 'n': cpar = 0;
              ipar = IGNPAR;
              break;
    case 'E':
    case 'e': cpar = PARENB;
              ipar = INPCK;
              break;
    case 'O':
    case 'o': cpar = (PARENB | PARODD);
              ipar = INPCK;
              break;
    default : printf("invalid parity '%c'\n", ahp_serial_mode[1]);
              return 1;
    }

    switch(ahp_serial_mode[2])
    {
    case '1': bstop = 0;
              break;
    case '2': bstop = CSTOPB;
              break;
    default : printf("invalid number of stop bits '%c'\n", ahp_serial_mode[2]);
              return 1;
    }

    ahp_serial_error = tcgetattr(ahp_serial_fd, &ahp_serial_old_port_settings);
    if(ahp_serial_error==-1)
    {
        perr("unable to read portsettings \n");
        return 1;
    }
    memset(&ahp_serial_new_port_settings, 0, sizeof(ahp_serial_new_port_settings));  /* clear the new struct */

    ahp_serial_new_port_settings.c_cflag = (tcflag_t)(cbits | cpar | bstop | CLOCAL | CREAD);
    if(ahp_serial_flowctrl)
    {
        ahp_serial_new_port_settings.c_cflag |= CRTSCTS;
    }
    ahp_serial_new_port_settings.c_iflag = (tcflag_t)ipar;
    ahp_serial_new_port_settings.c_oflag = 0;
    ahp_serial_new_port_settings.c_lflag = 0;
    ahp_serial_new_port_settings.c_cc[VMIN] = 0;      /* block untill n bytes are received */
    ahp_serial_new_port_settings.c_cc[VTIME] = 0;     /* block untill a timer expires (n * 100 mSec.) */

    cfsetispeed(&ahp_serial_new_port_settings, (speed_t)baudr);
    cfsetospeed(&ahp_serial_new_port_settings, (speed_t)baudr);

    ahp_serial_error = tcsetattr(ahp_serial_fd, TCSANOW, &ahp_serial_new_port_settings);
    if(ahp_serial_error==-1)
    {
        tcsetattr(ahp_serial_fd, TCSANOW, &ahp_serial_old_port_settings);
        perr("unable to adjust portsettings \n");
        return 1;
    }

/* http://man7.org/linux/man-pages/man4/tty_ioctl.4.html */

    if(ioctl(ahp_serial_fd, TIOCMGET, &status) == -1)
    {
        tcsetattr(ahp_serial_fd, TCSANOW, &ahp_serial_old_port_settings);
        perr("unable to get portstatus\n");
        return 1;
    }

    status |= TIOCM_DTR;    /* turn on DTR */
    status |= TIOCM_RTS;    /* turn on RTS */

    if(ioctl(ahp_serial_fd, TIOCMSET, &status) == -1)
    {
        tcsetattr(ahp_serial_fd, TCSANOW, &ahp_serial_old_port_settings);
        perr("unable to set portstatus\n");
        return 1;
    }

    return 0;
}

static void ahp_serial_flushRX()
{
    tcflush(ahp_serial_fd, TCIFLUSH);
}


static void ahp_serial_flushTX()
{
    tcflush(ahp_serial_fd, TCOFLUSH);
}


static void ahp_serial_flushRXTX()
{
    tcflush(ahp_serial_fd, TCIOFLUSH);
}

#else

static DCB ahp_serial_new_port_settings, ahp_serial_old_port_settings;

static int ahp_serial_SetupPort(int bauds, const char *m, int fc)
{
    strcpy(ahp_serial_mode, m);
    ahp_serial_flowctrl = fc;
    ahp_serial_baudrate = bauds;
    HANDLE pHandle = (HANDLE)_get_osfhandle(ahp_serial_fd);

    memset(&ahp_serial_old_port_settings, 0, sizeof(DCB));

    if(!GetCommState(pHandle, &ahp_serial_old_port_settings))
    {
        printf("unable to get comport cfg settings\n");
        return 1;
    }
    memset(&ahp_serial_new_port_settings, 0, sizeof(DCB));
    ahp_serial_new_port_settings.DCBlength = sizeof(DCB);
    ahp_serial_new_port_settings.BaudRate = ahp_serial_baudrate;
    ahp_serial_new_port_settings.XonChar = 0x13;
    ahp_serial_new_port_settings.XoffChar = 0x19;
    ahp_serial_new_port_settings.fOutxCtsFlow = 0;
    ahp_serial_new_port_settings.fOutxDsrFlow = 0;
    ahp_serial_new_port_settings.fDsrSensitivity = 0;
    ahp_serial_new_port_settings.fOutX = 0;
    ahp_serial_new_port_settings.fInX = 0;
    ahp_serial_new_port_settings.fErrorChar = 0;
    ahp_serial_new_port_settings.fBinary = 1;
    ahp_serial_new_port_settings.fNull = 0;
    ahp_serial_new_port_settings.fAbortOnError = 0;
    ahp_serial_new_port_settings.XonLim = 0;
    ahp_serial_new_port_settings.XoffLim = 0;
    ahp_serial_new_port_settings.fTXContinueOnXoff = 1;

    switch(ahp_serial_mode[0]) {
    case '5': ahp_serial_new_port_settings.ByteSize = DATABITS_5; break;
    case '6': ahp_serial_new_port_settings.ByteSize = DATABITS_6; break;
    case '7': ahp_serial_new_port_settings.ByteSize = DATABITS_7; break;
    case '8': ahp_serial_new_port_settings.ByteSize = DATABITS_8; break;
    default:
        perr("invalid byte size\n");
    return 1;
    }
    switch(tolower(ahp_serial_mode[1])) {
    case 'n': ahp_serial_new_port_settings.Parity = NOPARITY; ahp_serial_new_port_settings.fParity = 0; break;
    case 'o': ahp_serial_new_port_settings.Parity = ODDPARITY; ahp_serial_new_port_settings.fParity = 1; break;
    case 'e': ahp_serial_new_port_settings.Parity = EVENPARITY; ahp_serial_new_port_settings.fParity = 1; break;
    default:
        perr("invalid parity\n");
    return 1;
    }
    switch(ahp_serial_mode[2]) {
    case '1': ahp_serial_new_port_settings.StopBits = ONESTOPBIT; break;
    case '2': ahp_serial_new_port_settings.StopBits = TWOSTOPBITS; break;
    default:
        perr("invalid stop bits\n");
    return 1;
    }

    if(ahp_serial_flowctrl)
    {
        ahp_serial_new_port_settings.fOutxCtsFlow = TRUE;
        ahp_serial_new_port_settings.fDtrControl = DTR_CONTROL_HANDSHAKE;
        ahp_serial_new_port_settings.fRtsControl = RTS_CONTROL_HANDSHAKE;
    } else {
        ahp_serial_new_port_settings.fOutxCtsFlow = FALSE;
        ahp_serial_new_port_settings.fDtrControl = DTR_CONTROL_DISABLE;
        ahp_serial_new_port_settings.fRtsControl = RTS_CONTROL_DISABLE;
    }

    ahp_serial_new_port_settings.DCBlength = sizeof(ahp_serial_new_port_settings);

    if(!SetCommState(pHandle, &ahp_serial_new_port_settings))
    {
        perr("unable to set comport cfg settings\n");
        return 1;
    }

    COMMTIMEOUTS Cptimeouts;
    if(!GetCommTimeouts(pHandle, &Cptimeouts))
    {
        printf("unable to get comport timeouts\n");
        return 1;
    }

    Cptimeouts.ReadTotalTimeoutMultiplier  = 1;
    Cptimeouts.ReadTotalTimeoutConstant    = 1;
    Cptimeouts.WriteTotalTimeoutMultiplier  = 1;
    Cptimeouts.WriteTotalTimeoutConstant    = 1;

    if(!SetCommTimeouts(pHandle, &Cptimeouts))
    {
        printf("unable to set comport timeouts\n");
        return 1;
    }


    return 0;
}

/*
https://msdn.microsoft.com/en-us/library/windows/desktop/aa363428%28v=vs.85%29.aspx
*/

static void ahp_serial_flushRX()
{
    HANDLE pHandle = (HANDLE)_get_osfhandle(ahp_serial_fd);
    PurgeComm(pHandle, PURGE_RXCLEAR | PURGE_RXABORT);
}


static void ahp_serial_flushTX()
{
    HANDLE pHandle = (HANDLE)_get_osfhandle(ahp_serial_fd);
    PurgeComm(pHandle, PURGE_TXCLEAR | PURGE_TXABORT);
}


static void ahp_serial_flushRXTX()
{
    HANDLE pHandle = (HANDLE)_get_osfhandle(ahp_serial_fd);
    PurgeComm(pHandle, PURGE_RXCLEAR | PURGE_RXABORT);
    PurgeComm(pHandle, PURGE_TXCLEAR | PURGE_TXABORT);
}

#endif

static int ahp_serial_OpenComport(const char* dev_name)
{
    if(ahp_serial_fd == -1)
        ahp_serial_fd = open(dev_name, O_RDWR);

    if(ahp_serial_fd==-1) {
        perr("unable to open comport: %s\n", strerror(errno));
        return 1;
    }
    if(!ahp_serial_mutexes_initialized) {
        pthread_mutexattr_init(&ahp_serial_mutex_attr);
        pthread_mutexattr_settype(&ahp_serial_mutex_attr, PTHREAD_MUTEX_ERRORCHECK);
        pthread_mutex_init(&ahp_serial_mutex, &ahp_serial_mutex_attr);
        ahp_serial_mutexes_initialized = 1;
    }
#ifdef WINDOWS
    unsigned long nonblocking = 1;
    ioctlsocket(ahp_serial_fd, FIONBIO, &nonblocking);
#else
    int flags = fcntl(ahp_serial_fd, F_GETFL);
    fcntl(ahp_serial_fd, F_SETFL, flags | O_NONBLOCK);
#endif
    return 0;
}

static void ahp_serial_CloseComport()
{
    if(ahp_serial_fd != -1)
        close(ahp_serial_fd);
    if(ahp_serial_mutexes_initialized) {
        pthread_mutex_unlock(&ahp_serial_mutex);
        pthread_mutex_destroy(&ahp_serial_mutex);
        pthread_mutexattr_destroy(&ahp_serial_mutex_attr);
        ahp_serial_mutexes_initialized = 0;

    }
    strcpy(ahp_serial_mode, "   ");
    ahp_serial_flowctrl = -1;
    ahp_serial_baudrate = -1;
    ahp_serial_fd = -1;
}

static int ahp_serial_RecvBuf(unsigned char *buf, int size)
{
    int n = -ENODEV;
    int nbytes = 0;
    int ntries = size;
    int bytes_left = size;
    int err = 0;
    if(ahp_serial_mutexes_initialized) {
        while(pthread_mutex_trylock(&ahp_serial_mutex))
            usleep(100);
        while(bytes_left > 0 && ntries-->0) {
            usleep(12000000/ahp_serial_baudrate);
            n = read(ahp_serial_fd, buf+nbytes, bytes_left);
            if(n<0) {
                err = -errno;
                continue;
            }
            nbytes += n;
            bytes_left -= n;
        }
        pthread_mutex_unlock(&ahp_serial_mutex);
    }
    if(nbytes < 1) {
        if(ntries < 0)
            return -ENODATA;
        return err;
    }
    return nbytes;
}

static int ahp_serial_SendBuf(unsigned char *buf, int size)
{
    int n = -ENODEV;
    int nbytes = 0;
    int ntries = size*2;
    int bytes_left = size;
    int err = 0;
    if(ahp_serial_mutexes_initialized) {
        while(pthread_mutex_trylock(&ahp_serial_mutex))
            usleep(100);
        while(bytes_left > 0 && ntries-->0) {
            usleep(12000000/ahp_serial_baudrate);
            n = write(ahp_serial_fd, buf+nbytes, bytes_left);
            if(n<1) {
                err = -errno;
                continue;
            }
            nbytes += n;
            bytes_left -= n;
        }
        pthread_mutex_unlock(&ahp_serial_mutex);
    }
    if(nbytes < size)
        return err;
    return nbytes;
}

static int ahp_serial_RecvByte()
{
    int byte = 0;
    int n = ahp_serial_RecvBuf((unsigned char*)&byte, 1);
    if(n < 1)
    {
        return -errno;
    }
    return byte;
}

static int ahp_serial_SendByte(unsigned char byte)
{
    int n = ahp_serial_SendBuf(&byte, 1);
    if(n < 1)
    {
        return -errno;
    }
    return 0;
}

static int ahp_serial_AlignFrame(int sof, int maxtries)
{
    int c = 0;
    ahp_serial_flushRX();
    while(c != sof && (maxtries > 0 ? maxtries-- > 0 : 1)) {
        c = ahp_serial_RecvByte();
        if(c < 0) {
            continue;
        }
    }
    return 0;
}

static void ahp_serial_SetFD(int f, int bauds)
{
    if(!ahp_serial_mutexes_initialized) {
        pthread_mutexattr_init(&ahp_serial_mutex_attr);
        pthread_mutexattr_settype(&ahp_serial_mutex_attr, PTHREAD_MUTEX_ERRORCHECK);
        pthread_mutex_init(&ahp_serial_mutex, &ahp_serial_mutex_attr);
        ahp_serial_mutexes_initialized = 1;
    }
    ahp_serial_fd = f;
    ahp_serial_baudrate = bauds;
#ifdef WINDOWS
    unsigned long nonblocking = 1;
    ioctlsocket(ahp_serial_fd, FIONBIO, &nonblocking);
#else
    int flags = fcntl(ahp_serial_fd, F_GETFL);
    fcntl(ahp_serial_fd, F_SETFL, flags | O_NONBLOCK);
#endif
}

static int ahp_serial_GetFD()
{
    return ahp_serial_fd;
}

#ifdef __cplusplus
} /* extern "C" */
#endif