testsuite: A description for each test added

testsuite/arphole/test_main.c

@@ -1,8 +1,10 @@
 /**
  * @file
  *
- * This test program processes all ARP requests and claims every IP address it
- * notices.  Use with care in production networks.
+ * @brief This test program processes all ARP requests and claims every IP address it
+ * notices.
+ *
+ * Use with care in production networks.
  */
 
 /*

testsuite/cdev01/test_main.c

@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * It creates a character device (cdev) and tests the basic i/o functions,
+ * e.g. open(), read(), write(), ioctl(), etc.
+ */
+
 /*
  * Copyright (c) 2016 embedded brains GmbH.  All rights reserved.
  *

testsuite/commands01/test_main.c

@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * The following commands are tested: route, ifconfig, ping, ping6 (if defined),
+ * netstat and wlanstats (if defined).
+ */
+
 /*
  * Copyright (c) 2013-2014 embedded brains GmbH.  All rights reserved.
  *

testsuite/condvar01/test_main.c

@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * It tests condition variable (condvar) sending RTEMS events to two
+ * workers (RTEMS tasks).
+ */
+
 /*
  * Copyright (c) 2014 embedded brains GmbH.  All rights reserved.
  *

testsuite/crypto01/test_main.c

@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief It tests /dev/crypto device.
+ */
+
 /*
  * Copyright (c) 2018 embedded brains GmbH.  All rights reserved.
  *

testsuite/debugger01/test_main.c

@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief It tests RTEMS debugger (TCP:1122).
+ */
+
 /*
  * Copyright (c) 2016 Chris Johns <chrisj@rtems.org>
  * All rights reserved.

testsuite/dhcpcd01/test_main.c

@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief It tests to add a hook to DHCP client daemon (dhcpcd).
+ *
+ * Every time the hook is called, the environment is printed out.
+ */
+
 /*
  * Copyright (c) 2013, 2018 embedded brains GmbH.  All rights reserved.
  *

testsuite/dhcpcd02/test_main.c

@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief It tests the DHCP client daemon (dhcpcd).
+ */
+
 /*
  * Copyright (c) 2013-2014 embedded brains GmbH.  All rights reserved.
  *

testsuite/epoch01/test_main.c

@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * The following epoch functions are tested with parallel tasks: epoch_enter(),
+ * epoch_exit(), epoch_call(), epoch_wait(), epoch_enter_preempt(),
+ * epoch_exit_preempt(), epoch_wait_preempt() and epoch_drain_callbacks().
+ */
+
 /*
  * Copyright (c) 2018 embedded brains GmbH.  All rights reserved.
  *

testsuite/evdev01/init.c

@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief Different event devices (evdev) are tested in different RTEMS tasks.
+ */
+
 /*-
  * COPYRIGHT (c) 2017 Kevin Kirspel
  * All rights reserved.

testsuite/foobarclient/test_main.c

@@ -1,3 +1,13 @@
+/**
+ * @file
+ *
+ * @brief The multicast DNS (mDNS) protocol is tested.
+ *
+ * To run this test is also required to run foobarserver.
+ * The following functions are called: mDNS_StartBrowse(),
+ * mDNS_StartResolveService() and mDNS_StopResolveService().
+ */
+
 /*
  * Copyright (c) 2014 embedded brains GmbH.  All rights reserved.
  *

testsuite/foobarserver/test_main.c

@@ -1,3 +1,15 @@
+/**
+ * @file
+ *
+ * @brief The multicast DNS (mDNS) protocol is tested.
+ *
+ * To run this test is also required to run foobarclient.
+ * A TCP socket (SOCK_STREAM) is open from port FOOBAR_PORT_BEGIN to
+ * port FOOBAR_PORT_END - 1 on at a time.
+ * The following functions are called: mDNS_RegisterService(),
+ * mDNS_DeregisterService() and mDNS_RenameAndReregisterService().
+ */
+
 /*
  * Copyright (c) 2014 embedded brains GmbH.  All rights reserved.
  *

testsuite/ftpd01/test_main.c

@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief It starts an FTP daemon (ftpd).
+ */
+
 /*
  * Copyright (c) 2013 embedded brains GmbH.  All rights reserved.
  *

testsuite/ftpd02/test_main.c

@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief File handling basics are tested in an FTP file system locally.
+ */
+
 /*
  * Copyright (c) 2011, 2016 embedded brains GmbH.  All rights reserved.
  *

testsuite/init01/test_main.c

@@ -1,4 +1,6 @@
-/*
+/**
+ * @file
+ *
  *  This is the body of the test. It does not do much except ensure
  *  that the target is alive after initializing the TCP/IP stack.
  */

