support.h

Go to the documentation of this file.

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

/*
 * 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.
 */

/*
 * Do not manually edit this file.  It 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 to an RTEMS mailing list or raise a bug report:
 *
 * https://docs.rtems.org/branches/master/user/support/bugs.html
 *
 * For information on updating and regenerating please refer to:
 *
 * https://docs.rtems.org/branches/master/eng/req/howto.html
 */

/* Generated from spec:/rtems/support/if/header */

#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>

#ifdef __cplusplus
extern "C" {
#endif

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

/* Generated from spec:/rtems/support/if/milliseconds-to-microseconds */

#define RTEMS_MILLISECONDS_TO_MICROSECONDS( _ms ) ( ( _ms ) * 1000UL )

/* Generated from spec:/rtems/support/if/microseconds-to-ticks */

#define RTEMS_MICROSECONDS_TO_TICKS( _us ) \
  ( ( _us ) / rtems_configuration_get_microseconds_per_tick() )

/* Generated from spec:/rtems/support/if/is-name-valid */

static inline bool rtems_is_name_valid( rtems_status_code name )
{
  return name != 0;
}

/* Generated from spec:/rtems/support/if/milliseconds-to-ticks */

#define RTEMS_MILLISECONDS_TO_TICKS( _ms ) \
  RTEMS_MICROSECONDS_TO_TICKS( RTEMS_MILLISECONDS_TO_MICROSECONDS( _ms ) )

/* Generated from spec:/rtems/support/if/name-to-characters */

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;
}

/* Generated from spec:/rtems/support/if/workspace-allocate */

bool rtems_workspace_allocate( size_t bytes, void **pointer );

/* Generated from spec:/rtems/support/if/workspace-free */

bool rtems_workspace_free( void *pointer );

/* Generated from spec:/rtems/support/if/workspace-get-information */

bool rtems_workspace_get_information( Heap_Information_block *the_info );

/* Generated from spec:/rtems/support/if/workspace-greedy-allocate */

void *rtems_workspace_greedy_allocate(
  const uintptr_t *block_sizes,
  size_t           block_count
);

/* Generated from spec:/rtems/support/if/workspace-greedy-allocate-all-except-largest */

void *rtems_workspace_greedy_allocate_all_except_largest(
  uintptr_t *allocatable_size
);

/* Generated from spec:/rtems/support/if/workspace-greedy-free */

void rtems_workspace_greedy_free( void *opaque );

#ifdef __cplusplus
}
#endif

#endif /* _RTEMS_RTEMS_SUPPORT_H */