andreika-git
/
ChibiOS
mirror of https://github.com/andreika-git/ChibiOS.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
ChibiOS/os/sb/host/sb.h

313 lines
9.0 KiB
C
Raw Blame History

/*
ChibiOS - Copyright (C) 2006,2007,2008,2009,2010,2011,2012,2013,2014,
2015,2016,2017,2018,2019,2020,2021 Giovanni Di Sirio.
This file is part of ChibiOS.
ChibiOS is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation version 3 of the License.
ChibiOS is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file sb/host/sb.h
* @brief ARM SandBox macros and structures.
*
* @addtogroup ARM_SANDBOX
* @{
*/
#ifndef SB_H
#define SB_H
#include "hal.h"
#include "vfs.h"
#include "errcodes.h"
/*===========================================================================*/
/* Module constants. */
/*===========================================================================*/
/**
* @brief ChibiOS/SB identification macro.
*/
#define __CHIBIOS_SB__
/**
* @brief Stable release flag.
*/
#define CH_SB_STABLE 0
/**
* @name ChibiOS/SE version identification
* @{
*/
/**
* @brief Safety Extensions version string.
*/
#define CH_SB_VERSION "3.0.0"
/**
* @brief Safety Extensions version major number.
*/
#define CH_SB_MAJOR 3
/**
* @brief Safety Extensions version minor number.
*/
#define CH_SB_MINOR 0
/**
* @brief Safety Extensions version patch number.
*/
#define CH_SB_PATCH 0
/** @} */
/*===========================================================================*/
/* Module pre-compile time settings. */
/*===========================================================================*/
#include "sbconf.h"
/*===========================================================================*/
/* Derived constants and error checks. */
/*===========================================================================*/
#if !defined(__CHIBIOS_SB_CONF__)
#error "missing or wrong configuration file"
#endif
#if !defined(__CHIBIOS_SB_CONF_VER_3_0__)
#error "obsolete or unknown configuration file"
#endif
/* Checks on configuration options.*/
#if !defined(SB_CFG_NUM_REGIONS) || defined(__DOXYGEN__)
#error "SB_CFG_NUM_REGIONS not defined in sbconf.h"
#endif
#if !defined(SB_CFG_ENABLE_VFS) || defined(__DOXYGEN__)
#error "SB_CFG_ENABLE_VFS not defined in sbconf.h"
#endif
#if !defined(SB_CFG_FD_NUM) || defined(__DOXYGEN__)
#error "SB_CFG_FD_NUM not defined in sbconf.h"
#endif
/* License checks.*/
#if !defined(CH_CUSTOMER_LIC_SB) || !defined(CH_LICENSE_FEATURES)
#error "malformed chlicense.h"
#endif
#if CH_CUSTOMER_LIC_SB == FALSE
#error "ChibiOS/SB not licensed"
#endif
#if (CH_LICENSE_FEATURES != CH_FEATURES_FULL) && \
(CH_LICENSE_FEATURES != CH_FEATURES_INTERMEDIATE) && \
(CH_LICENSE_FEATURES != CH_FEATURES_BASIC)
#error "invalid CH_LICENSE_FEATURES setting"
#endif
#if CH_LICENSE_FEATURES != CH_FEATURES_FULL
#error "ChibiOS/SB insufficient features level"
#endif
#if CH_CFG_ST_RESOLUTION != 32
#error "SandBox requires CH_CFG_ST_RESOLUTION == 32"
#endif
#if CH_CFG_INTERVALS_SIZE != 32
#error "SandBox requires CH_CFG_INTERVALS_SIZE == 32"
#endif
#if CH_CFG_USE_MEMCHECKS == FALSE
#error "SandBox requires CH_CFG_USE_MEMCHECKS == TRUE"
#endif
#if PORT_USE_SYSCALL == FALSE
#error "SandBox requires PORT_USE_SYSCALL == TRUE"
#endif
#if (SB_CFG_NUM_REGIONS < 1) || (SB_CFG_NUM_REGIONS > 4)
#error "invalid SB_CFG_NUM_REGIONS value"
#endif
#if (PORT_SWITCHED_REGIONS_NUMBER > 0) && \
(PORT_SWITCHED_REGIONS_NUMBER != SB_CFG_NUM_REGIONS)
#error "SB_CFG_NUM_REGIONS not matching PORT_SWITCHED_REGIONS_NUMBER"
#endif
/*===========================================================================*/
/* Module data structures and types. */
/*===========================================================================*/
/**
* @brief Type of a sandbox manager global structure.
*/
typedef struct {
#if (CH_CFG_USE_EVENTS == TRUE) || defined(__DOXYGEN__)
/**
* @brief Event source for sandbox termination.
*/
event_source_t termination_es;
#endif
} sb_t;
/**
* @brief Type of a sandbox memory region.
*/
typedef struct {
/**
* @brief Associated memory area.
*/
memory_area_t area;
/**
* @brief Writable memory range.
*/
bool writeable;
} sb_memory_region_t;
#if (SB_CFG_ENABLE_VFS == TRUE) || defined(__DOXYGEN__)
/**
* @brief Type of a sandbox I/O structure.
*/
typedef struct {
/**
* @brief VFS nodes associated to file descriptors.
*/
vfs_node_c *vfs_nodes[SB_CFG_FD_NUM];
/**
* @brief Extra attributes added to the VFS nodes.
*/
uint8_t attributes[SB_CFG_FD_NUM];
} sb_ioblock_t;
#endif
/**
* @brief Type of a sandbox configuration structure.
*/
typedef struct {
/**
* @brief Memory region for code.
* @note It is used to locate the startup header.
*/
uint32_t code_region;
/**
* @brief Memory region for data and stack.
* @note It is used for initial PSP placement.
*/
uint32_t data_region;
/**
* @brief SandBox regions.
* @note The following memory regions are used only for pointers
* validation, not for MPU setup.
*/
sb_memory_region_t regions[SB_CFG_NUM_REGIONS];
#if (PORT_SWITCHED_REGIONS_NUMBER == SB_CFG_NUM_REGIONS) || defined(__DOXYGEN__)
/**
* @brief MPU regions initialization values.
* @note Regions initialization values must be chosen to be
* consistent with the values in the "regions" field.
*/
mpureg_t mpuregs[SB_CFG_NUM_REGIONS];
#endif
#if (SB_CFG_ENABLE_VFS == TRUE) || defined(__DOXYGEN__)
/**
* @brief VFS driver associated to the sandbox as root.
*/
vfs_driver_c *vfs_driver;
#else
/**
* @brief Sandbox STDIN stream.
* @note Set this to @p NULL if standard I/O is not needed.
* @note By design you can use HAL streams here, you need to use
* a cast however.
*/
SandboxStream *stdin_stream;
/**
* @brief Sandbox STDOUT stream.
* @note Set this to @p NULL if standard I/O is not needed.
* @note By design you can use HAL streams here, you need to use
* a cast however.
*/
SandboxStream *stdout_stream;
/**
* @brief Sandbox STDERR stream.
* @note Set this to @p NULL if standard I/O is not needed.
* @note By design you can use HAL streams here, you need to use
* a cast however.
*/
SandboxStream *stderr_stream;
#endif
} sb_config_t;
/**
* @brief Type of a sandbox object.
*/
typedef struct {
/**
* @brief Pointer to the sandbox configuration data.
*/
const sb_config_t *config;
/**
* @brief Thread running in the sandbox.
*/
thread_t *tp;
#if (CH_CFG_USE_MESSAGES == TRUE) || defined(__DOXYGEN__)
/**
* @brief Thread sending a message to the sandbox.
*/
thread_t *msg_tp;
#endif
#if (CH_CFG_USE_EVENTS == TRUE) || defined(__DOXYGEN__)
/**
* @brief Sandbox events source.
*/
event_source_t es;
#endif
#if (SB_CFG_ENABLE_VFS == TRUE) || defined(__DOXYGEN__)
/**
* @brief VFS bindings for Posix API.
*/
sb_ioblock_t io;
#endif
} sb_class_t;
/*===========================================================================*/
/* Module macros. */
/*===========================================================================*/
/*===========================================================================*/
/* External declarations. */
/*===========================================================================*/
#ifdef __cplusplus
extern "C" {
#endif
#ifdef __cplusplus
}
#endif
/*===========================================================================*/
/* Module inline functions. */
/*===========================================================================*/
#include "sbsysc.h"
#include "sbposix.h"
#include "sbapi.h"
#include "sbhost.h"
#endif /* SBHOST_H */
/** @} */
Reference in New Issue View Git Blame Copy Permalink