driver-avalon8.h

/*
 * Copyright 2017 xuzhenxing <xuzhenxing@canaan-creative.com>
 * Copyright 2016-2017 Mikeqin <Fengling.Qin@gmail.com>
 * Copyright 2016 Con Kolivas <kernel@kolivas.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; either version 3 of the License, or (at your option)
 * any later version.  See COPYING for more details.
 */

#ifndef _AVALON8_H_
#define _AVALON8_H_

#include "util.h"
#include "i2c-context.h"

#ifdef USE_AVALON8

#define AVA8_FREQUENCY_MAX	1404

#define AVA8_DEFAULT_FAN_MIN		5 /* % */
#define AVA8_DEFAULT_FAN_MAX		100

#define AVA8_DEFAULT_TEMP_TARGET	90
#define AVA8_DEFAULT_TEMP_OVERHEAT	105

#define AVA8_DEFAULT_VOLTAGE_LEVEL_MIN	-15
#define AVA8_DEFAULT_VOLTAGE_LEVEL_MAX	15
#define AVA8_INVALID_VOLTAGE_LEVEL	-16

#define AVA8_DEFAULT_VOLTAGE_LEVEL_OFFSET_MIN	-2
#define AVA8_DEFAULT_VOLTAGE_LEVEL_OFFSET	0
#define AVA8_DEFAULT_VOLTAGE_LEVEL_OFFSET_MAX	1

#define AVA8_INVALID_ASIC_OTP	-1

#define AVA8_DEFAULT_FACTORY_INFO_0_MIN		-15
#define AVA8_DEFAULT_FACTORY_INFO_0		0
#define AVA8_DEFAULT_FACTORY_INFO_0_MAX		15
#define AVA8_DEFAULT_FACTORY_INFO_0_CNT		1
#define AVA8_DEFAULT_FACTORY_INFO_0_IGNORE	16

#define AVA8_DEFAULT_FACTORY_INFO_1_CNT		3

#define AVA8_DEFAULT_OVERCLOCKING_OFF 0
#define AVA8_DEFAULT_OVERCLOCKING_ON  1

#define AVA8_DEFAULT_FREQUENCY_0M	0
#define AVA8_DEFAULT_FREQUENCY_650M	650
#define AVA8_DEFAULT_FREQUENCY_725M	725
#define AVA8_DEFAULT_FREQUENCY_775M	775
#define AVA8_DEFAULT_FREQUENCY_850M	850
#define AVA8_DEFAULT_FREQUENCY_MAX	1200
#define AVA8_DEFAULT_FREQUENCY		(AVA8_DEFAULT_FREQUENCY_MAX)
#define AVA8_DEFAULT_FREQUENCY_SEL	3

#define AVA8_DEFAULT_MODULARS	7	/* Only support 6 modules maximum with one AUC */
#define AVA8_DEFAULT_MINER_CNT	4
#define AVA8_DEFAULT_ASIC_MAX	26
#define AVA8_DEFAULT_PLL_CNT	4
#define AVA8_DEFAULT_PMU_CNT	2
#define AVA8_DEFAULT_CORE_VOLT_CNT	8

#define AVA8_DEFAULT_POLLING_DELAY	20 /* ms */
#define AVA8_DEFAULT_NTIME_OFFSET	2

#define AVA8_DEFAULT_SMARTSPEED_OFF 0
#define AVA8_DEFAULT_SMARTSPEED_MODE1 1
#define AVA8_DEFAULT_SMART_SPEED	(AVA8_DEFAULT_SMARTSPEED_MODE1)

