Generate <rtems/rtems/config.h>

1 files changed, 142 insertions, 69 deletions

diff --git a/cpukit/include/rtems/rtems/config.h b/cpukit/include/rtems/rtems/config.h
index bd6b38a532..590f87c3fa 100644
--- a/cpukit/include/rtems/rtems/config.h
+++ b/cpukit/include/rtems/rtems/config.h
@@ -1,24 +1,54 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
 /**
  * @file
  *
- * @ingroup ClassicConfig
+ * @ingroup RTEMSAPIConfig
  *
- * This include file contains the table of user defined configuration
- * parameters specific for the RTEMS API.
+ * @brief This header file defines parts of the application configuration
+ *   information API.
  */
 
-/* COPYRIGHT (c) 1989-2013.
- * On-Line Applications Research Corporation (OAR).
+/*
+ * Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+ * Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
+ *
+ * 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.
  *
- * The license and distribution terms for this file may be
- * found in the file LICENSE in this distribution or at
- * http://www.rtems.org/license/LICENSE.
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT OWNER 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.
+ */
+
+/*
+ * This file was automatically generated.  Do not edit it manually.
+ * Please have a look at
+ *
+ * https://docs.rtems.org/branches/master/eng/req/howto.html
+ *
+ * for information how to maintain and re-generate this file.
  */
 
 #ifndef _RTEMS_RTEMS_CONFIG_H
 #define _RTEMS_RTEMS_CONFIG_H
 
-#include <rtems/rtems/types.h>
+#include <stdbool.h>
+#include <stdint.h>
 #include <rtems/rtems/tasks.h>
 
 #ifdef __cplusplus
