Changeset 3ac68119 in rtems


Ignore:
Timestamp:
Mar 6, 2015, 5:41:49 PM (4 years ago)
Author:
Gedare Bloom <gedare@…>
Branches:
4.11, master
Children:
23e43f6
Parents:
b05549fc
git-author:
Gedare Bloom <gedare@…> (03/06/15 17:41:49)
git-committer:
Gedare Bloom <gedare@…> (03/10/15 16:53:07)
Message:

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

Files:
13 edited

Legend:

Unmodified
Added
Removed
  • c/src/librtems++/include/rtems++/rtemsTask.h

    rb05549fc r3ac68119  
    128128  // notepad control
    129129  const rtems_status_code get_note(const uint32_t notepad,
    130                                    uint32_t& note);
     130                                   uint32_t& note) RTEMS_COMPILER_DEPRECATED_ATTRIBUTE;
    131131  const rtems_status_code set_note(const uint32_t notepad,
    132                                    const uint32_t note);
     132                                   const uint32_t note) RTEMS_COMPILER_DEPRECATED_ATTRIBUTE;
    133133
    134134  // object id, and name
  • cpukit/libmisc/monitor/monitor.h

    rb05549fc r3ac68119  
    105105    rtems_mode                 modes;
    106106    rtems_attribute            attributes;
    107     uint32_t                   notepad[RTEMS_NUMBER_NOTEPADS];
     107    uint32_t                   notepad[RTEMS_NUMBER_NOTEPADS]
     108                                            RTEMS_COMPILER_DEPRECATED_ATTRIBUTE;
    108109    rtems_id                   wait_id;
    109110    uint32_t                   wait_args;
  • cpukit/rtems/include/rtems/rtems/tasks.h

    rb05549fc r3ac68119  
    272272 * @brief RTEMS Get Task Node
    273273 *
     274 * @deprecated Notepads are deprecated and will be removed.
     275 *
    274276 * This routine implements the rtems_task_get_note directive. The
    275277 * value of the indicated notepad for the task associated with ID
     
    286288  uint32_t    notepad,
    287289  uint32_t   *note
    288 );
     290) RTEMS_COMPILER_DEPRECATED_ATTRIBUTE;
    289291
    290292/**
    291293 * @brief RTEMS Set Task Note
     294 *
     295 * @deprecated Notepads are deprecated and will be removed.
    292296 *
    293297 * This routine implements the rtems_task_set_note directive. The
     
    307311  uint32_t   notepad,
    308312  uint32_t   note
    309 );
     313) RTEMS_COMPILER_DEPRECATED_ATTRIBUTE;
    310314
    311315/**
     
    664668  /**
    665669   *  This field contains the notepads for this task.
     670   *
     671   *  @deprecated Notepads are deprecated and will be removed.
    666672   *
    667673   *  @note MUST BE LAST ENTRY.
    668674   */
    669   uint32_t                 Notepads[ RTEMS_ZERO_LENGTH_ARRAY ];
     675  uint32_t Notepads[ RTEMS_ZERO_LENGTH_ARRAY ] RTEMS_COMPILER_DEPRECATED_ATTRIBUTE;
    670676}  RTEMS_API_Control;
    671677
  • cpukit/sapi/include/confdefs.h

    rb05549fc r3ac68119  
    18111811    (CONFIGURE_MAXIMUM_TASKS + CONFIGURE_LIBBLOCK_TASKS)
    18121812
    1813   #ifndef CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS
     1813  #if defined(CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS)
     1814    #warning "CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS is deprecated and will be removed."
     1815  #endif
     1816  #if defined(CONFIGURE_ENABLE_CLASSIC_API_NOTEPADS)
     1817    #warning "CONFIGURE_ENABLE_CLASSIC_API_NOTEPADS is deprecated and will be removed."
    18141818    #define CONFIGURE_NOTEPADS_ENABLED           TRUE
    18151819  #else
     
    26142618    } Scheduler;
    26152619    RTEMS_API_Control API_RTEMS;
    2616     #ifndef CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS
    2617       uint32_t Notepads[ RTEMS_NUMBER_NOTEPADS ];
     2620    #if defined(CONFIGURE_ENABLE_CLASSIC_API_NOTEPADS)
     2621      uint32_t Notepads[ RTEMS_NUMBER_NOTEPADS ] RTEMS_COMPILER_DEPRECATED_ATTRIBUTE;
    26182622    #endif
    26192623    #ifdef RTEMS_POSIX_API
  • doc/user/conf.t

    rb05549fc r3ac68119  
    596596
    597597@c
    598 @c === CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS ===
    599 @c
    600 @subsection Disable Classic API Notepads
    601 
    602 @findex CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS
    603 
    604 @table @b
    605 @item CONSTANT:
    606 @code{CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS}
    607 
    608 @item DATA TYPE:
    609 Boolean feature macro.
    610 
    611 @item RANGE:
    612 Defined or undefined.
    613 
    614 @item DEFAULT VALUE:
    615 This is not defined by default, and Classic API Notepads are supported.
    616 
    617 @end table
    618 
    619 @subheading DESCRIPTION:
    620 @code{CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS} should be defined if the
    621 user does not want to have support for Classic API Notepads in their
    622 application.
     598@c === CONFIGURE_ENABLE_CLASSIC_API_NOTEPADS ===
     599@c
     600@subsection Enable Classic API Notepads
     601
     602@findex CONFIGURE_ENABLE_CLASSIC_API_NOTEPADS
     603
     604@table @b
     605@item CONSTANT:
     606@code{CONFIGURE_ENABLE_CLASSIC_API_NOTEPADS}
     607
     608@item DATA TYPE:
     609Boolean feature macro.
     610
     611@item RANGE:
     612Defined or undefined.
     613
     614@item DEFAULT VALUE:
     615This is not defined by default, and Classic API Notepads are not supported.
     616
     617@end table
     618
     619@subheading DESCRIPTION:
     620@code{CONFIGURE_ENABLE_CLASSIC_API_NOTEPADS} should be defined if the
     621user wants to have support for Classic API Notepads in their application.
    623622
    624623@subheading NOTES:
     
    626625thirty-two bit integers. This saves sixty-four bytes per task/thread
    627626plus the allocation overhead. Notepads are rarely used in applications
    628 and this can save significant memory in a low RAM system.
     627and this can save significant memory in a low RAM system. Classic API
     628Notepads are deprecated, and this option is expected to be obsolete in
     629the near future.
     630
     631@c
     632@c === CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS ===
     633@c
     634@subsection Disable Classic API Notepads
     635
     636@findex CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS
     637
     638@table @b
     639@item CONSTANT:
     640@code{CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS}
     641
     642@item DATA TYPE:
     643Boolean feature macro.
     644
     645@item RANGE:
     646Defined or undefined.
     647
     648@item DEFAULT VALUE:
     649This is not defined by default, and Classic API Notepads are not supported.
     650
     651@end table
     652
     653@subheading DESCRIPTION:
     654@code{CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS} is deprecated. If users
     655want to have support for Classic API Notepads, they should use
     656@code{CONFIGURE_ENABLE_CLASSIC_API_NOTEPADS}.
     657
     658@subheading NOTES:
     659Disabling Classic API Notepads saves the allocation of sixteen (16)
     660thirty-two bit integers. This saves sixty-four bytes per task/thread
     661plus the allocation overhead. Notepads are rarely used in applications
     662and this can save significant memory in a low RAM system. Classic API
     663Notepads are deprecated, and this option is expected to be obsolete in
     664the near future.
    629665
    630666@c
  • doc/user/task.t

    rb05549fc r3ac68119  
    646646directive allows the user to obtain the note
    647647contained in any one of the sixteen notepads of a specified task.
     648Notepads are deprecated and will be removed.
    648649
    649650@subsection Task Deletion
     
    15161517
    15171518@subheading NOTES:
     1519This directive is deprecated and will be removed.
     1520
    15181521This directive will not cause the running task to be preempted.
    15191522
     
    15681571
    15691572@subheading DESCRIPTION:
     1573This directive is deprecated and will be removed.
     1574
    15701575This directive sets the notepad entry for the task specified by
    15711576id to the value note.
  • doc/user/userext.t

    rb05549fc r3ac68119  
    138138to utilize the notepad locations associated with each task
    139139although this may conflict with application usage of those
    140 particular notepads.
     140particular notepads. However, notepads are deprecated and will
     141be removed.
    141142
    142143The TCB extension is an array of pointers in the TCB. The
  • testsuites/libtests/rtems++/System.h

    rb05549fc r3ac68119  
    124124#define CONFIGURE_TICKS_PER_TIMESLICE       100
    125125
     126#define CONFIGURE_ENABLE_CLASSIC_API_NOTEPADS
    126127#define CONFIGURE_INITIAL_EXTENSIONS RTEMS_TEST_INITIAL_EXTENSION
    127128
  • testsuites/mptests/mp02/system.h

    rb05549fc r3ac68119  
    3131#define CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER
    3232
     33#define CONFIGURE_ENABLE_CLASSIC_API_NOTEPADS
     34
    3335#define CONFIGURE_MAXIMUM_TASKS               2
    3436
  • testsuites/sptests/sp07/system.h

    rb05549fc r3ac68119  
    6565#define CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER
    6666
     67#define CONFIGURE_ENABLE_CLASSIC_API_NOTEPADS
     68
    6769#define CONFIGURE_MAXIMUM_USER_EXTENSIONS     2
    6870#define CONFIGURE_TICKS_PER_TIMESLICE       100
  • testsuites/sptests/spnotepad01/init.c

    rb05549fc r3ac68119  
    5454#define CONFIGURE_APPLICATION_DOES_NOT_NEED_CLOCK_DRIVER
    5555
    56 #define CONFIGURE_DISABLE_CLASSIC_API_NOTEPADS
    5756#define CONFIGURE_MAXIMUM_TASKS         1
    5857#define CONFIGURE_INITIAL_EXTENSIONS RTEMS_TEST_INITIAL_EXTENSION
  • testsuites/sptests/sptask_err04/system.h

    rb05549fc r3ac68119  
    3030#define CONFIGURE_APPLICATION_NEEDS_CLOCK_DRIVER
    3131
     32#define CONFIGURE_ENABLE_CLASSIC_API_NOTEPADS
     33
    3234#define CONFIGURE_MAXIMUM_TASKS 2
    3335
  • testsuites/tmtests/tm08/system.h

    rb05549fc r3ac68119  
    2828#define CONFIGURE_APPLICATION_NEEDS_TIMER_DRIVER
    2929
     30#define CONFIGURE_ENABLE_CLASSIC_API_NOTEPADS
     31
    3032#define CONFIGURE_MAXIMUM_TASKS              3
    3133#define CONFIGURE_TICKS_PER_TIMESLICE        0
Note: See TracChangeset for help on using the changeset viewer.