serial.h

Go to the documentation of this file.

#pragma once
 
/* ************************************************************************** */
/*      ____    _    _____ ____     _    _   _   _____ _  _   ____  ____      */
/*     / ___|  / \  |  ___|  _ \   / \  | \ | | |_   _| || | |  _ \/ ___|     */
/*     \___ \ / _ \ | |_  | |_) | / _ \ |  \| |   | | | || |_| | | \___ \     */
/*      ___) / ___ \|  _| |  _ < / ___ \| |\  |   | | |__   _| |_| |___) |    */
/*     |____/_/   \_|_|   |_| \_/_/   \_|_| \_|   |_|    |_| |____/|____/     */
/*                                                                            */
/* ************************************************************************** */
 
#include "o2s/file_input_stream.h"
#include "o2s/serial_options.h"
 
#include <stdbool.h>
#include <stdint.h>    // uint*_t

typedef struct serial_port serial_port_t;

struct serial_port
{
    ifstream_t       file;           
    serial_options_t options;        
    bool             got_options;    
};

serial_port_t  serial_open_readonly(const char* port_name);
serial_port_t  serial_open_readwrite(const char* port_name);
void           serial_close(serial_port_t* port);
serial_port_t* serial_new_readwrite(const char* port_name);
void           serial_free(serial_port_t** port);

bool          serial_get_options(serial_port_t* port);
bool          serial_apply_options(serial_port_t* port);
 
bool          serial_set_options_raw(serial_port_t* port);
bool          serial_set_options_speed(serial_port_t* port, int64_t speed_bps);
bool          serial_make_raw(serial_port_t* port, int64_t speed_bps);

int64_t       serial_decode_baudrate(speed_t flag);
speed_t       serial_encode_baudrate(int64_t speed_in_bps);

#define Serial __attribute__((cleanup(serial_close))) serial_port_t