//OpenSCADA module DAQ.DiamondBoards file: diamond.h
/***************************************************************************
 *   Copyright (C) 2005-2024 by Roman Savochenko, <roman@oscada.org>       *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; version 2 of the License.               *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/

#ifndef DIAMOND_H
#define DIAMOND_H

#include <tmodule.h>
#include <tcontroller.h>
#include <ttypedaq.h>
#include <tparamcontr.h>

#include <string>
#include <vector>

#include "dscud.h"

#undef _
#define _(mess) mod->I18N(mess).c_str()
#undef trS
#define trS(mess) mod->I18N(mess,mess_PreSave)

using std::string;
using std::vector;
using namespace OSCADA;

namespace Diamond
{
//*************************************************
//* DevFeature                                    *
//*************************************************
class DevFeature
{
    public:
	//Data
	struct rng { float min, max; };
	//Functions
	DevFeature( const string &inm, unsigned iAI, unsigned iAO = 0, unsigned iDIO = 0, unsigned iDI = 0, unsigned iDO = 0 ) :
	    name(inm), AI(iAI), AO(iAO), DIO(iDIO), DI(iDI), DO(iDO), aiSzFIFO(48)	{ }
	DevFeature( ) : AI(0), AO(0), DIO(0), DI(0), DO(0), aiSzFIFO(46)		{ }

	void setAITypes( const string &vl );
	void setAOTypes( const string &vl )	{ aoTypes = vl; }

	string	 name;	//Device name

	unsigned AI;	//[res][smpl][cnls]	0x6410	smpl:interrupted samplerate into ksml/s; res:A/D resolution (bits), default 16
	unsigned AO;	//[res][cnls]		res:D/A resolution (bits), default 12
	unsigned DIO;	//[ports]	0x0002  ports*8
	unsigned DI;	//[ports]	0x0002  ports*8
	unsigned DO;	//[ports]	0x0002  ports*8

	string	aiTypes,	//Two string with modes indexes and names. Indexes code: [diff|range|polar][gain]
		aoTypes;	//Two string with modes indexes and names. Indexes code: [daPol|range|polar][gain]
	int	aiSzFIFO;	//Size FIFO for board, default is minimal 46.
	map<int, rng>	aiRngs;	//Parsed from aiTypes ranges for voltage values calculate
};

//*************************************************
//* TMdPrm                                        *
//*************************************************
class TMdContr;

class TMdPrm : public TParamContr
{
    public:
	//Data
	enum AIMode	{ AIM_CODE = 0, AIM_PERC, AIM_VOLT };

	//Methods
	TMdPrm( string name, TTypeParam *tp_prm );
	~TMdPrm( );

	TElem &elem( )		{ return pEl; }

	void enable( );
	void disable( );

	void getVals( const string &atr = "", bool start = false, bool stop = false );
	string modPrm( const string &prm, const string &def = "" );

	void setModPrm( const string &prm, const string &val );

	TMdContr &owner( ) const;

    private:
	//Methods
	void postEnable( int flag );
	void cntrCmdProc( XMLNode *opt );
	void vlGet( TVal &vo );
	void vlSet( TVal &vo, const TVariant &vl, const TVariant &pvl );
	void vlArchMake( TVal &vo );

	string errDSC( const string &func );

	//Attributes
	TElem	pEl;		//Work atribute elements
	int64_t	&mTP,		//Board type
		&mADDR,		//Board address
		&mINT,		//Board interrupt
		&mS_RATE,	//Sample rate
		&mAImode;	//AI values mode
	char	&asynchRd;	//Asynchronous reading

	ResRW	devRes;		//Resource for access to device
	DevFeature dev;		//Device info
	DSCB	dscb;		//Board descriptor
	uint32_t dInOutRev[10];	//Up to 10 channels with 32 io each
	ResString acqErr;	//Acquisition error status

	// Interrupt AI mode
	int	aiScInt;	//Analog inputs scan period. Too big will drop sample rate for some values
	DSCS	dscs;		//Sample structure
	DSCAIOINT dscaioint;	//Interrupt IO mode description
	DWORD	prevTrans;	//Previous processed transfer
	int64_t	cTm, diffTm;	//Current time by DAQ board's clock and it divergency measurement start time
	unsigned st_overflows, st_lostcycles, st_sRateCor;
	double	st_drift;
};

//*************************************************
//* TMdContr                                      *
//*************************************************
class TTpContr;

class TMdContr: public TController
{
    friend class TMdPrm;
    public:
	//Methods
	TMdContr( string name_c, const string &daq_db, TElem *cfgelem );
	~TMdContr( );

	string tblStd( const TTypeParam &tP ) const;

	string	getStatus( );

	int64_t	period( )	{ return mPer; }
	string	cron( )		{ return mSched; }
	int64_t	prior( )	{ return mPrior; }
	int64_t	lag( )		{ return mLag; }

	AutoHD<TMdPrm> at( const string &nm )	{ return TController::at(nm); }

	void prmEn( const string &id, bool val );

    protected:
	//Methods
	void start_( );
	void stop_( );
	void cntrCmdProc( XMLNode *opt );	//Control interface command process
	bool cfgChange( TCfg &co, const TVariant &pc );

    private:
	//Methods
	TParamContr *ParamAttach( const string &name, int type );
	static void *Task( void *icntr );

	//Attributes
	ResRW	enRes;			//Resource for enable params
	int64_t	&mPrior;		//Process task priority
	TCfg	&mSched;		//Calc schedule
	int64_t	mPer, mLag;

	bool	prcSt,			//Process task active
		callSt;			//Calc now stat
	vector< AutoHD<TMdPrm> > pHd;
};

//*************************************************
//* TTpContr                                      *
//*************************************************
class TTpContr: public TTypeDAQ
{
    public:
	//Methods
	TTpContr( string name );
	~TTpContr( );

	bool drvInitOk( )	{ return mInit; }
	void postEnable( int flag );

	//Attributes
	map<int, DevFeature> devs;

    private:
	//Methods
	TController *ContrAttach( const string &name, const string &daq_db );
	bool redntAllow( )	{ return true; }

	//Attributes
	bool	mInit;
};

extern TTpContr *mod;

} //End namespace

#endif //DIAMOND_H