// -----------------------------------------------------------------------------
/// @file  PCBA.h
/// @brief File description
// -----------------------------------------------------------------------------
//  Micro-Key bv
//  Industrieweg 28, 9804 TG Noordhorn
//  Postbus 92, 9800 AB Zuidhorn
//  The Netherlands
//  Tel: +31 594 503020
//  Fax: +31 594 505825
//  Email: support@microkey.nl
//  Web: www.microkey.nl
// -----------------------------------------------------------------------------
/// $Revision$
/// $Author$
/// $Date$
//  (c) 2015 Micro-Key bv
// -----------------------------------------------------------------------------

/**
 * Pcba implementation
 * \defgroup Pcba Package Pcba
 * \ingroup Platform
 * @{
 */

#ifndef PCBA_H_
#define PCBA_H_


// -----------------------------------------------------------------------------
// Include files 
// -----------------------------------------------------------------------------
#include "stm32f10x.h"

#include "platform.h"

// -----------------------------------------------------------------------------
// Constant and macro definitions 
// -----------------------------------------------------------------------------



// -----------------------------------------------------------------------------
// Type definitions. 
// -----------------------------------------------------------------------------

typedef enum
{
   PCBA_CathodeMCP = 0,
   PCBA_Tesla = 1,
   PCBA_Anode = 2,
   PCBA_ND = 3
}PCBA_t;

struct Pcba
{
   PCBA_t pcba;
   char name[20];
   T_PL_GPIO A0;
   T_PL_GPIO A1;
};

// -----------------------------------------------------------------------------
// Function declarations 
// -----------------------------------------------------------------------------


/** ----------------------------------------------------------------------------
 * PCBA_construct
 * Initializes the PCBA information of the hardware.
 * PCBA information is defined via placed resistors
 * This function creates a singleton. Calling this function for the first time
 * constructs the PCBA information. Calling it afterwards returns the already
 * constructed data
 *
 * @return	struct Pcba*               The PCBA information singelton
 *
 *
 * @todo
 * -----------------------------------------------------------------------------
 */
extern struct Pcba* PCBA_getInstance(void);


/** ----------------------------------------------------------------------------
 * PCBA_setIO
 * Sets the IO used for PCBA detection
 *
 * @param	A0                         Input 0
 * @param	A1                         Input 1
 *
 * @return	ErrorStatus                SUCCESS if setting was successful
 *                                     ERROR otherwise
 *
 * @todo
 * -----------------------------------------------------------------------------
 */
extern ErrorStatus PCBA_setIO(T_PL_GPIO* A0, T_PL_GPIO* A1);

#endif /* PCBA_H_ */

/** @} */