//*****************************************************************************
//
// stepper.h - Prototypes for the stepper motor control fucntions.
//
// Copyright (c) 2006-2007 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.  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 220 of sw01246.
//
//*****************************************************************************

#ifndef __STEPPER_H__
#define __STEPPER_H__

//*****************************************************************************
//
//! \addtogroup main_stepper_api
//! @{
//
//*****************************************************************************

//*****************************************************************************
//
//! This value, when passed to StepperXCurrent(), StepperYCurrent(), or
//! StepperZCurrent(), will set the current of the corresponding motor to the
//! running (i.e. rated) value.
//
//*****************************************************************************
#define CURRENT_RUNNING         0

//*****************************************************************************
//
//! This value, when passed to StepperXCurrent(), StepperYCurrent(), or
//! StepperZCurrent(), will set the current of the corresponding motor to the
//! holding value.
//
//*****************************************************************************
#define CURRENT_HOLDING         1

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

//*****************************************************************************
//
// Prototypes for the stepper motor control functions.
//
//*****************************************************************************
extern void StepperXStep(long lDir);
extern void StepperYStep(long lDir);
extern void StepperZStep(long lDir);
extern void StepperXCurrent(unsigned long ulCurrent);
extern void StepperYCurrent(unsigned long ulCurrent);
extern void StepperZCurrent(unsigned long ulCurrent);
extern void StepperInit(void);

#endif // __STEPPER_H__