usci.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.
 */

/* !BSP430! periph=usci */
/* !BSP430! instance=USCI_A0,USCI_A1,USCI_B0,USCI_B1 */

#ifndef BSP430_PERIPH_USCI_H
#define BSP430_PERIPH_USCI_H

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

#define BSP430_MODULE_USCI defined(__MSP430_HAS_USCI__)

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

#ifndef BSP430_USCI_UART_MAX_BAUD
#define BSP430_USCI_UART_MAX_BAUD 1000000UL
#endif /* BSP430_USCI_UART_MAX_BAUD */

typedef struct sBSP430hplUSCI {
  unsigned char ctl0;                /* 0x00 */
  unsigned char ctl1;                /* 0x01 */
  unsigned char br0;                 /* 0x02 */
  unsigned char br1;                 /* 0x03 */
  unsigned char mctl;                /* 0x04 */
  unsigned char stat;                /* 0x05 */
  unsigned char rxbuf;               /* 0x06 */
  unsigned char txbuf;               /* 0x07 */
} sBSP430hplUSCI;

#define BSP430_PERIPH_USCI_A0_BASEADDRESS_ 0x0060
#define BSP430_PERIPH_USCI_A1_BASEADDRESS_ 0x00d0
#define BSP430_PERIPH_USCI_B0_BASEADDRESS_ 0x0068
#define BSP430_PERIPH_USCI_B1_BASEADDRESS_ 0x00d8
 /* DOXYGEN_INTERNAL */

/* !BSP430! periph=serial insert=hal_decl */
/* BEGIN AUTOMATICALLY GENERATED CODE---DO NOT MODIFY [hal_decl] */
#ifndef configBSP430_HAL_USCI_A0
#define configBSP430_HAL_USCI_A0 0
#endif /* configBSP430_HAL_USCI_A0 */

#if (configBSP430_HAL_USCI_A0 - 0)
/* You do not need to know about this */
extern sBSP430halSERIAL xBSP430hal_USCI_A0_;
#endif /* configBSP430_HAL_USCI_A0 */

#if defined(BSP430_DOXYGEN) || (configBSP430_HAL_USCI_A0 - 0)
#define BSP430_HAL_USCI_A0 (&xBSP430hal_USCI_A0_)
#endif /* configBSP430_HAL_USCI_A0 */

#ifndef configBSP430_HAL_USCI_A1
#define configBSP430_HAL_USCI_A1 0
#endif /* configBSP430_HAL_USCI_A1 */

#if (configBSP430_HAL_USCI_A1 - 0)
/* You do not need to know about this */
extern sBSP430halSERIAL xBSP430hal_USCI_A1_;
#endif /* configBSP430_HAL_USCI_A1 */

#if defined(BSP430_DOXYGEN) || (configBSP430_HAL_USCI_A1 - 0)
#define BSP430_HAL_USCI_A1 (&xBSP430hal_USCI_A1_)
#endif /* configBSP430_HAL_USCI_A1 */

#ifndef configBSP430_HAL_USCI_B0
#define configBSP430_HAL_USCI_B0 0
#endif /* configBSP430_HAL_USCI_B0 */

#if (configBSP430_HAL_USCI_B0 - 0)
/* You do not need to know about this */
extern sBSP430halSERIAL xBSP430hal_USCI_B0_;
#endif /* configBSP430_HAL_USCI_B0 */

#if defined(BSP430_DOXYGEN) || (configBSP430_HAL_USCI_B0 - 0)
#define BSP430_HAL_USCI_B0 (&xBSP430hal_USCI_B0_)
#endif /* configBSP430_HAL_USCI_B0 */

#ifndef configBSP430_HAL_USCI_B1
#define configBSP430_HAL_USCI_B1 0
#endif /* configBSP430_HAL_USCI_B1 */

#if (configBSP430_HAL_USCI_B1 - 0)
/* You do not need to know about this */
extern sBSP430halSERIAL xBSP430hal_USCI_B1_;
#endif /* configBSP430_HAL_USCI_B1 */

#if defined(BSP430_DOXYGEN) || (configBSP430_HAL_USCI_B1 - 0)
#define BSP430_HAL_USCI_B1 (&xBSP430hal_USCI_B1_)
#endif /* configBSP430_HAL_USCI_B1 */

/* END AUTOMATICALLY GENERATED CODE [hal_decl] */
/* !BSP430! end=hal_decl */
/* !BSP430! periph=usci */

