sol-uart.h

Go to the documentation of this file.

/*
 * This file is part of the Soletta (TM) Project
 *
 * Copyright (C) 2015 Intel Corporation. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#pragma once

#include <stdbool.h>
#include <stdint.h>

#include <sol-types.h>
#include <sol-buffer.h>
#include <sol-common-buildopts.h>
#include <sol-macros.h>

#ifdef __cplusplus
extern "C" {
#endif

struct sol_uart;
typedef struct sol_uart sol_uart;

enum sol_uart_baud_rate {
    SOL_UART_BAUD_RATE_9600 = 0,
    SOL_UART_BAUD_RATE_19200,
    SOL_UART_BAUD_RATE_38400,
    SOL_UART_BAUD_RATE_57600,
    SOL_UART_BAUD_RATE_115200
};

enum sol_uart_data_bits {
    SOL_UART_DATA_BITS_8 = 0, 
    SOL_UART_DATA_BITS_7, 
    SOL_UART_DATA_BITS_6, 
    SOL_UART_DATA_BITS_5 
};

enum sol_uart_parity {
    SOL_UART_PARITY_NONE = 0, 
    SOL_UART_PARITY_EVEN, 
    SOL_UART_PARITY_ODD 
};

enum sol_uart_stop_bits {
    SOL_UART_STOP_BITS_ONE = 0, 
    SOL_UART_STOP_BITS_TWO 
};

typedef struct sol_uart_config {
#ifndef SOL_NO_API_VERSION
#define SOL_UART_CONFIG_API_VERSION (1) 
    uint16_t api_version; 
#endif

    ssize_t (*on_data)(void *data, struct sol_uart *uart, const struct sol_buffer *buf);
    void (*on_feed_done)(void *data, struct sol_uart *uart, struct sol_blob *blob, int status);
    const void *user_data; 
    size_t feed_size;
    size_t data_buffer_size;
    enum sol_uart_baud_rate baud_rate; 
    enum sol_uart_data_bits data_bits; 
    enum sol_uart_parity parity; 
    enum sol_uart_stop_bits stop_bits; 
    bool flow_control; 
} sol_uart_config;

enum sol_uart_baud_rate sol_uart_baud_rate_from_str(const char *baud_rate)
#ifndef DOXYGEN_RUN
    SOL_ATTR_WARN_UNUSED_RESULT
#endif
    ;

const char *sol_uart_baud_rate_to_str(enum sol_uart_baud_rate baud_rate)
#ifndef DOXYGEN_RUN
    SOL_ATTR_WARN_UNUSED_RESULT
#endif
    ;

enum sol_uart_data_bits sol_uart_data_bits_from_str(const char *data_bits)
#ifndef DOXYGEN_RUN
    SOL_ATTR_WARN_UNUSED_RESULT
#endif
    ;

const char *sol_uart_data_bits_to_str(enum sol_uart_data_bits data_bits)
#ifndef DOXYGEN_RUN
    SOL_ATTR_WARN_UNUSED_RESULT
#endif
    ;

enum sol_uart_parity sol_uart_parity_from_str(const char *parity)
#ifndef DOXYGEN_RUN
    SOL_ATTR_WARN_UNUSED_RESULT
#endif
    ;

const char *sol_uart_parity_to_str(enum sol_uart_parity parity)
#ifndef DOXYGEN_RUN
    SOL_ATTR_WARN_UNUSED_RESULT
#endif
    ;

enum sol_uart_stop_bits sol_uart_stop_bits_from_str(const char *stop_bits)
#ifndef DOXYGEN_RUN
    SOL_ATTR_WARN_UNUSED_RESULT
#endif
    ;

const char *sol_uart_stop_bits_to_str(enum sol_uart_stop_bits stop_bits)
#ifndef DOXYGEN_RUN
    SOL_ATTR_WARN_UNUSED_RESULT
#endif
    ;

struct sol_uart *sol_uart_open(const char *port_name, const struct sol_uart_config *config);

void sol_uart_close(struct sol_uart *uart);

int sol_uart_feed(struct sol_uart *uart, struct sol_blob *blob);

#ifdef __cplusplus
}
#endif