//*****************************************************************************
//
// switches.h - Prototypes for the switch handling functinos.
//
// 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 __SWITCHES_H__
#define __SWITCHES_H__

//*****************************************************************************
//
//! \addtogroup main_switches_api
//! @{
//
//*****************************************************************************

//*****************************************************************************
//
//! The bit field in the value returned by SwitchesRead() and
//! SwitchesLimitRead() that indicates that the X home limit switch is engaged.
//! SwitchesRead() doesn't distinguish between the two X limit switches, so
//! this bit field will be returned by SwitchesRead() if either switch is
//! engaged.
//
//*****************************************************************************
#define SWITCH_LIMIT_X_MINUS    0x00000001

//*****************************************************************************
//
//! The bit field in the value returned by SwitchesRead() and
//! SwitchesLimitRead() that indicates that the X limit switch is engaged.
//! SwitchesRead() doesn't distinguish between the two X limit switches, so
//! this bit field will be returned by SwitchesRead() if either switch is
//! engaged.
//
//*****************************************************************************
#define SWITCH_LIMIT_X_PLUS     0x00000002

//*****************************************************************************
//
//! The bit fields in the value returned by SwitchesRead() that are set if
//! either of the X limit switches are engaged.
//
//*****************************************************************************
#define SWITCH_LIMIT_X          (SWITCH_LIMIT_X_MINUS | SWITCH_LIMIT_X_PLUS)

//*****************************************************************************
//
//! The bit field in the value returned by SwitchesRead() and
//! SwitchesLimitRead() that indicates that the Y home limit switch is engaged.
//! SwitchesRead() doesn't distinguish between the two Y limit switches, so
//! this bit field will be returned by SwitchesRead() if either switch is
//! engaged.
//
//*****************************************************************************
#define SWITCH_LIMIT_Y_MINUS    0x00000004

//*****************************************************************************
//
//! The bit field in the value returned by SwitchesRead() and
//! SwitchesLimitRead() that indicates that the Y limit switch is engaged.
//! SwitchesRead() doesn't distinguish between the two Y limit switches, so
//! this bit field will be returned by SwitchesRead() if either switch is
//! engaged.
//
//*****************************************************************************
#define SWITCH_LIMIT_Y_PLUS     0x00000008

//*****************************************************************************
//
//! The bit fields in the value returned by SwitchesRead() that are set if
//! either of the Y limit switches are engaged.
//
//*****************************************************************************
#define SWITCH_LIMIT_Y          (SWITCH_LIMIT_Y_MINUS | SWITCH_LIMIT_Y_PLUS)

//*****************************************************************************
//
//! The bit field in the value returned by SwitchesRead() and
//! SwitchesLimitRead() that indicates that the Z home limit switch is engaged.
//! SwitchesRead() doesn't distinguish between the two Z limit switches, so
//! this bit field will be returned by SwitchesRead() if either switch is
//! engaged.
//
//*****************************************************************************
#define SWITCH_LIMIT_Z_MINUS    0x00000010

//*****************************************************************************
//
//! The bit field in the value returned by SwitchesRead() and
//! SwitchesLimitRead() that indicates that the Z limit switch is engaged.
//! SwitchesRead() doesn't distinguish between the two Z limit switches, so
//! this bit field will be returned by SwitchesRead() if either switch is
//! engaged.
//
//*****************************************************************************
#define SWITCH_LIMIT_Z_PLUS     0x00000020

//*****************************************************************************
//
//! The bit fields in the value returned by SwitchesRead() that are set if
//! either of the Z limit switches are engaged.
//
//*****************************************************************************
#define SWITCH_LIMIT_Z          (SWITCH_LIMIT_Z_MINUS | SWITCH_LIMIT_Z_PLUS)

//*****************************************************************************
//
//! The bit field in the value returned by SwitchesRead() and
//! SwitchesLimitRead() that indicates that the panic switch is engaged.
//
//*****************************************************************************
#define SWITCH_SHUTDOWN         0x00000040

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

//*****************************************************************************
//
// Prototypes for the switch handling functions.
//
//*****************************************************************************
extern void GPIOEIntHandler(void);
extern unsigned long SwitchesRead(void);
extern unsigned long SwitchesLimitRead(void);
extern void SwitchesInit(void);

#endif // __SWITCHES_H__