OpenCores
URL https://opencores.org/ocsvn/w11/w11/trunk

Subversion Repositories w11

[/] [w11/] [tags/] [w11a_V0.74/] [doc/] [README.txt] - Blame information for rev 17

Go to most recent revision | Details | Compare with Previous | View Log

Line No. Rev Author Line
1 17 wfjm
# $Id: README.txt 467 2013-01-02 19:49:05Z mueller $
2 5 wfjm
 
3
Release notes for w11a
4
 
5
  Table of content:
6
 
7
  1. Documentation
8
  2. Files
9
  3. Change Log
10
 
11
 
12 9 wfjm
1. Documentation -------------------------------------------------------------
13 5 wfjm
 
14
  More detailed information on installation, build and test can be found
15
  in the doc directory, specifically
16
 
17
    * README.txt: release notes
18
    * INSTALL.txt: installation and building test benches and systems
19
    * w11a_tb_guide.txt: running test benches
20
    * w11a_os_guide.txt: booting operating systems
21 6 wfjm
    * w11a_known_issues.txt: known differences, limitations and issues
22 5 wfjm
 
23 9 wfjm
2. Files ---------------------------------------------------------------------
24 5 wfjm
 
25
   doc                          Documentation
26
   rtl                          VHDL sources
27
   rtl/bplib                    - board and component support libs
28 16 wfjm
   rtl/bplib/atlys                - for Digilent Atlys board
29 17 wfjm
   rtl/bplib/fx2lib               - for Cypress FX2 USB interface controller
30 5 wfjm
   rtl/bplib/issi                 - for ISSI parts
31
   rtl/bplib/micron               - for Micron parts
32
   rtl/bplib/nexys2               - for Digilent Nexsy2 board
33 15 wfjm
   rtl/bplib/nexys3               - for Digilent Nexsy3 board
34 16 wfjm
   rtl/bplib/nxcramlib            - for CRAM part used in Nexys2/3
35 5 wfjm
   rtl/bplib/s3board              - for Digilent S3BOARD
36
   rtl/ibus                     - ibus devices (UNIBUS peripherals)
37
   rtl/sys_gen                  - top level designs
38 17 wfjm
   rtl/sys_gen/tst_fx2loop        - top level designs for Cypress FX2 tester
39
     nexys2                         - systems for Nexsy2
40 11 wfjm
   rtl/sys_gen/tst_rlink          - top level designs for an rlink tester
41 16 wfjm
     nexys2,nexys3,s3board          - systems for Nexsy2,Nexsy3,S3BOARD
42 17 wfjm
   rtl/sys_gen/tst_rlink_cuff     - top level designs for rlink over FX2 tester
43
     nexys2                         - systems for Nexsy2
44 16 wfjm
   rtl/sys_gen/tst_serloop        - top level designs for serport loop tester
45
     nexys2,nexys3,s3board          - systems for Nexsy2,Nexsy3,S3BOARD
46
   rtl/sys_gen/tst_snhumanio      - top level designs for human I/O tester
47
     atlys,nexys2,nexys3,s3board    - systems for Atlys,Nexsy2,Nexsy3,S3BOARD
48 5 wfjm
   rtl/sys_gen/w11a               - top level designs for w11a SoC
49 16 wfjm
     nexys2,nexys3,s3board          - w11a systems for Nexsy2,Nexsy3,S3BOARD
50 5 wfjm
   rtl/vlib                     - VHDL component libs
51
   rtl/vlib/comlib                - communication
52
   rtl/vlib/genlib                - general
53
   rtl/vlib/memlib                - memory
54 9 wfjm
   rtl/vlib/rbus                  - rri: rbus
55
   rtl/vlib/rlink                 - rri: rlink
56 5 wfjm
   rtl/vlib/serport               - serial port (UART)
57
   rtl/vlib/simlib                - simulation helper lib
58
   rtl/vlib/xlib                  - Xilinx specific components
59
   rtl/w11a                     - w11a core
60
   tools                        helper programs
