uart.h

Go to the documentation of this file.

/*
 * Author: Thomas Ingleby <thomas.c.ingleby@intel.com>
 * Contributions: Jon Trulson <jtrulson@ics.com>
 *                Brendan Le Foll <brendan.le.foll@intel.com>
 * Copyright (c) 2014 - 2015 Intel Corporation
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#pragma once

#ifdef __cplusplus
extern "C" {
#endif

#include <stdio.h>

#include "common.h"

typedef struct _uart* mraa_uart_context;

mraa_uart_context mraa_uart_init(int uart);

mraa_uart_context mraa_uart_init_raw(const char* path);

mraa_result_t mraa_uart_flush(mraa_uart_context dev);

mraa_result_t mraa_uart_sendbreak(mraa_uart_context dev, int duration);

mraa_result_t mraa_uart_set_baudrate(mraa_uart_context dev, unsigned int baud);

mraa_result_t mraa_uart_set_mode(mraa_uart_context dev, int bytesize, mraa_uart_parity_t parity, int stopbits);

mraa_result_t mraa_uart_set_flowcontrol(mraa_uart_context dev, mraa_boolean_t xonxoff, mraa_boolean_t rtscts);

mraa_result_t mraa_uart_set_timeout(mraa_uart_context dev, int read, int write, int interchar);

mraa_result_t mraa_uart_set_non_blocking(mraa_uart_context dev, mraa_boolean_t nonblock);

const char* mraa_uart_get_dev_path(mraa_uart_context dev);

mraa_result_t
mraa_uart_settings(int index,
    const char **devpath,
    const char **name,
    int* baudrate,
    int* databits,
    int* stopbits,
    mraa_uart_parity_t* parity,
    unsigned int* rtscts,
    unsigned int* xonxoff);

mraa_result_t mraa_uart_stop(mraa_uart_context dev);

int mraa_uart_read(mraa_uart_context dev, char* buf, size_t length);

int mraa_uart_write(mraa_uart_context dev, const char* buf, size_t length);

mraa_boolean_t mraa_uart_data_available(mraa_uart_context dev, unsigned int millis);

#ifdef __cplusplus
}
#endif