serial.h

Go to the documentation of this file.

/* Copyright 2012-2014, Peter A. Bigot
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 *
 * * 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.
 *
 * * Neither the name of the software 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.
 */

#ifndef BSP430_SERIAL_H
#define BSP430_SERIAL_H

#include <bsp430/core.h>
#include <bsp430/periph.h>

/* NOTE TO MAINTAINER: You will be tempted to refactor the boolean
 * configBSP430_SERIAL_USE_FOO flag to a valued
 * configBSP430_SERIAL_USE_VARIANT==BSP430_SERIAL_HAL_HPL_VARIANT_FOO
 * flag.  Don't.  There are MCUs (such as msp430fg4618) that provide
 * serial capabilities through multiple modules (USART+USCI) where SPI
 * might come from one and UART from another. */

#ifndef configBSP430_SERIAL_USE_USCI
#define configBSP430_SERIAL_USE_USCI defined(__MSP430_HAS_USCI__)
#endif /* configBSP430_SERIAL_USE_USCI */

#ifndef configBSP430_SERIAL_USE_USCI5
#define configBSP430_SERIAL_USE_USCI5 defined(__MSP430_HAS_USCI_A0__)
#endif /* configBSP430_SERIAL_USE_USCI5 */

#ifndef configBSP430_SERIAL_USE_EUSCI
#define configBSP430_SERIAL_USE_EUSCI (defined(__MSP430_HAS_EUSCI_A0__) || defined(__MSP430_HAS_EUSCI_B0__))
#endif /* configBSP430_SERIAL_USE_EUSCI */

#ifndef configBSP430_SERIAL_ENABLE_UART
#define configBSP430_SERIAL_ENABLE_UART (configBSP430_CONSOLE - 0)
#endif /* configBSP430_SERIAL_ENABLE_UART */

#ifndef configBSP430_SERIAL_ENABLE_SPI
#define configBSP430_SERIAL_ENABLE_SPI 0
#endif /* configBSP430_SERIAL_ENABLE_SPI */

#ifndef BSP430_SERIAL_SPI_BUS_SPEED_HZ
#define BSP430_SERIAL_SPI_BUS_SPEED_HZ 4000000UL
#endif /* BSP430_SERIAL_SPI_BUS_SPEED_HZ */

#ifndef configBSP430_SERIAL_ENABLE_I2C
#define configBSP430_SERIAL_ENABLE_I2C 0
#endif /* configBSP430_SERIAL_ENABLE_I2C */

#ifndef BSP430_SERIAL_I2C_BUS_SPEED_HZ
#define BSP430_SERIAL_I2C_BUS_SPEED_HZ 400000UL
#endif /* BSP430_SERIAL_SPI_BUS_SPEED_HZ */

#define BSP430_SERIAL                           \
  ((configBSP430_SERIAL_ENABLE_UART - 0)        \
   || (configBSP430_SERIAL_ENABLE_SPI - 0)      \
   || (configBSP430_SERIAL_ENABLE_I2C - 0))

#include <bsp430/serial_.h>

#if defined(BSP430_DOXYGEN) || (BSP430_SERIAL - 0)

#define BSP430_SERIAL_ADJUST_CTL0_INITIALIZER(_i) (((_i) >= 0x100) ? ((_i) >> 8) : (_i))

unsigned int uiBSP430serialSMCLKPrescaler (unsigned long freq_Hz);

#if defined(BSP430_DOXYGEN) || (configBSP430_SERIAL_ENABLE_UART - 0)

static BSP430_CORE_INLINE
hBSP430halSERIAL hBSP430serialOpenUART (hBSP430halSERIAL hal,
                                        unsigned char ctl0_byte,
                                        unsigned char ctl1_byte,
                                        unsigned long baud)
{
  return hal->dispatch->openUART(hal, ctl0_byte, ctl1_byte, baud);
}

static BSP430_CORE_INLINE
int iBSP430uartRxByte_rh (hBSP430halSERIAL hal)
{
  return hal->dispatch->uartRxByte_rh(hal);
}

static BSP430_CORE_INLINE
int iBSP430uartTxByte_rh (hBSP430halSERIAL hal, uint8_t c)
{
  return hal->dispatch->uartTxByte_rh(hal, c);
}

static BSP430_CORE_INLINE
int iBSP430uartTxData_rh (hBSP430halSERIAL hal,
                          const uint8_t * data,
                          size_t len)
{
  return hal->dispatch->uartTxData_rh(hal, data, len);
}

static BSP430_CORE_INLINE
int iBSP430uartTxASCIIZ_rh (hBSP430halSERIAL hal, const char * str)
{
  return hal->dispatch->uartTxASCIIZ_rh(hal, str);
}
#endif /* configBSP430_SERIAL_ENABLE_UART */

#if defined(BSP430_DOXYGEN) || (configBSP430_SERIAL_ENABLE_SPI - 0)

