1 /* |
|
2 * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). |
|
3 * All rights reserved. |
|
4 * This component and the accompanying materials are made available |
|
5 * under the terms of the License "Eclipse Public License v1.0" |
|
6 * which accompanies this distribution, and is available |
|
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 * |
|
9 * Initial Contributors: |
|
10 * Nokia Corporation - initial contribution. |
|
11 * |
|
12 * Contributors: |
|
13 * |
|
14 * Description: |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 /* ------------------------------------------------------------------------- */ |
|
20 |
|
21 |
|
22 /* 1 ABSTRACT |
|
23 |
|
24 1.1 Module type |
|
25 |
|
26 Message definition file for autogeneration |
|
27 |
|
28 |
|
29 1.2 Functional description |
|
30 |
|
31 This file is the message definition file for the SOS FTD. |
|
32 |
|
33 |
|
34 1.3 Notes |
|
35 |
|
36 |
|
37 |
|
38 2 CONTENTS |
|
39 |
|
40 |
|
41 1 ABSTRACT |
|
42 1.1 Module type |
|
43 1.2 Functional description |
|
44 1.3 Notes |
|
45 |
|
46 2 CONTENTS |
|
47 |
|
48 3 CONSTANTS |
|
49 |
|
50 4 MACROS |
|
51 |
|
52 5 DATA TYPES |
|
53 |
|
54 6 CLASSES |
|
55 |
|
56 7 OBJECTS |
|
57 |
|
58 8 DATA STRUCTURES |
|
59 |
|
60 9 FUNCTION PROTOTYPES |
|
61 */ |
|
62 |
|
63 #include "pn_const.h" |
|
64 /* Message ID's */ |
|
65 |
|
66 #define SOS_FTD_ACTIVATE_REQ 0x0000 |
|
67 #define SOS_FTD_ACTIVATE_RESP 0x0001 |
|
68 #define SOS_FTD_DEACTIVATE_REQ 0x0002 |
|
69 #define SOS_FTD_DEACTIVATE_RESP 0x0003 |
|
70 #define SOS_FTD_EXECUTE_REQ 0x0004 |
|
71 #define SOS_FTD_EXECUTE_RESP 0x0005 |
|
72 #define SOS_FTD_VERSION_GET_REQ 0x0006 |
|
73 #define SOS_FTD_VERSION_GET_RESP 0x0007 |
|
74 |
|
75 /* Sub block ID's */ |
|
76 |
|
77 #define SOS_FTD_DATA_STATUS 0x0000 |
|
78 #define SOS_FTD_DATA_BYTE 0x0001 |
|
79 #define SOS_FTD_DATA_WORD 0x0002 |
|
80 #define SOS_FTD_DATA_ALL 0x0003 |
|
81 #define SOS_FTD_DATA_DWORD 0x0004 |
|
82 #define SOS_FTD_DATA_STRING 0x0005 |
|
83 #define SOS_FTD_DATA_BYTEARRAY 0x0006 |
|
84 |
|
85 /* Constants */ |
|
86 |
|
87 #define MAX_FTD_DATA_ITEMS 255 |
|
88 #define SOS_FTD_MAX_STR_LEN 65524 |
|
89 #define SOS_FTD_INPUT_PROPERTY 0x01 |
|
90 #define SOS_FTD_OUTPUT_PROPERTY 0x02 |
|
91 #define SOS_FTD_BYTE_VALUE_NOT_DEFINED 0x00 |
|
92 #define SOS_FTD_WORD_VALUE_NOT_DEFINED 0x0000 |
|
93 #define SOS_FTD_DWORD_VALUE_NOT_DEFINED 0x00000000 |
|
94 #define SOS_FTD_STRING_VALUE_NOT_DEFINED 0x00 |
|
95 #define SOS_FTD_BYTEARRAY_VALUE_NOT_DEFINED 0x00 |
|
96 |
|
97 #define KPSFIELDTESTUID 0x102824C5 |
|
98 |
|
99 |
|
100 /* MACROS */ |
|
101 |
|
102 #define PN_SOS_FTD_EXTENDED \ |
|
103 PN_RES(PN_RES_TYPE_SOS_FIELD_TEST, 1) |
|
104 |
|
105 |
|
106 #define SOS_SB_HDR \ |
|
107 REFERENCE(16, BE, id, "Data item ID", SB_ID) \ |
|
108 REFERENCE(16, BE, length, "Item length", SB_LENGTH) |
|
109 |
|
110 #define SOS_SB_STATUS_HDR \ |
|
111 REFERENCE(16, BE, id, "Status item ID", SB_ID) \ |
|
112 REFERENCE(16, BE, length, "Status item length", SB_LENGTH) |
|
113 |
|
114 |
|
115 #ifndef PN_RES_TYPE_SOS_FIELD_TEST_VERSION |
|
116 #define PN_RES_TYPE_SOS_FIELD_TEST_VERSION |
|
117 #define PN_RES_TYPE_SOS_FIELD_TEST_VERSION_Z 001 |
|
118 #define PN_RES_TYPE_SOS_FIELD_TEST_VERSION_Y 001 |
|
119 #endif |
|
120 |
|
121 /* --------------------------------------------------------------------- */ |
|
122 /* Project / Document information */ |
|
123 /* --------------------------------------------------------------------- */ |
|
124 |
|
125 /* Project / Document properties */ |
|
126 PROPERTY_STRING(PROPERTY_PROJECT_SITE_NAME, "") |
|
127 PROPERTY_STRING(PROPERTY_PROJECT_NAME, "") |
|
128 PROPERTY_STRING(PROPERTY_PROJECT_OWNER_NAME, "") |
|
129 PROPERTY_STRING(PROPERTY_PROJECT_CONFIDENTIALITY, "") |
|
130 |
|
131 /* ISI header properties */ |
|
132 PROPERTY_STRING(PROPERTY_ISIHDR_TITLE, "SOS FTD, include file") |
|
133 PROPERTY_STRING(PROPERTY_ISIHDR_FILENAME, "sos_ftd_isi.h") |
|
134 /*PROPERTY_STRING(PROPERTY_ISIHDR_FILENAME_16, "-")*/ |
|
135 PROPERTY_STRING(PROPERTY_ISIHDR_CONTINUUS_PROJECT_DB, "") |
|
136 PROPERTY_STRING(PROPERTY_ISIHDR_CONTINUUS_PROJECT_PATH, "global_interface/ISI/Protocol") |
|
137 /*PROPERTY_STRING(PROPERTY_ISIHDR_CONTINUUS_PROJECT_PATH_16, "-")*/ |
|
138 PROPERTY_STRING(PROPERTY_ISIHDR_CONTINUUS_INSTANCE_NAME, "-") |
|
139 /*PROPERTY_STRING(PROPERTY_ISIHDR_CONTINUUS_INSTANCE_NAME_16, "-")*/ |
|
140 |
|
141 /* HTML properties |
|
142 PROPERTY_STRING(PROPERTY_HTML_TITLE, "SOS FTD, file descriptions") |
|
143 PROPERTY_STRING(PROPERTY_HTML_FILENAME, "i_sos_ftd.html") |
|
144 PROPERTY_STRING(PROPERTY_HTML_DOCUMENT_NUMBER, "-") |
|
145 PROPERTY_STRING(PROPERTY_HTML_CONTINUUS_PROJECT_DB, "") |
|
146 PROPERTY_STRING(PROPERTY_HTML_CONTINUUS_PROJECT_NAME, "") |
|
147 PROPERTY_STRING(PROPERTY_HTML_DIRECTORY_PATH, "") |
|
148 PROPERTY(PROPERTY_HTML_INCLUDE_INTRODUCTION) |
|
149 */ |
|
150 PROPERTY(PROPERTY_ISIHDR_GENERATE_ALL_STRUCTURE_ELEMENTS) |
|
151 RES_BEGIN(RESOURCE_ISI, PN_RES_TYPE_SOS_FIELD_TEST, SOS_FTD, "SOS FTD", |
|
152 RES_VERSION_STRING(PN_RES_TYPE_SOS_FIELD_TEST_VERSION_Z, PN_RES_TYPE_SOS_FIELD_TEST_VERSION_Y), FALSE) |
|
153 |
|
154 |
|
155 /* --------------------------------------------------------------------- */ |
|
156 /* File description */ |
|
157 /* --------------------------------------------------------------------- */ |
|
158 |
|
159 RES_COMMENT(COMMENT_PARAGRAPH, "This file includes SOS FTD definitions") |
|
160 |
|
161 /* --------------------------------------------------------------------- */ |
|
162 /* ISI version history */ |
|
163 /* --------------------------------------------------------------------- */ |
|
164 |
|
165 |
|
166 |
|
167 ISI_VERSION_COMMENT(COMMENT_TEXT, "The first version has been generated. "); |
|
168 ISI_VERSION_HISTORY("000.001") |
|
169 |
|
170 |
|
171 /* --------------------------------------------------------------------- */ |
|
172 /* Notes / references */ |
|
173 /* --------------------------------------------------------------------- */ |
|
174 |
|
175 |
|
176 /* --------------------------------------------------------------------- */ |
|
177 /* Symbols */ |
|
178 /* --------------------------------------------------------------------- */ |
|
179 |
|
180 |
|
181 /* FTD definitions */ |
|
182 |
|
183 /* --------------------------------------------------------------------- */ |
|
184 /* Constant tables */ |
|
185 /* --------------------------------------------------------------------- */ |
|
186 |
|
187 |
|
188 CONST_TBL_BEGIN(SOS_FTD_DATA_STATUSES, 8, BE, "000.001", "") |
|
189 CONST_TBL_ENTRY(SOS_FTD_DATA_OK, 0x00, |
|
190 "FTD Data OK. ") |
|
191 CONST_TBL_ENTRY(SOS_FTD_DATA_FAIL, 0x01, |
|
192 "FTD Data fail.") |
|
193 CONST_TBL_ENTRY(SOS_FTD_DATA_NOT_ACTIVATED, 0x02, |
|
194 "FTD data activated.") |
|
195 CONST_TBL_ENTRY(SOS_FTD_DATA_NOT_SUPPORTED, 0x03, |
|
196 "FTD data not supported.") |
|
197 CONST_TBL_ENTRY(SOS_FTD_DATA_NOT_AVAILABLE, 0x04, |
|
198 "FTD data NOT available.") |
|
199 CONST_TBL_END |
|
200 |
|
201 CONST_TBL_BEGIN(SOS_FTD_STRING_TYPE, 8, BE, "000.001", "") |
|
202 CONST_TBL_ENTRY(SOS_FTD_STRING_ASCII, 0x00, "") |
|
203 CONST_TBL_ENTRY(SOS_FTD_STRING_UNICODE, 0x01, "") |
|
204 CONST_TBL_END |
|
205 |
|
206 CONST_TBL_BEGIN(SOS_FTD_UID, 32, BE, "000.001", "") |
|
207 CONST_TBL_ENTRY(KPSFIELDTESTUID, 0x102824C5, "") |
|
208 CONST_TBL_END |
|
209 |
|
210 CONST_TBL_BEGIN(SOS_FTD_EXECUTE_TYPE, 8, BE, "000.001", "") |
|
211 CONST_TBL_ENTRY(SOS_FTD_EXECUTE_WITH_INPUT, 0x01, "") |
|
212 CONST_TBL_ENTRY(SOS_FTD_EXECUTE_WITHOUT_INPUT, 0x02, "") |
|
213 CONST_TBL_END |
|
214 |
|
215 CONST_TBL_BEGIN(SOS_FTD_CONSTANTS_TABLE_BYTE, 8, BE, "001.001", "") |
|
216 CONST_TBL_ENTRY(SOS_FTD_INPUT_PROPERTY, 0x01, "") |
|
217 CONST_TBL_ENTRY(SOS_FTD_OUTPUT_PROPERTY, 0x02, "") |
|
218 CONST_TBL_ENTRY(SOS_FTD_BYTE_VALUE_NOT_DEFINED, 0x00, "") |
|
219 CONST_TBL_END |
|
220 |
|
221 CONST_TBL_BEGIN(SOS_FTD_CONSTANTS_TABLE_STRING, 8, BE, "001.001", "") |
|
222 CONST_TBL_ENTRY(SOS_FTD_STRING_VALUE_NOT_DEFINED, 0x00, "") |
|
223 CONST_TBL_END |
|
224 |
|
225 CONST_TBL_BEGIN(SOS_FTD_CONSTANTS_TABLE_BYTEARRAY, 8, BE, "001.001", "") |
|
226 CONST_TBL_ENTRY(SOS_FTD_BYTEARRAY_VALUE_NOT_DEFINED, 0x00, "") |
|
227 CONST_TBL_END |
|
228 |
|
229 CONST_TBL_BEGIN(SOS_FTD_CONSTANTS_TABLE_WORD, 16, BE, "001.001", "") |
|
230 CONST_TBL_ENTRY(SOS_FTD_WORD_VALUE_NOT_DEFINED, 0x0000, "") |
|
231 CONST_TBL_END |
|
232 |
|
233 CONST_TBL_BEGIN(SOS_FTD_CONSTANTS_TABLE_DWORD, 32, BE, "001.001", "") |
|
234 CONST_TBL_ENTRY(SOS_FTD_DWORD_VALUE_NOT_DEFINED, 0x00000000, "") |
|
235 CONST_TBL_END |
|
236 |
|
237 /* --------------------------------------------------------------------- */ |
|
238 /* Sequences */ |
|
239 /* --------------------------------------------------------------------- */ |
|
240 |
|
241 SEQ_BEGIN(SOS_FTD_DATA_ARRAY, DONT_CREATE_STRUCT, "000.001", "") |
|
242 VALUE(8, BE, array, "Array", DEC) |
|
243 SEQ_END |
|
244 |
|
245 SEQ_BEGIN(SOS_FTD_DATA_STRING_ASCII, DONT_CREATE_STRUCT, "000.001", "") |
|
246 STRING_REF(STRING_ASCII_ZERO_TERMINATED, BE, string, "Data", STR_LEN, ISIHDR_RESERVE_SPACE) |
|
247 SEQ_END |
|
248 |
|
249 SEQ_BEGIN(SOS_FTD_DATA_STRING_UNICODE, DONT_CREATE_STRUCT, "000.001", "") |
|
250 STRING_REF(STRING_UNICODE_ZERO_TERMINATED, BE, string, "Data", STR_LEN, ISIHDR_RESERVE_SPACE) |
|
251 SEQ_END |
|
252 |
|
253 SEQ_BEGIN(SOS_FTD_STRING_SEQ, DONT_CREATE_STRUCT, "000.001","") |
|
254 VALUE(8,BE, string, "String", DEC) |
|
255 SEQ_END |
|
256 |
|
257 SEQ_BEGIN(SOS_FTD_WORD, DONT_CREATE_STRUCT, "", "") |
|
258 VALUE(16, BE, word, "Word", DEC) |
|
259 SEQ_END |
|
260 |
|
261 /* --------------------------------------------------------------------- */ |
|
262 /* Sub blocks */ |
|
263 /* --------------------------------------------------------------------- */ |
|
264 #define FTD_SB_16 \ |
|
265 REFERENCE(16, BE, subblockID, "Sub Block ID", SB_ID) \ |
|
266 REFERENCE(8, BE, subblock_length, "Sub Block Length", SB_LENGTH) |
|
267 |
|
268 |
|
269 /* SOS_FTD_DATA_BYTE */ |
|
270 /* |
|
271 COMMENT(COMMENT_TEXT, |
|
272 "Should just be used as a template for FTD data item description, see reference ") |
|
273 COMMENT_LINK(LINK_NOTE, "/5/", "", "") |
|
274 PROPERTY(PROPERTY_ISIHDR_DONT_GENERATE) |
|
275 SEQ_BEGIN(SOS_FTD_DATA_BYTE, CREATE_STRUCT, "000.001", "") |
|
276 FTD_SB_16 |
|
277 VALUE(8, BE, data, "Data", DEC) |
|
278 SEQ_END |
|
279 */ |
|
280 |
|
281 /* SOS_FTD_INPUT_PROPERTY */ |
|
282 |
|
283 PROPERTY_STRING(PROPERTY_ISIHDR_STRUCT_NAME, "tFTD_SeqOfSOSFTDInputPropertyKey") |
|
284 PROPERTY_STRING(PROPERTY_ISIHDR_STRUCT_LENGTH_NAME, "") |
|
285 SEQ_BEGIN(SOS_FTD_INPUT_PROPERTY_KEY, CREATE_STRUCT, "001.001","") |
|
286 COMMENT(COMMENT_TEXT, "4th byte(MSB). Value = SOS_FTD_INPUT_PROPERTY = 0x01") |
|
287 VALUE(8, BE, property_key_1, "property key byte 1", DEC) |
|
288 COMMENT(COMMENT_TEXT, "3rd byte. Symbian data source id") |
|
289 VALUE(8, BE, property_key_2, "property key byte 2", DEC) |
|
290 COMMENT(COMMENT_TEXT, "2nd byte. PN_RES_TYPE_SOS_FIELD_TEST") |
|
291 VALUE(8, BE, property_key_3, "property key byte 3", DEC) |
|
292 COMMENT(COMMENT_TEXT, "1st byte(LSB). PN_PREFIX") |
|
293 VALUE(8, BE, property_key_4, "property key byte 4", DEC) |
|
294 SEQ_END |
|
295 |
|
296 /* SOS_FTD_OUTPUT_PROPERTY */ |
|
297 |
|
298 PROPERTY_STRING(PROPERTY_ISIHDR_STRUCT_NAME, "tFTD_SeqOfSOSFTDOutputPropertyKey") |
|
299 PROPERTY_STRING(PROPERTY_ISIHDR_STRUCT_LENGTH_NAME, "") |
|
300 SEQ_BEGIN(SOS_FTD_OUTPUT_PROPERTY_KEY, CREATE_STRUCT, "001.001","") |
|
301 COMMENT(COMMENT_TEXT, "4th byte(MSB). Value = SOS_FTD_OUTPUT_PROPERTY = 0x02") |
|
302 VALUE(8, BE, property_key_1, "property key byte 1", DEC) |
|
303 COMMENT(COMMENT_TEXT, "3rd byte. Symbian data source id") |
|
304 VALUE(8, BE, property_key_2, "property key byte 2", DEC) |
|
305 COMMENT(COMMENT_TEXT, "2nd byte. PN_RES_TYPE_SOS_FIELD_TEST") |
|
306 VALUE(8, BE, property_key_3, "property key byte 3", DEC) |
|
307 COMMENT(COMMENT_TEXT, "1st byte(LSB). PN_PREFIX") |
|
308 VALUE(8, BE, property_key_4, "property key byte 4", DEC) |
|
309 SEQ_END |
|
310 |
|
311 /* SOS_FTD_DATA_BYTE */ |
|
312 |
|
313 SB_BEGIN(SOS_FTD_DATA_BYTE, "000.001", "") |
|
314 SOS_SB_HDR |
|
315 COMMENT(COMMENT_TEXT, "SOS FTD data.") |
|
316 COMMENT(COMMENT_TEXT, "SOS_FTD_BYTE_VALUE_NOT_DEFINED if SOS_FTD_EXECUTE_WITHOUT_INPUT.") |
|
317 VALUE(8, BE, data, "Data", DEC) |
|
318 FILLER_EX(filler1, 8, 1) |
|
319 FILLER_EX(filler2, 8, 1) |
|
320 FILLER_EX(filler3, 8, 1) |
|
321 SB_END |
|
322 |
|
323 /* SOS_FTD_DATA_WORD */ |
|
324 |
|
325 SB_BEGIN(SOS_FTD_DATA_WORD, "000.001", "") |
|
326 SOS_SB_HDR |
|
327 COMMENT(COMMENT_TEXT, "SOS FTD data.") |
|
328 COMMENT(COMMENT_TEXT, "SOS_FTD_WORD_VALUE_NOT_DEFINED if SOS_FTD_EXECUTE_WITHOUT_INPUT.") |
|
329 VALUE(16, BE, data, "Data", DEC) |
|
330 FILLER_EX(filler1, 8, 1) |
|
331 FILLER_EX(filler2, 8, 1) |
|
332 SB_END |
|
333 |
|
334 |
|
335 /* SOS_FTD_DATA_ALL */ |
|
336 |
|
337 SB_BEGIN(SOS_FTD_DATA_ALL, "000.001", "") |
|
338 SOS_SB_HDR |
|
339 COMMENT(COMMENT_TEXT, "SOS FTD data.") |
|
340 SB_END |
|
341 |
|
342 |
|
343 /* SOS_FTD_DATA_DWORD */ |
|
344 |
|
345 SB_BEGIN(SOS_FTD_DATA_DWORD, "000.001", "") |
|
346 SOS_SB_HDR |
|
347 COMMENT(COMMENT_TEXT, "SOS FTD data.") |
|
348 COMMENT(COMMENT_TEXT, "SOS_FTD_DWORD_VALUE_NOT_DEFINED if SOS_FTD_EXECUTE_WITHOUT_INPUT.") |
|
349 VALUE(32, BE, data, "Data", DEC) |
|
350 SB_END |
|
351 |
|
352 |
|
353 /* SOS_FTD_DATA_STRING */ |
|
354 |
|
355 SB_BEGIN(SOS_FTD_DATA_STRING, "000.001", "") |
|
356 SOS_SB_HDR |
|
357 REFERENCE_CONST(str_type, "String type", STR_TYPE, SOS_FTD_STRING_TYPE) |
|
358 FILLER_EX(filler1, 8, 1) |
|
359 COMMENT(COMMENT_TEXT, "SOS FTD string length in bytes.") |
|
360 ITEM_LIMITS(0, SOS_FTD_MAX_STR_LEN, LIMITS_NO_VALUE, LIMITS_NO_VALUE, LIMITS_NO_VALUE) |
|
361 REFERENCE(16, BE, string_length, "String length", N) |
|
362 COMMENT(COMMENT_TEXT, "SOS_FTD_STRING_VALUE_NOT_DEFINED if SOS_FTD_EXECUTE_WITHOUT_INPUT.") |
|
363 SEQ_OF_REF(string, "SOS FTD string", |
|
364 SOS_FTD_STRING_SEQ, N, ISIHDR_DONT_GENERATE) |
|
365 FILLER(FILLER_VARIABLE, 32) |
|
366 SB_END |
|
367 |
|
368 |
|
369 |
|
370 /* SOS_FTD_DATA_BYTEARRAY */ |
|
371 |
|
372 SB_BEGIN(SOS_FTD_DATA_BYTEARRAY, "000.001", "") |
|
373 SOS_SB_HDR |
|
374 COMMENT(COMMENT_TEXT, "SOS FTD data bytearray") |
|
375 REFERENCE(8, BE, arraylen, "Array length", N) |
|
376 COMMENT(COMMENT_TEXT, "SOS_FTD_BYTEARRAY_VALUE_NOT_DEFINED if SOS_FTD_EXECUTE_WITHOUT_INPUT.") |
|
377 SEQ_OF_REF(array, "Byte array", SOS_FTD_DATA_ARRAY, N, ISIHDR_DONT_GENERATE) |
|
378 FILLER(FILLER_VARIABLE, 32) |
|
379 SB_END |
|
380 |
|
381 |
|
382 /* SOS_FTD_DATA_STATUS */ |
|
383 |
|
384 SB_BEGIN(SOS_FTD_DATA_STATUS, "000.001", "") |
|
385 SOS_SB_STATUS_HDR |
|
386 COMMENT(COMMENT_TEXT, "SOS FTD dataitem ID") |
|
387 VALUE(16, BE, dataitem_id, "Dataitem ID", DEC) |
|
388 VALUE_CONST(status, "Data status", SOS_FTD_DATA_STATUSES) |
|
389 FILLER_EX(filler1, 8, 1) |
|
390 SB_END |
|
391 |
|
392 |
|
393 /* -------------------------------------------------------------------- */ |
|
394 /* ISI Messages */ |
|
395 /* -------------------------------------------------------------------- */ |
|
396 |
|
397 /* SOS_FTD_VERSION_GET */ |
|
398 |
|
399 PROPERTY_STRING(PROPERTY_ISIHDR_STRUCT_NAME, "tSosFtdVersionGetReq") |
|
400 PROPERTY_STRING(PROPERTY_ISIHDR_STRUCT_LENGTH_NAME, |
|
401 "SOS_FTD_VERSION_GET_REQ_HDR_LEN") |
|
402 MSG_BEGIN(SOS_FTD_VERSION_GET_REQ, MESSAGE_REQ, "000.001", "") |
|
403 COMMENT(COMMENT_TEXT, |
|
404 "This is a general message for querying the version of FTD") |
|
405 COMMON_MSG_HDR |
|
406 MSG_END |
|
407 |
|
408 PROPERTY_STRING(PROPERTY_ISIHDR_STRUCT_NAME, "tSosFtdVersionGetResp") |
|
409 PROPERTY_STRING(PROPERTY_ISIHDR_STRUCT_LENGTH_NAME, |
|
410 "SOS_FTD_VERSION_GET_RESP_HDR_LEN") |
|
411 MSG_BEGIN(SOS_FTD_VERSION_GET_RESP, MESSAGE_REQ, "000.001", "") |
|
412 COMMENT(COMMENT_TEXT, |
|
413 "This is a response message for querying the version of FTD") |
|
414 COMMON_MSG_HDR |
|
415 VALUE(8, BE, isi_version_zzz, "ISI Version Z", DEC) |
|
416 VALUE(8, BE, isi_version_yyy, "ISI Version Y", DEC) |
|
417 MSG_END |
|
418 |
|
419 MSG_PAIR(SOS_FTD_VERSION_GET_REQ, SOS_FTD_VERSION_GET_RESP) |
|
420 |
|
421 |
|
422 /* SOS_FTD_ACTIVATE_REQ */ |
|
423 |
|
424 COMMENT(COMMENT_TEXT, "Corresponding property key: SOS_FTD_INPUT_PROPERTY. ") |
|
425 PROPERTY_STRING(PROPERTY_ISIHDR_STRUCT_NAME, "tSosFtdActivateReq") |
|
426 PROPERTY_STRING(PROPERTY_ISIHDR_STRUCT_LENGTH_NAME, |
|
427 "SOS_FTD_ACTIVATE_REQ_HDR_LEN") |
|
428 MSG_BEGIN(SOS_FTD_ACTIVATE_REQ, MESSAGE_REQ, "000.001", "") |
|
429 COMMENT(COMMENT_TEXT, |
|
430 "This is a general message for activate the FTD") |
|
431 COMMON_MSG_HDR |
|
432 VALUE(16, BE, message_length, "Message Length", DEC) |
|
433 PROPERTY_VALUE(PROPERTY_ITEM_MAXIMUM_VALUE, MAX_FTD_DATA_ITEMS) |
|
434 REFERENCE(8, BE, data_item_count, "Number of FTD Data", N) |
|
435 FILLER_EX(pad1, 8, 1) |
|
436 FILLER_EX(pad2, 8, 1) |
|
437 FILLER_EX(pad3, 8, 1) |
|
438 COMMENT(COMMENT_TEXT, "Only required Sub Block IDs are added to request message.") |
|
439 COMMENT(COMMENT_TEXT, " Response will contain SOS_FTD_DATA_*.") |
|
440 SEQ_OF_REF(ids, "List of FTD data items", SOS_FTD_WORD, N, ISIHDR_DONT_GENERATE) |
|
441 MSG_END |
|
442 |
|
443 |
|
444 /* SOS_FTD_ACTIVATE_RESP */ |
|
445 |
|
446 COMMENT(COMMENT_TEXT, "Corresponding property key: SOS_FTD_OUTPUT_PROPERTY. ") |
|
447 PROPERTY_STRING(PROPERTY_ISIHDR_STRUCT_NAME, "tSosFtdActivateResp") |
|
448 PROPERTY_STRING(PROPERTY_ISIHDR_STRUCT_LENGTH_NAME, |
|
449 "SOS_FTD_ACTIVATE_RESP_HDR_LEN") |
|
450 MSG_BEGIN(SOS_FTD_ACTIVATE_RESP, MESSAGE_RESP, "000.001", "") |
|
451 COMMENT(COMMENT_TEXT, |
|
452 "This is a response message for activate the FTD") |
|
453 COMMON_MSG_HDR |
|
454 VALUE(16, BE, message_length, "Message Length", DEC) |
|
455 PROPERTY_VALUE(PROPERTY_ITEM_MAXIMUM_VALUE, MAX_FTD_DATA_ITEMS) |
|
456 REFERENCE(8, BE, data_item_count, "Number of FTD Data", N) |
|
457 FILLER_EX(pad1, 8, 1) |
|
458 FILLER_EX(pad2, 8, 1) |
|
459 FILLER_EX(pad3, 8, 1) |
|
460 SB_LST_REF_BEGIN(LIST_OF_SUBBLOCKS, sub_block_ids, "FTD data items", N, |
|
461 ISIHDR_MARKER_ANYSIZE) |
|
462 SB_LST_ENTRY(SOS_FTD_DATA_BYTE) |
|
463 SB_LST_ENTRY(SOS_FTD_DATA_WORD) |
|
464 SB_LST_ENTRY(SOS_FTD_DATA_ALL) |
|
465 SB_LST_ENTRY(SOS_FTD_DATA_DWORD) |
|
466 SB_LST_ENTRY(SOS_FTD_DATA_STRING) |
|
467 SB_LST_ENTRY(SOS_FTD_DATA_BYTEARRAY) |
|
468 SB_LST_ENTRY(SOS_FTD_DATA_STATUS) |
|
469 SB_LST_END |
|
470 MSG_END |
|
471 |
|
472 MSG_PAIR(SOS_FTD_ACTIVATE_REQ, SOS_FTD_ACTIVATE_RESP) |
|
473 |
|
474 |
|
475 /* SOS_FTD_DEACTIVATE_REQ */ |
|
476 |
|
477 COMMENT(COMMENT_TEXT, "Corresponding property key: SOS_FTD_INPUT_PROPERTY. ") |
|
478 PROPERTY_STRING(PROPERTY_ISIHDR_STRUCT_NAME, "tSosFtdDeactivateReq") |
|
479 PROPERTY_STRING(PROPERTY_ISIHDR_STRUCT_LENGTH_NAME, |
|
480 "SOS_FTD_DEACTIVATE_REQ_HDR_LEN") |
|
481 MSG_BEGIN(SOS_FTD_DEACTIVATE_REQ, MESSAGE_REQ, "000.001", "") |
|
482 COMMENT(COMMENT_TEXT, |
|
483 "This is a general message for deactivate the FTD") |
|
484 COMMON_MSG_HDR |
|
485 VALUE(16, BE, message_length, "Message Length", DEC) |
|
486 PROPERTY_VALUE(PROPERTY_ITEM_MAXIMUM_VALUE, MAX_FTD_DATA_ITEMS) |
|
487 REFERENCE(8, BE, data_item_count, "Number of FTD Data", N) |
|
488 FILLER_EX(pad1, 8, 1) |
|
489 FILLER_EX(pad2, 8, 1) |
|
490 FILLER_EX(pad3, 8, 1) |
|
491 COMMENT(COMMENT_TEXT, "Use data item IDs as parameter or deactivate all with value SOS_FTD_DATA_ALL.") |
|
492 SEQ_OF_REF(ids, "List of FTD data items", SOS_FTD_WORD, N, ISIHDR_DONT_GENERATE) |
|
493 MSG_END |
|
494 |
|
495 |
|
496 /* SOS_FTD_DEACTIVATE_RESP */ |
|
497 |
|
498 COMMENT(COMMENT_TEXT, "Corresponding property key: SOS_FTD_OUTPUT_PROPERTY. ") |
|
499 PROPERTY_STRING(PROPERTY_ISIHDR_STRUCT_NAME, "tSosFtdDeactivateResp") |
|
500 PROPERTY_STRING(PROPERTY_ISIHDR_STRUCT_LENGTH_NAME, |
|
501 "SOS_FTD_DEACTIVATE_RESP_HDR_LEN") |
|
502 MSG_BEGIN(SOS_FTD_DEACTIVATE_RESP, MESSAGE_RESP, "000.001", "") |
|
503 COMMENT(COMMENT_TEXT, |
|
504 "This is a response message for deactivate the FTD") |
|
505 COMMON_MSG_HDR |
|
506 VALUE(16, BE, message_length, "Message Length", DEC) |
|
507 PROPERTY_VALUE(PROPERTY_ITEM_MAXIMUM_VALUE, MAX_FTD_DATA_ITEMS) |
|
508 REFERENCE(8, BE, data_item_count, "Number of FTD Data", N) |
|
509 FILLER_EX(pad1, 8, 1) |
|
510 FILLER_EX(pad2, 8, 1) |
|
511 FILLER_EX(pad3, 8, 1) |
|
512 SB_LST_REF_BEGIN(LIST_OF_SUBBLOCKS, sub_block_ids, "N * Status data items", N, |
|
513 ISIHDR_MARKER_ANYSIZE) |
|
514 SB_LST_ENTRY(SOS_FTD_DATA_STATUS) |
|
515 SB_LST_END |
|
516 MSG_END |
|
517 |
|
518 MSG_PAIR(SOS_FTD_DEACTIVATE_REQ, SOS_FTD_DEACTIVATE_RESP) |
|
519 |
|
520 |
|
521 /* SOS_FTD_EXECUTE_REQ */ |
|
522 |
|
523 /* |
|
524 COMMENT(COMMENT_TEXT, "Corresponding property key: SOS_FTD_INPUT_PROPERTY. ") |
|
525 PROPERTY_STRING(PROPERTY_ISIHDR_STRUCT_NAME, "tSosFtdExecuteReq") |
|
526 PROPERTY_STRING(PROPERTY_ISIHDR_STRUCT_LENGTH_NAME, |
|
527 "SOS_FTD_EXECUTE_REQ_HDR_LEN") |
|
528 MSG_BEGIN(SOS_FTD_EXECUTE_REQ, MESSAGE_REQ, "000.001", "") |
|
529 COMMENT(COMMENT_TEXT, |
|
530 "This is a general message for execute the FTD") |
|
531 COMMON_MSG_HDR |
|
532 VALUE(16, BE, message_length, "Message Length", DEC) |
|
533 PROPERTY_VALUE(PROPERTY_ITEM_MAXIMUM_VALUE, MAX_FTD_DATA_ITEMS) |
|
534 REFERENCE(8, BE, data_item_count, "Number of FTD Data", N) |
|
535 VALUE_CONST(execute_type, "Execute type", SOS_FTD_EXECUTE_TYPE) |
|
536 FILLER_EX(pad1, 8, 1) |
|
537 FILLER_EX(pad2, 8, 1) |
|
538 SB_LST_REF_BEGIN(LIST_OF_SUBBLOCKS, sub_block_ids, "List of execute data items", N, |
|
539 ISIHDR_MARKER_ANYSIZE) |
|
540 SB_LST_ENTRY(SOS_FTD_DATA_BYTE) |
|
541 SB_LST_ENTRY(SOS_FTD_DATA_WORD) |
|
542 SB_LST_ENTRY(SOS_FTD_DATA_ALL) |
|
543 SB_LST_ENTRY(SOS_FTD_DATA_DWORD) |
|
544 SB_LST_ENTRY(SOS_FTD_DATA_STRING) |
|
545 SB_LST_ENTRY(SOS_FTD_DATA_BYTEARRAY) |
|
546 SB_LST_ENTRY(SOS_FTD_DATA_STATUS) |
|
547 SB_LST_END |
|
548 MSG_END |
|
549 */ |
|
550 COMMENT(COMMENT_TEXT, "Corresponding property key: SOS_FTD_INPUT_PROPERTY. ") |
|
551 PROPERTY_STRING(PROPERTY_ISIHDR_STRUCT_NAME, "tSosFtdExecuteReq") |
|
552 PROPERTY_STRING(PROPERTY_ISIHDR_STRUCT_LENGTH_NAME, |
|
553 "SOS_FTD_EXECUTE_REQ_HDR_LEN") |
|
554 MSG_BEGIN(SOS_FTD_EXECUTE_REQ, MESSAGE_REQ, "000.001", "") |
|
555 COMMENT(COMMENT_TEXT, |
|
556 "This is a general message for execute the FTD") |
|
557 COMMON_MSG_HDR |
|
558 VALUE(16, BE, message_length, "Message Length", DEC) |
|
559 /* |
|
560 PROPERTY_VALUE(PROPERTY_ITEM_MAXIMUM_VALUE, MAX_FTD_DATA_ITEMS) |
|
561 REFERENCE(8, BE, data_item_count, "Number of FTD Data", N) |
|
562 */ |
|
563 FILLER_EX(pad1, 8, 1) |
|
564 VALUE_CONST(execute_type, "Execute type", SOS_FTD_EXECUTE_TYPE) |
|
565 VALUE(16, BE, data_item_id, "Data item ID", DEC) |
|
566 COMMENT(COMMENT_TEXT, |
|
567 "Only requred Input data if SOS_FTD_EXECUTE_TYPE = SOS_FTD_EXECUTE_TYPE_WITH_INPUT.") |
|
568 VALUE(32, BE, input_data, "Input data", DEC) |
|
569 MSG_END |
|
570 |
|
571 /* SOS_FTD_EXECUTE_RESP */ |
|
572 /* |
|
573 COMMENT(COMMENT_TEXT, "Corresponding property key: SOS_FTD_OUTPUT_PROPERTY. ") |
|
574 PROPERTY_STRING(PROPERTY_ISIHDR_STRUCT_NAME, "tSosFtdExecuteResp") |
|
575 PROPERTY_STRING(PROPERTY_ISIHDR_STRUCT_LENGTH_NAME, |
|
576 "SOS_FTD_EXECUTE_RESP_HDR_LEN") |
|
577 MSG_BEGIN(SOS_FTD_EXECUTE_RESP, MESSAGE_RESP, "000.001", "") |
|
578 COMMENT(COMMENT_TEXT, |
|
579 "This is a response message for execute the FTD") |
|
580 COMMON_MSG_HDR |
|
581 VALUE(16, BE, message_length, "Message Length", DEC) |
|
582 PROPERTY_VALUE(PROPERTY_ITEM_MAXIMUM_VALUE, MAX_FTD_DATA_ITEMS) |
|
583 REFERENCE(8, BE, data_item_count, "Number of FTD Data", N) |
|
584 FILLER_EX(pad1, 8, 1) |
|
585 FILLER_EX(pad2, 8, 1) |
|
586 FILLER_EX(pad3, 8, 1) |
|
587 COMMENT(COMMENT_TEXT, "Only required Sub Block IDs are added to reponse message.") |
|
588 COMMENT(COMMENT_TEXT, " Response contains SOS_FTD_DATA_*.") |
|
589 SEQ_OF_REF(ids, "List of FTD data items", SOS_FTD_WORD, N, ISIHDR_DONT_GENERATE) |
|
590 MSG_END |
|
591 */ |
|
592 COMMENT(COMMENT_TEXT, "Corresponding property key: SOS_FTD_OUTPUT_PROPERTY. ") |
|
593 PROPERTY_STRING(PROPERTY_ISIHDR_STRUCT_NAME, "tSosFtdExecuteResp") |
|
594 PROPERTY_STRING(PROPERTY_ISIHDR_STRUCT_LENGTH_NAME, |
|
595 "SOS_FTD_EXECUTE_RESP_HDR_LEN") |
|
596 MSG_BEGIN(SOS_FTD_EXECUTE_RESP, MESSAGE_RESP, "000.001", "") |
|
597 COMMENT(COMMENT_TEXT, |
|
598 "This is a response message for execute the FTD") |
|
599 COMMON_MSG_HDR |
|
600 VALUE(16, BE, message_length, "Message Length", DEC) |
|
601 VALUE(16, BE, status_item_id, "Status item ID", DEC) |
|
602 VALUE(16, BE, status_item_len, "Status item length", DEC) |
|
603 VALUE(16, BE, data_item_id, "Dataitem ID", DEC) |
|
604 COMMENT(COMMENT_TEXT, |
|
605 "Constant from table SOS_FTD_DATA_STATUSES.") |
|
606 VALUE(8, BE, data_status, "Data status", DEC) |
|
607 FILLER_EX(pad1, 8, 1) |
|
608 |
|
609 MSG_END |
|
610 |
|
611 MSG_PAIR(SOS_FTD_EXECUTE_REQ, SOS_FTD_EXECUTE_RESP) |
|
612 |
|
613 RES_END |
|
614 |
|
615 /* End of file sos_ftd_isi_m.h */ |
|