Changeset 7b289f6 in rtems-docs


Ignore:
Timestamp:
Sep 21, 2021, 9:36:17 AM (4 weeks ago)
Author:
Chris Johns <chrisj@…>
Branches:
master
Children:
13092ff
Parents:
7afc7a0
git-author:
Chris Johns <chrisj@…> (09/21/21 09:36:17)
git-committer:
Chris Johns <chrisj@…> (09/23/21 05:02:20)
Message:

user/testing: Add the %wait directive

Location:
user/testing
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • user/testing/configuration.rst

    r7afc7a0 r7b289f6  
    11.. SPDX-License-Identifier: CC-BY-SA-4.0
    22
    3 .. Copyright (C) 2018 Chris Johns <chrisj@rtems.org>
     3.. Copyright (C) 2018,2021 Chris Johns <chrisj@rtems.org>
    44
    55Tester Configuration
     
    227227- ``%gdb``
    228228- ``%tftp``
    229 
     229- ``%wait``
     230
     231.. index:: Console, %console
    230232.. _tester-config-console:
    231 .. index:: Console, %console
    232233
    233234Console
     
    279280
    280281Telnet can be combined with the ``ser2net`` daemon to remotely access a
    281 target's physical serial UART interface.
    282 
     282target's physical serial UART interface. The syntax is ``host:port``::
     283
     284  %define bsp_tty_dev      1.2.3.4:8989
     285
     286.. index:: Execute, %execute
    283287.. _tester-config-execute:
    284 .. index:: Execute, %execute
    285288
    286289Execute
     
    298301  %execute %{run_cmd} %{run_opts} %{test_executable} %{test_executable_opts}
    299302
     303.. index:: GDB, %gdb
    300304.. _tester-config-gdb:
    301 .. index:: GDB, %gdb
    302305
    303306GDB
     
    314317  %gdb %{gdb_cmd} %{test_executable} %{gdb_script}
    315318
     319.. index:: TFTP, %tftp
    316320.. _tester-config-tftp:
    317 .. index:: TFTP, %tftp
    318321
    319322TFTP
     
    329332
    330333  %tftp %{test_executable} %{tftp_port}
     334
     335The RTEMS Tester contains a TFTP server so an external TFTP is not
     336needed. It is recommended a TFTP Proxy is set up to handle the TFTP
     337sessions for your network. The internal TFTP server ignores the
     338requrest file and serves the next executable. If the target requires
     339the executable ne in a specific format provide a script via the
     340``target_pretest_command`` option in your user configuration file.
     341
     342The RTEMS Tools provides a TFTP protocol proxy server. It takes a list
     343of MAC addresses and proxies TFTP sessions for that MAC address to
     344another IP address and port. A proxy provides the following benefits:
     345
     3461. The TFTP proxy server is the only software required to run as root
     347
     3482. All hardware targets can be configured to serve from a single
     349   machine and the proxy can distribute the sessions out to developer
     350   machines
     351
     3523. There is no need to provide a globally writable file system a
     353   central TFTP server acceses
     354
     355If you have a central TFTP server refer to the ``%wait`` directive.
     356
     357.. index:: Wait, %wait
     358.. _tester-config-wait:
     359
     360Wait
     361~~~~
     362
     363The ``%wait`` directive waits the timeout period for a test to
     364complete. The directive monitors the console output and resets the
     365timeout timer if console output is seen. If the test runs for too long
     366while outputing data an error is reported.
     367
     368The wait directive can be used in systems where there is an external
     369mechanism being used to send the executable to the target hardware.
     370
     371An example is::
     372
     373  %wait
     374
     375Wait has no options. The timeouts are controlled in other ways.
     376
     377If you have an external system wide TFTP server with global access
     378wait can used by providing a `` script that places the file in the
     379location the TFTP server can see. This is done as the test start so if
     380networking loading there is normally enough time to get the executable
     381image in place before the transfer starts. The MVME2700
     382(``powerpc/mvme2307``) is a BSP that supports the ``%wait`` directive.
     383
     384The following is an example user configuration file (see
     385``--user-config``)::
     386
     387  #
     388  # MVME2700 (mvme2307)
     389  #
     390  [mvme2307]
     391  bsp_tty_dev            = 1.2.3.4:5678
     392  target_pretest_command = mk-mvme2307-img @EXE@ /tftp/cjohns/rtems.img
     393  target_exe_filter      = /\.exe/.exe.img/
     394  target_on_command      = pw-ctl 1.2.3.4 toggle-on 3 1
     395  target_off_command     = pw-ctl 1.2.3.4 off 3
     396  target_reset_command   = pw-ctl 1.2.3.4 toggle-on 3 1
     397
     398The script ``mk-mvme2307-img`` converts the RTEMS ELF executable into
     399the PowerPC prep bootloader format and copies the file to the TFTP
     400server's network wide location. The MVME2700 is configured to request
     401``rtems.img`` from this location. The command ``pw-ctl`` is a command
     402to control the power to the board.
  • user/testing/tftp.rst

    r7afc7a0 r7b289f6  
    1111
    1212TFTP and U-Boot provides a simple way to test RTEMS on a network capable
    13 target. The RTEMS Tester starts a TFTP server for each test and the target's
    14 boot monitor, in this case U-Boot request a file, any file, which the TFTP
    15 server supplies. U-Boot loads the executable and boots it using a standard
    16 U-Boot script.
     13target. The RTEMS Tester starts a TFTP server session for each test and the
     14target's boot monitor, in this case U-Boot request a file, any file, which the
     15TFTP server supplies. U-Boot loads the executable and boots it using a
     16standard U-Boot script.
     17
     18The RTEMS Tester contains a TFTP server so no external TFTP server or
     19configuration is required. If you have an external TFTP server and wish to use
     20that resource the :ref:`tester-config-wait` directive can be used.
    1721
    1822.. _fig-tester-tftp-u-boot:
Note: See TracChangeset for help on using the changeset viewer.