/*********************************************************************************
|
* Copyright: (C) 2020 LingYun IoT System Studio
|
* All rights reserved.
|
*
|
* Filename: comport.h
|
* Description: This head file is for the common TTY/Serial port operator library
|
*
|
* Version: 1.0.0(06/29/2020~)
|
* Author: Guo Wenxue <guowenxue@gmail.com>
|
* ChangeLog: 1, Release initial version on "06/29/2020 03:33:25 PM"
|
*
|
********************************************************************************/
|
#ifndef __COMPORT_H_
|
#define __COMPORT_H_
|
|
#include <stdio.h>
|
#include <stdlib.h>
|
#include <unistd.h>
|
#include <string.h>
|
#include <getopt.h>
|
#include <fcntl.h>
|
#include <errno.h>
|
#include <termios.h>
|
#include <sys/stat.h>
|
#include <sys/wait.h>
|
#include <sys/types.h>
|
#include <sys/stat.h>
|
#include <sys/select.h>
|
|
#ifndef DEVNAME_LEN
|
#define DEVNAME_LEN 64
|
#endif
|
|
//#define COM_DEBUG
|
#ifdef COM_DEBUG
|
#define COM_PRINT(format,args...) printf(format, ##args)
|
#else
|
#define COM_PRINT(format,args...) do{} while(0);
|
#endif
|
|
typedef struct comport_s
|
{
|
int fd;
|
char dev_name[DEVNAME_LEN];
|
|
long baudrate;
|
unsigned char databit;
|
unsigned char parity;
|
unsigned char stopbit;
|
unsigned char flowctrl;
|
|
int frag_size;
|
} comport_t;
|
|
|
/*+-----------------------------------------------------------------------------------------+
|
* description: Initialise the comport structure
|
*
|
* input args:
|
* $comport: The comport work context pointer
|
* $dev_name: The comport device name path, such as '/dev/ttyS3'
|
* $baudrate: The baudrate, such as 115200
|
* $settings: The databit,parity,stopbit,flowctrl settings, such as '8N1N'
|
*
|
* return value: 0: Successfully <0: Failure
|
*+-----------------------------------------------------------------------------------------+*/
|
int comport_init(comport_t *comport, const char *dev_name, int baudrate, const char *settings);
|
|
|
|
/*+-----------------------------------------------------------------------------------------+
|
* description: display current comport settings such as databit,parity,stopbit,flowctrl
|
* input args: $comport: corresponding comport point
|
*+-----------------------------------------------------------------------------------------+*/
|
#ifdef COM_DEBUG
|
extern void disp_settings(comport_t * comport);
|
#endif
|
|
|
|
/*+-----------------------------------------------------------------------------------------+
|
* description: Open the comport specified by $comport
|
* input args: $comport: comport work context
|
* return value: >0: The comport opened file description, <0: Failure
|
*+-----------------------------------------------------------------------------------------+*/
|
extern int comport_open(comport_t * comport);
|
|
|
|
/*+-----------------------------------------------------------------------------------------+
|
* description: close comport
|
* input args: $comport: corresponding comport point
|
*+-----------------------------------------------------------------------------------------+*/
|
extern void comport_close(comport_t * comport);
|
|
|
|
/*+-----------------------------------------------------------------------------------------+
|
* description: write $send_bytes bytes data from $buf to $comport
|
* return value: 0: write ok <0: write failure
|
*+-----------------------------------------------------------------------------------------+*/
|
extern int comport_send(comport_t * comport, char *buf, int send_bytes);
|
|
|
|
/*+-----------------------------------------------------------------------------------------+
|
* description: read data from $comport in $timeout <ms> to $buf, no more than $buf_size bytes
|
* return value: the actual read data bytes, <0: read failure
|
*+-----------------------------------------------------------------------------------------+*/
|
extern int comport_recv(comport_t * comport, char *buf, int buf_size, unsigned long timeout);
|
|
|
|
#endif
|
