Mercurial > flash_v2
changeset 632:b928cfca72fc
* cdl/redboot.cdl: Put virtually all options inside
CYGBLD_BUILD_REDBOOT. And indent accordingly.
| author | jlarmour |
|---|---|
| date | Fri, 14 Feb 2003 02:49:06 +0000 |
| parents | 06b38a628db3 |
| children | 62d320796ef8 |
| files | packages/redboot/current/ChangeLog packages/redboot/current/cdl/redboot.cdl packages/redboot/current/doc/redboot_installing.sgml |
| diffstat | 3 files changed, 788 insertions(+), 619 deletions(-) [+] |
line wrap: on
line diff
--- a/packages/redboot/current/ChangeLog +++ b/packages/redboot/current/ChangeLog @@ -1,3 +1,8 @@ +2003-02-14 Jonathan Larmour <jifl@eCosCentric.com> + + * cdl/redboot.cdl: Put virtually all options inside + CYGBLD_BUILD_REDBOOT. And indent accordingly. + 2003-02-04 Mark Salter <msalter@redhat.com> 2003-02-04 Brian Murphy <brian@murphy.dk>
--- a/packages/redboot/current/cdl/redboot.cdl +++ b/packages/redboot/current/cdl/redboot.cdl @@ -196,76 +196,41 @@ cdl_package CYGPKG_REDBOOT { $(CC) -c $(INCLUDE_PATH) $(CFLAGS) -o $(PREFIX)/lib/version.o $(REPOSITORY)/$(PACKAGE)/src/version.c $(CC) $(LDFLAGS) -L$(PREFIX)/lib -Ttarget.ld -o $@ $(PREFIX)/lib/version.o } - } - cdl_component CYGPKG_REDBOOT_NETWORKING { - display "Redboot Networking" - flavor bool - active_if CYGPKG_IO_ETH_DRIVERS - default_value 1 - implements CYGINT_REDBOOT_LOAD_METHOD - compile net/bootp.c net/udp.c net/ip.c net/pktbuf.c net/cksum.c - compile net/enet.c net/icmp.c net/tcp.c net/timers.c net/arp.c - compile net/net_io.c net/inet_addr.c - compile -library=libextras.a net/ping.c net/tftp_client.c - description "This option includes networking support in RedBoot." - define_proc { - puts $::cdl_system_header "#define CYGNUM_HAL_VIRTUAL_VECTOR_AUX_CHANNELS 1" - } - - cdl_option CYGDBG_REDBOOT_NET_DEBUG { - display "Print net debug information" - flavor bool - default_value 0 - description " - This option is overriden by the configuration stored in flash." - } - - cdl_option CYGSEM_REDBOOT_NET_HTTP_DOWNLOAD { - display "Support HTTP for download" - flavor bool - default_value 1 - compile -library=libextras.a net/http_client.c - description " - This option enables the use of the HTTP protocol for download" - } - - cdl_component CYGDAT_REDBOOT_DEFAULT_IP_ADDR { - display "Default IP address" - flavor booldata - default_value CYGSEM_REDBOOT_FLASH_CONFIG ? 0 : \ - { "0, 0, 0, 0" } - description " - This IP address is the default used by RedBoot if a BOOTP/DHCP - server does not respond. The numbers should be separated by - *commas*, and not dots. If an IP address is configured into - the Flash configuration, that will be used in preference." - - cdl_option CYGSEM_REDBOOT_DEFAULT_NO_BOOTP { - display "Do not try to use BOOTP" - flavor bool - default_value 0 - description " - By default Redboot tries to use BOOTP to get an IP - address. If there's no BOOTP server on your network - use this option to avoid to wait until the - timeout. This option is overriden by the - configuration stored in flash." + cdl_component CYGPKG_REDBOOT_NETWORKING { + display "Redboot Networking" + flavor bool + active_if CYGPKG_IO_ETH_DRIVERS + default_value 1 + implements CYGINT_REDBOOT_LOAD_METHOD + compile net/bootp.c net/udp.c net/ip.c net/pktbuf.c net/cksum.c + compile net/enet.c net/icmp.c net/tcp.c net/timers.c net/arp.c + compile net/net_io.c net/inet_addr.c + compile -library=libextras.a net/ping.c net/tftp_client.c + description "This option includes networking support in RedBoot." + define_proc { + puts $::cdl_system_header "#define CYGNUM_HAL_VIRTUAL_VECTOR_AUX_CHANNELS 1" } - } - - cdl_component CYGSEM_REDBOOT_NETWORKING_USE_GATEWAY { - display "Use a gateway for non-local IP traffic" - flavor bool - default_value 1 - description " - Enabling this option will allow the RedBoot networking - stack to use a \[single\] gateway to reach a non-local - IP address. If disabled, RedBoot will only be able to - reach nodes on the same subnet." - - cdl_component CYGDAT_REDBOOT_DEFAULT_GATEWAY_IP_ADDR { - display "Default gateway IP address" + + cdl_option CYGDBG_REDBOOT_NET_DEBUG { + display "Print net debug information" + flavor bool + default_value 0 + description " + This option is overriden by the configuration stored in flash." + } + + cdl_option CYGSEM_REDBOOT_NET_HTTP_DOWNLOAD { + display "Support HTTP for download" + flavor bool + default_value 1 + compile -library=libextras.a net/http_client.c + description " + This option enables the use of the HTTP protocol for download" + } + + cdl_component CYGDAT_REDBOOT_DEFAULT_IP_ADDR { + display "Default IP address" flavor booldata default_value CYGSEM_REDBOOT_FLASH_CONFIG ? 0 : \ { "0, 0, 0, 0" } @@ -274,586 +239,621 @@ cdl_package CYGPKG_REDBOOT { server does not respond. The numbers should be separated by *commas*, and not dots. If an IP address is configured into the Flash configuration, that will be used in preference." + + cdl_option CYGSEM_REDBOOT_DEFAULT_NO_BOOTP { + display "Do not try to use BOOTP" + flavor bool + default_value 0 + description " + By default Redboot tries to use BOOTP to get an IP + address. If there's no BOOTP server on your network + use this option to avoid to wait until the + timeout. This option is overriden by the + configuration stored in flash." + } } - - cdl_component CYGDAT_REDBOOT_DEFAULT_IP_ADDR_MASK { - display "Default IP address mask" - flavor booldata - default_value CYGSEM_REDBOOT_FLASH_CONFIG ? 0 : \ - { "255, 255, 255, 0" } + + cdl_component CYGSEM_REDBOOT_NETWORKING_USE_GATEWAY { + display "Use a gateway for non-local IP traffic" + flavor bool + default_value 1 + description " + Enabling this option will allow the RedBoot networking + stack to use a \[single\] gateway to reach a non-local + IP address. If disabled, RedBoot will only be able to + reach nodes on the same subnet." + + cdl_component CYGDAT_REDBOOT_DEFAULT_GATEWAY_IP_ADDR { + display "Default gateway IP address" + flavor booldata + default_value CYGSEM_REDBOOT_FLASH_CONFIG ? 0 : \ + { "0, 0, 0, 0" } + description " + This IP address is the default used by RedBoot if a BOOTP/DHCP + server does not respond. The numbers should be separated by + *commas*, and not dots. If an IP address is configured into + the Flash configuration, that will be used in preference." + } + + cdl_component CYGDAT_REDBOOT_DEFAULT_IP_ADDR_MASK { + display "Default IP address mask" + flavor booldata + default_value CYGSEM_REDBOOT_FLASH_CONFIG ? 0 : \ + { "255, 255, 255, 0" } + description " + This IP address mask is the default used by RedBoot if a BOOTP/DHCP + server does not respond. The numbers should be separated by + *commas*, and not dots. If an IP address is configured into + the Flash configuration, that will be used in preference." + } + } + + cdl_option CYGNUM_REDBOOT_NETWORKING_TCP_PORT { + display "TCP port to listen for incoming connections" + flavor data + default_value 9000 description " - This IP address mask is the default used by RedBoot if a BOOTP/DHCP - server does not respond. The numbers should be separated by - *commas*, and not dots. If an IP address is configured into - the Flash configuration, that will be used in preference." + RedBoot will 'listen' on this port for incoming TCP connections. + This allows outside connections to be made to the platform, either + for GDB or RedBoot commands." + } + + cdl_option CYGNUM_REDBOOT_NETWORKING_MAX_PKTBUF { + display "Number of \[network\] packet buffers" + flavor data + default_value 4 + legal_values 3 to 8 + description " + RedBoot may need to buffer network data to support various connections. + This option allows control over the number of such buffered packets, + and in turn, controls the amount of memory used by RedBoot (which + is not available to user applications). Each packet buffer takes up + about 1514 bytes. Note: there is little need to make this larger + than the default." + } + + cdl_component CYGPKG_REDBOOT_NETWORKING_DNS { + display "DNS support" + default_value 1 + requires CYGPKG_NS_DNS + requires !CYGPKG_NS_DNS_BUILD + compile net/dns.c + description " + When this option is enabled, RedBoot will be built with + support for DNS, allowing use of hostnames on the command + line." + + cdl_option CYGPKG_REDBOOT_NETWORKING_DNS_IP { + display "Default DNS IP" + flavor data + active_if !CYGSEM_REDBOOT_FLASH_CONFIG + default_value { "0.0.0.0" } + description " + This option sets the IP of the default DNS. The IP can be + changed at runtime as well." + } + + cdl_option CYGNUM_REDBOOT_NETWORKING_DNS_TIMEOUT { + display "Timeout in DNS lookup" + flavor data + default_value 10 + description " + This option sets the timeout used when looking up an + address via the DNS. Default is 10 seconds." + } + } } - - cdl_option CYGNUM_REDBOOT_NETWORKING_TCP_PORT { - display "TCP port to listen for incoming connections" - flavor data - default_value 9000 - description " - RedBoot will 'listen' on this port for incoming TCP connections. - This allows outside connections to be made to the platform, either - for GDB or RedBoot commands." + + cdl_option CYGPKG_REDBOOT_ANY_CONSOLE { + display "Allow RedBoot to use any I/O channel for its console." + flavor bool + default_value 1 + description " + If this option is enabled then RedBoot will attempt to use all + defined serial I/O channels for its console device. Once input + arrives at one of these channels then the console will use only + that port." } - - cdl_option CYGNUM_REDBOOT_NETWORKING_MAX_PKTBUF { - display "Number of \[network\] packet buffers" - flavor data - default_value 4 - legal_values 3 to 8 - description " - RedBoot may need to buffer network data to support various connections. - This option allows control over the number of such buffered packets, - and in turn, controls the amount of memory used by RedBoot (which - is not available to user applications). Each packet buffer takes up - about 1514 bytes. Note: there is little need to make this larger - than the default." + + cdl_option CYGSEM_REDBOOT_VARIABLE_BAUD_RATE { + display "Allow RedBoot to adjust the baud rate on the serial console." + flavor bool + default_value 1 + active_if CYGINT_HAL_VIRTUAL_VECTOR_COMM_BAUD_SUPPORT + description " + If this option is enabled then RedBoot will support commands to set + and query the baud rate on the selected console." } - - cdl_component CYGPKG_REDBOOT_NETWORKING_DNS { - display "DNS support" - default_value 1 - requires CYGPKG_NS_DNS - requires !CYGPKG_NS_DNS_BUILD - compile net/dns.c - description " - When this option is enabled, RedBoot will be built with - support for DNS, allowing use of hostnames on the command - line." - - cdl_option CYGPKG_REDBOOT_NETWORKING_DNS_IP { - display "Default DNS IP" - flavor data - active_if !CYGSEM_REDBOOT_FLASH_CONFIG - default_value { "0.0.0.0" } - description " - This option sets the IP of the default DNS. The IP can be - changed at runtime as well." - } - - cdl_option CYGNUM_REDBOOT_NETWORKING_DNS_TIMEOUT { - display "Timeout in DNS lookup" - flavor data - default_value 10 - description " - This option sets the timeout used when looking up an - address via the DNS. Default is 10 seconds." - } - + + cdl_option CYGPKG_REDBOOT_MAX_CMD_LINE { + display "Maximum command line length" + flavor data + default_value 256 + description " + This option allows control over how long the CLI command line + should be. This space will be allocated statically + rather than from RedBoot's stack." + } + + cdl_option CYGNUM_REDBOOT_CLI_IDLE_TIMEOUT { + display "Command processing idle timeout (ms)" + flavor data + default_value 10 + description " + This option controls the timeout period before the + command processing is considered 'idle'. Making this + number smaller will cause idle processing to take place + more often, etc. The default value of 10ms is a reasonable + tradeoff between responsiveness and overhead." + } + + cdl_option CYGNUM_REDBOOT_LOAD_ZLIB_BUFFER { + display "Size of zlib decompression buffer" + active_if CYGPKG_COMPRESS_ZLIB + flavor data + default_value 64 + legal_values 5 to 256 + description " + This is the size of the buffer filled with incoming data + during load before calls are made to the decompressor + function. For ethernet downloads this can be made bigger + (at the cost of memory), but for serial downloads on slow + processors it may be necessary to reduce the size to + avoid serial overruns. zlib appears to bail out if less than + five bytes are available initially so this is the minimum." } - } - - cdl_option CYGPKG_REDBOOT_ANY_CONSOLE { - display "Allow RedBoot to use any I/O channel for its console." - flavor bool - default_value 1 - description " - If this option is enabled then RedBoot will attempt to use all - defined serial I/O channels for its console device. Once input - arrives at one of these channels then the console will use only - that port." - } - - cdl_option CYGSEM_REDBOOT_VARIABLE_BAUD_RATE { - display "Allow RedBoot to adjust the baud rate on the serial console." - flavor bool - default_value 1 - active_if CYGINT_HAL_VIRTUAL_VECTOR_COMM_BAUD_SUPPORT - description " - If this option is enabled then RedBoot will support commands to set - and query the baud rate on the selected console." - } - - cdl_option CYGPKG_REDBOOT_MAX_CMD_LINE { - display "Maximum command line length" - flavor data - default_value 256 - description " - This option allows control over how long the CLI command line - should be. This space will be allocated statically - rather than from RedBoot's stack." - } - - cdl_option CYGNUM_REDBOOT_CLI_IDLE_TIMEOUT { - display "Command processing idle timeout (ms)" - flavor data - default_value 10 - description " - This option controls the timeout period before the - command processing is considered 'idle'. Making this - number smaller will cause idle processing to take place - more often, etc. The default value of 10ms is a reasonable - tradeoff between responsiveness and overhead." - } - - cdl_option CYGNUM_REDBOOT_LOAD_ZLIB_BUFFER { - display "Size of zlib decompression buffer" - active_if CYGPKG_COMPRESS_ZLIB - flavor data - default_value 64 - legal_values 5 to 256 - description " - This is the size of the buffer filled with incoming data - during load before calls are made to the decompressor - function. For ethernet downloads this can be made bigger - (at the cost of memory), but for serial downloads on slow - processors it may be necessary to reduce the size to - avoid serial overruns. zlib appears to bail out if less than - five bytes are available initially so this is the minimum." - } - - cdl_option CYGSEM_REDBOOT_VALIDATE_USER_RAM_LOADS { - display "Validate RAM addresses during load" - flavor bool - default_value 1 - description " - This option controls whether or not RedBoot will make sure that - memory being used by the \"load\" command is in fact in user RAM. - Leaving the option enabled makes for a safer environment, but this - check may not be valid on all platforms, thus the ability to - disable it. ** Disable this only with great care **" - } - - cdl_component CYGPKG_REDBOOT_FLASH { - display "Allow RedBoot to support FLASH programming" - flavor bool - default_value 1 - active_if CYGHWR_IO_FLASH_DEVICE - description " - If this option is enabled then RedBoot will provide commands - to manage images in FLASH memory. These images can be loaded - into memory for execution or executed in place." - compile -library=libextras.a flash.c - - cdl_option CYGBLD_REDBOOT_MIN_IMAGE_SIZE { - display "Minimum image size" - flavor data - default_value 0x20000 - description " - This option controls the minimum length of images kept by - the FIS. In particular, it should be large enough to hold - the RedBoot primary image itself, as well as be a natural - multiple of the FLASH erase block size." + + cdl_option CYGSEM_REDBOOT_VALIDATE_USER_RAM_LOADS { + display "Validate RAM addresses during load" + flavor bool + default_value 1 + description " + This option controls whether or not RedBoot will make sure that + memory being used by the \"load\" command is in fact in user RAM. + Leaving the option enabled makes for a safer environment, but this + check may not be valid on all platforms, thus the ability to + disable it. ** Disable this only with great care **" } - - cdl_option CYGBLD_REDBOOT_FLASH_BOOT_OFFSET { - display "Offset from start of FLASH to RedBoot boot image" - flavor data - default_value CYGNUM_REDBOOT_FLASH_RESERVED_BASE - requires { CYGNUM_REDBOOT_FLASH_RESERVED_BASE <= \ - CYGBLD_REDBOOT_FLASH_BOOT_OFFSET } - description " - This option controls where the RedBoot boot image is located - relative to the start of FLASH." - } - - cdl_option CYGNUM_REDBOOT_FLASH_RESERVED_BASE { - display "Size of reserved area at start of FLASH" - flavor data - default_value 0 - description " - This option reserves an area at the start of FLASH where RedBoot - will never interfere; it is expected that this area contains - (non-RedBoot-based) POST code or some other boot monitor that - executes before RedBoot." - } - - cdl_option CYGOPT_REDBOOT_FIS { - display "RedBoot Flash Image System support" - default_value 1 - description " - This option enables the Flash Image System commands - and support within RedBoot. If disabled, simple Flash - access commands such as \"fis write\" will still exist. - This option would be disabled for targets that need simple - FLASH manipulation, but do not have the need or space for - complete image management." - } - - cdl_component CYGPKG_REDBOOT_FIS_CONTENTS { - display "Flash Image System default directory contents" - active_if CYGOPT_REDBOOT_FIS - calculated 1 - - cdl_option CYGNUM_REDBOOT_FIS_DIRECTORY_BLOCK { - display "Flash block containing the Directory" - flavor data - default_value (-1) + + cdl_component CYGPKG_REDBOOT_FLASH { + display "Allow RedBoot to support FLASH programming" + flavor bool + default_value 1 + active_if CYGHWR_IO_FLASH_DEVICE + description " + If this option is enabled then RedBoot will provide commands + to manage images in FLASH memory. These images can be loaded + into memory for execution or executed in place." + compile -library=libextras.a flash.c + + cdl_option CYGBLD_REDBOOT_MIN_IMAGE_SIZE { + display "Minimum image size" + flavor data + default_value 0x20000 description " - Which block of flash should hold the directory - information. Positive numbers are absolute block numbers. - Negative block numbers count backwards from the last block. - eg 2 means block 2, -2 means the last but one block." + This option controls the minimum length of images kept by + the FIS. In particular, it should be large enough to hold + the RedBoot primary image itself, as well as be a natural + multiple of the FLASH erase block size." } - - cdl_option CYGOPT_REDBOOT_FIS_RESERVED_BASE { - display "Pseudo-file to describe reserved area" - active_if { 0 != CYGNUM_REDBOOT_FLASH_RESERVED_BASE } + + cdl_option CYGBLD_REDBOOT_FLASH_BOOT_OFFSET { + display "Offset from start of FLASH to RedBoot boot image" + flavor data + default_value CYGNUM_REDBOOT_FLASH_RESERVED_BASE + requires { CYGNUM_REDBOOT_FLASH_RESERVED_BASE <= \ + CYGBLD_REDBOOT_FLASH_BOOT_OFFSET } + description " + This option controls where the RedBoot boot image is located + relative to the start of FLASH." + } + + cdl_option CYGNUM_REDBOOT_FLASH_RESERVED_BASE { + display "Size of reserved area at start of FLASH" + flavor data + default_value 0 + description " + This option reserves an area at the start of FLASH where RedBoot + will never interfere; it is expected that this area contains + (non-RedBoot-based) POST code or some other boot monitor that + executes before RedBoot." + } + + cdl_option CYGOPT_REDBOOT_FIS { + display "RedBoot Flash Image System support" default_value 1 description " - If an area of FLASH is reserved, it is informative to - have a fis entry describing it. This option controls - creation of such an entry by default in the fis init - command." - } - - cdl_option CYGOPT_REDBOOT_FIS_REDBOOT { - display "File to describe RedBoot boot image" - default_value 1 - description " - Normally a ROM-startup RedBoot image is first in the - FLASH, and the system boots using that image. This - option controls creation of an entry describing it in - the fis init command. It might be disabled if a - platform has an immutable boot image of its own, where - we use a POST-startup RedBoot instead, which performs - less board initialization." - } - - cdl_component CYGOPT_REDBOOT_FIS_REDBOOT_POST { - display "File to describe RedBoot POST-compatible image" - default_value !CYGOPT_REDBOOT_FIS_REDBOOT - description " - This option controls creation of an entry describing a - POST-startup RedBoot image in the fis init command. - Not all platforms support POST-startup. A platform - might have both for testing purposes, where the - eventual user would substitute their own POST code for - the initial ROM-startup RedBoot, and then jump to the - POST-compatible RedBoot immediately following." - cdl_option CYGNUM_REDBOOT_FIS_REDBOOT_POST_OFFSET { - display "Offset of POST image from FLASH start" - flavor booldata - default_value 0 - requires { CYGNUM_REDBOOT_FIS_REDBOOT_POST_OFFSET >= \ - CYGBLD_REDBOOT_FLASH_BOOT_OFFSET } - description " - This option specifies the offset for a POST image from - the start of FLASH. If unset, then the fis entry - describing the POST image will be placed where - convenient." - } - } - - cdl_option CYGOPT_REDBOOT_FIS_REDBOOT_BACKUP { - display "File to describe RedBoot backup image" - default_value 0 - description " - This option controls creation of an entry describing a - backup RedBoot image in the fis init command. - Conventionally a RAM-startup RedBoot image is kept - under this name for use in updating the ROM-based - RedBoot that boots the board." + This option enables the Flash Image System commands + and support within RedBoot. If disabled, simple Flash + access commands such as \"fis write\" will still exist. + This option would be disabled for targets that need simple + FLASH manipulation, but do not have the need or space for + complete image management." } - - cdl_option CYGOPT_REDBOOT_FIS_DIRECTORY_ARM_SIB_ID { - display "Include ARM SIB ID in FIS" - default_value 0 - description " - If set, this option will cause the last 5 words of - the FIS to include the special ID needed for the - flash to be recognized as a reserved area for RedBoot - by an ARM BootRom monitor." + + cdl_component CYGPKG_REDBOOT_FIS_CONTENTS { + display "Flash Image System default directory contents" + active_if CYGOPT_REDBOOT_FIS + calculated 1 + + cdl_option CYGNUM_REDBOOT_FIS_DIRECTORY_BLOCK { + display "Flash block containing the Directory" + flavor data + default_value (-1) + description " + Which block of flash should hold the directory + information. Positive numbers are absolute block numbers. + Negative block numbers count backwards from the last block. + eg 2 means block 2, -2 means the last but one block." + } + + cdl_option CYGOPT_REDBOOT_FIS_RESERVED_BASE { + display "Pseudo-file to describe reserved area" + active_if { 0 != CYGNUM_REDBOOT_FLASH_RESERVED_BASE } + default_value 1 + description " + If an area of FLASH is reserved, it is informative to + have a fis entry describing it. This option controls + creation of such an entry by default in the fis init + command." + } + + cdl_option CYGOPT_REDBOOT_FIS_REDBOOT { + display "File to describe RedBoot boot image" + default_value 1 + description " + Normally a ROM-startup RedBoot image is first in the + FLASH, and the system boots using that image. This + option controls creation of an entry describing it in + the fis init command. It might be disabled if a + platform has an immutable boot image of its own, where + we use a POST-startup RedBoot instead, which performs + less board initialization." + } + + cdl_component CYGOPT_REDBOOT_FIS_REDBOOT_POST { + display "File to describe RedBoot POST-compatible image" + default_value !CYGOPT_REDBOOT_FIS_REDBOOT + description " + This option controls creation of an entry describing a + POST-startup RedBoot image in the fis init command. + Not all platforms support POST-startup. A platform + might have both for testing purposes, where the + eventual user would substitute their own POST code for + the initial ROM-startup RedBoot, and then jump to the + POST-compatible RedBoot immediately following." + cdl_option CYGNUM_REDBOOT_FIS_REDBOOT_POST_OFFSET { + display "Offset of POST image from FLASH start" + flavor booldata + default_value 0 + requires { CYGNUM_REDBOOT_FIS_REDBOOT_POST_OFFSET >= \ + CYGBLD_REDBOOT_FLASH_BOOT_OFFSET } + description " + This option specifies the offset for a POST image from + the start of FLASH. If unset, then the fis entry + describing the POST image will be placed where + convenient." + } + } + + cdl_option CYGOPT_REDBOOT_FIS_REDBOOT_BACKUP { + display "File to describe RedBoot backup image" + default_value 0 + description " + This option controls creation of an entry describing a + backup RedBoot image in the fis init command. + Conventionally a RAM-startup RedBoot image is kept + under this name for use in updating the ROM-based + RedBoot that boots the board." + } + + cdl_option CYGOPT_REDBOOT_FIS_DIRECTORY_ARM_SIB_ID { + display "Include ARM SIB ID in FIS" + default_value 0 + description " + If set, this option will cause the last 5 words of + the FIS to include the special ID needed for the + flash to be recognized as a reserved area for RedBoot + by an ARM BootRom monitor." + } + + cdl_option CYGNUM_REDBOOT_FIS_DIRECTORY_ENTRY_SIZE { + display "Size of FIS directory entry" + flavor data + default_value 256 + description " + The FIS directory is limited to one single flash + sector. If your flash has tiny sectors, you may wish + to reduce this value in order to get more slots in + the FIS directory." + } } - - cdl_option CYGNUM_REDBOOT_FIS_DIRECTORY_ENTRY_SIZE { - display "Size of FIS directory entry" - flavor data - default_value 256 - description " - The FIS directory is limited to one single flash - sector. If your flash has tiny sectors, you may wish - to reduce this value in order to get more slots in - the FIS directory." - } - } - - cdl_component CYGSEM_REDBOOT_FLASH_CONFIG { - display "Keep RedBoot configuration data in FLASH" - flavor bool - default_value 1 - description " - When this option is enabled, RedBoot will keep configuration - data in a separate block of FLASH memory. This data will - include such items as the node IP address or startup scripts." - - cdl_option CYGNUM_REDBOOT_FLASH_CONFIG_SIZE { - display "Length of configuration data in FLASH" - flavor data - default_value 4096 - description " - This option is used to control the amount of memory and FLASH - to be used for configuration options (persistent storage)." - } - - cdl_option CYGSEM_REDBOOT_FLASH_COMBINED_FIS_AND_CONFIG { - display "Merged config data and FIS directory" - flavor bool - active_if CYGOPT_REDBOOT_FIS - default_value 0 - description " - If this option is set, then the FIS directory and FLASH - configuration database will be stored in the same physical - FLASH block." - } - - cdl_option CYGNUM_REDBOOT_FLASH_CONFIG_BLOCK { - display "Which block of flash to use" - flavor data - default_value (-2) - description " - Which block of flash should hold the configuration - information. Positive numbers are absolute block numbers. - Negative block numbers count backwards from the last block. - eg 2 means block 2, -2 means the last but one block." - } - - cdl_option CYGSEM_REDBOOT_FLASH_ALIASES { - display "Support simple macros/aliases in FLASH" + + cdl_component CYGSEM_REDBOOT_FLASH_CONFIG { + display "Keep RedBoot configuration data in FLASH" flavor bool default_value 1 description " - This option is used to allow support for simple text-based - macros (aliases). These aliases are kept in the FLASH - configuration data (persistent storage)." - } - - cdl_option CYGNUM_REDBOOT_FLASH_STRING_SIZE { - display "Length of strings in FLASH configuration data" - flavor data - default_value 128 - description " - This option is used to control the amount of memory and FLASH - to be used for string configuration options (persistent storage)." + When this option is enabled, RedBoot will keep configuration + data in a separate block of FLASH memory. This data will + include such items as the node IP address or startup scripts." + + cdl_option CYGNUM_REDBOOT_FLASH_CONFIG_SIZE { + display "Length of configuration data in FLASH" + flavor data + default_value 4096 + description " + This option is used to control the amount of memory and FLASH + to be used for configuration options (persistent storage)." + } + + cdl_option CYGSEM_REDBOOT_FLASH_COMBINED_FIS_AND_CONFIG { + display "Merged config data and FIS directory" + flavor bool + active_if CYGOPT_REDBOOT_FIS + default_value 0 + description " + If this option is set, then the FIS directory and FLASH + configuration database will be stored in the same physical + FLASH block." + } + + cdl_option CYGNUM_REDBOOT_FLASH_CONFIG_BLOCK { + display "Which block of flash to use" + flavor data + default_value (-2) + description " + Which block of flash should hold the configuration + information. Positive numbers are absolute block numbers. + Negative block numbers count backwards from the last block. + eg 2 means block 2, -2 means the last but one block." + } + + cdl_option CYGSEM_REDBOOT_FLASH_ALIASES { + display "Support simple macros/aliases in FLASH" + flavor bool + default_value 1 + description " + This option is used to allow support for simple text-based + macros (aliases). These aliases are kept in the FLASH + configuration data (persistent storage)." + } + + cdl_option CYGNUM_REDBOOT_FLASH_STRING_SIZE { + display "Length of strings in FLASH configuration data" + flavor data + default_value 128 + description " + This option is used to control the amount of memory and FLASH + to be used for string configuration options (persistent storage)." + } + + cdl_option CYGNUM_REDBOOT_FLASH_SCRIPT_SIZE { + display "Length of configuration script(s) in FLASH" + flavor data + default_value 512 + description " + This option is used to control the amount of memory and FLASH + to be used for configuration options (persistent storage)." + } + + cdl_option CYGSEM_REDBOOT_FLASH_CONFIG_READONLY_FALLBACK { + display "Fallback to read-only FLASH configuration" + flavor bool + default_value 1 + description " + This option will cause the configuration information to + revert to the readonly information stored in the FLASH. + The option only takes effect after + 1) the config_ok flag has been set to be true, + indicating that at one time the copy in RAM was valid; + and + 2) the information in RAM has been verified to be invalid" + + } } - - cdl_option CYGNUM_REDBOOT_FLASH_SCRIPT_SIZE { - display "Length of configuration script(s) in FLASH" - flavor data - default_value 512 + + cdl_option CYGSEM_REDBOOT_FLASH_LOCK_SPECIAL { + display "Keep all RedBoot FLASH data blocks locked." + flavor bool + default_value 1 + active_if { CYGHWR_IO_FLASH_BLOCK_LOCKING != 0 } description " - This option is used to control the amount of memory and FLASH - to be used for configuration options (persistent storage)." + When this option is enabled, RedBoot will keep configuration + data and the FIS directory blocks implicitly locked. While + this is somewhat safer, it does add overhead during updates." } - - cdl_option CYGSEM_REDBOOT_FLASH_CONFIG_READONLY_FALLBACK { - display "Fallback to read-only FLASH configuration" + + cdl_option CYGSEM_REDBOOT_FIS_CRC_CHECK { + display "Use CRC checksums on FIS images." flavor bool default_value 1 description " - This option will cause the configuration information to - revert to the readonly information stored in the FLASH. - The option only takes effect after - 1) the config_ok flag has been set to be true, - indicating that at one time the copy in RAM was valid; - and - 2) the information in RAM has been verified to be invalid" - + When this option is enabled, RedBoot will use CRC checksums + when reading and writing flash images." + } + + cdl_interface CYGINT_REDBOOT_ARM_FLASH_SIB_SUPPORTED { + display "ARM FLASH drivers support SIB flash block structure" + active_if CYGPKG_HAL_ARM + description "This interface is implemented by a flash driver + to indicate that it supports the ARM SIB flash + block structure" + } + + cdl_option CYGHWR_REDBOOT_ARM_FLASH_SIB { + display "Use ARM SIB flash block structure" + flavor bool + active_if CYGINT_REDBOOT_ARM_FLASH_SIB_SUPPORTED + default_value 1 + description " + This option is used to interpret ARM Flash System information + blocks." } } - - cdl_option CYGSEM_REDBOOT_FLASH_LOCK_SPECIAL { - display "Keep all RedBoot FLASH data blocks locked." - flavor bool - default_value 1 - active_if { CYGHWR_IO_FLASH_BLOCK_LOCKING != 0 } - description " - When this option is enabled, RedBoot will keep configuration - data and the FIS directory blocks implicitly locked. While - this is somewhat safer, it does add overhead during updates." - } - - cdl_option CYGSEM_REDBOOT_FIS_CRC_CHECK { - display "Use CRC checksums on FIS images." - flavor bool - default_value 1 - description " - When this option is enabled, RedBoot will use CRC checksums - when reading and writing flash images." - } - - cdl_interface CYGINT_REDBOOT_ARM_FLASH_SIB_SUPPORTED { - display "ARM FLASH drivers support SIB flash block structure" - active_if CYGPKG_HAL_ARM - description "This interface is implemented by a flash driver - to indicate that it supports the ARM SIB flash - block structure" - } - - cdl_option CYGHWR_REDBOOT_ARM_FLASH_SIB { - display "Use ARM SIB flash block structure" - flavor bool - active_if CYGINT_REDBOOT_ARM_FLASH_SIB_SUPPORTED - default_value 1 - description " - This option is used to interpret ARM Flash System information - blocks." - } - } - - cdl_component CYGPKG_REDBOOT_DISK { - display "Allow RedBoot to support disks" - flavor bool - default_value 1 - active_if { CYGINT_HAL_PLF_IF_IDE != 0 } - description " - If this option is enabled then RedBoot will provide commands - to load disk files." - compile -library=libextras.a fs/disk.c - - cdl_option CYGNUM_REDBOOT_MAX_DISKS { - display "Maximum number of supported disks" - flavor data - default_value 4 - description " - This option controls the number of disks supported by RedBoot." - } - - cdl_option CYGNUM_REDBOOT_MAX_PARTITIONS { - display "Maximum number of partitions per disk" - flavor data - default_value 8 - description " - This option controls the maximum number of supported partitions per disk." - } - - cdl_component CYGSEM_REDBOOT_DISK_IDE { - display "Support IDE disks." - flavor bool - default_value 1 - description " - When this option is enabled, RedBoot will support IDE disks." - compile -library=libextras.a fs/ide.c - } - - cdl_component CYGSEM_REDBOOT_DISK_EXT2FS { - display "Support Linux second extended filesystems." + + cdl_component CYGPKG_REDBOOT_DISK { + display "Allow RedBoot to support disks" flavor bool default_value 1 - description " - When this option is enabled, RedBoot will support IDE disks." - compile -library=libextras.a fs/e2fs.c - } - - cdl_component CYGSEM_REDBOOT_DISK_ISO9660 { - display "Support ISO9660 filesystems." - flavor bool - calculated 0 - description " - When this option is enabled, RedBoot will support ISO9660 filesystems." - compile -library=libextras.a fs/iso9660fs.c - } - } - - cdl_component CYGPKG_REDBOOT_BOOT_SCRIPT { - display "Boot scripting" - flavor none - no_define - description " - This contains options related to RedBoot's boot script - functionality." - - cdl_option CYGFUN_REDBOOT_BOOT_SCRIPT { - display "Boot scripting enabled" - flavor bool - active_if { CYGDAT_REDBOOT_DEFAULT_BOOT_SCRIPT || \ - CYGSEM_REDBOOT_FLASH_CONFIG } - calculated 1 + active_if { CYGINT_HAL_PLF_IF_IDE != 0 } + description " + If this option is enabled then RedBoot will provide commands + to load disk files." + compile -library=libextras.a fs/disk.c + + cdl_option CYGNUM_REDBOOT_MAX_DISKS { + display "Maximum number of supported disks" + flavor data + default_value 4 + description " + This option controls the number of disks supported by RedBoot." + } + + cdl_option CYGNUM_REDBOOT_MAX_PARTITIONS { + display "Maximum number of partitions per disk" + flavor data + default_value 8 description " - This option controls whether RedBoot boot script - functionality is enabled." - } - - cdl_option CYGDAT_REDBOOT_DEFAULT_BOOT_SCRIPT { - display "Use default RedBoot boot script" - flavor booldata - default_value 0 + This option controls the maximum number of supported partitions per disk." + } + + cdl_component CYGSEM_REDBOOT_DISK_IDE { + display "Support IDE disks." + flavor bool + default_value 1 description " - If enabled, this option will tell RedBoot to use the value of - this option as a default boot script." - } - - cdl_option CYGNUM_REDBOOT_BOOT_SCRIPT_TIMEOUT_RESOLUTION { - display "Resolution (in ms) for script timeout value." - flavor data - default_value 1000 - description " - This option controls the resolution of the script timeout. - The value is specified in milliseconds (ms), thus to have the - script timeout be defined in terms of tenths of seconds, use 100." - } - - cdl_option CYGNUM_REDBOOT_BOOT_SCRIPT_DEFAULT_TIMEOUT { - display "Script default timeout value" - flavor data - default_value 10 - description " - This option is used to set the default timeout for startup - scripts, when they are enabled." + When this option is enabled, RedBoot will support IDE disks." + compile -library=libextras.a fs/ide.c + } + + cdl_component CYGSEM_REDBOOT_DISK_EXT2FS { + display "Support Linux second extended filesystems." + flavor bool + default_value 1 + description " + When this option is enabled, RedBoot will support IDE disks." + compile -library=libextras.a fs/e2fs.c + } + + cdl_component CYGSEM_REDBOOT_DISK_ISO9660 { + display "Support ISO9660 filesystems." + flavor bool + calculated 0 + description " + When this option is enabled, RedBoot will support ISO9660 filesystems." + compile -library=libextras.a fs/iso9660fs.c + } } - } - - cdl_option CYGPRI_REDBOOT_ROM_MONITOR { - display "Behave like a ROM monitor" - active_if { CYG_HAL_STARTUP == "ROM" || CYG_HAL_STARTUP == "ROMRAM" } - requires CYGSEM_HAL_ROM_MONITOR - calculated 1 - no_define - description " - Enabling this option will allow RedBoot to provide ROM monitor-style - services to programs which it executes." - } - - cdl_component CYGSEM_REDBOOT_BSP_SYSCALLS { - display "Allow RedBoot to handle GNUPro application 'syscalls'." - flavor bool - default_value 0 - description " - If this option is enabled then RedBoot will install a syscall handler - to support debugging of applications based on GNUPro newlib/bsp." - - cdl_option CYGSEM_REDBOOT_BSP_SYSCALLS_GPROF { - display "Support additional syscalls for 'gprof' profiling" - flavor bool - default_value 1 - active_if { 0 < CYGINT_REDBOOT_BSP_SYSCALLS_GPROF_SUPPORT } - description " - Support additional syscalls to support a periodic callback - function for histogram-style profiling, and an enquire/set - of the tick rate. - The application must use the GNUPro newlib facilities - to set this up." - } - - cdl_interface CYGINT_REDBOOT_BSP_SYSCALLS_GPROF_SUPPORT { - display "Does the HAL support 'gprof' profiling?" - no_define - } - } - - cdl_component CYGOPT_REDBOOT_FIS_ZLIB_COMMON_BUFFER { - display "Use a common buffer for Zlib and FIS" - flavor bool - active_if { CYGBLD_BUILD_REDBOOT_WITH_ZLIB && \ - CYGOPT_REDBOOT_FIS } - default_value 0 - description " - Use a common memory buffer for both the zlib workspace - and FIS directory operations. This can save a substantial - amount of RAM, especially when flash sectors are large." - - cdl_option CYGNUM_REDBOOT_FIS_ZLIB_COMMON_BUFFER_SIZE { - display "Size of Zlib/FIS common buffer" - flavor data - default_value 0xc000 - legal_values 0x4000 to 0x80000000 - description " - Size of common buffer to allocate. Must be at least the - size of one flash sector." - } + + cdl_component CYGPKG_REDBOOT_BOOT_SCRIPT { + display "Boot scripting" + flavor none + no_define + description " + This contains options related to RedBoot's boot script + functionality." + + cdl_option CYGFUN_REDBOOT_BOOT_SCRIPT { + display "Boot scripting enabled" + flavor bool + active_if { CYGDAT_REDBOOT_DEFAULT_BOOT_SCRIPT || \ + CYGSEM_REDBOOT_FLASH_CONFIG } + calculated 1 + description " + This option controls whether RedBoot boot script + functionality is enabled." + } + + cdl_option CYGDAT_REDBOOT_DEFAULT_BOOT_SCRIPT { + display "Use default RedBoot boot script" + flavor booldata + default_value 0 + description " + If enabled, this option will tell RedBoot to use the value of + this option as a default boot script." + } + + cdl_option CYGNUM_REDBOOT_BOOT_SCRIPT_TIMEOUT_RESOLUTION { + display "Resolution (in ms) for script timeout value." + flavor data + default_value 1000 + description " + This option controls the resolution of the script timeout. + The value is specified in milliseconds (ms), thus to have the + script timeout be defined in terms of tenths of seconds, use 100." + } + + cdl_option CYGNUM_REDBOOT_BOOT_SCRIPT_DEFAULT_TIMEOUT { + display "Script default timeout value" + flavor data + default_value 10 + description " + This option is used to set the default timeout for startup + scripts, when they are enabled." + } + } + + cdl_option CYGPRI_REDBOOT_ROM_MONITOR { + display "Behave like a ROM monitor" + active_if { CYG_HAL_STARTUP == "ROM" || CYG_HAL_STARTUP == "ROMRAM" } + requires CYGSEM_HAL_ROM_MONITOR + calculated 1 + no_define + description " + Enabling this option will allow RedBoot to provide ROM monitor-style + services to programs which it executes." + } + + cdl_component CYGSEM_REDBOOT_BSP_SYSCALLS { + display "Allow RedBoot to handle GNUPro application 'syscalls'." + flavor bool + default_value 0 + description " + If this option is enabled then RedBoot will install a syscall handler + to support debugging of applications based on GNUPro newlib/bsp." + + cdl_option CYGSEM_REDBOOT_BSP_SYSCALLS_GPROF { + display "Support additional syscalls for 'gprof' profiling" + flavor bool + default_value 1 + active_if { 0 < CYGINT_REDBOOT_BSP_SYSCALLS_GPROF_SUPPORT } + description " + Support additional syscalls to support a periodic callback + function for histogram-style profiling, and an enquire/set + of the tick rate. + The application must use the GNUPro newlib facilities + to set this up." + } + + cdl_interface CYGINT_REDBOOT_BSP_SYSCALLS_GPROF_SUPPORT { + display "Does the HAL support 'gprof' profiling?" + no_define + } + } + + cdl_component CYGOPT_REDBOOT_FIS_ZLIB_COMMON_BUFFER { + display "Use a common buffer for Zlib and FIS" + flavor bool + active_if { CYGBLD_BUILD_REDBOOT_WITH_ZLIB && \ + CYGOPT_REDBOOT_FIS } + default_value 0 + description " + Use a common memory buffer for both the zlib workspace + and FIS directory operations. This can save a substantial + amount of RAM, especially when flash sectors are large." + + cdl_option CYGNUM_REDBOOT_FIS_ZLIB_COMMON_BUFFER_SIZE { + display "Size of Zlib/FIS common buffer" + flavor data + default_value 0xc000 + legal_values 0x4000 to 0x80000000 + description " + Size of common buffer to allocate. Must be at least the + size of one flash sector." + } + } } }
--- a/packages/redboot/current/doc/redboot_installing.sgml +++ b/packages/redboot/current/doc/redboot_installing.sgml @@ -1458,7 +1458,171 @@ description of the associated modes.</pa </sect2> </sect1> - +<?Pub _newpage> +<sect1 id="excaliburarm9"> +<title>ARM/ARM9 Altera Excalibur</title> +<sect2> +<title>Overview</title> +<para><indexterm><primary>Altera Excalibur ARM9 (excalibur_arm9)</primary> +<secondary>installing and testing</secondary></indexterm><indexterm><primary> +installing and testing</primary><secondary>Altera Excalibur ARM9 (excalibur_arm9) +</secondary></indexterm>RedBoot supports the serial port labelled +P2 on the board. The default serial port settings are 57600,8,N,1. RedBoot +also supports flash management on the Excalibur.</para> + +<para>The following RedBoot configurations are supported: + + <informaltable frame="all"> + <tgroup cols="4" colsep="1" rowsep="1" align="left"> + <thead> + <row> + <entry>Configuration</entry> + <entry>Mode</entry> + <entry>Description</entry> + <entry>File</entry> + </row> + </thead> + <tbody> + <row> + <entry>ROMRAM</entry> + <entry>[ROMRAM]</entry> + <entry>RedBoot running from RAM, but contained in the + board's flash boot sector.</entry> + <entry>redboot_ROMRAM.ecm</entry> + </row> + <row> + <entry>RAM</entry> + <entry>[RAM]</entry> + <entry>RedBoot running from RAM with RedBoot in the + flash boot sector.</entry> + <entry>redboot_RAM.ecm</entry> + </row> + <row> + <entry>REDBOOT</entry> + <entry>[ROMRAM]</entry> + <entry>RedBoot running from top of RAM, but contained in + the board's flash boot sector.</entry> + <entry>redboot_REDBOOT.ecm</entry> + </row> +</tbody> +</tgroup> +</informaltable> +</para> + +<note> <title>NOTE</title> +<para>RedBoot is currently hardwired to use a 128MB SDRAM SIMM module. +</para> +</note> +</sect2> + +<sect2> +<title>Initial Installation Method </title> +<para>A Windows utility +(<application>exc_flash_programmer.exe</application>) is used to +program flash using the ByteBlasterMV JTAG unit. +See board documentation for details on +in situ flash programming. </para> +<para>For ethernet to work (under Linux) the following jumper +settings should be used on a REV 2 board: <literallayout> +SW2-9 : OFF +U179 : 2-3 +JP14-18 : OPEN +JP40-41 : 2-3 +JP51-55 : 2-3 +</literallayout> +</para> +</sect2> +<sect2> +<title>Flash management</title> + +<para>The ROMRAM and REDBOOT configurations supported on this platform +differ only in the memory layout (ROMRAM configuration runs RedBoot from +0x00008000 while REDBOOT configuration runs RedBoot from 0x07f80000). The +REDBOOT configuration allows applications to be loaded and run from +address 0x00008000.</para> +</sect2> +<sect2> +<title>Special RedBoot Commands </title> +<para>The <command>exec</command> command which allows the loading +and execution of Linux kernels, +is supported for this board (see <xref linkend="executing-programs">). The <command> +exec</command> parameters used for the Excalibur are:</para> +<variablelist><varlistentry> +<term>-b <replaceable><addr></replaceable></term> +<listitem><para>Location Linux kernel was loaded to</para></listitem></varlistentry> +<varlistentry><term> +-l <replaceable><len></replaceable></term> +<listitem><para>Length of kernel</para></listitem></varlistentry> +<varlistentry><term> +-c <replaceable>"params"</replaceable></term> +<listitem><para>Parameters passed to kernel</para></listitem></varlistentry> +<varlistentry><term>-r <replaceable><addr></replaceable></term> +<listitem><para>'initrd' ramdisk location</para></listitem></varlistentry> +<varlistentry><term>-s <replaceable><len></replaceable></term> +<listitem><para>Length of initrd ramdisk</para></listitem></varlistentry> +</variablelist> + +<para>The parameters for kernel image base and size are automatically +set after a load operation. So one way of starting the kernel would +be: + +<screen>RedBoot> <userinput>load -r -b 0x100000 zImage</userinput> +Raw file loaded 0x00100000-0x001a3d6c +RedBoot> <userinput>exec -c "console=ttyUA0,57600"</userinput> +Using base address 0x00100000 and length 0x000a3d6c +Uncompressing Linux..... +</screen> + +An image could also be put in flash and started directly: + +<screen>RedBoot> <userinput>exec -b 0x40400000 -l 0xc0000 -c "console=ttyUA0,57600"</userinput> +Uncompressing Linux..... +</screen> + +</para> +</sect2> +<sect2> +<title>Memory Maps </title> +<para>The MMU page tables are located at 0x4000. <note><title>NOTE +</title> +<para>The virtual memory maps in this section use a C and B column to indicate +whether or not the region is cached (C) or buffered (B).</para> +</note><programlisting>Physical Address Range Description +----------------------- ---------------------------------- +0x00000000 - 0x07ffffff SDRAM +0x08000000 - 0x0805ffff On-chip SRAM +0x40000000 - 0x40ffffff Flash +0x7fffc000 - 0x7fffffff I/O registers +0x80000000 - 0x8001ffff PLD + +Virtual Address Range C B Description +----------------------- - - ---------------------------------- +0x00000000 - 0x07ffffff Y Y SDRAM +0x08000000 - 0x0805ffff Y Y On-chip SRAM +0x40000000 - 0x403fffff N Y Flash +0x7fffc000 - 0x7fffffff N N I/O registers +0x80000000 - 0x8001ffff N N PLD +</programlisting></para> + +</sect2> +<sect2> +<title>Rebuilding RedBoot</title> + +<para>These shell variables provide the platform-specific information +needed for building RedBoot according to the procedure described in +<xref linkend="Rebuilding-Redboot">: +<programlisting> +export TARGET=excalibur_arm9 +export ARCH_DIR=arm +export PLATFORM_DIR=arm9/excalibur +</programlisting> +</para> + +<para>The names of configuration files are listed above with the +description of the associated modes.</para> + +</sect2> +</sect1> <?Pub _newpage> <sect1 id="ebsa285">