From 7bfe395e0aba7ea94fd88b9d64bffb7316458e77 Mon Sep 17 00:00:00 2001 From: Simon Southwell Date: Tue, 15 Sep 2020 08:37:59 +0100 Subject: [PATCH] Adding notes to generic IP bloc's JSON files. No functional changes. --- generic_ip/generic_delay_queue/1/doc/generic_delay_queue_1.json | 1 + generic_ip/generic_pio/1/doc/generic_pio_1.json | 1 + generic_ip/generic_sequencer/15/doc/generic_sequencer_15.json | 1 + generic_ip/generic_sequencer/16/doc/generic_sequencer_16.json | 1 + generic_ip/multi_alert_uart_rx/0/doc/multi_alert_uart_rx_0.json | 2 +- generic_ip/shutdown_monitor/0/doc/shutdown_monitor_0.json | 1 + generic_ip/signal_sequencer/10/doc/signal_sequencer_10.json | 1 + 7 files changed, 7 insertions(+), 1 deletion(-) diff --git a/generic_ip/generic_delay_queue/1/doc/generic_delay_queue_1.json b/generic_ip/generic_delay_queue/1/doc/generic_delay_queue_1.json index 63a05c5..c76fb27 100644 --- a/generic_ip/generic_delay_queue/1/doc/generic_delay_queue_1.json +++ b/generic_ip/generic_delay_queue/1/doc/generic_delay_queue_1.json @@ -3,6 +3,7 @@ "bus" : "csr", "addr_width" : "4", "description" : "This block is the generic delay queue", + "notes" : "This is the generic delay queue component, used in various projects. Details of this block can be found at https://confluence.gisapps.co.uk/display/EL/Generic+Delay+Queue.", "registers" : { "ip_id" : { "address" : "0", diff --git a/generic_ip/generic_pio/1/doc/generic_pio_1.json b/generic_ip/generic_pio/1/doc/generic_pio_1.json index 899b08a..26db0b9 100644 --- a/generic_ip/generic_pio/1/doc/generic_pio_1.json +++ b/generic_ip/generic_pio/1/doc/generic_pio_1.json @@ -3,6 +3,7 @@ "bus" : "csr", "addr_width" : "6", "description" : "This block is the generic PIO", + "notes" : "This is a generic Programmed Input/Output component used in various products. More details can be found at https://confluence.gisapps.co.uk/display/EL/Generic+PIO.", "registers" : { "ip_id" : { "address" : "0", diff --git a/generic_ip/generic_sequencer/15/doc/generic_sequencer_15.json b/generic_ip/generic_sequencer/15/doc/generic_sequencer_15.json index dfb18b6..a6197c7 100644 --- a/generic_ip/generic_sequencer/15/doc/generic_sequencer_15.json +++ b/generic_ip/generic_sequencer/15/doc/generic_sequencer_15.json @@ -3,6 +3,7 @@ "bus" : "csr", "addr_width" : "4", "description" : "Generic Sequencer core", + "notes" : "This is the generic sequencer processing element core used in various products for a variety of purposes, such as pulse generation control, waveform generation for analogue heads and print data control. More details of this component can be found at https://confluence.gisapps.co.uk/display/EL/Generic+Sequencer.", "registers" : { "ip_id" : { "address" : "0", diff --git a/generic_ip/generic_sequencer/16/doc/generic_sequencer_16.json b/generic_ip/generic_sequencer/16/doc/generic_sequencer_16.json index 324d7ff..d6f70c1 100644 --- a/generic_ip/generic_sequencer/16/doc/generic_sequencer_16.json +++ b/generic_ip/generic_sequencer/16/doc/generic_sequencer_16.json @@ -3,6 +3,7 @@ "bus" : "csr", "addr_width" : "4", "description" : "Generic Sequencer core", + "notes" : "This is the generic sequencer processing element core used in various products for a variety of purposes, such as pulse generation control, waveform generation for analogue heads and print data control. More details of this component can be found at https://confluence.gisapps.co.uk/display/EL/Generic+Sequencer.", "registers" : { "ip_id" : { "address" : "0", diff --git a/generic_ip/multi_alert_uart_rx/0/doc/multi_alert_uart_rx_0.json b/generic_ip/multi_alert_uart_rx/0/doc/multi_alert_uart_rx_0.json index 1798eec..ff4f63f 100644 --- a/generic_ip/multi_alert_uart_rx/0/doc/multi_alert_uart_rx_0.json +++ b/generic_ip/multi_alert_uart_rx/0/doc/multi_alert_uart_rx_0.json @@ -3,7 +3,7 @@ "bus" : "csr", "addr_width" : "4", "description" : "This block is the multi alter 1MBaud UART interface for alerts", - "notes" : "", + "notes" : "The Multi-alert UART receiver is a generic component, used in multiple projects, which receives messages over multiple UART receivers (at 1MBaud), configurable up to 16 channels, indicating under-range and over-range alerts from STM8 devices and generating trigger outputs for a shutdown monitor (see https://confluence.gisapps.co.uk/pages/viewpage.action?spaceKey=DHBTTCF3&title=CF3+Logic+Design#CF3LogicDesign-ShutdownMonitor). More details of an example deployment of this block, and its use, can be found at https://confluence.gisapps.co.uk/pages/viewpage.action?spaceKey=DHBTTCF3&title=CF3+Logic+Design#CF3LogicDesign-Stm8AlertUartSTM8AlertReceiver).", "registers" : { "ip_id" : { "address" : "0", diff --git a/generic_ip/shutdown_monitor/0/doc/shutdown_monitor_0.json b/generic_ip/shutdown_monitor/0/doc/shutdown_monitor_0.json index bfcd710..2020301 100644 --- a/generic_ip/shutdown_monitor/0/doc/shutdown_monitor_0.json +++ b/generic_ip/shutdown_monitor/0/doc/shutdown_monitor_0.json @@ -3,6 +3,7 @@ "bus" : "csr", "addr_width" : "6", "description" : "This block is the emergency shutdown monitor for HMB-FD-HV", + "notes" : "The shutdown monitor is used in various products to facilitate the powering up and down of power supplies, and the monitoring of critical signals and alerts in order to shutdown the supplies in the case of a failure mode. More details of a deployment of the shutdown monitor, and its use, can be found at https://confluence.gisapps.co.uk/pages/viewpage.action?spaceKey=DHBTTCF3&title=CF3+Logic+Design#CF3LogicDesign-ShutdownMonitor.", "registers" : { "ip_id" : { "address" : "0", diff --git a/generic_ip/signal_sequencer/10/doc/signal_sequencer_10.json b/generic_ip/signal_sequencer/10/doc/signal_sequencer_10.json index 5dfc83b..3f12307 100644 --- a/generic_ip/signal_sequencer/10/doc/signal_sequencer_10.json +++ b/generic_ip/signal_sequencer/10/doc/signal_sequencer_10.json @@ -4,6 +4,7 @@ "addr_hi_bit" : "9", "addr_lo_bit" : "4", "description" : "Generic Signal-Sequencer", + "notes" : "The component is a signal sequencer used to generate a variety of control signals, programmably. It used the generic sequencer at its core (see https://confluence.gisapps.co.uk/display/EL/Generic+Sequencer). More details of this component can be found at https://confluence.gisapps.co.uk/display/EL/Generic+Sequencer.", "sub_blocks" : { "generic_sequencer_15" : { "instance" : "",