/* !BSP430! insert=periph_decl */
/* BEGIN AUTOMATICALLY GENERATED CODE---DO NOT MODIFY [periph_decl] */
#ifndef configBSP430_HPL_USCI_A0
#define configBSP430_HPL_USCI_A0 (configBSP430_HAL_USCI_A0 - 0)
#endif /* configBSP430_HPL_USCI_A0 */

#if (configBSP430_HAL_USCI_A0 - 0) && ! (configBSP430_HPL_USCI_A0 - 0)
#warning configBSP430_HAL_USCI_A0 requested without configBSP430_HPL_USCI_A0
#endif /* HAL and not HPL */

#if defined(BSP430_DOXYGEN) || (configBSP430_HPL_USCI_A0 - 0)
#define BSP430_PERIPH_USCI_A0 ((tBSP430periphHandle)(BSP430_PERIPH_USCI_A0_BASEADDRESS_))
#endif /* configBSP430_HPL_USCI_A0 */

#ifndef configBSP430_HPL_USCI_A1
#define configBSP430_HPL_USCI_A1 (configBSP430_HAL_USCI_A1 - 0)
#endif /* configBSP430_HPL_USCI_A1 */

#if (configBSP430_HAL_USCI_A1 - 0) && ! (configBSP430_HPL_USCI_A1 - 0)
#warning configBSP430_HAL_USCI_A1 requested without configBSP430_HPL_USCI_A1
#endif /* HAL and not HPL */

#if defined(BSP430_DOXYGEN) || (configBSP430_HPL_USCI_A1 - 0)
#define BSP430_PERIPH_USCI_A1 ((tBSP430periphHandle)(BSP430_PERIPH_USCI_A1_BASEADDRESS_))
#endif /* configBSP430_HPL_USCI_A1 */

#ifndef configBSP430_HPL_USCI_B0
#define configBSP430_HPL_USCI_B0 (configBSP430_HAL_USCI_B0 - 0)
#endif /* configBSP430_HPL_USCI_B0 */

#if (configBSP430_HAL_USCI_B0 - 0) && ! (configBSP430_HPL_USCI_B0 - 0)
#warning configBSP430_HAL_USCI_B0 requested without configBSP430_HPL_USCI_B0
#endif /* HAL and not HPL */

#if defined(BSP430_DOXYGEN) || (configBSP430_HPL_USCI_B0 - 0)
#define BSP430_PERIPH_USCI_B0 ((tBSP430periphHandle)(BSP430_PERIPH_USCI_B0_BASEADDRESS_))
#endif /* configBSP430_HPL_USCI_B0 */

#ifndef configBSP430_HPL_USCI_B1
#define configBSP430_HPL_USCI_B1 (configBSP430_HAL_USCI_B1 - 0)
#endif /* configBSP430_HPL_USCI_B1 */

#if (configBSP430_HAL_USCI_B1 - 0) && ! (configBSP430_HPL_USCI_B1 - 0)
#warning configBSP430_HAL_USCI_B1 requested without configBSP430_HPL_USCI_B1
#endif /* HAL and not HPL */

#if defined(BSP430_DOXYGEN) || (configBSP430_HPL_USCI_B1 - 0)
#define BSP430_PERIPH_USCI_B1 ((tBSP430periphHandle)(BSP430_PERIPH_USCI_B1_BASEADDRESS_))
#endif /* configBSP430_HPL_USCI_B1 */

/* END AUTOMATICALLY GENERATED CODE [periph_decl] */
/* !BSP430! end=periph_decl */

/* !BSP430! insert=hpl_decl */
/* BEGIN AUTOMATICALLY GENERATED CODE---DO NOT MODIFY [hpl_decl] */
#if defined(BSP430_DOXYGEN) || (configBSP430_HPL_USCI_A0 - 0)
#define BSP430_HPL_USCI_A0 ((volatile sBSP430hplUSCI *)BSP430_PERIPH_USCI_A0)
#endif /* configBSP430_HPL_USCI_A0 */

#if defined(BSP430_DOXYGEN) || (configBSP430_HPL_USCI_A1 - 0)
#define BSP430_HPL_USCI_A1 ((volatile sBSP430hplUSCI *)BSP430_PERIPH_USCI_A1)
#endif /* configBSP430_HPL_USCI_A1 */

#if defined(BSP430_DOXYGEN) || (configBSP430_HPL_USCI_B0 - 0)
#define BSP430_HPL_USCI_B0 ((volatile sBSP430hplUSCI *)BSP430_PERIPH_USCI_B0)
#endif /* configBSP430_HPL_USCI_B0 */