testsuite/ipsec01/test_main.c

@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief It tests Internet Protocol Security protocol (ipsec).
+ *
+ * It needs a communication partner (see testsuit/ipsec01/README).
+ */
+
 /*
  * Copyright (c) 2018 embedded brains GmbH.  All rights reserved.
  *

testsuite/lagg01/test_main.c

@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief A link aggregation (lagg) is tested.
+ *
+ * ifconfig command is used to do this.
+ */
+
 /*
  * Copyright (c) 2015 embedded brains GmbH.  All rights reserved.
  *

testsuite/log01/test_main.c

@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief Different logging levels are tested.
+ */
+
 /*
  * Copyright (c) 2016 embedded brains GmbH.  All rights reserved.
  *

testsuite/loopback01/test_main.c

@@ -1,6 +1,9 @@
-/*
- *  This is the body of the test. It does not do much except ensure
- *  that the target is alive after initializing the TCP/IP stack.
+/**
+ * @file
+ *
+ * @brief It tests socket connections locally.
+ *
+ * The server and clients are running in different RTEMS tasks.
  */
 
 #include <stdlib.h>

testsuite/media01/test_main.c

@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief Code used to test the Media Manager.
+ *
+ * Telnet daemon (telnetd) and FTP daemon (ftpd) are started. Events are recorded.
+ */
+
 /*
  * Copyright (c) 2010-2016 embedded brains GmbH.  All rights reserved.
  *

testsuite/mutex01/test_main.c

@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief Different mutex methods are tested.
+ */
+
 /*
  * Copyright (c) 2014, 2018 embedded brains GmbH.  All rights reserved.
  *

testsuite/netshell01/test_main.c

@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief RTEMS shell is started and it is possible to run net commands.
+ */
+
 /*
  * COPYRIGHT (c) 2012. On-Line Applications Research Corporation (OAR).
  * All rights reserved.
@@ -24,11 +30,6 @@
  * SUCH DAMAGE.
  */
 
-/*
- *  This is the body of the test. It does not do much except ensure
- *  that the target is alive after initializing the TCP/IP stack.
- */
-
 #include <assert.h>
 #include <errno.h>
 #include <stdarg.h>

testsuite/nfs01/test_main.c

