rs232c_io.hpp

#pragma once
//=====================================================================//
/*!	@file
	@brief	RS232C 入出力クラス
    @author 平松邦仁 (hira@rvf-rc45.net)
	@copyright	Copyright (C) 2016, 2017 Kunihito Hiramatsu @n
				Released under the MIT license @n
				https://github.com/hirakuni45/RX/blob/master/LICENSE
*/
//=====================================================================//
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <termios.h>
#include <unistd.h>
#include <limits.h>
#include <sys/ioctl.h>

#include <string>
#include <iostream>
#include <cstring>
#include <cstdio>

namespace utils {

	//+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++//
	/*!
		@brief	RS232C I/O クラス
	*/
	//+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++//
	class rs232c_io {
	public:

		//+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++//
		/*!
			@brief	パリティの設定
		*/
		//+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++//
		enum class parity {
			none,	///< パリティー無し
			even,	///< 偶数パリティ
			odd		///< 奇数パリティ
		};


		//+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++//
		/*!
			@brief	キャラクター長
		*/
		//+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++//
		enum class char_len {
			bits7,	///< ７ビット
			bits8	///< ８ビット
		};


		//+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++//
		/*!
			@brief	ストップ・ビット長
		*/
		//+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++//
		enum class stop_len {
			one,	///< １ビット
			two		///< ２ビット
		};

	private:
		int    fd_;

		termios		attr_back_;
		termios		attr_;

		void close_() {
			tcsetattr(fd_, TCSANOW, &attr_back_);
			::close(fd_);
			fd_ = -1;
		}

	public:
		//-----------------------------------------------------------------//
		/*!
			@brief	コンストラクター
		*/
		//-----------------------------------------------------------------//
		rs232c_io() : fd_(-1) { }


		//-----------------------------------------------------------------//
		/*!
			@brief オープン
			@param[in]	path	シリアルポートパス
			@param[in]	brate	接続ボーレート
			@param[in]	clen	キャラクター長
			@param[in]	slen	ストップ・ビット長
			@param[in]	par		パリティ・ビット
			@param[in]	hc		ハードウェアー制御を有効にする場合「true」
			@return 正常なら「true」
		*/
		//-----------------------------------------------------------------//
		bool open(const std::string& path, speed_t brate,
			char_len clen = char_len::bits8, stop_len slen = stop_len::one,
			parity par = parity::none, bool hc = false) {

			int cpar = 0;
			int ipar = IGNBRK;
			switch(par) {
			case parity::none:
				cpar = 0;
				ipar = IGNPAR;
				break;
			case parity::even:
				cpar = PARENB;
				ipar = INPCK;
				break;
			case parity::odd:
				cpar = (PARENB | PARODD);
				ipar = INPCK;
				break;
			default:
				return false;
			}

			int bstop = 0;
			switch(slen) {
			case stop_len::one: bstop = 0;
				break;
			case stop_len::two: bstop = CSTOPB;
				break;
			default:
				return false;
			}

			int cbits = 0;
			switch(clen) {
			case char_len::bits8:
				cbits = CS8;
				break;
			case char_len::bits7:
				cbits = CS7;
				break;
			default:
				return false;
			}

			fd_ = ::open(path.c_str(), O_RDWR | O_NOCTTY | O_NDELAY);
			if(fd_ < 0) {
				return false;
			}

			if(tcgetattr(fd_, &attr_back_) == -1) {
				::close(fd_);
				fd_ = -1;
			}

			memset(&attr_, 0, sizeof(attr_));
			if(hc) {
				attr_.c_cflag = cbits | cpar | bstop | CRTSCTS | CREAD;
			} else {
				attr_.c_cflag = cbits | cpar | bstop | CLOCAL | CREAD;
			}
			attr_.c_iflag = ipar;
			attr_.c_oflag = 0;
			attr_.c_lflag = 0;
			attr_.c_cc[VMIN]  = 0;     // block untill n bytes are received
			attr_.c_cc[VTIME] = 1;     // block untill a timer expires (n * 100 mSec.)

			if(cfsetspeed(&attr_, brate) == -1) {
				close_();
				return false;
			}

			if(tcsetattr(fd_, TCSANOW, &attr_) == -1) {
				close_();
				return false;
			}

			int status;
			if(ioctl(fd_, TIOCMGET, &status) == -1) {
				close_();
				return false;
			}

			return true;
		}


