stack.h

Go to the documentation of this file.

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

 
/*
 * Copyright (C) 2022 embedded brains GmbH & Co. KG
 * Copyright (C) 1989, 2021 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.
 */
 
#ifndef _RTEMS_SCORE_STACK_H
#define _RTEMS_SCORE_STACK_H
 
#include <rtems/score/basedefs.h>
 
#ifdef __cplusplus
extern "C" {
#endif


#define STACK_MINIMUM_SIZE  CPU_STACK_MINIMUM_SIZE

typedef struct {
  size_t      size;
  void       *area;
}   Stack_Control;

typedef void ( *Stack_Allocator_initialize )( size_t stack_space_size );

typedef void *( *Stack_Allocator_allocate )( size_t stack_size );

typedef void ( *Stack_Allocator_free )( void *addr );

typedef void *( *Stack_Allocator_allocate_for_idle )(
  uint32_t  cpu,
  size_t   *stack_size
);

extern uint32_t rtems_minimum_stack_size;

extern const uintptr_t _Stack_Space_size;

extern const bool _Stack_Allocator_avoids_workspace;

extern const Stack_Allocator_initialize _Stack_Allocator_initialize;

extern const Stack_Allocator_allocate _Stack_Allocator_allocate;

extern const Stack_Allocator_free _Stack_Allocator_free;

void _Stack_Allocator_do_initialize( void );

void *_Stack_Allocator_allocate_for_idle_workspace(
  uint32_t  unused,
  size_t   *storage_size
);

extern const size_t _Stack_Allocator_allocate_for_idle_storage_size;

extern char _Stack_Allocator_allocate_for_idle_storage_areas[];

void *_Stack_Allocator_allocate_for_idle_static(
  uint32_t  cpu_index,
  size_t   *storage_size
);

extern const Stack_Allocator_allocate_for_idle
  _Stack_Allocator_allocate_for_idle;

 
#ifdef __cplusplus
}
#endif
 
#endif
/* end of include file */