object.h

Go to the documentation of this file.

/* COPYRIGHT (c) 1989-2013.
 * On-Line Applications Research Corporation (OAR).
 *
 * 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.
 */

#ifndef _RTEMS_RTEMS_OBJECT_H
#define _RTEMS_RTEMS_OBJECT_H

#include <stdint.h>
#include <rtems/score/object.h>
#include <rtems/rtems/status.h>
#include <rtems/rtems/types.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef struct {
  rtems_id  minimum_id;
  rtems_id  maximum_id;
  uint32_t  maximum;
  bool      auto_extend;
  uint32_t  unallocated;
} rtems_object_api_class_information;

#define rtems_build_id( _api, _class, _node, _index ) \
  _Objects_Build_id( _api, _class, _node, _index )

#define rtems_build_name( _C1, _C2, _C3, _C4 ) \
  _Objects_Build_name( _C1, _C2, _C3, _C4 )

rtems_status_code rtems_object_get_classic_name(
  rtems_id      id,
  rtems_name   *name
);

char *rtems_object_get_name(
  rtems_id       id,
  size_t         length,
  char          *name
);

rtems_status_code rtems_object_set_name(
  rtems_id       id,
  const char    *name
);

#define rtems_object_id_get_api( _id ) \
  _Objects_Get_API( _id )

#define rtems_object_id_get_class( _id ) \
  _Objects_Get_class( _id )

#define rtems_object_id_get_node( _id ) \
  _Objects_Get_node( _id )

#define rtems_object_id_get_index( _id ) \
  _Objects_Get_index( _id )

#define rtems_object_id_api_minimum() \
  OBJECTS_INTERNAL_API

#define rtems_object_id_api_maximum() \
  OBJECTS_APIS_LAST

int rtems_object_api_minimum_class(
  int api
);

int rtems_object_api_maximum_class(
  int api
);


int rtems_object_id_api_maximum_class(
  int api
);

const char *rtems_object_get_api_name(
  int api
);

const char *rtems_object_get_api_class_name(
  int the_api,
  int the_class
);

rtems_status_code rtems_object_get_class_information(
  int                                 the_api,
  int                                 the_class,
  rtems_object_api_class_information *info
);

RTEMS_INLINE_ROUTINE uint16_t rtems_object_get_local_node( void )
{
  return _Objects_Local_node;
}

#ifdef __cplusplus
}
#endif

#endif
/* end of include file */