#if defined(BSP430_DOXYGEN) || (configBSP430_HPL_USCI_B1 - 0)
#define BSP430_HPL_USCI_B1 ((volatile sBSP430hplUSCI *)BSP430_PERIPH_USCI_B1)
#endif /* configBSP430_HPL_USCI_B1 */

/* END AUTOMATICALLY GENERATED CODE [hpl_decl] */
/* !BSP430! end=hpl_decl */

/* !BSP430! instance=0,1 */
/* !BSP430! insert=hal_usci_isr_decl */
/* BEGIN AUTOMATICALLY GENERATED CODE---DO NOT MODIFY [hal_usci_isr_decl] */
#ifndef configBSP430_HAL_USCI_AB0RX_ISR
#define configBSP430_HAL_USCI_AB0RX_ISR ((configBSP430_HAL_USCI_A0 - 0) || (configBSP430_HAL_USCI_B0 - 0))
#endif /* configBSP430_HAL_USCI_AB0RX_ISR */

#if ((configBSP430_HAL_0_ISR - 0) \
     && ! ((configBSP430_HAL_USCI_A0RX - 0) | (configBSP430_HAL_USCI_B0 - 0)))
#warning configBSP430_HAL_USCI_AB0RX_ISR requested without configBSP430_HAL_USCI_A0 or configBSP430_HAL_USCI_B0
#endif /* HAL_ISR and not HAL */

#ifndef configBSP430_HAL_USCI_AB0TX_ISR
#define configBSP430_HAL_USCI_AB0TX_ISR ((configBSP430_HAL_USCI_A0 - 0) | (configBSP430_HAL_USCI_B0 - 0))
#endif /* configBSP430_HAL_USCI_AB0TX_ISR */

#if ((configBSP430_HAL_0_ISR - 0) \
     && ! ((configBSP430_HAL_USCI_A0TX - 0) | (configBSP430_HAL_USCI_B0 - 0)))
#warning configBSP430_HAL_USCI_AB0TX_ISR requested without configBSP430_HAL_USCI_A0 or configBSP430_HAL_USCI_B0
#endif /* HAL_ISR and not HAL */

#ifndef configBSP430_HAL_USCI_AB1RX_ISR
#define configBSP430_HAL_USCI_AB1RX_ISR ((configBSP430_HAL_USCI_A1 - 0) || (configBSP430_HAL_USCI_B1 - 0))
#endif /* configBSP430_HAL_USCI_AB1RX_ISR */

#if ((configBSP430_HAL_1_ISR - 0) \
     && ! ((configBSP430_HAL_USCI_A1RX - 0) | (configBSP430_HAL_USCI_B1 - 0)))
#warning configBSP430_HAL_USCI_AB1RX_ISR requested without configBSP430_HAL_USCI_A1 or configBSP430_HAL_USCI_B1
#endif /* HAL_ISR and not HAL */

#ifndef configBSP430_HAL_USCI_AB1TX_ISR
#define configBSP430_HAL_USCI_AB1TX_ISR ((configBSP430_HAL_USCI_A1 - 0) | (configBSP430_HAL_USCI_B1 - 0))
#endif /* configBSP430_HAL_USCI_AB1TX_ISR */

#if ((configBSP430_HAL_1_ISR - 0) \
     && ! ((configBSP430_HAL_USCI_A1TX - 0) | (configBSP430_HAL_USCI_B1 - 0)))
#warning configBSP430_HAL_USCI_AB1TX_ISR requested without configBSP430_HAL_USCI_A1 or configBSP430_HAL_USCI_B1
#endif /* HAL_ISR and not HAL */

/* END AUTOMATICALLY GENERATED CODE [hal_usci_isr_decl] */
/* !BSP430! end=hal_usci_isr_decl */
/* !BSP430! instance=USCI_A0,USCI_A1,USCI_B0,USCI_B1 */

hBSP430halSERIAL hBSP430usciOpenUART (hBSP430halSERIAL hal,
                                      unsigned char ctl0_byte,
                                      unsigned char ctl1_byte,
                                      unsigned long baud);

hBSP430halSERIAL hBSP430usciOpenSPI (hBSP430halSERIAL hal,
                                     unsigned char ctl0_byte,
                                     unsigned char ctl1_byte,
                                     unsigned int prescaler);

hBSP430halSERIAL hBSP430usciOpenI2C (hBSP430halSERIAL hal,
                                     unsigned char ctl0_byte,
                                     unsigned char ctl1_byte,
                                     unsigned int prescaler);

int iBSP430usciSetReset_rh (hBSP430halSERIAL hal, int resetp);