#define AVA8_DEFAULT_TH_PASS	160
#define AVA8_DEFAULT_TH_FAIL	8000
#define AVA8_DEFAULT_TH_INIT	32767
#define AVA8_DEFAULT_TH_ADD	1
#define AVA8_DEFAULT_TH_MS	5
#define AVA8_DEFAULT_TH_TIMEOUT	20000
#define AVA8_DEFAULT_NONCE_MASK 24
#define AVA8_DEFAULT_NONCE_CHECK	1
#define AVA8_DEFAULT_MUX_L2H	0
#define AVA8_DEFAULT_MUX_H2L	1
#define AVA8_DEFAULT_H2LTIME0_SPD	3
#define AVA8_DEFAULT_ROLL_ENABLE	1
#define AVA8_DEFAULT_SPDLOW            0
#define AVA8_DEFAULT_SPDHIGH           3
#define AVA8_INVALID_TH_PASS		-1
#define AVA8_INVALID_TH_FAIL		-1
#define AVA8_INVALID_TH_TIMEOUT		-1
#define AVA8_INVALID_NONCE_MASK		-1
#define AVA8_INVALID_SPDLOW		-1

#define AVA851_DEFAULT_TH_PASS		200
#define AVA851_DEFAULT_TH_FAIL		7000
#define AVA851_DEFAULT_TH_TIMEOUT	16000
#define AVA851_DEFAULT_SPDLOW		2
#define AVA851_DEFAULT_NONCE_MASK	27

#define AVA831_DEFAULT_TH_PASS		200
#define AVA831_DEFAULT_TH_FAIL		7000
#define AVA831_DEFAULT_TH_TIMEOUT	16000
#define AVA831_DEFAULT_SPDLOW		2
#define AVA831_DEFAULT_NONCE_MASK	27

/* PID CONTROLLER*/
#define AVA8_DEFAULT_PID_P		2
#define AVA8_DEFAULT_PID_I		5
#define AVA8_DEFAULT_PID_D		0
#define AVA8_DEFAULT_PID_TEMP_MIN	50
#define AVA8_DEFAULT_PID_TEMP_MAX	100

#define AVA8_DEFAULT_IIC_DETECT	false

#define AVA8_PWM_MAX	0x3FF
#define AVA8_DRV_DIFFMAX	2700
#define AVA8_ASIC_TIMEOUT_CONST	419430400 /* (2^32 * 1000) / (256 * 40) */

#define AVA8_MODULE_DETECT_INTERVAL	30 /* 30 s */

#define AVA8_AUC_VER_LEN	12	/* Version length: 12 (AUC-YYYYMMDD) */
#define AVA8_AUC_SPEED		400000
#define AVA8_AUC_XDELAY  	19200	/* 4800 = 1ms in AUC (11U14)  */
#define AVA8_AUC_P_SIZE		64

#define AVA8_CONNECTER_AUC	1
#define AVA8_CONNECTER_IIC	2

/* avalon8 protocol package type from MM protocol.h */
#define AVA8_MM_VER_LEN	15
#define AVA8_MM_DNA_LEN	8
#define AVA8_H1	'C'
#define AVA8_H2	'N'

#define AVA8_P_COINBASE_SIZE	(6 * 1024 + 64)
#define AVA8_P_MERKLES_COUNT	30

#define AVA8_P_COUNT	40
#define AVA8_P_DATA_LEN 32

#define AVA8_OTP_LEN	        32

/* Broadcase with block iic_write*/
#define AVA8_P_DETECT	0x10

/* Broadcase With non-block iic_write*/
#define AVA8_P_STATIC	0x11
#define AVA8_P_JOB_ID	0x12
#define AVA8_P_COINBASE	0x13
#define AVA8_P_MERKLES	0x14
#define AVA8_P_HEADER	0x15
#define AVA8_P_TARGET	0x16
#define AVA8_P_JOB_FIN	0x17

/* Broadcase or with I2C address */
#define AVA8_P_SET			0x20
#define AVA8_P_SET_FIN			0x21
#define AVA8_P_SET_VOLT			0x22
#define AVA8_P_SET_PMU			0x24
#define AVA8_P_SET_PLL			0x25
#define AVA8_P_SET_SS			0x26
/* 0x27 reserved */
#define AVA8_P_SET_FAC			0x28
#define AVA8_P_SET_OC			0x29

/* Have to send with I2C address */
#define AVA8_P_POLLING	0x30
#define AVA8_P_SYNC	0x31
#define AVA8_P_TEST	0x32
#define AVA8_P_RSTMMTX	0x33
#define AVA8_P_GET_VOLT	0x34

