uart.h

Go to the documentation of this file.

/*
 * KubOS HAL
 * Copyright (C) 2016 Kubos Corporation
 *
 * 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.
 */
#if (defined YOTTA_CFG_HARDWARE_UART) && (YOTTA_CFG_HARDWARE_UART_COUNT > 0)
#ifndef K_UART_H
#define K_UART_H

#include <csp/arch/csp_queue.h>
#include <stdint.h>

#include "pins.h"

#ifndef K_NUM_UARTS
#define K_NUM_UARTS YOTTA_CFG_HARDWARE_UART_COUNT
#endif

#ifndef K_UART_CONSOLE
#define K_UART_CONSOLE YOTTA_CFG_HARDWARE_CONSOLE_UART
#endif

#ifndef K_UART_CONSOLE_BAUDRATE
#define K_UART_CONSOLE_BAUDRATE YOTTA_CFG_HARDWARE_CONSOLE_BAUDRATE
#endif

typedef enum {
    // @warning - need to add K_UART_NO_BUS
#ifdef YOTTA_CFG_HARDWARE_UART_UART1
    K_UART1 = 0,
#endif
#ifdef YOTTA_CFG_HARDWARE_UART_UART2
    K_UART2,
#endif
#ifdef YOTTA_CFG_HARDWARE_UART_UART3
    K_UART3,
#endif
#ifdef YOTTA_CFG_HARDWARE_UART_UART4
    K_UART4,
#endif
#ifdef YOTTA_CFG_HARDWARE_UART_UART5
    K_UART5,
#endif
#ifdef YOTTA_CFG_HARDWARE_UART_UART6
    K_UART6
#endif
} KUARTNum;

typedef enum {
    K_WORD_LEN_7BIT = 0,
    K_WORD_LEN_8BIT,
    K_WORD_LEN_9BIT
} KWordLen;

typedef enum {
    K_STOP_BITS_1 = 0,
    K_STOP_BITS_2
} KStopBits;

typedef enum {
    K_PARITY_NONE = 0,
    K_PARITY_EVEN,
    K_PARITY_ODD
} KParity;

typedef enum {
    UART_OK,
    UART_ERROR,
    UART_ERROR_NULL_HANDLE,
    UART_ERROR_CONFIG
} KUARTStatus;

typedef struct {
    const char *dev_path;
    uint32_t baud_rate;
    KWordLen word_len;
    KStopBits stop_bits;
    KParity parity;
    uint8_t rx_queue_len;
    uint8_t tx_queue_len;
} KUARTConf;

typedef struct {
    int dev;
    KUARTConf conf;
    csp_queue_handle_t rx_queue;
    csp_queue_handle_t tx_queue;
} KUART;

KUARTConf k_uart_conf_defaults(void);

KUARTStatus k_uart_init(KUARTNum uart, KUARTConf *conf);


void k_uart_terminate(KUARTNum uart);

void k_uart_console_init(void);

int k_uart_read(KUARTNum uart, char *ptr, int len);

int k_uart_write(KUARTNum uart, char *ptr, int len);

KUARTStatus k_uart_write_immediate(KUARTNum uart, char c);

KUARTStatus k_uart_write_immediate_str(KUARTNum uart, uint8_t * ptr, uint8_t len);

int k_uart_rx_queue_len(KUARTNum uart);

void k_uart_rx_queue_push(KUARTNum uart, char c, void *task_woken);

int k_uart_rx_pin(KUARTNum uart);

int k_uart_tx_pin(KUARTNum uart);

// private APIs
KUART* kprv_uart_get(KUARTNum uart);

KUARTStatus kprv_uart_dev_init(KUARTNum uart);

void kprv_uart_dev_terminate(KUARTNum uart);

void kprv_uart_enable_tx_int(KUARTNum uart);
#endif // #ifndef K_UART_H
#endif // #ifdef YOTTA_CFG_HARDWARE_UART && YOTTA_CFG_HARDE_UART_COUNT > 0
/* @} */