| CE Gobi SDK 2.14 GobiApi

- Main Page
- Modules
- Classes
- Files

- File List

GobiImageMgmtAPI.h
1 /*===========================================================================
2 FILE:
3 GobiImageMgmtAPI.h
4
5 DESCRIPTION:
6 QUALCOMM Image Management API for Gobi 3000
7
8 Copyright (C) 2011 QUALCOMM Incorporated. All rights reserved.
9 QUALCOMM Proprietary/GTDR
10
11 All data and information contained in or disclosed by this document is
12 confidential and proprietary information of QUALCOMM Incorporated and all
13 rights therein are expressly reserved. By accepting this material the
14 recipient agrees that this material and the information contained therein
15 is held in confidence and in trust and will not be used, copied, reproduced
16 in whole or in part, nor its contents revealed in any manner to others
17 without the express written permission of QUALCOMM Incorporated.
18 ==========================================================================*/
19
20 /*=========================================================================*/
21 // Pragmas
22 /*=========================================================================*/
23 #pragma once
24
25 //---------------------------------------------------------------------------
26 // Definitions
27 //---------------------------------------------------------------------- -----
28
29 // The actual Gobi IM API functions are tagged/exported with this
30 #ifndef IMPORTGOBI
31 #define IMPORTGOBI extern "C" __declspec( dllimport )
32 #endif
33
34 // Calling convention for API
35 #define GOBIAPI __cdecl
36
37 /*=========================================================================*/
38 // Definitions
39 /*=========================================================================*/
40
45
46 /*=========================================================================*/
47 // Structs
48 /*=========================================================================*/
49
50 #ifdef __cplusplus
51 extern "C" {
52 #endif
53
54 #define UNIQUE_ID_LEN 16
55 #define MAX_BUILDID_LEN 255
56 #define MAX_NO_OF_FW 5
57 #define MAX_STORED_IMG 50
58 #define MAX_IMG_LIST 2
59
60 typedef struct
61 {
62 BYTE imageType;
63 CHAR uniqueID[UNIQUE_ID_LEN];
64 BYTE buildIDLen;
65 CHAR buildID[MAX_BUILDID_LEN];
66 } curFwImageList;
67
68 typedef struct
69 {
70 BYTE numInstances;
71 curFwImageList fwImage[MAX_NO_OF_FW];
72 } arrFwImageList;
73
74 typedef struct
75 {
76 BYTE storageIndex;
77 BYTE failureCount;
78 BYTE arrUniqueId[16];
79 BYTE buildIdLen;
80 #pragma warning(suppress:4200)
81 CHAR szBuildId[];
82 } imageElement;
83
84 typedef struct
85 {
86 BYTE* pImageType;
87 BYTE* pMaxImage;
88 BYTE* pIndexRunning;
89 BYTE* pNumOfImageElement;
90 imageElement* pImageElements[MAX_STORED_IMG];//4*50=200 bytes
91 } storedImageSubList;//200+4*4=216 bytes
92
93 typedef struct
94 {
95 BYTE* pNumImageType;
96 storedImageSubList ArrImageList[MAX_IMG_LIST];//216*2=432 bytes
97 } storedImageList;//432+4=436 bytes
98
99 #ifdef __cplusplus
100 };
101 #endif
102
103 /*=========================================================================*/
104 // Prototypes
105 /*=========================================================================*/
106
107
108
109
110
120 IMPORTGOBI ULONG GOBIAPI GetBARMode( ULONG * pBARMode );
121
122 /*=========================================================================*/
131 IMPORTGOBI ULONG GOBIAPI SetBARMode();
132
133
134
150 IMPORTGOBI ULONG GOBIAPI GetStoredImageInfo(
151 ULONG imageInfoSize,
152 BYTE * pImageInfo,
153 ULONG * pMajorVersion,
154 ULONG * pMinorVersion,
155 ULONG * pVersionID,
156 CHAR * pInfo,
157 ULONG * pLockID );
158
169 IMPORTGOBI ULONG GOBIAPI DeleteStoredImage(
170 ULONG imageInfoSize,
171 BYTE * pImageInfo );
172
173 // End of GIM group
GetBARMode
IMPORTGOBI ULONG GOBIAPI GetBARMode(ULONG *pBARMode)
curFwImageList
Definition: GobiImageMgmtAPI.h:60
arrFwImageList
Definition: GobiImageMgmtAPI.h:68
SetBARMode
IMPORTGOBI ULONG GOBIAPI SetBARMode()
DeleteStoredImage
IMPORTGOBI ULONG GOBIAPI DeleteStoredImage(ULONG imageInfoSize, BYTE *pImageInfo)
storedImageList
Definition: GobiImageMgmtAPI.h:93
imageElement
Definition: GobiImageMgmtAPI.h:74
GetStoredImageInfo
IMPORTGOBI ULONG GOBIAPI GetStoredImageInfo(ULONG imageInfoSize, BYTE *pImageInfo, ULONG *pMajorVersion, ULONG *pMinorVersion, ULONG *pVersionID, CHAR *pInfo, ULONG *pLockID)
storedImageSubList
Definition: GobiImageMgmtAPI.h:84