61
   tools/bin                    - scripts and binaries
62 11 wfjm
   tools/dox                    - Doxygen documentation configuration
63
   tools/make                   - make includes
64 17 wfjm
   tools/fx2                    - Firmware for Cypress FX2 USB Interface
65
   tools/fx2/bin                  - pre-build firmware images in .ihx format
66
   tools/fx2/src                  - C and asm sources
67
   tools/fx2/sys                  - udev rules for USB on fpga eval boards
68
   tools/src                    - C++ sources for rlink backend software
69 11 wfjm
   tools/src/librlink             - basic rlink interface
70
   tools/src/librlinktpp          - C++ to tcl binding for rlink interface
71 17 wfjm
   tools/src/librtcltools         - support classes to implement Tcl bindings
72 11 wfjm
   tools/src/librtools            - general support classes and methods
73
   tools/src/librutiltpp          - Tcl support commands implemented in C++
74
   tools/tcl                    - Tcl scripts
75 5 wfjm
 
76 9 wfjm
3. Change Log ----------------------------------------------------------------
77 5 wfjm
 
78 17 wfjm
- trunk (2013-01-02: svn rev 17(oc) 467(wfjm); untagged w11a_V0.56) ++++++++++
79
 
80
  - Summary
81
    - re-organized handling of board and derived clocks in test benches
82
    - added message filter definitions for some designs (.mfset files)
83
    - added Cypress EZ-USB FX2 controller (USB interface)
84
    - added firmware for EZ-USB FX2 supporting jtag access and data transfer
85
    - FPGA configure over USB now supported directly in make build flow
86
    - added test systems for USB testing and rlink over USB verification
87
    - no functional change of w11a CPU core or any pre-existing test systems
88
    - Note: Carefully read the disclaimer about usage of USB VID/PID numbers
89
            in the file README_USB-VID-PID.txt. You'll be responsible for any
90
            misuse of the defaults provided with the project sources !!
91
 
92
  - New refernce system
93
    The development and test system was upgraded from Kubuntu 10.04 to 12.04.
94
    The version of several key tools and libraries changed:
95
       linux kernel    3.2.0    (was  2.6.32)
96
       gcc/g++         4.6.3    (was  4.4.3)
97
       boost           1.46.1   (was  1.40)
98
       libusb          1.0.9    (was  1.0.6)
99
       perl            5.14.2   (was  5.10.1)
100
       tcl             8.5.11   (was  8.4.19)
101
       xilinx ise     13.3      (was 13.1)
102
    --> see INSTALL.txt, INSTALL_ghdl.txt and INSTALL_urjtag.txt
103
 
104
  - New features
105
    - added firmware for Cypress FX2 controller
106
      - tools/fx2
107
        - bin    - pre-build firmware images in .ihx file format
108
        - src    - C and asm sources
109
        - sys    - udev rules for usb interfaces on fpga eval boards
110
    - new modules
111
      - rtl/bplib/fx2lib
112
        - fx2_2fifoctl_ic - Cypress EZ-USB FX2 controller (2 fifo; int clk)
113
        - fx2_3fifoctl_ic - Cypress EZ-USB FX2 controller (3 fifo; int clk)
114
    - new systems
115
      - rtl/sys_gen/tst_fx2loop/nexys2/ic/sys_tst_fx2loop_ic_n2
116
      - rtl/sys_gen/tst_fx2loop/nexys2/ic3/sys_tst_fx2loop_ic3_n2
117
      - rtl/sys_gen/tst_rlink_cuff/nexys2/ic/sys_tst_rlink_cuff_ic_n2
118
    - tools/bin
119
      - xilinx_sdf_ghdl_filter: tool to patch ISE sdf files for usage with ghdl
120
 
121
  - Changes
122
    - documentation
123
      - added a 'system requirements' section in INSTALL.txt
124
      - added INSTALL_ghdl.txt and INSTALL_urjtag.txt covering ghdl and urjtag
125
      - added README_USB-VID-PID.txt
126
    - organizational changes
