stbcicc.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2016 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 *
 * 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 _STBCICC_H
#define _STBCICC_H

#include "techtype.h"

/*---Constant and macro definitions for public use-----------------------------*/

#define CIP_CICAM_ID_LEN            8
#define CIP_URI_LEN                 8
#define CIP_MAX_PIN_LENGTH          8
#define CIP_PIN_PRIVATE_DATA_SIZE   15

/*---Enumerations for public use-----------------------------------------------*/

/*---Global type defs for public use-------------------------------------------*/

/*---Global Function prototypes for public use---------------------------------*/

void STB_CiCcInitialise(void);

void STB_CiCcRemove(U8BIT slot_id);

void STB_CiCcNotifyModuleInsert(U8BIT slot_id);

void STB_CiCcNotifyModuleRemove(U8BIT slot_id);

BOOLEAN STB_CiCcIsSlotReady(U8BIT slot_id);

void STB_CiCcSetSDTAcquisitionStatus(BOOLEAN complete);

BOOLEAN STB_CiCcIsServiceAllowed(U8BIT slot_id, U8BIT *ci_prot_desc);

BOOLEAN STB_CiCcAuthenticated(U8BIT slot_id);

U8BIT STB_CiCcFindSlotForCicamId(U8BIT cicam_id[CIP_CICAM_ID_LEN]);

void STB_CiCcGetUsageRulesInfo(U8BIT slot_id, U16BIT service_id,
   U8BIT uri[CIP_URI_LEN]);

void STB_CiCcGetDefaultUsageRulesInfo(U8BIT raw_uri[CIP_URI_LEN]);

U32BIT STB_CiCcGetRetentionLimit(U8BIT uri[CIP_URI_LEN]);

void STB_CiCcApplyUsageRulesInfo(U8BIT *uri);

void STB_CiCcApplyUsageRulesInfoForPlayback(U8BIT *uri);

BOOLEAN STB_CiCcIsHDCPRequired(U16BIT service_id);

BOOLEAN STB_CiCcSendPlaybackLicence(U8BIT slot_id, U16BIT program_number, U8BIT *licence,
   U16BIT licence_len);

U8BIT *STB_CiCcGetRecordingLicence(U8BIT slot_id, U8BIT * licence_status, U16BIT * licence_len,
                               U8BIT raw_uri[CIP_URI_LEN]);

U8BIT *STB_CiCcGetPlaybackLicence(U8BIT slot_id, U8BIT * licence_status, U16BIT * licence_len,
                              U8BIT raw_uri[CIP_URI_LEN]);

BOOLEAN STB_CiCcSendPin(U8BIT slot_id, U8BIT *pin_data);

BOOLEAN STB_CiCcGetRecordingPinInfo(U8BIT slot_id, U8BIT *status, U8BIT *age_rating,
   U8BIT **private_data, U16BIT *date_code, U8BIT *hour, U8BIT *min, U8BIT *sec);

BOOLEAN STB_CiCcSendPinPlayback(U8BIT slot_id, U8BIT age_rating, U8BIT *private_data);

void STB_CiCcSetRecordOperatingMode(U8BIT slot_id, U32BIT mode, U16BIT service_id);

BOOLEAN STB_CiCcSendRecordStart(U8BIT slot_id, U16BIT program_number, U8BIT *pin_string);

BOOLEAN STB_CiCcSendRecordStop(U8BIT slot_id);

#endif /* _STBCICC_H */