/* Back to host */
#define AVA8_P_ACKDETECT		0x40
#define AVA8_P_STATUS			0x41
#define AVA8_P_NONCE			0x42
#define AVA8_P_TEST_RET			0x43
#define AVA8_P_STATUS_VOLT		0x46
#define AVA8_P_STATUS_PMU		0x48
#define AVA8_P_STATUS_PLL		0x49
#define AVA8_P_STATUS_LOG		0x4a
#define AVA8_P_STATUS_ASIC		0x4b
#define AVA8_P_STATUS_PVT		0x4c
#define AVA8_P_STATUS_FAC		0x4d
#define AVA8_P_STATUS_OC		0x4e
#define AVA8_P_STATUS_OTP		0x4f
#define AVA8_P_SET_ASIC_OTP		0x50

#define AVA8_MODULE_BROADCAST	0
/* End of avalon8 protocol package type */

#define AVA8_IIC_RESET		0xa0
#define AVA8_IIC_INIT		0xa1
#define AVA8_IIC_DEINIT		0xa2
#define AVA8_IIC_XFER		0xa5
#define AVA8_IIC_INFO		0xa6

#define AVA8_FREQ_INIT_MODE	0x0
#define AVA8_FREQ_PLLADJ_MODE	0x1

#define AVA8_DEFAULT_FACTORY_INFO_CNT	(AVA8_DEFAULT_FACTORY_INFO_0_CNT + AVA8_DEFAULT_FACTORY_INFO_1_CNT)

#define AVA8_DEFAULT_OVERCLOCKING_CNT	1

#define AVA8_MM821_VIN_ADC_RATIO	(3.3 / 4095.0 * 25.62 / 5.62 * 1000.0 * 100.0)
#define AVA8_MM831_VIN_ADC_RATIO	(3.3 / 4095.0 * 25.62 / 5.62 * 1000.0 * 100.0)
#define AVA8_MM841_VIN_ADC_RATIO	(3.3 / 4095.0 * 25.62 / 5.62 * 1000.0 * 100.0)
#define AVA8_MM851_VIN_ADC_RATIO	(3.3 / 4095.0 * 25.62 / 5.62 * 1000.0 * 100.0)

#define AVA8_MM821_VOUT_ADC_RATIO	(3.3 / 4095.0 * 63.0 / 20.0 * 10000.0 * 100.0)
#define AVA8_MM831_VOUT_ADC_RATIO	(3.3 / 4095.0 * 63.0 / 20.0 * 10000.0 * 100.0)
#define AVA8_MM841_VOUT_ADC_RATIO	(3.3 / 4095.0 * 63.0 / 20.0 * 10000.0 * 100.0)
#define AVA8_MM851_VOUT_ADC_RATIO	(3.3 / 4095.0 * 72.3 / 20.0 * 10000.0 * 100.0)

#define AVA8_OTP_INDEX_READ_STEP   	27
#define AVA8_OTP_INDEX_ASIC_NUM	28
#define AVA8_OTP_INDEX_CYCLE_HIT	29
#define AVA8_OTP_INFO_LOTIDCRC_OFFSET	0
#define AVA8_OTP_INFO_LOTID_OFFSET  	6

struct avalon8_pkg {
	uint8_t head[2];
	uint8_t type;
	uint8_t opt;
	uint8_t idx;
	uint8_t cnt;
	uint8_t data[32];
	uint8_t crc[2];
};
#define avalon8_ret avalon8_pkg

struct avalon8_info {
	/* Public data */
	int64_t last_diff1;
	int64_t pending_diff1;
	double last_rej;

	int mm_count;
	int xfer_err_cnt;
	int pool_no;

	struct timeval firsthash;
	struct timeval last_fan_adj;
	struct timeval last_stratum;
	struct timeval last_detect;

	cglock_t update_lock;

	struct pool pool0;
	struct pool pool1;
	struct pool pool2;

	bool work_restart;

	uint32_t last_jobid;

	/* For connecter */
	char auc_version[AVA8_AUC_VER_LEN + 1];

