William Kane / Generic

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   LaserioLib

Generic/abcc_obj/app_obj.h@0:9509fece98da, 2016-05-12 (annotated)

Committer:
wkane
Date:
Thu May 12 19:04:45 2016 +0000
Revision:
0:9509fece98da
ver1.0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
wkane 0:9509fece98da 1 /*******************************************************************************
wkane 0:9509fece98da 2 ********************************************************************************
wkane 0:9509fece98da 3 ** **
wkane 0:9509fece98da 4 ** ABCC Starter Kit version 2.01.01 (2015-12-14) **
wkane 0:9509fece98da 5 ** **
wkane 0:9509fece98da 6 ** Delivered with: **
wkane 0:9509fece98da 7 ** ABCC Driver 4.01.01 (2015-12-14) **
wkane 0:9509fece98da 8 ** ABP 7.16.01 (2015-10-14) **
wkane 0:9509fece98da 9 ** */
wkane 0:9509fece98da 10 /*******************************************************************************
wkane 0:9509fece98da 11 ********************************************************************************
wkane 0:9509fece98da 12 ** COPYRIGHT NOTIFICATION (c) 2015 HMS Industrial Networks AB **
wkane 0:9509fece98da 13 ** **
wkane 0:9509fece98da 14 ** This code is the property of HMS Industrial Networks AB. **
wkane 0:9509fece98da 15 ** The source code may not be reproduced, distributed, or used without **
wkane 0:9509fece98da 16 ** permission. When used together with a product from HMS, permission is **
wkane 0:9509fece98da 17 ** granted to modify, reproduce and distribute the code in binary form **
wkane 0:9509fece98da 18 ** without any restrictions. **
wkane 0:9509fece98da 19 ** **
wkane 0:9509fece98da 20 ** THE CODE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. HMS DOES NOT **
wkane 0:9509fece98da 21 ** WARRANT THAT THE FUNCTIONS OF THE CODE WILL MEET YOUR REQUIREMENTS, OR **
wkane 0:9509fece98da 22 ** THAT THE OPERATION OF THE CODE WILL BE UNINTERRUPTED OR ERROR-FREE, OR **
wkane 0:9509fece98da 23 ** THAT DEFECTS IN IT CAN BE CORRECTED. **
wkane 0:9509fece98da 24 ********************************************************************************
wkane 0:9509fece98da 25 ********************************************************************************
wkane 0:9509fece98da 26 ** This is the public header file for the APP object.
wkane 0:9509fece98da 27 ********************************************************************************
wkane 0:9509fece98da 28 ********************************************************************************
wkane 0:9509fece98da 29 ** Services:
wkane 0:9509fece98da 30 ** APP_GetCandidateFwAvailable() - Checks if there is an firmware available
wkane 0:9509fece98da 31 ** in the module's candidate area.
wkane 0:9509fece98da 32 ** APP_ProcResetRequest() - Performs a reset of the application
wkane 0:9509fece98da 33 ** APP_ProcessCmdMsg() - Processes commands sent to the APP object.
wkane 0:9509fece98da 34 ** APP_HwConfAddress() - Set attribute ABP_APP_IA_HW_CONF_ADDR.
wkane 0:9509fece98da 35 ********************************************************************************
wkane 0:9509fece98da 36 ********************************************************************************
wkane 0:9509fece98da 37 */
wkane 0:9509fece98da 38 #ifndef APP_OBJ_H
wkane 0:9509fece98da 39 #define APP_OBJ_H
wkane 0:9509fece98da 40
wkane 0:9509fece98da 41
wkane 0:9509fece98da 42 /*******************************************************************************
wkane 0:9509fece98da 43 ** Constants
wkane 0:9509fece98da 44 ********************************************************************************
wkane 0:9509fece98da 45 */
wkane 0:9509fece98da 46
wkane 0:9509fece98da 47 /*******************************************************************************
wkane 0:9509fece98da 48 ** Typedefs
wkane 0:9509fece98da 49 ********************************************************************************
wkane 0:9509fece98da 50 */
wkane 0:9509fece98da 51
wkane 0:9509fece98da 52 /*******************************************************************************
wkane 0:9509fece98da 53 ** Public Globals
wkane 0:9509fece98da 54 ********************************************************************************
wkane 0:9509fece98da 55 */
wkane 0:9509fece98da 56
wkane 0:9509fece98da 57 /*******************************************************************************
wkane 0:9509fece98da 58 ** Public Services
wkane 0:9509fece98da 59 ********************************************************************************
wkane 0:9509fece98da 60 */
wkane 0:9509fece98da 61
wkane 0:9509fece98da 62 /*------------------------------------------------------------------------------
wkane 0:9509fece98da 63 ** Call to check if there is firmware available in the candidate area. This
wkane 0:9509fece98da 64 ** function retrieves the value from a NVS.
wkane 0:9509fece98da 65 **------------------------------------------------------------------------------
wkane 0:9509fece98da 66 ** Arguments:
wkane 0:9509fece98da 67 ** None
wkane 0:9509fece98da 68 **
wkane 0:9509fece98da 69 ** Returns:
wkane 0:9509fece98da 70 ** BOOL - TRUE: Firmware available in candidate area.
wkane 0:9509fece98da 71 ** FALSE: Firmware NOT available in candidate area.
wkane 0:9509fece98da 72 **------------------------------------------------------------------------------
wkane 0:9509fece98da 73 */
wkane 0:9509fece98da 74 EXTFUNC BOOL APP_GetCandidateFwAvailable( void );
wkane 0:9509fece98da 75
wkane 0:9509fece98da 76
wkane 0:9509fece98da 77 /*------------------------------------------------------------------------------
wkane 0:9509fece98da 78 ** Set attribute ABP_APP_IA_HW_CONF_ADDR to indicate if the address is set by
wkane 0:9509fece98da 79 ** hardware switches or not.
wkane 0:9509fece98da 80 **------------------------------------------------------------------------------
wkane 0:9509fece98da 81 ** Arguments:
wkane 0:9509fece98da 82 ** fhwConfAddress: - TRUE if address is set by HW switches.
wkane 0:9509fece98da 83 **
wkane 0:9509fece98da 84 ** Returns:
wkane 0:9509fece98da 85 ** None
wkane 0:9509fece98da 86 **------------------------------------------------------------------------------
wkane 0:9509fece98da 87 */
wkane 0:9509fece98da 88 EXTFUNC void APP_HwConfAddress( BOOL fhwConfAddress );
wkane 0:9509fece98da 89
wkane 0:9509fece98da 90
wkane 0:9509fece98da 91 /*------------------------------------------------------------------------------
wkane 0:9509fece98da 92 ** Called to perform a reset upon request.
wkane 0:9509fece98da 93 **------------------------------------------------------------------------------
wkane 0:9509fece98da 94 ** Arguments:
wkane 0:9509fece98da 95 ** bResetType - Type of reset, see ABP_RESET_XXX defines.
wkane 0:9509fece98da 96 **
wkane 0:9509fece98da 97 ** Returns:
wkane 0:9509fece98da 98 ** None.
wkane 0:9509fece98da 99 **------------------------------------------------------------------------------
wkane 0:9509fece98da 100 */
wkane 0:9509fece98da 101 EXTFUNC void APP_ProcResetRequest( UINT8 bResetType );
wkane 0:9509fece98da 102
wkane 0:9509fece98da 103 /*------------------------------------------------------------------------------
wkane 0:9509fece98da 104 ** The function that processes the commands sent to the APP object.
wkane 0:9509fece98da 105 **------------------------------------------------------------------------------
wkane 0:9509fece98da 106 ** Arguments:
wkane 0:9509fece98da 107 ** psNewMessage - Pointer to a ABP_MsgType message.
wkane 0:9509fece98da 108 **
wkane 0:9509fece98da 109 ** Returns:
wkane 0:9509fece98da 110 ** None.
wkane 0:9509fece98da 111 **------------------------------------------------------------------------------
wkane 0:9509fece98da 112 */
wkane 0:9509fece98da 113 EXTFUNC void APP_ProcessCmdMsg( ABP_MsgType* psNewMessage );
wkane 0:9509fece98da 114
wkane 0:9509fece98da 115
wkane 0:9509fece98da 116
wkane 0:9509fece98da 117
wkane 0:9509fece98da 118 #endif /* inclusion lock */