Added inverted LED data output.
[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) and inverted on LEDR(8) to LEDR(15).
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
65 library fhw_sd;
66 use fhw_sd.sd_host;
67
68 library fhw_tools;
69 use fhw_tools.all;
70 use fhw_tools.types.all;
71
72 use work.bos2k9_globals.all;
73
74 -----------------------------------------------------------------------
75
76 entity bos2k9 is
77   port(
78     CLOCK_50 : in std_logic;
79     
80     KEY  : in  std_logic_vector(3 downto 0);
81     SW   : in  std_logic_vector(17 downto 0);
82     LEDR : out std_logic_vector(17 downto 0);
83     LEDG : out std_logic_vector(8 downto 0);
84     
85     SD_DAT  : in  std_logic;
86     SD_CMD  : out std_logic;
87     SD_DAT3 : out std_logic;
88     SD_CLK  : out std_logic);
89 end bos2k9;
90
91 -----------------------------------------------------------------------
92
93 architecture board of bos2k9 is
94
95   component sd_host is
96     generic(
97       clock_interval : time     := clock_interval_c;
98       clock_divider  : positive := sd_clock_div_c);
99     port(
100       clk : in  std_logic;
101       rst : in  std_logic;
102
103       init  : in  std_logic;
104       ready : out std_logic;
105       error : out std_logic;
106       
107       address : in  std_logic_block_address_t;
108       start   : in  std_logic;
109       rxd     : out std_logic_byte_t;
110       shd     : out std_logic;
111       
112       miso  : in  std_logic;
113       mosi  : out std_logic;
114       sck   : out std_logic;
115       cs    : out std_logic);
116   end component;
117   
118   component bos2k9_mmu is
119     port(
120       clock : in  std_logic;
121       reset : in  std_logic;
122     
123       write_next : in  std_logic;
124       write_addr : out std_logic_byte_address_t;
125       write_data : in  std_logic_byte_t;
126     
127       read_addr : in  std_logic_byte_address_t;
128       read_data : out std_logic_byte_t);
129   end component;
130   
131   component button
132     port(
133       clk : in std_logic;
134       rst : in std_logic;
135       
136       input  : in  std_ulogic;
137       output : out std_ulogic);
138   end component;
139
140   signal clock_s : std_logic;
141   signal reset_s : std_logic;
142   
143   signal ready_led_s : std_logic;
144   signal error_led_s : std_logic;
145   
146   signal init_btn_s  : std_logic;
147   signal start_btn_s : std_logic;
148   
149   signal byte_led_s  : std_logic_vector(7 downto 0);
150   signal byte_sw1_s  : std_logic_vector(7 downto 0);
151   signal byte_sw2_s  : std_logic_vector(7 downto 0);
152   
153   signal spi_s : spi_bus_t;
154   
155 begin
156   clock_s <= CLOCK_50;
157   reset_s <= not SW(17);
158
159   init_button : button port map(clock_s, reset_s,
160     input  => KEY(0),
161     output => init_btn_s);
162   start_button : button port map(clock_s, reset_s,
163     input  => KEY(1),
164     output => start_btn_s);
165   
166   spi_s.miso <= SD_DAT;
167   SD_CMD     <= spi_s.mosi;
168   SD_CLK     <= spi_s.sck;
169   SD_DAT3    <= spi_s.cs;
170   
171   LEDG <= (
172     7 => spi_s.miso,
173     6 => spi_s.mosi,
174     5 => spi_s.sck,
175     4 => spi_s.cs,
176     1 => ready_led_s,
177     0 => error_led_s,
178     others => '0');
179   LEDR <= (
180    17 => not reset_s,
181    15 => not byte_led_s(7),
182    14 => not byte_led_s(6),
183    13 => not byte_led_s(5),
184    12 => not byte_led_s(4),
185    11 => not byte_led_s(3),
186    10 => not byte_led_s(2),
187     9 => not byte_led_s(1),
188     8 => not byte_led_s(0),
189     7 => byte_led_s(7),
190     6 => byte_led_s(6),
191     5 => byte_led_s(5),
192     4 => byte_led_s(4),
193     3 => byte_led_s(3),
194     2 => byte_led_s(2),
195     1 => byte_led_s(1),
196     0 => byte_led_s(0),
197     others => '0');
198   byte_sw1_s <= SW(7 downto 0);
199   byte_sw2_s <= SW(15 downto 8);
200   
201   guts : block
202     signal sd_init_s    : std_logic;
203     signal sd_ready_s   : std_logic;
204     signal sd_error_s   : std_logic;
205     signal sd_address_s : std_logic_block_address_t;
206     signal sd_start_s   : std_logic;
207     signal sd_data_s    : std_logic_byte_t;
208     signal sd_latch_s   : std_logic;
209     signal sd_shift_s   : std_logic;
210   
211     signal bl_address_s : std_logic_byte_address_t;
212   begin
213
214     ready_led_s <= sd_ready_s;
215     error_led_s <= sd_error_s;
216     
217     sd_init_s  <= init_btn_s;
218     sd_start_s <= start_btn_s;
219   
220     sd_address_s(std_logic_block_address_t'high downto std_logic_byte_t'high + 1) <= (others => '0');
221     sd_address_s(std_logic_byte_t'range) <= byte_sw1_s;
222     bl_address_s(std_logic_byte_address_t'high downto std_logic_byte_t'high + 1) <= (others => '0');
223     bl_address_s(std_logic_byte_t'range) <= byte_sw2_s;
224   
225     sd_io : sd_host port map(
226       clk => clock_s,
227       rst => reset_s,
228     
229       init    => sd_init_s, 
230       ready   => sd_ready_s,
231       error   => sd_error_s,
232       address => sd_address_s,
233       start   => sd_start_s,
234       rxd     => sd_data_s,
235       shd     => sd_latch_s,
236     
237       miso  => spi_s.miso,
238       mosi  => spi_s.mosi,
239       sck   => spi_s.sck,
240       cs    => spi_s.cs);
241     mmu : bos2k9_mmu port map(
242       clock => clock_s,
243       reset => reset_s,
244       write_next => sd_latch_s,
245       write_addr => open,
246       write_data => sd_data_s,
247       read_addr  => bl_address_s,
248       read_data  => byte_led_s);
249   
250   end block;
251 end board;