@@ -26,127 +56,170 @@ extern "C" {
 #endif
 
 /**
- *  @defgroup ClassicConfig Configuration
+ * @ingroup RTEMSAPIConfig
  *
- *  @ingroup RTEMSAPIClassic
+ * @brief This structure contains a summary of the Classic API configuration.
  *
- *  This encapsulates functionality related to the application's configuration
- *  of the Classic API including the maximum number of each class of objects.
- */
-/**@{*/
-
-/**
- *  The following records define the Configuration Table.  The
- *  information contained in this table is required in all
- *  RTEMS systems, whether single or multiprocessor.  This
- *  table primarily defines the following:
- *
- *     + required number of each object type
+ * Use rtems_configuration_get_rtems_api_configuration() to get the
+ * configuration table.
  */
 typedef struct {
   /**
-   * This field contains the maximum number of Classic API
-   * Tasks which are configured for this application.
+   * @brief This field contains the maximum number of Classic API Tasks which are
+   *   configured for this application.
    */
-  uint32_t                    maximum_tasks;
+  uint32_t maximum_tasks;
 
   /**
-   * This field indicates whether Classic API notepads are
-   * enabled or disabled.
+   * @brief This field indicates if Classic API Notepads are enabled or disabled
+   *   for this application.
    */
-  bool                        notepads_enabled;
+  bool notepads_enabled;
 
   /**
-   * This field contains the maximum number of Classic API
-   * Timers which are configured for this application.
+   * @brief This field contains the maximum number of Classic API Timers which
+   *   are configured for this application.
    */
-  uint32_t                    maximum_timers;
+  uint32_t maximum_timers;
 
   /**
-   * This field contains the maximum number of Classic API
-   * Semaphores which are configured for this application.
+   * @brief This field contains the maximum number of Classic API Semaphores
+   *   which are configured for this application.
    */
-  uint32_t                    maximum_semaphores;
+  uint32_t maximum_semaphores;
 
   /**
-   * This field contains the maximum number of Classic API
-   * Message Queues which are configured for this application.
+   * @brief This field contains the maximum number of Classic API Message Queues
+   *   which are configured for this application.
    */
-  uint32_t                    maximum_message_queues;
+  uint32_t maximum_message_queues;
 
   /**
-   * This field contains the maximum number of Classic API
-   * Partitions which are configured for this application.
+   * @brief This field contains the maximum number of Classic API Partitions
+   *   which are configured for this application.
    */
-  uint32_t                    maximum_partitions;
+  uint32_t maximum_partitions;
 
   /**
-   * This field contains the maximum number of Classic API
-   * Regions which are configured for this application.
+   * @brief This field contains the maximum number of Classic API Regions which
+   *   are configured for this application.
    */
-  uint32_t                    maximum_regions;
+  uint32_t maximum_regions;
 
   /**
-   * This field contains the maximum number of Classic API
-   * Dual Ported Memory Areas which are configured for this
-   * application.
+   * @brief This field contains the maximum number of Classic API Dual Ported
+   *   Memory Areas which are configured for this application.
    */
-  uint32_t                    maximum_ports;
+  uint32_t maximum_ports;
 
   /**
-   * This field contains the maximum number of Classic API
-   * Rate Monotonic Periods which are configured for this
-   * application.
+   * @brief This field contains the maximum number of Classic API Rate Monotonic
+   *   Periods which are configured for this application.
    */
-  uint32_t                    maximum_periods;
+  uint32_t maximum_periods;
 
   /**
-   * This field contains the maximum number of Classic API
-   * Barriers which are configured for this application.
+   * @brief This field contains the maximum number of Classic API Barriers which
+   *   are configured for this application.
    */
-  uint32_t                    maximum_barriers;
+  uint32_t maximum_barriers;
 
   /**
-   * This field contains the number of Classic API Initialization
-   * Tasks which are configured for this application.
+   * @brief This field contains the number of Classic API Initialization Tasks
+   *   which are configured for this application.
    */
-  uint32_t                    number_of_initialization_tasks;
+  uint32_t number_of_initialization_tasks;
 
   /**
-   * This field is the set of Classic API Initialization
-   * Tasks which are configured for this application.
+   * @brief This field contains the pointer to Classic API Initialization Tasks
+   *   Table of this application.
    */
   const rtems_initialization_tasks_table *User_initialization_tasks_table;
 } rtems_api_configuration_table;
 
-/**@}*/
+/**
+ * @ingroup RTEMSAPIConfig
+ *
+ * @brief Returns the pointer to the Classic API Configuration Table of this
+ *   application.
+ */
+const rtems_api_configuration_table *
+rtems_configuration_get_rtems_api_configuration( void );
 
+/**
+ * @ingroup RTEMSAPIConfig
+ *
+ * @brief Returns the maximum number of Classic API Barriers which are
+ *   configured for this application.
+ */
 uint32_t rtems_configuration_get_maximum_barriers( void );
 
+/**
+ * @ingroup RTEMSAPIConfig
+ *
+ * @brief Returns the maximum number of Classic API Message Queues which are
+ *   configured for this application.
+ */
 uint32_t rtems_configuration_get_maximum_message_queues( void );
 
+/**
+ * @ingroup RTEMSAPIConfig
+ *
+ * @brief Returns the maximum number of Classic API Partitions which are
+ *   configured for this application.
+ */
 uint32_t rtems_configuration_get_maximum_partitions( void );
 
+/**
+ * @ingroup RTEMSAPIConfig
+ *
+ * @brief Returns the maximum number of Classic API Rate Monotonic Periods
+ *   which are configured for this application.
+ */
 uint32_t rtems_configuration_get_maximum_periods( void );
 
+/**
+ * @ingroup RTEMSAPIConfig
+ *
+ * @brief Returns the maximum number of Classic API Dual Ported Memory Areas
+ *   which are configured for this application.
+ */
 uint32_t rtems_configuration_get_maximum_ports( void );
 
+/**
+ * @ingroup RTEMSAPIConfig
+ *
+ * @brief Returns the maximum number of Classic API Regions which are
+ *   configured for this application.
+ */
 uint32_t rtems_configuration_get_maximum_regions( void );
 
+/**
+ * @ingroup RTEMSAPIConfig
+ *
+ * @brief Returns the maximum number of Classic API Semaphores which are
+ *   configured for this application.
+ */
 uint32_t rtems_configuration_get_maximum_semaphores( void );
 
-uint32_t rtems_configuration_get_maximum_timers( void );
-
+/**
+ * @ingroup RTEMSAPIConfig
+ *
+ * @brief Returns the maximum number of Classic API Tasks which are configured
+ *   for this application.
+ */
 uint32_t rtems_configuration_get_maximum_tasks( void );
 
-const rtems_api_configuration_table *
-rtems_configuration_get_rtems_api_configuration( void );
+/**
+ * @ingroup RTEMSAPIConfig
+ *
+ * @brief Returns the maximum number of Classic API Timers which are configured
+ *   for this application.
+ */
+uint32_t rtems_configuration_get_maximum_timers( void );
 
 #ifdef __cplusplus
 }
 #endif
 
-/**@}*/
-
-#endif
-/* end of include file */
+#endif /* _RTEMS_RTEMS_CONFIG_H */