main.h

Luminary Micro BLDC motor control software

//*****************************************************************************
//
// main.h - Prototypes for the Brushless DC motor drive main application.
//
// Copyright (c) 2007-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 716 of the BLDC motor application.
//
//*****************************************************************************

#ifndef __MAIN_H__
#define __MAIN_H__

//*****************************************************************************
//
//! \addtogroup main_api
//! @{
//
//*****************************************************************************

//*****************************************************************************
//
//! The frequency of the crystal attached to the microcontroller.  This must
//! match the crystal value passed to SysCtlClockSet() in main().
//
//*****************************************************************************
#define CRYSTAL_CLOCK           6000000

//*****************************************************************************
//
//! The frequency of the processor clock, which is also the clock rate of all
//! the peripherals.  This must match the value configured by SysCtlClockSet()
//! in main().
//
//*****************************************************************************
#define SYSTEM_CLOCK            50000000

//*****************************************************************************
//
//! The watchdog timer reload value.
//
//*****************************************************************************
#define WATCHDOG_RELOAD_VALUE   (SYSTEM_CLOCK / 2)

//*****************************************************************************
//
//! The address of the first block of flash to be used for storing parameters.
//
//*****************************************************************************
#define FLASH_PB_START          0x0003f000

//*****************************************************************************
//
//! The address of the last block of flash to be used for storing parameters.
//! Since the end of flash is used for parameters, this is actually the first
//! address past the end of flash.
//
//*****************************************************************************
#define FLASH_PB_END            0x00040000

//*****************************************************************************
//
//! The size of the parameter block to save. This must be a power of 2,
//! and should be large enough to contain the tDriveParameters structure
//! (see the ui.h file).
//
//*****************************************************************************
#define FLASH_PB_SIZE           128

//*****************************************************************************
//
// Close the Doxyen group.
//! @}
//
//*****************************************************************************

//*****************************************************************************
//
// Prototypes for the exported variables and functions.
//
//*****************************************************************************
extern unsigned long g_ulFaultFlags;
extern unsigned char g_ucMotorStatus;
extern unsigned long g_ulAngle;
extern unsigned long g_ulMeasuredSpeed;
extern void MainSetPWMFrequency(void);
extern void MainSetSpeed(void);
extern void MainSetDirection(tBoolean bForward);
extern void MainUpdateFAdjI(long lNewFAdjI);
extern void MainWaveformTick(void);
extern void MainMillisecondTick(void);
extern void MainRun(void);
extern void MainStop(void);
extern void MainEmergencyStop(void);
extern unsigned long MainIsRunning(void);
extern unsigned long MainIsReverse(void);
extern void MainSetFault(unsigned long ulFaultFlag);
extern void MainClearFaults(void);
extern unsigned long MainIsFaulted(void);
extern void NmiSR(void);
extern void FaultISR(void);
extern void DefaultIntHandler(void);

#endif // __MAIN_H__