diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-06-24 08:09:03 +0200 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-10-01 14:09:50 +0200 |
commit | 599e5de8aac095eb3556ffe3c7a7bf3db3d88d93 (patch) | |
tree | 1dba40e31997ee2ced3e44c6a80ca909c6e66330 | |
parent | ce035fe038c7d560f0c5c125259aeec4985b04df (diff) |
Generate <rtems/rtems/support.h>
-rw-r--r-- | cpukit/include/rtems/rtems/support.h | 237 |
1 files changed, 149 insertions, 88 deletions
diff --git a/cpukit/include/rtems/rtems/support.h b/cpukit/include/rtems/rtems/support.h index 92dd49076f..cbafb5def5 100644 --- a/cpukit/include/rtems/rtems/support.h +++ b/cpukit/include/rtems/rtems/support.h @@ -1,168 +1,229 @@ +/* SPDX-License-Identifier: BSD-2-Clause */ + /** * @file * - * @ingroup ClassicRTEMSWorkspace + * @ingroup RTEMSAPIClassicSupport + * + * @brief This header file defines support services of the API. */ -/* COPYRIGHT (c) 1989-2008. - * On-Line Applications Research Corporation (OAR). +/* + * Copyright (C) 2020 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 was automatically generated. Do not edit it manually. + * Please have a look at + * + * https://docs.rtems.org/branches/master/eng/req/howto.html * - * 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. + * for information how to maintain and re-generate this file. */ #ifndef _RTEMS_RTEMS_SUPPORT_H #define _RTEMS_RTEMS_SUPPORT_H +#include <stdbool.h> +#include <stddef.h> +#include <stdint.h> +#include <rtems/config.h> +#include <rtems/rtems/status.h> #include <rtems/rtems/types.h> #include <rtems/score/heapinfo.h> -#include <rtems/config.h> #ifdef __cplusplus extern "C" { #endif /** - * @addtogroup ClassicTasks - */ -/**@{**/ - -/** - * @brief Returns the number of micro seconds for the milli seconds value @a _ms. + * @defgroup RTEMSAPIClassicSupport Support Services + * + * @ingroup RTEMSAPIClassic + * + * @brief Items of this group should move to other groups. */ -#define RTEMS_MILLISECONDS_TO_MICROSECONDS(_ms) ((_ms) * 1000UL) /** - * @brief Returns the number of ticks for the milli seconds value @a _ms. + * @ingroup RTEMSAPIClassicSupport + * + * @brief Returns the number of microseconds for the specified milliseconds + * value. + * + * @param _ms is the milliseconds value to convert to microseconds. + * + * @return The number of microseconds for the specified milliseconds value is + * returned. */ -#define RTEMS_MILLISECONDS_TO_TICKS(_ms) \ - (RTEMS_MILLISECONDS_TO_MICROSECONDS(_ms) / \ - rtems_configuration_get_microseconds_per_tick()) +#define RTEMS_MILLISECONDS_TO_MICROSECONDS( _ms ) ( ( _ms ) * 1000UL ) /** - * @brief Returns the number of ticks for the micro seconds value @a _us. + * @ingroup RTEMSAPIClassicSupport + * + * @brief Returns the number of clock ticks for the specified microseconds + * value. + * + * The number of clock ticks per second is defined by the + * #CONFIGURE_MICROSECONDS_PER_TICK application configuration option. + * + * @param _us is the microseconds value to convert to clock ticks. + * + * @return The number of clock ticks for the specified microseconds value is + * returned. */ -#define RTEMS_MICROSECONDS_TO_TICKS(_us) \ - ((_us) / rtems_configuration_get_microseconds_per_tick()) +#define RTEMS_MICROSECONDS_TO_TICKS( _us ) \ + ( ( _us ) / rtems_configuration_get_microseconds_per_tick() ) /** - * @brief Returns @c true if the name is valid, and @c false otherwise. + * @ingroup RTEMSAPIClassicSupport + * + * @brief Returns true, if the specified object name is valid, otherwise + * returns false. + * + * @param name is the object name to check. + * + * @retval true The specified object name is valid. + * + * @retval false Otherwise. */ -RTEMS_INLINE_ROUTINE bool rtems_is_name_valid ( - rtems_name name -) +static inline bool rtems_is_name_valid( rtems_status_code name ) { - return ( name != 0 ); + return name != 0; } /** - * @brief Breaks the object name into the four component characters @a c1, - * @a c2, @a c3, and @a c4. + * @ingroup RTEMSAPIClassicSupport + * + * @brief Returns the number of clock ticks for the specified milliseconds + * value. + * + * The number of clock ticks per second is defined by the + * #CONFIGURE_MICROSECONDS_PER_TICK application configuration option. + * + * @param _ms is the milliseconds value to convert to clock ticks. + * + * @return The number of clock ticks for the specified milliseconds value is + * returned. */ -RTEMS_INLINE_ROUTINE void rtems_name_to_characters( - rtems_name name, - char *c1, - char *c2, - char *c3, - char *c4 -) -{ - *c1 = (char) ((name >> 24) & 0xff); - *c2 = (char) ((name >> 16) & 0xff); - *c3 = (char) ((name >> 8) & 0xff); - *c4 = (char) ( name & 0xff); -} - -/** @} */ +#define RTEMS_MILLISECONDS_TO_TICKS( _ms ) \ + RTEMS_MICROSECONDS_TO_TICKS( RTEMS_MILLISECONDS_TO_MICROSECONDS( _ms ) ) /** - * @defgroup ClassicRTEMSWorkspace Workspace + * @ingroup RTEMSAPIClassicSupport * - * @ingroup RTEMSAPIClassic + * @brief Breaks the object name into the four component characters. + * + * @param name is the object name to break into four component characters. + * + * @param[out] c1 is the first character of the object name. + * + * @param[out] c2 is the second character of the object name. * - * Workspace definitions. + * @param[out] c3 is the third character of the object name. + * + * @param[out] c4 is the fourth character of the object name. */ -/**@{**/ +static inline void rtems_name_to_characters( + rtems_name name, + char *c1, + char *c2, + char *c3, + char *c4 +) +{ + *c1 = (char) ( name >> 24 ); + *c2 = (char) ( name >> 16 ); + *c3 = (char) ( name >> 8 ); + *c4 = (char) name; +} /** - * @brief Gets Workspace Information + * @ingroup RTEMSAPIClassicSupport + * + * @brief % * - * Returns information about the heap that is used as the RTEMS Executive - * Workspace in @a the_info. + * @param bytes % * - * Returns @c true if successful, and @a false otherwise. + * @param pointer % */ -bool rtems_workspace_get_information( - Heap_Information_block *the_info -); +bool rtems_workspace_allocate( size_t bytes, void **pointer ); /** - * @brief Allocates Memory from the Workspace + * @ingroup RTEMSAPIClassicSupport * - * A number of @a bytes bytes will be allocated from the RTEMS Executive - * Workspace and returned in @a pointer. + * @brief % * - * Returns @c true if successful, and @a false otherwise. + * @param pointer % */ -bool rtems_workspace_allocate( - size_t bytes, - void **pointer -); +bool rtems_workspace_free( void *pointer ); /** - * @brief Frees Memory Allocated from the Workspace + * @ingroup RTEMSAPIClassicSupport * - * This frees the memory indicated by @a pointer that was allocated from the - * RTEMS Executive Workspace. + * @brief % * - * Returns @c true if successful, and @a false otherwise. + * @param the_info % */ -bool rtems_workspace_free( - void *pointer -); +bool rtems_workspace_get_information( Heap_Information_block *the_info ); /** - * @brief Greedy allocate that empties the workspace. + * @ingroup RTEMSAPIClassicSupport + * + * @brief % * - * Afterwards the heap has at most @a block_count allocatable blocks of sizes - * specified by @a block_sizes. The @a block_sizes must point to an array with - * @a block_count members. All other blocks are used. + * @param block_sizes % * - * @see rtems_workspace_greedy_free(). + * @param block_count % */ void *rtems_workspace_greedy_allocate( const uintptr_t *block_sizes, - size_t block_count + size_t block_count ); /** - * @brief Greedy allocate all blocks except the largest free block. + * @ingroup RTEMSAPIClassicSupport * - * Afterwards the heap has at most one allocatable block. This block is the - * largest free block if it exists. The allocatable size of this block is - * stored in @a allocatable_size. All other blocks are used. + * @brief % * - * @see rtems_workspace_greedy_free(). + * @param allocatable_size % */ void *rtems_workspace_greedy_allocate_all_except_largest( uintptr_t *allocatable_size ); /** - * @brief Frees space of a greedy allocation. + * @ingroup RTEMSAPIClassicSupport * - * The @a opaque argument must be the return value of - * rtems_workspace_greedy_allocate() or - * rtems_workspace_greedy_allocate_all_except_largest(). + * @brief % + * + * @param opaque % */ void rtems_workspace_greedy_free( void *opaque ); -/** @} */ - #ifdef __cplusplus } #endif -#endif -/* end of include file */ +#endif /* _RTEMS_RTEMS_SUPPORT_H */ |