/* File: LED.H */

/****************************************************************************
* 
* STK16XSW.LED
* ============
*
* Low level routines for LED control
*
* TQ-Systems GmbH                                                         
* ---------------                                                         
* Customer: TQ-Components
* Project : STK16XSW
* Tools   : uVision 2.05
*
* Rev: Date:     Name:            Modification:
* ----+---------+----------------+------------------------------------------
* 100  16.01.01  A. Lichte        taken over from STK16X.506                
*****************************************************************************/

#include "header.h"

/*==========================================================================*
* extern available definitions (#DEFINE):
*===========================================================================*/

/*--------------------------------------------------------------------------*
* hardware definitions:
*---------------------------------------------------------------------------*/
#define LED_DIR_OUT    1         /* data direction register value: output  */

#define LED_0_DIR      DP2^0     /* data direction register: LED 0         */
#define LED_0          P2^0      /* data register:           LED 0         */
#define LED_0_ON       1         /* level for LED 0 ON                     */

#define LED_1_DIR      DP2^1     /* data direction register: LED 1         */
#define LED_1          P2^1      /* data register:           LED 1         */
#define LED_1_ON       1         /* level for LED 1 ON                     */

#define LED_2_DIR      DP2^2     /* data direction register: LED 2         */
#define LED_2          P2^2      /* data register:           LED 2         */
#define LED_2_ON       1         /* level for LED 2 ON                     */

#define LED_3_DIR      DP2^3     /* data direction register: LED 3         */
#define LED_3          P2^3      /* data register:           LED 3         */
#define LED_3_ON       1         /* level for LED 3 ON                     */

#define LED_4_DIR      DP2^4     /* data direction register: LED 4         */
#define LED_4          P2^4      /* data register:           LED 4         */
#define LED_4_ON       1         /* level for LED 4 ON                     */

#define LED_5_DIR      DP2^5     /* data direction register: LED 5         */
#define LED_5          P2^5      /* data register:           LED 5         */
#define LED_5_ON       1         /* level for LED 5 ON                     */

#define LED_6_DIR      DP2^6     /* data direction register: LED 6         */
#define LED_6          P2^6      /* data register:           LED 6         */
#define LED_6_ON       1         /* level for LED 6 ON                     */

#define LED_7_DIR      DP2^7     /* data direction register: LED 7         */
#define LED_7          P2^7      /* data register:           LED 7         */
#define LED_7_ON       1         /* level for LED 7 ON                     */

#define LED_8_DIR      DP2^8     /* data direction register: LED 8         */
#define LED_8          P2^8      /* data register:           LED 8         */
#define LED_8_ON       1         /* level for LED 8 ON                     */

#define LED_9_DIR      DP2^9     /* data direction register: LED 9         */
#define LED_9          P2^9      /* data register:           LED 9         */
#define LED_9_ON       1         /* level for LED 9 ON                     */

#define LED_10_DIR     DP2^10    /* data direction register: LED 10        */
#define LED_10         P2^10     /* data register:           LED 10        */
#define LED_10_ON      1         /* level for LED 10 ON                    */

#define LED_11_DIR     DP2^11    /* data direction register: LED 11        */
#define LED_11         P2^11     /* data register:           LED 11        */
#define LED_11_ON      1         /* level for LED 11 ON                    */

#define LED_12_DIR     DP2^12    /* data direction register: LED 12        */
#define LED_12         P2^12     /* data register:           LED 12        */
#define LED_12_ON      1         /* level for LED 12 ON                    */

#define LED_13_DIR     DP2^13    /* data direction register: LED 13        */
#define LED_13         P2^13     /* data register:           LED 13        */
#define LED_13_ON      1         /* level for LED 13 ON                    */

#define LED_14_DIR     DP2^14    /* data direction register: LED 14        */
#define LED_14         P2^14     /* data register:           LED 14        */
#define LED_14_ON      1         /* level for LED 14 ON                    */

#define LED_15_DIR     DP2^15    /* data direction register: LED 15        */
#define LED_15         P2^15     /* data register:           LED 15        */
#define LED_15_ON      1         /* level for LED 15 ON                    */

/*--------------------------------------------------------------------------*
* LED blink frequency:
*---------------------------------------------------------------------------*/
#define LED_BLINK_DFLT 50        /* default LED blink intervall [10ms]     */

/*--------------------------------------------------------------------------*
* LED controlling definitions:
*---------------------------------------------------------------------------*/
#define LED_OFF        0x00
#define LED_ON         0x01
#define LED_BLINK      0x02
#define LED_UNDEF      0xFF

#define LED_MIN        0
#define LED_MAX        15

/*--------------------------------------------------------------------------*
* general definitions:
*---------------------------------------------------------------------------*/

/*==========================================================================*
* extern available type definitions (TYPEDEF):
*===========================================================================*/

/*==========================================================================*
* extern available constants (CONST):
*===========================================================================*/

/*==========================================================================*
* globale extern available variables (EXTERN):
*===========================================================================*/

/*==========================================================================*
* extern available functions:
*===========================================================================*/

/*--------------------------------------------------------------------------*
* void led_init()
*---------------------------------------------------------------------------*
* FT: init LED control and data ports
* EP: -
* RV: -
* GP: LED_DIR_OUT, LED_0_ON, LED_1_ON, LED_2_ON, LED_3_ON, LED_4_ON,
*     LED_5_ON, LED_6_ON, LED_7_ON
*---------------------------------------------------------------------------*/ 
void led_init();

/*--------------------------------------------------------------------------*
* void led_clrall();
*---------------------------------------------------------------------------*
* FT: reset all LEDs
* EP: -
* RW: -
* GP: LED_MIN, LED_MAX, LED_OFF
*---------------------------------------------------------------------------*/ 
void led_clrall();

/*--------------------------------------------------------------------------*
* void led_idle()
*---------------------------------------------------------------------------*
* FT: idle function for LED handling (blinking etc.)
* EP: -
* RV: -
* GP: -
*---------------------------------------------------------------------------*/ 
void led_idle();

/*--------------------------------------------------------------------------*
* BOOL led_set(BYTE led_num, BYTE state);
*---------------------------------------------------------------------------*
* FT: LED controlling
* EP: led_num = number of LED to be set
*     state   = LED state (LED_OFF, LED_ON, LED_BLINK)
* RV: TRUE = function successfully; FALSE = invalid LED number
* GP: LED_MIN, LED_MAX, led_state
*---------------------------------------------------------------------------*/ 
BOOL led_set(BYTE led_num, BYTE state);

/*--------------------------------------------------------------------------*
* BYTE led_get(BYTE led_num);
*---------------------------------------------------------------------------*
* FT: get current led state
* EP: led_num = number of LED to be detected
* RV: LED state (LED_UNDEF if invalid LED number)
* GP: LED_MIN, LED_MAX, LED_UNDEF, led_state
*---------------------------------------------------------------------------*/ 
BYTE led_get(BYTE led_num);