[rtems commit] rtems: Generate <rtems/rtems/config.h>
Sebastian Huber
sebh at rtems.org
Thu Nov 12 07:55:16 UTC 2020
Module: rtems
Branch: master
Commit: da44df31b151daf2bbeb0fcc587af82ec7eaa188
Changeset: http://git.rtems.org/rtems/commit/?id=da44df31b151daf2bbeb0fcc587af82ec7eaa188
Author: Sebastian Huber <sebastian.huber at embedded-brains.de>
Date: Thu May 28 13:48:17 2020 +0200
rtems: Generate <rtems/rtems/config.h>
Change license to BSD-2-Clause according to file histories and
documentation re-licensing agreement.
Update #3899.
Update #3993.
---
cpukit/include/rtems/rtems/config.h | 304 ++++++++++++++++++++++++++++--------
1 file changed, 236 insertions(+), 68 deletions(-)
diff --git a/cpukit/include/rtems/rtems/config.h b/cpukit/include/rtems/rtems/config.h
index bd6b38a..cd1791e 100644
--- a/cpukit/include/rtems/rtems/config.h
+++ b/cpukit/include/rtems/rtems/config.h
@@ -1,152 +1,320 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
/**
* @file
*
- * @ingroup ClassicConfig
+ * @brief This header file provides parts of the application configuration
+ * information API.
+ */
+
+/*
+ * Copyright (C) 2020 embedded brains GmbH (http://www.embedded-brains.de)
+ * Copyright (C) 1989, 2008 On-Line Applications Research Corporation (OAR)
*
- * This include file contains the table of user defined configuration
- * parameters specific for the RTEMS API.
+ * 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 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.
*/
-/* COPYRIGHT (c) 1989-2013.
- * On-Line Applications Research Corporation (OAR).
+/*
+ * This file is part of the RTEMS quality process and was automatically
+ * generated. If you find something that needs to be fixed or
+ * worded better please post a report or patch to an RTEMS mailing list
+ * or raise a bug report:
+ *
+ * https://docs.rtems.org/branches/master/user/support/bugs.html
*
- * 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.
+ * For information on updating and regenerating please refer to:
+ *
+ * https://docs.rtems.org/branches/master/eng/req/howto.html
*/
+/* Generated from spec:/rtems/config/if/header-2 */
+
#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
extern "C" {
#endif
-/**
- * @defgroup ClassicConfig Configuration
- *
- * @ingroup RTEMSAPIClassic
- *
- * This encapsulates functionality related to the application's configuration
- * of the Classic API including the maximum number of each class of objects.
- */
-/**@{*/
+/* Generated from spec:/rtems/config/if/api-table */
/**
- * 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:
+ * @ingroup RTEMSAPIConfig
+ *
+ * @brief This structure contains a summary of the Classic API configuration.
*
- * + 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 member contains the maximum number of Classic API Tasks
+ * configured for this application.
+ *
+ * See #CONFIGURE_MAXIMUM_TASKS.
*/
- uint32_t maximum_tasks;
+ uint32_t maximum_tasks;
/**
- * This field indicates whether Classic API notepads are
- * enabled or disabled.
+ * @brief This member is true, if the Classic API Notepads are enabled,
+ * otherwise it is false.
*/
- bool notepads_enabled;
+ bool notepads_enabled;
/**
- * This field contains the maximum number of Classic API
- * Timers which are configured for this application.
+ * @brief This member contains the maximum number of Classic API Timers
+ * configured for this application.
+ *
+ * See #CONFIGURE_MAXIMUM_TIMERS.
*/
- 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 member contains the maximum number of Classic API Semaphores
+ * configured for this application.
+ *
+ * See #CONFIGURE_MAXIMUM_SEMAPHORES.
*/
- 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 member contains the maximum number of Classic API Message Queues
+ * configured for this application.
+ *
+ * See #CONFIGURE_MAXIMUM_MESSAGE_QUEUES.
*/
- 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 member contains the maximum number of Classic API Partitions
+ * configured for this application.
+ *
+ * See #CONFIGURE_MAXIMUM_PARTITIONS.
*/
- 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 member contains the maximum number of Classic API Regions
+ * configured for this application.
+ *
+ * See #CONFIGURE_MAXIMUM_REGIONS.
*/
- 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 member contains the maximum number of Classic API Dual-Ported
+ * Memories configured for this application.
+ *
+ * See #CONFIGURE_MAXIMUM_PORTS.
*/
- 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 member contains the maximum number of Classic API Rate Monotonic
+ * Periods configured for this application.
+ *
+ * See #CONFIGURE_MAXIMUM_PERIODS.
*/
- 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 member contains the maximum number of Classic API Barriers
+ * configured for this application.
+ *
+ * See #CONFIGURE_MAXIMUM_BARRIERS.
*/
- 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 member contains the number of Classic API Initialization Tasks
+ * configured for this application.
+ *
+ * See #CONFIGURE_RTEMS_INIT_TASKS_TABLE.
*/
- 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 member contains the pointer to Classic API Initialization Tasks
+ * Table of this application.
+ *
+ * See #CONFIGURE_RTEMS_INIT_TASKS_TABLE.
*/
const rtems_initialization_tasks_table *User_initialization_tasks_table;
} rtems_api_configuration_table;
-/**@}*/
+/* Generated from spec:/rtems/config/if/get-api-configuration */
+
+/**
+ * @ingroup RTEMSAPIConfig
+ *
+ * @brief Gets the Classic API Configuration Table of this application.
+ *
+ * @return Returns the pointer to the Classic API Configuration Table of this
+ * application.
+ */
+const rtems_api_configuration_table *
+rtems_configuration_get_rtems_api_configuration( void );
+
+/* Generated from spec:/rtems/config/if/get-maximum-barriers */
+/**
+ * @ingroup RTEMSAPIConfig
+ *
+ * @brief Gets the maximum number of Classic API Barriers configured for this
+ * application.
+ *
+ * See #CONFIGURE_MAXIMUM_BARRIERS.
+ *
+ * @return Returns the maximum number of Classic API Barriers configured for
+ * this application.
+ */
uint32_t rtems_configuration_get_maximum_barriers( void );
+/* Generated from spec:/rtems/config/if/get-maximum-message-queues */
+
+/**
+ * @ingroup RTEMSAPIConfig
+ *
+ * @brief Gets the maximum number of Classic API Message Queues configured for
+ * this application.
+ *
+ * See #CONFIGURE_MAXIMUM_MESSAGE_QUEUES.
+ *
+ * @return Returns the maximum number of Classic API Message Queues configured
+ * for this application.
+ */
uint32_t rtems_configuration_get_maximum_message_queues( void );
+/* Generated from spec:/rtems/config/if/get-maximum-partitions */
+
+/**
+ * @ingroup RTEMSAPIConfig
+ *
+ * @brief Gets the maximum number of Classic API Partitions configured for this
+ * application.
+ *
+ * See #CONFIGURE_MAXIMUM_PARTITIONS.
+ *
+ * @return Returns the maximum number of Classic API Partitions configured for
+ * this application.
+ */
uint32_t rtems_configuration_get_maximum_partitions( void );
+/* Generated from spec:/rtems/config/if/get-maximum-periods */
+
+/**
+ * @ingroup RTEMSAPIConfig
+ *
+ * @brief Gets the maximum number of Classic API Rate Monotonic Periods
+ * configured for this application.
+ *
+ * See #CONFIGURE_MAXIMUM_PERIODS.
+ *
+ * @return Returns the maximum number of Classic API Rate Monotonic Periods
+ * configured for this application.
+ */
uint32_t rtems_configuration_get_maximum_periods( void );
+/* Generated from spec:/rtems/config/if/get-maximum-ports */
+
+/**
+ * @ingroup RTEMSAPIConfig
+ *
+ * @brief Gets the maximum number of Classic API Dual-Ported Memories
+ * configured for this application.
+ *
+ * See #CONFIGURE_MAXIMUM_PORTS.
+ *
+ * @return Returns the maximum number of Classic API Dual-Ported Memories
+ * configured for this application.
+ */
uint32_t rtems_configuration_get_maximum_ports( void );
+/* Generated from spec:/rtems/config/if/get-maximum-regions */
+
+/**
+ * @ingroup RTEMSAPIConfig
+ *
+ * @brief Gets the maximum number of Classic API Regions configured for this
+ * application.
+ *
+ * See #CONFIGURE_MAXIMUM_REGIONS.
+ *
+ * @return Returns the maximum number of Classic API Regions configured for
+ * this application.
+ */
uint32_t rtems_configuration_get_maximum_regions( void );
+/* Generated from spec:/rtems/config/if/get-maximum-semaphores */
+
+/**
+ * @ingroup RTEMSAPIConfig
+ *
+ * @brief Gets the maximum number of Classic API Semaphores configured for this
+ * application.
+ *
+ * See #CONFIGURE_MAXIMUM_SEMAPHORES.
+ *
+ * @return Returns the maximum number of Classic API Semaphores configured for
+ * this application.
+ */
uint32_t rtems_configuration_get_maximum_semaphores( void );
-uint32_t rtems_configuration_get_maximum_timers( void );
+/* Generated from spec:/rtems/config/if/get-maximum-tasks */
+/**
+ * @ingroup RTEMSAPIConfig
+ *
+ * @brief Gets the maximum number of Classic API Tasks configured for this
+ * application.
+ *
+ * See #CONFIGURE_MAXIMUM_TASKS.
+ *
+ * @return Returns the maximum number of Classic API Tasks configured for this
+ * application.
+ */
uint32_t rtems_configuration_get_maximum_tasks( void );
-const rtems_api_configuration_table *
-rtems_configuration_get_rtems_api_configuration( void );
+/* Generated from spec:/rtems/config/if/get-maximum-timers */
+
+/**
+ * @ingroup RTEMSAPIConfig
+ *
+ * @brief Gets the maximum number of Classic API Timers configured for this
+ * application.
+ *
+ * See #CONFIGURE_MAXIMUM_TIMERS.
+ *
+ * @return Returns the maximum number of Classic API Timers 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 */
More information about the vc
mailing list