	int auc_speed;
	int auc_xdelay;
	int auc_sensor;

	struct i2c_ctx *i2c_slaves[AVA8_DEFAULT_MODULARS];

	uint8_t connecter; /* AUC or IIC */

	/* For modulars */
	bool enable[AVA8_DEFAULT_MODULARS];
	bool reboot[AVA8_DEFAULT_MODULARS];

	struct timeval elapsed[AVA8_DEFAULT_MODULARS];

	uint8_t mm_dna[AVA8_DEFAULT_MODULARS][AVA8_MM_DNA_LEN];
	char mm_version[AVA8_DEFAULT_MODULARS][AVA8_MM_VER_LEN + 1]; /* It's a string */
	uint32_t total_asics[AVA8_DEFAULT_MODULARS];
	uint32_t max_ntime; /* Maximum: 7200 */

	uint8_t otp_info[AVA8_DEFAULT_MODULARS][AVA8_DEFAULT_MINER_CNT][AVA8_OTP_LEN + 1];

	int mod_type[AVA8_DEFAULT_MODULARS];
	uint8_t miner_count[AVA8_DEFAULT_MODULARS];
	uint8_t asic_count[AVA8_DEFAULT_MODULARS];

	uint32_t freq_mode[AVA8_DEFAULT_MODULARS];
	int led_indicator[AVA8_DEFAULT_MODULARS];
	int fan_pct[AVA8_DEFAULT_MODULARS];
	int fan_cpm[AVA8_DEFAULT_MODULARS];

	int temp[AVA8_DEFAULT_MODULARS][AVA8_DEFAULT_MINER_CNT][AVA8_DEFAULT_ASIC_MAX];
	int temp_mm[AVA8_DEFAULT_MODULARS];

	uint32_t core_volt[AVA8_DEFAULT_MODULARS][AVA8_DEFAULT_MINER_CNT] \
			  [AVA8_DEFAULT_ASIC_MAX][AVA8_DEFAULT_CORE_VOLT_CNT];

	uint8_t cutoff[AVA8_DEFAULT_MODULARS];
	int temp_target[AVA8_DEFAULT_MODULARS];
	int temp_overheat[AVA8_DEFAULT_MODULARS];

	/* pid controler*/
	int pid_p[AVA8_DEFAULT_MODULARS];
	int pid_i[AVA8_DEFAULT_MODULARS];
	int pid_d[AVA8_DEFAULT_MODULARS];
	double pid_u[AVA8_DEFAULT_MODULARS];
	int pid_e[AVA8_DEFAULT_MODULARS][3];
	int pid_0[AVA8_DEFAULT_MODULARS];

	int set_voltage_level[AVA8_DEFAULT_MODULARS][AVA8_DEFAULT_MINER_CNT];
	uint32_t set_frequency[AVA8_DEFAULT_MODULARS][AVA8_DEFAULT_MINER_CNT][AVA8_DEFAULT_PLL_CNT];
	uint32_t get_frequency[AVA8_DEFAULT_MODULARS][AVA8_DEFAULT_MINER_CNT][AVA8_DEFAULT_ASIC_MAX][AVA8_DEFAULT_PLL_CNT];

	int set_asic_otp[AVA8_DEFAULT_MODULARS][AVA8_DEFAULT_MINER_CNT];

	uint16_t get_vin[AVA8_DEFAULT_MODULARS][AVA8_DEFAULT_MINER_CNT];
	uint32_t get_voltage[AVA8_DEFAULT_MODULARS][AVA8_DEFAULT_MINER_CNT];
	uint32_t get_pll[AVA8_DEFAULT_MODULARS][AVA8_DEFAULT_MINER_CNT][AVA8_DEFAULT_PLL_CNT];

	uint32_t get_asic[AVA8_DEFAULT_MODULARS][AVA8_DEFAULT_MINER_CNT][AVA8_DEFAULT_ASIC_MAX][6];

	int8_t factory_info[AVA8_DEFAULT_FACTORY_INFO_CNT];
	int8_t overclocking_info[AVA8_DEFAULT_OVERCLOCKING_CNT];

