dataCarousel.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2004 Ocean Blue Software Ltd
 * Copyright © 2001 Koninklijke Philips Electronics N.V
 *
 * This file is part of a DTVKit Software Component
 * You are permitted to copy, modify or distribute this file subject to the terms
 * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
 * 
 * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
 * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
 * 
 * If you or your organisation is not a member of DTVKit then you have access
 * to this source code outside of the terms of the licence agreement
 * and you are expected to delete this and any associated files immediately.
 * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
 *******************************************************************************/
#ifndef _DATACAROUSEL_H_
#define _DATACAROUSEL_H_


/*--------------------------------  Includes  --------------------------------*/

#include "clDsmSystem.h"

#include "linkList.h"
#include "module.h"

#ifdef __cplusplus
extern "C" {
#endif


/*-----------------------------  Exported Macros  ----------------------------*/


/*------------------------------  Exported Types  ----------------------------*/

typedef struct {
    U16BIT  blockSize;
    U16BIT  numberOfModules;  /* -- NB. Value stored here not currently used */
} DiiInfo_t, *pDiiInfo_t;


typedef struct {
    S_LLObject              llData[NUM_LISTS_DATA_CAROUSEL];
    U16BIT                  dataCarouselId;
    U32BIT                  lastRcvdTransactionId;
    U32BIT                  diiCrc;

    /* -- DII filter info */
    DeliveryParaTap_t       tap;
    pSectionFilterInfo_t    pDiiSf;

    U16BIT                  diiRequestCount;
    U16BIT                  diiMonitorCount;

    DiiInfo_t               diiInfo;
    U16BIT                  diiMsgDataLen;
    MemHandle               hDiiMsgData;

    P_LLControl             llcDcModules;

} DataCarousel_t, *pDataCarousel_t;


/*------------------------------  Exported Data  -----------------------------*/


/*---------------------------  Exported Prototypes  --------------------------*/

clDsmErr_t dcCreate( pclDsmInstData_t idp,
    pDeliveryParaTap_t pTap, MemHandle *phDataCarousel );

void dcDestroy( pclDsmInstData_t idp, MemHandle *phDataCarousel );

MemHandle dcListFindById( P_LLControl pDcList, U32BIT transactionId );


/* -- CONTIGUOUS MEMORY DATA ACCESS FUNCTIONS */

#include "defMemUtilsContig.h"  /* -- Default mem type for functions */

BOOLEAN dcGetDiiMsgInfoContig( const U8BIT* pDiiMsg, DiiInfo_t *pDiiInfo );

BOOLEAN dcFindModuleInDiiMsgContig(
    /*I*/ const MemPtr pDiiMsg, U32BIT dataLength, U16BIT moduleId,
    /*O*/ MemPtr *pModuleInfoDescStart );

BOOLEAN dcGetModuleInfoContig(
    const MemPtr pModuleInfoDescStart, ModuleInfo_t *pModuleInfo );

void dcGetFirstModuleDescContig(
    /*I*/ const MemPtr mpDiiMsg,
    /*O*/ MemPtr *mpModuleInfoDescStart );

void dcGetNextModuleDescContig(
    /*I*/ const MemPtr mpCurrModuleDescStart,
    /*O*/ MemPtr *mpNextModuleDescStart );


/* -- MANAGED MEMORY DATA ACCESS FUNCTIONS */

#include "defMemUtilsMgd.h"  /* -- Default mem type for functions */

BOOLEAN dcFindModuleInDiiMsgSeq(
    /*I*/ const MemPtr mpDiiMsg, U32BIT dataLength, U16BIT moduleId,
    /*O*/ MemPtr *mpModuleInfoDescStart );

BOOLEAN dcGetModuleInfoSeq(
    const MemPtr mpModuleInfoDescStart, ModuleInfo_t *pModuleInfo );


/*----------------------------------------------------------------------------*/

#ifdef __cplusplus
}
#endif
#endif /* _DATACAROUSEL_H_ */