AM261x MCU+ SDK: FOTAAgent_BufferManager.h Source File

| AM261x MCU+ SDK 26.00.00 |

FOTAAgent_BufferManager.h
Go to the documentation of this file.
1 /*
2 * Copyright (C) 2025 Texas Instruments Incorporated
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 *
8 * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *
11 * Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the
14 * distribution.
15 *
16 * Neither the name of Texas Instruments Incorporated nor the names of
17 * its contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32
33 #ifndef __FOTAAGENT_BUFFER_MANAGER_H__
34 #define __FOTAAGENT_BUFFER_MANAGER_H__
35
36 #include <stdint.h>
37 #include "fota_agent.h"
38
39 #ifdef __cplusplus
40 extern "C"
41 {
42 #endif
43
44 #define FotaAgentP_BufferManager_BUFFERFULL ((int32_t)-3)
45 #define FotaAgentP_BufferManager_ADDRESS_DISCONT ((int32_t)-4)
46 #define FotaAgentP_BufferManager_ADDRESS_UNALIGNED ((int32_t)-5)
47
59 int32_t FOTAAgent_BufferManager_init(FOTAAgent_Handle *fotaAgentHandle);
60
79 int32_t FOTAAgent_BufferManager_update(FOTAAgent_Handle *fotaAgentHandle, uint8_t newData,
80 uint32_t flashOffset);
81
94 int32_t FOTAAgent_BufferManager_calculateFlushAddress(FOTAAgent_Handle *fotaAgentHandle, uint32_t * addr);
95
107 int32_t FOTAAgent_BufferManager_flush(FOTAAgent_Handle *fotaAgentHandle);
108
120 int32_t FOTAAgent_BufferManager_checkAddressDiscontinuity(
121 FOTAAgent_Handle *fotaAgentHandle, uint32_t address, uint8_t newData);
122
123 #ifdef __cplusplus
124 }
125 #endif
126
127
128 #endif //__FOTAAGENT_BUFFER_MANAGER_H__
FOTAAgent_BufferManager_update
int32_t FOTAAgent_BufferManager_update(FOTAAgent_Handle *fotaAgentHandle, uint8_t newData, uint32_t flashOffset)
Update internal buffer with new data.
FOTAAgent_BufferManager_flush
int32_t FOTAAgent_BufferManager_flush(FOTAAgent_Handle *fotaAgentHandle)
Flush internal buffer to flash.
FOTAAgent_BufferManager_init
int32_t FOTAAgent_BufferManager_init(FOTAAgent_Handle *fotaAgentHandle)
Initilize buffer manager state machine.
FOTAAgent_Handle
Definition: fota_agent.h:91
FOTAAgent_BufferManager_checkAddressDiscontinuity
int32_t FOTAAgent_BufferManager_checkAddressDiscontinuity(FOTAAgent_Handle *fotaAgentHandle, uint32_t address, uint8_t newData)
Check if the new data's address is discontinuous or not.
FOTAAgent_BufferManager_calculateFlushAddress
int32_t FOTAAgent_BufferManager_calculateFlushAddress(FOTAAgent_Handle *fotaAgentHandle, uint32_t *addr)
Calculate Address at which internal buffer to be flushed at.abort.
fota_agent.h
FOTA Agent Driver API/interface file.