DSMCC Version 1.0
DTVKit DSMCC Documentation
 All Data Structures Files Functions Typedefs
getIopIor_include_src.h
Go to the documentation of this file.
1 /*******************************************************************************
2  * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
3  * Copyright © 2004 Ocean Blue Software Ltd
4  * Copyright © 2001 Koninklijke Philips Electronics N.V
5  *
6  * This file is part of a DTVKit Software Component
7  * You are permitted to copy, modify or distribute this file subject to the terms
8  * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
9  *
10  * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
11  * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
12  * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
13  *
14  * If you or your organisation is not a member of DTVKit then you have access
15  * to this source code outside of the terms of the licence agreement
16  * and you are expected to delete this and any associated files immediately.
17  * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
18  *******************************************************************************/
27 /*
28 -- getIorInfo - Common Code
29 --
30 -- Get typeId, location and tap info from IOR data (compatible with
31 -- contiguous or managed/MemSeq memory)
32 --
33 -- Uses/assumes the following vars:
34 -- length_used, mpIorData, pIorTypeId, pLocation, pTap
35 --
36 -- mpIorData references ('points' to) first byte of IOP::IOR
37 -- length_used (U16BIT) indicates whether info was successfully recovered
38 --
39 -- mpIorData = pUInt8 OR MemSeqRef,
40 -- pIorTypeId = U32BIT *
41 -- pLocation = ObjectLocation_t *
42 -- pTap = DeliveryParaTap_t *
43 -- length_used = U16BIT
44 -- On entry - mpIorData -> first byte of IOR
45 -- On exit - mpIorData -> UNCHANGED
46 */
47 {
48  U32BIT profileIdTag;
49  MemPtr mpIor;
50  MemPtr mpIorStart;
51  MemPtr mpIopProfile;
52  BOOLEAN keyValid;
53  U8BIT ui8 = 0;
54  U16BIT ui16 = 0;
55  U32BIT ui32 = 0;
56  U32BIT profileIndex;
57  U32BIT taggedProfilesCount;
58  U32BIT profileDataLength;
59  /*U8BIT *pDump ;*/
60  /* -- stop compiler warnings when no checking */
61  ui8 += 0;
62 
63  dsmAssert(( mpIorData != NULL ));
64  dsmAssert(( pIorTypeId != NULL ));
65  dsmAssert(( pLocation != NULL ));
66  dsmAssert(( pTap != NULL ));
67 
68 
69  MEMPTR_OPEN( mpIorData, mpIor );
70 
71  mpIorStart = mpIor;
72 
73  /*pDump = mpIor;*/
74 
75  /* -- mpIor -> start of IOP::IOR */
76 
77  /* -- typeIdLength = 4 (DVB/UK DTT) */
78  ADV_UINT32_L2CHK( mpIor, ui32, ui32 == 4,
79  dsmDP2(("DATA ERROR: IOR typeIdLength (!= 4) = %u\n", ui32)),
80  goto _return_False );
81 
82  /* -- Read typeId */
83  READ_UINT32( mpIor, *pIorTypeId );
84 
85  /* -- taggedProfilesCount >= 1 (DVB/UK DTT) */
86  READ_UINT32_L2CHK( mpIor, taggedProfilesCount, taggedProfilesCount >= 1,
87  dsmDP2(("DATA ERROR: IOR taggedProfilesCount (< 1) = %u\n",
88  taggedProfilesCount)),
89  goto _return_False );
90 
91  /* -- Store location of first IOP::taggedProfile */
92  mpIopProfile = mpIor;
93 
94  /* -- Read profileIdTag */
95  READ_UINT32( mpIor, profileIdTag );
96 
97  pLocation->uiBindingTag = profileIdTag;
98 
99  /* -- mpIor -> start of (first) BIOPProfileBody */
100 
101  if ( profileIdTag == TAG_BIOP )
102  {
103  /* -- profileDataLength */
104  ADV_UINT32_L2CHK( mpIor, ui32, ui32 >=
105  (2 + MIN_OBJ_LOCATION_LEN + MIN_CONN_BINDER_LEN),
106  dsmDP2(("DATA ERROR: IOR TAG_BIOP profileDataLength = %u\n", ui32)),
107  goto _return_False );
108 
109  /* -- byteOrder = big_endian (DVB) */
110  /* -- L1 check because if this is wrong, subsequent data will be garbaged */
111  ADV_UINT8_L1CHK( mpIor, ui8, ui8 == 0,
112  dsmDP2(("DATA ERROR: IOR TAG_BIOP byteOrder = %u\n", ui8)),
113  goto _return_False );
114 
115  /* -- liteComponentsCount >= 1 (UK DTT) */
116  /* -- L1 check because if this is wrong, subsequent data will be garbaged */
117  ADV_UINT8_L1CHK( mpIor, ui8, ui8 >= 1,
118  dsmDP2(("DATA ERROR: IOR TAG_BIOP liteComponentsCount (< 1) = %u\n", ui8)),
119  goto _return_False );
120 
121  /* -- mpIor -> start of BIOP::ObjectLocation */
122 
123  /* -- componentIdTag = BIOP::ObjectLocation (DVB/UK DTT) */
124  /* -- L0 check because this must be correct */
125  READ_UINT32_L0CHK( mpIor, ui32, ui32 == TAG_OBJECT_LOCATION,
126  dsmDP2(("DATA ERROR: IOR TAG_BIOP 1st componentIdTag (!= ObjectLocation) = %u\n", ui32)),
127  goto _return_False );
128 
129  /* -- componentDataLength */
130  ADV_UINT8_L2CHK( mpIor, ui8, ui8 >= MIN_OBJLOC_COMPONENT_DATA_LEN,
131  dsmDP2(("DATA ERROR: IOR ObjectLocation componentDataLength = %u\n", ui8)),
132  goto _return_False );
133 
134  /* -- Read carouselId */
135  READ_UINT32( mpIor, pLocation->carouselId );
136 
137  /* -- Read moduleId */
138  READ_UINT16( mpIor, pLocation->moduleId );
139 
140  /* -- BIOP protocol version - major = 0x01, minor = 0x00 (DVB) */
141  ADV_UINT16_L2CHK( mpIor, ui16, ui16 == 0x0100,
142  dsmDP2(("DATA ERROR: IOR ObjectLocation protocol version (!=0x0100) = %u\n", ui16)),
143  goto _return_False );
144 
145  /* -- mpIor -> start of objectKey info */
146  READ_OBJECT_KEY( mpIor, pLocation->objectKey, keyValid );
147  if (!keyValid) {
148  dsmDP2(("DATA ERROR: IOR ObjectLocation objectKey invalid\n"));
149  goto _return_False;
150  }
151 
152  /* -- mpIor -> start of DSM::ConnBinder */
153 
154  /* -- componentIdTag = DSM::ConnBinder (DVB/UK DTT) */
155  /* -- L0 check because this must be correct */
156  READ_UINT32_L0CHK( mpIor, ui32, ui32 == TAG_CONN_BINDER,
157  dsmDP2(("DATA ERROR: IOR TAG_BIOP 2nd componentIdTag (!= ConnBinder) = %u\n", ui32)),
158  goto _return_False );
159 
160  /* -- componentDataLength */
161  ADV_UINT8_L2CHK( mpIor, ui8, ui8 >= MIN_CONBIND_COMPONENT_DATA_LEN,
162  dsmDP2(("DATA ERROR: IOR ConnBinder componentDataLength = %u\n", ui8)),
163  goto _return_False );
164 
165  /* -- tapsCount >= 1 (DVB) */
166  /* -- L1 check because if this is wrong, subsequent data will be garbaged */
167  ADV_UINT8_L1CHK( mpIor, ui8, ui8 >= 1,
168  dsmDP2(("DATA ERROR: IOR ConnBinder tapsCount (< 1) = %u\n", ui8)),
169  goto _return_False );
170 
171 
172  /* -- mpIor -> start of first BIOP::Tap */
173 
174  /* -- Read tapId - TODO: Not required ? */
175  READ_UINT16( mpIor, pTap->id );
176 
177  /* -- 1st tapUse = BIOP_DELIVERY_PARA_USE (in IORs - DVB UK DTT) */
178  /* -- L0 check because this must be correct */
179  READ_UINT16_L0CHK( mpIor, ui16, ui16 == BIOP_DELIVERY_PARA_USE,
180  dsmDP2(("DATA ERROR: IOR ConnBinder 1st tapUse (!= BIOP_DELIVERY_PARA_USE) = %u\n", ui16)),
181  goto _return_False );
182 
183  /* -- Read associationTag */
184  READ_UINT16( mpIor, pTap->associationTag );
185 
186  /* -- selectorLength = 10 (DVB/UK DTT) */
187  ADV_UINT8_L2CHK( mpIor, ui8, ui8 == 0x0A,
188  dsmDP2(("DATA ERROR: IOR ConnBinder tap selectorLength (!= 10) = %u\n", ui8)),
189  goto _return_False );
190 
191  /* -- selectorType = 1 (DVB/UK DTT) */
192  ADV_UINT16_L2CHK( mpIor, ui16, ui16 == 0x0001,
193  dsmDP2(("DATA ERROR: IOR ConnBinder tap selectorType (!= 1) = %u\n", ui16)),
194  goto _return_False );
195 
196  /* -- Read transactionId */
197  READ_UINT32( mpIor, pTap->transactionId );
198 
199  /* -- Read timeout */
200  READ_UINT32( mpIor, pTap->timeout );
201 
202  }
203  else if ( profileIdTag == TAG_LITE_OPTIONS )
204  {
205 
206  U32BIT uiComponentCount = 0;
207  U8BIT *pWriteNSAPaddr = NULL;
208  U32BIT i = 0;
209  S8BIT *pPathPtr = NULL;
210 
211  /* -- profileDataLength */
212  SET_POS_REL( mpIor, 4 ); /* changed from thing below as the check did nothing
213  ADV_UINT32_L2CHK( mpIor, ui32, ui32 >= 0,
214  dsmDP2(("DATA ERROR: IOR TAG_BIOP profileDataLength = %u\n", ui32)),
215  goto _return_False );*/
216 
217  /* -- byteOrder = big_endian (DVB) */
218  /* -- L1 check because if this is wrong, subsequent data will be garbaged */
219  ADV_UINT8_L1CHK( mpIor, ui8, ui8 == 0,
220  dsmDP2(("DATA ERROR: IOR TAG_BIOP byteOrder = %u\n", ui8)),
221  goto _return_False );
222 
223  /* -- liteComponentsCount >= 1 (UK DTT) */
224  /* -- L1 check because if this is wrong, subsequent data will be garbaged */
225  ADV_UINT8_L1CHK( mpIor, ui8, ui8 >= 1,
226  dsmDP2(("DATA ERROR: IOR TAG_BIOP liteComponentsCount (< 1) = %u\n", ui8)),
227  goto _return_False );
228 
229  /* -- mpIor -> start of BIOP::ObjectLocation */
230 
231  /* -- componentIdTag = BIOP::ObjectLocation (DVB/UK DTT) */
232  /* -- L0 check because this must be correct */
233  READ_UINT32_L0CHK( mpIor, ui32, ui32 == TAG_SERVICE_LOCATION,
234  dsmDP2(("DATA ERROR: IOR TAG_LITE_OPTIONS 1st componentIdTag (!= ServiceLocation) = %u\n", ui32)),
235  goto _return_False );
236 
237  /* -- componentDataLength */
238  READ_UINT8( mpIor, ui8 );
239 
240  /* -- Read service domain lg */
241  ADV_UINT8_L1CHK( mpIor, ui8, ui8 == 0x14,
242  dsmDP2(("DATA ERROR: IOR TAG_LITE_OPTIONS bad NSAP address length (!= 0x14) = %u\n", ui8)),
243  goto _return_False );
244 
245  pWriteNSAPaddr = &pLocation->dvbCarouselNSAPaddress[0];
246 
247  i = 0;
248  while(i++ < 0x14)
249  {
250  READ_UINT8( mpIor, *(pWriteNSAPaddr++));
251  }
252 
253  /* read name component count */
254  READ_UINT32( mpIor, uiComponentCount);
255 
256  pPathPtr = &pLocation->pathName[0];
257 
258  for(i=0; i < uiComponentCount; i++)
259  {
260  U32BIT uiNameId_lg = 0;
261  U32BIT uiKing_lg = 0;
262  U32BIT j = 0;
263 
264 
265  /* read name_id lg */
266  READ_UINT32( mpIor, uiNameId_lg);
267 
268 
269 
270  if(uiNameId_lg > MAX_PATH_NAME_SIZE)
271  {
272  uiNameId_lg = MAX_PATH_NAME_SIZE;
273  }
274 
275  /* get path */
276  for(j=0;j < uiNameId_lg; j++)
277  {
278  READ_UINT8( mpIor,ui8);
279  *pPathPtr++=ui8;
280  }
281  *(pPathPtr++) = '/';
282 
283  /* read path kind lg */
284  READ_UINT32( mpIor, uiKing_lg);
285 
286  /* SKIP path kind data */
287  SET_POS_REL( mpIor, uiKing_lg);
288 
289  }
290 
291  }
292  else
293  {
294  dsmDP2(( "DATA ERROR: IOR - Invalid profileIdTag for DVB object carousel: %x\n",
295  profileIdTag ));
296  goto _return_False;
297  }
298 
299  /* -- SKIP ALL TAGGED PROFILES IN IOP::IOR */
300 
301  length_used = (U16BIT)(mpIopProfile - mpIorStart);
302  mpIor = mpIopProfile;
303  for (profileIndex = 0; profileIndex < taggedProfilesCount; profileIndex++)
304  {
305  /* -- Read profileIdTag */
306  READ_UINT32( mpIor, profileIdTag );
307 
308  /* -- profileDataLength */
309  READ_UINT32_L2CHK( mpIor, profileDataLength, profileDataLength >=
310  (2 + MIN_OBJ_LOCATION_LEN + MIN_CONN_BINDER_LEN),
311  dsmDP2(("DATA ERROR: IOR TAG_BIOP profileDataLength = %u\n", ui32)),
312  goto _return_False );
313 
314  /* -- Skip profile */
315  SET_POS_REL( mpIor, profileDataLength );
316 
317  /* -- profileIdTag, profileDataLength and the actual data */
318  length_used += 8 + profileDataLength;
319  }
320 
321  goto _return;
322 
323 _return_False:
324  length_used = 0;
325 
326 _return:
327  /* printf("DUMP -----\n"); */
328 
329 /* while(pDump < mpIor) */
330 /* printf(" 0x%2x",*(pDump++)); */
331 
332 /* printf("\nEND DUMP -----\n"); */
333 
334  MEMPTR_CLOSE( mpIor );
335  DEBUG_CHK( length_used != 0,
336  dsmDP1(("ERROR: getIorInfo failure (invalid)\n")) );
337 }
338 
339 
340 /*----------------------------------------------------------------------------*/
341 
342 
343 
Generated on Wed Mar 12 2014 10:15:29 for DSMCC Version 1.0 by   doxygen 1.8.6