cc26xx-uart.h

Go to the documentation of this file.

/*
 * Copyright (c) 2014, Texas Instruments Incorporated - http://www.ti.com/
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the copyright holder nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 */
/**
 * \addtogroup cc26xx
 * @{
 *
 * \defgroup cc26xx-uart CC13xx/CC26xx UARTs
 *
 * Driver for the CC13xx/CC26xx UART controller
 * @{
 *
 * \file
 * Header file for the CC13xx/CC26xx UART driver
 */
#ifndef CC26XX_UART_H_
#define CC26XX_UART_H_
 
#include <stdint.h>
/*---------------------------------------------------------------------------*/
/** \name UART functions
 * @{
 */
 
/**
 * \brief Initialises the UART controller, configures I/O control
 * and interrupts
 */
void cc26xx_uart_init();
 
/**
 * \brief Sends a single character down the UART
 * \param b The character to transmit
 */
void cc26xx_uart_write_byte(uint8_t b);
 
/**
 * \brief Assigns a callback to be called when the UART receives a byte
 * \param input A pointer to the function
 *
 * If \e input is NULL, the UART driver will assume that RX functionality is
 * not required and it will be disabled. It will also disable the module's
 * clocks under sleep and deep sleep and allow the SERIAL PD to be powered off.
 *
 * If \e input is not NULL, the UART driver will assume that RX is in fact
 * required and it will be enabled. The module's clocks will be enabled under
 * sleep and deep sleep and the driver will not allow the SERIAL PD to turn
 * off during deep sleep, so that the UART can still receive bytes.
 *
 * \note This has a significant impact on overall energy consumption, so you
 * should only enabled UART RX input when it's actually required.
 */
void cc26xx_uart_set_input(int (*input)(unsigned char c));
 
/**
 * \brief Returns the UART busy status
 * \return UART_IDLE or UART_BUSY
 *
 * ti_lib_uart_busy() will access UART registers. It is our responsibility
 * to first make sure the UART is accessible before calling it. Hence this
 * wrapper.
 *
 * Return values are defined in CC26xxware's uart.h
 */
uint8_t cc26xx_uart_busy(void);
/** @} */
/*---------------------------------------------------------------------------*/
#endif /* CC26XX_UART_H_ */
 
/**
 * @}
 * @}
 */