rtems/score/freechain.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSScoreFreechain
0007  *
0008  * @brief This header file provides interfaces of the
0009  *   @ref RTEMSScoreFreechain which are used by the implementation and the
0010  *   @ref RTEMSImplApplConfig.
0011  */
0012
0013 /*
0014  * Copyright (c) 2013 Gedare Bloom.
0015  *
0016  * Redistribution and use in source and binary forms, with or without
0017  * modification, are permitted provided that the following conditions
0018  * are met:
0019  * 1. Redistributions of source code must retain the above copyright
0020  *    notice, this list of conditions and the following disclaimer.
0021  * 2. Redistributions in binary form must reproduce the above copyright
0022  *    notice, this list of conditions and the following disclaimer in the
0023  *    documentation and/or other materials provided with the distribution.
0024  *
0025  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0026  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0027  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0028  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0029  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0030  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0031  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0032  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0033  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0034  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0035  * POSSIBILITY OF SUCH DAMAGE.
0036  */
0037
0038 #ifndef _RTEMS_SCORE_FREECHAIN_H
0039 #define _RTEMS_SCORE_FREECHAIN_H
0040
0041 #include <rtems/score/chain.h>
0042
0043 #ifdef __cplusplus
0044 extern "C" {
0045 #endif
0046
0047 /**
0048  * @defgroup RTEMSScoreFreechain Freechain Handler
0049  *
0050  * @ingroup RTEMSScore
0051  *
0052  * @brief This group contains the Freechain Handler implementation.
0053  *
0054  * This handler encapsulates functionality related to the management of
0055  * free nodes of a user-defined size.  If the chain of free nodes is empty
0056  * during an allocation request, it can be dynamically extended.
0057  *
0058  * @{
0059  */
0060
0061 /**
0062  * @brief The freechain control.
0063  */
0064 typedef struct {
0065   /**
0066    * @brief Chain of free nodes.
0067    */
0068   Chain_Control Free;
0069 } Freechain_Control;
0070
0071 /** @} */
0072
0073 #ifdef __cplusplus
0074 }
0075 #endif
0076
0077 #endif
0078 /* end of include file */