		//-----------------------------------------------------------------//
		/*!
			@brief	速度を変更
			@param[in]	brate 新しいボーレート
			@return 正常なら「true」
		*/
		//-----------------------------------------------------------------//
		bool change_speed(speed_t brate) {
			if(fd_ < 0) return false;

			if(cfsetspeed(&attr_, brate) == -1) {
				close_();
				return false;
			}
			if(tcsetattr(fd_, TCSANOW, &attr_) == -1) {
				close_();
				return false;
			}

			return true;
		}


		//-----------------------------------------------------------------//
		/*!
			@brief	クローズ
			@return 正常なら「true」
		*/
		//-----------------------------------------------------------------//
		bool close() noexcept
		{
			if(fd_ < 0) return false;

			int status;
			if(ioctl(fd_, TIOCMGET, &status) == -1) {
				close_();
				return false;
			}

			status &= ~TIOCM_DTR;    /* turn off DTR */
			status &= ~TIOCM_RTS;    /* turn off RTS */

			if(ioctl(fd_, TIOCMSET, &status) == -1) {
				close_();
				return false;
			}

			close_();

			return true;
		}


		//-----------------------------------------------------------------//
		/*!
			@brief	送信同期
			@return 正常なら「true」
		*/
		//-----------------------------------------------------------------//
		bool sync_send() const noexcept
		{
			if(fd_ < 0) return false;

			tcdrain(fd_);

			return true;
		}


		//-----------------------------------------------------------------//
		/*!
			@brief	受信
			@param[out]	dst	受信データ転送先
			@param[in]	len	受信最大長さ
			@return 受信した長さ
		*/
		//-----------------------------------------------------------------//
		size_t recv(void* dst, size_t len) noexcept
		{
			if(fd_ < 0) return 0;

			return ::read(fd_, dst, len);
		}


		//-----------------------------------------------------------------//
		/*!
			@brief	受信
			@param[out]	dst	受信データ転送先
			@param[in]	len	受信最大長さ
			@param[in]	tv	タイムアウト指定
			@return 受信した長さ
		*/
		//-----------------------------------------------------------------//
		size_t recv(void* dst, size_t len, const timeval& tv) noexcept
		{
			if(fd_ < 0) return 0;

			size_t total = 0;
			uint8_t* p = static_cast<uint8_t*>(dst);
			int retry = 5;
			while(total < len) {
				fd_set fds;
				FD_ZERO(&fds);
				FD_SET(fd_, &fds);
				timeval t;
				t = tv;
				int ret = select(fd_ + 1, &fds, NULL, NULL, &t);
				if(ret == -1) {  // for error..
					std::cout << "recv select: 'error'" << std::endl;
					retry--;
				} else if(ret == 1) {
					size_t rl = ::read(fd_, p, len - total);
					total += rl;
					p += rl;
				} else {
					retry--;
				}
				if(retry == 0) {
					break;
				}
			}

			return total;
		}


		//-----------------------------------------------------------------//
		/*!
			@brief	１バイト受信（タイムアウト）
			@param[in]	tv	タイムアウト指定
			@return 受信データ
		*/
		//-----------------------------------------------------------------//
		int recv(const timeval& tv) noexcept
		{
			uint8_t buff[1];
			if(recv(buff, 1, tv) != 1) {
				return EOF;
			}
			return static_cast<int>(buff[0]);
		}