@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief It mounts a network file system (nfs).
+ */
+
 /*
  * Copyright (c) 2016 embedded brains GmbH.  All rights reserved.
  *

testsuite/openssl01/test_main.c

@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief It tests encryption and decryption using openssl.
+ */
+
 /*
  * Copyright (c) 2018 embedded brains GmbH.  All rights reserved.
  *

testsuite/openssl02/test_main.c

@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * The openssl certificate generation is tested and performance of
+ * cryptographic algorithm is shown.
+ */
+
 /*
  * Copyright (c) 2013-2019 embedded brains GmbH.  All rights reserved.
  *

testsuite/pf01/test_main.c

@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief Packet filter rules are tested (see defines below).
+ */
+
 /*
  * Copyright (c) 2016 embedded brains GmbH.  All rights reserved.
  *

testsuite/pf02/test_main.c

@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief Packet filter rules are tested (see defines below).
+ *
+ * RTEMS shell starts at the end of the test.
+ */
+
 /*
  * Copyright (c) 2016 embedded brains GmbH.  All rights reserved.
  *

testsuite/ping01/test_main.c

@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief Ping (shell command) test.
+ */
+
 /*
  * Copyright (c) 2013-2014 embedded brains GmbH.  All rights reserved.
  *

testsuite/ppp01/test_main.c

@@ -1,3 +1,17 @@
+/**
+ * @file
+ *
+ * To test PPP connect the RTEMS target with your host.  Start PPP on the host
+ * with something like this:
+ *
+ * pppd nodetach noauth 192.168.100.11:192.168.100.70 proxyarp 115200 dump \
+ *   local nocrtscts debug mtu 296 mru 296 nolock ms-dns 192.168.96.1 novj \
+ *   /dev/ttyS0
+ *
+ * Make sure IP forwarding is enabled and check the firewall settings if you
+ * want to access the internet.
+ */
+
 /*
  * Copyright (c) 2014, 2018 embedded brains GmbH.  All rights reserved.
  *
@@ -29,18 +43,6 @@
  * SUCH DAMAGE.
  */
 
-/*
- * To test PPP connect the RTEMS target with your host.  Start PPP on the host
- * with something like this:
- *
- * pppd nodetach noauth 192.168.100.11:192.168.100.70 proxyarp 115200 dump \
- *   local nocrtscts debug mtu 296 mru 296 nolock ms-dns 192.168.96.1 novj \
- *   /dev/ttyS0
- *
- * Make sure IP forwarding is enabled and check the firewall settings if you
- * want to access the internet.
- */
-
 #include <assert.h>
 #include <stdlib.h>
 #include <sys/stat.h>

testsuite/program01/test_main.c

@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief RTEMS function wrappers for BSD programs test.
+ */
+
 /*
  * Copyright (c) 2013 embedded brains GmbH.  All rights reserved.
  *

testsuite/rcconf01/test_main.c

@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * The following functions are tested: rtems_bsd_rc_conf_argc_argv_create(),
+ * rtems_bsd_rc_conf_find(), rtems_bsd_rc_conf_print_cmd() and
+ * rtems_bsd_rc_conf_find_next().
+ */
+
 /*
  * Copyright 2016 Chris Johns <chrisj@rtems.org>
  *

testsuite/rcconf02/test_main.c

@@ -1,3 +1,32 @@
+/**
+ * @file
+ *
+ * @brief A rc.conf script (rc_conf_text) is run. RTEMS shell starts at the end of the test.
+ *
+ * Tests:
+ *
+ * 1. rc.conf processing
+ *  1.1  syslog_priority
+ *  1.2  create_args_*
+ *  1.3  hostname
+ *  1.4  ifconfig_<iface>
+ *  1.5  vlans_<iface>
+ *  1.6  ifconfig_<iface>.<vlan>
+ *  1.7  defaultrouter
+ *  1.8  defaultroute_delay
+ *  1.9  ftp_enable
+ *  1.10 ftp_options
+ *  1.11 dhcpcd_priority
+ *  1.12 dhcpcd_options
+ *
+ * 2. dhcpcd (via vlan, should timeout unless VLAN is present)
+ *
+ * 3. get route, the defaultrouter sets a default route and the vlan DHCP
+ *    interface requires the default route be probed and found.
+ *
+ * 4. ftpd
+ */
+
 /*
  * Copyright 2016 Chris Johns <chrisj@rtems.org>
  *
@@ -23,31 +52,6 @@
  * SUCH DAMAGE.
  */
 
