Move buffered serial to extra entity.
[bos2k9.git] / bos2k9.vhd
1 -----------------------------------------------------------------------
2 -- Copyright (c) 2009 Malte S. Stretz <http://msquadrat.de> 
3 --
4 -- The project top level entity.
5 --
6 -- It implements a simple test setup which can read data from an SD 
7 -- card.  Blocks are read in 512 Byte blocks, so both block addresses
8 -- and byte addresses (relative to the block start) can be specified.
9 -- The system starts up doing nothing, an init button has to be pressed
10 -- to initialize the card and afterwards the selected block can be read
11 -- to an internal buffer.
12 --
13 -- This is designed around the DE2 evaluation board.  To simplify
14 -- development, the ports of the entity are named after the file
15 -- `DE2_Pin_Table.pdf`, which is part of the DE2 documentation.
16 -- The PDF file was converted to a TCL file and is included in this
17 -- project as `de2_pins.tcl` and can be copied to the `bos2k9.qsf`
18 -- project file.  This has the side effect that Quartus will complain
19 -- that some of these pins are stuck to GND or not used; these 
20 -- warnings can be ignored.
21 --
22 -- The following pins are used:
23 --  * `CLOCK_50` is the 50 MHz system clock.
24 --  * `KEY` are the four push button which are low-active.
25 --  * `SW` are the eighteen on-off switches.
26 --  * `LEDR` are the eighteen red LEDs above the switches.
27 --  * `LEDG` are the nine green LEDs; the low eight are located above
28 --    the push buttons, the ninth is above the row of red LEDs.
29 --  * `SD_DAT` is the SPI MISO.
30 --  * `SD_CMD` is the SPI MOSI.
31 --  * `SD_DAT3` is the SPI CS.
32 --  * `SD_CLK` is the SPI SCK.
33 --
34 -- LEDG(0) should be always on and represents a powered system. The 
35 -- `reset` is wired to `SW(17)`, so the switch should be off when these
36 -- system is started.  Once `reset` is off (ie. the switch on), the card
37 -- can be initialized (and later reset) by pressing `KEY(0)`.  Once
38 -- LEDG(2) is led, the system is ready to read a block; if an error 
39 -- occurs, LEDG(1) is switched on instead.
40 --
41 -- The low eight bits of the block address can be specified by the
42 -- first eight `SW`es, ie. SW(0) to SW(7).  Only the first 256 blocks 
43 -- of 4096 possible ones (on 2 GiB SD cards; SDHC is not supported) can 
44 -- be read.  `KEY(1)` starts the reading of the selected block.
45 --
46 -- The used `button` entity ensures that even with really slow fingers,
47 -- the button press is only signaled once.  As the buttons on the DE2
48 -- board tend to break, this cannot be ensured but a longer press 
49 -- doesn't break anything.
50 --
51 -- The currently via SW(8) to SW(15) selected byte is displayed on the
52 -- LEDs LEDR(0) to LEDR(7).
53 --
54 -- Because only eight address bits are wired, only half the block can 
55 -- be displayed.  Both this and the above limitation doesn't matter as 
56 -- this is a test setup only.
57 --
58 -- For debugging purposes, the SPI bus is also wired to the LEDs 
59 -- LEDG(7) to LEDG(4). 
60 -----------------------------------------------------------------------
61
62 library ieee;
63 use ieee.std_logic_1164.all;
64 use ieee.numeric_std.all;
65
66 library fhw_sd;
67 use fhw_sd.sd_host;
68
69 library fhw_tools;
70 use fhw_tools.all;
71 use fhw_tools.types.all;
72
73 use work.bos2k9_globals.all;
74
75 -----------------------------------------------------------------------
76
77 entity bos2k9 is
78   port(
79     CLOCK_50 : in std_logic;
80     
81     KEY  : in  std_logic_vector(3 downto 0);
82     SW   : in  std_logic_vector(17 downto 0);
83     LEDR : out std_logic_vector(17 downto 0);
84     LEDG : out std_logic_vector(8 downto 0);
85     
86     UART_RXD : in  std_logic;
87     UART_TXD : out std_logic;
88     
89     SD_DAT  : in  std_logic;
90     SD_CMD  : out std_logic;
91     SD_DAT3 : out std_logic;
92     SD_CLK  : out std_logic);
93 end bos2k9;
94
95 -----------------------------------------------------------------------
96
97 architecture board of bos2k9 is
98
99   component sd_host is
100     generic(
101       clock_interval : time     := clock_interval_c;
102       clock_divider  : positive := sd_clock_div_c);
103     port(
104       clk : in  std_logic;
105       rst : in  std_logic;
106
107       init  : in  std_logic;
108       ready : out std_logic;
109       error : out std_logic;
110       
111       address : in  std_logic_block_address_t;
112       start   : in  std_logic;
113       rxd     : out std_logic_byte_t;
114       shd     : out std_logic;
115       
116       miso  : in  std_logic;
117       mosi  : out std_logic;
118       sck   : out std_logic;
119       cs    : out std_logic);
120   end component;
121   
122   component bos2k9_counter is
123     generic(
124       cnt  : positive);
125     port(
126       clk  : in  std_logic;
127       rst  : in  std_logic;
128       en   : in  std_logic;
129       clr  : in  std_logic;
130       done : out std_logic);
131   end component;
132   
133   component bos2k9_pump is
134     generic(
135       clock_divider  : positive  := ser_clock_div_c;
136       parity_enabled : std_logic := '1');
137     port(
138       clock : in  std_logic;
139       reset : in  std_logic;
140     
141       busy  : out std_logic;
142     
143       txn : in  std_logic;
144       txd : in  std_logic_byte_t;
145       tx : out std_logic);
146   end component;
147   
148   component button
149     port(
150       clk : in std_logic;
151       rst : in std_logic;
152       
153       input  : in  std_ulogic;
154       output : out std_ulogic);
155   end component;
156
157   signal clock_s : std_logic;
158   signal reset_s : std_logic;
159   
160   signal ready_led_s : std_logic;
161   signal error_led_s : std_logic;
162   signal dummy_led_s : std_logic;
163   
164   signal read_btn_s : std_logic;
165   
166   signal byte_led_s  : std_logic_vector(7 downto 0);
167   signal byte_sw1_s  : std_logic_vector(7 downto 0);
168   
169   signal spi_s : spi_bus_t;
170   signal ser_s : ser_bus_t;
171   
172 begin
173   clock_s <= CLOCK_50;
174   reset_s <= not SW(17);
175
176   read_button : button port map(clock_s, reset_s,
177     input  => KEY(1),
178     output => read_btn_s);
179   
180   spi_s.miso <= SD_DAT;
181   SD_CMD     <= spi_s.mosi;
182   SD_CLK     <= spi_s.sck;
183   SD_DAT3    <= spi_s.cs;
184   
185   UART_TXD <= ser_s.tx;
186   ser_s.rx <= UART_RXD;
187   
188   LEDG <= (
189     7 => spi_s.miso,
190     6 => spi_s.mosi,
191     5 => spi_s.sck,
192     4 => spi_s.cs,
193     3 => dummy_led_s,
194     1 => ready_led_s,
195     0 => error_led_s,
196     others => '0');
197   LEDR <= (
198    17 => not reset_s,
199     7 => byte_led_s(7),
200     6 => byte_led_s(6),
201     5 => byte_led_s(5),
202     4 => byte_led_s(4),
203     3 => byte_led_s(3),
204     2 => byte_led_s(2),
205     1 => byte_led_s(1),
206     0 => byte_led_s(0),
207     others => '0');
208   byte_sw1_s <= SW(7 downto 0);
209   
210   guts : block
211     -- SD interface.
212     signal sd_init_s    : std_logic;
213     signal sd_ready_s   : std_logic;
214     signal sd_error_s   : std_logic;
215     signal sd_address_s : std_logic_block_address_t;
216     signal sd_start_s   : std_logic;
217     signal sd_data_s    : std_logic_byte_t;
218     signal sd_latch_s   : std_logic;
219     signal sd_shift_s   : std_logic;
220     
221     signal pumping_s    : std_logic;
222   begin
223
224     -- Map the board outputs.
225     ready_led_s <= sd_ready_s;
226     error_led_s <= sd_error_s;
227     dummy_led_s <= pumping_s;
228     byte_led_s  <= (others => '0');
229     
230     -- We can address the first 256 blocks only.
231     sd_address_s(std_logic_block_address_t'high downto std_logic_byte_t'high + 1) <= (others => '0');
232     sd_address_s(std_logic_byte_t'range) <= byte_sw1_s;
233     
234     sd_start_s <= read_btn_s and not pumping_s;
235   
236     sd_io : sd_host port map(
237       clk => clock_s,
238       rst => reset_s,
239     
240       init    => sd_init_s, 
241       ready   => sd_ready_s,
242       error   => sd_error_s,
243       address => sd_address_s,
244       start   => sd_start_s,
245       rxd     => sd_data_s,
246       shd     => sd_latch_s,
247     
248       miso  => spi_s.miso,
249       mosi  => spi_s.mosi,
250       sck   => spi_s.sck,
251       cs    => spi_s.cs);
252     sd_to : bos2k9_counter generic map(
253       cnt  => init_ticks_c) port map(
254       clk  => clock_s,
255       rst  => reset_s,
256       en   => '1',
257       clr  => sd_ready_s,
258       done => sd_init_s);
259     
260     pump : bos2k9_pump port map(
261       clock => clock_s,
262       reset => reset_s,
263       
264       busy  => pumping_s,
265       
266       txd   => sd_data_s,
267       txn   => sd_latch_s,
268       tx    => ser_s.tx);
269   end block;
270 end board;