Safe API Framework 0.1.0 build 384e6ae
Layered API framework for safety-related applications (ERTMS RBC reference targeting CENELEC EN 50128 SIL 4)
Loading...
Searching...
No Matches
rte_fsou.h
Go to the documentation of this file.
1
28#ifndef RTE_FSOU_H
29#define RTE_FSOU_H
30
31#include <stdbool.h>
32#include <stdint.h>
33
34#include "rte/utils/safestate/rte_safestate.h"
35#include "rte/utils/status/rte_status.h"
36
37#ifdef __cplusplus
38extern "C" {
39#endif
40
41/*
42 * The OSAdapter vtable (rte_osadapter_fsou_t) and rte_osadapter_fsou_register() live in
43 * rte_osadapter/fsou/rte_osadapter_fsou.h, not here (ADR-021). This header is the consumer-facing surface only.
44 */
45
52rte_status_t rte_fsou_grant(uint32_t cycle_id);
53
60rte_status_t rte_fsou_revoke(rte_safestate_reason_t reason);
61
66bool rte_fsou_is_present(void);
67
74void rte_fsou_report_presence(void);
75
76#ifdef __cplusplus
77}
78#endif
79
81
82#endif /* RTE_FSOU_H */
rte_fsou_report_presence
void rte_fsou_report_presence(void)
Logs once whether an FSOU is present (REQ-FSOU-003).
Definition rte_fsou.c:99
rte_fsou_grant
rte_status_t rte_fsou_grant(uint32_t cycle_id)
Grants this channel's output permission to the FSOU for one cycle (REQ-FSOU-002).
Definition rte_fsou.c:52
rte_fsou_is_present
bool rte_fsou_is_present(void)
Tells whether an FSOU OSAdapter is registered.
Definition rte_fsou.c:94
rte_fsou_revoke
rte_status_t rte_fsou_revoke(rte_safestate_reason_t reason)
Withdraws this channel's output permission from the FSOU (REQ-FSOU-002).
Definition rte_fsou.c:73
rte_safestate_reason_t
uint16_t rte_safestate_reason_t
Diagnostic reason code accompanying a safe-state transition.
Definition rte_safestate.h:63
rte_status_t
rte_status_t
Common result/status codes.
Definition rte_status.h:27
rte_safestate.h
Safe-state transitions and checked assertions (ADR-004).
rte_status.h
Common status/error codes returned by every Safe API Framework function. Shared across all OS Abstrac...