os-hooks.h

Go to the documentation of this file.

/*
 * This file is part of the µOS++ distribution.
 *   (https://github.com/micro-os-plus)
 * Copyright (c) 2016 Liviu Ionescu.
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom
 * the Software is furnished to do so, subject to the following
 * conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */
 
#ifndef CMSIS_PLUS_RTOS_OS_HOOKS_H_
#define CMSIS_PLUS_RTOS_OS_HOOKS_H_
 
#include <stddef.h>
#include <stdbool.h>
 
// ----------------------------------------------------------------------------
 
#if defined(__cplusplus)
extern "C"
{
#endif /* __cplusplus */
 
  void
  __attribute__ ((noreturn))
  _start (void);
 
  void
  os_startup_initialize_hardware_early (void);
 
  void
  os_startup_initialize_hardware (void);
 
  void
  os_startup_initialize_free_store (void* heap_address, size_t heap_size_bytes);
 
  void
  os_startup_initialize_args (int* p_argc, char*** p_argv);
 
  void
  os_startup_create_thread_idle (void);
 
  void
  os_terminate_goodbye (void);
 
  void
  __attribute__ ((noreturn))
  os_terminate (int code);
 
  bool
  os_rtos_idle_enter_power_saving_mode_hook (void);
 
  void
  os_rtos_application_out_of_memory_hook (void);
 
  void
  os_rtos_system_out_of_memory_hook (void);
 
#define os_initialize_hardware_early os_startup_initialize_hardware_early
#define os_initialize_hardware os_startup_initialize_hardware
#define os_initialize_args os_startup_initialize_args
 
#if defined(__cplusplus)
}
#endif /* __cplusplus */
 
#endif /* CMSIS_PLUS_RTOS_OS_HOOKS_H_ */