Generate <rtems/rtems/options.h>

1 files changed, 71 insertions, 36 deletions

diff --git a/cpukit/include/rtems/rtems/options.h b/cpukit/include/rtems/rtems/options.h
index e50c4d1429..6c1dc20a38 100644
--- a/cpukit/include/rtems/rtems/options.h
+++ b/cpukit/include/rtems/rtems/options.h
@@ -1,80 +1,115 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
 /**
  * @file
  *
- * @ingroup ClassicOptions
+ * @ingroup RTEMSAPIClassicOptions
+ *
+ * @brief This header file defines options provided by the API.
+ */
+
+/*
+ * 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.
  *
- * This include file contains information which defines the
- * options available on many directives.
+ * 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-2008.
- * On-Line Applications Research Corporation (OAR).
+/*
+ * This file was automatically generated.  Do not edit it manually.
+ * Please have a look at
  *
- * 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.
+ * https://docs.rtems.org/branches/master/eng/req/howto.html
+ *
+ * for information how to maintain and re-generate this file.
  */
 
 #ifndef _RTEMS_RTEMS_OPTIONS_H
 #define _RTEMS_RTEMS_OPTIONS_H
 
-#include <rtems/score/basedefs.h>
+#include <stdint.h>
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
 /**
- * @defgroup ClassicOptions Classic API Options
+ * @defgroup RTEMSAPIClassicOptions Directive Options
  *
  * @ingroup RTEMSAPIClassic
  *
- * This encapsulates functionality related to the options argument
- * to Classic API blocking operations. The primary option is whether
- * or not a task is willing to wait for the operation to complete.
+ * @brief This group contains the Classic API directive options.
  */
-/**@{*/
 
 /**
- *  The following type defines the control block used to manage
- *  option sets.
+ * @ingroup RTEMSAPIClassicOptions
+ *
+ * @brief This option constant is the default option set.
  */
-typedef uint32_t   rtems_option;
+#define RTEMS_DEFAULT_OPTIONS 0x00000000
 
 /**
- *  The following constants define the individual options which may
- *  be used to compose an option set.
+ * @ingroup RTEMSAPIClassicOptions
+ *
+ * @brief This option constant indicates that the task wishes to wait until all
+ *   events of interest are available.
  */
-#define RTEMS_DEFAULT_OPTIONS   0x00000000
+#define RTEMS_EVENT_ALL 0x00000000
 
 /**
- *  This option constants indicates that the task is to wait on resource.
+ * @ingroup RTEMSAPIClassicOptions
+ *
+ * @brief This option constant indicates that the task wishes to wait until any
+ *   events of interest are available.
  */
-#define RTEMS_WAIT      0x00000000
+#define RTEMS_EVENT_ANY 0x00000002
+
 /**
- *  This option constants indicates that the task is to not wait on
- *  the resource.  If it is not available, return immediately with
- *  a status to indicate unsatisfied.
+ * @ingroup RTEMSAPIClassicOptions
+ *
+ * @brief This option constant indicates that the task is to not wait on the
+ *   resource.
+ *
+ * If the resource is not available, then directives shall return immediately
+ * with a status to indicate unsatisfied.
  */
-#define RTEMS_NO_WAIT   0x00000001
+#define RTEMS_NO_WAIT 0x00000001
 
 /**
- *  This option constants indicates that the task wishes to wait until
- *  all events of interest are available.
+ * @ingroup RTEMSAPIClassicOptions
+ *
+ * @brief This type defines the control block used to manage option sets.
  */
-#define RTEMS_EVENT_ALL 0x00000000
+typedef uint32_t rtems_option;
 
 /**
- *  This option constants indicates that the task wishes to wait until
- *  ANY events of interest are available.
+ * @ingroup RTEMSAPIClassicOptions
+ *
+ * @brief This option constant indicates that the task is to wait on resource.
  */
-#define RTEMS_EVENT_ANY 0x00000002
-
-/**@}*/
+#define RTEMS_WAIT 0x00000000
 
 #ifdef __cplusplus
 }
 #endif
 
-#endif
-/* end of include file */
+#endif /* _RTEMS_RTEMS_OPTIONS_H */