static BSP430_CORE_INLINE
hBSP430halSERIAL hBSP430serialOpenSPI (hBSP430halSERIAL hal,
                                       unsigned char ctl0_byte,
                                       unsigned char ctl1_byte,
                                       unsigned int prescaler)
{
  return hal->dispatch->openSPI(hal, ctl0_byte, ctl1_byte, prescaler);
}

static BSP430_CORE_INLINE
int iBSP430spiTxRx_rh (hBSP430halSERIAL hal,
                       const uint8_t * tx_data,
                       size_t tx_len,
                       size_t rx_len,
                       uint8_t * rx_data)
{
  return hal->dispatch->spiTxRx_rh(hal, tx_data, tx_len, rx_len, rx_data);
}

#endif /* configBSP430_SERIAL_ENABLE_SPI */

#ifndef BSP430_I2C_SPIN_LIMIT
#define BSP430_I2C_SPIN_LIMIT 65536
#endif /* BSP430_I2C_SPIN_LIMIT */

#define BSP430_I2C_ERRFLAG_PROTOCOL 0x4000

#define BSP430_I2C_ERRFLAG_SPINLIMIT 0x2000

#if defined(BSP430_DOXYGEN) || (configBSP430_SERIAL_ENABLE_I2C - 0)

static BSP430_CORE_INLINE
hBSP430halSERIAL hBSP430serialOpenI2C (hBSP430halSERIAL hal,
                                       unsigned char ctl0_byte,
                                       unsigned char ctl1_byte,
                                       unsigned int prescaler)
{
  return hal->dispatch->openI2C(hal, ctl0_byte, ctl1_byte, prescaler);
}

static BSP430_CORE_INLINE
int iBSP430i2cSetAddresses_rh (hBSP430halSERIAL hal,
                               int own_address,
                               int slave_address)
{
  return hal->dispatch->i2cSetAddresses_rh(hal, own_address, slave_address);
}

static BSP430_CORE_INLINE
int iBSP430i2cTxData_rh (hBSP430halSERIAL hal,
                         const uint8_t * tx_data,
                         size_t tx_len)
{
  return hal->dispatch->i2cTxData_rh(hal, tx_data, tx_len);
}

static BSP430_CORE_INLINE
int iBSP430i2cRxData_rh (hBSP430halSERIAL hal,
                         uint8_t * rx_data,
                         size_t rx_len)
{
  return hal->dispatch->i2cRxData_rh(hal, rx_data, rx_len);
}
#endif /* configBSP430_SERIAL_ENABLE_I2C */

static BSP430_CORE_INLINE
int iBSP430serialSetReset_rh (hBSP430halSERIAL hal,
                              int resetp)
{
  return hal->dispatch->setReset_rh(hal, resetp);
}

static BSP430_CORE_INLINE
int iBSP430serialSetHold_rh (hBSP430halSERIAL hal,
                             int holdp)
{
  return hal->dispatch->setHold_rh(hal, holdp);
}

static BSP430_CORE_INLINE
int iBSP430serialClose (hBSP430halSERIAL hal)
{
  return hal->dispatch->close(hal);
}

static BSP430_CORE_INLINE
void vBSP430serialWakeupTransmit_rh (hBSP430halSERIAL hal)
{
  hal->dispatch->wakeupTransmit_rh(hal);
}

static BSP430_CORE_INLINE
void vBSP430serialFlush_ni (hBSP430halSERIAL hal)
{
  hal->dispatch->flush_ni(hal);
}

static BSP430_CORE_INLINE
unsigned long ulBSP430serialRate (hBSP430halSERIAL hal)
{
  return hal->dispatch->rate(hal);
}

#endif /* BSP430_SERIAL - 0 */

#if (configBSP430_SERIAL_USE_USCI - 0)
#include <bsp430/periph/usci.h>
#endif /* configBSP430_SERIAL_USE_USCI */
#if (configBSP430_SERIAL_USE_USCI5 - 0)
#include <bsp430/periph/usci5.h>
#endif /* configBSP430_SERIAL_USE_USCI5 */
#if (configBSP430_SERIAL_USE_EUSCI - 0)
#include <bsp430/periph/eusci.h>
#endif /* configBSP430_SERIAL_USE_EUSCI */

static BSP430_CORE_INLINE
hBSP430halSERIAL hBSP430serialLookup (tBSP430periphHandle periph)
{
  hBSP430halSERIAL rv = NULL;
#if (configBSP430_SERIAL_USE_USCI - 0)
  if (NULL == rv) {
    rv = hBSP430usciLookup(periph);
  }
#endif /* configBSP430_SERIAL_USE_USCI */
#if (configBSP430_SERIAL_USE_USCI5 - 0)
  if (NULL == rv) {
    rv = hBSP430usci5Lookup(periph);
  }
#endif /* configBSP430_SERIAL_USE_USCI5 */
#if (configBSP430_SERIAL_USE_EUSCI - 0)
  if (NULL == rv) {
    rv = hBSP430eusciLookup(periph);
  }
#endif /* configBSP430_SERIAL_USE_EUSCI */
  return rv;
}

const char * xBSP430serialName (tBSP430periphHandle periph);

#endif /* BSP430_SERIAL_H */