[RTEMS Project] #3070: Add rtems_scheduler_ident_by_processor_set()

[RTEMS trac]

#3070: Add rtems_scheduler_ident_by_processor_set()
-----------------------------+------------------------------
 Reporter:  Sebastian Huber  |       Owner:  Sebastian Huber
     Type:  enhancement      |      Status:  assigned
 Priority:  normal           |   Milestone:  4.12.0
Component:  SMP              |     Version:  4.11
 Severity:  normal           |  Resolution:
 Keywords:                   |
-----------------------------+------------------------------
Description changed by Sebastian Huber:

Old description:

> {{{
> /**
>  * @brief Gets the set of processors owned by the specified scheduler
> instance.
>  *
>  * @param[in] scheduler_id Identifier of the scheduler instance.
>  * @param[in] cpusetsize Size of the specified processor set buffer in
>  * bytes.  This value must be positive.
>  * @param[out] cpuset The processor set owned by the scheduler.  A set
> bit in
>  * the processor set means that this processor is owned by the scheduler
> and a
>  * cleared bit means the opposite.
>  *
>  * @retval RTEMS_SUCCESSFUL Successful operation.
>  * @retval RTEMS_INVALID_ADDRESS The @a cpuset parameter is @c NULL.
>  * @retval RTEMS_INVALID_ID Invalid scheduler instance identifier.
>  * @retval RTEMS_INVALID_NUMBER The processor set buffer is too small for
> the
>  * set of processors owned by the scheduler.
>  */
> rtems_status_code rtems_scheduler_get_processor_set(
>   rtems_id   scheduler_id,
>   size_t     cpusetsize,
>   cpu_set_t *cpuset
> );
> }}}

New description:

 {{{
 /**
  * @brief Identifies a scheduler by a processor set.
  *
  * The scheduler is selected according to the highest numbered online
 processor
  * in the specified processor set.
  *
  * @param[in] cpusetsize Size of the specified processor set buffer in
  *   bytes.  This value must be positive.
  * @param[out] cpuset The processor set to identify the scheduler.
  * @param[out] id The scheduler identifier associated with the processor
 set.
  *
  * @retval RTEMS_SUCCESSFUL Successful operation.
  * @retval RTEMS_INVALID_ADDRESS The @a id parameter is @c NULL.
  * @retval RTEMS_INVALID_SIZE Invalid processor set size.
  * @retval RTEMS_INVALID_NAME The processor set contains no online
 processor.
  * @retval RTEMS_INCORRECT_STATE The processor set is valid, however, the
  *   highest numbered online processor in the specified processor set is
 not
  *   owned by a scheduler.
  */
 rtems_status_code rtems_scheduler_ident_by_processor_set(
   size_t     cpusetsize,
   cpu_set_t *cpuset,
   rtems_id  *id
 );
 }}}

--

--
Ticket URL: <http://devel.rtems.org/ticket/3070#comment:1>
RTEMS Project <http://www.rtems.org/>
RTEMS Project