	uint64_t local_works[AVA8_DEFAULT_MODULARS];
	uint64_t local_works_i[AVA8_DEFAULT_MODULARS][AVA8_DEFAULT_MINER_CNT];
	uint64_t hw_works[AVA8_DEFAULT_MODULARS];
	uint64_t hw_works_i[AVA8_DEFAULT_MODULARS][AVA8_DEFAULT_MINER_CNT];
	uint64_t chip_matching_work[AVA8_DEFAULT_MODULARS][AVA8_DEFAULT_MINER_CNT][AVA8_DEFAULT_ASIC_MAX];

	uint32_t error_code[AVA8_DEFAULT_MODULARS][AVA8_DEFAULT_MINER_CNT + 1];
	uint32_t error_crc[AVA8_DEFAULT_MODULARS][AVA8_DEFAULT_MINER_CNT];
	uint8_t error_polling_cnt[AVA8_DEFAULT_MODULARS];

	uint8_t power_good[AVA8_DEFAULT_MODULARS];
	char pmu_version[AVA8_DEFAULT_MODULARS][AVA8_DEFAULT_PMU_CNT][5];
	uint64_t diff1[AVA8_DEFAULT_MODULARS];

	uint16_t vin_adc_ratio[AVA8_DEFAULT_MODULARS];
	uint16_t vout_adc_ratio[AVA8_DEFAULT_MODULARS];

	bool conn_overloaded;
};

struct avalon8_iic_info {
	uint8_t iic_op;
	union {
		uint32_t aucParam[2];
		uint8_t slave_addr;
	} iic_param;
};

struct avalon8_dev_description {
	uint8_t dev_id_str[8];
	int mod_type;
	uint8_t miner_count; /* it should not greater than AVA8_DEFAULT_MINER_CNT */
	uint8_t asic_count; /* asic count each miner, it should not great than AVA8_DEFAULT_ASIC_MAX */
	uint16_t vin_adc_ratio;
	uint16_t vout_adc_ratio;
	int set_voltage_level;
	uint16_t set_freq[AVA8_DEFAULT_PLL_CNT];
	int set_asic_otp;
};

#define AVA8_WRITE_SIZE (sizeof(struct avalon8_pkg))
#define AVA8_READ_SIZE AVA8_WRITE_SIZE

#define AVA8_SEND_OK 0
#define AVA8_SEND_ERROR -1

extern char *set_avalon8_fan(char *arg);
extern char *set_avalon8_freq(char *arg);
extern char *set_avalon8_voltage_level(char *arg);
extern char *set_avalon8_voltage_level_offset(char *arg);
extern char *set_avalon8_asic_otp(char *arg);
extern int opt_avalon8_temp_target;
extern int opt_avalon8_polling_delay;
extern int opt_avalon8_aucspeed;
extern int opt_avalon8_aucxdelay;
extern int opt_avalon8_smart_speed;
extern bool opt_avalon8_iic_detect;
extern int opt_avalon8_freq_sel;
extern uint32_t opt_avalon8_th_pass;
extern uint32_t opt_avalon8_th_fail;
extern uint32_t opt_avalon8_th_init;
extern uint32_t opt_avalon8_th_ms;
extern uint32_t opt_avalon8_th_timeout;
extern uint32_t opt_avalon8_th_add;
extern uint32_t opt_avalon8_nonce_mask;
extern uint32_t opt_avalon8_nonce_check;
extern uint32_t opt_avalon8_mux_l2h;
extern uint32_t opt_avalon8_mux_h2l;
extern uint32_t opt_avalon8_h2ltime0_spd;
extern uint32_t opt_avalon8_roll_enable;
extern uint32_t opt_avalon8_spdlow;
extern uint32_t opt_avalon8_spdhigh;
extern uint32_t opt_avalon8_pid_p;
extern uint32_t opt_avalon8_pid_i;
extern uint32_t opt_avalon8_pid_d;

#endif /* USE_AVALON8 */
#endif /* _AVALON8_H_ */