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>

#ifndef BSP430_SERIAL_ENABLE_RESOURCE
#define BSP430_SERIAL_ENABLE_RESOURCE 0
#endif /* BSP430_SERIAL_ENABLE_RESOURCE */

#if defined(BSP430_DOXYGEN) || (BSP430_SERIAL_ENABLE_RESOURCE - 0)
#include <bsp430/resource.h>
#endif /* BSP430_SERIAL_ENABLE_RESOURCE */

#define BSP430_SERIAL_HAL_HPL_VARIANT_USCI 1

#define BSP430_SERIAL_HAL_HPL_VARIANT_USCI5 2

#define BSP430_SERIAL_HAL_HPL_VARIANT_EUSCIA 3

#define BSP430_SERIAL_HAL_HPL_VARIANT_EUSCIB 4

/* !BSP430! instance=usci,usci5,euscia,euscib */
/* !BSP430! periph=serial insert=hal_variant_hpl_macro */
/* BEGIN AUTOMATICALLY GENERATED CODE---DO NOT MODIFY [hal_variant_hpl_macro] */
#define BSP430_SERIAL_HAL_HPL_VARIANT_IS_USCI(hal_) (BSP430_SERIAL_HAL_HPL_VARIANT_USCI == BSP430_PERIPH_HAL_STATE_CFLAGS_VARIANT(hal_))

#define BSP430_SERIAL_HAL_GET_HPL_USCI(hal_) ((BSP430_SERIAL_HAL_HPL_VARIANT_IS_USCI(hal_)) ? (hal_)->hpl.usci : (void *)0)

#define BSP430_SERIAL_HAL_HPL_VARIANT_IS_USCI5(hal_) (BSP430_SERIAL_HAL_HPL_VARIANT_USCI5 == BSP430_PERIPH_HAL_STATE_CFLAGS_VARIANT(hal_))

#define BSP430_SERIAL_HAL_GET_HPL_USCI5(hal_) ((BSP430_SERIAL_HAL_HPL_VARIANT_IS_USCI5(hal_)) ? (hal_)->hpl.usci5 : (void *)0)

#define BSP430_SERIAL_HAL_HPL_VARIANT_IS_EUSCIA(hal_) (BSP430_SERIAL_HAL_HPL_VARIANT_EUSCIA == BSP430_PERIPH_HAL_STATE_CFLAGS_VARIANT(hal_))

#define BSP430_SERIAL_HAL_GET_HPL_EUSCIA(hal_) ((BSP430_SERIAL_HAL_HPL_VARIANT_IS_EUSCIA(hal_)) ? (hal_)->hpl.euscia : (void *)0)

#define BSP430_SERIAL_HAL_HPL_VARIANT_IS_EUSCIB(hal_) (BSP430_SERIAL_HAL_HPL_VARIANT_EUSCIB == BSP430_PERIPH_HAL_STATE_CFLAGS_VARIANT(hal_))

#define BSP430_SERIAL_HAL_GET_HPL_EUSCIB(hal_) ((BSP430_SERIAL_HAL_HPL_VARIANT_IS_EUSCIB(hal_)) ? (hal_)->hpl.euscib : (void *)0)

/* END AUTOMATICALLY GENERATED CODE [hal_variant_hpl_macro] */
/* !BSP430! end=hal_variant_hpl_macro */
/* !BSP430! periph=serial insert=hal_variant_hplaux_macro */
/* BEGIN AUTOMATICALLY GENERATED CODE---DO NOT MODIFY [hal_variant_hplaux_macro] */
#define BSP430_SERIAL_HAL_GET_HPLAUX_USCI(hal_) ((BSP430_SERIAL_HAL_HPL_VARIANT_IS_USCI(hal_)) ? (hal_)->hpl_aux.usci : (void *)0)

#define BSP430_SERIAL_HAL_GET_HPLAUX_USCI5(hal_) ((BSP430_SERIAL_HAL_HPL_VARIANT_IS_USCI5(hal_)) ? (hal_)->hpl_aux.usci5 : (void *)0)

#define BSP430_SERIAL_HAL_GET_HPLAUX_EUSCIA(hal_) ((BSP430_SERIAL_HAL_HPL_VARIANT_IS_EUSCIA(hal_)) ? (hal_)->hpl_aux.euscia : (void *)0)

