DVBCore  17.9.0
Open Source DVB Engine
 All Data Structures Files Functions Typedefs Macros Pages
stbhwupg.h
Go to the documentation of this file.
1 /*******************************************************************************
2  * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
3  * Copyright © 2009 Ocean Blue Software Ltd
4  *
5  * This file is part of a DTVKit Software Component
6  * You are permitted to copy, modify or distribute this file subject to the terms
7  * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
8  *
9  * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
10  * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
11  * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
12  *
13  * If you or your organisation is not a member of DTVKit then you have access
14  * to this source code outside of the terms of the licence agreement
15  * and you are expected to delete this and any associated files immediately.
16  * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
17  *******************************************************************************/
25 /* pre-processor mechanism so multiple inclusions don't cause compilation error*/
26 
27 #ifndef _STBHWUPG_H
28 
29 #define _STBHWUPG_H
30 
31 #include "techtype.h"
32 
33 /*---Constant and macro definitions for public use-----------------------------*/
34 
35 /*---Enumerations for public use-----------------------------------------------*/
36 
37 /*---Global type defs for public use-------------------------------------------*/
38 
39 /*---Global Function prototypes for public use---------------------------------*/
40 
44 void STB_UPGInitialise(void);
45 
58 BOOLEAN STB_UPGStart(U8BIT image_type, U8BIT *filename);
59 
73 BOOLEAN STB_UPGWrite(U8BIT image_type, U32BIT offset, U32BIT size, U8BIT *buffer);
74 
87 BOOLEAN STB_UPGRead(U8BIT image_type, U32BIT offset, U32BIT size, U8BIT *buffer);
88 
101 BOOLEAN STB_UPGFinish(U8BIT image_type, BOOLEAN upgrade_successful);
102 
109 U32BIT STB_UPGGetApplicationSize(void);
110 
115 U32BIT STB_UPGGetApplicationOffset(void);
116 
117 #endif /* _STBHWUPG_H */
void STB_UPGInitialise(void)
Initialisation of the necessary structures.
BOOLEAN STB_UPGFinish(U8BIT image_type, BOOLEAN upgrade_successful)
Finalises the upgrade performing all the required actions needed when all the upgrade data have been ...
U32BIT STB_UPGGetApplicationOffset(void)
Returns the application's offset inside its area.
U32BIT STB_UPGGetApplicationSize(void)
Returns the size of the NVM area available for the application and all the upgradable modules...
System Wide Global Technical Data Type Definitions.
BOOLEAN STB_UPGRead(U8BIT image_type, U32BIT offset, U32BIT size, U8BIT *buffer)
Read size bytes from the upgrade storage area specified by image_type.
BOOLEAN STB_UPGStart(U8BIT image_type, U8BIT *filename)
Specifies the file path that STB_UPWrite would write to and STB_UPGRead would read from when performi...
BOOLEAN STB_UPGWrite(U8BIT image_type, U32BIT offset, U32BIT size, U8BIT *buffer)
Writes size bytes to the upgrade storage area specified by image_type.