/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @ingroup RTEMSScoreFreechain
*
* @brief This header file provides interfaces of the
* @ref RTEMSScoreFreechain which are used by the implementation and the
* @ref RTEMSImplApplConfig.
*/
/*
* Copyright (c) 2013 Gedare Bloom.
*
* 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.
*/
#ifndef _RTEMS_SCORE_FREECHAIN_H
#define _RTEMS_SCORE_FREECHAIN_H
#include <rtems/score/chain.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* @defgroup RTEMSScoreFreechain Freechain Handler
*
* @ingroup RTEMSScore
*
* @brief This group contains the Freechain Handler implementation.
*
* This handler encapsulates functionality related to the management of
* free nodes of a user-defined size. If the chain of free nodes is empty
* during an allocation request, it can be dynamically extended.
*
* @{
*/
/**
* @brief The freechain control.
*/
typedef struct {
/**
* @brief Chain of free nodes.
*/
Chain_Control Free;
} Freechain_Control;
/** @} */
#ifdef __cplusplus
}
#endif
#endif
/* end of include file */