path: root/cpukit/include/rtems/extension.h

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

/**
 * @file
 *
 * @brief This header file defines the User Extensions Manager API.
 */

/*
 * Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
 * Copyright (C) 1988, 2008 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/userext/if/header */

#ifndef _RTEMS_EXTENSION_H
#define _RTEMS_EXTENSION_H

#include <rtems/rtems/status.h>
#include <rtems/rtems/types.h>
#include <rtems/score/interr.h>
#include <rtems/score/userextdata.h>

#ifdef __cplusplus
extern "C" {
#endif

/* Generated from spec:/rtems/userext/if/group */

/**
 * @defgroup RTEMSAPIClassicUserext User Extensions Manager
 *
 * @ingroup RTEMSAPIClassic
 *
 * @brief The User Extensions Manager allows the application developer to
 *   augment the executive by allowing them to supply extension routines which
 *   are invoked at critical system events.
 */

/* Generated from spec:/rtems/userext/if/delete */

/**
 * @ingroup RTEMSAPIClassicUserext
 *
 * @brief Deletes the extension set.
 *
 * @param id is the extension set identifier.
 *
 * This directive deletes the extension set specified by ``id``.
 *
 * @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
 *
 * @retval ::RTEMS_INVALID_ID There was no extension set associated with the
 *   identifier specified by ``id``.
 *
 * @par Notes
 * The ESCB for the deleted extension set is reclaimed by RTEMS.
 *
 * @par Constraints
 * @parblock
 * The following constraints apply to this directive:
 *
 * * The directive may be called from within device driver initialization
 *   context.
 *
 * * The directive may be called from within task context.
 *
 * * The directive may obtain and release the object allocator mutex.  This may
 *   cause the calling task to be preempted.
 *
 * * The calling task does not have to be the task that created the object.
 *   Any local task that knows the object identifier can delete the object.
 * @endparblock
 */
rtems_status_code rtems_extension_delete( rtems_id id );

/* Generated from spec:/rtems/userext/if/fatal */

/**
 * @ingroup RTEMSAPIClassicUserext
 *
 * @brief %
 */
typedef User_extensions_fatal_extension rtems_fatal_extension;

/* Generated from spec:/rtems/userext/if/fatal-code */

/**
 * @ingroup RTEMSAPIClassicUserext
 *
 * @brief %
 */
typedef Internal_errors_t rtems_fatal_code;

/* Generated from spec:/rtems/userext/if/fatal-source */

/**
 * @ingroup RTEMSAPIClassicUserext
 *
 * @brief %
 */
typedef Internal_errors_Source rtems_fatal_source;

/* Generated from spec:/rtems/userext/if/ident */

/**
 * @ingroup RTEMSAPIClassicUserext
 *
 * @brief Identifies an extension set by the object name.
 *
 * @param name is the object name to look up.
 *
 * @param[out] id is the pointer to an object identifier variable.  When the
 *   directive call is successful, the object identifier of an object with the
 *   specified name will be stored in this variable.
 *
 * This directive obtains an extension set identifier associated with the
 * extension set name specified in ``name``.
 *
 * @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
 *
 * @retval ::RTEMS_INVALID_ADDRESS The ``id`` parameter was NULL.
 *
 * @retval ::RTEMS_INVALID_NAME The ``name`` parameter was 0.
 *
 * @retval ::RTEMS_INVALID_NAME There was no object with the specified name on
 *   the local node.
 *
 * @par Notes
 * @parblock
 * If the extension set name is not unique, then the extension set identifier
 * will match the first extension set with that name in the search order.
 * However, this extension set identifier is not guaranteed to correspond to
 * the desired extension set.
 *
 * The objects are searched from lowest to the highest index.  Only the local
 * node is searched.
 *
 * The extension set identifier is used with other extension related directives
 * to access the extension set.
 * @endparblock
 *
 * @par Constraints
 * @parblock
 * The following constraints apply to this directive:
 *
 * * The directive may be called from within device driver initialization
 *   context.
 *
 * * The directive will not cause the calling task to be preempted.
 * @endparblock
 */
rtems_status_code rtems_extension_ident( rtems_name name, rtems_id *id );

/* Generated from spec:/rtems/userext/if/table */

/**
 * @ingroup RTEMSAPIClassicUserext
 *
 * @brief %
 */
typedef User_extensions_Table rtems_extensions_table;

/* Generated from spec:/rtems/userext/if/create */

/**
 * @ingroup RTEMSAPIClassicUserext
 *
 * @brief Creates an extension set.
 *
 * @param name is the object name of the extension set.
 *
 * @param extension_table is the table with the extensions to be used by the
 *   extension set.
 *
 * @param[out] id is the pointer to an object identifier variable.  When the
 *   directive call is successful, the identifier of the created extension set
 *   will be stored in this variable.
 *
 * This directive creates an extension set which resides on the local node.
 * The extension set has the user-defined object name specified in ``name``.
 * The assigned object identifier is returned in ``id``.  This identifier is
 * used to access the extension set with other extension set related
 * directives.
 *
 * The extension set is initialized using the extension table specified in
 * ``extension_table``.
 *
 * @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
 *
 * @retval ::RTEMS_INVALID_NAME The ``name`` parameter was invalid.
 *
 * @retval ::RTEMS_INVALID_ADDRESS The ``extension_table`` parameter was NULL.
 *
 * @retval ::RTEMS_INVALID_ADDRESS The ``id`` parameter was NULL.
 *
 * @retval ::RTEMS_TOO_MANY There was no inactive object available to create an
 *   extension set.  The number of extension sets available to the application
 *   is configured through the #CONFIGURE_MAXIMUM_USER_EXTENSIONS application
 *   configuration option.
 *
 * @par Notes
 * @parblock
 * The user-provided extension set table is not used after the return of the
 * directive.
 *
 * Newly created extension sets are immediately installed and are invoked upon
 * the next system event supporting an extension.
 *
 * An alternative to dynamically created extension sets are initial extensions,
 * see #CONFIGURE_INITIAL_EXTENSIONS.  Initial extensions are recommended for
 * extension sets which provide a fatal error extension.
 *
 * For control and maintenance of the extension set, RTEMS allocates a ESCB
 * from the local ESCB free pool and initializes it.
 * @endparblock
 *
 * @par Constraints
 * @parblock
 * The following constraints apply to this directive:
 *
 * * The directive may be called from within device driver initialization
 *   context.
 *
 * * The directive may be called from within task context.
 *
 * * The directive may obtain and release the object allocator mutex.  This may
 *   cause the calling task to be preempted.
 *
 * * The number of extension sets available to the application is configured
 *   through the #CONFIGURE_MAXIMUM_USER_EXTENSIONS application configuration
 *   option.
 * @endparblock
 */
rtems_status_code rtems_extension_create(
  rtems_name                    name,
  const rtems_extensions_table *extension_table,
  rtems_id                     *id
);

/* Generated from spec:/rtems/userext/if/task-begin */

/**
 * @ingroup RTEMSAPIClassicUserext
 *
 * @brief %
 */
typedef User_extensions_thread_begin_extension rtems_task_begin_extension;

/* Generated from spec:/rtems/userext/if/task-create */

/**
 * @ingroup RTEMSAPIClassicUserext
 *
 * @brief %
 */
typedef User_extensions_thread_create_extension rtems_task_create_extension;

/* Generated from spec:/rtems/userext/if/task-delete */

/**
 * @ingroup RTEMSAPIClassicUserext
 *
 * @brief %
 */
typedef User_extensions_thread_delete_extension rtems_task_delete_extension;

/* Generated from spec:/rtems/userext/if/task-exitted */

/**
 * @ingroup RTEMSAPIClassicUserext
 *
 * @brief %
 */
typedef User_extensions_thread_exitted_extension rtems_task_exitted_extension;

/* Generated from spec:/rtems/userext/if/task-restart */

/**
 * @ingroup RTEMSAPIClassicUserext
 *
 * @brief %
 */
typedef User_extensions_thread_restart_extension rtems_task_restart_extension;

/* Generated from spec:/rtems/userext/if/task-start */

/**
 * @ingroup RTEMSAPIClassicUserext
 *
 * @brief %
 */
typedef User_extensions_thread_start_extension rtems_task_start_extension;

/* Generated from spec:/rtems/userext/if/task-switch */

/**
 * @ingroup RTEMSAPIClassicUserext
 *
 * @brief %
 */
typedef User_extensions_thread_switch_extension rtems_task_switch_extension;

/* Generated from spec:/rtems/userext/if/task-terminate */

/**
 * @ingroup RTEMSAPIClassicUserext
 *
 * @brief %
 */
typedef User_extensions_thread_terminate_extension rtems_task_terminate_extension;

#ifdef __cplusplus
}
#endif

#endif /* _RTEMS_EXTENSION_H */