mpy32.h

Go to the documentation of this file.

//*****************************************************************************
//
// mpy32.h - Driver for the MPY32 Module.
//
//*****************************************************************************
 
#ifndef __MSP430WARE_MPY32_H__
#define __MSP430WARE_MPY32_H__
 
#include "inc/hw_memmap.h"
 
#ifdef __MSP430_HAS_MPY32__
 
//*****************************************************************************
//
// If building with a C++ compiler, make all of the definitions in this header
// have a C binding.
//
//*****************************************************************************
#ifdef __cplusplus
extern "C"
{
#endif
 
#include "inc/hw_memmap.h"
 
//*****************************************************************************
//
// The following are values that can be passed to the writeDelaySelect
// parameter for functions: MPY32_setWriteDelay().
//
//*****************************************************************************
#define MPY32_WRITEDELAY_OFF                        (!(MPYDLY32 + MPYDLYWRTEN))
#define MPY32_WRITEDELAY_32BIT                                    (MPYDLYWRTEN)
#define MPY32_WRITEDELAY_64BIT                         (MPYDLY32 + MPYDLYWRTEN)
 
//*****************************************************************************
//
// The following are values that can be passed to the multiplicationType
// parameter for functions: MPY32_setOperandOne8Bit(),
// MPY32_setOperandOne16Bit(), MPY32_setOperandOne24Bit(), and
// MPY32_setOperandOne32Bit().
//
//*****************************************************************************
#define MPY32_MULTIPLY_UNSIGNED                                          (0x00)
#define MPY32_MULTIPLY_SIGNED                                            (0x02)
#define MPY32_MULTIPLYACCUMULATE_UNSIGNED                                (0x04)
#define MPY32_MULTIPLYACCUMULATE_SIGNED                                  (0x06)
 
//*****************************************************************************
//
// The following are values that can be passed toThe following are values that
// can be returned by the MPY32_getSaturationMode() function.
//
//*****************************************************************************
#define MPY32_SATURATION_MODE_DISABLED                                     0x00
#define MPY32_SATURATION_MODE_ENABLED                                    MPYSAT
 
//*****************************************************************************
//
// The following are values that can be passed toThe following are values that
// can be returned by the MPY32_getFractionalMode() function.
//
//*****************************************************************************
#define MPY32_FRACTIONAL_MODE_DISABLED                                     0x00
#define MPY32_FRACTIONAL_MODE_ENABLED                                   MPYFRAC
 
//*****************************************************************************
//
// Prototypes for the APIs.
//
//*****************************************************************************
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void MPY32_setWriteDelay(uint16_t writeDelaySelect);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void MPY32_enableSaturationMode(void);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void MPY32_disableSaturationMode(void);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern uint8_t MPY32_getSaturationMode(void);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void MPY32_enableFractionalMode(void);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void MPY32_disableFractionalMode(void);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern uint8_t MPY32_getFractionalMode(void);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void MPY32_setOperandOne8Bit(uint8_t multiplicationType,
                                    uint8_t operand);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void MPY32_setOperandOne16Bit(uint8_t multiplicationType,
                                     uint16_t operand);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void MPY32_setOperandOne24Bit(uint8_t multiplicationType,
                                     uint32_t operand);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void MPY32_setOperandOne32Bit(uint8_t multiplicationType,
                                     uint32_t operand);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void MPY32_setOperandTwo8Bit(uint8_t operand);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void MPY32_setOperandTwo16Bit(uint16_t operand);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void MPY32_setOperandTwo24Bit(uint32_t operand);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void MPY32_setOperandTwo32Bit(uint32_t operand);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern uint64_t MPY32_getResult(void);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern uint16_t MPY32_getSumExtension(void);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern uint16_t MPY32_getCarryBitValue(void);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void MPY32_clearCarryBitValue(void);
 
//*****************************************************************************
//
//
//*****************************************************************************
extern void MPY32_preloadResult(uint64_t result);
 
//*****************************************************************************
//
// Mark the end of the C bindings section for C++ compilers.
//
//*****************************************************************************
#ifdef __cplusplus
}
#endif
 
#endif
#endif // __MSP430WARE_MPY32_H__