/*****************************************************************************

    resnet.h

    Compute weights for resistors networks.

    Copyright (c) 1996-2007, Nicola Salmoria and the MAME Team.
    Visit http://mamedev.org for licensing and usage restrictions.

*****************************************************************************/

#pragma once

#ifndef _RESNET_H_
#define _RESNET_H_

/**********************************************************************
 *      Rbias
 * Vbias >-ZZZ-.    .-----------------------------------------> Out0
 *             |    |                           Vcc
 *          R0 |    |                            |
 *   In0 >-ZZZ-+----+               Vcc          Z
 *             |    |                |           Z
 *          R1 |    |               /            Z
 *   In1 >-ZZZ-+    +----+----ZZZ--|   NPN       +------------> Out1
 *             :         |          >           <
 *             :         |           +----+----|  PNP
 *          R8 |         |           Z    |     \
 *   In8 >-ZZZ-+         |           Z    |      |
 *             |         |           Z    |     Gnd
 *             Z         |           |    '-------------------> Out2
 *             Z Rgnd    |          Gnd
 *             Z         |   |-----------------------|
 *             |         `---| max(vmin,min(sig-vcut)|--------> Out3
 *            Gnd            |-----------------------|
 *
 *********************************************************************/

/* Amplifier stage per channel but may be specified globally as default */

#define RES_NET_AMP_USE_GLOBAL		0x0000
#define RES_NET_AMP_NONE			0x0001		//Out0
#define RES_NET_AMP_DARLINGTON		0x0002		//Out1
#define RES_NET_AMP_EMITTER			0x0003		//Out2
#define RES_NET_AMP_CUSTOM			0x0004		//Out3
#define RES_NET_AMP_MASK			0x0007

/* VCC prebuilds - Global */

#define RES_NET_VCC_5V				0x0000
#define RES_NET_VCC_CUSTOM			0x0008
#define RES_NET_VCC_MASK			0x0008

/* VBias prebuils - per channel but may be specified globally as default */

#define RES_NET_VBIAS_USE_GLOBAL	0x0000
#define RES_NET_VBIAS_5V			0x0010
#define RES_NET_VBIAS_TTL			0x0020
#define RES_NET_VBIAS_CUSTOM		0x0030
#define RES_NET_VBIAS_MASK			0x0030

/* Input Voltage levels - Global */

#define RES_NET_VIN_OPEN_COL		0x0000
#define RES_NET_VIN_VCC				0x0100
#define RES_NET_VIN_TTL_OUT			0x0200
#define RES_NET_VIN_CUSTOM			0x0300
#define RES_NET_VIN_MASK			0x0300

/* Monitor options */

// Just invert the signal
#define RES_NET_MONITOR_INVERT		0x1000
// SANYO_EZV20 / Nintendo with inverter circuit
#define RES_NET_MONITOR_SANYO_EZV20	0x2000
#define RES_NET_MONITOR_MASK		0x3000

/* General defines */

#define RES_NET_CHAN_RED			0x00
#define RES_NET_CHAN_GREEN			0x01
#define RES_NET_CHAN_BLUE			0x02

/* Some aliases */

#define RES_NET_VIN_MB7052 			RES_NET_VIN_TTL_OUT
#define RES_NET_VIN_MB7053 			RES_NET_VIN_TTL_OUT
#define RES_NET_VIN_28S42 			RES_NET_VIN_TTL_OUT

/* Structures */

typedef struct _res_net_channel_info res_net_channel_info;
struct _res_net_channel_info {
	// per channel options
	UINT32	options;
	// Pullup resistor value in Ohms
	double	rBias;
	// Pulldown resistor value in Ohms
	double	rGnd;
	// Number of inputs connected to resistors
	int		num;
	// Resistor values
	// - Least significant bit first
	double R[8];
	// Minimum output voltage
	// - Applicable if output is routed through a complimentary
	// - darlington circuit
	// - typical value ~ 0.9V
	double	minout;
	// Cutoff output voltage
	// - Applicable if output is routed through 1:1 transistor amplifier
	// - Typical value ~ 0.7V
	double	cut;
	// Voltage at the pullup resistor
	// - Typical voltage ~5V
	double	vBias;
};

