X-Git-Url: http://sigrok.org/gitweb/?a=blobdiff_plain;f=src%2Fhardware%2Fitech-it8500%2Fprotocol.h;h=b3b4ce3e7a9e44e558a5566836cdb0e94ac4ba09;hb=f21b6983e8e2d3b03eb518dbec3fe35cf0211d18;hp=3df079c4d6ac6953461ec7070c2f6228e872a55e;hpb=c16effaedc3a3d8539065d1cf228e98f8cace5e0;p=libsigrok.git

diff --git a/src/hardware/itech-it8500/protocol.h b/src/hardware/itech-it8500/protocol.h
index 3df079c4..b3b4ce3e 100644
--- a/src/hardware/itech-it8500/protocol.h
+++ b/src/hardware/itech-it8500/protocol.h
@@ -27,9 +27,185 @@
 
 #define LOG_PREFIX "itech-it8500"
 
+/*
+ * Unit uses 26 byte binary packets for communications.
+ * Packets have fixed format:
+ *
+ * Offset|Length|Description
+ * ------|------|-------------------------------------
+ *     0 |    1 | Preable (always set to 0xAA).
+ *     1 |    1 | Unit Address (0-254, 255=broadcast).
+ *     2 |    1 | Command number.
+ *     3 |   22 | Variable data.
+ *    25 |    1 | Parity code (checksum).
+ */
+#define IT8500_HEADER_LEN 3
+#define IT8500_DATA_LEN 22
+#define IT8500_PACKET_LEN (IT8500_HEADER_LEN + IT8500_DATA_LEN + 1)
+
+#define IT8500_PREAMBLE 0xaa
+#define IT8500_MAX_MODEL_NAME_LEN 5
+
+/* Status packet status byte values. */
+#define IT8500_COMMAND_SUCCESSFUL 0x80
+#define IT8500_INVALID_CHECKSUM   0x90
+#define IT8500_INVALID_PARAMETER  0xa0
+#define IT8500_UNKNOWN_COMMAND    0xb0
+#define IT8500_INVALID_COMMAND    0xc0
+
+/*
+ * Operating modes.
+ * Note! These map directly to mode numbers used in CMD_SET_MODE
+ * and CMD_GET_MODE commands, so values are manually defined below.
+ */
+enum itech_it8500_modes {
+	CC = 0,
+	CV = 1,
+	CW = 2,
+	CR = 3,
+	IT8500_MODES, /* Total count, for internal use. */
+};
+
+enum itech_it8500_command {
+	CMD_GET_LOAD_LIMITS = 0x01,
+	CMD_SET_HW_OPP_VALUE = 0x02,
+	CMD_GET_HW_OPP_VALUE = 0x03,
+	CMD_SET_VON_MODE = 0x0e,
+	CMD_GET_VON_MODE = 0x0f,
+	CMD_SET_VON_VALUE = 0x10,
+	CMD_GET_VON_VALUE = 0x11,
+	CMD_RESPONSE = 0x12, /* Response to commands not returning any data. */
+	CMD_SET_REMOTE_MODE = 0x20,
+	CMD_LOAD_ON_OFF = 0x21,
+	CMD_SET_MAX_VOLTAGE = 0x22,
+	CMD_GET_MAX_VOLTAGE = 0x23,
+	CMD_SET_MAX_CURRENT = 0x24,
+	CMD_GET_MAX_CURRENT = 0x25,
+	CMD_SET_MAX_POWER = 0x26,
+	CMD_GET_MAX_POWER = 0x27,
+	CMD_SET_MODE = 0x28,
+	CMD_GET_MODE = 0x29,
+	CMD_SET_CC_CURRENT = 0x2a,
+	CMD_GET_CC_CURRENT = 0x2b,
+	CMD_SET_CV_VOLTAGE = 0x2c,
+	CMD_GET_CV_VOLTAGE = 0x2d,
+	CMD_SET_CW_POWER = 0x2e,
+	CMD_GET_CW_POWER = 0x2f,
+	CMD_SET_CR_RESISTANCE = 0x30,
+	CMD_GET_CR_RESISTANCE = 0x31,
+	CMD_SET_BATTERY_MIN_VOLTAGE = 0x4e,
+	CMD_GET_BATTERY_MIN_VOLTAGE = 0x4f,
+	CMD_SET_LOAD_ON_TIMER = 0x50,
+	CMD_GET_LOAD_ON_TIMER = 0x51,
+	CMD_LOAD_ON_TIMER = 0x52,
+	CMD_LOAD_ON_TIME_STATUS = 0x53,
+	CMD_SET_ADDRESS = 0x54,
+	CMD_LOCAL_CONTROL = 0x55,
+	CMD_REMOTE_SENSING = 0x56,
+	CMD_REMOTE_SENSING_STATUS = 0x57,
+	CMD_SET_TRIGGER_SOURCE = 0x58,
+	CMD_GET_TRIGGER_SOURCE = 0x59,
+	CMD_TRIGGER = 0x5a,
+	CMD_SAVE_SETTINGS = 0x5b,
+	CMD_LOAD_SETTINGS = 0x5c,
+	CMD_SET_FUNCTION = 0x5d,
+	CMD_GET_FUNCTION = 0x5e,
+	CMD_GET_STATE = 0x5f,
+	CMD_GET_MODEL_INFO = 0x6a,
+	CMD_GET_BARCODE_INFO = 0x6b,
+	CMD_SET_OCP_VALUE = 0x80,
+	CMD_GET_OCP_VALUE = 0x81,
+	CMD_SET_OCP_DELAY = 0x82,
+	CMD_GET_OCP_DELAY = 0x83,
+	CMD_ENABLE_OCP = 0x84,
+	CMD_DISABLE_OCP = 0x85,
+	CMD_SET_OPP_VALUE = 0x86,
+	CMD_GET_OPP_VALUE = 0x87,
+	CMD_SET_OPP_DELAY = 0x88,
+	CMD_GET_OPP_DELAY = 0x89,
+};
+
+/*
+ * Data structure to track commands and reponses.
+ */
+struct itech_it8500_cmd_packet {
+	uint8_t command; /* Command number. */
+	uint8_t address; /* Unit address: 0..254 (255 = broadcast). */
+	uint8_t data[IT8500_DATA_LEN]; /* Command/Response data. */
+};
+
+/*
+ * "Operation state" register flags.
+ */
+#define OS_CAL_FLAG   0x01
+#define OS_WTG_FLAG   0x02
+#define OS_REM_FLAG   0x04
+#define OS_OUT_FLAG   0x08
+#define OS_LOCAL_FLAG 0x10
+#define OS_SENSE_FLAG 0x20
+#define OS_LOT_FLAG   0x40
+
+/*
+ * "Demand state" register flags.
+ */
+#define DS_RV_FLAG      0x0001
+#define DS_OV_FLAG      0x0002
+#define DS_OC_FLAG      0x0004
+#define DS_OP_FLAG      0x0008
+#define DS_OT_FLAG      0x0010
+#define DS_SV_FLAG      0x0020
+#define DS_CC_MODE_FLAG 0x0040
+#define DS_CV_MODE_FLAG 0x0080
+#define DS_CW_MODE_FLAG 0x0100
+#define DS_CR_MODE_FLAG 0x0200
+
 struct dev_context {
+	char model[IT8500_MAX_MODEL_NAME_LEN + 1];
+	uint8_t fw_ver_major;
+	uint8_t fw_ver_minor;
+	uint8_t address;
+	double max_current;
+	double min_voltage;
+	double max_voltage;
+	double max_power;
+	double min_resistance;
+	double max_resistance;
+	size_t max_sample_rate_idx;
+
+	double voltage;
+	double current;
+	double power;
+	uint8_t operation_state;
+	uint16_t demand_state;
+	enum itech_it8500_modes mode;
+	gboolean load_on;
+
+	uint64_t sample_rate;
+	struct sr_sw_limits limits;
+
+	GMutex mutex;
 };
 
