/****************************************************************************/
/*             TEXAS INSTRUMENTS PROPRIETARY INFORMATION                    */
/*                                                                          */
/*  (c) Copyright, Texas Instruments Incorporated, 2007.                    */
/*      All Rights Reserved.                                                */
/*                                                                          */
/*  Property of Texas Instruments Incorporated. Restricted Rights -         */
/*  Use, duplication, or disclosure is subject to restrictions set          */
/*  forth in TI's program license agreement and associated documentation.   */
/****************************************************************************/

/****************************************************************************/
/* lmp_blst.h                                                               */
/*                                                                          */
/* This file contains the interface to UART enabled lamp ballasts           */
/****************************************************************************/

#ifndef __LMP_BLST_H
#define __LMP_BLST_H

/* Lamp UART return codes */
#define LMP_BLST_INUSEERR           -1      /* (0xFF) Lamp UART access contention error    */
#define LMP_BLST_TIMEOUT            -2      /* (0xFE) Lamp UART Command Timeout error      */
#define LMP_BLST_URTERR             -3      /* (0xFD) Lamp UART command/query Error        */
#define LMP_BLST_WAVEFORM_OOR       -4      /* (0xFC) Waveform specified out of range      */
#define LMP_BLST_NOSEQMATCH         -5      /* (0xFB) No Sequence match for the ballast manufacturer ID */
#define LMP_BLST_BALLASTERR         -6      /* (0xFA) Ballast return error status */
#define LMP_BLST_WAVEFORMGAIN_OOR   -7      /* (0xF9) Waveform gain specified out of range */

/* Public functions */
int08  LMP_BLST_EnableCommunication    (BOOL Enable);
BOOL   LMP_BLST_IsCommunicationEnabled (void);

int08  LMP_BLST_SetWaveform      (uint08 Waveform_Index);
uint08 LMP_BLST_GetNumWaveforms  (void);
int08  LMP_BLST_GetWaveformID    (uint08 *WaveformID);
uint08 LMP_BLST_GetWaveformIndex (void);

int08  LMP_BLST_SetWaveformGain  (uint08 Waveform_Gain);
uint08 LMP_BLST_GetWaveformGain  (void);
uint08 LMP_BLST_GetMinGain       (void);
uint08 LMP_BLST_GetMaxGain       (void);

int08  LMP_BLST_OpenMailBox      (uint16 StartAddr);
int08  LMP_BLST_WriteMailBox     (uint08 Data);
int08  LMP_BLST_ReadMailBox      (uint08 *Data);
int08  LMP_BLST_CloseMailBox     (void);
int08  LMP_BLST_GetMailboxStatus (uint16 *StartAddr, uint08 *MailboxAccess);

uint08 LMP_BLST_GetManufacturerID(void);
uint16 LMP_BLST_GetBallastID     (void);
int08  LMP_BLST_GetBallastStatus (uint08 *BallastStatus);

int08  LMP_BLST_GetLampStatus    (BOOL *LampSafeMode, int08 *LampERRCode);
int08  LMP_BLST_SetLampStatus    (BOOL  LampSafeMode, int08  LampERRCode);

#endif /* __LMP_BLST_H */