typedef struct _res_net_info res_net_info;
struct _res_net_info {
	// global options
	UINT32	options;
	// The three color channels
	res_net_channel_info rgb[3];
	// Supply Voltage
	// - Typical value 5V
	double	vcc;
	// High Level output voltage
	// - TTL : 3.40V
	// - CMOS: 4.95V (@5v vcc)
	double	vOL;
	// Low Level output voltage
	// - TTL : 0.35V
	// - CMOS: 0.05V (@5v vcc)
	double	vOH;
	// Open Collector flag
	UINT8	OpenCol;
};

#define RES_NET_MAX_COMP	3

typedef struct _res_net_decode_info res_net_decode_info;
struct _res_net_decode_info {
	int	numcomp;
	int	start;
	int	end;
	UINT16	offset[3 * RES_NET_MAX_COMP];
	INT16	shift[3 * RES_NET_MAX_COMP];
	UINT16 	mask[3 * RES_NET_MAX_COMP];
};

/* return a single value for one channel */

int compute_res_net(int inputs, int channel, const res_net_info *di);

/* compute all values */

rgb_t *compute_res_net_all(const UINT8 *prom, const res_net_decode_info *rdi, const res_net_info *di);


/* legacy interface */

double compute_resistor_weights(
	int minval, int maxval, double scaler,
	int count_1, const int * resistances_1, double * weights_1, int pulldown_1, int pullup_1,
	int count_2, const int * resistances_2, double * weights_2, int pulldown_2, int pullup_2,
	int count_3, const int * resistances_3, double * weights_3, int pulldown_3, int pullup_3 );

#define combine_8_weights(tab,w0,w1,w2,w3,w4,w5,w6,w7)	((int)(((tab)[0]*(w0) + (tab)[1]*(w1) + (tab)[2]*(w2) + (tab)[3]*(w3) + (tab)[4]*(w4) + (tab)[5]*(w5) + (tab)[6]*(w6) + (tab)[7]*(w7)) + 0.5))
#define combine_7_weights(tab,w0,w1,w2,w3,w4,w5,w6)		((int)(((tab)[0]*(w0) + (tab)[1]*(w1) + (tab)[2]*(w2) + (tab)[3]*(w3) + (tab)[4]*(w4) + (tab)[5]*(w5) + (tab)[6]*(w6)) + 0.5))
#define combine_6_weights(tab,w0,w1,w2,w3,w4,w5)		((int)(((tab)[0]*(w0) + (tab)[1]*(w1) + (tab)[2]*(w2) + (tab)[3]*(w3) + (tab)[4]*(w4) + (tab)[5]*(w5)) + 0.5))
#define combine_5_weights(tab,w0,w1,w2,w3,w4)			((int)(((tab)[0]*(w0) + (tab)[1]*(w1) + (tab)[2]*(w2) + (tab)[3]*(w3) + (tab)[4]*(w4)) + 0.5))
#define combine_4_weights(tab,w0,w1,w2,w3)				((int)(((tab)[0]*(w0) + (tab)[1]*(w1) + (tab)[2]*(w2) + (tab)[3]*(w3)) + 0.5))
#define combine_3_weights(tab,w0,w1,w2)					((int)(((tab)[0]*(w0) + (tab)[1]*(w1) + (tab)[2]*(w2)) + 0.5))
#define combine_2_weights(tab,w0,w1)					((int)(((tab)[0]*(w0) + (tab)[1]*(w1)) + 0.5))



/* this should be moved to one of the core files */

#define MAX_NETS 3
#define MAX_RES_PER_NET 18




/* for the open collector outputs PROMs */

double compute_resistor_net_outputs(
	int minval, int maxval, double scaler,
	int count_1, const int * resistances_1, double * outputs_1, int pulldown_1, int pullup_1,
	int count_2, const int * resistances_2, double * outputs_2, int pulldown_2, int pullup_2,
	int count_3, const int * resistances_3, double * outputs_3, int pulldown_3, int pullup_3 );



#endif /*_RESNET_H_*/