127
      - added TCLINC,RETRO_FX2_VID,RETRO_FX2_PID environment variables
128
    - functional changes
129
      - tools/bin
130
        - vbomconv - file name substitution handling redone; many vboms updated
131
    - retired modules
132
      - vlib/rlink/tb/
133
        - tbcore_rlink_dcm  - obsolete, use tbcore_rlink
134
 
135 16 wfjm
- trunk (2011-12-23: svn rev 16(oc) 442(wfjm); untagged w11a_V0.55)  +++++++++
136 12 wfjm
 
137
  - Summary
138 16 wfjm
    - added xon/xoff (software flow control) support to serport library
139
    - added test systems for serport verification
140
    - use new serport stack in sys_w11a_* and sys_tst_rlink_* systems
141 15 wfjm
 
142
  - New features
143 16 wfjm
    - new modules
144
      - vlib/serport
145
        - serport_xonrx  - xon/xoff logic rx path
146
        - serport_xontx  - xon/xoff logic tx path
147
        - serport_1clock - serial port module (uart, fifo, flow control)
148
      - vlib/rlink
149
        - rlink_core8 - rlink core8 with 8bit interface
150
        - rlink_sp1c  - rlink_core8 + serport_1clock combo
151
    - new unit tests
152
      - bplib/s3board/tb/tb_s3_sram_memctl       (for s3board sram controller
153
      - bplib/nxcramlib/tb/tb_nx_cram_memctl_as  (for nexys2,3 cram controller)
154 15 wfjm
    - new systems
155 16 wfjm
      - sys_gen/tst_serloop/nexys2/sys_tst_serloop1_n2
156
      - sys_gen/tst_serloop/nexys3/sys_tst_serloop1_n3
157
      - sys_gen/tst_serloop/s3board/sys_tst_serloop1_s3
158
      - sys_gen/tst_rlink/s3board/sys_tst_rlink_s3
159 15 wfjm
 
160 17 wfjm
  - Changes
161
    - retired modules
162
      - vlib/rlink
163
        - rlink_rlb2rl       - obsolete, now all in rlink_core8
164
        - rlink_base         - use now new rlink_core8
165
        - rlink_serport      - obsolete, now all in rlink_sp1c
166
        - rlink_base_serport - use now new rlink_sp1c
167
 
168 16 wfjm
- trunk (2011-12-04: svn rev 15(oc) 436(wfjm); untagged w11a_V0.54)  +++++++++
169
 
170
  - Summary
171
    - added support for nexys3 board for w11a
172
 
173 17 wfjm
  - New features
174
    - new systems
175
      - sys_gen/w11a/nexys3/sys_w11a_n3
176
      - sys_gen/w11a/nexys3/sys_tst_rlink_n3
177
 
178 15 wfjm
  - Changes
179
    - module renames:
180
        bplib/nexys2/n2_cram_dummy     -> bplib/nxcramlib/nx_cram_dummy
181
        bplib/nexys2/n2_cram_memctl_as -> bplib/nxcramlib/nx_cram_memctl_as
182
 
183
  - Bug fixes
184
    - tools/src/lib*: backend libraries compile now on 64 bit systems
185
 
186
- trunk (2011-11-20: svn rev 14(oc) 428(wfjm); untagged w11a_V0.532) +++++++++
187
 
188
  - Summary
189 13 wfjm
    - generalized the 'human I/O' interface for s3board,nexys2/3 and atlys
190
    - added test design for the 'human I/O' interface
191
    - no functional change of w11a CPU core or any existing test systems
192
 
193
  - Changes
194
    - functional changes
195
      - use now 'a6' polynomial of Koopman et al for crc8 in rlink
196
    - with one exception all vhdl sources use now numeric_std
197
    - module renames:
198
        vlib/xlib/dcm_sp_sfs_gsim   -> vlib/xlib/dcm_sfs_gsim
199
        vlib/xlib/dcm_sp_sfs_unisim -> vlib/xlib/dcm_sfs_unisim_s3e
200
        vlib/xlib/tb/tb_dcm_sp_sfs  -> vlib/xlib/tb/tb_dcm_sfs
201
 
202 16 wfjm
  - New features
203
    - new modules
204
      - rtl/sys_gen/tst_snhumanio
205
        - sub-tree with test design for 'human I/O' interface modules
206
        - atlys, nexys2, and s3board directories contain the systems
207
          for the respective Digilent boards
208
 
209 13 wfjm
- trunk (2011-09-11: svn rev 12(oc) 409(wfjm); untagged w11a_V0.531) +++++++++
210
 
211
  - Summary
212 12 wfjm
    - Many small changes to prepare upcoming support for
213
      - Spartan-6 boards (nexys3 and atlys)
214
      - usage of Cypress FX2 USB interface on nexys2/3 and atlys boards
215
    - no functional change of w11a CPU core or any test systems
216
 
217
  - Changes
218
    - use boost libraries instead of custom coding:
219
      - boost/function and /bind for callbacks, retire RmethDscBase and RmethDsc
220
      - boost/foreach for some iterator loops
221
      Note: boost 1.35 and gcc 4.3 or newer is required, see INSTALL.txt
222
    - module renames:
223
        bplib/s3board/s3_rs232_iob_int -> bplib/bpgen/bp_rs232_2line_iob
224
        bplib/s3board/s3_rs232_iob_ext -> bplib/bpgen/bp_rs232_4line_iob
225
        bplib/s3board/s3_dispdrv       -> bplib/bpgen/sn_4x7segctl
226
        bplib/s3board/s3_humanio       -> bplib/bpgen/sn_humanio
227
        bplib/s3board/s3_humanio_rbus  -> bplib/bpgen/sn_humanio_rbus
228
    - other renames:
229
        tools/bin/impact_wrapper       -> tools/bin/config_wrapper
230
    - reorganize Makefile includes and xflow option files
231
        rtl/vlib/Makefile.ghdl         -> rtl/make/generic_ghdl.mk
232
        rtl/vlib/Makefile.isim         -> rtl/make/generic_isim.mk
233
        rtl/vlib/Makefile.xflow        -> rtl/make/generic_xflow.mk
234
        rtl/vlib/xst_vhdl.opt          -> rtl/make/syn_s3_speed.opt
235
        rtl/vlib/balanced.opt          -> rtl/make/imp_s3_speed.opt
236
 
237 11 wfjm
- trunk (2011-04-17: svn rev 11(oc) 376(wfjm); untagged w11a_V0.53) ++++++++++
238 6 wfjm
 
239 9 wfjm
  - Summary
240 11 wfjm
    - Introduce C++ and Tcl based backend server. A set of C++ classes provide
241 16 wfjm
      the basic rlink communication primitives. Additional glue classes provide
242 11 wfjm
      a Tcl binding. This first phase contains the basic functionality needed
243
      to control simple test benches.
244
    - add an 'rlink exerciser' (tst_rlink) and a top level design for a Nexys2
245
      board (sys_tst_rlink_n2) and a test suite implemented in Tcl.
246
 
247
  - Note: No functional changes in w11a core and I/O system at this point!
248
          The w11a demonstrator systems are still operated with the old
249
          backend code (pi_rri).
250
 
251
  - New features
252
    - new directory trees for
253
      - C++ sources of backend (plus make and doxygen documentation support)
254
        - tools/dox                - Doxygen documentation configuration
255
        - tools/make               - make includes
256
        - tools/src/librlink       - basic rlink interface
257
        - tools/src/librlinktpp    - C++ to tcl binding for rlink interface
258
        - tools/src/librtools      - general support classes and methods
259
        - tools/src/librtcltools   - support classes to implement Tcl bindings
260
        - tools/src/librutiltpp    - Tcl support commands implemented in C++
261
      - VHDL sources of an 'rlink exerciser'
262
        - rtl/sys_gen/tst_rlink    - top level designs for an rlink tester
263
        - rtl/sys_gen/tst_rlink/nexys2  - rlink tester system for Nexsy2 board
264
      - Tcl sources of 'rlink exerciser'
265
        - tools/tcl/rlink          - defs and proc's for basic rlink functions
266
        - tools/tcl/rutil          - general support procs
267
        - tools/tcl/rbtest         - defs and proc's for rbd_tester
268
        - tools/tcl/rbbram         - defs and proc's for rbd_bram
269
        - tools/tcl/rbmoni         - defs and proc's for rbd_rbmon
270
        - tools/tcl/rbs3hio        - defs and proc's for s3_humanio_rbus
271
        - tools/tcl/tst_rlink      - defs and proc's for tst_rlink
272
    - new modules
273
      - rtl/vlib/rbus
274
        - rbd_bram     - rbus bram test target
275
        - rbd_eyemon   - eye monitor for serport's
276
        - rbd_rbmon    - rbus monitor
277
        - rbd_tester   - rbus tester
278
        - rbd_timer    - usec precision timer
279
      - rtl/vlib/memlib
280
        - additional wrappers for distributed and block memories added
281
      - tools/bin
282
        - ti_rri: Tcl driver for rlink tests and servers (will replace pi_rri)
283
 
284
- trunk (2011-01-02: svn rev 9(oc) 352(wfjm); untagged w11a_V0.52) +++++++++++
285
 
286
  - Summary
287
    - Introduce rbus protocol V3
288 9 wfjm
    - reorganize rbus and rlink modules, many renames
289
 
290 17 wfjm
  - New features
291
    - vlib/rbus
292
      - added several rbus devices useful for debugging
293
        - rbd_tester: test target, used for example in test benches
294
 
295 8 wfjm
  - Changes
296
    - module renames:
297 9 wfjm
      - the rri (remote-register-interface) components were re-organized and
298
        cleanly separated into rbus and rlink components:
299
          rri/rb_sres_or_*              -> rbus/rb_sres_or_*
300
          rri/rri_core                  -> rlink/rlink_core
301
          rri/rri_base_serport          -> rlink/rlink_base_serport
302
          rri/rrilib                    -> rbus/rblib
303
                                        -> rlink/rlinklib
304
          rri/rri_serport               -> rlink/rlink_serport
305
          rri/tb/rritb_sres_or_mon      -> rbus/rb_sres_or_mon
306
      - the rri test bench monitors were reorganized and renamed
307
          rri/tb/rritb_cpmon            -> rlink/rlink_mon
308
          rri/tb/rritb_cpmon_sb         -> rlink/rlink_mon_sb
309
          rri/tb/rritb_rbmon            -> rbus/rb_mon
310
          rri/tb/rritb_rbmon_sb         -> rbus/rb_mon_sb
311
      - the rri low level test bench were also renamed
312
          rri/tb/tb_rri                 -> rlink/tb/tb_rlink
313
          rri/tb/tb_rri_core            -> rlink/tb/tb_rlink_direct
314
          rri/tb/tb_rri_serport         -> rlink/tb/tb_rlink_serport
315
      - the base modules for rlink+cext based test benches were renamed
316
          rri/tb/rritb_core_cm          -> rlink/tb/tbcore_rlink_dcm
317
          rri/tb/rritb_core             -> rlink/tb/tbcore_rlink
318
          rri/tb/vhpi_rriext            -> rlink/tb/rlink_cext_vhpi
319
          rri/tb/cext_rriext.c          -> rlink/tb/rlink_cext.c
320
 
321
      - other rri/rbus related renames
322
          bplib/s3board/s3_humanio_rri  -> s3_humanio_rbus
323
          w11a/pdp11_core_rri           -> pdp11_core_rbus
324
 
325
      - other renames
326
          w11a/tb/tb_pdp11_core         -> tb_pdp11core
327
 
328
    - signal renames:
329
      - rlink interface (defined in rlink/rlinklib.vhd):
330
        - rename rlink port signals:
331
          CP_*  -> RL_*
332
        - rename status bit names to better reflect their usage in v3:
333
          ccrc  -> cerr   - indicates cmd crc error or other cmd level abort
334
          dcrc  -> derr   - indicates data crc error or other data level abort
335
          ioto  -> rbnak  - indicates rbus abort, either no ack or timeout
336
          ioerr -> rberr  - indicates that rbus err flag was set
337
 
338 16 wfjm
    - migrate to rbus protocol version 3
339 9 wfjm
      - in rb_mreq use now aval,re,we instead of req,we
340
      - basic rbus transaction now takes 2 cycles, one for address select, one
341
        for data exchange. Same concept and reasoning behind as in ibus V2.
342
 
343
    - vlib/rlink/rlink_core
344
      - cerr and derr state flags now set on command or data crc errors as well
345
        as on eop/nak aborts when command or wblk data is received.
346
      - has now 'monitor port', RL_MONI.
347
      - RL_FLUSH port removed, the flush logic is now in rlink_serport
348
 
349
    - restructured rlink modules
350
      - rlink_core is the rlink protocol engine with a 9 bit wide interface
351
      - rlink_rlb2rl (new) is an adapter to a byte wide interface
352
      - rlink_base (new) combines rlink_core and rlink_rlb2rl
353
      - rlink_serport (re-written) is an adapter to a serial interface
354
      - rlink_base_serport (renamed) combines rlink_base and rlink_serport
355
 
356 11 wfjm
- trunk (2010-11-28: svn rev 8(oc) 341(wfjm); untagged w11a_V0.51) +++++++++++
357 9 wfjm
 
358
  - Summary
359 11 wfjm
    - Introduce ibus protocol V2
360 9 wfjm
    - Nexys2 systems use DCM
361
    - sys_w11a_n2 now runs with 58 MHz
362
 
363 17 wfjm
  - New features
364
    - ibus
365
      - added ib_sres_or_mon to check for miss-behaving ibus devices
366
      - added ib_sel to encapsulate address select logic
367
    - nexys2 systems
368
      - now DCM derived system clock supported
369
      - sys_gen/w11a/nexys2
370
        - sys_w11a_n2 now runs with 58 MHz clksys
371
 
372 9 wfjm
  - Changes
373
    - module renames:
374 8 wfjm
      - in future 'box' is used for large autonomous blocks, therefore use
375
        the term unit for purely sequential logic modules:
376
          pdp11_abox -> pdp11_ounit
377
          pdp11_dbox -> pdp11_aunit
378
          pdp11_lbox -> pdp11_lunit
379
          pdp11_mbox -> pdp11_munit
380 6 wfjm
 
381 8 wfjm
    - signal renames:
382
      - renamed RRI_LAM -> RB_LAM in all ibus devices
383
      - renamed CLK     -> I_CLK50 in all top level nexys2 and s3board designs
384
 
385 16 wfjm
    - migrate to ibus protocol version 2
386 8 wfjm
      - in ib_mreq use now aval,re,we,rmw instead of req,we,dip
387
      - basic ibus transaction now takes 2 cycles, one for address select, one
388 9 wfjm
        for data exchange. This avoids too long logic paths in the ibus logic.
389 8 wfjm
 
390
  - Bug fixes
391
    - rtl/vlib/Makefile.xflow: use default .opt files under rtl/vlib again.
392
 
393 11 wfjm
- w11a_V0.5 (2010-07-23) +++++++++++++++++++++++++++++++++++++++++++++++++++++
394 6 wfjm
 
395 5 wfjm
  Initial release with
396
  - w11a CPU core
397
  - basic set of peripherals: kw11l, dl11, lp11, pc11, rk11/rk05
398
  - just for fun: iist (not fully implemented and tested yet)
399
  - two complete system configurations with
400
    - for a Digilent S3BOARD    rtl/sys_gen/w11a/s3board/sys_w11a_s3
401
    - for a Digilent Nexys2     rtl/sys_gen/w11a/nexys2/sys_w11a_n2

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.