		//-----------------------------------------------------------------//
		/*!
			@brief	送信
			@param[in]	src	送信データ転送元
			@param[in]	len	送信長さ
			@return 送信した長さ
		*/
		//-----------------------------------------------------------------//
		size_t send(const void* src, size_t len) noexcept
		{
			if(fd_ < 0) return 0;

			return ::write(fd_, src, len);
		}


		//-----------------------------------------------------------------//
		/*!
			@brief	送信
			@param[in]	ch	送信データ
			@return 成功なら「true」
		*/
		//-----------------------------------------------------------------//
		bool send(char ch) noexcept
		{
			if(fd_ < 0) return false;

			char buff[1];
			buff[0] = ch;
			return send(buff, 1) == 1;
		}


		//-----------------------------------------------------------------//
		/*!
			@brief	破棄
			@return 成功なら「true」
		*/
		//-----------------------------------------------------------------//
		bool flush() noexcept
		{
			return tcflush(fd_, TCIOFLUSH) == 0;
		}


		//-----------------------------------------------------------------//
		/*!
			@brief	DCD 信号の状態を取得
			@return DCD 信号
		*/
		//-----------------------------------------------------------------//
		bool get_DCD() const noexcept
		{
			if(fd_ < 0) return false;

			int status;
			if(ioctl(fd_, TIOCMGET, &status) == -1) {
				return false;
			}

			return status & TIOCM_CAR;
		}


		//-----------------------------------------------------------------//
		/*!
			@brief	CTS 信号の状態を取得
			@return CTS 信号
		*/
		//-----------------------------------------------------------------//
		bool get_CTS() const noexcept
		{
			if(fd_ < 0) return false;

			int status;
			if(ioctl(fd_, TIOCMGET, &status) == -1) {
				return false;
			}

			return status & TIOCM_CTS;
		}


		//-----------------------------------------------------------------//
		/*!
			@brief	DSR 信号の状態を取得
			@return DSR 信号
		*/
		//-----------------------------------------------------------------//
		bool get_DSR() const noexcept
		{
			if(fd_ < 0) return false;

			int status;

			if(ioctl(fd_, TIOCMGET, &status) == -1) {
				return false;
			}

			return status & TIOCM_DSR;
		}


		//-----------------------------------------------------------------//
		/*!
			@brief	TXD 端子のレベルを設定
			@param[in]	level	設定レベル
			@return 正常なら「true」
		*/
		//-----------------------------------------------------------------//
		bool set_TXD(bool level) noexcept
		{
			if(fd_ < 0) return false;

			int command;
			if(level) {
				command = TIOCCBRK;
			} else {
				command = TIOCSBRK;
			}
			return ioctl(fd_, command) != -1; 
		}


		//-----------------------------------------------------------------//
		/*!
			@brief	DTR 信号の状態を設定
			@param[in]	ena 「flase」なら「０」
			@return 成功なら「true」
		*/
		//-----------------------------------------------------------------//
		bool enable_DTR(bool ena = true) noexcept
		{
			if(fd_ < 0) return false;

			int status;
			if(ioctl(fd_, TIOCMGET, &status) == -1) {
				return false;
			}

			if(ena) status |= TIOCM_DTR;
			else status &= ~TIOCM_DTR;

			if(ioctl(fd_, TIOCMSET, &status) == -1) {
				return false;
			}

			return true;
		}


		//-----------------------------------------------------------------//
		/*!
			@brief	RTS 信号の状態を設定
			@param[in]	ena 「flase」なら「０」
			@return 成功なら「true」
		*/
		//-----------------------------------------------------------------//
		bool enable_RTS(bool ena = true) noexcept
		{
			if(fd_ < 0) return false;

			int status;
			if(ioctl(fd_, TIOCMGET, &status) == -1) {
				return false;
			}

			if(ena) status |= TIOCM_RTS;
			else status &= ~TIOCM_RTS;

			if(ioctl(fd_, TIOCMSET, &status) == -1) {
				return false;
			}
			return true;
		}
	};
}