#define BSP430_SERIAL_HAL_GET_HPLAUX_EUSCIB(hal_) ((BSP430_SERIAL_HAL_HPL_VARIANT_IS_EUSCIB(hal_)) ? (hal_)->hpl_aux.euscib : (void *)0)

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

#ifndef BSP430_SERIAL_SPI_READ_TX_BYTE
#define BSP430_SERIAL_SPI_READ_TX_BYTE(i_) (i_)
#endif /* BSP430_SERIAL_SPI_READ_TX_BYTE */

/* Forward declarations */
struct sBSP430hplUSCI;
struct sBSP430usciHPLAux;
struct sBSP430hplUSCI5;
struct sBSP430hplEUSCIA;
struct sBSP430hplEUSCIB;
struct sBSP430serialDispatch;

typedef struct sBSP430halSERIAL {
  sBSP430hplHALStatePrefix hal_state;

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

  sBSP430resource resource;
#endif /* BSP430_SERIAL_ENABLE_RESOURCE */

  union {
    volatile void * any;

    volatile struct sBSP430hplUSCI * usci;

    volatile struct sBSP430hplUSCI5 * usci5;

    volatile struct sBSP430hplEUSCIA * euscia;

    volatile struct sBSP430hplEUSCIB * euscib;
  } const hpl;

  union {
    void * any;
    struct sBSP430usciHPLAux * usci;
  } const hpl_aux;

  uint8_t rx_byte;

  uint8_t tx_byte;

  const struct sBSP430halISRVoidChainNode * volatile rx_cbchain_ni;

  const struct sBSP430halISRVoidChainNode * volatile tx_cbchain_ni;

  unsigned long num_rx;

  unsigned long num_tx;

#if (BSP430_SERIAL - 0)

  const struct sBSP430serialDispatch * const dispatch;
#endif /* BSP430_SERIAL */
} sBSP430halSERIAL;

typedef struct sBSP430halSERIAL * hBSP430halSERIAL;

struct sBSP430serialDispatch {
#if (configBSP430_SERIAL_ENABLE_UART - 0)
  hBSP430halSERIAL (* openUART) (hBSP430halSERIAL hal,
                                 unsigned char ctl0_byte,
                                 unsigned char ctl1_byte,
                                 unsigned long baud);
  int (* uartRxByte_rh) (hBSP430halSERIAL hal);
  int (* uartTxByte_rh) (hBSP430halSERIAL hal,
                         uint8_t c);
  int (* uartTxData_rh) (hBSP430halSERIAL hal,
                         const uint8_t * data,
                         size_t len);
  int (* uartTxASCIIZ_rh) (hBSP430halSERIAL hal, const char * str);
#endif /* configBSP430_SERIAL_ENABLE_UART */
#if (configBSP430_SERIAL_ENABLE_SPI - 0)
  hBSP430halSERIAL (* openSPI) (hBSP430halSERIAL hal,
                                unsigned char ctl0_byte,
                                unsigned char ctl1_byte,
                                unsigned int prescaler);
  int (* spiTxRx_rh) (hBSP430halSERIAL hal, const uint8_t * tx_data, size_t tx_len, size_t rx_len, uint8_t * rx_data);
#endif /* configBSP430_SERIAL_ENABLE_SPI */
#if (configBSP430_SERIAL_ENABLE_I2C - 0)
  hBSP430halSERIAL (* openI2C) (hBSP430halSERIAL hal,
                                unsigned char ctl0_byte,
                                unsigned char ctl1_byte,
                                unsigned int prescaler);
  int (* i2cSetAddresses_rh) (hBSP430halSERIAL hal, int own_address, int slave_address);
  int (* i2cRxData_rh) (hBSP430halSERIAL hal, uint8_t * rx_data, size_t rx_len);
  int (* i2cTxData_rh) (hBSP430halSERIAL hal, const uint8_t * tx_data, size_t tx_len);
#endif /* configBSP430_SERIAL_ENABLE_I2C */
  int (* setReset_rh) (hBSP430halSERIAL hal, int resetp);
  int (* setHold_rh) (hBSP430halSERIAL hal, int holdp);
  int (* close) (hBSP430halSERIAL hal);
  void (* wakeupTransmit_rh) (hBSP430halSERIAL hal);
  void (* flush_ni) (hBSP430halSERIAL hal);
  unsigned long (* rate) (hBSP430halSERIAL hal);
};
#endif /* BSP430_SERIAL__H */