Generate <rtems/rtems/attr.h>

1 files changed, 160 insertions, 94 deletions

diff --git a/cpukit/include/rtems/rtems/attr.h b/cpukit/include/rtems/rtems/attr.h
index 74ed96fdba..df915bfc74 100644
--- a/cpukit/include/rtems/rtems/attr.h
+++ b/cpukit/include/rtems/rtems/attr.h
@@ -1,188 +1,254 @@
+/* SPDX-License-Identifier: BSD-2-Clause */
+
 /**
  * @file
  *
- * @ingroup ClassicAttributes
+ * @ingroup RTEMSAPIClassicAttr
  *
- * This include file contains all information about the Object Attributes
- * Handler.
+ * @brief This header file defines attributes provided by the API.
  */
 
-/* COPYRIGHT (c) 1989-2008.
- * On-Line Applications Research Corporation (OAR).
+/*
+ * Copyright (C) 2014, 2020 embedded brains GmbH (http://www.embedded-brains.de)
+ * Copyright (C) 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 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
  *
- * 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_ATTR_H
 #define _RTEMS_RTEMS_ATTR_H
 
-#include <rtems/score/basedefs.h>
+#include <stdint.h>
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
 /**
- *  @defgroup ClassicAttributes Attributes
+ * @defgroup RTEMSAPIClassicAttr Directive Attributes
  *
- *  @ingroup RTEMSAPIClassic
+ * @ingroup RTEMSAPIClassic
  *
- *  This encapsulates functionality which defines and manages the
- *  set of Classic API object attributes.
+ * @brief This group contains the Classic API directive attributes.
  */
-/**@{*/
 
 /**
- *  This defines the type used to contain Classic API attributes.  These
- *  are primarily used when creating objects.
+ * @ingroup RTEMSAPIClassicAttr
+ *
+ * @brief This attribute constant indicates that the task was created by the
+ *   application using normal Classic API methods.
  */
-typedef uint32_t   rtems_attribute;
-
-/** This is the default value for an attribute set. */
-
-#define RTEMS_DEFAULT_ATTRIBUTES  0x00000000
+#define RTEMS_APPLICATION_TASK 0x00000000
 
 /**
- *  This is the attribute constant to indicate local resource.
+ * @ingroup RTEMSAPIClassicAttr
+ *
+ * @brief This type is used to represent Classic API attributes.
+ *
+ * Attributes are primarily used when creating objects.
  */
-#define RTEMS_LOCAL               0x00000000
+typedef uint32_t rtems_attribute;
 
 /**
- *  This is the attribute constant to indicate global resource.
+ * @ingroup RTEMSAPIClassicAttr
+ *
+ * @brief This attribute constant indicates that the Classic API Barrier
+ *   instance created will use an automatic release protocol.
  */
-#define RTEMS_GLOBAL              0x00000002
+#define RTEMS_BARRIER_AUTOMATIC_RELEASE 0x00000200
 
 /**
- *  This is the attribute constant which reflects that blocking
- *  tasks will be managed using FIFO discipline.
+ * @ingroup RTEMSAPIClassicAttr
+ *
+ * @brief This attribute constant indicates that the Classic API Barrier
+ *   instance created will use the manual release protocol.
  */
-#define RTEMS_FIFO                0x00000000
+#define RTEMS_BARRIER_MANUAL_RELEASE 0x00000000
 
 /**
- *  This is the attribute constant which reflects that blocking
- *  tasks will be managed using task priority discipline.
+ * @ingroup RTEMSAPIClassicAttr
+ *
+ * @brief This attribute constant indicates that the Classic API Semaphore
+ *   instance created will be a proper binary semaphore or mutex.
  */
-#define RTEMS_PRIORITY            0x00000004
-
-/******************** RTEMS Task Specific Attributes *********************/
+#define RTEMS_BINARY_SEMAPHORE 0x00000010
 
 /**
- *  This attribute constant indicates that the task will not use the
- *  floating point hardware.  If the architecture permits it, then
- *  the FPU will be disabled when the task is executing.
+ * @ingroup RTEMSAPIClassicAttr
+ *
+ * @brief This attribute constant indicates that the Classic API Semaphore
+ *   instance created will be a counting semaphore.
  */
