source: firmware/FTM/ftm_definitions.vhd @ 10259

Last change on this file since 10259 was 10259, checked in by vogler, 9 years ago
ftm_definitions update constants for clock conditioner interface introduced
File size: 18.2 KB
Line 
1----------------------------------------------------------------------------------
2-- Company:        ETH Zurich, Institute for Particle Physics
3-- Engineer:       Q. Weitzel
4--
5-- Create Date:    February 2011
6-- Design Name:   
7-- Module Name:    ftm_definitions
8-- Project Name:
9-- Target Devices:
10-- Tool versions:
11-- Description:    library file for FTM design
12--
13-- Dependencies:
14--
15-- Revision:
16-- Revision 0.01 - File Created
17-- Additional Comments:
18--
19-- modified:   Patrick Vogler, February 17 2011
20-- merged with library file from Dortmund, Q. Weitzel, February 24, 2011
21--
22-- kw 25.02.:  changes for HDL-Designer (use FACT_FTM.lib.ftm_...),
23-- DD_BLOCK_SIZE added (set to 0x008 for first tests), SD_ADDR_coin_win_[p,c] defined
24--
25-- modified:   Quirin Weitzel, March 14 2011
26-- second merger with library file from dortmund (changes below)
27-- kw 01.03.: added array sd_block_default_ftu_active_list (type and defaults)
28-- kw 02.03.: added DD_BLOCK_SIZE_GENERAL (on-time counter + temperatures), changed DD_BLOCK_SIZE to 0x010 for testing
29-- kw 03.03.: added FTM_HEADER_LENGTH
30--
31----------------------------------------------------------------------------------
32
33
34library IEEE;
35use IEEE.STD_LOGIC_1164.all;
36use IEEE.STD_LOGIC_ARITH.ALL;
37use IEEE.STD_LOGIC_UNSIGNED.ALL;
38use IEEE.NUMERIC_STD.ALL;
39
40package ftm_array_types is
41
42  -- !!! some arrays are also defined in the ftm_constants package !!!
43 
44  -- data arrays for a single FTU
45  type FTU_enable_array_type is array (0 to 3) of std_logic_vector(15 downto 0);
46  type FTU_dac_array_type    is array (0 to 4) of std_logic_vector(15 downto 0);
47  type FTU_rate_array_type   is array (0 to 4) of std_logic_vector(31 downto 0);
48  type active_FTU_array_type is array (0 to 3) of std_logic_vector(15 downto 0);
49  type FTU_answer_array_type is array (0 to 3) of integer range 0 to 10;
50
51  -- data array for clock conditioner interface
52  type clk_cond_array_type is array (0 to 13) of std_logic_vector (31 downto 0);
53
54  -- network array types
55  type ip_type  is array (0 to 3) of integer;
56  type mac_type is array (0 to 2) of std_logic_vector (15 downto 0);
57
58  -- Temperature Sensor interface
59  type sensor_array_type is array (0 to 3) of integer range 0 to 2**16 - 1;
60 
61end ftm_array_types;
62
63
64library IEEE;
65use IEEE.STD_LOGIC_1164.all;
66use IEEE.STD_LOGIC_ARITH.ALL;
67use IEEE.STD_LOGIC_UNSIGNED.ALL;
68-- for HDL-Designer
69-- LIBRARY FACT_FTM_lib;
70-- use FACT_FTM_lib.ftm_array_types.all;
71library ftm_definitions;
72use ftm_definitions.ftm_array_types.all;
73use IEEE.NUMERIC_STD.ALL;
74
75package ftm_constants is
76
77  -- !!! many constants depend on each other or are defined 2x with different types !!!
78 
79  constant NO_OF_CRATES         : integer :=  4;
80  constant NO_OF_FTUS_PER_CRATE : integer := 10;
81  constant NO_OF_FTU_ENABLE_REG : integer :=  4;
82  constant NO_OF_FTU_DAC_REG    : integer :=  5;
83 
84  --internal FPGA clock frequencies
85  constant INT_CLK_FREQUENCY_1 : integer :=  50000000;  --  50MHz
86  constant INT_CLK_FREQUENCY_2 : integer := 250000000;  -- 250MHz
87  constant LOW_FREQUENCY       : integer :=   1000000;  -- has to be smaller than INT_CLK_FREQUENCY_1
88  constant SCALER_FREQ_DIVIDER : integer :=         1;  -- for simulation, should normally be 1
89 
90  --FTM address and firmware ID
91  constant FTM_ADDRESS : std_logic_vector(7 downto 0) := "11000000";  -- 192
92  constant FIRMWARE_ID : std_logic_vector(7 downto 0) := "00000001";  -- firmware version
93 
94  --communication with FTUs
95  constant FTU_RS485_BAUD_RATE   : integer := 250000;  -- bits / sec in our case
96  constant FTU_RS485_TIMEOUT     : integer := (INT_CLK_FREQUENCY_1 * 2) / 1000;  -- 2ms @ 50MHz (100000 clk periods)
97  -- constant FTU_RS485_BAUD_RATE   : integer := 10000000;  -- for simulation
98  -- constant FTU_RS485_TIMEOUT     : integer := (INT_CLK_FREQUENCY_1 * 2) / 40000;  -- for simulation
99  constant FTU_RS485_NO_OF_RETRY : integer range 0 to 2 := 2;  -- in case of timeout, !!! HAS TO BE < 3 !!!
100  constant FTU_RS485_BLOCK_WIDTH : integer := 224;  -- 28 byte protocol
101  constant FTU_RS485_START_DELIM : std_logic_vector(7 downto 0) := "01000000";  -- start delimiter "@"
102 
103  --CRC setup
104  constant CRC_POLYNOMIAL : std_logic_vector(7 downto 0) := "00000111";  -- 8-CCITT
105  constant CRC_INIT_VALUE : std_logic_vector(7 downto 0) := "11111111";
106 
107  --DNA identifier for simulation
108  constant DNA_FOR_SIM : bit_vector := X"01710000E0000501";
109
110  -- Clock conditioner (LMK03000, National semiconductor) interface
111  constant MICROWIRE_CLK_FREQUENCY : integer := 2000000;  -- 2 MHz
112  -- value to be written to R0 of the LMK03000 to perform a reset, see LMK03000 datasheet
113  constant LMK03000_Reset          : std_logic_vector (31 downto 0) :=  x"80000000";
114  constant LMK03000_REGISTER_WIDTH : integer := 32;
115  constant LMK03000_REGISTER_COUNT : integer := 9;  -- number of registers to be programmed in the LMK03000 including reset
116 
117  -- network settings Dortmund
118  -- constant MAC_ADDRESS : mac_type := (X"0011", X"9561", X"95A0");
119  -- constant NETMASK : ip_type := (255, 255, 255, 0);
120  -- constant IP_ADDRESS : ip_type := (129, 217, 160, 118);
121  -- constant GATEWAY : ip_type := (129, 217, 160, 1);
122  -- constant FIRST_PORT : integer := 5000;
123
124  -- network settings Zuerich
125  constant MAC_ADDRESS : mac_type := (X"FAC7", X"0FAD", X"1101");
126  constant NETMASK     : ip_type  := (255, 255, 248, 0);
127  constant IP_ADDRESS  : ip_type  := (192, 33, 99, 246);
128  constant GATEWAY     : ip_type  := (192, 33, 96, 1);
129  constant FIRST_PORT  : integer  := 5000;
130
131  -- W5300 settings
132  constant W5300_S_INC : std_logic_vector(6 downto 0) := "1000000"; -- socket address offset
133  -- W5300 Registers
134  constant W5300_BASE_ADR    : std_logic_vector (9 downto 0) := (others => '0');
135  constant W5300_MR          : std_logic_vector (9 downto 0) := W5300_BASE_ADR + X"0";
136  constant W5300_IR          : std_logic_vector (9 downto 0) := W5300_BASE_ADR + X"2";
137  constant W5300_IMR         : std_logic_vector (9 downto 0) := W5300_BASE_ADR + X"4";
138  constant W5300_SHAR        : std_logic_vector (9 downto 0) := W5300_BASE_ADR + X"8";
139  constant W5300_GAR         : std_logic_vector (9 downto 0) := W5300_BASE_ADR + X"10";
140  constant W5300_SUBR        : std_logic_vector (9 downto 0) := W5300_BASE_ADR + X"14";
141  constant W5300_SIPR        : std_logic_vector (9 downto 0) := W5300_BASE_ADR + X"18";
142  constant W5300_RTR         : std_logic_vector (9 downto 0) := W5300_BASE_ADR + X"1C";
143  constant W5300_RCR         : std_logic_vector (9 downto 0) := W5300_BASE_ADR + X"1E";
144  constant W5300_TMS01R      : std_logic_vector (9 downto 0) := W5300_BASE_ADR + X"20";
145  constant W5300_TMS23R      : std_logic_vector (9 downto 0) := W5300_BASE_ADR + X"22";
146  constant W5300_TMS45R      : std_logic_vector (9 downto 0) := W5300_BASE_ADR + X"24";
147  constant W5300_TMS67R      : std_logic_vector (9 downto 0) := W5300_BASE_ADR + X"26";
148  constant W5300_RMS01R      : std_logic_vector (9 downto 0) := W5300_BASE_ADR + X"28";
149  constant W5300_RMS23R      : std_logic_vector (9 downto 0) := W5300_BASE_ADR + X"2A";
150  constant W5300_RMS45R      : std_logic_vector (9 downto 0) := W5300_BASE_ADR + X"2C";
151  constant W5300_RMS67R      : std_logic_vector (9 downto 0) := W5300_BASE_ADR + X"2E";
152  constant W5300_MTYPER      : std_logic_vector (9 downto 0) := W5300_BASE_ADR + X"30";
153  constant W5300_S0_MR       : std_logic_vector (9 downto 0) := W5300_BASE_ADR + "1000000000" + X"0";
154  constant W5300_S0_CR       : std_logic_vector (9 downto 0) := W5300_BASE_ADR + "1000000000" + X"2";
155  constant W5300_S0_IMR      : std_logic_vector (9 downto 0) := W5300_BASE_ADR + "1000000000" + X"4";
156  constant W5300_S0_IR       : std_logic_vector (9 downto 0) := W5300_BASE_ADR + "1000000000" + X"6";
157  constant W5300_S0_SSR      : std_logic_vector (9 downto 0) := W5300_BASE_ADR + "1000000000" + X"8";
158  constant W5300_S0_PORTR    : std_logic_vector (9 downto 0) := W5300_BASE_ADR + "1000000000" + X"A";
159  constant W5300_S0_DPORTR   : std_logic_vector (9 downto 0) := W5300_BASE_ADR + "1000000000" + X"12";
160  constant W5300_S0_DIPR     : std_logic_vector (9 downto 0) := W5300_BASE_ADR + "1000000000" + X"14";
161  constant W5300_S0_TX_WRSR  : std_logic_vector (9 downto 0) := W5300_BASE_ADR + "1000000000" + X"20";
162  constant W5300_S0_TX_FSR   : std_logic_vector (9 downto 0) := W5300_BASE_ADR + "1000000000" + X"24";
163  constant W5300_S0_RX_RSR   : std_logic_vector (9 downto 0) := W5300_BASE_ADR + "1000000000" + X"28";
164  constant W5300_S0_TX_FIFOR : std_logic_vector (9 downto 0) := W5300_BASE_ADR + "1000000000" + X"2E";
165  constant W5300_S0_RX_FIFOR : std_logic_vector (9 downto 0) := W5300_BASE_ADR + "1000000000" + X"30";
166  -- End W5300 registers
167  constant W5300_TX_FIFO_SIZE_8B : integer := 65536; -- Socket TX FIFO-Size in Bytes
168  constant W5300_TX_FIFO_SIZE    : integer := (W5300_TX_FIFO_SIZE_8B / 2); -- Socket TX FIFO-Size in 16 Bit Words
169  constant W5300_LAST_SOCKET     : integer := 0;
170
171  -- Commands
172  constant CMD_START_DELIMITER : std_logic_vector := X"0040"; -- "@"
173  constant CMD_TLED            : std_logic_vector := X"C000"; -- only a test
174  constant CMD_READ            : std_logic_vector := X"0001";
175  constant PAR_READ_SD         : std_logic_vector := X"0001"; -- read static data block
176  constant PAR_READ_DD         : std_logic_vector := X"0002"; -- read dynamic data block
177  -- only for debugging: data_block (0) = ADDR
178  constant PAR_READ_SD_ADDR : std_logic_vector := X"0004"; -- read from address in static data block
179  constant PAR_READ_DD_ADDR : std_logic_vector := X"0008"; -- read from address in dynamic data block
180  constant CMD_WRITE    : std_logic_vector     := X"0002";
181  constant PAR_WRITE_SD : std_logic_vector     := X"0001"; -- write static data block
182  -- only for debugging: data_block (0) = ADDR, data_block (1) = DATA
183  constant PAR_WRITE_SD_ADDR : std_logic_vector := X"0002"; -- write to address in static data ram
184  -- ping all FTUs
185  constant CMD_PING : std_logic_vector := X"0010"; -- ping all FTUs
186
187  -- header length of data packages
188  constant FTM_HEADER_LENGTH : std_logic_vector (7 DOWNTO 0) := X"0B";
189 
190  -- FTU-list parameters
191  constant FL_BLOCK_SIZE           : std_logic_vector := X"0F9"; -- FTU-list size -- 9 + (40 * 6) = 249
192  constant NO_OF_FTU_LIST_REG      : integer := 6;
193  constant FTU_LIST_RAM_OFFSET     : integer := 16#009#;
194  constant FTU_LIST_RAM_ADDR_WIDTH : integer := 12;
195 
196  -- Static data block
197  constant SD_BLOCK_SIZE_GENERAL     : integer := 32;               -- X"20" -- static data block size without FTU data
198  constant SD_FTU_BASE_ADDR          : std_logic_vector := X"020";  -- beginning of FTU data
199  constant STATIC_RAM_CFG_FTU_OFFSET : integer := 16#020#;
200  constant STATIC_RAM_ADDR_WIDTH     : integer := 12;
201  constant SD_FTU_DATA_SIZE          : integer := 10;               -- X"00A" -- size of one FTU data block
202  constant SD_FTU_NUM                : integer := 40;               -- number of FTUs
203  constant SD_FTU_ACTIVE_BASE_ADDR   : std_logic_vector := X"1B0";  -- beginning of active FTU lists
204  constant SD_FTU_ACTIVE_NUM         : integer := 4;                -- number of active FTU lists (cr0 to cr3)
205  constant SD_BLOCK_SIZE             : std_logic_vector (11 downto 0) := X"1B4";  -- total size of static data block
206
207  -- dynamic data block
208  --constant DD_BLOCK_SIZE         : std_logic_vector (11 downto 0) := X"010"; -- 7 + (40 * 12) = 0x1E7 --total size of dynamic data block
209  constant DD_BLOCK_SIZE         : std_logic_vector (11 downto 0) := X"1E7"; -- 7 + (40 * 12) = 0x1E7 --total size of dynamic data block
210  constant DD_BLOCK_SIZE_GENERAL : integer := 7; -- dynamic block size without FTU data
211 
212  -- addresses in static data block
213  constant SD_ADDR_general_settings : std_logic_vector := X"000";
214  constant SD_ADDR_led              : std_logic_vector := X"001";
215  constant SD_ADDR_lp_pt_freq       : std_logic_vector := X"002";
216  constant SD_ADDR_lp_pt_ratio      : std_logic_vector := X"003";
217  constant SD_ADDR_lp1_amplitude    : std_logic_vector := X"004";
218  constant SD_ADDR_lp2_amplitude    : std_logic_vector := X"005";
219  constant SD_ADDR_lp1_delay        : std_logic_vector := X"006";
220  constant SD_ADDR_lp2_delay        : std_logic_vector := X"007";
221  constant SD_ADDR_coin_n_p         : std_logic_vector := X"008";
222  constant SD_ADDR_coin_n_c         : std_logic_vector := X"009";
223  constant SD_ADDR_trigger_delay    : std_logic_vector := X"00A";
224  constant SD_ADDR_timemarker_delay : std_logic_vector := X"00B";
225  constant SD_ADDR_dead_time        : std_logic_vector := X"00C";
226  constant SD_ADDR_cc_R0_HI         : std_logic_vector := X"00D";
227  constant SD_ADDR_cc_R0_LO         : std_logic_vector := X"00E";
228  constant SD_ADDR_cc_R1_HI         : std_logic_vector := X"00F";
229  constant SD_ADDR_cc_R1_LO         : std_logic_vector := X"010";
230  constant SD_ADDR_cc_R8_HI         : std_logic_vector := X"011";
231  constant SD_ADDR_cc_R8_LO         : std_logic_vector := X"012";
232  constant SD_ADDR_cc_R9_HI         : std_logic_vector := X"013";
233  constant SD_ADDR_cc_R9_LO         : std_logic_vector := X"014";
234  constant SD_ADDR_cc_R11_HI        : std_logic_vector := X"015";
235  constant SD_ADDR_cc_R11_LO        : std_logic_vector := X"016";
236  constant SD_ADDR_cc_R13_HI        : std_logic_vector := X"017";
237  constant SD_ADDR_cc_R13_LO        : std_logic_vector := X"018";
238  constant SD_ADDR_cc_R14_HI        : std_logic_vector := X"019";
239  constant SD_ADDR_cc_R14_LO        : std_logic_vector := X"01A";
240  constant SD_ADDR_cc_R15_HI        : std_logic_vector := X"01B";
241  constant SD_ADDR_cc_R15_LO        : std_logic_vector := X"01C";
242  constant SD_ADDR_coin_win_p       : std_logic_vector := X"01D";
243  constant SD_ADDR_coin_win_c       : std_logic_vector := X"01E";
244  constant SD_ADDR_ftu_active_cr0   : std_logic_vector := X"1B0";
245  constant SD_ADDR_ftu_active_cr1   : std_logic_vector := X"1B1";
246  constant SD_ADDR_ftu_active_cr2   : std_logic_vector := X"1B2";
247  constant SD_ADDR_ftu_active_cr3   : std_logic_vector := X"1B3";
248  constant STATIC_RAM_ACT_FTU_OFFSET : integer := 16#1B0#;
249
250
251  -- Clock conditioner interface
252  constant cc_R2_const              : std_logic_vector := X"00000102";
253  constant cc_R3_const              : std_logic_vector := X"00000103";
254  constant cc_R4_const              : std_logic_vector := X"00000104";
255  constant cc_R5_const              : std_logic_vector := X"00000105";
256  constant cc_R6_const              : std_logic_vector := X"00000106";
257  constant cc_R7_const              : std_logic_vector := X"00000107";
258 
259
260  -- arrays for default values
261  type sd_block_default_array_type is array (0 to (SD_BLOCK_SIZE_GENERAL - 1)) of std_logic_vector (15 downto 0);
262  type sd_block_ftu_default_array_type is array (0 to (SD_FTU_DATA_SIZE - 1)) of std_logic_vector (15 downto 0);
263  type sd_block_default_ftu_active_list_type is array (0 to (SD_FTU_ACTIVE_NUM - 1)) of std_logic_vector (15 downto 0);
264 
265  -- general default values
266  -- !!! to be defined !!!
267  constant sd_block_default_array : sd_block_default_array_type := (
268      X"0000", -- SD_ADDR_general_settings  -- general settings
269      X"0000", -- SD_ADDR_led               -- on-board status LEDs
270      X"0002", -- SD_ADDR_lp_pt_freq        -- light pulser and pedestal trigger frequency
271      X"0003", -- SD_ADDR_lp_pt_ratio...    -- ratio between LP1, LP2 and pedestal triggers
272      X"0004", -- SD_ADDR_lp1_amplitude     -- light pulser 1 amplitude
273      X"0005", -- SD_ADDR_lp2_amplitude     -- light pulser 2 amplitude
274      X"0006", -- SD_ADDR_lp1_delay         -- light pulser 1 delay
275      X"0007", -- SD_ADDR_lp2_delay         -- light pulser 2 delay
276      X"0008", -- SD_ADDR_coin_n_p          -- majority coincidence n (for physics)
277      X"0009", -- SD_ADDR_coin_n_c          -- majority coincidence n (for calibration)
278      X"000A", -- SD_ADDR_trigger_delay     -- trigger delay
279      X"000B", -- SD_ADDR_timemarker_delay  -- timemarker delay
280      X"000C", -- SD_ADDR_dead_time         -- dead time
281      X"0003", -- SD_ADDR_cc_R0_HI          -- clock conditioner R0 bits 31...16
282      X"8000", -- SD_ADDR_cc_R0_LO          -- clock conditioner R0 bits 15...0
283      X"0001", -- SD_ADDR_cc_R1_HI          -- clock conditioner R1 bits 31...16
284      X"0101", -- SD_ADDR_cc_R1_LO          -- clock conditioner R1 bits 15...0
285      X"1000", -- SD_ADDR_cc_R8_HI          -- clock conditioner R8 bits 31...16
286      X"0908", -- SD_ADDR_cc_R8_LO          -- clock conditioner R8 bits 15...0
287      X"A003", -- SD_ADDR_cc_R9_HI          -- clock conditioner R9 bits 31...16
288      X"2A09", -- SD_ADDR_cc_R9_LO          -- clock conditioner R9 bits 15...0
289      X"0082", -- SD_ADDR_cc_R11_HI         -- clock conditioner R11 bits 31...16
290      X"000B", -- SD_ADDR_cc_R11_LO         -- clock conditioner R11 bits 15...0
291      X"020A", -- SD_ADDR_cc_R13_HI         -- clock conditioner R13 bits 31...16
292      X"000D", -- SD_ADDR_cc_R13_LO         -- clock conditioner R13 bits 15...0
293      X"0830", -- SD_ADDR_cc_R14_HI         -- clock conditioner R14 bits 31...16
294      X"280E", -- SD_ADDR_cc_R14_LO         -- clock conditioner R14 bits 15...0
295      X"1400", -- SD_ADDR_cc_R15_HI         -- clock conditioner R15 bits 31...16
296      X"FA0F", -- SD_ADDR_cc_R15_LO         -- clock conditioner R15 bits 15...0
297      X"001D", -- SD_ADDR_coin_win_p        -- majority coincidence window (for physics)
298      X"001E", -- SD_ADDR_coin_win_c        -- majority coincidence window (for calibration)
299      X"001F"  --                           -- Spare
300  );
301
302  -- default values for all FTUs
303  constant sd_block_ftu_default_array : sd_block_ftu_default_array_type := (
304      X"01FF", -- enables patch 0 board x crate y
305      X"01FF", -- enables patch 1 board x crate y
306      X"01FF", -- enables patch 2 board x crate y
307      X"01FF", -- enables patch 3 board x crate y
308      X"01F4", -- DAC_A board x crate y
309      X"01F4", -- DAC_B board x crate y
310      X"01F4", -- DAC_C board x crate y
311      X"01F4", -- DAC_D board x crate y
312      X"0010", -- DAC_H board x crate y
313      X"0001"  -- Prescaling board x crate y
314  );
315
316  --default values for active FTU lists
317  constant sd_block_default_ftu_active_list : sd_block_default_ftu_active_list_type := (
318    X"0001",
319    X"0000",
320    X"0000",
321    X"0000"
322  );
323
324  -- Light pulser interface
325  constant low_PLC : integer := 16;   -- minimal pulse duration in units of 4 ns
326  constant width_PLC : integer := 6;  -- counter width pulse duration
327
328  -- Timing counter
329  constant tc_width : integer := 48;    -- width (number of bits) of timing counter
330  constant zero : unsigned (tc_width - 1 downto 0) := (others => '0'); 
331
332end ftm_constants;
Note: See TracBrowser for help on using the repository browser.