sci.h

Go to the documentation of this file.

/* --COPYRIGHT--,BSD
 * Copyright (c) 2015, Texas Instruments Incorporated
 * 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 Texas Instruments Incorporated 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 OWNER 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.
 * --/COPYRIGHT--*/
#ifndef _SCI_H_
#define _SCI_H_



// **************************************************************************
// the includes

// drivers
#include "sw/drivers/cpu/src/32b/f28x/f2806x/cpu.h"


// modules
#include "sw/modules/types/src/types.h"





#ifdef __cplusplus
extern "C" {
#endif


// **************************************************************************
// the defines


#define SCIA_BASE_ADDR              (0x00007050)

#define SCIB_BASE_ADDR              (0x00007750)


#define SCI_SCICCR_CHAR_LENGTH_BITS   (7 << 0)

#define SCI_SCICCR_MODE_BITS          (1 << 3)

#define SCI_SCICCR_LB_ENA_BITS        (1 << 4)

#define SCI_SCICCR_PARITY_ENA_BITS    (1 << 5)

#define SCI_SCICCR_PARITY_BITS        (1 << 6)

#define SCI_SCICCR_STOP_BITS          (1 << 7)


#define SCI_SCICTL1_RXENA_BITS           (1 << 0)

#define SCI_SCICTL1_TXENA_BITS           (1 << 1)

#define SCI_SCICTL1_SLEEP_BITS           (1 << 2)

#define SCI_SCICTL1_TXWAKE_BITS          (1 << 3)

#define SCI_SCICTL1_RESET_BITS           (1 << 5)

#define SCI_SCICTL1_RX_ERR_INT_ENA_BITS  (1 << 6)


#define SCI_SCICTL2_TX_INT_ENA_BITS      (1 << 0)

#define SCI_SCICTL2_RX_INT_ENA_BITS      (1 << 1)  

#define SCI_SCICTL2_TXEMPTY_BITS         (1 << 6)

#define SCI_SCICTL2_TXRDY_BITS           (1 << 7)


#define SCI_SCIRXST_RXWAKE_BITS          (1 << 1)

#define SCI_SCIRXST_PE_BITS              (1 << 2)

#define SCI_SCIRXST_OE_BITS              (1 << 3)

#define SCI_SCIRXST_FE_BITS              (1 << 4)

#define SCI_SCIRXST_BRKDT_BITS           (1 << 5)

#define SCI_SCIRXST_RXRDY_BITS           (1 << 6)  

#define SCI_SCIRXST_RXERROR_BITS         (1 << 7)  


#define SCI_SCIFFRX_IL_BITS           (31 << 0)

#define SCI_SCIFFRX_IENA_BITS         ( 1 << 5)

#define SCI_SCIFFRX_INTCLR_BITS       ( 1 << 6)

#define SCI_SCIFFRX_INT_BITS          ( 1 << 7)

#define SCI_SCIFFRX_FIFO_ST_BITS      (31 << 8)

#define SCI_SCIFFRX_FIFO_RESET_BITS   ( 1 << 13)

#define SCI_SCIFFRX_FIFO_OVFCLR_BITS  ( 1 << 14)

#define SCI_SCIFFRX_FIFO_OVF_BITS     ( 1 << 15)


#define SCI_SCIFFTX_IL_BITS           (31 << 0)

#define SCI_SCIFFTX_IENA_BITS         ( 1 << 5)

#define SCI_SCIFFTX_INTCLR_BITS       ( 1 << 6)

#define SCI_SCIFFTX_INT_BITS          ( 1 << 7)

#define SCI_SCIFFTX_FIFO_ST_BITS      (31 << 8)

#define SCI_SCIFFTX_FIFO_RESET_BITS   ( 1 << 13)

#define SCI_SCIFFTX_FIFO_ENA_BITS     ( 1 << 14)

#define SCI_SCIFFTX_CHAN_RESET_BITS   ( 1 << 15)


#define SCI_SCIFFCT_DELAY_BITS        (255 << 0)

#define SCI_SCIFFCT_CDC_BITS          (  1 << 13)

#define SCI_SCIFFCT_ABDCLR_BITS       (  1 << 14)

#define SCI_SCIFFCT_ABD_BITS          (  1 << 15)


// **************************************************************************
// the typedefs

typedef enum
{
  SCI_BaudRate_9_6_kBaud = 194,      
  SCI_BaudRate_19_2_kBaud = 97,      
  SCI_BaudRate_57_6_kBaud = 33,      
  SCI_BaudRate_115_2_kBaud = 15      
} SCI_BaudRate_e;


typedef enum
{
  SCI_CharLength_1_Bit=(0 << 0),     
  SCI_CharLength_2_Bits=(1 << 0),    
  SCI_CharLength_3_Bits=(2 << 0),    
  SCI_CharLength_4_Bits=(3 << 0),    
  SCI_CharLength_5_Bits=(4 << 0),    
  SCI_CharLength_6_Bits=(5 << 0),    
  SCI_CharLength_7_Bits=(6 << 0),    
  SCI_CharLength_8_Bits=(7 << 0)     
} SCI_CharLength_e;


typedef enum
{
  SCI_Mode_IdleLine=(0 << 3),    
  SCI_Mode_AddressBit=(1 << 3)   
} SCI_Mode_e;


typedef enum
{
  SCI_NumStopBits_One=(0 << 7),   
  SCI_NumStopBits_Two=(1 << 7)    
} SCI_NumStopBits_e;


typedef enum
{
  SCI_Parity_Odd=(0 << 6),        
  SCI_Parity_Even=(1 << 6)        
} SCI_Parity_e;


typedef enum
{
  SCI_Priority_Immediate=(0 << 3),    
  SCI_Priority_FreeRun=(1 << 3),      
  SCI_Priority_AfterRxRxSeq=(2 << 3)  
} SCI_Priority_e;


typedef enum
{
  SCI_FifoLevel_Empty=(0 << 0),      
  SCI_FifoLevel_1_Word=(1 << 0),     
  SCI_FifoLevel_2_Words=(2 << 0),    
  SCI_FifoLevel_3_Words=(3 << 0),    
  SCI_FifoLevel_4_Words=(4 << 0)     
} SCI_FifoLevel_e;


typedef enum
{
  SCI_FifoStatus_Empty=(0 << 8),      
  SCI_FifoStatus_1_Word=(1 << 8),     
  SCI_FifoStatus_2_Words=(2 << 8),    
  SCI_FifoStatus_3_Words=(3 << 8),    
  SCI_FifoStatus_4_Words=(4 << 8)     
}  SCI_FifoStatus_e;


typedef struct _SCI_Obj_
{
  volatile uint16_t      SCICCR;        
  volatile uint16_t      SCICTL1;       
  volatile uint16_t      SCIHBAUD;      
  volatile uint16_t      SCILBAUD;      
  volatile uint16_t      SCICTL2;       
  volatile uint16_t      SCIRXST;       
  volatile uint16_t      SCIRXEMU;      
  volatile uint16_t      SCIRXBUF;      
  volatile uint16_t      rsvd_1;        
  volatile uint16_t      SCITXBUF;      
  volatile uint16_t      SCIFFTX;       
  volatile uint16_t      SCIFFRX;       
  volatile uint16_t      SCIFFCT;       
  volatile uint16_t      rsvd_2[2];     
  volatile uint16_t      SCIPRI;        
} SCI_Obj;


typedef struct _SCI_Obj_ *SCI_Handle;


// **************************************************************************
// the globals


// **************************************************************************
// the function prototypes

extern void SCI_clearAutoBaudDetect(SCI_Handle sciHandle);


extern void SCI_clearRxFifoOvf(SCI_Handle sciHandle);


extern void SCI_clearRxFifoInt(SCI_Handle sciHandle);


extern void SCI_clearTxFifoInt(SCI_Handle sciHandle);


extern void SCI_disable(SCI_Handle sciHandle);


extern void SCI_disableAutoBaudAlign(SCI_Handle sciHandle);


extern void SCI_disableLoopBack(SCI_Handle sciHandle);


extern void SCI_disableParity(SCI_Handle sciHandle);


extern void SCI_disableRx(SCI_Handle sciHandle);


extern void SCI_disableRxErrorInt(SCI_Handle sciHandle);


extern void SCI_disableRxFifoInt(SCI_Handle sciHandle);


extern void SCI_disableRxInt(SCI_Handle sciHandle);


extern void SCI_disableSleep(SCI_Handle sciHandle);


extern void SCI_disableTx(SCI_Handle sciHandle);


extern void SCI_disableTxFifoEnh(SCI_Handle sciHandle);


extern void SCI_disableTxFifoInt(SCI_Handle sciHandle);


extern void SCI_disableTxInt(SCI_Handle sciHandle);


extern void SCI_disableTxWake(SCI_Handle sciHandle);


extern void SCI_enable(SCI_Handle sciHandle);


extern void SCI_enableAutoBaudAlign(SCI_Handle sciHandle);


extern void SCI_enableChannels(SCI_Handle sciHandle);


extern void SCI_enableLoopBack(SCI_Handle sciHandle);


extern void SCI_enableParity(SCI_Handle sciHandle);


extern void SCI_enableRx(SCI_Handle sciHandle);


extern void SCI_enableRxErrorInt(SCI_Handle sciHandle);


extern void SCI_enableRxInt(SCI_Handle sciHandle);


extern void SCI_enableSleep(SCI_Handle sciHandle);


extern void SCI_enableRxFifo(SCI_Handle sciHandle);


extern void SCI_enableRxFifoInt(SCI_Handle sciHandle);


extern void SCI_enableTx(SCI_Handle sciHandle);


extern void SCI_enableTxFifo(SCI_Handle sciHandle);


extern void SCI_enableTxFifoEnh(SCI_Handle sciHandle);


extern void SCI_enableTxFifoInt(SCI_Handle sciHandle);


extern void SCI_enableTxInt(SCI_Handle sciHandle);


extern void SCI_enableTxWake(SCI_Handle sciHandle);


extern uint16_t SCI_getDataBlocking(SCI_Handle sciHandle);


extern uint16_t SCI_getDataNonBlocking(SCI_Handle sciHandle, uint16_t * success);


extern SCI_FifoStatus_e SCI_getRxFifoStatus(SCI_Handle sciHandle);


extern SCI_FifoStatus_e SCI_getTxFifoStatus(SCI_Handle sciHandle);


extern SCI_Handle SCI_init(void *pMemory,const size_t numBytes);


extern void SCI_putDataBlocking(SCI_Handle sciHandle, uint16_t data);


extern uint16_t SCI_putDataNonBlocking(SCI_Handle sciHandle, uint16_t data);


static inline uint16_t SCI_read(SCI_Handle sciHandle)
{
  SCI_Obj *sci = (SCI_Obj *)sciHandle;


  // get the data
  uint16_t data = sci->SCIRXBUF;

  return(data);
} // end of SCI_read() function


extern void SCI_reset(SCI_Handle sciHandle);


extern void SCI_resetChannels(SCI_Handle sciHandle);


extern void SCI_resetRxFifo(SCI_Handle sciHandle);


extern void SCI_resetTxFifo(SCI_Handle sciHandle);


static inline bool SCI_rxDataReady(SCI_Handle sciHandle)
{
  SCI_Obj *sci = (SCI_Obj *)sciHandle;
  bool status;

  status = (sci->SCIRXST & SCI_SCIRXST_RXRDY_BITS) >> 6;

  return((bool)status);
} // end of SCI_rxDataReady() function


extern void SCI_setBaudRate(SCI_Handle sciHandle,const SCI_BaudRate_e baudRate);


extern void SCI_setCharLength(SCI_Handle sciHandle,const SCI_CharLength_e charLength);


extern void SCI_setMode(SCI_Handle sciHandle,const SCI_Mode_e mode);


extern void SCI_setNumStopBits(SCI_Handle sciHandle,const SCI_NumStopBits_e numBits);


extern void SCI_setPriority(SCI_Handle sciHandle,const SCI_Priority_e priority);


extern void SCI_setParity(SCI_Handle sciHandle,const SCI_Parity_e parity);


extern void SCI_setTxDelay(SCI_Handle sciHandle,const uint_least8_t delay);


extern void SCI_setTxFifoIntLevel(SCI_Handle sciHandle,const SCI_FifoLevel_e fifoLevel);


extern void SCI_setRxFifoIntLevel(SCI_Handle sciHandle,const SCI_FifoLevel_e fifoLevel);


static inline bool SCI_txReady(SCI_Handle sciHandle)
{
  SCI_Obj *sci = (SCI_Obj *)sciHandle;
  bool status;

  status = (sci->SCICTL2 & SCI_SCICTL2_TXRDY_BITS) >> 7;

  return((bool)status);
} // end of SCI_txReady() function


static inline void SCI_write(SCI_Handle sciHandle,const uint16_t data)
{
  SCI_Obj *sci = (SCI_Obj *)sciHandle;


  // write the data
  sci->SCITXBUF = data;

  return;
} // end of SCI_write() function


#ifdef __cplusplus
}
#endif // extern "C"

#endif // end of _SCI_H_ definition