-/*
- * Tests:
- *
- * 1. rc.conf processing
- *  1.1  syslog_priority
- *  1.2  create_args_*
- *  1.3  hostname
- *  1.4  ifconfig_<iface>
- *  1.5  vlans_<iface>
- *  1.6  ifconfig_<iface>.<vlan>
- *  1.7  defaultrouter
- *  1.8  defaultroute_delay
- *  1.9  ftp_enable
- *  1.10 ftp_options
- *  1.11 dhcpcd_priority
- *  1.12 dhcpcd_options
- *
- * 2. dhcpcd (via vlan, should timeout unless VLAN is present)
- *
- * 3. get route, the defaultrouter sets a default route and the vlan DHCP
- *    interface requires the default route be probed and found.
- *
- * 4. ftpd
- */
-
 #include <sys/param.h>
 
 #include <assert.h>

testsuite/rwlock01/test_main.c

@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief Readers-writer lock is tested.
+ */
+
 /*
  * Copyright (c) 2013 embedded brains GmbH.  All rights reserved.
  *

testsuite/selectpollkqueue01/test_main.c

@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * The following system calls are tested: select(), pselect(), poll(), kqueue() and pipe().
+ */
+
 /*
  * Copyright (c) 2013, 2019 embedded brains GmbH.  All rights reserved.
  *

testsuite/sleep01/test_main.c

@@ -1,3 +1,13 @@
+/**
+ * @file
+ *
+ * The following functions are tested: msleep(), msleep_spin(), tsleep(),
+ * wakeup() and wakeup_one().
+ * SLAVE_COUNT tasks are created. Each one increments its own counter and
+ * then it is sent to sleep with tsleep(). All tasks are grouped under the
+ * same channel. This means that all threads are woken up if wakeup() is called.
+ */
+
 /*
  * Copyright (c) 2013 embedded brains GmbH.  All rights reserved.
  *

testsuite/smp01/test_main.c

@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief Symetric Multiprocessing (smp) is tested.
+ *
+ * Parallel jobs are run with rtems_test_parallel().
+ */
+
 /*
  * Copyright (c) 2015 embedded brains GmbH.  All rights reserved.
  *

testsuite/swi01/init.c

@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief Software interrupts (swi) are tested.
+ *
+ * The following functions are called: swi_add() and swi_sched().
+ */
+
 /*
  * Copyright (c) 2012 embedded brains GmbH.  All rights reserved.
  *

testsuite/syscalls01/test_main.c

@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief Different system calls are tested.
+ */
+
 /*
  * Copyright (c) 2013, 2018 embedded brains GmbH.  All rights reserved.
  *

testsuite/telnetd01/test_main.c

@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief The telnet daemon is run.
+ */
+
 /*
  * Copyright (c) 2014 embedded brains GmbH.  All rights reserved.
  *

testsuite/termios/test_main.c

@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief A program to test different setting of termios manually is run.
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2010.
  *  On-Line Applications Research Corporation (OAR).

testsuite/termios01/test_main.c

@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief Settings of termios (e.g. baudrate, parity, etc.) are tested.
+ *
+ * tcsetattr() is used to change the settings.
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2010.
  *  On-Line Applications Research Corporation (OAR).

testsuite/termios02/test_main.c

@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * The following system calls are tested: tcflow(), tcflush(), tcgetpgrp(),
+ * tcsendbreak() and ctermid().
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2017.
  *  On-Line Applications Research Corporation (OAR).
@@ -137,4 +144,4 @@ test_main(void)
   exit(0);
 }
 
-#include <rtems/bsd/test/default-termios-init.h>
+#include <rtems/bsd/test/default-termios-init.h>

testsuite/termios03/test_main.c

@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief read() and write() are tested using the termios utilities.
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2017.
  *  On-Line Applications Research Corporation (OAR).
@@ -70,4 +76,4 @@ test_main(void)
   exit(0);
 }
 
-#include <rtems/bsd/test/default-termios-init.h>
+#include <rtems/bsd/test/default-termios-init.h>

testsuite/termios04/test_main.c

@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief IXON and IXOFF flags test.
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2017.
  *  On-Line Applications Research Corporation (OAR).
@@ -66,4 +72,4 @@ test_main(void)
   exit(0);
 }
 
-#include <rtems/bsd/test/default-termios-init.h>
+#include <rtems/bsd/test/default-termios-init.h>

testsuite/termios05/test_main.c

@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief Noncanonical mode test.
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2017.
  *  On-Line Applications Research Corporation (OAR).
@@ -62,4 +68,4 @@ test_main(void)
   exit(0);
 }
 
-#include <rtems/bsd/test/default-termios-init.h>
+#include <rtems/bsd/test/default-termios-init.h>

testsuite/termios06/test_main.c

@@ -1,3 +1,10 @@
+/**
+ * @file
+ *
+ * The behavior of the following flags are tested: IGNCR, ISRTIP, IUCLC, ICRNL,
+ * INLCR, OPOST, ONLRET, ONLCR, ONOCR, OCRNL, OXTABS and OLCUC.
+ */
+
 /*
  *  COPYRIGHT (c) 1989-2017.
  *  On-Line Applications Research Corporation (OAR).

testsuite/thread01/test_main.c

@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @brief The creation and execution of threads (RTEMS task, kproc, kthread) are tested.
+ *
+ * The main thread creates a worker and the waits until receives an event of the
+ * created worker.
+ */
+
 /*
  * Copyright (c) 2013, 2018 embedded brains GmbH.  All rights reserved.
  *

testsuite/timeout01/init.c

@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief The timeout and callout functions are tested.
+ */
+
 /*
  * Copyright (c) 2012 embedded brains GmbH.  All rights reserved.
  *

testsuite/unix01/test_main.c

@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief PF_UNIX sockets test.
+ */
+
 /*
  * Copyright (c) 2014 embedded brains GmbH.  All rights reserved.
  *

testsuite/usb01/init.c

@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief Same as media01 but without ftpd and telnetd.
+ *
+ * RTEMS shell starts at the end of the test.
+ */
+
 /*
  * Copyright (c) 2010, 2016 embedded brains GmbH.  All rights reserved.
  *

testsuite/usbkbd01/init.c

@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief USB keyboard test.
+ *
+ * RTEMS shell starts at the end of the test.
+ */
+
 /*-
  * COPYRIGHT (c) 2017 Kevin Kirspel
  * All rights reserved.

testsuite/usbmouse01/init.c

@@ -1,3 +1,12 @@
+/**
+ * @file
+ *
+ * @brief USB mouse test.
+ *
+ * This test requires a USB mouse to be attached to a USB port.
+ * RTEMS shell starts at the end of the test.
+ */
+
 /*-
  * COPYRIGHT (c) 2017 Kevin Kirspel
  * All rights reserved.
@@ -24,10 +33,6 @@
  * SUCH DAMAGE.
  */
 
-/*
- * This test requires a USB mouse to be attached to a USB port.
- */
-
 #include <sys/malloc.h>
 #include <assert.h>
 #include <stdio.h>

testsuite/usbserial01/init.c

@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief USB serial adapter test.
+ *
+ * RTEMS shell starts at the end of the test.
+ */
+
 /*-
  * COPYRIGHT (c) 2017 Kevin Kirspel
  * All rights reserved.

testsuite/vlan01/test_main.c

@@ -1,3 +1,9 @@
+/**
+ * @file
+ *
+ * @brief A vlan creation using ifconfig is tested.
+ */
+
 /*
  * Copyright (c) 2015 embedded brains GmbH.  All rights reserved.
  *

testsuite/zerocopy01/test_main.c

@@ -1,3 +1,11 @@
+/**
+ * @file
+ *
+ * @brief Zerocopy test.
+ *
+ * Telnet daemon (telnetd) is initilized.
+ */
+
 /*
  * Copyright (c) 2015 embedded brains GmbH.  All rights reserved.
  *