Add serial util; move to github workflows

Author: sidcha

.github/workflows/build-ci.yml

@@ -0,0 +1,23 @@
+# Copyright (c) 2020 Siddharth Chandrasekaran <siddharth@embedjournal.com>
+# SPDX-License-Identifier: Apache-2.0
+
+name: Build CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: configure
+      run: cmake .
+    - name: make
+      run: make
+    - name: make check
+      run: make check

.travis.yml

@@ -1,49 +1,40 @@
-cmake_minimum_required(VERSION 2.6)
-project(CUtils)
+#
+#  Copyright (c) 2019 Siddharth Chandrasekaran <siddharth@embedjournal.com>
+#
+#  SPDX-License-Identifier: Apache-2.0
+#
 
-set(CUTILS_VERSION_MAJOR 1)
-set(CUTILS_VERSION_MINOR 0)
+cmake_minimum_required(VERSION 3.0 FATAL_ERROR)
+project(CUtils VERSION 0.1.0 LANGUAGES C)
 
 set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
 set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
 
-include_directories(${PROJECT_SOURCE_DIR}/src)
-include_directories(${PROJECT_SOURCE_DIR}/test)
+# Public headers
+include_directories(${CMAKE_SOURCE_DIR}/include)
 
-set(TEST_DIR ${PROJECT_SOURCE_DIR}/test)
-set(SRC_DIR  ${PROJECT_SOURCE_DIR}/src)
-set(SAMPLE_DIR ${PROJECT_SOURCE_DIR}/sample)
-
-# Samples
-
-## circular Buffers
-set(SAMPLE_SRC
-	${SRC_DIR}/circbuf.c
-	${SAMPLE_DIR}/sample-circbuf.c
+# libutils.a
+set(LIB_UTILS utils)
+file(GLOB LIB_UTILS_SRC ${CMAKE_SOURCE_DIR}/src/*.c)
+file(GLOB LIB_UTILS_INC ${CMAKE_SOURCE_DIR}/include/utils/*.h)
+add_library(${LIB_UTILS} STATIC ${LIB_UTILS_SRC})
+set_target_properties(${LIB_UTILS} PROPERTIES
+	PUBLIC_HEADER "${LIB_UTILS_INC}"
 )
-add_executable(sample_circbuf ${SAMPLE_SRC})
-
-## String
-set(SAMPLE_SRC
-	${SRC_DIR}/strlib.c
-	${SAMPLE_DIR}/sample-strlib.c
+install(
+	TARGETS ${LIB_UTILS}
+	DESTINATION ${CMAKE_INSTALL_DIR}/lib
+	PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_DIR}/include/utils/
 )
-add_executable(sample_strlib ${SAMPLE_SRC})
-
-
-# Tests
 
-set(MOD_SRC
-	${SRC_DIR}/circbuf.c
-	${SRC_DIR}/strlib.c
+# check target
+set(TEST_BIN test-utils)
+file(GLOB TEST_SRC ${CMAKE_SOURCE_DIR}/test/*.c)
+add_executable(${TEST_BIN} ${TEST_SRC})
+target_link_libraries(${TEST_BIN} ${LIB_UTILS})
+add_custom_target(check
+	COMMAND ${CMAKE_BINARY_DIR}/bin/${TEST_BIN}
+	COMMAND rm ${CMAKE_BINARY_DIR}/bin/${TEST_BIN}
+	DEPENDS ${TEST_BIN}
 )
-
-set(TEST_SRC
-	${TEST_DIR}/test.c
-	${TEST_DIR}/test-circbuf.c
-	${TEST_DIR}/test-strlib.c
-)
-
-add_executable(test_cutils ${TEST_SRC} ${MOD_SRC})
-

CMakeLists.txt

@@ -1,5 +1,5 @@
 # c-utils
-[![Build Status](https://travis-ci.com/EmbedJournal/c-utils.svg?branch=master)](https://travis-ci.com/EmbedJournal/c-utils)
+[![Build CI][1]][2]
 
 This repository hosts some modular, drop-in, C utilities that you can copy into
 your project and and kick-start your work.
@@ -8,8 +8,7 @@ your project and and kick-start your work.
 
 The following methods/utils are available in this repo:
 
-* Circular Buffers - A data-type agnostic circular buffer implementation read
-  more [here][1].
+* Circular Buffers - A data-type agnostic circular buffer implementation read more [here][3].
 * Hexdump - A `hexdump -c` output equivalent method to inspect buffers.
 * String Library - A string library for some common use cases where pasing
   char pointer, and length around looks ugly.
@@ -19,5 +18,6 @@ The following methods/utils are available in this repo:
 You can clone this repo and copy individual files from src/ and link it to your
 project.
 
-[1]: https://embedjournal.com/implementing-circular-buffer-embedded-c/
-
+[1]: https://github.com/embedjournal/c-utils/workflows/Build%20CI/badge.svg
+[2]: https://github.com/embedjournal/c-utils/actions?query=workflow%3A%22Build+CI%22
+[3]: https://embedjournal.com/implementing-circular-buffer-embedded-c/

README.md

@@ -0,0 +1,43 @@
+/*
+ * Copyright (c) 2019 Siddharth Chandrasekaran <siddharth@embedjournal.com>
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ */
+
+#ifndef _SERIAL_H_
+#define _SERIAL_H_
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <termios.h>
+
+struct serial {
+	int fd;
+	struct termios new_termios;
+	struct termios old_termios;
+};
+
+struct serial *serial_open(const char *device, int baud, const char *mode);
+void serial_close(struct serial *ctx);
+int serial_read(struct serial *ctx, unsigned char *buf, int size);
+int serial_write(struct serial *ctx, unsigned char *buf, int size);
+void serial_flush_rx(struct serial *ctx);
+void serial_flush_tx(struct serial *ctx);
+void serial_flush(struct serial *ctx);
+
+/* line control methods */
+int serial_get_dcd(struct serial *ctx);
+int serial_get_rng(struct serial *ctx);
+int serial_get_cts(struct serial *ctx);
+int serial_get_dsr(struct serial *ctx);
+void serial_assert_dtr(struct serial *ctx, int state);
+void serial_assert_rts(struct serial *ctx, int state);
+
+#ifdef __cplusplus
+} /* extern "C" */
+#endif
+
+#endif /* _SERIAL_H_ */

src/arg_parser.h include/utils/arg_parser.h

@@ -10,7 +10,7 @@
 #include <string.h>
 #include <unistd.h>
 
-#include "arg_parser.h"
+#include <utils/arg_parser.h>
 
 #define is_lower_alpha(x) (x >= 97 && x <= 122)
 

src/circbuf.h include/utils/circbuf.h

@@ -6,7 +6,7 @@
 
 #include <string.h>
 
-#include "circbuf.h"
+#include <utils/circbuf.h>
 
 int __circ_gbuf_pop(circ_gbuf_t *circ_buf, void *elem, int read_only)
 {

src/hexdump.h include/utils/hexdump.h

@@ -6,13 +6,16 @@
 
 #include <stdio.h>
 #include <stdint.h>
+#include <ctype.h>
+
+#include <utils/hexdump.h>
 
 void hexdump(const char *head, const uint8_t *data, size_t len)
 {
 	int i;
 	char str[16];
 
-	printf("%s [%d] =>\n    0000  %02x ", head, len, data[0]);
+	printf("%s [%zu] =>\n    0000  %02x ", head, len, data[0]);
 	str[0] = isprint(data[0]) ? data[0] : '.';
 	for (i = 1; i < len; i++) {
 		if ((i & 0x0f) == 0) {

src/procutils.h include/utils/procutils.h

@@ -9,7 +9,7 @@
 #include <unistd.h>
 #include <fcntl.h>
 
-#include "procutils.h"
+#include <utils/procutils.h>
 
 int read_pid(const char *file, int *pid)
 {

include/utils/serial.h

@@ -0,0 +1,301 @@
+/*
+ * Copyright (c) 2019 Siddharth Chandrasekaran <siddharth@embedjournal.com>
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ */
+
+/**
+ * Note:
+ *   This code is based on Teunis van Beelen's implementation. Its API and coding
+ *   style needed a lot of work before consumption and hence warrented a full
+ *   rewrite. His implementation can be found at https://www.teuniz.net/RS-232/
+ *
+ *   A good explanation can be found at https://www.cmrr.umn.edu/~strupp/serial.html
+ */
+
+
+#include <stdio.h>
+#include <string.h>
+#include <stdlib.h>
+
+#include <termios.h>
+#include <sys/ioctl.h>
+#include <unistd.h>
+#include <fcntl.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <limits.h>
+#include <sys/file.h>
+#include <errno.h>
+
+#include <utils/serial.h>
+
+struct serial *serial_open(const char *device, int baud, const char *mode)
+{
+	int status, tmp;
+	int flow_control = 0, cflags = 0, ignore_parity = 0;
+	struct serial *ctx;
+
+	switch (baud) {
+	case 50:	baud = B50; break;
+	case 75:	baud = B75; break;
+	case 110:	baud = B110; break;
+	case 134:	baud = B134; break;
+	case 150:	baud = B150; break;
+	case 200:	baud = B200; break;
+	case 300:	baud = B300; break;
+	case 600:	baud = B600; break;
+	case 1200:	baud = B1200; break;
+	case 1800:	baud = B1800; break;
+	case 2400:	baud = B2400; break;
+	case 4800:	baud = B4800; break;
+	case 9600:	baud = B9600; break;
+	case 19200:	baud = B19200; break;
+	case 38400:	baud = B38400; break;
+	case 57600:	baud = B57600; break;
+	case 115200:	baud = B115200; break;
+	case 230400:	baud = B230400; break;
+	default:
+		printf("invalid baudrate\n");
+		return NULL;
+	}
+
+	tmp = strlen(mode);
+	if (tmp < 3 || tmp > 4) {
+		printf("invalid mode \"%s\"\n", mode);
+		return NULL;
+	}
+
+	if (tmp == 4 && (mode[3] == 'F' || mode[3] == 'f'))
+		flow_control = 1;
+
+	switch (mode[0]) {
+	case '8': cflags |= CS8; break;
+	case '7': cflags |= CS7; break;
+	case '6': cflags |= CS6; break;
+	case '5': cflags |= CS5; break;
+	default:
+		printf("invalid number of data-bits '%c'\n", mode[0]);
+		return  NULL;
+	}
+
+	if (mode[1] == 'N' || mode[1] == 'n') { /* no parity */
+		cflags |= IGNPAR;
+		ignore_parity = 1;
+	} else { /* has parity */
+		cflags |= PARENB;
+		if (mode[1] == 'O' || mode[1] == 'o')
+			cflags |= PARODD;
+	}
+
+	if (mode[2] == '2') {
+		cflags |= CSTOPB;
+	}
+
+	ctx = calloc(1, sizeof(struct serial));
+	if (ctx == NULL) {
+		printf("failed to alloc struct serial_port\n");
+		return NULL;
+	}
+
+	ctx->fd = open(device, O_RDWR | O_NOCTTY | O_NDELAY);
+	if (ctx->fd == -1) {
+		perror("unable to open comport");
+		goto error;
+	}
+
+	if (flock(ctx->fd, LOCK_EX | LOCK_NB) != 0) {
+		close(ctx->fd);
+		perror("another process has locked the comport");
+		goto error;
+	}
+
+	if (tcgetattr(ctx->fd, &ctx->old_termios) == -1) {
+		close(ctx->fd);
+		perror("unable to read portsettings");
+		goto error;
+	}
+
+	ctx->new_termios.c_cflag = cflags | CLOCAL | CREAD;
+	if (flow_control)
+		ctx->new_termios.c_cflag |= CRTSCTS;
+	ctx->new_termios.c_iflag = ignore_parity ? IGNPAR : INPCK;
+	ctx->new_termios.c_oflag = 0;
+	ctx->new_termios.c_lflag = 0;
+
+	/* block until n bytes are received */
+	ctx->new_termios.c_cc[VMIN] = 0;
+
+	/* block until a timer expires (n * 100 mSec.) */
+	ctx->new_termios.c_cc[VTIME] = 0;
+
+	cfsetispeed(&ctx->new_termios, baud);
+	cfsetospeed(&ctx->new_termios, baud);
+
+	if (tcsetattr(ctx->fd, TCSANOW, &ctx->new_termios) == -1) {
+		tcsetattr(ctx->fd, TCSANOW, &ctx->old_termios);
+		close(ctx->fd);
+		perror("unable to adjust portsettings");
+		goto error;
+	}
+
+	if (ioctl(ctx->fd, TIOCMGET, &status) == -1) {
+		tcsetattr(ctx->fd, TCSANOW, &ctx->old_termios);
+		perror("unable to get portstatus");
+		goto error;
+	}
+
+	status |= TIOCM_DTR; /* turn on DTR */
+	status |= TIOCM_RTS; /* turn on RTS */
+
+	if (ioctl(ctx->fd, TIOCMSET, &status) == -1) {
+		tcsetattr(ctx->fd, TCSANOW, &ctx->old_termios);
+		perror("unable to set portstatus");
+		goto error;
+	}
+
+	return ctx;
+
+error:
+	if (ctx->fd != 0 && ctx->fd != -1)
+		flock(ctx->fd, LOCK_UN);
+	free(ctx);
+	return NULL;
+}
+
+void serial_close(struct serial *ctx)
+{
+	int status;
+
+	if (ctx == NULL)
+		return;
+
+	if (ioctl(ctx->fd, TIOCMGET, &status) == -1) {
+		perror("unable to get portstatus");
+	}
+
+	status &= ~TIOCM_DTR; /* turn off DTR */
+	status &= ~TIOCM_RTS; /* turn off RTS */
+
+	if (ioctl(ctx->fd, TIOCMSET, &status) == -1) {
+		perror("unable to set portstatus");
+	}
+
+	tcsetattr(ctx->fd, TCSANOW, &ctx->old_termios);
+	close(ctx->fd);
+	flock(ctx->fd, LOCK_UN);
+
+	free(ctx);
+}
+
+int serial_read(struct serial *ctx, unsigned char *buf, int size)
+{
+	int n;
+
+	n = read(ctx->fd, buf, size);
+	if (n < 0) {
+		if (errno == EAGAIN)
+			return 0;
+	}
+	return n;
+}
+
+int serial_write(struct serial *ctx, unsigned char *buf, int size)
+{
+	int n;
+
+	n = write(ctx->fd, buf, size);
+	if (n < 0) {
+		if (errno == EAGAIN)
+			return 0;
+	}
+	return n;
+}
+
+void serial_flush_rx(struct serial *ctx)
+{
+	tcflush(ctx->fd, TCIFLUSH);
+}
+
+void serial_flush_tx(struct serial *ctx)
+{
+	tcflush(ctx->fd, TCOFLUSH);
+}
+
+void serial_flush(struct serial *ctx)
+{
+	tcflush(ctx->fd, TCIOFLUSH);
+}
+
+int serial_get_dcd(struct serial *ctx)
+{
+	int status;
+
+	ioctl(ctx->fd, TIOCMGET, &status);
+
+	return (status & TIOCM_CAR) ? 1 : 0;
+}
+
+int serial_get_rng(struct serial *ctx)
+{
+	int status;
+
+	ioctl(ctx->fd, TIOCMGET, &status);
+
+	return (status & TIOCM_RNG) ? 1 : 0;
+}
+
+int serial_get_cts(struct serial *ctx)
+{
+	int status;
+
+	ioctl(ctx->fd, TIOCMGET, &status);
+
+	return (status & TIOCM_CTS) ? 1 : 0;
+}
+
+int serial_get_dsr(struct serial *ctx)
+{
+	int status;
+
+	ioctl(ctx->fd, TIOCMGET, &status);
+
+	return (status & TIOCM_DSR) ? 1 : 0;
+}
+
+void serial_assert_dtr(struct serial *ctx, int state)
+{
+	int status;
+
+	if (ioctl(ctx->fd, TIOCMGET, &status) == -1) {
+		perror("unable to get portstatus");
+	}
+
+	if (state)
+		status |= TIOCM_DTR; /* turn on RTS */
+	else
+		status &= ~TIOCM_DTR; /* turn off RTS */
+
+	if (ioctl(ctx->fd, TIOCMSET, &status) == -1) {
+		perror("unable to set portstatus");
+	}
+}
+
+void serial_assert_rts(struct serial *ctx, int state)
+{
+	int status;
+
+	if (ioctl(ctx->fd, TIOCMGET, &status) == -1) {
+		perror("unable to get portstatus");
+	}
+
+	if (state)
+		status |= TIOCM_RTS; /* turn on RTS */
+	else
+		status &= ~TIOCM_RTS; /* turn off RTS */
+
+	if (ioctl(ctx->fd, TIOCMSET, &status) == -1) {
+		perror("unable to set portstatus");
+	}
+}

src/strlib.h include/utils/strlib.h

@@ -7,7 +7,8 @@
 #include <stdio.h>
 #include <stdarg.h>
 #include <string.h>
-#include "strlib.h"
+
+#include <utils/strlib.h>
 
 int str_printf(string_t *s, const char *mode, const char *fmt, ...)
 {

src/strutils.h include/utils/strutils.h

@@ -4,7 +4,9 @@
  * SPDX-License-Identifier: MIT
  */
 
-#include "strutils.h"
+#include <stdlib.h>
+
+#include <utils/strutils.h>
 
 static inline int hex2int(char ch)
 {

src/arg_parser.c

@@ -2,8 +2,9 @@
 #include <stdlib.h>
 #include <time.h>
 
+#include <utils/circbuf.h>
+
 #include "test.h"
-#include "circbuf.h"
 
 struct test_struct {
     int a;
@@ -99,6 +100,6 @@ void do_test_circular_buffer(test_result_t *result)
     if (test_boundary() == 0) pass++; total++;
     if (test_probabilistic() == 0) pass++; total++;
 
-    result->pass += pass;
-    result->total += total;
+    result->pass = pass;
+    result->total = total;
 }

src/circbuf.c

@@ -1,15 +1,17 @@
 #include <stdio.h>
 #include <stdlib.h>
 #include <time.h>
+#include <string.h>
+
+#include <utils/strlib.h>
 
 #include "test.h"
-#include "strlib.h"
 
 GLOBAL_STRING_DEF(test_str, 8);
 
-int test_print_info_string(const char *msg, string_t *s)
+void test_print_info_string(const char *msg, string_t *s)
 {
-	printf("\t[%s] s->len: %d s->max_len: %d s->buf: %s\n",
+	printf("\t[%s] s->len: %zu s->max_len: %zu s->buf: %s\n",
 		msg, s->len, s->max_len, s->buf);
 }
 
@@ -86,6 +88,6 @@ void do_test_strlib(test_result_t *result)
 	if (test_str_copy() == 0) pass++; total++;
 	if (test_str_printf() == 0) pass++; total++;
 
-	result->pass += pass;
-	result->total += total;
+	result->pass = pass;
+	result->total = total;
 }

src/hexdump.c

@@ -25,7 +25,7 @@ void test_execute(test_t *t, test_module_t *tm)
     printf("Testing '%s'\n", tm->name);
     tm->runner(&result);
     mod_printf("Result: name:'%s' total:%d pass:%d\n",
-            tm->name, result.total, result.pass);
+               tm->name, result.total, result.pass);
     t->pass += result.pass;
     t->total += result.total;
 }
@@ -36,7 +36,7 @@ char *time_string(time_t *t)
     return date_time;
 }
 
-int main(char *argc, char *argv[])
+int main(int argc, char *argv[])
 {
     int i=0, total_pass, total_exec;
     time_t start_time, end_time;