+SR_PRIV uint8_t itech_it8500_checksum(const uint8_t *packet);
+SR_PRIV const char *itech_it8500_mode_to_string(enum itech_it8500_modes mode);
+SR_PRIV int itech_it8500_string_to_mode(const char *modename,
+		enum itech_it8500_modes *mode);
+SR_PRIV int itech_it8500_send_cmd(struct sr_serial_dev_inst *serial,
+		struct itech_it8500_cmd_packet *cmd,
+		struct itech_it8500_cmd_packet **response);
+SR_PRIV int itech_it8500_cmd(const struct sr_dev_inst *sdi,
+		struct itech_it8500_cmd_packet *cmd,
+		struct itech_it8500_cmd_packet **response);
+SR_PRIV void itech_it8500_status_change(const struct sr_dev_inst *sdi,
+		uint8_t old_op, uint8_t new_op,
+		uint16_t old_de, uint16_t new_de,
+		enum itech_it8500_modes old_m, enum itech_it8500_modes new_m);
+SR_PRIV int itech_it8500_get_status(const struct sr_dev_inst *sdi);
+SR_PRIV int itech_it8500_get_int(const struct sr_dev_inst *sdi,
+		enum itech_it8500_command command, int *result);
+SR_PRIV void itech_it8500_channel_send_value(const struct sr_dev_inst *sdi,
+		struct sr_channel *ch, double value, enum sr_mq mq,
+		enum sr_unit unit, int digits);
 SR_PRIV int itech_it8500_receive_data(int fd, int revents, void *cb_data);
 
 #endif