int iBSP430usciSetHold_rh (hBSP430halSERIAL hal, int holdp);

int iBSP430usciClose (hBSP430halSERIAL xUSCI);

void vBSP430usciWakeupTransmit_rh (hBSP430halSERIAL device);

void vBSP430usciFlush_ni (hBSP430halSERIAL device);

int iBSP430usciUARTrxByte_rh (hBSP430halSERIAL device);

int iBSP430usciUARTtxByte_rh (hBSP430halSERIAL device, uint8_t c);

int iBSP430usciUARTtxData_rh (hBSP430halSERIAL device, const uint8_t * data, size_t len);

int iBSP430usciUARTtxASCIIZ_rh (hBSP430halSERIAL device, const char * str);

int iBSP430usciSPITxRx_rh (hBSP430halSERIAL hal,
                           const uint8_t * tx_data,
                           size_t tx_len,
                           size_t rx_len,
                           uint8_t * rx_data);

int iBSP430usciI2CsetAddresses_rh (hBSP430halSERIAL hal,
                                   int own_address,
                                   int slave_address);

int iBSP430usciI2CrxData_rh (hBSP430halSERIAL hal,
                             uint8_t * rx_data,
                             size_t rx_len);

int iBSP430usciI2CtxData_rh (hBSP430halSERIAL hal,
                             const uint8_t * tx_data,
                             size_t tx_len);

static BSP430_CORE_INLINE
volatile sBSP430hplUSCI * xBSP430hplLookupUSCI (tBSP430periphHandle periph)
{
  /* !BSP430! insert=periph_hpl_demux */
  /* BEGIN AUTOMATICALLY GENERATED CODE---DO NOT MODIFY [periph_hpl_demux] */
#if (configBSP430_HPL_USCI_A0 - 0)
  if (BSP430_PERIPH_USCI_A0 == periph) {
    return BSP430_HPL_USCI_A0;
  }
#endif /* configBSP430_HPL_USCI_A0 */

#if (configBSP430_HPL_USCI_A1 - 0)
  if (BSP430_PERIPH_USCI_A1 == periph) {
    return BSP430_HPL_USCI_A1;
  }
#endif /* configBSP430_HPL_USCI_A1 */

#if (configBSP430_HPL_USCI_B0 - 0)
  if (BSP430_PERIPH_USCI_B0 == periph) {
    return BSP430_HPL_USCI_B0;
  }
#endif /* configBSP430_HPL_USCI_B0 */

#if (configBSP430_HPL_USCI_B1 - 0)
  if (BSP430_PERIPH_USCI_B1 == periph) {
    return BSP430_HPL_USCI_B1;
  }
#endif /* configBSP430_HPL_USCI_B1 */

  /* END AUTOMATICALLY GENERATED CODE [periph_hpl_demux] */
  /* !BSP430! end=periph_hpl_demux */
  return NULL;
}

static BSP430_CORE_INLINE
hBSP430halSERIAL hBSP430usciLookup (tBSP430periphHandle periph)
{
  /* !BSP430! insert=periph_hal_demux */
  /* BEGIN AUTOMATICALLY GENERATED CODE---DO NOT MODIFY [periph_hal_demux] */
#if (configBSP430_HAL_USCI_A0 - 0)
  if (BSP430_PERIPH_USCI_A0 == periph) {
    return BSP430_HAL_USCI_A0;
  }
#endif /* configBSP430_HAL_USCI_A0 */

#if (configBSP430_HAL_USCI_A1 - 0)
  if (BSP430_PERIPH_USCI_A1 == periph) {
    return BSP430_HAL_USCI_A1;
  }
#endif /* configBSP430_HAL_USCI_A1 */

#if (configBSP430_HAL_USCI_B0 - 0)
  if (BSP430_PERIPH_USCI_B0 == periph) {
    return BSP430_HAL_USCI_B0;
  }
#endif /* configBSP430_HAL_USCI_B0 */

#if (configBSP430_HAL_USCI_B1 - 0)
  if (BSP430_PERIPH_USCI_B1 == periph) {
    return BSP430_HAL_USCI_B1;
  }
#endif /* configBSP430_HAL_USCI_B1 */

  /* END AUTOMATICALLY GENERATED CODE [periph_hal_demux] */
  /* !BSP430! end=periph_hal_demux */
  return NULL;
}

const char * xBSP430usciName (tBSP430periphHandle periph);

#endif /* BSP430_MODULE_USCI */

#endif /* BSP430_PERIPH_USCI_H */