hal_serial.h

Go to the documentation of this file.

/*
 *  hal_serial.h
 *
 *  Copyright 2013-2021 Michael Zillgith
 *
 *  This file is part of Platform Abstraction Layer (libpal)
 *  for libiec61850, libmms, and lib60870.
 */
 
#ifndef SRC_IEC60870_LINK_LAYER_SERIAL_PORT_H_
#define SRC_IEC60870_LINK_LAYER_SERIAL_PORT_H_
 
#include "hal_base.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct sSerialPort* SerialPort;
 
typedef enum {
    SERIAL_PORT_ERROR_NONE = 0,
    SERIAL_PORT_ERROR_INVALID_ARGUMENT = 1,
    SERIAL_PORT_ERROR_INVALID_BAUDRATE = 2,
    SERIAL_PORT_ERROR_OPEN_FAILED = 3,
    SERIAL_PORT_ERROR_UNKNOWN = 99
} SerialPortError;
 
PAL_API SerialPort
SerialPort_create(const char* interfaceName, int baudRate, uint8_t dataBits, char parity, uint8_t stopBits);
 
PAL_API void
SerialPort_destroy(SerialPort self);
 
PAL_API bool
SerialPort_open(SerialPort self);
 
PAL_API void
SerialPort_close(SerialPort self);
 
PAL_API int
SerialPort_getBaudRate(SerialPort self);
 
PAL_API void
SerialPort_setTimeout(SerialPort self, int timeout);
 
PAL_API void
SerialPort_discardInBuffer(SerialPort self);
 
PAL_API int
SerialPort_readByte(SerialPort self);
 
PAL_API int
SerialPort_write(SerialPort self, uint8_t* buffer, int startPos, int numberOfBytes);
 
PAL_API SerialPortError
SerialPort_getLastError(SerialPort self);
 
#ifdef __cplusplus
}
#endif
 
 
#endif /* SRC_IEC60870_LINK_LAYER_SERIAL_PORT_H_ */