diff --git a/generic_ip/fire_pulse_manager/7/doc/fpm_7.json b/generic_ip/fire_pulse_manager/7/doc/fpm_7.json index c3c63f8..40d8a19 100644 --- a/generic_ip/fire_pulse_manager/7/doc/fpm_7.json +++ b/generic_ip/fire_pulse_manager/7/doc/fpm_7.json @@ -6,6 +6,7 @@ "addr_hi_bit": "14", "addr_lo_bit": "11", "description": "Fire-Pulse-Manager version 7", + "notes": "The Fire Pulse Manager produces fire-request strobe signals to trigger the print_units to load and fire the printhead (or sub-head). It does so based on either received UART messages over Plastic Optic Fibre (POF) if using the SEB-PDW, or from encoder/PD inputs if using the SEB-EPD. Full details on confluence at https://congis.atlassian.net/wiki/spaces/EL/pages/26742062920/Fire+Pulse+Manager#FPM---v7", "sub_blocks": { "fpm_ctrl_7": { "instance": "", diff --git a/generic_ip/fire_pulse_manager/7/doc/fpm_ctrl_7.json b/generic_ip/fire_pulse_manager/7/doc/fpm_ctrl_7.json index 21e35ea..bff2583 100644 --- a/generic_ip/fire_pulse_manager/7/doc/fpm_ctrl_7.json +++ b/generic_ip/fire_pulse_manager/7/doc/fpm_ctrl_7.json @@ -4,6 +4,7 @@ "bus": "csr", "addr_width": "5", "description": "This block is the fire pulse manager control", + "notes": "This is the control registers for the Fire Pulse Manager. https://congis.atlassian.net/wiki/spaces/EL/pages/26742062920/Fire+Pulse+Manager#FPM---v7. The Fire Pulse Manager produces fire-request strobe signals to trigger the print_units to load and fire the printhead (or sub-head). It does so based on either received UART messages over Plastic Optic Fibre (POF) if using the SEB-PDW, or from encoder/PD inputs if using the SEB-EPD. Full details on confluence at https://congis.atlassian.net/wiki/spaces/EL/pages/26742062920/Fire+Pulse+Manager#FPM---v7", "registers": { "ip_id": { "address": "0", @@ -144,13 +145,13 @@ "bit_len": "1", "reset": "0x0", "description": "0 => SEB_EPD_LINK_OUT is driven by the POF-Tx output, 0 => SEB_EPD_LINK_OUT is driven by the Drop-Watch output" - }, + }, "print_start_override": { - "type": "w", - "bit_len": "2", - "reset": "0x0", - "description": "0- => no override. 10 => override to zero (stop print). 11 => override to one (start print). output of FPM and value for pof_tx" - } + "type": "w", + "bit_len": "2", + "reset": "0x0", + "description": "0- => no override. 10 => override to zero (stop print). 11 => override to one (start print). output of FPM and value for pof_tx" + } } }, "pof_receiver_control": { @@ -329,10 +330,10 @@ "description": "0 => Error rate below threshold, 1 => Error rate above threshold" }, "print_start_received": { - "type": "r", - "bit_len": "1", - "reset": "0x0", - "description": "print_start as received over pof. (for protocol zero, will be fixed at '1')" + "type": "r", + "bit_len": "1", + "reset": "0x0", + "description": "print_start as received over pof. (for protocol zero, will be fixed at '1')" } } }, diff --git a/generic_ip/fire_pulse_manager/7/doc/fpm_diags_7.json b/generic_ip/fire_pulse_manager/7/doc/fpm_diags_7.json index 1a823de..0643aab 100644 --- a/generic_ip/fire_pulse_manager/7/doc/fpm_diags_7.json +++ b/generic_ip/fire_pulse_manager/7/doc/fpm_diags_7.json @@ -3,7 +3,8 @@ "ip_name": "fpm_diags_7", "bus": "csr", "addr_width": "6", - "description": "SMB diagnostics, see https://congis.atlassian.net/wiki/spaces/EL/pages/26778599541/Notes+on+FPM+changes+to+support+auto+generated+registers", + "description": "Fire Pulse Manager diagnostics - used to monitor encoder / PD inputs", + "notes": "

Diagnostics for the Fire Pulse Manager for use when the SEB-EPD inputs are connected. Details on confluence via https://congis.atlassian.net/wiki/spaces/EL/pages/26778599541/Notes+on+FPM+changes+to+support+auto+generated+registers#fpm_diags_7 This is optionally instantiated in FPM_7 based on a generic. (presence will be reported in fpm_ctrl registers.

When the ESW wants to read the encoder fifo, the ESW should: a. write '1' to register rd_enc_fifo to prepare the encoder fifo output; b. read the encoder fifo output from register enc_fifo_output.

When the ESW wants to read the product detect fifo, the ESW should: a. write '1' to register rd_pd_fifo to prepare the product detect fifo output;b. read the product detect fifo output from register pd_fifo_output.

", "registers": { "init": { "address": "0",