Subversion Repositories openrisc

//*****************************************************************************

//

// ssi.h - Prototypes for the Synchronous Serial Interface Driver.

//

// Copyright (c) 2005-2008 Luminary Micro, Inc.  All rights reserved.

// 

// Software License Agreement

// 

// Luminary Micro, Inc. (LMI) is supplying this software for use solely and

// exclusively on LMI's microcontroller products.

// 

// The software is owned by LMI and/or its suppliers, and is protected under

// applicable copyright laws.  All rights are reserved.  You may not combine

// this software with "viral" open-source software in order to form a larger

// program.  Any use in violation of the foregoing restrictions may subject

// the user to criminal sanctions under applicable laws, as well as to civil

// liability for the breach of the terms and conditions of this license.

// 

// THIS SOFTWARE IS PROVIDED "AS IS".  NO WARRANTIES, WHETHER EXPRESS, IMPLIED

// OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF

// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE.

// LMI SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR

// CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.

// 

// This is part of revision 2523 of the Stellaris Peripheral Driver Library.

//

//*****************************************************************************

#ifndef __SSI_H__

#define __SSI_H__

//*****************************************************************************

//

// If building with a C++ compiler, make all of the definitions in this header

// have a C binding.

//

//*****************************************************************************

#ifdef __cplusplus

extern "C"

{

#endif

//*****************************************************************************

//

// Values that can be passed to SSIIntEnable, SSIIntDisable, and SSIIntClear

// as the ulIntFlags parameter, and returned by SSIIntStatus.

//

//*****************************************************************************

#define SSI_TXFF                0x00000008  // TX FIFO half empty or less

#define SSI_RXFF                0x00000004  // RX FIFO half full or less

#define SSI_RXTO                0x00000002  // RX timeout

#define SSI_RXOR                0x00000001  // RX overrun

//*****************************************************************************

//

// Values that can be passed to SSIConfigSetExpClk.

//

//*****************************************************************************

#define SSI_FRF_MOTO_MODE_0     0x00000000  // Moto fmt, polarity 0, phase 0

#define SSI_FRF_MOTO_MODE_1     0x00000002  // Moto fmt, polarity 0, phase 1

#define SSI_FRF_MOTO_MODE_2     0x00000001  // Moto fmt, polarity 1, phase 0

#define SSI_FRF_MOTO_MODE_3     0x00000003  // Moto fmt, polarity 1, phase 1

#define SSI_FRF_TI              0x00000010  // TI frame format

#define SSI_FRF_NMW             0x00000020  // National MicroWire frame format

#define SSI_MODE_MASTER         0x00000000  // SSI master

#define SSI_MODE_SLAVE          0x00000001  // SSI slave

#define SSI_MODE_SLAVE_OD       0x00000002  // SSI slave with output disabled

//*****************************************************************************

//

// Values that can be passed to SSIDMAEnable() and SSIDMADisable().

//

//*****************************************************************************

#define SSI_DMA_TX              0x00000002  // Enable DMA for transmit

#define SSI_DMA_RX              0x00000001  // Enable DMA for receive

//*****************************************************************************

//

// Prototypes for the APIs.

//

//*****************************************************************************

extern void SSIConfigSetExpClk(unsigned long ulBase, unsigned long ulSSIClk,

                               unsigned long ulProtocol, unsigned long ulMode,

                               unsigned long ulBitRate,

                               unsigned long ulDataWidth);

extern void SSIDataGet(unsigned long ulBase, unsigned long *pulData);

extern long SSIDataGetNonBlocking(unsigned long ulBase,

                                  unsigned long *pulData);

extern void SSIDataPut(unsigned long ulBase, unsigned long ulData);

extern long SSIDataPutNonBlocking(unsigned long ulBase, unsigned long ulData);

extern void SSIDisable(unsigned long ulBase);

extern void SSIEnable(unsigned long ulBase);

extern void SSIIntClear(unsigned long ulBase, unsigned long ulIntFlags);

extern void SSIIntDisable(unsigned long ulBase, unsigned long ulIntFlags);

extern void SSIIntEnable(unsigned long ulBase, unsigned long ulIntFlags);

extern void SSIIntRegister(unsigned long ulBase, void(*pfnHandler)(void));

extern unsigned long SSIIntStatus(unsigned long ulBase, tBoolean bMasked);

extern void SSIIntUnregister(unsigned long ulBase);

extern void SSIDMAEnable(unsigned long ulBase, unsigned long ulDMAFlags);

extern void SSIDMADisable(unsigned long ulBase, unsigned long ulDMAFlags);

//*****************************************************************************

//

// Several SSI APIs have been renamed, with the original function name being

// deprecated.  These defines provide backward compatibility.

//

//*****************************************************************************

#ifndef DEPRECATED

#include "sysctl.h"

#define SSIConfig(a, b, c, d, e)                            \

        SSIConfigSetExpClk(a, SysCtlClockGet(), b, c, d, e)

#define SSIDataNonBlockingGet(a, b) \

        SSIDataGetNonBlocking(a, b)

#define SSIDataNonBlockingPut(a, b) \

        SSIDataPutNonBlocking(a, b)

#endif

//*****************************************************************************

//

// Mark the end of the C bindings section for C++ compilers.

//

//*****************************************************************************

#ifdef __cplusplus

}

#endif

#endif // __SSI_H__