summaryrefslogtreecommitdiffstats
path: root/tools/cpu/nios2/README
diff options
context:
space:
mode:
authorJoel Sherrill <joel.sherrill@OARcorp.com>2011-05-17 20:37:15 +0000
committerJoel Sherrill <joel.sherrill@OARcorp.com>2011-05-17 20:37:15 +0000
commitd305d75c7eac1018c13788954b6707261b5fd176 (patch)
treed39633ece1525958431236cd462163b4bf61356b /tools/cpu/nios2/README
parent4900e0c545561de1ccc1d363650567916d4ec363 (diff)
downloadrtems-d305d75c7eac1018c13788954b6707261b5fd176.tar.bz2
2011-05-17 Joel Sherrill <joel.sherrill@oarcorp.com>
* tools/build/.cvsignore, tools/build/ChangeLog, tools/build/Makefile.am, tools/build/README, tools/build/binpatch.c, tools/build/cklength.c, tools/build/configure.ac, tools/build/cvsignore-add.sh, tools/build/doxy-filter, tools/build/eolstrip.c, tools/build/install-if-change.in, tools/build/multigen, tools/build/packhex.c, tools/build/rtems-bin2c.c, tools/build/search-id.sh, tools/build/unhex.c, tools/cpu/.cvsignore, tools/cpu/ChangeLog, tools/cpu/Makefile.am, tools/cpu/configure.ac, tools/cpu/generic/.cvsignore, tools/cpu/generic/ChangeLog, tools/cpu/generic/Makefile.am, tools/cpu/generic/configure.ac, tools/cpu/generic/size_rtems.in, tools/cpu/nios2/.cvsignore, tools/cpu/nios2/ChangeLog, tools/cpu/nios2/Makefile.am, tools/cpu/nios2/README, tools/cpu/nios2/bridges.c, tools/cpu/nios2/bridges.h, tools/cpu/nios2/clocks.c, tools/cpu/nios2/clocks.h, tools/cpu/nios2/configure.ac, tools/cpu/nios2/devices.c, tools/cpu/nios2/devices.h, tools/cpu/nios2/linkcmds.c, tools/cpu/nios2/linkcmds.h, tools/cpu/nios2/memory.c, tools/cpu/nios2/memory.h, tools/cpu/nios2/nios2gen.c, tools/cpu/nios2/output.c, tools/cpu/nios2/output.h, tools/cpu/nios2/ptf.c, tools/cpu/nios2/ptf.h, tools/cpu/nios2/sample.ptf, tools/cpu/sh/.cvsignore, tools/cpu/sh/AUTHORS, tools/cpu/sh/COPYING, tools/cpu/sh/ChangeLog, tools/cpu/sh/Makefile.am, tools/cpu/sh/TODO, tools/cpu/sh/configure.ac, tools/cpu/sh/sci.c, tools/cpu/sh/sci.h, tools/cpu/sh/shgen.c, tools/schedsim/.cvsignore, tools/schedsim/ChangeLog, tools/schedsim/Makefile.am, tools/schedsim/README, tools/schedsim/configure.ac, tools/schedsim/rtems/.cvsignore, tools/schedsim/rtems/ChangeLog, tools/schedsim/rtems/Makefile.am, tools/schedsim/rtems/interr.c, tools/schedsim/rtems/rtems_init.c, tools/schedsim/rtems/rtems_sched.h, tools/schedsim/rtems/wkspace.c, tools/schedsim/rtems/sched_cpu/cpu.c, tools/schedsim/rtems/sched_cpu/cpu_asm.c, tools/schedsim/rtems/sched_cpu/rtems/asm.h, tools/schedsim/rtems/sched_cpu/rtems/stringto.h, tools/schedsim/rtems/sched_cpu/rtems/score/cpu.h, tools/schedsim/rtems/sched_cpu/rtems/score/cpu_asm.h, tools/schedsim/rtems/sched_cpu/rtems/score/cpuopts.h, tools/schedsim/rtems/sched_cpu/rtems/score/no_cpu.h, tools/schedsim/rtems/sched_cpu/rtems/score/types.h, tools/schedsim/shell/.cvsignore, tools/schedsim/shell/ChangeLog, tools/schedsim/shell/Makefile.am, tools/schedsim/shell/schedsim_priority/.cvsignore, tools/schedsim/shell/schedsim_priority/Makefile.am, tools/schedsim/shell/schedsim_priority/config.c, tools/schedsim/shell/schedsim_priority/printheir_executing.c, tools/schedsim/shell/schedsim_priority/schedsim.cc, tools/schedsim/shell/schedsim_priority/wrap_thread_dispatch.c, tools/schedsim/shell/scripts/script01, tools/schedsim/shell/scripts/script02, tools/schedsim/shell/scripts/script03, tools/schedsim/shell/scripts/script04, tools/schedsim/shell/scripts/script05, tools/schedsim/shell/scripts/script06, tools/schedsim/shell/shared/.cvsignore, tools/schedsim/shell/shared/Makefile.am, tools/schedsim/shell/shared/commands.c, tools/schedsim/shell/shared/getopt.c, tools/schedsim/shell/shared/lookup_semaphore.c, tools/schedsim/shell/shared/lookup_task.c, tools/schedsim/shell/shared/main_clocktick.c, tools/schedsim/shell/shared/main_echo.c, tools/schedsim/shell/shared/main_executing.c, tools/schedsim/shell/shared/main_heir.c, tools/schedsim/shell/shared/main_help.c, tools/schedsim/shell/shared/main_rtemsinit.c, tools/schedsim/shell/shared/main_semcreate.c, tools/schedsim/shell/shared/main_semdelete.c, tools/schedsim/shell/shared/main_semflush.c, tools/schedsim/shell/shared/main_semobtain.c, tools/schedsim/shell/shared/main_semrelease.c, tools/schedsim/shell/shared/main_taskcreate.c, tools/schedsim/shell/shared/main_taskdelete.c, tools/schedsim/shell/shared/main_taskmode.c, tools/schedsim/shell/shared/main_taskpriority.c, tools/schedsim/shell/shared/main_taskresume.c, tools/schedsim/shell/shared/main_tasksuspend.c, tools/schedsim/shell/shared/main_taskwakeafter.c, tools/schedsim/shell/shared/schedsim_shell.h, tools/schedsim/shell/shared/shell_cmdset.c, tools/schedsim/shell/shared/shell_makeargs.c, tools/schedsim/shell/shared/include/shell.h, tools/schedsim/shell/shared/include/newlib/_ansi.h, tools/schedsim/shell/shared/include/newlib/getopt.h: Removed. * configure.ac: RTEMS Scheduler Simulator is now in its own CVS module named rtems-schedsim.
Diffstat (limited to 'tools/cpu/nios2/README')
-rw-r--r--tools/cpu/nios2/README148
1 files changed, 0 insertions, 148 deletions
diff --git a/tools/cpu/nios2/README b/tools/cpu/nios2/README
deleted file mode 100644
index f961dff6b1..0000000000
--- a/tools/cpu/nios2/README
+++ /dev/null
@@ -1,148 +0,0 @@
-$Id$
-
-nios2gen:
- Tool to generate BSP data for boards utilizing NIOS2 soft core processor.
-
-=================================
-What it does
-
-It creates a sopc.h and linkcmds file for RTEMS nios2 BSPs from one or more inputs:
-
-1. SOPC System Description PTF
-
-As an output from SOPC Builder you get a file with extension ".ptf" that fully
-describes the SOPC, including all CPUs, memory and integrated peripherals.
-(PTF simply means "plain-text file").
-
-2. BSP Configuration PTF
-
-This file, using the same format as the SOPC System Description PTF, describes
-which components of the SOPC shall be used by the BSP. For example, there may
-be several timers, but a BSP wants at least one named "CLOCK" and optionally
-another named "TIMER". This mapping can be specified in the BSP.
-
-=================================
-Contents of the configuration PTF
-
-There can be definitions of ...
-
-HEADER: This is written to sopc.h before anything else. Example:
-
- HEADER = "
- #ifndef __SOPC_H
- #define __SOPC_H 1
- ";
-
-EPILOG: This is written to sopc.h after anything else. Example:
-
- EPILOG = "
- #endif
- ";
-
-CLOCKS section: Used to specify names for clocks to be used in definitions in
-the sopc.h. The default name (if none is specified here) is the uppercased name
-as in the system description PTF. Specify the name you want on the left, the
-name in the sopc PTF on the right! Example:
-
- CLOCKS
- {
- GLOBAL_CLOCK = "sys_clk";
- }
-
-MODULES section: Same as clocks but for modules / peripherals. As a special definition,
-if the PTF contains more than one nios2 CPU, it /must/ define a CPU to use. Example to
-select cpu_0 and rename timer_0 to CLOCK and timer_1 to TIMER:
-
- MODULES
- {
- CPU = "cpu_0";
- CLOCK = "timer_0";
- TIMER = "timer_1";
- }
-
-CLASS xyz sections: These specify what you want in the sopc.h, and how the definitions
-shall be named. Actually, the CLASS xyz should look exactly like the corresponding MODULE
-specification in the system description PTF of modules belonging to that class; e.g. a
-a JTAG UART is originally described like this:
-
- MODULE jtag_uart_0
- {
- class = "altera_avalon_jtag_uart";
- class_version = "1.0";
- iss_model_name = "altera_avalon_jtag_uart";
- SLAVE avalon_jtag_slave
- {
- SYSTEM_BUILDER_INFO
- {
- Bus_Type = "avalon";
- Is_Printable_Device = "1";
- Address_Alignment = "native";
- Address_Width = "1";
- Data_Width = "32";
- Has_IRQ = "1";
- Read_Wait_States = "peripheral_controlled";
- Write_Wait_States = "peripheral_controlled";
- JTAG_Hub_Base_Id = "0x04006E";
- JTAG_Hub_Instance_Id = "0";
- MASTERED_BY cpu_0/data_master
- {
- priority = "1";
- }
- IRQ_MASTER cpu_0/data_master
- {
- IRQ_Number = "2";
- }
- Base_Address = "0x08000000";
- }
- }
- ...
- }
-
-If you want to have definitions about its base address and irq number in your sopc.h,
-define a CLASS for altera_avalon_jtag_uart that matches the MODULE description above,
-but instead of values for the items you specify names to be used in your sopc.h (You
-can omit items from the MODULE as you like, but the section nesting must match; and
-section names (such as avalon_jtag_slave for the SLAVE section) also have to match)
-
- CLASS altera_avalon_jtag_uart
- {
- SLAVE avalon_jtag_slave
- {
- SYSTEM_BUILDER_INFO
- {
- Base_Address = "BASE_ADDR";
- IRQ_MASTER { IRQ_Number = "IRQ"; }
- }
- }
- }
-
-The output for jtag_uart_0 will be:
-
- #define JTAG_UART_BASE_ADDR 0x021208D0
- #define JTAG_UART_IRQ 1
-
-There are some values with special meaning to nios2gen,
-
-N2G_CLOCKREF_CLOCK: This should be used whereever the value in the SOPC PTF
-specifies the name of a clock. nios2gen will use whatever you configured for
-the selected clock in your CLOCKS section.
-
-N2G_CLOCKREF_DEVICE: This should be used whereever the value in the SOPC PTF
-specifies the name of a module. nios2gen will use whatever you configured for
-the selected module in your MODULES section.
-
-Additionally, you can specify items in your CLASSes so that nios2gen will include
-constant definitions in the sopc.h whenever such CLASS is present. The format is
-
- N2G_DEFINE_xyz = "123"
-
-and will result in
-
-#define MODULENAME_xyz 123
-
-
-
-
-
-
-