cpukit: deprecate notepads

Deprecate Classic API Notepads. Mark task_set/get_note() with
the deprecated attribute, and also mark the notepads field.

Replace disable with enable option for notepads in confdefs.h,
and make notepads disabled by default. The previous option
CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS is now unused and
will emit a compile-time warning. A new option
CONFIGURE_ENABLE_CLASSIC_API_NOTEPADS is available to turn
on notepads, but it also will emit a compile-time warning
to indicate that notepads are deprecated.

Closes #2265

3 files changed, 18 insertions, 7 deletions

diff --git a/cpukit/libmisc/monitor/monitor.h b/cpukit/libmisc/monitor/monitor.h
index 6a85d602eb..799df353a7 100644
--- a/cpukit/libmisc/monitor/monitor.h
+++ b/cpukit/libmisc/monitor/monitor.h
@@ -104,7 +104,8 @@ typedef struct {
     rtems_event_set            events;
     rtems_mode                 modes;
     rtems_attribute            attributes;
-    uint32_t                   notepad[RTEMS_NUMBER_NOTEPADS];
+    uint32_t                   notepad[RTEMS_NUMBER_NOTEPADS]
+                                            RTEMS_COMPILER_DEPRECATED_ATTRIBUTE;
     rtems_id                   wait_id;
     uint32_t                   wait_args;
     uint32_t                   ticks;
diff --git a/cpukit/rtems/include/rtems/rtems/tasks.h b/cpukit/rtems/include/rtems/rtems/tasks.h
index e0fa27e16f..237ec19093 100644
--- a/cpukit/rtems/include/rtems/rtems/tasks.h
+++ b/cpukit/rtems/include/rtems/rtems/tasks.h
@@ -271,6 +271,8 @@ rtems_status_code rtems_task_delete(
 /**
  * @brief RTEMS Get Task Node
  *
+ * @deprecated Notepads are deprecated and will be removed.
+ *
  * This routine implements the rtems_task_get_note directive. The
  * value of the indicated notepad for the task associated with ID
  * is returned in note.
@@ -285,11 +287,13 @@ rtems_status_code rtems_task_get_note(
   rtems_id    id,
   uint32_t    notepad,
   uint32_t   *note
-);
+) RTEMS_COMPILER_DEPRECATED_ATTRIBUTE;
 
 /**
  * @brief RTEMS Set Task Note
  *
+ * @deprecated Notepads are deprecated and will be removed.
+ *
  * This routine implements the rtems_task_set_note directive. The
  * value of the indicated notepad for the task associated with ID
  * is returned in note.
@@ -306,7 +310,7 @@ rtems_status_code rtems_task_set_note(
   rtems_id   id,
   uint32_t   notepad,
   uint32_t   note
-);
+) RTEMS_COMPILER_DEPRECATED_ATTRIBUTE;
 
 /**
  * @brief RTEMS Task Mode
@@ -663,10 +667,12 @@ typedef struct {
 
   /**
    *  This field contains the notepads for this task.
+   * 
+   *  @deprecated Notepads are deprecated and will be removed.
    *
    *  @note MUST BE LAST ENTRY.
    */
-  uint32_t                 Notepads[ RTEMS_ZERO_LENGTH_ARRAY ];
+  uint32_t Notepads[ RTEMS_ZERO_LENGTH_ARRAY ] RTEMS_COMPILER_DEPRECATED_ATTRIBUTE;
 }  RTEMS_API_Control;
 
 /**
diff --git a/cpukit/sapi/include/confdefs.h b/cpukit/sapi/include/confdefs.h
index 7d9e3b9e08..0bebb4ed0d 100644
--- a/cpukit/sapi/include/confdefs.h
+++ b/cpukit/sapi/include/confdefs.h
@@ -1810,7 +1810,11 @@ const rtems_libio_helper rtems_fs_init_helper =
   #define CONFIGURE_TASKS \
     (CONFIGURE_MAXIMUM_TASKS + CONFIGURE_LIBBLOCK_TASKS)
 
-  #ifndef CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS
+  #if defined(CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS)
+    #warning "CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS is deprecated and will be removed."
+  #endif
+  #if defined(CONFIGURE_ENABLE_CLASSIC_API_NOTEPADS)
+    #warning "CONFIGURE_ENABLE_CLASSIC_API_NOTEPADS is deprecated and will be removed."
     #define CONFIGURE_NOTEPADS_ENABLED           TRUE
   #else
     #define CONFIGURE_NOTEPADS_ENABLED           FALSE
@@ -2613,8 +2617,8 @@ const rtems_libio_helper rtems_fs_init_helper =
       #endif
     } Scheduler;
     RTEMS_API_Control API_RTEMS;
-    #ifndef CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS
-      uint32_t Notepads[ RTEMS_NUMBER_NOTEPADS ];
+    #if defined(CONFIGURE_ENABLE_CLASSIC_API_NOTEPADS)
+      uint32_t Notepads[ RTEMS_NUMBER_NOTEPADS ] RTEMS_COMPILER_DEPRECATED_ATTRIBUTE;
     #endif
     #ifdef RTEMS_POSIX_API
       POSIX_API_Control API_POSIX;