From 23304fb6c4e4bf34fdb6b73820f8acd844662e3b Mon Sep 17 00:00:00 2001 From: Thomas Ingleby Date: Thu, 10 Jul 2014 00:55:50 +0100 Subject: [PATCH] uart: barebones uart module added. * Only defined call is the init. Will then expose the uart from * the multiplexors. Signed-off-by: Thomas Ingleby --- api/mraa.h | 1 + api/mraa/common.h | 19 +++++++++++++- api/mraa/uart.h | 57 +++++++++++++++++++++++++++++++++++++++++ include/mraa_internal.h | 7 +++++ src/CMakeLists.txt | 1 + src/mraa.c | 29 +++++++++++++++++++++ src/uart/uart.c | 54 ++++++++++++++++++++++++++++++++++++++ 7 files changed, 167 insertions(+), 1 deletion(-) create mode 100644 api/mraa/uart.h create mode 100644 src/uart/uart.c diff --git a/api/mraa.h b/api/mraa.h index 175da12..b3b0d59 100644 --- a/api/mraa.h +++ b/api/mraa.h @@ -32,6 +32,7 @@ extern "C" { #include "mraa/gpio.h" #include "mraa/spi.h" #include "mraa/i2c.h" +#include "mraa/uart.h" #ifdef __cplusplus } diff --git a/api/mraa/common.h b/api/mraa/common.h index ba81339..7254945 100644 --- a/api/mraa/common.h +++ b/api/mraa/common.h @@ -51,7 +51,8 @@ typedef enum { MRAA_PIN_FAST_GPIO = 3, /**< Faster GPIO */ MRAA_PIN_SPI = 4, /**< SPI */ MRAA_PIN_I2C = 5, /**< I2C */ - MRAA_PIN_AIO = 6 /**< Analog in */ + MRAA_PIN_AIO = 6, /**< Analog in */ + MRAA_PIN_UART = 7 /**< UART */ } mraa_pinmodes_t; /** @@ -66,6 +67,7 @@ typedef struct { mraa_boolean_t spi:1; /**< Is the pin spi capable */ mraa_boolean_t i2c:1; /**< Is the pin i2c capable */ mraa_boolean_t aio:1; /**< Is the pin analog input capable */ + mraa_boolean_t uart:1; /**< Is the pin uart capable */ /*@}*/ } mraa_pincapabilities_t; @@ -121,6 +123,7 @@ typedef struct { mraa_mmap_pin_t mmap; /**< GPIO through memory */ mraa_pin_t i2c; /**< i2c bus/pin */ mraa_pin_t spi; /**< spi bus/pin */ + mraa_pin_t uart; /**< uart module/pin */ /*@}*/ } mraa_pininfo_t; @@ -150,6 +153,17 @@ typedef struct { /*@}*/ } mraa_spi_bus_t; +/** + * A Structure representing a uart device. + */ +typedef struct { + /*@{*/ + unsigned int index; /**< ID as exposed in the system */ + int rx; /**< uart rx */ + int tx; /**< uart tx */ + /*@}*/ +} mraa_uart_dev_t; + /** * A Structure representing a platform/board. */ @@ -166,6 +180,9 @@ typedef struct { unsigned int def_spi_bus; /**< Position in array of defult spi bus */ unsigned int adc_raw; /**< ADC raw bit value */ unsigned int adc_supported; /**< ADC supported bit value */ + unsigned int def_uart_dev; /**< Position in array of defult uart */ + unsigned int uart_dev_count; /**< Usable spi Count */ + mraa_uart_dev_t uart_dev[6]; /**< Array of UARTs */ mraa_pininfo_t* pins; /**< Pointer to pin array */ /*@}*/ } mraa_board_t; diff --git a/api/mraa/uart.h b/api/mraa/uart.h new file mode 100644 index 0000000..d2c6832 --- /dev/null +++ b/api/mraa/uart.h @@ -0,0 +1,57 @@ +/* + * Author: Thomas Ingleby + * Copyright (c) 2014 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 + +/** + * @file + * @brief UART module + * + * UART is the Universal asynchronous receiver/transmitter interface to + * libmraa. It allows the exposure of UART pins on supported boards. + * With functionality to expand at a later date. + */ + +#ifdef __cplusplus +extern "C" { +#endif + +#include +#include + +#include "common.h" + +typedef struct _uart* mraa_uart_context; + +/** + * Initialise uart_context, uses board mapping + * + * @param uart the index of the uart set to use + * @return uart context or NULL + */ +mraa_uart_context mraa_uart_init(int uart); + +#ifdef __cplusplus +} +#endif diff --git a/include/mraa_internal.h b/include/mraa_internal.h index b55db77..a8abf6a 100644 --- a/include/mraa_internal.h +++ b/include/mraa_internal.h @@ -77,3 +77,10 @@ mraa_mmap_pin_t* mraa_setup_mmap_gpio(int pin); * @return out direction to setup. 1 for output 0 for input */ mraa_result_t mraa_swap_complex_gpio(int pin, int out); + +/** Setup uart muxes to exposes the pins physically. + * + * @param index of the uart in the board definition to expose physically + * @return mraa_result_t of operation + */ +mraa_result_t mraa_setup_uart(int index); diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index d330108..d9bdf9c 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -12,6 +12,7 @@ set (mraa_LIB_SRCS ${PROJECT_SOURCE_DIR}/src/pwm/pwm.c ${PROJECT_SOURCE_DIR}/src/spi/spi.c ${PROJECT_SOURCE_DIR}/src/aio/aio.c + ${PROJECT_SOURCE_DIR}/src/uart/uart.c ${PROJECT_SOURCE_DIR}/src/intel_galileo_rev_d.c ${PROJECT_SOURCE_DIR}/src/intel_galileo_rev_g.c # autogenerated version file diff --git a/src/mraa.c b/src/mraa.c index 6819d74..d8e8940 100644 --- a/src/mraa.c +++ b/src/mraa.c @@ -453,3 +453,32 @@ mraa_adc_supported_bits() return plat->adc_supported; } + +mraa_result_t +mraa_setup_uart(int index) +{ + if (plat == NULL) + return MRAA_ERROR_PLATFORM_NOT_INITIALISED; + + if (plat->uart_dev_count == 0) + return MRAA_ERROR_FEATURE_NOT_SUPPORTED; + + if (plat->uart_dev_count <= index) + return MRAA_ERROR_NO_RESOURCES; + + int pos = plat->uart_dev[index].rx; + if (pos >= 0) { + if (plat->pins[pos].uart.mux_total > 0) + if (mraa_setup_mux_mapped(plat->pins[pos].uart) != MRAA_SUCCESS) + return MRAA_ERROR_INVALID_RESOURCE; + } + + if (pos >= 0) { + pos = plat->uart_dev[index].tx; + if (plat->pins[pos].uart.mux_total > 0) + if (mraa_setup_mux_mapped(plat->pins[pos].uart) != MRAA_SUCCESS) + return MRAA_ERROR_INVALID_RESOURCE; + } + + return MRAA_SUCCESS; +} diff --git a/src/uart/uart.c b/src/uart/uart.c new file mode 100644 index 0000000..42ff5e0 --- /dev/null +++ b/src/uart/uart.c @@ -0,0 +1,54 @@ +/* + * Author: Thomas Ingleby + * Copyright (c) 2014 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. + */ + +#include +#include +#include +#include + +#include "uart.h" +#include "mraa_internal.h" + +/** + * A structure representing a UART device + */ +struct _uart { + /*@{*/ + int index; /**< the uart index, as known to the os. */ + /*@}*/ +}; + +mraa_uart_context +mraa_uart_init(int index) +{ + if ( mraa_setup_uart(index) != MRAA_SUCCESS) + return NULL; + + mraa_uart_context dev = (mraa_uart_context) malloc(sizeof(struct _uart)); + memset(dev, 0, sizeof(struct _uart)); + + dev->index = index; + + return dev; +}