From 0444b24bf9a928a39cf4e8c9eaa096b6f242ae55 Mon Sep 17 00:00:00 2001 From: "Moyano, Gabriel" Date: Fri, 3 Apr 2020 09:35:23 +0200 Subject: testsuite: A description for each test added --- testsuite/arphole/test_main.c | 6 ++-- testsuite/cdev01/test_main.c | 7 +++++ testsuite/commands01/test_main.c | 7 +++++ testsuite/condvar01/test_main.c | 7 +++++ testsuite/crypto01/test_main.c | 6 ++++ testsuite/debugger01/test_main.c | 6 ++++ testsuite/dhcpcd01/test_main.c | 8 +++++ testsuite/dhcpcd02/test_main.c | 6 ++++ testsuite/epoch01/test_main.c | 8 +++++ testsuite/evdev01/init.c | 6 ++++ testsuite/foobarclient/test_main.c | 10 ++++++ testsuite/foobarserver/test_main.c | 12 ++++++++ testsuite/ftpd01/test_main.c | 6 ++++ testsuite/ftpd02/test_main.c | 6 ++++ testsuite/init01/test_main.c | 4 ++- testsuite/ipsec01/test_main.c | 8 +++++ testsuite/lagg01/test_main.c | 8 +++++ testsuite/log01/test_main.c | 6 ++++ testsuite/loopback01/test_main.c | 9 ++++-- testsuite/media01/test_main.c | 8 +++++ testsuite/mutex01/test_main.c | 6 ++++ testsuite/netshell01/test_main.c | 11 ++++--- testsuite/nfs01/test_main.c | 6 ++++ testsuite/openssl01/test_main.c | 6 ++++ testsuite/openssl02/test_main.c | 7 +++++ testsuite/pf01/test_main.c | 6 ++++ testsuite/pf02/test_main.c | 8 +++++ testsuite/ping01/test_main.c | 6 ++++ testsuite/ppp01/test_main.c | 26 ++++++++-------- testsuite/program01/test_main.c | 6 ++++ testsuite/rcconf01/test_main.c | 8 +++++ testsuite/rcconf02/test_main.c | 52 +++++++++++++++++--------------- testsuite/rwlock01/test_main.c | 6 ++++ testsuite/selectpollkqueue01/test_main.c | 6 ++++ testsuite/sleep01/test_main.c | 10 ++++++ testsuite/smp01/test_main.c | 8 +++++ testsuite/swi01/init.c | 8 +++++ testsuite/syscalls01/test_main.c | 6 ++++ testsuite/telnetd01/test_main.c | 6 ++++ testsuite/termios/test_main.c | 6 ++++ testsuite/termios01/test_main.c | 8 +++++ testsuite/termios02/test_main.c | 9 +++++- testsuite/termios03/test_main.c | 8 ++++- testsuite/termios04/test_main.c | 8 ++++- testsuite/termios05/test_main.c | 8 ++++- testsuite/termios06/test_main.c | 7 +++++ testsuite/thread01/test_main.c | 9 ++++++ testsuite/timeout01/init.c | 6 ++++ testsuite/unix01/test_main.c | 6 ++++ testsuite/usb01/init.c | 8 +++++ testsuite/usbkbd01/init.c | 8 +++++ testsuite/usbmouse01/init.c | 13 +++++--- testsuite/usbserial01/init.c | 8 +++++ testsuite/vlan01/test_main.c | 6 ++++ testsuite/zerocopy01/test_main.c | 8 +++++ 55 files changed, 413 insertions(+), 55 deletions(-) diff --git a/testsuite/arphole/test_main.c b/testsuite/arphole/test_main.c index 45a28cc0..a77c79ee 100644 --- a/testsuite/arphole/test_main.c +++ b/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. */ /* diff --git a/testsuite/cdev01/test_main.c b/testsuite/cdev01/test_main.c index a72985e1..ae2422bf 100644 --- a/testsuite/cdev01/test_main.c +++ b/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. * diff --git a/testsuite/commands01/test_main.c b/testsuite/commands01/test_main.c index 73168eac..3bd38a70 100644 --- a/testsuite/commands01/test_main.c +++ b/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. * diff --git a/testsuite/condvar01/test_main.c b/testsuite/condvar01/test_main.c index 8b2d102b..3734ae32 100644 --- a/testsuite/condvar01/test_main.c +++ b/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. * diff --git a/testsuite/crypto01/test_main.c b/testsuite/crypto01/test_main.c index 5c6b725e..ddea9f64 100644 --- a/testsuite/crypto01/test_main.c +++ b/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. * diff --git a/testsuite/debugger01/test_main.c b/testsuite/debugger01/test_main.c index 777e8a76..3c3040fb 100644 --- a/testsuite/debugger01/test_main.c +++ b/testsuite/debugger01/test_main.c @@ -1,3 +1,9 @@ +/** + * @file + * + * @brief It tests RTEMS debugger (TCP:1122). + */ + /* * Copyright (c) 2016 Chris Johns * All rights reserved. diff --git a/testsuite/dhcpcd01/test_main.c b/testsuite/dhcpcd01/test_main.c index 358b4ac8..c1d97a3f 100644 --- a/testsuite/dhcpcd01/test_main.c +++ b/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. * diff --git a/testsuite/dhcpcd02/test_main.c b/testsuite/dhcpcd02/test_main.c index 611c12b1..221b096f 100644 --- a/testsuite/dhcpcd02/test_main.c +++ b/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. * diff --git a/testsuite/epoch01/test_main.c b/testsuite/epoch01/test_main.c index dd8aa50f..98ae006a 100644 --- a/testsuite/epoch01/test_main.c +++ b/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. * diff --git a/testsuite/evdev01/init.c b/testsuite/evdev01/init.c index bbcd3434..38ae1e12 100644 --- a/testsuite/evdev01/init.c +++ b/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. diff --git a/testsuite/foobarclient/test_main.c b/testsuite/foobarclient/test_main.c index 85007ee8..d55b55c6 100644 --- a/testsuite/foobarclient/test_main.c +++ b/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. * diff --git a/testsuite/foobarserver/test_main.c b/testsuite/foobarserver/test_main.c index a239a561..84c40c4d 100644 --- a/testsuite/foobarserver/test_main.c +++ b/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. * diff --git a/testsuite/ftpd01/test_main.c b/testsuite/ftpd01/test_main.c index 98eb47ef..7ec17b96 100644 --- a/testsuite/ftpd01/test_main.c +++ b/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. * diff --git a/testsuite/ftpd02/test_main.c b/testsuite/ftpd02/test_main.c index 3eb079d2..d62976b4 100644 --- a/testsuite/ftpd02/test_main.c +++ b/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. * diff --git a/testsuite/init01/test_main.c b/testsuite/init01/test_main.c index 61d7836b..ea45b511 100644 --- a/testsuite/init01/test_main.c +++ b/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. */ diff --git a/testsuite/ipsec01/test_main.c b/testsuite/ipsec01/test_main.c index 651a4056..e8a8455e 100644 --- a/testsuite/ipsec01/test_main.c +++ b/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. * diff --git a/testsuite/lagg01/test_main.c b/testsuite/lagg01/test_main.c index 99544a52..96256d36 100644 --- a/testsuite/lagg01/test_main.c +++ b/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. * diff --git a/testsuite/log01/test_main.c b/testsuite/log01/test_main.c index 45f62cdf..4eaa9017 100644 --- a/testsuite/log01/test_main.c +++ b/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. * diff --git a/testsuite/loopback01/test_main.c b/testsuite/loopback01/test_main.c index f0453e69..1b5c0064 100644 --- a/testsuite/loopback01/test_main.c +++ b/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 diff --git a/testsuite/media01/test_main.c b/testsuite/media01/test_main.c index 942664cd..91e0dd5a 100644 --- a/testsuite/media01/test_main.c +++ b/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. * diff --git a/testsuite/mutex01/test_main.c b/testsuite/mutex01/test_main.c index c3e193d9..323ca527 100644 --- a/testsuite/mutex01/test_main.c +++ b/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. * diff --git a/testsuite/netshell01/test_main.c b/testsuite/netshell01/test_main.c index 13d8a31c..81941d0b 100644 --- a/testsuite/netshell01/test_main.c +++ b/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 #include #include diff --git a/testsuite/nfs01/test_main.c b/testsuite/nfs01/test_main.c index d50edc37..2312040a 100644 --- a/testsuite/nfs01/test_main.c +++ b/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. * diff --git a/testsuite/openssl01/test_main.c b/testsuite/openssl01/test_main.c index 4359b5f0..0cac4b98 100644 --- a/testsuite/openssl01/test_main.c +++ b/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. * diff --git a/testsuite/openssl02/test_main.c b/testsuite/openssl02/test_main.c index 94a735b0..32e9c03a 100644 --- a/testsuite/openssl02/test_main.c +++ b/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. * diff --git a/testsuite/pf01/test_main.c b/testsuite/pf01/test_main.c index 9421f0e6..3c07b82e 100644 --- a/testsuite/pf01/test_main.c +++ b/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. * diff --git a/testsuite/pf02/test_main.c b/testsuite/pf02/test_main.c index 3e71ebb4..92073165 100644 --- a/testsuite/pf02/test_main.c +++ b/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. * diff --git a/testsuite/ping01/test_main.c b/testsuite/ping01/test_main.c index 659043c4..5702cee2 100644 --- a/testsuite/ping01/test_main.c +++ b/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. * diff --git a/testsuite/ppp01/test_main.c b/testsuite/ppp01/test_main.c index 550039e9..078e96e2 100644 --- a/testsuite/ppp01/test_main.c +++ b/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 #include #include diff --git a/testsuite/program01/test_main.c b/testsuite/program01/test_main.c index 7691b210..a318b7b8 100644 --- a/testsuite/program01/test_main.c +++ b/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. * diff --git a/testsuite/rcconf01/test_main.c b/testsuite/rcconf01/test_main.c index 4701390c..c7f8ef5f 100644 --- a/testsuite/rcconf01/test_main.c +++ b/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 * diff --git a/testsuite/rcconf02/test_main.c b/testsuite/rcconf02/test_main.c index 3a7b7026..c40392de 100644 --- a/testsuite/rcconf02/test_main.c +++ b/testsuite/rcconf02/test_main.c @@ -1,29 +1,8 @@ -/* - * Copyright 2016 Chris Johns +/** + * @file * - * Redistribution and use in source and binary forms, with or without - * modification, are permitted provided that the following conditions - * are met: - * 1. Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * 2. Redistributions in binary form must reproduce the above copyright - * notice, this list of conditions and the following disclaimer in the - * documentation and/or other materials provided with the distribution. + * @brief A rc.conf script (rc_conf_text) is run. RTEMS shell starts at the end of the test. * - * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND - * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE - * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE - * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL - * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS - * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) - * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT - * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY - * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF - * SUCH DAMAGE. - */ - -/* * Tests: * * 1. rc.conf processing @@ -48,6 +27,31 @@ * 4. ftpd */ +/* + * Copyright 2016 Chris Johns + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + */ + #include #include diff --git a/testsuite/rwlock01/test_main.c b/testsuite/rwlock01/test_main.c index a0ae91b6..ed1dc126 100644 --- a/testsuite/rwlock01/test_main.c +++ b/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. * diff --git a/testsuite/selectpollkqueue01/test_main.c b/testsuite/selectpollkqueue01/test_main.c index 244f5b50..1c481517 100755 --- a/testsuite/selectpollkqueue01/test_main.c +++ b/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. * diff --git a/testsuite/sleep01/test_main.c b/testsuite/sleep01/test_main.c index ffea7420..576c166f 100644 --- a/testsuite/sleep01/test_main.c +++ b/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. * diff --git a/testsuite/smp01/test_main.c b/testsuite/smp01/test_main.c index 583fe906..35c10c96 100644 --- a/testsuite/smp01/test_main.c +++ b/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. * diff --git a/testsuite/swi01/init.c b/testsuite/swi01/init.c index 5c832554..25e35cfe 100644 --- a/testsuite/swi01/init.c +++ b/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. * diff --git a/testsuite/syscalls01/test_main.c b/testsuite/syscalls01/test_main.c index 5db3013c..ad180e8e 100644 --- a/testsuite/syscalls01/test_main.c +++ b/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. * diff --git a/testsuite/telnetd01/test_main.c b/testsuite/telnetd01/test_main.c index 8fca493e..00916843 100644 --- a/testsuite/telnetd01/test_main.c +++ b/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. * diff --git a/testsuite/termios/test_main.c b/testsuite/termios/test_main.c index 68a15c6f..ff805032 100644 --- a/testsuite/termios/test_main.c +++ b/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). diff --git a/testsuite/termios01/test_main.c b/testsuite/termios01/test_main.c index e00ff865..6f9041f4 100644 --- a/testsuite/termios01/test_main.c +++ b/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). diff --git a/testsuite/termios02/test_main.c b/testsuite/termios02/test_main.c index 3ec5c0b2..387a55bf 100644 --- a/testsuite/termios02/test_main.c +++ b/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 \ No newline at end of file +#include diff --git a/testsuite/termios03/test_main.c b/testsuite/termios03/test_main.c index c92c4f0d..a0e9cdf3 100644 --- a/testsuite/termios03/test_main.c +++ b/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 \ No newline at end of file +#include diff --git a/testsuite/termios04/test_main.c b/testsuite/termios04/test_main.c index f4d94767..c4f24c28 100644 --- a/testsuite/termios04/test_main.c +++ b/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 \ No newline at end of file +#include diff --git a/testsuite/termios05/test_main.c b/testsuite/termios05/test_main.c index faad94fe..959c9c23 100644 --- a/testsuite/termios05/test_main.c +++ b/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 \ No newline at end of file +#include diff --git a/testsuite/termios06/test_main.c b/testsuite/termios06/test_main.c index d70b7bdf..34972eae 100644 --- a/testsuite/termios06/test_main.c +++ b/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). diff --git a/testsuite/thread01/test_main.c b/testsuite/thread01/test_main.c index fa15b9f6..9d5e5bba 100644 --- a/testsuite/thread01/test_main.c +++ b/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. * diff --git a/testsuite/timeout01/init.c b/testsuite/timeout01/init.c index 6072bbc6..1c8df1c9 100644 --- a/testsuite/timeout01/init.c +++ b/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. * diff --git a/testsuite/unix01/test_main.c b/testsuite/unix01/test_main.c index 61f9aa4e..32b37ba0 100644 --- a/testsuite/unix01/test_main.c +++ b/testsuite/unix01/test_main.c @@ -1,3 +1,9 @@ +/** + * @file + * + * @brief PF_UNIX sockets test. + */ + /* * Copyright (c) 2014 embedded brains GmbH. All rights reserved. * diff --git a/testsuite/usb01/init.c b/testsuite/usb01/init.c index 8d6bb274..2f5260e3 100644 --- a/testsuite/usb01/init.c +++ b/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. * diff --git a/testsuite/usbkbd01/init.c b/testsuite/usbkbd01/init.c index ed6f5999..238e2318 100644 --- a/testsuite/usbkbd01/init.c +++ b/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. diff --git a/testsuite/usbmouse01/init.c b/testsuite/usbmouse01/init.c index 0ae65545..95276147 100644 --- a/testsuite/usbmouse01/init.c +++ b/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 #include #include diff --git a/testsuite/usbserial01/init.c b/testsuite/usbserial01/init.c index 4baca74d..5b62b72e 100644 --- a/testsuite/usbserial01/init.c +++ b/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. diff --git a/testsuite/vlan01/test_main.c b/testsuite/vlan01/test_main.c index 5f4082ee..9450dac2 100644 --- a/testsuite/vlan01/test_main.c +++ b/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. * diff --git a/testsuite/zerocopy01/test_main.c b/testsuite/zerocopy01/test_main.c index 54051259..3e7b7b7b 100644 --- a/testsuite/zerocopy01/test_main.c +++ b/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. * -- cgit v1.2.3