ConOpSys V2970  P004.07
ANVILEX control operating system
app_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 APP object.
27 ********************************************************************************
28 ********************************************************************************
29 ** Services:
30 ** APP_GetCandidateFwAvailable() - Checks if there is an firmware available
31 ** in the module's candidate area.
32 ** APP_ProcResetRequest() - Performs a reset of the application
33 ** APP_ProcessCmdMsg() - Processes commands sent to the APP object.
34 ** APP_HwConfAddress() - Set attribute ABP_APP_IA_HW_CONF_ADDR.
35 ********************************************************************************
36 ********************************************************************************
37 */
38 #ifndef APP_OBJ_H
39 #define APP_OBJ_H
40 
41 
42 /*******************************************************************************
43 ** Constants
44 ********************************************************************************
45 */
46 
47 /*******************************************************************************
48 ** Typedefs
49 ********************************************************************************
50 */
51 
52 /*******************************************************************************
53 ** Public Globals
54 ********************************************************************************
55 */
56 
57 /*******************************************************************************
58 ** Public Services
59 ********************************************************************************
60 */
61 
62 /*------------------------------------------------------------------------------
63 ** Call to check if there is firmware available in the candidate area. This
64 ** function retrieves the value from a NVS.
65 **------------------------------------------------------------------------------
66 ** Arguments:
67 ** None
68 **
69 ** Returns:
70 ** BOOL - TRUE: Firmware available in candidate area.
71 ** FALSE: Firmware NOT available in candidate area.
72 **------------------------------------------------------------------------------
73 */
74 EXTFUNC BOOL APP_GetCandidateFwAvailable( void );
75 
76 
77 /*------------------------------------------------------------------------------
78 ** Set attribute ABP_APP_IA_HW_CONF_ADDR to indicate if the address is set by
79 ** hardware switches or not.
80 **------------------------------------------------------------------------------
81 ** Arguments:
82 ** fhwConfAddress: - TRUE if address is set by HW switches.
83 **
84 ** Returns:
85 ** None
86 **------------------------------------------------------------------------------
87 */
88 EXTFUNC void APP_HwConfAddress( BOOL fhwConfAddress );
89 
90 
91 /*------------------------------------------------------------------------------
92 ** Called to perform a reset upon request.
93 **------------------------------------------------------------------------------
94 ** Arguments:
95 ** bResetType - Type of reset, see ABP_RESET_XXX defines.
96 **
97 ** Returns:
98 ** None.
99 **------------------------------------------------------------------------------
100 */
101 EXTFUNC void APP_ProcResetRequest( U8 bResetType );
102 
103 /*------------------------------------------------------------------------------
104 ** The function that processes the commands sent to the APP object.
105 **------------------------------------------------------------------------------
106 ** Arguments:
107 ** psNewMessage - Pointer to a ABP_MsgType message.
108 **
109 ** Returns:
110 ** None.
111 **------------------------------------------------------------------------------
112 */
113 EXTFUNC void APP_ProcessCmdMsg( ABP_MsgType* psNewMessage );
114 
115 
116 
117 
118 #endif /* inclusion lock */
BOOL
int BOOL
Boolean datatype definition.
Definition: Defines.h:124
EXTFUNC
#define EXTFUNC
Definition: Defines.h:998
U8
unsigned char U8
Binary 8-Bit unsigned integer datatype defenition.
Definition: Defines.h:183
APP_ProcResetRequest
EXTFUNC void APP_ProcResetRequest(U8 bResetType)
APP_ProcessCmdMsg
EXTFUNC void APP_ProcessCmdMsg(ABP_MsgType *psNewMessage)
APP_GetCandidateFwAvailable
EXTFUNC BOOL APP_GetCandidateFwAvailable(void)
APP_HwConfAddress
EXTFUNC void APP_HwConfAddress(BOOL fhwConfAddress)
Generated on Thu Mar 10 2022 03:50:15 for ConOpSys V2970 by doxygen 1.9.1