1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
|
/*===========================================================================
FILE:
GobiMBNMgmt.h
DESCRIPTION:
QUALCOMM Gobi MBN management functions for Gobi 3000
PUBLIC CLASSES AND FUNCTIONS:
sImageInfo
GetImageStore
GetImageInfo
GetImagesInfo
GetImageBootCompatibility
MapVersionInfo
GetImageByUniqueID
Copyright (c) 2011, Code Aurora Forum. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
* Neither the name of Code Aurora Forum nor
the names of its contributors may be used to endorse or promote
products derived from this software without specific prior written
permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
==========================================================================*/
/*=========================================================================*/
// Pragmas
/*=========================================================================*/
#pragma once
//---------------------------------------------------------------------------
// Include Files
//---------------------------------------------------------------------------
#include "GobiImageDefinitions.h"
#include "GobiError.h"
#include <vector>
//---------------------------------------------------------------------------
// Definitions
//---------------------------------------------------------------------------
// Maximum length for unique image ID
const ULONG MBN_UNIQUE_ID_LEN = 16;
/*=========================================================================*/
// Struct sImageInfo
// Storage structure for Image information
/*=========================================================================*/
struct sImageInfo
{
public:
// Default constructor
sImageInfo()
: mImageType( eGOBI_MBN_TYPE_ENUM_BEGIN ),
mVersionID( ULONG_MAX ),
mVersion( "" )
{
memset( (LPVOID)&mImageID[0], 0, MBN_UNIQUE_ID_LEN );
};
// Is this object valid?
bool IsValid() const
{
return ( (mImageType != eGOBI_MBN_TYPE_ENUM_BEGIN)
&& (mVersionID != ULONG_MAX)
&& (mVersion.size() > 0) );
};
/* Image type */
eGobiMBNType mImageType;
/* Unique image ID */
BYTE mImageID[MBN_UNIQUE_ID_LEN];
/* Version ID */
ULONG mVersionID;
/* Version string */
std::string mVersion;
};
/*=========================================================================*/
// Public Methods
/*=========================================================================*/
/*===========================================================================
METHOD:
GetImageStore (Public Method)
DESCRIPTION:
Return the image store folder, i.e., the folder containing one or more
carrier-specific image subfolders
RETURN VALUE:
std::string - Image Store
===========================================================================*/
std::string GetImageStore();
/*===========================================================================
METHOD:
GetImageInfo (Public Method)
DESCRIPTION:
Get the image information for the image specified by the given fully
qualified path
PARAMETERS:
pFilePath [ I ] - Fully qualified path to image file
pImageType [ O ] - Image type
pImageID [ O ] - Unique image ID
pVersionID [ O ] - Version ID
versionSize [ I ] - The maximum number of characters including the NULL
terminator that can be copied to the version array
pVersion [ O ] - NULL-terminated string representing the version
RETURN VALUE:
eGobiError - Return code
===========================================================================*/
eGobiError GetImageInfo(
LPCSTR pFilePath,
BYTE * pImageType,
BYTE * pImageID,
ULONG * pVersionID,
USHORT versionSize,
CHAR * pVersion );
/*===========================================================================
METHOD:
GetImagesInfo (Public Method)
DESCRIPTION:
Return the info for the images located at the given path
PARAMETERS:
path [ I ] - Fully qualified path
RETURN VALUE:
std:vector <sImageInfo> - Vector of image information
===========================================================================*/
std::vector <sImageInfo> GetImagesInfo( const std::string & path );
/*===========================================================================
METHOD:
GetImageBootCompatibility (Public Method)
DESCRIPTION:
Get the image boot compatibility for the image specified by the given
fully qualified path
PARAMETERS:
pFilePath [ I ] - Fully qualified path to image file
pMajorVersion [ O ] - Major version of compatible boot downloader
pMinorVersion [ O ] - Minor version of compatible boot downloader
RETURN VALUE:
eGobiError - Return code
===========================================================================*/
eGobiError GetImageBootCompatibility(
LPCSTR pFilePath,
ULONG * pMajorVersion,
ULONG * pMinorVersion );
/*===========================================================================
METHOD:
MapVersionInfo (Public Method)
DESCRIPTION:
Map the specified version string to image capabilities
PARAMETERS:
versionID [ I ] - Version ID
imageType [ I ] - Image type
pVersion [ I ] - Version string for image
pTechnology [ O ] - Technology type
pCarrier [ O ] - Carrier type
pRegion [ O ] - Region type
pGPSCapability [ O ] - GPS capability
RETURN VALUE:
eGobiError - Return code
===========================================================================*/
eGobiError MapVersionInfo(
ULONG versionID,
BYTE imageType,
LPCSTR pVersion,
ULONG * pTechnology,
ULONG * pCarrier,
ULONG * pRegion,
ULONG * pGPSCapability );
/*===========================================================================
METHOD:
GetImageByUniqueID (Public Method)
DESCRIPTION:
Return the fully qualified path to an image specified by unique ID
PARAMETERS:
pImageID [ I ] - Unique image ID
RETURN VALUE:
std::string - Fully qualified path to matching image
===========================================================================*/
std::string GetImageByUniqueID( BYTE * pImageID );
|
