zwapi_serial.c File Reference

#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <errno.h>
#include <unistd.h>
#include <fcntl.h>
#include <termios.h>
#include <sys/ioctl.h>
#include <sys/file.h>
#include <assert.h>
#include <limits.h>
#include <time.h>
#include <sys/time.h>
#include "zwapi_serial.h"
#include "sl_log.h"

Include dependency graph for zwapi_serial.c:

Macros
#define	LOG_TAG   "zwapi_serial"
#define	SERIAL_LOG

Functions
static bool	zwapi_serial_timeval_a_lt_b_milis (const struct timeval *a, const struct timeval *b, unsigned int ms)
	Test if a is less than b + ms. More...
static int	zwapi_open_serial_port (const char *serial_device_path)
int	zwapi_serial_init (const char *port)
	Initialize the serial port to 115200 BAUD 8N1. More...
static void	zwapi_serial_log_timestamp (const struct timeval *cur_time)
sl_status_t	zwapi_serial_log_to_file_enable (const char *filename)
	Enable logging of serial data to a file. More...
sl_status_t	zwapi_serial_log_to_file_disable ()
	Disable/stop logging serial data to file. More...
void	zwapi_serial_close (void)
	De-Initialize the serial port. More...
int	zwapi_serial_restart (void)
	Closes and re-initialize the last open serial port. More...
int	zwapi_serial_get_byte (uint8_t *c)
	Reads a byte from the serial port device. More...
void	zwapi_serial_put_byte (uint8_t c)
	Write a byte to serial port device. More...
int	zwapi_serial_get_buffer (uint8_t *c, int len)
	Reads the output of the serial port device and stores the content in a buffer. More...
void	zwapi_serial_put_buffer (uint8_t *c, int len)
	Writes the content of a buffer to the serial port device. More...
bool	zwapi_serial_is_file_available (void)
	Check the file descriptor for the serial device is available for I/O operations. More...
void	zwapi_serial_drain_buffer (void)
	Flush the serial output if using buffered output. More...

Variables
static int	serial_fd
FILE *	log_fd = NULL
static int	log_dir = 0
struct timeval	last_time
static char	last_used_serial_port [PATH_MAX] = {0}

Macro Definition Documentation

LOG_TAG

#define LOG_TAG   "zwapi_serial"

SERIAL_LOG

#define SERIAL_LOG

Function Documentation

zwapi_open_serial_port()

static int zwapi_open_serial_port ( const char *  serial_device_path )

static

Open a serial device and configure it. Returns the file descriptor associated to the device.

Here is the caller graph for this function:

zwapi_serial_close()

void zwapi_serial_close

(

void

)

De-Initialize the serial port.

aka SerialClose

Here is the caller graph for this function:

zwapi_serial_drain_buffer()

void zwapi_serial_drain_buffer

(

void

)

Flush the serial output if using buffered output.

This function calls tcdrain, which waits that the TTY buffer data has been written to the hardware.

aka SerialFlush

Here is the caller graph for this function:

zwapi_serial_get_buffer()

int zwapi_serial_get_buffer	(	uint8_t *	c,
		int	len
	)

Reads the output of the serial port device and stores the content in a buffer.

Parameters

c	buffer to store data from serial port to.
len	length of buffer.

Returns

The length of the data copied in the buffer.

aka SerialGetBuffer

Here is the call graph for this function:

Here is the caller graph for this function:

zwapi_serial_get_byte()

int zwapi_serial_get_byte

(

uint8_t *

c

)

Reads a byte from the serial port device.

Parameters

c	char to store data from serial port to.

Returns

0 if no characters are available, otherwise this returns 1 (length of the read data)

aka SerialGetByte

Here is the call graph for this function:

Here is the caller graph for this function:

zwapi_serial_init()

int zwapi_serial_init

(

const char *

serial_port

)

Initialize the serial port to 115200 BAUD 8N1.

Returns

the file descriptor for the serial device.

aka SerialInit

Here is the call graph for this function:

Here is the caller graph for this function:

zwapi_serial_is_file_available()

bool zwapi_serial_is_file_available

(

void

)

Check the file descriptor for the serial device is available for I/O operations.

Returns

true if the file is available, false if not or if an error occurred.

aka SerialCheck

Here is the caller graph for this function:

zwapi_serial_log_timestamp()

static void zwapi_serial_log_timestamp ( const struct timeval *  cur_time )

static

Here is the caller graph for this function:

zwapi_serial_log_to_file_disable()

sl_status_t zwapi_serial_log_to_file_disable

(

)

Disable/stop logging serial data to file.

This will stop the logging of serial data to file.

Returns

SL_STATUS_OK on success

Here is the caller graph for this function:

zwapi_serial_log_to_file_enable()

sl_status_t zwapi_serial_log_to_file_enable

(

const char *

filename

)

Enable logging of serial data to a file.

The log will append to the file, it is up to the user to handle log rotation, free disk space monitoring etc.

Parameters

filename

file to log serial trace to, log will append to this file.

Returns

SL_STATUS_OK on success.

SL_STATUS_ALREADY_INITIALIZED if log to file is already enabled.

SL_STATUS_FAIL if other failure (e.g. folder doesn't exist, lacking permissions, etc.).

Here is the call graph for this function:

Here is the caller graph for this function:

zwapi_serial_put_buffer()

void zwapi_serial_put_buffer	(	uint8_t *	c,
		int	len
	)

Writes the content of a buffer to the serial port device.

Parameters

c	buffer with data to write to serial port.
len	length of data in buffer.

aka SerialPutBuffer

Here is the call graph for this function:

Here is the caller graph for this function:

zwapi_serial_put_byte()

void zwapi_serial_put_byte

(

uint8_t

c

)

Write a byte to serial port device.

aka SerialPutByte

Here is the call graph for this function:

Here is the caller graph for this function:

zwapi_serial_restart()

int zwapi_serial_restart

(

void

)

Closes and re-initialize the last open serial port.

Returns

the file descriptor for the serial device.

aka SerialRestart

Here is the call graph for this function:

Here is the caller graph for this function:

zwapi_serial_timeval_a_lt_b_milis()

static bool zwapi_serial_timeval_a_lt_b_milis ( const struct timeval *  a, const struct timeval *  b, unsigned int  ms  )

static

Test if a is less than b + ms.

Testing this: a < (b + ms)

Parameters

a	timeval pointer to a value
b	timeval pointer to b value
ms	time in ms to add to b

Returns

true if a is lesser than b + ms

false if a is greater or equal to b + ms

Here is the caller graph for this function:

Variable Documentation

last_time

struct timeval last_time

last_used_serial_port

char last_used_serial_port[PATH_MAX] = {0}

static

log_dir

int log_dir = 0

static

log_fd

FILE* log_fd = NULL

serial_fd

int serial_fd

static