object.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */

 
/*
 * Copyright (C) 2020, 2021 embedded brains GmbH & Co. KG
 * Copyright (C) 1988, 2009 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 is part of the RTEMS quality process and was automatically
 * generated.  If you find something that needs to be fixed or
 * worded better please post a report or patch to an RTEMS mailing list
 * or raise a bug report:
 *
 * https://www.rtems.org/bugs.html
 *
 * For information on updating and regenerating please refer to the How-To
 * section in the Software Requirements Engineering chapter of the
 * RTEMS Software Engineering manual.  The manual is provided as a part of
 * a release.  For development sources please refer to the online
 * documentation at:
 *
 * https://docs.rtems.org
 */
 
/* Generated from spec:/rtems/object/if/header */
 
#ifndef _RTEMS_RTEMS_OBJECT_H
#define _RTEMS_RTEMS_OBJECT_H
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <rtems/rtems/status.h>
#include <rtems/rtems/types.h>
#include <rtems/score/object.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* Generated from spec:/rtems/object/if/group */

 
/* Generated from spec:/rtems/object/if/api-class-information */

typedef struct {
  rtems_id minimum_id;

  rtems_id maximum_id;

  uint32_t maximum;

  bool auto_extend;

  uint32_t unallocated;
} rtems_object_api_class_information;
 
/* Generated from spec:/rtems/object/if/id-final */

#define RTEMS_OBJECT_ID_FINAL OBJECTS_ID_FINAL
 
/* Generated from spec:/rtems/object/if/id-final-index */

#define RTEMS_OBJECT_ID_FINAL_INDEX OBJECTS_ID_FINAL_INDEX
 
/* Generated from spec:/rtems/object/if/id-initial */

#define RTEMS_OBJECT_ID_INITIAL( _api, _class, _node ) \
  OBJECTS_ID_INITIAL( _api, _class, _node )
 
/* Generated from spec:/rtems/object/if/id-initial-index */

#define RTEMS_OBJECT_ID_INITIAL_INDEX OBJECTS_ID_INITIAL_INDEX
 
/* Generated from spec:/rtems/object/if/search-all-nodes */

#define RTEMS_SEARCH_ALL_NODES OBJECTS_SEARCH_ALL_NODES
 
/* Generated from spec:/rtems/object/if/search-local-node */

#define RTEMS_SEARCH_LOCAL_NODE OBJECTS_SEARCH_LOCAL_NODE
 
/* Generated from spec:/rtems/object/if/search-other-nodes */

#define RTEMS_SEARCH_OTHER_NODES OBJECTS_SEARCH_OTHER_NODES
 
/* Generated from spec:/rtems/object/if/who-am-i */

#define RTEMS_WHO_AM_I OBJECTS_WHO_AM_I
 
/* Generated from spec:/rtems/object/if/build-id */

rtems_id rtems_build_id(
  uint32_t api,
  uint32_t the_class,
  uint32_t node,
  uint32_t index
);
 
/* Generated from spec:/rtems/object/if/build-id-macro */
#define rtems_build_id( _api, _class, _node, _index ) \
  _Objects_Build_id( _api, _class, _node, _index )
 
/* Generated from spec:/rtems/object/if/build-name */

rtems_name rtems_build_name( char c1, char c2, char c3, char c4 );
 
/* Generated from spec:/rtems/object/if/build-name-macro */
#define rtems_build_name( _c1, _c2, _c3, _c4 ) \
  _Objects_Build_name( _c1, _c2, _c3, _c4 )
 
/* Generated from spec:/rtems/object/if/get-classic-name */

rtems_status_code rtems_object_get_classic_name(
  rtems_id    id,
  rtems_name *name
);
 
/* Generated from spec:/rtems/object/if/get-name */

char *rtems_object_get_name( rtems_id id, size_t length, char *name );
 
/* Generated from spec:/rtems/object/if/set-name */

rtems_status_code rtems_object_set_name( rtems_id id, const char *name );
 
/* Generated from spec:/rtems/object/if/id-get-api */

int rtems_object_id_get_api( rtems_id id );
 
/* Generated from spec:/rtems/object/if/id-get-api-macro */
#define rtems_object_id_get_api( _id ) _Objects_Get_API( _id )
 
/* Generated from spec:/rtems/object/if/id-get-class */

int rtems_object_id_get_class( rtems_id id );
 
/* Generated from spec:/rtems/object/if/id-get-class-macro */
#define rtems_object_id_get_class( _id ) _Objects_Get_class( _id )
 
/* Generated from spec:/rtems/object/if/id-get-node */

int rtems_object_id_get_node( rtems_id id );
 
/* Generated from spec:/rtems/object/if/id-get-node-macro */
#define rtems_object_id_get_node( _id ) _Objects_Get_node( _id )
 
/* Generated from spec:/rtems/object/if/id-get-index */

int rtems_object_id_get_index( rtems_id id );
 
/* Generated from spec:/rtems/object/if/id-get-index-macro */
#define rtems_object_id_get_index( _id ) _Objects_Get_index( _id )
 
/* Generated from spec:/rtems/object/if/id-api-minimum */

int rtems_object_id_api_minimum( void );
 
/* Generated from spec:/rtems/object/if/id-api-minimum-macro */
#define rtems_object_id_api_minimum() OBJECTS_INTERNAL_API
 
/* Generated from spec:/rtems/object/if/id-api-maximum */

int rtems_object_id_api_maximum( void );
 
/* Generated from spec:/rtems/object/if/id-api-maximum-macro */
#define rtems_object_id_api_maximum() OBJECTS_APIS_LAST
 
/* Generated from spec:/rtems/object/if/api-minimum-class */

int rtems_object_api_minimum_class( int api );
 
/* Generated from spec:/rtems/object/if/api-maximum-class */

int rtems_object_api_maximum_class( int api );
 
/* Generated from spec:/rtems/object/if/get-api-name */

const char *rtems_object_get_api_name( int api );
 
/* Generated from spec:/rtems/object/if/get-api-class-name */

const char *rtems_object_get_api_class_name( int the_api, int the_class );
 
/* Generated from spec:/rtems/object/if/get-class-information */

rtems_status_code rtems_object_get_class_information(
  int                                 the_api,
  int                                 the_class,
  rtems_object_api_class_information *info
);
 
/* Generated from spec:/rtems/object/if/get-local-node */

static inline uint16_t rtems_object_get_local_node( void )
{
  return _Objects_Local_node;
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* _RTEMS_RTEMS_OBJECT_H */