ConOpSys V2970  P004.07
ANVILEX control operating system
safe_obj.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ********************************************************************************
3 ** **
4 ** ABCC Starter Kit version 3.04.01 (2018-01-23) **
5 ** **
6 ** Delivered with: **
7 ** ABP 7.55.01 (2017-12-20) **
8 ** ABCC Driver 5.04.01 (2017-12-18) **
9 ** */
10 /*******************************************************************************
11 ********************************************************************************
12 ** COPYRIGHT NOTIFICATION (c) 2015 HMS Industrial Networks AB **
13 ** **
14 ** This code is the property of HMS Industrial Networks AB. **
15 ** The source code may not be reproduced, distributed, or used without **
16 ** permission. When used together with a product from HMS, permission is **
17 ** granted to modify, reproduce and distribute the code in binary form **
18 ** without any restrictions. **
19 ** **
20 ** THE CODE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. HMS DOES NOT **
21 ** WARRANT THAT THE FUNCTIONS OF THE CODE WILL MEET YOUR REQUIREMENTS, OR **
22 ** THAT THE OPERATION OF THE CODE WILL BE UNINTERRUPTED OR ERROR-FREE, OR **
23 ** THAT DEFECTS IN IT CAN BE CORRECTED. **
24 ********************************************************************************
25 ********************************************************************************
26 ** This is the public header file for the Functional Safety object.
27 ********************************************************************************
28 ********************************************************************************
29 ** Services:
30 ** SAFE_ProcessCmdMsg() - Processes commands sent to the Functional Safety
31 ** object.
32 ********************************************************************************
33 ********************************************************************************
34 */
35 #ifndef SAFE_OBJ_H
36 #define SAFE_OBJ_H
37 
38 #include "abcc_obj_cfg.h"
39 
40 /*******************************************************************************
41 ** Constants
42 ********************************************************************************
43 */
44 
45 /*******************************************************************************
46 ** Typedefs
47 ********************************************************************************
48 */
49 
50 /*******************************************************************************
51 ** Public Globals
52 ********************************************************************************
53 */
54 
55 /*******************************************************************************
56 ** Public Services
57 ********************************************************************************
58 */
59 
60 /*------------------------------------------------------------------------------
61 ** The function that processes the commands sent to the Functional Safety
62 ** object.
63 **------------------------------------------------------------------------------
64 ** Arguments:
65 ** psNewMessage - Pointer to a ABP_MsgType message.
66 **
67 ** Returns:
68 ** None.
69 **------------------------------------------------------------------------------
70 */
71 EXTFUNC void SAFE_ProcessCmdMsg( ABP_MsgType* psNewMessage );
72 
73 /*------------------------------------------------------------------------------
74 ** The function will control the ABP_SAFE_IA_SAFETY_ENABLED attribute
75 ** value in runtime.
76 **------------------------------------------------------------------------------
77 ** Arguments:
78 ** fEnabled - TRUE: Safety is enabled; FALSE: Safety is disabled
79 **
80 ** Returns:
81 ** None.
82 **------------------------------------------------------------------------------
83 */
84 #if( SAFE_IA_SAFETY_ENABLED_ENABLE )
85 EXTFUNC void SAFE_SetSafetyEnable( BOOL fEnabled );
86 #endif
87 
88 #endif /* inclusion lock */
int BOOL
Boolean datatype definition.
Definition: Defines.h:124
#define EXTFUNC
Definition: Defines.h:998
EXTFUNC void SAFE_ProcessCmdMsg(ABP_MsgType *psNewMessage)