From 770b1bbc1d75886b2b80f6b928072bd8ba2ae4ee Mon Sep 17 00:00:00 2001 From: Damian Smith Date: Tue, 25 Jan 2022 09:38:19 +0000 Subject: [PATCH] ELGIP-159 - corrected the version number to 02_00 --- .../enc_pd_emul/2/doc/enc_pd_emul_2.json | 869 +++++++++--------- 1 file changed, 434 insertions(+), 435 deletions(-) diff --git a/generic_ip/enc_pd_emul/2/doc/enc_pd_emul_2.json b/generic_ip/enc_pd_emul/2/doc/enc_pd_emul_2.json index 3431a9d..653db6f 100644 --- a/generic_ip/enc_pd_emul/2/doc/enc_pd_emul_2.json +++ b/generic_ip/enc_pd_emul/2/doc/enc_pd_emul_2.json @@ -1,439 +1,438 @@ -[{ - "ip_name": "enc_pd_emul_2", - "bus": "csr", - "addr_width" : "5", - "description": "Encoder/PD emulator", - "addr_hi_bit" : "6", - "addr_lo_bit" : "5", - "sub_blocks": { - "local": { - "instance": "", - "process": "cpp, txt", - "offset": "0x0" - }, - "generic_sequencer_18": { - "instance": "", - "process": "enabled", - "offset": "0x20" - } - }, - "registers": { - "ip_id" : { - "address" : "0", - "width" : "32", - "description" : "Unique ID for this IP block", - "fields": { - "ip_number" : { - "type" : "c", - "bit_len" : "8", - "reset" : "0x12", - "description" : "IP identifier number" - }, - "mfr_number" : { - "type" : "c", - "bit_len" : "8", - "reset" : "0xFF", - "description" : "Manufacturer number" - - }, - "reserved" : { - "type" : "rsv", - "bit_len" : "16", - "description" : "Reserved bits" - } - } - }, - "ip_ver" : { - "address" : "1", - "width" : "32", - "description" : "IP Version", - "fields": { - "minor_number" : { - "type" : "c", - "bit_len" : "8", - "reset" : "0x01", - "description" : "Minor number" - }, - "major_number" : { - "type" : "c", - "bit_len" : "8", - "reset" : "0x01", - "description" : "Major number" - - }, - "reserved" : { - "type" : "rsv", - "bit_len" : "16", - "description" : "Reserved bits" - } - } - }, - "out_enable": { - "address": "2", - "width": "16", - "description": "TTL/RS422 Output Enable/Force output", - "fields": { - "ttl_pd_en": { - "type": "w", - "bit_len": "1", - "reset": "0x0", - "description": "TTL PD output enable" - }, - "ttl_ph1_en": { - "type": "w", - "bit_len": "1", - "reset": "0x0", - "description": "TTL enc-phase-1 output enable" - }, - "ttl_ph2_en": { - "type": "w", - "bit_len": "1", - "reset": "0x0", - "description": "TTL enc-phase-2 output enable" - }, - "ttl_zp_en": { - "type": "w", - "bit_len": "1", - "reset": "0x0", - "description": "TTL enc-zero-phase output enable" - }, - "rs422_pd_en": { - "type": "w", - "bit_len": "1", - "reset": "0x0", - "description": "RS422 PD output enable" - }, - "rs422_ph1_en": { - "type": "w", - "bit_len": "1", - "reset": "0x0", - "description": "RS422 enc-phase-1 output enable" - }, - "rs422_ph2_en": { - "type": "w", - "bit_len": "1", - "reset": "0x0", - "description": "RS422 enc-phase-2 output enable" - }, - "rs422_zp_en": { - "type": "w", - "bit_len": "1", - "reset": "0x0", - "description": "RS422 enc-zero-phase output enable" - }, - "ttl_pd_fh": { - "type": "w", - "bit_len": "1", - "reset": "0x0", - "description": "TTL PD output force high" - }, - "ttl_ph1_fh": { - "type": "w", - "bit_len": "1", - "reset": "0x0", - "description": "TTL enc-phase-1 output force high" - }, - "ttl_ph2_fh": { - "type": "w", - "bit_len": "1", - "reset": "0x0", - "description": "TTL enc-phase-2 output force high" - }, - "ttl_zp_fh": { - "type": "w", - "bit_len": "1", - "reset": "0x0", - "description": "TTL enc-zero-phase output force high" - }, - "rs422_pd_fh": { - "type": "w", - "bit_len": "1", - "reset": "0x0", - "description": "RS422 PD output force high" - }, - "rs422_ph1_fh": { - "type": "w", - "bit_len": "1", - "reset": "0x0", - "description": "RS422 enc-phase-1 output force high" - }, - "rs422_ph2_fh": { - "type": "w", - "bit_len": "1", - "reset": "0x0", - "description": "RS422 enc-phase-2 output force high" - }, - "rs422_zp_fh": { - "type": "w", - "bit_len": "1", - "reset": "0x0", - "description": "RS422 enc-zero-phase output force high" - } - } - }, - "out_status": { - "address": "3", - "width": "8", - "description": "Reports the status of TTL and RS422 outputs", - "fields": { - "ttl_pd": { - "type": "r", - "bit_len": "1", - "reset": "U", - "description": "TTL PD status" - }, - "ttl_ph1": { - "type": "r", - "bit_len": "1", - "reset": "U", - "description": "TTL enc-phase-1 status" - }, - "ttl_ph2": { - "type": "r", - "bit_len": "1", - "reset": "U", - "description": "TTL enc-phase-2 status" - }, - "ttl_zp": { - "type": "r", - "bit_len": "1", - "reset": "U", - "description": "TTL enc-zp status" - }, - "rs422_pd": { - "type": "r", - "bit_len": "1", - "reset": "U", - "description": "RS422 PD status" - }, - "rs422_ph1": { - "type": "r", - "bit_len": "1", - "reset": "U", - "description": "RS422 enc-phase-1 status" - }, - "rs422_ph2": { - "type": "r", - "bit_len": "1", - "reset": "U", - "description": "RS422 enc-phase-2 status" - }, - "rs422_zp": { - "type": "r", - "bit_len": "1", - "reset": "U", - "description": "RS422 enc-zp status" - } - } - }, - "enc_ctrl_w": { - "address": "4", - "width": "6", - "description": "Control the emulation of encoder signals", - "fields": { - "nco_en": { - "type": "w", - "bit_len": "1", - "reset": "0x0", - "description": "enable the NCO increment" - }, - "nco_init": { - "type": "w0", - "bit_len": "1", - "reset": "0x0", - "description": "force the NCO to the initial value" - }, - "enc_dir": { - "type": "w", - "bit_len": "1", - "reset": "0x0", - "description": "encoder/absolute position direction: 0 => positive, 1 => negative" - }, - "set_abs_pos": { - "type": "w0", - "bit_len": "1", - "reset": "0x0", - "description": "force the absolute position to the (programmable) initial value" - }, - "max_pulses_en": { - "type": "w", - "bit_len": "1", - "reset": "0x0", - "description": "0 => NCO free running, 1 => the NCO automatically stops after a specified number of absolute position increments" - }, - "max_pulses_start": { - "type": "w0", - "bit_len": "1", - "reset": "0x0", - "description": "start the generation of a fixed number of absolute position increments " - } +[ + { + "ip_name": "enc_pd_emul_2", + "bus": "csr", + "addr_width": "5", + "description": "Encoder/PD emulator", + "addr_hi_bit": "6", + "addr_lo_bit": "5", + "sub_blocks": { + "local": { + "instance": "", + "process": "cpp, txt", + "offset": "0x0" + }, + "generic_sequencer_18": { + "instance": "", + "process": "enabled", + "offset": "0x20" } }, - "enc_ctrl_r": { - "address": "5", - "width": "32", - "description": "Status", - "fields": { - "reserved0": { - "type": "rsv", - "bit_len": "6", - "description": "Reserved" - }, - "max_pulses_done": { - "type": "r", - "bit_len": "1", - "reset": "0x0", - "description": "signals the completion of the encoder/absolute position increments" - }, - "reserved1": { - "type": "rsv", - "bit_len": "24", - "description": "Reserved" - }, - "seq_present": { - "type": "r", - "bit_len": "1", - "reset": "0x0", - "description": "Set to 1 when the Sequencer is instantiated, 0 otherwise" - } - } - }, - "enc_nco_inc": { - "type": "w", - "address": "6", - "reset": "0x0", - "width": "32", - "description": "Encoder NCO increment" - }, - "enc_pulse_num": { - "type": "w", - "address": "7", - "reset": "0x0", - "width": "32", - "description": "number of encoder/absolute position increments to be generated" - }, - "enc_zp_ppr": { - "type": "w", - "address": "8", - "reset": "0x0", - "width": "16", - "description": "Zero-Phase PPR (Pulse-Per-Revolution)" - }, - "pos_init_lsb": { - "type": "w", - "address": "9", - "reset": "0x0", - "width": "32", - "subtype": "signed", - "description": "Absolute Position Initial value, bits 31:0" - }, - "pos_init_msb": { - "type": "w", - "address": "10", - "reset": "0x0", - "width": "8", - "subtype": "signed", - "description": "Absolute Position Initial value, bits 39:32" - }, - "pos_stat_lsb": { - "type": "r", - "address": "11", - "reset": "0x0", - "width": "32", - "subtype": "signed", - "description": "Absolute Position value, bits 31:0" - }, - "pos_stat_msb": { - "type": "r", - "address": "12", - "reset": "0x0", - "width": "8", - "subtype": "signed", - "description": "Absolute Position value, bits 39:32" - }, - "pd_ctrl": { - "address": "13", - "description": "Control the emulation of PD", - "width": "3", - "fields": { - "pd_en": { - "type": "w", - "bit_len": "1", - "reset": "0x0", - "description": "enable the generation of PD events" - }, - "pd_gen": { - "type": "w0", - "bit_len": "1", - "reset": "0x0", - "description": "issue a PD pulse" - }, - "clr_pd_cnt": { - "type": "w0", - "bit_len": "1", - "reset": "0x0", - "description": "clear the value of the PD counter register" - } - } - }, - "pd_pulse_width": { - "type": "w", - "address": "14", - "reset": "0x14", - "width": "16", - "description": "PD pulse-width [clock-cycles at 100 MHz]. The minimum value is 1." - }, - "pd_cnt": { - "type": "r", - "address": "15", - "reset": "0x0", - "width": "24", - "description": "PD pulse counter" - }, - "seq_ctrl": { - "address": "16", - "description": "sequencer control", - "width": "25", - "fields": { - "seq_start_req": { - "type": "w0", - "bit_len": "1", - "reset": "0x0", - "description": "sequencer start request" - }, - "seq_ext_trig": { - "type": "w0", - "bit_len": "1", - "reset": "0x0", - "description": "sequencer external trigger" - }, - "reserved" : { - "type" : "rsv", - "bit_len" : "14", - "description" : "Reserved bits" - }, - "seq_start_addr": { - "type": "w", - "bit_len": "9", - "reset": "0x0", - "description": "sequencer start address" - } + "registers": { + "ip_id": { + "address": "0", + "width": "32", + "description": "Unique ID for this IP block", + "fields": { + "ip_number": { + "type": "c", + "bit_len": "8", + "reset": "0x12", + "description": "IP identifier number" + }, + "mfr_number": { + "type": "c", + "bit_len": "8", + "reset": "0xFF", + "description": "Manufacturer number" + }, + "reserved": { + "type": "rsv", + "bit_len": "16", + "description": "Reserved bits" + } + } + }, + "ip_ver": { + "address": "1", + "width": "32", + "description": "IP Version", + "fields": { + "minor_number": { + "type": "c", + "bit_len": "8", + "reset": "0x00", + "description": "Minor number" + }, + "major_number": { + "type": "c", + "bit_len": "8", + "reset": "0x02", + "description": "Major number" + }, + "reserved": { + "type": "rsv", + "bit_len": "16", + "description": "Reserved bits" + } + } + }, + "out_enable": { + "address": "2", + "width": "16", + "description": "TTL/RS422 Output Enable/Force output", + "fields": { + "ttl_pd_en": { + "type": "w", + "bit_len": "1", + "reset": "0x0", + "description": "TTL PD output enable" + }, + "ttl_ph1_en": { + "type": "w", + "bit_len": "1", + "reset": "0x0", + "description": "TTL enc-phase-1 output enable" + }, + "ttl_ph2_en": { + "type": "w", + "bit_len": "1", + "reset": "0x0", + "description": "TTL enc-phase-2 output enable" + }, + "ttl_zp_en": { + "type": "w", + "bit_len": "1", + "reset": "0x0", + "description": "TTL enc-zero-phase output enable" + }, + "rs422_pd_en": { + "type": "w", + "bit_len": "1", + "reset": "0x0", + "description": "RS422 PD output enable" + }, + "rs422_ph1_en": { + "type": "w", + "bit_len": "1", + "reset": "0x0", + "description": "RS422 enc-phase-1 output enable" + }, + "rs422_ph2_en": { + "type": "w", + "bit_len": "1", + "reset": "0x0", + "description": "RS422 enc-phase-2 output enable" + }, + "rs422_zp_en": { + "type": "w", + "bit_len": "1", + "reset": "0x0", + "description": "RS422 enc-zero-phase output enable" + }, + "ttl_pd_fh": { + "type": "w", + "bit_len": "1", + "reset": "0x0", + "description": "TTL PD output force high" + }, + "ttl_ph1_fh": { + "type": "w", + "bit_len": "1", + "reset": "0x0", + "description": "TTL enc-phase-1 output force high" + }, + "ttl_ph2_fh": { + "type": "w", + "bit_len": "1", + "reset": "0x0", + "description": "TTL enc-phase-2 output force high" + }, + "ttl_zp_fh": { + "type": "w", + "bit_len": "1", + "reset": "0x0", + "description": "TTL enc-zero-phase output force high" + }, + "rs422_pd_fh": { + "type": "w", + "bit_len": "1", + "reset": "0x0", + "description": "RS422 PD output force high" + }, + "rs422_ph1_fh": { + "type": "w", + "bit_len": "1", + "reset": "0x0", + "description": "RS422 enc-phase-1 output force high" + }, + "rs422_ph2_fh": { + "type": "w", + "bit_len": "1", + "reset": "0x0", + "description": "RS422 enc-phase-2 output force high" + }, + "rs422_zp_fh": { + "type": "w", + "bit_len": "1", + "reset": "0x0", + "description": "RS422 enc-zero-phase output force high" + } + } + }, + "out_status": { + "address": "3", + "width": "8", + "description": "Reports the status of TTL and RS422 outputs", + "fields": { + "ttl_pd": { + "type": "r", + "bit_len": "1", + "reset": "U", + "description": "TTL PD status" + }, + "ttl_ph1": { + "type": "r", + "bit_len": "1", + "reset": "U", + "description": "TTL enc-phase-1 status" + }, + "ttl_ph2": { + "type": "r", + "bit_len": "1", + "reset": "U", + "description": "TTL enc-phase-2 status" + }, + "ttl_zp": { + "type": "r", + "bit_len": "1", + "reset": "U", + "description": "TTL enc-zp status" + }, + "rs422_pd": { + "type": "r", + "bit_len": "1", + "reset": "U", + "description": "RS422 PD status" + }, + "rs422_ph1": { + "type": "r", + "bit_len": "1", + "reset": "U", + "description": "RS422 enc-phase-1 status" + }, + "rs422_ph2": { + "type": "r", + "bit_len": "1", + "reset": "U", + "description": "RS422 enc-phase-2 status" + }, + "rs422_zp": { + "type": "r", + "bit_len": "1", + "reset": "U", + "description": "RS422 enc-zp status" + } + } + }, + "enc_ctrl_w": { + "address": "4", + "width": "6", + "description": "Control the emulation of encoder signals", + "fields": { + "nco_en": { + "type": "w", + "bit_len": "1", + "reset": "0x0", + "description": "enable the NCO increment" + }, + "nco_init": { + "type": "w0", + "bit_len": "1", + "reset": "0x0", + "description": "force the NCO to the initial value" + }, + "enc_dir": { + "type": "w", + "bit_len": "1", + "reset": "0x0", + "description": "encoder/absolute position direction: 0 => positive, 1 => negative" + }, + "set_abs_pos": { + "type": "w0", + "bit_len": "1", + "reset": "0x0", + "description": "force the absolute position to the (programmable) initial value" + }, + "max_pulses_en": { + "type": "w", + "bit_len": "1", + "reset": "0x0", + "description": "0 => NCO free running, 1 => the NCO automatically stops after a specified number of absolute position increments" + }, + "max_pulses_start": { + "type": "w0", + "bit_len": "1", + "reset": "0x0", + "description": "start the generation of a fixed number of absolute position increments " + } + } + }, + "enc_ctrl_r": { + "address": "5", + "width": "32", + "description": "Status", + "fields": { + "reserved0": { + "type": "rsv", + "bit_len": "6", + "description": "Reserved" + }, + "max_pulses_done": { + "type": "r", + "bit_len": "1", + "reset": "0x0", + "description": "signals the completion of the encoder/absolute position increments" + }, + "reserved1": { + "type": "rsv", + "bit_len": "24", + "description": "Reserved" + }, + "seq_present": { + "type": "r", + "bit_len": "1", + "reset": "0x0", + "description": "Set to 1 when the Sequencer is instantiated, 0 otherwise" + } + } + }, + "enc_nco_inc": { + "type": "w", + "address": "6", + "reset": "0x0", + "width": "32", + "description": "Encoder NCO increment" + }, + "enc_pulse_num": { + "type": "w", + "address": "7", + "reset": "0x0", + "width": "32", + "description": "number of encoder/absolute position increments to be generated" + }, + "enc_zp_ppr": { + "type": "w", + "address": "8", + "reset": "0x0", + "width": "16", + "description": "Zero-Phase PPR (Pulse-Per-Revolution)" + }, + "pos_init_lsb": { + "type": "w", + "address": "9", + "reset": "0x0", + "width": "32", + "subtype": "signed", + "description": "Absolute Position Initial value, bits 31:0" + }, + "pos_init_msb": { + "type": "w", + "address": "10", + "reset": "0x0", + "width": "8", + "subtype": "signed", + "description": "Absolute Position Initial value, bits 39:32" + }, + "pos_stat_lsb": { + "type": "r", + "address": "11", + "reset": "0x0", + "width": "32", + "subtype": "signed", + "description": "Absolute Position value, bits 31:0" + }, + "pos_stat_msb": { + "type": "r", + "address": "12", + "reset": "0x0", + "width": "8", + "subtype": "signed", + "description": "Absolute Position value, bits 39:32" + }, + "pd_ctrl": { + "address": "13", + "description": "Control the emulation of PD", + "width": "3", + "fields": { + "pd_en": { + "type": "w", + "bit_len": "1", + "reset": "0x0", + "description": "enable the generation of PD events" + }, + "pd_gen": { + "type": "w0", + "bit_len": "1", + "reset": "0x0", + "description": "issue a PD pulse" + }, + "clr_pd_cnt": { + "type": "w0", + "bit_len": "1", + "reset": "0x0", + "description": "clear the value of the PD counter register" + } + } + }, + "pd_pulse_width": { + "type": "w", + "address": "14", + "reset": "0x14", + "width": "16", + "description": "PD pulse-width [clock-cycles at 100 MHz]. The minimum value is 1." + }, + "pd_cnt": { + "type": "r", + "address": "15", + "reset": "0x0", + "width": "24", + "description": "PD pulse counter" + }, + "seq_ctrl": { + "address": "16", + "description": "sequencer control", + "width": "25", + "fields": { + "seq_start_req": { + "type": "w0", + "bit_len": "1", + "reset": "0x0", + "description": "sequencer start request" + }, + "seq_ext_trig": { + "type": "w0", + "bit_len": "1", + "reset": "0x0", + "description": "sequencer external trigger" + }, + "reserved": { + "type": "rsv", + "bit_len": "14", + "description": "Reserved bits" + }, + "seq_start_addr": { + "type": "w", + "bit_len": "9", + "reset": "0x0", + "description": "sequencer start address" + } + } } } - } -}, -{ - "ip_name" : "enc_pd_emul_2", - "bus" : "seq", - "addr_hi_bit" : "10", - "addr_lo_bit" : "9", - "description" : "Encoder/PD emulator sequencer ram", - "sub_blocks" : { - "generic_sequencer_18" : { - "instance" : "", - "process" : "cpp", - "offset" : "0x200" - } - } -} -] + }, + { + "ip_name": "enc_pd_emul_2", + "bus": "seq", + "addr_hi_bit": "10", + "addr_lo_bit": "9", + "description": "Encoder/PD emulator sequencer ram", + "sub_blocks": { + "generic_sequencer_18": { + "instance": "", + "process": "cpp", + "offset": "0x200" + } + } + } +] \ No newline at end of file