-#define RTEMS_NO_FLOATING_POINT   0x00000000
+#define RTEMS_COUNTING_SEMAPHORE 0x00000000
 
 /**
- *  This attribute constant indicates that the task will use the
- *  floating point hardware.  There will be a floating point
- *  context associated with this task.
+ * @ingroup RTEMSAPIClassicAttr
+ *
+ * @brief This is the default value for an attribute set.
  */
-#define RTEMS_FLOATING_POINT      0x00000001
-
-/***************** RTEMS Semaphore Specific Attributes ********************/
+#define RTEMS_DEFAULT_ATTRIBUTES 0x00000000
 
 /**
- *  This is the mask for the attribute bits associated with the
- *  Classic API Semaphore Manager.
+ * @ingroup RTEMSAPIClassicAttr
+ *
+ * @brief This is the attribute constant which reflects that blocking tasks
+ *   will be managed using FIFO discipline.
  */
-#define RTEMS_SEMAPHORE_CLASS         0x00000030
+#define RTEMS_FIFO 0x00000000
 
 /**
- *  This attribute constant indicates that the Classic API Semaphore
- *  instance created will be a counting semaphore.
+ * @ingroup RTEMSAPIClassicAttr
+ *
+ * @brief This attribute constant indicates that the task will use the floating
+ *   point hardware.
+ *
+ * On some architectures, there will be a floating point context associated
+ * with this task.
  */
-#define RTEMS_COUNTING_SEMAPHORE      0x00000000
+#define RTEMS_FLOATING_POINT 0x00000001
 
 /**
- *  This attribute constant indicates that the Classic API Semaphore
- *  instance created will be a proper binary semaphore or mutex.
+ * @ingroup RTEMSAPIClassicAttr
+ *
+ * @brief This is the attribute constant to indicate global resource.
  */
-#define RTEMS_BINARY_SEMAPHORE        0x00000010
+#define RTEMS_GLOBAL 0x00000002
 
 /**
- *  This attribute constant indicates that the Classic API Semaphore
- *  instance created will be a simple binary semaphore.
+ * @ingroup RTEMSAPIClassicAttr
+ *
+ * @brief This attribute constant indicates that the Classic API Semaphore
+ *   instance created will use the Priority Inheritance Protocol.
+ *
+ * The semaphore instance must be a binary semaphore.
  */
-#define RTEMS_SIMPLE_BINARY_SEMAPHORE 0x00000020
+#define RTEMS_INHERIT_PRIORITY 0x00000040
 
 /**
- *  This attribute constant indicates that the Classic API Semaphore
- *  instance created will NOT use the Priority Inheritance Protocol.
+ * @ingroup RTEMSAPIClassicAttr
+ *
+ * @brief This is the attribute constant to indicate local resource.
  */
-#define RTEMS_NO_INHERIT_PRIORITY     0x00000000
+#define RTEMS_LOCAL 0x00000000
 
 /**
- *  This attribute constant indicates that the Classic API Semaphore
- *  instance created will use the Priority Inheritance Protocol.
+ * @ingroup RTEMSAPIClassicAttr
  *
- *  @note The semaphore instance must be a binary semaphore.
+ * @brief This attribute constant indicates that the Classic API Semaphore
+ *   instance created will use the Multiprocessor Resource Sharing Protocol.
+ *
+ * The semaphore instance must be a binary semaphore.
  */
-#define RTEMS_INHERIT_PRIORITY        0x00000040
+#define RTEMS_MULTIPROCESSOR_RESOURCE_SHARING 0x00000100
 
 /**
- *  This attribute constant indicates that the Classic API Semaphore
- *  instance created will NOT use the Priority Ceiling Protocol.
+ * @ingroup RTEMSAPIClassicAttr
+ *
+ * @brief This attribute constant indicates that the task will not use the
+ *   floating point hardware.
+ *
+ * If the architecture permits it, then the FPU will be disabled when the task
+ * is executing.
  */
-#define RTEMS_NO_PRIORITY_CEILING     0x00000000
+#define RTEMS_NO_FLOATING_POINT 0x00000000
 
 /**
- *  This attribute constant indicates that the Classic API Semaphore
- *  instance created will use the Priority Ceiling Protocol.
+ * @ingroup RTEMSAPIClassicAttr
  *
- *  @note The semaphore instance must be a binary semaphore.
+ * @brief This attribute constant indicates that the Classic API Semaphore
+ *   instance created will not use the Priority Inheritance Protocol.
  */
-#define RTEMS_PRIORITY_CEILING        0x00000080
+#define RTEMS_NO_INHERIT_PRIORITY 0x00000000
 
 /**
- *  This attribute constant indicates that the Classic API Semaphore instance
- *  created will NOT use the Multiprocessor Resource Sharing Protocol.
+ * @ingroup RTEMSAPIClassicAttr
+ *
+ * @brief This attribute constant indicates that the Classic API Semaphore
+ *   instance created will not use the Multiprocessor Resource Sharing
+ *   Protocol.
  */
 #define RTEMS_NO_MULTIPROCESSOR_RESOURCE_SHARING 0x00000000
 
 /**
- *  This attribute constant indicates that the Classic API Semaphore instance
- *  created will use the Multiprocessor Resource Sharing Protocol.
+ * @ingroup RTEMSAPIClassicAttr
  *
- *  @note The semaphore instance must be a binary semaphore.
+ * @brief This attribute constant indicates that the Classic API Semaphore
+ *   instance created will not use the Priority Ceiling Protocol.
  */
-#define RTEMS_MULTIPROCESSOR_RESOURCE_SHARING 0x00000100
-
-/******************** RTEMS Barrier Specific Attributes ********************/
+#define RTEMS_NO_PRIORITY_CEILING 0x00000000
 
 /**
- *  This attribute constant indicates that the Classic API Barrier
- *  instance created will use an automatic release protocol.
+ * @ingroup RTEMSAPIClassicAttr
+ *
+ * @brief This is the attribute constant which reflects that blocking tasks
+ *   will be managed using task priority discipline.
  */
-#define RTEMS_BARRIER_AUTOMATIC_RELEASE 0x00000200
+#define RTEMS_PRIORITY 0x00000004
 
 /**
- *  This attribute constant indicates that the Classic API Barrier
- *  instance created will use the manual release protocol.
+ * @ingroup RTEMSAPIClassicAttr
+ *
+ * @brief This attribute constant indicates that the Classic API Semaphore
+ *   instance created will use the Priority Ceiling Protocol.
+ *
+ * The semaphore instance must be a binary semaphore.
  */
-#define RTEMS_BARRIER_MANUAL_RELEASE    0x00000000
-
-/**************** RTEMS Internal Task Specific Attributes ****************/
+#define RTEMS_PRIORITY_CEILING 0x00000080
 
 /**
- *  This attribute constant indicates that the task was created
- *  by the application using normal Classic API methods.
+ * @ingroup RTEMSAPIClassicAttr
+ *
+ * @brief This is the mask for the attribute bits associated with the Classic
+ *   API Semaphore Manager.
  */
-#define RTEMS_APPLICATION_TASK        0x00000000
+#define RTEMS_SEMAPHORE_CLASS 0x00000030
 
 /**
- *  This attribute constant indicates that the task was created
- *  by RTEMS as a support task.
+ * @ingroup RTEMSAPIClassicAttr
+ *
+ * @brief This attribute constant indicates that the Classic API Semaphore
+ *   instance created will be a simple binary semaphore.
  */
-#define RTEMS_SYSTEM_TASK             0x00008000
+#define RTEMS_SIMPLE_BINARY_SEMAPHORE 0x00000020
 
-/**@}*/
+/**
+ * @ingroup RTEMSAPIClassicAttr
+ *
+ * @brief This attribute constant indicates that the task was created by RTEMS
+ *   as a support task.
+ */
+#define RTEMS_SYSTEM_TASK 0x00008000
 
 #ifdef __cplusplus
 }
 #endif
 
-#endif
-/* end of include file */
+#endif /* _RTEMS_RTEMS_ATTR_H */